golden_retriever 0.0.1

data/.gitignore

@@ -0,0 +1 @@
+.*.swp

data/README

@@ -0,0 +1,32 @@
+Golden Retriever automatically retrieves resources from the database for
+actions/controllers that follow rest conventions.
+
+Instructions:
+
+script/plugin git://github.com/DouglasMeyer/golden_retriever.git
+And add "require GoldenRetriever" to the controllers for which you want your
+resources automatically retrieved.
+
+Example:
+
+ActionController::Routing::Routes.draw do |map|
+  map.resources :users, :has_many => :posts
+end
+
+class PostsController < ApplicationController
+  require GoldenRetriever
+  # In this controller, you'll have access to @user, which is
+  # the same as: User.find(params[:user_id])
+  def index
+    # @posts will be the same as @user.posts
+    render :json => @posts
+  end
+  def show
+    # @post will be the same as @user.posts.find(params[:id])
+    render :json => @post
+  end
+  def new
+    # @post will be the same as @user.posts.build
+    render :json => @post
+  end
+end

data/Rakefile

@@ -0,0 +1,50 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "golden_retriever"
+    gem.summary = %Q{Retriever fetches your resources for you.}
+    gem.description = %Q{ Restful controllers will have their resources automatically loaded for them.}
+    gem.email = "DouglasYMan@Yahoo.com"
+    gem.homepage = "http://github.com/DouglasMeyer/golden_retriever"
+    gem.authors = ["DouglasMeyer"]
+    gem.add_development_dependency "riot", ">= 0"
+    gem.add_development_dependency "active_support", ">= 2.3.0"
+#    gem.add_development_dependency "yard", ">= 0"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+#Rake::TestTask.new(:test_non_rails) do |test|
+#  test.libs << 'lib' << 'test'
+#  test.test_files = FileList['test/**/*_test.rb'].exclude("test/rails/**/*_test.rb")
+#  test.verbose = true
+#end
+#
+#Rake::TestTask.new(:test_rails) do |test|
+#  test.libs << 'lib' << 'test'
+#  test.test_files = FileList["test/rails/**/*_test.rb"]
+#  test.verbose = true
+#end
+#
+#task :test => [:check_dependencies, :test_non_rails, :test_rails]
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.test_files = FileList['test/**/*_test.rb']
+  test.verbose = true
+end
+task :default => :test
+
+#begin
+#  require 'yard'
+#  YARD::Rake::YardocTask.new
+#rescue LoadError
+#  task :yardoc do
+#    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+#  end
+#end

data/lib/golden_retriever.rb

@@ -0,0 +1,45 @@
+module GoldenRetriever
+
+  def self.included(controller)
+    controller.before_filter :load_resource
+  end
+
+private
+  def load_resource
+    resource_keys = ActionController::Routing::Routes.routes_by_controller[controller_name][action_name][params.keys][0][0].segment_keys.map(&:to_s).grep(/id$/)
+
+    parent = nil
+    resource_keys.each do |key|
+      singular_name = key.match(/^(.*)_id$/).try(:[], 1) || controller_name.singularize
+      object = if parent
+        parent.send(singular_name.pluralize)
+      else
+        singular_name.camelize.constantize
+      end.find params[key]
+      instance_variable_set("@#{singular_name}", object)
+      parent = object
+    end
+
+    if resource_keys.last != 'id'
+      singular_name = controller_name.singularize
+      objects = if parent
+        parent.send(singular_name.pluralize)
+      else
+        singular_name.camelize.constantize.all
+      end
+      instance_variable_set("@#{controller_name}", objects)
+    end
+
+    if %w(new create).include? action_name
+      singular_name = controller_name.singularize
+      objects = if parent
+        parent.send(singular_name.pluralize).build
+      else
+        singular_name.camelize.constantize.new
+      end
+      instance_variable_set("@#{singular_name}", objects)
+    end
+
+  end
+
+end

data/test/nested_restful_controller_test.rb

@@ -0,0 +1,61 @@
+require 'teststrap'
+
+class FakeParent
+  def self.find(id)
+    new if id == :fake_parent_id
+  end
+  def fake_posts
+    fake_post = 'fake_posts'
+    class << fake_post
+      def build
+        :build_fake_posts
+      end
+    end
+    fake_post
+  end
+end
+
+context "Nested Restful Controller" do
+  setup do
+    class FakePostsController
+      def self.action_name=(name)
+        @@params = HashWithIndifferentAccess.new
+        @@params[:fake_parent_id] = :fake_parent_id
+        @@params[:id] = :fake_post_id if name == 'show'
+        ActionController::Routing::Routes.action_and_params(name, @@params)
+        @@action_name = name
+      end
+    end
+    FakePostsController
+  end
+
+  should "set @fake_parent to FakeParent.find params[:fake_parent_id]" do
+    topic.action_name = 'index'
+    topic.new.tap{|c|
+      c.send :load_resource
+    }.instance_variable_get('@fake_parent').kind_of? FakeParent
+  end
+
+  context "for a collection request" do
+    setup do
+      topic.action_name = 'index'
+      topic.new.tap{|c| c.send :load_resource }
+    end
+
+    should "set @fake_posts to be @fake_parent.fake_posts" do
+      topic.instance_variable_get('@fake_posts')
+    end.equals('fake_posts')
+  end
+
+  context "for a request to :new" do
+    setup do
+      topic.action_name = 'new'
+      topic.new.tap{|c| c.send :load_resource }
+    end
+
+    should "set @fake_post to be @fake_parent.fake_posts.build" do
+      topic.instance_variable_get('@fake_post')
+    end.equals(:build_fake_posts)
+  end
+
+end

data/test/restful_controller_test.rb

@@ -0,0 +1,53 @@
+require 'teststrap'
+
+context "Restful Controller" do
+  setup do
+    class FakePostsController
+      def self.action_name=(name)
+        @@params = HashWithIndifferentAccess.new
+        @@params[:id] = :fake_post_id if name == 'show'
+        ActionController::Routing::Routes.action_and_params(name, @@params)
+        @@action_name = name
+      end
+    end
+    FakePostsController
+  end
+
+  should "add before_filter :load_resource" do
+    topic.before_filter
+  end.equals(:load_resource)
+
+  context "for a collection request" do
+    setup do
+      topic.action_name = 'index'
+      topic.new.tap{|c|
+        c.send :load_resource
+      }.instance_variable_get('@fake_posts')
+    end
+    should "set @fake_posts to FakePost.all" do
+      topic
+    end.equals(:all)
+  end
+
+  context "for a member request" do
+    setup do
+      topic.action_name = 'show'
+      topic.new.tap{|c| c.send :load_resource }
+    end
+    should "set @fake_post to FakePost.find params[:id]" do
+      FakePost.find_id == :fake_post_id and
+      topic.instance_variable_get('@fake_post')
+    end.equals(:find)
+  end
+
+  context "for a :new request" do
+    setup do
+      topic.action_name = 'new'
+      topic.new.tap{|c| c.send :load_resource }
+    end
+    should "set @fake_post to FakePost.new" do
+      topic.instance_variable_get('@fake_post')
+    end.equals(:new)
+  end
+
+end

data/test/teststrap.rb

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'riot'
+require 'ostruct'
+
+require 'active_support'
+
+require 'golden_retriever'
+
+# -=-=- "fixtures"/helpers
+module ActionController
+  module Routing
+    class Routes
+      def self.action_and_params(name, params)
+        @@routes_by_controller ||= { 'fake_posts' => {}}
+        @@routes_by_controller['fake_posts'][name] = {
+          params.keys => [[ OpenStruct.new(:segment_keys => params.keys) ]]
+        }
+      end
+      def self.routes_by_controller
+        @@routes_by_controller
+      end
+    end
+  end
+end
+
+class FakePost
+  class << self
+    def find_id
+      @@id
+    end
+  end
+  def self.all; :all; end
+  def self.find(id)
+    @@id = id
+    :find
+  end
+  def self.new; :new; end
+end
+
+class FakePostsController
+  def self.before_filter(name=nil)
+    @@before_filter = name if name
+    @@before_filter
+  end
+  def controller_name; 'fake_posts'; end
+  def self.action_name; @@action_name; end
+  def action_name
+    self.class.action_name
+  end
+  def params; @@params; end
+  include GoldenRetriever
+end
+

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification 
+name: golden_retriever
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- DouglasMeyer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-25 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: riot
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: active_support
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.0
+    version: 
+description: " Restful controllers will have their resources automatically loaded for them."
+email: DouglasYMan@Yahoo.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- .gitignore
+- README
+- Rakefile
+- lib/golden_retriever.rb
+- test/nested_restful_controller_test.rb
+- test/restful_controller_test.rb
+- test/teststrap.rb
+has_rdoc: true
+homepage: http://github.com/DouglasMeyer/golden_retriever
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Retriever fetches your resources for you.
+test_files: 
+- test/teststrap.rb
+- test/nested_restful_controller_test.rb
+- test/restful_controller_test.rb