how_is 5.0.0 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a775e265a8f9fd63ee19be53d95b24938e15d137
-  data.tar.gz: 199b882343ecc55d904e50c4b8b54b98e476a6df
+  metadata.gz: 417f8bf34cc439c2d30a35ddef05a57bd8f91605
+  data.tar.gz: acb4d660e2b52c831d6f43519c5859a25e6254f1
 SHA512:
-  metadata.gz: 47cfe1ea6fe78379106597d910558d35a8226876af48f2ae520ee309146c30c966927c8882ff192f20e9db3d436402293773fbda55d11d5248ce485b248d5269
-  data.tar.gz: b26c0c29ba44adb57335c302638704ff66f9de7b76d65d7092ef2ebbc32aaf1213b343b8d9c80a8800d1cf0a5fbc3015ef0cb2c7e8b652b98936a446f98643b3
+  metadata.gz: aa4ccd0b26c542676702e4b8cf437c2166729186cb67945da5ed1a47fa85f6dbb112ecdfb90114f69f21d02f2ba1329e95629caa9ab327891ce4eca74af66de1
+  data.tar.gz: e66e43791f6febae0884820cee777d04723fdf6b74c529e6c929d48eb4b87d285d7e632b1c66a3d316626cfc818f4da1d208f07805dc8a0e3b3ca66bbab3421a

data/.gitignore

@@ -12,3 +12,4 @@ report.json
 report.html
 *.dat
 *.png
+Thumbs.db

data/.rspec

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

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

@@ -32,6 +32,34 @@ E.g.,
 
 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 — 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.
+
+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)
+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.

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/exe/how_is

@@ -7,6 +7,8 @@ options = {
   repository: nil,
   report_file:  "report.pdf",
   from_file: nil,
+  use_config_file: false,
+  config_file: nil,
 }
 
 opts = OptionParser.new do |opts|
@@ -29,6 +31,11 @@ opts = OptionParser.new do |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
@@ -39,6 +46,12 @@ opts = OptionParser.new do |opts|
 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

data/lib/how_is/cli.rb

@@ -0,0 +1,92 @@
+require 'how_is'
+require 'yaml'
+require 'contracts'
+require 'stringio'
+
+C = Contracts
+
+class HowIs::CLI
+  include Contracts::Core
+
+  DEFAULT_CONFIG_FILE = 'how_is.yml'
+
+  # Generates YAML frontmatter, as is used in Jekyll and other blog engines.
+  #
+  # E.g.,
+  #     generate_frontmatter({'foo' => "bar %{baz}"}, {'baz' => "asdf"})
+  # =>  "---\nfoo: bar asdf\n"
+  Contract C::HashOf[C::Or[String, Symbol] => String],
+           C::HashOf[C::Or[String, Symbol] => C::Any] => String
+  def generate_frontmatter(frontmatter, report_data)
+    frontmatter = convert_keys(frontmatter, :to_s)
+    report_data = convert_keys(report_data, :to_sym)
+
+    frontmatter = frontmatter.map { |k, v|
+      v = v % report_data
+
+      [k, v]
+    }.to_h
+
+    YAML.dump(frontmatter)
+  end
+
+  def from_config_file(config_file = nil, **kwargs)
+    config_file ||= DEFAULT_CONFIG_FILE
+
+    from_config(YAML.load_file(config_file), **kwargs)
+  end
+
+  def from_config(config,
+        github: nil,
+        report_class: nil)
+    report_class ||= HowIs::Report
+
+    date = Date.strptime(Time.now.to_i.to_s, '%s')
+    date_string = date.strftime('%Y-%m-%d')
+    friendly_date = date.strftime('%B %d, %y')
+
+    analysis = HowIs.generate_analysis(repository: config['repository'], github: github)
+
+    report_data = {
+      repository: config['repository'],
+      date: date,
+      friendly_date: friendly_date,
+    }
+
+    config['reports'].map do |format, report_config|
+      filename = report_config['filename'] % report_data
+      file = File.join(report_config['directory'], filename)
+
+      report = report_class.export(analysis, format)
+
+      result = build_report(report_config['frontmatter'], report_data, report)
+
+      File.open(file, 'w') do |f|
+        f.puts result
+      end
+
+      result
+    end
+  end
+
+  def build_report(frontmatter, report_data, report)
+    str = StringIO.new
+
+    if frontmatter
+      str.puts generate_frontmatter(frontmatter, report_data)
+      str.puts "---"
+      str.puts
+    end
+
+    str.puts report
+
+    str.string
+  end
+
+private
+  # convert_keys({'foo' => 'bar'}, :to_sym)
+  # => {:foo => 'bar'}
+  def convert_keys(data, method_name)
+    data.map {|k, v| [k.send(method_name), v]}.to_h
+  end
+end

data/lib/how_is/version.rb

@@ -1,3 +1,3 @@
 module HowIs
-  VERSION = "5.0.0"
+  VERSION = "6.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: how_is
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 6.0.0
 platform: ruby
 authors:
 - Ellen Marie Dash
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-07-21 00:00:00.000000000 Z
+date: 2016-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: github_api
@@ -174,6 +174,7 @@ files:
 - lib/how_is.rb
 - lib/how_is/analyzer.rb
 - lib/how_is/chart.rb
+- lib/how_is/cli.rb
 - lib/how_is/fetcher.rb
 - lib/how_is/pulse.rb
 - lib/how_is/report.rb
@@ -202,8 +203,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.3
 signing_key: 
 specification_version: 4
 summary: Quantify the health of a GitHub repository is.
 test_files: []
+has_rdoc: