josevalim-inherited_resources 0.7.0 → 0.7.1

data/README

@@ -1,6 +1,6 @@
 Inherited Resources
 License: MIT
-Version: 0.7.0
+Version: 0.7.1
 
 You can also read this README in pretty html at the GitHub project Wiki page:
 
@@ -288,6 +288,42 @@ messages will be checked in the following order:
    flash.projects.create.notice
    flash.actions.create.notice
 
+Has Scope
+---------
+
+InheritedResources tries to integrate nicely with your model. In order to do so,
+it also is named_scope fluent. Let's suppose our Project model with the scopes:
+
+  class ProjectsController < ActiveRecord::Base
+    named_scope :featured, :conditions => { :featured => true }
+    named_scope :by_methodology, proc {|methodology| { :conditions => { :methodology => methodology } } }
+    named_scope :limit, proc{|limit| :limit => limit.to_i }
+  end
+
+Your controller:
+
+  class GraduationsController < InheritedResources::Base
+    has_scope :featured, :boolean => true, :only => :index
+    has_scope :by_methodology
+    has_scope :limit, :default => 10
+  end
+
+Then for each request:
+
+  /projects
+  #=> acts like a normal request, but returning 10 projects
+
+  /projects?featured=true
+  #=> calls the featured named scope and bring 10 featured projects
+
+  /projects?featured=true&by_methodology=agile&limit=20
+  #=> brings 20 featured projects with methodology agile
+
+You can retrieve the current scopes in use with :current_scopes method.
+In the last case, it would return:
+
+  { :featured => "true", :by_methodology => "agile", :limit => "20" }
+
 Belongs to
 ----------
 
@@ -337,74 +373,12 @@ Warning: calling several belongs_to is the same as nesting them:
 
 In other words, the code above is the same as calling nested_belongs_to.
 
-Has Scope
----------
-
-InheritedResources besides belongs_to also speaks named_scope. Let's have a
-break from projects and talk about graduations. Your model:
-
-  class Graduation < ActiveRecord::Base
-    named_scope :featured, :conditions => { :featured => true }
-    named_scope :by_degree, proc {|degree| { :conditions => { :degree => degree } } }
-    named_scope :limit, proc{|limit| :limit => limit.to_i }
-  end
-
-Your controller:
-
-  class GraduationsController < InheritedResources::Base
-    has_scope :featured, :boolean => true, :only => :index
-    has_scope :by_degree
-    has_scope :limit, :default => 10
-  end
-
-Then for each request:
-
-  /graduations
-  #=> acts like a normal request, but returning 10 resources
-
-  /graduations?featured=true
-  #=> calls the featured named scope and bring 10 featured graduations
-
-  /graduations?featured=true&by_degree=phd&limit=20
-  #=> brings 20 featured graduations with phd degree
-
-You can also specify the target of the scope. Let's suppose that a Graduation
-has many Students:
-
-  class StudentsController < InheritedResources::Base
-    belongs_to :graduation
-
-    has_scope :featured, :on => :graduation, :boolean => true, :only => :index
-    has_scope :by_degree, :on => :graduation, :only => :index
-    has_scope :limit, :on => :graduation, :default => 10
-  end
-
-You can also do this inside the belongs to block:
-
-  class StudentsController < InheritedResources::Base
-    belongs_to :graduation do
-      has_scope :featured,  :boolean => true, :only => :index
-      has_scope :by_degree, :only => :index
-      has_scope :limit, :default => 10
-    end
-  end
-
-Or even better, you can load the scopes from another controller:
-
-  class StudentsController < InheritedResources::Base
-    belongs_to :graduation do
-      load_scopes_from GraduationsController
-    end
-  end
-
-Another feature is that you can retrive the current scopes in use with
-the method <tt>current_scopes</tt>, that returns a hash.
-
 Polymorphic belongs to
 ----------------------
 
-Now let's go back to Projects which can now have Files, Messages and Tasks, and
-they are all commentable:
+We can go even further. Let's suppose our Projects can now have Files, Messages
+and Tasks, and they are all commentable. In this case, the best solution is to
+use polymorphism:
 
    class CommentsController < InheritedResources::Base
      belongs_to :task, :file, :message, :polymorphic => true
@@ -419,6 +393,12 @@ You can even use it with nested resources:
      end
    end
 
+The url in such cases can be:
+
+   /project/1/task/13/comments
+   /project/1/file/11/comments
+   /project/1/message/9/comments
+
 When using polymorphic associations, you get some free helpers:
 
    parent?         #=> true
@@ -429,8 +409,8 @@ When using polymorphic associations, you get some free helpers:
 Optional belongs to
 -------------------
 
-Later you decide to create a view to show all comments, independing they belong
-to a task, file or message. You canm reuse your previous controller just doing:
+Later you decide to create a view to show all comments, independent if they belong
+to a task, file or message. You can reuse your polymorphic controller just doing:
 
   class ProjectsController < InheritedResources::Base
     belongs_to :task, :file, :message, :optional => true

data/lib/inherited_resources/base_helpers.rb

@@ -113,7 +113,7 @@ module InheritedResources
 
         if chain
           if method_for_association_chain
-            apply_scope_to(chain.send(method_for_association_chain), resource_instance_name)
+            apply_scope_to(chain.send(method_for_association_chain))
           else
             # This only happens when we specify begin_of_association_chain in
             # a singletion controller without parents. In this case, the chain
@@ -122,7 +122,7 @@ module InheritedResources
             chain
           end
         else
-          apply_scope_to(resource_class, resource_instance_name)
+          apply_scope_to(resource_class)
         end
       end
 
@@ -273,7 +273,7 @@ module InheritedResources
       # Hook to apply scopes. By default returns only the target_object given.
       # It's extend by HasScopeHelpers.
       #
-      def apply_scope_to(target_object, target_name) #:nodoc:
+      def apply_scope_to(target_object) #:nodoc:
         target_object
       end
 

data/lib/inherited_resources/belongs_to_helpers.rb

@@ -72,7 +72,6 @@ module InheritedResources
           parent_config[:parent_class]
         end
 
-        parent = apply_scope_to(parent, parent_symbol)
         parent = parent.send(parent_config[:finder], params[parent_config[:param]])
 
         instance_variable_set("@#{parent_config[:instance_name]}", parent)

data/lib/inherited_resources/class_methods.rb

@@ -106,40 +106,11 @@ module InheritedResources
       #   /graduations?featured=true&by_degree=phd
       #   #=> brings featured graduations with phd degree
       #
-      # You can also specify the target of the scope. Let's suppose that a
-      # Graduation has many students:
-      #
-      #   class StudentsController < InheritedResources::Base
-      #     belongs_to :graduation
-      #
-      #     has_scope :featured, :on => :graduation, :boolean => true, :only => :index
-      #     has_scope :by_degree, :on => :graduation, :only => :index
-      #   end
-      #
-      # You can also do this in a block:
-      #
-      #   class StudentsController < InheritedResources::Base
-      #     belongs_to :graduation do
-      #       has_scope :featured,  :boolean => true, :only => :index
-      #       has_scope :by_degree, :only => :index
-      #     end
-      #   end
-      #
-      # Or even better:
-      #
-      #   class StudentsController < InheritedResources::Base
-      #     belongs_to :graduation do
-      #       load_scopes_from GraduationsController
-      #     end
-      #   end
-      #
-      # Another feature is that you can retrive the current scopes in use with
-      # the method <tt>current_scopes</tt> that returns a hash.
+      # You can retrieve the current scopes in use with <tt>current_scopes</tt>
+      # method. In the last case, it would return: { :featured => "true", :by_degree => "phd" }
       #
       # == Options
       #
-      # * <tt>:on</tt> - In each resource the scope is applied to. Defaults to the resource class.
-      #
       # * <tt>:boolean</tt> - When set to true, call the scope only when the params is true or 1,
       #                       and does not send the value as argument.
       #
@@ -157,54 +128,21 @@ module InheritedResources
         options = scopes.extract_options!
 
         options.symbolize_keys!
-        options.assert_valid_keys(:on, :boolean, :key, :only, :except, :default)
+        options.assert_valid_keys(:boolean, :key, :only, :except, :default)
 
-        acts_as_has_scopes!
-
-        scope_target  = options.delete(:on) || @@_parent_block_name || self.resources_configuration[:self][:instance_name]
-        target_config = self.scopes_configuration[scope_target.to_sym] ||= {}
-
-        scopes.each do |scope|
-          target_config[scope]         ||= {}
-          target_config[scope][:key]     = options[:key] || scope
-          target_config[scope][:only]    = Array(options[:only])
-          target_config[scope][:except]  = Array(options[:except])
-          target_config[scope][:boolean] = options[:boolean] if options.key?(:boolean)
-          target_config[scope][:default] = options[:default] if options.key?(:default)
+        if self.scopes_configuration.empty?
+          include HasScopeHelpers
+          helper_method :current_scopes
         end
-      end
 
-      # Load scopes from another controller into the current controller.
-      #
-      # You can give :on as option if you want to load just a set of the another
-      # controller scope.
-      #
-      #   class TasksController < InheritedResources::Base
-      #     belongs_to :project
-      #     load_scopes_from CompaniesController                 # load all scopes
-      #     load_scopes_from ProjectsController, :on => :project # load scopes that apply on :project
-      #   end
-      #
-      # Whenever called inside a belongs to block, the :on value is guessed:
-      #
-      #   class TasksController < InheritedResources::Base
-      #     belongs_to :project do
-      #       load_scopes_from ProjectsController # load scopes that apply on :project
-      #     end
-      #
-      #     load_scopes_from CompaniesController  # load all companies controller scopes
-      #   end
-      #
-      def load_scopes_from(scopes_controller, options={})
-        to_merge = if on = options.delete(:on) || @@_parent_block_name
-          scopes_controller.send(:scopes_configuration).slice(on)
-        else
-          scopes_controller.send(:scopes_configuration)
+        scopes.each do |scope|
+          self.scopes_configuration[scope]         ||= {}
+          self.scopes_configuration[scope][:key]     = options[:key] || scope
+          self.scopes_configuration[scope][:only]    = Array(options[:only])
+          self.scopes_configuration[scope][:except]  = Array(options[:except])
+          self.scopes_configuration[scope][:boolean] = options[:boolean] if options.key?(:boolean)
+          self.scopes_configuration[scope][:default] = options[:default] if options.key?(:default)
         end
-
-        acts_as_has_scopes! # Add the module before merging scopes.
-
-        self.scopes_configuration.deep_merge!(to_merge)
       end
 
       # Defines that this controller belongs to another resource.
@@ -303,20 +241,11 @@ module InheritedResources
           config[:route_name]      = options.delete(:route_name) || symbol
         end
 
-        # Regenerate url helpers only once when blocks are given
         if block_given?
-          raise ArgumentError, "You cannot define multiple associations and give a block to belongs_to." if symbols.size > 1
-
-          unless @@_parent_block_name
-            @@_parent_block_name = symbols.first
-            class_eval(&block)
-            @@_parent_block_name = nil
-          else
-            class_eval(&block)
-          end
+          class_eval(&block)
+        else
+          InheritedResources::UrlHelpers.create_resources_url_helpers!(self)
         end
-
-        InheritedResources::UrlHelpers.create_resources_url_helpers!(self) unless @@_parent_block_name
       end
       alias :nested_belongs_to :belongs_to
 
@@ -361,19 +290,11 @@ module InheritedResources
         end
       end
 
-      def acts_as_has_scopes! #:nodoc:
-        if self.scopes_configuration.empty?
-          include HasScopeHelpers
-          helper_method :current_scopes
-        end
-      end
-
       # Initialize resources class accessors and set their default values.
       #
       def initialize_resources_class_accessors!(base) #:nodoc:
         # Add and protect class accessors
         base.class_eval do
-          @@_parent_block_name = nil # Initialize parent flag
           metaklass = (class << self; self; end)
 
           RESOURCES_CLASS_ACCESSORS.each do |cattr|

data/lib/inherited_resources/has_scope_helpers.rb

@@ -12,11 +12,10 @@ module InheritedResources
 
       # Overwrites apply to scope to implement default scope logic.
       #
-      def apply_scope_to(target_object, target_name) #:nodoc:
+      def apply_scope_to(target_object) #:nodoc:
         @current_scopes ||= {}
-        scope_config = self.scopes_configuration[target_name] || {}
 
-        scope_config.each do |scope, options|
+        self.scopes_configuration.each do |scope, options|
           next unless apply_scope_to_action?(options)
           key = options[:key]
 

data/test/class_methods_test.rb

@@ -21,7 +21,6 @@ end
 class SchoolsController < InheritedResources::Base
   has_scope :by_city
   has_scope :featured, :boolean => true, :only => :index, :key => :by_featured
-  has_scope :limit, :default => 10, :except => :index, :on => :anything
 end
 
 class DeansController < InheritedResources::Base
@@ -123,101 +122,16 @@ class BelongsToErrorsTest < ActiveSupport::TestCase
   ensure
     DeansController.send(:parents_symbols=, [:school])
   end
-
-  def test_belongs_to_raises_an_error_when_multiple_associations_are_given_with_block
-    assert_raise ArgumentError, "You cannot define multiple associations and give a block to belongs_to." do
-      DeansController.send(:belongs_to, :school, :another) do
-        belongs_to :association
-      end
-    end
-  ensure
-    DeansController.send(:parents_symbols=, [:school])
-  end
 end
 
 class HasScopeClassMethods < ActiveSupport::TestCase
-
   def test_scope_configuration_is_stored_as_hashes
     config = SchoolsController.send(:scopes_configuration)
-    assert config.key?(:school)
-    assert config.key?(:anything)
-
-    assert config[:school].key?(:by_city)
-    assert config[:school].key?(:featured)
-    assert config[:anything].key?(:limit)
-
-    assert_equal config[:school][:by_city], { :key => :by_city, :only => [], :except => [] }
-    assert_equal config[:school][:featured], { :key => :by_featured, :only => [ :index ], :except => [], :boolean => true }
-    assert_equal config[:anything][:limit], { :key => :limit, :except => [ :index ], :only => [], :default => 10 }
-  end
-
-  def test_scope_on_value_is_guessed_inside_belongs_to_blocks
-    DeansController.send(:has_scope, :limit)
-    DeansController.send(:belongs_to, :school) do
-      has_scope :featured
-      has_scope :another, :on => :dean
-    end
-
-    config = DeansController.send(:scopes_configuration)
-    assert config[:school].key?(:featured)
-    assert config[:dean].key?(:limit)
-    assert config[:dean].key?(:another)
-  ensure
-    DeansController.send(:scopes_configuration=, {})
-  end
-
-  def test_scope_is_loaded_from_another_controller
-    DeansController.send(:load_scopes_from, SchoolsController)
-    config = DeansController.send(:scopes_configuration)
 
-    assert config.key?(:school)
-    assert config.key?(:anything)
+    assert config.key?(:by_city)
+    assert config.key?(:featured)
 
-    assert config[:school].key?(:by_city)
-    assert config[:school].key?(:featured)
-    assert config[:anything].key?(:limit)
-  ensure
-    DeansController.send(:scopes_configuration=, {})
-  end
-
-  def test_scope_is_deep_merged_from_another_controller
-    config = DeansController.send(:scopes_configuration)
-
-    DeansController.send(:has_scope, :featured, :on => :school)
-    assert_equal config[:school][:featured], { :key => :featured, :only => [ ], :except => [] }
-
-    DeansController.send(:load_scopes_from, SchoolsController)
-    assert config.key?(:school)
-    assert config[:school].key?(:by_city)
-    assert config[:school].key?(:featured)
-    assert_equal config[:school][:featured], { :key => :by_featured, :only => [ :index ], :except => [], :boolean => true }
-  end
-
-  def test_scope_is_loaded_from_another_controller_with_on_specified
-    DeansController.send(:load_scopes_from, SchoolsController, :on => :school)
-    config = DeansController.send(:scopes_configuration)
-
-    assert config.key?(:school)
-    assert config[:school].key?(:by_city)
-    assert config[:school].key?(:featured)
-
-    assert !config.key?(:anything)
-  ensure
-    DeansController.send(:scopes_configuration=, {})
-  end
-
-  def test_scope_is_loaded_from_another_controller_with_on_guessed
-    DeansController.send(:belongs_to, :school) do
-      load_scopes_from SchoolsController
-    end
-    config = DeansController.send(:scopes_configuration)
-
-    assert config.key?(:school)
-    assert config[:school].key?(:by_city)
-    assert config[:school].key?(:featured)
-
-    assert !config.key?(:anything)
-  ensure
-    DeansController.send(:scopes_configuration=, {})
+    assert_equal config[:by_city], { :key => :by_city, :only => [], :except => [] }
+    assert_equal config[:featured], { :key => :by_featured, :only => [ :index ], :except => [], :boolean => true }
   end
 end

data/test/has_scope_test.rb

@@ -4,24 +4,11 @@ class Tree
   def self.human_name; 'Tree'; end
 end
 
-class Branch
-  def self.human_name; 'Branch'; end
-end
-
 class TreesController < InheritedResources::Base
   has_scope :color
   has_scope :only_tall, :boolean => true, :only => :index
   has_scope :shadown_range, :default => 10, :except => [ :index, :show, :destroy ]
   has_scope :root_type, :key => :root
-  has_scope :another, :on => :anything, :default => 10, :only => :destroy
-end
-
-class BranchesController < InheritedResources::Base
-  belongs_to :tree do
-    load_scopes_from TreesController
-  end
-
-  has_scope :by_size
 end
 
 class HasScopeTest < ActionController::TestCase
@@ -105,15 +92,6 @@ class HasScopeTest < ActionController::TestCase
     assert_equal({ :root => 'outside' }, assigns(:current_scopes))
   end
 
-  def test_scope_on_another_object_is_never_called
-    Tree.expects(:another).never
-    Tree.expects(:find).with('42').returns(mock_tree)
-    mock_tree.expects(:destroy)
-    delete :destroy, :id => '42'
-    assert_equal(mock_tree, assigns(:tree))
-    assert_equal({ }, assigns(:current_scopes))
-  end
-
   protected
 
     def mock_tree(stubs={})
@@ -122,50 +100,3 @@ class HasScopeTest < ActionController::TestCase
 
 end
 
-class NestedHasScopeTest < ActionController::TestCase
-  tests BranchesController
-
-  def test_scope_is_applied_on_parent
-    Tree.expects(:only_tall).with().returns(Tree).in_sequence
-    Tree.expects(:find).with('42').returns(mock_tree).in_sequence
-    mock_tree.expects(:branches).returns(Branch).in_sequence
-    Branch.expects(:find).with(:all).returns([mock_branch]).in_sequence
-    get :index, :only_tall => 'true', :tree_id => '42'
-    assert_equal(mock_tree, assigns(:tree))
-    assert_equal([mock_branch], assigns(:branches))
-    assert_equal({ :only_tall => 'true' }, assigns(:current_scopes))
-  end
-
-  def test_scope_is_applied_on_resource
-    Tree.expects(:find).with('42').returns(mock_tree).in_sequence
-    mock_tree.expects(:branches).returns(Branch).in_sequence
-    Branch.expects(:by_size).with('10').returns(Branch).in_sequence
-    Branch.expects(:find).with(:all).returns([mock_branch]).in_sequence
-    get :index, :by_size => '10', :tree_id => '42'
-    assert_equal(mock_tree, assigns(:tree))
-    assert_equal([mock_branch], assigns(:branches))
-    assert_equal({ :by_size => '10' }, assigns(:current_scopes))
-  end
-
-  def test_scope_is_applied_on_both_resource_and_parent
-    Tree.expects(:only_tall).with().returns(Tree).in_sequence
-    Tree.expects(:find).with('42').returns(mock_tree).in_sequence
-    mock_tree.expects(:branches).returns(Branch).in_sequence
-    Branch.expects(:by_size).with('10').returns(Branch).in_sequence
-    Branch.expects(:find).with(:all).returns([mock_branch]).in_sequence
-    get :index, :only_tall => 'true', :by_size => '10', :tree_id => '42'
-    assert_equal(mock_tree, assigns(:tree))
-    assert_equal([mock_branch], assigns(:branches))
-    assert_equal({ :by_size => '10', :only_tall => 'true' }, assigns(:current_scopes))
-  end
-
-  protected
-
-    def mock_tree(stubs={})
-      @mock_tree ||= mock(stubs)
-    end
-
-    def mock_branch(stubs={})
-      @mock_branch ||= mock(stubs)
-    end
-end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: josevalim-inherited_resources
 version: !ruby/object:Gem::Version 
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors: 
 - "Jos\xC3\xA9 Valim"
@@ -85,10 +85,6 @@ test_files:
 - test/test_helper.rb
 - test/url_helpers_test.rb
 - test/locales/en.yml
-- test/views/branches/edit.html.erb
-- test/views/branches/index.html.erb
-- test/views/branches/new.html.erb
-- test/views/branches/show.html.erb
 - test/views/cities/edit.html.erb
 - test/views/cities/index.html.erb
 - test/views/cities/new.html.erb

data/test/views/branches/edit.html.erb

@@ -1 +0,0 @@
-Edit HTML

data/test/views/branches/index.html.erb

@@ -1 +0,0 @@
-Index HTML

data/test/views/branches/new.html.erb

@@ -1 +0,0 @@
-New HTML

data/test/views/branches/show.html.erb

@@ -1 +0,0 @@
-Show HTML