how_is 8.0.0 → 9.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4048011b690428fb1074409a0c6407cb1b9b8543
-  data.tar.gz: b31f1009e81f94a45c5bb7c24b7250e8e77072e9
+  metadata.gz: d7243c84fe47a38ab1ebe38586797bfab2e859bb
+  data.tar.gz: 51107d4818272e4019f38592b0b7d2ce55dbdf1d
 SHA512:
-  metadata.gz: 8c15a561a6d278c9a371b56005abea0a5a3e85829f4d84c38fc1e1c888b684f61818cc9b60313aecd509cc641bc93389afdfcaf1a99dd9ee15407c0b04d2d860
-  data.tar.gz: b1319f6338fdc68839064f398b0fdb6503be6ce794b0888293726d0f1bd3912b143a0d9928d3f77a1fac674d01059f5429e56ac0836490882cd72ea550331aa3
+  metadata.gz: 9b9edbd04e8104938e57015d8615f2d49d3503675648b7b6b7a2662f5a6f692689cf5dbc877bf1d62342e64a1d2549af9c93c825782f20266feb9664801130d5
+  data.tar.gz: e60c288394b391aab576498d6b068963d49a030a6211674123b9ad322b01d3b32c786e892b3cc618232a481ec0803bbaed71c3b5357c56b1ba2cc71e0bb57b01

data/.gitignore

@@ -1,15 +1,15 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-report.pdf
-report.json
-report.html
-*.dat
-*.png
-Thumbs.db
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+report.pdf
+report.json
+report.html
+*.dat
+*.png
+Thumbs.db

data/.rspec

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

data/.rspec-ignore-tags

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

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

data/Gemfile

@@ -2,3 +2,4 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in how_is.gemspec
 gemspec
+

data/README.md

@@ -1,76 +1,76 @@
-[![Stories in Ready](https://badge.waffle.io/duckinator/how_is.png?label=ready&title=Ready)](https://waffle.io/duckinator/how_is)
-[![Build Status](https://travis-ci.org/duckinator/how_is.svg?branch=master)](https://travis-ci.org/duckinator/how_is)
-
-# 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.
-
-The summary includes:
-
-* repository name,
-* number of open issues,
-* number of open pull requests,
-* number of open issues associated with each label and with no label,
-* average issue age,
-* average pull request age,
-* date oldest issue was opened,
-* date oldest pull request was opened.
-
-## Installation
-
-Make sure you have [gnuplot](http://gnuplot.info/) installed, then:
-
-    $ gem install how_is
-
-## Usage
-
-    $ how_is <orgname>/<reponame> [--report-file FILENAME]
-
-E.g.,
-
-    $ how_is rubygems/rubygems --report-file report.pdf
-
-The above command creates a PDF containing the summary at `./report.pdf`.
-
-### Generating reports from a config file
-
-Beyond the above, you can also create a config file &mdash; typically called
-how_is.yml &mdash; 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.
-
-The config file is a YAML file. The two root keys are `repository` (the
-repository name, of format USER_OR_ORG/REPOSITORY &mdash; e.g. how-is/how_is)
-and `reports`.
-
-`reports` is a hash of key/value pairs, with the keys being the type of report
-("html", "pdf", or "json") and the values being another hash.
-
-That hash can have the following keys: `directory` (the directory to place the
-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.
-
-Every value under `reports` is a format string, so you can do e.g.
-`filename: "%{date}-report.html"` or (under `frontmatter`)
-`title: "%{date} Report"`.
-
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. Run `bundle exec how_is` to use the gem in this directory, ignoring other installed copies of this gem.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/duckinator/how_is. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
-
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+[![Stories in Ready](https://badge.waffle.io/duckinator/how_is.png?label=ready&title=Ready)](https://waffle.io/duckinator/how_is)
+[![Build Status](https://travis-ci.org/duckinator/how_is.svg?branch=master)](https://travis-ci.org/duckinator/how_is)
+
+# 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.
+
+The summary includes:
+
+* repository name,
+* number of open issues,
+* number of open pull requests,
+* number of open issues associated with each label and with no label,
+* average issue age,
+* average pull request age,
+* date oldest issue was opened,
+* date oldest pull request was opened.
+
+## Installation
+
+Make sure you have [gnuplot](http://gnuplot.info/) installed, then:
+
+    $ gem install how_is
+
+## Usage
+
+    $ how_is <orgname>/<reponame> [--report-file FILENAME]
+
+E.g.,
+
+    $ how_is rubygems/rubygems --report-file report.pdf
+
+The above command creates a PDF containing the summary at `./report.pdf`.
+
+### Generating reports from a config file
+
+Beyond the above, you can also create a config file &mdash; typically called
+how_is.yml &mdash; 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.
+
+The config file is a YAML file. The two root keys are `repository` (the
+repository name, of format USER_OR_ORG/REPOSITORY &mdash; e.g. how-is/how_is)
+and `reports`.
+
+`reports` is a hash of key/value pairs, with the keys being the type of report
+("html", "pdf", or "json") and the values being another hash.
+
+That hash can have the following keys: `directory` (the directory to place the
+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.
+
+Every value under `reports` is a format string, so you can do e.g.
+`filename: "%{date}-report.html"` or (under `frontmatter`)
+`title: "%{date} Report"`.
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. Run `bundle exec how_is` to use the gem in this directory, ignoring other installed copies of this gem.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/duckinator/how_is. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -4,3 +4,27 @@ require "rspec/core/rake_task"
 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'
+  end
+
+  desc 'Run slow tests tag'
+  RSpec::Core::RakeTask.new('integration') do |task|
+    task.pattern = './spec/**/*_spec.rb'
+    task.rspec_opts = '--tag slow'
+  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'
+  end
+end

data/data/issues.plg

@@ -1,22 +1,22 @@
-if (!exists("chartsize")) chartsize = '500,500'
-if (!exists("labelfont")) labelfont = 'Helvetica,12'
-if (!exists("chartfont")) chartfont = 'Helvetica,12'
-if (!exists("data")) data = 'issues-per-label.dat'
-if (!exists("pngfile")) data = 'issues-per-label.png'
-
-set terminal png size chartsize font chartfont
-
-set output pngfile
-
-unset key
-unset border
-set tics nomirror
-unset xtics
-
-set style fill solid 0.15 border
-
-plot data using 1:2 with boxes, data using 1:(0):3 with \
-      labels left \
-      rotate by 90 \
-      font labelfont \
-      offset 0,0.45
+if (!exists("chartsize")) chartsize = '500,500'
+if (!exists("labelfont")) labelfont = 'Helvetica,12'
+if (!exists("chartfont")) chartfont = 'Helvetica,12'
+if (!exists("data")) data = 'issues-per-label.dat'
+if (!exists("pngfile")) data = 'issues-per-label.png'
+
+set terminal png size chartsize font chartfont
+
+set output pngfile
+
+unset key
+unset border
+set tics nomirror
+unset xtics
+
+set style fill solid 0.15 border
+
+plot data using 1:2 with boxes, data using 1:(0):3 with \
+      labels left \
+      rotate by 90 \
+      font labelfont \
+      offset 0,0.45

data/exe/how_is

@@ -1,75 +1,30 @@
-#!/usr/bin/env ruby
-
-require "how_is"
-require "how_is/cli"
-require "optparse"
-
-options = {
-  repository: nil,
-  report_file:  "report.pdf",
-  from_file: nil,
-  use_config_file: false,
-  config_file: nil,
-}
-
-opts = OptionParser.new do |opts|
-  opts.banner =
-    <<-EOF.gsub(/ *\| ?/, '')
-      | Usage: how_is REPOSITORY [--report REPORT_FILE]
-      |
-      | Where REPOSITORY is of the format <GitHub username or org>/<repository name>.
-      |
-      | E.g., if you wanted to check https://github.com/duckinator/how_is,
-      | you'd run `how_is duckinator/how_is`.
-      |
-    EOF
-
-  opts.separator ""
-  opts.separator "Options:"
-
-  opts.on("-h", "--help", "Print this help") do
-    puts opts
-    exit 0
-  end
-
-  opts.on("--config [YAML_CONFIG_FILE]", "generate reports as specified in YAML_CONFIG_FILE") do |file|
-    options[:use_config_file] = true
-    options[:config_file] = file
-  end
-
-  opts.on("--from JSON_REPORT_FILE", "import JSON_REPORT_FILE instead of fetching the data again") do |file|
-    options[:from_file] = file
-  end
-
-  opts.on("--report REPORT_FILE", "file containing the report") do |file|
-    options[:report_file] = file
-  end
-
-  opts.on("-v", "--version", "prints the version") do
-    puts HowIs::VERSION
-    exit
-  end
-end
-opts.parse!
-
-if options[:use_config_file]
-  HowIs::CLI.new.from_config_file(options[:config_file])
-  exit
-end
-
-
-unless HowIs.can_export_to?(options[:report_file])
-   abort "Invalid file: #{options[:report_file]}. Supported formats: #{HowIs.supported_formats.join(', ')}"
-end
-
-if options[:from_file]
-  # Opening this file here seems a bit messy, but it works.
-  options[:repository] = JSON.parse(open(options[:from_file]).read)['repository']
-  abort "Error: Invalid JSON report file." unless options[:repository]
-elsif ARGV.length >= 1
-  options[:repository] = ARGV.delete_at(0)
-else
-  abort "Error: No repository specified."
-end
-
-HowIs.generate_report_file(options)
+#!/usr/bin/env ruby
+
+require "how_is"
+require "how_is/cli"
+require "how_is/cli/parser"
+
+begin
+  parser  = HowIs::CLI::Parser.new
+  result  = parser.call(ARGV)
+rescue HowIs::CLI::OptionsError => e
+  if ENV['SHOW_TRACE']
+    raise
+  else
+    abort "Error: #{e.message}"
+  end
+end
+
+opts      = result[:opts]
+options   = result[:options]
+arguments = result[:arguments]
+
+if options[:help]
+  puts result[:opts]
+elsif options[:version]
+  puts HowIs::VERSION
+elsif options[:config]
+  HowIs::CLI.new.from_config_file(options[:config])
+else
+  HowIs.generate_report_file(options)
+end

data/how_is.gemspec

@@ -1,37 +1,38 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'how_is/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "how_is"
-  spec.version       = HowIs::VERSION
-  spec.authors       = ["Ellen Marie Dash"]
-  spec.email         = ["me@duckie.co"]
-
-  spec.summary       = %q{Quantify the health of a GitHub repository is.}
-  spec.homepage      = "https://github.com/duckinator/how_is"
-  spec.license       = "MIT"
-
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_runtime_dependency "github_api", "~> 0.13.1"
-  spec.add_runtime_dependency "contracts"
-  spec.add_runtime_dependency "prawn"
-
-  spec.add_runtime_dependency "mini_magick"
-
-  # Travis CI only supports up to Ruby 2.2.0, but Rack 2.0+ requires Ruby 2.2.2+,
-  # so this pegs Rack to the latest version that works with Ruby 2.2.0.
-  spec.add_runtime_dependency "rack", "< 2.0"
-
-  spec.add_runtime_dependency "tessellator-fetcher", "~> 4.0.1"
-
-  spec.add_development_dependency "bundler", "~> 1.11"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency 'timecop', '~> 0.8.1'
-end
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'how_is/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "how_is"
+  spec.version       = HowIs::VERSION
+  spec.authors       = ["Ellen Marie Dash"]
+  spec.email         = ["me@duckie.co"]
+
+  spec.summary       = %q{Quantify the health of a GitHub repository is.}
+  spec.homepage      = "https://github.com/duckinator/how_is"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "github_api", "~> 0.13.1"
+  spec.add_runtime_dependency "contracts"
+  spec.add_runtime_dependency "slop"
+  spec.add_runtime_dependency "prawn"
+
+  spec.add_runtime_dependency "mini_magick"
+
+  # Travis CI only supports up to Ruby 2.2.0, but Rack 2.0+ requires Ruby 2.2.2+,
+  # so this pegs Rack to the latest version that works with Ruby 2.2.0.
+  spec.add_runtime_dependency "rack", "< 2.0"
+
+  spec.add_runtime_dependency "tessellator-fetcher", "~> 5.0.0"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "timecop", "~> 0.8.1"
+end