twigg 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f3e52b0f0bd210a32cf32644f0b9eb53c19b24c5
-  data.tar.gz: aa750f08ceb9795ef9e8d2f3b970470bf0c3e869
+  metadata.gz: 08f8b0a5dc7eaafda3901ab196d782d98f6aecba
+  data.tar.gz: 5b7524480befd14000a0571316787ba5b4ba6194
 SHA512:
-  metadata.gz: 2d2cda3048d6a225c48d0e62ac26b3dd012b2be379e45584c088381c3f4d5d901ae154e1565d5f0d4af74b8f11e3c99cc3025bb66196bdfe1f9c65705695e5e4
-  data.tar.gz: 66d36587d5b4e8339517cc1f78ade317a77f132cb634f409b689744ba932c85787f54350a6868b57fa0688ff12cfef82ad259ec3071834057db606c3ff72a756
+  metadata.gz: 1e0219ae5d8e788b11db183b962889e1ec6153a01f519bbf82a304e1ac5d6e61ad4ad46ee3d9a3ac9e4afab08b49930e20762f11e530ecba01b3e22ee0c4781e
+  data.tar.gz: f50671909a2c1f24da4ee39ea5317a71f93e5d7c80cf64216971b3dd222701c0c3c70208334d62f8a99265cb9bc378aa55906dafa2afa1a20d9732db95366d53

data/lib/twigg/cacher.rb

@@ -0,0 +1,85 @@
+require 'digest/sha1'
+
+module Twigg
+  # The Cacher module is an abstraction around caching that offers two public
+  # methods, {Twigg::Cacher.get} and {Twigg::Cacher.set}.
+  #
+  # If the twigg-cache gem is installed and enabled, delegates the storing of
+  # cached items to Memcached. In the absence of the gem, every cache lookup is
+  # treated as a miss.
+  module Cacher
+    # Dummy Memcached client that always misses.
+    class DummyClient
+      def get(key); end
+      def set(key); end
+    end
+
+    class << self
+      include Dependency # for with_dependency
+
+      # Gets stored value for `key`; in the event of a cache miss, yields to
+      # `block`, and caches and returns the result. `*args`, if present, are
+      # hashed and appended to key to permit the results of different calls to
+      # the same method to be conveniently stored and retrieved independently.
+      #
+      # 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.
+      def get(key, *args, &block)
+        raise ArgumentError, 'block required by not given' unless block_given?
+        digest = hashed_key_and_args(key, *args)
+        client.get(digest) || set(key, *args, &block)
+      end
+
+      # Stores the result of yielding to `block` in the cache, with `key` as
+      # key, and returns the result.
+      #
+      # As with {get}, any `*args`, if present, are hashed and appended to the
+      # key to premit the results of different calls to the same method to be
+      # conveniently stored and retrieved independently.
+      def set(key, *args, &block)
+        digest = hashed_key_and_args(key, *args)
+        yield.tap { |result| client.set(digest, result) }
+      end
+
+    private
+
+      def client
+        @client ||= (caching? ? Cache::Client.new : DummyClient.new)
+      end
+
+      def caching?
+        return false unless Config.cache.enabled # don't want to load the gem
+        return true if defined?(Twigg::Cache)    # gem was already loaded
+        with_dependency('twigg-cache') { true }  # will die if can't load
+      end
+
+      # Produces a composite cache key based on `key` and a digest of `args`.
+      #
+      # If `args` contains non-shallow objects such as hashes or arrays, uses
+      # 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
+      # Symbol).
+      def hashed_key_and_args(key, *args)
+        base = args.inject('') do |memo, arg|
+          memo << (':' + arg.class.to_s + ':') << case arg
+          when Array
+            hashed_key_and_args(key, *arg)
+          when Hash
+            hashed_key_and_args(key, *arg.to_a)
+          when NilClass,Numeric, String, Symbol
+            arg.to_s
+          else
+            raise ArgumentError, 'can only compute digest for primitive objects'
+          end
+
+          Digest::SHA1::hexdigest(memo)
+        end
+
+        key + ':' + base
+      end
+    end
+  end
+end

data/lib/twigg/command/stats.rb

@@ -5,6 +5,7 @@ module Twigg
 
       def initialize(*args)
         super
+        # sigh.. need something declarative to DRY up this repetitive set-up
         Help.new('stats').run! if @args.size > 2
 
         @repositories_directory = @args[0] || Config.repositories_directory

data/lib/twigg/commit.rb

@@ -34,7 +34,7 @@ module Twigg
     end
 
     def filtered_commit_message
-      @filtered_commit_message ||= @body.lines.reject do |line|
+      @filtered_commit_message ||= @body.reject do |line|
         line =~ /^[a-z-]+: /i # filter out Change-Id:, Signed-off-by: etc
       end.concat([@subject]).join("\n").chomp
     end

data/lib/twigg/commit_set.rb

@@ -71,6 +71,8 @@ module Twigg
       self.class.new(commits_for_author)
     end
 
+    # Special case: if `team` is `nil`, select people who don't belong to a
+    # team.
     def select_team(team)
       members = Set.new(Config.teams[team])
 

data/lib/twigg/config.rb

@@ -39,8 +39,9 @@ module Twigg
       end
     end
 
-    def initialize
-      @settings = Settings.new(config_from_argv ||
+    def initialize(twiggrc: nil)
+      @settings = Settings.new(config_from_file(twiggrc) ||
+                               config_from_argv ||
                                config_from_env ||
                                config_from_home)
     end
@@ -53,6 +54,8 @@ module Twigg
     end
 
     def config_from_file(path)
+      return unless path
+
       YAML.load_file(path).tap do |contents|
         if File.world_readable?(path)
           warn "#{path} is world-readable"
@@ -77,11 +80,11 @@ module Twigg
       # twigg-app.gemspec), which means that this happens before the
       # Twigg::Command.run method gets a chance to set things up properly.
       path = consume_option(%w[-c --config], ARGV)
-      config_from_file(path) if path
+      config_from_file(path)
     end
 
     def config_from_env
-      config_from_file(ENV['TWIGGRC']) if ENV['TWIGGRC']
+      config_from_file(ENV['TWIGGRC'])
     end
 
     TWIGGRC = '.twiggrc'

data/lib/twigg/dependency.rb

@@ -2,6 +2,8 @@ module Twigg
   module Dependency
   private
 
+  # could add noisy: true, or graceful: false (or similar option) here if we
+  # wanted to infer the presence of the twigg-cache gem
     def with_dependency(gem, &block)
       require gem
       yield

data/lib/twigg/repo.rb

@@ -100,25 +100,23 @@ module Twigg
         loop do
           begin
             commit           = { repo: self }
+            commit[:body]    = []
+            commit[:stat]    = Hash.new(0)
             commit[:commit]  = lines.next.chomp
             commit[:author]  = lines.next.chomp
             commit[:date]    = Time.at(lines.next.chomp.to_i).to_date
             commit[:subject] = lines.next.chomp rescue ''
 
-            commit[:body]    = []
             while lines.peek =~ /^ {4}(.*)$/ && lines.next
               commit[:body] << $~[1]
             end
-            commit[:body]    = commit[:body].join("\n")
             lines.next if lines.peek == "\n" # blank separator line
 
-            commit[:stat]    = Hash.new(0)
             while lines.peek =~ /^(\d+|-)\t(\d+|-)\t.+$/ && lines.next
               commit[:stat][:additions] += $~[1].to_i
               commit[:stat][:deletions] += $~[2].to_i
             end
             lines.next if lines.peek == "\n" # blank separator line
-
           rescue StopIteration
             break # end of output
           ensure

data/lib/twigg/settings.rb

@@ -30,6 +30,14 @@ module Twigg
       end
     end
 
+    namespace :cache do
+      setting :enabled,   default: false
+      setting :expiry,    default: 3600 # 1 hour
+      setting :host,      default: 'localhost'
+      setting :namespace, default: 'twigg'
+      setting :port,      default: 11211
+    end
+
     setting :default_days, default: 7
 
     namespace :gerrit do

data/lib/twigg/version.rb

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

data/lib/twigg.rb

@@ -1,6 +1,7 @@
 require 'pathname'
 
 module Twigg
+  autoload :Cacher,       'twigg/cacher'
   autoload :Command,      'twigg/command'
   autoload :Commit,       'twigg/commit'
   autoload :CommitSet,    'twigg/commit_set'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twigg
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Causes Engineering
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-17 00:00:00.000000000 Z
+date: 2013-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -90,6 +90,7 @@ extra_rdoc_files: []
 files:
 - bin/twigg
 - files/github.pem
+- lib/twigg/cacher.rb
 - lib/twigg/command/git.rb
 - lib/twigg/command/git_host.rb
 - lib/twigg/command/git_hub.rb