cartage-rack 1.0 → 1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1fa674a4148825b651ef4b4877a11512f398fccf
-  data.tar.gz: 41fd855e575def1e21c4822ad926825bbfb29f84
+  metadata.gz: f1f756831e081111a68cf696035705057d5b06a8
+  data.tar.gz: 5d02f8976aa4b7433e9c8d96c6ccc3558007e50b
 SHA512:
-  metadata.gz: bd9c50ca6065c103d6df58d84541be5d9d342955e1ce14ed5e103bd31a78d6098a95e405f8c55b371eb31657dc9e9aac408723901a02f553aba9460f4f4af232
-  data.tar.gz: cdf0ee60b847b6c8450c7c87492474147691bcd880554a091ddf4ec287c33b721667f0b7f4ced8012f538ef985a05704c159b8f6375b7f892341b90f9b4f7587
+  metadata.gz: da2f68e98d8ae476143c955ea2e8e1921b89890491a5b7ed41746bf518c42a8c9c26cb824397bfe4557c67da3686826ffd4f2b24f3023c2d90dd76e002f84d57
+  data.tar.gz: 0515b3f19b46cdd5725ff1650ea4d87b7c354a16e535ccafe7282488558f4de09a159ee560c1f1ed2fa79f25938f4adcb266616ae31609359d78d7a5ea44c9d2

data/.travis.yml

@@ -0,0 +1,36 @@
+---
+sudo: false
+language: ruby
+rvm:
+  - "2.2"
+  - "2.1"
+  - 2.0.0
+  - ruby-head
+  - jruby-head
+  - jruby-9.0.0.0.pre1
+  - rbx-2
+matrix:
+  allow_failures:
+    - rvm: rbx-2
+    - rvm: jruby-head
+    - rvm: jruby-9.0.0.0.pre1
+    - rvm: ruby-head
+gemfile:
+  - Gemfile
+before_script:
+  - |
+    case "${TRAVIS_RUBY_VERSION}" in
+      rbx*)
+        gem install psych
+        ;;
+    esac
+  - rake travis:before -t
+script: rake travis
+after_script:
+  - rake travis:after -t
+notifications:
+  email:
+    recipients:
+      - aziegler@kineticcafe.com
+    on_success: change
+    on_failure: always

data/History.rdoc

@@ -1,3 +1,24 @@
+=== 1.1 / 2015-04-11
+
+*   2 minor enhancements
+
+    *   Implemented Cartage::Rack#inspect to prevent <tt>rake routes</tt> from
+        presenting badly.
+
+    *   Preparing for a future Cartage change to the contents of the
+        +release_hashref+ file. The future +release_hashref+ will be two lines:
+
+            hashref
+            timestamp
+
+        If +release_hashref+ has two lines, the timestamp will be included in
+        the response. A timestamp will not be included if there is no
+        +release_hashref+ file.
+
+*   1 development change
+
+    *   Implemented tests for Cartage::Rack.
+
 === 1.0 / 2015-03-20
 
 *   1 major enhancement

data/Manifest.txt

@@ -1,6 +1,7 @@
 .autotest
 .gemtest
 .minitest.rb
+.travis.yml
 Contributing.rdoc
 Gemfile
 History.rdoc
@@ -9,3 +10,5 @@ Manifest.txt
 README.rdoc
 Rakefile
 lib/cartage/rack.rb
+test/minitest_config.rb
+test/test_cartage_rack.rb

data/README.rdoc

@@ -40,14 +40,30 @@ It can then be queried easily:
     % rails start
     % curl localhost:3000/release
     development: (git) main
-    % curl localhost:3000/release.json
-    { "env" : "development", "release_hashref" : "(git) main" }
+    % curl localhost:3000/release.json | jshon
+    {
+      "env" : "development",
+      "release_hashref" : "(git) main"
+    }
+
+If there is a +release_hashref+ file, the value returned will be from this
+file. There are two versions of +release_hashref+ files supported; the original
+format (Cartage 1.0 and 1.1) has one line (just the hashref of the release).
+The new format has two lines, the hashref of the release and the timestamp of
+the release.
+
+    % curl localhost:3000/release.json | jshon
+    {
+      "env" : "production",
+      "release_hashref" : "134458c3e3c02dd7c1cac8d5d41d85ce1e4decab"
+      "timestamp" : "20150411001143"
+    }
 
 == Install
 
 Add cartage-rack to your Gemfile:
 
-    gem 'cartage-rack', '~> 1.0'
+    gem 'cartage-rack', '~> 1.1'
 
 Or manually install:
 

data/Rakefile

@@ -10,6 +10,7 @@ Hoe.plugin :gemspec2
 Hoe.plugin :git
 Hoe.plugin :minitest
 Hoe.plugin :rubygems
+Hoe.plugin :travis
 
 spec = Hoe.spec 'cartage-rack' do
   developer('Austin Ziegler', 'aziegler@kineticcafe.com')
@@ -25,6 +26,7 @@ spec = Hoe.spec 'cartage-rack' do
   self.extra_dev_deps << ['hoe-doofus', '~> 1.0']
   self.extra_dev_deps << ['hoe-gemspec2', '~> 1.1']
   self.extra_dev_deps << ['hoe-git', '~> 1.5']
+  self.extra_dev_deps << ['hoe-travis', '~> 1.2']
   self.extra_dev_deps << ['minitest', '~> 5.4']
   self.extra_dev_deps << ['minitest-autotest', '~> 1.0']
   self.extra_dev_deps << ['minitest-bisect', '~> 1.2']
@@ -34,6 +36,15 @@ spec = Hoe.spec 'cartage-rack' do
   self.extra_dev_deps << ['simplecov', '~> 0.7']
 end
 
+module Hoe::Publish
+  alias_method :original_make_rdoc_cmd, :make_rdoc_cmd
+
+  def make_rdoc_cmd(*extra_args) # :nodoc:
+    spec.extra_rdoc_files.reject! { |f| f == 'Manifest.txt' }
+    original_make_rdoc_cmd(*extra_args)
+  end
+end
+
 namespace :test do
   task :coverage do
     prelude = <<-EOS

data/lib/cartage/rack.rb

@@ -1,4 +1,5 @@
 require 'pathname'
+require 'json'
 
 # Cartage, a package builder.
 class Cartage; end
@@ -10,12 +11,12 @@ class Cartage; end
 # If +release_hashref+ does not exist, Cartage::Rack will read the hash of the
 # current HEAD.
 class Cartage::Rack
-  VERSION = '1.0' #:nodoc:
+  VERSION = '1.1' #:nodoc:
 
   # Creates a new version of the Cartage::Rack application to the specified
   # +root_path+, or +Dir.pwd+.
-  def self.mount(root_path = Dir.pwd)
-    new(root_path)
+  def self.mount(root_path = nil)
+    new(root_path || Dir.pwd)
   end
 
   # Sets the root path for Cartage::Rack.
@@ -25,28 +26,51 @@ class Cartage::Rack
 
   # The Rack application method.
   def call(env)
-    file = @root_path.join('release_hashref')
-    release_hashref = if file.exist?
-                        file.read
-                      elsif @root_path.join('.git').directory?
-                        "(git) #{%x(git rev-parse --abbrev-ref HEAD)}"
-                      else
-                        'UNKNOWN - no release_hashref or source control directory'
-                      end
-    application_env = ENV['RAILS_ENV'] || ENV['RACK_ENV'] || 'UNKNOWN'
+    content = {
+      env:             application_env,
+      release_hashref: release_hashref,
+      timestamp:       timestamp
+    }.delete_if(&->(_, v) { v.nil? })
 
     case env['PATH_INFO']
     when /\.json\z/
       type = 'application/json'
-      body = {
-        env: application_env,
-        release_hashref: release_hashref
-      }.to_json
+      body = content.to_json
     else
       type = 'text/plain'
-      body = "#{application_env}: #{release_hashref}"
+      body = "#{content[:env]}: #{content[:release_hashref]}"
+      body += " (#{content[:timestamp]})" if content[:timestamp]
     end
 
     [ '200', { 'Content-Type' => type }, [ body ] ]
   end
+
+  def inspect
+    %Q(#{self.class} for #{@root_path.expand_path.basename})
+  end
+
+  private
+  def application_env
+    ENV['RAILS_ENV'] || ENV['RACK_ENV'] || 'UNKNOWN'
+  end
+
+  def release_hashref
+    file = @root_path.join('release_hashref')
+    if file.exist?
+      file.read.split($/).first.chomp
+    elsif @root_path.join('.git').directory?
+      "(git) #{%x(git rev-parse --abbrev-ref HEAD).chomp}"
+    else
+      'UNKNOWN - no release_hashref or .git directory'
+    end
+  end
+
+  def timestamp
+    file = @root_path.join('release_hashref')
+    if file.exist?
+      stamp = file.read.split($/, 2)[1]
+      stamp = nil if stamp && stamp.empty?
+      stamp.chomp if stamp
+    end
+  end
 end

data/test/minitest_config.rb

@@ -0,0 +1,51 @@
+# -*- ruby encoding: utf-8 -*-
+
+gem 'minitest'
+require 'rack/test'
+require 'minitest/autorun'
+require 'minitest/pretty_diff'
+require 'minitest/focus'
+require 'minitest/moar'
+require 'minitest/bisect'
+
+require 'cartage/rack'
+
+module Minitest::ENVStub
+  def stub_dir_pwd value, *block_args, &block
+    if defined? Minitest::Moar::Stubbing
+      stub Dir, :pwd, value, *block_args, &block
+    else
+      Dir.stub :pwd, value, *block_args, &block
+    end
+  end
+
+  def stub_env env, options = {}, *block_args, &block
+    mock = lambda { |key|
+      env.fetch(key) { |k|
+        if options[:passthrough]
+          ENV.send(:"__minitest_stub__[]", k)
+        else
+          nil
+        end
+      }
+    }
+
+    if defined? Minitest::Moar::Stubbing
+      stub ENV, :[], mock, *block_args, &block
+    else
+      ENV.stub :[], mock, *block_args, &block
+    end
+  end
+
+  def stub_backticks value
+    Kernel.send(:alias_method, :__stub_backticks__, :`)
+    Kernel.send(:define_method, :`) { |*| value }
+    yield
+  ensure
+    Kernel.send(:undef_method, :`)
+    Kernel.send(:alias_method, :`, :__stub_backticks__)
+    Kernel.send(:undef_method, :__stub_backticks__)
+  end
+
+  Minitest::Test.send(:include, self)
+end

data/test/test_cartage_rack.rb

@@ -0,0 +1,131 @@
+# -*- ruby encoding: utf-8 -*-
+
+require 'minitest_config'
+
+describe Cartage::Rack do
+  include Rack::Test::Methods
+
+  let(:app) { Cartage::Rack.mount(path) }
+  let(:path) { 'test/application' }
+
+  it 'inspects nicely for `rake routes` in Rails' do
+    stub_dir_pwd path do
+      assert_equal 'Cartage::Rack for application', Cartage::Rack.mount.inspect
+    end
+  end
+
+  it 'returns text/plain content by default' do
+    instance_stub Cartage::Rack, :application_env, 'env' do
+      instance_stub Cartage::Rack, :release_hashref, 'ref' do
+        get '/'
+
+        assert_equal 'text/plain', last_response.header['Content-Type']
+      end
+    end
+  end
+
+  it 'returns application/json content when requested' do
+    instance_stub Cartage::Rack, :application_env, 'env' do
+      instance_stub Cartage::Rack, :release_hashref, 'ref' do
+        get '/.json'
+
+        assert_equal 'application/json', last_response.header['Content-Type']
+      end
+    end
+  end
+
+  describe 'application_env' do
+    it 'uses RAILS_ENV first' do
+      instance_stub Cartage::Rack, :release_hashref, 'release_hashref' do
+        stub_env({ 'RAILS_ENV' => 'vne_sliar', 'RACK_ENV' => 'vne_kcar' }) do
+          get '/'
+
+          assert last_response.ok?
+          assert_equal 'vne_sliar: release_hashref', last_response.body
+          assert_equal 'text/plain', last_response.header['Content-Type']
+        end
+      end
+    end
+
+    it 'uses RACK_ENV second' do
+      instance_stub Cartage::Rack, :release_hashref, 'release_hashref' do
+        stub_env({ 'RACK_ENV' => 'vne_kcar' }) do
+          get '/'
+
+          assert last_response.ok?
+          assert_equal 'vne_kcar: release_hashref', last_response.body
+          assert_equal 'text/plain', last_response.header['Content-Type']
+        end
+      end
+    end
+
+    it 'uses RACK_ENV second' do
+      instance_stub Cartage::Rack, :release_hashref, 'release_hashref' do
+        stub_env({}) do
+          get '/'
+
+          assert last_response.ok?
+          assert_equal 'UNKNOWN: release_hashref', last_response.body
+          assert_equal 'text/plain', last_response.header['Content-Type']
+        end
+      end
+    end
+  end
+
+  describe 'release_hashref' do
+    it 'looks for ./release_hashref' do
+      stub_env({ 'RAILS_ENV' => 'x' }) do
+        instance_stub Pathname, :exist?, true do
+          instance_stub Pathname, :read, "file-contents\n" do
+            get '/'
+
+            assert last_response.ok?
+            assert_equal 'x: file-contents', last_response.body
+          end
+        end
+      end
+    end
+
+    it 'looks for ./release_hashref (multi-line)' do
+      stub_env({ 'RAILS_ENV' => 'x' }) do
+        instance_stub Pathname, :exist?, true do
+          instance_stub Pathname, :read, "file-contents\ntimestamp\n" do
+            get '/'
+
+            assert last_response.ok?
+            assert_equal 'x: file-contents (timestamp)', last_response.body
+          end
+        end
+      end
+    end
+
+    it 'looks for .git next' do
+      stub_env({ 'RAILS_ENV' => 'x' }) do
+        instance_stub Pathname, :exist?, false do
+          instance_stub Pathname, :directory?, true do
+            stub_backticks 'HEAD' do
+              get '/'
+
+              assert last_response.ok?
+              assert_equal 'x: (git) HEAD', last_response.body
+            end
+          end
+        end
+      end
+    end
+
+    it 'defaults to a string value' do
+      stub_env({ 'RAILS_ENV' => 'x' }) do
+        instance_stub Pathname, :exist?, false do
+          instance_stub Pathname, :directory?, false do
+            get '/'
+
+            assert last_response.ok?
+            assert_equal 'x: UNKNOWN - no release_hashref or .git directory',
+              last_response.body
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,209 +1,223 @@
 --- !ruby/object:Gem::Specification
 name: cartage-rack
 version: !ruby/object:Gem::Version
-  version: '1.0'
+  version: '1.1'
 platform: ruby
 authors:
 - Austin Ziegler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-24 00:00:00.000000000 Z
+date: 2015-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '5.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '5.5'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '4.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.6'
 - !ruby/object:Gem::Dependency
   name: hoe-doofus
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
   name: hoe-gemspec2
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.1'
 - !ruby/object:Gem::Dependency
   name: hoe-git
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: hoe-travis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: minitest-autotest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
   name: minitest-bisect
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.2'
 - !ruby/object:Gem::Dependency
   name: minitest-focus
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.1'
 - !ruby/object:Gem::Dependency
   name: minitest-moar
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.0'
 - !ruby/object:Gem::Dependency
   name: minitest-pretty_diff
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.1'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.7'
 - !ruby/object:Gem::Dependency
   name: hoe
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3.13'
 description: |-
@@ -226,9 +240,10 @@ extra_rdoc_files:
 - Manifest.txt
 - README.rdoc
 files:
-- ".autotest"
-- ".gemtest"
-- ".minitest.rb"
+- .autotest
+- .gemtest
+- .minitest.rb
+- .travis.yml
 - Contributing.rdoc
 - Gemfile
 - History.rdoc
@@ -237,29 +252,31 @@ files:
 - README.rdoc
 - Rakefile
 - lib/cartage/rack.rb
+- test/minitest_config.rb
+- test/test_cartage_rack.rb
 homepage: https://github.com/KineticCafe/cartage-rack/
 licenses:
 - MIT
 metadata: {}
 post_install_message: 
 rdoc_options:
-- "--main"
+- --main
 - README.rdoc
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: cartage-rack is a plug-in for {cartage}[https://github.com/KineticCafe/cartage]