declarative-find 1.0

data/.gitignore

@@ -0,0 +1,2 @@
+.yardoc
+doc

data/.yardopts

@@ -0,0 +1 @@
+--charset UTF-8 --markup markdown lib/**/*.rb - LICENSE

data/LICENSE

@@ -0,0 +1,10 @@
+The MIT License
+===============
+
+© 2011 Cody Robbins
+
+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.markdown

@@ -0,0 +1,58 @@
+Declarative Find for Rails
+=======================
+
+This Rails plugin makes a `find` method available at the class level in `ApplicationController` which takes the name of an ActiveRecord model. Using this method creates a before filter which finds an ActiveRecord instance and assigns it to an appropriately named instance variable in the controller. The name of the model passed to `find` is used for both the key in `params` assumed to contain the ID of the record to find as well as the name of the instance variable to assign it to. An 404 HTTP code will be returned and the corresponding error page rendered for non-existent records via the [`http-error` gem](http://codyrobbins.com/software/http-error).
+
+Full documentation is at [RubyDoc.info](http://rubydoc.info/gems/declarative-find).
+
+Examples
+--------
+
+The following examples assume the request for the `delete` action has an `:id` or `:user` param passed to it with the ID of the user to delete.
+
+### All actions
+
+    class UserController < ApplicationController
+      find(:user)
+
+      def delete
+        @user.destroy
+      end
+    end
+
+### Options
+
+The find can be restricted to specific actions the same way a typical before filter can be—in fact, any options passed to `find` are simply passed through to `before_filter`.
+
+    class UserController < ApplicationController
+      find(:user, :only => :delete)
+
+      def delete
+        @user.destroy
+      end
+
+      def something_else
+        render(:text => 'Something else.')
+      end
+    end
+
+Colophon
+--------
+
+### Tested with
+
+* Rails 3.0.5 — 20 May 2011
+
+### Contributing
+
+* [Source](https://github.com/codyrobbins/declarative-find)
+* [Bug reports](https://github.com/codyrobbins/declarative-find/issues)
+
+To send patches, please fork on GitHub and submit a pull request.
+
+### Credits
+
+© 2011 [Cody Robbins](http://codyrobbins.com/). See LICENSE for details.
+
+* [Homepage](http://codyrobbins.com/software/declarative-find)
+* [Follow me on Twitter](http://twitter.com/codyrobbins)

data/declarative-find.gemspec

@@ -0,0 +1,21 @@
+Gem::Specification.new do |s|
+  s.name     = 'declarative-find'
+  s.version  = '1.0'
+  s.summary  = 'Find records for Rails controller actions declaratively.'
+  s.homepage = 'http://codyrobbins.com/software/declarative-find'
+  s.author   = 'Cody Robbins'
+  s.email    = 'cody@codyrobbins.com'
+
+  s.post_install_message = '
+-------------------------------------------------------------
+Follow me on Twitter: http://twitter.com/codyrobbins
+-------------------------------------------------------------
+
+'
+
+  s.files = `git ls-files`.split
+
+  s.add_dependency('easier-instance-variable-access')
+  s.add_dependency('to-class')
+  s.add_dependency('http-error')
+end

data/lib/cody_robbins/declarative_find/class_methods.rb

@@ -0,0 +1,52 @@
+# encoding: UTF-8
+
+module CodyRobbins
+  module DeclarativeFind
+    module ClassMethods
+      # Creates a before filter on the controller that finds an ActiveRecord instance and assigns it to an instance variable.
+      #
+      # * You pass the name of the model to look up to the method.
+      # * The key in `params` assumed to contain the ID of the record to find is either `:id` or, if `:id` is not present, then extrapolated from the model name. For example, if the model is `User` then this key would be `:user`. Preference is given to `:id` to prevent conflicts in situations such as edit actions, where a record is looked up but new values for its attributes are passed via a key in `params` sharing the name of the model. For example, if the model is `User` then `params[:user]` would contain the attributes for the user from the form, and `:id` would have to be used to specify the ID of the user in question.
+      # * The instance variable that the record is assigned to will be named according to the model. For example, if the model is `User` then the instance variable will be `@user`.
+      #
+      # An 404 HTTP code will be returned and the corresponding error page rendered for non-existent records via the [`http-error` gem](http://codyrobbins.com/software/http-error).
+      #
+      # @param name [Symbol, String] The name of the model to look up.
+      # @param filter_options [Hash] Options to pass through to the underlying `before_filter`. For example, you could limit the lookup to a specific action by using the `:only` option.
+      #
+      # @example The following examples assume the request for the `delete` action has an `:id` or `:user` param passed to it with the ID of the user to delete.
+      #    class UserController < ApplicationController
+      #      find(:user)
+      #
+      #      def delete
+      #        @user.destroy
+      #      end
+      #    end
+      # @example Restricting the find to specific actions.
+      #    class UserController < ApplicationController
+      #      find(:user, :only => :delete)
+      #
+      #      def delete
+      #        @user.destroy
+      #      end
+      #
+      #      def something_else
+      #        render(:text => 'Something else.')
+      #      end
+      #    end
+      def find(name, filter_options = {})
+        before_filter(filter_options) do
+          model = name.to_class
+          id = params[:id] || params[name]
+          object = model.find_by_id(id)
+
+          if object
+            set_instance_variable(name, object)
+          else
+            http_error(404)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cody_robbins/declarative_find/railtie.rb

@@ -0,0 +1,11 @@
+module CodyRobbins
+  module DeclarativeFind
+    class Railtie < Rails::Railtie
+      initializer('cody_robbins.declarative_find') do
+        ActiveSupport.on_load(:action_controller) do
+          extend(ClassMethods)
+        end
+      end
+    end
+  end
+end

data/lib/declarative-find.rb

@@ -0,0 +1,2 @@
+require('cody_robbins/declarative_find/class_methods')
+require('cody_robbins/declarative_find/railtie')

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification 
+name: declarative-find
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: "1.0"
+platform: ruby
+authors: 
+- Cody Robbins
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-24 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: easier-instance-variable-access
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: to-class
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: http-error
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+description: 
+email: cody@codyrobbins.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .yardopts
+- LICENSE
+- README.markdown
+- declarative-find.gemspec
+- lib/cody_robbins/declarative_find/class_methods.rb
+- lib/cody_robbins/declarative_find/railtie.rb
+- lib/declarative-find.rb
+has_rdoc: true
+homepage: http://codyrobbins.com/software/declarative-find
+licenses: []
+
+post_install_message: "\n\
+  -------------------------------------------------------------\n\
+  Follow me on Twitter: http://twitter.com/codyrobbins\n\
+  -------------------------------------------------------------\n\n"
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Find records for Rails controller actions declaratively.
+test_files: []
+