how_is 18.0.2 → 18.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7af6f8d15c041385b198ac7aab7e3d0f7daec229
-  data.tar.gz: 8633dfde4863be308641d36c4aad7983981c1b03
+  metadata.gz: d6f35707314d01b26c01a857209228e882ab19e8
+  data.tar.gz: 488bb2052b79301f7c3919f84504e7a786410506
 SHA512:
-  metadata.gz: 0b9ed47bce960ecac6e3b32b1cf95495e6a14624f7a1c713709b8e5a92a91a4c4bb30d1ebe544ae8d06dc6f2099fe72d45588f734c5395187fc7cdddf6e31e34
-  data.tar.gz: d03d18caf52eb5b3195c925ce87137399ed7f172aed06c653afefc6b695f4079ca1635d5ac5bf05ded466f1f4f6afedc0705ab8810732a53b821a6eb71157e1b
+  metadata.gz: 73c0fd55cfae0d7a25dfb60e431bb99a5826872af8d03db6fdef9b44bdda900746210b32bc220026b03c0fe36bc95c7a0bdf0819cdb9ce9868932af915608bed
+  data.tar.gz: 6fc00770653ba6af093c986d4135aa5b30fd187f8a6c89e260fc4b33ec18eee57ffb8323d90a2e2b1f8c2ecc3f08845cff37e8c642a07ed5ab9df3c65ae6e0d3

data/.hound.yml

@@ -0,0 +1,2 @@
+ruby:
+  config_file: .rubocop.yml

data/.rubocop.yml

@@ -0,0 +1,126 @@
+# Exceptions should inherit from StandardError.
+# (RuboCop default is to inherit from RuntimeError.)
+Lint/InheritException:
+  EnforcedStyle: standard_error
+
+# The guiding principle of classes is SRP, SRP can't be accurately measured by LoC
+#Metrics/ClassLength:
+#  Max: 1500
+
+# Still try for 80, but we'll allow 110 because there's a not-insignificant
+# number of cases where we have long lines.
+#
+# It may be worth revisiting this in the future and refactoring those lines.
+Metrics/LineLength:
+  Max: 120
+
+# 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
+
+# Most readable form.
+Style/AlignHash:
+  EnforcedHashRocketStyle: table
+  EnforcedColonStyle: table
+
+# This codebase may be English, but some English words contain diacritics.
+Style/AsciiComments:
+  Enabled: false
+
+# Despite the fact that some English words contain diacritics, we want all
+# method names to be writable by people who don't have an easy way to type
+# words with diacritics.
+Style/AsciiIdentifiers:
+  Enabled: true
+
+# { ... } for multi-line blocks is okay, follow Weirichs rule instead:
+# https://web.archive.org/web/20140221124509/http://onestepback.org/index.cgi/Tech/Ruby/BraceVsDoEnd.rdoc
+Style/BlockDelimiters:
+  Enabled: false
+
+# Unicode is good, mkay?
+Style/Encoding:
+  Enabled: true
+
+# Force Unix line endings.
+Style/EndOfLine:
+  Enabled: true
+  EnforcedStyle: lf
+
+# A lot of the approaches I use for making things readable makes this angry.
+# E.g., formatting multiple consecutive assignments so that the equal signs
+# and values line up.
+#
+# foobar = 'blah'
+# baz    = 'asdf'
+# beep   = 'boop'
+Style/ExtraSpacing:
+  Enabled: false
+
+# Freeze string literals to future-proof the code.
+# TODO: Enable this always. (Disabled due to not knowing what will happen.)
+Style/FrozenStringLiteralComment:
+  Enabled: true
+  #EnforcedStyle: always
+
+# Mixing hash styles just looks silly.
+# http://www.rubydoc.info/gems/rubocop/RuboCop/Cop/Style/HashSyntax
+Style/HashSyntax:
+  EnforcedStyle: no_mixed_keys
+
+# I deplore assignments in conditions and never want them in any codebase
+# I have direct control over.
+Style/ParenthesesAroundCondition:
+  AllowSafeAssignment: false
+Lint/AssignmentInCondition:
+  AllowSafeAssignment: false
+
+# Use [] for `%`-literal delimiters (e.g. for %q[]) that RuboCop doesn't define
+# anything for. (E.g., %q[].)
+#
+# The reason I prefer [] instead of () is that most of the time I use
+# `%`-literals is inside of function calls, and using () makes it blend in too
+# much.
+Style/PercentLiteralDelimiters:
+  Enabled: true
+  PreferredDelimiters:
+    default: "[]"
+
+# `has_key?` and `has_value?` are clearer than `key?` and `value?`.
+Style/PreferredHashMethods:
+  Enabled: true
+  EnforcedStyle: verbose
+
+# do / end blocks should be used for side effects,
+# methods that run a block for side effects and have
+# a useful return value are rare, assign the return
+# value to a local variable for those cases.
+Style/MethodCalledOnDoEndBlock:
+  Enabled: true
+
+# Indenting the chained dots beneath each other is not supported by this cop,
+# see https://github.com/bbatsov/rubocop/issues/1633
+Style/MultilineOperationIndentation:
+  Enabled: false
+
+# {'foo' => 'bar'} not { 'foo' => 'bar' }
+Style/SpaceInsideHashLiteralBraces:
+  Enabled: true
+  EnforcedStyle: no_space
+
+# Use double quotes everywhere by default.
+# TODO: Enable Style/StringLiterals cop. Disabled due to number of violations.
+Style/StringLiterals:
+  Enabled: false
+  #EnforcedStyle: double_quotes
+
+# Require parentheses around complex ternary conditions.
+Style/TernaryParentheses:
+  Enabled: true
+  EnforcedStyle: require_parentheses_when_complex
+
+# Require a comma after the last item in an array or hash if each item is on
+# its own line.
+Style/TrailingCommaInLiteral:
+  EnforcedStyleForMultiline: comma

data/CHANGELOG.md

@@ -9,6 +9,25 @@ this project adheres to [Semantic Versioning](http://semver.org).
 
 (Nothing so far.)
 
+## [v18.0.3]
+
+This release ([snapshot](https://github.com/how-is/how_is/tree/v18.0.3))
+fixes the things the last few releases broke. I think. Hopefully.
+
+It also includes some refactoring work, and the addition of a RuboCop
+configuration.
+
+@duckinator enabled [Hound CI](https://houndci.com) for the repository, which
+should find any RuboCop violations that are added in PRs. The preexisting
+RuboCop violations (of which there are many) need to be addressed separately,
+and there will likely be an entire release dedicated to that.
+
+### Changes
+
+* Add RuboCop config ([#158](https://github.com/how-is/how_is/pull/158))
+* CLI parser refactor ([#157](https://github.com/how-is/how_is/pull/157))
+* exe/how_is: Reinstate to_json, to_html ([#150](https://github.com/how-is/how_is/pull/150), by @olleolleolle)
+
 ## [v18.0.2]
 
 This release ([snapshot](https://github.com/how-is/how_is/tree/v18.0.2))

data/Gemfile

@@ -3,3 +3,10 @@ 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/exe/how_is

@@ -4,8 +4,7 @@ require "how_is"
 require "how_is/cli"
 
 begin
-  parser  = HowIs::CLI::Parser.new
-  result  = parser.call(ARGV)
+  result  = HowIs::CLI.parse(ARGV)
 rescue HowIs::CLI::OptionsError => e
   if ENV['SHOW_TRACE']
     raise
@@ -14,9 +13,7 @@ rescue HowIs::CLI::OptionsError => e
   end
 end
 
-opts      = result[:opts]
-options   = result[:options]
-arguments = result[:arguments]
+options = result[:options]
 
 if options[:help]
   puts result[:opts]
@@ -26,21 +23,11 @@ elsif options[:version]
   exit
 end
 
-def save_files(reports)
-  reports.each do |file, report|
-    format = file.split('.').last
-
-    File.open(file, 'w') do |f|
-      f.write report
-    end
-  end
-end
-
 begin
   if options[:config]
     reports = HowIs.from_config(YAML.load_file(options[:config]))
 
-    save_files(reports)
+    reports.each { |file, report| HowIs::Report.save_report(file, report) }
   else
     report =
       if options[:from]
@@ -50,7 +37,10 @@ begin
         HowIs.new(options[:repository])
       end
 
-    save_files({ options[:report] => report })
+    HowIs::Report.save_report(
+      options[:report],
+      HowIs::Report.to_format_based_on(options[:report], report)
+    )
   end
 
 rescue => e

data/how_is.gemspec

@@ -1,4 +1,5 @@
 # coding: utf-8
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'how_is/version'

data/lib/how_is/cli.rb

@@ -22,17 +22,14 @@ class HowIs::CLI
   class NoRepositoryError < OptionsError
   end
 
-  class Parser
-    attr_reader :opts
-
-    # Parses +argv+ to generate an options Hash to control the behavior of
-    # the library.
-    def call(argv)
-      opts = Slop::Options.new
-
-      # General usage information.
-      opts.banner =
-        <<-EOF.gsub(/ *\| ?/, '')
+  # Parses +argv+ to generate an options Hash to control the behavior of
+  # the library.
+  def self.parse(argv)
+    opts = Slop::Options.new
+
+    # General usage information.
+    opts.banner =
+      <<-EOF.gsub(/ *\| ?/, '')
         | Usage: how_is REPOSITORY [--report REPORT_FILE] [--from JSON_FILE]
         |        how_is --config CONFIG_FILE
         |
@@ -42,74 +39,73 @@ class HowIs::CLI
         | E.g., if you wanted to check https://github.com/how-is/how_is,
         | you'd run `how_is how-is/how_is`.
         |
-        EOF
-
-      opts.separator ""
-      opts.separator "Options:"
-
-      # Allowed arguments:
-      opts.bool   "-h", "--help",    "Print help text"
-      opts.string       "--config",  "YAML config file, used to generate a group of reports"
-      opts.string       "--from",    "JSON report file, used instead of fetching the data again"
-      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"
-
-      # Parse the arguments.
-      parser    = Slop::Parser.new(opts)
-      result    = parser.parse(argv)
-
-      # +options+ is a Hash of flags/values.
-      options   = result.to_hash
-      # +arguments+ is an Array of values that don't correspond to a flag.
-      arguments = result.arguments
-
-      # If --report isn't specified, default to DEFAULT_REPORT_FILE.
-      options[:report] ||= DEFAULT_REPORT_FILE
-
-      # The following are only useful if they're not nil or false.
-      # Removing them here simplifies contracts and keyword args for
-      # other APIs.
-      options.delete(:config)   unless options[:config]
-      options.delete(:help)     unless options[:help]
-      options.delete(:version)  unless options[:version]
-
-      # If we can't export to the specified file, raise an exception.
-      unless HowIs.can_export_to?(options[:report])
-        raise InvalidOutputFileError, "Invalid file: #{options[:report_file]}. Supported formats: #{HowIs.supported_formats.join(', ')}"
-      end
+      EOF
+
+    opts.separator ""
+    opts.separator "Options:"
+
+    # Allowed arguments:
+    opts.bool   "-h", "--help",    "Print help text"
+    opts.string       "--config",  "YAML config file, used to generate a group of reports"
+    opts.string       "--from",    "JSON report file, used instead of fetching the data again"
+    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"
+
+    # Parse the arguments.
+    parser    = Slop::Parser.new(opts)
+    result    = parser.parse(argv)
+
+    # +options+ is a Hash of flags/values.
+    options   = result.to_hash
+    # +arguments+ is an Array of values that don't correspond to a flag.
+    arguments = result.arguments
+
+    # If --report isn't specified, default to DEFAULT_REPORT_FILE.
+    options[:report] ||= DEFAULT_REPORT_FILE
+
+    # The following are only useful if they're not nil or false.
+    # Removing them here simplifies contracts and keyword args for
+    # other APIs.
+    options.delete(:config)   unless options[:config]
+    options.delete(:help)     unless options[:help]
+    options.delete(:version)  unless options[:version]
+
+    # If we can't export to the specified file, raise an exception.
+    unless HowIs.can_export_to?(options[:report])
+      raise InvalidOutputFileError, "Invalid file: #{options[:report]}. Supported formats: #{HowIs.supported_formats.join(', ')}"
+    end
 
-      # If we pass --config, other options (excluding --help and
-      # --version) are ignored. As such, when --config is passed,
-      # everything in this `unless` block is irrelevant.
-      unless options[:config]
-        if options[:from]
-          raise InvalidInputFileError, "No such file: #{options[:from]}" unless File.file?(options[:from])
+    # If we pass --config, other options (excluding --help and
+    # --version) are ignored. As such, when --config is passed,
+    # everything in this `unless` block is irrelevant.
+    unless options[:config]
+      if options[:from]
+        raise InvalidInputFileError, "No such file: #{options[:from]}" unless File.file?(options[:from])
 
-          # Opening the file here is a bit gross, but I couldn't find a
-          # better way to do it. -@duckinator
-          options[:repository] = JSON.parse(open(options[:from]).read)['repository']
+        # Opening the file here is a bit gross, but I couldn't find a
+        # better way to do it. -@duckinator
+        options[:repository] = JSON.parse(open(options[:from]).read)['repository']
 
-          raise InvalidInputFileError, "Invalid JSON report file." unless options[:repository]
+        raise InvalidInputFileError, "Invalid JSON report file." unless options[:repository]
 
-        elsif argv.length >= 1
-          options[:repository] = argv.delete_at(0)
+      elsif argv.length >= 1
+        options[:repository] = argv.delete_at(0)
 
-        else
-          raise NoRepositoryError, "No repository specified."
-        end
+      else
+        raise NoRepositoryError, "No repository specified."
       end
-
-      # Return a Hash with:
-      #   +opts+: the original Slop::Options object.
-      #   +options+: the Hash of flags/values (e.g. +--foo bar+ becomes
-      #     +options[:foo]+ with the value of +"bar"+).
-      #   +arguments+: an Array of arguments that don't have a
-      #     corresponding flags.
-      {
-        opts: opts,
-        options: options,
-        arguments: arguments,
-      }
     end
+
+    # Return a Hash with:
+    #   +opts+: the original Slop::Options object.
+    #   +options+: the Hash of flags/values (e.g. +--foo bar+ becomes
+    #     +options[:foo]+ with the value of +"bar"+).
+    #   +arguments+: an Array of arguments that don't have a
+    #     corresponding flags.
+    {
+      opts: opts,
+      options: options,
+      arguments: arguments,
+    }
   end
 end

data/lib/how_is/report/base_report.rb

@@ -43,7 +43,7 @@ class HowIs
     ##
     # Returns the format of report this class generates.
     #
-    # @returns [Symbol] A lowercase symbol denoting the report format.
+    # @return [Symbol] A lowercase symbol denoting the report format.
     def format
       raise NotImplementedError
     end

data/lib/how_is/report.rb

@@ -1,4 +1,5 @@
 require 'date'
+require "pathname"
 
 class HowIs
   class UnsupportedExportFormat < StandardError
@@ -28,6 +29,40 @@ class HowIs
       report.export
     end
 
+    ##
+    # Saves given Report in given file.
+    #
+    # @param file [String,Pathname] Name of file to write to
+    # @param report [Report] Report to store
+    def self.save_report(file, report)
+      File.open(file, 'w') do |f|
+        f.write report
+      end
+    end
+
+    ##
+    # Returns the report format for given filename.
+    #
+    # @param file [String] Filename of a report
+    #
+    # @return [String] Report format inferred from file name
+    def self.infer_format(file)
+      Pathname(file).extname.delete('.')
+    end
+
+    ##
+    # Exports given +report+ to the format suitable for given +file+.
+    #
+    # @param file [String,Pathname]
+    # @param report [Report]
+    #
+    # @return [String] The rendered report
+    def self.to_format_based_on(file, report)
+      report_format = infer_format(file)
+
+      report.public_send("to_#{report_format}")
+    end
+
   private
     # Given a format name (+format+), returns the corresponding <blah>Report
     # class.

data/lib/how_is/version.rb

@@ -1,3 +1,3 @@
 class HowIs
-  VERSION = "18.0.2"
+  VERSION = "18.0.3"
 end

data/lib/how_is.rb

@@ -33,7 +33,7 @@ class HowIs
   ##
   # Generate an HTML report.
   #
-  # @returns [String] An HTML report.
+  # @return [String] An HTML report.
   def to_html
     Report.export(@analysis, :html)
   end
@@ -41,7 +41,7 @@ class HowIs
   ##
   # Generate a JSON report.
   #
-  # @returns [String] A JSON report.
+  # @return [String] A JSON report.
   def to_json
     Report.export(@analysis, :json)
   end
@@ -51,7 +51,7 @@ class HowIs
   # reports).
   #
   # @param json [String] A JSON report object.
-  # @returns [HowIs] A HowIs object that can be used for generating other
+  # @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))
@@ -62,7 +62,7 @@ class HowIs
   # other reports).
   #
   # @param data [Hash] A hash containing report data.
-  # @returns [HowIs] A HowIs object that can be used for generating other
+  # @return [HowIs] A HowIs object that can be used for generating other
   #   reports, treating the provided report data as a cache.
   def self.from_hash(data)
     analysis = HowIs::Analyzer.from_hash(data)
@@ -73,7 +73,7 @@ class HowIs
   ##
   # Returns a list of possible export formats.
   #
-  # @returns [Array<String>] An array of the types of reports you can
+  # @return [Array<String>] An array of the types of reports you can
   #   generate.
   def self.supported_formats
     report_constants = HowIs.constants.grep(/.Report/) - [:BaseReport]
@@ -84,7 +84,7 @@ class HowIs
   # Returns whether or not the specified +file+ can be exported to.
   #
   # @param file [String] A filename.
-  # @returns [Boolean] +true+ if HowIs can export to the file, +false+
+  # @return [Boolean] +true+ if HowIs can export to the file, +false+
   #   if it can't.
   def self.can_export_to?(file)
     # TODO: Check if the file is writable?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: how_is
 version: !ruby/object:Gem::Version
-  version: 18.0.2
+  version: 18.0.3
 platform: ruby
 authors:
 - Ellen Marie Dash
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-05 00:00:00.000000000 Z
+date: 2017-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: github_api
@@ -159,7 +159,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".hound.yml"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -209,7 +211,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.2
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Quantify the health of a GitHub repository.