rack-revision 1.0.0 → 1.0.1

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3

data/README.md

@@ -11,25 +11,41 @@ From rubygems:
 gem install rack-revision
 ```
 
+Or install with bundler:
+
+```
+gem 'rack-revision'
+```
+
+And run `bundle install`
+
 ## Usage
 
 Rack::Revision is implemented as a piece of Rack middleware and can be used with
-any Rack-based application. If you have a `configu.ru` rackup file you can 
-drop the following:
+any Rack-based application. If you have a `config.ru` rackup file you can 
+drop the following snippet (for sinatra app):
 
 ```ruby
 require 'rack/revision'
 
+# Basic example
 use Rack::Revision
 
-run YourApp
+# With custom revision header
+use Rack::Revision, :header => 'X-CODE-VERSION'
+
+# With custom filename and default value
+use Rack::Revision, :filename => '.version', :default => 'n/a'
+
+run Sinatra::Application
 ```
 
-Configuration options:
+Available options:
 
-- `:header` - Set a custom revision header. Default: `X-Revision`
-- `:filename` - Set a filename with revision data. Default: `REVISION`
-- `:default` - Override default `UNDEFINED` revision value
+- `:header`   - Sets a custom revision header. Default: `X-Revision`
+- `:filename` - Sets a filename with revision data. Default: `REVISION`
+- `:default`  - Sets a revision value if file does not exist. Default: UNDEFINED
+- `:rack_env` - Sets a revision value to Rack's `env` hash. Default: `env['rack.app_revision']`
 
 ## Test
 
@@ -47,4 +63,4 @@ Permission is hereby granted, free of charge, to any person obtaining a copy of
 
 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/rack/revision.rb

@@ -7,18 +7,19 @@ module Rack
 
     def initialize(app, options={})
       @options = {
-        :header   => options[:header]   || 'X-Revision',
+        :header   => options[:header].nil? ? 'X-Revision' : options[:header],
         :filename => options[:filename] || 'REVISION',
-        :default  => options[:default]  || 'UNDEFINED' 
+        :default  => options[:default]  || 'UNDEFINED',
+        :rack_env => options[:rack_env].nil? ? 'rack.app_revision' : options[:rack_env]
       }
 
       @app = app
-      @file = File.join(Dir.pwd, @options[:filename])
     end
  
     def call(env)
+      env[@options[:rack_env]] = revision if @options[:rack_env]
       status, headers, body = @app.call(env)
-      headers[@options[:header]] = revision
+      headers[@options[:header]] = revision if @options[:header]
       [status, headers, body]
     end
 
@@ -33,7 +34,11 @@ module Rack
     end
  
     def read_revision
-      File.exists?(@file) ? File.read(@file).strip : @options[:default]
+      File.exists?(detected_filename) ? File.read(detected_filename).strip : @options[:default]
+    end
+
+    def detected_filename
+      @file ||= (@options[:filename] =~ /\A\// ? @options[:filename] : File.join(Dir.pwd, @options[:filename]))
     end
   end
-end
+end

data/lib/rack/revision/version.rb

@@ -1,5 +1,5 @@
 module Rack
   class Revision
-    VERSION = '1.0.0'
+    VERSION = '1.0.1'
   end
 end

data/rack-revision.gemspec

@@ -8,9 +8,10 @@ Gem::Specification.new do |s|
   s.homepage    = "http://github.com/sosedoff/rack-revision"
   s.authors     = ["Dan Sosedoff"]
   s.email       = ["dan.sosedoff@gmail.com"]
-    
+
   s.add_runtime_dependency 'rack', '>= 1.0'
-  
+  s.add_development_dependency 'rack-test', '>= 0'
+
   s.files              = `git ls-files`.split("\n")
   s.test_files         = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables        = `git ls-files -- bin/*`.split("\n").map{|f| File.basename(f)}

data/test/test_revision.rb

@@ -46,6 +46,15 @@ class TestRevision < Test::Unit::TestCase
     assert_not_nil last_response.headers['X-Revision']
   end
 
+  def test_blank
+    self.app = Rack::Revision.new(default_app, :header => false)
+    self.app.reset_revision
+    get app_url
+
+    assert_nil last_response.headers['X-REVISION']
+    assert_nil last_response.headers['X-Revision']
+  end
+
   def test_default_value
     self.app.reset_revision
     get app_url
@@ -69,7 +78,7 @@ class TestRevision < Test::Unit::TestCase
     assert_not_nil last_response.headers['FOOBAR']
   end
 
-  def test_default_filename
+  def test_custom_filename
     File.open('./test/tmp/REVISION', 'w') { |f| f.write('qwe123') }
 
     self.app = Rack::Revision.new(default_app, :filename => './test/tmp/REVISION')
@@ -78,4 +87,39 @@ class TestRevision < Test::Unit::TestCase
     get app_url
     assert_equal 'qwe123', last_response.headers['X-Revision']
   end
-end
+
+  def test_custom_filename_starting_from_root
+    File.open('./test/tmp/REVISION', 'w') { |f| f.write('qwe123') }
+    filename = File.expand_path("./test/tmp/REVISION")
+
+    self.app = Rack::Revision.new(default_app, :filename => filename)
+    self.app.reset_revision
+
+    get app_url
+    assert_equal 'qwe123', last_response.headers['X-Revision']
+  end
+
+  def test_env_is_present
+    self.app.reset_revision
+    get app_url
+
+    assert_not_nil last_request.env['rack.app_revision']
+  end
+
+  def test_custom_env
+    self.app = Rack::Revision.new(default_app, :rack_env => 'rack.custom_env')
+    self.app.reset_revision
+    get app_url
+
+    assert_nil last_request.env['rack.app_revision']
+    assert_not_nil last_request.env['rack.custom_env']
+  end
+
+  def test_disable_env
+    self.app = Rack::Revision.new(default_app, :rack_env => false)
+    self.app.reset_revision
+    get app_url
+
+    assert_nil last_request.env['rack.app_revision']
+  end
+end

metadata

@@ -1,39 +1,48 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: rack-revision
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 1.0.1
   prerelease: 
-  version: 1.0.0
 platform: ruby
-authors: 
+authors:
 - Dan Sosedoff
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-11-26 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-12-17 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rack
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2157761320 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "1.0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.0'
   type: :runtime
-  version_requirements: *id001
-description: Adds an extra X-REVISION header with source code revision string (git, svn, etc)
-email: 
+  prerelease: false
+  version_requirements: *2157761320
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: &2157759940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2157759940
+description: Adds an extra X-REVISION header with source code revision string (git,
+  svn, etc)
+email:
 - dan.sosedoff@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - README.md
 - Rakefile
@@ -43,31 +52,28 @@ files:
 - test/test_revision.rb
 homepage: http://github.com/sosedoff/rack-revision
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Code ravision rack middleware
-test_files: 
+test_files:
 - test/test_revision.rb
 has_rdoc: