cykl 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b07a376904547e0e04bf745b064ce931ac1eacb9
-  data.tar.gz: e6b664cc00679e72968b9a7a43df3228241cc1b5
+  metadata.gz: 8c99ae9d7e779ef2a320a87ffcb3e1aef9de0d05
+  data.tar.gz: 3334785aeb7e86a06eb94d9518737a8e3b0ac41e
 SHA512:
-  metadata.gz: 1c3c7513e8aea904661cd346fbb3d13eddb272c81207997fc5c88ded21c929fc958cd922985e0ed7534752bc5c76e85c85921e0bf4028ea4d574fb48396ec29b
-  data.tar.gz: 021223d73ca7ea9362d38d498d8e105bed6b2c7ce382bee2b42b13bae7983a13eca6f9a8e2bee7cc7cd568e9048e2eecf4d87f4d630e7850441d25613b33f5b0
+  metadata.gz: 4a3c1f622558e13bdcda749654c902de8e7e7ea369d7659835f44ab21dcbec021f2c586df31ed1418044316195d54f337f2d26faf6f8a6780b3f87cfbf4366b6
+  data.tar.gz: e63c0fd8a3a8213a0904c58e507f6378a9b5588bb447eeb519662375f6c03a2ca5b1ee10dd3490faef5f22d2fa996722dd771e71a1a8ee3363e6382e88bc42de

data/README.md

@@ -15,7 +15,7 @@ board (if the board is connected to Github)
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'cykl', '~> 0.1.3'
+gem 'cykl', '~> 0.1.4'
 ```
 
 And then execute:
@@ -30,12 +30,19 @@ Or install it yourself as:
 
 First, be sure to have your Github login details in a `.netrc` in your root directory
 
-- Just call `cykl` with no arguments to return up to the last 100
- closed issues assigned to you
+- Just call `cykl` with no arguments to return at least the
+ last 50 closed issues assigned to you
 
-- Or `cykl 'owner/repo'` to return up to the last 100 closed issues
- from a specific repository
+- Or `cykl 'owner/repo'` to return at least the last 50
+ closed issues from a specific repository
 
+#### Options
+
+`--label`
+
+- You can provide a label to scope your return to issues only
+ containing the given label, like so: `--label '<your repo label>'`.
+ You can also pass `-l`
 
 ## Contributing
 

data/bin/cykl

@@ -2,4 +2,4 @@
 
 require 'cykl'
 
-Cykl.time(ARGV.first)
+Cykl::Initializer.start(ARGV)

data/cykl.gemspec

@@ -9,13 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Brandon Burton']
   spec.email         = ['brandon.anthony.burton@gmail.com']
 
-  spec.summary       = %q{View the cycle-time of your Github issues}
-  spec.description   = %q{
-                          Cykl uses the Github API to pull information on the last 100 issues in your repo.
-                          Currently you can track the average lifetime of your issues, and soon you'll be
-                          able to see how long they've spent in a particular column on your project board
-                          (if the board is connected to Github).
-                        }
+  spec.description   = "Track the cycle-time of your repo's issues"
+  spec.summary       = spec.description
   spec.homepage      = 'https://github.com/Baron-burton/cykl'
   spec.license       = 'MIT'
 
@@ -27,6 +22,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'netrc', '~> 0.11'
   spec.add_dependency 'octokit', '~> 4.7'
+  spec.add_dependency 'thor', '~> 0.19.1'
 
   spec.add_development_dependency 'bundler', '~> 1.15'
   spec.add_development_dependency 'byebug', '~> 9.0'

data/lib/cykl.rb

@@ -1,51 +1,3 @@
 require 'cykl/issues'
 require 'cykl/version'
-
-module Cykl
-  class << self
-    attr_reader :cycle_time
-    private :cycle_time
-
-    def time(repo = nil)
-      puts_and_flush "Pulling in your issues, please wait..."
-      issues = Issues.new.list_issues(repo)
-      @cycle_time = average_cycle_time(issues)
-
-      puts_and_flush(cycle_time_message)
-    rescue Octokit::NotFound
-      puts_and_flush('Sorry, Github couldn\'t find anything')
-    end
-
-    private
-
-    def cycle_time_message
-      "Your average cycle time is #{cycle_time}" +
-      (cycle_time == 1.00 ? 'day' : 'days')
-    end
-
-    def average_cycle_time(issues)
-      lifetimes = []
-
-      issues.each do |issue|
-        lifetimes << ((issue.closed_at - issue.created_at) / seconds_in_a_day)
-      end
-
-      calculate_average(lifetimes)
-    end
-
-    def calculate_average(data)
-      total = data.inject(:+)
-
-      (total / data.count).round(2)
-    end
-
-    def seconds_in_a_day
-      (24 * 60 * 60)
-    end
-
-    def puts_and_flush(msg)
-      puts msg
-      STDOUT.flush
-    end
-  end
-end
+require 'cykl/initializer'

data/lib/cykl/initializer.rb

@@ -0,0 +1,75 @@
+require 'thor'
+
+module Cykl
+  class Initializer < Thor
+    attr_reader :cycle_time
+    private :cycle_time
+
+
+    desc 'time REPO', 'returns the average cycle time for your repo'
+    method_option(
+      :label,
+      type: :string,
+      aliases: '-l',
+      lazy_default: '',
+      desc: 'search for repositories with a given label'
+    )
+
+    def time(repo = nil)
+      initializer_message(repo, options)
+      list_of_issues(repo, options)
+
+      puts_and_flush(cycle_time_message)
+    rescue Octokit::NotFound
+      puts_and_flush('Sorry, Github couldn\'t find anything')
+    end
+
+    private
+
+    def list_of_issues(repo, options)
+      issues = Issues.new.list_issues(repo, options)
+      @cycle_time = average_cycle_time(issues)
+    end
+
+    def cycle_time_message
+      "\nYour average cycle time is #{cycle_time}" +
+      (cycle_time == 1.00 ? 'day' : 'days')
+    end
+
+    def average_cycle_time(issues)
+      lifetimes = []
+
+      issues.each do |issue|
+        lifetimes << ((issue.closed_at - issue.created_at) / seconds_in_a_day)
+      end
+
+      calculate_average(lifetimes)
+    end
+
+    def calculate_average(data)
+      total = data.inject(:+)
+
+      (total / data.count).round(2)
+    end
+
+    def seconds_in_a_day
+      (24 * 60 * 60)
+    end
+
+    def initializer_message(repo, options)
+      if options.any? && !options[:label].empty?
+        puts_and_flush(
+          "Attempting to pull in your #{options[:label]} issues \n" +
+          "from #{repo}, please wait..."
+        )
+      else
+        puts_and_flush("Pulling in your issues from #{repo}, please wait...")
+      end
+    end
+
+    def puts_and_flush(msg)
+      puts msg
+      STDOUT.flush
+    end
+  end
+end

data/lib/cykl/issues.rb

@@ -12,24 +12,25 @@ module Cykl
       )
     end
 
-    def list_issues(repo = nil)
+    def list_issues(repo = nil, options)
       pr_free_issues = []
       counter = 1
 
       while pr_free_issues.count < 50
-        issues = get_issues(repo, counter)
+        issues = get_issues(repo, counter, options)
         issues.select { |issue| pr_free_issues << issue if issue.pull_request == nil }
         counter += 1
       end
       pr_free_issues
     end
 
-    def get_issues(repo = nil, pages)
+    def get_issues(repo = nil, page, options)
       client.issues(
         repo,
         state: 'closed',
         per_page: 100,
-        page: pages
+        page: page,
+        labels: options[:label]
       )
     end
   end

data/lib/cykl/version.rb

@@ -1,3 +1,3 @@
 module Cykl
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cykl
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Brandon Burton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-28 00:00:00.000000000 Z
+date: 2017-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: netrc
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -94,11 +108,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: "\n                          Cykl uses the Github API to pull information
-  on the last 100 issues in your repo.\n                          Currently you can
-  track the average lifetime of your issues, and soon you'll be\n                          able
-  to see how long they've spent in a particular column on your project board\n                          (if
-  the board is connected to Github).\n                        "
+description: Track the cycle-time of your repo's issues
 email:
 - brandon.anthony.burton@gmail.com
 executables:
@@ -116,6 +126,7 @@ files:
 - bin/setup
 - cykl.gemspec
 - lib/cykl.rb
+- lib/cykl/initializer.rb
 - lib/cykl/issues.rb
 - lib/cykl/version.rb
 homepage: https://github.com/Baron-burton/cykl
@@ -141,5 +152,5 @@ rubyforge_project:
 rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
-summary: View the cycle-time of your Github issues
+summary: Track the cycle-time of your repo's issues
 test_files: []