how_is 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2a6fdbded1ff0bf48eba79e033d60b63fe5b3227
-  data.tar.gz: 3cce6191b1f525431233d27fc856f593d2e59b3f
+  metadata.gz: 0d03e9957e3cfefe6c95927bf11693ee2556d318
+  data.tar.gz: 9159d25f1cd1f7d221a21fb7d0d38a844a271fda
 SHA512:
-  metadata.gz: 9c6e101d9dbf277c6df9f21b0c68457316bd346a2d97d93472a9f4661d44f06ae9987901368e5bb09b24f63d6e66e2ee71f5f91c5c8ff03b46d9d4696e993afd
-  data.tar.gz: 7f66062db788773e525b566acc9b8f38cbcb9c381176f8150059368601e04a10d096867e70e80457e571d9a4b4de678c9954dd55bad81e9406e30981677e342f
+  metadata.gz: bad3e1bd77fa4958c81c497b3002309121efc4575c8f5b45e31d302abb7ce23a0332999bcf631e08b735a612acb32ae0eb57e4b35df4d7b332b3adf2618506a2
+  data.tar.gz: f6989dc7995c9aaf8215f1dd813d9173a14aa54fc9003bec21d91885e6335ac26c2a33c76ceaad4791a6243e0b3e9291cd89a5f65b3c7ecd190e72057e95926f

data/.gitignore

@@ -9,5 +9,6 @@
 /tmp/
 report.pdf
 report.json
+report.html
 *.dat
 *.png

data/.rspec

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

data/.travis.yml

@@ -1,6 +1,6 @@
-language: ruby
-rvm:
-  - 2.2
-  - jruby
-  - rbx-2
-before_install: gem install bundler -v 1.11.2
+language: ruby
+rvm:
+  - 2.2
+  - jruby
+  - rbx-2
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -1,49 +1,49 @@
-# Contributor Code of Conduct
-
-As contributors and maintainers of this project, and in the interest of
-fostering an open and welcoming community, we pledge to respect all people who
-contribute through reporting issues, posting feature requests, updating
-documentation, submitting pull requests or patches, and other activities.
-
-We are committed to making participation in this project a harassment-free
-experience for everyone, regardless of level of experience, gender, gender
-identity and expression, sexual orientation, disability, personal appearance,
-body size, race, ethnicity, age, religion, or nationality.
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery
-* Personal attacks
-* Trolling or insulting/derogatory comments
-* Public or private harassment
-* Publishing other's private information, such as physical or electronic
-  addresses, without explicit permission
-* Other unethical or unprofessional conduct
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-By adopting this Code of Conduct, project maintainers commit themselves to
-fairly and consistently applying these principles to every aspect of managing
-this project. Project maintainers who do not follow or enforce the Code of
-Conduct may be permanently removed from the project team.
-
-This code of conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community.
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting a project maintainer at me@duckie.co. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. Maintainers are
-obligated to maintain confidentiality with regard to the reporter of an
-incident.
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 1.3.0, available at
-[http://contributor-covenant.org/version/1/3/0/][version]
-
-[homepage]: http://contributor-covenant.org
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at me@duckie.co. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
 [version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -1,21 +1,21 @@
-The MIT License (MIT)
-
-Copyright (c) 2016 Ellen Marie Dash
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+The MIT License (MIT)
+
+Copyright (c) 2016 Ellen Marie Dash
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -16,6 +16,8 @@ The summary includes:
 
 ## Installation
 
+Make sure you have [gnuplot](http://gnuplot.info/) installed, then:
+
     $ gem install how_is
 
 ## Usage

data/Rakefile

@@ -1,6 +1,6 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -1,14 +1,14 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "how_is"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "how_is"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -1,8 +1,8 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/data/how_is_spec/generate_report--generates-a-correct-JSON-report.json

@@ -0,0 +1 @@
+{"repository":"rubygems/rubygems","number_of_issues":30,"number_of_pulls":30,"issues_with_label":{"triage":7,"bug report":9,"feedback":4,"osx":1,"bug fix":4,"category - install":5,"feature implementation":2,"major bump":2,"windows":1,"feature request":1,"cleanup":1,"accepted":2,"category - #gem or #require":1,"ready for work":1,"question":3,"administrative":1},"issues_with_no_label":0,"average_issue_age":"approximately 3 months and 1 week","average_pull_age":"approximately 11 months and 3 days","oldest_issue_date":"2016-01-31T21:28:02+00:00","oldest_pull_date":"2013-09-16T15:04:07+00:00"}

data/exe/how_is

@@ -39,10 +39,14 @@ opts = OptionParser.new do |opts|
 end
 opts.parse!
 
-if ARGV.length >= 1
+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(options)
+HowIs.generate_report_file(options)

data/lib/how_is/analyzer.rb

@@ -80,11 +80,10 @@ module HowIs
     end
 
     def average_date_for(issues_or_pulls)
-      timestamps = issues_or_pulls.map { |iop| Time.parse(iop['created_at']).to_i }
+      timestamps = issues_or_pulls.map { |iop| Date.parse(iop['created_at']).strftime('%s').to_i }
       average_timestamp = timestamps.reduce(:+) / issues_or_pulls.length
 
-      average_time = Time.at(average_timestamp)
-      Date.parse(average_time.to_s)
+      Date.strptime(average_timestamp.to_s, '%s')
     end
 
     # Given an Array of issues or pulls, return the average age of them.

data/lib/how_is/fetcher.rb

@@ -24,9 +24,10 @@ class HowIs::Fetcher
   end
 
 
-  Contract String, C::RespondTo[:issues, :pulls] => Results
+  Contract String, C::Or[C::RespondTo[:issues, :pulls], nil] => Results
   def call(repository,
-        github = Github.new(auto_pagination: true))
+        github = nil)
+    github ||= Github.new(auto_pagination: true)
     user, repo = repository.split('/', 2)
     issues  = github.issues.list user: user, repo: repo
     pulls   = github.pulls.list  user: user, repo: repo

data/lib/how_is/report/html.rb

@@ -1,7 +1,78 @@
 module HowIs
   class HtmlReport < BaseReport
-    def export!(&block)
-      raise NotImplementedError
+    def title(_text)
+      @title = _text
+      @r += "<h1>#{_text}</h1>"
+    end
+
+    def header(_text)
+      @r += "<h2>#{_text}</h2>"
+    end
+
+    def horizontal_bar_graph(data)
+      biggest = data.map(&:last).max
+      get_percentage = ->(number_of_issues) { number_of_issues * 100 / biggest }
+
+      longest_label_length = data.map(&:first).map(&:length).max
+      label_width = "#{longest_label_length}ch"
+
+      @r += '<table class="horizontal-bar-graph">'
+      data.each do |row|
+        percentage = get_percentage.(row[1])
+        @r += <<-EOF
+  <tr>
+    <td style="width: #{label_width}">#{row[0]}</td>
+    <td><span class="fill" style="width: #{percentage}%">#{row[1]}</span></td>
+  </tr>
+        EOF
+      end
+      @r += "</table>"
+    end
+
+    def text(_text)
+      @r += "<p>#{_text}</p>"
+    end
+
+    def export(&block)
+      @r = ''
+      instance_exec(&block)
+    end
+
+    def export!(file, &block)
+      report = export(&block)
+
+      File.open(file, 'w') do |f|
+        f.puts <<-EOF
+<!DOCTYPE html>
+<html>
+<head>
+  <title>#{@title}</title>
+  <style>
+  body { font: sans-serif; }
+  main {
+    max-width: 600px;
+    max-width: 72ch;
+    margin: auto;
+  }
+
+  .horizontal-bar-graph {
+    position: relative;
+    width: 100%;
+  }
+  .horizontal-bar-graph .fill {
+    display: inline-block;
+    background: #CCC;
+  }
+  </style>
+</head>
+<body>
+  <main>
+  #{report}
+  </main>
+</body>
+</html>
+        EOF
+      end
     end
   end
 end

data/lib/how_is/report/pdf.rb

@@ -1,3 +1,6 @@
+require 'prawn'
+require 'how_is/chart'
+
 module HowIs
   class PdfReport < BaseReport
     attr_accessor :pdf

data/lib/how_is/report.rb

@@ -33,6 +33,7 @@ module HowIs
   class Report
     require 'how_is/report/pdf'
     require 'how_is/report/json'
+    require 'how_is/report/html'
 
     REPORT_BLOCK = proc do
       title "How is #{analysis.repository}?"
@@ -49,10 +50,6 @@ module HowIs
       horizontal_bar_graph issues_per_label
     end
 
-    def self.export(analysis, format = :pdf)
-
-    end
-
     def self.export!(analysis, file)
       format = file.split('.').last
       report = get_report_class(format).new(analysis)
@@ -64,8 +61,6 @@ module HowIs
       report = get_report_class(format).new(analysis)
 
       report.export(&REPORT_BLOCK)
-
-      report
     end
 
   private

data/lib/how_is/version.rb

@@ -1,3 +1,3 @@
 module HowIs
-  VERSION = "1.0.0"
+  VERSION = "2.0.0"
 end

data/lib/how_is.rb

@@ -8,25 +8,39 @@ module HowIs
 
   require 'how_is/fetcher'
   require 'how_is/analyzer'
-  require 'how_is/reporter'
-
-  Contract C::KeywordArgs[repository: String, report_file: String,
-                          from_file: C::Optional[C::Or[String, nil]],
-                          fetcher: C::Optional[Class],
-                          analyzer: C::Optional[Class],
-                          reporter: C::Optional[Class]] => C::Any
-  def self.generate_report(repository:, report_file:,
+  require 'how_is/report'
+
+  def self.generate_report_file(report_file:, **kw_args)
+    analysis = self.generate_analysis(**kw_args)
+
+    Report.export!(analysis, report_file)
+  end
+
+  def self.generate_report(format:, **kw_args)
+    analysis = self.generate_analysis(**kw_args)
+
+    Report.export(analysis, format)
+  end
+private
+
+
+Contract C::KeywordArgs[repository: String,
+                        from_file: C::Optional[C::Or[String, nil]],
+                        fetcher: C::Optional[Class],
+                        analyzer: C::Optional[Class],
+                        github: C::Optional[C::Any]] => C::Any
+  def self.generate_analysis(repository:,
         from_file: nil,
-        fetcher:  Fetcher.new,
+        fetcher: Fetcher.new,
         analyzer: Analyzer.new,
-        reporter: Reporter.new)
+        github: nil)
     if from_file
       analysis = analyzer.from_file(from_file)
     else
-      raw_data = fetcher.call(repository)
+      raw_data = fetcher.call(repository, github)
       analysis = analyzer.call(raw_data)
     end
 
-    reporter.call(analysis, report_file)
+    analysis
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: how_is
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Ellen Marie Dash
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-06-22 00:00:00.000000000 Z
+date: 2016-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: github_api
@@ -140,6 +140,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- data/how_is_spec/generate_report--generates-a-correct-JSON-report.json
 - data/issues.plg
 - exe/how_is
 - how_is.gemspec
@@ -151,7 +152,6 @@ files:
 - lib/how_is/report/html.rb
 - lib/how_is/report/json.rb
 - lib/how_is/report/pdf.rb
-- lib/how_is/reporter.rb
 - lib/how_is/version.rb
 - roadmap.markdown
 homepage: https://github.com/duckinator/how_is
@@ -174,7 +174,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.3
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Quantify the health of a GitHub repository is.

data/lib/how_is/reporter.rb

@@ -1,19 +0,0 @@
-require 'contracts'
-require 'prawn'
-require 'how_is/chart'
-
-module HowIs
-  class Reporter
-    require 'how_is/report'
-    include Contracts::Core
-
-    ##
-    # Given an Analysis, generate a Report
-    #
-    # Returns a class that inherits from Report.
-    Contract Analysis, String => C::Any
-    def call(analysis, report_file)
-      Report.export!(analysis, report_file)
-    end
-  end
-end