versioncake 0.1.0 → 0.2.0

data/.gitignore

@@ -1,4 +1,5 @@
 .idea
 .rvmrc
 spec/log
-log/
+log/
+*.gem

data/Gemfile.lock

@@ -2,6 +2,9 @@ PATH
   remote: .
   specs:
     versioncake (0.1.0)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
 
 GEM
   remote: http://rubygems.org/
@@ -29,7 +32,6 @@ GEM
       multi_json (~> 1.0)
     arel (3.0.2)
     builder (3.0.0)
-    diff-lcs (1.1.3)
     erubis (2.7.0)
     hike (1.2.1)
     i18n (0.6.1)
@@ -56,19 +58,6 @@ GEM
     rake (0.9.2.2)
     rdoc (3.12)
       json (~> 1.4)
-    rspec (2.11.0)
-      rspec-core (~> 2.11.0)
-      rspec-expectations (~> 2.11.0)
-      rspec-mocks (~> 2.11.0)
-    rspec-core (2.11.1)
-    rspec-expectations (2.11.2)
-      diff-lcs (~> 1.1.3)
-    rspec-mocks (2.11.2)
-    rspec-rails (2.11.0)
-      actionpack (>= 3.0)
-      activesupport (>= 3.0)
-      railties (>= 3.0)
-      rspec (~> 2.11.0)
     sprockets (2.1.3)
       hike (~> 1.2)
       rack (~> 1.0)
@@ -90,7 +79,6 @@ DEPENDENCIES
   multi_json
   rack
   rake
-  rspec-rails
   sqlite3
   test-unit
   tzinfo

data/README.md

@@ -1,8 +1,12 @@
 # Version Cake [![Build Status](https://secure.travis-ci.org/bwillis/versioncake.png?branch=master)](http://travis-ci.org/bwillis/versioncake)
 
-Version Cake is a way to easily version views in your Rails app.
+Co-authored by Ben Willis ([@bwillis](https://github.com/bwillis/)) and Jim Jones ([@aantix](https://github.com/aantix)).
 
-## Install - not release yet
+Version Cake is an unobtrusive way to version views in your Rails app. 
+
+We were tired of urls with version numbers, namespacing controllers with versions, and bumping all resources everytime we supported a new version. Simply configure your supported version numbers, create a versioned view if you need one and let versioncake render the requested version or gracefully degrade to the latest supported view version.
+
+## Install
 
 ```
 gem install versioncake
@@ -10,22 +14,26 @@ gem install versioncake
 
 ## How to use
 
-### Configure
+### Configuration
 
-You need to define the supported versions in your Rails application.rb file as
-```view_versions```. Use this config to set the range of supported API
-versions that can be served:
+You need to define the supported versions in your Rails application.rb file as `view_versions`. Use this config to set the range of supported API versions that can be served:
 
 ```ruby
 config.view_versions = [1,3,4,5] # or (1...5)
-#config.view_version_extraction_strategy = :http_parameter # options = :http_header, :http_accept_parameter, :query_parameter, custom Proc
 ```
+You can also define the way to extract the version. The `view_version_extraction_strategy` allows you to set one of the default strategies or provide a proc to set your own. You can also pass it a prioritized array of the strategies.
+```ruby
+config.view_version_extraction_strategy = :http_parameter # [:http_header, :http_accept_parameter, :query_parameter]
+```
+These are the default strategies:
+ - **http_header**: Api version HTTP header ie. ```API-Version: 1```
+ - **http_accept_parameter**: HTTP Accept header ie. ```Accept: application/xml; version=1``` [why do this?](http://blog.steveklabnik.com/posts/2011-07-03-nobody-understands-rest-or-http#i_want_my_api_to_be_versioned)
+ - **query_parameter**: version in the url query parameter, for testing or to override for special case ie. ```http://localhost:3000/posts.json?api_version=1```
+ - **custom**: `lambda {|request| request.headers["HTTP_X_API_VERSION"].to_i }` takes the request object and must return an integer
 
 ### Version your views
 
-When a client makes a request to your controller the latest version of the
-view will be rendered. The latest version is determined by naming the template
-or partial with a version number that you configured to support.
+When a client makes a request to your controller the latest version of the view will be rendered. The latest version is determined by naming the template or partial with a version number that you configured to support.
 
 ```
 - app/views/posts
@@ -39,37 +47,31 @@ or partial with a version number that you configured to support.
     - _form.html.erb
 ```
 
-If you start supporting a newer version, v3 for instance, a request for the latest
-version of posts/show will gracefully degrade to the latest support available
-version, in this case posts/show.v2.json.jbuilder.
+If you start supporting a newer version, v3 for instance, you do not have to copy posts/show.v2 to posts/show.v3. By default, the request for v3 or higher will gracefully degrade to the view that is the newest, supported version, in this case posts/show.v2.
+
+### Controller
+
+You don't need to do anything special in your controller, but if you find that you want to perform some tasks for a specific version you can use `requested_version` and `latest_version`. This may be updated in the [near future](https://github.com/bwillis/versioncake/issues/1).
 
 ### Client requests
 
-When a client makes a request it will automatically receive the latest supported
-version of the view. The client can also request for a specific version by one of three
-strategies configured by ``view_version_extraction_strategy``:
+When a client makes a request it will automatically receive the latest supported version of the view. The client can also request for a specific version by one of the strategies configured by ``view_version_extraction_strategy``.
 
- - http_header: Api version HTTP header ie. ```API-Version: 1```
- - http_accept_parameter: HTTP Accept header ie. ```Accept: application/xml; version=1```
-  - http://blog.steveklabnik.com/posts/2011-07-03-nobody-understands-rest-or-http#i_want_my_api_to_be_versioned
- - query_parameter: version in the url query parameter ie. ```http://localhost:3000/posts.json?api_version=1```
+# Related Material
 
-A custom strategy is available by providing a proc to the ``view_version_extraction_strategy`` configuration. It
-takes a single parameter of the current request and must return an integer.
+## Libraries
 
-```ruby
-Proc.new { |request| request.headers["HTTP_X_API_MAGIC"].to_i }
-```
+- https://github.com/bploetz/versionist
+- https://github.com/filtersquad/rocket_pants
 
-## Development Work
+## Discussions
 
-1. Finish convertion of Rspec tests to TestUnit
-2. Syntatic sugar controller helpers to detect the version - interface discussion: https://github.com/bwillis/versioncake/commit/3dbdaf612ff99676c499a456f3e858e22382e76b#commitcomment-1847368
-3. Log the version requested in the logs
+- [Steve Klabnik on how to version in a resful way](http://blog.steveklabnik.com/posts/2011-07-03-nobody-understands-rest-or-http#i_want_my_api_to_be_versioned)
+- [Rails API project disucssion on versioning](https://github.com/spastorino/rails-api/issues/8)
 
-# Similar Libraries
+# Questions?
 
-- https://github.com/bploetz/versionist
+Create a bug/enhancement/question on github or contact [aantix](https://github.com/aantix) or [bwillis](https://github.com/bwillis) through github.
 
 # License
 

data/Rakefile

@@ -1,31 +1,17 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 
 require 'rake/dsl_definition'
-require "bundler"
+require 'bundler'
 Bundler.setup
 
-require "rspec"
-require "rspec/core/rake_task"
 require 'rake/testtask'
 
-$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
-
 Bundler::GemHelper.install_tasks
 
-task :default => :spec
-
-RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = 'spec/**/*_spec.rb'
-end
-
-$: << "."
-$: << "./test"
+task :default => :test
 
 Rake::TestTask.new do |i|
-  #i.libs << '.'
   i.libs << 'test'
   i.test_files = FileList['test/**/*_test.rb']
-  #i.test_files = FileList['test/test_*.rb']
-  #i.test_files = FileList.new('test/**/*_test.rb')
   i.verbose = true
 end

data/lib/versioncake/version.rb

@@ -1,3 +1,3 @@
 module VersionCake
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/test/template/render_test.rb

@@ -0,0 +1,34 @@
+require "test_helper"
+
+class VersionRenderTest < ActiveSupport::TestCase
+
+  def setup
+    path = ActionView::FileSystemResolver.new(FIXTURE_LOAD_PATH)
+    view_paths = ActionView::PathSet.new([path])
+    @view = ActionView::Base.new(view_paths)
+  end
+
+  def test_regression_renders_unversioned_template
+    @view.lookup_context.versions = [:v0]
+    assert_equal "template", @view.render(:template => "templates/versioned")
+  end
+
+  def test_render_template_defaults_to_latest_template_version
+    assert_equal "template v3", @view.render(:template => "templates/versioned")
+  end
+
+  def test_render_template_with_parameter_version_override
+    assert_equal "template v1", @view.render(:template => "templates/versioned", :versions => :v1)
+  end
+
+  def test_render_template_with_legacy_version
+    @view.lookup_context.versions = [:v2]
+    assert_equal "template v2", @view.render(:template => "templates/versioned")
+  end
+
+  def test_render_template_gracefully_degrades
+    @view.lookup_context.versions = [:v4,:v3,:v2,:v1]
+    assert_equal "template v3", @view.render(:template => "templates/versioned")
+  end
+
+end

data/test/test_helper.rb

@@ -9,24 +9,9 @@ require 'rails/all'
 require 'rails/test_help'
 require 'test/unit'
 
-
 require File.expand_path('../config/application', __FILE__)
 
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-
-root = File.expand_path(File.dirname(__FILE__))
-
-class ActiveSupport::TestCase
-  # Setup all fixtures in test/fixtures/*.(yml|csv) for all tests in alphabetical order.
-  #
-  # Note: You'll currently still have to declare fixtures explicitly in integration tests
-  # -- they do not yet inherit this setting
-  fixtures :all
-
-  # Add more helper methods to be used by all tests here...
-end
-
-RendersTest::Application.initialize!
+FIXTURE_LOAD_PATH = File.join(File.dirname(__FILE__), 'fixtures')
+FIXTURES = Pathname.new(FIXTURE_LOAD_PATH)
 
-Dir.glob(File.dirname(__FILE__) + "/app/controllers/**/*").each{|f| require(f) if File.file?(f)}
+RendersTest::Application.initialize!

data/versioncake.gemspec

@@ -11,13 +11,16 @@ Gem::Specification.new do |s|
   s.summary     = %q{Easily render versions of your rails views.}
   s.description = %q{Render versioned views automagically based on the clients requested version.}
 
-  #s.rubyforge_project = ""
-
   s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.test_files    = `git ls-files -- {test}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_development_dependency "rspec-rails"
+  s.add_dependency('actionpack', '>= 3.0')
+  s.add_dependency('activesupport', '>= 3.0')
+  s.add_dependency('railties', '>= 3.0')
+
+  s.add_development_dependency "test-unit"
   s.add_development_dependency "mocha"
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: versioncake
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,10 +10,58 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-13 00:00:00.000000000Z
+date: 2012-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rspec-rails
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -66,30 +114,6 @@ files:
 - lib/versioncake/action_view/template.rb
 - lib/versioncake/action_view/versions.rb
 - lib/versioncake/version.rb
-- spec/app/controllers/renders_controller.rb
-- spec/app/views/renders/index.html.erb
-- spec/app/views/renders/index.v1.html.erb
-- spec/app/views/renders/index.v2.html.erb
-- spec/config.ru
-- spec/config/application.rb
-- spec/config/database.yml
-- spec/config/routes.rb
-- spec/db/test.sqlite3
-- spec/fixtures/partials/_versioned.erb
-- spec/fixtures/partials/_versioned.v1.erb
-- spec/fixtures/partials/_versioned.v2.erb
-- spec/fixtures/partials/_versioned.v3.erb
-- spec/fixtures/partials/another_versioned_partial.erb
-- spec/fixtures/partials/another_versioned_partial.v1.erb
-- spec/fixtures/templates/unversioned.html.erb
-- spec/fixtures/templates/versioned.html.erb
-- spec/fixtures/templates/versioned.v1.html.erb
-- spec/fixtures/templates/versioned.v2.html.erb
-- spec/fixtures/templates/versioned.v3.html.erb
-- spec/script/rails
-- spec/spec_helper.rb
-- spec/template/render_spec.rb
-- spec/template/resolver_spec.rb
 - test/app/controllers/renders_controller.rb
 - test/app/views/renders/index.html.erb
 - test/app/views/renders/index.v1.html.erb
@@ -99,8 +123,20 @@ files:
 - test/config/database.yml
 - test/config/routes.rb
 - test/db/test.sqlite3
+- test/fixtures/partials/_versioned.erb
+- test/fixtures/partials/_versioned.v1.erb
+- test/fixtures/partials/_versioned.v2.erb
+- test/fixtures/partials/_versioned.v3.erb
+- test/fixtures/partials/another_versioned_partial.erb
+- test/fixtures/partials/another_versioned_partial.v1.erb
+- test/fixtures/templates/unversioned.html.erb
+- test/fixtures/templates/versioned.html.erb
+- test/fixtures/templates/versioned.v1.html.erb
+- test/fixtures/templates/versioned.v2.html.erb
+- test/fixtures/templates/versioned.v3.html.erb
 - test/functional/renders_controller_test.rb
 - test/script/rails
+- test/template/render_test.rb
 - test/test_helper.rb
 - versioncake.gemspec
 homepage: https://github.com/bwillis/versioncake
@@ -123,44 +159,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.19
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Easily render versions of your rails views.
-test_files:
-- spec/app/controllers/renders_controller.rb
-- spec/app/views/renders/index.html.erb
-- spec/app/views/renders/index.v1.html.erb
-- spec/app/views/renders/index.v2.html.erb
-- spec/config.ru
-- spec/config/application.rb
-- spec/config/database.yml
-- spec/config/routes.rb
-- spec/db/test.sqlite3
-- spec/fixtures/partials/_versioned.erb
-- spec/fixtures/partials/_versioned.v1.erb
-- spec/fixtures/partials/_versioned.v2.erb
-- spec/fixtures/partials/_versioned.v3.erb
-- spec/fixtures/partials/another_versioned_partial.erb
-- spec/fixtures/partials/another_versioned_partial.v1.erb
-- spec/fixtures/templates/unversioned.html.erb
-- spec/fixtures/templates/versioned.html.erb
-- spec/fixtures/templates/versioned.v1.html.erb
-- spec/fixtures/templates/versioned.v2.html.erb
-- spec/fixtures/templates/versioned.v3.html.erb
-- spec/script/rails
-- spec/spec_helper.rb
-- spec/template/render_spec.rb
-- spec/template/resolver_spec.rb
-- test/app/controllers/renders_controller.rb
-- test/app/views/renders/index.html.erb
-- test/app/views/renders/index.v1.html.erb
-- test/app/views/renders/index.v2.html.erb
-- test/config.ru
-- test/config/application.rb
-- test/config/database.yml
-- test/config/routes.rb
-- test/db/test.sqlite3
-- test/functional/renders_controller_test.rb
-- test/script/rails
-- test/test_helper.rb
+test_files: []

data/spec/app/controllers/renders_controller.rb

@@ -1,4 +0,0 @@
-class RendersController < ActionController::Base
-  def index
-  end
-end

data/spec/app/views/renders/index.html.erb

@@ -1 +0,0 @@
-index.html.erb

data/spec/app/views/renders/index.v1.html.erb

@@ -1 +0,0 @@
-index.v1.html.erb

data/spec/app/views/renders/index.v2.html.erb

@@ -1 +0,0 @@
-index.v2.html.erb

data/spec/config/application.rb

@@ -1,13 +0,0 @@
-module RendersTest
-  class Application < Rails::Application
-    config.encoding = "utf-8"
-    config.filter_parameters += [:password]
-    config.active_support.escape_html_entities_in_json = true
-    config.active_record.whitelist_attributes = true
-    config.assets.enabled = true
-    config.assets.version = '1.0'
-    config.active_support.deprecation = :stderr
-    config.view_versions = (1..4)
-    config.view_version_extraction_strategy = :http_header
-  end
-end

data/spec/config/database.yml

@@ -1,4 +0,0 @@
-test:
-  adapter: sqlite3
-  database: db/test.sqlite3
-  timeout: 5000

data/spec/config/routes.rb

@@ -1,3 +0,0 @@
-RendersTest::Application.routes.draw do
-  resources :renders
-end

data/spec/spec_helper.rb

@@ -1,27 +0,0 @@
-require 'bundler'
-Bundler.require
-
-require 'versioncake'
-require 'rspec'
-require 'rails/all'
-require 'rspec/rails'
-require 'config/application'
-
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-
-ENV["RAILS_ENV"] ||= 'test'
-
-root = File.expand_path(File.dirname(__FILE__))
-
-# Initialize the application
-RendersTest::Application.initialize!
-
-RSpec.configure do |config|
-  config.mock_with :mocha
-end
-
-FIXTURE_LOAD_PATH = File.join(File.dirname(__FILE__), 'fixtures')
-FIXTURES = Pathname.new(FIXTURE_LOAD_PATH)
-
-Dir.glob(File.dirname(__FILE__) + "/app/controllers/**/*").each{|f| require(f) if File.file?(f)}

data/spec/template/render_spec.rb

@@ -1,34 +0,0 @@
-require "spec_helper"
-
-describe "RenderTestCases" do
-
-  before do
-    path = ActionView::FileSystemResolver.new(FIXTURE_LOAD_PATH)
-    view_paths = ActionView::PathSet.new([path])
-    @view = ActionView::Base.new(view_paths,{})
-  end
-
-  it "renders the unversioned template (regression)" do
-    @view.lookup_context.versions = [:v0]
-    @view.render(:template => "templates/versioned").should == "template"
-  end
-
-  it "renders the latest version of the template" do
-    @view.render(:template => "templates/versioned").should == "template v3"
-  end
-
-  it "renders the overridden version of the template" do
-    @view.render(:template => "templates/versioned", :versions => :v1).should == "template v1"
-  end
-
-  it "renders the legacy version of the template" do
-    @view.lookup_context.versions = [:v2]
-    @view.render(:template => "templates/versioned").should == "template v2"
-  end
-
-  it "renders the latest available version of the requested template" do
-    @view.lookup_context.versions = [:v4,:v3,:v2,:v1]
-    @view.render(:template => "templates/versioned").should == "template v3"
-  end
-
-end

data/spec/template/resolver_spec.rb

@@ -1,12 +0,0 @@
-require "spec_helper"
-
-describe "Resolver" do
-
-  it "extracts the correct handler and format from a versioned template" do
-    resolver = ActionView::PathResolver.new
-    handler, format = resolver.send "extract_handler_and_format", "/some/path/to/app/views/index.v1.xml.builder", nil
-    handler.class.should == ActionView::Template::Handlers::Builder
-    format.should == "application/xml"
-  end
-
-end