jetmeter 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 552f4e1368015da59b856cf64cb93ad98b571ffd
+  data.tar.gz: f1ed9aa5f81412a7581337c010a0d5ddddb69d0c
+SHA512:
+  metadata.gz: 144711bf099df07a7dc65e781bacd1436344428f5aa51f293fda266d8735f360174cc61f5048f63cf95f407fa6ace14f40cb6edc056ffe7c9ef6b6f0efbbbc31
+  data.tar.gz: '02394680fcb5c414938af6bab035f028c924fd6c9d39a7af0897ec3e8d55974e28183bf2479f541ae741a2ac769ce42a98f08ae37c314963393ae3ef522d487b'

data/bin/jetmeter

@@ -0,0 +1,5 @@
+#! /usr/bin/env ruby
+require 'jetmeter'
+
+config_path = File.expand_path(ARGV[0])
+Jetmeter::CLI.new(config_path).run

data/lib/jetmeter/cli.rb

@@ -0,0 +1,117 @@
+module Jetmeter
+  class CLI
+    CREDENTIAL_PATH = File.expand_path('~/.jetmeter/token').freeze
+    CACHE_PATH = File.expand_path('~/.jetmeter/cache').freeze
+
+    def initialize(config_path)
+      @config = eval(File.read(config_path))
+      prepare_cache
+      authenticate_user
+    end
+
+    def run
+      puts "Receiving issue events..."
+      repository_issue_events = Jetmeter::Collection.new(
+        Jetmeter::RepositoryIssueEventsLoader.new(@config).load,
+        Jetmeter::IssueEventAdapter
+      )
+
+      puts "Receiving issues..."
+      repository_issues = Jetmeter::Collection.new(
+        Jetmeter::RepositoryIssuesLoader.new(@config).load,
+        Jetmeter::IssueAdapter
+      )
+
+      accums = [
+        Jetmeter::OpenAccumulator.new,
+        Jetmeter::LabelAccumulator.new,
+        Jetmeter::LabelAccumulator.new(additive: false),
+        Jetmeter::CloseAccumulator.new,
+        Jetmeter::CloseAccumulator.new(additive: false),
+        Jetmeter::MergeAccumulator.new
+      ]
+      filters = [
+        Jetmeter::DateFilter.new,
+        Jetmeter::OpenFilter.new
+      ]
+
+      reducer = Jetmeter::FlowReducer.new(
+        [repository_issues, repository_issue_events],
+        @config
+      )
+
+      puts "Analyzing received data..."
+      reducer.reduce(accums, filters)
+
+      puts "Initializing CSV formatter..."
+      formatter = Jetmeter::CsvFormatter.new(@config, reducer)
+
+      puts "Saving CSV file..."
+      File.open(@config.output_path, 'wb') do |file|
+        formatter.save(file)
+        puts "Created CSV: #{@config.output_path}"
+      end
+    end
+
+    private
+
+    def authenticate_user
+      if access_token_stored? && access_token_readable?
+        @config.github_credentials = { access_token: File.read(CREDENTIAL_PATH) }
+      else
+        login, password = ask_credentials
+        @config.github_credentials = { login: login, password: password }
+
+        authorization = create_authorization
+        save_access_token(authorization.token)
+      end
+    end
+
+    def prepare_cache
+      FileUtils.mkdir_p CACHE_PATH
+      @config.cache_path = CACHE_PATH
+    end
+
+    def ask_credentials
+      puts "Your github login:"
+      login = STDIN.gets.chomp
+
+      puts "Your github password:"
+      password = STDIN.noecho(&:gets).chomp
+
+      [login, password]
+    end
+
+    def ask_two_factor
+      puts 'Enter 2-factor authentication token:'
+      STDIN.gets.chomp
+    end
+
+    def create_authorization
+      auth_note = "jetmeter for #{ENV['USER']}@#{ENV['HOSTNAME']}"
+      @config.client.create_authorization(
+        scopes: [:repo],
+        note: auth_note
+      )
+    rescue Octokit::OneTimePasswordRequired
+      @config.client.create_authorization(
+        scopes: [:repo],
+        note: auth_note,
+        headers: { 'X-GitHub-OTP' => ask_two_factor }
+      )
+    end
+
+    def save_access_token(token)
+      File.write(CREDENTIAL_PATH, token)
+      @config.github_credentials = { access_token: token }
+    end
+
+    def access_token_stored?
+      File.exist?(CREDENTIAL_PATH)
+    end
+
+    def access_token_readable?
+      File.readable?(CREDENTIAL_PATH)
+    end
+  end
+end

data/lib/jetmeter/close_accumulator.rb

@@ -0,0 +1,25 @@
+module Jetmeter
+  class CloseAccumulator
+    CLOSED_EVENT = 'closed'.freeze
+
+    attr_reader :additive
+
+    def initialize(additive: true)
+      @additive = additive
+    end
+
+    def valid?(event, flow)
+      event.issue_event? &&
+        event.event == CLOSED_EVENT &&
+        closing_transition?(flow)
+    end
+
+    private
+
+    def closing_transition?(flow)
+      flow.transitions(additive).any? do |from, to|
+        from.nil? && to.include?(:closed)
+      end
+    end
+  end
+end

data/lib/jetmeter/collection.rb

@@ -0,0 +1,7 @@
+module Jetmeter
+  class Collection < SimpleDelegator
+    def initialize(inner_collection, adapter_class)
+      super(inner_collection.map { |el| adapter_class.new(el) })
+    end
+  end
+end

data/lib/jetmeter/config/client_middleware.rb

@@ -0,0 +1,17 @@
+module Jetmeter
+  class Config
+    class ClientMiddleware
+      def self.build(cache_path)
+        raise ArgumentError unless cache_path
+
+        store = Jetmeter::Config::FileCacheStore.new(cache_path)
+
+        Faraday::RackBuilder.new do |builder|
+          builder.use Faraday::HttpCache, store: store, serializer: Marshal, shared_cache: false
+          builder.use Octokit::Response::RaiseError
+          builder.adapter Faraday.default_adapter
+        end
+      end
+    end
+  end
+end

data/lib/jetmeter/config/file_cache_store.rb

@@ -0,0 +1,39 @@
+module Jetmeter
+  class Config
+    class FileCacheStore
+      def initialize(root_path)
+        raise ArgumentError unless File.exist?(root_path)
+        raise ArgumentError unless File.directory?(root_path)
+        raise ArgumentError unless File.writable?(root_path)
+
+        @root_path = root_path
+      end
+
+      def read(key)
+        if readable?(key)
+          File.open(path(key)) { |f| Marshal.load(f) }
+        end
+      end
+
+      def write(key, value)
+        File.open(path(key), 'wb') { |f| Marshal.dump(value, f) }
+      end
+
+      def delete(key)
+        if File.exist?(path(key))
+          File.delete(path(key))
+        end
+      end
+
+      private
+
+      def path(key)
+        File.join(@root_path, Digest::MD5.hexdigest(key))
+      end
+
+      def readable?(key)
+        File.exist?(path(key)) && File.readable?(path(key))
+      end
+    end
+  end
+end

data/lib/jetmeter/config/flow.rb

@@ -0,0 +1,37 @@
+module Jetmeter
+  class Config
+    class Flow
+      attr_reader :additions
+      attr_reader :substractions
+      attr_accessor :filters
+      attr_writer :accumulative
+
+      def initialize
+        @additions = Hash.new { |hash, key| hash[key] = [] }
+        @substractions = Hash.new { |hash, key| hash[key] = [] }
+        @filters = {}
+        @accumulative = true
+      end
+
+      def register_addition(hash)
+        hash.each_pair do |key, value|
+          @additions[key] << value
+        end
+      end
+
+      def register_substraction(hash)
+        hash.each_pair do |key, value|
+          @substractions[key] << value
+        end
+      end
+
+      def transitions(additive)
+        additive ? additions : substractions
+      end
+
+      def accumulative?
+        !!@accumulative
+      end
+    end
+  end
+end

data/lib/jetmeter/config.rb

@@ -0,0 +1,37 @@
+module Jetmeter
+  class Config
+    attr_accessor :repository_name
+    attr_accessor :output_path
+    attr_reader :flows
+    attr_writer :cache_path
+
+    def initialize(api: Octokit::Client, middleware: Jetmeter::Config::ClientMiddleware)
+      raise ArgumentError unless block_given?
+
+      @api = api
+      @middleware = middleware
+      @flows = {}
+      @cache_path = nil
+
+      yield self
+    end
+
+    def github_credentials=(credentials)
+      @github_credentials = credentials
+      @_client = nil
+    end
+
+    def client
+      @_client ||= begin
+        client = @api.new(@github_credentials)
+        client.auto_paginate = true
+        client.middleware = @middleware.build(@cache_path) if @cache_path
+        client
+      end
+    end
+
+    def register_flow(flow_name, &block)
+      @flows[flow_name] = Jetmeter::Config::Flow.new.tap(&block)
+    end
+  end
+end

data/lib/jetmeter/csv_formatter.rb

@@ -0,0 +1,46 @@
+module Jetmeter
+  class CsvFormatter
+    def initialize(config, reducer)
+      @config = config
+      @reducer = reducer
+      @commulative = Hash.new { |hash, flow| hash[flow] = Set.new }
+      @dates = @reducer.flows.values.map(&:keys).flatten
+    end
+
+    def save(io)
+      csv = CSV.new(io)
+      render_header(csv)
+      render_rows(csv)
+    end
+
+    private
+
+    def render_header(csv)
+      csv << ['Date'] + @config.flows.keys
+    end
+
+    def render_rows(csv)
+      return if @dates.empty?
+
+      (@dates.min..@dates.max).each do |date|
+        accumulative_flow_names = []
+
+        @config.flows.each_pair do |flow_name, flow_config|
+          issues = Set.new(@reducer.flows[flow_name][date])
+
+          @commulative[flow_name] |= issues
+
+          accumulative_flow_names.each do |accumulative_flow_name|
+            @commulative[accumulative_flow_name] |= issues
+          end
+
+          if flow_config.accumulative?
+            accumulative_flow_names.push(flow_name)
+          end
+        end
+
+        csv << [date.iso8601] + @commulative.values.map(&:size)
+      end
+    end
+  end
+end

data/lib/jetmeter/date_filter.rb

@@ -0,0 +1,7 @@
+module Jetmeter
+  class DateFilter
+    def apply?(resource, flow)
+      flow.filters.key?(:start_at) && resource.created_at < flow.filters[:start_at]
+    end
+  end
+end

data/lib/jetmeter/flow_reducer.rb

@@ -0,0 +1,43 @@
+module Jetmeter
+  class FlowReducer
+    attr_reader :flows
+
+    def initialize(resource_collections, config)
+      @resource_collections = resource_collections
+      @config_flows = config.flows
+      @flows = Hash.new do |hash, flow_name|
+        hash[flow_name] = Hash.new { |flow, date| flow[date] = [] }
+      end
+    end
+
+    def reduce(accumulators, filters)
+      @resource_collections.each do |resource_collection|
+        resource_collection.each do |resource|
+          reduce_resource(resource, accumulators, filters)
+        end
+      end
+    end
+
+    private
+
+    def reduce_resource(resource, accumulators, filters)
+      @config_flows.each_pair do |flow_name, flow_config|
+        next if filters.any? { |filter| filter.apply?(resource, flow_config) }
+
+        accumulators.each do |accumulator|
+          if accumulator.valid?(resource, flow_config)
+            apply_accumulator(resource, accumulator, flow_name)
+          end
+        end
+      end
+    end
+
+    def apply_accumulator(resource, accumulator, flow_name)
+      if accumulator.additive
+        @flows[flow_name][resource.flow_date].push(resource.issue_number)
+      else
+        @flows[flow_name][resource.flow_date].delete(resource.issue_number)
+      end
+    end
+  end
+end

data/lib/jetmeter/issue_adapter.rb

@@ -0,0 +1,17 @@
+require 'jetmeter/resource_adapter'
+
+module Jetmeter
+  class IssueAdapter < ResourceAdapter
+    def issue?
+      true
+    end
+
+    def flow_date
+      created_at.to_date
+    end
+
+    def issue_number
+      number
+    end
+  end
+end

data/lib/jetmeter/issue_event_adapter.rb

@@ -0,0 +1,17 @@
+require 'jetmeter/resource_adapter'
+
+module Jetmeter
+  class IssueEventAdapter < ResourceAdapter
+    def issue_event?
+      true
+    end
+
+    def flow_date
+      created_at.to_date
+    end
+
+    def issue_number
+      issue[:number]
+    end
+  end
+end

data/lib/jetmeter/label_accumulator.rb

@@ -0,0 +1,64 @@
+module Jetmeter
+  class LabelAccumulator
+    LABELED_EVENT = 'labeled'.freeze
+    UNLABELED_EVENT = 'unlabeled'.freeze
+    CORRESPONDING_EVENTS_LIMIT = 15
+    MAX_LABEL_CHANGE_TIME = 60
+
+    attr_reader :additive
+
+    def initialize(additive: true)
+      @corresponding_events = { LABELED_EVENT => [], UNLABELED_EVENT => [] }
+      @additive = additive
+    end
+
+    def valid?(event, flow)
+      return false unless event.issue_event?
+
+      store_corresponding_event(event)
+      labeling_transition?(flow, event) || unlabeling_transition?(flow, event)
+    end
+
+    private
+
+    def labeling_transition?(flow, event)
+      if event.event == LABELED_EVENT
+        flow.transitions(additive).any? do |from, to|
+          to.include?(event.label[:name]) && from.nil? || corresponding_event?(event, from)
+        end
+      end
+    end
+
+    def unlabeling_transition?(flow, event)
+      if event.event == UNLABELED_EVENT
+        flow.transitions(additive).any? do |from, to|
+          from == event.label[:name] && to.any? { |label| label.nil? || corresponding_event?(event, label) }
+        end
+      end
+    end
+
+    def store_corresponding_event(event)
+      return unless [LABELED_EVENT, UNLABELED_EVENT].include?(event.event)
+
+      @corresponding_events[event.event].push(event)
+      if @corresponding_events[event.event].length > CORRESPONDING_EVENTS_LIMIT
+        @corresponding_events[event.event].shift
+      end
+    end
+
+    def corresponding_event?(event, label)
+      corresponding_type = event.event == LABELED_EVENT ? UNLABELED_EVENT : LABELED_EVENT
+
+      @corresponding_events[corresponding_type].any? do |corresponding|
+        corresponding.label[:name] == label &&
+          corresponding.issue[:number] == event.issue[:number] &&
+          near?(corresponding, event)
+      end
+    end
+
+    def near?(first, second)
+      diff = (first.created_at.to_time - second.created_at.to_time).abs
+      diff < MAX_LABEL_CHANGE_TIME
+    end
+  end
+end

data/lib/jetmeter/merge_accumulator.rb

@@ -0,0 +1,23 @@
+module Jetmeter
+  class MergeAccumulator
+    MERGED_EVENT = 'merged'.freeze
+
+    def valid?(event, flow)
+      event.issue_event? &&
+        event.event == MERGED_EVENT &&
+        merging_transition?(flow)
+    end
+
+    def additive
+      true
+    end
+
+    private
+
+    def merging_transition?(flow)
+      flow.transitions(additive).any? do |from, to|
+        from.nil? && to.include?(:merged)
+      end
+    end
+  end
+end

data/lib/jetmeter/open_accumulator.rb

@@ -0,0 +1,27 @@
+module Jetmeter
+  class OpenAccumulator
+    def valid?(resource, flow)
+      resource.issue? &&
+        opening_transition?(flow) &&
+        open_or_finished?(resource)
+    end
+
+    def additive
+      true
+    end
+
+    private
+
+    def opening_transition?(flow)
+      if flow
+        flow.transitions(additive).any? do |from, to|
+          from.nil? && to.include?(:opened)
+        end
+      end
+    end
+
+    def open_or_finished?(issue)
+      issue[:closed_at].nil? || issue.key?(:pull_request)
+    end
+  end
+end

data/lib/jetmeter/open_filter.rb

@@ -0,0 +1,14 @@
+module Jetmeter
+  class OpenFilter
+    def apply?(resource, flow)
+      resource.issue? && flow.filters.key?(:open_at) && closed_at?(resource, flow)
+    end
+
+    private
+
+    def closed_at?(resource, flow)
+      resource.closed_at && resource.closed_at < flow.filters[:open_at]
+    end
+  end
+end
+

data/lib/jetmeter/repository_issue_events_loader.rb

@@ -0,0 +1,13 @@
+module Jetmeter
+  class RepositoryIssueEventsLoader
+    def initialize(config)
+      @repository_name = config.repository_name
+      @client = config.client
+    end
+
+    def load
+      return @events if defined?(@events)
+      @events = @client.repository_issue_events(@repository_name)
+    end
+  end
+end

data/lib/jetmeter/repository_issues_loader.rb

@@ -0,0 +1,13 @@
+module Jetmeter
+  class  RepositoryIssuesLoader
+    def initialize(config)
+      @repository_name = config.repository_name
+      @client = config.client
+    end
+
+    def load
+      return @issues if defined?(@issues)
+      @issues = @client.list_issues(@repository_name, state: 'all')
+    end
+  end
+end

data/lib/jetmeter/resource_adapter.rb

@@ -0,0 +1,19 @@
+module Jetmeter
+  class ResourceAdapter < SimpleDelegator
+    def issue?
+      false
+    end
+
+    def issue_event?
+      false
+    end
+
+    def flow_date
+      raise NotImplementedError
+    end
+
+    def issue_number
+      raise NotImplementedError
+    end
+  end
+end

data/lib/jetmeter/version.rb

@@ -0,0 +1,3 @@
+module Jetmeter
+  VERSION = '0.5.0'.freeze
+end

data/lib/jetmeter.rb

@@ -0,0 +1,28 @@
+module Jetmeter; end
+
+require 'octokit'
+require 'faraday-http-cache'
+
+require 'csv'
+require 'delegate'
+require 'io/console'
+require 'fileutils'
+
+require 'jetmeter/config'
+require 'jetmeter/config/flow'
+require 'jetmeter/config/client_middleware'
+require 'jetmeter/config/file_cache_store'
+require 'jetmeter/collection'
+require 'jetmeter/repository_issues_loader'
+require 'jetmeter/repository_issue_events_loader'
+require 'jetmeter/issue_adapter'
+require 'jetmeter/issue_event_adapter'
+require 'jetmeter/flow_reducer'
+require 'jetmeter/label_accumulator'
+require 'jetmeter/close_accumulator'
+require 'jetmeter/open_accumulator'
+require 'jetmeter/merge_accumulator'
+require 'jetmeter/date_filter'
+require 'jetmeter/open_filter'
+require 'jetmeter/csv_formatter'
+require 'jetmeter/cli'

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: jetmeter
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- Mark Volosiuk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: faraday-http-cache
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.10.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.10.2
+description: Jetmeter is a tool to analyze github repo activity
+email:
+- marchi.martius@gmail.com
+executables:
+- jetmeter
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/jetmeter
+- lib/jetmeter.rb
+- lib/jetmeter/cli.rb
+- lib/jetmeter/close_accumulator.rb
+- lib/jetmeter/collection.rb
+- lib/jetmeter/config.rb
+- lib/jetmeter/config/client_middleware.rb
+- lib/jetmeter/config/file_cache_store.rb
+- lib/jetmeter/config/flow.rb
+- lib/jetmeter/csv_formatter.rb
+- lib/jetmeter/date_filter.rb
+- lib/jetmeter/flow_reducer.rb
+- lib/jetmeter/issue_adapter.rb
+- lib/jetmeter/issue_event_adapter.rb
+- lib/jetmeter/label_accumulator.rb
+- lib/jetmeter/merge_accumulator.rb
+- lib/jetmeter/open_accumulator.rb
+- lib/jetmeter/open_filter.rb
+- lib/jetmeter/repository_issue_events_loader.rb
+- lib/jetmeter/repository_issues_loader.rb
+- lib/jetmeter/resource_adapter.rb
+- lib/jetmeter/version.rb
+homepage: 
+licenses:
+- BSD-2-Clause
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Analyze github repo - JT way
+test_files: []