usps_flags 0.2.6 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 230cbb0c6890872f99ec67e5a5db72eb528b84bc
-  data.tar.gz: 54251932a8c574ebfa8efea790086eeec8cc5459
+  metadata.gz: 9fdff1aa8bd6137e6cf924483f5e56febb4cb5cc
+  data.tar.gz: 9a497de8ac453be04f0b4ca8620b67048f68a922
 SHA512:
-  metadata.gz: 57d576e35c377d8527988d9fd51628712d6a3eaf8db4c9c137f4e657e61fb174f11c1868d407ab2dffce080ccdde5631e586e1f71e6b0fc610984ee8cf42ebaa
-  data.tar.gz: 80160eaa9c095e3a3af76d0c27550183b081c9599140c43b0a8c378e99359d96f65c1f6c32554238cbdd60e09908d5c57fe5635c81a0da6938c752fc0c54ff3d
+  metadata.gz: 8c7cff7cdd70760dae34da50fc1b217a721da2bf02dce238863641303f3c40a5e26601fdcb60e213fff2237ed1b1b9aafcb8db5cbadd88542bda7ab6ef4d3119
+  data.tar.gz: 4bfa4672d65cbb79f1c1042c205e0af15dd901856aabd1f7067782c47be356894766f73dca6f72258c7d800182cab624a15542c84416a82ca175b1d75241f59b

data/Gemfile.lock

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

data/lib/usps_flags/errors.rb

@@ -0,0 +1,19 @@
+module USPSFlags::Errors
+  class PNGGenerationError < StandardError
+    def initialize(msg = "There was an error generating the PNG file.", svg: "")
+      super(msg)
+    end
+  end
+
+  class StaticFilesGenerationError < StandardError
+    def initialize(msg = "There was an error generating the static files.", cause: nil)
+      super(msg)
+    end
+  end
+
+  class ZipGenerationError < StandardError
+    def initialize(msg = "There was an error generating the zip file.", type: nil, cause: nil)
+      super(msg)
+    end
+  end
+end

data/lib/usps_flags/generate.rb

@@ -28,11 +28,14 @@ class USPSFlags::Generate
     # @param [String] svg The SVG data.
     # @param [String] outfile The path to save the PNG file to. (Required because the file is not accessible if this is left blank.)
     # @param [Boolean] trim Whether to trim the generated PNG file of excess transparency.
-    def png(svg, outfile:, trim: false)
-      temp_svg = ::File.new("temp.svg", "w+")
+    def png(svg, outfile: nil, trim: false)
+      temp_svg_file = "temp.svg"
+      temp_svg = ::File.new(temp_svg_file, "w+")
       temp_svg.write(svg)
       temp_svg.flush
 
+      raise USPSFlags::Errors::PNGGenerationError, svg: svg if outfile.nil? || outfile.empty?
+
       MiniMagick::Tool::Convert.new do |convert|
         convert << "-background" << "none"
         convert << "-format" << "png"
@@ -41,7 +44,7 @@ class USPSFlags::Generate
         convert << outfile
       end
     ensure
-      ::File.delete(temp_svg) if ::File.exist?(temp_svg)
+      ::File.delete(temp_svg_file) if ::File.exist?(temp_svg_file)
     end
 
     # Generate all static SVG and PNG files, and automaticall generates zip archives for download.
@@ -51,6 +54,8 @@ class USPSFlags::Generate
     # @param [Boolean] zips Whether to create zip archives for all images created. Does not create a zip for skipped formats.
     # @param [Boolean] reset Whether to delete all previous files before generating new files.
     def all(svg: true, png: true, zips: true, reset: true)
+      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.",
@@ -72,6 +77,9 @@ class USPSFlags::Generate
       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.
@@ -79,17 +87,21 @@ class USPSFlags::Generate
     # @param [Boolean] svg Generate zip archive of SVG images.
     # @param [Boolean] png Generate zip archive of PNG images.
     def zips(svg: true, png: true)
+      raise USPSFlags::Errors::ZipGenerationError, "At least one argument switch must be true out of [svg, png]." unless svg || png
       begin
         generate_zip("svg") if svg
       rescue Errno::EACCES => e
-        puts "Error: Failed to generate SVG Zip -> #{e.message}"
+        raise USPSFlags::Errors::ZipGenerationError, type: :svg, cause: e
       end
 
       begin
         generate_zip("png") if png
       rescue Errno::EACCES => e
-        puts "Error: Failed to generate SVG Zip -> #{e.message}"
+        raise USPSFlags::Errors::ZipGenerationError, type: :png, cause: e
       end
+    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.
@@ -111,7 +123,10 @@ class USPSFlags::Generate
 
     private
     def remove_static_files
-      ["SVG", "PNG", "ZIP"].each { |dir| ::FileUtils.rm_rf(Dir.glob("#{USPSFlags::Config.flags_dir}/#{dir}/*")) }
+      ["SVG", "PNG", "ZIP"].each do |dir|
+        dir_path = "#{USPSFlags::Config.flags_dir}/#{dir}"
+        ::FileUtils.rm_rf(::Dir.glob("#{dir_path}/*")) if ::Dir.exist?(dir_path)
+      end
       ["SVG/insignia", "PNG/insignia"].each { |dir| ::FileUtils.mkdir_p("#{USPSFlags::Config.flags_dir}/#{dir}") }
       USPSFlags::Helpers.log "\n - Cleared previous files.\n"
     end
@@ -178,17 +193,13 @@ class USPSFlags::Generate
         svg flag, field: false, outfile: @svg_ins_file, scale: 1
         USPSFlags::Helpers.log "I"
       end
-    rescue => e
-      USPSFlags::Helpers.log "x -> #{e.message}"
     end
 
     def generate_static_png(flag)
       USPSFlags::Helpers.log "  | "
       generate_fullsize_png
       generate_fullsize_png_insignia(flag)
-      generate_reduced_size_pngs
-    rescue => e
-      USPSFlags::Helpers.log "x -> #{e.message}"
+      generate_reduced_size_pngs(flag)
     end
 
     def generate_fullsize_png
@@ -205,7 +216,7 @@ class USPSFlags::Generate
       end
     end
 
-    def generate_reduced_size_pngs
+    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")
         size, size_key = USPSFlags::Helpers.size_and_key(size: size, flag: flag)

data/lib/usps_flags.rb

@@ -12,6 +12,7 @@ class USPSFlags
   require 'usps_flags/helpers'
   require 'usps_flags/core'
   require 'usps_flags/generate'
+  require 'usps_flags/errors'
 
   # Dir['./lib/usps_flags/core/**'].map { |d| d.split("/").last.split(".rb").first }
   %w[anchor binoculars ensign field footer headers lighthouse pennant star trident tridents trident_spec trumpet us wheel].each do |d|
@@ -104,7 +105,7 @@ class USPSFlags
   #
   # @return [String] Returns the SVG file output path.
   def png
-    raise "Error: png_file must be set." if self.png_file.nil?
+    raise USPSFlags::Errors::PNGGenerationError, "A path must be set with png_file." if self.png_file.nil?
     svg_file_storage = self.svg_file
     self.svg_file ""
     USPSFlags::Generate.png(self.svg, outfile: self.png_file, trim: self.trim)

data/spec/spec_helper.rb

@@ -7,6 +7,23 @@ CodeClimate::TestReporter.start
 
 require 'usps_flags'
 
+# The spec for USPSFlags and USPSFlags::Generate contain some examples that check for
+# USPSFlags::Errors::PNGGenerationError
+# USPSFlags::Errors::StaticFilesGenerationError
+# USPSFlags::Errors::ZipGenerationError
+RSpec::Expectations.configuration.on_potential_false_positives = :nothing
+
 RSpec.configure do |config|
-  # some (optional) config here
+  config.before(:suite) do
+    $tmp_flags_dir = "tmp/flags"
+    $tmp_alt_flags_dir = "tmp/alt_flags"
+
+    USPSFlags::Config.new do |config|
+      config.flags_dir = $tmp_flags_dir
+    end
+  end
+
+  config.after(:suite) do
+    ::FileUtils.rm_rf("tmp") if ::Dir.exist?("tmp")
+  end
 end

data/spec/usps_flags/config_spec.rb

@@ -3,14 +3,13 @@ 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)
+      expect(USPSFlags::Config.flags_dir).to eql($tmp_flags_dir)
     end
   end
 
   describe "log_path" do
     it "should return the current flags directory" do
-      default_log_path = File.dirname(__dir__).gsub("/spec", "/lib") + "/output/log"
+      default_log_path = $tmp_flags_dir + "/log"
       expect(USPSFlags::Config.log_path).to eql(default_log_path)
     end
   end
@@ -35,12 +34,11 @@ describe USPSFlags::Config do
 
   describe "configuration constructor" do
     it "should return a properly constructed configuration" do
-      test_flags_dir = "./path/to/flags/for/spec"
       @config = USPSFlags::Config.new do |config|
-        config.flags_dir = test_flags_dir
+        config.flags_dir = $tmp_flags_dir
       end
 
-      expect(@config.flags_dir).to eql(test_flags_dir)
+      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)

data/spec/usps_flags/generate_spec.rb

@@ -1,32 +1,84 @@
 require 'spec_helper'
 
 describe USPSFlags::Generate do
-  it "should generate a flag with the correct size" do
-    expect(USPSFlags::Generate.svg("LtC", outfile: "")).to include(
-      "width=\"1024pt\" height=\"682pt\" viewBox=\"0 0 3072 2048\""
-    )
-  end
+  describe "general features" do
+    it "should generate a flag with the correct size" do
+      expect(USPSFlags::Generate.svg("LtC", outfile: "")).to include(
+        "width=\"1024pt\" height=\"682pt\" viewBox=\"0 0 3072 2048\""
+      )
+    end
 
-  it "should generate a flag with the correct field" do
-    expect(USPSFlags::Generate.svg("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
-    )
-  end
+    it "should generate a flag with the correct field" do
+      expect(USPSFlags::Generate.svg("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
+      )
+    end
 
-  it "should generate a flag with the correct starting position" do
-    expect(USPSFlags::Generate.svg("LtC", outfile: "")).to include("<path d=\"M 1536 512")
+    it "should generate a flag with the correct starting position" do
+      expect(USPSFlags::Generate.svg("LtC", outfile: "")).to include("<path d=\"M 1536 512")
+    end
+
+    it "should generate a flag with the correct trident transformations" do
+      expect(USPSFlags::Generate.svg("LtC", outfile: "")).to include("<g transform=\"translate(-512)\">")
+      expect(USPSFlags::Generate.svg("LtC", outfile: "")).to include("<g transform=\"translate(512)\">")
+    end
   end
 
-  it "should generate a flag with the correct trident transformations" do
-    expect(USPSFlags::Generate.svg("LtC", outfile: "")).to include("<g transform=\"translate(-512)\">")
-    expect(USPSFlags::Generate.svg("LtC", outfile: "")).to include("<g transform=\"translate(512)\">")
+  describe "line flags" do
+    it "should generate CC" do
+      expect(USPSFlags::Generate.svg("CC", outfile: "")).to include("<title>CC</title>")
+    end
+
+    it "should generate VC" do
+      expect(USPSFlags::Generate.svg("VC", outfile: "")).to include("<title>VC</title>")
+    end
+
+    it "should generate RC" do
+      expect(USPSFlags::Generate.svg("RC", outfile: "")).to include("<title>RC</title>")
+    end
+
+    it "should generate StfC" do
+      expect(USPSFlags::Generate.svg("StfC", outfile: "")).to include("<title>STFC</title>")
+    end
+
+    it "should generate DC" do
+      expect(USPSFlags::Generate.svg("DC", outfile: "")).to include("<title>DC</title>")
+    end
+
+    it "should generate DLtC" do
+      expect(USPSFlags::Generate.svg("DLtC", outfile: "")).to include("<title>DLTC</title>")
+    end
+
+    it "should generate D1Lt" do
+      expect(USPSFlags::Generate.svg("D1Lt", outfile: "")).to include("<title>D1LT</title>")
+    end
+
+    it "should generate DLt" do
+      expect(USPSFlags::Generate.svg("DLt", outfile: "")).to include("<title>DLT</title>")
+    end
+
+    it "should generate Cdr" do
+      expect(USPSFlags::Generate.svg("Cdr", outfile: "")).to include("<title>CDR</title>")
+    end
+
+    it "should generate LtC" do
+      expect(USPSFlags::Generate.svg("LtC", outfile: "")).to include("<title>LTC</title>")
+    end
+
+    it "should generate 1Lt" do
+      expect(USPSFlags::Generate.svg("1Lt", outfile: "")).to include("<title>1LT</title>")
+    end
+
+    it "should generate Lt" do
+      expect(USPSFlags::Generate.svg("Lt", outfile: "")).to include("<title>LT</title>")
+    end
   end
 
   describe "special flags" do
@@ -58,4 +110,66 @@ describe USPSFlags::Generate do
       expect(USPSFlags::Generate.svg("NFLt", outfile: "")).to include("<title>NFLT</title>")
     end
   end
+
+  describe "pennants" do
+    it "should generate the cruise pennant" do
+      expect(USPSFlags::Generate.svg("Cruise", outfile: "")).to include("<title>Cruise Pennant</title>")
+    end
+
+    it "should generate the officer-in-charge pennant" do
+      expect(USPSFlags::Generate.svg("OIC", outfile: "")).to include("<title>Officer-in-Charge Pennant</title>")
+    end
+  end
+
+  describe "other flags" do
+    it "should generate US" do
+      expect(USPSFlags::Generate.svg("US", outfile: "")).to include("<title>US Ensign</title>")
+    end
+
+    it "should generate USPS Ensign" do
+      expect(USPSFlags::Generate.svg("Ensign", outfile: "")).to include("<title>USPS Ensign</title>")
+    end
+
+    it "should generate the USPS Wheel logo" do
+      expect(USPSFlags::Generate.svg("Wheel", outfile: "")).to include("<title>USPS Ensign Wheel</title>")
+    end
+  end
+
+  describe "trident specifications" do
+    it "should generate the trident specification sheet" do
+      expect(USPSFlags::Generate.spec(outfile: "")).to include("<title>USPS Trident Specifications</title>")
+    end
+  end
+
+  describe "png" do
+    it "should raise PNGGenerationError without an outfile" do
+      expect { USPSFlags::Generate.png(USPSFlags::Generate.svg("LtC", outfile: ""), outfile: "") }.to raise_error(USPSFlags::Errors::PNGGenerationError)
+    end
+
+    it "should not raise PNGGenerationError when correctly configured" do
+      expect { USPSFlags::Generate.png(USPSFlags::Generate.svg("LtC", outfile: ""), outfile: "lib/output/PNG/LTC.png") }.to_not raise_error(USPSFlags::Errors::PNGGenerationError)
+    end
+  end
+
+  describe "static files" do
+    it "should raise USPSFlags::Errors::StaticFilesGenerationError when not given any true arguments" do
+      expect { USPSFlags::Generate.all(svg: false, png: false, zips: false) }.to raise_error(
+        USPSFlags::Errors::StaticFilesGenerationError, "At least one argument switch must be true out of [svg, png, zips]."
+      )
+    end
+
+    it "should not raise StaticFilesGenerationError while generating all static files" do
+      expect { USPSFlags::Generate.all }.to_not raise_error(USPSFlags::Errors::StaticFilesGenerationError)
+    end
+
+    it "should raise USPSFlags::Errors::ZipGenerationError when not given any true arguments" do
+      expect { USPSFlags::Generate.zips(svg: false, png: false) }.to raise_error(
+        USPSFlags::Errors::ZipGenerationError, "At least one argument switch must be true out of [svg, png]."
+      )
+    end
+
+    it "should not raise ZipGenerationError while generating zip files" do
+      expect { USPSFlags::Generate.zips }.to_not raise_error(USPSFlags::Errors::ZipGenerationError)
+    end
+  end
 end

data/spec/usps_flags/helpers_spec.rb

@@ -12,5 +12,13 @@ describe USPSFlags::Helpers do
         DFLT D1LT DLTC DC PSTFC PRC PVC PCC NAIDE NFLT STFC RC VC CC
       ].sort)
     end
+
+    it "should correctly generate the grid helper" do
+      expect(USPSFlags::Helpers::Builders.grid).to include("<circle cx=\"0\" cy=\"0\" r=\"#{USPSFlags::Config::BASE_FLY/60}\" fill=\"#000000\" fill-opacity=\"0.4\" />")
+    end
+
+    it "should correctly generate the locator helper" do
+      expect(USPSFlags::Helpers::Builders.locator).to include("<rect x=\"0\" y=\"0\" width=\"#{USPSFlags::Config::BASE_FLY/30}\" height=\"#{USPSFlags::Config::BASE_FLY/30}\" fill=\"#333333\" fill-opacity=\"0.6\" />")
+    end
   end
 end

data/spec/usps_flags_spec.rb

@@ -114,14 +114,14 @@ describe USPSFlags do
       expect(@flag.trim).to eql(true)
     end
 
-    it "should update svg_file" do
-      @flag.svg_file = "/path/to/svg/output.svg"
-      expect(@flag.svg_file).to eql("/path/to/svg/output.svg")
+    it "should correctly update svg_file" do
+      @flag.svg_file = "#{$tmp_alt_flags_dir}/SVG/output.svg"
+      expect(@flag.svg_file).to eql("#{$tmp_alt_flags_dir}/SVG/output.svg")
     end
 
-    it "should update png_file" do
-      @flag.png_file = "/path/to/png/output.png"
-      expect(@flag.png_file).to eql("/path/to/png/output.png")
+    it "should correctly update png_file" do
+      @flag.png_file = "#{$tmp_alt_flags_dir}/PNG/output.png"
+      expect(@flag.png_file).to eql("#{$tmp_alt_flags_dir}/PNG/output.png")
     end
 
     describe "as configured" do
@@ -138,6 +138,17 @@ describe USPSFlags do
       it "should construct and generate a flag with a valid body" do
         expect(@flag.svg).to include(@valid_body)
       end
+
+      describe "png" do
+        it "should raise PNGGenerationError without png_file set" do
+          expect { @flag.png }.to raise_error(USPSFlags::Errors::PNGGenerationError, "A path must be set with png_file.")
+        end
+
+        it "should not raise PNGGenerationError with png_file set" do
+          @flag.png_file = "#{$tmp_alt_flags_dir}/PNG/LtC.png"
+          expect { @flag.png }.to_not raise_error(USPSFlags::Errors::PNGGenerationError)
+        end
+      end
     end
   end
 end

data/usps_flags.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name          = 'usps_flags'
-  s.version       = '0.2.6'
+  s.version       = '0.3.0'
   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.2.6
+  version: 0.3.0
 platform: ruby
 authors:
 - Julian Fiander
@@ -213,6 +213,7 @@ files:
 - lib/usps_flags/core/trumpet.rb
 - lib/usps_flags/core/us.rb
 - lib/usps_flags/core/wheel.rb
+- lib/usps_flags/errors.rb
 - lib/usps_flags/generate.rb
 - lib/usps_flags/generate/flag.rb
 - lib/usps_flags/helpers.rb