basic_assumption 0.3.2 → 0.3.3

data/README.rdoc

@@ -13,7 +13,7 @@ It represents an idiom for writing certain kinds of code in a declarative way.
 Particularly in your Rails apps, it's worth checking out. BasicAssumption is
 another implementation of the idiom. It exists largely because I felt like
 practicing writing a gem, though it does have a differentiating feature or two.
-Check the configuration options for enabling compatibility with the
+Check the +Configuration+ options for enabling compatibility with the
 DecentExposure API.
 
 == Install BasicAssumption
@@ -34,18 +34,18 @@ For Rails 3, in your Gemfile:
 
 It's possible to use BasicAssumption in your Rails 3 app without requiring
 'basic_assumption/rails', and will in fact allow more flexibility if you don't,
-but will incure the cost of additional setup. See the file
+but will incur the cost of additional setup. See the file
 'lib/basic_assumption/rails.rb' for guidance.
 
 To use the library in another context, it is enough to extend the
-BasicAssumption module with the classes you would like to use it in.
+BasicAssumption module inside the class you would like it available.
 
 == Examples
 
 === Inside a Rails controller
 
 The presumed most-common use case for BasicAssumption is in a Rails app. By
-default, BasicAssumption is extended by ActionController::Base, making it
+default, BasicAssumption is extended within ActionController::Base, making it
 available inside your controllers.
 
 The most important (of the few) methods made available in controller classes is
@@ -98,15 +98,48 @@ created by +assume+ whenever a block is not passed. Here is a simple example:
       ...
     end
 
-This will provide the same behavior as the similar example above. In Rails,
-a helpful default is already made available. Please see +SimpleRails+ for
-a discussion.
+This will provide the same behavior as the similar example above. It is also
+possible to pass a proc or lambda directly.
 
-=== Supplying custome default behavior classes
+Finally, a symbol may be passed if it corresponds to a
+specifically-defined helper class that came packaged with the library or was
+provided by the application.
+
+=== In Rails
+
+In Rails, a useful default is already active out of the box. It attempts to
+guess the name of a class derived from ActiveRecord::Base and do a find on it
+based on an id available in the +params+ of the request. Because of this, the
+following two constructs would be equivalent in your controllers:
+
+    assume(:film) { Film.find(params[:film_id] || params[:id]) }
+    # The above line is exactly the same as:
+    assume(:film)
+
+Please see +SimpleRails+ for details of implementation. Because finding on :id
+could be considered dangerous, there is another default available for use,
++CautiousRails+, that will only find on :name_id. (In the example above,
+this would be :film_id.) Enable that for one of your controllers like so:
+
+    class FilmController < ActionController::Base
+      default_assumption :cautious_rails
+    end
+
+Default assumptions are inherited by derived classes.
+
+=== Supplying custom default behavior classes
 
 There is an ability to provide custom, modular default extensions to
-BasicAssumption. Please see the documentation for +DefaultAssumption+
-for a discussion and +SimpleRails+ for an example.
+BasicAssumption and then use them by passing a symbol, like so:
+
+    class WidgetController < ActionController::Base
+      default_assumption :my_custom_default_class
+    end
+
+The symbol is converted to a class in the same manner as Rails classify/
+constantize operates, but it is looked up in the
+BasicAssumption::DefaultAssumption namespace. Please see the documentation for
++DefaultAssumption+ for a discussion and +SimpleRails+ for an example of this.
 
 === Configuration
 
@@ -114,8 +147,6 @@ There are a couple of simple configuration settings that can be set inside of
 a configuration block that can be used in places such as Rails initializer
 blocks. For more information, see +Configuration+.
 
-More are yet to come...
-
 == Issues
 
 === Memoization

data/lib/basic_assumption/default_assumption.rb

@@ -28,14 +28,10 @@ module BasicAssumption
   # provides a +block+ instance method, and use the result as the default
   # behavior. See the +SimpleRails+ class for an example.
   module DefaultAssumption
-    # Stores the +default+ as the default behavior for class +klass+ that
-    # will be used by calls to +assume+.
     def self.register(klass, default) #:nodoc:
       registry[klass.object_id] = strategy(default)
     end
 
-    # Returns the default behavior used by calls to +assume+ for the class
-    # +klass+.
     def self.resolve(klass) #:nodoc:
       while !registry.has_key?(klass.object_id)
         klass = klass.superclass
@@ -44,7 +40,7 @@ module BasicAssumption
       registry[klass.object_id]
     end
 
-    class << self 
+    class << self
       attr_accessor :default #:nodoc:
 
       protected

data/lib/basic_assumption/default_assumption/cautious_rails.rb

@@ -0,0 +1,27 @@
+module BasicAssumption
+  module DefaultAssumption
+    # Custom default behavior in the context of Rails.
+    class CautiousRails < BasicAssumption::DefaultAssumption::Base
+      # Returns a block that will attempt to find an instance of
+      # an ActiveRecord model based on the name that was given to
+      # BasicAssumption#assume and an id value in the parameters.
+      # It will not find based on params[:id], only params[:model_id].
+      # The following two examples would be equivalent:
+      #
+      #   class WidgetController < ActionController::Base
+      #     assume :widget
+      #   end
+      #
+      #   class WidgetController < ActionController::Base
+      #     assume(:widget) { Widget.find(params[:widget_id]) }
+      #   end
+      def block
+        Proc.new do |name|
+          model_class = name.to_s.classify.constantize
+          model_class.find(params["#{name}_id"])
+        end
+      end
+    end
+  end
+end
+

data/lib/basic_assumption/version.rb

@@ -1,3 +1,3 @@
 module BasicAssumption
-  VERSION = '0.3.2'
+  VERSION = '0.3.3'
 end

data/spec/lib/basic_assumption/default_assumption/cautious_rails_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+require 'active_support'
+require 'basic_assumption/default_assumption/cautious_rails'
+
+describe BasicAssumption::DefaultAssumption::CautiousRails do
+  class Model; end
+
+  context "#block" do
+    let(:default) { BasicAssumption::DefaultAssumption::CautiousRails.new }
+    let(:params)  { stub(:[] => 42) }
+
+    before(:each) do
+      Model.stub!(:find)
+      default.stub!(:params).and_return(params)
+    end
+
+    it "looks for a params[model_id] in its calling context" do
+      params.should_receive(:[]).with('model_id').and_return(nil)
+      default.block.call(:model)
+    end
+
+    it "does not look for params[id] in its calling context" do
+      params.should_receive(:[]).with('id').never
+      default.block.call(:model)
+    end
+
+    it "attempts to find a model instance based off the given name" do
+      Model.should_receive(:find).with(42).and_return(:model)
+      default.block.call(:model).should eql(:model)
+    end
+  end
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 3
-  - 2
-  version: 0.3.2
+  - 3
+  version: 0.3.3
 platform: ruby
 authors: 
 - Matt Yoho
@@ -73,6 +73,7 @@ files:
 - lib/basic_assumption/configuration.rb
 - lib/basic_assumption/default_assumption.rb
 - lib/basic_assumption/default_assumption/base.rb
+- lib/basic_assumption/default_assumption/cautious_rails.rb
 - lib/basic_assumption/default_assumption/class_resolver.rb
 - lib/basic_assumption/default_assumption/rails.rb
 - lib/basic_assumption/default_assumption/simple_rails.rb
@@ -115,5 +116,6 @@ test_files:
 - spec/lib/basic_assumption/configuration_spec.rb
 - spec/lib/basic_assumption/default_assumption_spec.rb
 - spec/lib/basic_assumption/default_assumption/base_spec.rb
+- spec/lib/basic_assumption/default_assumption/cautious_rails_spec.rb
 - spec/lib/basic_assumption/default_assumption/class_resolver_spec.rb
 - spec/lib/basic_assumption/default_assumption/simple_rails_spec.rb