cykl 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 23651edd6a80f1af217e4da233d37aeb0e2e2e0c
+  data.tar.gz: fe91e3fc6c20b799c98cd1f9ec9f7e9f73e318cb
+SHA512:
+  metadata.gz: d7a860b9285f9ad1a975ba20a554a9940d79693e1d89bb78730c11bc1a4a2b7d76da5282588693aee9f088e34b67a388dc81d25c1fdc20626cd14ced81dda93c
+  data.tar.gz: fe426792fbc14404c7d38f2ede2eeae77a37d714b39923e5a07210210ff1392dc76e17a226ce985ede87b4917071955ab6a5ae0c82706543f98f99132cd46506

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/Gemfile

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

data/README.md

@@ -0,0 +1,47 @@
+# Cykl
+
+View the cycle-time of your Github issues
+
+Cykl uses the Github API via Octokit to pull information on the last 100 closed
+issues in your repo. Currently, you can track the average lifetime of those issues.
+
+### Upcoming
+
+- How long issues have spent in a particular column on your project
+board (if the board is connected to Github)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cykl', '0.1.0'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cykl
+
+## Usage
+
+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
+
+- Or `cykl 'owner/repo'` to return up to the last 100 closed issues
+ from a specific repository
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Baron-burton/cykl. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "cykl"
+
+# 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(__FILE__)

data/bin/cykl

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'cykl'
+
+Cykl.time(ARGV.first)

data/bin/setup

@@ -0,0 +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

data/cykl.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cykl/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'cykl'
+  spec.version       = Cykl::VERSION
+  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.homepage      = 'https://github.com/Baron-burton/cykl'
+  spec.license       = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.executables << 'cykl'
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'netrc', '~> 0.11'
+  spec.add_dependency 'octokit', '~> 4.7'
+
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'byebug', '~> 9.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/cykl/issues.rb

@@ -0,0 +1,23 @@
+require 'octokit'
+
+module Cykl
+  class Issues
+
+    attr_reader :client
+    private :client
+
+    def initialize
+      @client = Octokit::Client.new(
+        netrc: true
+      )
+    end
+
+    def list_issues(repo = nil)
+      client.issues(
+        repo,
+        state: 'closed',
+        per_page: 100
+      )
+    end
+  end
+end

data/lib/cykl/version.rb

@@ -0,0 +1,3 @@
+module Cykl
+  VERSION = "0.1.1"
+end

data/lib/cykl.rb

@@ -0,0 +1,50 @@
+require 'cykl/issues'
+require 'cykl/version'
+
+module Cykl
+  class << self
+    attr_reader :cycle_time
+    private :cycle_time
+
+    def time(repo = nil)
+      issues = Issues.new.list_issues(repo)
+      @cycle_time = average_cycle_time(issues)
+
+      print_and_flush(cycle_time_message)
+    rescue Octokit::NotFound
+      print_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 print_and_flush(msg)
+      print msg
+      STDOUT.flush
+    end
+  end
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: cykl
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Brandon Burton
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-07-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: netrc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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                        "
+email:
+- brandon.anthony.burton@gmail.com
+executables:
+- cykl
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/cykl
+- bin/setup
+- cykl.gemspec
+- lib/cykl.rb
+- lib/cykl/issues.rb
+- lib/cykl/version.rb
+homepage: https://github.com/Baron-burton/cykl
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: View the cycle-time of your Github issues
+test_files: []