git_reporting 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 91b9f49ba3d2b69928b8dba4e18fbf53f8c9ef8d
+  data.tar.gz: 18e165d4fc7d5ca67f7a7e29fc5ae55c522d7ec3
+SHA512:
+  metadata.gz: c5f9c345e79db0b9af8e791efb652fc8b7a8938d32dbcc85b1e2768aa5d1cdc26eadca95a5dce39dc0ad4a8905a4a963a6d4302b47ef03453e92c8bdcfda771c
+  data.tar.gz: b4e7799f72df6ae9d125ed0f011fd0c4eb3f8d318a49e56de76a463243f06cc0583b192105e3f4f2ab4ce440eb41bf943d07c1842031ed0e035bcab3900043f7

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 bsboris
+
+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,12 @@
+# GitReporting
+
+[![Code Climate](https://codeclimate.com/github/bsboris/git_reporting/badges/gpa.svg)](https://codeclimate.com/github/bsboris/git_reporting)
+
+    reporter = GitReporting::Reporter.new(source: :github, login: "...", password: "...", repo: "my/repo")
+
+    reporter.build_report #=> simple report for all time
+    reporter.build_report(type: :timesheet) #=> report per user for all time
+    reporter.build_report(type: :timesheet, from: "2015-01-01", to: "2015-01-31") #=> report per user for given period
+    reporter.build_report(type: :timesheet, group: :week, from: "2015-01-01", to: "2015-01-31") #=> report per user for given period groupped by week
+
+More docs are coming.

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+end

data/git_reporting.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'git_reporting/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "git_reporting"
+  spec.version       = GitReporting::VERSION
+  spec.authors       = ["bsboris"]
+  spec.email         = ["bsboris@gmail.com"]
+
+  spec.summary       = %q{Git reporitng.}
+  spec.description   = %q{Git reporitng.}
+  spec.homepage      = "https://github.com/bsboris/git_reporting"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport", "~> 4.2"
+  spec.add_dependency "chronic_duration", "~> 0.10"
+  spec.add_dependency "octokit", "~> 4.0"
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "faker", "~> 1.4"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "vcr", "~> 2.9.3"
+  spec.add_development_dependency "webmock", "~> 1.21"
+end

data/lib/git_reporting.rb

@@ -0,0 +1,64 @@
+require "active_support"
+require "active_support/core_ext"
+require "git_reporting/version"
+require "git_reporting/commit"
+require "git_reporting/report"
+require "git_reporting/source"
+
+module GitReporting
+  def self.configure
+    yield(configuration) if block_given?
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.reset_configuration!
+    @configuration = Configuration.new
+  end
+
+  class Configuration
+    attr_accessor :prefix
+
+    def initialize
+      @prefix = nil
+    end
+  end
+
+  class Reporter
+    attr_reader :source
+
+    def initialize(source_options)
+      @source = case source_options
+      when Source then source_options
+      when Array then Source::Array.new(source_options)
+      when Hash then Source.from_options(source_options)
+      else
+        raise ArgumentError, "You should initialize GitReporting::Reporter with array, hash of source options or GitReporting::Source instance."
+      end
+    end
+
+    def build_report(options = {})
+      type = options[:type] || :simple
+      group = options[:group] || :none
+      from_time = options[:from].present? ? parse_time(options[:from]) : Time.at(0)
+      to_time = options[:to].present? ? parse_time(options[:to]) : Time.current
+
+      commits = source.fetch(from_time..to_time)
+
+      root = Report.new("Report")
+      root << Report::Group.const_get(group.to_s.capitalize).build(commits) do |group_commits|
+        Report::Type.const_get(type.to_s.capitalize).build(group_commits)
+      end
+    end
+
+    private
+
+    def parse_time(time)
+      DateTime.parse(time.to_s)
+    rescue ArgumentError
+      raise ArgumentError, "#{time} is not a valid date"
+    end
+  end
+end

data/lib/git_reporting/commit.rb

@@ -0,0 +1,26 @@
+require "git_reporting/message_parser"
+
+module GitReporting
+
+  class Commit
+    attr_accessor :sha, :author, :message, :time, :timestamp
+
+    def initialize(attrs = {})
+      @time = 0
+      attrs.each do |key, value|
+        send "#{key}=", value
+      end
+    end
+
+    def message=(value)
+      parsed = MessageParser.parse(value)
+      @message = parsed.first
+      @time = parsed.last if parsed.last.present?
+    end
+
+    def to_s
+      "Commit #{sha}"
+    end
+  end
+
+end

data/lib/git_reporting/message_parser.rb

@@ -0,0 +1,43 @@
+require "chronic_duration"
+
+module GitReporting
+  class MessageParser
+    attr_reader :input, :regexp
+
+    def self.parse(*args)
+      new(*args).parse
+    end
+
+    def initialize(input)
+      @input = input.to_s
+      prefix = GitReporting.configuration.prefix
+      @regexp = /\[\s*#{prefix && prefix + "\s*"}\s*(\d[^\[\]]*)\]/m
+    end
+
+    def parse
+      message = parse_message
+      time = parse_time
+      [message, time]
+    end
+
+    private
+
+    def parse_message
+      input.gsub(regexp, "").strip
+    end
+
+    def parse_time
+      times = input.scan(regexp)
+      time = if times[0]
+        times[0][0] # we want to take only first time marker
+      else
+        nil
+      end
+      return nil unless time.present?
+
+      time = "#{time}:00" if time =~ /^\d{1,2}:\d{1,2}$/
+
+      ChronicDuration.parse(time, keep_zero: true)
+    end
+  end
+end

data/lib/git_reporting/report.rb

@@ -0,0 +1,61 @@
+require "git_reporting/report/commit"
+require "git_reporting/report/type"
+require "git_reporting/report/group"
+
+module GitReporting
+  class Report
+    attr_reader :key, :children
+
+    def self.new_from_collection(collection)
+      raise ArgumentError, "#{collection.inspect} is not a collection" unless collection.respond_to?(:each)
+
+      collection.map { |item| new(item) }
+    end
+
+    def self.build(commits)
+      hash = Hash.new { |h, k| h[k] = [] }
+      commits.each { |commit| hash[key_for_commit(commit)] << commit }
+      hash.map do |key, commits|
+        new(key) << (block_given? ? yield(commits) : Commit.new_from_collection(commits))
+      end
+    end
+
+    def self.key_for_commit(commit)
+      nil
+    end
+
+    def initialize(key = nil)
+      @key = key
+      @children = []
+    end
+
+    def append_child(child)
+      if child.respond_to?(:each)
+        child.each { |c| self.append_child(c) }
+      else
+        raise ArgumentError, "Attempting to add a nil node" unless child
+        raise ArgumentError, "Only Report and its descendants can be added as a children" unless child.is_a?(Report)
+        raise ArgumentError, "Attempting add node to itself" if self.equal?(child)
+
+        children << child
+      end
+      self
+    end
+    alias << append_child
+
+    def time
+      @time ||= children.inject(0) { |time, child| time + child.time }
+    end
+
+    def to_s
+      "#{self.class.name} : #{key} : #{time}"
+    end
+
+    def print
+      puts to_s
+      children.each do |child|
+        child.print
+      end
+    end
+  end
+end

data/lib/git_reporting/report/commit.rb

@@ -0,0 +1,11 @@
+module GitReporting
+  class Report
+
+    class Commit < Report
+      def time
+        key.time
+      end
+    end
+
+  end
+end

data/lib/git_reporting/report/group.rb

@@ -0,0 +1,37 @@
+module GitReporting
+  class Report
+
+    module Group
+      class Base < Report
+      end
+
+      class None < Base
+      end
+
+      class Day < Base
+        def self.key_for_commit(commit)
+          commit.timestamp.to_date
+        end
+      end
+
+      class Week < Base
+        def self.key_for_commit(commit)
+          commit.timestamp.beginning_of_week
+        end
+      end
+
+      class Month < Base
+        def self.key_for_commit(commit)
+          commit.timestamp.beginning_of_month
+        end
+      end
+
+      class Year < Base
+        def self.key_for_commit(commit)
+          commit.timestamp.beginning_of_year
+        end
+      end
+    end
+
+  end
+end

data/lib/git_reporting/report/type.rb

@@ -0,0 +1,19 @@
+module GitReporting
+  class Report
+
+    module Type
+      class Base < Report
+      end
+
+      class Simple < Base
+      end
+
+      class Timesheet < Base
+        def self.key_for_commit(commit)
+          commit.author
+        end
+      end
+    end
+
+  end
+end

data/lib/git_reporting/source.rb

@@ -0,0 +1,11 @@
+require "git_reporting/source/array"
+require "git_reporting/source/github"
+
+module GitReporting
+  module Source
+    def self.from_options(options = {})
+      source = options.delete(:source)
+      const_get(source.to_s.capitalize).new(options)
+    end
+  end
+end

data/lib/git_reporting/source/array.rb

@@ -0,0 +1,32 @@
+module GitReporting
+  module Source
+
+    class Array
+      attr_reader :commits
+
+      def initialize(commits_array)
+        @commits = extract_commits_from_array(commits_array)
+        sort_commits!
+      end
+
+      def fetch(period)
+        commits.select { |commit| period === commit.timestamp }
+      end
+
+      def fetch_all
+        commits
+      end
+
+      private
+
+      def extract_commits_from_array(commits_array)
+        commits_array.map { |commit_hash| Commit.new(commit_hash) }
+      end
+
+      def sort_commits!
+        @commits = @commits.sort_by { |commit| commit.timestamp }
+      end
+    end
+
+  end
+end

data/lib/git_reporting/source/github.rb

@@ -0,0 +1,41 @@
+require "octokit"
+
+module GitReporting
+  module Source
+
+    class Github
+      attr_reader :client, :repo, :branch
+
+      def initialize(options = {})
+        if options[:repo]
+          @repo = options.delete(:repo)
+        else
+          raise ArgumentError, "You must specify repo for GitHub source"
+        end
+        @branch = options.delete(:branch) || :master
+        options[:auto_paginate] ||= true
+        @client = Octokit::Client.new(options)
+      end
+
+      def fetch_all
+        extract_commits_from_array client.commits(repo, branch)
+      end
+
+      def fetch(period)
+        extract_commits_from_array client.commits_between(repo, period.begin, period.end, sha: branch)
+      end
+
+      private
+
+      def extract_commits_from_array(commits_array)
+        commits_array.map do |data|
+          Commit.new sha: data.sha,
+                     author: data.author.login,
+                     message: data.commit.message,
+                     timestamp: data.commit.author.date
+        end
+      end
+    end
+
+  end
+end

data/lib/git_reporting/version.rb

@@ -0,0 +1,3 @@
+module GitReporting
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: git_reporting
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- bsboris
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: chronic_duration
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !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: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.9.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.9.3
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+description: Git reporitng.
+email:
+- bsboris@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- git_reporting.gemspec
+- lib/git_reporting.rb
+- lib/git_reporting/commit.rb
+- lib/git_reporting/message_parser.rb
+- lib/git_reporting/report.rb
+- lib/git_reporting/report/commit.rb
+- lib/git_reporting/report/group.rb
+- lib/git_reporting/report/type.rb
+- lib/git_reporting/source.rb
+- lib/git_reporting/source/array.rb
+- lib/git_reporting/source/github.rb
+- lib/git_reporting/version.rb
+homepage: https://github.com/bsboris/git_reporting
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Git reporitng.
+test_files: []