usps_flags 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 00b32e5fbfbb5d0d90e1f3f449e96b89c5d3d52de7a9ea6ae6a042609bb69665
-  data.tar.gz: c35ad25ec8df45961cbf57829109ad05eacba524daf1674751f2649322ad5479
+  metadata.gz: 3a401780854a7517c7b211d59ae8c64d99f2190ece54927c9db84fea2bf33957
+  data.tar.gz: cd332320e247bd219bf094a72ab6c31a57fb642fefdc3cab889a4fb26b32cfc4
 SHA512:
-  metadata.gz: 451d050441eb4de435dc9f4463d8fcbe04b9b58d17264ce5fac69dc60d1578597f91069ba536e75fe7ed44faaca64dde43cc5c07175fb386776373e0cb5ec5d7
-  data.tar.gz: 16fd6eaf1886833465bb5a8e16a25a70b1ff381447d90fda55117d402247bb6552669b20d6d0792842bcdb4cbf473d409edc8d87dfad48091ff196c7c488a404
+  metadata.gz: a7d4c6dd949fb0402e768a3347610cf417c2926eddbb99fe319721bb4d09595d2f9886b52bcbb88728dfa6b1d556d839e992e01b4c70a62a0ceef997996f81e4
+  data.tar.gz: 0d4ab1879a6d9fc1616a8fd7b1532dd50900a824d39b958679fecbc05ab8966a64d8bb48aa5ff505d5a43ce5eb4dd764b030c0063f4fba9e4ced7ab3c1e27ece

data/.rubocop.yml

@@ -2,9 +2,11 @@ require: rubocop-rspec
 AllCops:
   TargetRubyVersion: 2.5
   Exclude:
+    - lib/output/*
     - tmp/**/*
+    - vendor/**/*
 
-Layout/IndentHash:
+Layout/IndentFirstHashElement:
   EnforcedStyle: consistent
 Layout/AccessModifierIndentation:
   EnforcedStyle: outdent
@@ -24,6 +26,8 @@ Layout/SpaceInsideHashLiteralBraces:
   EnforcedStyleForEmptyBraces: no_space
 Layout/SpaceInsideArrayLiteralBrackets:
   EnforcedStyle: no_space
+Layout/EndAlignment:
+  EnforcedStyleAlignWith: start_of_line
 
 Lint/UnusedMethodArgument:
   Enabled: true
@@ -34,12 +38,6 @@ Metrics/BlockLength:
   Exclude:
     - 'spec/**/*.rb'
 Metrics/LineLength:
-  Exclude:
-    - 'spec/**/*.rb'
-  Max: 100
-Metrics/LineLength:
-  Include:
-    - 'spec/**/*.rb'
   Max: 120
 Metrics/MethodLength:
   Enabled: true
@@ -53,11 +51,19 @@ Metrics/CyclomaticComplexity:
 Metrics/AbcSize:
   Enabled: true
 
-Rails/InverseOf:
-  Enabled: true
+Naming/UncommunicativeMethodParamName:
+  Enabled: false
+Naming/AccessorMethodName:
+  Enabled: false
 
 RSpec/MessageSpies:
   EnforcedStyle: receive
+RSpec/InstanceVariable:
+  Enabled: false
+RSpec/NestedGroups:
+  Enabled: false
+RSpec/ExampleLength:
+  Enabled: false
 
 Style/Documentation:
   Enabled: false
@@ -73,12 +79,17 @@ Style/ClassCheck:
   Enabled: true
 Style/GuardClause:
   Enabled: true
+Style/ClassAndModuleChildren:
+  EnforcedStyle: nested
+Style/GlobalVars:
+  Exclude:
+    - 'spec/**/*.rb'
+Style/ParallelAssignment:
+  Enabled: false
 
 Security/Eval:
   Enabled: true
 Security/JSONLoad:
   Enabled: true
-Security/JSONLoad:
-  Enabled: true
 Security/YAMLLoad:
   Enabled: true

data/.travis.yml

@@ -1,6 +1,6 @@
 language: ruby
 rvm:
-  - 2.4.1
+  - 2.5.1
 branches:
   except:
     - "/^v[0-9]+\\.[0-9]+\\.[0-9]+(?:-.*)?/"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    usps_flags (0.5.0)
+    usps_flags (0.5.1)
       file_utils (~> 1.1, >= 1.1.2)
       mini_magick (~> 4.8, >= 4.8.0)
       rubyzip (~> 1.2, >= 1.2.1)
@@ -41,6 +41,8 @@ GEM
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 1.7)
+    rubocop-rspec (1.33.0)
+      rubocop (>= 0.60.0)
     ruby-progressbar (1.10.1)
     rubyzip (1.2.3)
     simplecov (0.15.1)
@@ -56,7 +58,8 @@ PLATFORMS
 DEPENDENCIES
   rake (~> 12.2, >= 12.2.1)
   rspec (~> 3.7, >= 3.7.0)
-  rubocop (~> 0.59, >= 0.59.2)
+  rubocop (~> 0.71, >= 0.71.0)
+  rubocop-rspec (~> 1.30, >= 1.30.0)
   simplecov (~> 0.15, >= 0.15.1)
   usps_flags!
 

data/README.md

@@ -125,6 +125,12 @@ flag = USPSFlags.new do |f|
   f.png_file = "/path/to/png/output.png"
 end
 
+flag = USPSFlags.new(
+  type: "LtC", scale: 3, field: false, trim: true,
+  svg_file: "/path/to/svg/output.svg",
+  png_file: "/path/to/png/output.png"
+)
+
 flag.svg #=> Generates SVG file at "/path/to/svg/output.svg"
 flag.png #=> Generates PNG file at "/path/to/png/output.png"
 ```

data/lib/usps_flags.rb

@@ -1,33 +1,28 @@
 # frozen_string_literal: false
 
-# Base class for the namespace. Provides a constructor DSL.
+# Main module for the namespace.
 #
 # @author Julian Fiander
 # @since 0.1.5
 class USPSFlags
+  MODULES ||= {
+    'usps_flags' => %w[rational config helpers core generate errors],
+    'usps_flags/helpers' => %w[builders spec_arrows],
+    'usps_flags/core' => %w[
+      icons ensign field footer headers pennant tridents trident_specs trident_spec us wheel
+    ],
+    'usps_flags/generate' => %w[flag]
+  }.freeze
+
   require 'fileutils'
   require 'zip'
   require 'mini_magick'
-  require 'rational'
-
-  %w[config helpers core generate errors].each do |d|
-    require "usps_flags/#{d}"
-  end
-
-  %w[builders spec_arrows].each do |d|
-    require "usps_flags/helpers/#{d}"
-  end
 
-  %w[icons ensign field footer headers pennant tridents trident_specs trident_spec us wheel].each do |d|
-    require "usps_flags/core/#{d}"
-  end
-
-  %w[flag].each do |d|
-    require "usps_flags/generate/#{d}"
-  end
-
-  class << self
-    attr_accessor :configuration
+  MODULES.each do |parent, bases|
+    bases.each do |base|
+      res = require("#{parent}/#{base}")
+      puts "#{parent}/#{base}: #{res}" if ENV['VERBOSE_REQUIRE'] == 'true'
+    end
   end
 
   # Configuration accessor.
@@ -38,7 +33,7 @@ class USPSFlags
   # Configuration constructor.
   def self.configure
     yield(configuration) if block_given?
-    self.ensure_directories
+    ensure_directories
     @configuration
   end
 
@@ -46,9 +41,9 @@ class USPSFlags
   #
   # @private
   def self.ensure_directories
-    self.get_dir_configs
-    self.prepare_dir_configs
-    self.prepare_flags_dir
+    get_dir_configs
+    prepare_dir_configs
+    prepare_flags_dir
     ::FileUtils.mkdir_p(USPSFlags.configuration.log_path)
   end
 
@@ -56,12 +51,8 @@ class USPSFlags
   #
   # @private
   def self.get_dir_configs
-    @dirs = USPSFlags.configuration.
-      instance_variables.
-      map(&:to_s).
-      map { |v| v.match(/.*?_dir/) }.
-      reject! { |v| v.nil? }.
-      map(&:to_s)
+    @dirs = USPSFlags.configuration.instance_variables.map(&:to_s)
+                     .map { |v| v.match(/.*?_dir/) }.compact.map(&:to_s)
   end
 
   # Ensures that directories exist (and are cleared, if configured).
@@ -98,14 +89,14 @@ class USPSFlags
   #
   #  flag.svg #=> Generates SVG file at "/path/to/svg/output.svg"
   #  flag.png #=> Generates PNG file at "/path/to/png/output.png"
-  def initialize
-    @type = nil
-    @svg_file = nil
-    @png_file = nil
-    @scale = nil
-    @field = nil
-    @trim = nil
-    yield self if block_given?
+  def initialize(options = {})
+    @type = options[:type]
+    @svg_file = options[:svg_file]
+    @png_file = options[:png_file]
+    @scale = options[:scale]
+    @field = options[:field]
+    @trim = options[:trim]
+    yield(self) if block_given?
   end
 
   # Constructor accessors.
@@ -122,8 +113,8 @@ class USPSFlags
   #
   # @return [String] Returns the SVG file output path, or the svg data if no path was specified.
   def svg
-    svg = USPSFlags::Generate.svg(self.type, outfile: self.svg_file, scale: self.scale, field: self.field)
-    (self.svg_file.nil? || self.svg_file == '') ? svg : self.svg_file
+    svg = USPSFlags::Generate.svg(type, outfile: svg_file, scale: scale, field: field)
+    svg_file.nil? || svg_file == '' ? svg : svg_file
   end
 
   # Generates the constructed file as PNG.
@@ -132,12 +123,12 @@ class USPSFlags
   #
   # @return [String] Returns the SVG file output path.
   def png
-    raise USPSFlags::Errors::PNGGenerationError, 'A path must be set with png_file.' if self.png_file.nil?
+    raise USPSFlags::Errors::PNGGenerationError, 'A path must be set with png_file.' if png_file.nil?
 
-    svg_file_storage = self.svg_file
+    svg_file_storage = svg_file
     self.svg_file = ''
-    USPSFlags::Generate.png(self.svg, outfile: self.png_file, trim: self.trim)
+    USPSFlags::Generate.png(svg, outfile: png_file, trim: trim)
     self.svg_file = svg_file_storage
-    self.png_file
+    png_file
   end
 end

data/lib/usps_flags/config.rb

@@ -1,108 +1,110 @@
 # frozen_string_literal: false
 
 # Container class for configuration values.
-class USPSFlags::Config
-  BLUE ||= '#012169'
-  RED ||= '#E4002B'
-  GOLD ||= '#FFBF3F'
-  OLD_GLORY_BLUE ||= '#041E42'
-  OLD_GLORY_RED ||= '#BF0D3E'
+class USPSFlags
+  class Config
+    BLUE ||= '#012169'.freeze
+    RED ||= '#E4002B'.freeze
+    GOLD ||= '#FFBF3F'.freeze
+    OLD_GLORY_BLUE ||= '#041E42'.freeze
+    OLD_GLORY_RED ||= '#BF0D3E'.freeze
 
-  # Base measurements for most flags, before scaling
-  BASE_FLY ||= 3072
-  BASE_HOIST ||= BASE_FLY * 2 / 3
-  FRACTION_SCALE ||= 85
+    # Base measurements for most flags, before scaling
+    BASE_FLY ||= 3072
+    BASE_HOIST ||= BASE_FLY * 2 / 3
+    FRACTION_SCALE ||= 85
 
-  attr_accessor :flags_dir, :clear
+    attr_accessor :flags_dir, :clear
 
-  # Configuration constructor
-  #
-  # @param [String] flag_dir The path to the flags directory.
-  # @param [Boolean] clear Whether to clear out the specified flags_dir.
-  def initialize
-    get_defaults
-    yield self if block_given?
-  end
+    # Configuration constructor
+    #
+    # @param [String] flag_dir The path to the flags directory.
+    # @param [Boolean] clear Whether to clear out the specified flags_dir.
+    def initialize
+      get_defaults
+      yield self if block_given?
+    end
 
-  # Base configuration values for trident insignia.
-  #
-  # All other values are derived from these, or directly from the constant sizes.
-  #
-  # @return [Hash] RThe configuration values for tridents.
-  def trident
-    {
-      height: trident_heights, center_point: BASE_FLY / 2,
-      width: USPSFlags::Config::BASE_FLY * 5 / 32, bar_width: bar_width,
-      hash_width: USPSFlags::Config::BASE_FLY * 47 / 528
-    }.merge(spikes_config).merge(delta_config).merge(circle_config)
-  end
+    # Base configuration values for trident insignia.
+    #
+    # All other values are derived from these, or directly from the constant sizes.
+    #
+    # @return [Hash] RThe configuration values for tridents.
+    def trident
+      {
+        height: trident_heights, center_point: BASE_FLY / 2,
+        width: USPSFlags::Config::BASE_FLY * 5 / 32, bar_width: bar_width,
+        hash_width: USPSFlags::Config::BASE_FLY * 47 / 528
+      }.merge(spikes_config).merge(delta_config).merge(circle_config)
+    end
 
-  # Height values for trident insignia.
-  #
-  # @return [Hash] The height values for tridents.
-  def trident_heights
-    {
-      s:   USPSFlags::Config::BASE_HOIST / 2,
-      d:   USPSFlags::Config::BASE_HOIST * 5 / 8,
-      stf: USPSFlags::Config::BASE_HOIST * 3 / 4,
-      n:   USPSFlags::Config::BASE_HOIST * 3 / 4
-    }
-  end
+    # Height values for trident insignia.
+    #
+    # @return [Hash] The height values for tridents.
+    def trident_heights
+      {
+        s: USPSFlags::Config::BASE_HOIST / 2,
+        d: USPSFlags::Config::BASE_HOIST * 5 / 8,
+        stf: USPSFlags::Config::BASE_HOIST * 3 / 4,
+        n: USPSFlags::Config::BASE_HOIST * 3 / 4
+      }
+    end
 
-  # Alias for the directory to store generated log files.
-  #
-  # @return [String] The current path to the logs directory.
-  def log_path
-    if defined?(::Rails)
-      "#{::Rails.root}/log"
-    else
-      "#{USPSFlags.configuration.flags_dir}/log"
+    # Alias for the directory to store generated log files.
+    #
+    # @return [String] The current path to the logs directory.
+    def log_path
+      if defined?(::Rails)
+        "#{::Rails.root}/log"
+      else
+        "#{USPSFlags.configuration.flags_dir}/log"
+      end
     end
-  end
 
-private
+  private
 
-  def get_defaults
-    @flags_dir = if defined?(::Rails)
-      "#{::Rails.root}/app/assets/images/usps-flags"
-    else
-      "#{File.dirname(__dir__)}/output"
+    def get_defaults
+      @flags_dir = if defined?(::Rails)
+        "#{::Rails.root}/app/assets/images/usps-flags"
+      else
+        "#{File.dirname(__dir__)}/output"
+      end
+      @use_larger_tridents = true
+      @clear = false
     end
-    @use_larger_tridents = true
-    @clear = false
-  end
 
-  def center_point_height
-    USPSFlags::Config::BASE_FLY / 48 * 23 / 8
-  end
+    def center_point_height
+      USPSFlags::Config::BASE_FLY / 48 * 23 / 8
+    end
 
-  def side_point_height
-    USPSFlags::Config::BASE_FLY / 48 * 21 / 8
-  end
+    def side_point_height
+      USPSFlags::Config::BASE_FLY / 48 * 21 / 8
+    end
 
-  def bar_width
-    USPSFlags::Config::BASE_FLY / 48 * 5 / 4
-  end
+    def bar_width
+      USPSFlags::Config::BASE_FLY / 48 * 5 / 4
+    end
 
-  def spikes_config
-    {
-      center_point_height: center_point_height, side_point_height: side_point_height,
-      main_point_barb: USPSFlags::Config::BASE_HOIST / 82,
-      crossbar_from_top: USPSFlags::Config::BASE_HOIST / 4 + bar_width / 5,
-      side_spike_height: USPSFlags::Config::BASE_HOIST / 4 - side_point_height - bar_width * 3 / 5
-    }
-  end
+    def spikes_config
+      {
+        center_point_height: center_point_height, side_point_height: side_point_height,
+        main_point_barb: USPSFlags::Config::BASE_HOIST / 82,
+        crossbar_from_top: USPSFlags::Config::BASE_HOIST / 4 + bar_width / 5,
+        side_spike_height: USPSFlags::Config::BASE_HOIST / 4 - side_point_height - bar_width * 3 / 5
+      }
+    end
 
-  def delta_config
-    {
-      delta_height: USPSFlags::Config::BASE_FLY * 33 / 240, delta_gap_height: USPSFlags::Config::BASE_FLY / 16,
-      delta_gap_width: bar_width * 5 / 4, delta_width: USPSFlags::Config::BASE_FLY * 43 / 768,
-      delta_from_bottom: USPSFlags::Config::BASE_HOIST * 10 / 64, delta_gap_scale: 0.40,
-      delta_gap_x: USPSFlags::Config::BASE_HOIST * 144 / 128, delta_gap_y: USPSFlags::Config::BASE_HOIST * 221 / 256
-    }
-  end
+    def delta_config
+      {
+        delta_height: USPSFlags::Config::BASE_FLY * 33 / 240, delta_gap_height: USPSFlags::Config::BASE_FLY / 16,
+        delta_gap_width: bar_width * 5 / 4, delta_width: USPSFlags::Config::BASE_FLY * 43 / 768,
+        delta_from_bottom: USPSFlags::Config::BASE_HOIST * 10 / 64, delta_gap_scale: 0.40,
+        delta_gap_x: USPSFlags::Config::BASE_HOIST * 144 / 128, delta_gap_y: USPSFlags::Config::BASE_HOIST * 221 / 256
+      }
+    end
 
-  def circle_config
-    { circle_height_adj: USPSFlags::Config::BASE_FLY / 800 }
+    def circle_config
+      { circle_height_adj: USPSFlags::Config::BASE_FLY / 800 }
+    end
   end
 end