usps_flags 0.5.0 → 0.5.1

data/spec/usps_flags/helpers_spec.rb

@@ -4,24 +4,24 @@ require 'spec_helper'
 
 describe USPSFlags::Helpers do
   describe 'valid_flags' do
-    it 'should return an Array' do
-      expect(USPSFlags::Helpers.valid_flags).to be_an(Array)
+    it 'returns an Array' do
+      expect(described_class.valid_flags).to be_an(Array)
     end
 
-    it 'should return all officer flags but nothing else when given type :officer' do
-      expect(USPSFlags::Helpers.valid_flags(:officer).sort).to eql(%w[
+    it 'returns all officer flags but nothing else when given type :officer' do
+      expect(described_class.valid_flags(:officer).sort).to eql(%w[
         PLTC PC PORTCAP FLEETCAP LT FLT 1LT LTC CDR PDLTC PDC DLT DAIDE
         DFLT D1LT DLTC DC PSTFC PRC PVC PCC NAIDE NFLT STFC RC VC CC
       ].sort)
     end
 
-    it 'should correctly generate the grid helper' do
+    it 'correctlies 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
+    it 'correctlies 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\" />"
@@ -30,9 +30,9 @@ describe USPSFlags::Helpers do
   end
 
   describe 'resize_png' do
-    it 'should raise USPSFlags::Errors::PNGConversionError with invalid parameters' do
+    it 'raises USPSFlags::Errors::PNGConversionError with invalid parameters' do
       expect do
-        USPSFlags::Helpers.resize_png('path/to/image.png', size: 100, size_key: 'thumb')
+        described_class.resize_png('path/to/image.png', size: 100, size_key: 'thumb')
       end.to raise_error(USPSFlags::Errors::PNGConversionError)
     end
   end

data/spec/usps_flags/rational_spec.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: false
+
+require 'spec_helper'
+
+describe USPSFlags::Rational do
+  it 'renders a simplified fraction as an Array' do
+    expect(described_class.new(Rational(4, 3)).to_simplified_a).to eql([1, Rational(1, 3)])
+  end
+
+  it 'renders a proper fraction as String' do
+    expect(described_class.new(Rational(2, 3)).to_simplified_a).to eql('2/3')
+  end
+
+  it 'renders a simplified fraction as a String' do
+    expect(described_class.new(Rational(4, 3)).to_simplified_s).to eql('1 1/3')
+  end
+end

data/spec/usps_flags_spec.rb

@@ -3,7 +3,7 @@
 require 'spec_helper'
 
 describe USPSFlags do
-  before(:all) do
+  before do
     @valid_header = <<~SVG
       <?xml version="1.0" standalone="no"?>
       <!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 20010904//EN" "http://www.w3.org/TR/2001/REC-SVG-20010904/DTD/svg10.dtd">
@@ -88,76 +88,74 @@ describe USPSFlags do
       </g>
       </svg>
     SVG
-  end
 
-  before(:each) do
-    @flag = USPSFlags.new
+    @flag = described_class.new
   end
 
   describe 'constructor' do
-    it 'should update type' do
+    it 'updates type' do
       @flag.type = 'LtC'
       expect(@flag.type).to eql('LtC')
     end
 
-    it 'should update scale' do
+    it 'updates scale' do
       @flag.scale = 4
-      expect(@flag.scale).to eql(4)
+      expect(@flag.scale).to be(4)
     end
 
-    it 'should update field' do
+    it 'updates field' do
       @flag.field = false
-      expect(@flag.field).to eql(false)
+      expect(@flag.field).to be(false)
     end
 
-    it 'should update trim' do
+    it 'updates trim' do
       @flag.trim = true
-      expect(@flag.trim).to eql(true)
+      expect(@flag.trim).to be(true)
     end
 
-    it 'should correctly update svg_file' do
+    it 'correctlies 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 correctly update png_file' do
+    it 'correctlies 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
-      before(:each) do
+      before do
         @flag.type = 'LtC'
         @flag.scale = 5
         @flag.svg_file = ''
       end
 
-      it 'should construct and generate a flag with a valid header' do
+      it 'constructs and generate a flag with a valid header' do
         expect(@flag.svg).to include(@valid_header)
       end
 
-      it 'should construct and generate a flag with a valid body' do
+      it 'constructs 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
+        it 'raises PNGGenerationError without png_file set' do
           expect { @flag.png }.to raise_error(
             USPSFlags::Errors::PNGGenerationError, 'A path must be set with png_file.'
           )
         end
 
         context 'with png_file set' do
-          before(:each) do
+          before do
             @flag.png_file = "#{$tmp_alt_flags_dir}/PNG/LtC.png"
             ::FileUtils.mkdir_p("#{$tmp_alt_flags_dir}/PNG/")
           end
 
-          it 'should not raise PNGGenerationError with png_file set' do
-            expect { @flag.png }.to_not raise_error
+          it 'does not raise PNGGenerationError with png_file set' do
+            expect { @flag.png }.not_to raise_error
           end
 
-          it 'should return the value of png_file' do
+          it 'returns the value of png_file' do
             expect(@flag.png).to eql("#{$tmp_alt_flags_dir}/PNG/LtC.png")
           end
         end

data/usps_flags.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name          = 'usps_flags'
-  s.version       = '0.5.0'
+  s.version       = '0.5.1'
   s.date          = '2019-06-07'
   s.summary       = 'Flag generator for United States Power Squadrons'
   s.description   = 'A flag image (PNG, SVG) generator for United States Power Squadrons.'
@@ -14,14 +14,15 @@ Gem::Specification.new do |s|
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- spec/*`.split("\n")
 
-  s.required_ruby_version = '~> 2.4'
+  s.required_ruby_version = '~> 2.5'
 
   s.add_runtime_dependency 'file_utils',    '~> 1.1',  '>= 1.1.2'
   s.add_runtime_dependency 'mini_magick',   '~> 4.8',  '>= 4.8.0'
   s.add_runtime_dependency 'rubyzip',       '~> 1.2',  '>= 1.2.1'
 
-  s.add_development_dependency 'rake',      '~> 12.2', '>= 12.2.1'
-  s.add_development_dependency 'rspec',     '~> 3.7',  '>= 3.7.0'
-  s.add_development_dependency 'rubocop',   '~> 0.59', '>= 0.59.2'
-  s.add_development_dependency 'simplecov', '~> 0.15', '>= 0.15.1'
+  s.add_development_dependency 'rake',          '~> 12.2', '>= 12.2.1'
+  s.add_development_dependency 'rspec',         '~> 3.7',  '>= 3.7.0'
+  s.add_development_dependency 'rubocop',       '~> 0.71', '>= 0.71.0'
+  s.add_development_dependency 'rubocop-rspec', '~> 1.30', '>= 1.30.0'
+  s.add_development_dependency 'simplecov',     '~> 0.15', '>= 0.15.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: usps_flags
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Julian Fiander
@@ -116,20 +116,40 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.59'
+        version: '0.71'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.59.2
+        version: 0.71.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.59'
+        version: '0.71'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.59.2
+        version: 0.71.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.30'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.30.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.30'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.30.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -167,7 +187,6 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- lib/rational.rb
 - lib/usps_flags.rb
 - lib/usps_flags/config.rb
 - lib/usps_flags/core.rb
@@ -190,8 +209,11 @@ files:
 - lib/usps_flags/core/trident_specs/circle.rb
 - lib/usps_flags/core/trident_specs/delta.rb
 - lib/usps_flags/core/trident_specs/header.rb
+- lib/usps_flags/core/trident_specs/horizontal.rb
 - lib/usps_flags/core/trident_specs/long.rb
+- lib/usps_flags/core/trident_specs/overlay.rb
 - lib/usps_flags/core/trident_specs/short.rb
+- lib/usps_flags/core/trident_specs/vertical.rb
 - lib/usps_flags/core/tridents.rb
 - lib/usps_flags/core/us.rb
 - lib/usps_flags/core/us_defs.svg.partial
@@ -200,17 +222,19 @@ files:
 - lib/usps_flags/errors.rb
 - lib/usps_flags/generate.rb
 - lib/usps_flags/generate/flag.rb
-- lib/usps_flags/generate/private.rb
+- lib/usps_flags/generate/generator_methods.rb
+- lib/usps_flags/generate/helper_methods.rb
 - lib/usps_flags/helpers.rb
 - lib/usps_flags/helpers/builders.rb
 - lib/usps_flags/helpers/spec_arrows.rb
 - lib/usps_flags/helpers/valid_flags.rb
-- spec/rational_spec.rb
+- lib/usps_flags/rational.rb
 - spec/spec_helper.rb
 - spec/usps_flags/config_spec.rb
 - spec/usps_flags/core_spec.rb
 - spec/usps_flags/generate_spec.rb
 - spec/usps_flags/helpers_spec.rb
+- spec/usps_flags/rational_spec.rb
 - spec/usps_flags_spec.rb
 - usps_flags.gemspec
 homepage: http://rubygems.org/gems/usps_flags
@@ -227,7 +251,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - "~>"
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -240,10 +264,10 @@ signing_key:
 specification_version: 4
 summary: Flag generator for United States Power Squadrons
 test_files:
-- spec/rational_spec.rb
 - spec/spec_helper.rb
 - spec/usps_flags/config_spec.rb
 - spec/usps_flags/core_spec.rb
 - spec/usps_flags/generate_spec.rb
 - spec/usps_flags/helpers_spec.rb
+- spec/usps_flags/rational_spec.rb
 - spec/usps_flags_spec.rb

data/lib/rational.rb

@@ -1,39 +0,0 @@
-# frozen_string_literal: false
-
-# Monkey patch to add some formatting methods to Rational.
-#
-# @author Julian Fiander
-# @since 0.1.5
-class Rational
-  # Converts Rational to String
-  #
-  # If Rational is an improper fraction, removes the integer part to convert to a mixed fraction.
-  #
-  # @example Mixed fraction
-  #   Rational(4,3).to_simplified_s #=> "1 1/3"
-  # @return [String] If less than 1, fraction. If greater than 1, a mixed fraction.
-  def to_simplified_s
-    if self < 1
-      to_s
-    else
-      truncated = self.truncate
-      "#{truncated} #{self - truncated}"
-    end
-  end
-
-  # Converts Rational to Array
-  #
-  # If Rational is an improper fraction, removes the integer part to convert to a mixed fraction.
-  #
-  # @example Mixed fraction
-  #   Rational(4,3).to_simplified_a #=> [1, Rational(1,3)]
-  # @return [Array] If less than 1, fraction. If greater than 1, a mixed fraction.
-  def to_simplified_a
-    if self < 1
-      to_s
-    else
-      truncated = self.truncate
-      [truncated, (self - truncated)]
-    end
-  end
-end

data/lib/usps_flags/generate/private.rb

@@ -1,199 +0,0 @@
-# frozen_string_literal: false
-
-# Private methods for USPSFlags::Generator.
-#
-# These methods should never need to be called directly.
-# @private
-module USPSFlags::Generate::Private
-private
-
-  def any_all_arg?(svg, png, zips, reset)
-    svg || png || zips || reset
-  end
-
-  def all_arg_error
-    raise(
-      USPSFlags::Errors::StaticFilesGenerationError,
-      'At least one argument switch must be true out of [svg, png, zips, reset].'
-    )
-  end
-
-  def track_time(simple: false)
-    overall_start_time = Time.now
-    yield
-    end_time = Time.now - overall_start_time
-    simple ? end_time : USPSFlags::Helpers.log("\nTotal run time: #{end_time} s\n\n")
-  end
-
-  def remove_static_files
-    ['SVG', 'PNG', 'ZIP'].each do |dir|
-      dir_path = "#{USPSFlags.configuration.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.configuration.flags_dir}/#{dir}") }
-    USPSFlags::Helpers.log "\n - Cleared previous files.\n"
-  end
-
-  def set_file_paths
-    @svg_file = "#{USPSFlags.configuration.flags_dir}/SVG/#{@flag}.svg"
-    @png_file = @svg_file.gsub('/SVG/', '/PNG/').gsub('.svg', '.png')
-    @svg_ins_file = @svg_file.gsub('/SVG/', '/SVG/insignia/')
-    @png_ins_file = @svg_file.gsub('/SVG/', '/PNG/insignia/').gsub('.svg', '.png')
-    [@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.configuration.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)
-    no_dir = [USPSFlags::Errors::ZipGenerationError, 'Flags directory not found.']
-    raise *no_dir unless ::Dir.exist?("#{USPSFlags.configuration.flags_dir}/ZIP")
-
-    zip = "#{USPSFlags.configuration.flags_dir}/ZIP/USPS_Flags.#{type}.zip"
-    ::File.delete(zip) if ::File.exist?(zip)
-    write_zip_file(zip, type)
-
-    puts "Generated #{type.upcase} Zip"
-  end
-
-  def write_zip_file(zip, type)
-    ::Zip::File.open(zip, ::Zip::File::CREATE) do |z|
-      ::Dir.glob("#{USPSFlags.configuration.flags_dir}/#{type.upcase}/**/*").each do |f|
-        add_to_zip(z, f)
-      end
-    end
-  end
-
-  def add_to_zip(z, f)
-    filename = f.split('/').last
-    filename = "insignia/#{filename}" if f.split('/').last(2).first == 'insignia'
-    z.add(filename, f)
-  end
-
-  def generate_static_images_for(flag, svg: true, png: true)
-    run_time = track_time(simple: true) do
-      @flag = flag.upcase
-      USPSFlags::Helpers.log "#{@flag.rjust(USPSFlags::Helpers.max_flag_name_length)} |"
-      set_file_paths
-      generate_requested_images(svg, png)
-    end
-
-    USPSFlags::Helpers.log " | #{run_time.round(4).to_s[(0..5)].ljust(6, '0')} s\n"
-  end
-
-  def generate_requested_images(svg, png)
-    svg ? generate_static_svg : USPSFlags::Helpers.log('-')
-    png ? generate_static_png : USPSFlags::Helpers.log('- ')
-  end
-
-  def generate_static_svg
-    USPSFlags::Helpers.log ' '
-
-    generate_regular_svg
-    generate_insignia_svg
-  end
-
-  def generate_regular_svg
-    return if file_found?(@svg_file)
-
-    svg @flag, outfile: @svg_file, scale: 1
-    USPSFlags::Helpers.log 'S'
-  end
-
-  def generate_insignia_svg
-    return if no_insignia?
-
-    svg @flag, field: false, outfile: @svg_ins_file, scale: 1
-    USPSFlags::Helpers.log 'I'
-  end
-
-  def set_temp_svg(svg)
-    @temp_svg_path = "#{USPSFlags.configuration.flags_dir}/temp.svg"
-    temp_svg = ::File.new(@temp_svg_path, 'w+')
-    temp_svg.write(svg)
-    temp_svg.flush
-    @temp_svg_path
-  end
-
-  def delete_temp_svg?
-    !@temp_svg_path.to_s.empty? && ::File.exist?(@temp_svg_path)
-  end
-
-  def generate_static_png
-    USPSFlags::Helpers.log '  | '
-    generate_fullsize_png
-    generate_fullsize_png_insignia
-    generate_reduced_size_pngs
-  end
-
-  def generate_fullsize_png
-    return if file_found?(@png_file)
-
-    png(File.read(@svg_file), outfile: @png_file)
-    USPSFlags::Helpers.log 'F'
-  end
-
-  def generate_fullsize_png_insignia
-    return if no_insignia?
-    return if file_found?(@png_ins_file)
-
-    png(File.read(@svg_ins_file), outfile: @png_ins_file, trim: true)
-    USPSFlags::Helpers.log 'I'
-  end
-
-  def generate_reduced_size_pngs
-    USPSFlags::Helpers.png_sizes.keys.each do |size|
-      size, size_key = USPSFlags::Helpers.size_and_key(size: size, flag: @flag)
-      @sized_png_file = "#{USPSFlags.configuration.flags_dir}/PNG/#{@flag}.#{size_key}.png"
-      @sized_png_ins_file = @sized_png_file.gsub('/PNG/', '/PNG/insignia/')
-
-      generate_smaller_png(size, size_key)
-      generate_smaller_png_insignia(size, size_key)
-    end
-  end
-
-  def generate_smaller_png(size, size_key)
-    return if file_found?(@sized_png_file)
-    return if too_big?(@png_file, size)
-
-    USPSFlags::Helpers.resize_png(@png_file, file: @flag, size: size, size_key: size_key)
-    USPSFlags::Helpers.log USPSFlags::Helpers.png_sizes[size_key]
-  end
-
-  def generate_smaller_png_insignia(size, size_key)
-    return if no_insignia?
-    return if file_found?(@sized_png_ins_file)
-    return if too_big?(@png_ins_file, size)
-
-    USPSFlags::Helpers.resize_png(@png_ins_file, file: "insignia/#{@flag}", size: size, size_key: size_key)
-    USPSFlags::Helpers.log 'i'
-  end
-
-  def no_insignia?
-    return false if USPSFlags::Helpers.valid_flags(:insignia).include?(@flag)
-
-    USPSFlags::Helpers.log '-'
-    true
-  end
-
-  def file_found?(file)
-    return false unless ::File.exist?(file)
-
-    USPSFlags::Helpers.log '.'
-    true
-  end
-
-  def too_big?(file, size)
-    return false unless size > MiniMagick::Image.open(file)[:width]
-
-    USPSFlags::Helpers.log '+'
-    true
-  end
-end