how_is 18.0.3 → 18.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d6f35707314d01b26c01a857209228e882ab19e8
-  data.tar.gz: 488bb2052b79301f7c3919f84504e7a786410506
+SHA256:
+  metadata.gz: aa512f40b28b33221fb83a6db55d83efe39e5b5c3f5a5160a5eabb1441a58638
+  data.tar.gz: 4dc0c71bd1a56bb32e29efebbbc7405b21456566b47ae8b4b1fcc8ebafe90cae
 SHA512:
-  metadata.gz: 73c0fd55cfae0d7a25dfb60e431bb99a5826872af8d03db6fdef9b44bdda900746210b32bc220026b03c0fe36bc95c7a0bdf0819cdb9ce9868932af915608bed
-  data.tar.gz: 6fc00770653ba6af093c986d4135aa5b30fd187f8a6c89e260fc4b33ec18eee57ffb8323d90a2e2b1f8c2ecc3f08845cff37e8c642a07ed5ab9df3c65ae6e0d3
+  metadata.gz: 4f2ffd1e34fa07420631add37aa8b084956f58b6b8d67d14ccb4d58942f60a167ad9c7106bd14ce3c53db73498255e1542c2e56559733fccc05dfba157876c46
+  data.tar.gz: 40a4bf011b459a31a7ab9e9fedf50b8672f64f8ba3d5e62fa4492260eab05aed27f88b882f87583e128fc2fcf0891508229be723c4d75399dbb43735e0dac9de

data/.gitignore

@@ -1,6 +1,6 @@
 /.bundle/
 /.yardoc
-/Gemfile.lock
+#/Gemfile.lock
 /_yardoc/
 /coverage/
 /doc/

data/.rubocop.yml

@@ -1,8 +1,22 @@
+AllCops:
+  TargetRubyVersion: 2.3
+  Exclude:
+    - 'how_is.gemspec'
+    - 'bin/*'
+    - '**/*~'
+    - 'spec/capture_warnings.rb'
+    - 'lib/how_is/cli.rb' # FIXME: Make HowIs::CLI.parse not a disaster.
+
 # Exceptions should inherit from StandardError.
 # (RuboCop default is to inherit from RuntimeError.)
 Lint/InheritException:
   EnforcedStyle: standard_error
 
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*_spec.rb'
+
+
 # The guiding principle of classes is SRP, SRP can't be accurately measured by LoC
 #Metrics/ClassLength:
 #  Max: 1500
@@ -13,16 +27,32 @@ Lint/InheritException:
 # It may be worth revisiting this in the future and refactoring those lines.
 Metrics/LineLength:
   Max: 120
+  AllowHeredoc: true
 
 # Too short methods lead to extraction of single-use methods, which can make
 # the code easier to read (by naming things), but can also clutter the class
 Metrics/MethodLength:
   Max: 20
 
+Style/Alias:
+  EnforcedStyle: prefer_alias_method
+
 # Most readable form.
 Style/AlignHash:
   EnforcedHashRocketStyle: table
   EnforcedColonStyle: table
+  # Disable because it wound up conflicting with a lot of things like:
+  # foo('bar',
+  #   baz: 'asdf',
+  #   beep: 'boop')
+  #
+  # I suspect these'll disappear when overarching architectural issues are
+  # addressed.
+  Enabled: false
+
+Style/AlignParameters:
+  # See Style/AlignedHash.
+  Enabled: false
 
 # This codebase may be English, but some English words contain diacritics.
 Style/AsciiComments:
@@ -86,6 +116,8 @@ Style/PercentLiteralDelimiters:
   Enabled: true
   PreferredDelimiters:
     default: "[]"
+    '%w': '[]'
+    '%W': '[]'
 
 # `has_key?` and `has_value?` are clearer than `key?` and `value?`.
 Style/PreferredHashMethods:
@@ -115,6 +147,10 @@ Style/StringLiterals:
   Enabled: false
   #EnforcedStyle: double_quotes
 
+# TODO: Maybe make it so you have to do [:foo, :bar] not %i[foo bar]?
+Style/SymbolArray:
+  Enabled: false
+
 # Require parentheses around complex ternary conditions.
 Style/TernaryParentheses:
   Enabled: true

data/.travis.yml

@@ -1,3 +1,4 @@
 language: ruby
 rvm:
   - 2.3.3
+  - 2.4.1

data/CHANGELOG.md

@@ -9,6 +9,23 @@ this project adheres to [Semantic Versioning](http://semver.org).
 
 (Nothing so far.)
 
+## [v18.0.4]
+
+This release ([snapshot](https://github.com/how-is/how_is/tree/v18.0.4))
+is exclusively cleaning up RuboCop violations and updating dependencies.
+There should be no noticeable changes in functionality.
+
+### Miscellaneous
+
+* Use Hashie stable; update Gemfile/add Gemfile.lock. ([#170](https://github.com/how-is/how_is/pull/170))
+* Pass -w to Ruby when running 'rake spec'. ([#169](https://github.com/how-is/how_is/pull/169))
+* Rubocop cleanup. ([#167](https://github.com/how-is/how_is/pull/167))
+* Gemfile: use Hashie from master branch. ([#166](https://github.com/how-is/how_is/pull/166))
+* Update github_api, contracst to latest. ([#165](https://github.com/how-is/how_is/pull/165))
+* Fix (a significant number of) RuboCop violations. ([#162](https://github.com/how-is/how_is/pull/162))
+* README: Drop from_config_file reference. ([#161](https://github.com/how-is/how_is/pull/161))
+* Move rubocop dependency to gemspec. ([#160](https://github.com/how-is/how_is/pull/160))
+
 ## [v18.0.3]
 
 This release ([snapshot](https://github.com/how-is/how_is/tree/v18.0.3))

data/Gemfile

@@ -1,12 +1,6 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in how_is.gemspec
 gemspec
-
-# Everything says to put it here. It feels like it should go in the gemspec?
-# SOMEBODY WHO KNOWS WHAT THEY'RE DOING PLEASE LET ME KNOW WHAT TO DO HERE.
-group :test, :development do
-  # Matches version used by Hound, even though there's newer releases.
-  # https://github.com/houndci/linters/blob/master/Gemfile.lock
-  gem 'rubocop', '~> 0.46.0', require: false
-end

data/Gemfile.lock

@@ -0,0 +1,110 @@
+PATH
+  remote: .
+  specs:
+    how_is (18.0.4)
+      contracts (~> 0.16.0)
+      github_api (~> 0.17.0)
+      slop (~> 4.4.1)
+      tessellator-fetcher (~> 5.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.4.0)
+    ast (2.3.0)
+    contracts (0.16.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    curl_cacert (1.0.0)
+    default (1.0.0)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.3)
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    github_api (0.17.0)
+      addressable (~> 2.4.0)
+      descendants_tracker (~> 0.0.4)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 3.4)
+      mime-types (>= 1.16, < 3.0)
+      oauth2 (~> 1.0)
+    hashdiff (0.3.4)
+    hashie (3.5.6)
+    heresy (4.0.0)
+      default (~> 1.0.0)
+      heresy-string (~> 1.0.0)
+      net-socket (~> 1.0.0)
+    heresy-string (1.0.0)
+    jwt (1.5.6)
+    mayhaps (0.3.0)
+    mime-types (2.99.3)
+    multi_json (1.12.1)
+    multi_xml (0.6.0)
+    multipart-post (2.0.0)
+    net-socket (1.0.0)
+    oauth2 (1.4.0)
+      faraday (>= 0.8, < 0.13)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 3)
+    openssl-better_defaults (0.0.1)
+    parser (2.4.0.0)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    rack (2.0.3)
+    rainbow (2.2.2)
+      rake
+    rake (11.3.0)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+    rubocop (0.47.1)
+      parser (>= 2.3.3.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.8.1)
+    safe_yaml (1.0.4)
+    slop (4.4.3)
+    tessellator-fetcher (5.0.1)
+      curl_cacert
+      heresy (~> 4.0.0)
+      mayhaps (~> 0.3.0)
+      openssl-better_defaults
+    thread_safe (0.3.6)
+    timecop (0.8.1)
+    unicode-display_width (1.3.0)
+    vcr (3.0.3)
+    webmock (3.0.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.11)
+  how_is!
+  rake (~> 11.2)
+  rspec (~> 3.5)
+  rubocop (~> 0.47.0)
+  timecop (~> 0.8.1)
+  vcr (~> 3.0)
+  webmock
+
+BUNDLED WITH
+   1.15.1

data/README.md

@@ -102,11 +102,6 @@ Every value under `reports` is a format string, so you can do e.g.
 report = HowIs.new('<orgname>/<reponame>').to_html
 File.open('report.html', 'w') { |f| f.puts report }
 
-# Generate a report from a config file located at ./how_is.yml.
-# Example config file: https://github.com/how-is/how-is-rubygems/blob/gh-pages/how_is.yml
-require 'yaml'
-HowIs.from_config_file(YAML.load_file('how_is.yml'))
-
 # Generate a report from a config Hash.
 HowIs.from_config({
   repository: '<orgname>/<reponame>',

data/Rakefile

@@ -1,16 +1,21 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'timecop'
-#require 'vcr'
 require './spec/vcr_helper.rb'
 require 'how_is'
 
-RSpec::Core::RakeTask.new(:spec)
+RSpec::Core::RakeTask.new(:spec) do |t|
+  # Warning.warn() was added in Ruby 2.4.0, so don't use -w on older versions.
+  t.ruby_opts = '-w -r./spec/capture_warnings.rb' if RUBY_VERSION >= '2.4.0'
+end
 
 task :default => :spec
 
+# Helper functions used later in the Rakefile.
 class HelperFunctions
-  def self.freeze_time(&block)
+  def self.freeze_time(&_block)
     date = DateTime.parse('2016-11-01').new_offset(0)
     Timecop.freeze(date) do
       yield
@@ -26,7 +31,7 @@ class HelperFunctions
         format: format,
       }
 
-      cassette = repository.gsub('/', '-')
+      cassette = repository.tr('/', '-')
       VCR.use_cassette(cassette) do
         report = HowIs.generate_report(**options)
       end

data/exe/how_is

@@ -1,10 +1,12 @@
 #!/usr/bin/env ruby
 
+# frozen_string_literal: true
+
 require "how_is"
 require "how_is/cli"
 
 begin
-  result  = HowIs::CLI.parse(ARGV)
+  result = HowIs::CLI.parse(ARGV)
 rescue HowIs::CLI::OptionsError => e
   if ENV['SHOW_TRACE']
     raise
@@ -42,7 +44,6 @@ begin
       HowIs::Report.to_format_based_on(options[:report], report)
     )
   end
-
 rescue => e
   if ENV['SHOW_TRACE']
     raise

data/how_is.gemspec

@@ -19,8 +19,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "github_api", "~> 0.14.5"
-  spec.add_runtime_dependency "contracts", "~> 0.14.0"
+  spec.add_runtime_dependency "github_api", "~> 0.17.0"
+  spec.add_runtime_dependency "contracts", "~> 0.16.0"
   spec.add_runtime_dependency "slop", "~> 4.4.1"
 
   spec.add_runtime_dependency "tessellator-fetcher", "~> 5.0.0"
@@ -31,4 +31,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "timecop", "~> 0.8.1"
   spec.add_development_dependency "vcr", "~> 3.0"
   spec.add_development_dependency "webmock"
+  spec.add_development_dependency "rubocop", "~> 0.47.0"
 end

data/lib/how_is/analyzer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'contracts'
 require 'ostruct'
 require 'date'
@@ -52,7 +54,7 @@ class HowIs
         newest_issue: issue_or_pull_to_hash(newest_for(issues)),
         newest_pull: issue_or_pull_to_hash(newest_for(pulls)),
 
-        pulse: data.pulse,
+        pulse: data.pulse
       )
     end
 
@@ -61,11 +63,11 @@ class HowIs
     #
     # @param data [Hash] The hash to generate an Analysis from.
     def self.from_hash(data)
-      hash = data.map do |k, v|
+      hash = data.map { |k, v|
         v = DateTime.parse(v) if k.end_with?('_date')
 
         [k, v]
-      end.to_h
+      }.to_h
 
       hash.keys.each do |key|
         next unless hash[key].is_a?(Hash) && hash[key]['date']
@@ -116,7 +118,7 @@ class HowIs
     def average_age_for(issues_or_pulls)
       return nil if issues_or_pulls.empty?
 
-      ages = issues_or_pulls.map {|iop| time_ago_in_seconds(iop['created_at'])}
+      ages = issues_or_pulls.map { |iop| time_ago_in_seconds(iop['created_at']) }
       raw_average = ages.reduce(:+) / ages.length
 
       seconds_in_a_year = 31_556_926
@@ -140,24 +142,25 @@ class HowIs
         [months, "month"],
         [weeks, "week"],
         [days, "day"],
-      ].reject {|(v, k)| v == 0}.map{ |(v,k)|
-        k = k + 's' if v != 1
+      ].reject { |(v, _)| v == 0 }.map { |(v, k)|
+        k += 's' if v != 1
         [v, k]
       }
 
-      most_significant = values[0, 2].map {|x| x.join(" ")}
+      most_significant = values[0, 2].map { |x| x.join(" ") }
 
-      if most_significant.length < 2
-        value = most_significant.first
-      else
-        value = most_significant.join(" and ")
-      end
+      value =
+        if most_significant.length < 2
+          most_significant.first
+        else
+          most_significant.join(" and ")
+        end
 
       "approximately #{value}"
     end
 
     def sort_iops_by_created_at(issues_or_pulls)
-      issues_or_pulls.sort_by {|x| DateTime.parse(x['created_at']) }
+      issues_or_pulls.sort_by { |x| DateTime.parse(x['created_at']) }
     end
 
     # Given an Array of issues or pulls, return the oldest.
@@ -181,15 +184,16 @@ class HowIs
       DateTime.parse(issue_or_pull['created_at'])
     end
 
-  private
+    private
+
     # Takes an Array of labels, and returns amodified list that includes links
     # to each label.
     def with_label_links(labels, repository)
-      labels.map do |label, num_issues|
+      labels.map { |label, num_issues|
         label_link = "https://github.com/#{repository}/issues?q=" + CGI.escape("is:open is:issue label:\"#{label}\"")
 
         [label, {'link' => label_link, 'total' => num_issues}]
-      end.to_h
+      }.to_h
     end
 
     # Returns how many seconds ago a date (as a String) was.

data/lib/how_is/cli.rb

@@ -1,8 +1,10 @@
+# NOPE THIS IS BROKEN // frozen_string_literal: // true
+
 require "how_is"
 require "slop"
 
 class HowIs::CLI
-  DEFAULT_REPORT_FILE = "report.#{HowIs::DEFAULT_FORMAT}"
+  DEFAULT_REPORT_FILE = "report.#{HowIs::DEFAULT_FORMAT}".freeze
 
   # Parent class of all exceptions raised in HowIs::CLI.
   class OptionsError < StandardError
@@ -44,6 +46,14 @@ class HowIs::CLI
     opts.separator ""
     opts.separator "Options:"
 
+    # The extra spaces make this a lot easier to comprehend, so we don't want
+    # RuboCop to complain about them.
+    #
+    # Same for line length.
+    #
+    # rubocop:disable Style/SpaceBeforeFirstArg
+    # rubocop:disable Metrics/LineLength
+
     # Allowed arguments:
     opts.bool   "-h", "--help",    "Print help text"
     opts.string       "--config",  "YAML config file, used to generate a group of reports"
@@ -51,6 +61,9 @@ class HowIs::CLI
     opts.string       "--report",  "output file for the report (valid extensions: #{HowIs.supported_formats.join(', ')}; default: #{DEFAULT_REPORT_FILE})"
     opts.bool   "-v", "--version", "prints the version"
 
+    # rubocop:enable Style/SpaceBeforeFirstArg
+    # rubocop:enable Metrics/LineLength
+
     # Parse the arguments.
     parser    = Slop::Parser.new(opts)
     result    = parser.parse(argv)

data/lib/how_is/fetcher.rb

@@ -1,59 +1,67 @@
+# frozen_string_literal: true
+
 require 'contracts'
 require 'github_api'
 require 'how_is/pulse'
 
 ##
 # Fetches data from GitHub.
-class HowIs::Fetcher
-  include Contracts::Core
-
-  ##
-  # Standardized representation for fetcher results.
-  #
-  # Implemented as a class instead of passing around a Hash so that it can
-  # be more easily referenced by Contracts.
-  class Results < Struct.new(:repository, :issues, :pulls, :pulse)
+class HowIs
+  class Fetcher
     include Contracts::Core
 
-    Contract String, C::ArrayOf[Hash], C::ArrayOf[Hash], String => nil
-    def initialize(repository, issues, pulls, pulse)
-      super(repository, issues, pulls, pulse)
+    ##
+    # Standardized representation for fetcher results.
+    #
+    # Implemented as a class instead of passing around a Hash so that it can
+    # be more easily referenced by Contracts.
+    class Results < Struct.new(:repository, :issues, :pulls, :pulse)
+      include Contracts::Core
+
+      Contract String, C::ArrayOf[Hash], C::ArrayOf[Hash], String => nil
+      def initialize(repository, issues, pulls, pulse)
+        super(repository, issues, pulls, pulse)
+      end
+
+      # Struct defines #to_h, but not #to_hash, so we alias them.
+      alias_method :to_hash, :to_h
     end
 
-    # Struct defines #to_h, but not #to_hash, so we alias them.
-    alias_method :to_hash, :to_h
-  end
+    ##
+    # Fetches repository information from GitHub and returns a Results object.
+    Contract String,
+      C::Or[C::RespondTo[:issues, :pulls], nil],
+      C::Or[C::RespondTo[:html_summary], nil] => Results
+    def call(repository,
+             github = nil,
+             pulse = nil)
+      github ||= Github.new(auto_pagination: true)
+      pulse ||= HowIs::Pulse.new(repository)
+      user, repo = repository.split('/', 2)
 
+      unless user && repo
+        raise HowIs::CLI::OptionsError, 'To generate a report from GitHub, ' \
+          'provide the repository ' \
+          'username/project. Quitting!'
+      end
 
-  ##
-  # Fetches repository information from GitHub and returns a Results object.
-  Contract String,
-    C::Or[C::RespondTo[:issues, :pulls], nil],
-    C::Or[C::RespondTo[:html_summary], nil] => Results
-  def call(repository,
-        github = nil,
-        pulse = nil)
-    github ||= Github.new(auto_pagination: true)
-    pulse ||= HowIs::Pulse.new(repository)
-    user, repo = repository.split('/', 2)
-    raise HowIs::CLI::OptionsError, 'To generate a report from GitHub, ' \
-                                    'provide the repository username/project. ' \
-                                    'Quitting!' unless user && repo
-    issues  = github.issues.list user: user, repo: repo
-    pulls   = github.pulls.list  user: user, repo: repo
-
-    summary = pulse.html_summary
-
-    Results.new(
-      repository,
-      obj_to_array_of_hashes(issues),
-      obj_to_array_of_hashes(pulls),
-      summary,
-    )
-  end
+      issues  = github.issues.list user: user, repo: repo
+      pulls   = github.pulls.list  user: user, repo: repo
 
-private
-  def obj_to_array_of_hashes(object)
-    object.to_a.map(&:to_h)
+      summary = pulse.html_summary
+
+      Results.new(
+        repository,
+        obj_to_array_of_hashes(issues),
+        obj_to_array_of_hashes(pulls),
+        summary
+      )
+    end
+
+    private
+
+    def obj_to_array_of_hashes(object)
+      object.to_a.map(&:to_h)
+    end
   end
 end

data/lib/how_is/pulse.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'tessellator/fetcher'
 
 class HowIs
@@ -19,7 +21,7 @@ class HowIs
 
     # Gets the HTML Pulse summary.
     def html_summary
-      parts = 
+      parts =
         @pulse_page_response.body
           .split('<div class="section diffstat-summary">')
 
@@ -34,10 +36,11 @@ class HowIs
         .strip
     end
 
-  private
+    private
+
     # Fetch Pulse page from GitHub for scraping.
-    def fetch_pulse!(repository, period='monthly')
-      Tessellator::Fetcher.new.call('get', "https://github.com/#{repository}/pulse/#{period}")
+    def fetch_pulse!(repository)
+      Tessellator::Fetcher.new.call('get', "https://github.com/#{repository}/pulse/monthly")
     end
   end
 end

data/lib/how_is/report/base_report.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'json'
 
 class HowIs
@@ -27,7 +29,7 @@ class HowIs
       issue_or_pr_summary "issue", "issue"
 
       header "Issues Per Label"
-      issues_per_label = analysis.issues_with_label.to_a.sort_by { |(k, v)| v['total'].to_i }.reverse
+      issues_per_label = analysis.issues_with_label.to_a.sort_by { |(_, v)| v['total'].to_i }.reverse
       issues_per_label.map! do |label, hash|
         [label, hash['total'], hash['link']]
       end
@@ -50,37 +52,37 @@ class HowIs
 
     ##
     # Appends a title to the report.
-    def title(_text)
+    def title(_content)
       raise NotImplementedError
     end
 
     ##
     # Appends a header to the report.
-    def header(_text)
+    def header(_content)
       raise NotImplementedError
     end
 
     ##
     # Appends a line of text to the report.
-    def text(_text)
+    def text(_content)
       raise NotImplementedError
     end
 
     ##
     # Appends a link to the report.
-    def link(_text, url)
+    def link(_content, _url)
       raise NotImplementedError
     end
 
     ##
     # Appends an unordered list to the report.
-    def unordered_list(arr)
+    def unordered_list(_arr)
       raise NotImplementedError
     end
 
     ##
     # Appends a horizontal bar graph to the report.
-    def horizontal_bar_graph(data)
+    def horizontal_bar_graph(_data)
       raise NotImplementedError
     end
 
@@ -94,26 +96,27 @@ class HowIs
     # Exports a report to a file.
     #
     # NOTE: May be removed in the future.
-    def export_file(file)
+    def export_file(_file)
       raise NotImplementedError
     end
 
     def to_h
       analysis.to_h
     end
-    alias :to_hash :to_h
+    alias_method :to_hash, :to_h
 
     def to_json
       JSON.pretty_generate(to_h)
     end
 
     private
+
     def pluralize(text, number)
-      number == 1 ? text : "#{text}s"
+      (number == 1) ? text : "#{text}s"
     end
 
     def are_is(number)
-      number == 1 ? "is" : "are"
+      (number == 1) ? "is" : "are"
     end
 
     def issue_or_pr_summary(type, type_label)

data/lib/how_is/report/html.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cgi'
 require 'how_is/report/base_report'
 
@@ -7,21 +9,21 @@ class HowIs
       :html
     end
 
-    def title(_text)
-      @title = _text
-      @r += "\n<h1>#{_text}</h1>\n"
+    def title(content)
+      @title = content
+      @r += "\n<h1>#{content}</h1>\n"
     end
 
-    def header(_text)
-      @r += "\n<h2>#{_text}</h2>\n"
+    def header(content)
+      @r += "\n<h2>#{content}</h2>\n"
     end
 
-    def link(_text, url)
-      %Q[<a href="#{url}">#{_text}</a>]
+    def link(content, url)
+      %[<a href="#{url}">#{content}</a>]
     end
 
-    def text(_text)
-      @r += "<p>#{_text}</p>\n"
+    def text(content)
+      @r += "<p>#{content}</p>\n"
     end
 
     def unordered_list(arr)
@@ -46,13 +48,14 @@ class HowIs
 
       @r += "<table class=\"horizontal-bar-graph\">\n"
       data.each do |row|
-        percentage = get_percentage.(row[1])
+        percentage = get_percentage.call(row[1])
 
-        if row[2]
-          label_text = link(row[0], row[2])
-        else
-          label_text = row[0]
-        end
+        label_text =
+          if row[2]
+            link(row[0], row[2])
+          else
+            row[0]
+          end
 
         @r += <<-EOF
   <tr>
@@ -74,35 +77,35 @@ class HowIs
       report = export
 
       File.open(file, 'w') do |f|
-        f.puts <<-EOF
-<!DOCTYPE html>
-<html>
-<head>
-  <title>#{@title}</title>
-  <style>
-  body { font: sans-serif; }
-  main {
-    max-width: 600px;
-    max-width: 72ch;
-    margin: auto;
-  }
-
-  .horizontal-bar-graph {
-    position: relative;
-    width: 100%;
-  }
-  .horizontal-bar-graph .fill {
-    display: inline-block;
-    background: #CCC;
-  }
-  </style>
-</head>
-<body>
-  <main>
-  #{report}
-  </main>
-</body>
-</html>
+        f.puts <<~EOF
+          <!DOCTYPE html>
+          <html>
+          <head>
+            <title>#{@title}</title>
+            <style>
+            body { font: sans-serif; }
+            main {
+              max-width: 600px;
+              max-width: 72ch;
+              margin: auto;
+            }
+
+            .horizontal-bar-graph {
+              position: relative;
+              width: 100%;
+            }
+            .horizontal-bar-graph .fill {
+              display: inline-block;
+              background: #CCC;
+            }
+            </style>
+          </head>
+          <body>
+            <main>
+            #{report}
+            </main>
+          </body>
+          </html>
         EOF
       end
     end

data/lib/how_is/report/json.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'how_is/report/base_report'
 
 class HowIs

data/lib/how_is/report.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'date'
 require "pathname"
 
@@ -63,7 +65,6 @@ class HowIs
       report.public_send("to_#{report_format}")
     end
 
-  private
     # Given a format name (+format+), returns the corresponding <blah>Report
     # class.
     def self.get_report_class(format)
@@ -73,5 +74,6 @@ class HowIs
 
       HowIs.const_get(class_name)
     end
+    private_class_method :get_report_class
   end
 end

data/lib/how_is/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class HowIs
-  VERSION = "18.0.3"
+  VERSION = "18.0.4"
 end

data/lib/how_is.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'how_is/version'
 require 'contracts'
 require 'cacert'
@@ -54,7 +56,7 @@ class HowIs
   # @return [HowIs] A HowIs object that can be used for generating other
   #   reports, treating the JSON report as a cache.
   def self.from_json(json)
-    self.from_hash(JSON.parse(json))
+    from_hash(JSON.parse(json))
   end
 
   ##
@@ -67,7 +69,7 @@ class HowIs
   def self.from_hash(data)
     analysis = HowIs::Analyzer.from_hash(data)
 
-    self.new(analysis.repository, analysis)
+    new(analysis.repository, analysis)
   end
 
   ##
@@ -77,7 +79,7 @@ class HowIs
   #   generate.
   def self.supported_formats
     report_constants = HowIs.constants.grep(/.Report/) - [:BaseReport]
-    report_constants.map {|x| x.to_s.split('Report').first.downcase }
+    report_constants.map { |x| x.to_s.split('Report').first.downcase }
   end
 
   ##
@@ -93,6 +95,8 @@ class HowIs
 
   # Generate an analysis.
   # TODO: This may make more sense as Analysis.new().
+  # TODO: Nothing overrides +fetcher+ and +analyzer+. Remove ability to do so.
+  # FIXME: THIS CODE AND EVERYTHING ASSOCIATED WITH IT IS A FUCKING ATROCITY.
   Contract C::KeywordArgs[repository: String,
                           fetcher: C::Optional[Class],
                           analyzer: C::Optional[Class],
@@ -119,7 +123,9 @@ class HowIs
     report_data = convert_keys(report_data, :to_sym)
 
     frontmatter = frontmatter.map { |k, v|
-      v = v % report_data
+      # Sometimes report_data has unused keys, which generates a warning, but
+      # we're okay with it.
+      v = silence_warnings { v % report_data }
 
       [k, v]
     }.to_h
@@ -142,7 +148,6 @@ class HowIs
     report_class ||= HowIs::Report
 
     date = Date.strptime(Time.now.to_i.to_s, '%s')
-    date_string = date.strftime('%Y-%m-%d')
     friendly_date = date.strftime('%B %d, %y')
 
     analysis = HowIs.generate_analysis(repository: config['repository'], github: github)
@@ -156,7 +161,9 @@ class HowIs
     generated_reports = {}
 
     config['reports'].map do |format, report_config|
-      filename = report_config['filename'] % report_data
+      # Sometimes report_data has unused keys, which generates a warning, but
+      # we're okay with it.
+      filename = silence_warnings { report_config['filename'] % report_data }
       file = File.join(report_config['directory'], filename)
 
       report = report_class.export(analysis, format)
@@ -187,11 +194,24 @@ class HowIs
     str.string
   end
 
-private
   # convert_keys({'foo' => 'bar'}, :to_sym)
   # => {:foo => 'bar'}
   def self.convert_keys(data, method_name)
-    data.map {|k, v| [k.send(method_name), v]}.to_h
+    data.map { |k, v| [k.send(method_name), v] }.to_h
   end
+  private_class_method :convert_keys
 
+  def self.silence_warnings(&block)
+    with_warnings(nil, &block)
+  end
+  private_class_method :silence_warnings
+
+  def self.with_warnings(flag, &_block)
+    old_verbose = $VERBOSE
+    $VERBOSE = flag
+    yield
+  ensure
+    $VERBOSE = old_verbose
+  end
+  private_class_method :with_warnings
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: how_is
 version: !ruby/object:Gem::Version
-  version: 18.0.3
+  version: 18.0.4
 platform: ruby
 authors:
 - Ellen Marie Dash
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-25 00:00:00.000000000 Z
+date: 2017-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: github_api
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.5
+        version: 0.17.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.5
+        version: 0.17.0
 - !ruby/object:Gem::Dependency
   name: contracts
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: 0.16.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: 0.16.0
 - !ruby/object:Gem::Dependency
   name: slop
   requirement: !ruby/object:Gem::Requirement
@@ -150,6 +150,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.47.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.47.0
 description: 
 email:
 - me@duckie.co
@@ -166,6 +180,7 @@ files:
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - ISSUES.md
 - LICENSE.txt
 - README.md
@@ -211,7 +226,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Quantify the health of a GitHub repository.