twigg 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d4acbfc3dab81cc46307e04748ccc89ade34cac2
-  data.tar.gz: 13e6267f6bd29a0f84ddbcf7fd7110a7fd1806bd
+  metadata.gz: 282331adcc35a06bb23a3691d527af21569d18f4
+  data.tar.gz: 786b7007f4e5a6391eb8bb16b3bc28f9a7a03ff4
 SHA512:
-  metadata.gz: 37d68f4ad72e96ae993e614e362ac5a5d2fd323d68724558970687ba3bab3a0d5b330d0b707744c98d99ae32ad967cfebdcf9d965510a66ae3ce638c69a23ba9
-  data.tar.gz: b912766a33db3431a3a07d479b1cf831f01ba461555ba36a2956bc236d7f55aa9a997284b9b4f1312bc41961f19cc9076a211ad9c119151a6cf655c212058be6
+  metadata.gz: 994087ede63df1cff19699ea8da0690ef4ad5f7fc7f939cf022a31ab5673cba565db42904483a68594e03bd8585adf8c518fba8e4c8573c7735a5128dc092f59
+  data.tar.gz: d79c58a57e7dcad78881604de48505e144423096434c714bfcb626418b07fd5c3cbd5a7991ba05983335ee2b59408b70514a6690ba623f331b1a347e41872839

data/lib/twigg/cacher.rb

@@ -24,7 +24,7 @@ module Twigg
       #
       # Note: if a `nil` or `false` value is ever stored in the cache, this
       # method will consider any lookup of the corresponding key to be a miss,
-      # because we employ a simply truthiness check to determine presence.
+      # because we employ a simple truthiness check to determine presence.
       def get(key, *args, &block)
         raise ArgumentError, 'block required by not given' unless block_given?
         digest = hashed_key_and_args(key, *args)
@@ -60,7 +60,7 @@ module Twigg
       # recursion to incorporate the contents of those objects in the digest.
       #
       # Will raise an exception if `args` or any object encontered via recursion
-      # is not a "simple" object (Hash, Array, String, NilClas, Numeric, or
+      # is not a "simple" object (Hash, Array, String, NilClass, Numeric, or
       # Symbol).
       def hashed_key_and_args(key, *args)
         base = args.inject('') do |memo, arg|
@@ -69,7 +69,7 @@ module Twigg
             hashed_key_and_args(key, *arg)
           when Hash
             hashed_key_and_args(key, *arg.to_a)
-          when NilClass,Numeric, String, Symbol
+          when NilClass, Numeric, String, Symbol
             arg.to_s
           else
             raise ArgumentError, 'can only compute digest for primitive objects'

data/lib/twigg/command/help.rb

@@ -1,5 +1,3 @@
-require 'shellwords'
-
 module Twigg
   class Command
     class Help < Command
@@ -22,10 +20,6 @@ module Twigg
 
     private
 
-      def executable
-        Shellwords.escape($0)
-      end
-
       TOPIC_HEADERS = Hash.new { |h, k| h[k] = k.capitalize }.merge(
         # header = subcommand with first letter capitalized; exceptions:
         'app'    => 'Web application',
@@ -34,78 +28,85 @@ module Twigg
 
       def show_help(topic)
         puts TOPIC_HEADERS[topic] + ':'
-        stderr strip_heredoc(send(topic)) + "\n"
+        stderr strip_heredoc(send(topic), indent: 2) + "\n"
       end
 
       def app
         <<-DOC
-          #{executable} app [-D|--daemon] [-P|--pidfile <pidfile>]
+          twigg app [-D|--daemon] [-P|--pidfile <pidfile>]
         DOC
       end
 
       def commands
         <<-DOC
-          #{executable} app    # run the Twigg web app
-          #{executable} gerrit # clone/update/report from Gerrit
-          #{executable} git    # perform operations on Git repos
-          #{executable} github # clone/update from GitHub
-          #{executable} init   # generate a .twiggrc file
-          #{executable} help   # this help information
-          #{executable} stats  # show statistics about repos
+          twigg app     # run the Twigg web app
+          twigg gerrit  # clone/update/report from Gerrit
+          twigg git     # perform operations on Git repos
+          twigg github  # clone/update from GitHub
+          twigg init    # generate a .twiggrc file
+          twigg help    # this help information
+          twigg pivotal # show open stories in Pivotal Tracker
+          twigg stats   # show statistics about repos
         DOC
       end
 
       def gerrit
         <<-DOC
-          #{executable} gerrit clone [repos dir]  # clone repos into repos dir
-          #{executable} gerrit update [repos dir] # update repos in repos dir
-          #{executable} gerrit stats [repos dir]  # show stats for repos in dir
+          twigg gerrit clone [repos dir]  # clone repos into repos dir
+          twigg gerrit update [repos dir] # update repos in repos dir
+          twigg gerrit stats [repos dir]  # show stats for repos in dir
         DOC
       end
 
       def git
         <<-DOC
-          #{executable} git gc [repos dir] # garbage collect repos in repos dir
+          twigg git gc [repos dir] # garbage collect repos in repos dir
         DOC
       end
 
       def github
         <<-DOC
-          #{executable} github clone [repos dir]  # clone repos into repos dir
-          #{executable} github update [repos dir] # update repos in repos dir
+          twigg github clone [repos dir]  # clone repos into repos dir
+          twigg github update [repos dir] # update repos in repos dir
         DOC
       end
 
       def help
         <<-DOC
-          #{executable} help              # this help information
-          #{executable} help <subcommand> # help for a specific subcommand
-          #{executable} help commands     # list all subcommands
+          twigg help              # this help information
+          twigg help <subcommand> # help for a specific subcommand
+          twigg help commands     # list all subcommands
         DOC
       end
 
       def init
         <<-DOC
-          #{executable} init # emit a sample .twiggrc file to standard out
+          twigg init # emit a sample .twiggrc file to standard out
+        DOC
+      end
+
+      def pivotal
+        <<-DOC
+          twigg pivotal stats # show overview of open stories
         DOC
       end
 
       def russian
         <<-DOC
-          #{executable} russian <repos dir> <number of days> # easter egg
+          twigg russian <repos dir> <number of days> # easter egg
         DOC
       end
 
       def stats
         <<-DOC
-          #{executable} stats [--verbose|-v] <repos dir> <number of days>
+          twigg stats [--verbose|-v] <repos dir> <number of days>
         DOC
       end
 
       def usage
         <<-DOC
-          #{executable} <subcommand> [options] <arguments...>
-          #{executable} help
+          twigg <subcommand> [options] <arguments...>
+          twigg help
         DOC
       end
     end

data/lib/twigg/command/stats.rb

@@ -21,7 +21,7 @@ module Twigg
           puts '%5s %-24s %s' % [
             number_with_delimiter(commit_set.count),
             author,
-            breakdown(commit_set, html: false),
+            commit_set.decorate.breakdown(html: false),
           ]
 
           if @verbose

data/lib/twigg/command.rb

@@ -3,7 +3,7 @@ require 'forwardable'
 module Twigg
   class Command
     # Subcommands, in the order they should appear in the help output.
-    PUBLIC_SUBCOMMANDS = %w[help init app stats gerrit github git]
+    PUBLIC_SUBCOMMANDS = %w[help init app stats gerrit github pivotal git]
 
     EASTER_EGGS        = %w[russian]
     SUBCOMMANDS        = PUBLIC_SUBCOMMANDS + EASTER_EGGS
@@ -44,7 +44,10 @@ module Twigg
     private
 
       def ignore(args)
-        warn "unsupported extra arguments #{args.inspect} ignored" if args.any?
+        if args.any?
+          warn "unsupported extra argument#{'s' if args.size > 1} " \
+               "#{args.inspect} ignored"
+        end
       end
 
       def app(*args)
@@ -71,6 +74,10 @@ module Twigg
         Init.new(*args).run
       end
 
+      def pivotal(*args)
+        with_dependency('twigg-pivotal') { Pivotal.new(*args).run }
+      end
+
       def russian(*args)
         Russian.new(*args).run
       end

data/lib/twigg/commit_set.rb

@@ -3,6 +3,7 @@ require 'set'
 
 module Twigg
   class CommitSet
+    include Decoratable
     extend Forwardable
     def_delegators :commits, :any?, :count, :each, :inject, :<<
     attr_reader :commits

data/lib/twigg/commit_set_decorator.rb

@@ -0,0 +1,31 @@
+module Twigg
+  class CommitSetDecorator < Decorator
+    include Util # for `number_with_delimiter`
+
+    # Returns a per-repo breakdown (repo names, commit counts) of commits in
+    # the decorated {CommitSet}.
+    #
+    # Returns HTML output by default, or plain-text when `html` is `false`.
+    def breakdown(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
+
+  private
+
+    def commit_set
+      @decorated
+    end
+  end
+end

data/lib/twigg/console.rb

@@ -31,13 +31,14 @@ module Twigg
 
     # Given a "heredoc" `doc`, find the non-empty line with the smallest indent,
     # and strip that amount of whitespace from the beginning of each line.
+    # Subsequently, prepend a fixed number (`indent`) of spaces to each line.
     #
     # This allows us to write nicely indented copy that sits well with the
     # surrounding code, irrespective of the level of indentation of the code,
     # without emitting excessive whitespace to the user at runtime.
-    def strip_heredoc(doc)
-      indent = doc.scan(/^[ \t]*(?=\S)/).map(&:size).min || 0
-      doc.gsub(/^[ \t]{#{indent}}/, '')
+    def strip_heredoc(doc, indent: 0)
+      strip_count = doc.scan(/^[ \t]*(?=\S)/).map(&:size).min || 0
+      doc.gsub(/^[ \t]{#{strip_count}}/, ' ' * indent)
     end
 
     # Given `switches` (which may be either a single switch or an array of

data/lib/twigg/decoratable.rb

@@ -0,0 +1,17 @@
+module Twigg
+  module Decoratable
+    def decorate
+      klass = self.class.instance_variable_get('@decorator_class')
+
+      if !klass
+        components = (self.class.name + 'Decorator').split('::')
+        klass = components.inject(Object) do |namespace, klass|
+          namespace.const_get(klass)
+        end
+        self.class.instance_variable_set('@decorator_class', klass)
+      end
+
+      klass.new(self)
+    end
+  end
+end

data/lib/twigg/decorator.rb

@@ -0,0 +1,11 @@
+module Twigg
+  class Decorator < BasicObject
+    def initialize(decorated)
+      @decorated = decorated
+    end
+
+    def method_missing(method, *args, &block)
+      @decorated.send(method, *args, &block)
+    end
+  end
+end

data/lib/twigg/repo.rb

@@ -75,7 +75,7 @@ module Twigg
       IO.popen([{ 'GIT_DIR' => git_dir },
                 'git', command, *args, *STDERR_TO_STDOUT], 'r') do |io|
         io.read
-      end
+      end.force_encoding('UTF-8')
     end
 
     def log(*args)
@@ -91,7 +91,8 @@ module Twigg
         '%w(0,4,4)%b', # body, indented 4 spaces
       ].join
 
-      git 'log', "--pretty=format:#{format}", '--numstat', *args
+      git 'log',
+        '--encoding=UTF-8', "--pretty=format:#{format}", '--numstat', *args
     end
 
     def parse_log(string)

data/lib/twigg/settings.rb

@@ -28,6 +28,10 @@ module Twigg
       namespace :gerrit do
         setting :enabled, default: false
       end
+
+      namespace :pivotal do
+        setting :enabled, default: false
+      end
     end
 
     namespace :cache do
@@ -64,6 +68,10 @@ module Twigg
       setting :token,        required: true
     end
 
+    namespace :pivotal do
+      setting :token,        required: true
+    end
+
     setting :repositories_directory, required: true do |name, value|
       raise ArgumentError, "#{name} not a directory" unless File.directory?(value)
     end

data/lib/twigg/util.rb

@@ -1,5 +1,11 @@
 module Twigg
   module Util
+    class << self
+      def inflections
+        @inflections ||= {}
+      end
+    end
+
   private
 
     # Returns the age of `time` relative to now in hours (for short intervals)
@@ -37,32 +43,16 @@ module Twigg
     #   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
+      inflections = ::Twigg::Util.inflections
+      number      = delimit ? number_with_delimiter(count) : count.to_s
 
-      (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 plural
+        inflections[singular] ||= plural
+      else
+        plural = inflections[singular] || (singular + 's')
+      end
 
-        if html
-          "<i>#{name}:</i> <b>#{number_with_delimiter data[:count]}</b>"
-        else
-          "#{name}: #{number_with_delimiter data[:count]}"
-        end
-      end.join(', ')
+      "#{number} #{count == 1 ? singular : plural}"
     end
   end
 end

data/lib/twigg/version.rb

@@ -1,3 +1,3 @@
 module Twigg
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 end

data/lib/twigg.rb

@@ -1,23 +1,26 @@
 require 'pathname'
 
 module Twigg
-  autoload :Cacher,       'twigg/cacher'
-  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'
+  autoload :Cacher,             'twigg/cacher'
+  autoload :Command,            'twigg/command'
+  autoload :Commit,             'twigg/commit'
+  autoload :CommitSet,          'twigg/commit_set'
+  autoload :CommitSetDecorator, 'twigg/commit_set_decorator'
+  autoload :Config,             'twigg/config'
+  autoload :Console,            'twigg/console'
+  autoload :Dependency,         'twigg/dependency'
+  autoload :Decorator,          'twigg/decorator'
+  autoload :Decoratable,        'twigg/decoratable'
+  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).

data/templates/twiggrc.yml

@@ -13,6 +13,8 @@ app:
   bind: '0.0.0.0' # default
   gerrit:
     enabled: false # default
+  pivotal:
+    enabled: false # default
 
 cache:
   enabled:         false     # default
@@ -40,6 +42,9 @@ github:
   organization: causes
   token: 0da57c4304855867e97dd4419d7d070543c5c092
 
+pivotal:
+  token: dcc9b8d1445dc21d02f1cbea1edd8aa56ffd6af2
+
 teams:
   Red Team:
     - John Smith

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twigg
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Causes Engineering
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-28 00:00:00.000000000 Z
+date: 2013-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -101,8 +101,11 @@ files:
 - lib/twigg/command.rb
 - lib/twigg/commit.rb
 - lib/twigg/commit_set.rb
+- lib/twigg/commit_set_decorator.rb
 - lib/twigg/config.rb
 - lib/twigg/console.rb
+- lib/twigg/decoratable.rb
+- lib/twigg/decorator.rb
 - lib/twigg/dependency.rb
 - lib/twigg/flesch.rb
 - lib/twigg/gatherer.rb