gitGraph 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2ef0185233741d9fe0914102d81fe41ab83d9923
+  data.tar.gz: 475770178ffc17cf3a66be1adbe7a497c8d14762
+SHA512:
+  metadata.gz: cca0d2447edc9d7373dffc34365d34fc8f186934e92413bfadd9791fb870330dd9c6ec67ae3360dc682ffcdbe0f2b93eb129ea3fbb6516859ec85aedbdcb89de
+  data.tar.gz: c8c13184784ffa829126cbb5f5e5bc93bc1de7dc0935c54e1cffc8c6f0dc92529761ef92cd56ca72d1b31976578b4ae5431e5c4b8f58d66ccf92ae788ab7f932

data/.gitignore

@@ -0,0 +1,41 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+.env
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+examplefile.rb
+
+## Environment normalisation:
+/.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

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--format doc

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gem 'rack'
+gem 'octokit'
+gem 'rspec'
+gem 'dotenv-rails'
+gem 'color-generator'
+gem 'erb'
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Joe Canero
+
+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/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 caneroj1
+
+MIT License
+
+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,67 @@
+# GitGraph
+
+Displays nice graphs of GitHub usage through a Rack App. Can help you analyze things like what languages you most frequently push in, etc.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gitGraph'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gitGraph
+
+## Usage
+
+```ruby
+require 'gitGraph'
+
+# configuring the client
+GitGraph::Configuration.config do |config|
+  config.username = # your github username
+  config.password = # your github password
+end
+
+# your GitGraph client is now all configured to access GitHub's apis
+client = GitGraph::GitHub::Client.new
+
+# start adding GitHub users
+client << # some github username
+
+client + # another github username
+
+# you can also github users using integers.
+## CAUTION: these are not guaranteed to exist. ##
+
+client + 1
+
+# let's run a language comparison. this checks all of
+# the public repositories for each added user and tallies
+# up their language usage.
+client.compare_languages(:radar) # using a radar chart
+
+# we can change to a bar chart
+# the compare languages feature is indexed under
+# the :languages key.
+client.change_chart_type(:languages, :bar)
+
+# let's render our chart
+path = # path to where you want the chart
+client.render(path)
+
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/gitGraph/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/gitGraph.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gitGraph/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gitGraph"
+  spec.version       = GitGraph::VERSION
+  spec.authors       = ["caneroj1"]
+  spec.email         = ["caneroj1@tcnj.edu"]
+  spec.summary       = %q{Displays nice graphs of GitHub usage through a Rack App.}
+  spec.description   = %q{Displays nice graphs of GitHub usage through a Rack App. Can help you analyze things like what languages you most frequently push in, etc.}
+  spec.homepage      = "https://github.com/caneroj1/GitGraph"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/gitGraph.rb

@@ -0,0 +1,6 @@
+require_relative "gitGraph/version"
+require_relative "utils"
+
+module GitGraph
+  require_files(File.dirname(__FILE__) << "/gitGraph/*")
+end

data/lib/gitGraph/configuration.rb

@@ -0,0 +1,16 @@
+module GitGraph
+  class Configuration
+    class << self
+      attr_accessor :username, :password
+
+      def config
+        raise ArgumentError, block_error if !block_given?
+        yield self
+      end
+
+      def block_error
+        "A block must be passed in order to set attributes."
+      end
+    end
+  end
+end

data/lib/gitGraph/github/client.rb

@@ -0,0 +1,71 @@
+require 'octokit'
+require_relative '../configuration'
+require_relative 'graphable_object'
+require_relative 'feature'
+require_relative '../renderer.rb'
+
+module GitGraph
+  module GitHub
+    class Client
+      attr_reader :client
+      include Enumerable
+
+      def initialize
+        @client = Octokit::Client.new(
+          login:    GitGraph::Configuration.username,
+          password: GitGraph::Configuration.password
+        )
+
+        @stored_users = {
+          GitGraph::Configuration.username =>
+          @client.user
+        }
+
+        @data_to_graph = {}
+      end
+
+      def get_user(key)
+        @stored_users.fetch(key)
+      end
+      alias_method :[], :get_user
+
+      def add_user(user)
+        user_to_add = @client.user(user)
+        @stored_users[user_to_add.login] = user_to_add
+      end
+      alias_method :<<, :add_user
+      alias_method :+, :add_user
+
+      def remove_user(user)
+        @stored_users.delete(user)
+      end
+      alias_method :-, :remove_user
+
+      def user_count
+        @stored_users.count
+      end
+      alias_method :user_size, :user_count
+
+      def change_chart_type(graphable_object_name, chart_type)
+        @data_to_graph[graphable_object_name].chart_type = chart_type
+      end
+
+      def each
+        @stored_users.each { |name, user| yield(name, user) }
+      end
+
+      def compare_languages(chart, **options)
+        options ||= {}
+        title = options.delete(:title) || "Kilobytes Written per Language"
+        data = GitGraph::GitHub::Feature.send(:compare_languages, self)
+        graphable = GitGraph::GitHub::GraphableObject.new(data, chart, options, title)
+        @data_to_graph[:languages] = graphable
+      end
+
+      def render(path)
+        @data_to_graph.each { |key, data| GitGraph::Renderer.render(data, key, path) }
+        GitGraph::Renderer.copy_files(path)
+      end
+    end
+  end
+end

data/lib/gitGraph/github/feature.rb

@@ -0,0 +1,11 @@
+require_relative '../../utils'
+
+module GitGraph
+  module GitHub
+    class Feature
+      class << self
+        require_files(File.dirname(__FILE__) << "/feature/*")
+      end
+    end
+  end
+end

data/lib/gitGraph/github/feature/compare_languages.rb

@@ -0,0 +1,51 @@
+require 'octokit'
+require_relative '../graphable_data'
+
+def compare_languages(client)
+  # languages will be the array that will be used
+  # to form labels in the chart
+  languages = []
+
+  # datasets will hold the data that we obtain for each user
+  # based on github querying for their languages
+  datasets = []
+
+  client.each do |name, user|
+    new_dataset = {
+      label: name,
+      data: {}
+    }
+
+    client.client.repositories(name).each do |repo|
+      client.client.languages(repo.full_name).attrs.each_pair do |lang, value|
+        languages.push(lang) unless languages.include?(lang)
+        new_dataset[:data][lang] ||= 0
+        new_dataset[:data][lang] += value
+      end
+    end
+
+    datasets.push(new_dataset)
+  end
+
+  # sort the languages
+  languages.sort!
+
+  # go through the languages, and if a dataset does not have that language
+  # as part of its data array, default it to 0
+  languages.each do |lang|
+    datasets.each { |dataset| dataset[:data][lang] ||= 0}
+  end
+
+  # convert the data hash to an array
+  datasets.each { |dataset| dataset[:data] = dataset[:data].to_a }
+
+  # sort on the array by key
+  datasets.each { |dataset| dataset[:data].sort! { |a, b| a[0] <=> b[0] } }
+
+  # each value in the array represents bytes of code written in a language.
+  # convert each value in the array to kilobytes written in each language
+  datasets.each { |dataset| dataset[:data].each { |data| data[1] /= 1024} }
+
+  # return a new graphable data item
+  GitGraph::GitHub::GraphableData.new(labels: languages, datasets: datasets)
+end

data/lib/gitGraph/github/graphable_data.rb

@@ -0,0 +1,107 @@
+require 'color-generator'
+
+module GitGraph
+  module GitHub
+    class GraphableData
+      attr_accessor :labels, :datasets
+
+      # datasets should be an array of hashes. each has needs to contain
+      # a label => name key-value pair, which is basically the name of that dataset, and
+      # and a data => data_arr key-value pair, which is just an array of data points.
+      def initialize(labels: labels, datasets: datasets)
+        @labels, @datasets = labels, datasets
+      end
+
+
+      def stringify(chart_type, options = {})
+        new_options = format_options(options)
+        map_colors_to_datasets(new_options)
+        if chart_type == :polar_area
+          format_for_polar_area(new_options)
+        else
+          format_chart(new_options)
+        end
+      end
+
+      def map_colors_to_datasets(options)
+        @datasets.map! { |dataset| dataset.merge(prettify(options)) }
+      end
+
+      def prettify(options)
+        prettified_hash = {}
+        base_color = ColorGenerator.new(saturation: 1.0, value: 1.0).create_rgb
+
+        fill_color = new_color(base_color, options[:fill_alpha])
+        stroke_color = new_color(base_color, options[:stroke_alpha])
+        { :fillColor => fill_color, :strokeColor => stroke_color, :pointColor => stroke_color,
+          :pointStrokeColor => options[:point_stroke_color], :pointHighlightFill => options[:point_highlight_fill],
+          :pointHighlightStroke => stroke_color }
+      end
+
+      def new_color(color, alpha)
+        "rgba(#{color[0]}, #{color[1]}, #{color[2]}, #{alpha})"
+      end
+
+      def format_options(options)
+        options[:fill_alpha] ||= 0.2
+        options[:stroke_alpha] ||= 1.0
+        options[:point_stroke_color] ||= '#fff'
+        options[:point_highlight_fill] ||= '#fff'
+        options
+      end
+
+      private
+      def format_chart(new_options)
+        main_string = make_options(new_options)
+        main_string << "\nvar data = {\n"
+        main_string << make_labels
+        main_string << make_datasets
+        main_string << "\n};"
+      end
+
+      def make_options(new_options)
+        options_string = "var options = {\n"
+        opts_arr = []
+
+        new_options.each do |key, value|
+          if value.class.eql?(String)
+            opts_arr.push("\t#{key}: '#{value}'")
+          else
+            opts_arr.push("\t#{key}: #{value}")
+          end
+        end
+
+        options_string << opts_arr.join(",\n")
+        options_string << "\n};"
+        options_string
+      end
+
+      def make_labels
+        "\tlabels: #{@labels.map { |label| label.to_s }.inspect},\n"
+      end
+
+      def make_datasets
+        main_string = "\tdatasets: ["
+        dataset_string_array = []
+
+        @datasets.each do |dataset|
+          new_string = "\n\t\t{\n"
+          dataset_string_components = []
+
+          dataset.each_pair do |key, value|
+            value = value.class.eql?(String) ? "\"#{value}\"" : value.map { |item| [item[1]]}
+            dataset_string_components.push("\t\t\t#{key}: #{value}")
+          end
+
+          new_string << dataset_string_components.join(",\n")
+          new_string << "\n\t\t}"
+
+          dataset_string_array.push(new_string)
+        end
+
+        main_string << dataset_string_array.join(',')
+        main_string << "\n\t]"
+      end
+    end
+  end
+end