Class: CustomPrinter

Inherits:
REXML::Formatters::Pretty
  • Object
show all
Defined in:
lib/terrestrial/cli/editor/custom_printer.rb

Overview

Common fixes for editors that use REXML

Instance Method Summary collapse

Instance Method Details

#write_element(elm, out) ⇒ Object

Custom sorting of Storyboard element attributes. In order to prevent massive diffs in Storyboard files after flight, we need to try to match the Xcode XML generator as closely as possible.

One big issue is the ordering of XML element attributes. Here we attempt to match the attribute ordering for each type of Storyboard element.



13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/terrestrial/cli/editor/custom_printer.rb', line 13

def write_element(elm, out)
  att = elm.attributes

  class <<att
    # Alias old method 
    alias _each_attribute each_attribute

    # Redefine the each_attribute method to call our sorting
    # method
    def each_attribute(&b)
      to_enum(:_each_attribute)
        .sort_by {|x| xcode_index_for(x) }
        .each(&b)
    end

    def _xcode_get_index(order, attr)
      order.index(attr.name) || attr.name.length
    end

    # Define the order for each type of Xcode element
    def xcode_index_for(attr)
      element_type = attr.element.name
      
      case element_type
      when 'userDefinedRuntimeAttribute'
        index = _xcode_get_index(['type','keyPath','value'], attr)
      when 'color'
        index = _xcode_get_index(['key', 'red', 'green', 'blue', 'white', 'alpha', 'colorSpace', 
                                  'customColorSpace'], attr)
      when 'placeholder'
        index = _xcode_get_index(['placeholderIdentifier', 'id', 'userLabel', 'sceneMemberID'], attr)
      when 'fontDescription'
        index = _xcode_get_index(['key', 'type', 'name', 'family', 'pointSize'], attr)
      when 'rect'
        index = _xcode_get_index(['key', 'x', 'y', 'width', 'height'], attr)
      when 'label'
        index = _xcode_get_index(['opaque', 'multipleTouchEnabled', 'userInteractionEnabled', 'contentMode', 
                                  'horizontalHuggingPriority', 'verticalHuggingPriority', 'text',
                                  'misplaced', 'textAlignment', 'lineBreakMode', 'numberOfLines', 
                                  'baselineAdjustment', 'adjustsFontSizeToFit', 'minimumScaleFactor', 
                                  'translatesAutoresizingMaskIntoConstraints', 'id', 
                                  'customClass'], attr)
      when 'button'
        index = _xcode_get_index(['opaque', 'contentMode', 'contentHorizontalAlignment', 
                                  'contentVerticalAlignment', 'buttonType', 'lineBreakMode', 
                                  'id'], attr)
      when 'viewController'
        index = _xcode_get_index(['storyboardIdentifier', 'id', 'customClass', 'customModule', 
                 'customModuleProvider', 'sceneMemberID'], attr)
      when 'viewControllerLayoutGuide'
        index = _xcode_get_index(['type', 'id'], attr)
      when 'view'
        index = _xcode_get_index(['autoresizesSubviews','clipsSubviews', 'alpha', 'key', 
                                  'contentMode', 'id'], attr)
      when 'autoresizingMask'
        index = _xcode_get_index(['key', 'flexibleMaxX', 'flexibleMaxY', 'widthSizable', 
                                  'heightSizable'], attr)
      when 'document'
        index = _xcode_get_index(['type', 'version', 'toolsVersion', 'systemVersion', 
                                  'targetRuntime', 'propertyAccessControl', 'useAutolayout', 
                                  'useTraitCollections', 'initialViewController'], attr)
      when 'document'
        index = _xcode_get_index(['type', 'version', 'toolsVersion', 'systemVersion', 
                                  'targetRuntime', 'propertyAccessControl', 'useAutolayout', 
                                  'useTraitCollections', 'initialViewController'], attr)
      when 'image'
        index = _xcode_get_index(['name', 'width', 'height'], attr)
      when 'imageView'
        index = _xcode_get_index(['clipsSubviews', 'userInteractionEnabled', 'alpha', 
                                  'contentMode', 'horizontalHuggingPriority', 
                                  'verticalHuggingPriority', 'image', 'id'], attr)
      when 'segue'
        index = _xcode_get_index(['destination', 'kind', 'relationship', 'id'], attr)
      when 'navigationBar'
        index = _xcode_get_index(['key', 'contentMode', 'id'], attr)
      when 'navigationItem'
        index = _xcode_get_index(['key', 'title', 'id'], attr)
      when 'navigationController'
        index = _xcode_get_index(['storyboardIdentifier', 'automaticallyAdjustsScrollViewInsets', 
                                  'id', 'sceneMemberID'], attr)
      when 'outlet'
        index = _xcode_get_index(['property', 'destination', 'id'], attr)
      when 'action'
        index = _xcode_get_index(['selector', 'destination', 'id'], attr)
      when 'barButtonItem'
        index = _xcode_get_index(['key', 'title', 'id'], attr)
      when 'tableViewController'
        index = _xcode_get_index(['restorationIdentifier', 'storyboardIdentifier', 'id', 
                                  'customClass', 'sceneMemberID'], attr)
      when 'tableView'
        index = _xcode_get_index(['key', 'clipsSubviews', 'contentMode', 'alwaysBounceVertical', 
                                  'dataMode', 'style', 'separatorStyle', 'rowHeight', 
                                  'sectionHeaderHeight', 'sectionFooterHeight', 'id'], attr)
      when 'tableViewCellContentView'
        index = _xcode_get_index(['key', 'opaque', 'clipsSubviews', 'multipleTouchEnabled', 
                                  'contentMode', 'tableViewCell', 'id'], attr)
      when 'tableViewCell'
        index = _xcode_get_index(['key', 'opaque', 'clipsSubviews', 'multipleTouchEnabled', 
                                  'contentMode', 'selectionStyle', 'accessoryType', 'indentationWidth', 
                                  'textLabel', 'detailTextLabel', 'rowHeight', 'style', 'id'], attr)
      when 'size'
        index = _xcode_get_index(['key', 'width', 'height'], attr)
      when 'textField'
        index = _xcode_get_index(['opaque', 'clipsSubviews', 'contentMode', 'contentHorizontalAlignment', 
                                  'contentVerticalAlignment', 'text', 'borderStyle', 'placeholder', 
                                  'textAlignment', 'minimumFontSize', 'id'], attr)
      else
        index = attr.name
      end
      index
    end
  end
  super(elm, out)
end

#write_text(node, output) ⇒ Object

This genious is here to stop the damn thing from wrapping lines over 80 chars long >.<

Source:

http://stackoverflow.com/questions/4203180/rexml-is-wrapping-long-lines-how-do-i-switch-that-off



134
135
136
137
138
139
140
141
142
143
 
# File 'lib/terrestrial/cli/editor/custom_printer.rb', line 134

def write_text( node, output )
  s = node.to_s()

  #The Pretty formatter code mistakenly used 80 instead of the @width variable
  #s = wrap(s, 80-@level)
  s = wrap(s, @width-@level)

  s = indent_text(s, @level, " ", true)
  output << (' '*@level + s)
end