restful_route_version 0.0.2

data/Gemfile

@@ -0,0 +1,11 @@
+source "http://rubygems.org"
+
+gem "rails", "3.0.7"
+gem "rake"
+
+group :test do
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem 'shoulda'
+end
+

data/Gemfile.lock

@@ -0,0 +1,81 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.7)
+      actionpack (= 3.0.7)
+      mail (~> 2.2.15)
+    actionpack (3.0.7)
+      activemodel (= 3.0.7)
+      activesupport (= 3.0.7)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.5.0)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.14)
+      rack-test (~> 0.5.7)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.7)
+      activesupport (= 3.0.7)
+      builder (~> 2.1.2)
+      i18n (~> 0.5.0)
+    activerecord (3.0.7)
+      activemodel (= 3.0.7)
+      activesupport (= 3.0.7)
+      arel (~> 2.0.2)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.7)
+      activemodel (= 3.0.7)
+      activesupport (= 3.0.7)
+    activesupport (3.0.7)
+    arel (2.0.10)
+    builder (2.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    git (1.2.5)
+    i18n (0.5.0)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    mail (2.2.19)
+      activesupport (>= 2.3.6)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    polyglot (0.3.1)
+    rack (1.2.3)
+    rack-mount (0.6.14)
+      rack (>= 1.0.0)
+    rack-test (0.5.7)
+      rack (>= 1.0)
+    rails (3.0.7)
+      actionmailer (= 3.0.7)
+      actionpack (= 3.0.7)
+      activerecord (= 3.0.7)
+      activeresource (= 3.0.7)
+      activesupport (= 3.0.7)
+      bundler (~> 1.0)
+      railties (= 3.0.7)
+    railties (3.0.7)
+      actionpack (= 3.0.7)
+      activesupport (= 3.0.7)
+      rake (>= 0.8.7)
+      thor (~> 0.14.4)
+    rake (0.8.7)
+    shoulda (2.11.3)
+    thor (0.14.6)
+    treetop (1.4.9)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.27)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.2)
+  rails (= 3.0.7)
+  rake
+  shoulda

data/LICENSE

@@ -0,0 +1,3 @@
+Copyright (c) 2010 Hemant Kumar ( mail [at] gnufied [dot] org )
+
+The Library is dual licensed under terms of Ruby License or MIT License.

data/MIT-LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2010 Hemant Kumar ( mail [at] gnufied [dot] org )
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+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.

data/README.md

@@ -0,0 +1,53 @@
+# Restful Route Version #
+
+### Useful for creating inheritable routes and controllers ###
+
+Features
+----------
+
+1. It extends routing API of rails, letting us inherit routes between versions:
+
+```ruby
+version_namespace :api do
+  version_namespace(:v10,:cache_route => true) do
+    resources :articles
+    resources :comments
+    resources :notes
+  end     
+
+  version_namespace(:v11, :cache_route => true) do
+    inherit_routes("/api/v10", :except => %w(articles))
+    resources :articles
+    resources :tags
+  end
+
+  version_namespace(:v12) do
+    inherit_routes("/api/v11",:except => %w(notes))
+    resources :lessons
+  end
+end
+```
+
+   Important thing to remember is only routes which were cached via `cache_route => true` can be 
+   reused for inheritance. Normal namespace blocks aren't cached.
+   
+2. Dynamically defines controllers between versions. In other words if v11 inherits 'notes' route
+   from v10, and v11 doesn't have its own NotesController defined the, plugin will
+   automatically define `Api::V11::NotesController` which will inherit from `Api::V10::NotesController`. 
+   
+
+3. Inherits view files (such as index.xml.builder) between versions. For example if `V11::ArticlesController`
+   inherits `V10::ArticlesController` it will as well inherit all the view files of `v10/articles/`
+   and hence there won't be any need to copy the view files around when creating new version of the API.
+
+  
+  Template inheritance will work out of box on Rails 3.1, but if you are still on 3.0.x series,
+  you can use it now :
+
+```ruby
+class Api::V10::BaseController < ActionController::Base
+   restful_route_version
+end
+```
+
+4. Works with Ruby 1.9.2 and Ruby 1.8.7

data/Rakefile

@@ -0,0 +1,40 @@
+require 'rubygems'
+require 'rake'
+desc "Run tests"
+task :test do
+  test_files = Dir["test/*_test.rb"]
+  $:.unshift(File.dirname(__FILE__)) unless
+    $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+  test_files.each { |x| load(x) }
+end
+
+
+begin
+  gem 'jeweler', '~> 1.4'
+  require 'jeweler'
+
+  Jeweler::Tasks.new do |gem|
+    gem.name        = 'restful_route_version'
+    gem.summary     = 'Versioning your routes in Rails3'
+    gem.description = 'Versioning your routes in Rails3'
+    gem.email       = 'gethemant@gmail.com'
+    
+    gem.homepage    = 'http://github.com/gnufied/%s' % gem.name
+
+    gem.authors     = [ 'Hemant Kumar']
+
+    gem.rubyforge_project = 'restful_route_version'
+
+    gem.add_dependency 'activesupport',   '~> 3.0.0'
+    gem.add_dependency 'actionpack',      '~> 3.0.0'
+    gem.add_dependency 'railties',        '~> 3.0.0'
+  end
+
+  Jeweler::GemcutterTasks.new
+
+  FileList['tasks/**/*.rake'].each { |task| import task }
+rescue LoadError
+  puts 'Jeweler (or a dependency) not available. Install it with: gem install jeweler'
+end
+
+task(:spec) {} # stub out the spec task for as long as we don't have any specs

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/lib/restful_route_version.rb

@@ -0,0 +1,2 @@
+require 'restful_route_version/railtie'
+

data/lib/restful_route_version/dependency_ext.rb

@@ -0,0 +1,15 @@
+module RestfulRouteVersion
+  module DependencyExt
+    mattr_accessor :dynamically_defined_constants
+    self.dynamically_defined_constants = Set.new()
+
+    def remove_unloadable_constants!
+      autoloaded_constants.each { |const|
+        remove_constant const unless dynamically_defined_constants.include?(const)
+      }
+      autoloaded_constants.clear
+      ActiveSupport::Dependencies::Reference.clear!
+      explicitly_unloadable_constants.each { |const| remove_constant const }
+    end
+  end
+end

data/lib/restful_route_version/inherited_view_resolver.rb

@@ -0,0 +1,26 @@
+module RestfulRouteVersion
+
+  module ControllerExt
+    def restful_route_version
+      view_paths.each do |path|
+        append_view_path(InheritedViewResolver.new(path.to_s))
+      end
+    end
+  end
+
+  class InheritedViewResolver < ::ActionView::FileSystemResolver
+    def find_templates(name, prefix, partial, details)
+      klass = "#{prefix}_controller".camelize.constantize rescue nil
+
+      return [] if !klass || !(klass < ActionController::Base)
+
+      ancestor = klass.ancestors.second
+      ancestor_prefix = ancestor.name.gsub(/Controller$/, '').underscore
+
+      templates = super(name, ancestor_prefix, partial, details)
+      return templates if templates.present?
+      find_templates(name, ancestor_prefix, partial, details)
+    end
+
+  end
+end

data/lib/restful_route_version/railtie.rb

@@ -0,0 +1,22 @@
+require "rails"
+
+require "restful_route_version/dependency_ext"
+require "restful_route_version/version_mapper"
+require "restful_route_version/inherited_view_resolver"
+
+module RestfulRouteVersion
+  VERSION = '0.0.2'
+  class Railtie < Rails::Railtie
+
+    initializer "restful_route_version.configure_rails_initialization" do
+      ActionDispatch::Routing::Mapper.send(:include, RestfulRouteVersion::VersionMapper)
+      ActiveSupport::Dependencies.send(:include, RestfulRouteVersion::DependencyExt)
+      ActiveSupport::Dependencies.extend(RestfulRouteVersion::DependencyExt)
+      ActionController::Base.extend(ControllerExt)
+    end
+  end
+end
+
+
+
+

data/lib/restful_route_version/version_mapper.rb

@@ -0,0 +1,109 @@
+module RestfulRouteVersion
+  module VersionMapper
+    attr_accessor :cached_namespace_blocks
+    def version_namespace(path, options = {}, &block)
+      #puts "Calling version_namespace"
+      path = path.to_s
+      options = { :path => path, :as => path, :module => path,
+                  :shallow_path => path, :shallow_prefix => path }.merge!(options)
+      
+      @cached_namespace_blocks ||= {}
+      
+
+      scope(options) { 
+        create_controller_class(@scope[:module].to_s.camelize,Module.new)
+        @cached_namespace_blocks[@scope[:path]] = block if options[:cache_route]
+        block.call 
+      }
+    end
+
+    def resources(*resources, &block)
+      except_options = @scope[:options][:except]
+      return if skip_resource?(resources,except_options)
+      super(*resources, &block)
+    end
+
+    def resource(*resources, &block)
+      except_options = @scope[:options][:except]
+      return if skip_resource?(resources,except_options)
+      super(*resources, &block)
+    end
+
+    def skip_resource?(resources, except_options)
+      #puts "********** incoming #{resources.inspect} and except_options #{except_options.inspect} and path #{@scope[:path]} **********"
+      return false if(resources.length > 1 || except_options.blank?)
+      return true if except_options.include?(resources.first.to_s)
+      false
+    end
+
+    def inherit_routes(*entities)
+      #puts "Current path #{@scope[:path]} and old one #{entities.first}"
+      options = entities.extract_options!
+      new_options = merge_except_options(options)
+      #puts "New options are #{new_options.inspect}"
+      new_options[:old_namespace] = @scope[:options][:old_namespace] || entities.dup.shift
+
+
+      entities.each { |entity|
+        inherited_route_block = @cached_namespace_blocks[entity]
+        inherited_route_block && scope(new_options) do
+          inherited_route_block.call()
+        end
+      }
+      create_derived_controllers(new_options[:old_namespace], new_options)
+    end
+
+    def merge_except_options(options)
+      options[:except] ||= []
+      options[:namespace] = @scope[:path]
+      if old_exception_option = @scope[:options][:except]
+        options[:except] += old_exception_option
+      end
+      options
+    end
+
+    def create_derived_controllers(old_namespace, options = {})
+      old_namespace.gsub!(/^\/?/,'')
+      current_namespace = options[:namespace].gsub(/^\/?/,'')
+      Dir["#{Rails.root}/app/controllers/#{old_namespace}/*.rb"].each do |controller_file_name|
+        require_or_load(controller_file_name)
+      end
+
+      exclude_constants = options[:except].blank? ? [] : options[:except]
+
+      controllers_to_exclude = exclude_constants.map { |x| (old_namespace + "/#{x}Controller").camelize }
+      #puts "Old namespace is #{old_namespace}"
+      old_namespace.camelize.constantize.constants.each do |constant_name|
+        #puts "Incoming constant #{constant_name}"
+        full_constant_name = old_namespace.camelize + "::" + constant_name.to_s
+        new_controller_name = "#{current_namespace.camelize}::#{constant_name}"
+        #puts "Defining constant #{new_controller_name} with parent #{full_constant_name}"
+        if create_controller_dynamically?(controllers_to_exclude, full_constant_name, new_controller_name)
+          create_controller_class(new_controller_name,Class.new(full_constant_name.constantize))
+        end
+      end
+    end
+
+    def create_controller_dynamically?(controllers_to_exclude, old_controller_name, new_controller_name)
+      !controllers_to_exclude.include?(old_controller_name) &&
+        old_controller_name =~ /Controller$/ &&
+        !File.exists?("#{Rails.root}/app/controllers/#{new_controller_name.underscore}.rb")
+    end
+
+
+    def create_controller_class(full_constant_name, klass_constant)
+      #puts "Full constant_name is #{full_constant_name}"
+      names = full_constant_name.split('::')
+      ActiveSupport::Dependencies.dynamically_defined_constants << full_constant_name
+      names.shift if names.empty? || names.first.empty?
+      constant = Object
+      names.each do |name|
+        if constant.const_defined?(name)
+          constant = constant.const_get(name)
+        else
+          constant = constant.const_set(name, klass_constant)
+        end
+      end
+    end
+  end
+end

data/restful_route_version.gemspec

@@ -0,0 +1,99 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{restful_route_version}
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Hemant Kumar"]
+  s.date = %q{2011-06-12}
+  s.description = %q{Versioning your routes in Rails3}
+  s.email = %q{gethemant@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.md"
+  ]
+  s.files = [
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE",
+    "MIT-LICENSE",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/restful_route_version.rb",
+    "lib/restful_route_version/dependency_ext.rb",
+    "lib/restful_route_version/inherited_view_resolver.rb",
+    "lib/restful_route_version/railtie.rb",
+    "lib/restful_route_version/version_mapper.rb",
+    "restful_route_version.gemspec",
+    "test/dependency_ext_test.rb",
+    "test/fixture_files/a.rb",
+    "test/fixture_files/b.rb",
+    "test/fixture_files/c.rb",
+    "test/rails_sandbox/app/controllers/api/v10/articles_controller.rb",
+    "test/rails_sandbox/app/controllers/api/v10/notes_controller.rb",
+    "test/rails_sandbox/app/controllers/api/v10/questions_controller.rb",
+    "test/rails_sandbox/app/controllers/api/v10/songs_controller.rb",
+    "test/rails_sandbox/app/controllers/api/v11/articles_controller.rb",
+    "test/rails_sandbox/app/controllers/api/v11/tags_controller.rb",
+    "test/rails_sandbox/app/views/api/v10/songs/_bar.erb",
+    "test/rails_sandbox/app/views/api/v10/songs/create.html.erb",
+    "test/rails_sandbox/app/views/api/v10/songs/foo.html.erb",
+    "test/rails_sandbox/app/views/api/v10/songs/index.html.erb",
+    "test/rails_sandbox/app/views/api/v10/songs/show.html.erb",
+    "test/rails_sandbox/app/views/api/v11/songs/_wow.html.erb",
+    "test/rails_sandbox/app/views/api/v11/songs/bar.html.erb",
+    "test/rails_sandbox/app/views/api/v11/songs/baz.html.erb",
+    "test/rails_sandbox/app/views/api/v11/songs/show.html.erb",
+    "test/test_helper.rb",
+    "test/version_mapper_test.rb"
+  ]
+  s.homepage = %q{http://github.com/gnufied/restful_route_version}
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{restful_route_version}
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{Versioning your routes in Rails3}
+  s.test_files = [
+    "test/dependency_ext_test.rb",
+    "test/fixture_files/a.rb",
+    "test/fixture_files/b.rb",
+    "test/fixture_files/c.rb",
+    "test/rails_sandbox/app/controllers/api/v10/articles_controller.rb",
+    "test/rails_sandbox/app/controllers/api/v10/notes_controller.rb",
+    "test/rails_sandbox/app/controllers/api/v10/questions_controller.rb",
+    "test/rails_sandbox/app/controllers/api/v10/songs_controller.rb",
+    "test/rails_sandbox/app/controllers/api/v11/articles_controller.rb",
+    "test/rails_sandbox/app/controllers/api/v11/tags_controller.rb",
+    "test/test_helper.rb",
+    "test/version_mapper_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rails>, ["= 3.0.7"])
+      s.add_runtime_dependency(%q<rake>, [">= 0"])
+      s.add_runtime_dependency(%q<activesupport>, ["~> 3.0.0"])
+      s.add_runtime_dependency(%q<actionpack>, ["~> 3.0.0"])
+      s.add_runtime_dependency(%q<railties>, ["~> 3.0.0"])
+    else
+      s.add_dependency(%q<rails>, ["= 3.0.7"])
+      s.add_dependency(%q<rake>, [">= 0"])
+      s.add_dependency(%q<activesupport>, ["~> 3.0.0"])
+      s.add_dependency(%q<actionpack>, ["~> 3.0.0"])
+      s.add_dependency(%q<railties>, ["~> 3.0.0"])
+    end
+  else
+    s.add_dependency(%q<rails>, ["= 3.0.7"])
+    s.add_dependency(%q<rake>, [">= 0"])
+    s.add_dependency(%q<activesupport>, ["~> 3.0.0"])
+    s.add_dependency(%q<actionpack>, ["~> 3.0.0"])
+    s.add_dependency(%q<railties>, ["~> 3.0.0"])
+  end
+end
+

data/test/dependency_ext_test.rb

@@ -0,0 +1,50 @@
+require_relative "test_helper"
+
+class RestfulRouteVersionDependenciesTest < Test::Unit::TestCase
+  context "For RestfulRouteVersionDependencies" do 
+    setup do
+      ActiveSupport::Dependencies.dynamically_defined_constants << "Foo"
+      ActiveSupport::Dependencies.dynamically_defined_constants << "Bar"
+      ActiveSupport::Dependencies.dynamically_defined_constants << "C"
+    end
+
+    should "only remove constants which were not dynamically defined" do
+      with_autoloading_fixtures do
+        Object.const_set(:Foo,Class.new)
+        Object.const_set(:Bar,Class.new)
+        Object.const_get(:A)
+        Object.const_get(:B)
+        Object.const_get(:C)
+        ActiveSupport::Dependencies.clear
+        assert !Object.const_defined?(:A)
+        assert !Object.const_defined?(:B)
+        assert Object.const_defined?(:Foo)
+        assert Object.const_defined?(:Bar)
+        assert Object.const_defined?(:C)
+      end
+    end
+  end
+
+  def with_loading(*from)
+    old_mechanism, ActiveSupport::Dependencies.mechanism = ActiveSupport::Dependencies.mechanism, :load
+    this_dir = File.dirname(__FILE__)
+    parent_dir = File.dirname(this_dir)
+    path_copy = $LOAD_PATH.dup
+    $LOAD_PATH.unshift(parent_dir) unless $LOAD_PATH.include?(parent_dir)
+    prior_autoload_paths = ActiveSupport::Dependencies.autoload_paths
+    ActiveSupport::Dependencies.autoload_paths = from.collect { |f| "#{this_dir}/#{f}" }
+    yield
+  ensure
+    $LOAD_PATH.replace(path_copy)
+    ActiveSupport::Dependencies.autoload_paths = prior_autoload_paths
+    ActiveSupport::Dependencies.mechanism = old_mechanism
+    ActiveSupport::Dependencies.explicitly_unloadable_constants = []
+  end
+
+  def with_autoloading_fixtures(&block)
+    with_loading 'fixture_files', &block
+  end
+
+end
+
+

data/test/fixture_files/a.rb

@@ -0,0 +1,2 @@
+class A
+end

data/test/fixture_files/b.rb

@@ -0,0 +1,2 @@
+class B
+end

data/test/fixture_files/c.rb

@@ -0,0 +1,2 @@
+class C
+end

data/test/rails_sandbox/app/controllers/api/v10/articles_controller.rb

@@ -0,0 +1,10 @@
+module Api
+  module V10
+    class ArticlesController < ActionController::Base
+      restful_route_version
+      def index
+        render :text => "Hello world from v10 ArticlesController"
+      end
+    end
+  end
+end

data/test/rails_sandbox/app/controllers/api/v10/notes_controller.rb

@@ -0,0 +1,6 @@
+class Api::V10::NotesController < ActionController::Base
+  restful_route_version
+  def index
+    render :text => "Hello from V10 notes controller, lolz"
+  end
+end

data/test/rails_sandbox/app/controllers/api/v10/questions_controller.rb

@@ -0,0 +1,10 @@
+module Api
+  module V10
+    class QuestionsController < ActionController::Base
+      restful_route_version
+      def index
+        render :text => "Hello world from v10 QuestionsController"
+      end
+    end
+  end
+end

data/test/rails_sandbox/app/controllers/api/v10/songs_controller.rb

@@ -0,0 +1,26 @@
+module Api
+  module V10
+    class SongsController < ActionController::Base
+      restful_route_version
+      def index
+      end
+
+      def show
+        
+      end
+
+      def create
+      end
+
+      def foo
+      end
+
+      def bar
+        
+      end
+
+      def baz
+      end
+    end
+  end
+end

data/test/rails_sandbox/app/controllers/api/v11/articles_controller.rb

@@ -0,0 +1,9 @@
+module Api
+  module V11
+    class ArticlesController < Api::V10::ArticlesController
+      def index
+        render :text => "Hello world from v11 ArticlesController"
+      end
+    end
+  end
+end

data/test/rails_sandbox/app/controllers/api/v11/tags_controller.rb

@@ -0,0 +1,9 @@
+module Api
+  module V11
+    class TagsController < ActionController::Base
+      def index
+        render :text => "Hello world from v11 ArticlesController"
+      end
+    end
+  end
+end

data/test/rails_sandbox/app/views/api/v10/songs/_bar.erb

@@ -0,0 +1 @@
+bar

data/test/rails_sandbox/app/views/api/v10/songs/create.html.erb

@@ -0,0 +1 @@
+Calling Songs#create from v10

data/test/rails_sandbox/app/views/api/v10/songs/foo.html.erb

@@ -0,0 +1 @@
+Calling Foo from <%= render :partial => 'bar' -%>

data/test/rails_sandbox/app/views/api/v10/songs/index.html.erb

@@ -0,0 +1 @@
+Hello from v10 of Music#index

data/test/rails_sandbox/app/views/api/v10/songs/show.html.erb

@@ -0,0 +1 @@
+Calling Songs#show from v10

data/test/rails_sandbox/app/views/api/v11/songs/_wow.html.erb

@@ -0,0 +1 @@
+baz

data/test/rails_sandbox/app/views/api/v11/songs/bar.html.erb

@@ -0,0 +1 @@
+Dude this is <%= render :partial => 'bleh' -%>

data/test/rails_sandbox/app/views/api/v11/songs/baz.html.erb

@@ -0,0 +1 @@
+Hello from <%= render :partial => 'wow' -%> dude

data/test/rails_sandbox/app/views/api/v11/songs/show.html.erb

@@ -0,0 +1 @@
+Calling Songs#show from v11

data/test/test_helper.rb

@@ -0,0 +1,60 @@
+require "rubygems"
+gem 'activesupport', '~> 3.0.7'
+gem 'actionpack', '~> 3.0.7'
+gem 'activerecord', '~> 3.0.7'
+gem 'rails', '~> 3.0.7'
+
+require "active_support"
+require "active_support/dependencies"
+require "active_support/core_ext/hash/slice"
+require "action_controller"
+require "action_view"
+require "action_pack"
+
+require "shoulda"
+
+class MockLogger
+  attr_reader :logged
+
+  def initialize
+    @logged = []
+  end
+
+  def method_missing(method, *args)
+    @logged << args.first
+  end
+end
+
+class MockBacktraceCleaner < ActiveSupport::BacktraceCleaner
+end
+
+$:<< File.join(File.dirname(__FILE__), "..", "lib")
+$:<< File.join(File.dirname(__FILE__), "rails_sandbox", "app", "controllers")
+
+require "restful_route_version"
+ActionDispatch::Routing::Mapper.send(:include, RestfulRouteVersion::VersionMapper)
+ActiveSupport::Dependencies.send(:include, RestfulRouteVersion::DependencyExt)
+ActiveSupport::Dependencies.extend(RestfulRouteVersion::DependencyExt)
+ActionController::Base.extend(RestfulRouteVersion::ControllerExt)
+
+module Rails
+  def self.root
+    File.expand_path(File.join(File.dirname(__FILE__), "rails_sandbox"))
+  end
+
+  def self.backtrace_cleaner
+    @@backtrace_cleaner ||= MockBacktraceCleaner.new()
+  end
+  def self.env
+    @_env ||= ActiveSupport::StringInquirer.new(ENV["RAILS_ENV"] || ENV["RACK_ENV"] || "test")
+  end
+
+  def self.env_defaults
+    {}
+  end
+
+  def self.application
+    self
+  end
+end
+

data/test/version_mapper_test.rb

@@ -0,0 +1,201 @@
+require_relative "test_helper"
+
+class VersionMapperTest < Test::Unit::TestCase
+  context "Versioned routing extension" do
+    setup do
+      @route_set = ActionDispatch::Routing::RouteSet.new()
+      @mapper = ActionDispatch::Routing::Mapper.new(@route_set)
+    end
+
+    should "provide version_namespace routing method" do
+      assert @mapper.respond_to?(:version_namespace)
+    end
+
+    should "capture specified namespace when using version_namespace" do
+      route_block = lambda do
+        version_namespace("foo") do
+          resources :articles
+        end
+      end
+      @mapper.instance_exec(&route_block)
+      assert !ActiveSupport::Dependencies.dynamically_defined_constants.blank?
+    end
+
+    should "capture route block if cache_route is true when using version_namespace" do
+      route_block = lambda do
+        version_namespace("foo", :cache_route => true) do
+          resources :articles
+        end
+      end
+      @mapper.instance_exec(&route_block)
+      assert !@mapper.cached_namespace_blocks["/foo"].blank?
+    end
+
+    should "provide inherit_routes routing method" do
+      assert @mapper.respond_to?(:inherit_routes)
+    end
+  end
+
+  context "Restful route extension with inherit_routes" do
+    setup do
+      @route_set = ActionDispatch::Routing::RouteSet.new()
+      @mapper = ActionDispatch::Routing::Mapper.new(@route_set)
+
+      @route_block = lambda do
+        version_namespace :api do
+          version_namespace(:v10,:cache_route => true) do
+            resources :articles
+            resources :comments
+            resources :notes
+          end
+
+          version_namespace(:v11, :cache_route => true) do
+            inherit_routes("/api/v10", :except => %w(articles))
+            resources :articles
+            resources :tags
+          end
+
+          version_namespace(:v12) do
+            inherit_routes("/api/v11",:except => %w(notes))
+            resources :lessons
+          end
+        end #end of map.version_namespace(:api)
+      end #end of route_block
+
+    end #end of setup block
+
+    should "create derived routes when using inherit_routes" do
+      @mapper.instance_exec(&@route_block)
+      v12_tag_route = @route_set.named_routes.routes[:edit_api_v12_tag]
+      assert !v12_tag_route.blank?
+      assert_match /\/api\/v12\/tags\/\:id\/edit/, v12_tag_route.to_s
+    end
+    
+    should "not create routes for except resources" do
+      @mapper.instance_exec(&@route_block)
+      article_route = @route_set.named_routes.routes[:new_api_v12_article]
+      assert !article_route.blank?
+
+      note_route = @route_set.named_routes.routes[:new_api_v12_note]
+      assert note_route.blank?
+    end
+  end
+
+  context "Restful route extension with inherit_routes and creating controllers dynamically" do
+    setup do 
+      @route_set = ActionDispatch::Routing::RouteSet.new()
+      @mapper = ActionDispatch::Routing::Mapper.new(@route_set)
+
+      @route_block = lambda do
+        version_namespace :api do
+          version_namespace(:v10,:cache_route => true) do
+            resources :articles
+            resources :notes
+          end
+  
+          version_namespace(:v11, :cache_route => true) do
+            inherit_routes("/api/v10", :except => %w(articles))
+            resources :tags
+            resources :articles
+          end
+
+          version_namespace(:v12) do
+            inherit_routes("/api/v11")
+            resources :lessons
+          end
+  
+        end #end of map.version_namespace(:api)
+      end #end of route_block
+    end #end of setup block
+
+    should "automatically load classes which has to be loaded dynamically" do
+      @mapper.instance_exec(&@route_block)
+      assert defined?(Api::V11::NotesController)
+      t_superclass = Api::V11::NotesController.superclass.to_s
+      assert_equal "Api::V10::NotesController", t_superclass
+
+      assert defined?(Api::V12::NotesController)
+      assert_equal "Api::V11::NotesController", Api::V12::NotesController.superclass.to_s
+    end
+  end #end of context inherit_routes
+
+
+  context "Inherit controller with except" do 
+    setup do 
+      @route_set = ActionDispatch::Routing::RouteSet.new()
+      @mapper = ActionDispatch::Routing::Mapper.new(@route_set)
+
+      @route_block = lambda do
+        version_namespace :api do
+          version_namespace(:v10,:cache_route => true) do
+            resources :articles
+            resources :notes
+          end
+  
+          version_namespace(:v11, :cache_route => true) do
+            inherit_routes("api/v10", :except => %w(articles))
+            resources :tags
+            resources :articles
+          end
+
+          version_namespace(:v12) do
+            inherit_routes("api/v11", :except => %w(tags))
+            resources :lessons
+          end
+  
+        end #end of map.version_namespace(:api)
+      end #end of route_block
+    end #end of setup block
+
+    should "not create controllers in only specified namespace" do
+      @mapper.instance_exec(&@route_block)
+      ActiveSupport::Dependencies.remove_constant("Api::V12::TagsController")
+
+      assert defined?(Api::V11::ArticlesController)
+      assert defined?(Api::V12::ArticlesController)
+      assert (Api::V12::ArticlesController < Api::V11::ArticlesController)
+      assert (Api::V12::NotesController < Api::V11::NotesController)
+      assert (Api::V11::NotesController < Api::V10::NotesController)
+      assert !defined?(Api::V12::TagsController)
+    end
+  end
+
+  context "Inherit controller with except for non-existant" do 
+    setup do
+      ActiveSupport::Dependencies.remove_constant("Api::V11::QuestionsController")
+      ActiveSupport::Dependencies.remove_constant("Api::V12::QuestionsController")
+      @route_set = ActionDispatch::Routing::RouteSet.new()
+      @mapper = ActionDispatch::Routing::Mapper.new(@route_set)      
+
+      @route_block = lambda do
+        version_namespace :api do
+          version_namespace(:v10,:cache_route => true) do
+            resources :articles
+            resources :notes
+            resources :questions
+          end
+          
+          version_namespace(:v11, :cache_route => true) do
+            inherit_routes("api/v10", :except => %w(articles questions))
+            resources :tags
+            resources :articles
+          end
+
+          version_namespace(:v12) do
+            inherit_routes("api/v11")
+            resources :lessons
+          end
+        end #end of map.version_namespace(:api)
+      end #end of route_block
+
+    end #end of setup block
+
+    should "not create controllers in only specified namespace" do
+      @mapper.instance_exec(&@route_block)
+      assert defined?(Api::V10::QuestionsController)
+      assert !defined?(Api::V11::QuestionsController)
+      assert !defined?(Api::V12::QuestionsController)
+    end
+  end
+  
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification 
+name: restful_route_version
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Hemant Kumar
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-12 00:00:00 +05:30
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 3.0.7
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: actionpack
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: railties
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id005
+description: Versioning your routes in Rails3
+email: gethemant@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- MIT-LICENSE
+- README.md
+- Rakefile
+- VERSION
+- lib/restful_route_version.rb
+- lib/restful_route_version/dependency_ext.rb
+- lib/restful_route_version/inherited_view_resolver.rb
+- lib/restful_route_version/railtie.rb
+- lib/restful_route_version/version_mapper.rb
+- restful_route_version.gemspec
+- test/dependency_ext_test.rb
+- test/fixture_files/a.rb
+- test/fixture_files/b.rb
+- test/fixture_files/c.rb
+- test/rails_sandbox/app/controllers/api/v10/articles_controller.rb
+- test/rails_sandbox/app/controllers/api/v10/notes_controller.rb
+- test/rails_sandbox/app/controllers/api/v10/questions_controller.rb
+- test/rails_sandbox/app/controllers/api/v10/songs_controller.rb
+- test/rails_sandbox/app/controllers/api/v11/articles_controller.rb
+- test/rails_sandbox/app/controllers/api/v11/tags_controller.rb
+- test/rails_sandbox/app/views/api/v10/songs/_bar.erb
+- test/rails_sandbox/app/views/api/v10/songs/create.html.erb
+- test/rails_sandbox/app/views/api/v10/songs/foo.html.erb
+- test/rails_sandbox/app/views/api/v10/songs/index.html.erb
+- test/rails_sandbox/app/views/api/v10/songs/show.html.erb
+- test/rails_sandbox/app/views/api/v11/songs/_wow.html.erb
+- test/rails_sandbox/app/views/api/v11/songs/bar.html.erb
+- test/rails_sandbox/app/views/api/v11/songs/baz.html.erb
+- test/rails_sandbox/app/views/api/v11/songs/show.html.erb
+- test/test_helper.rb
+- test/version_mapper_test.rb
+has_rdoc: true
+homepage: http://github.com/gnufied/restful_route_version
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: -2262431187530772954
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: restful_route_version
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Versioning your routes in Rails3
+test_files: 
+- test/dependency_ext_test.rb
+- test/fixture_files/a.rb
+- test/fixture_files/b.rb
+- test/fixture_files/c.rb
+- test/rails_sandbox/app/controllers/api/v10/articles_controller.rb
+- test/rails_sandbox/app/controllers/api/v10/notes_controller.rb
+- test/rails_sandbox/app/controllers/api/v10/questions_controller.rb
+- test/rails_sandbox/app/controllers/api/v10/songs_controller.rb
+- test/rails_sandbox/app/controllers/api/v11/articles_controller.rb
+- test/rails_sandbox/app/controllers/api/v11/tags_controller.rb
+- test/test_helper.rb
+- test/version_mapper_test.rb