rack-commit-stats 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aa1969bb30585c2b370d5f9ab29a923e50ee917f
-  data.tar.gz: 39f81d487ee9d3305d0d7263d186a1fb0884541d
+  metadata.gz: 33cd6390c84f95343a8d60e31c3f7502b8d32717
+  data.tar.gz: e23b76420f3d499816f80c067a429eac109e40d6
 SHA512:
-  metadata.gz: 884c460c19c327de728437ad2be96d50f150109834b2db136bfe0c1227a116c92ef76167a8ec35db0bf57cbffd7d3ef1166e6a3577d9091441e0a01efd6caded
-  data.tar.gz: 22c23203b2085846b9de718b0e2b3ff1226a09240b328bfc5cb2e362d21776405dfb8cfdbfd5a1212957873c3ac2e674fa680e26e8d726646d95d020e5c7383c
+  metadata.gz: e86742e895139b597fce471ea999e9de4021342547d32fbbdb9b864b9165601fafc173e07ac2eb98097810da717929afe7fb7f95976e07a505d7a2bfa6f7fdd7
+  data.tar.gz: 98088766feac142a7ff0dda000a7639853f7300c26747ea000227ff8074846355c889b47b65ad91408c6f72f0211cddde63abd6ac814e4de56dd669a020d792a

data/README.md

@@ -1,5 +1,6 @@
 rack-commit-stats
 ===========
+[![Gem Version](https://badge.fury.io/rb/rack-commit-stats.svg)](http://badge.fury.io/rb/rack-commit-stats)
 [![Build Status](https://travis-ci.org/todd/rack-commit-stats.svg?branch=master)](https://travis-ci.org/todd/rack-commit-stats)
 [![Coverage Status](https://coveralls.io/repos/todd/rack-commit-stats/badge.png?branch=master)](https://coveralls.io/r/todd/rack-commit-stats?branch=master)
 [![Code Climate](https://codeclimate.com/github/todd/rack-commit-stats/badges/gpa.svg)](https://codeclimate.com/github/todd/rack-commit-stats)
@@ -23,7 +24,7 @@ on your system. CMake should be available through your package manager of choice
 
 ## For Rails
 Mount the application on a new endpoint within your `routes.rb` file. You will
-probably want to limit access to this endpoint using some sort of authentication
+probably want to limit access to this endpoint using some sort of authorization
 constraint you've established, though this is totally optional.
 
 ```ruby
@@ -37,7 +38,7 @@ in the affected environment configuration files.
 
 ```ruby
 # production.rb
-config.rack_commit_stats.repo_path = '../repo'
+config.rack_commit_stats.repo_path = '../.git'
 ```
 
 ## For Sinatra
@@ -60,6 +61,29 @@ RackCommitStats.configure do |config|
 end
 ```
 
+## Using with Capistrano
+By default, the gem will attempt to read a Git repo on a standard path. However,
+deploying with a tool like Capistrano does some things that make reading Git
+state a bit trickier. The `.git` directory is moved outside of the project root
+and the deployed branch is not checked out on the server. To work around this,
+rack-commit-stats can read the branch and revision state from the `revisions.log`
+file created by Capistrano on deploys and pull repository state based on that.
+
+To enable this, you'll need to set a few additional configuration options:
+```ruby
+# Rails - production.rb (or other environment configuration file)
+config.rack_commit_stats.repo_path = "../../repo"
+config.rack_commit_stats.mode = :file
+config.rack_commit_stats.file_path_prefix = "../../"
+
+# Sinatra
+RackCommitStats.configure do |config|
+  config.repo_path = "../../repo"
+  config.mode = :file
+  config.file_path_prefix = "../../"
+end
+```
+
 ## Example Output
 ```json
 {

data/lib/rack-commit-stats/app.rb

@@ -3,25 +3,33 @@ require 'json'
 module RackCommitStats
   class App
     def self.call(env)
-      status = 200
+      status  = 200
       headers = {"Content-Type" => "application/json"}
 
       [status, headers, [response]]
     end
 
-    private
+    class << self
+      def response
+        {
+          branch: commit.branch,
+          commit: {
+            revision: commit.revision,
+            message:  commit.message,
+            author:   commit.author
+          }
+        }.to_json
+      end
 
-    def self.response
-      commit = Commit.new
+      def commit
+        if RackCommitStats.config.file_mode?
+          @_commit ||= CommitFromEnv.new
+        else
+          @_commit ||= Commit.new
+        end
 
-      {
-        branch: commit.branch,
-        commit: {
-          revision: commit.revision,
-          message:  commit.message,
-          author:   commit.author
-        }
-      }.to_json
+        @_commit
+      end
     end
   end
 end

data/lib/rack-commit-stats/commit.rb

@@ -18,12 +18,14 @@ module RackCommitStats
       commit.author.reject { |k, _| k == :time }
     end
 
-    private
+    protected
 
     def repo
       @_repo ||= Rugged::Repository.new(RackCommitStats.config.repo_path)
     end
 
+    private
+
     def head
       repo.head
     end

data/lib/rack-commit-stats/commit_from_env.rb

@@ -0,0 +1,31 @@
+module RackCommitStats
+  class CommitFromEnv < Commit
+    REVISION_LOG_FILE = 'revisions.log'
+
+    def branch
+      current_revision[1]
+    end
+
+    def revision
+      commit.oid
+    end
+
+    private
+
+    def commit
+      @_commit ||= repo.lookup(sha_from_file)
+    end
+
+    def sha_from_file
+      current_revision[3].gsub(/[)]/, '')
+    end
+
+    def current_revision
+      @_current_revision ||= File.open(
+        File.join(
+          RackCommitStats.config.file_path_prefix, REVISION_LOG_FILE
+        ), 'r'
+      ).readlines.last.split
+    end
+  end
+end

data/lib/rack-commit-stats/railtie.rb

@@ -6,6 +6,10 @@ module RackCommitStats
       RackCommitStats.configure do |config|
         config.repo_path = app.config.rack_commit_stats.repo_path ||
           DEFAULT_REPO_PATH
+
+        config.mode = app.config.rack_commit_stats.mode || DEFAULT_MODE
+        config.file_path_prefix = app.config.rack_commit_stats.file_path_prefix ||
+          DEFAULT_FILE_PATH_PREFIX
       end
     end
   end

data/lib/rack-commit-stats/version.rb

@@ -1,3 +1,3 @@
 module RackCommitStats
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/rack-commit-stats.rb

@@ -1,14 +1,24 @@
 module RackCommitStats
   require 'rack-commit-stats/app'
   require 'rack-commit-stats/commit'
+  require 'rack-commit-stats/commit_from_env'
   require 'rack-commit-stats/railtie' if defined? Rails
 
-  DEFAULT_REPO_PATH = '.git'
+  DEFAULT_REPO_PATH        = '.git'
+  DEFAULT_MODE             = :default
+  FILE_MODE                = :file
+  DEFAULT_FILE_PATH_PREFIX = '.'
 
-  class Configuration < Struct.new(:repo_path); end
+  class Configuration < Struct.new(:repo_path, :mode, :file_path_prefix)
+    def file_mode?
+      mode == FILE_MODE
+    end
+  end
 
   def self.config
-    @@_config ||= Configuration.new(DEFAULT_REPO_PATH)
+    @@_config ||= Configuration.new(
+      DEFAULT_REPO_PATH, DEFAULT_MODE, DEFAULT_FILE_PATH_PREFIX
+    )
   end
 
   def self.configure

data/spec/fixtures/revisions.log

@@ -0,0 +1 @@
+Branch test_branch (at ce7a40f) deployed as release 20141210195915 by runner\n

data/spec/lib/rack-commit-stats/app_spec.rb

@@ -23,22 +23,48 @@ RSpec.describe RackCommitStats::App do
       expect(headers).to eq({"Content-Type" => "application/json"})
     end
 
-    it 'renders a JSON object with commit details as the body' do
-      allow(RackCommitStats::Commit).to receive(:new).and_return commit_double
-      _, _, response = subject
-      expect(response.first).to eq(
-        {
-          branch: 'specs',
-          commit: {
-            revision: 'gibberish',
-            message:  'hello',
-            author: {
-              name:  'Foo Bar',
-              email: 'foo@bar.com'
+    context 'default mode' do
+      it 'renders a JSON object with commit details as the body' do
+        allow(described_class).to receive(:commit).and_return commit_double
+        _, _, response = subject
+        expect(response.first).to eq(
+          {
+            branch: 'specs',
+            commit: {
+              revision: 'gibberish',
+              message:  'hello',
+              author: {
+                name:  'Foo Bar',
+                email: 'foo@bar.com'
+              }
             }
-          }
-        }.to_json
-      )
+          }.to_json
+        )
+      end
+    end
+
+    context 'file mode' do
+      before do
+        RackCommitStats.configure { |config| config.mode = :file }
+      end
+
+      it 'renders a JSON object with commit details as the body' do
+        allow(described_class).to receive(:commit).and_return commit_double
+        _, _, response = subject
+        expect(response.first).to eq(
+          {
+            branch: 'specs',
+            commit: {
+              revision: 'gibberish',
+              message:  'hello',
+              author: {
+                name:  'Foo Bar',
+                email: 'foo@bar.com'
+              }
+            }
+          }.to_json
+        )
+      end
     end
   end
 

data/spec/lib/rack-commit-stats/commit_from_env_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+RSpec.describe RackCommitStats::CommitFromEnv do
+  before do
+    RackCommitStats.configure do |config|
+      config.repo_path = 'spec/fixtures/repo'
+      config.mode = :file
+      config.file_path_prefix = 'spec/fixtures'
+    end
+  end
+
+  describe '#branch' do
+    it 'returns the branch name at HEAD' do
+      expect(described_class.new.branch).to eq 'test_branch'
+    end
+  end
+
+  describe '#revision' do
+    it 'returns the revision SHA at HEAD' do
+      expect(described_class.new.revision).to eq(
+        "ce7a40f280665ce2e7bbc10b81a91632affe15ab"
+      )
+    end
+  end
+
+  describe '#message' do
+    it 'returns the commit message at HEAD' do
+      expect(described_class.new.message).to eq "bar"
+    end
+  end
+
+  describe '#author' do
+    it 'returns a hash of author information for the commit at HEAD' do
+      expect(described_class.new.author).to eq(
+        {
+          name: 'Foo Bar',
+          email: 'foo@bar.com'
+        }
+      )
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rack-commit-stats
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Todd Bealmear
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-07 00:00:00.000000000 Z
+date: 2014-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rugged
@@ -65,13 +65,16 @@ files:
 - lib/rack-commit-stats.rb
 - lib/rack-commit-stats/app.rb
 - lib/rack-commit-stats/commit.rb
+- lib/rack-commit-stats/commit_from_env.rb
 - lib/rack-commit-stats/railtie.rb
 - lib/rack-commit-stats/version.rb
 - rack-commit-stats.gemspec
 - spec/fixtures/repo/HEAD
 - spec/fixtures/repo/objects/ce/7a40f280665ce2e7bbc10b81a91632affe15ab
 - spec/fixtures/repo/refs/heads/master
+- spec/fixtures/revisions.log
 - spec/lib/rack-commit-stats/app_spec.rb
+- spec/lib/rack-commit-stats/commit_from_env_spec.rb
 - spec/lib/rack-commit-stats/commit_spec.rb
 - spec/lib/rack-commit-stats_spec.rb
 - spec/spec_helper.rb