usps_flags-grades 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d04db88fa35d1d77607f2d5bae89654050d273456bd18b2cbeb16398df65823
-  data.tar.gz: a67938502f0e98b24440f8b34773033d2306f390a2253577bf3469ac2dacb23f
+  metadata.gz: bed371b7ebafe55439d4e32bc76f7d827f6e451886cf36686468dbbcee68b5f0
+  data.tar.gz: 137519775477d52fe1cdb7868fee126aa77126fee16bebabf0a928180b4dacc2
 SHA512:
-  metadata.gz: 4299127e49b38dac33d0f3000f6e95871468e6172b4eb7adac8d5b445d44eef2f154608fac209cbe0b0b772536dd72873c99b11b055acf1c03963a8ea51bd601
-  data.tar.gz: 27230946ec311f81ac5457b1893322c990509686422d6c7286c87d1c64dd942f64201184ad7a837f0c0bec058f6fa9356aff1e8fce62d88d882fd3d97ca12120
+  metadata.gz: b7daf28c0211cb0c5ed8c5cf1fd826aadd0055d4fffb6950ce894f0f47374c4744b21502ae198fa134993e9f8aa5210fcaacb9a211bc5078ed33dbce85212ecd
+  data.tar.gz: 32eda0eae042cf09f6f92e7c7aaae66551ffbeb50d617611f95ca4843390e040e59b6f494b0ac55b3653bd8297b5a4ac18a6c25935c4b83027a866a631c3fc67

data/.rubocop.yml

@@ -0,0 +1,95 @@
+require: rubocop-rspec
+AllCops:
+  TargetRubyVersion: 2.5
+  Exclude:
+    - lib/output/*
+    - tmp/**/*
+    - vendor/**/*
+
+Layout/IndentFirstHashElement:
+  EnforcedStyle: consistent
+Layout/AccessModifierIndentation:
+  EnforcedStyle: outdent
+Layout/EmptyLinesAroundAccessModifier:
+  Enabled: true
+Layout/AlignArray:
+  Enabled: true
+Layout/AlignHash:
+  Enabled: true
+Layout/EmptyLineAfterGuardClause:
+  Enabled: true
+Layout/SpaceInsideBlockBraces:
+  EnforcedStyle: space
+  EnforcedStyleForEmptyBraces: no_space
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: space
+  EnforcedStyleForEmptyBraces: no_space
+Layout/SpaceInsideArrayLiteralBrackets:
+  EnforcedStyle: no_space
+Layout/EndAlignment:
+  EnforcedStyleAlignWith: start_of_line
+
+Lint/UnusedMethodArgument:
+  Enabled: true
+Lint/UselessAssignment:
+  Enabled: true
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'
+Metrics/LineLength:
+  Max: 120
+Metrics/MethodLength:
+  Enabled: true
+Metrics/ClassLength:
+  Enabled: true
+  Max: 125
+Metrics/ParameterLists:
+  Enabled: true
+Metrics/CyclomaticComplexity:
+  Enabled: true
+Metrics/AbcSize:
+  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
+Style/FrozenStringLiteralComment:
+  Enabled: true
+Style/NumericLiterals:
+  Enabled: true
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+Style/AndOr:
+  Enabled: true
+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/YAMLLoad:
+  Enabled: true

data/.travis.yml

@@ -8,3 +8,6 @@ notifications:
   email:
     on_success: change
     on_failure: always
+script:
+  - bundle exec rubocop
+  - bundle exec rspec

data/Gemfile.lock

@@ -1,17 +1,23 @@
 PATH
   remote: .
   specs:
-    usps_flags-grades (0.1.1)
+    usps_flags-grades (0.1.2)
       usps_flags (~> 0.5, >= 0.5.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    ast (2.4.0)
     diff-lcs (1.3)
     docile (1.1.5)
     file_utils (1.1.2)
+    jaro_winkler (1.5.2)
     json (2.1.0)
     mini_magick (4.9.3)
+    parallel (1.17.0)
+    parser (2.6.3.0)
+      ast (~> 2.4.0)
+    rainbow (3.0.0)
     rake (12.2.1)
     rspec (3.7.0)
       rspec-core (~> 3.7.0)
@@ -26,12 +32,23 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.7.0)
     rspec-support (3.7.0)
+    rubocop (0.71.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      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)
       docile (~> 1.1.0)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
+    unicode-display_width (1.6.0)
     usps_flags (0.5.1)
       file_utils (~> 1.1, >= 1.1.2)
       mini_magick (~> 4.8, >= 4.8.0)
@@ -43,6 +60,8 @@ PLATFORMS
 DEPENDENCIES
   rake (~> 12.2, >= 12.2.1)
   rspec (~> 3.7, >= 3.7.0)
+  rubocop (~> 0.71, >= 0.71.0)
+  rubocop-rspec (~> 1.30, >= 1.30.0)
   simplecov (~> 0.15, >= 0.15.1)
   usps_flags-grades!
 

data/lib/usps_flags/grades.rb

@@ -5,121 +5,123 @@ require 'usps_flags/grades/config'
 require 'usps_flags/grades/errors'
 
 # Main class for generating grade and other insignia.
-class USPSFlags::Grades
-  require 'usps_flags/grades/grade'
-  require 'usps_flags/grades/membership'
-  require 'usps_flags/grades/edpro'
-  require 'usps_flags/grades/merit_marks'
-
-  ALL_CONFIGS ||= [
-    [:s, false, nil], [:p, false, nil], [:ap, false, nil], [:ap, true, nil],
-    [:jn, false, nil], [:jn, true, nil], [:n, false, nil], [:n, true, nil],
-    [:sn, false, nil], [nil, false, :senior], [nil, false, :life]
-  ].freeze
-
-  # Constructor for generating grade insignia.
-  #
-  # @example Generate JN with EdPro and Senior Member
-  #  insignia = USPSFlags::Grades.new do |b|
-  #    b.grade = :jn
-  #    b.edpro = :edpro
-  #    b.membership = :senior
-  #    b.outfile = "/path/to/svg/output.svg"
-  #  end
-  #
-  #  insignia.svg #=> Generates SVG file at "/path/to/svg/output.svg"
-  def initialize(options = {})
-    @grade = options[:grade]
-    @edpro = options[:edpro] || false
-    @membership = options[:membership]
-    @merit_marks = options[:merit_marks] || 0
-    @outfile = options[:outfile]
-    @generated_at = Time.now.strftime('%Y%m%d.%H%S%z')
-    yield self if block_given?
-  end
-
-  attr_accessor :grade
-  attr_accessor :edpro
-  attr_accessor :membership
-  attr_accessor :merit_marks
-  attr_accessor :outfile
-
-  # Generates the constructed file as SVG.
-  #
-  # @return [String] Returns the SVG file output path, or the svg data if no path was specified.
-  def svg
-    validate
-    @svg = <<~SVG
-      #{USPSFlags::Core.headers(title: title).gsub('0 0 3072 2048', '0 0 1024 682')}
-      <g transform="translate(0, 50)">
-        #{USPSFlags::Grades::Grade.get(@grade)}
-        #{USPSFlags::Grades::EdPro.get(@grade) if @edpro && USPSFlags::Grades::EdPro.for_grade(@grade)}
-        #{USPSFlags::Grades::Membership.get(@membership) unless @membership.nil?}
-      </g>
-      <g transform="translate(0, 450)">
-         #{USPSFlags::Grades::MeritMarks.get(@merit_marks)}
-      </g>
-      #{USPSFlags::Core.footer}
-    SVG
-
-    USPSFlags::Helpers.output(@svg, outfile: @outfile)
-  end
+class USPSFlags
+  class Grades
+    require 'usps_flags/grades/grade'
+    require 'usps_flags/grades/membership'
+    require 'usps_flags/grades/edpro'
+    require 'usps_flags/grades/merit_marks'
+
+    ALL_CONFIGS ||= [
+      [:s, false, nil], [:p, false, nil], [:ap, false, nil], [:ap, true, nil],
+      [:jn, false, nil], [:jn, true, nil], [:n, false, nil], [:n, true, nil],
+      [:sn, false, nil], [nil, false, :senior], [nil, false, :life]
+    ].freeze
+
+    # Constructor for generating grade insignia.
+    #
+    # @example Generate JN with EdPro and Senior Member
+    #  insignia = USPSFlags::Grades.new do |b|
+    #    b.grade = :jn
+    #    b.edpro = :edpro
+    #    b.membership = :senior
+    #    b.outfile = "/path/to/svg/output.svg"
+    #  end
+    #
+    #  insignia.svg #=> Generates SVG file at "/path/to/svg/output.svg"
+    def initialize(options = {})
+      @grade = options[:grade]
+      @edpro = options[:edpro] || false
+      @membership = options[:membership]
+      @merit_marks = options[:merit_marks] || 0
+      @outfile = options[:outfile]
+      @generated_at = Time.now.strftime('%Y%m%d.%H%S%z')
+      yield self if block_given?
+    end
 
-  # Generates the descriptive title for the SVG.
-  #
-  # @return [String] Returns the descriptive title.
-  def title
-    grade = @grade.to_s.upcase
-    edpro = ' - EdPro' if @edpro && @grade != :sn
-    membership = case @membership
-                 when :senior
-                   ' - Senior Member'
-                 when :life
-                   ' - Life Member'
+    attr_accessor :grade
+    attr_accessor :edpro
+    attr_accessor :membership
+    attr_accessor :merit_marks
+    attr_accessor :outfile
+
+    # Generates the constructed file as SVG.
+    #
+    # @return [String] Returns the SVG file output path, or the svg data if no path was specified.
+    def svg
+      validate
+      @svg = <<~SVG
+        #{USPSFlags::Core.headers(title: title).gsub('0 0 3072 2048', '0 0 1024 682')}
+        <g transform="translate(0, 50)">
+          #{USPSFlags::Grades::Grade.get(@grade)}
+          #{USPSFlags::Grades::EdPro.get(@grade) if @edpro && USPSFlags::Grades::EdPro.for_grade(@grade)}
+          #{USPSFlags::Grades::Membership.get(@membership) unless @membership.nil?}
+        </g>
+        <g transform="translate(0, 450)">
+          #{USPSFlags::Grades::MeritMarks.get(@merit_marks)}
+        </g>
+        #{USPSFlags::Core.footer}
+      SVG
+
+      USPSFlags::Helpers.output(@svg, outfile: @outfile)
     end
 
-    "#{grade}#{edpro}#{membership}"
-  end
+    # Generates the descriptive title for the SVG.
+    #
+    # @return [String] Returns the descriptive title.
+    def title
+      grade = @grade.to_s.upcase
+      edpro = ' - EdPro' if @edpro && @grade != :sn
+      membership = case @membership
+                   when :senior
+                     ' - Senior Member'
+                   when :life
+                     ' - Life Member'
+      end
+
+      "#{grade}#{edpro}#{membership}"
+    end
 
-  def self.all(dir = nil)
-    dir ||= USPSFlags.configuration.flags_dir
+    def self.all(dir = nil)
+      dir ||= USPSFlags.configuration.flags_dir
 
-    ALL_CONFIGS.each do |grade, edpro, membership|
-      path = "#{dir}/#{grade}"
-      path += '_edpro' if edpro
+      ALL_CONFIGS.each do |grade, edpro, membership|
+        path = "#{dir}/#{grade}"
+        path += '_edpro' if edpro
 
-      insignia = USPSFlags::Grades.new(
-        grade: grade, edpro: edpro, membership: membership,
-        outfile: "#{path}.svg"
-      )
+        insignia = USPSFlags::Grades.new(
+          grade: grade, edpro: edpro, membership: membership,
+          outfile: "#{path}.svg"
+        )
 
-      USPSFlags::Generate.png(insignia.svg, outfile: "#{path}.png", trim: true)
+        USPSFlags::Generate.png(insignia.svg, outfile: "#{path}.png", trim: true)
+      end
     end
-  end
 
-private
+  private
 
-  def validate
-    validate_grade
-    validate_edpro
-    validate_membership
-  end
+    def validate
+      validate_grade
+      validate_edpro
+      validate_membership
+    end
 
-  def validate_grade
-    return if @grade.nil? || USPSFlags::Grades::Grade.valid_grades.include?(@grade)
+    def validate_grade
+      return if @grade.nil? || USPSFlags::Grades::Grade.valid_grades.include?(@grade)
 
-    raise USPSFlags::Errors::InvalidInsignia, "Unknown grade: #{@grade}"
-  end
+      raise USPSFlags::Errors::InvalidInsignia, "Unknown grade: #{@grade}"
+    end
 
-  def validate_edpro
-    return if [true, false].include?(@edpro)
+    def validate_edpro
+      return if [true, false].include?(@edpro)
 
-    raise USPSFlags::Errors::InvalidInsignia, 'EdPro must be boolean'
-  end
+      raise USPSFlags::Errors::InvalidInsignia, 'EdPro must be boolean'
+    end
 
-  def validate_membership
-    return if [nil, :senior, :life].include?(@membership)
+    def validate_membership
+      return if [nil, :senior, :life].include?(@membership)
 
-    raise USPSFlags::Errors::InvalidInsignia, "Unknown membership level: #{@membership}"
+      raise USPSFlags::Errors::InvalidInsignia, "Unknown membership level: #{@membership}"
+    end
   end
 end

data/lib/usps_flags/grades/config.rb

@@ -3,7 +3,9 @@
 # Extension of USPSFlags::Config to for insignia config.
 #
 # @private
-class USPSFlags::Config
-  GOLD ||= '#FFBF3F'
-  GRADE_SPACING ||= 125
+class USPSFlags
+  class Config
+    GOLD ||= '#FFBF3F'
+    GRADE_SPACING ||= 125
+  end
 end

data/lib/usps_flags/grades/edpro.rb

@@ -4,20 +4,22 @@
 #
 # This class should never need to be called directly.
 # @private
-class USPSFlags::Grades::EdPro
-  class << self
-    def get(grade)
-      unless for_grade(grade)
-        raise USPSFlags::Errors::InvalidInsignia, 'EdPro is only valid for grades AP, JN, N'
-      end
+class USPSFlags
+  class Grades
+    class EdPro
+      class << self
+        def get(grade)
+          raise USPSFlags::Errors::InvalidInsignia, 'EdPro is only valid for grades AP, JN, N' unless for_grade(grade)
 
-      <<~SVG
-        <rect x="0" y="100" width="#{USPSFlags::Grades::Grade.width(grade)}" height="20" fill="#{USPSFlags::Config::GOLD}" />
-      SVG
-    end
+          <<~SVG
+            <rect x="0" y="100" width="#{USPSFlags::Grades::Grade.width(grade)}" height="20" fill="#{USPSFlags::Config::GOLD}" />
+          SVG
+        end
 
-    def for_grade(grade)
-      %i[ap jn n].include?(grade)
+        def for_grade(grade)
+          %i[ap jn n].include?(grade)
+        end
+      end
     end
   end
 end

data/lib/usps_flags/grades/grade.rb

@@ -4,95 +4,99 @@
 #
 # This class should never need to be called directly.
 # @private
-class USPSFlags::Grades::Grade
-  class << self
-    def get(grade)
-      return if grade.nil?
-      raise USPSFlags::Errors::InvalidInsignia, "Unknown grade: #{grade}" unless valid_grades.include?(grade)
+class USPSFlags
+  class Grades
+    class Grade
+      class << self
+        def get(grade)
+          return if grade.nil?
+          raise USPSFlags::Errors::InvalidInsignia, "Unknown grade: #{grade}" unless valid_grades.include?(grade)
 
-      send(grade)
-    end
+          send(grade)
+        end
 
-    def valid_grades
-      %i[s p ap jn n sn]
-    end
+        def valid_grades
+          %i[s p ap jn n sn]
+        end
 
-    def width(grade)
-      case grade
-      when :ap
-        USPSFlags::Config::GRADE_SPACING * 2.25 + 100
-      when :jn
-        USPSFlags::Config::GRADE_SPACING * 3 + 10
-      when :n
-        USPSFlags::Config::GRADE_SPACING * 5 + 45
-      end
-    end
+        def width(grade)
+          case grade
+          when :ap
+            USPSFlags::Config::GRADE_SPACING * 2.25 + 100
+          when :jn
+            USPSFlags::Config::GRADE_SPACING * 3 + 10
+          when :n
+            USPSFlags::Config::GRADE_SPACING * 5 + 45
+          end
+        end
 
-  private
+      private
 
-    def bar
-      <<~SVG
-        <rect x="0" y="0" width="100" height="35" fill="#{USPSFlags::Config::GOLD}" />
-      SVG
-    end
+        def bar
+          <<~SVG
+            <rect x="0" y="0" width="100" height="35" fill="#{USPSFlags::Config::GOLD}" />
+          SVG
+        end
 
-    def star
-      <<~SVG
-        <g transform="scale(0.33) translate(0, 150)">
-          #{USPSFlags::Core::Icons::Star.new.svg.gsub('fill="#FFFFFF"', "fill=\"#{USPSFlags::Config::GOLD}\"")}
-        </g>
-      SVG
-    end
+        def star
+          <<~SVG
+            <g transform="scale(0.33) translate(0, 150)">
+              #{USPSFlags::Core::Icons::Star.new.svg.gsub('fill="#FFFFFF"', "fill=\"#{USPSFlags::Config::GOLD}\"")}
+            </g>
+          SVG
+        end
 
-    def s
-      bar
-    end
+        def s
+          bar
+        end
 
-    def p
-      <<~SVG
-        #{bar}
-        <g transform="translate(#{USPSFlags::Config::GRADE_SPACING})">#{bar}</g>
-      SVG
-    end
+        def p
+          <<~SVG
+            #{bar}
+            <g transform="translate(#{USPSFlags::Config::GRADE_SPACING})">#{bar}</g>
+          SVG
+        end
 
-    def ap
-      <<~SVG
-        #{bar}
-        <g transform="translate(#{USPSFlags::Config::GRADE_SPACING * 1.5 + 5})">#{star}</g>
-        <g transform="translate(#{USPSFlags::Config::GRADE_SPACING * 2.25})">#{bar}</g>
-      SVG
-    end
+        def ap
+          <<~SVG
+            #{bar}
+            <g transform="translate(#{USPSFlags::Config::GRADE_SPACING * 1.5 + 5})">#{star}</g>
+            <g transform="translate(#{USPSFlags::Config::GRADE_SPACING * 2.25})">#{bar}</g>
+          SVG
+        end
 
-    def jn
-      <<~SVG
-        <g transform="translate(60)">
-          #{star}
-          <g transform="translate(#{USPSFlags::Config::GRADE_SPACING / 2 + 25})">#{bar}</g>
-          <g transform="translate(#{USPSFlags::Config::GRADE_SPACING * 2 + 20})">#{star}</g>
-        </g>
-      SVG
-    end
+        def jn
+          <<~SVG
+            <g transform="translate(60)">
+              #{star}
+              <g transform="translate(#{USPSFlags::Config::GRADE_SPACING / 2 + 25})">#{bar}</g>
+              <g transform="translate(#{USPSFlags::Config::GRADE_SPACING * 2 + 20})">#{star}</g>
+            </g>
+          SVG
+        end
 
-    def n
-      <<~SVG
-        <g transform="translate(60)">
-          #{star}
-          <g transform="translate(#{USPSFlags::Config::GRADE_SPACING / 2 + 25})">#{bar}</g>
-          <g transform="translate(#{USPSFlags::Config::GRADE_SPACING * 2 + 20})">#{star}</g>
-          <g transform="translate(#{USPSFlags::Config::GRADE_SPACING * 3 - 10})">#{bar}</g>
-          <g transform="translate(#{USPSFlags::Config::GRADE_SPACING * 4 + 50})">#{star}</g>
-        </g>
-      SVG
-    end
+        def n
+          <<~SVG
+            <g transform="translate(60)">
+              #{star}
+              <g transform="translate(#{USPSFlags::Config::GRADE_SPACING / 2 + 25})">#{bar}</g>
+              <g transform="translate(#{USPSFlags::Config::GRADE_SPACING * 2 + 20})">#{star}</g>
+              <g transform="translate(#{USPSFlags::Config::GRADE_SPACING * 3 - 10})">#{bar}</g>
+              <g transform="translate(#{USPSFlags::Config::GRADE_SPACING * 4 + 50})">#{star}</g>
+            </g>
+          SVG
+        end
 
-    def sn
-      box_width = USPSFlags::Grades::Grade.width(:n) + 60
-      <<~SVG
-        <rect x="20" y="-10" width="#{box_width}" height="155" fill=\"none\" stroke-width=\"20\" stroke=\"#{USPSFlags::Config::GOLD}\" />
-        <g transform="translate(50, 50)">
-          #{n}
-        </g>
-      SVG
+        def sn
+          box_width = USPSFlags::Grades::Grade.width(:n) + 60
+          <<~SVG
+            <rect x="20" y="-10" width="#{box_width}" height="155" fill=\"none\" stroke-width=\"20\" stroke=\"#{USPSFlags::Config::GOLD}\" />
+            <g transform="translate(50, 50)">
+              #{n}
+            </g>
+          SVG
+        end
+      end
     end
   end
 end