versionist 0.1.3 → 0.2.0

data/lib/generators/versionist/copy_api_version/USAGE

@@ -0,0 +1,19 @@
+Description:
+    Copies an existing API version to a new API version.
+
+Example:
+    rails generate versionist:copy_api_version v2.0.0 V2_0_0 v3.0.0 V3_0_0
+
+    This will do the following:
+
+    route  api_version(:module => "V3__0__0", :header=>"Accept", :value=>"application/vnd.mycompany.com-v3.0.0") do
+    end
+    Copying all files from app/controllers/v2_0_0 to app/controllers/v3_0_0
+    Copying all files from spec/controllers/v2_0_0 to spec/controllers/v3_0_0
+    Copying all files from app/presenters/v2_0_0 to app/presenters/v3_0_0
+    Copying all files from spec/presenters/v2_0_0 to spec/presenters/v3_0_0
+    Copying all files from public/docs/v2.0.0 to public/docs/v3.0.0
+
+Note: routes can only be copied with MRI Ruby 1.9 and above, as this feature relies on Ripper which is only available 
+in stdlib in MRI Ruby 1.9 and above. Outside of routes copying, the other copy steps will work just fine in Ruby 1.8 and other
+non-MRI Ruby implementations.

data/lib/generators/versionist/copy_api_version/copy_api_version_generator.rb

@@ -0,0 +1,134 @@
+require 'yard'
+require 'fileutils'
+
+module Versionist
+  class CopyApiVersionGenerator < Rails::Generators::Base
+    include InflectorFixes
+
+    desc "copies an existing API version a new API version"
+
+    source_root File.expand_path('../templates', __FILE__)
+
+    argument :old_version, :type => :string
+    argument :old_module_name, :type => :string
+    argument :new_version, :type => :string
+    argument :new_module_name, :type => :string
+
+    def validate_old_version
+      in_root do
+        api_version_block = /api_version.*:module\s*(=>|:)\s*("|')#{module_name_for_route(old_module_name)}("|').*do/
+        matching_version_blocks = File.readlines("config/routes.rb").grep(api_version_block)
+        raise "old API version #{old_module_name} not found in config/routes.rb" if matching_version_blocks.empty?
+        raise "old API version module namespace #{old_module_name} not found in app/controllers" if !File.exists?("app/controllers/#{module_name_for_path(old_module_name)}")
+        raise "old API version module namespace #{old_module_name} not found in app/presenters" if !File.exists?("app/presenters/#{module_name_for_path(old_module_name)}")
+        case Versionist.configuration.configured_test_framework
+        when :test_unit
+          raise "old API version module namespace #{old_module_name} not found in test/functional/#{module_name_for_path(old_module_name)}" if !File.exists?("test/functional/#{module_name_for_path(old_module_name)}")
+          raise "old API version module namespace #{old_module_name} not found in test/presenters/#{module_name_for_path(old_module_name)}" if !File.exists?("test/presenters/#{module_name_for_path(old_module_name)}")
+        when :rspec
+          raise "old API version module namespace #{old_module_name} not found in spec/controllers/#{module_name_for_path(old_module_name)}" if !File.exists?("spec/controllers/#{module_name_for_path(old_module_name)}")
+          raise "old API version module namespace #{old_module_name} not found in spec/presenters/#{module_name_for_path(old_module_name)}" if !File.exists?("spec/presenters/#{module_name_for_path(old_module_name)}")
+        end
+        raise "old API version #{old_version} not found in public/docs" if !File.exists?("public/docs/#{old_version}")
+      end
+    end
+
+    def copy_routes
+      in_root do
+        if RUBY_VERSION =~ /1.8/ || !defined?(RUBY_ENGINE) || RUBY_ENGINE != "ruby"
+          log "ERROR: Cannot copy routes as this feature relies on the Ripper library, which is only available in MRI 1.9."
+          return
+        end
+        parser = YARD::Parser::SourceParser.parse_string(File.read("config/routes.rb"))
+        existing_routes = nil
+        parser.enumerator.first.traverse do |node|
+          existing_routes = node.source if node.type == :fcall && node.source =~ /api_version.*:module\s*(=>|:)\s*("|')#{module_name_for_route(old_module_name)}("|')/
+        end
+        copied_routes = String.new(existing_routes)
+        copied_routes.gsub!(/"#{module_name_for_route(old_module_name)}"/, "\"#{module_name_for_route(new_module_name)}\"")
+        copied_routes.gsub!(/#{old_version}/, new_version)
+        route copied_routes
+      end
+    end
+
+    def copy_controllers
+      in_root do
+        log "Copying all files from app/controllers/#{module_name_for_path(old_module_name)} to app/controllers/#{module_name_for_path(new_module_name)}"
+        FileUtils.cp_r "app/controllers/#{module_name_for_path(old_module_name)}", "app/controllers/#{module_name_for_path(new_module_name)}"
+        Dir.glob("app/controllers/#{module_name_for_path(new_module_name)}/*.rb").each do |f|
+          text = File.read(f)
+          File.open(f, 'w') {|f| f << text.gsub(/#{old_module_name}/, new_module_name)}
+        end
+      end
+    end
+
+    # due to the inflector quirks we can't use hook_for :test_framework
+    def copy_controller_tests
+      in_root do
+        case Versionist.configuration.configured_test_framework
+        when :test_unit
+          log "Copying all files from test/functional/#{module_name_for_path(old_module_name)} to test/functional/#{module_name_for_path(new_module_name)}"
+          FileUtils.cp_r "test/functional/#{module_name_for_path(old_module_name)}", "test/functional/#{module_name_for_path(new_module_name)}"
+          Dir.glob("test/functional/#{module_name_for_path(new_module_name)}/*.rb").each do |f|
+            text = File.read(f)
+            File.open(f, 'w') {|f| f << text.gsub(/#{old_module_name}/, new_module_name)}
+          end
+        when :rspec
+          log "Copying all files from spec/controllers/#{module_name_for_path(old_module_name)} to spec/controllers/#{module_name_for_path(new_module_name)}"
+          FileUtils.cp_r "spec/controllers/#{module_name_for_path(old_module_name)}", "spec/controllers/#{module_name_for_path(new_module_name)}"
+          Dir.glob("spec/controllers/#{module_name_for_path(new_module_name)}/*.rb").each do |f|
+            text = File.read(f)
+            File.open(f, 'w') {|f| f << text.gsub(/#{old_module_name}/, new_module_name)}
+          end
+        else
+          say "Unsupported test_framework: #{Versionist.configuration.configured_test_framework}"
+        end
+      end
+    end
+
+    def copy_presenters
+      in_root do
+        log "Copying all files from app/presenters/#{module_name_for_path(old_module_name)} to app/presenters/#{module_name_for_path(new_module_name)}"
+        FileUtils.cp_r "app/presenters/#{module_name_for_path(old_module_name)}", "app/presenters/#{module_name_for_path(new_module_name)}"
+        Dir.glob("app/presenters/#{module_name_for_path(new_module_name)}/*.rb").each do |f|
+          text = File.read(f)
+          File.open(f, 'w') {|f| f << text.gsub(/#{old_module_name}/, new_module_name)}
+        end
+      end
+    end
+
+    def copy_presenter_tests
+      in_root do
+        case Versionist.configuration.configured_test_framework
+        when :test_unit
+          log "Copying all files from test/presenters/#{module_name_for_path(old_module_name)} to test/presenters/#{module_name_for_path(new_module_name)}"
+          FileUtils.cp_r "test/presenters/#{module_name_for_path(old_module_name)}", "test/presenters/#{module_name_for_path(new_module_name)}"
+          Dir.glob("test/presenters/#{module_name_for_path(new_module_name)}/*.rb").each do |f|
+            text = File.read(f)
+            File.open(f, 'w') {|f| f << text.gsub(/#{old_module_name}/, new_module_name)}
+          end
+        when :rspec
+          log "Copying all files from spec/presenters/#{module_name_for_path(old_module_name)} to spec/presenters/#{module_name_for_path(new_module_name)}"
+          FileUtils.cp_r "spec/presenters/#{module_name_for_path(old_module_name)}", "spec/presenters/#{module_name_for_path(new_module_name)}"
+          Dir.glob("spec/presenters/#{module_name_for_path(new_module_name)}/*.rb").each do |f|
+            text = File.read(f)
+            File.open(f, 'w') {|f| f << text.gsub(/#{old_module_name}/, new_module_name)}
+          end
+        else
+          say "Unsupported test_framework: #{Versionist.configuration.configured_test_framework}"
+        end
+      end
+    end
+
+    def copy_documentation
+      in_root do
+        log "Copying all files from public/docs/#{old_version} to public/docs/#{new_version}"
+        FileUtils.cp_r "public/docs/#{old_version}", "public/docs/#{new_version}"
+        Dir.glob("public/docs/#{new_version}/*.html").each do |f|
+          text = File.read(f)
+          File.open(f, 'w') {|f| f << text.gsub(/#{old_version}/, new_version)}
+        end
+      end
+    end
+  end
+end

data/lib/generators/versionist/new_api_version/new_api_version_generator.rb

@@ -12,7 +12,7 @@ module Versionist
 
     def add_routes
       in_root do
-        api_version_block = /api_version.*:module\s*(=>|:)\s*("|')#{module_name_for_route(module_name)}("|').*do/
+        api_version_block = /api_version.*:module\s*(=>|:)\s*("|')#{module_name_for_route(module_name)}("|')/
         matching_version_blocks = File.readlines("config/routes.rb").grep(api_version_block)
         raise "API version already exists in config/routes.rb" if !matching_version_blocks.empty?
         versioning_strategy.symbolize_keys!
@@ -28,15 +28,19 @@ module Versionist
     end
 
     # due to the inflector quirks we can't use hook_for :test_framework
-    def add_controller_base_test
+    def add_controller_base_tests
       in_root do
         case Versionist.configuration.configured_test_framework
         when :test_unit
           empty_directory "test/functional/#{module_name_for_path(module_name)}"
-          template 'base_controller_test.rb', File.join("test", "functional", "#{module_name_for_path(module_name)}", "base_controller_test.rb")
+          template 'base_controller_functional_test.rb', File.join("test", "functional", "#{module_name_for_path(module_name)}", "base_controller_test.rb")
+          empty_directory "test/integration/#{module_name_for_path(module_name)}"
+          template 'base_controller_integration_test.rb', File.join("test", "integration", "#{module_name_for_path(module_name)}", "base_controller_test.rb")
         when :rspec
           empty_directory "spec/controllers/#{module_name_for_path(module_name)}"
           template 'base_controller_spec.rb', File.join("spec", "controllers", "#{module_name_for_path(module_name)}", "base_controller_spec.rb")
+          empty_directory "spec/requests/#{module_name_for_path(module_name)}"
+          template 'base_controller_spec.rb', File.join("spec", "requests", "#{module_name_for_path(module_name)}", "base_controller_spec.rb")
         else
           say "Unsupported test_framework: #{Versionist.configuration.configured_test_framework}"
         end

data/lib/generators/versionist/{new_controller/templates/new_controller_test.rb → new_api_version/templates/base_controller_integration_test.rb}

@@ -1,7 +1,6 @@
 require 'test_helper'
 
-class <%= module_name %>::<%= class_name%>Controller < ActionController::TestCase
-
+class <%= module_name %>::BaseControllerTest < ActionDispatch::IntegrationTest
   # Replace this with your real tests.
   test "the truth" do
     assert true

data/lib/generators/versionist/new_api_version/templates/base_presenter_test.rb

@@ -1,6 +1,6 @@
 require 'test_helper'
 
-class <%= module_name %>::BaseControllerTest < Test::Unit::TestCase
+class <%= module_name %>::BasePresenterTest < Test::Unit::TestCase
   # Replace this with your real tests.
   test "the truth" do
     assert true

data/lib/generators/versionist/new_api_version/templates/docs_style.rb

@@ -1,5 +1,5 @@
 body {margin: 0; background-color: #fff; color: #000; font-family: Arial,sans-serif;}
-#content {margin-left: 200px;}
-#content h1 {text-align: center;}
-#operations {float: left; width: 200px; border-right: 1px solid #ccc;}
-#operations h3 {text-align: center;}
+content {margin-left: 200px;}
+content h1 {text-align: center;}
+operations {float: left; width: 200px; border-right: 1px solid #ccc;}
+operations h3 {text-align: center;}

data/lib/generators/versionist/new_controller/new_controller_generator.rb

@@ -12,7 +12,7 @@ module Versionist
         raise "API module namespace #{module_name} doesn't exist. Please run \'rails generate versionist:new_api_version\' generator first" if !File.exists?("app/controllers/#{module_name_for_path(module_name)}")
         template 'new_controller.rb', File.join("app", "controllers", "#{module_name_for_path(module_name)}", "#{file_name}_controller.rb")
 
-        api_version_block = /api_version.*:module\s*(=>|:)\s*("|')#{module_name_for_route(module_name)}("|').*do/
+        api_version_block = /api_version.*:module\s*(=>|:)\s*("|')#{module_name_for_route(module_name)}("|')/
         new_route = "    resources :#{file_name}\n"
         matching_version_blocks = File.readlines("config/routes.rb").grep(api_version_block)
         if matching_version_blocks.empty?
@@ -27,13 +27,15 @@ module Versionist
     end
 
     # due to the inflector quirks we can't use hook_for :test_framework
-    def new_controller_test
+    def new_controller_tests
       in_root do
         case Versionist.configuration.configured_test_framework
         when :test_unit
-          template 'new_controller_test.rb', File.join("test", "functional", "#{module_name_for_path(module_name)}", "#{file_name}_controller_test.rb")
+          template 'new_controller_functional_test.rb', File.join("test", "functional", "#{module_name_for_path(module_name)}", "#{file_name}_controller_test.rb")
+          template 'new_controller_integration_test.rb', File.join("test", "integration", "#{module_name_for_path(module_name)}", "#{file_name}_controller_test.rb")
         when :rspec
           template 'new_controller_spec.rb', File.join("spec", "controllers", "#{module_name_for_path(module_name)}", "#{file_name}_controller_spec.rb")
+          template 'new_controller_spec.rb', File.join("spec", "requests", "#{module_name_for_path(module_name)}", "#{file_name}_controller_spec.rb")
         else
           say "Unsupported test_framework: #{Versionist.configuration.configured_test_framework}"
         end

data/lib/generators/versionist/new_controller/templates/new_controller_functional_test.rb

@@ -0,0 +1,9 @@
+require 'test_helper'
+
+class <%= module_name %>::<%= class_name%>ControllerTest < ActionController::TestCase
+
+  # Replace this with your real tests.
+  test "the truth" do
+    assert true
+  end
+end

data/lib/generators/versionist/new_controller/templates/new_controller_integration_test.rb

@@ -0,0 +1,9 @@
+require 'test_helper'
+
+class <%= module_name %>::<%= class_name%>ControllerTest < ActionDispatch::IntegrationTest
+
+  # Replace this with your real tests.
+  test "the truth" do
+    assert true
+  end
+end

data/lib/generators/versionist/new_presenter/templates/new_presenter.rb

@@ -1,4 +1,4 @@
-class <%= module_name %>::<%= class_name%>Presenter
+class <%= module_name %>::<%= class_name%>Presenter < <%= module_name %>::BasePresenter
 
   def initialize(<%= file_name %>)
     @<%= file_name %> = <%= file_name %>

data/lib/versionist/routing.rb

@@ -12,6 +12,7 @@ module Versionist
       raise ArgumentError, "you must pass a configuration Hash to api_version" if config.nil? || !config.is_a?(Hash)
       raise ArgumentError, "you must specify :module in configuration Hash passed to api_version" if !config.has_key?(:module)
       raise ArgumentError, "you must specify :header, :path, or :parameter in configuration Hash passed to api_version" if !config.has_key?(:header) && !config.has_key?(:path) && !config.has_key?(:parameter)
+      raise ArgumentError, ":defaults must be a Hash" if config.has_key?(:defaults) && !config[:defaults].is_a?(Hash)
       if config.has_key?(:header)
         return configure_header(config, &block)
       elsif config.has_key?(:path)
@@ -26,22 +27,28 @@ module Versionist
 
     def configure_header(config, &block)
       header = Versionist::VersioningStrategy::Header.new(config)
-      scope({:module => config[:module], :constraints => header}, &block)
+      route_hash = {:module => config[:module], :constraints => header}
+      route_hash.merge!({:defaults => config[:defaults]}) if config.has_key?(:defaults)
+      scope(route_hash, &block)
     end
 
     def configure_path(config, &block)
       path = Versionist::VersioningStrategy::Path.new(config)
       # Use the :as option and strip out non-word characters from the path to avoid this:
       # https://github.com/rails/rails/issues/3224
-      namespace(config[:path], {:module => config[:module], :as => config[:path].gsub(/\W/, '_')}, &block)
+      route_hash = {:module => config[:module], :as => config[:path].gsub(/\W/, '_')}
+      route_hash.merge!({:defaults => config[:defaults]}) if config.has_key?(:defaults)
+      namespace(config[:path], route_hash, &block)
       if path.default?
-        scope({:module => config[:module], :as => config[:path].gsub(/\W/, '_')}, &block)
+        scope(route_hash, &block)
       end
     end
 
     def configure_parameter(config, &block)
       parameter = Versionist::VersioningStrategy::Parameter.new(config)
-      scope({:module => config[:module], :constraints => parameter}, &block)
+      route_hash = {:module => config[:module], :constraints => parameter}
+      route_hash.merge!({:defaults => config[:defaults]}) if config.has_key?(:defaults)
+      scope(route_hash, &block)
     end
   end
 end

data/lib/versionist/version.rb

@@ -1,3 +1,3 @@
 module Versionist
-  VERSION = '0.1.3'
+  VERSION = '0.2.0'
 end

data/lib/versionist.rb

@@ -5,6 +5,7 @@ module Versionist
 
   autoload :Configuration
   autoload :InflectorFixes, "generators/versionist/inflector_fixes"
+  autoload :CopyApiVersionGenerator, "generators/versionist/copy_api_version/copy_api_version_generator"
   autoload :NewApiVersionGenerator, "generators/versionist/new_api_version/new_api_version_generator"
   autoload :NewControllerGenerator, "generators/versionist/new_controller/new_controller_generator"
   autoload :NewPresenterGenerator, "generators/versionist/new_presenter/new_presenter_generator"

metadata

@@ -2,7 +2,7 @@
 name: versionist
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors: 
 - Brian Ploetz
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-04-17 00:00:00 Z
+date: 2012-04-25 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rails
@@ -23,6 +23,17 @@ dependencies:
         version: "3.0"
   type: :runtime
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "0.7"
+  type: :runtime
+  version_requirements: *id002
 description: A plugin for versioning Rails 3 based RESTful APIs.
 email: 
 executables: []
@@ -32,11 +43,14 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- lib/generators/versionist/copy_api_version/copy_api_version_generator.rb
+- lib/generators/versionist/copy_api_version/USAGE
 - lib/generators/versionist/inflector_fixes.rb
 - lib/generators/versionist/new_api_version/new_api_version_generator.rb
 - lib/generators/versionist/new_api_version/templates/base_controller.rb
+- lib/generators/versionist/new_api_version/templates/base_controller_functional_test.rb
+- lib/generators/versionist/new_api_version/templates/base_controller_integration_test.rb
 - lib/generators/versionist/new_api_version/templates/base_controller_spec.rb
-- lib/generators/versionist/new_api_version/templates/base_controller_test.rb
 - lib/generators/versionist/new_api_version/templates/base_presenter.rb
 - lib/generators/versionist/new_api_version/templates/base_presenter_spec.rb
 - lib/generators/versionist/new_api_version/templates/base_presenter_test.rb
@@ -45,8 +59,9 @@ files:
 - lib/generators/versionist/new_api_version/USAGE
 - lib/generators/versionist/new_controller/new_controller_generator.rb
 - lib/generators/versionist/new_controller/templates/new_controller.rb
+- lib/generators/versionist/new_controller/templates/new_controller_functional_test.rb
+- lib/generators/versionist/new_controller/templates/new_controller_integration_test.rb
 - lib/generators/versionist/new_controller/templates/new_controller_spec.rb
-- lib/generators/versionist/new_controller/templates/new_controller_test.rb
 - lib/generators/versionist/new_controller/USAGE
 - lib/generators/versionist/new_presenter/new_presenter_generator.rb
 - lib/generators/versionist/new_presenter/templates/new_presenter.rb
@@ -90,6 +105,7 @@ rubyforge_project:
 rubygems_version: 1.8.17
 signing_key: 
 specification_version: 3
-summary: versionist-0.1.3
+summary: versionist-0.2.0
 test_files: []
 
+has_rdoc: