how_is 13.0.0 → 14.0.0

data/lib/how_is/analyzer.rb

@@ -47,6 +47,8 @@ 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,
       )
     end
 

data/lib/how_is/cli.rb

@@ -1,10 +1,93 @@
-require 'how_is'
-require 'yaml'
-require 'contracts'
-require 'stringio'
+#!/usr/bin/env ruby
+
+require "how_is"
+require "slop"
 
 class HowIs::CLI
-  include Contracts::Core
+  DEFAULT_REPORT_FILE = "report.#{HowIs::DEFAULT_FORMAT}"
+
+  class OptionsError < StandardError
+  end
+
+  class InvalidOutputFileError < OptionsError
+  end
+
+  class InvalidInputFileError < OptionsError
+  end
+
+  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
+      opts.banner =
+        <<-EOF.gsub(/ *\| ?/, '')
+        | Usage: how_is REPOSITORY [--report REPORT_FILE] [--from JSON_FILE]
+        |        how_is --config CONFIG_FILE
+        |
+        | Where REPOSITORY is <GitHub username or org>/<repository name>.
+        | CONFIG_FILE defaults to how_is.yml.
+        |
+        | 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:"
+
+      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"
+
+      parser    = Slop::Parser.new(opts)
+      result    = parser.parse(argv)
+      options   = result.to_hash
+      arguments = result.arguments
+
+      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]
+
+      # Raise an exception if the file can't be exported.
+      unless HowIs.can_export_to?(options[:report])
+        raise InvalidOutputFileError, "Invalid file: #{options[:report_file]}. Supported formats: #{HowIs.supported_formats.join(', ')}"
+      end
+
+      unless options[:config]
+        # If we pass --config, other options (excluding --help and --version)
+        # are ignored. As such, everything in this `unless` block is irrelevant.
+
+        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_file]).read)['repository']
+          raise InvalidInputFileError, "Invalid JSON report file." unless options[:repository]
+        elsif argv.length >= 1
+          options[:repository] = argv.delete_at(0)
+        else
+          raise NoRepositoryError, "No repository specified."
+        end
+      end
 
+      {
+        opts: opts,
+        options: options,
+        arguments: arguments,
+      }
+    end
+  end
 end

data/lib/how_is/fetcher.rb

@@ -1,5 +1,6 @@
 require 'contracts'
 require 'github_api'
+require 'how_is/pulse'
 
 ##
 # Fetches data from GitHub.
@@ -11,12 +12,12 @@ class HowIs::Fetcher
   #
   # 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)
+  class Results < Struct.new(:repository, :issues, :pulls, :pulse)
     include Contracts::Core
 
-    Contract String, C::ArrayOf[Hash], C::ArrayOf[Hash] => nil
-    def initialize(repository, issues, pulls)
-      super(repository, issues, pulls)
+    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.
@@ -26,10 +27,14 @@ class HowIs::Fetcher
 
   ##
   # Fetches repository information from GitHub and returns a Results object.
-  Contract String, C::Or[C::RespondTo[:issues, :pulls], nil] => Results
+  Contract String,
+    C::Or[C::RespondTo[:issues, :pulls], nil],
+    C::Or[C::RespondTo[:html_summary], nil] => Results
   def call(repository,
-        github = nil)
+        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. ' \
@@ -37,10 +42,13 @@ class HowIs::Fetcher
     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)
+      obj_to_array_of_hashes(pulls),
+      summary,
     )
   end
 

data/lib/how_is/report/base_report.rb

@@ -18,7 +18,7 @@ class HowIs
       # TODO: Stop pretending everyone who runs how_is is in UTC.
       text "Monthly report, ending on #{DateTime.now.new_offset(0).strftime('%B %e, %Y')}."
 
-      text github_pulse_summary
+      text analysis.pulse
 
       header "Pull Requests"
       issue_or_pr_summary "pull", "pull request"
@@ -68,10 +68,6 @@ class HowIs
       raise NotImplementedError
     end
 
-    def monthly_summary
-      raise NotImplementedError
-    end
-
     def export
       raise NotImplementedError
     end
@@ -90,11 +86,6 @@ class HowIs
     end
 
     private
-    def github_pulse_summary
-      @pulse ||= HowIs::Pulse.new(analysis.repository)
-      @pulse.send("#{format}_summary")
-    end
-
     def pluralize(text, number)
       number == 1 ? text : "#{text}s"
     end

data/lib/how_is/report/html.rb

@@ -65,10 +65,6 @@ class HowIs
       @r += "</table>\n"
     end
 
-    def monthly_summary
-      pulse.html_summary
-    end
-
     def export
       @r = ''
       generate_report_text!

data/lib/how_is/report.rb

@@ -1,5 +1,4 @@
 require 'date'
-require 'how_is/pulse'
 
 class HowIs
   class UnsupportedExportFormat < StandardError

data/lib/how_is/version.rb

@@ -1,3 +1,3 @@
 class HowIs
-  VERSION = "13.0.0"
+  VERSION = "14.0.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: how_is
 version: !ruby/object:Gem::Version
-  version: 13.0.0
+  version: 14.0.0
 platform: ruby
 authors:
 - Ellen Marie Dash
@@ -189,12 +189,12 @@ files:
 - exe/how_is
 - fixtures/vcr_cassettes/how-is-example-empty-repository.yml
 - fixtures/vcr_cassettes/how-is-example-repository.yml
+- fixtures/vcr_cassettes/how-is-from-config-frontmatter.yml
 - fixtures/vcr_cassettes/how-is-with-config-file.yml
 - how_is.gemspec
 - lib/how_is.rb
 - lib/how_is/analyzer.rb
 - lib/how_is/cli.rb
-- lib/how_is/cli/parser.rb
 - lib/how_is/fetcher.rb
 - lib/how_is/pulse.rb
 - lib/how_is/report.rb

data/lib/how_is/cli/parser.rb

@@ -1,94 +0,0 @@
-#!/usr/bin/env ruby
-
-require "how_is"
-require "how_is/cli"
-require "slop"
-
-class HowIs::CLI
-  DEFAULT_REPORT_FILE = "report.#{HowIs::DEFAULT_FORMAT}"
-
-  class OptionsError < StandardError
-  end
-
-  class InvalidOutputFileError < OptionsError
-  end
-
-  class InvalidInputFileError < OptionsError
-  end
-
-  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
-      opts.banner =
-        <<-EOF.gsub(/ *\| ?/, '')
-        | Usage: how_is REPOSITORY [--report REPORT_FILE] [--from JSON_FILE]
-        |        how_is --config CONFIG_FILE
-        |
-        | Where REPOSITORY is <GitHub username or org>/<repository name>.
-        | CONFIG_FILE defaults to how_is.yml.
-        |
-        | 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:"
-
-      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"
-
-      parser    = Slop::Parser.new(opts)
-      result    = parser.parse(argv)
-      options   = result.to_hash
-      arguments = result.arguments
-
-      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]
-
-      # Raise an exception if the file can't be exported.
-      unless HowIs.can_export_to?(options[:report])
-        raise InvalidOutputFileError, "Invalid file: #{options[:report_file]}. Supported formats: #{HowIs.supported_formats.join(', ')}"
-      end
-
-      unless options[:config]
-        # If we pass --config, other options (excluding --help and --version)
-        # are ignored. As such, everything in this `unless` block is irrelevant.
-
-        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_file]).read)['repository']
-          raise InvalidInputFileError, "Invalid JSON report file." unless options[:repository]
-        elsif argv.length >= 1
-          options[:repository] = argv.delete_at(0)
-        else
-          raise NoRepositoryError, "No repository specified."
-        end
-      end
-
-      {
-        opts: opts,
-        options: options,
-        arguments: arguments,
-      }
-    end
-  end
-end