inherited_resources 1.1.2 → 1.2.0

data/.gitignore

@@ -0,0 +1 @@
+.bundle

data/CHANGELOG

@@ -1,3 +1,9 @@
+# Version 1.2
+
+* Improved lookup for namespaces (by github.com/Sirupsen)
+* Support to custom actions (by github.com/lda)
+* Rails 3.1 compatibility (by github.com/etehtsea)
+
 # Version 1.1
 
 * Rails 3 compatible

data/Gemfile

@@ -0,0 +1,12 @@
+source "http://rubygems.org"
+
+gem "rails", "3.0.3"
+gem "responders", "~> 0.6.0"
+gem "has_scope", "~> 0.5.0"
+gem "mocha"
+
+if RUBY_VERSION < "1.9"
+  gem "ruby-debug"
+else
+  gem "test-unit"
+end

data/Gemfile.lock

@@ -0,0 +1,86 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.3)
+      actionpack (= 3.0.3)
+      mail (~> 2.2.9)
+    actionpack (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.13)
+      rack-test (~> 0.5.6)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.3)
+      activesupport (= 3.0.3)
+      builder (~> 2.1.2)
+      i18n (~> 0.4)
+    activerecord (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+      arel (~> 2.0.2)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+    activesupport (3.0.3)
+    arel (2.0.6)
+    builder (2.1.2)
+    columnize (0.3.1)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    has_scope (0.5.0)
+    i18n (0.5.0)
+    linecache (0.43)
+    mail (2.2.14)
+      activesupport (>= 2.3.6)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    mocha (0.9.8)
+      rake
+    polyglot (0.3.1)
+    rack (1.2.1)
+    rack-mount (0.6.13)
+      rack (>= 1.0.0)
+    rack-test (0.5.7)
+      rack (>= 1.0)
+    rails (3.0.3)
+      actionmailer (= 3.0.3)
+      actionpack (= 3.0.3)
+      activerecord (= 3.0.3)
+      activeresource (= 3.0.3)
+      activesupport (= 3.0.3)
+      bundler (~> 1.0)
+      railties (= 3.0.3)
+    railties (3.0.3)
+      actionpack (= 3.0.3)
+      activesupport (= 3.0.3)
+      rake (>= 0.8.7)
+      thor (~> 0.14.4)
+    rake (0.8.7)
+    responders (0.6.2)
+    ruby-debug (0.10.3)
+      columnize (>= 0.1)
+      ruby-debug-base (~> 0.10.3.0)
+    ruby-debug-base (0.10.3)
+      linecache (>= 0.3)
+    thor (0.14.6)
+    treetop (1.4.9)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.24)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  has_scope (~> 0.5.0)
+  mocha
+  rails (= 3.0.3)
+  responders (~> 0.6.0)
+  ruby-debug

data/README.rdoc

@@ -5,18 +5,31 @@ all restful actions so you just have to focus on what is important. It makes
 your controllers more powerful and cleaner at the same time.
 
 Plus, making your controllers follow a pattern, it helps you to write better
-code by following fat models and skinny controllers convention. There is
-a screencast made by Fabio Akita about its features:
+code by following fat models and skinny controllers convention. There are
+two screencasts available besides this README:
 
+http://railscasts.com/episodes/230-inherited-resources
 http://akitaonrails.com/2009/09/01/screencast-real-thin-restful-controllers-with-inherited-resources
 
-== Rails 3
+== Installation
+
+=== Rails 3
 
 Inherited Resources master branch is now supports Rails 3 and is NOT backward compatible.
 
-You can install it as:
+You can let bundler to install Inherited Resources by adding this line to your application's Gemfile:
+
+  gem 'inherited_resources', '~> 1.2'
+
+And then execute:
+
+  bundle install 
+
+Or install it yourself as:
 
-  sudo gem install inherited_resources --version=1.1.1
+  gem install inherited_resources --version=1.2
+
+=== Rails 2.3.x
 
 If you want to use the Rails 2.3.x version, you should install:
 
@@ -38,7 +51,7 @@ has_scope gem is available at:
 
 And can be installed as:
 
-  sudo gem install has_scope
+  gem install has_scope
 
 == Responders
 
@@ -51,24 +64,13 @@ how it will change your application:
 
 And it can be installed as:
 
-  sudo gem install responders
+  gem install responders
 
 Using responders will set the flash message to :notice and :alert. You can change
 that through the following configuration value:
 
   InheritedResources.flash_keys = [ :success, :failure ]
 
-== Rspec known bug
-
-Rspec monkey patches a couple of controller methods in a way that Controller specs
-(with integrate views true or false) and Inherited Resources are not compatible.
-
-However, since your controllers inherit from InheritedResources::Base, they are
-already unit-tested in the plugin, so there is no need to test them again in Rspec.
-
-You should test things like url redirection and associations in your integration
-specs.
-
 == Basic Usage
 
 To use Inherited Resources you just have to inherit (duh) it:
@@ -279,6 +281,25 @@ give a block that expects two arguments, the first will be executed only in
 success scenarios and the second in failure scenarios. You keep everything
 clean and organized inside the same action.
 
+== Smart redirects
+
+Although the syntax above is a nice shortcut, you won't need to do it frequently
+because (since version 1.2) Inherited Resources has smart redirects. Redirects
+in actions calculates depending on the existent controller methods.
+
+Redirects in create and update actions calculates in following order resource_url,
+collection_url, parent_url (which we are going to see later), root_url. Redirect
+in destroy action calculate in following order collection_url, parent_url, root_url.
+
+Example:
+
+    class ButtonsConntroller < InheritedResources::Base
+      belong_to :window
+      actions :all, :except => [:show, :index]
+    end
+
+This controller redirect to parent window after all CUD actions.
+
 == Success and failure scenarios on destroy
 
 The destroy action can also fail, this usually happens when you have a
@@ -294,24 +315,6 @@ be something like this:
       end
     end
 
-== Some DSL
-
-For those DSL lovers, InheritedResources won't leave you alone. You can overwrite
-your success/failure blocks straight from your class binding. For it, you just
-need to add a DSL module to your application controller:
-
-    class ApplicationController < ActionController::Base
-      include InheritedResources::DSL
-    end
-
-And then you can rewrite the last example as:
-
-    class ProjectsController < InheritedResources::Base
-      update! do |success, failure|
-        failure.html { redirect_to project_url(@project) }
-      end
-    end
-
 == Belongs to
 
 Finally, our Projects are going to get some Tasks. Then you create a
@@ -399,7 +402,7 @@ to have two polymorphic associations nested.
 Later you decide to create a view to show all comments, independent if they belong
 to a task, file or message. You can reuse your polymorphic controller just doing:
 
-    class ProjectsController < InheritedResources::Base
+    class CommentsController < InheritedResources::Base
       belongs_to :task, :file, :message, :optional => true
       # optional_belongs_to :task, :file, :message
     end
@@ -435,6 +438,20 @@ option.
 
 It will deal with everything again and hide the action :index from you.
 
+== Namespaced Controllers
+
+Namespaced controllers works out the box.
+
+    class Forum::PostsController < InheritedResources::Base
+    end
+
+Inherited Resources prioritizes the default resource class for the namespaced controller in
+this order:
+
+    Forum::Post
+    ForumPost
+    Post
+
 == URL Helpers
 
 When you use InheritedResources it creates some URL helpers.
@@ -478,6 +495,43 @@ Another nice thing is that those urls are not guessed during runtime. They are
 all created when your application is loaded (except for polymorphic
 associations, that relies on Rails polymorphic_url).
 
+== Custom actions
+
+Since version 1.2, Inherited Resources allows you to define custom actions in controller:
+
+    class ButtonsController < InheritedResources::Base
+      custom_actions :resource => :delete, :collection => :search
+    end
+
+This code creates delete and search actions in controller (they behaves like show and
+index actions accordingly). Also, it will produce delete_resource_{path,url} and 
+search_resources_{path,url} url helpers.
+
+== What about views?
+
+Sometimes just DRY the controllers is not enough, if you need to DRY up your views,
+check this Wiki page:
+
+https://github.com/josevalim/inherited_resources/wiki/Views-Inheritance
+
+== Some DSL
+
+For those DSL lovers, InheritedResources won't leave you alone. You can overwrite
+your success/failure blocks straight from your class binding. For it, you just
+need to add a DSL module to your application controller:
+
+    class ApplicationController < ActionController::Base
+      include InheritedResources::DSL
+    end
+
+And then you can rewrite the last example as:
+
+    class ProjectsController < InheritedResources::Base
+      update! do |success, failure|
+        failure.html { redirect_to project_url(@project) }
+      end
+    end
+
 == Bugs and Feedback
 
 If you discover any bugs or want to drop a line, join us in the mailing list:

data/Rakefile

@@ -3,28 +3,6 @@
 require 'rake'
 require 'rake/testtask'
 require 'rake/rdoctask'
-require File.join(File.dirname(__FILE__), 'lib', 'inherited_resources', 'version')
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |s|
-    s.name = "inherited_resources"
-    s.version = InheritedResources::VERSION.dup
-    s.rubyforge_project = "inherited_resources"
-    s.summary = "Inherited Resources speeds up development by making your controllers inherit all restful actions so you just have to focus on what is important."
-    s.email = "jose.valim@gmail.com"
-    s.homepage = "http://github.com/josevalim/inherited_resources"
-    s.description = "Inherited Resources speeds up development by making your controllers inherit all restful actions so you just have to focus on what is important."
-    s.authors = ['José Valim']
-    s.files =  FileList["[A-Z]*", "init.rb", "{lib}/**/*"]
-    s.add_dependency("responders", "~> 0.6.0")
-    s.add_dependency("has_scope",  "~> 0.5.0")
-  end
-
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
-end
 
 desc 'Run tests for InheritedResources.'
 Rake::TestTask.new(:test) do |t|

data/inherited_resources.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "inherited_resources/version"
+
+Gem::Specification.new do |s|
+  s.name        = "inherited_resources"
+  s.version     = InheritedResources::VERSION.dup
+  s.platform    = Gem::Platform::RUBY
+  s.summary     = "Inherited Resources speeds up development by making your controllers inherit all restful actions so you just have to focus on what is important."
+  s.email       = "developers@plataformatec.com.br"
+  s.homepage    = "http://github.com/josevalim/inherited_resources"
+  s.description = "Inherited Resources speeds up development by making your controllers inherit all restful actions so you just have to focus on what is important."
+  s.authors     = ['José Valim']
+
+  s.rubyforge_project = "inherited_resources"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency("responders", "~> 0.6.0")
+  s.add_dependency("has_scope",  "~> 0.5.0")
+end

data/lib/inherited_resources.rb

@@ -6,6 +6,7 @@ module InheritedResources
   autoload :Actions,            'inherited_resources/actions'
   autoload :Base,               'inherited_resources/base'
   autoload :BaseHelpers,        'inherited_resources/base_helpers'
+  autoload :ShallowHelpers,     'inherited_resources/shallow_helpers'
   autoload :BelongsToHelpers,   'inherited_resources/belongs_to_helpers'
   autoload :ClassMethods,       'inherited_resources/class_methods'
   autoload :DSL,                'inherited_resources/dsl'
@@ -21,7 +22,11 @@ module InheritedResources
 
   class Railtie < ::Rails::Railtie
     config.inherited_resources = InheritedResources
-    config.generators.scaffold_controller = :inherited_resources_controller
+    if config.respond_to?(:app_generators)
+      config.app_generators.scaffold_controller = :inherited_resources_controller
+    else
+      config.generators.scaffold_controller = :inherited_resources_controller
+    end
   end
 end
 
@@ -34,4 +39,4 @@ class ActionController::Base
     initialize_resources_class_accessors!
     create_resources_url_helpers!
   end
-end
+end

data/lib/inherited_resources/actions.rb

@@ -31,7 +31,7 @@ module InheritedResources
       object = build_resource
 
       if create_resource(object)
-        options[:location] ||= resource_url rescue nil
+        options[:location] ||= smart_resource_url
       end
 
       respond_with_dual_blocks(object, options, &block)
@@ -42,8 +42,8 @@ module InheritedResources
     def update(options={}, &block)
       object = resource
 
-      if update_resource(object, params[resource_instance_name])
-        options[:location] ||= resource_url rescue nil
+      if update_resource(object, params[resource_request_name])
+        options[:location] ||= smart_resource_url
       end
 
       respond_with_dual_blocks(object, options, &block)
@@ -53,7 +53,7 @@ module InheritedResources
     # DELETE /resources/1
     def destroy(options={}, &block)
       object = resource
-      options[:location] ||= collection_url rescue nil
+      options[:location] ||= smart_collection_url
 
       destroy_resource(object)
       respond_with_dual_blocks(object, options, &block)

data/lib/inherited_resources/base.rb

@@ -24,18 +24,19 @@ module InheritedResources
         respond_to :html
         self.responder = InheritedResources::Responder
 
-        helper_method :collection_url, :collection_path, :resource_url, :resource_path,
-                      :new_resource_url, :new_resource_path, :edit_resource_url, :edit_resource_path,
-                      :parent_url, :parent_path, :resource, :collection, :resource_class, :association_chain,
-                      :resource_instance_name, :resource_collection_name
+        helper_method :resource, :collection, :resource_class, :association_chain,
+                      :resource_instance_name, :resource_collection_name,
+                      :resource_url, :resource_path,
+                      :collection_url, :collection_path,
+                      :new_resource_url, :new_resource_path,
+                      :edit_resource_url, :edit_resource_path,
+                      :parent_url, :parent_path,
+                      :smart_resource_url, :smart_collection_url
 
-        base.with_options :instance_writer => false do |c|
-          c.class_inheritable_accessor :resource_class
-          c.class_inheritable_array :parents_symbols
-          c.class_inheritable_hash :resources_configuration
-        end
+        self.class_attribute :resource_class,  :parents_symbols,  :resources_configuration, :instance_writer => false
 
-        protected :resource_class, :parents_symbols, :resources_configuration
+        protected :resource_class, :parents_symbols, :resources_configuration,
+          :resource_class?, :parents_symbols?, :resources_configuration?
       end
     end