how_is 8.0.0 → 9.0.0

data/lib/how_is/chart.rb

@@ -1,83 +1,83 @@
-class HowIs::Chart
-  # Generates the gnuplot script in data/issues.plg.
-  #
-  # Some configuration is available. Font locations are path to a TTF or other
-  # Gnuplot-readable font name.
-  #
-  # For example that could be '/Users/anne/Library/Fonts/InputMono-Medium.ttf'
-  # or just 'Helvetica'.
-  #
-  # @param font_location [String] Font for the chart
-  # @param font_size [Integer] Size of the chart text
-  # @param label_font_location [String] Font for labels
-  # @param label_font_size [Integer] Size of the label text
-  #
-  # @return void
-  def self.gnuplot(font_location: nil,
-                   font_size: 16,
-                   label_font_location: nil,
-                   label_font_size: 10,
-                   chartsize: '500,500',
-                   data_file:,
-                   png_file:)
-    default_font_location =
-      if Gem.win_platform?
-        'Arial'
-      else
-        'Helvetica'
-      end
-
-    font_location ||= default_font_location
-    label_font_location ||= font_location
-
-    cmd = %Q{
-      gnuplot -e "labelfont='#{label_font_location},#{label_font_size}'" \
-              -e "chartfont='#{font_location},#{font_size}'" \
-              -e "chartsize='#{chartsize}'" \
-              -e "data='#{data_file}'" \
-              -e "pngfile='#{png_file}'" \
-              -c data/issues.plg
-    }
-    puts cmd
-    IO.popen(cmd, 'w')
-  end
-
-  def self.rotate(offset, filename)
-    if Gem.win_platform?
-      rotate_with_dotnet(filename, offset)
-    else
-      rotate_with_minimagick(filename, offset)
-    end
-  end
-
-  def self.rotate_with_dotnet(filename, offset)
-    ps_rotate_flip = {
-      90  => 'Rotate90FlipNone',
-      180 => 'Rotate180FlipNone',
-      270 => 'Rotate270FlipNone',
-      -90 => 'Rotate270FlipNone'
-    }[offset]
-
-    command = %Q{
-      $path = "#{filename}"
-
-      [Reflection.Assembly]::LoadWithPartialName("System.Windows.Forms");
-      $i = new-object System.Drawing.Bitmap $path
-
-      $i.RotateFlip("#{ps_rotate_flip}")
-
-      $i.Save($path,"png")
-
-      exit
-    }
-
-    IO.popen(["powershell", "-Command", command], 'w') { |io| }
-  end
-
-  def self.rotate_with_minimagick(filename, offset)
-    require 'mini_magick'
-    image = MiniMagick::Image.new(filename) { |b| b.rotate offset.to_s }
-    image.format 'png'
-    image.write filename
-  end
-end
+class HowIs::Chart
+  # Generates the gnuplot script in data/issues.plg.
+  #
+  # Some configuration is available. Font locations are path to a TTF or other
+  # Gnuplot-readable font name.
+  #
+  # For example that could be '/Users/anne/Library/Fonts/InputMono-Medium.ttf'
+  # or just 'Helvetica'.
+  #
+  # @param font_location [String] Font for the chart
+  # @param font_size [Integer] Size of the chart text
+  # @param label_font_location [String] Font for labels
+  # @param label_font_size [Integer] Size of the label text
+  #
+  # @return void
+  def self.gnuplot(font_location: nil,
+                   font_size: 16,
+                   label_font_location: nil,
+                   label_font_size: 10,
+                   chartsize: '500,500',
+                   data_file:,
+                   png_file:)
+    default_font_location =
+      if Gem.win_platform?
+        'Arial'
+      else
+        'Helvetica'
+      end
+
+    font_location ||= default_font_location
+    label_font_location ||= font_location
+
+    cmd = %Q{
+      gnuplot -e "labelfont='#{label_font_location},#{label_font_size}'" \
+              -e "chartfont='#{font_location},#{font_size}'" \
+              -e "chartsize='#{chartsize}'" \
+              -e "data='#{data_file}'" \
+              -e "pngfile='#{png_file}'" \
+              -c data/issues.plg
+    }
+    puts cmd
+    IO.popen(cmd, 'w')
+  end
+
+  def self.rotate(offset, filename)
+    if Gem.win_platform?
+      rotate_with_dotnet(filename, offset)
+    else
+      rotate_with_minimagick(filename, offset)
+    end
+  end
+
+  def self.rotate_with_dotnet(filename, offset)
+    ps_rotate_flip = {
+      90  => 'Rotate90FlipNone',
+      180 => 'Rotate180FlipNone',
+      270 => 'Rotate270FlipNone',
+      -90 => 'Rotate270FlipNone'
+    }[offset]
+
+    command = %Q{
+      $path = "#{filename}"
+
+      [Reflection.Assembly]::LoadWithPartialName("System.Windows.Forms");
+      $i = new-object System.Drawing.Bitmap $path
+
+      $i.RotateFlip("#{ps_rotate_flip}")
+
+      $i.Save($path,"png")
+
+      exit
+    }
+
+    IO.popen(["powershell", "-Command", command], 'w') { |io| }
+  end
+
+  def self.rotate_with_minimagick(filename, offset)
+    require 'mini_magick'
+    image = MiniMagick::Image.new(filename) { |b| b.rotate offset.to_s }
+    image.format 'png'
+    image.write filename
+  end
+end

data/lib/how_is/cli.rb

@@ -1,92 +1,90 @@
-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
+require 'how_is'
+require 'yaml'
+require 'contracts'
+require 'stringio'
+
+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/cli/parser.rb

@@ -0,0 +1,76 @@
+#!/usr/bin/env ruby
+
+require "how_is"
+require "how_is/cli"
+require "slop"
+
+class HowIs::CLI
+  DEFAULT_REPORT_FILE = "report.#{HowIs::DEFAULT_FORMAT}"
+
+  class OptionsError < StandardError
+  end
+
+  class Parser
+    attr_reader :opts
+
+    def call(argv)
+      opts = Slop::Options.new
+      opts.banner =
+        <<-EOF.gsub(/ *\| ?/, '')
+        | Usage: how_is REPOSITORY [--report REPORT_FILE]
+        |        how_is --config CONFIG_FILE
+        |
+        | Where REPOSITORY is of the format <GitHub username or org>/<repository name>.
+        | CONFIG_FILE defaults to how_is.yml.
+        |
+        | E.g., if you wanted to check https://github.com/how-is/how_is,
+        | you'd run `how_is how-is/how_is`.
+        |
+        EOF
+
+      opts.separator ""
+      opts.separator "Options:"
+
+      opts.bool   "-h", "--help",    "Print help text"
+      opts.string       "--config",  "YAML config file, used to generate a group of reports"
+      opts.string       "--from",    "JSON report file, used instead of fetching the data again"
+      opts.string       "--report",  "output file for the report (valid extensions: #{HowIs.supported_formats.join(', ')}; default: #{DEFAULT_REPORT_FILE})"
+      opts.string "-v", "--version", "prints the version"
+
+      parser    = Slop::Parser.new(opts)
+      result    = parser.parse(argv)
+      options   = result.to_hash
+      arguments = result.arguments
+
+      options[:report] ||= DEFAULT_REPORT_FILE
+
+      # The following are only useful if true.
+      # Removing them here simplifies contracts and keyword args for other APIs.
+      options.delete(:config)   unless options[:config]
+      options.delete(:help)     unless options[:help]
+      options.delete(:version)  unless options[:version]
+
+      unless HowIs.can_export_to?(options[:report])
+        raise OptionsError, "Invalid file: #{options[:report_file]}. Supported formats: #{HowIs.supported_formats.join(', ')}"
+      end
+
+      if options[:config]
+        # Nothing to do.
+      elsif options[:from]
+        # Opening this file here seems a bit messy, but it works.
+        options[:repository] = JSON.parse(open(options[:from_file]).read)['repository']
+        raise OptionsError, "Invalid JSON report file." unless options[:repository]
+      elsif argv.length >= 1
+        options[:repository] = argv.delete_at(0)
+      else
+        raise OptionsError, "No repository specified."
+      end
+
+      {
+        opts: opts,
+        options: options,
+        arguments: arguments,
+      }
+    end
+  end
+end

data/lib/how_is/fetcher.rb

@@ -1,45 +1,45 @@
-require 'contracts'
-require 'github_api'
-
-##
-# Fetches data from GitHub.
-class HowIs::Fetcher
-  include Contracts::Core
-
-  ##
-  # Standardized representation for fetcher results.
-  #
-  # Implemented as a class instead of passing around a Hash so that it can
-  # be more easily referenced by Contracts.
-  class Results < Struct.new(:repository, :issues, :pulls)
-    include Contracts::Core
-
-    Contract String, C::ArrayOf[Hash], C::ArrayOf[Hash] => nil
-    def initialize(repository, issues, pulls)
-      super(repository, issues, pulls)
-    end
-
-    # Struct defines #to_h, but not #to_hash, so we alias them.
-    alias_method :to_hash, :to_h
-  end
-
-
-  Contract String, C::Or[C::RespondTo[:issues, :pulls], nil] => Results
-  def call(repository,
-        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
-
-    Results.new(
-      repository,
-      obj_to_array_of_hashes(issues),
-      obj_to_array_of_hashes(pulls)
-    )
-  end
-
-  private def obj_to_array_of_hashes(object)
-    object.to_a.map(&:to_h)
-  end
-end
+require 'contracts'
+require 'github_api'
+
+##
+# Fetches data from GitHub.
+class HowIs::Fetcher
+  include Contracts::Core
+
+  ##
+  # Standardized representation for fetcher results.
+  #
+  # Implemented as a class instead of passing around a Hash so that it can
+  # be more easily referenced by Contracts.
+  class Results < Struct.new(:repository, :issues, :pulls)
+    include Contracts::Core
+
+    Contract String, C::ArrayOf[Hash], C::ArrayOf[Hash] => nil
+    def initialize(repository, issues, pulls)
+      super(repository, issues, pulls)
+    end
+
+    # Struct defines #to_h, but not #to_hash, so we alias them.
+    alias_method :to_hash, :to_h
+  end
+
+
+  Contract String, C::Or[C::RespondTo[:issues, :pulls], nil] => Results
+  def call(repository,
+        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
+
+    Results.new(
+      repository,
+      obj_to_array_of_hashes(issues),
+      obj_to_array_of_hashes(pulls)
+    )
+  end
+
+  private def obj_to_array_of_hashes(object)
+    object.to_a.map(&:to_h)
+  end
+end