RubyGems - asha79-rack_revision_info - Versions diffs - 0.3.2 - Mend

asha79-rack_revision_info 0.3.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (3) hide show

data/lib/rack_revision_info.rb +87 -0
data/spec/spec_rack_revision_info.rb +102 -0
metadata +54 -0

data/lib/rack_revision_info.rb ADDED Viewed

@@ -0,0 +1,87 @@
+module Rack
+  class RevisionInfo
+    INJECT_ACTIONS = [:after, :before, :append, :prepend, :swap, :inner_html]
+    def initialize(app, opts={})
+      @app = app
+      path = opts[:path] or raise ArgumentError, "You must specify directory of your local repository!"
+      revision, date = get_revision_info(path, opts)
+      @revision_info = "#{get_revision_label(opts)} #{revision || 'unknown'}"
+      @revision_info << " (#{date.strftime(get_date_format(opts))})" if date
+      @action = (opts.keys & INJECT_ACTIONS).first
+      if @action
+        require 'hpricot'
+        @selector = opts[@action]
+      end
+    end
+    def call(env)
+      status, headers, body = @app.call(env)
+      if headers['Content-Type'].include?('text/html') && !Rack::Request.new(env).xhr?
+        html = ""
+        body.each { |s| html << s }
+        body = html
+        begin
+          if @action
+            doc = Hpricot(body)
+            elements = doc.search(@selector).compact
+            if elements.size > 0
+              elements = elements.first if @action == :swap
+              elements.send(@action, @revision_info)
+              body = doc.to_s
+            end
+          end
+        rescue => e
+          puts e
+          puts e.backtrace
+        end
+        body << %(\n<!-- #{@revision_info} -->\n)
+        body = [body]
+      end
+      [status, headers, body]
+    end
+    protected
+    def get_revision_label(opts={})
+      revision_label = 'Revision'
+      unless opts[:revision_label].nil?
+        revision_label = opts[:revision_label]
+      end
+    end
+    def get_date_format(opts={})
+      date_format = "%Y-%m-%d %H:%M:%S %Z"
+      unless opts[:date_format].nil?
+        date_format = opts[:date_format]
+      end
+    end
+    def get_revision_info(path, opts={})
+      case detect_type(path)
+      when :git
+        revision_regex_extra = '+'
+        if not opts[:short_git_revisions].nil? and opts[:short_git_revisions]
+          revision_regex_extra = '{8}'
+        end
+        info = `cd #{path}; LC_ALL=C git log -1 --pretty=medium`
+        revision = info[/commit\s([a-z0-9]#{revision_regex_extra})/, 1]
+        date = (d = info[/Date:\s+(.+)$/, 1]) && (DateTime.parse(d) rescue nil)
+      when :svn
+        info = `cd #{path}; LC_ALL=C svn info`
+        revision = info[/Revision:\s(\d+)$/, 1]
+        date = (d = info[/Last Changed Date:\s([^\(]+)/, 1]) && (DateTime.parse(d.strip) rescue nil)
+      else
+        revision, date = nil, nil
+      end
+      [revision, date]
+    end
+    def detect_type(path)
+      return :git if ::File.directory?(::File.join(path, ".git"))
+      return :svn if ::File.directory?(::File.join(path, ".svn"))
+      :unknown
+    end
+  end
+end

data/spec/spec_rack_revision_info.rb ADDED Viewed

@@ -0,0 +1,102 @@
+require 'rubygems'
+require 'spec'
+require 'rack/builder'
+require 'rack/mock'
+require File.join(File.dirname(__FILE__), '..', 'lib', 'rack_revision_info.rb')
+class Rack::RevisionInfo
+  DATETIME_FORMAT = "%Y-%m-%d %H:%M:%S %Z"
+  def get_revision_info(path, opts={})
+    [(opts[:short_git_revisions] ? SHORT_GIT_REV : REV), DATE]
+  end
+  def get_revision_label(opts={})
+    opts[:revision_label] or REV_LABEL
+  end
+  def get_date_format(opts={})
+    opts[:date_format] or DATETIME_FORMAT
+  end
+end
+describe "Rack::RevisionInfo" do
+  REV = "a4jf64jf4hff"
+  SHORT_GIT_REV = "a4jf64jf"
+  REV_LABEL = "Revision"
+  DATE = DateTime.now
+  it "should append revision info in html comment" do
+    app = Rack::Builder.new do
+      use Rack::RevisionInfo, :path => "/some/path/to/repo"
+      run lambda { |env| [200, { 'Content-Type' => 'text/html' }, ["<html><head></head><body>Hello, World!</body></html>"]] }
+    end
+    response = Rack::MockRequest.new(app).get('/')
+    response.body.should match(/#{Regexp.escape("<!-- Revision #{REV} (#{DATE.strftime(Rack::RevisionInfo::DATETIME_FORMAT)}) -->")}/)
+  end
+  it "should append customised revision info in html comment" do
+    custom_date_format = "%d-%m-%Y %H:%M:%S"
+    app = Rack::Builder.new do
+      use Rack::RevisionInfo, :path => "/some/path/to/repo", :revision_label => "Rev", :date_format => custom_date_format
+      run lambda { |env| [200, { 'Content-Type' => 'text/html' }, ["<html><head></head><body>Hello, World!</body></html>"]] }
+    end
+    response = Rack::MockRequest.new(app).get('/')
+    response.body.should match(/#{Regexp.escape("<!-- Rev #{REV} (#{DATE.strftime(custom_date_format)}) -->")}/)
+  end
+  it "should append customised git specific revision info in html comment" do
+    custom_date_format = "%d-%m-%Y %H:%M:%S"
+    app = Rack::Builder.new do
+      use Rack::RevisionInfo, :path => "/some/path/to/repo", :revision_label => "Rev", :date_format => custom_date_format, :short_git_revisions => true
+      run lambda { |env| [200, { 'Content-Type' => 'text/html' }, ["<html><head></head><body>Hello, World!</body></html>"]] }
+    end
+    response = Rack::MockRequest.new(app).get('/')
+    response.body.should match(/#{Regexp.escape("<!-- Rev #{SHORT_GIT_REV} (#{DATE.strftime(custom_date_format)}) -->")}/)
+  end
+  it "shouldn't append revision info for non-html content-types" do
+    app = Rack::Builder.new do
+      use Rack::RevisionInfo, :path => "/some/path/to/repo"
+      run lambda { |env| [200, { 'Content-Type' => 'text/plain' }, ["Hello, World!"]] }
+    end
+    response = Rack::MockRequest.new(app).get('/')
+    response.body.should_not match(/#{Regexp.escape('<!-- Revision ')}/)
+  end
+  it "shouldn't append revision info for xhr requests" do
+    app = Rack::Builder.new do
+      use Rack::RevisionInfo, :path => "/some/path/to/repo"
+      run lambda { |env| [200, { 'Content-Type' => 'text/html' }, ["<html><head></head><body>Hello, World!</body></html>"]] }
+    end
+    response = Rack::MockRequest.new(app).get('/', "HTTP_X_REQUESTED_WITH" => "XMLHttpRequest")
+    response.body.should_not match(/#{Regexp.escape('<!-- Revision ')}/)
+  end
+  it "should raise exeption when no path given" do
+    app = Rack::Builder.new do
+      use Rack::RevisionInfo
+      run lambda { |env| [200, {'Content-Type' => 'text/plain'}, ["Hello, World!"]] }
+    end
+    lambda do
+      response = Rack::MockRequest.new(app).get('/')
+    end.should raise_error(ArgumentError)
+  end
+  it "should inject revision info into DOM" do
+    Rack::RevisionInfo::INJECT_ACTIONS.each do |action|
+      app = Rack::Builder.new do
+        use Rack::RevisionInfo, :path => "/some/path/to/repo", action => "#footer"
+        run lambda { |env| [200, { 'Content-Type' => 'text/html' }, ["<html><head></head><body>Hello, World!<div id='footer'>Foota</div></body></html>"]] }
+      end
+      response = Rack::MockRequest.new(app).get('/')
+      response.body.should match(/#{Regexp.escape("Revision #{REV} (#{DATE.strftime(Rack::RevisionInfo::DATETIME_FORMAT)})")}.*#{Regexp.escape("</body>")}/)
+    end
+  end
+  it "shouldn't inject revision info into DOM if unknown action" do
+    app = Rack::Builder.new do
+      use Rack::RevisionInfo, :path => "/some/path/to/repo", :what_what => "#footer"
+      run lambda { |env| [200, { 'Content-Type' => 'text/html' }, ["<html><head></head><body>Hello, World!<div id='footer'>Foota</div></body></html>"]] }
+    end
+    response = Rack::MockRequest.new(app).get('/')
+    response.body.should_not match(/#{Regexp.escape("Revision #{REV} (#{DATE.strftime(Rack::RevisionInfo::DATETIME_FORMAT)})")}.*#{Regexp.escape("</body>")}/)
+  end
+end

metadata ADDED Viewed

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: asha79-rack_revision_info
+version: !ruby/object:Gem::Version
+  version: 0.3.2
+platform: ruby
+authors:
+- Marcin Kulik
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2009-06-18 00:00:00 -07:00
+default_executable:
+dependencies: []
+description:
+email: marcin.kulik@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/rack_revision_info.rb
+- spec/spec_rack_revision_info.rb
+has_rdoc: false
+homepage: http://sickill.net
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: "0"
+  version:
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: "0"
+  version:
+requirements: []
+rubyforge_project:
+rubygems_version: 1.2.0
+signing_key:
+specification_version: 2
+summary: Rack middleware showing current git (or svn) revision number of application
+test_files: []