github_issue_stats 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e44a369c67f5f5183e8cd90f26d8fc204e41a4eb
-  data.tar.gz: 98ac378482af845a7d3b564bb98576c34f6b7112
+  metadata.gz: ae17636f4ac0fbedef888f294dc9a493e2dd1c88
+  data.tar.gz: 19b0639e7a6341f463dc784f631a9b193af550af
 SHA512:
-  metadata.gz: 4d1147b5ccf451cad07c2b455ffe08ad657fdf54d82e95eab9329625a2128ab56c66eb66414d7d8e2c87df18d8251a03a3e66db86e295c4396291c2a11c8782a
-  data.tar.gz: 293fce8c08876c7207cb30b0662bef63ad392395ac08bbcdafed6c89b033a0f6cc4bd7559b7c8a4ff8a8b00c75d2cae2fdc1d9ce518f87e4d19e395932da275b
+  metadata.gz: ab26cc8b8bb2832c6a86fc35e400379e477455a142e06378915cdc4910cb2a6cff2d511b3de999967a3986dbba1e581ddee79d6249d028646cf6971a7a5faa3e
+  data.tar.gz: 9eb615a02c1ffd81ba6621def0b510d219d693743e87f3df161898e83491ea4bacf99115de7f38be3a3ad2f3c11e90bc2b3e9c1801ea2a455c520dd8e31a8132

data/bin/github_issue_stats

@@ -1,108 +1,65 @@
 #!/usr/bin/env ruby
 
+require "commander"
 require "optparse"
 require "github_issue_stats"
 
 ARGV.push('-h') if ARGV.empty?
 
-options = {}
+cli = HighLine.new($stdin, $stderr)
 
-options[:verbose] = false
-options[:output_format] = 'text'
-options[:token] = ENV["GITHUB_OAUTH_TOKEN"]
-options[:labels] = "issues"
-options[:interval_length] = "1w"
-options[:interval_count] = 4
+Commander.configure do
+  program :name, 'GitHub Issue Stats'
+  program :version, GitHubIssueStats::VERSION
+  program :description, 'Simple program for collecting stats on issues in GitHub repositories.'
 
-opt_parser = OptionParser.new do |opts|
-  opts.banner = "GitHub Issue Stats -- simple program for collecting stats on issues in GitHub repositories.\n\nUsage: github_issue_stats [options]"
+  global_option '--verbose', "Enable output of detailed debugging information to STDERR"
+  global_option '--token STRING', String, "GitHub OAuth token for making API calls. If not specified, the GITHUB_OAUTH_TOKEN environment variable is used. Create a token here: https://github.com/settings/token"
 
-  opts.separator ""
-  opts.separator "Specific options:"
+  command :history do |c|
+    c.syntax = 'github_issue_stats history [options]'
+    c.description = 'Collect stats on number of open issues over time'
 
-  opts.on("-t", "--token [STRING]", String,
-          "GitHub OAuth token for making API calls. If not specified,",
-          "the GITHUB_OAUTH_TOKEN environment variable is used.",
-          "Create a token here: https://github.com/settings/token", "\n") do |token|
-    options[:token] = token
-  end
+    c.option '-s', '--scopes x,y,z', Array, "(required) List of scopes for which stats will be collected. A scope is a username or repo name. Example: --scopes github,rails/rails"
+    c.option '-l', '--labels [x,y,z]', Array, "List of labels for which stats will be collected for each scope. A label is an issue or pull request label, or special values 'issues' and 'pulls' representing all issues and all pull requests within the scope respectively. Default: 'issues'."
+    c.option '-i', '--interval_length [STRING]', String, "Size of interval for which stats will be aggregated. Intervals are defined with N[hdwmy], where h is hour, d is day, w is week m is month, y is year, and N is a positive integer used as a multiplier. Default: '1w'."
+    c.option '-n', '--interval_count [INTEGER]', Integer, "Number of intervals for which stats will be collected. Default: 4."
+    c.option '-o', '--output_format [STRING]', String, "Format used for output tables with collected stats. Can be 'text' or 'markdown'."
 
-  opts.on("-s", "--scopes x,y,z", Array,
-          "List of scopes for which stats will be collected. A scope is",
-          "a username or repo name. Example: --scopes github,rails/rails", "\n") do |scopes|
-    options[:scopes] = scopes
-  end
+    c.example "Statistics for the atom organization, for issues, pull requests, bug and enhancement labels, going back four one-week intervals, with Markdown output", "github_issue_stats history -s atom -l issues,bug,enhancement,pulls -i 1w -n 4 -o markdown"
 
-  opts.on("-l", "--labels [x,y,z]", Array,
-          "List of labels for which stats will be collected for each",
-          "scope. A label is an issue or pull request label, or special",
-          "values 'issues' and 'pulls' representing all issues and all",
-          "pull requests within the scope respectively. Default: 'issues'.",
-          "Example: --labels issues,bug,pulls", "\n") do |labels|
-    options[:labels] = labels
-  end
+    c.action do |args, options|
+      options.default \
+        :verbose => false,
+        :token => ENV["GITHUB_OAUTH_TOKEN"],
+        :output_format => 'text',
+        :labels => "issues",
+        :interval_length => "1w",
+        :interval_count => 4
 
-  opts.on("-i", "--interval_length [STRING]", String,
-          "Size of interval for which stats will be aggregated. Intervals",
-          "are defined with N[hdwmy], where h is hour, d is day, w is week",
-          "m is month, y is year, and N is a positive integer used as a",
-          "multiplier. Default: '1w'. Example: --interval_length 4d", "\n") do |interval_length|
-    options[:interval_length] = interval_length
-  end
+      options.scopes = Array(options.scopes)
+      options.labels = Array(options.labels)
 
-  opts.on("-n", "--interval_count [INTEGER]", Integer,
-          "Number of intervals for which stats will be collected.",
-          "Default: 4. Example: --interval_count 2", "\n") do |interval_count|
-    options[:interval_count] = interval_count
-  end
+      raise ArgumentError.new("--token is required") if options.token.nil?
+      raise ArgumentError.new("invalid --token format") unless /\A\h{40}\z/.match(options.token)
+      raise ArgumentError.new("--scopes is required") if options.scopes.nil?
+      raise ArgumentError.new("invalid --interval_length format") unless /\A\d[hdwmy]\z/.match(options.interval_length)
+      raise ArgumentError.new("invalid --interval_count format") if options.interval_count.nil? || options.interval_count < 1
+      raise ArgumentError.new("invalid --output_format") unless /\A(text)|(markdown)\z/.match(options.output_format)
 
-  opts.on("-o", "--output_format [STRING]", String,
-          "Format used for output tables with collected stats. Can be",
-          "'text' or 'markdown'. Default: 'text'. Example: -o markdown", "\n") do |output_format|
-    options[:output_format] = output_format
-  end
+      github_issue_stats = GitHubIssueStats.new(options.token, options.verbose)
 
-  opts.on("--[no-]verbose", "Enable output of detailed debugging information to STDERR", "\n") do |verbose|
-    options[:verbose] = verbose
-  end
+      STDERR.print "Collecting stats..."
+      STDERR.flush
 
-  opts.on_tail("-h", "--help", "Show this message", "\n") do
-    STDERR.puts(opts)
-    exit
-  end
+      stats = github_issue_stats.get_history_statistics(options.__hash__)
+      tables = github_issue_stats.generate_tables(stats, options.__hash__)
 
-  opts.on_tail("-v", "--version", "Show version", "\n") do
-    STDERR.puts(GitHubIssueStats::VERSION)
-    exit
-  end
-end
+      for scope, table in tables
+        puts "\n#{scope} stats:\n\n#{table}"
+      end
 
-opt_parser.parse!
-
-def log_input_error(message, opt_parser)
-  STDERR.puts("ERROR: #{message}\n\n")
-  STDERR.puts(opt_parser)
-  exit
-end
-
-log_input_error("--token is required", opt_parser) if options[:token].nil?
-log_input_error("invalid --token format", opt_parser) unless /\A\h{40}\z/.match(options[:token])
-log_input_error("--scopes is required", opt_parser) if options[:scopes].nil?
-log_input_error("invalid --interval_length format", opt_parser) unless /\A\d[hdwmy]\z/.match(options[:interval_length])
-log_input_error("invalid --interval_count format", opt_parser) if options[:interval_count].nil? || options[:interval_count] < 1
-log_input_error("invalid --output_format", opt_parser) unless /\A(text)|(markdown)\z/.match(options[:output_format])
-
-options[:scopes] = Array(options[:scopes])
-options[:labels] = Array(options[:labels])
-
-github_issue_stats = GitHubIssueStats.new(options[:token], options[:verbose])
-
-STDERR.print "Collecting stats..."
-STDERR.flush
-
-stats = github_issue_stats.get_statistics(options)
-tables = github_issue_stats.generate_tables(stats, options)
-
-for scope, table in tables
-  puts "\n#{scope} stats:\n\n#{table}"
+      cli.say("Done!")
+    end
+  end
 end

data/lib/github_issue_stats.rb

@@ -30,7 +30,7 @@ module Enumerable
 end
 
 class GitHubIssueStats
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 
   attr_accessor :client,          # Octokit client for acesing the API
                 :logger,          # Logger for writing debugging info
@@ -89,7 +89,7 @@ class GitHubIssueStats
   #   }
   # ]
   #
-  def get_statistics(options)
+  def get_history_statistics(options)
     # number_of_calls = get_required_number_of_api_calls(options)
     # @sleep_period = get_api_calls_sleep(number_of_calls)
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: github_issue_stats
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Ivan Zuzak
@@ -10,6 +10,20 @@ bindir: bin
 cert_chain: []
 date: 2015-09-08 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: commander
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
 - !ruby/object:Gem::Dependency
   name: octokit
   requirement: !ruby/object:Gem::Requirement