super_resources 1.0.0.rc1 → 1.0.0.rc2

data/.gitignore

@@ -15,6 +15,7 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.DS_Store
 
 spec/dummy/log/*.log
 spec/dummy/db/*.sqlite3

data/README.md

@@ -126,13 +126,12 @@ SuperResources derives the class of the target resource from the controller name
 
 Yes, you can adapt these to suit your needs. 
 
-Both `resource` and `collection` accept a block, which SuperResources uses to stitch into its internal implementation, so tht any subsequent calls to these helpers uses your implementation.
-The block for `resource` shall answer a single instance of the resource class and the block for `collection` shall answer an array of instances of the resource class. 
+The `resource` and `collection` methods are used internally by the default RESTful actions provided by SuperResources, and can have their implementations customised easily. The return values of these methods are memoized for various reasons, for this you should make use of the `memoize_resource` and `memoize_collection` methods respectivley. Both methods take a block that is only executed as necessary.
 
 For example, if you wanted 'TeamsController#collection' to return only those teams that the current user has joined, you would write an implementation of `collection` that calls its super, passing a block the evalautes to the right collection:
 
     def collection
-      super { resource_class.joined_by(current_user) }
+      memoize_collection { resource_class.joined_by(current_user) }
     end
 
 If that looks strange, bear in mind it's been designed so that you don't need to know how SuperResources internally uses your preferred implementation.
@@ -156,20 +155,10 @@ While SuperResource uses the `find` method as the default, you can choose anothe
 
 ### Builder Method
 
-SuperResources extracts the construction of a new resource into the `build_resource` method. If you need to create a new resource, say in a special action, use 'build_resource' so that SuperResource can also keep track of it (for example, make sure that `resource' answers the built object).
-
-If you need to do specialized work for the build, pass the a block to `build_resource` that evaluates to an object with the state you need. For example:
-
-    build_resource do
-      resource_class.new do |p|
-        # initialize the state here
-      end
-    end
-
-More commonly, you would redefine the whole method so that it always behaves the same way for its enclosing controller:
+SuperResources extracts the construction of a new resource into the `build_resource` method. If you need to do specialized work for the build, override the `build_resource` method and be sure to memoize your result:
 
     def build_resource
-      super do
+      memoize_resource do
         resource_class.new do |p|
           # initialize the state here
         end
@@ -200,9 +189,9 @@ Just do it. Declare them in your controller and match them in routes. All the Su
 
 ## Acknowledgments
 
-SuperResources would never have happened without InheritedResources [https://github.com/josevalim/inherited_resources] existing first.
+SuperResources would never have happened without [InheritedResources](https://github.com/josevalim/inherited_resources) existing first.
 We preferred the idea of abstracting and extracting RESTful actions out of all our controllers and we're not so keen on scaffolds generating
-un-DRY code. We used InheritedResources in a production deployed application [meetlinkshare.com], gained some experience and decided we wanted an even DRYer tool.
+un-DRY code. We used InheritedResources in a production deployed application [MeetLinkShare](http://www.meetlinkshare.com), gained some experience and decided we wanted an even DRYer tool.
 
 The basic mechanics of SuperResources was hacked out during Rails Camp 12 in Tasmania, Australia and was subsequently applied to MeetLinkShare.
 

data/lib/generators/rails/super_controller_generator.rb

@@ -0,0 +1,13 @@
+require 'rails/generators/rails/scaffold_controller/scaffold_controller_generator'
+
+module Rails
+  module Generators
+    class SuperControllerGenerator < Rails::Generators::ScaffoldControllerGenerator
+      def self.source_root
+        @source_root ||= File.expand_path('../templates', __FILE__)
+      end
+    end
+  end
+end
+
+

data/lib/generators/rails/templates/controller.rb

@@ -0,0 +1,9 @@
+<% if namespaced? -%>
+require_dependency "<%= namespaced_file_path %>/application_controller"
+
+<% end -%>
+<% module_namespacing do -%>
+class <%= controller_class_name %>Controller < ApplicationController
+  include SuperResources::Controller
+end
+<% end -%>

data/lib/super_resources/nesting.rb

@@ -1,7 +1,9 @@
 module SuperResources
   module Nesting
     extend ActiveSupport::Concern
+
     include Resources
+    include Routing
 
     included do
       helper_method :association_chain, :with_chain, :method_missing, :respond_to?
@@ -24,28 +26,16 @@ module SuperResources
       end
     end
 
-    def collection(&block)
-      if block_given?
-        @collection = yield
-      else
-        @collection ||= end_of_association_chain
-      end
+    def collection
+      memoize_collection { end_of_association_chain }
     end
 
-    def resource(&block)
-      if block_given?
-        @resource = yield
-      else
-        @resource ||= end_of_association_chain.send(finder_method, params[:id])
-      end
+    def resource
+      memoize_resource { end_of_association_chain.send(finder_method, params[:id]) }
     end
 
-    def build_resource(&block)
-      if block_given?
-        @resource = yield
-      else
-        @resource ||= end_of_association_chain.build(resource_params)
-      end
+    def build_resource(params={})
+      memoize_resource { end_of_association_chain.build(params) }
     end
 
     def nested?
@@ -82,29 +72,10 @@ module SuperResources
         route.parts \
              .select { |p| p.to_s =~ %r(_id$) } \
              .map    { |p| p.to_s.gsub(/_id$/, '').to_sym }
-      @symbols_for_association_chain
     end
 
     def with_chain(object)
       association_chain + [ object ]
     end
-
-    def route
-      @route ||= begin
-        routes.formatter.send(:match_route, nil, path_parameters) do |route|
-          # TODO: don't assume the first route is good, validate!
-          # TODO: don't use break
-          break route
-        end
-      end
-    end
-
-    def routes
-      request.env['action_dispatch.routes']
-    end
-
-    def path_parameters
-      request.env['action_dispatch.request.path_parameters'].symbolize_keys
-    end
   end
 end

data/lib/super_resources/railtie.rb

@@ -0,0 +1,9 @@
+module SuperResources
+  class Railtie < Rails::Railtie
+    if config.respond_to?(:app_generators)
+      config.app_generators.scaffold_controller = :super_controller
+    else
+      config.generators.scaffold_controller = :super_controller
+    end
+  end
+end

data/lib/super_resources/resources.rb

@@ -3,7 +3,7 @@ module SuperResources
     extend ActiveSupport::Concern
 
     included do
-      helper_method :collection, :collection=, :resource, :resource=, :resource_class, :parent, :nested?
+      helper_method :collection, :resource, :resource_class, :parent, :nested?
     end
 
     protected
@@ -24,28 +24,20 @@ module SuperResources
       controller_name.to_sym
     end
 
-    def collection(&block)
-      if block_given?
-        @collection = yield
-      else
-        @collection ||= resource_class.scoped
-      end
+    def collection
+      memoize_collection { resource_class.scoped }
     end
 
-    def collection=(c)
-      @collection = c
+    def memoize_collection(&block)
+      @collection ||= block.call
     end
 
-    def resource(&block)
-      if block_given?
-        @resource = yield
-      else
-        @resource ||= resource_class.send(finder_method, params[:id])
-      end
+    def resource
+      memoize_resource { resource_class.send(finder_method, params[:id]) }
     end
 
-    def resource=(r)
-      @resource = r
+    def memoize_resource(&block)
+      @resource ||= block.call
     end
 
     def finder_method
@@ -60,25 +52,20 @@ module SuperResources
       nil
     end
 
-    def build_resource(&block)
-      if block_given?
-        @resource = yield
-      else
-        @resource ||= resource_class.new(resource_params)
-      end
+    def resource_params
+      params[resource_params_name] || {}
     end
 
-    def create_resource(attributes)
-      build_resource.attributes = attributes
-      resource.save
+    def build_resource(params={})
+      memoize_resource { resource_class.new(params) }
     end
 
-    def update_resource(attributes)
-      resource.update_attributes(attributes)
+    def create_resource(params)
+      build_resource(params).save
     end
-  
-    def resource_params
-      params[resource_params_name] || {}
+
+    def update_resource(params)
+      resource.update_attributes(params)
     end
 
     def destroy_resource

data/lib/super_resources/routing.rb

@@ -0,0 +1,40 @@
+module SuperResources
+  module Routing
+    extend ActiveSupport::Concern
+
+    protected
+
+    def routes
+      Rails.application.routes || request.env['action_dispatch.routes']
+    end
+
+    def router
+      routes.router
+    end
+
+    def route
+      @route ||= recognize_route(request.path.present? ? request : mock_request)
+    end
+
+    private
+
+    def recognize_route(request)
+      router.recognize(request) do |route, matches, params|
+        return route
+      end
+    end
+
+    def path_parameters
+      request.env['action_dispatch.request.path_parameters'].symbolize_keys
+    end
+
+    def mock_request
+      # used when there's no path in +request+. only seems to happen when
+      # testing controller actions
+      @mock_request ||= begin
+        env = Rack::MockRequest.env_for(url_for(path_parameters), :method => request.method)
+        request.class.new(env)
+      end
+    end
+  end
+end

data/lib/super_resources/support/cancan.rb

@@ -0,0 +1,46 @@
+module SuperController
+  module Cancan
+    extend ActiveSupport::Concern
+
+    def index(*args)
+      authorize! :index, resource_class
+      super
+    end
+
+    def show(*args)
+      authorize! :show, resource
+      super
+    end
+
+    def new(*args)
+      authorize! :new, resource_class
+      super
+    end
+
+    def edit(*args)
+      authorize! :edit, resource
+      super
+    end
+
+    def create(*args)
+      authorize! :create, resource_class
+      super
+    end
+
+    def update(*args)
+      authorize! :update, resource
+      super
+    end
+
+    def destroy(*args)
+      authorize! :destroy, resource
+      super
+    end
+
+    protected
+
+    def collection
+      super.accessible_by(current_ability)
+    end
+  end
+end

data/lib/super_resources/version.rb

@@ -1,3 +1,3 @@
 module SuperResources
-  VERSION = "1.0.0.rc1"
+  VERSION = "1.0.0.rc2"
 end

data/lib/super_resources.rb

@@ -1,11 +1,18 @@
 module SuperResources
-  autoload :Actions,    "super_resources/actions"
-  autoload :Controller, "super_resources/controller"
-  autoload :Nesting,    "super_resources/nesting"
-  autoload :Resources,  "super_resources/resources"
-  autoload :URLHelpers, "super_resources/url_helpers"
-  autoload :Version,    "super_resources/version"
+  extend ActiveSupport::Autoload
 
-  autoload :HasScope,   "super_resources/has_scope"
-  autoload :Cancan,     "super_resources/cancan"
+  autoload :Actions
+  autoload :Controller
+  autoload :Nesting
+  autoload :Resources
+  autoload :Routing
+  autoload :URLHelpers
+  autoload :Version
+
+  autoload_under 'support' do
+    autoload :HasScope
+    autoload :Cancan
+  end
 end
+
+require 'super_resources/railtie' if defined?(Rails)

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

@@ -10,8 +10,8 @@ class AdaptedResourcesController < SimpleResourcesController
     :input
   end
 
-  def build_resource
-   	super do
+  def build_resource(params={})
+    memoize_resource do
       resource_class.new do |p|
          p.description = a_hard_coded_description
     	end

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

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: super_resources
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc1
+  version: 1.0.0.rc2
   prerelease: 6
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-05 00:00:00.000000000 Z
+date: 2013-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -36,19 +36,22 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .DS_Store
 - .gitignore
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- lib/generators/rails/super_controller_generator.rb
+- lib/generators/rails/templates/controller.rb
 - lib/super_resources.rb
 - lib/super_resources/actions.rb
-- lib/super_resources/cancan.rb
 - lib/super_resources/controller.rb
-- lib/super_resources/has_scope.rb
 - lib/super_resources/nesting.rb
+- lib/super_resources/railtie.rb
 - lib/super_resources/resources.rb
+- lib/super_resources/routing.rb
+- lib/super_resources/support/cancan.rb
+- lib/super_resources/support/has_scope.rb
 - lib/super_resources/url_helpers.rb
 - lib/super_resources/version.rb
 - spec/controllers/actions_nested_spec.rb
@@ -59,7 +62,6 @@ files:
 - spec/controllers/resources_adapted_spec.rb
 - spec/controllers/resources_nested_spec.rb
 - spec/controllers/resources_spec.rb
-- spec/dummy/.DS_Store
 - spec/dummy/README.rdoc
 - spec/dummy/Rakefile
 - spec/dummy/app/assets/javascripts/application.js
@@ -146,7 +148,6 @@ test_files:
 - spec/controllers/resources_adapted_spec.rb
 - spec/controllers/resources_nested_spec.rb
 - spec/controllers/resources_spec.rb
-- spec/dummy/.DS_Store
 - spec/dummy/README.rdoc
 - spec/dummy/Rakefile
 - spec/dummy/app/assets/javascripts/application.js

data/lib/super_resources/cancan.rb

@@ -1,15 +0,0 @@
-module SuperController
-  module Cancan
-    extend ActiveSupport::Concern
-
-    included do
-      before_filter :authorize_resource
-    end
-
-    protected
-
-    def authorize_resource
-      #authorize! action_name.to_sym, resource
-    end
-  end
-end