usps_flags-grades 0.0.12 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f9ab5d165c202f4af2a99caa777e90a0f5df7a4b06fd8de58fa9d3d3a86079d
-  data.tar.gz: 5a54878338bdb11837dafa04550092da604b4f86ebdd5ae68a08410597f32c20
+  metadata.gz: cefac45cc5531db3f4f992a90e1b527a7e743aaf982a6266d6b6fb30d2256e17
+  data.tar.gz: 732876a050800e686568512f63274b38ad6a296ceab6f0b777bb4085b6de07a8
 SHA512:
-  metadata.gz: b7b2a9a9438a142a22991c594c9c36c11859cb4066f3f0995bcc31a2e9f5693b1298298b06fc72faf45135421cbb54fa3b37d081d356fc596d3c31e246877e0a
-  data.tar.gz: 1e210586ed6693d2708e17ca7dee3026de42e5afd9db08a0ef174957ba5a9d28dc61fdd65e039aecd19dcce09f82500f34b4a44fa5a3460ba229e477daace60b
+  metadata.gz: db74e2ca7a56c73a99f1cdc90bbaaade93598c7c44fd662af77c0586d98c58a93c19cf41bb802a1f8225e5610d03df24f78e95e922c909a328e41521b0620bdc
+  data.tar.gz: b70066bc684b2c02de5b54c010955b3a9cc1efdcb32b85e44c9fa83a928a39e1989ec1b661370680425bfed860c60bf0cf76bc37cbd5d5e848f6b6523bc29a3a

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/.ruby-version

@@ -0,0 +1 @@
+2.5.1

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]+(?:-.*)?/"
@@ -8,3 +8,8 @@ notifications:
   email:
     on_success: change
     on_failure: always
+before_install:
+  - gem install bundler -v '< 2'
+script:
+  - bundle exec rubocop
+  - bundle exec rspec

data/Gemfile

@@ -1,2 +1,4 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
 gemspec

data/Gemfile.lock

@@ -1,18 +1,24 @@
 PATH
   remote: .
   specs:
-    usps_flags-grades (0.0.12)
-      usps_flags (~> 0.4, >= 0.4.0)
+    usps_flags-grades (0.1.5)
+      usps_flags (~> 0.5, >= 0.5.5)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    ast (2.4.0)
     diff-lcs (1.3)
     docile (1.1.5)
     file_utils (1.1.2)
-    json (2.1.0)
-    mini_magick (4.9.3)
-    rake (12.2.1)
+    jaro_winkler (1.5.2)
+    json (2.3.1)
+    mini_magick (4.10.1)
+    parallel (1.17.0)
+    parser (2.6.3.0)
+      ast (~> 2.4.0)
+    rainbow (3.0.0)
+    rake (12.3.3)
     rspec (3.7.0)
       rspec-core (~> 3.7.0)
       rspec-expectations (~> 3.7.0)
@@ -26,16 +32,27 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.7.0)
     rspec-support (3.7.0)
-    rubyzip (1.2.3)
+    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.3.0)
     simplecov (0.15.1)
       docile (~> 1.1.0)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
-    usps_flags (0.4.1)
+    unicode-display_width (1.6.0)
+    usps_flags (0.6.1)
       file_utils (~> 1.1, >= 1.1.2)
-      mini_magick (~> 4.8, >= 4.8.0)
-      rubyzip (~> 1.2, >= 1.2.1)
+      mini_magick (~> 4.9, >= 4.9.4)
+      rubyzip (~> 1.3, >= 1.3.0)
 
 PLATFORMS
   ruby
@@ -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/README.md

@@ -6,7 +6,7 @@
 [![Maintainability](https://api.codeclimate.com/v1/badges/760b824f0edac3316a11/maintainability)](https://codeclimate.com/github/jfiander/usps-flags_grades/maintainability)
 
 An extension for [USPSFlags](https://github.com/jfiander/usps-flags) to generate
-regrade insignia.
+grade insignia.
 
 ## Usage
 

data/Rakefile

@@ -1,7 +1,9 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new
 
 task default: :spec
-task test: :spec
+task test: :spec

data/lib/usps_flags/grades.rb

@@ -1,123 +1,135 @@
+# frozen_string_literal: true
+
 require 'usps_flags'
 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] || nil
-    @edpro = options[:edpro] || false
-    @membership = options[:membership] || nil
-    @merit_marks = options[:merit_marks] || 0
-    @outfile = options[:outfile] || nil
-    @generated_at = Time.now.strftime("%Y%m%d.%H%S%z")
-    yield self if block_given?
-  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
 
-  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
+    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
 
-  # 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"
+    # Generates the constructed file as PNG.
+    #
+    # @return [String] Returns the PNG file output path.
+    def png(outfile: nil)
+      USPSFlags::Generate.png(svg, outfile: 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
 
-  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