usps_flags 0.3.10 → 0.3.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4d85ccc10a610da7a9847f5543e7d907ff15fd5e
-  data.tar.gz: c7affbfa94639f5b621ed8c753a8d4f2a48ec8c7
+  metadata.gz: 912c06bbc43cfe66768f59b678da12adaecd9964
+  data.tar.gz: 44107e8638acf16858899949fc6b29198844f742
 SHA512:
-  metadata.gz: f6524af08c48876941a3f3600ec93551d937e7fa45eaccf14efca7cc2122652db3c5fde7749b2fca2e478e881cfed8e9f88017bfa6abafb42212ab5ed80121ae
-  data.tar.gz: 83dca9e5580e3405a92940525ed21cc33b26b59a3b41101b700d8b63f0ab32e8b96b18a5908a994255f015629f3bc81d1ad46c7cc3b1704cacdfdb4c55bbc91b
+  metadata.gz: eb93a2912820cc42b41a03d1c1deab2fb3caec1a2ccec47c9a0e2ab38e3e930ba1afbcf0510e22d1c6b6a032cdf2619bd4a6cebf413587938ad45a1d0c6b6688
+  data.tar.gz: bf314db590a8cd310e92155ba5dba21a5bde8773c21ab37faf1d0c6428144a3e554a01dcd392e9b84b15a2269593e9c5143b96b3feb93ddc72a5136dff22f084

checksums.yaml.gz.sig

@@ -1,2 +1,2 @@
-X�cȬ�4K�0��r��T��h!�պF::�'������+��(7-C�������)�f}vR�?�-�L	��
��@y��{?㥔繌!/��zUT�J;4���S����C
-[�.�S�S�7-�I`i��lR|�r��fK�zF4���Y{t15PF�K����EV�lKC~a��G#0<֧�<x ��{$1��k���d@�)4G�JpH�)��F�/�*H�2al'f��ä�V?��Ԕ*nj�g�
+B�wA[�zs���R1p����q�Ң^�������M�����̡�
�l����d*���>n
+����RK�ՖBӴPm�b}E�|m�*Ԫ���YI�f��Iw2���f/L	P����j���jsI��8�!Z/xU�}%kJ7��-C�!Q�XQ}�=_f튧�Ɓx���;큒���c<�\X6>qo�L�Q�'.��^˻\g�Ib��g�GN�:l,��ܧ�Lӈc

data/Gemfile.lock

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

data/README.md

@@ -21,7 +21,7 @@ gem 'usps_flags'
 Create the file `config/initializers/usps_flags.rb`:
 
 ```ruby
-USPSFlags::Config.new do |config|
+USPSFlags.configure do |config|
   config.flags_dir "#{Rails.root}/app/assets/images/flags"
 end
 ```

data/lib/usps_flags/config.rb

@@ -8,35 +8,27 @@ class USPSFlags::Config
   BASE_HOIST ||= BASE_FLY*2/3
   FRACTION_SCALE ||= 85
 
-  @@flags_dir = "#{File.dirname(__dir__)}/output"
-  @@use_larger_tridents = true
-  @@reset = false
+  attr_accessor :flags_dir, :clear, :use_larger_tridents
   
   # 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] reset Whether to clear out the specified flags_dir.
+  # @param [Boolean] clear Whether to clear out the specified flags_dir.
   def initialize
-    load_init_variables
+    get_defaults
     yield self if block_given?
-    set_class_variables
-    set_flags_dir(reset: @reset)
   end
 
-  attr_accessor :flags_dir
-  attr_accessor :reset
-  attr_accessor :use_larger_tridents
-
   # 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 self.trident
+  def trident
     point_height = USPSFlags::Config::BASE_FLY/48*17/8
     bar_width = USPSFlags::Config::BASE_FLY/48
-    bar_width = bar_width*5/4 if self.use_larger_tridents
+    bar_width = bar_width*5/4 if USPSFlags.configuration.use_larger_tridents
     {
       height: trident_heights,
 
@@ -57,8 +49,8 @@ class USPSFlags::Config
       hash_width: USPSFlags::Config::BASE_FLY*3/32,
 
       delta_height: USPSFlags::Config::BASE_FLY*2/15,
-      delta_gap_height: self.use_larger_tridents ? USPSFlags::Config::BASE_FLY*14/256 : USPSFlags::Config::BASE_FLY*17/256,
-      delta_gap_width: self.use_larger_tridents ? bar_width*5/4 : bar_width*7/4,
+      delta_gap_height: USPSFlags.configuration.use_larger_tridents ? USPSFlags::Config::BASE_FLY*14/256 : USPSFlags::Config::BASE_FLY*17/256,
+      delta_gap_width: USPSFlags.configuration.use_larger_tridents ? bar_width*5/4 : bar_width*7/4,
       delta_width: USPSFlags::Config::BASE_FLY*43/768,
       delta_from_bottom: USPSFlags::Config::BASE_HOIST*11/64,
       delta_gap_scale: 0.40,
@@ -72,7 +64,7 @@ class USPSFlags::Config
   # Height values for trident insignia.
   #
   # @return [Hash] The height values for tridents.
-  def self.trident_heights
+  def trident_heights
     {
       s:   USPSFlags::Config::BASE_HOIST/2,
       d:   USPSFlags::Config::BASE_HOIST*5/8,
@@ -81,68 +73,25 @@ class USPSFlags::Config
     }
   end
 
-  # Accessor for the directory for storing generated flags.
-  #
-  # @return [String] The current path to the flags directory.
-  def self.flags_dir
-    @@flags_dir || if defined?(::Rails)
-      "#{::Rails.root}/app/assets/images/usps-flags"
-    else
-      "#{File.dirname(__dir__)}/output"
-    end
-  end
-
   # Alias for the directory to store generated log files.
   #
   # @return [String] The current path to the logs directory.
-  def self.log_path
-    log_path = if defined?(::Rails)
+  def log_path
+    if defined?(::Rails)
       "#{::Rails.root}/log"
     else
-      "#{@@flags_dir}/log"
+      "#{USPSFlags.configuration.flags_dir}/log"
     end
-    ::FileUtils.mkdir_p(log_path)
-    log_path
-  end
-
-  # Accessor for the boolean of whether to use the larger or smaller trident width.
-  #
-  # @return [Boolean] Returns the current setting.
-  def self.use_larger_tridents
-    # Smaller: 1/2 in width on 24in x 16in field
-    # Larger:  5/8 in width on 24in x 16in field
-    @@use_larger_tridents
-  end
-
-  # Accessor for the boolean of whether to clear the flags_dir.
-  #
-  # @return [Boolean] Returns the current setting.
-  def self.reset
-    @@reset
   end
 
   private
-  def load_init_variables
-    @flags_dir = @@flags_dir
-    @use_larger_tridents = @@use_larger_tridents
-    @reset = @@reset
-  end
-
-  def set_class_variables
-    @@flags_dir = @flags_dir
-    @@use_larger_tridents = @use_larger_tridents
-    @@reset = @reset
-  end
-
-  def set_flags_dir(reset: false)
-    return false if @@flags_dir.nil? || @@flags_dir.empty?
-    ::FileUtils.rm_rf(@@flags_dir) if reset
-    [
-      "#{@@flags_dir}/SVG/insignia",
-      "#{@@flags_dir}/PNG/insignia",
-      "#{@@flags_dir}/ZIP"
-    ].each do |dir|
-      ::FileUtils.mkdir_p(dir)
+  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
 end

data/lib/usps_flags/core/trident.rb

@@ -41,7 +41,7 @@ class USPSFlags::Core::Trident
 
   private
   def load_config
-    @trident_config = USPSFlags::Config.trident
+    @trident_config = USPSFlags.configuration.trident
     @main_spike_overhang = @trident_config[:bar_width] / 2
     @side_spike_overhang = @trident_config[:bar_width] / 2
     @top_point = ((USPSFlags::Config::BASE_HOIST - @trident_config[:height][@type]) / 2)

data/lib/usps_flags/core/trident_spec.rb

@@ -4,7 +4,7 @@
 # @private
 class USPSFlags::Core::TridentSpec
   def initialize(fly: 24, unit: "in")
-    @trident_config = USPSFlags::Config.trident
+    @trident_config = USPSFlags.configuration.trident
     configure_sizes(fly)
     configure_labels(unit)
   end

data/lib/usps_flags/generate.rb

@@ -103,15 +103,15 @@ class USPSFlags::Generate
     private
     def remove_static_files
       ["SVG", "PNG", "ZIP"].each do |dir|
-        dir_path = "#{USPSFlags::Config.flags_dir}/#{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::Config.flags_dir}/#{dir}") }
+      ["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::Config.flags_dir}/SVG/#{@flag}.svg"
+      @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")
@@ -122,20 +122,20 @@ class USPSFlags::Generate
       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 "\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)
-      raise USPSFlags::Errors::ZipGenerationError, "Flags directory not found." unless ::Dir.exist?("#{USPSFlags::Config.flags_dir}/ZIP")
+      raise USPSFlags::Errors::ZipGenerationError, "Flags directory not found." unless ::Dir.exist?("#{USPSFlags.configuration.flags_dir}/ZIP")
 
-      zip = "#{USPSFlags::Config.flags_dir}/ZIP/USPS_Flags.#{type}.zip"
+      zip = "#{USPSFlags.configuration.flags_dir}/ZIP/USPS_Flags.#{type}.zip"
       ::File.delete(zip) if ::File.exist?(zip)
 
       ::Zip::File.open(zip, Zip::File::CREATE) do |z|
-        ::Dir.glob("#{USPSFlags::Config.flags_dir}/#{type.upcase}/**/*").each do |f|
+        ::Dir.glob("#{USPSFlags.configuration.flags_dir}/#{type.upcase}/**/*").each do |f|
           add_to_zip(z, f)
         end
       end
@@ -200,7 +200,7 @@ class USPSFlags::Generate
     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::Config.flags_dir}/PNG/#{@flag}.#{size_key}.png"
+        @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)

data/lib/usps_flags/helpers.rb

@@ -29,7 +29,7 @@ class USPSFlags::Helpers
     # @param [String] size_key Size suffix to attach to the file name.
     def resize_png(png_file, file: nil, outfile: nil, size:, size_key:)
       raise USPSFlags::Errors::PNGConversionError if outfile.nil? && file.nil?
-      output_file_name = outfile || "#{USPSFlags::Config.flags_dir}/PNG/#{file}.#{size_key}.png"
+      output_file_name = outfile || "#{USPSFlags.configuration.flags_dir}/PNG/#{file}.#{size_key}.png"
       MiniMagick::Tool::Convert.new do |convert|
         convert << "-background" << "none"
         convert << "-format" << "png"
@@ -93,10 +93,10 @@ class USPSFlags::Helpers
     # This should never need to be called directly.
     # @private
     def log(*messages)
-      ::FileUtils.mkdir_p(USPSFlags::Config.log_path)
+      ::FileUtils.mkdir_p(USPSFlags.configuration.log_path)
       outputs = [STDOUT]
 
-      log_file = File.open("#{USPSFlags::Config.log_path}/flag.log", 'a')
+      log_file = File.open("#{USPSFlags.configuration.log_path}/flag.log", 'a')
       outputs << log_file
 
       messages.each do |message|

data/lib/usps_flags.rb

@@ -29,6 +29,33 @@ class USPSFlags
     require "usps_flags/helpers/#{d}"
   end
 
+  class << self
+    attr_accessor :configuration
+  end
+
+  # Configuration accessor.
+  def self.configuration
+    @configuration ||= USPSFlags::Config.new
+  end
+
+  # Configuration constructor.
+  def self.configure
+    yield(configuration)
+    self.ensure_directories
+    @configuration
+  end
+
+  # Ensures the directory structure exists.
+  #
+  # @private
+  def self.ensure_directories
+    ::FileUtils.rm_rf(@configuration.flags_dir) if @configuration.clear
+    ::FileUtils.mkdir_p("#{@configuration.flags_dir}/PNG/insignia")
+    ::FileUtils.mkdir_p("#{@configuration.flags_dir}/SVG/insignia")
+    ::FileUtils.mkdir_p("#{@configuration.flags_dir}/ZIP")
+    ::FileUtils.mkdir_p(USPSFlags.configuration.log_path)
+  end
+
   # Constructor for individual flags.
   #
   # @example Generate insignia at default scale for Lt/C
@@ -53,43 +80,15 @@ class USPSFlags
     yield self if block_given?
   end
 
-  # Constructor accessor for the flag type.
+  # Constructor accessors.
   #
   # @param [String] type The type of flag to generate.
-  # @return [String]
-  attr_accessor :type
-
-  # Constructor accessor for the SVG file output path.
-  #
   # @param [String] svg_file The SVG file output path.
-  # @return [String] Returns the current (or updated) SVG file output path.
-  attr_accessor :svg_file
-
-  # Constructor accessor for the PNG file output path.
-  #
   # @param [String] png_file The PNG file output path.
-  # @return [String] Returns the current (or updated) PNG file output path.
-  attr_accessor :png_file
-
-  # Constructor accessor for the image scale divisor factor.
-  #
-  # Available options are Float between 0 and 1, or Integer above 1.
-  #
   # @param [Integer, Float] scale The scale divisor factor.
-  # @return [Integer, Float] Returns the current (or updated) scaling factor.
-  attr_accessor :scale
-
-  # Constructor accessor for whether to generate the flag field (including any border).
-  #
   # @param [Boolean] field The field setting.
-  # @return [Boolean] Returns the current (or updated) setting.
-  attr_accessor :field
-
-  # Constructor accessor for whether to trim the generated PNG file of excess transparency.
-  #
   # @param [Boolean] trim The trim setting.
-  # @return [String] Returns the current (or updated) setting.
-  attr_accessor :trim
+  attr_accessor :type, :svg_file, :png_file, :scale, :field, :trim
 
   # Generates the constructed file as SVG.
   #

data/spec/spec_helper.rb

@@ -13,7 +13,7 @@ RSpec.configure do |config|
     $tmp_flags_dir = "tmp/flags"
     $tmp_alt_flags_dir = "tmp/alt_flags"
 
-    USPSFlags::Config.new do |c|
+    USPSFlags.configure do |c|
       c.flags_dir = $tmp_flags_dir
     end
   end

data/spec/usps_flags/config_spec.rb

@@ -3,38 +3,38 @@ require 'spec_helper'
 describe USPSFlags::Config do
   describe "class variable accessors" do
     it "should return the current flags directory" do
-      expect(USPSFlags::Config.flags_dir).to eql($tmp_flags_dir)
+      expect(USPSFlags.configuration.flags_dir).to eql($tmp_flags_dir)
     end
 
     it "should return the current flags directory" do
       default_log_path = $tmp_flags_dir + "/log"
-      expect(USPSFlags::Config.log_path).to eql(default_log_path)
+      expect(USPSFlags.configuration.log_path).to eql(default_log_path)
     end
 
     it "should return a Boolean from use_larger_tridents" do
-      expect([true, false]).to include(USPSFlags::Config.use_larger_tridents)
+      expect([true, false]).to include(USPSFlags.configuration.use_larger_tridents)
     end
 
-    it "should return a Boolean from reset" do
-      expect([true, false]).to include(USPSFlags::Config.reset)
+    it "should return a Boolean from clear" do
+      expect([true, false]).to include(USPSFlags.configuration.clear)
     end
   end
 
   describe "trident" do
     it "should return a Hash from trident" do
-      expect(USPSFlags::Config.trident).to be_a(Hash)
+      expect(USPSFlags.configuration.trident).to be_a(Hash)
     end
   end
 
   describe "configuration constructor" do
     it "should return a properly constructed configuration" do
-      @config = USPSFlags::Config.new do |config|
+      USPSFlags.configure do |config|
         config.flags_dir = $tmp_flags_dir
       end
 
-      expect(@config.flags_dir).to eql($tmp_flags_dir)
-      expect(@config.reset).to eql(false)
-      expect(@config.use_larger_tridents).to eql(true)
+      expect(USPSFlags.configuration.flags_dir).to eql($tmp_flags_dir)
+      expect(USPSFlags.configuration.clear).to eql(false)
+      expect(USPSFlags.configuration.use_larger_tridents).to eql(true)
     end
   end
 
@@ -52,7 +52,7 @@ describe USPSFlags::Config do
     end
 
     it "should use the default Rails log directory" do
-      expect(USPSFlags::Config.log_path).to eql("tmp/rails_app/log")
+      expect(@config.log_path).to eql("tmp/rails_app/log")
     end
   end
 end

data/spec/usps_flags/generate_spec.rb

@@ -176,7 +176,7 @@ describe USPSFlags::Generate do
     end
 
     it "should not raise an error while generating all static files" do
-      png_dir = "#{USPSFlags::Config.flags_dir}/PNG"
+      png_dir = "#{USPSFlags.configuration.flags_dir}/PNG"
       ::FileUtils.cp("spec/assets/1LT.thumb.png", "#{png_dir}/insignia/1LT.thumb.png")
       ::FileUtils.cp("spec/assets/LT.png", "#{png_dir}/insignia/LT.png")
       ::FileUtils.cp("spec/assets/FLT.png", "#{png_dir}/FLT.png")
@@ -223,7 +223,7 @@ describe USPSFlags::Generate do
           Generated PNG Zip
       LOG
 
-      log_contents = ::File.read("#{USPSFlags::Config.log_path}/flag.log")
+      log_contents = ::File.read("#{USPSFlags.configuration.log_path}/flag.log")
 
       expect(log_contents).to match(Regexp.new(correct_log_pattern))
     end

data/usps_flags.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name          = 'usps_flags'
-  s.version       = '0.3.10'
+  s.version       = '0.3.11'
   s.date          = '2017-11-08'
   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.10
+  version: 0.3.11
 platform: ruby
 authors:
 - Julian Fiander