giraffesoft-resource_controller 0.4.12 → 0.5.1

data/README.rdoc

@@ -4,11 +4,25 @@ resource_controller makes RESTful controllers easier, more maintainable, and sup
 
 == Get It
 
-  svn export http://svn.jamesgolick.com/resource_controller/tags/stable vendor/plugins/resource_controller
-  
-SVN (stable): {http://svn.jamesgolick.com/resource_controller/tags/stable}[http://svn.jamesgolick.com/resource_controller/tags/stable]
+Add it as a gem dependency
 
-SVN (ongoing): {http://svn.jamesgolick.com/resource_controller/trunk}[http://svn.jamesgolick.com/resource_controller/trunk]
+  config.gem 'resource_controller'
+  
+...or for the development version
+  
+  config.gem 'giraffesoft-resource_controller', :lib => 'resource_controller', :source => 'http://gems.github.com'
+  
+Or install it as a gem manually  
+  
+  sudo gem install resource_controller
+  
+...or for the development version
+  
+  sudo gem install giraffesoft-resource_controller
+  
+Or grab the source
+  
+  git clone git://github.com/giraffesoft/resource_controller.git
 
 = Usage
 
@@ -96,6 +110,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)
 
@@ -226,42 +276,6 @@ Finally, the route_name helper is used by Urligence to determine which url helpe
       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
-
 == Url Helpers
 
 Thanks to Urligence, you also get some free url helpers.
@@ -309,4 +323,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

@@ -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/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: giraffesoft-resource_controller
 version: !ruby/object:Gem::Version 
-  version: 0.4.12
+  version: 0.5.1
 platform: ruby
 authors: 
 - James Golick
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-08-10 21:00:00 -07:00
+date: 2008-09-02 21:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -23,7 +23,6 @@ extra_rdoc_files: []
 
 files: 
 - README.rdoc
-- README
 - LICENSE
 - init.rb
 - Rakefile

data/README

@@ -1 +0,0 @@
-README.rdoc

data/generators/scaffold_resource/USAGE

@@ -1,29 +0,0 @@
-Description:
-    The scaffold resource generator creates a model, a controller, and a set of templates that's ready to use as the
-    starting point for your REST-like, resource-oriented application. This basically means that it follows a set of
-    conventions to exploit the full set of HTTP verbs (GET/POST/PUT/DELETE) and is prepared for multi-client access
-    (like one view for HTML, one for an XML API, one for ATOM, etc). Everything comes with sample unit and functional
-    tests as well.
-    
-    The generator takes the name of the model as its first argument. This model name is then pluralized to get the 
-    controller name. So "scaffold_resource post" will generate a Post model and a PostsController and will be intended
-    for URLs like /posts and /posts/45.
-    
-    As additional parameters, the generator will take attribute pairs described by name and type. These attributes will
-    be used to prepopulate the migration to create the table for the model and to give you a set of templates for the
-    view. For example, "scaffold_resource post title:string created_on:date body:text published:boolean" will give
-    you a model with those four attributes, forms to create and edit those models from, and an index that'll list them 
-    all.
-    
-    You don't have to think up all attributes up front, but it's a good idea of adding just the baseline of what's 
-    needed to start really working with the resource.
-    
-    Once the generator has run, you'll need to add a declaration to your config/routes.rb file to hook up the rules
-    that'll point URLs to this new resource. If you create a resource like "scaffold_resource post", you'll need to
-    add "map.resources :posts" (notice the plural form) in the routes file. Then your new resource is accessible from
-    /posts.
-
-Examples:
-    ./script/generate scaffold_resource post # no attributes, view will be anemic
-    ./script/generate scaffold_resource post title:string created_on:date body:text published:boolean
-    ./script/generate scaffold_resource purchase order_id:integer created_at:datetime amount:decimal

data/generators/scaffold_resource/scaffold_resource_generator.rb

@@ -1,179 +0,0 @@
-class ScaffoldResourceGenerator < Rails::Generator::NamedBase
-  attr_reader   :controller_name,
-                :controller_class_path,
-                :controller_file_path,
-                :controller_class_nesting,
-                :controller_class_nesting_depth,
-                :controller_class_name,
-                :controller_singular_name,
-                :controller_plural_name,
-                :resource_edit_path,
-                :default_file_extension,
-                :generator_default_file_extension
-  alias_method  :controller_file_name,  :controller_singular_name
-  alias_method  :controller_table_name, :controller_plural_name
-
-  def initialize(runtime_args, runtime_options = {})
-    super
-
-    if @rspec = has_rspec?
-      if ActionController::Base.respond_to?(:resource_action_separator)
-        @resource_edit_path = "/edit"
-      else
-        @resource_edit_path = ";edit"
-      end
-    end
-
-    @generator_default_file_extension = (defined? Haml )? "haml" : "erb"
-    
-    # we want to call erb templates .rhtml or .haml if this is rails 1
-    if RAILS_GEM_VERSION.to_i == 1
-      @default_file_extension = @generator_default_file_extension == 'erb' ? 'rhtml' : @generator_default_file_extension
-    else
-      @default_file_extension = "html.#{@generator_default_file_extension}"
-    end
-    
-    @controller_name = @name.pluralize
-
-    base_name, @controller_class_path, @controller_file_path, @controller_class_nesting, @controller_class_nesting_depth = extract_modules(@controller_name)
-    @controller_class_name_without_nesting, @controller_singular_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))
-
-      if @rspec
-        m.directory(File.join('spec/controllers', controller_class_path))
-        m.directory(File.join('spec/helpers', class_path))
-        m.directory(File.join('spec/models', class_path))
-        m.directory File.join('spec/views', controller_class_path, controller_file_name)
-        m.directory(File.join('spec/fixtures', class_path))
-      else
-        m.directory(File.join('test/functional', controller_class_path))
-        m.directory(File.join('test/unit', class_path))
-      end
-      
-      scaffold_views.each do |action|
-        m.template(
-          "view_#{action}.#{generator_default_file_extension}",
-          File.join('app/views', controller_class_path, controller_file_name, "#{action}.#{default_file_extension}")
-        )
-      end
-
-      m.template('model.rb', File.join('app/models', class_path, "#{file_name}.rb"))
-      m.template('controller.rb', File.join('app/controllers', controller_class_path, "#{controller_file_name}_controller.rb"))
-      m.template('helper.rb',          File.join('app/helpers',     controller_class_path, "#{controller_file_name}_helper.rb"))
-
-      if @rspec
-        m.template('rspec/functional_spec.rb',  File.join('spec/controllers', controller_class_path, "#{controller_file_name}_controller_spec.rb"))
-        m.template('rspec/routing_spec.rb',     File.join('spec/controllers', controller_class_path, "#{controller_file_name}_routing_spec.rb"))
-        m.template('rspec/helper_spec.rb',      File.join('spec/helpers',     class_path, "#{controller_file_name}_helper_spec.rb"))
-        m.template('rspec/unit_spec.rb',        File.join('spec/models',      class_path, "#{file_name}_spec.rb"))
-        m.template('fixtures.yml',        File.join('spec/fixtures',    "#{table_name}.yml"))
-
-        rspec_views.each do |action|
-          m.template(
-            "rspec/views/#{action}_spec.rb",
-            File.join('spec/views', controller_class_path, controller_file_name, "#{action}_spec.rb")
-          )
-        end
-
-      else
-        functional_test = (defined? ThoughtBot::Shoulda) ? "shoulda_functional_test.rb" : "functional_test.rb"
-
-        m.template("#{functional_test}", 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"))
-      end
-
-
-      unless options[:skip_migration]
-        migration_template = RAILS_GEM_VERSION.to_i == 1 ? 'old_migration.rb' : 'migration.rb'
-        
-        m.migration_template(
-          migration_template, 'db/migrate', 
-          :assigns => {
-            :migration_name => "Create#{class_name.pluralize.gsub(/::/, '')}",
-            :attributes     => attributes
-          }, 
-          :migration_file_name => "create_#{file_path.gsub(/\//, '_').pluralize}"
-        )
-      end
-
-      m.route_resources controller_file_name
-    end
-  end
-
-  # Lifted from Rick Olson's restful_authentication
-  def has_rspec?
-    options[:rspec] || (File.exist?('spec') && File.directory?('spec'))
-  end
-  
-  protected
-    # Override with your own usage banner.
-    def banner
-      "Usage: #{$0} scaffold_resource ModelName [field:type, field:type]"
-    end
-
-    def rspec_views
-      %w[ index show new edit ]
-    end
-    
-    def scaffold_views
-      rspec_views + %w[ _form ]
-    end
-
-    def model_name 
-      class_name.demodulize
-    end
-
-    def add_options!(opt)
-      opt.separator ''
-      opt.separator 'Options:'
-      opt.on("--rspec", "Force rspec mode (checks for RAILS_ROOT/spec by default)") { |v| options[:rspec] = true }
-    end
-end
-
-module Rails
-  module Generator
-    class GeneratedAttribute
-      def default_value
-        @default_value ||= case type
-          when :int, :integer               then "\"1\""
-          when :float                       then "\"1.5\""
-          when :decimal                     then "\"9.99\""
-          when :datetime, :timestamp, :time then "Time.now"
-          when :date                        then "Date.today"
-          when :string                      then "\"MyString\""
-          when :text                        then "\"MyText\""
-          when :boolean                     then "false"
-          else
-            ""
-        end      
-      end
-
-      def input_type
-        @input_type ||= case type
-          when :text                        then "textarea"
-          else
-            "input"
-        end      
-      end
-    end
-  end
-end

data/generators/scaffold_resource/templates/controller.rb

@@ -1,2 +0,0 @@
-class <%= controller_class_name %>Controller < ResourceController::Base
-end

data/generators/scaffold_resource/templates/fixtures.yml

@@ -1,10 +0,0 @@
-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/generators/scaffold_resource/templates/functional_test.rb

@@ -1,57 +0,0 @@
-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 < Test::Unit::TestCase
-  fixtures :<%= table_name %>
-
-  def setup
-    @controller = <%= controller_class_name %>Controller.new
-    @request    = ActionController::TestRequest.new
-    @response   = ActionController::TestResponse.new
-  end
-
-  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