language-usage-charts 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ad83c38803901abb10cfef72315ed4088c25454bc04ba413e3b3a0b113812146
+  data.tar.gz: 9be18391cbbeb0f1693c5e972f8a56e136a2572b020f3ba4f5a57ff80b7363d3
+SHA512:
+  metadata.gz: db2e99ed172e8acebf876852b59876d7438234bf6334ac8ee4666c6884f8e5440dad6ed9da0ae75f9b17f97fac9e09ef0620a11062bfd2817e99aa4474c3b8e9
+  data.tar.gz: f248a28e31b34b2be042582ecca96aa9b4d39d8ec9503903e0011ccd635b8c0a287f452650958e913061d0a21b3ae36b5c6379af0eff05c15fc76782a2b9a9c2

data/.gitignore

@@ -0,0 +1,53 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+cache: bundler
+sudo: false
+rvm: 2.3
+
+install: gem install bundler; bundle install
+script: gem build language_usage_charts.gemspec
+
+deploy:
+  provider: rubygems
+api_key: $API_KEY

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright 2019 Sasha Elaine Fox
+
+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 @@
+# Language Usage Charts
+
+## What is this project?
+
+This project started life as a way to add Github language usage-esque
+graphics to an independent CI/CD pipeline.
+
+## Installation
+
+### System Dependencies
+
+This package relies on Github Linguist which in turn relies on `charlock_holmes`
+and `rugged`. These dependencies require _quite_ a few system packages to work
+properly.
+
+If you're using a Debian variant distro all dependencies can be installed via:
+
+```shell
+sudo apt-get install cmake pkg-config libicu-dev zlib1g-dev libcurl4-openssl-dev libssl-dev ruby-dev
+```
+
+### Package installation
+
+From the project root directory (the one containing the `.gempspec` file)
+run the following command.
+
+```shell
+bundle exec rake install
+```
+
+## Usage
+
+Once things have been installed with bundle language usage charts can be generated
+from anywhere using `generate_usage_chart $OPTS`. The following options are
+supported.
+
+| Option        | Usage                             | Example             |
+|---------------|-----------------------------------|---------------------|
+| `-r`. `--repo`| Path to a git repository.         | "."                 |
+| `-o`, `--out` | Path where usage chart should go. | "./usage_chart.png" |
+
+Example usage:
+
+```shell
+generate_usage_chart -r "." -o "./language_usage_chart.png"
+```

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

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

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'ostruct'
+
+require 'rugged'
+require 'linguist'
+require 'gruff'
+
+require 'language_usage_graphics'
+
+options = OpenStruct.new
+OptionParser.new do |opt|
+  opt.on('-r', '--repo REPO', 'Path to a git repository.') { |o| options.repo = o }
+  opt.on('-o', '--out OUT', 'Path where the resulting usage chart should go.') { |o| options.out = o }
+end.parse!
+
+repo = Rugged::Repository.new(options.repo)
+project = Linguist::Repository.new( repo, repo.head.target_id )
+
+normalized_scores = LanguageUsageCharts.normalize_scores( project.languages )
+
+graph = LanguageUsageCharts.render_language_breakdown( normalized_scores )
+graph.write( options.out )

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/language_usage_charts.gemspec

@@ -0,0 +1,16 @@
+Gem::Specification.new do |s|
+  s.name = 'language-usage-charts'
+  s.version = '0.1.0'
+  s.date = '2019-03-18'
+  s.summary = "Stand alone language usage charts."
+  s.description = "Display break-down of programming language usage in a git repo."
+  s.authors = ["Sasha Fox"]
+  s.email = 'sashanullptr@gmail.com'
+  s.files = `git ls-files`.split($\)
+  s.license = 'MIT'
+  s.executables = ["generate_usage_chart"]
+  s.require_paths = ["lib"]
+  s.add_runtime_dependency 'rugged', '~> 0.28', '>= 0.28.1'
+  s.add_runtime_dependency 'github-linguist', '~> 7.3', '>= 7.3.1'
+  s.add_runtime_dependency 'gruff', '~> 0.7', '>= 0.7.0'
+end

data/lib/language_usage_graphics.rb

@@ -0,0 +1,35 @@
+require 'gruff'
+
+module LanguageUsageCharts
+  def self.render_language_breakdown( scores )
+  # Render a Pie Chart using normalized Linguist statistics.
+
+    graph = Gruff::SideStackedBar.new('800x300')
+    graph.title = "Language Breakdown"
+
+    # Graph lavels *must* be defined, however we do not want any labels displayed,
+    # so we set the label for the zero'th bar to nil.
+    graph.labels = {0=>nil}
+
+    scores.each do |k,v|
+      percent = (v*100)
+      label = k + " " + (percent.round(1)).to_s + "%"
+      graph.data( label, percent )
+    end
+
+    graph.sort = true
+    graph
+  end
+
+  def self.normalize_scores( languages )
+  # By default Linguist produces language usage statistics as a dictionary
+  # which takes the following form:
+  #   :"Language Name" => Total number of characters written in language.
+  # This function produces a new dictionary with the following form:
+  #   :"Language Name" => Fraction of repository written in language.
+
+      num_chars = languages.values.reduce(:+)
+      total_chars = num_chars.to_f
+      languages.inject({}) { |h,(k,v)| h[k] = v/total_chars; h }
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: language-usage-charts
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sasha Fox
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-03-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rugged
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.28'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.28.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.28'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.28.1
+- !ruby/object:Gem::Dependency
+  name: github-linguist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.3.1
+- !ruby/object:Gem::Dependency
+  name: gruff
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+description: Display break-down of programming language usage in a git repo.
+email: sashanullptr@gmail.com
+executables:
+- generate_usage_chart
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/generate_usage_chart
+- bin/setup
+- language_usage_charts.gemspec
+- lib/language_usage_graphics.rb
+homepage: 
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Stand alone language usage charts.
+test_files: []