github_bus_factor 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1cba5f9e910be4bd2032951b9fd6a7f4775b8ec2
+  data.tar.gz: d236b469ad20187f07a9d93017e2fe8a9af3e48a
+SHA512:
+  metadata.gz: cb0fc42b4ce7a95d6245463a4ef251968a11bed8ea72008faa50352fff6dd234a5cae1b3b9ec00c1ba733c0eee21493b8a55f9a8a663a3fed4a38b10207e36f7
+  data.tar.gz: 12b58ce1d3d42be1f9818ddc1963edf7793ad31dd90bce637f02fc4541c4ceca3def922a2a464c6be5a242036f4f49824b07b98c9c5d1a4dcb90a856ec8d1ddd

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.1
+before_install: gem install bundler -v 1.10.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Sash Zats
+
+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

@@ -0,0 +1,46 @@
+# GitHub Bus Factor
+
+> More meaningful statistics for GitHub projects than just stars.
+
+![](https://raw.githubusercontent.com/zats/github_bus_factor/master/README/screenshot.png)
+
+    $ gem install github_bus_factor
+
+
+# Report
+
+| 🙂 | Description |
+| :--: | :-- |
+| 🍴 | **Forks**. Might mean people planning are fixing bugs or adding features. |
+| 🔭 | **Watchers**. Shows number of people interested in project changes. |
+| 🌟 | **Stars**. Might mean it is a good project or that it was featured in a mailing list. Some people use 🌟 as a "Like". |
+| 🗓 | **Age**. Mature projects might mean battle tested project. Recent pushes might mean project is actively maintained. |
+| 🍻 | **Pull Requests**. Community contributions to the project. Many closed PRs usually is a good sign, while no PRs usual is bad. |
+| 🛠 | **Refactoring**. Balance between added and deleted code. Crude value not including semantic understanding of the code. |
+| 📦 | **Releases**. Might mean disciplined maintainer. Certain dependency managers rely on releases to be present. |
+| 🚌 | **Bus factor**. Chances of the project to become abandoned once current collaborators stop updating it. The higher - the worse. |
+
+
+# Usage
+
+You will need to create a GitHub access token. Head over to https://github.com/settings/tokens and create a new one, call the app `GitHub Score` and copy the token.
+
+To fetch a report for a particular repository
+
+	$ github_bus_factor fetch octokit/octokit.rb
+
+First time you call it, it will prompt you to provide the token you just created.
+
+To remove the token
+	
+	$ github_bus_factor logout
+
+If you ever forget what each line of the report means, run
+
+	$ github_bus_factor about
+
+
+## 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 @@
+require "bundler/gem_tasks"

data/bin/console

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

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/github_score

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.push File.expand_path("../../lib", __FILE__)
+
+require "github_bus_factor"

data/github_bus_factor.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'github_bus_factor/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "github_bus_factor"
+  spec.version       = GitHubBusFactor::VERSION
+  spec.authors       = ["Sash Zats"]
+  spec.email         = ["sash@zats.io"]
+
+  spec.summary       = "Is it a good idea to use this GitHub project?"
+  spec.description   = "Provides few more parameters to estimate quality of the GitHub project besides stars."
+  spec.homepage      = "https://github.com/zats/github_bus_factor"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "octokit", "~> 0.4"
+  spec.add_development_dependency 'commander', '~> 4.3', '>= 4.3.3'
+  spec.add_development_dependency "security", "~> 0.1.3"
+  spec.add_development_dependency 'terminal-table', '~> 1.5', '>= 1.5.2'
+  spec.add_development_dependency 'faraday-http-cache', '~> 1.2', '>= 1.2.2'
+  spec.add_development_dependency 'activesupport', '~> 4.2', '>= 4.2.5'
+end

data/lib/github_bus_factor.rb

@@ -0,0 +1,232 @@
+require "github_bus_factor/version"
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'commander/import'
+require 'octokit'
+require 'security'
+require 'terminal-table'
+require 'faraday-http-cache'
+require 'action_view'
+require 'active_support/core_ext/numeric/time'
+include ActionView::Helpers::DateHelper
+
+
+
+module GitHubBusFactor
+	KEYCHAIN_SERVICE = 'github_bus_factor'
+	API_CALL_RETRY_COUNT = 3
+
+
+	program :version, '0.0.1'
+	program :description, 'More than just stars'
+	default_command :about
+
+	# There must be a better way to deal with GitHub caching… 
+	def GitHubBusFactor.helper(count, block)
+		return unless count > 0
+		return if !block.call(count).nil?
+		puts "Waiting for GitHub cache. Will retry in 3 seconds…"
+		sleep(3)
+		helper(count - 1, block)
+	end
+
+
+	command :about do |c|
+		c.syntax = 'github_bus_factor about'
+		c.summary = 'Explains every line of the report.'
+		c.action do |args, options|
+			table = Terminal::Table.new do |t|
+				t.style = {:padding_left => 1, :padding_right => 2}
+				t.title = 'GitHub Score'
+				t.headings = ['', 'Description']
+				t << ['🍴', 'Forks. Might mean people planning are fixing bugs or adding features.']
+				t << ['🔭', 'Watchers. Shows number of people interested in project changes.']
+				t << ['🌟', 'Stars. Might mean it is a good project or that it was featured in a mailing list. Some people use 🌟 as a "Like".']
+				t << ['🗓', 'Age. Mature projects might mean battle tested project. Recent pushes might mean project is actively maintained.']
+				t << ['🍻', 'Pull Requests. Community contributions to the project. Many closed PRs usually is a good sign, while no PRs usual is bad.']
+				t << ['🛠', 'Refactoring. Balance between added and deleted code. Crude value not including semantic understanding of the code.']
+				t << ['📦', 'Releases. Might mean disciplined maintainer. Certain dependency managers rely on releases to be present.']
+				t << ['🚌', 'Bus factor. Chances of the project to become abandoned once current collaborators stop updating it. The higher - the worse.']
+			end
+			puts table
+		end
+	end
+
+	command :logout do |c|
+		c.syntax = 'github_bus_factor logout'
+		c.summary = 'Remove GitHub token from your keychain.'
+		c.action do |args, options|
+			Security::GenericPassword.delete(service: KEYCHAIN_SERVICE)
+		end
+	end
+
+	command :fetch do |c|
+		c.syntax = 'github_bus_factor fetch [options]'
+		c.summary = 'Fetches GitHub score for a given owner/repository'
+		c.option '--verbose', 'Add extra logging'
+		c.action do |args, options|
+			# owner / repo
+			throw "Expect owner/repo as an argument" unless args.count == 1
+			matches = args.first.match(/^(.+)\/(.+)$/)
+			throw "Expect owner/repo as an argument" unless !matches.nil?
+			ownerName, repoName = matches.captures
+			throw "Expect owner/repo as an argument" if ownerName.nil? || ownerName.empty? || repoName.nil? || repoName.empty?
+
+			# Token
+			tokenPassword = Security::GenericPassword.find(service: KEYCHAIN_SERVICE)
+			token = nil
+			unless tokenPassword
+				puts "Please create a GitHub access token at https://github.com/settings/tokens"
+				while token.nil? || token.empty? do
+					token = ask("Token: ")
+					Security::GenericPassword.add(KEYCHAIN_SERVICE, '', token) unless token.nil? || token.empty?
+				end
+			else
+				token = tokenPassword.password
+			end
+
+			# GitHub client
+			client = Octokit::Client.new(:access_token => token)
+			client.auto_paginate = true
+			repository = Octokit::Repository.new(:owner => ownerName, :repo => repoName)
+
+			# Cache
+			stack = Faraday::RackBuilder.new do |builder|
+				builder.use Faraday::HttpCache
+				builder.use Octokit::Response::RaiseError
+				builder.adapter Faraday.default_adapter
+			end
+			client.middleware = stack
+
+			# Output
+			output = []
+
+			# Info
+			puts("1/6 Fetching repository info…")
+			repository_info = client.repository(repository)
+			puts(repository_info.inspect) if options.verbose
+
+			# Forks
+			FORKS_THRESHOLD = 5
+			if repository_info.forks_count > FORKS_THRESHOLD
+				forks_value = "#{repository_info.forks_count} forks."
+			else 
+				forks_value = "Few forks (#{repository_info.forks_count})."
+			end
+			output << ['🍴', forks_value]
+
+			# Watchers
+			WATCHERS_THRESHOLD = 5
+			if repository_info.subscribers_count > WATCHERS_THRESHOLD
+				watchers_value = "#{repository_info.subscribers_count} watchers."
+			else 
+				watchers_value = "Few watchers (#{repository_info.subscribers_count})."
+			end
+			output << ['🔭', watchers_value]
+
+			# Stars
+			STARS_THRESHOLD = 10
+		    if repository_info.stargazers_count > STARS_THRESHOLD
+		        stars_value = "#{repository_info.stargazers_count} stars."
+		    else 
+		        stars_value = "Few stars (#{repository_info.stargazers_count})."
+		    end
+		    output << ['🌟', stars_value]
+
+		    # Age
+		    created_at = repository_info.created_at
+		    last_push = repository_info.pushed_at
+		    output << ['🗓',  "Created #{time_ago_in_words(created_at)} ago; last push #{time_ago_in_words(last_push)} ago."]
+
+		    # PRs
+			puts("2/6 Fetching open PRs…")
+			open_PRs = client.pull_requests(repository, {:per_page => 100})
+			puts(open_PRs.inspect) if options.verbose
+
+			puts("3/6 Fetching closed PRs…")
+			closed_PRs = client.pull_requests(repository, {:state => 'closed'})
+			puts(closed_PRs.inspect) if options.verbose
+
+		    total_PRs_count = open_PRs.count + closed_PRs.count
+		    if total_PRs_count > 0
+		    	ratio = (Float(closed_PRs.count) / total_PRs_count * 100).round(2)
+		    	prs_value = "#{total_PRs_count} PRs: #{closed_PRs.count} closed; #{open_PRs.count} opened; #{ratio}% PRs are closed."
+		    else 
+		    	prs_value = 'No PRs opened yet for this repository.'
+		    end
+			output << ['🍻', prs_value]
+
+		    # Refactoring
+			code_frequency = nil
+			GitHubBusFactor.helper(API_CALL_RETRY_COUNT, lambda { |c|  
+				puts("4/6 Fetching code frequency…")
+				code_frequency = client.code_frequency_stats(repository)
+			})
+			puts(code_frequency.inspect) if options.verbose
+
+		    deletions = 0
+		    additions = 0
+		    refactoring = code_frequency.each { |frequency| 
+		    	additions += frequency[1]
+		    	deletions += frequency[2]
+		    }
+		    refactoring = (Float(deletions.abs) / Float(additions) * 100).round(2)
+		    REFACTORING_THRESHOLD = 5
+		    if refactoring > REFACTORING_THRESHOLD
+		    	refactoring_value = "Deletions to additions ratio: #{refactoring}% (#{deletions}/#{additions})."
+		    else
+				refactoring_value = "Mostly additions, few deletions (#{deletions}/#{additions})."
+		    end
+			output << ['🛠', refactoring_value]
+
+			# Releases
+			puts("5/6 Fetching releases…")
+			releases = client.releases(repository)
+			puts(releases.inspect) if options.verbose
+			if !releases.empty?
+				latest_release = releases.first
+				release_name = latest_release.name.nil? || latest_release.name.empty? ? latest_release.tag_name : latest_release.name
+				releases_value = "#{releases.count} releases; latest release \"#{release_name}\": #{time_ago_in_words(latest_release.published_at)}."
+			else
+				releases_value = 'No releases.'
+			end
+			output << ['📦', releases_value]
+
+			# Bus factor
+			contributions = nil 
+			GitHubBusFactor.helper(API_CALL_RETRY_COUNT, lambda { |c|
+				puts("6/6 Fetching contribution statistics…")
+				contributions = client.contributors_stats(repository)
+			})
+			puts(contributions.inspect) if options.verbose
+			contributions = contributions.map { |c| c.total }
+			min, max = contributions.minmax
+			delta = max - min
+			CONTRIBUTION_THRESHOLD = 0.7
+			meaningful = contributions.select { |c|  (max - c) < delta * CONTRIBUTION_THRESHOLD }
+			total_contributions = contributions.reduce(0) { |t, c|  t + c }
+			if meaningful.empty? 
+				bus_factor = 100
+			else 
+				average = contributions.reduce(0) { |a, c| a + Float(c) / total_contributions }
+				bus_factor = (average / meaningful.count * 100.0).round(2)
+			end
+			if bus_factor > 90
+				bus_factor_value = "Bus factor: #{bus_factor}%. Most likely one core contributor."
+			else 
+				bus_factor_value = "Bus factor: #{bus_factor}% (#{meaningful.count} impactful contributors out of #{contributions.count})."
+			end
+			output << ['🚌', bus_factor_value]
+
+			# Output
+			puts("Thank you for you patience 💕\n\n")
+		    table = Terminal::Table.new do |t|
+		    	t.title = "#{ownerName}/#{repoName}"
+				t.style = {:padding_left => 1, :padding_right => 2}
+		    	t.rows = output.each_with_index
+		    end
+		    puts table
+		end
+	end
+end

data/lib/github_bus_factor/version.rb

@@ -0,0 +1,3 @@
+module GitHubBusFactor
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,197 @@
+--- !ruby/object:Gem::Specification
+name: github_bus_factor
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sash Zats
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-01-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: commander
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.3.3
+- !ruby/object:Gem::Dependency
+  name: security
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+- !ruby/object:Gem::Dependency
+  name: faraday-http-cache
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.5
+description: Provides few more parameters to estimate quality of the GitHub project
+  besides stars.
+email:
+- sash@zats.io
+executables:
+- github_score
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- README/screenshot.png
+- Rakefile
+- bin/console
+- bin/setup
+- exe/github_score
+- github_bus_factor.gemspec
+- lib/github_bus_factor.rb
+- lib/github_bus_factor/version.rb
+homepage: https://github.com/zats/github_bus_factor
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Is it a good idea to use this GitHub project?
+test_files: []
+has_rdoc: