contributors_stats 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8c726ad0986d83954b3b2bddde135824e1421dc2
+  data.tar.gz: 676fca44931563548b82c5abeb09cf34ae94de8b
+SHA512:
+  metadata.gz: 83969f2f0da917ba5d1a5a0ce2c43785e8a7e90073a7b140c98493252fb97228c68017330cdd1bccd3f0d1427cfdfd1ba0bb715793c5d0123262290c2895c39a
+  data.tar.gz: acd9a3de698b3903ab65f6950e3c6bb930fcf1f2f6ca736cd806b0245e614d23b88503bbfe4695aad04882018b0ecab61063d97a511649095f832949f9541deb

data/.gitignore

@@ -0,0 +1,6 @@
+/coverage
+/doc
+/.yardoc
+/vendor
+/*.gem
+/Gemfile.lock

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 2.0.0
+notifications:
+  irc:
+    channels:
+      - "irc.freenode.org#rvm-test"
+  email:
+    recipients:
+      - mpapis@gmail.com
+    on_failure: change

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+#ruby=2.0.0
+
+gemspec

data/LICENSE.md

@@ -0,0 +1,14 @@
+Copyright (c) 2009-2011 Wayne E. Seguin
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+

data/README.md

@@ -0,0 +1,43 @@
+# Contributors stats
+
+[![Build Status](https://travis-ci.org/mpapis/contributors_stats.png?branch=master)](https://travis-ci.org/mpapis/contributors_stats)
+[![Code Climate](https://codeclimate.com/github/mpapis/contributors_stats.png)](https://codeclimate.com/github/mpapis/contributors_stats)
+[![Dependency Status](https://gemnasium.com/mpapis/contributors_stats.png)](https://gemnasium.com/mpapis/contributors_stats)
+
+Update static files with contributors statistics.
+
+* Static content update of contributors statistics.
+* Plugable:
+** backends to load data
+** user details calculation
+** output fomratters
+** target files updating
+
+## Usage
+
+Contributors stats consists on two basic parts and few plugins.
+
+```ruby
+calculator = ContributorsStats.load(<options>)
+calculator.load(:<type> => '<name>')
+calculator.user_data_type = :<user_data_type>
+formatter = calculator.format(:<format>)
+formatter.save('<file>', ...)
+formatter.update('<file>', ..., options: <options>)
+puts formatter.content
+```
+
+Plugins are loaded automatically, for example `calculator.user_data_type = :fetch`
+will load `plugins/contributors_stats/user_data/fetch.rb` and use
+`ContributorsStats::UserData::Fetch` and use it to process user details calculation.
+
+## Examples
+
+```ruby
+ContributorsStats.load(gh_org:  'railsisntaller').format(:markdown).save('public/contributors.md')
+ContributorsStats.load(gh_repo: 'railsisntaller/website').format.update('public/index.html')
+```
+
+```shell
+ruby -I lib:lib/plugins -rcontributors_stats -e "puts ContributorsStats.load(:gh_org => 'rvm', :gh_repo => ['wayneeseguin/rvm', 'wayneeseguin/rvm-capistrano'], :user_data => :fetch).format(:html).content"
+```

data/Rakefile

@@ -0,0 +1,28 @@
+require "rake/testtask"
+require "yard"
+require "yard/rake/yardoc_task"
+
+Rake::TestTask.new do |t|
+  t.verbose = true
+  t.libs.push("test")
+  t.pattern = "test/**/*_test.rb"
+end
+
+YARD::Rake::YardocTask.new do |t|
+  t.before  = Proc.new do
+    puts "\n[YARD] Generating documentation\n\n"
+  end
+  t.files   = ['lib/**/*.rb']
+  # --quiet / --verbose =>
+  t.options = ['--quiet', '--list-undoc', '--compact', '--verbose']
+end
+
+task :default => [:test, :yard]
+
+task :example_data do
+  require "example_data"
+  example = ExampleData.new
+  example.parse_org(  example.url_builder("orgs/railsinstaller/repos") )
+  example.parse_repo( example.url_builder("repos/rvm/pluginator/contributors") )
+  example.parse_repo( example.url_builder("repos/mpapis/rubygems-bundler/contributors") )
+end

data/contributors_stats.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+
+require File.expand_path("../lib/contributors_stats/version.rb", __FILE__)
+
+Gem::Specification.new do |spec|
+  spec.name        = "contributors_stats"
+  spec.version     = ContributorsStats::VERSION
+  spec.license     = 'Apache'
+  spec.author      = "Michal Papis"
+  spec.email       = "mpapis@gmail.com"
+  spec.homepage    = "https://github.com/mpapis/contributors_stats"
+  spec.summary     = %q{Calculate statics for multiple project contributoions.}
+
+  spec.files       = `git ls-files`.split("\n")
+  spec.test_files  = `git ls-files -- {test,spec,features}/*`.split("\n")
+
+  spec.required_ruby_version = ">= 2.0.0"
+
+  spec.add_dependency "pluginator"
+
+  %w{rake simplecov coveralls yard redcarpet}.each do |name|
+    spec.add_development_dependency(name)
+  end
+end

data/lib/contributors_stats.rb

@@ -0,0 +1,28 @@
+#/usr/bin/env ruby
+
+##
+# static content update for speed and avoiding GH limits
+# read GitHub contributions, transform to urls and update files
+# all public methods return self for easy chaining
+#
+# Example:
+#
+#     ContributorsStats.load(org: 'railsisntaller').format.update('public/contributors.html')
+#     contributors = ContributorsStats.load(repo: 'railsisntaller/website')
+#     contributors.format(:html).update('public/index.html', 'public/contributors.html')
+#     contributors.format(:markdown).save('public/contriutors.md')
+#
+
+require 'pluginator'
+require 'contributors_stats/calculator'
+
+# Calculate contribution statistics for projects,
+# by default supports github organizations and repositories,
+# but is easily extendible with plugins.
+module ContributorsStats
+  # Initialize ContributorsStats
+  # @see ContributorsStats::Calculator.new
+  def self.load(options = {})
+    ContributorsStats::Calculator.new(options)
+  end
+end

data/lib/contributors_stats/base.rb

@@ -0,0 +1,29 @@
+module ContributorsStats
+
+  # Basis for ContributorsStats, includes logging and plugins support
+  class Base
+    attr_accessor :logger, :options
+
+    def initialize(options = {})
+      @logger = $stdout
+      @logger = options.delete(:logger) if options[:logger]
+      @options = options
+    end
+
+  private
+
+    def filter_options(type)
+      @options.select do |key, value|
+        plugins.class_exist?(type, key)
+      end
+    end
+
+    def plugins
+      @plugins ||= Pluginator.find("contributors_stats", extends: %i{first_class class_exist})
+    end
+
+    def log(text)
+      logger.respond_to?(:info) ? logger.info(text) : logger.puts(text)
+    end
+  end
+end

data/lib/contributors_stats/calculator.rb

@@ -0,0 +1,50 @@
+require 'contributors_stats/reader'
+require 'contributors_stats/formatter'
+
+module ContributorsStats
+
+  # Placeholder for user details resolution plugins
+  module UserData
+  end
+
+  # Calculates statistics gathered from multiple sources
+  class Calculator < Reader
+    attr_accessor :user_data_type
+
+    def initialize(options = {})
+      @user_data_type = options.delete(:user_data) if options[:user_data]
+      super(options)
+    end
+
+    # transform calculated data into asked format
+    # @param type [String] name of plugin to use for formatting
+    # @param options [Hash] list of options for the plugin to use
+    # @return [ContributorsStats::Formatter]
+    def format(type = :html, options = {})
+      ContributorsStats::Formatter.new(calculated_data, type, options)
+    end
+
+  private
+
+    # group data, calculate contributions, sort by contributions
+    def calculated_data
+      @data ||= @raw_data.group_by { |contributor|
+        contributor['login']
+      }.map {|login, data|
+        log "user: #{login}"
+        [login, user_data(login, data)]
+      }.sort_by{|login, data|
+        [1000000/data['contributions'], login]
+      }
+    end
+
+    def contributions(data)
+      data.map{|repo| repo['contributions'].to_i}.inject(&:+)
+    end
+
+    def user_data(login, data)
+      @user_data_plugin ||= plugins.first_class!("user_data", user_data_type || :simple)
+      @user_data_plugin.load(login, data.first, contributions(data))
+    end
+  end
+end

data/lib/contributors_stats/formatter.rb

@@ -0,0 +1,57 @@
+module ContributorsStats
+
+  # Placeholder for updater plugins
+  module Updater
+  end
+
+  # Takes care of formatting data and saving it
+  class Formatter
+    attr_reader :content
+
+    def initialize(data, type = :html, options = {})
+       format(data, type, options)
+    end
+
+    # overwrite target with the formatted content
+    # @param targets [Array] list of files to overwrite
+    def save(*targets)
+      targets.flatten.each do |file|
+        File.open(file, 'w') { |f| f.write(content * "\n") }
+      end
+    end
+
+    # update target with the formatted content
+    # @param targets [Array] list of files to update
+    # @param options [Hash] options are passed to updater plugin, check
+    def update(*targets, options: {})
+      targets.flatten.each do |file|
+        plugin = plugins.first_ask!("updater", :handles?, file)
+        update_file(file) do |file_content|
+          plugin.update(file_content, content, options)
+        end
+      end
+    end
+
+  private
+
+    def plugins
+      @plugins ||= Pluginator.find("contributors_stats", extends: %i{first_ask first_class})
+    end
+
+    def format(data, type = :html, options = {})
+      formatter_plugin = plugins.first_class!("formatter", type).new(options)
+      @content = data.map do |login, user_data|
+        formatter_plugin.format(login, user_data)
+      end
+    end
+
+    # Allow editing file text in a block
+    # @example
+    #     update_file('some.txt'){|text| text.gsub(/bla/,'ble')}
+    def update_file(file)
+      text = File.read(file)
+      text = yield text
+      File.open(file, 'w') { |f| f.write(text) }
+    end
+  end
+end

data/lib/contributors_stats/json_helper.rb

@@ -0,0 +1,49 @@
+require 'json'
+require 'open-uri'
+
+module ContributorsStats
+
+  # Support code for loading json urls/files
+  module JsonHelper
+
+    # Build full path to resource to use
+    def url_builder(path)
+      "#{self.path_prefix}#{path}#{self.path_suffix}"
+    end
+
+    # Load json from url, fallback to prefix
+    def load_json(url)
+      open(url){ |json| JSON.load(json) }
+    rescue Exception => e
+      if File.exist?("#{self.path_prefix}#{url}")
+        open("#{self.path_prefix}#{url}"){ |json| JSON.load(json) }
+      elsif File.exist?("#{self.path_prefix}#{url}#{self.path_suffix}")
+        open("#{self.path_prefix}#{url}#{self.path_suffix}"){ |json| JSON.load(json) }
+      else
+        raise e
+      end
+    end
+
+    # get prefix, sets the default if empty, makes sure it's ending with '/'
+    def path_prefix
+      @path_prefix ||= "https://api.github.com"
+      @path_prefix+="/" if @path_prefix != "" && @path_prefix[-1] != "/"
+      @path_prefix
+    end
+
+    # get suffix, sets the default if empty, makes sure it's starts with '.'
+    def path_suffix
+      @path_suffix ||= ""
+      @path_suffix = ".#{@path_suffix}" if @path_suffix != "" && @path_suffix[0] != "."
+      @path_suffix
+    end
+
+  protected
+
+    def configure_path(prefix, suffix)
+      @path_prefix = prefix
+      @path_suffix = suffix
+    end
+
+  end
+end

data/lib/contributors_stats/reader.rb

@@ -0,0 +1,52 @@
+require 'contributors_stats/base'
+require 'contributors_stats/json_helper'
+
+module ContributorsStats
+
+  # Base for reading ContributorsStats data
+  class Reader < Base
+    include ContributorsStats::JsonHelper
+
+    attr_reader :data, :raw_data
+
+    def initialize(options = {})
+      configure_path(*options.delete(:configure_path)) if options[:configure_path]
+      super(options)
+      @raw_data = []
+      @data = nil
+      parse_readers(filter_options("reader"))
+    end
+
+    # load data using given plugin
+    # @param type [String] plugin to use
+    # @param name [String] name to pass to the plugin
+    def load(type, name)
+      reader_plugin(type).load(name) do |data, name|
+        log "repository: #{name}"
+        @raw_data += data
+      end
+      @data = nil
+    end
+
+  private
+
+    def reader_plugin(type)
+      plugin = plugins.first_class!("reader", type)
+      if plugin.kind_of?(ContributorsStats::JsonHelper)
+        plugin.send(:configure_path, path_prefix, path_suffix)
+      end
+      plugin
+    end
+
+    def parse_readers(options = {})
+      options.each do |type, name|
+        if name.kind_of?(Array)
+          name.each{|n| load(type,n)}
+        else
+          load(type, name)
+        end
+      end
+    end
+
+  end
+end

data/lib/contributors_stats/version.rb

@@ -0,0 +1,4 @@
+module ContributorsStats
+  # gem version
+  VERSION = "1.0.0"
+end

data/lib/example_data.rb

@@ -0,0 +1,58 @@
+require 'contributors_stats/json_helper'
+
+# Dump some test data from github, rather one time, but who knows ;)
+class ExampleData
+  include ContributorsStats::JsonHelper
+
+  # setup proper context for dumping data
+  def initialize(target_path = "../../test/fixtures-gh")
+    target_path = File.expand_path( target_path, __FILE__ ) unless Dir.exist?(target_path)
+    Dir.chdir(target_path)
+    `rm -rf *` # clean
+  end
+
+  # parse organization data from given url, parses also repositories
+  # @see .parse_repo
+  def parse_org(org_url)
+    puts "reading: #{org_url}"
+    org_data = load_json(org_url)
+    write(org_url, org_data)
+    org_data.each do |repo|
+      parse_repo(repo['contributors_url'], "  ")
+    end
+  end
+
+  # parse repository data from given url, parses also users
+  # @see .parse_repo
+  def parse_repo(contributors_url, str_prefix="")
+    puts "#{str_prefix}reading: #{contributors_url}"
+    contributors_data = load_json(contributors_url)
+    write(contributors_url, contributors_data)
+    contributors_data.each do |contributor|
+      parse_user(contributor['url'], str_prefix+"  ")
+    end
+  end
+
+  # parse user data from given url
+  def parse_user(user_url, str_prefix="")
+    puts "#{str_prefix}reading: #{user_url}"
+    user_data = load_json(user_url)
+    write(user_url, user_data)
+  end
+
+  # saves content to path corresponding to the given file url
+  def write(file, content)
+    file = remove_prefix(file)
+    return if File.exist?(file)
+    `mkdir -p #{File.dirname(file)}`
+    File.open(file, "w+") { |f|
+      f.write(remove_prefix(JSON.pretty_generate(content)))
+    }
+  end
+
+  # remove prefix from all urls in the given content
+  def remove_prefix(conten)
+    conten.gsub(/#{path_prefix}([^"]*)/, "\\1.json")
+  end
+
+end