github_bus_factor 0.1.4 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 278961f91489f5b4ef28bce01f740831f449116b
-  data.tar.gz: 850d44a73f6cf92e4324b4a51cf26284a959295d
+  metadata.gz: ae9a67035be44381b94300dfc621e8cb5a3f34d2
+  data.tar.gz: d0d162e0cc74061d6a987ae1e92182f9345d2635
 SHA512:
-  metadata.gz: 56f765793d015ffa8bbd8c272ecfa3657c6dde4b21ac2dc6f0d5a46a8799ee8e5223d98f54c54debb0f6f2ba6e138b6a5182d993c15e81570191e23868c2f3fa
-  data.tar.gz: 1966d285894ab4593f01b2df914b58247a84a8bf74b506c134c742eb3d925c79ed91c9933a7c4cc62218b0770635a3dc4117f63a445ac4f9c72caf684f89eb0d
+  metadata.gz: 3d347a0d09033802ac2248100d6dfbf81a3864caa32d09f87cd99a6a61b5296f3b08f67f6352764e8ff7a85aa7c616d2e18170526f1d94c84ff055a129741c74
+  data.tar.gz: e2f020b138a21f9f781b2114477e2dbdea82a72ce8ff792bae59d53c9f1cc871eecf35c02a84940d6931d9dba6f6dec8f8ecd0b137e73dfd2401f11ebe81b681

data/github_bus_factor.gemspec

@@ -29,10 +29,10 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_runtime_dependency "octokit", "~> 4.2"
-  spec.add_runtime_dependency 'commander', '~> 4.3', '>= 4.3.3'
-  spec.add_runtime_dependency "security", "~> 0.1.3"
-  spec.add_runtime_dependency 'terminal-table', '~> 1.5', '>= 1.5.2'
-  spec.add_runtime_dependency 'faraday-http-cache', '~> 1.2', '>= 1.2.2'
-  spec.add_runtime_dependency 'activesupport', '~> 4.2', '>= 4.2.5'
+  spec.add_dependency 'octokit', '~> 4.2'
+  spec.add_dependency 'commander', '~> 4.3'
+  spec.add_dependency 'security', '~> 0.1.3'
+  spec.add_dependency 'terminal-table', '~> 1.5'
+  spec.add_dependency 'faraday-http-cache', '~> 1.2'
+  spec.add_dependency 'activesupport', '~> 4.2'
 end

data/lib/github_bus_factor/version.rb

@@ -1,3 +1,3 @@
 module GitHubBusFactor
-  VERSION = "0.1.4"
+  VERSION = "0.1.6"
 end

data/lib/github_bus_factor.rb

@@ -1,4 +1,4 @@
-require "github_bus_factor/version"
+require 'github_bus_factor/version'
 require 'rubygems'
 require 'commander/import'
 require 'octokit'
@@ -10,221 +10,217 @@ require 'active_support/core_ext/numeric/time'
 include ActionView::Helpers::DateHelper
 
 
+KEYCHAIN_SERVICE = 'github_bus_factor'
+API_CALL_RETRY_COUNT = 3
 
-module GitHubBusFactor
-	KEYCHAIN_SERVICE = 'github_bus_factor'
-	API_CALL_RETRY_COUNT = 3
+program :version, GitHubBusFactor::VERSION
+program :description, 'More than just stars'
+default_command :fetch
 
-
-	program :version, '0.0.1'
-	program :description, 'More than just stars'
-	default_command :fetch
-
-	# 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
+# There must be a better way to deal with GitHub caching… 
+def 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
+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
+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
+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)
+		# 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
+		# 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
+		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 
+		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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: github_bus_factor
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.6
 platform: ruby
 authors:
 - Sash Zats
@@ -59,9 +59,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.3'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.3.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -69,9 +66,6 @@ dependencies:
     - - "~>"
       - !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
@@ -93,9 +87,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.5.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -103,9 +94,6 @@ dependencies:
     - - "~>"
       - !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
@@ -113,9 +101,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.2.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -123,9 +108,6 @@ dependencies:
     - - "~>"
       - !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
@@ -133,9 +115,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.2'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.2.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -143,9 +122,6 @@ dependencies:
     - - "~>"
       - !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: