how_is 11.0.0 → 12.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 54f57134fd048db57ac6305e075305d6e26d0bcc
-  data.tar.gz: 8b822b82157a68d82c4f842af37ebe21b2b98834
+  metadata.gz: f94a1942844fecd5d67a87e5bcfa10fa8cfb9218
+  data.tar.gz: 71f9b9df67822471f710bb78ecec7e8ce7e7c219
 SHA512:
-  metadata.gz: f71efbd4e9393c1f4b93ba3e24b43c4a9bb2ed9ed46d2bfb7de7464337e1eb7788092c5d05a5ff782709114c30512dbc730941d88b1ea035c0b717085bd22232
-  data.tar.gz: 79f8473db656c9cfd5588345bd4ac9c8055dcae692d55dde7dfaa4d4af457511d499f456dbf1031041126ae16ea6e5adb193d25db5c9ccf0b67953aba01bc4c3
+  metadata.gz: 4ed0992ecdf4d9a7f4b0351ede0961e3daa82a33d759652b20643b7238fcc515487a4b820c0e4643c95e60f9ee76e1a88566c83f5ea115e4298a24b1b9cac425
+  data.tar.gz: 1fbe9fd60239c6f478164ffc3feb2e890053a87c7fd44e7cb821da869ca976f881b5c368948c00d9c48f7b4cdd87b6396d35ef039b7ff6ed9f9c2bc51822af10

data/.rspec

@@ -1,6 +1,2 @@
 --format documentation
 --color
-
-# Skip all tests tagged with "integration" or "slow"
---tag ~integration
---tag ~slow

data/.travis.yml

@@ -1,8 +1,5 @@
 language: ruby
-env:
-  - TEST_SUITE=units
-  - TEST_SUITE=integration
-script: "bundle exec rake test:$TEST_SUITE"
+script: "bundle exec rake spec"
 rvm:
   - 2.2
 before_install: gem install bundler -v 1.11.2

data/CHANGELOG.md

@@ -9,6 +9,30 @@ this project adheres to [Semantic Versioning](http://semver.org).
 
 (Nothing so far.)
 
+## [v12.0.0]
+
+This release largely focused on refactoring and developer experience
+improvements (e.g. adding Rake tasks and improving the generated JSON and HTML).
+
+Pull Requests for this release can be [viewed on
+GitHub](https://github.com/how-is/how_is/pulls?utf8=&q=is%3Apr%20created%3A2016-11-11..2016-12-11).
+
+### Added
+
+- Include newest PR/issue in reports.
+  ([#85](https://github.com/how-is/how_is/pull/85))
+
+### Changed
+
+- Refactoring. ([#79](https://github.com/how-is/how_is/pull/79), [#80](https://github.com/how-is/how_is/pull/80), [#82](https://github.com/how-is/how_is/pull/82), [#88](https://github.com/how-is/how_is/pull/88))
+- JSON and HTML reports have nicer source.
+  ([#82](https://github.com/how-is/how_is/pulls/82),
+  [#84](https://github.com/how-is/how_is/pulls/84))
+- Handle generating a report on a repository with no open issues.
+  ([#92](https://github.com/how-is/how_is/pull/92))
+- Add Rake tasks to make development easier. ([#86](https://github.com/how-is/how_is/pull/86), [#94](https://github.com/how-is/how_is/pull/94), [#96](https://github.com/how-is/how_is/pull/96))
+- PR/issue info is now displayed as lists instead of paragraphs. ([#83](https://github.com/how-is/how_is/pull/83))
+
 ## [11.0.0]
 
 ### Added

data/README.md

@@ -3,7 +3,7 @@
 
 # How is [your repo]?
 
-`how_is` is tool for generating summaries of the health of a codebase. It uses information available from issues and pull requests to provide an overview of a repository and highlight problem areas of the codebase.
+`how_is` is tool for generating summaries of the health of a codebase hosted on GitHub. It uses information available from issues and pull requests to provide an overview of a repository and highlight problem areas of the codebase.
 
 The summary includes:
 
@@ -37,11 +37,24 @@ The above command creates a HTML file containing the summary at `./report.html`.
 #### Generating reports from a config file
 
 Beyond the above, you can also create a config file — typically called
-how_is.yml — and run `how_is --config YAML_CONFIG_FILE`. If your config
-file is called how_is.yml, you can just run `how_is --config`.
-
-You can see [the how_is.yml in the how-is-rubygems repository](https://github.com/how-is/how-is-rubygems/blob/gh-pages/how_is.yml)
-for an example.
+how_is.yml — and run `how_is --config YAML_CONFIG_FILE`. (E.g., if
+the config file is how_is.yml, you would run `how_is --config how_is.yml`.)
+
+Below is an example config file, [from the how-is-rubygems repository](https://github.com/how-is/how-is-rubygems/blob/gh-pages/how_is.yml).
+
+```yaml
+repository: rubygems/rubygems
+reports:
+  html:
+    directory: _posts
+    frontmatter:
+      title: "%{date} Report"
+      layout: default
+    filename: "%{date}-report.html"
+  json:
+    directory: json
+    filename: "%{date}.json"
+```
 
 The config file is a YAML file. The two root keys are `repository` (the
 repository name, of format USER_OR_ORG/REPOSITORY — e.g. how-is/how_is)
@@ -55,7 +68,8 @@ report in), `filename` (the format string for filenames), and (optionally)
 `frontmatter`.
 
 `frontmatter` is a set of key/value pairs specifying frontmatter as used by
-various blog engines (e.g. Jekyll), so you can set title, layout, etc.
+various blog engines (e.g. Jekyll), so you can set the title, layout, etc of
+the page.
 
 Every value under `reports` is a format string, so you can do e.g.
 `filename: "%{date}-report.html"` or (under `frontmatter`)

data/Rakefile

@@ -1,30 +1,62 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+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)
 
 task :default => :spec
 
-namespace :test do
-  task :units => :spec
-
-  desc 'Run integration tests tag'
-  RSpec::Core::RakeTask.new('integration') do |task|
-    task.pattern = './spec/**/*_spec.rb'
-    task.rspec_opts = '--tag integration'
+class HelperFunctions
+  def self.freeze_time(&block)
+    date = DateTime.parse('2016-11-01').new_offset(0)
+    Timecop.freeze(date) do
+      yield
+    end
   end
 
-  desc 'Run slow tests tag'
-  RSpec::Core::RakeTask.new('integration') do |task|
-    task.pattern = './spec/**/*_spec.rb'
-    task.rspec_opts = '--tag slow'
+  def self.generate_report(repository, format)
+    freeze_time do
+      report = nil
+
+      options = {
+        repository: repository,
+        format: format,
+      }
+
+      cassette = repository.gsub('/', '-')
+      VCR.use_cassette(cassette) do
+        report = HowIs.generate_report(**options)
+      end
+
+      filename = "#{cassette}-report.#{format}"
+      path = File.expand_path("spec/data/#{filename}", __dir__)
+      File.open(path, 'w') do |f|
+        f.puts report
+        # HACK: Trailing newline is missing, otherwise.
+        f.puts if format == 'html'
+      end
+    end
   end
+end
 
+namespace :generate_reports do
+  desc 'Generate example HTML reports.'
+  task :html do
+    %w[
+      how-is/example-repository
+      how-is/example-empty-repository
+    ].each do |repo|
+      HelperFunctions.generate_report(repo, 'html')
+    end
+  end
 
-  desc 'Run all tests regardless of tags'
-  RSpec::Core::RakeTask.new('all') do |task|
-    task.pattern = './spec/**/*_spec.rb'
-    # Load the tagless options file
-    task.rspec_opts = '-O .rspec-ignore-tags'
+  desc 'Generate example JSON reports.'
+  task :json do
+    HelperFunctions.generate_report('how-is/example-repository', 'json')
   end
+
+  task :all => [:html, :json]
 end