how_is 24.0.0 → 25.0.0

data/lib/how_is/templates/{report_partial.html_template → report_partial.html}

@@ -2,11 +2,11 @@
 <h1>%{title}</h1>
 <p>%{contributions_summary}</p>
 
+<h2>New Contributors</h2>
+%{new_contributors}
+
 <h2>Pull Requests</h2>
 %{pulls_summary}
 
 <h2>Issues</h2>
 %{issues_summary}
-
-<h2>Issues Per Label</h2>
-%{issues_per_label}

data/lib/how_is/text.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module HowIs
+  ##
+  # Helper class for printing text, but hiding it when e.g. running in CI.
+  class Text
+    def self.show_default_output
+      @show_default_output = true unless
+        instance_variable_defined?(:"@show_default_output")
+
+      @show_default_output
+    end
+
+    def self.show_default_output=(val)
+      @show_default_output = val
+    end
+
+    def self.print(*args)
+      Kernel.print(*args) if HowIs::Text.show_default_output
+    end
+
+    def self.puts(*args)
+      Kernel.puts(*args) if HowIs::Text.show_default_output
+    end
+  end
+end

data/lib/how_is/version.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
 module HowIs
-  VERSION = "24.0.0"
+  VERSION = "25.0.0"
+  VERSION_STRING = "how_is #{HowIs::VERSION}"
 end

data/lib/how_is.rb

@@ -1,39 +1,47 @@
 # frozen_string_literal: true
 
 require "how_is/version"
+require "how_is/config"
 require "how_is/report"
+require "how_is/report_collection"
 
+##
+# Top-level module for creating a report.
 module HowIs
-  DEFAULT_REPORT_FILE = "report.html"
+  def self.default_config(repository)
+    {
+      "repository" => repository,
+      "reports" => {
+        "html" => {
+          "directory" => ".",
+          "frontmatter" => {},
+          "filename" => "report.html",
+        },
+      },
+    }
+  end
 
-  def self.new(repository, date)
-    Report.new(repository, date)
+  def self.new(repository, date, cache_mechanism = nil)
+    config =
+      Config.new
+        .load_defaults
+        .load(default_config(repository))
+    config["cache"] = {"type" => "self", "cache_mechanism" => cache_mechanism} if cache_mechanism
+    Report.new(config, date)
   end
 
   ##
   # Generates a series of report files based on a config Hash.
   #
-  # @param config [Hash] A Hash specifying the formats, locations, etc
-  #   of the reports to generate.
+  # @param config [ReportCollection] All the information needed to generate
+  #   the reports.
   # @param date [String] A string containing the date (YYYY-MM-DD) that the
   #   report ends on. E.g., for Jan 1-Feb 1 2017, you'd pass 2017-02-01.
   def self.from_config(config, date)
-    report = Report.new(config["repository"], date)
-    report_data = prepare_report_metadata(config["repository"], date)
-
-    generated_reports =
-      config["reports"].map { |format, report_config|
-        # Sometimes report_data has unused keys, which generates a warning, but
-        # we're okay with it, so we wrap it with silence_warnings {}.
-        filename = silence_warnings { report_config["filename"] % report_data }
-        file = File.join(report_config["directory"], filename)
-
-        report_export = report.send("to_#{format}", report_config["frontmatter"])
+    raise "Expected config to be Hash, got #{config.class}" unless \
+      config.is_a?(Hash)
 
-        [file, report_export]
-      }
-
-    generated_reports.to_h
+    ReportCollection.new(config, date)
   end
 
   ##
@@ -44,47 +52,12 @@ module HowIs
     ["html", "json"]
   end
 
-  def self.template(filename)
-    dir  = File.expand_path("./how_is/templates/", __dir__)
-    path = File.join(dir, filename)
-
-    open(path).read
-  end
-
   ##
-  # Returns whether or not the specified +file+ can be exported to.
+  # Returns whether or not the specified +format+ is supported.
   #
-  # @param file [String] A filename.
-  # @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?
-    supported_formats.include?(file.split(".").last)
-  end
-
-  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
-
-  def self.prepare_report_metadata(repository, date)
-    end_date = DateTime.strptime(date, "%Y-%m-%d")
-    friendly_end_date = end_date.strftime("%B %d, %y")
-
-    {
-      repository: repository,
-      date: end_date,
-      friendly_date: friendly_end_date,
-    }
+  # @param format_name [String] The format in question.
+  # @return [Boolean] +true+ if HowIs supports the format, +false+ otherwise.
+  def self.supported_format?(format_name)
+    supported_formats.include?(format_name)
   end
-  private_class_method :prepare_report_metadata
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: how_is
 version: !ruby/object:Gem::Version
-  version: 24.0.0
+  version: 25.0.0
 platform: ruby
 authors:
 - Ellen Marie Dash
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-17 00:00:00.000000000 Z
+date: 2019-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: github_api
@@ -24,34 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.18.1
-- !ruby/object:Gem::Dependency
-  name: contracts
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.16.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.16.0
 - !ruby/object:Gem::Dependency
   name: okay
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 7.0.0
+        version: '11.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 7.0.0
+        version: '11.0'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -100,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.8'
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
@@ -178,20 +164,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: 
 email:
 - me@duckie.co
@@ -203,13 +175,12 @@ files:
 - ".codeclimate.yml"
 - ".github_changelog_generator"
 - ".gitignore"
-- ".hound.yml"
 - ".rspec"
 - ".rubocop.yml"
-- ".rubocop_todo.yml"
 - ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - Gemfile
 - ISSUES.md
 - LICENSE.txt
@@ -219,6 +190,7 @@ files:
 - bin/prerelease-generate-changelog
 - bin/setup
 - bors.toml
+- build-debug.rb
 - design/01-functionality.md
 - design/02-implementation.md
 - exe/how_is
@@ -240,21 +212,31 @@ files:
 - fixtures/vcr_cassettes/how_is_contributions_summary_2.yml
 - how_is.gemspec
 - lib/how_is.rb
+- lib/how_is/cacheable.rb
 - lib/how_is/cli.rb
+- lib/how_is/config.rb
+- lib/how_is/constants.rb
+- lib/how_is/date_time_helpers.rb
 - lib/how_is/frontmatter.rb
 - lib/how_is/report.rb
+- lib/how_is/report_collection.rb
 - lib/how_is/sources.rb
+- lib/how_is/sources/ci/appveyor.rb
+- lib/how_is/sources/ci/travis.rb
 - lib/how_is/sources/github.rb
 - lib/how_is/sources/github/contributions.rb
+- lib/how_is/sources/github/issue_fetcher.rb
 - lib/how_is/sources/github/issues.rb
 - lib/how_is/sources/github/pulls.rb
 - lib/how_is/sources/github_helpers.rb
-- lib/how_is/sources/travis.rb
-- lib/how_is/templates/issues_or_pulls_partial.html_template
-- lib/how_is/templates/report.html_template
-- lib/how_is/templates/report_partial.html_template
+- lib/how_is/template.rb
+- lib/how_is/templates/contributions_partial.html
+- lib/how_is/templates/issues_or_pulls_partial.html
+- lib/how_is/templates/new_contributors_partial.html
+- lib/how_is/templates/report.html
+- lib/how_is/templates/report_partial.html
+- lib/how_is/text.rb
 - lib/how_is/version.rb
-- roadmap.markdown
 homepage: https://github.com/how-is/how_is
 licenses:
 - MIT
@@ -265,17 +247,16 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Quantify the health of a GitHub repository.

data/.hound.yml

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

data/.rubocop_todo.yml

@@ -1,21 +0,0 @@
-# This configuration was generated by
-# `rubocop --auto-gen-config`
-# on 2017-07-16 19:09:46 +0200 using RuboCop version 0.49.1.
-# The point is for the user to remove these configuration records
-# one by one as the offenses are removed from the code base.
-# Note that changes in the inspected code, or installation of new
-# versions of RuboCop, may require this file to be generated again.
-
-# Offense count: 8
-Metrics/AbcSize:
-  Max: 31
-
-# Offense count: 2
-# Configuration parameters: CountComments.
-Metrics/ClassLength:
-  Max: 117
-
-# Offense count: 3
-# Configuration parameters: CountComments.
-Metrics/MethodLength:
-  Max: 31

data/lib/how_is/sources/travis.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-require "okay/http"
-require "how_is/sources/github"
-
-module HowIs::Sources
-  # Fetches metadata about CI builds from travis-ci.org.
-  class Travis
-    # @param repository [String] GitHub repository name, of the format user/repo.
-    # @param start_date [String] Start date for the report being generated.
-    # @param end_date [String] End date for the report being generated.
-    def initialize(repository, start_date, end_date)
-      @repository = repository
-      @start_date = start_date
-      @end_date = end_date
-      # TODO: Use start/end date.
-      # TODO: Figure out Default Branch of the repo
-    end
-
-    def builds
-      JSON.parse(fetch_builds)
-    end
-
-    private
-
-    # Returns API result of /repos/:user/:repo/builds for Push type Travis
-    # events.
-    #
-    # @return [String] JSON result
-    def fetch_builds
-      Okay::HTTP.get(
-        "http://api.travis-ci.org/repos/#{@repository}/builds?event_type=push",
-        headers: {"Accept" => "application/vnd.travis-ci.2+json"}
-      ).body
-    end
-  end
-end

data/roadmap.markdown

@@ -1,82 +0,0 @@
-# How_is Roadmap
-
-2016-09-01
-
-A brief overview of how_is' goals and current status.
-
-## Current Progress
-
-So far, HTML and JSON reports work extremely well. PDF support has lagged
-due to difficulties finding a library that can do everything needed.
-There is [an integration test that fails for an unknown reason](https://github.com/how-is/how_is/issues/36).
-
-Reports can be generated using a config file, typically named
-how_is.yml. This has been successfully used for
-[how-is.github.io/how-is-rubygems](https://how-is.github.io/how-is-rubygems/)
-([how_is.yml source](https://github.com/how-is/how-is-rubygems/blob/gh-pages/how_is.yml)).
-
-how_is can be used as either an executable or a library, however
-[library usage is currently undocumented](https://github.com/how-is/how_is/issues/45).
-
-Metrics that have been implemented include:
-
-* number of open Issues,
-* number of open Pull Requests,
-* number of issues associated with each label, as well as the number associated with no label,
-* average Issue age,
-* average Pull Request age,
-* date oldest Issue was opened,
-* date oldest Pull Request was opened.
-
-HTML reports contain a graph showing the issues assigned each label (or no
-label). PDF reports contain a less-nice variant of
-that graph.
-
-## Goals
-
-The next major steps are complex metrics and creating a web
-dashboard for multiple projects.
-
-Complex metrics require things like cloning the repository or making multiple API requests.
-
-### Complex Metrics
-
-Complex metrics will include:
-
-* code churn (code change over time),
-* average response time by a team member in the past week,
-* graph of average response time by a team member per week.
-
-These metrics serve to either quantify the state of the repository, quantify the state of the codebase itself, or both. By quantifying the state of the issue tracker and codebase, it will hopefully be easier to decide what needs to be done.
-
-### Dashboard
-
-The end goal for the dashboard is to have a website where you can view
-information about multiple projects, and identify trends.
-
-Currently, there is a way to generate reports based on a configuration
-file, which has been successfully used to generate [reports for RubyGems](https://how-is.github.io/how-is-rubygems/).
-However, these have to be manually generated each month.
-
-Idealy, these could be generated automatically, and would be stored in a
-database. Once that is done, the information can be more easily retrieved
-in groups and used to generate graphs or more complex summaries.
-
-## Milestones
-
-Before beginning work on the dashboard, the how_is APIs need to be
-documented and possibly cleaned up.
-
-Once that's done, the plan for beginning work on the dashboard is
-roughly:
-
-1. decide what the dashboard will eventually contain,
-2. create a design for the finished dashboard (so we know what's being
-  worked towards),
-3. figure out the software architecture required to support this,
-4. determine what parts of the dashboard are currently implementable,
-5. create an intermediate design for what how_is can actually support
-  (this should be a subset of the original design).
-
-Once these have been done, it should be possible to have people work on
-the dashboard in parallel.