twigg 0.0.1

data/lib/twigg/settings/dsl.rb

@@ -0,0 +1,144 @@
+require 'ostruct'
+
+module Twigg
+  class Settings
+    module DSL
+      # Hash subclass used as a book-keeping detail, which allows us to
+      # differentiate settings hashes from hashes used to construct namespaces.
+      class Namespace < Hash; end
+
+      module ClassMethods
+        attr_reader :overrides
+
+      private
+
+        def namespaces
+          @namespaces ||= []
+        end
+
+        # DSL method for declaring settings underneath a namespace.
+        #
+        # Example:
+        #
+        #   namespace :app do
+        #     setting :bind, default: '0.0.0.0'
+        #   end
+        #
+        def namespace(scope, &block)
+          namespaces.push scope
+          yield
+        ensure
+          namespaces.pop
+        end
+
+        # DSL method which is used to create a reader for the setting `name`. If
+        # the configuration file does not contain a value for the setting, return
+        # `options[:default]` from the `options` hash.
+        #
+        # A block maybe provided to do checking of the supplied value prior to
+        # returning; for an example, see the `repositories_directory` setting in
+        # this file.
+        #
+        # Note that this method doesn't actually create any readers; it merely
+        # records data about default values and validation which are then used at
+        # initialization time to override the readers provided by OpenStruct
+        # itself.
+        def setting(name, options = {}, &block)
+          options.merge!(block: block)
+          @overrides ||= {}
+
+          overrides = namespaces.inject(@overrides) do |overrides, namespace|
+            overrides[namespace] ||= Namespace.new
+          end
+
+          overrides[name] = options
+        end
+      end
+
+      module InstanceMethods
+      private
+
+        def initialize(hash = nil)
+          super
+          deep_open_structify!(self)
+          override_methods!(self, self.class.overrides)
+        end
+
+        # Recursively replace nested hash values with OpenStructs.
+        #
+        # This enables us to make nice calls like `Config.foo.bar` instead of
+        # the somewhat unsightly `Config.foo[:bar]`.
+        def deep_open_structify!(instance)
+          # call `to_a` here to avoid mutating the collection during iteration
+          instance.each_pair.to_a.each do |key, value|
+            if value.is_a?(Hash)
+              deep_open_structify!(instance.[]=(key, OpenStruct.new(value)))
+            end
+          end
+        end
+
+        # Recurses through the `overrides` hash, overriding OpenStruct-supplied
+        # methods with ones which handle defaults, perform validation, and memoize
+        # their results.
+        #
+        # The `overrides` hash itself is built up using the DSL as this class file
+        # is passed. This method is called at runtime, once the YAML file containing
+        # the configuration has been loaded from disk.
+        def override_methods!(instance, overrides, namespace = nil)
+          return unless overrides
+
+          overrides.each do |name, options|
+            if options.is_a?(Namespace)
+              process_namespace(instance, namespace, name, options) # recurses
+            else
+              define_getter(instance, namespace, name, options)
+            end
+          end
+        end
+
+        # Sets up the given `namespace` on `instance`, if not already set up,
+        # and (recursively) calls {#override_methods!} to set up `name`.
+        def process_namespace(instance, namespace, name, options)
+          nested = instance.[](name)
+
+          unless nested.is_a?(OpenStruct)
+            instance.[]=(name, nested = OpenStruct.new)
+          end
+
+          override_methods!(nested, options, name)
+        end
+
+        # Defines a getter on the `instance` for setting `name` within
+        # `namespace`.
+        #
+        # The getter:
+        #
+        #   - memoizes its result
+        #   - raises an ArgumentError if the option is required by not
+        #     configured
+        #   - supplies a default value if the option is not configured and a
+        #     default setting is available
+        #   - optionally calls a supplied block to perform validation of the
+        #     configured value
+        #
+        def define_getter(instance, namespace, name, options)
+          instance.define_singleton_method name do
+            value = instance_variable_get("@#{namespace}__#{name}")
+            return value if value
+
+            if options[:required] &&
+              !instance.each_pair.to_a.map(&:first).include?(name)
+              raise ArgumentError, "#{name} not set"
+            end
+
+            value = instance.[](name) || options[:default]
+
+            options[:block].call(name, value) if options[:block]
+
+            instance_variable_set("@#{namespace}__#{name}", value)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/twigg/settings.rb

@@ -0,0 +1,69 @@
+require 'ostruct'
+
+module Twigg
+  # Simple OpenStruct subclass with some methods overridden in order to provide
+  # more detailed feedback in the event of a misconfiguration, or to provide
+  # reasonable default values.
+  #
+  # For example, we override `repositories_directory` so that we can report to
+  # the user that:
+  #
+  #   - the setting is missing from the configuration file
+  #   - the setting does not point at a directory
+  #
+  # We override `app.bind` so that we can supply a reasonable default when the
+  # configuration file has no value set.
+  #
+  # In order to keep this class a simple and readable manifest of the different
+  # options, the real logic is all implemented in the {Twigg::Settings::DSL}
+  # module, leaving only the DSL declarations here.
+  class Settings < OpenStruct
+    autoload :DSL, 'twigg/settings/dsl'
+    extend   DSL::ClassMethods
+    include  DSL::InstanceMethods
+
+    namespace :app do
+      setting :bind,   default: '0.0.0.0'
+
+      namespace :gerrit do
+        setting :enabled, default: false
+      end
+    end
+
+    setting :default_days, default: 7
+
+    namespace :gerrit do
+      setting :host, default: 'localhost'
+      setting :port, default: 29418
+      setting :user, default: ENV['USER']
+
+      namespace :web do
+        setting :host,   default: 'https://localhost'
+      end
+
+      namespace :db do
+        setting :adapter,   default: 'mysql2'
+        setting :database,  required: true
+        setting :host,      default: 'localhost'
+        setting :password
+        setting :port,      default: 3306
+        setting :user,      default: ENV['USER']
+      end
+    end
+
+    namespace :github do
+      setting :organization, required: true
+      setting :token,        required: true
+    end
+
+    setting :repositories_directory, required: true do |name, value|
+      raise ArgumentError, "#{name} not a directory" unless File.directory?(value)
+    end
+
+    setting :teams, default: {} do |name, value|
+      if !value.respond_to?(:to_h) || value.to_h.values.any? { |team| !team.is_a?(Array) }
+        raise ArgumentError, "#{name} should be a hash of arrays"
+      end
+    end
+  end
+end

data/lib/twigg/team.rb

@@ -0,0 +1,25 @@
+module Twigg
+  class Team
+    # Catch-all team name for authors who aren't assigned to a particular team.
+    OTHER_TEAM_NAME = 'Other'
+
+    class << self
+      # Returns a hash where the keys are author names and the values are team
+      # names.
+      #
+      # As there is only one value per key, an author must be in one team only;
+      # if the author is assigned to multiple teams, this method will pick the
+      # first team the author is assigned to as his or her team.
+      def author_to_team_map
+        Config.
+          teams.
+          each_pair.
+          each_with_object(Hash.new(OTHER_TEAM_NAME)) do |(team, members), map|
+          members.each do |member|
+            map[member] = team.to_s unless map.has_key?(member)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/twigg/util.rb

@@ -0,0 +1,68 @@
+module Twigg
+  module Util
+  private
+
+    # Returns the age of `time` relative to now in hours (for short intervals)
+    # or days (for intervals longer than 24 hours).
+    def age(time)
+      delta = Time.now - time
+      return 'future' if delta < 0
+      hours = (delta / (60 * 60)).to_i
+      days = hours / 24
+      (hours > 24 ? "#{pluralize days, 'day'}" : "#{pluralize hours, 'hour'}") +
+        ' ago'
+    end
+
+    def number_with_delimiter(integer)
+      # Regex based on one in `ActiveSupport::NumberHelper#number_to_delimited`;
+      # this method is simpler because it only needs to handle integers.
+      integer.to_s.tap do |string|
+        string.gsub!(/(\d)(?=(\d{3})+(?!\d))/, '\\1,')
+      end
+    end
+
+    # Dumb implementation of a Rails-style `#pluralize` helper.
+    #
+    # As a default, it pluralizes by adding an "s" to the singular form, and
+    # will use `#number_with_delimiter` to insert delimiters, unless passed
+    # `delimit: false`.
+    #
+    # If you pass a plural inflection, it is remembered for subsequent calls.
+    #
+    # Example:
+    #
+    #   pluralize(1, 'octopus', 'octopi')          # => "1 octopus"
+    #   pluralize(2, 'octopus')                    # => "2 octopi"
+    #   pluralize(1_200, 'commit')                 # => "1,200 commits"
+    #   pluralize(1_200, 'commit', delimit: false) # => "1200 commits"
+    #
+    def pluralize(count, singular, plural = nil, delimit: true)
+      @inflections ||= Hash.new do |hash, key|
+        hash[key] = [key, plural ? plural : key + 's']
+      end
+
+      (delimit ? number_with_delimiter(count) : count.to_s) + ' ' +
+        @inflections[singular][count == 1 ? 0 : 1]
+    end
+
+    # Returns a per-repo breakdown (repo names, commit counts) of commits in
+    # `commit_set`.
+    #
+    # Returns HTML output by default, or plain-text when `html` is `false`.
+    def breakdown(commit_set, html: true)
+      commit_set.count_by_repo.map do |data|
+        if html && (link = data[:repo].link)
+          name = %{<a href="#{link}">#{data[:repo].name}</a>}
+        else
+          name = data[:repo].name
+        end
+
+        if html
+          "<i>#{name}:</i> <b>#{number_with_delimiter data[:count]}</b>"
+        else
+          "#{name}: #{number_with_delimiter data[:count]}"
+        end
+      end.join(', ')
+    end
+  end
+end

data/lib/twigg/version.rb

@@ -0,0 +1,3 @@
+module Twigg
+  VERSION = '0.0.1'
+end

data/lib/twigg.rb

@@ -0,0 +1,26 @@
+require 'pathname'
+
+module Twigg
+  autoload :Command,      'twigg/command'
+  autoload :Commit,       'twigg/commit'
+  autoload :CommitSet,    'twigg/commit_set'
+  autoload :Config,       'twigg/config'
+  autoload :Console,      'twigg/console'
+  autoload :Dependency,   'twigg/dependency'
+  autoload :Flesch,       'twigg/flesch'
+  autoload :Gatherer,     'twigg/gatherer'
+  autoload :PairMatrix,   'twigg/pair_matrix'
+  autoload :Repo,         'twigg/repo'
+  autoload :RepoSet,      'twigg/repo_set'
+  autoload :RussianNovel, 'twigg/russian_novel'
+  autoload :Settings,     'twigg/settings'
+  autoload :Team,         'twigg/team'
+  autoload :Util,         'twigg/util'
+  autoload :VERSION,      'twigg/version'
+
+  # Returns a Pathname instance corresponding to the root directory of the gem
+  # (ie. the directory containing the `files` and `templates` directories).
+  def self.root
+    Pathname.new(__dir__) + '..'
+  end
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: twigg
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Causes Engineering
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Twigg provides stats for activity in Git repositories.
+email:
+- eng@causes.com
+executables:
+- twigg
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/twigg
+- files/github.pem
+- lib/twigg/command/git.rb
+- lib/twigg/command/git_host.rb
+- lib/twigg/command/git_hub.rb
+- lib/twigg/command/help.rb
+- lib/twigg/command/init.rb
+- lib/twigg/command/russian.rb
+- lib/twigg/command/stats.rb
+- lib/twigg/command.rb
+- lib/twigg/commit.rb
+- lib/twigg/commit_set.rb
+- lib/twigg/config.rb
+- lib/twigg/console.rb
+- lib/twigg/dependency.rb
+- lib/twigg/flesch.rb
+- lib/twigg/gatherer.rb
+- lib/twigg/pair_matrix.rb
+- lib/twigg/repo.rb
+- lib/twigg/repo_set.rb
+- lib/twigg/russian_novel.rb
+- lib/twigg/settings/dsl.rb
+- lib/twigg/settings.rb
+- lib/twigg/team.rb
+- lib/twigg/util.rb
+- lib/twigg/version.rb
+- lib/twigg.rb
+homepage: https://github.com/causes/twigg
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Statistics for Git repositories
+test_files: []