usps_flags 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b2914b680d80ec58dd16d063e50dc6adde807de7
-  data.tar.gz: e42467fd6b4739d4b5440a3897f698f03063f8b4
+  metadata.gz: 99d8700124e5242379c12635f83401644e2d2216
+  data.tar.gz: 0363226cb26fbfe1b85d3f45fbf8eabe24ecd209
 SHA512:
-  metadata.gz: 443ab189736f15209dd5cd5e199654153370e4c7e7f6d0d89c764a216e444b8b12417dc93da41439b69658492aabb7ba5cbba11bca28e62130535196a504158b
-  data.tar.gz: 6e8577fa46d0ca01a9e2614b5e20eb4d55a493eaa6527cc7f8d9f760601976160583465d26e7d976aeb7ba7a736f5257f85d9e8cb64480f0a6ff252b8ee80db1
+  metadata.gz: 66379243b5d54d074c1d06034f9090ac0d461f7fcf5952a355c6fc81a1a9f953acfad27874e89b3efab3e9dbe62e278eea7cfad2041cd22b4f2b6d95c9fb07b5
+  data.tar.gz: 4fb7463ab1c82513d27e366fa42ecf9e1d905e032d90f736b8e2e1f8aae8b53cf1a8d57207534fd870f5d40cb78d4524eb90c28d0dda6063963c21c2482330cf

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    usps_flags (0.2.2)
+    usps_flags (0.2.3)
       file_utils (~> 1.1, >= 1.1.2)
       mini_magick (~> 4.8, >= 4.8.0)
       rubyzip (~> 1.2, >= 1.2.1)
@@ -9,6 +9,8 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    codeclimate-test-reporter (0.6.0)
+      simplecov (>= 0.7.1, < 1.0.0)
     coveralls (0.8.21)
       json (>= 1.8, < 3)
       simplecov (~> 0.14.1)
@@ -49,6 +51,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  codeclimate-test-reporter (~> 0.4, >= 0.4.8)
   coveralls (~> 0.8, >= 0.8.21)
   rake (~> 12.1, >= 12.1.0)
   rspec (~> 3.7, >= 3.7.0)

data/README.md

@@ -21,7 +21,9 @@ gem 'usps_flags'
 Create the file `config/initializers/usps_flags.rb`:
 
 ```ruby
-USPSFlags::Config.flags_dir "#{Rails.root}/app/assets/images/flags"
+USPSFlags::Config.new do |config|
+  config.flags_dir "#{Rails.root}/app/assets/images/flags"
+end
 ```
 
 ### Other
@@ -119,17 +121,17 @@ USPSFlags::Generate.png svg_data, outfile: nil, trim: false
 You can also construct individual flags using the following syntax:
 
 ```ruby
-f = USPSFlags.new do
-  type "LtC"
-  scale 3
-  field false
-  trim true
-  svg_file "/path/to/svg/output.svg"
-  png_file "/path/to/png/output.png"
+flag = USPSFlags.new do |f|
+  f.type = "LtC"
+  f.scale = 3
+  f.field = false
+  f.trim = true
+  f.svg_file = "/path/to/svg/output.svg"
+  f.png_file = "/path/to/png/output.png"
 end
 
-f.svg # Generate SVG file
-f.png # Generate PNG file
+flag.svg #=> Generates SVG file at "/path/to/svg/output.svg"
+flag.png #=> Generates PNG file at "/path/to/png/output.png"
 ```
 
 - Calling any DSL method without argument, or with `nil` as argument will return

data/lib/usps_flags/config.rb

@@ -7,75 +7,28 @@ class USPSFlags::Config
   BASE_FLY ||= 3072
   BASE_HOIST ||= BASE_FLY*2/3
   FRACTION_SCALE ||= 85
-
+  
   @@flags_dir ||= "#{File.dirname(__dir__)}/output"
   @@use_larger_tridents ||= true
   @@log_fail_quietly ||= true
-
-  # Accessor for the directory for storing generated flags.
+  
+  # Configuration constructor
   #
-  # @param [String] init If set, updates the path to the directory for storing generated flags.
-  # @param [Boolean] reset Delete all files in the specified directory if found.
-  # @example Update flag storage directory
-  #   # Rails.root => "/path/to"
-  #   USPSFlags::Config.flags_dir "#{Rails.root}/app/assets/images/flags" #=> "/path/to/app/assets/images/flags"
-  # @example Update flag storage directory that already has some files in it
-  #   # Rails.root => "/path/to"
-  #   USPSFlags::Config.flags_dir "#{Rails.root}/app/assets/images/flags", reset: true #=> "/path/to/app/assets/images/flags"
-  # @return [String] Returns the current (or updated) path to the flags directory.
-  def self.flags_dir(init = nil, reset: false)
-    unless init.nil?
-      @@flags_dir = init
-      ::FileUtils.rm_rf(USPSFlags::Config.flags_dir) if reset
-      [
-        "#{USPSFlags::Config.flags_dir}/SVG/insignia",
-        "#{USPSFlags::Config.flags_dir}/PNG/insignia",
-        "#{USPSFlags::Config.flags_dir}/ZIP"
-      ].each do |dir|
-        ::FileUtils.mkdir_p(dir)
-      end
-      ::FileUtils.mkdir_p(USPSFlags::Config.log_path) unless defined?(Rails)
-    end
-    @@flags_dir
+  # @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
+    yield self if block_given?
+    set_flags_dir(reset: @reset)
+    set_class_variables
   end
 
-  # Alias for the directory to store generated log files.
-  #
-  # @example Rails
-  #   # Rails.root => "/path/to"
-  #   USPSFlags::Config.logs_dir #=> "/path/to/log"
-  #
-  # @example Non-Rails
-  #   USPSFlags::Config.logs_dir #=> "/app/root/log"
-  def self.log_path
-    if defined?(Rails)
-      "#{Rails.root}/log"
-    else
-      log_dir = "#{self.flags_dir}/log"
-      ::FileUtils.mkdir_p(log_dir)
-      log_dir
-    end
-  end
-
-  # Accessor for the boolean of whether to use the larger or smaller trident width.
-  #
-  # @param [Boolean] bool If set to a Boolean, specify whether to use the larger trident width.
-  # @return [Boolean] Returns the current (or updated) setting.
-  def self.use_larger_tridents(bool = nil)
-    # Smaller: 1/2 in width on 24in x 16in field
-    # Larger:  5/8 in width on 24in x 16in field
-    @@use_larger_tridents = bool unless bool.nil? || !([true, false].include?(bool))
-    @@use_larger_tridents 
-  end
-
-  # Accessor for the boolean of whether to print an error message if the log file is inaccessible.
-  #
-  # @param [Boolean] bool If set to a Boolean, specify whether to print the error message.
-  # @return [Boolean] Returns the current (or updated) setting.
-  def self.log_fail_quietly(bool = nil)
-    @@log_fail_quietly = bool if [true, false].include?(bool)
-    @@log_fail_quietly
-  end
+  attr_accessor :flags_dir
+  attr_accessor :reset
+  attr_accessor :use_larger_tridents
+  attr_accessor :log_fail_quietly
 
   # Base configuration values for trident insignia.
   #
@@ -122,4 +75,65 @@ class USPSFlags::Config
       circle_height_adj: USPSFlags::Config::BASE_FLY/800
     }
   end
+
+  # Accessor for the directory for storing generated flags.
+  #
+  # @return [String] The current path to the flags directory.
+  def self.flags_dir
+    @@flags_dir
+  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)
+      "#{::Rails.root}/log"
+    else
+      "#{@@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 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
+
+  def set_flags_dir(reset: false)
+    ::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)
+    end
+  end
+
+  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.rb

@@ -31,106 +31,64 @@ class USPSFlags
   # Constructor for individual flags.
   #
   # @example Generate insignia at default scale for Lt/C
-  #  f = USPSFlags.new do
-  #    type "LtC"
-  #    scale 3
-  #    field false
-  #    trim true
-  #    svg_file "/path/to/svg/output.svg"
-  #    png_file "/path/to/png/output.png"
+  #  flag = USPSFlags.new do |f|
+  #    f.type = "LtC"
+  #    f.scale = 3
+  #    f.field = false
+  #    f.trim = true
+  #    f.svg_file = "/path/to/svg/output.svg"
+  #    f.png_file = "/path/to/png/output.png"
   #  end
   #
-  #  f.svg #=> Generates SVG file at "/path/to/svg/output.svg"
-  #  f.png #=> Generates PNG file at "/path/to/png/output.png"
-  def initialize(&block)
+  #  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
-    instance_eval(&block) if block_given?
+    yield self if block_given?
   end
 
   # Constructor accessor for the flag type.
   #
-  # @param [String] type If set, updates the constructor's flag type.
-  # @return [String] Returns the current (or updated) flag type.
-  def type(string = nil)
-    if string.nil?
-      @type
-    else
-      @type = string
-      self
-    end
-  end
+  # @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 If set, updates the constructor's SVG file output path.
+  # @param [String] svg_file The SVG file output path.
   # @return [String] Returns the current (or updated) SVG file output path.
-  def svg_file(string = nil)
-    if string.nil?
-      @svg_file
-    else
-      @svg_file = string
-      self
-    end
-  end
+  attr_accessor :svg_file
 
   # Constructor accessor for the PNG file output path.
   #
-  # @param [String] png_file If set, updates the constructor's PNG file output path.
+  # @param [String] png_file The PNG file output path.
   # @return [String] Returns the current (or updated) PNG file output path.
-  def png_file(string = nil)
-    if string.nil?
-      @png_file
-    else
-      @png_file = string
-      self
-    end
-  end
+  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 If set, updates the constructor's scale divisor factor.
+  # @param [Integer, Float] scale The scale divisor factor.
   # @return [Integer, Float] Returns the current (or updated) scaling factor.
-  def scale(num = nil)
-    if num.nil?
-      @scale
-    else
-      @scale = num
-      self
-    end
-  end
+  attr_accessor :scale
 
   # Constructor accessor for whether to generate the flag field (including any border).
   #
-  # @param [Boolean] field If set, updates the constructor's field setting.
+  # @param [Boolean] field The field setting.
   # @return [Boolean] Returns the current (or updated) setting.
-  def field(bool = nil)
-    if bool.nil?
-      @field
-    else
-      @field = bool
-      self
-    end
-  end
+  attr_accessor :field
 
   # Constructor accessor for whether to trim the generated PNG file of excess transparency.
   #
-  # @param [Boolean] trim If set, updates the constructor's trim setting.
+  # @param [Boolean] trim The trim setting.
   # @return [String] Returns the current (or updated) setting.
-  def trim(bool = nil)
-    if bool.nil?
-      @trim
-    else
-      @trim = bool
-      self
-    end
-  end
+  attr_accessor :trim
 
   # Generates the constructed file as SVG.
   #

data/spec/spec_helper.rb

@@ -2,6 +2,8 @@ require 'coveralls'
 Coveralls.wear!
 require 'bundler/setup'
 Bundler.setup
+require 'codeclimate-test-reporter'
+CodeClimate::TestReporter.start
 
 require 'usps_flags'
 

data/spec/usps_flags/config_spec.rb

@@ -6,10 +6,12 @@ describe USPSFlags::Config do
       default_flags_dir = File.dirname(__dir__).gsub("/spec", "/lib") + "/output"
       expect(USPSFlags::Config.flags_dir).to eql(default_flags_dir)
     end
+  end
 
-    it "should return the new flags directory when given a new path" do
-      new_flags_dir = "#{File.dirname(__dir__)}/flags"
-      expect(USPSFlags::Config.flags_dir(new_flags_dir)).to eql(new_flags_dir)
+  describe "log_path" do
+    it "should return the current flags directory" do
+      default_log_path = File.dirname(__dir__).gsub("/spec", "/lib") + "/output/log"
+      expect(USPSFlags::Config.log_path).to eql(default_log_path)
     end
   end
 
@@ -24,4 +26,24 @@ describe USPSFlags::Config do
       expect([true, false]).to include(USPSFlags::Config.use_larger_tridents)
     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
+      test_flags_dir = "./path/to/flags/for/spec"
+      @config = USPSFlags::Config.new do |config|
+        config.flags_dir = test_flags_dir
+      end
+
+      expect(@config.flags_dir).to eql(test_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/spec/usps_flags_spec.rb

@@ -95,41 +95,40 @@ describe USPSFlags do
 
   describe "constructor" do
     it "should update type" do
-      @flag.type "LtC"
+      @flag.type = "LtC"
       expect(@flag.type).to eql("LtC")
     end
 
     it "should update scale" do
-      @flag.scale 4
+      @flag.scale = 4
       expect(@flag.scale).to eql(4)
     end
 
     it "should update field" do
-      @flag.field false
+      @flag.field = false
       expect(@flag.field).to eql(false)
     end
 
     it "should update trim" do
-      @flag.trim true
+      @flag.trim = true
       expect(@flag.trim).to eql(true)
     end
 
     it "should update svg_file" do
-      @flag.svg_file "/path/to/svg/output.svg"
+      @flag.svg_file = "/path/to/svg/output.svg"
       expect(@flag.svg_file).to eql("/path/to/svg/output.svg")
     end
 
     it "should update png_file" do
-      @flag.png_file "/path/to/png/output.png"
+      @flag.png_file = "/path/to/png/output.png"
       expect(@flag.png_file).to eql("/path/to/png/output.png")
     end
 
     describe "as configured" do
       before(:each) do
-        @flag.type "LtC"
-        @flag.scale 5
-        @flag.svg_file ""
-        @flag.svg
+        @flag.type = "LtC"
+        @flag.scale = 5
+        @flag.svg_file = ""
       end
 
       it "should construct and generate a flag with a valid header" do

data/usps_flags.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name          = 'usps_flags'
-  s.version       = '0.2.3'
+  s.version       = '0.2.4'
   s.date          = '2017-11-05'
   s.summary       = 'Flag generator for United States Power Squadrons'
   s.description   = 'A flag image (PNG, SVG) generator for United States Power Squadrons.'
@@ -24,4 +24,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rake',      '~> 12.1', '>= 12.1.0'
   s.add_development_dependency 'rspec',     '~> 3.7',  '>= 3.7.0'
   s.add_development_dependency 'coveralls', '~> 0.8',  '>= 0.8.21'
+  s.add_development_dependency 'codeclimate-test-reporter', '~> 0.4', '>= 0.4.8'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: usps_flags
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Julian Fiander
@@ -152,6 +152,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.8.21
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.8
 description: A flag image (PNG, SVG) generator for United States Power Squadrons.
 email: julian@fiander.one
 executables: []