make_resourceful 1.0

data/lib/resourceful/default/urls.rb

@@ -0,0 +1,136 @@
+module Resourceful
+  module Default
+    # This file contains various methods to make URL helpers less painful.
+    # They provide methods analogous to the standard foo_url and foo_path helpers.
+    # However, they use make_resourceful's knowledge of the structure of the controller
+    # to allow you to avoid figuring out which method to call and which parent objects it should be passed.
+    module URLs
+      # This returns the path for the given object,
+      # by default current_object[link:classes/Resourceful/Default/Accessors.html#M000012].
+      # For example, in HatsController the following are equivalent:
+      #
+      #   object_path    #=> "/hats/12"
+      #   hat_path(@hat) #=> "/hats/12"
+      # 
+      def object_path(object = current_object); object_route(object, 'path'); end
+      # Same as object_path, but with the protocol and hostname.
+      def object_url (object = current_object); object_route(object, 'url');  end
+
+      # This is the same as object_path,
+      # unless a parent exists.
+      # Then it returns the nested path for the object.
+      # For example, in HatsController where Person has_many :hats and <tt>params[:person_id] == 42</tt>,
+      # the following are equivalent:
+      #
+      #   nested_object_path             #=> "/person/42/hats/12"
+      #   person_hat_path(@person, @hat) #=> "/person/42/hats/12"
+      # 
+      def nested_object_path(object = current_object); nested_object_route(object, 'path'); end
+      # Same as nested_object_path, but with the protocol and hostname.
+      def nested_object_url (object = current_object); nested_object_route(object, 'url');  end
+
+      # This returns the path for the edit action for the given object,
+      # by default current_object[link:classes/Resourceful/Default/Accessors.html#M000012].
+      # For example, in HatsController the following are equivalent:
+      #
+      #   edit_object_path                    #=> "/hats/12/edit"
+      #   edit_person_hat_path(@person, @hat) #=> "/hats/12/edit"
+      # 
+      def edit_object_path(object = current_object); edit_object_route(object, 'path'); end
+      # Same as edit_object_path, but with the protocol and hostname.
+      def edit_object_url (object = current_object); edit_object_route(object, 'url');  end
+
+      # This returns the path for the collection of the current controller.
+      # For example, in HatsController where Person has_many :hats and <tt>params[:person_id] == 42</tt>,
+      # the following are equivalent:
+      #
+      #   objects_path              #=> "/people/42/hats"
+      #   person_hats_path(@person) #=> "/people/42/hats"
+      # 
+      def objects_path; objects_route('path'); end
+      # Same as objects_path, but with the protocol and hostname.
+      def objects_url ; objects_route('url');  end
+
+      # This returns the path for the new action for the current controller.
+      # For example, in HatsController where Person has_many :hats and <tt>params[:person_id] == 42</tt>,
+      # the following are equivalent:
+      #
+      #   new_object_path              #=> "/people/42/hats/new"
+      #   new_person_hat_path(@person) #=> "/people/42/hats/new"
+      # 
+      def new_object_path; new_object_route('path'); end
+      # Same as new_object_path, but with the protocol and hostname.
+      def new_object_url ; new_object_route('url');  end
+
+      # This returns the path for the parent object.
+      # 
+      def parent_path(object = parent_object)
+        instance_route(parent_class_name.underscore, object, 'path')
+      end
+      # Same as parent_path, but with the protocol and hostname.
+      def parent_url(object = parent_object)
+        instance_route(parent_class_name.underscore, object, 'url')
+      end
+
+      # This prefix is added to the Rails URL helper names
+      # before they're called.
+      # By default, it's the underscored list of namespaces of the current controller,
+      # or nil if there are no namespaces defined.
+      # However, it can be overridden if another prefix is needed.
+      # Note that if this is overridden,
+      # the new method should return a string ending in an underscore.
+      #
+      # For example, in Admin::Content::PagesController:
+      #
+      #   url_helper_prefix #=> "admin_content_"
+      #
+      # Then object_path is the same as <tt>admin_content_page_path(current_object)</tt>.
+      def url_helper_prefix
+        namespaces.empty? ? nil : "#{namespaces.join('_')}_"
+      end
+
+      # This prefix is added to the Rails URL helper names
+      # for the make_resourceful collection URL helpers,
+      # objects_path and new_object_path.
+      # By default, it's the parent name followed by an underscore if a parent
+      # is given, and the empty string otherwise.
+      #
+      # See also url_helper_prefix.
+      def collection_url_prefix
+        parent? ? "#{parent_class_name.underscore}_" : ''
+      end
+
+      private
+
+      def object_route(object, type)
+        instance_route(current_model_name.underscore, object, type)
+      end
+
+      def nested_object_route(object, type)
+        return object_route(object, type) unless parent?
+        send("#{url_helper_prefix}#{parent_class_name.underscore}_#{current_model_name.underscore}_#{type}", parent_object, object)
+      end
+
+      def edit_object_route(object, type)
+        instance_route(current_model_name.underscore, object, type, "edit")
+      end
+
+      def objects_route(type)
+        collection_route(current_model_name.pluralize.underscore, type)
+      end
+
+      def new_object_route(type)
+        collection_route(current_model_name.underscore, type, "new")
+      end
+
+      def instance_route(name, object, type, action = nil)
+        send("#{action ? action + '_' : ''}#{url_helper_prefix}#{collection_url_prefix unless shallow?}#{name}_#{type}", *(parent? && !shallow? ? [parent_object, object] : [object]))
+      end
+
+      def collection_route(name, type, action = nil)
+        send("#{action ? action + '_' : ''}#{url_helper_prefix}#{collection_url_prefix}#{name}_#{type}",
+             *(parent? ? [parent_object] : []))
+      end
+    end
+  end
+end

data/lib/resourceful/generators/resourceful_scaffold/resourceful_scaffold_generator.rb

@@ -0,0 +1,87 @@
+class ResourcefulScaffoldGenerator < Rails::Generators::Base
+  attr_reader   :controller_class_path,
+                :controller_file_path,
+                :controller_class_nesting,
+                :controller_class_nesting_depth,
+                :controller_class_name,
+                :controller_underscore_name,
+                :controller_plural_name
+  alias_method  :controller_file_name,  :controller_underscore_name
+  alias_method  :controller_table_name, :controller_plural_name
+
+  def initialize(runtime_args, runtime_options = {})
+    super
+
+    base_name, @controller_class_path, @controller_file_path, @controller_class_nesting, @controller_class_nesting_depth = extract_modules(@name.pluralize)
+    @controller_class_name_without_nesting, @controller_underscore_name, @controller_plural_name = inflect_names(base_name)
+
+    if @controller_class_nesting.empty?
+      @controller_class_name = @controller_class_name_without_nesting
+    else
+      @controller_class_name = "#{@controller_class_nesting}::#{@controller_class_name_without_nesting}"
+    end
+  end
+  
+  def manifest
+    record do |m|
+      # Check for class naming collisions.
+      m.class_collisions(controller_class_path, "#{controller_class_name}Controller", "#{controller_class_name}Helper")
+      m.class_collisions(class_path, "#{class_name}")
+
+      # Controller, helper, views, and test directories.
+      m.directory(File.join('app/models', class_path))
+      m.directory(File.join('app/controllers', controller_class_path))
+      m.directory(File.join('app/helpers', controller_class_path))
+      m.directory(File.join('app/views', controller_class_path, controller_file_name))
+      m.directory(File.join('test/functional', controller_class_path))
+      m.directory(File.join('test/unit', class_path))
+      m.directory(File.join('test/fixtures', class_path))
+
+      # Views
+      for action in scaffold_views
+        m.template("view_#{action}.haml", File.join('app/views', controller_class_path, controller_file_name, "#{action}.html.haml"))
+      end
+      m.template('view_partial.haml', File.join('app/views', controller_class_path, controller_file_name, "_#{singular_name}.html.haml"))
+
+      # Helper
+      m.template('helper.rb', File.join('app/helpers', controller_class_path, "#{controller_file_name}_helper.rb"))
+
+      # Model
+      m.template('model.rb', File.join('app/models', class_path, "#{file_name}.rb"))
+
+      unless options[:skip_migration]
+        m.migration_template('migration.rb', 'db/migrate', 
+          :assigns => {
+            :migration_name => "Create#{class_name.pluralize.gsub(/::/, '')}",
+            :attributes     => attributes
+          },
+          :migration_file_name => "create_#{file_path.gsub(/\//, '_').pluralize}")
+      end
+
+      # Controller
+      m.template('controller.rb', File.join('app/controllers', controller_class_path, "#{controller_file_name}_controller.rb"))      
+
+      # Tests
+      m.template('functional_test.rb', File.join('test/functional', controller_class_path, "#{controller_file_name}_controller_test.rb"))
+      m.template('unit_test.rb',       File.join('test/unit', class_path, "#{file_name}_test.rb"))
+      m.template('fixtures.yml',       File.join('test/fixtures', "#{table_name}.yml"))
+
+      # Route
+      m.route_resources controller_file_name
+    end
+  end
+
+  protected
+  
+  def banner
+    "Usage: #{$0} resourcefulscaffold ModelName [field:type, field:type]"
+  end
+
+  def scaffold_views
+    %w[ index show new edit _form ]
+  end
+
+  def model_name 
+    class_name.demodulize
+  end
+end

data/lib/resourceful/generators/resourceful_scaffold/templates/controller.rb

@@ -0,0 +1,5 @@
+class <%= controller_class_name %>Controller < ApplicationController
+  make_resourceful do
+    actions :all
+  end
+end

data/lib/resourceful/generators/resourceful_scaffold/templates/fixtures.yml

@@ -0,0 +1,10 @@
+one:
+  id: 1
+<% for attribute in attributes -%>
+  <%= attribute.name %>: <%= attribute.default %>
+<% end -%>
+two:
+  id: 2
+<% for attribute in attributes -%>
+  <%= attribute.name %>: <%= attribute.default %>
+<% end -%>

data/lib/resourceful/generators/resourceful_scaffold/templates/functional_test.rb

@@ -0,0 +1,50 @@
+require File.dirname(__FILE__) + '<%= '/..' * controller_class_nesting_depth %>/../test_helper'
+require '<%= controller_file_path %>_controller'
+
+# Re-raise errors caught by the controller.
+class <%= controller_class_name %>Controller; def rescue_action(e) raise e end; end
+
+class <%= controller_class_name %>ControllerTest < ActionController::TestCase
+
+  def test_should_get_index
+    get :index
+    assert_response :success
+    assert assigns(:<%= table_name %>)
+  end
+
+  def test_should_get_new
+    get :new
+    assert_response :success
+  end
+
+  def test_should_create_<%= file_name %>
+    old_count = <%= class_name %>.count
+    post :create, :<%= file_name %> => { }
+    assert_equal old_count + 1, <%= class_name %>.count
+
+    assert_redirected_to <%= file_name %>_path(assigns(:<%= file_name %>))
+  end
+
+  def test_should_show_<%= file_name %>
+    get :show, :id => 1
+    assert_response :success
+  end
+
+  def test_should_get_edit
+    get :edit, :id => 1
+    assert_response :success
+  end
+
+  def test_should_update_<%= file_name %>
+    put :update, :id => 1, :<%= file_name %> => { }
+    assert_redirected_to <%= file_name %>_path(assigns(:<%= file_name %>))
+  end
+
+  def test_should_destroy_<%= file_name %>
+    old_count = <%= class_name %>.count
+    delete :destroy, :id => 1
+    assert_equal old_count-1, <%= class_name %>.count
+
+    assert_redirected_to <%= table_name %>_path
+  end
+end

data/lib/resourceful/generators/resourceful_scaffold/templates/helper.rb

@@ -0,0 +1,2 @@
+module <%= controller_class_name %>Helper
+end

data/lib/resourceful/generators/resourceful_scaffold/templates/migration.rb

@@ -0,0 +1,13 @@
+class <%= migration_name %> < ActiveRecord::Migration
+  def self.up
+    create_table :<%= table_name %>, :force => true do |t|
+<% for attribute in attributes -%>
+      t.column :<%= attribute.name %>, :<%= attribute.type %>
+<% end -%>
+    end
+  end
+
+  def self.down
+    drop_table :<%= table_name %>
+  end
+end

data/lib/resourceful/generators/resourceful_scaffold/templates/model.rb

@@ -0,0 +1,2 @@
+class <%= class_name %> < ActiveRecord::Base
+end

data/lib/resourceful/generators/resourceful_scaffold/templates/unit_test.rb

@@ -0,0 +1,7 @@
+require File.dirname(__FILE__) + '<%= '/..' * class_nesting_depth %>/../test_helper'
+
+class <%= class_name %>Test < Test::Unit::TestCase
+  def test_truth
+    assert true
+  end
+end

data/lib/resourceful/generators/resourceful_scaffold/templates/view__form.haml

@@ -0,0 +1,5 @@
+<%- for attribute in attributes -%>
+%p
+  %label{:for => "<%= singular_name %>_<%= attribute.name %>"} <%= attribute.column.human_name %>:
+  = f.<%= attribute.field_type %> :<%= attribute.name %>
+<% end -%>

data/lib/resourceful/generators/resourceful_scaffold/templates/view_edit.haml

@@ -0,0 +1,11 @@
+%h1 Editing <%= singular_name %>
+
+= error_messages_for :<%= singular_name %>
+
+= form_for(:<%= singular_name %>, :url => object_url, :html => { :method => :put }) do |f|
+  = render :partial => "form", :locals => {:f => f}
+  %p= submit_tag "Update"
+
+= link_to 'Show', object_path
+|
+= link_to 'Back', objects_path

data/lib/resourceful/generators/resourceful_scaffold/templates/view_index.haml

@@ -0,0 +1,5 @@
+%h1 Listing <%= plural_name %>
+
+= render :partial => '<%= singular_name %>', :collection => current_objects
+
+= link_to 'New <%= singular_name %>', new_object_path 

data/lib/resourceful/generators/resourceful_scaffold/templates/view_new.haml

@@ -0,0 +1,9 @@
+%h1 Creating <%= singular_name %>
+
+= error_messages_for :<%= singular_name %>
+
+= form_for(:<%= singular_name %>, :url => objects_url) do |f|
+  = render :partial => "form", :locals => {:f => f}
+  %p= submit_tag "Create"
+
+= link_to 'Back', objects_path

data/lib/resourceful/generators/resourceful_scaffold/templates/view_partial.haml

@@ -0,0 +1,12 @@
+%div[<%= singular_name %>]
+<% for attribute in attributes -%>
+  %p.<%= attribute.name %>
+    %strong <%= attribute.column.human_name %>
+    = h <%= singular_name %>.<%= attribute.name %>
+<% end -%>
+
+  = link_to 'Show', object_path(<%= singular_name %>)
+  |
+  = link_to 'Edit', edit_object_path(<%= singular_name %>)
+  |
+  = link_to 'Destroy', object_path(<%= singular_name %>), :confirm => 'Really destroy <%= singular_name %>?', :method => :delete

data/lib/resourceful/generators/resourceful_scaffold/templates/view_show.haml

@@ -0,0 +1,14 @@
+%h1 Viewing <%= singular_name %>
+
+%div[current_object]
+<% for attribute in attributes -%>
+  %p.<%= attribute.name %>
+    %strong <%= attribute.column.human_name %>
+    = h current_object.<%= attribute.name %>
+<% end -%>
+
+= link_to 'Edit', edit_object_path
+|
+= link_to 'Destroy', object_path, :confirm => 'Really destroy <%= singular_name %>?', :method => :delete
+|
+= link_to 'Back', objects_path

data/lib/resourceful/maker.rb

@@ -0,0 +1,92 @@
+require 'resourceful/builder'
+require 'resourceful/base'
+
+module Resourceful
+  # This module is extended by the ActionController::Base class object.
+  # It provides the actual +make_resourceful+ method
+  # and sets up the controller so that everything will work.
+  module Maker
+    # Called automatically on ActionController::Base.
+    # Initializes various inheritable attributes.
+    def self.extended(base)
+      base.class_attribute :resourceful_callbacks
+      base.class_attribute :resourceful_responses
+      base.class_attribute :parents
+      base.class_attribute :shallow_parent
+      base.class_attribute :model_namespace
+      base.class_attribute :made_resourceful
+      
+      base.resourceful_callbacks = {}
+      base.resourceful_responses = {}
+      base.parents               = []
+      base.model_namespace       = nil
+      base.made_resourceful      = false
+    end
+
+    # :call-seq:
+    #   make_resourceful(options = {}) { ... }
+    #
+    # This is the central method, and namesake, of make_resourceful.
+    # It takes a block and evaluates it in the context of a Builder,
+    # allowing the controller to be customized extensively.
+    #
+    # See Resourceful::Builder for documentation on the methods available
+    # in the context of the block.
+    #
+    # The only option currently available is <tt>:include</tt>.
+    # It takes an object that responds to to_proc
+    # (or an array of such objects)
+    # and evaluates that proc in the same context as the block.
+    # For example:
+    #
+    #   make_resourceful :include => proc { actions :all } do
+    #     before :show do
+    #       current_object.current_user = current_user
+    #     end
+    #   end
+    #
+    # This is the same as:
+    #
+    #   make_resourceful do
+    #     actions :all
+    #     before :show do
+    #       current_object.current_user = current_user
+    #     end
+    #   end
+    # 
+    def make_resourceful(options = {}, &block)
+      # :stopdoc:
+      include Resourceful::Base
+      # :startdoc:
+
+      builder = Resourceful::Builder.new(self)
+      unless builder.inherited?
+        Resourceful::Base.made_resourceful.each { |proc| builder.instance_eval(&proc) }
+      end
+      Array(options[:include]).each { |proc| builder.instance_eval(&proc) }
+      builder.instance_eval(&block)
+
+      builder.apply
+
+      add_helpers
+    end
+
+    # Returns whether or not make_resourceful has been called
+    # on this controller or any controllers it inherits from.
+    def made_resourceful?
+      self.class.made_resourceful
+    end
+
+    private
+
+    def add_helpers
+      helper_method(:object_path, :objects_path, :new_object_path, :edit_object_path,
+                    :object_url, :objects_url, :new_object_url, :edit_object_url,
+                    :parent_path, :parent_url,
+                    :nested_object_path, :nested_object_url,
+                    :current_objects, :current_object, :current_model, :current_model_name,
+                    :namespaces, :instance_variable_name, :parent_names, :parent_name,
+                    :parent?, :parent_model, :parent_object, :save_succeeded?)
+    end
+  end
+end

data/lib/resourceful/response.rb

@@ -0,0 +1,33 @@
+module Resourceful
+  # This is the class of the object passed to the Builder#response_for method.
+  # It shouldn't be used by users.
+  #
+  # The Response collects format procs
+  # and returns them with the format method,
+  # in the order they were given.
+  # For example:
+  #
+  #   response.html { redirect_to '/' }
+  #   response.xml { render :xml => current_object.to_xml }
+  #   response.js
+  #   response.formats #=> [[:html, #<Proc>], [:xml, #<Proc>], [:js, #<Proc>]]
+  #
+  # Note that the <tt>:js</tt> response is the empty proc -
+  # the same as <tt>proc {}</tt>.
+  class Response # :nodoc:
+    # Returns a list of pairs of formats and procs
+    # representing the formats passed to the response object.
+    # See class description.
+    attr :formats
+
+    # Returns a new Response with no format data.
+    def initialize
+      @formats = []
+    end
+
+    # Used to dispatch the individual format methods.
+    def method_missing(name, &block)
+      @formats.push([name, block || proc {}]) unless @formats.any? {|n,b| n == name}
+    end
+  end
+end