usps_flags 0.5.0 → 0.5.1

data/lib/usps_flags/helpers/builders.rb

@@ -4,105 +4,112 @@
 #
 # These methods should never need to be called directly, except when designing new flags.
 # @private
-class USPSFlags::Helpers::Builders
-  class << self
-    # Displays an overlay grid with regularly spaced locator markers.
-    #
-    # This is useful for adjusting or creating new SVG data generators, but should not otherwise need to be called.
-    # @private
-    def grid(width: USPSFlags::Config::BASE_FLY, height: USPSFlags::Config::BASE_HOIST)
-      @width = width
-      @height = height
-      @stroke_width = @width / 600
-      "#{circles}#{horizontal_lines}#{vertical_lines}#{diagonal_lines}"
-    end
+class USPSFlags
+  class Helpers
+    class Builders
+      class << self
+        # Displays an overlay grid with regularly spaced locator markers.
+        #
+        # This is useful for adjusting or creating new SVG data generators, but should not otherwise need to be called.
+        # @private
+        def grid(width: USPSFlags::Config::BASE_FLY, height: USPSFlags::Config::BASE_HOIST)
+          @width = width
+          @height = height
+          @stroke_width = @width / 600
+          "#{circles}#{horizontal_lines}#{vertical_lines}#{diagonal_lines}"
+        end
 
-    # Displays an overlay indicator of concentric circles and radiating lines.
-    #
-    # This is useful for adjusting or creating new SVG data generators, but should not otherwise need to be called.
-    # @private
-    def locator
-      <<~SVG
-        <circle cx="0" cy="0" r="#{USPSFlags::Config::BASE_FLY * 2}" fill="#000000" fill-opacity="0.4" />
-        <circle cx="0" cy="0" r="#{USPSFlags::Config::BASE_FLY}" fill="#333333" fill-opacity="0.4" />
-        <circle cx="0" cy="0" r="#{USPSFlags::Config::BASE_FLY / 2}" fill="#666666" fill-opacity="0.4" />
-        <circle cx="0" cy="0" r="#{USPSFlags::Config::BASE_FLY / 4}" fill="#999999" fill-opacity="0.4" />
-        <circle cx="0" cy="0" r="#{USPSFlags::Config::BASE_FLY / 8}" fill="#CCCCCC" fill-opacity="0.4" />
-        <circle cx="0" cy="0" r="#{USPSFlags::Config::BASE_FLY / 16}" fill="#FFFFFF" fill-opacity="0.4" />
+        # Displays an overlay indicator of concentric circles and radiating lines.
+        #
+        # This is useful for adjusting or creating new SVG data generators, but should not otherwise need to be called.
+        # @private
+        def locator
+          <<~SVG
+            <circle cx="0" cy="0" r="#{USPSFlags::Config::BASE_FLY * 2}" fill="#000000" fill-opacity="0.4" />
+            <circle cx="0" cy="0" r="#{USPSFlags::Config::BASE_FLY}" fill="#333333" fill-opacity="0.4" />
+            <circle cx="0" cy="0" r="#{USPSFlags::Config::BASE_FLY / 2}" fill="#666666" fill-opacity="0.4" />
+            <circle cx="0" cy="0" r="#{USPSFlags::Config::BASE_FLY / 4}" fill="#999999" fill-opacity="0.4" />
+            <circle cx="0" cy="0" r="#{USPSFlags::Config::BASE_FLY / 8}" fill="#CCCCCC" fill-opacity="0.4" />
+            <circle cx="0" cy="0" r="#{USPSFlags::Config::BASE_FLY / 16}" fill="#FFFFFF" fill-opacity="0.4" />
 
-        <line x1="-#{USPSFlags::Config::BASE_FLY}" y1="-#{USPSFlags::Config::BASE_HOIST}" x2="#{USPSFlags::Config::BASE_FLY}" y2="#{USPSFlags::Config::BASE_HOIST}"  stroke="#FFFFFF" stroke-width="#{USPSFlags::Config::BASE_FLY / 600}" />
-        <line x1="-#{USPSFlags::Config::BASE_FLY}" y1="#{USPSFlags::Config::BASE_HOIST}" x2="#{USPSFlags::Config::BASE_FLY}" y2="-#{USPSFlags::Config::BASE_HOIST}" stroke="#FFFFFF" stroke-width="#{USPSFlags::Config::BASE_FLY / 600}" />
-        <line x1="0" y1="#{USPSFlags::Config::BASE_HOIST}" x2="0" y2="-#{USPSFlags::Config::BASE_HOIST}" stroke="#FFFFFF" stroke-width="#{USPSFlags::Config::BASE_FLY / 600}" />
-        <line x1="-#{USPSFlags::Config::BASE_FLY}" y1="0" x2="#{USPSFlags::Config::BASE_FLY}" y2="0" stroke="#FFFFFF" stroke-width="#{USPSFlags::Config::BASE_FLY / 600}" />
+            <line x1="-#{USPSFlags::Config::BASE_FLY}" y1="-#{USPSFlags::Config::BASE_HOIST}" x2="#{USPSFlags::Config::BASE_FLY}" y2="#{USPSFlags::Config::BASE_HOIST}"  stroke="#FFFFFF" stroke-width="#{USPSFlags::Config::BASE_FLY / 600}" />
+            <line x1="-#{USPSFlags::Config::BASE_FLY}" y1="#{USPSFlags::Config::BASE_HOIST}" x2="#{USPSFlags::Config::BASE_FLY}" y2="-#{USPSFlags::Config::BASE_HOIST}" stroke="#FFFFFF" stroke-width="#{USPSFlags::Config::BASE_FLY / 600}" />
+            <line x1="0" y1="#{USPSFlags::Config::BASE_HOIST}" x2="0" y2="-#{USPSFlags::Config::BASE_HOIST}" stroke="#FFFFFF" stroke-width="#{USPSFlags::Config::BASE_FLY / 600}" />
+            <line x1="-#{USPSFlags::Config::BASE_FLY}" y1="0" x2="#{USPSFlags::Config::BASE_FLY}" y2="0" stroke="#FFFFFF" stroke-width="#{USPSFlags::Config::BASE_FLY / 600}" />
 
-        <rect x="0" y="0" width="#{USPSFlags::Config::BASE_FLY / 30}" height="#{USPSFlags::Config::BASE_FLY / 30}" fill="#333333" fill-opacity="0.6" />
-      SVG
-    end
+            <rect x="0" y="0" width="#{USPSFlags::Config::BASE_FLY / 30}" height="#{USPSFlags::Config::BASE_FLY / 30}" fill="#333333" fill-opacity="0.6" />
+          SVG
+        end
 
-  private
+      private
 
-    def circles
-      <<~SVG
-        #{pos_circle(0, 0)}
-        #{pos_circle(@width, 0)}
-        #{pos_circle(@width, @height)}
-        #{pos_circle(0, @height)}
-        <circle cx="#{@width * 1 / 4}" cy="#{@height / 2}" r="#{@width / 60}" fill="#999999" fill-opacity="0.4" />
-        <circle cx="#{@width * 3 / 4}" cy="#{@height / 2}" r="#{@width / 60}" fill="#999999" fill-opacity="0.4" />
-        #{radial_circles}
-      SVG
-    end
+        def circles
+          <<~SVG
+            #{pos_circle(0, 0)}
+            #{pos_circle(@width, 0)}
+            #{pos_circle(@width, @height)}
+            #{pos_circle(0, @height)}
+            <circle cx="#{@width * 1 / 4}" cy="#{@height / 2}" r="#{@width / 60}" fill="#999999" fill-opacity="0.4" />
+            <circle cx="#{@width * 3 / 4}" cy="#{@height / 2}" r="#{@width / 60}" fill="#999999" fill-opacity="0.4" />
+            #{radial_circles}
+          SVG
+        end
 
-    def radial_circles
-      <<~SVG
-        #{radial_circle(1, @width / 60)}
-        #{radial_circle(2, @width / 60)}
-        #{radial_circle(2, @width / 75)}
-        #{radial_circle(2, @width / 100)}
-        #{radial_circle(3, @width / 60)}
-      SVG
-    end
+        def radial_circles
+          <<~SVG
+            #{radial_circle(1, @width / 60)}
+            #{radial_circle(2, @width / 60)}
+            #{radial_circle(2, @width / 75)}
+            #{radial_circle(2, @width / 100)}
+            #{radial_circle(3, @width / 60)}
+          SVG
+        end
 
-    def pos_circle(cx, cy)
-      <<~SVG
-        <circle cx="#{cx}" cy="#{cy}" r="#{@width / 60}" fill="#000000" fill-opacity="0.4" />
-      SVG
-    end
+        def pos_circle(cx, cy)
+          <<~SVG
+            <circle cx="#{cx}" cy="#{cy}" r="#{@width / 60}" fill="#000000" fill-opacity="0.4" />
+          SVG
+        end
 
-    def radial_circle(index, radius)
-      <<~SVG
-        <circle cx="#{@width / 2}" cy="#{@height * index / 4}" r="#{radius}"  fill="#999999" fill-opacity="0.4" />
-      SVG
-    end
+        def radial_circle(index, radius)
+          <<~SVG
+            <circle cx="#{@width / 2}" cy="#{@height * index / 4}" r="#{radius}"  fill="#999999" fill-opacity="0.4" />
+          SVG
+        end
 
-    def horizontal_lines
-      (0..4).map { |index| horizontal_line(index) }.join
-    end
+        def horizontal_lines
+          (0..4).map { |index| horizontal_line(index) }.join
+        end
 
-    def horizontal_line(index)
-      <<~SVG
-        <line x1="0" y1="#{@height * index / 4}" x2="#{@width}" y2="#{@height * index / 4}" stroke="#333333" stroke-width="#{@stroke_width}" stroke-opacity="0.5" />
-      SVG
-    end
+        def horizontal_line(index)
+          <<~SVG
+            <line x1="0" y1="#{@height * index / 4}" x2="#{@width}" y2="#{@height * index / 4}" stroke="#333333" stroke-width="#{@stroke_width}" stroke-opacity="0.5" />
+          SVG
+        end
 
-    def vertical_lines
-      (0..6).map { |index| vertical_line(index) }.join
-    end
+        def vertical_lines
+          (0..6).map { |index| vertical_line(index) }.join
+        end
 
-    def vertical_line(index)
-      <<~SVG
-        <line y1="0" x1="#{@width * index / 6}" y2="#{@height}" x2="#{@width * index / 6}" stroke="#333333" stroke-width="#{@stroke_width}" stroke-opacity="0.5" />
-      SVG
-    end
+        def vertical_line(index)
+          <<~SVG
+            <line y1="0" x1="#{@width * index / 6}" y2="#{@height}" x2="#{@width * index / 6}" stroke="#333333" stroke-width="#{@stroke_width}" stroke-opacity="0.5" />
+          SVG
+        end
 
-    def diagonal_lines
-      "#{diagonal_line(2, 1, 3, 2)}#{diagonal_line(3, 2, 2, 3)}#{diagonal_line(2, 3, 1, 2)}#{diagonal_line(1, 2, 2, 1)}"
-    end
+        def diagonal_lines
+          diagonal_line(2, 1, 3, 2) +
+            diagonal_line(3, 2, 2, 3) +
+            diagonal_line(2, 3, 1, 2) +
+            diagonal_line(1, 2, 2, 1)
+        end
 
-    def diagonal_line(a, b, c, d)
-      <<~SVG
-        <line x1="#{@width * a / 4}" y1="#{@height * b / 4}" x2="#{@width * c / 4}" y2="#{@height * d / 4}" stroke="#999999" stroke-width="#{@stroke_width}" stroke-opacity="0.5" />
-      SVG
+        def diagonal_line(a, b, c, d)
+          <<~SVG
+            <line x1="#{@width * a / 4}" y1="#{@height * b / 4}" x2="#{@width * c / 4}" y2="#{@height * d / 4}" stroke="#999999" stroke-width="#{@stroke_width}" stroke-opacity="0.5" />
+          SVG
+        end
+      end
     end
   end
 end

data/lib/usps_flags/helpers/spec_arrows.rb

@@ -4,130 +4,134 @@
 #
 # These methods should never need to be called directly.
 # @private
-class USPSFlags::Helpers::SpecArrows
-  class << self
-    # Creates a vertical arrow for the trident spec sheet.
-    #
-    # This is used USPSFlags::Core.trident_spec, and should never need to be called directly.
-    # @private
-    def vertical(x, top, bottom, **options)
-      options = defaults.merge(options)
-
-      load_common_config(options[:fly])
-      label, label_fraction = get_labels(bottom, top)
-      options = options.merge(x: x, top: top, bottom: bottom, label: label, label_fraction: label_fraction)
-
-      vertical_svg_group(options)
-    end
-
-    # Creates a horizontal arrow for the trident spec sheet.
-    #
-    # This is used USPSFlags::Core.trident_spec, and should never need to be called directly.
-    # @private
-    def horizontal(y, left, right, **options)
-      options = defaults(:h).merge(options)
-
-      load_common_config(options[:fly])
-      label, label_fraction = get_labels(right, left)
-      options = options.merge(y: y, left: left, right: right, label: label, label_fraction: label_fraction)
-
-      horizontal_svg_group(options)
-    end
-
-  private
-
-    def defaults(mode = :v)
-      {
-        pointer_top: nil, pointer_bottom: nil, pointer_left: nil, pointer_right: nil, fly: nil,
-        unit: nil, label_offset: (USPSFlags::Config::BASE_FLY / (mode == :v ? 120 : 45)),
-        label_offset_x: 0, label_offset_y: 0, label_align: (mode == :v ? 'left' : 'middle')
-      }
-    end
-
-    def vertical_svg_group(options)
-      svg = +''
-      svg << arrow_pointer(options) unless options[:pointer_top].nil?
-      svg << arrow_pointer(options) unless options[:pointer_bottom].nil?
-      svg << vertical_svg(options)
-      svg
-    end
-
-    def vertical_svg(options)
-      <<~SVG
-        <path d="#{vertical_svg_path(options)}" fill="none" />
-        <g>
-          <style><![CDATA[tspan{font-size: #{USPSFlags::Config::FRACTION_SCALE}%;}]]></style>
-          #{vertical_svg_text(options)}
-        </g>
-      SVG
-    end
-
-    def vertical_svg_path(options)
-      <<~SVG
-        M#{options[:x]} #{options[:top]} l #{@arrow_size} #{@arrow_size} M#{options[:x]} #{options[:top]} l -#{@arrow_size} #{@arrow_size} M#{options[:x]} #{options[:top]} l 0 #{options[:bottom] - options[:top]} l #{@arrow_size} -#{@arrow_size} M#{options[:x]} #{options[:bottom]} l -#{@arrow_size} -#{@arrow_size}" stroke="#{@color}" stroke-width="#{@stroke_width}
-      SVG
-    end
-
-    def vertical_svg_text(options)
-      <<~SVG
-        <text x="#{options[:x] + options[:label_offset]}" y="#{(options[:top] + options[:bottom]) / 2 + (USPSFlags::Config::BASE_HOIST / 150) + options[:label_offset_y]}" font-family="sans-serif" font-size="#{@font_size}px" fill="#041E42" text-anchor="#{options[:label_align]}">#{options[:label]} <tspan>#{options[:label_fraction]}</tspan> #{options[:unit]}</text>
-      SVG
-    end
-
-    def horizontal_svg_group(options)
-      svg = +''
-      svg << arrow_pointer(options) unless options[:pointer_left].nil?
-      svg << arrow_pointer(options) unless options[:pointer_right].nil?
-      svg << horizontal_svg(options)
-      svg
-    end
-
-    def horizontal_svg(options)
-      <<~SVG
-        <path d="#{horizontal_svg_path(options)}" stroke="#{@color}" stroke-width="#{@stroke_width}" fill="none" />
-        <g>
-          <style><![CDATA[tspan{font-size: #{USPSFlags::Config::FRACTION_SCALE}%;}]]></style>
-          #{horizontal_svg_text(options)}
-        </g>
-      SVG
-    end
-
-    def horizontal_svg_path(options)
-      <<~SVG
-        M#{options[:left]} #{options[:y]} l #{@arrow_size} #{@arrow_size} M#{options[:left]} #{options[:y]} l #{@arrow_size} -#{@arrow_size} M#{options[:left]} #{options[:y]} l #{options[:right] - options[:left]} 0 l -#{@arrow_size} -#{@arrow_size} M#{options[:right]} #{options[:y]} l -#{@arrow_size} #{@arrow_size}
-      SVG
-    end
-
-    def horizontal_svg_text(options)
-      <<~SVG
-        <text x="#{(options[:left] + options[:right]) / 2 + options[:label_offset_x]}" y="#{options[:y] + options[:label_offset]}" font-family="sans-serif" font-size="#{@font_size}px" fill="#041E42" text-anchor="#{options[:label_align]}">#{options[:label]} <tspan>#{options[:label_fraction]}</tspan> #{options[:unit]}</text>
-      SVG
-    end
-
-    def load_common_config(fly)
-      @color = '#CCCCCC'
-      @stroke_width = (USPSFlags::Config::BASE_FLY / 600)
-      @stroke_dash = '10, 10'
-      @font_size = (USPSFlags::Config::BASE_FLY / 60)
-      @arrow_size = (USPSFlags::Config::BASE_FLY / 120)
-      @fly = fly || USPSFlags::Config::BASE_FLY
-    end
-
-    def arrow_pointer(options)
-      <<~SVG
-        <line x1="#{options[:x1]}" y1="#{options[:y1]}" x2="#{options[:x2]}" y2="#{options[:y2]}" stroke="#{@color}" stroke-width="#{@stroke_width}" stroke-dasharray="#{@stroke_dash}" />
-      SVG
-    end
-
-    def get_labels(a, b)
-      label = (a - b) * Rational(@fly, USPSFlags::Config::BASE_FLY)
-      if label == label.to_i
-        label = label.to_i
-        label_fraction = ''
-      else
-        label, label_fraction = label.to_simplified_a
+class USPSFlags
+  class Helpers
+    class SpecArrows
+      class << self
+        # Creates a vertical arrow for the trident spec sheet.
+        #
+        # This is used USPSFlags::Core.trident_spec, and should never need to be called directly.
+        # @private
+        def vertical(x, top, bottom, **options)
+          options = defaults.merge(options)
+
+          load_common_config(options[:fly])
+          label, label_fraction = get_labels(bottom, top)
+          options = options.merge(x: x, top: top, bottom: bottom, label: label, label_fraction: label_fraction)
+
+          vertical_svg_group(options)
+        end
+
+        # Creates a horizontal arrow for the trident spec sheet.
+        #
+        # This is used USPSFlags::Core.trident_spec, and should never need to be called directly.
+        # @private
+        def horizontal(y, left, right, **options)
+          options = defaults(:h).merge(options)
+
+          load_common_config(options[:fly])
+          label, label_fraction = get_labels(right, left)
+          options = options.merge(y: y, left: left, right: right, label: label, label_fraction: label_fraction)
+
+          horizontal_svg_group(options)
+        end
+
+      private
+
+        def defaults(mode = :v)
+          {
+            pointer_top: nil, pointer_bottom: nil, pointer_left: nil, pointer_right: nil, fly: nil,
+            unit: nil, label_offset: (USPSFlags::Config::BASE_FLY / (mode == :v ? 120 : 45)),
+            label_offset_x: 0, label_offset_y: 0, label_align: (mode == :v ? 'left' : 'middle')
+          }
+        end
+
+        def vertical_svg_group(options)
+          svg = +''
+          svg << arrow_pointer(options) unless options[:pointer_top].nil?
+          svg << arrow_pointer(options) unless options[:pointer_bottom].nil?
+          svg << vertical_svg(options)
+          svg
+        end
+
+        def vertical_svg(options)
+          <<~SVG
+            <path d="#{vertical_svg_path(options)}" fill="none" />
+            <g>
+              <style><![CDATA[tspan{font-size: #{USPSFlags::Config::FRACTION_SCALE}%;}]]></style>
+              #{vertical_svg_text(options)}
+            </g>
+          SVG
+        end
+
+        def vertical_svg_path(options)
+          <<~SVG
+            M#{options[:x]} #{options[:top]} l #{@arrow_size} #{@arrow_size} M#{options[:x]} #{options[:top]} l -#{@arrow_size} #{@arrow_size} M#{options[:x]} #{options[:top]} l 0 #{options[:bottom] - options[:top]} l #{@arrow_size} -#{@arrow_size} M#{options[:x]} #{options[:bottom]} l -#{@arrow_size} -#{@arrow_size}" stroke="#{@color}" stroke-width="#{@stroke_width}
+          SVG
+        end
+
+        def vertical_svg_text(options)
+          <<~SVG
+            <text x="#{options[:x] + options[:label_offset]}" y="#{(options[:top] + options[:bottom]) / 2 + (USPSFlags::Config::BASE_HOIST / 150) + options[:label_offset_y]}" font-family="sans-serif" font-size="#{@font_size}px" fill="#041E42" text-anchor="#{options[:label_align]}">#{options[:label]} <tspan>#{options[:label_fraction]}</tspan> #{options[:unit]}</text>
+          SVG
+        end
+
+        def horizontal_svg_group(options)
+          svg = +''
+          svg << arrow_pointer(options) unless options[:pointer_left].nil?
+          svg << arrow_pointer(options) unless options[:pointer_right].nil?
+          svg << horizontal_svg(options)
+          svg
+        end
+
+        def horizontal_svg(options)
+          <<~SVG
+            <path d="#{horizontal_svg_path(options)}" stroke="#{@color}" stroke-width="#{@stroke_width}" fill="none" />
+            <g>
+              <style><![CDATA[tspan{font-size: #{USPSFlags::Config::FRACTION_SCALE}%;}]]></style>
+              #{horizontal_svg_text(options)}
+            </g>
+          SVG
+        end
+
+        def horizontal_svg_path(options)
+          <<~SVG
+            M#{options[:left]} #{options[:y]} l #{@arrow_size} #{@arrow_size} M#{options[:left]} #{options[:y]} l #{@arrow_size} -#{@arrow_size} M#{options[:left]} #{options[:y]} l #{options[:right] - options[:left]} 0 l -#{@arrow_size} -#{@arrow_size} M#{options[:right]} #{options[:y]} l -#{@arrow_size} #{@arrow_size}
+          SVG
+        end
+
+        def horizontal_svg_text(options)
+          <<~SVG
+            <text x="#{(options[:left] + options[:right]) / 2 + options[:label_offset_x]}" y="#{options[:y] + options[:label_offset]}" font-family="sans-serif" font-size="#{@font_size}px" fill="#041E42" text-anchor="#{options[:label_align]}">#{options[:label]} <tspan>#{options[:label_fraction]}</tspan> #{options[:unit]}</text>
+          SVG
+        end
+
+        def load_common_config(fly)
+          @color = '#CCCCCC'
+          @stroke_width = (USPSFlags::Config::BASE_FLY / 600)
+          @stroke_dash = '10, 10'
+          @font_size = (USPSFlags::Config::BASE_FLY / 60)
+          @arrow_size = (USPSFlags::Config::BASE_FLY / 120)
+          @fly = fly || USPSFlags::Config::BASE_FLY
+        end
+
+        def arrow_pointer(options)
+          <<~SVG
+            <line x1="#{options[:x1]}" y1="#{options[:y1]}" x2="#{options[:x2]}" y2="#{options[:y2]}" stroke="#{@color}" stroke-width="#{@stroke_width}" stroke-dasharray="#{@stroke_dash}" />
+          SVG
+        end
+
+        def get_labels(a, b)
+          label = (a - b) * Rational(@fly, USPSFlags::Config::BASE_FLY)
+          if label == label.to_i
+            label = label.to_i
+            label_fraction = ''
+          else
+            label, label_fraction = USPSFlags::Rational.new(label).to_simplified_a
+          end
+          [label, label_fraction]
+        end
       end
-      [label, label_fraction]
     end
   end
 end