super_resources 1.0.0.rc1

data/spec/controllers/resources_adapted_spec.rb

@@ -0,0 +1,192 @@
+require 'spec_helper'
+
+describe AdaptedResourcesController do
+  describe 'resource class method' do
+    it "answers the resource class through an adapted resource_class method" do
+      get :index
+      subject.send(:resource_class).should eq(MyAdaptedResource)
+    end
+  end
+
+  describe 'individual and collection methods' do
+    it "answers the the name of the resource's input param hash name " do
+      subject.send(:resource_params_name).should eq(:input)
+    end
+  end
+
+  describe 'customized resource building' do
+    it "adapts building" do
+      get :new, {}
+      assigns(:resource).description.should eq(subject.send :a_hard_coded_description)
+    end
+  end
+
+# test RESTful actions still work after the above shenanigans
+
+  describe 'standard RESTful actions still work' do
+    def valid_attributes
+      {}
+    end
+
+    def valid_session
+      {}
+    end
+
+    describe "GET index" do
+      it "assigns all simple resources as collection" do
+        r = MyAdaptedResource.create! valid_attributes
+        get :index, {}, valid_session
+        assigns(:collection).should eq([r])
+      end
+    end
+
+    describe "GET show" do
+      it "assigns the requested resource as resource" do
+        r = MyAdaptedResource.create! valid_attributes
+        get :show, {:id => r.to_param}, valid_session
+        assigns(:resource).should eq(r)
+      end
+    end
+
+    describe "GET new" do
+      it "assigns a new resource as resource" do
+        get :new, {}, valid_session
+        assigns(:resource).should be_a_new(MyAdaptedResource)
+      end
+    end
+
+    describe "GET edit" do
+      it "assigns the requested resource as resource" do
+        r = MyAdaptedResource.create! valid_attributes
+        get :edit, {:id => r.to_param}, valid_session
+        assigns(:resource).should eq(r)
+      end
+    end
+
+    describe "POST create" do
+      describe "with valid params" do
+        it "creates a new resource" do
+          expect {
+            post :create, {:input => valid_attributes}, valid_session
+          }.to change(MyAdaptedResource, :count).by(1)
+        end
+
+        it "assigns a newly created resource as resource" do
+          post :create, {:input => valid_attributes}, valid_session
+          assigns(:resource).should be_a(SimpleResource)
+          assigns(:resource).should be_persisted
+        end
+
+        it "redirects to the created resource" do
+          post :create, {:simple_resource => valid_attributes}, valid_session
+          response.should redirect_to("/adapted_resources/#{MyAdaptedResource.last.id}")
+        end
+      end
+
+      describe "with invalid params" do
+        it "assigns a newly created but unsaved resource as resource" do
+          # Trigger the behavior that occurs when invalid params are submitted
+          MyAdaptedResource.any_instance.stub(:save).and_return(false)
+          post :create, {:input => {}}, valid_session
+          assigns(:resource).should be_a_new(MyAdaptedResource)
+        end
+
+        it "re-renders the 'new' template" do
+          # Trigger the behavior that occurs when invalid params are submitted
+          MyAdaptedResource.any_instance.stub(:save).and_return(false)
+          MyAdaptedResource.any_instance.stub(:errors).and_return(['error'])
+          post :create, {:input => {}}, valid_session
+          response.should render_template("new")
+        end
+      end
+    end
+
+    describe "PUT update" do
+      describe "with valid params" do
+        it "updates the requested resource" do
+          r = MyAdaptedResource.create! valid_attributes
+          # Assuming there are no other resources in the database, this
+          # specifies that the resource created on the previous line
+          # receives the :update_attributes message with whatever params are
+          # submitted in the request.
+          MyAdaptedResource.any_instance.should_receive(:update_attributes).with({'these' => 'params'})
+          put :update, {:id => r.to_param, :input => {'these' => 'params'}}, valid_session
+        end
+
+        it "assigns the requested resource as resource" do
+          r = MyAdaptedResource.create! valid_attributes
+          put :update, {:id => r.to_param, :input => valid_attributes}, valid_session
+          assigns(:resource).should eq(r)
+        end
+
+        it "redirects to the resource" do
+          r = MyAdaptedResource.create! valid_attributes
+          put :update, {:id => r.to_param, :input => valid_attributes}, valid_session
+          response.should redirect_to('/adapted_resources/1')
+        end
+      end
+
+      describe "with invalid params" do
+        it "assigns the resource as resource" do
+          r = MyAdaptedResource.create! valid_attributes
+          # Trigger the behavior that occurs when invalid params are submitted
+          AdaptedResource.any_instance.stub(:save).and_return(false)
+          put :update, {:id => r.to_param, :input => {}}, valid_session
+          assigns(:resource).should eq(r)
+        end
+
+        it "re-renders the 'edit' template" do
+          r = MyAdaptedResource.create! valid_attributes
+          # Trigger the behavior that occurs when invalid params are submitted
+          MyAdaptedResource.any_instance.stub(:save).and_return(false)
+          MyAdaptedResource.any_instance.stub(:errors).and_return(['error'])
+          put :update, {:id => r.to_param, :input => {}}, valid_session
+          response.should render_template("edit")
+        end
+      end
+    end
+
+    describe "DELETE destroy" do
+      it "destroys the requested resource" do
+        r = MyAdaptedResource.create! valid_attributes
+        expect {
+          delete :destroy, {:id => r.to_param}, valid_session
+        }.to change(MyAdaptedResource, :count).by(-1)
+      end
+
+      it "redirects to the resources list" do
+        r = MyAdaptedResource.create! valid_attributes
+        delete :destroy, {:id => r.to_param}, valid_session
+        response.should redirect_to(subject.send :collection_url)
+      end
+    end      
+  end
+end
+
+describe MyAdaptedResourcesController do
+  def valid_attributes
+    { :description => subject.send(:a_hard_coded_description) }
+  end
+
+  def valid_session
+    {}
+  end
+
+  describe 'finding resourcess' do
+    it "finds resources by a specific finder when one is given" do
+      get :index
+      subject.send(:finder_method).should eq(:find_by_description)
+    end
+  end
+
+  describe 'standard RESTful actions still work' do
+    describe "GET show" do
+      it "assigns the requested resource as resource" do
+        r = MyAdaptedResource.create! valid_attributes
+        get :show, {:id => r.to_param}, valid_session
+        assigns(:resource).should eq(nil) # since we have changed the finder method and not set up a friendly id strategy
+      end
+    end
+  end
+end  
+

data/spec/controllers/resources_nested_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe ChildResourcesController do
+  let(:ggp)       { GreatGrandparentResource.create! }
+  let(:gp)        { GrandparentResource.create!(:great_grandparent_resource => ggp) }
+  let(:p)         { ParentResource.create!(:grandparent_resource => gp) }
+  let(:c)         { ChildResource.create!(:parent_resource => p) }
+
+  describe 'parent method' do
+    it "answers the resource's immediate parent through a standard parent method" do
+      get :show, {:id => c.to_param, :parent_resource_id => p.id, :grandparent_resource_id => gp.id, :great_grandparent_resource_id => ggp.id}
+      subject.send(:parent).should eq(p)
+    end
+  end
+
+  describe 'nested resources by derived name methods' do
+    it "answers the resource through a method named after the route information" do
+      get :show, {:id => c.to_param, :parent_resource_id => p.id, :grandparent_resource_id => gp.id, :great_grandparent_resource_id => ggp.id}
+      subject.send(:child_resource).should eq(c)
+    end
+
+    it "answers the resource's parent through a method named after the route information" do
+      get :show, {:id => c.to_param, :parent_resource_id => p.id, :grandparent_resource_id => gp.id, :great_grandparent_resource_id => ggp.id}
+      subject.send(:parent_resource).should eq(p)
+    end
+
+    it "answers the resource's grandparent through a method named after the route information" do
+      get :show, {:id => c.to_param, :parent_resource_id => p.id, :grandparent_resource_id => gp.id, :great_grandparent_resource_id => ggp.id}
+      subject.send(:grandparent_resource).should eq(gp)
+    end
+
+    it "answers the resource's great-grandparent through a method named after the route information" do
+      get :show, {:id => c.to_param, :parent_resource_id => p.id, :grandparent_resource_id => gp.id, :great_grandparent_resource_id => ggp.id}
+      subject.send(:great_grandparent_resource).should eq(ggp)
+    end
+  end
+end

data/spec/controllers/resources_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe SimpleResourcesController do
+  describe 'resource class method' do
+    it "answers the resource class through a standard resource_class method" do
+      get :index
+      subject.send(:resource_class).should eq(SimpleResource)
+    end
+  end
+
+  describe 'individual and collection methods' do
+    it "answers the resource through a standard resource method" do
+      r = SimpleResource.create!
+      get :show, {:id => r.to_param}
+      subject.send(:resource).should eq(r)
+    end
+
+    it "answers the the name of the resource's input param hash name " do
+      subject.send(:resource_params_name).should eq(:simple_resource)
+    end
+
+    it "answers a collection of resources through collection method" do
+      r = SimpleResource.create!
+      get :index, {:id => r.to_param}
+      subject.send(:collection).should eq([r])
+    end
+  end
+
+  describe 'finding resourcess' do
+    it "finds resources by a default finder when no override is given" do
+      get :index
+      subject.send(:finder_method).should eq(:find)
+    end
+  end
+end

data/spec/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.

data/spec/dummy/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/spec/dummy/app/controllers/adapted_resources_controller.rb

@@ -0,0 +1,24 @@
+class AdaptedResourcesController < SimpleResourcesController
+
+  protected
+
+  def resource_class
+  	MyAdaptedResource
+  end
+
+  def resource_params_name
+    :input
+  end
+
+  def build_resource
+   	super do
+      resource_class.new do |p|
+         p.description = a_hard_coded_description
+    	end
+    end
+  end
+
+  def a_hard_coded_description
+  	'We hard-coded this description in AdaptedResourcesController#build_resource'
+  end
+end

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  include SuperResources::Controller
+end

data/spec/dummy/app/controllers/child_resources_controller.rb

@@ -0,0 +1,2 @@
+class ChildResourcesController < ApplicationController
+end

data/spec/dummy/app/controllers/grandparent_resources_controller.rb

@@ -0,0 +1,13 @@
+class GrandparentResourcesController < ApplicationController
+	def create
+		super :location => polymorphic_url(parent)
+	end
+
+	def update
+		super :location => polymorphic_url(parent)
+	end
+
+	def destroy
+		super :location => polymorphic_url(parent)
+	end
+end

data/spec/dummy/app/controllers/great_grandparent_resources_controller.rb

@@ -0,0 +1,46 @@
+class GreatGrandparentResourcesController < ApplicationController
+	def index
+		super do
+			collection.each do |r|
+				r.description = 'We are all great grandparents'
+				r.save
+			end
+		end
+	end
+
+	def show
+		super do
+			resource.description = 'I am a great grandparent'
+		end
+	end
+
+	def new
+		super do
+			resource.description = 'I am becoming a new great grandparent'
+		end
+	end
+
+	def edit
+		super do
+			resource.description = 'I am becoming a great grandparent again'
+		end
+	end
+
+	def create
+		super do
+			resource.description = 'I am a new great grandparent'
+		end
+	end
+
+	def update
+		super do
+			resource.description = 'I am a great grandparent again'
+		end
+	end
+
+	def destroy
+		super do
+			@obituary = 'Here lies a dead great grandparent'
+		end
+	end
+end

data/spec/dummy/app/controllers/my_adapted_resources_controller.rb

@@ -0,0 +1,8 @@
+class MyAdaptedResourcesController < AdaptedResourcesController
+
+  protected
+
+  def finder_method
+  	:find_by_description
+  end
+end

data/spec/dummy/app/controllers/parent_resources_controller.rb

@@ -0,0 +1,2 @@
+class ParentResourcesController < ApplicationController
+end

data/spec/dummy/app/controllers/simple_resources_controller.rb

@@ -0,0 +1,2 @@
+class SimpleResourcesController < ApplicationController
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end