contributors_stats 1.0.0

data/lib/plugins/contributors_stats/formatter/html.rb

@@ -0,0 +1,26 @@
+class ContributorsStats::Formatter
+
+  # generate html for a contributor, by default it will create a link to profile with contributor avatar
+  class Html
+    # default template building link to profile with contributor avatar
+    DEFAULT_TEMPLATE = %q{%Q{<a href="#{data['html_url']}" title="#{login} - #{data['contributions']}"><img src="#{data['avatar_url']}" alt="#{login} - #{data['contributions']}"/></a>}}
+
+    # access to the template used to generate content
+    attr_accessor :template
+
+    # create the generator object
+    # @option template [String] the template to use, if not given default will be used
+    def initialize(options = {})
+      @template = options[:template] || DEFAULT_TEMPLATE
+    end
+
+    # format user data using template
+    # @param login [String] user name
+    # @param data [Hash] user data
+    # @return [String]
+    def format(login, data)
+      eval(template)
+    end
+
+  end
+end

data/lib/plugins/contributors_stats/reader/gh_org.rb

@@ -0,0 +1,21 @@
+require 'contributors_stats/json_helper'
+
+class ContributorsStats::Reader
+
+  # Plugin to load contributions from Github organization
+  class GhOrg
+    extend ContributorsStats::JsonHelper
+
+    # load contributions for Github organization
+    # param name [String] name of the organization to load
+    # return [Array] loaded conributors data
+    def self.load(name)
+      load_json(url_builder("orgs/#{name}/repos")).map{ |repo|
+        data = load_json(repo['contributors_url'])
+        yield(data, "#{name}/#{repo['name']}") if block_given?
+        data
+      }.inject(&:+)
+    end
+
+  end
+end

data/lib/plugins/contributors_stats/reader/gh_repo.rb

@@ -0,0 +1,19 @@
+require 'contributors_stats/json_helper'
+
+class ContributorsStats::Reader
+
+  # Plugin to load contributions from Github repository
+  class GhRepo
+    extend ContributorsStats::JsonHelper
+
+    # load contributions for Github repository
+    # param name [String] name of the repository to load
+    # return [Array] loaded conributors data
+    def self.load(name)
+      data = load_json(url_builder("repos/#{name}/contributors"))
+      yield(data, name) if block_given?
+      data
+    end
+
+  end
+end

data/lib/plugins/contributors_stats/updater/html.rb

@@ -0,0 +1,36 @@
+module ContributorsStats::Updater
+
+  # Update a target file with content
+  class Html
+    # Default search pattern
+    DEFAULT_SEARCH = /<span class="contributors">.*?<\/span>/m
+    # Default replace template
+    DEFAULT_REPLACE = %q{%Q{<span class="contributors">\n#{replace_content.join("\n")}\n</span>}}
+
+    attr_accessor :search, :replace
+    attr_reader   :file_content, :replace_content
+
+    # check if given file is supported by this updater
+    def self.handles?(file)
+      %w{ .html .html.erb }.any?{|ext| file.end_with?(ext) }
+    end
+
+    # perform the content update
+    def self.update(file_content, replace_content, options = {})
+      new(file_content, replace_content, options).to_s
+    end
+
+    # set initial parameters, set default options
+    def initialize(file_content, replace_content, options = {})
+      @search  = options[:search]  || DEFAULT_SEARCH
+      @replace = options[:replace] || DEFAULT_REPLACE
+      @file_content    = file_content
+      @replace_content = replace_content
+    end
+
+    # perform the replace operation
+    def to_s
+      file_content.sub( search, eval(replace) )
+    end
+  end
+end

data/lib/plugins/contributors_stats/user_data/fetch.rb

@@ -0,0 +1,16 @@
+require 'contributors_stats/json_helper'
+
+module ContributorsStats::UserData
+
+  # fetch user data from github
+  class Fetch
+    extend ContributorsStats::JsonHelper
+
+    # fetch user data from github
+    def self.load(login, data, contributions)
+      user_data = load_json(data['url'])
+      user_data['contributions'] = contributions
+      user_data
+    end
+  end
+end

data/lib/plugins/contributors_stats/user_data/simple.rb

@@ -0,0 +1,23 @@
+module ContributorsStats::UserData
+
+  # fill in user data using minimal possible set of data
+  class Simple
+
+    # fill in user data using minimal possible set of data
+    def self.load(login, data, contributions)
+      {
+        'avatar_url'    => data['avatar_url'],
+        'name'          => login,
+        'url'           => data['url'],
+        'html_url'      => profile_url(login),
+        'contributions' => contributions
+      }
+    end
+    # build github profile url for the given user name
+    # @param username [String]
+    # @return [String] github profile url
+    def self.profile_url(username)
+      "https://github.com/#{username}"
+    end
+  end
+end

data/test/contributors_stats/base_test.rb

@@ -0,0 +1,36 @@
+require 'test_helper'
+require 'contributors_stats/base'
+
+describe ContributorsStats::Base do
+  before do
+    @tester = ContributorsStats::Base
+  end
+
+  it "logs messages" do
+    tester = @tester.new
+    tester.logger = ContributorsStats::ArrayLoggerExample.new
+    tester.send(:log, 'something')
+    tester.send(:log, 'nothing')
+    tester.logger.data.must_equal(['something', 'nothing'])
+  end
+
+  it "loads plugins" do
+    plugins = @tester.new.send(:plugins)
+    plugins.must_be_kind_of(Pluginator::Group)
+    plugins.types.size.must_be(:>=, 4)
+    plugins.first_class('formatter', 'html').wont_be_nil
+  end
+
+  it "filters options" do
+    example_input = {
+      :gh_org => "railsisntaller",
+      :nothing => "name",
+    }
+    example_output = {
+      :gh_org => "railsisntaller"
+    }
+    plugins = @tester.new(example_input).send(:filter_options, 'reader')
+    plugins.must_equal(example_output)
+  end
+
+end

data/test/contributors_stats/calculator_test.rb

@@ -0,0 +1,70 @@
+require 'test_helper'
+require 'contributors_stats/calculator'
+
+describe ContributorsStats::Calculator do
+  before do
+    @tester = ContributorsStats::Calculator
+  end
+
+  it "initializes user_data_type" do
+    tester = @tester.new(:user_data => :fetch)
+    tester.user_data_type.must_equal(:fetch)
+  end
+
+  it "calculates contributions" do
+    tester = @tester.new
+    tester.send(:contributions, [{"contributions" => 2}, {"contributions" => 3}]).must_equal(5)
+  end
+
+  it "calculates user_data" do
+    data = [
+      {"contributions" => 2, "url" => "users/mpapis.json", "avatar_url" => "mpapis-avatar.jpg"},
+      {"contributions" => 4},
+    ]
+    expected = {
+      "avatar_url"=>"mpapis-avatar.jpg",
+      "name"=>"mpapis",
+      "url"=>"users/mpapis.json",
+      "html_url"=>"https://github.com/mpapis",
+      "contributions"=>6
+    }
+    tester = @tester.new
+    tester.send(:configure_path, File.expand_path("../../fixtures-gh", __FILE__), ".json")
+    result = tester.send(:user_data, "mpapis", data)
+    result.must_equal(expected)
+  end
+
+  it "calculates data" do
+    raw_data = [
+      {"login" => "mpapis", "contributions" => 2, "url" => "users/mpapis.json", "avatar_url" => "mpapis-avatar.jpg"},
+      {"login" => "mpapis", "contributions" => 5},
+    ]
+    expected = [["mpapis", {
+      "avatar_url"=>"mpapis-avatar.jpg",
+      "name"=>"mpapis",
+      "url"=>"users/mpapis.json",
+      "html_url"=>"https://github.com/mpapis",
+      "contributions"=>7
+    } ]]
+    tester = @tester.new
+    tester.logger = ContributorsStats::ArrayLoggerExample.new
+    tester.send(:configure_path, File.expand_path("../../fixtures-gh", __FILE__), ".json")
+    tester.instance_variable_set(:@raw_data, raw_data)
+    tester.send(:calculated_data)
+    tester.data.must_equal(expected)
+  end
+
+  it "invokes formatter" do
+    data = [["mpapis", {
+      "avatar_url"=>"mpapis-avatar.jpg",
+      "name"=>"mpapis",
+      "url"=>"users/mpapis.json",
+      "html_url"=>"https://github.com/mpapis",
+      "contributions"=>7
+    }]]
+    tester = @tester.new
+    tester.instance_variable_set(:@data, data)
+    tester.format.kind_of?(ContributorsStats::Formatter).must_equal(true)
+  end
+
+end

data/test/contributors_stats/formatter_test.rb

@@ -0,0 +1,77 @@
+require 'test_helper'
+require 'contributors_stats/formatter'
+
+def with_temp_file(name: 'contributors_stats', extension: "")
+  file = Tempfile.new([name, extension])
+  begin
+     yield file if block_given?
+  ensure
+     file.close
+     file.unlink
+  end
+end
+
+describe ContributorsStats::Formatter do
+  before do
+    @tester = ContributorsStats::Formatter
+    @example_content = [
+      "<a href=\"https://github.com/mpapis\" title=\"mpapis - 7\"><img src=\"mpapis-avatar.jpg\" alt=\"mpapis - 7\"/></a>"
+    ]
+  end
+
+  it "loads plugins" do
+    plugins = @tester.allocate.send(:plugins)
+    plugins.must_be_kind_of(Pluginator::Group)
+    plugins.types.size.must_be(:>=, 4)
+    plugins.first_class('updater', 'html').wont_be_nil
+  end
+
+  it "invokes formatter" do
+    data = [["mpapis", {
+      "avatar_url"=>"mpapis-avatar.jpg",
+      "name"=>"mpapis",
+      "url"=>"users/mpapis.json",
+      "html_url"=>"https://github.com/mpapis",
+      "contributions"=>7
+    }]]
+    tester = @tester.new(data, :html)
+    tester.content.must_equal(@example_content)
+  end
+
+  it "saves to file" do
+    with_temp_file do |file|
+      tester = @tester.allocate
+      tester.instance_variable_set(:@content, @example_content)
+      tester.save(file.path)
+      file.readlines.must_equal(@example_content)
+    end
+  end
+
+  it "updates files - internal" do
+    with_temp_file do |file|
+      tester = @tester.allocate
+      File.open(file.path, "w") {|f| f.write("anything") }
+      tester.send(:update_file, file.path) do |text|
+        text.gsub(/a/, "b")
+      end
+      File.read(file.path).must_equal("bnything")
+    end
+  end
+
+  it "updates files - with plugins" do
+    content_start = %q{<body><span class="contributors">}
+    content_end   = %q{</span></body>}
+    with_temp_file(extension: ".html") do |file|
+      tester = @tester.allocate
+      File.open(file.path, "w") {|f| f.write("#{content_start}#{content_end}\n") }
+      tester.instance_variable_set(:@content, @example_content)
+      tester.update(file.path)
+      File.read(file.path).must_equal(<<-EXPECTED)
+#{content_start}
+#{@example_content * "\n"}
+#{content_end}
+EXPECTED
+    end
+  end
+
+end

data/test/contributors_stats/json_helper_test.rb

@@ -0,0 +1,76 @@
+require 'test_helper'
+require 'contributors_stats/json_helper'
+
+class ContributorsStats::JsonHelperTester
+  include ContributorsStats::JsonHelper
+end
+
+describe ContributorsStats::JsonHelper do
+  before do
+    @tester = ContributorsStats::JsonHelperTester.new
+  end
+
+  it "sets default prefix" do
+    @tester.path_prefix.must_equal("https://api.github.com/")
+  end
+
+  it "uses given prefix and ads /" do
+    @tester.send(:configure_path, "test_me", ".json")
+    @tester.path_prefix.must_equal("test_me/")
+  end
+
+  it "sets default suffix" do
+    @tester.path_suffix.must_equal("")
+  end
+
+  it "uses given suffix and ads ." do
+    @tester.send(:configure_path, "test_me", "json")
+    @tester.path_suffix.must_equal(".json")
+  end
+
+  it "builds url" do
+    @tester.url_builder("anything").must_equal("https://api.github.com/anything")
+  end
+
+  it "builds custom url" do
+    @tester.send(:configure_path, "test_me", "json")
+    @tester.url_builder("anything").must_equal("test_me/anything.json")
+  end
+
+  describe ".load_json" do
+    it "loads json from full path" do
+      example = File.expand_path("../../fixtures-gh/users/mpapis.json", __FILE__)
+      result = @tester.load_json(example)
+      result["id"].must_equal(48054)
+      result["gravatar_id"].must_equal("3ec52ed58eb92026d86e62c39bdb7589")
+    end
+
+    it "loads json from partial path" do
+      @tester.send(:configure_path, File.expand_path("../../fixtures-gh", __FILE__), "json")
+      result = @tester.load_json("users/mpapis.json")
+      result["id"].must_equal(48054)
+      result["gravatar_id"].must_equal("3ec52ed58eb92026d86e62c39bdb7589")
+    end
+
+    it "loads json from minimal path" do
+      @tester.send(:configure_path, File.expand_path("../../fixtures-gh", __FILE__), "json")
+      result = @tester.load_json("users/mpapis")
+      result["id"].must_equal(48054)
+      result["gravatar_id"].must_equal("3ec52ed58eb92026d86e62c39bdb7589")
+    end
+
+    it "does not loads json for missing URL" do
+      lambda {
+        @tester.load_json("https://api.github.com/mpapis/nonexisting/")
+      }.must_raise(OpenURI::HTTPError)
+    end
+
+    it "does not loads json for broken path" do
+      @tester.send(:configure_path, File.expand_path("../../fixtures-gh", __FILE__), "json")
+      lambda {
+        @tester.load_json("nonexisting")
+      }.must_raise(Errno::ENOENT)
+    end
+  end
+
+end

data/test/contributors_stats/reader_test.rb

@@ -0,0 +1,59 @@
+require 'test_helper'
+require 'contributors_stats/reader'
+
+describe ContributorsStats::Reader do
+  before do
+    @tester = ContributorsStats::Reader
+  end
+
+  it "loads data using single plugin single source" do
+    tester = @tester.new
+    tester.logger = ContributorsStats::ArrayLoggerExample.new
+    tester.send(:configure_path, File.expand_path("../../fixtures-gh", __FILE__), ".json")
+    tester.load(:gh_repo, "railsinstaller/website")
+    tester.raw_data.size.must_equal(10)
+  end
+
+  it "produces logs" do
+    tester = @tester.new
+    tester.logger = ContributorsStats::ArrayLoggerExample.new
+    tester.send(:configure_path, File.expand_path("../../fixtures-gh", __FILE__), ".json")
+    tester.load(:gh_org, "railsinstaller")
+    tester.logger.data.size.must_equal(3)
+  end
+
+  it "loads data using single plugin multiple sources" do
+    tester = @tester.new
+    tester.logger = ContributorsStats::ArrayLoggerExample.new
+    tester.send(:configure_path, File.expand_path("../../fixtures-gh", __FILE__), ".json")
+    tester.load(:gh_repo, "railsinstaller/website")
+    tester.load(:gh_repo, "railsinstaller/railsinstaller-nix")
+    tester.raw_data.size.must_equal(12)
+  end
+
+  it "loads data using single plugin array of sources (single) - privately" do
+    tester = @tester.new
+    tester.logger = ContributorsStats::ArrayLoggerExample.new
+    tester.send(:configure_path, File.expand_path("../../fixtures-gh", __FILE__), ".json")
+    tester.send(:parse_readers, gh_repo: "railsinstaller/website")
+    tester.raw_data.size.must_equal(10)
+  end
+
+  it "loads data using single plugin array of sources (multiple) - privately" do
+    tester = @tester.new
+    tester.logger = ContributorsStats::ArrayLoggerExample.new
+    tester.send(:configure_path, File.expand_path("../../fixtures-gh", __FILE__), ".json")
+    tester.send(:parse_readers, gh_repo: ["railsinstaller/website", "railsinstaller/railsinstaller-nix"])
+    tester.raw_data.size.must_equal(12)
+  end
+
+  it "loads data using single plugin array of sources" do
+    tester = @tester.new(
+      :configure_path => [File.expand_path("../../fixtures-gh", __FILE__), ".json"],
+      :logger => ContributorsStats::ArrayLoggerExample.new,
+      :gh_repo => "railsinstaller/railsinstaller-nix"
+    )
+    tester.raw_data.size.must_equal(2)
+  end
+
+end