def assertWrites(self, glyphs_object, text):
"""Assert that the given object, when given to the writer,
produces the given text.
"""
expected = text.splitlines()
actual = test_helpers.write_to_lines(glyphs_object)
self.assertLinesEqual(
expected, actual,
"The writer has not produced the expected output")
def assertWritesValue(self, glyphs_value, text):
"""Assert that the writer produces the given text for the given value."""
expected = dedent("""\
{{
writtenValue = {0};
}}
""").format(text).splitlines()
# We wrap the value in a dict to use the same test helper
actual = test_helpers.write_to_lines({'writtenValue': glyphs_value})
self.assertLinesEqual(
expected, actual,
"The writer has not produced the expected output")
def test_write_layer(self):
layer = classes.GSLayer()
# http://docu.glyphsapp.com/#gslayer
# parent: not written
# name
layer.name = '{125, 100}'
# associatedMasterId
layer.associatedMasterId = 'M1'
# layerId
layer.layerId = 'L1'
# color
layer.color = 2 # brown
# colorObject: read-only, computed
# components
component = classes.GSComponent(glyph='glyphName')
layer.components.append(component)
# guides
guide = classes.GSGuideLine()
guide.name = 'xheight'
layer.guides.append(guide)
# annotations
annotation = classes.GSAnnotation()
annotation.type = classes.TEXT
annotation.text = 'F**k, this curve is ugly!'
layer.annotations.append(annotation)
# hints
hint = classes.GSHint()
hint.name = 'hintName'
layer.hints.append(hint)
# anchors
anchor = classes.GSAnchor()
anchor.name = 'top'
layer.anchors['top'] = anchor
# paths
path = classes.GSPath()
layer.paths.append(path)
# selection: read-only
# LSB, RSB, TSB, BSB: not written
# width
layer.width = 890.4
# leftMetricsKey
layer.leftMetricsKey = "A"
# rightMetricsKey
layer.rightMetricsKey = "A"
# widthMetricsKey
layer.widthMetricsKey = "A"
# bounds: read-only, computed
# selectionBounds: read-only, computed
# background
# FIXME: (jany) why not use a GSLayer like the official doc suggests?
background_layer = classes.GSBackgroundLayer()
layer.background = background_layer
# backgroundImage
image = classes.GSBackgroundImage('/path/to/file.jpg')
layer.backgroundImage = image
# bezierPath: read-only, objective-c
# openBezierPath: read-only, objective-c
# completeOpenBezierPath: read-only, objective-c
# isAligned
# FIXME: (jany) is this read-only?
# is this computed from each component's alignment?
# layer.isAligned = False
# userData
layer.userData['rememberToMakeCoffe'] = True
# smartComponentPoleMapping
layer.smartComponentPoleMapping['crotchDepth'] = 2 # Top pole
layer.smartComponentPoleMapping['shoulderWidth'] = 1 # Bottom pole
self.assertWrites(layer, dedent("""\
{
anchors = (
{
name = top;
}
);
annotations = (
{
position = ;
text = "F**k, this curve is ugly!";
type = 1;
}
);
associatedMasterId = M1;
background = {
};
backgroundImage = {
crop = "{{0, 0}, {0, 0}}";
imagePath = "/path/to/file.jpg";
};
color = 2;
components = (
{
name = glyphName;
}
);
guideLines = (
{
name = xheight;
}
);
hints = (
{
name = hintName;
}
);
layerId = L1;
leftMetricsKey = A;
widthMetricsKey = A;
rightMetricsKey = A;
name = "{125, 100}";
paths = (
{
}
);
userData = {
PartSelection = {
crotchDepth = 2;
shoulderWidth = 1;
};
rememberToMakeCoffe = 1;
};
width = 890.4;
}
"""))
# Don't write a blank layer name
layer.name = ""
written = test_helpers.write_to_lines(layer)
self.assertNotIn('name = "";', written)
def test_write_font_attributes(self):
"""Test the writer on all GSFont attributes"""
font = classes.GSFont()
# List of properties from https://docu.glyphsapp.com/#gsfont
# parent: not handled because it's internal and read-only
# masters
m1 = classes.GSFontMaster()
m1.id = "M1"
font.masters.insert(0, m1)
m2 = classes.GSFontMaster()
m2.id = "M2"
font.masters.insert(1, m2)
# instances
i1 = classes.GSInstance()
i1.name = "MuchBold"
font.instances.append(i1)
# glyphs
g1 = classes.GSGlyph()
g1.name = 'G1'
font.glyphs.append(g1)
# classes
c1 = classes.GSClass()
c1.name = "C1"
font.classes.append(c1)
# features
f1 = classes.GSFeature()
f1.name = "F1"
font.features.append(f1)
# featurePrefixes
fp1 = classes.GSFeaturePrefix()
fp1 = "FP1"
font.featurePrefixes.append(fp1)
# copyright
font.copyright = "Copyright Bob"
# designer
font.designer = "Bob"
# designerURL
font.designerURL = "bob.me"
# manufacturer
font.manufacturer = "Manu"
# manufacturerURL
font.manufacturerURL = "manu.com"
# versionMajor
font.versionMajor = 2
# versionMinor
font.versionMinor = 104
# date
font.date = glyphs_datetime('2017-10-03 07:35:46 +0000')
# familyName
font.familyName = "Sans Rien"
# upm
font.upm = 2000
# note
font.note = "Was bored, made this"
# kerning
font.kerning = OrderedDict([
('M1', OrderedDict([
('@MMK_L_G1', OrderedDict([
('@MMK_R_G1', 0.1)
]))
]))
])
# userData
font.userData = {
'a': 'test',
'b': [1, {'c': 2}],
'd': [1, "1"],
}
# grid -> gridLength
font.grid = 35
# gridSubDivisions
font.gridSubDivisions = 5
# keyboardIncrement
font.keyboardIncrement = 1.2
# disablesNiceNames
font.disablesNiceNames = True
# customParameters
font.customParameters['ascender'] = 300
# selection: not written
# selectedLayers: not written
# selectedFontMaster: not written
# masterIndex: not written
# currentText: not written
# tabs: not written
# currentTab: not written
# filepath: not written
# tool: not written
# tools: not handled because it is a read-only list of GUI features
# .appVersion (extra property that is not in the docs!)
font.appVersion = "895"
self.assertWrites(font, dedent("""\
{
.appVersion = "895";
classes = (
{
code = "";
name = C1;
}
);
copyright = "Copyright Bob";
customParameters = (
{
name = note;
value = "Was bored, made this";
},
{
name = ascender;
value = 300;
}
);
date = "2017-10-03 07:35:46 +0000";
designer = Bob;
designerURL = bob.me;
disablesNiceNames = 1;
familyName = "Sans Rien";
featurePrefixes = (
FP1
);
features = (
{
code = "";
name = F1;
}
);
fontMaster = (
{
ascender = 800;
capHeight = 700;
id = M1;
xHeight = 500;
},
{
ascender = 800;
capHeight = 700;
id = M2;
xHeight = 500;
}
);
glyphs = (
{
glyphname = G1;
}
);
gridLength = 35;
gridSubDivision = 5;
instances = (
{
name = MuchBold;
}
);
kerning = {
M1 = {
"@MMK_L_G1" = {
"@MMK_R_G1" = 0.1;
};
};
};
keyboardIncrement = 1.2;
manufacturer = Manu;
manufacturerURL = manu.com;
unitsPerEm = 2000;
userData = {
a = test;
b = (
1,
{
c = 2;
}
);
d = (
1,
"1"
);
};
versionMajor = 2;
versionMinor = 104;
}
"""))
# Don't write the keyboardIncrement if it's 1 (default)
font.keyboardIncrement = 1
written = test_helpers.write_to_lines(font)
self.assertFalse(any("keyboardIncrement" in line for line in written))
def test_write_glyph(self):
glyph = classes.GSGlyph()
# https://docu.glyphsapp.com/#gsglyph
# parent: not written
# layers
# Put the glyph in a font with at least one master for the magic in
# `glyph.layers.append()` to work.
font = classes.GSFont()
master = classes.GSFontMaster()
master.id = "MASTER-ID"
font.masters.insert(0, master)
font.glyphs.append(glyph)
layer = classes.GSLayer()
layer.layerId = "LAYER-ID"
layer.name = "L1"
glyph.layers.insert(0, layer)
# name
glyph.name = "Aacute"
# unicode
glyph.unicode = "00C1"
# string: not written
# id: not written
# category
glyph.category = "Letter"
# subCategory
glyph.subCategory = "Uppercase"
# script
glyph.script = "latin"
# productionName
glyph.productionName = "Aacute.prod"
# glyphInfo: not written
# leftKerningGroup
glyph.leftKerningGroup = "A"
# rightKerningGroup
glyph.rightKerningGroup = "A"
# leftKerningKey: not written
# rightKerningKey: not written
# leftMetricsKey
glyph.leftMetricsKey = "A"
# rightMetricsKey
glyph.rightMetricsKey = "A"
# widthMetricsKey
glyph.widthMetricsKey = "A"
# export
glyph.export = False
# color
glyph.color = 11
# colorObject: not written
# note
glyph.note = "Stunning one-bedroom A with renovated acute accent"
# selected: not written
# mastersCompatible: not stored
# userData
glyph.userData['rememberToMakeCoffe'] = True
# Check that empty collections are written
glyph.userData['com.someoneelse.coolsoftware.customdata'] = [
OrderedDict([
('zero', 0),
('emptyList', []),
('emptyDict', {}),
('emptyString', ""),
]),
[],
{},
"",
"hey",
0,
1,
]
# smartComponentAxes
axis = classes.GSSmartComponentAxis()
axis.name = "crotchDepth"
glyph.smartComponentAxes.append(axis)
# lastChange
glyph.lastChange = glyphs_datetime('2017-10-03 07:35:46 +0000')
self.assertWrites(glyph, dedent("""\
{
color = 11;
export = 0;
glyphname = Aacute;
lastChange = "2017-10-03 07:35:46 +0000";
layers = (
{
associatedMasterId = "MASTER-ID";
layerId = "LAYER-ID";
name = L1;
width = 0;
}
);
leftKerningGroup = A;
leftMetricsKey = A;
widthMetricsKey = A;
note = "Stunning one-bedroom A with renovated acute accent";
rightKerningGroup = A;
rightMetricsKey = A;
unicode = 00C1;
script = latin;
category = Letter;
subCategory = Uppercase;
userData = {
com.someoneelse.coolsoftware.customdata = (
{
zero = 0;
emptyList = (
);
emptyDict = {
};
emptyString = "";
},
(
),
{
},
"",
hey,
0,
1
);
rememberToMakeCoffe = 1;
};
partsSettings = (
{
name = crotchDepth;
bottomValue = 0;
topValue = 0;
}
);
}
"""))
# Write the script even when it's an empty string
# Same for category and subCategory
glyph.script = ""
glyph.category = ""
glyph.subCategory = ""
written = test_helpers.write_to_lines(glyph)
self.assertIn('script = "";', written)
self.assertIn('category = "";', written)
self.assertIn('subCategory = "";', written)
def test_write_font_master_attributes(self):
"""Test the writer on all GSFontMaster attributes"""
master = classes.GSFontMaster()
# List of properties from https://docu.glyphsapp.com/#gsfontmaster
# id
master.id = "MASTER-ID"
# name
# Cannot set the `name` attribute directly
# master.name = "Hairline Megawide"
master.customParameters['Master Name'] = "Hairline Megawide"
# weight
master.weight = "Thin"
# width
master.width = "Wide"
# weightValue
master.weightValue = 0.01
# widthValue
master.widthValue = 0.99
# customValue
# customName
master.customName = "cuteness"
# A value of 0.0 is not written to the file.
master.customValue = 0.001
master.customName1 = "color"
master.customValue1 = 0.1
master.customName2 = "depth"
master.customValue2 = 0.2
master.customName3 = "surealism"
master.customValue3 = 0.3
# ascender
master.ascender = 234.5
# capHeight
master.capHeight = 200.6
# xHeight
master.xHeight = 59.1
# descender
master.descender = -89.2
# italicAngle
master.italicAngle = 12.2
# verticalStems
master.verticalStems = [1, 2, 3]
# horizontalStems
master.horizontalStems = [4, 5, 6]
# alignmentZones
zone = classes.GSAlignmentZone(0, -30)
master.alignmentZones = [
zone
]
# blueValues: not handled because it is read-only
# otherBlues: not handled because it is read-only
# guides
guide = classes.GSGuideLine()
guide.name = "middle"
master.guides.append(guide)
# userData
master.userData['rememberToMakeTea'] = True
# customParameters
master.customParameters['underlinePosition'] = -135
self.assertWrites(master, dedent("""\
{
alignmentZones = (
"{0, -30}"
);
ascender = 234.5;
capHeight = 200.6;
custom = cuteness;
customValue = 0.001;
custom1 = color;
customValue1 = 0.1;
custom2 = depth;
customValue2 = 0.2;
custom3 = surealism;
customValue3 = 0.3;
customParameters = (
{
name = "Master Name";
value = "Hairline Megawide";
},
{
name = underlinePosition;
value = -135;
}
);
descender = -89.2;
guideLines = (
{
name = middle;
}
);
horizontalStems = (
4,
5,
6
);
id = "MASTER-ID";
italicAngle = 12.2;
name = "Hairline Megawide";
userData = {
rememberToMakeTea = 1;
};
verticalStems = (
1,
2,
3
);
weight = Thin;
weightValue = 0.01;
width = Wide;
widthValue = 0.99;
xHeight = 59.1;
}
"""))
# Write the capHeight and xHeight even if they are "0"
master.xHeight = 0
master.capHeight = 0
written = test_helpers.write_to_lines(master)
self.assertIn("xHeight = 0;", written)
self.assertIn("capHeight = 0;", written)
