RubyGems - rack-revision-info - Versions diffs - 0.3.6 - Mend

rack-revision-info 0.3.6

Files changed (4) hide show

data/lib/rack-revision-info/nokogiri_backend.rb +14 -0
data/lib/rack-revision-info.rb +77 -0
data/spec/spec-rack-revision-info.rb +111 -0
metadata +57 -0

data/lib/rack-revision-info/nokogiri_backend.rb ADDED Viewed

@@ -0,0 +1,14 @@
+require 'nokogiri'
+# extending Nokogiri with 'append' and 'prepend' methods
+class Nokogiri::XML::Element
+  def append(data)
+    self.inner_html = inner_html + data
+  end
+  def prepend(data)
+    self.inner_html = data + inner_html
+  end
+end

data/lib/rack-revision-info.rb ADDED Viewed

@@ -0,0 +1,77 @@
+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 ::File.join(::File.dirname(__FILE__), 'rack-revision-info', 'nokogiri_backend')
+        @selector = opts[@action]
+        @action = :inner_html= if @action == :inner_html
+      end
+    end
+    def call(env)
+      status, headers, body = @app.call(env)
+      if headers['Content-Type'].to_s.include?('text/html') && !Rack::Request.new(env).xhr?
+        body = body.inject("") { |acc, line| acc + line }
+        begin
+          if @action
+            doc = Nokogiri.parse(body)
+            elements = doc.css(@selector)
+            if elements.size > 0
+              elements.each { |e| e.send(@action, "<span class=\"rack-revision-info\">#{@revision_info}</span>") }
+              body = doc.to_s
+            end
+          end
+        rescue => e
+          puts e
+          puts e.backtrace
+        end
+        body << %(\n<!-- #{@revision_info} -->\n)
+        headers["Content-Length"] = body.size.to_s
+        body = [body]
+      end
+      [status, headers, body]
+    end
+    protected
+    def get_revision_label(opts={})
+      opts[:revision_label] || 'Revision'
+    end
+    def get_date_format(opts={})
+      opts[:date_format] || "%Y-%m-%d %H:%M:%S %Z"
+    end
+    def get_revision_info(path, opts={})
+      case detect_type(path)
+      when :git
+        revision_regex_extra = opts[:short_git_revisions] ? '{8}' : '+'
+        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,111 @@
+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)}) -->")}/m)
+  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 ')}/m)
+  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 ')}/m)
+  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' }, [%q{<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("<span class=\"rack-revision-info\">Revision #{REV} (#{DATE.strftime(Rack::RevisionInfo::DATETIME_FORMAT)})</span>")}.*#{Regexp.escape("</body>")}/m)
+    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' }, [%q{<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>")}/m)
+  end
+  it "shouldn't escape backslashes" do # hpricot was doing this :|
+    app = Rack::Builder.new do
+      use Rack::RevisionInfo, :path => "/some/path/to/repo", :inner_html => "#footer"
+      run lambda { |env| [200, { 'Content-Type' => 'text/html' }, [%q{<html><head></head><body><input type="text" name="foo" value="\" /><div id="footer">Foota</div></body></html>}]] }
+    end
+    response = Rack::MockRequest.new(app).get('/')
+    response.body.should_not match(/value="\\\\"/m)
+  end
+end

metadata ADDED Viewed

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: rack-revision-info
+version: !ruby/object:Gem::Version
+  version: 0.3.6
+platform: ruby
+authors:
+- Marcin Kulik
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2009-10-30 00:00:00 +01:00
+default_executable:
+dependencies: []
+description:
+email: marcin.kulik@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/rack-revision-info.rb
+- lib/rack-revision-info/nokogiri_backend.rb
+- spec/spec-rack-revision-info.rb
+has_rdoc: true
+homepage: http://sickill.net
+licenses: []
+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.3.5
+signing_key:
+specification_version: 3
+summary: Rack middleware showing current git (or svn) revision number of application
+test_files: []