resource_controller 0.4.9 → 0.5.0

data/README.rdoc

@@ -102,6 +102,42 @@ With actions that can fail, the scoping defaults to success.  That means that cr
     end
     
   end
+  
+== Singleton Resource
+
+If you want to create a singleton RESTful controller inherit from ResourceController::Singleton.
+
+  class AccountsController < ResourceController::Singleton
+  end
+
+*Note:* This type of controllers handle a single resource only so the index action and all the collection helpers (collection_url, collection_path...) are not available for them.
+
+Loading objects in singletons is similar to plural controllers with one exception. For non-nested singleton controllers you should override the object method as it defaults to nil for them.
+
+  class AccountsController < ResourceController::Singleton
+    private
+      def object
+        @object ||= Account.find(session[:account_id])
+      end
+   end
+
+In other cases you can use the default logic and override it only if you use permalinks or anything special. 
+
+Singleton nesting with both :has_many and :has_one associations is provided...
+
+  map.resource :account, :has_many => :options  # /account/options, account is a singleton parent
+  map.resources :users, :has_one => :image  # /users/1/image, image is a singleton child
+
+If you have the :has_many association with a singleton parent remember to override parent_object for your :has_many controller as it returns nil by default in this case.
+
+  class OptionsController < ResourceController::Base
+    belongs_to :account
+
+    protected
+    def parent_object
+      Account.find(session[:account_id])
+    end
+  end
 
 == Helpers (ResourceController::Helpers)
 
@@ -279,4 +315,4 @@ resource_controller was created, and is maintained by {James Golick}[http://jame
 
 == License
 
-resource_controller is available under the {MIT License}[http://en.wikipedia.org/wiki/MIT_License]
+resource_controller is available under the {MIT License}[http://en.wikipedia.org/wiki/MIT_License]

data/Rakefile

@@ -2,7 +2,7 @@ require 'rake'
 require 'rake/testtask'
 require 'rake/rdoctask'
 require File.dirname(__FILE__)+'/lib/resource_controller/version'
-Dir['lib/tasks/**.rake'].each { |tasks| load tasks }
+Dir['tasks/**.rake'].each { |tasks| load tasks }
 
 desc 'Default: run unit tests.'
 task :default => :test
@@ -19,7 +19,7 @@ Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title    = 'ResourceController'
   rdoc.options << '--line-numbers' << '--inline-source'
-  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('README.rdoc')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 

data/lib/resource_controller.rb

@@ -1,14 +1,19 @@
 module ResourceController
-  ACTIONS          = [:index, :show, :new_action, :create, :edit, :update, :destroy].freeze
-  FAILABLE_ACTIONS = ACTIONS - [:index, :new_action, :edit].freeze
-  NAME_ACCESSORS   = [:model_name, :route_name, :object_name]  
+  ACTIONS           = [:index, :show, :new_action, :create, :edit, :update, :destroy].freeze
+  SINGLETON_ACTIONS = (ACTIONS - [:index]).freeze
+  FAILABLE_ACTIONS  = ACTIONS - [:index, :new_action, :edit].freeze
+  NAME_ACCESSORS    = [:model_name, :route_name, :object_name]  
   
   module ActionControllerExtension
     unloadable
     
-    def resource_controller
+    def resource_controller(*args)
       include ResourceController::Controller
-    end
+      
+      if args.include?(:singleton)
+        include ResourceController::Helpers::SingletonCustomizations
+      end
+    end  
   end
 end
 

data/lib/resource_controller/class_methods.rb

@@ -10,8 +10,10 @@ module ResourceController
       config = {}
       config.merge!(opts.pop) if opts.last.is_a?(Hash)
 
+      all_actions = (singleton? ? ResourceController::SINGLETON_ACTIONS : ResourceController::ACTIONS) - [:new_action] + [:new]
+      
       actions_to_remove = []
-      actions_to_remove += (ResourceController::ACTIONS - [:new_action] + [:new]) - opts unless opts.first == :all                
+      actions_to_remove += all_actions - opts unless opts.first == :all                
       actions_to_remove += [*config[:except]] if config[:except]
       actions_to_remove.uniq!
 

data/lib/resource_controller/controller.rb

@@ -57,6 +57,12 @@ module ResourceController
             flash "Successfully removed!"
             wants.html { redirect_to collection_url }
           end
+          
+          class << self
+            def singleton?
+              false
+            end
+          end
         end
       end
   end

data/lib/resource_controller/helpers/nested.rb

@@ -1,7 +1,7 @@
 # Nested and Polymorphic Resource Helpers
 #
 module ResourceController::Helpers::Nested
-  protected
+  protected    
     # Returns the relevant association proxy of the parent. (i.e. /posts/1/comments # => @post.comments)
     #
     def parent_association
@@ -11,7 +11,19 @@ module ResourceController::Helpers::Nested
     # Returns the type of the current parent
     #
     def parent_type
-      @parent_type ||= [*belongs_to].find { |parent| !params["#{parent}_id".to_sym].nil? }
+      @parent_type ||= parent_type_from_params || parent_type_from_request
+    end
+    
+    # Returns the type of the current parent extracted from params
+    #    
+    def parent_type_from_params
+      [*belongs_to].find { |parent| !params["#{parent}_id".to_sym].nil? }
+    end
+    
+    # Returns the type of the current parent extracted form a request path
+    #    
+    def parent_type_from_request
+      [*belongs_to].find { |parent| request.path.split('/').include? parent.to_s }
     end
     
     # Returns true/false based on whether or not a parent is present.
@@ -20,6 +32,12 @@ module ResourceController::Helpers::Nested
       !parent_type.nil?
     end
     
+    # Returns true/false based on whether or not a parent is a singleton.
+    #    
+    def parent_singleton?
+      !parent_type_from_request.nil?
+    end
+    
     # Returns the current parent param, if there is a parent. (i.e. params[:post_id])
     def parent_param
       params["#{parent_type}_id".to_sym]
@@ -34,7 +52,7 @@ module ResourceController::Helpers::Nested
     # Returns the current parent object if a parent object is present.
     #
     def parent_object
-      parent? ? parent_model.find(parent_param) : nil
+      parent? && !parent_singleton? ? parent_model.find(parent_param) : nil
     end
     
     # If there is a parent, returns the relevant association proxy.  Otherwise returns model.

data/lib/resource_controller/helpers/singleton_customizations.rb

@@ -0,0 +1,60 @@
+# Singleton Resource Helpers
+# 
+# Used internally to transform a plural RESTful controller into a singleton
+#
+module ResourceController::Helpers::SingletonCustomizations
+  def self.included(subclass)
+    subclass.class_eval do  
+      methods_to_undefine = [:param, :index, :collection, :load_collection, :collection_url, 
+        :collection_path, :hash_for_collection_url, :hash_for_collection_path]
+      methods_to_undefine.each { |method| undef_method(method) if method_defined? method }
+      
+      class << self
+        def singleton?
+          true
+        end
+      end
+    end
+  end
+  
+  protected
+    # Used to fetch the current object in a singleton controller.
+    #
+    # By defult this method is able to fetch the current object for resources nested with the :has_one association only. (i.e. /users/1/image # => @user.image)
+    # In other cases you should override this method and provide your custom code to fetch a singleton resource object, like using a session hash.
+    #
+    # class AccountsController < ResourceController::Singleton
+    #   private
+    #     def object
+    #       @object ||= Account.find(session[:account_id])
+    #     end
+    #   end
+    #  
+    def object
+      @object ||= parent? ? end_of_association_chain : nil
+    end
+
+    # Returns the :has_one association proxy of the parent. (i.e. /users/1/image # => @user.image)
+    #  
+    def parent_association
+      @parent_association ||= parent_object.send(model_name.to_sym)
+    end
+  
+    # Used internally to provide the options to smart_url in a singleton controller.
+    #  
+    def object_url_options(action_prefix = nil, alternate_object = nil)
+      [action_prefix] + namespaces + [parent_url_options, route_name.to_sym]
+    end
+  
+    # Builds the object, but doesn't save it, during the new, and create action.
+    #
+    def build_object
+      @object ||= singleton_build_object_base.send parent? ? "build_#{model_name}".to_sym : :new, object_params
+    end
+    
+    # Singleton controllers don't build off of association proxy, so we can't use end_of_association_chain here
+    #
+    def singleton_build_object_base
+      parent? ? parent_object : model
+    end
+end

data/lib/resource_controller/helpers/urls.rb

@@ -110,7 +110,11 @@ module ResourceController::Helpers::Urls
     end
     
     def parent_url_options
-      parent? ? [parent_type.to_sym, parent_object] : nil
+      if parent?
+        parent_singleton? ? parent_type.to_sym : [parent_type.to_sym, parent_object]
+      else
+        nil
+      end
     end
     
     # Returns all of the current namespaces of the current controller, symbolized, in array form.

data/lib/resource_controller/singleton.rb

@@ -0,0 +1,15 @@
+module ResourceController
+  
+  # == ResourceController::Singleton
+  # 
+  # Inherit from this class to create your RESTful singleton controller.  See the README for usage.
+  # 
+  class Singleton < ApplicationController
+    unloadable
+    
+    def self.inherited(subclass)
+      super
+      subclass.class_eval { resource_controller :singleton }
+    end
+  end
+end

data/lib/resource_controller/version.rb

@@ -1,8 +1,8 @@
 module ResourceController
   module VERSION
     MAJOR    = 0
-    MINOR    = 4
-    TINY     = 9
+    MINOR    = 5
+    TINY     = 0
     
     STRING   = [MAJOR, MINOR, TINY].join('.')
   end

data/test/app/controllers/accounts_controller.rb

@@ -0,0 +1,6 @@
+class AccountsController < ResourceController::Singleton
+  protected
+    def object
+      Account.find(:first)
+    end
+end

data/test/app/controllers/cms/products_controller.rb

@@ -1,3 +1,3 @@
 class Cms::ProductsController < ResourceController::Base
-  create.flash_now 'something'
+  create.flash 'something'
 end

data/test/app/controllers/images_controller.rb

@@ -0,0 +1,4 @@
+class ImagesController < ResourceController::Singleton
+  belongs_to :user
+  actions :create
+end

data/test/app/controllers/options_controller.rb

@@ -0,0 +1,8 @@
+class OptionsController < ResourceController::Base
+  belongs_to :account
+  
+  protected
+    def parent_object
+      Account.find(:first)
+    end
+end

data/test/app/helpers/accounts_helper.rb

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

data/test/app/helpers/images_helper.rb

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

data/test/app/models/account.rb

@@ -1,3 +1,4 @@
 class Account < ActiveRecord::Base
   has_many :photos
+  has_many :options
 end

data/test/app/models/image.rb

@@ -0,0 +1,3 @@
+class Image < ActiveRecord::Base
+  belongs_to :user
+end

data/test/app/models/user.rb

@@ -0,0 +1,3 @@
+class User < ActiveRecord::Base
+  has_one :image
+end

data/test/app/views/accounts/_form.html.erb

@@ -0,0 +1,4 @@
+<p>
+  <label for="account_name">Name:</label>
+  <%= f.text_field :name %>
+</p>

data/test/app/views/accounts/edit.html.erb

@@ -0,0 +1,14 @@
+<h1>Editing Account</h1>
+
+<%= error_messages_for :account %>
+
+<% form_for(:account, :url => object_url, :html => { :method => :put }) do |f| %>
+  <%= render :partial => "form", :locals => { :f => f } %>
+  <p>
+    <%=submit_tag "Update"%>
+  </p>
+<% end %>
+
+<br/>
+
+<%= link_to 'Show', object_url %>

data/test/app/views/accounts/new.html.erb

@@ -0,0 +1,12 @@
+<h1>New Account</h1>
+
+<%= error_messages_for :account %>
+
+<% form_for(:account, :url => object_url) do |f| %>
+  <%= render :partial => "form", :locals => { :f => f } %>
+  <p>
+    <%= submit_tag "Create" %>
+  </p>
+<% end %>
+<br/>
+<%= link_to 'Back', object_url %>

data/test/app/views/accounts/show.html.erb

@@ -0,0 +1,5 @@
+<p>
+  <strong>Name:</strong><%=h @account.name %>
+</p>
+
+<%= link_to 'Edit', edit_object_url %>

data/test/app/views/images/_form.html.erb

@@ -0,0 +1,4 @@
+<p>
+  <label for="image_user_id">User:</label>
+  <%= f.text_field :user_id %>
+</p>

data/test/app/views/images/edit.html.erb

@@ -0,0 +1,14 @@
+<h1>Editing Image</h1>
+
+<%= error_messages_for :image %>
+
+<% form_for(:image, :url => object_url, :html => { :method => :put }) do |f| %>
+  <%= render :partial => "form", :locals => { :f => f } %>
+  <p>
+    <%=submit_tag "Update"%>
+  </p>
+<% end %>
+
+<br/>
+
+<%= link_to 'Show', object_url %>

data/test/app/views/images/new.html.erb

@@ -0,0 +1,12 @@
+<h1>New Image</h1>
+
+<%= error_messages_for :image %>
+
+<% form_for(:image, :url => object_url) do |f| %>
+  <%= render :partial => "form", :locals => { :f => f } %>
+  <p>
+    <%= submit_tag "Create" %>
+  </p>
+<% end %>
+<br/>
+<%= link_to 'Back', object_url %>

data/test/app/views/options/_form.html.erb

@@ -0,0 +1,8 @@
+<p>
+  <label for="option_account_id">Account:</label>
+  <%= f.text_field :account_id %>
+</p>
+<p>
+  <label for="option_name">Title:</label>
+  <%= f.text_field :title %>
+</p>

data/test/app/views/options/edit.html.erb

@@ -0,0 +1,16 @@
+<h1>Editing Option</h1>
+
+<%= error_messages_for :option %>
+
+<% form_for(:option, :url => object_url, :html => { :method => :put }) do |f| %>
+  <%= render :partial => "form", :locals => { :f => f } %>
+  <p>
+    <%=submit_tag "Update"%>
+  </p>
+<% end %>
+
+<br/>
+
+<%= link_to 'Show', object_url %>
+|
+<%= link_to 'Back', collection_url %>

data/test/app/views/options/index.html.erb

@@ -0,0 +1,21 @@
+<h1>Listing Options</h1>
+
+<table>
+  <tr>
+    <th>Account</th>
+    <th>Title</th>
+  </tr>
+  <%- @options.each do |option|%>
+    <tr>
+      <td><%=h option.account_id %></td>
+      <td><%=h option.title %></td>
+    
+      <td><%=link_to 'Show', object_url(option) %></td>
+      <td><%=link_to 'Edit', edit_object_url(option) %></td>
+      <td><%=link_to 'Destroy', object_url(option), :confirm => 'Are you sure?', :method => :delete %></td>
+    </tr>
+  <% end %>
+</table>
+<br/>
+
+<%= link_to 'New Option', new_object_url %>