gitlang 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 66c3047930dc30da7e2139fdc6b704b6be9df3c2
+  data.tar.gz: 65d905b24e5b7312175211d036d4f39231714b76
+SHA512:
+  metadata.gz: 182a51955d5b1ece347471681e2a386c32a8bcda0de8e5ba8060fe731560966525af2f9ca7b2bbb69c8dd120da38facdb00454878459aab351380b5d57fd13cd
+  data.tar.gz: 93e23a5ae89588f669e0395867fd46030e775b09b3e556d9260c28022250fa5a0d10a5dfe03f5e622c503cb3f66ca86b832338c8dc0936b6cbf541bfb30bca7c

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.16.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at kir.velissariou@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in gitlang.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,42 @@
+PATH
+  remote: .
+  specs:
+    gitlang (0.1.0)
+      lare_round (~> 0.0.1)
+      octokit (~> 4.0)
+      thor (~> 0.20)
+      tty-spinner (~> 0.8)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    faraday (0.12.2)
+      multipart-post (>= 1.2, < 3)
+    lare_round (0.0.2)
+    minitest (5.10.3)
+    multipart-post (2.0.0)
+    octokit (4.8.0)
+      sawyer (~> 0.8.0, >= 0.5.3)
+    public_suffix (3.0.1)
+    rake (10.4.2)
+    sawyer (0.8.1)
+      addressable (>= 2.3.5, < 2.6)
+      faraday (~> 0.8, < 1.0)
+    thor (0.20.0)
+    tty-cursor (0.5.0)
+    tty-spinner (0.8.0)
+      tty-cursor (>= 0.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  gitlang!
+  minitest (~> 5.0)
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.16.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Kiriakos Velissariou
+
+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,53 @@
+# Gitlang
+
+Simple gem for displaying information about the programming languages used by a GitHub organization.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gitlang'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gitlang
+
+## Setup
+
+This gem makes several requests to the GitHub API. In order to avoid rate limit restrictions follow the instructions below:
+* Create a Personal Access Token as described in the *Creating a token* section [here](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/).
+* Open your terminal and run:
+```bash
+export GITHUB_TOKEN=[token]
+```
+Note that this command sets this variable only for the current session. If you want persistence you can set it in a configuration file, depending on your terminal.
+
+## Usage
+
+Open your terminal and run:
+```bash
+gitlang relative_usage_per_language [organization_name]
+
+# Returns a prettified json formatted string, the numbers are expressed as %.
+# {
+#   "organization": organization_name,
+#   "languages": {
+#       "language1": 40.0,
+#       "language2": 60.0
+#    }
+# }
+```
+This gem can be used in conjuction with the redirection operators. For example, if you want to store the output in a file you can run:
+```
+gitlang relative_usage_per_language [organization_name] > [file_name]
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

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

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require "gitlang"
+Gitlang::CLI.start(ARGV)

data/gitlang.gemspec

@@ -0,0 +1,39 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "gitlang/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "gitlang"
+  spec.version       = Gitlang::VERSION
+  spec.authors       = ["Kiriakos Velissariou"]
+  spec.email         = ["kir.velissariou@gmail.com"]
+
+  spec.summary       = %q{Simple gem for displaying information about the programming languages used by a GitHub organization.}
+  spec.homepage      = "https://github.com/kiriakosv/gitlang"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing 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 do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_dependency "lare_round", "~> 0.0.1"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_dependency "octokit", "~> 4.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_dependency "thor", "~> 0.20"
+  spec.add_dependency "tty-spinner", "~> 0.8"
+end

data/lib/gitlang.rb

@@ -0,0 +1,37 @@
+require 'thor'
+require 'octokit'
+require 'tty-spinner'
+
+require 'gitlang/version'
+require 'gitlang/organization'
+require 'gitlang/formatters/json_formatter'
+require 'gitlang/errors'
+
+module Gitlang
+  # Class containing the commands that the final user can use.
+  class CLI < Thor
+    def initialize(*args)
+      super
+      @client = Octokit::Client.new access_token: ENV['GITHUB_TOKEN']
+      @formatter = JsonFormatter.new
+      @spinner = TTY::Spinner.new('[:spinner] Data crunching... ')
+    end
+
+    def self.exit_on_failure?
+      true
+    end
+
+    desc 'relative_usage_per_language [name]',
+         'Returns the relative usage per language for a given organization.'
+    def relative_usage_per_language(organization)
+      @spinner.auto_spin
+      @organization = Organization.new(organization, @client)
+      usage_per_repo = @organization.usage_per_repo
+      relative_usage = @organization.relative_usage_per_language(usage_per_repo)
+      puts @formatter.format(@organization.name, relative_usage)
+      @spinner.success('Done')
+    rescue GitlangError => e
+      @spinner.error('Failure: - ' + e.message)
+    end
+  end
+end

data/lib/gitlang/errors.rb

@@ -0,0 +1,3 @@
+module Gitlang
+  class GitlangError < StandardError; end
+end

data/lib/gitlang/formatters/json_formatter.rb

@@ -0,0 +1,18 @@
+require 'json'
+
+module Gitlang
+  # A class for formatting various results to JSON format.
+  class JsonFormatter
+    # Create a JSON formatted string for the data provided.
+    #
+    # @param organization_name [String]
+    # @param languages [Hash]
+    #
+    # @example
+    #   format('acme', { c: 30.0, ruby: 70.0 })
+    def format(organization_name, languages)
+      JSON.pretty_generate(organization: organization_name,
+                           languages: languages)
+    end
+  end
+end

data/lib/gitlang/github_stats.rb

@@ -0,0 +1,39 @@
+require 'bigdecimal'
+require 'lare_round'
+
+module Gitlang
+  # Module for extracting useful Github statistics.
+  module GithubStats
+    # Creates a hash with the absolute usage for each language.
+    #
+    # @param usage_per_repo [Array<Hash>]
+    #
+    # @example
+    #   absolute_usage_per_language([{ python: 4, ruby: 2 }, { python: 3 }])
+    def absolute_usage_per_language(usage_per_repo)
+      usage_per_repo.each_with_object(Hash.new(0)) do |repository, total|
+        repository.each { |language, usage| total[language] += usage }
+      end
+    end
+
+    # Creates a hash with the relative usage for each language.
+    #
+    # @param usage_per_repo [Array<Hash>]
+    #
+    # @example
+    #   relative_usage_per_language([{ python: 30, ruby: 70 }, { python: 100 }])
+    def relative_usage_per_language(usage_per_repo)
+      absolute_usage = absolute_usage_per_language(usage_per_repo)
+      total = absolute_usage.values.inject(&:+)
+      results_pre_lare = absolute_usage.merge(absolute_usage) do |_, usage|
+        (BigDecimal.new(usage) / total * 100)
+      end
+
+      # Largest remainder method is used in order to avoid cases where the sum
+      # of the relative usage is over or under 100%.
+      # More info at https://en.wikipedia.org/wiki/Largest_remainder_method.
+      results_after_lare = LareRound.round(results_pre_lare, 2)
+      results_after_lare.merge(results_after_lare) { |_, usage| usage.to_f }
+    end
+  end
+end

data/lib/gitlang/organization.rb

@@ -0,0 +1,55 @@
+require 'gitlang/github_stats'
+require 'gitlang/repository'
+require 'gitlang/utilities'
+
+module Gitlang
+  # Class representing a GitHub organization
+  class Organization
+    include Gitlang::GithubStats
+    include Gitlang::Utilities
+
+    attr_reader :name, :repositories
+
+    def initialize(name, client)
+      @name = name.downcase
+      @client = client
+      @repositories = fetch_repo_names.each_with_object([]) do |repo_name, repositories|
+        # There is a tight coupling between Organisation and Repository, but I
+        # think it's fine regarding the scope of the application.
+        repositories << Repository.new(@name, repo_name, @client)
+      end
+    end
+
+    # Creates an array of hashes with the language usage for each repository.
+    def usage_per_repo
+      conditional_rescue do
+        @repositories.each_with_object([]) do |repository, result|
+          result << repository.languages
+        end
+      end
+    end
+
+    private
+
+    def fetch_repo_names
+      conditional_rescue { fetch_all_pages.flatten }
+    end
+
+    # Get every repository name. Acts as a helper for fetch_repo_names since
+    # we're dealing with an external paginated service.
+    def fetch_all_pages
+      result = @client.org_repos(name,
+                                 query: { type: 'sources', visibility: 'public' },
+                                 per_page: 100)
+                      .map(&:name)
+      last_response = @client.last_response
+
+      until last_response.rels[:next].nil?
+        last_response = last_response.rels[:next].get
+        result << last_response.data.map(&:name)
+      end
+
+      result
+    end
+  end
+end

data/lib/gitlang/repository.rb

@@ -0,0 +1,24 @@
+require 'gitlang/utilities'
+
+module Gitlang
+  # Class representing a GitHub organization's repository.
+  class Repository
+    include Gitlang::Utilities
+
+    def initialize(organization_name, repository_name, client)
+      @organization_name = organization_name
+      @name = repository_name
+      @client = client
+    end
+
+    # Returns the full name of the repository as a string.
+    def full_name
+      @organization_name + '/' + @name
+    end
+
+    # Returns a hash containing the absolute usage of each language.
+    def languages
+      conditional_rescue { @client.languages(full_name) }
+    end
+  end
+end

data/lib/gitlang/utilities.rb

@@ -0,0 +1,23 @@
+module Gitlang
+  # Contains general purpose methods.
+  module Utilities
+    # Calls the given block and rescues from specific errors.
+    #
+    # @yield block
+    #
+    # @example
+    #   conditional_rescue { @client.call }
+    def conditional_rescue
+      yield if block_given?
+    rescue Octokit::TooManyRequests
+      raise Gitlang::GitlangError,
+            'You made too many requests. Please set GITHUB_TOKEN.'
+    rescue Octokit::NotFound
+      raise Gitlang::GitlangError, 'Resource not found.'
+    rescue Octokit::Unauthorized
+      raise Gitlang::GitlangError, 'Wrong GITHUB_TOKEN.'
+    rescue Faraday::ConnectionFailed
+      raise Gitlang::GitlangError, 'Connection failed.'
+    end
+  end
+end

data/lib/gitlang/version.rb

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

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification
+name: gitlang
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kiriakos Velissariou
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: lare_round
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.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: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+- !ruby/object:Gem::Dependency
+  name: tty-spinner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: 
+email:
+- kir.velissariou@gmail.com
+executables:
+- gitlang
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/gitlang
+- gitlang.gemspec
+- lib/gitlang.rb
+- lib/gitlang/errors.rb
+- lib/gitlang/formatters/json_formatter.rb
+- lib/gitlang/github_stats.rb
+- lib/gitlang/organization.rb
+- lib/gitlang/repository.rb
+- lib/gitlang/utilities.rb
+- lib/gitlang/version.rb
+homepage: https://github.com/kiriakosv/gitlang
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Simple gem for displaying information about the programming languages used
+  by a GitHub organization.
+test_files: []