usps_flags 0.1.17

data/lib/usps_flags/helpers.rb

@@ -0,0 +1,248 @@
+# Container class for helper methods.
+class USPSFlags::Helpers
+  # Valid options for flag generation.
+  #
+  # @param [Symbol] type Specify subset of flags.
+  # @option type [Symbol] :all All flags
+  # @option type [Symbol] :officer Officer flags
+  # @option type [Symbol] :insignia Insignia-eligible officer flags (no past officers)
+  # @option type [Symbol] :squadron Squadron-level officer flags
+  # @option type [Symbol] :district District-level officer flags
+  # @option type [Symbol] :national National-level officer flags
+  # @option type [Symbol] :special Special flags
+  # @option type [Symbol] :us US flag
+  # @return [Array] Valid options for flag generation (based on the provided type).
+  def self.valid_flags(type = :all)
+    squadron = %w[
+      PLTC
+      PC
+      PORTCAP
+      FLEETCAP
+      LT
+      FLT
+      1LT
+      LTC
+      CDR
+    ]
+
+    district = %w[
+      PDLTC
+      PDC
+      DLT
+      DAIDE
+      DFLT
+      D1LT
+      DLTC
+      DC
+    ]
+
+    national = %w[
+      PSTFC
+      PRC
+      PVC
+      PCC
+      NAIDE
+      NFLT
+      STFC
+      RC
+      VC
+      CC
+    ]
+
+    past = %w[
+      PLTC
+      PC
+      PDLTC
+      PDC
+      PSTFC
+      PRC
+      PVC
+      PCC
+    ]
+
+    special = %w[
+      CRUISE
+      OIC
+      ENSIGN
+      WHEEL
+    ]
+
+    us = %w[
+      US
+    ]
+
+    case type
+    when :all
+      squadron + district + national + special + us
+    when :officer
+      squadron + district + national
+    when :insignia
+      squadron + district + national - past
+    when :squadron
+      squadron
+    when :district
+      district
+    when :national
+      national
+    when :special
+      special
+    when :us
+      us
+    end
+  end
+
+  # 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 self.grid(width: USPSFlags::Config::BASE_FLY, height: USPSFlags::Config::BASE_HOIST)
+    <<~SVG
+      <circle cx="0" cy="0" r="#{width/60}" fill="#000000" fill-opacity="0.4" />
+      <circle cx="#{width}" cy="0" r="#{width/60}" fill="#000000" fill-opacity="0.4" />
+      <circle cx="#{width}" cy="#{height}" r="#{width/60}" fill="#000000" fill-opacity="0.4" />
+      <circle cx="0" cy="#{height}" r="#{width/60}" fill="#000000" fill-opacity="0.4" />
+
+      <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" />
+
+      <circle cx="#{width/2}" cy="#{height*1/4}" r="#{width/60}"  fill="#999999" fill-opacity="0.4" />
+      <circle cx="#{width/2}" cy="#{height/2}" r="#{width/60}"  fill="#000000" fill-opacity="0.4" />
+      <circle cx="#{width/2}" cy="#{height/2}" r="#{width/75}"  fill="#CCCCCC" fill-opacity="0.4" />
+      <circle cx="#{width/2}" cy="#{height/2}" r="#{width/100}" fill="#000000" fill-opacity="0.4" />
+      <circle cx="#{width/2}" cy="#{height*3/4}" r="#{width/60}"  fill="#999999" fill-opacity="0.4" />
+
+      <line x1="0" y1="0" x2="#{width}" y2="0" stroke="#333333" stroke-width="#{width/600}" stroke-opacity="0.5" />
+      <line x1="0" y1="#{height*1/4}" x2="#{width}" y2="#{height*1/4}" stroke="#333333" stroke-width="#{width/600}" stroke-opacity="0.5" />
+      <line x1="0" y1="#{height/2}" x2="#{width}" y2="#{height/2}" stroke="#333333" stroke-width="#{width/600}" stroke-opacity="0.5" />
+      <line x1="0" y1="#{height*3/4}" x2="#{width}" y2="#{height*3/4}" stroke="#333333" stroke-width="#{width/600}" stroke-opacity="0.5" />
+      <line x1="0" y1="#{height}" x2="#{width}" y2="#{height}" stroke="#333333" stroke-width="#{width/600}" stroke-opacity="0.5" />
+
+      <line y1="0" x1="0" y2="#{height}" x2="0" stroke="#333333" stroke-width="#{width/600}" stroke-opacity="0.5" />
+      <line y1="0" x1="#{width*1/6}" y2="#{height}" x2="#{width*1/6}" stroke="#333333" stroke-width="#{width/600}" stroke-opacity="0.5" />
+      <line y1="0" x1="#{width*2/6}" y2="#{height}" x2="#{width*2/6}" stroke="#333333" stroke-width="#{width/600}" stroke-opacity="0.5" />
+      <line y1="0" x1="#{width*3/6}" y2="#{height}" x2="#{width*3/6}" stroke="#333333" stroke-width="#{width/600}" stroke-opacity="0.5" />
+      <line y1="0" x1="#{width*4/6}" y2="#{height}" x2="#{width*4/6}" stroke="#333333" stroke-width="#{width/600}" stroke-opacity="0.5" />
+      <line y1="0" x1="#{width*5/6}" y2="#{height}" x2="#{width*5/6}" stroke="#333333" stroke-width="#{width/600}" stroke-opacity="0.5" />
+      <line y1="0" x1="#{width}" y2="#{height}" x2="#{width}" stroke="#333333" stroke-width="#{width/600}" stroke-opacity="0.5" />
+
+      <line x1="#{width/2}" y1="#{height*1/4}" x2="#{width*3/4}" y2="#{height/2}" stroke="#999999" stroke-width="#{width/600}" stroke-opacity="0.5" />
+      <line x1="#{width*3/4}" y1="#{height/2}" x2="#{width/2}" y2="#{height*3/4}" stroke="#999999" stroke-width="#{width/600}" stroke-opacity="0.5" />
+      <line x1="#{width/2}" y1="#{height*3/4}" x2="#{width*1/4}" y2="#{height/2}" stroke="#999999" stroke-width="#{width/600}" stroke-opacity="0.5" />
+      <line x1="#{width*1/4}" y1="#{height/2}" x2="#{width/2}" y2="#{height*1/4}" stroke="#999999" stroke-width="#{width/600}" stroke-opacity="0.5" />
+
+    SVG
+  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 self.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}" />
+
+      <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
+
+  # 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 self.v_arrow(x, top, bottom, pointer_top = nil, pointer_bottom = nil, label: nil, label_offset: (USPSFlags::Config::BASE_FLY/120), label_offset_y: 0, label_align: "left", 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: USPSFlags::Config::BASE_FLY, unit: nil)
+    label = bottom - top if label.nil?
+    label = label.to_i if label - label.to_i == 0
+    label = Rational(label) * fly / USPSFlags::Config::BASE_FLY
+    if label == label.to_i
+      label = label.to_i
+      label_fraction = ""
+    else
+      label, label_fraction = label.to_simplified_a
+    end
+    svg = ""
+    unless pointer_top.nil?
+      svg << <<~SVG
+        <line x1="#{x}" y1="#{top}" x2="#{pointer_top}" y2="#{top}" stroke="#{color}" stroke-width="#{stroke_width}" stroke-dasharray="#{stroke_dash}" />
+      SVG
+    end
+    unless pointer_bottom.nil?
+      svg << <<~SVG
+        <line x1="#{x}" y1="#{bottom}" x2="#{pointer_bottom}" y2="#{bottom}" stroke="#{color}" stroke-width="#{stroke_width}" stroke-dasharray="#{stroke_dash}" />
+      SVG
+    end
+
+    svg << <<~SVG
+      <path d="M#{x} #{top} l #{arrow_size} #{arrow_size} M#{x} #{top} l -#{arrow_size} #{arrow_size} M#{x} #{top} l 0 #{bottom - top} l #{arrow_size} -#{arrow_size} M#{x} #{bottom} l -#{arrow_size} -#{arrow_size}" stroke="#{color}" stroke-width="#{stroke_width}" fill="none" />
+      <g>
+        <style><![CDATA[tspan{font-size: #{USPSFlags::Config::FRACTION_SCALE}%;}]]></style>
+        <text x="#{x + label_offset}" y="#{(top+bottom)/2+(USPSFlags::Config::BASE_HOIST/150)+label_offset_y}" font-family="sans-serif" font-size="#{font_size}px" fill="#041E42" text-anchor="#{label_align}">#{label} <tspan>#{label_fraction}</tspan> #{unit}</text>
+      </g>
+    SVG
+
+    svg
+  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 self.h_arrow(y, left, right, pointer_left = nil, pointer_right = nil, label: nil, label_offset: (USPSFlags::Config::BASE_FLY/45), label_offset_x: 0, label_align: "middle", 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: USPSFlags::Config::BASE_FLY, unit: nil)
+    label = right - left if label.nil?
+    label = label.to_i if label - label.to_i == 0
+    label = Rational(label) * fly / USPSFlags::Config::BASE_FLY
+    if label == label.to_i
+      label = label.to_i
+      label_fraction = ""
+    else
+      label, label_fraction = label.to_simplified_a
+    end
+    svg = ""
+    unless pointer_left.nil?
+      svg << <<~SVG
+        <line x1="#{left}" y1="#{y}" x2="#{left}" y2="#{pointer_left}" stroke="#{color}" stroke-width="#{stroke_width}" stroke-dasharray="#{stroke_dash}" />
+      SVG
+    end
+    unless pointer_right.nil?
+      svg << <<~SVG
+        <line x1="#{right}" y1="#{y}" x2="#{right}" y2="#{pointer_right}" stroke="#{color}" stroke-width="#{stroke_width}" stroke-dasharray="#{stroke_dash}" />
+      SVG
+    end
+
+    svg << <<~SVG
+      <path d="M#{left} #{y} l #{arrow_size} #{arrow_size} M#{left} #{y} l #{arrow_size} -#{arrow_size} M#{left} #{y} l #{right - left} 0 l -#{arrow_size} -#{arrow_size} M#{right} #{y} l -#{arrow_size} #{arrow_size}" stroke="#{color}" stroke-width="#{stroke_width}" fill="none" />
+      <g>
+        <style><![CDATA[tspan{font-size: #{USPSFlags::Config::FRACTION_SCALE}%;}]]></style>
+        <text x="#{(left+right)/2+label_offset_x}" y="#{y + label_offset}" font-family="sans-serif" font-size="#{font_size}px" fill="#041E42" text-anchor="#{label_align}">#{label} <tspan>#{label_fraction}</tspan> #{unit}</text>
+      </g>
+    SVG
+
+    svg
+  end
+
+  # Prints message(s) to the console and logs them.
+  #
+  # This should never need to be called directly.
+  # @private
+  def self.log(*messages)
+    ::FileUtils.mkdir_p(USPSFlags::Config.log_path)
+    log_file = File.open("#{USPSFlags::Config.log_path}/flag.log", 'a')
+    messages.each do |message|
+      [STDOUT, log_file].each do |f|
+        f.write(message)
+      end
+    end
+    log_file.close
+
+    messages
+  end
+end

data/spec/rational_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe Rational do
+  describe "monkey patches" do
+    it "should render a simplified fraction as an Array" do
+      expect(Rational(4,3).to_simplified_a).to eql([1, Rational(1,3)])
+    end
+
+    it "should render a simplified fraction as a String" do
+      expect(Rational(4,3).to_simplified_s).to eql("1 1/3")
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require 'coveralls'
+Coveralls.wear!
+require 'bundler/setup'
+Bundler.setup
+
+require 'usps_flags' # Contains direct SVG matching
+# require 'fileutils'
+# require 'zip'
+# require 'mini_magick'
+require 'usps_flags/config'
+require 'usps_flags/helpers'
+require 'usps_flags/core' # Contains direct SVG matching
+require 'usps_flags/generate'
+
+RSpec.configure do |config|
+  # some (optional) config here
+end

data/spec/usps_flags/config_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe USPSFlags::Config do
+  describe "flags_dir" do
+    it "should return the current flags directory" do
+      default_flags_dir = File.dirname(__dir__).gsub("/spec", "/lib") + "/output"
+      expect(USPSFlags::Config.flags_dir).to eql(default_flags_dir)
+    end
+
+    it "should return the new flags directory when given a new path" do
+      new_flags_dir = "#{File.dirname(__dir__)}/flags"
+      expect(USPSFlags::Config.flags_dir(new_flags_dir)).to eql(new_flags_dir)
+    end
+  end
+
+  describe "trident" do
+    it "should return a Hash from trident" do
+      expect(USPSFlags::Config.trident).to be_a(Hash)
+    end
+  end
+
+  describe "use_larger_tridents" do
+    it "should return a Boolean from use_larger_tridents" do
+      expect([true, false]).to include(USPSFlags::Config.use_larger_tridents)
+    end
+  end
+end

data/spec/usps_flags/core_spec.rb

@@ -0,0 +1,133 @@
+require 'spec_helper'
+
+describe USPSFlags::Core do
+  describe "trident_spec" do
+    ["Field", "Specification Heading Information", "Short Trident", "Delta Trident", "Circle Trident", "Long Trident"].each do |section|
+      it "should contain the #{section} section" do
+        expect(USPSFlags::Core.trident_spec).to include("<!-- #{section} -->")
+      end
+    end
+  end
+
+  describe "headers" do
+    ["?xml ", "!DOCTYPE", "svg ", "metadata"].each do |tag|
+      it "should contain the #{tag} tag" do
+        expect(USPSFlags::Core.headers).to include("<#{tag}")
+      end
+    end
+  end
+
+  describe "footer" do
+    it "should contain the closing tag" do
+      expect(USPSFlags::Core.footer).to include("</svg>")
+    end
+  end
+
+  before(:all) do
+    @fly = USPSFlags::Config::BASE_FLY
+    @hoist = USPSFlags::Config::BASE_HOIST
+    @red = USPSFlags::Config::RED
+    @blue = USPSFlags::Config::BLUE
+  end
+
+  describe "field" do
+    it "should correctly generate the basic field" do
+      expect(USPSFlags::Core.field).to eql(
+        <<~SVG
+          <path d="M 0 0
+            l #{@fly} 0
+            l 0 #{@hoist}
+            l -#{@fly} 0
+            l 0 -#{@hoist}
+          " fill="#FFFFFF" stroke="#000000" stroke-width="#{USPSFlags::Config::BASE_FLY/600}" />
+        SVG
+      )
+    end
+
+    it "should correctly generate the red field" do
+      
+      expect(USPSFlags::Core.field(color: :red)).to eql(
+        <<~SVG
+          <path d="M 0 0
+            l #{@fly} 0
+            l 0 #{@hoist}
+            l -#{@fly} 0
+            l 0 -#{@hoist}
+          " fill="#{@red}" />
+        SVG
+      )
+    end
+
+    it "should correctly generate the swallowtail field" do
+      expect(USPSFlags::Core.field(style: :swallowtail)).to eql(
+        <<~SVG
+          <path d="M 0 0
+            l #{@fly} #{@hoist/6}
+            l -#{@fly/5} #{@hoist/3}
+            l #{@fly/5} #{@hoist/3}
+            l -#{@fly} #{@hoist/6}
+          " fill="#FFFFFF" stroke="#000000" stroke-width="#{USPSFlags::Config::BASE_FLY/600}" />
+        SVG
+      )
+    end
+
+    it "should correctly generate the blue past field" do
+      expect(USPSFlags::Core.field(style: :past, color: :blue)).to eql(
+        <<~SVG
+          <path d="M 0 0
+            l #{@fly/2} #{@hoist*1/12}
+            l 0 #{@hoist*10/12}
+            l -#{@fly/2} #{@hoist*1/12}
+          " fill="#{@blue}" />
+          <path d="M #{@fly/2} #{@hoist*1/12}
+            l #{@fly/4} #{@hoist*1/24}
+            l 0 #{@hoist*9/12}
+            l -#{@fly/4} #{@hoist*1/24}
+          " fill="#FFFFFF" />
+          <path d="M #{@fly*3/4} #{@hoist*3/24}
+            l #{@fly/4} #{@hoist*1/24}
+            l -#{@fly/5} #{@hoist/3}
+            l #{@fly/5} #{@hoist/3}
+            l -#{@fly/4} #{@hoist*1/24}
+          " fill="#{@red}" />
+          <path d="M 0 0
+            l #{@fly} #{@hoist/6}
+            l -#{@fly/5} #{@hoist/3}
+            l #{@fly/5} #{@hoist/3}
+            l -#{@fly} #{@hoist/6}
+          " fill="none" stroke="#000000" stroke-width="#{USPSFlags::Config::BASE_FLY/600}" />
+        SVG
+      )
+    end
+  end
+
+  describe "trident" do
+    it "should correctly generate a short trident" do
+      expect(USPSFlags::Core.trident(:s)).to include("<path d=\"M #{@fly/2} #{@hoist/4}\n")
+    end
+
+    it "should correctly generate a delta trident" do
+      expect(USPSFlags::Core.trident(:d)).to include("<g mask=\"url(#delta-mask)\"><path d=\"M #{@fly/2} #{@hoist*3/16}\n")
+    end
+
+    it "should correctly generate a circle trident" do
+      expect(USPSFlags::Core.trident(:stf)).to include("<g mask=\"url(#circle-mask-for-main-spike)\"><path d=\"M #{@fly/2} #{@hoist/8}\n")
+    end
+
+    it "should correctly generate a long trident" do
+      expect(USPSFlags::Core.trident(:n)).to include("<path d=\"M #{@fly/2} #{@hoist/8}\n")
+    end
+  end
+
+  describe "anchor" do
+    it "should correctly generate an anchor" do
+      expect(USPSFlags::Core.anchor).to include("<mask id=\"anchor-mask\">")
+    end
+  end
+
+  describe "lighthouse" do
+    it "should correctly generate a lighthouse" do
+      expect(USPSFlags::Core.lighthouse).to include("<mask id=\"lighthouse-mask\">")
+    end
+  end
+end

data/spec/usps_flags/generate_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe USPSFlags::Generate do
+  it "should get the correct flag" do
+    expect(USPSFlags::Generate.get("LtC", outfile: "")).to include("width=\"1024pt\" height=\"682pt\" viewBox=\"0 0 3072 2048\"")
+    expect(USPSFlags::Generate.get("LtC", outfile: "")).to include(
+      <<~SVG
+        <path d="M 0 0
+          l 3072 0
+          l 0 2048
+          l -3072 0
+          l 0 -2048
+        " fill="#BF0D3E" />
+      SVG
+    )
+    expect(USPSFlags::Generate.get("LtC", outfile: "")).to include("<path d=\"M 1536 512")
+    expect(USPSFlags::Generate.get("LtC", outfile: "")).to include("<g transform=\"translate(-512)\">")
+    expect(USPSFlags::Generate.get("LtC", outfile: "")).to include("<g transform=\"translate(512)\">")
+  end
+end