usps_flags 0.3.4 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 438531004f5629248e5cd73008ef140e8c9ad9fc
-  data.tar.gz: b2b586e3f878b8ea82d130e070b5ba5772b3587c
+  metadata.gz: 6f005b5e851564f4b8496aa3489b678a47c8cf9f
+  data.tar.gz: a5f44daaac686d24673233b5f503fa3d3685eeb7
 SHA512:
-  metadata.gz: b0d615902c4d3d28025abc36256bc45b778079fb4b8abec0e610c5acf57342a07db934eb52d840854f43d4bc0afaeba45dd597e5de5408ad9c2f2e3ed119b98c
-  data.tar.gz: ed64a81542097c27df2b1a33b8548a06884be94ff9987368704820b73c56391aafe1c48ea59cccd0f503937c04d9ec82b8bf1f877a7e11e8d313b9fdf9860f09
+  metadata.gz: 8e3831a3046a633600d8388727461f160704229690fe4ec57ae747933c60059e09bdf3b950d1cfd4dbe6548814e8848a5d6e1fe0430b678e09b9b44f67c5ef15
+  data.tar.gz: 0f9387270b6fae9bc37a6a40961d75eb520f99e81dae1748f71dbeda3503d176a829c2efb14fc8a70350fad32568e5a7c9963af2774d27bcf6a8b254b69d9bbe

data/CONTRIBUTING.md

@@ -4,7 +4,8 @@ Thank you for your interest in improving the USPSFlags generator!
 
 Please feel free to ask about anything or submit an issue or pull request.
 
-If you would like to submit a pull request, please use atomic (rather than squashed) commits.
+If you would like to submit a pull request, please use atomic (rather than
+squashed) commits.
 
 ## Contact
 
@@ -12,6 +13,12 @@ You can contact me via GitHub, Twitter, or email.
 
 ## License
 
-This project is released under the [GPLv3](https://raw.github.com/jfiander/usps-flags/master/LICENSE). All images generated (other than the US Ensign) are [registered trademarks](http://www.usps.org/national/itcom/trademark.html) of United States Power Squadrons.
+This project is released under the
+[GPLv3](https://raw.github.com/jfiander/usps-flags/master/LICENSE).
+All images generated (other than the US Ensign) are
+[registered trademarks](http://www.usps.org/national/itcom/trademark.html) of
+United States Power Squadrons.
 
-All contributions to this project will be released under the same license. By submitting a pull request, you agree to release your code under the same license.
+All contributions to this project will be released under the same license.
+By submitting a pull request, you agree to release your code under the same
+license.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    usps_flags (0.3.3)
+    usps_flags (0.3.4)
       file_utils (~> 1.1, >= 1.1.2)
       mini_magick (~> 4.8, >= 4.8.0)
       rubyzip (~> 1.2, >= 1.2.1)

data/README.md

@@ -71,7 +71,7 @@ USPSFlags::Generate.svg "flag", outfile: nil, scale: nil, field: true
 
 - `outfile` specifies where to save the file. If left as `nil`, this method will
   `puts` the generated SVG. Either way, the SVG code is returned.
-- `scale` is a divisor scaling factor – the larger it is, the smaller the 
+- `scale` is a divisor scaling factor – the larger it is, the smaller the
   resulting SVG will be rendered. Accepted values are floats between 0 and 1,
   and integers above that.
 - `field` specifies whether to render the field of a flag, or to only render the

data/lib/usps_flags/config.rb

@@ -10,13 +10,11 @@ class USPSFlags::Config
   
   @@flags_dir ||= defined?(::Rails) ? "#{::Rails.root}/app/assets/images/usps_flags" : "#{File.dirname(__dir__)}/output"
   @@use_larger_tridents ||= true
-  @@log_fail_quietly ||= true
   
   # Configuration constructor
   #
   # @param [String] flag_dir The path to the flags directory.
   # @param [Boolean] use_larger_tridents Whether to use the larger trident configuration.
-  # @param [Boolean] log_fail_quietly Whether to print an error message if the log file is inaccessible.
   # @param [Boolean] reset Whether to clear out the specified flags_dir.
   def initialize
     load_init_variables
@@ -28,7 +26,6 @@ class USPSFlags::Config
   attr_accessor :flags_dir
   attr_accessor :reset
   attr_accessor :use_larger_tridents
-  attr_accessor :log_fail_quietly
 
   # Base configuration values for trident insignia.
   #
@@ -112,18 +109,10 @@ class USPSFlags::Config
     @@use_larger_tridents
   end
 
-  # Accessor for the boolean of whether to print an error message if the log file is inaccessible.
-  #
-  # @return [Boolean] Returns the current setting.
-  def self.log_fail_quietly
-    @@log_fail_quietly
-  end
-
   private
   def load_init_variables
     @flags_dir = @@flags_dir
     @use_larger_tridents = @@use_larger_tridents
-    @log_fail_quietly = @@log_fail_quietly
     @reset = false
   end
 
@@ -141,6 +130,5 @@ class USPSFlags::Config
   def set_class_variables
     @@flags_dir = @flags_dir
     @@use_larger_tridents = @use_larger_tridents
-    @@log_fail_quietly = @log_fail_quietly
   end
 end

data/lib/usps_flags/core/ensign.rb

@@ -46,7 +46,7 @@ class USPSFlags::Core::Ensign
         <g transform="scale(0.375)">
           <g transform="translate(1885, 465)">
             <g transform="rotate(#{rotation}, 0, 900)">
-              #{USPSFlags::Core::Star.new.svg}
+              #{USPSFlags::Core.star}
             </g>
           </g>
         </g>

data/lib/usps_flags/core/headers.rb

@@ -7,29 +7,19 @@ class USPSFlags::Core::Headers
     @width = width
     @height = height
     @title = title
+    scale ||= 3
+    @generated_at = Time.now.strftime("%Y%m%d.%H%S%z")
+
     if @width.nil? || @height.nil?
-      scale = 3 if scale.nil?
       @width = USPSFlags::Config::BASE_FLY / scale
       @height = (@width*Rational(2,3)).to_i
-
       @view_width = USPSFlags::Config::BASE_FLY
       @view_height = USPSFlags::Config::BASE_HOIST
-
-      if pennant
-        @height = @height/4
-        @view_height = USPSFlags::Config::BASE_HOIST/4
-      end
+      set_pennant_height(@height) if pennant
     else
-      if scale.nil?
-        @view_width = @width
-        @view_height = @height
-      else
-        @view_width = @width * scale
-        @view_height = @height * scale
-      end
+      @view_width = width * scale
+      @view_height = height * scale
     end
-
-    @generated_at = Time.now.strftime("%Y%m%d.%H%S%z")
   end
 
   def svg
@@ -57,4 +47,10 @@ class USPSFlags::Core::Headers
 
     svg
   end
+
+  private
+  def set_pennant_height(height)
+    height = height/4
+    @view_height = USPSFlags::Config::BASE_HOIST/4
+  end
 end

data/lib/usps_flags/core/pennant.rb

@@ -16,7 +16,7 @@ class USPSFlags::Core::Pennant
       <<~SVG
         #{cruise}
         <g transform=\"translate(385, 340)\">
-          #{USPSFlags::Core::Star.new.svg}
+          #{USPSFlags::Core.star}
         </g>"
       SVG
     end

data/lib/usps_flags/core/trident.rb

@@ -124,9 +124,9 @@ class USPSFlags::Core::Trident
     elsif color == :blue
       @color_code = USPSFlags::Config::BLUE
       @field_color_code = "#FFFFFF"
-    elsif color == :white && field_color == :red
+    elsif field_color == :red
       @field_color_code = USPSFlags::Config::RED
-    elsif color == :white && field_color == :blue
+    elsif field_color == :blue
       @field_color_code = USPSFlags::Config::BLUE
     end
   end

data/lib/usps_flags/core/trident_spec.rb

@@ -32,21 +32,36 @@ class USPSFlags::Core::TridentSpec
 
   private
   def configure_sizes(fly)
+    @fly = fly
+    get_hoist_from_fly(@fly)
+    configure_hoist_fraction
+    configure_fly_fraction
+  end
+
+  def get_hoist_from_fly(fly)
     hoist = (fly*Rational(2,3))
-    @hoist = hoist == hoist.to_i ? hoist.to_i : hoist
+    @hoist = if hoist == hoist.to_i
+      hoist.to_i
+    else
+      hoist
+    end
+  end
 
-    @fly_fraction = ""
+  def configure_hoist_fraction
     @hoist_fraction = ""
-    if fly == fly.to_i
-      @fly = fly.to_i
+    if @hoist == @hoist.to_i
+      @hoist = @hoist.to_i
     else
-      @fly, @fly_fraction = fly.to_simplified_a
+      @hoist, @hoist_fraction = @hoist.to_simplified_a
     end
+  end
 
-    if hoist == hoist.to_i
-      @hoist = hoist.to_i
+  def configure_fly_fraction
+    @fly_fraction = ""
+    if @fly == @fly.to_i
+      @fly = @fly.to_i
     else
-      @hoist, @hoist_fraction = hoist.to_simplified_a
+      @fly, @fly_fraction = @fly.to_simplified_a
     end
   end
 
@@ -60,9 +75,16 @@ class USPSFlags::Core::TridentSpec
     @unit_text = unit.nil? ? "" :  "#{unit}"
     @unit = unit
 
+    configure_barb_label
+  end
+
+  def configure_barb_label
     barb_label = Rational(@trident_config[:main_point_barb]) * @fly / USPSFlags::Config::BASE_FLY
-    barb_label = barb_label == barb_label.to_i ? barb_label.to_i : barb_label.to_simplified_s
-    @barb_label = "#{barb_label}#{@unit_text}"
+    @barb_label = if barb_label == barb_label.to_i
+      "#{barb_label.to_i}#{@unit_text}"
+    else
+      "#{barb_label.to_simplified_s}#{@unit_text}"
+    end
   end
 
   def spec_header

data/lib/usps_flags/core/us.rb

@@ -39,7 +39,7 @@ class USPSFlags::Core::US
     rows[type].each do |r|
       columns[type].each do |c|
         svg << <<~SVG
-          <g transform="translate(#{@canton_fly*c/12}, #{@star_offset+@canton_hoist*r/10})"><g transform="scale(0.31)">#{USPSFlags::Core::Star.new.svg}</g></g>
+          <g transform="translate(#{@canton_fly*c/12}, #{@star_offset+@canton_hoist*r/10})"><g transform="scale(0.31)">#{USPSFlags::Core.star}</g></g>
         SVG
       end
     end

data/lib/usps_flags/generate/flag.rb

@@ -5,22 +5,16 @@
 class USPSFlags::Generate::Flag
   class << self
     def officer(rank: nil, width: USPSFlags::Config::BASE_FLY, outfile: nil, scale: nil, field: true)
-      raise "Error: No rank specified." if rank.nil?
+      raise ArgumentError, "No rank specified." if rank.nil?
       @rank = rank.to_s.upcase
       @field = field
 
       svg = ""
       svg << USPSFlags::Core.headers(scale: scale, title: @rank)
-
       modify_rank_for_insignia
       @flag_details = USPSFlags::Helpers.flag_details(@rank)
       @trident_color = @field ? :white : @flag_details[:color]
-
-      svg << USPSFlags::Core.field(style: @flag_details[:style], color: @flag_details[:color]) if @field
-      svg << "<g transform=\"translate(-150, 400)\"><g transform=\"scale(0.58333)\">" if @flag_details[:style] == :past
-      svg << get_officer_flag
-      svg << "</g></g>" if @flag_details[:style] == :past
-      svg << USPSFlags::Core.footer
+      svg << officer_flag_body
 
       USPSFlags::Helpers.output(svg, outfile: outfile)
     end
@@ -97,26 +91,60 @@ class USPSFlags::Generate::Flag
 
     private
     def get_officer_flag
-      if @flag_details[:type] == :n && @flag_details[:count] == 3
+      if cc?
         USPSFlags::Core::Tridents.cc(@flag_details[:type], trident_color: @trident_color)
-      elsif @flag_details[:type] == :n && @flag_details[:count] == 2
+      elsif vc?
         USPSFlags::Core::Tridents.vc(@flag_details[:type], trident_color: @trident_color)
-      elsif [:s, :d].include?(@flag_details[:type]) && @flag_details[:count] == 3
+      elsif cdr_or_dc?
         USPSFlags::Core::Tridents.three(@flag_details[:type], trident_color: @trident_color, field_color: @flag_details[:color])
-      elsif [:s, :d].include?(@flag_details[:type]) && @flag_details[:count] == 2
+      elsif ltc_or_dltc?
         USPSFlags::Core::Tridents.two(@flag_details[:type], trident_color: @trident_color, field_color: @flag_details[:color])
-      elsif [:s, :d, :stf, :n].include?(@flag_details[:type]) && %w[LT DLT].include?(@rank)
+      elsif lt_or_dlt?
         USPSFlags::Core::Tridents.offset(@flag_details[:type], field_color: @flag_details[:color], field: @field)
-      elsif [:a, :f, :fc, :pc].include?(@flag_details[:type])
+      elsif special_officer?
         special(@flag_details[:type], level: @flag_details[:level], field: @field)
       else
         USPSFlags::Core.trident(@flag_details[:type], field_color: @flag_details[:color])
       end
     end
 
+    def officer_flag_body
+      svg = ""
+      svg << USPSFlags::Core.field(style: @flag_details[:style], color: @flag_details[:color]) if @field
+      svg << "<g transform=\"translate(-150, 400)\"><g transform=\"scale(0.58333)\">" if @flag_details[:style] == :past
+      svg << get_officer_flag
+      svg << "</g></g>" if @flag_details[:style] == :past
+      svg << USPSFlags::Core.footer
+      svg
+    end
+
     def modify_rank_for_insignia
       @rank.slice!(0) if !@field && USPSFlags::Helpers.valid_flags(:past).include?(@rank)
       @rank = "CDR" if @rank == "C"
     end
+
+    def cc?
+      @flag_details[:type] == :n && @flag_details[:count] == 3
+    end
+
+    def vc?
+      @flag_details[:type] == :n && @flag_details[:count] == 2
+    end
+
+    def cdr_or_dc?
+      [:s, :d].include?(@flag_details[:type]) && @flag_details[:count] == 3
+    end
+
+    def ltc_or_dltc?
+      [:s, :d].include?(@flag_details[:type]) && @flag_details[:count] == 2
+    end
+
+    def lt_or_dlt?
+      %w[LT DLT].include?(@rank)
+    end
+
+    def special_officer?
+      [:a, :f, :fc, :pc].include?(@flag_details[:type])
+    end
   end
 end

data/lib/usps_flags/generate.rb

@@ -57,29 +57,13 @@ class USPSFlags::Generate
       raise USPSFlags::Errors::StaticFilesGenerationError, "At least one argument switch must be true out of [svg, png, zips]." unless svg || png || zips
 
       remove_static_files if reset
-
-      puts "\nSVGs generate a single file.",
-        "PNGs generate full-res, 1500w, 1000w, 500w, and thumbnail files.",
-        "Corresponding rank insignia (including smaller sizes) are also generated, as appropriate."
-      USPSFlags::Helpers.log "\nGeneration location: #{USPSFlags::Config.flags_dir}\n"
-      USPSFlags::Helpers.log "\n#{Time.now.strftime('%Y%m%d.%H%M%S%z')} – Generating static files...\n\n"
-      USPSFlags::Helpers.log "Flag | SVG | PNG        | Run time\n".rjust(USPSFlags::Helpers.max_flag_name_length+31),
-        "\n".rjust(USPSFlags::Helpers.max_flag_name_length+32, "-")
-
+      static_generation_header
       overall_start_time = Time.now
-
       USPSFlags::Helpers.valid_flags(:all).each do |flag|
         generate_static_images_for(flag, svg: svg, png: png)
       end
-
       zips(svg: svg, png: png) if zips
-
       USPSFlags::Helpers.log "\nTotal run time: #{Time.now - overall_start_time} s\n\n"
-
-      nil
-    rescue => e
-      raise e if e.is_a?(USPSFlags::Errors::StaticFilesGenerationError)
-      raise USPSFlags::Errors::StaticFilesGenerationError, cause: e
     end
 
     # Generate zip archives of current static image files.
@@ -90,9 +74,6 @@ class USPSFlags::Generate
       raise USPSFlags::Errors::ZipGenerationError, "At least one argument switch must be true out of [svg, png]." unless svg || png
       generate_zip("svg") if svg
       generate_zip("png") if png
-    rescue => e
-      raise e if e.is_a?(USPSFlags::Errors::ZipGenerationError)
-      raise USPSFlags::Errors::ZipGenerationError, cause: e
     end
 
     # Generate trident spec sheet as an SVG image.
@@ -130,8 +111,18 @@ class USPSFlags::Generate
       [@svg_file, @png_file, @svg_ins_file, @png_ins_file]
     end
 
+    def static_generation_header
+      puts "\nSVGs generate a single file.",
+        "PNGs generate full-res, 1500w, 1000w, 500w, and thumbnail files.",
+        "Corresponding rank insignia (including smaller sizes) are also generated, as appropriate."
+      USPSFlags::Helpers.log "\nGeneration location: #{USPSFlags::Config.flags_dir}\n"
+      USPSFlags::Helpers.log "\n#{Time.now.strftime('%Y%m%d.%H%M%S%z')} – Generating static files...\n\n"
+      USPSFlags::Helpers.log "Flag | SVG | PNG        | Run time\n".rjust(USPSFlags::Helpers.max_flag_name_length+31),
+        "\n".rjust(USPSFlags::Helpers.max_flag_name_length+32, "-")
+    end
+
     def generate_zip(type)
-      raise "Error: Flags directory not found." unless ::Dir.exist?("#{USPSFlags::Config.flags_dir}/ZIP")
+      raise USPSFlags::Errors::ZipGenerationError, "Flags directory not found." unless ::Dir.exist?("#{USPSFlags::Config.flags_dir}/ZIP")
 
       zip = "#{USPSFlags::Config.flags_dir}/ZIP/USPS_Flags.#{type}.zip"
       ::File.delete(zip) if ::File.exist?(zip)
@@ -158,17 +149,8 @@ class USPSFlags::Generate
 
       set_file_paths(flag)
 
-      if svg
-        generate_static_svg(flag)
-      else
-        USPSFlags::Helpers.log "-"
-      end
-
-      if png
-        generate_static_png(flag)
-      else
-        USPSFlags::Helpers.log "- "
-      end
+      svg ? generate_static_svg(flag) : USPSFlags::Helpers.log("-")
+      png ? generate_static_png(flag) : USPSFlags::Helpers.log("- ")
 
       run_time = (Time.now - start_time).round(4).to_s[(0..5)].ljust(6, "0")
       USPSFlags::Helpers.log " | #{run_time} s\n"
@@ -199,7 +181,7 @@ class USPSFlags::Generate
     end
 
     def generate_fullsize_png_insignia(flag)
-      if USPSFlags::Helpers.valid_flags(:past).include?(flag) || !USPSFlags::Helpers.valid_flags(:insignia).include?(flag)
+      if can_have_insignia?(flag)
         USPSFlags::Helpers.log "-"
       else
         png(File.read(@svg_ins_file), outfile: @png_ins_file, trim: true) unless ::File.exist?(@png_ins_file)
@@ -207,6 +189,10 @@ class USPSFlags::Generate
       end
     end
 
+    def can_have_insignia?(flag)
+      USPSFlags::Helpers.valid_flags(:past).include?(flag) || !USPSFlags::Helpers.valid_flags(:insignia).include?(flag)
+    end
+
     def generate_reduced_size_pngs(flag)
       USPSFlags::Helpers.png_sizes.keys.each do |size|
         USPSFlags::Helpers.log(".") and next if ::File.exist?("#{USPSFlags::Config.flags_dir}/PNG/#{flag}.#{size}.png")

data/lib/usps_flags/helpers.rb

@@ -89,12 +89,8 @@ class USPSFlags::Helpers
       ::FileUtils.mkdir_p(USPSFlags::Config.log_path)
       outputs = [STDOUT]
 
-      begin
-        log_file = File.open("#{USPSFlags::Config.log_path}/flag.log", 'a')
-        outputs << log_file
-      rescue Errno::EACCES => e
-        puts "\nError accessing log file." unless USPSFlags::Config.log_fail_quietly
-      end
+      log_file = File.open("#{USPSFlags::Config.log_path}/flag.log", 'a')
+      outputs << log_file
 
       messages.each do |message|
         outputs.each { |f| f.write(message) }
@@ -207,13 +203,10 @@ class USPSFlags::Helpers
       end
     end
 
-    def flag_type(rank)
-      if rank == "PORTCAP"
-        :pc
-      elsif rank == "FLEETCAP"
-        :fc
-      elsif rank == "STFC"
-        :stf
+    def flag_type(rank) # Complexity
+      specifics = {"PORTCAP" => :pc, "FLEETCAP" => :fc, "STFC" => :stf}
+      if specifics.keys.include?(rank)
+        specifics[rank]
       elsif rank.match /.AIDE/
         :a
       elsif rank.match /.?FLT/

data/spec/rational_spec.rb

@@ -6,6 +6,10 @@ describe Rational do
       expect(Rational(4,3).to_simplified_a).to eql([1, Rational(1,3)])
     end
 
+    it "should render a proper fraction as String" do
+      expect(Rational(2,3).to_simplified_a).to eql("2/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

data/spec/usps_flags/config_spec.rb

@@ -26,12 +26,6 @@ describe USPSFlags::Config do
     end
   end
 
-  describe "log_fail_quietly" do
-    it "should return a Boolean from log_fail_quietly" do
-      expect([true, false]).to include(USPSFlags::Config.log_fail_quietly)
-    end
-  end
-
   describe "configuration constructor" do
     it "should return a properly constructed configuration" do
       @config = USPSFlags::Config.new do |config|
@@ -41,7 +35,6 @@ describe USPSFlags::Config do
       expect(@config.flags_dir).to eql($tmp_flags_dir)
       expect(@config.reset).to eql(false)
       expect(@config.use_larger_tridents).to eql(true)
-      expect(@config.log_fail_quietly).to eql(true)
     end
   end
 end

data/usps_flags.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name          = 'usps_flags'
-  s.version       = '0.3.4'
+  s.version       = '0.3.5'
   s.date          = '2017-11-06'
   s.summary       = 'Flag generator for United States Power Squadrons'
   s.description   = 'A flag image (PNG, SVG) generator for United States Power Squadrons.'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: usps_flags
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.3.5
 platform: ruby
 authors:
 - Julian Fiander