remarkable_rails 3.1.6 → 3.1.7

data/CHANGELOG

@@ -1,3 +1,7 @@
+* Plugin files are automatically loaded [#86]
+
+* Allow should_route to use environment configuration [#88] (thanks to Lawrence Pit)
+
 * Allow mock model class to be set using :as option.
 
 * [DEPRECATION] By default all matchers perform expectations, use with_stubs => true

data/README

@@ -92,4 +92,25 @@ There are also params and mime methods:
     end
   end
 
-And much more. Be sure to check macro stubs documentation.
+And much more. Be sure to check macro stubs documentation.
+
+== Rails plugin developers
+
+Remarkable automatically loads files at the remarkable directory on your plugins
+and frozen gems if RAILS_ROOT is defined. The lookup happens like this:
+
+  RAILS_ROOT/spec/remarkable
+  RAILS_ROOT/vendor/gems/*/remarkable
+  RAILS_ROOT/vendor/plugins/*/remarkable
+
+Remarkable will load both ruby files (.rb) and Remarkable locale files (.yml).
+
+The only step remaining is to include the matchers, which Remarkable will not
+do automatically if the user is not using a Remarkable namespace. For example,
+if the developer includes his matchers to Remarkable::ActiveRecord::Matchers,
+the matchers will be automatically available in users spec. But if he creates
+a new namespace, like MyPlugin::Matchers, he has to tell Remarkable to include
+them in the proper example group:
+
+  Remarkable.include_matchers!(MyPlugin::Matchers, Spec::Rails::Example::ModelExampleGroup)
+

data/lib/remarkable_rails.rb

@@ -28,3 +28,37 @@ require File.join(dir, 'remarkable_rails', 'action_view')
 
 # Load locale file
 Remarkable.add_locale File.join(dir, '..', 'locale', 'en.yml')
+# Load plugin files if RAILS_ROOT is defined. It loads files at:
+#
+#   RAILS_ROOT/spec/remarkable
+#   RAILS_ROOT/vendor/gems/*/remarkable
+#   RAILS_ROOT/vendor/plugins/*/remarkable
+#
+# Remarkable will load both ruby files (.rb) and Remarkable locale files (.yml).
+#
+# The only step remaining is to include the matchers, which Remarkable will not
+# do automatically if the user is not using a Remarkable namespace. For example,
+# if the developer includes his matchers to Remarkable::ActiveRecord::Matchers,
+# the matchers will be automatically available in users spec. But if he creates
+# a new namespace, like MyPlugin::Matchers, he has to tell Remarkable to include
+# them in the proper example group:
+#
+#   Remarkable.include_matchers!(MyPlugin::Matchers, Spec::Rails::Example::ModelExampleGroup)
+#
+if defined?(RAILS_ROOT)
+  files = []
+  files += Dir.glob(File.join(RAILS_ROOT, "spec", "remarkable", "*"))
+  files += Dir.glob(File.join(RAILS_ROOT, "vendor", "{plugins,gems}", "*", "remarkable", "*"))
+  files.each do |file|
+    begin
+      case File.extname(file)
+        when ".rb"
+          require file
+        when ".yml"
+          Remarkable.add_locale file
+      end
+    rescue Exception => e
+      warn "[WARNING] Remarkable could not load file #{file.inspect}. Error: #{e.message}"
+    end
+  end
+end

data/lib/remarkable_rails/action_controller/matchers/route_matcher.rb

@@ -6,10 +6,9 @@ module Remarkable
         arguments :method, :path
 
         assertions :map_to_path?, :generate_params?
-
+
         before_assert do
           @options[:controller] ||= controller_name
-
           @populated_path = @path.dup
 
           @options.each do |key, value|
@@ -18,7 +17,15 @@ module Remarkable
           end
 
           ::ActionController::Routing::Routes.reload if ::ActionController::Routing::Routes.empty?
-        end
+        end
+
+        def controller
+          @controller ||= @spec.controller if @spec.respond_to?(:controller)
+        end
+
+        def request
+          controller.request if controller
+        end
 
         private
 
@@ -28,7 +35,11 @@ module Remarkable
           end
 
           def generate_params?
-            params_from = ::ActionController::Routing::Routes.recognize_path(@populated_path, :method => @method.to_sym)
+            env = ::ActionController::Routing::Routes.extract_request_environment(controller.request) if controller
+
+            env ||= {}
+            env[:method] = @method.to_sym
+            params_from  = ::ActionController::Routing::Routes.recognize_path(@populated_path, env) rescue nil
             return params_from == @options, :actual => params_from.inspect
           end
 
@@ -40,23 +51,27 @@ module Remarkable
           # subject or the controller class in the RoutingExampleGroup.
           #
           def controller_name
-            spec_class = @spec.class unless @spec.class == Class
-
-            controller = if @subject && @subject.class.ancestors.include?(::ActionController::Base)
-              @subject.class
-            elsif spec_class.respond_to?(:controller_class)
-              spec_class.controller_class
-            elsif spec_class.respond_to?(:described_class)
-              spec_class.described_class
-            end
-
-            if controller && controller.ancestors.include?(::ActionController::Base)
-              controller.name.gsub(/Controller$/, '').tableize
+            if controller_class
+              controller_class.name.gsub(/Controller$/, '').tableize
             else
               raise ArgumentError, "I cannot guess the controller name in route. Please supply :controller as option"
             end
           end
-
+
+          def controller_class
+            @controller_class ||= begin
+              spec_class = @spec.class unless @spec.class == Class
+
+              attempts = []
+              attempts << controller.class if controller
+              attempts << @subject.class   if @subject
+              attempts << spec_class.controller_class if spec_class.respond_to?(:controller_class)
+              attempts << spec_class.described_class  if spec_class.respond_to?(:described_class)
+
+              attempts.find{ |controller| ::ActionController::Base >= controller }
+            end
+          end
+
           def interpolation_options
             { :options => @options.inspect, :method => @method.to_s.upcase, :path => @path.inspect }
           end

data/spec/action_controller/route_matcher_spec.rb

@@ -40,6 +40,7 @@ describe 'route_matcher' do
 
     # failing case
     it { should_not route(:get, '/projects',    :controller => :projects, :action => :show) }
+    it { should_not route(:xyz, '/projects',    :controller => :projects, :action => :index) }
   end
 
   describe 'macros' do
@@ -58,6 +59,7 @@ describe 'route_matcher' do
 
     # failing case
     should_not_route :get, '/projects',    :controller => :projects, :action => :show
+    should_not_route :xyz, '/projects',    :controller => :projects, :action => :index
   end
 
   describe TasksController, :type => :routing do
@@ -72,4 +74,13 @@ describe 'route_matcher' do
     should_route :put,    '/projects/5/tasks/1',   :action => :update,  :id => 1, :project_id => 5
   end
 
+  describe 'using controller.request' do
+    it "should extract environment from controller request" do
+      @matcher = route(:get, '/projects', :controller => 'projects', :action => 'index')
+      ::ActionController::Routing::Routes.should_receive(:extract_request_environment).with(controller.request).and_return({:subdomain => "foo"})
+      ::ActionController::Routing::Routes.should_receive(:recognize_path).with("/projects", {:subdomain => "foo", :method => :get})
+      @matcher.matches?(@controller)
+    end
+  end
+
 end

data/spec/application/vendor/gems/my_plugin/remarkable/my_plugin_locale.yml

@@ -0,0 +1,2 @@
+en:
+  my_plugin_locale: "My plugin locale"

data/spec/application/vendor/gems/my_plugin/remarkable/my_plugin_matchers.rb

@@ -0,0 +1,4 @@
+module MyPlugin
+  module Matchers
+  end
+end

data/spec/remarkable_rails_spec.rb

@@ -0,0 +1,11 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe 'loader' do
+  it "should load files in the plugin folder" do
+    defined?(MyPlugin::Matchers).should == "constant"
+  end
+
+  it "should load files in the plugin folder" do
+    I18n.t("my_plugin_locale").should == "My plugin locale"
+  end
+end

data/spec/spec_helper.rb

@@ -2,7 +2,7 @@ require 'rubygems'
 
 RAILS_ENV     = 'test'
 RAILS_VERSION = ENV['RAILS_VERSION'] || '2.3.2'
-RSPEC_VERSION = ENV['RSPEC_VERSION'] || Spec::VERSION::STRING
+RSPEC_VERSION = ENV['RSPEC_VERSION'] || Spec::VERSION::STRING
 
 # Load Rails
 gem 'activesupport', RAILS_VERSION

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: remarkable_rails
 version: !ruby/object:Gem::Version 
-  version: 3.1.6
+  version: 3.1.7
 platform: ruby
 authors: 
 - Carlos Brando
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-06 00:00:00 +02:00
+date: 2009-07-05 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -41,7 +41,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 3.1.6
+        version: 3.1.7
     version: 
 - !ruby/object:Gem::Dependency 
   name: remarkable_activerecord
@@ -51,7 +51,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 3.1.6
+        version: 3.1.7
     version: 
 description: "Remarkable Rails: collection of matchers and macros with I18n for Rails"
 email: 
@@ -121,6 +121,8 @@ test_files:
 - spec/application/examples/example.html.erb
 - spec/application/application.rb
 - spec/application/projects/new.html.erb
+- spec/application/vendor/gems/my_plugin/remarkable/my_plugin_locale.yml
+- spec/application/vendor/gems/my_plugin/remarkable/my_plugin_matchers.rb
 - spec/application/layouts/examples.html.erb
 - spec/application/tasks_controller.rb
 - spec/action_controller/macro_stubs_spec.rb
@@ -137,3 +139,4 @@ test_files:
 - spec/spec_helper.rb
 - spec/functional_builder.rb
 - spec/spec.opts
+- spec/remarkable_rails_spec.rb