aeonscope-rest 1.0.0

data/CHANGELOG.rdoc

@@ -0,0 +1,3 @@
+= v1.0.0
+
+* Initial version.

data/LICENSE.rdoc

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Brooke Kuhlmann of {Berserk Technologies}[http://www.berserktech.com]
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,172 @@
+= Overview
+
+Enables default REST functionality, more than what you get with Rails out-of-the-box, and keeps your code DRY. This means you can write code like this:
+
+  class Posts < ApplicationController
+    include Rest 
+  end
+
+Which would automatically yield the following REST actions:
+
+* index
+* show
+* new
+* edit
+* create
+* update
+* destroy
+
+How is that for being {DRY}[http://en.wikipedia.org/wiki/DRY]? Read on to learn more.
+
+= License
+
+Copyright (c) 2008-2009 Brooke Kuhlmann of {Berserk Technologies}[http://www.berserktech.com].
+See the included LICENSE for more info.
+
+= History
+
+See the CHANGELOG file for more info.
+
+= Requirements
+
+1. {Ruby on Rails}[http://rubyonrails.org] (automatically installed for you if you don't have 2.3.x or higher).
+2. mislav-will_paginate[http://github.com/mislav/will_paginate/tree/master] gem (automatically installed for you).
+3. Knowledge of the {Representational State Transfer (REST)}[http://en.wikipedia.com/wiki/REST]. Download and read {RESTful Rails}[http://www.b-simple.de/documents] if you need further info.
+
+= Installation
+
+Type the following from the command line to install:
+
+* *UNIX*: sudo gem install aeonscope-rest
+* *Windows*: gem install aeonscope-rest
+
+Update your environment.rb file to include the new gem:
+
+* config.gem "rest"
+
+To apply unobtrusive jQuery support, run the following generator (TIP: suffix the command line with -h option for usage):
+
+* script/generate ujs_setup
+
+= Usage
+
+As mentioned in the overview, simply add the following line of code to your controller(s) to make them RESTful:
+
+  include Rest
+	
+Example:
+
+  class Posts < ApplicationController
+    include Rest 
+  end
+
+This will automatically create the seven REST actions (index, show, new, create, edit, update, and destroy) for your controller. The model (i.e. Post) and model instance (i.e. @posts or @post depending on the action) are automatically determined from the controller name and created for you as well which means you can immediately write the following code in your views:
+
+<b>index.html.erb</b>
+
+  <h2>Posts</h2>
+  <div>
+    <table>
+	  <thead>
+		  <tr>
+		    <th>Label</th>
+		    <th>Created At</th>
+		    <th>Updated At</th>
+		    <th>Actions</th>
+		  </tr>
+	  </thead>
+	  <tbody>
+		  <%= render @posts %>
+	  </tbody>
+    </table>
+  </div>
+
+<b>show.html.erb</b>
+
+  <h2>Label</h2>
+  <p><%= @post.label %></p>
+
+  <h2>Content</h2>
+  <p><%= @post.content %></p>
+
+  <p><%= link_to "Back", :back %></p>
+
+<b>new.html.erb</b>
+
+  <% form_for @post do |form| %>
+    <%= form.error_messages :header_data => :strong, :header_message => "Error" %>
+
+    <div>
+      <%= form.label :label %><br/>
+      <%= form.text_field :label %>
+    </div>
+
+    <div>
+      <%= form.label :content %><br/>
+      <%= form.text_area :content %>
+    </div>
+
+    <div><%= show_submit_and_cancel :cancel_options => posts_path %></div>
+ <% end %>
+
+<b>edit.html.erb</b>
+
+Use the same code as shown in the new.html.erb view above. ;-) The Rails form_for helper will automatically determine what action to take as shown in the following code:
+
+  <% form_for @post do |form| %>
+
+To customize the RESTful behavior of your controller, use any combination of these three macros:
+
+* *belongs_to* - Enables resource nesting where a controller can belong to a parent controller. This behavior is similar to the ActiveRecord {belongs_to}[http://apidock.com/rails/ActiveRecord/Associations/ClassMethods/belongs_to] macro.
+* *resource_options* - Allows you to customize the default behavior of your controller(s). There is a lot you can do with this, read the code documentation for more info.
+* *disabled_actions* - Allows you to disable any of the default REST actions. Follow the link to learn more.
+
+Example:
+
+  class Comments < ApplicationController
+    include Rest
+    belongs_to :posts
+    resource_options :label => "My Wicked Comments"
+    disabled_actions :show, :destroy
+  end
+
+Here is the breakdown, line-by-line, of the example shown above:
+
+1. Enables restful behavior.
+2. Identifies the controller as a nested resource of posts.
+3. Instead of using the default label "Comments", a customized label of "My Wicked Comments" is used instead.
+4. The "show" and "destroy" actions are disabled which means only the following actions will work:  index, new, edit, create, and update.
+
+Using the post and comment controller relationship as defined above, we can break this relationship down even further. The post (parent) resource would have the following values (in this case, all default values):
+
+* *parent_key* = N/A
+* *parent_value* = N/A
+* *parent_resource_method* = N/A
+* *name* = "posts"
+* *label* = "Posts"
+* *controller* = PostsController
+* *model* = Post
+* *record* =  #<Post id: 1, label: "Test", content: "Test", created_at: "2008-10-31 23:59:28", updated_at: "2008-10-31 23:59:28">
+* *namespaces* = []
+* *show_partial* = "/posts/show"
+* *new_or_edit_partial* = "/posts/new_or_edit"
+
+The comment (child) resource would have the following values:
+	
+* *parent_key* = post_id
+* *parent_value* = 1
+* *parent_resource_method* = N/A
+* *name* = "comments"
+* *label* = "My Wicked Comments"
+* *controller* = CommentsController
+* *model* = Comment
+* *record* =  #<Post id: 1, post_id: nil, label: "Test", content: "Test", created_at: "2008-10-31 23:59:28", updated_at: "2008-10-31 23:59:28">
+* *namespaces* = []
+* *show_partial* = "/comments/show"
+* *new_or_edit_partial* = "/comments/new_or_edit"
+		
+= Contact/Feedback/Issues
+
+* {Berserk Technologies}[http://www.berserktech.com] - Company web site.
+* Aeonscope[http://www.aeonscope.net] - Personal web site.
+* Twitter[http://www.twitter.com/Aeonscope] - Short bursts of insight and/or noise.

data/Rakefile

@@ -0,0 +1,52 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "rest"
+    gem.summary = "Enables default REST functionality, more than what you get with Rails out-of-the-box, and keeps your code DRY."
+    gem.description = "Ruby on Rails supports RESTful routing out-of-the-box. However, as you move along, you will often find yourself repeating the code for the seven REST actions: index, show, new, create, edit, update, destroy. This gem allows you to get all of the code for free by simply typing 'include Rest' at top of your controller code. That's it! Even better, you can have nested resources as well by adding a 'belongs_to' statement to your controllers much like you would for ActiveRecord models. This is just the tip of the iceburg so make sure to read the RDoc for more info."
+    gem.authors = ["Brooke Kuhlmann"]
+    gem.email = "aeonscope@gmail.com"
+    gem.homepage = "http://github.com/aeonscope/rest"
+		gem.required_ruby_version = ">= 1.8.6"
+		gem.add_dependency "rails", ">= 2.3.2"
+		gem.add_dependency "mislav-will_paginate", ">= 2.3.7"
+		gem.rdoc_options << "CHANGELOG.rdoc"
+		gem.files = FileList["[A-Z]*", "{bin,lib,generators,rails_generators,test,spec}/**/*"]
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rest #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:major: 1
+:minor: 0
+:patch: 0

data/lib/actions.rb

@@ -0,0 +1,230 @@
+module Rest
+  module Actions
+    # Default index action.  Feel free to override.
+    def index
+      build_resources
+      if @resources.size > 1
+        # Records for a nested resource (act on the second-to-last parent).
+        parent = @resources[@resources.size - 2][:record]
+				records_name = parent.class.name.underscore.pluralize
+				records = parent.instance_eval("#{@resources.last[:parent_resource_method] || @resources.last[:name]}").paginate :page => params[:page], :per_page => 10
+      else
+        # Records for single resource.
+				records_name = get_model_name
+				if records_name
+					records_name = records_name.pluralize
+					records = @resources.last[:model].all.paginate(:page => params[:page], :per_page => 10)
+				end
+      end
+			instance_variable_set "@#{records_name}", records if records_name
+    end
+
+    # Default show action.  Feel free to override.
+    def show
+      build_resources
+			render_action_partial @resources.last[:show_partial]
+    end
+
+    # Default new action.  Feel free to override.
+    def new
+      build_resources
+      render_new_or_edit_partial
+    end
+
+    # Default edit action.  Feel free to override.
+    def edit
+      build_resources
+      render_new_or_edit_partial
+    end
+
+    # Default create action.  Feel free to override.
+    def create
+      build_resources
+      if get_record.update_attributes params[get_model_symbol]
+        redirect_to build_resource_url(@resources)
+      else
+        render_new_or_edit_partial
+      end
+    end
+
+    # Default update action.  Feel free to override.
+    def update
+      build_resources
+      if get_record.update_attributes params[get_model_symbol]
+        redirect_to build_resource_url(@resources)
+      else
+        render_new_or_edit_partial
+      end  
+    end
+
+    # Default destroy action.  Feel free to override.
+    def destroy
+      build_resources
+      get_record.destroy
+      @resources.last.delete :record
+      redirect_to build_resource_url(@resources)
+    end
+
+    protected
+
+    # Convenience method for rendering the action partials.
+		def render_action_partial partial
+			symbol = get_model_symbol
+			record = get_record
+			if symbol && record
+				render :partial => partial, :layout => true, :locals => {symbol => record, :resources => @resources}
+			else
+				render :partial => partial, :layout => true, :locals => {:resources => @resources}
+			end
+		end
+
+    # Convenience method for rendering the new or edit partial.
+    def render_new_or_edit_partial
+			render_action_partial @resources.last[:new_or_edit_partial]
+    end
+
+    # Builds the RESTful parent URL based on an array of resources.
+    def build_parent_url resources = []
+			namespaces = resources.last[:namespaces]
+       url = namespaces && !namespaces.empty? ? '/' + resources.last[:namespaces].join('/') : nil
+      if resources.size > 1
+        resources.slice(0...resources.size - 1).each do |resource|
+          url = [url, resource[:name], resource[:parent_id]].join('/')
+        end
+      end
+      url
+    end    
+
+    # A convenience method for builing RESTful URLs based on an array of resources with the
+    # option to override the default action.  This is also defined as a helper method (see base.rb).
+    def build_resource_url resources = [], action = :index
+      name = resources.last[:name]
+      id = resources.last[:record].id if resources.last[:record]
+       parent_url = build_parent_url(resources)
+      url = parent_url ? [parent_url, name].join('/') : '/' + name
+      case action
+        when :show then url = [url, id].compact.join('/')
+        when :new then url = [url, "new"].compact.join('/')
+        when :edit then url = [url, id, "edit"].compact.join('/')
+        when :update then url = [url, id].compact.join('/') if name == name.pluralize
+        when :destroy then url = [url, id].compact.join('/') if name == name.pluralize
+      end
+      logger.debug "Resource URL: #{url}"
+      url
+    end    
+
+    private
+
+		# Answers the name of the current model.
+		def get_model_name
+			model = @resources.last[:model]
+			model ? model.name.underscore : nil
+		end
+		
+		# Answers the symbol of the current model.
+		def get_model_symbol
+			name = get_model_name
+			name ? name.to_sym : nil
+		end
+
+		# Answers the current record (a.k.a. the record of the last resource).
+		def get_record
+			name = get_model_name
+			name ? instance_variable_get("@#{name}") : nil
+		end
+
+    # Builds all resources for the controller(s).
+    def build_resources
+      @resources ||= []
+      if @resources.empty?
+        controller_name = self.class.name
+        add_resource controller_name, @resources
+        @resources.reverse!
+      end
+      # Convenience for accessing the current record.
+			name = get_model_name
+			instance_variable_set "@#{name}", @resources.last[:record] if name
+    end
+
+		# Convenience method for answering back a properly camelized controller name.
+		def camelize_controller_name name
+			name = name.gsub(/^(\w)/) {|c| c.capitalize}
+			name += "Controller" unless name.include? "Controller"
+			name
+		end
+
+    # Answers the child or parent controller namespaces (array) and name (string).
+		# Accepts the following argruments:
+		# * *full_name* - The fully namespaced controller (i.e. PostsController) or parent name (i.e. protected_pages).
+		# Usage:
+		# * Input: Public::PostsController, Output: [Public], "PostsController"
+		# * Input: member_manage_posts, Output: [Member, Manage], "PostsController"
+		# * Input: posts, Output: nil, "PostsController"
+		def get_controller_namespaces_and_name full_name
+			if full_name
+				delimiter = full_name.include?("Controller") ? "::" : '_'
+				if full_name.include? delimiter
+			    namespaces = full_name.split delimiter
+					name = camelize_controller_name namespaces.pop
+					return namespaces.collect(&:capitalize), name
+				else
+					return nil, camelize_controller_name(full_name)
+				end
+			end
+		end			
+
+    # Recursively walks the controller belongs_to hierarchy (if any) adding new resources along the way.
+    def add_resource controller_name, resources
+      logger.debug "Adding resource '#{controller_name}' to resources (size = #{resources.size})."
+      resource = configure_resource controller_name
+      if resource
+        resources << resource
+        # Recursively add parents (if any).
+        if resource[:controller].methods.include? "parent_resource"
+          add_resource resource[:controller].parent_resource, resources
+        end
+      end
+    end
+
+    # Configures a resource via belongs_to name refrence in controller.  By default the controller and model
+    # are assumed to use the same root name regardless of singular or plural context. 
+    def configure_resource controller_name
+			namespaces, name = get_controller_namespaces_and_name controller_name
+      controller = [namespaces, name].compact.join("::").constantize
+       name = name.chomp("Controller").underscore
+      parent_key = name.singularize + "_id"
+      resource = controller.resource_options || {}
+      resource.reverse_merge! :parent_key => parent_key,
+      :parent_id => params[parent_key],
+      :name => name,
+      :controller => controller,
+      :label => name.capitalize,
+      :namespaces => (namespaces.collect(&:downcase) if namespaces),
+      :show_partial => '/' + [namespaces, name, "show"].compact.join('/').downcase,
+      :new_or_edit_partial => '/' + [namespaces, name, "new_or_edit"].compact.join('/').downcase
+      begin
+        resource.reverse_merge! :model => name.singularize.camelize.constantize
+      rescue NameError
+        logger.warn "Unable to constantize: " + name
+      end
+      add_record resource
+    end
+
+    # Adds the current record to the resource based on position in chain.
+    def add_record resource
+      if resource[:model]
+        if params.include? resource[:parent_key]
+          # Nested parent.
+          resource[:record] = resource[:model].find resource[:parent_id] if resource[:parent_id]
+        else
+          # Single resource and/or end of nested chain.
+          resource[:record] = params[:id] ? resource[:model].find(params[:id]) : resource[:model].new
+        end
+      else
+        logger.error "Invalid model.  Check that your controller and model are of the same name, otherwise specify the model as a resource option."
+      end
+      resource
+    end
+  end
+end
+

data/lib/class_methods.rb

@@ -0,0 +1,35 @@
+module Rest
+  module ClassMethods
+    # Allows an object to belong to a parent object, thus creating a nested hierarchy. This behaves in a similar
+    # fashion to the belongs_to ActiveRecord macro.  Accepts the following parameters:
+    # * *parent* - The parent symbol (including namespaces delimited by underscores). Be sure to reflect singular or plural forms on the name. Example: Public::PostsController, Result: :public_posts
+    def belongs_to parent
+      @parent_resource = parent.to_s
+      class_eval "class << self; attr_accessor :parent_resource end"
+    end
+
+    # Allows one to specify the various options for a resource.  The following options are accepted:
+  	# * *parent_key* - The ID key of the parent resource (for nested resources only).  Defaults to:  <belongs_to name>_id
+  	# * *parent_value* - The ID value of the parent resource (for nested resources only).  Defaults to the record id.
+  	# * *parent_resource_method* - The instance method to call for acquiring child resource(s) of the parent (for nested resources only). Example: A post with many comments would be post.comments. Defaults to child resource name.
+  	# * *name* - The resource name. Defaults to the controller name.
+  	# * *label* - The resource label. Defaults to the controller name with capitalization.
+  	# * *controller* - The controller class. Defaults to the current class. You should not need to change this.
+  	# * *model* - The model class. Defaults to a model of the same name as the controller (minus namespace, suffix, and pluralization of course).
+  	# * *record* - The record (new or found) related to the resource.
+  	# * *namespaces* - The namespaces (if any) for routing. Defaults to whatever namespace your controller is using.
+  	# * *show_partial* - The show partial. Defaults to "/<namspace(s)>/<controller name>/_show".
+  	# * *new_or_edit_partial* - The new or edit partial. Defaults to "/<namspace(s)>/<controller name>/_new_or_edit".
+    def resource_options options = {}
+      @resource_options = options
+      class_eval "class << self; attr_reader :resource_options end"
+    end
+
+    # Allows one to disable any number of default actions.  Accepts the following parameters:
+    # * *actions* - A variable list of REST action symbols you wish to disable. You may use any of the following: index, show, new, create, edit, update, and/or destroy.
+    def disabled_actions *actions
+      actions.uniq.each {|action| undef_method action}
+    end
+  end
+end	
+

data/lib/resource_helper.rb

@@ -0,0 +1,63 @@
+module ResourceHelper
+	# Builds a DOM ID for a given record. Works the same as the dom_id helper found in Rails except that it returns a record ID with
+	# a "_0" suffix for new records instead of a "new_" prefix. This makes attaching JavaScript events easier since all DOM IDs are numbers.
+	def build_dom_id record
+		name = record.class.name.underscore
+		record.new_record? ? name + "_0" : name + '_' + record.id.to_s
+	end
+	
+  # Show a descriptive label based on the current controller action. Useful for new/edit actions. Accepts the following parameters:
+  # * *label* - The action label.
+  def show_action_label label
+    [params[:action].capitalize, label].compact.join ' '
+  end
+  
+  # Shows an unobtrusive jQuery link where the UJS event is attached to the link via the "destroy" class.
+  # If JavaScript is disabled then the _show_ action will be called instead of the _destroy_ action. Accepts
+  # the following hash arguments:
+  # * *parent_id* - The ID of the parent element for which the link is a child of. Example: post_1. *NOTE:* The parent ID takes precidence over the link ID if defined.
+  # * *id* - The link ID. Example: post_1_link. *NOTE:* The link ID _must_ include the parent ID.
+  # * *label* - The link label. Defaults to "Delete".
+  # * *url* - The destroy URL. Example: /posts/1. *NOTE:* The proper HTTP POST request will be handled by JavaScript.
+  def show_destroy_link options = {}
+		options.reverse_merge! :id => options[:parent_id].to_s + "_destroy"
+    options.reverse_merge! :label => "Delete", :class => "destroy", :url => '#' + options[:id].to_s
+    link_to options[:label], options[:url], :id => options[:id], :class => options[:class]
+  end
+
+  # Shows a nested, unobtrusive jQuery link where the UJS event is attached to the link via the "destroy-nested" class.
+  # If JavaScript is disabled then the _show_ action will be called instead of the _destroy_ action. Accepts
+  # the following hash arguments:
+  # * *object* - The model object to destroy.
+  # * *parent_id* - The ID of the parent element for which the link is a child of. Example: post_1. *NOTE:* The parent ID takes precidence over the link ID if defined.
+  # * *id* - The link ID. Example: post_1_link. *NOTE:* The link ID _must_ include the parent ID.
+  # * *label* - The link label. Defaults to "Delete".
+  # * *url* - The destroy URL. Example: /posts/1. *NOTE:* The proper HTTP POST request will be handled by JavaScript.
+	def show_destroy_nested_link options = {}
+		unless options[:object].new_record?
+			options.reverse_merge! :id => options[:parent_id].to_s + "_destroy-nested", :class => "destroy-nested"
+			show_destroy_link options
+		end
+	end
+
+  # Shows an unobtrusive jQuery link based on an array of resource hashes. See the show_destroy_link above
+  # for further details. Accepts the following arguments:
+  # * *resources* - The array of resource hashes.
+	def show_destroy_resource_link resources, parent_dom_id
+		show_destroy_link :parent_id => parent_dom_id, :url => build_resource_url(resources, :destroy)
+	end
+	
+  # Shows an unobtrusive jQuery link based on an array of resource hashes. See the show_destroy_link above
+  # for further details. Accepts the following arguments:
+  # * *resources* - The array of resource hashes.
+	def show_destroy_nested_resource_link resources, parent_dom_id
+		show_destroy_link(:id => parent_dom_id.to_s + "_destroy-nested", :class => "destroy-nested") unless resources.last[:record].new_record?
+	end
+
+  # Shows edit and delete links for resources. Accepts the following parameters:
+  # * *resources* - The array of resource hashes.
+  # * *parent_dom_id* - The parent ID of the dom object for which the edit and destroy links belong to for UJS manipulation.
+  def show_edit_and_destroy_resource_links resources, parent_dom_id
+		[link_to("Edit", build_resource_url(resources, :edit)), show_destroy_resource_link(resources, parent_dom_id)].join(" | ")
+  end
+end

data/lib/rest.rb

@@ -0,0 +1,12 @@
+require File.join(File.dirname(__FILE__), "class_methods.rb")
+require File.join(File.dirname(__FILE__), "actions.rb")
+require File.join(File.dirname(__FILE__), "resource_helper.rb")
+
+module Rest
+  def self.included base
+    base.extend ClassMethods
+    base.helper "resource"
+    base.helper_method :build_resource_url
+  end
+  include Actions
+end

data/rails_generators/ujs_setup/USAGE

@@ -0,0 +1,11 @@
+Berserk Technologies UJS Setup Generator
+
+Description:
+    Applies unobtrusive jQuery support to your Ruby on Rails application.
+
+Requirements
+	1. jQuery 1.3 or higher.
+	2. jQuery UI 1.7 or higher.
+	
+Usage:
+    script/generate ujs_setup

data/rails_generators/ujs_setup/templates/README

@@ -0,0 +1,14 @@
+
+Tasks You Need to Complete:
+    1.  Update your layouts/application.html.erb as follows:
+
+        <%= javascript_include_tag "jquery" %>
+        <%= javascript_include_tag "jquery-ui" %>
+        <%= javascript_include_tag "ujs" %>
+        <%= javascript_include_tag "rest" %>
+
+    2.  Add the following to the very bottom of your config/routes.rb file:
+
+        # Defaults
+        map.connect ":controller/:action/.:format"
+

data/rails_generators/ujs_setup/templates/app/controllers/javascripts_controller.rb

@@ -0,0 +1,6 @@
+# Enables dynamic javascript, namely Unobtrusive JavaScript (UJS) support for jQuery.
+class JavascriptsController < ApplicationController
+	# Serves global jQuery UJS settings. See the /views/layouts/application.html.erb for usage.
+  def ujs
+  end
+end

data/rails_generators/ujs_setup/templates/app/views/javascripts/ujs.js.erb

@@ -0,0 +1,18 @@
+// Ensures AJAX requests are properly formated so that Rails knows how to respond to them.
+$.ajaxSetup({
+  beforeSend: function(xhr) {xhr.setRequestHeader("Accept", "text/javascript")}
+});
+
+/* Ensures AJAX requests have the proper Rails authenticity token.  See the following
+   for more info:
+
+   http://henrik.nyh.se/2008/05/rails-authenticity-token-with-jquery
+   http://dev.jquery.com/ticket/3387
+*/
+$(document).ajaxSend(function(event, request, settings){
+  var authToken = "<%= form_authenticity_token %>";
+  if (authToken != null){
+    settings.data = settings.data || "";
+    settings.data += (settings.data ? "&" : "") + "authenticity_token=" + encodeURIComponent(authToken);
+  };
+});

data/rails_generators/ujs_setup/templates/public/javascripts/rest.js

@@ -0,0 +1,119 @@
+// Chops off the last string segment designated by delimiter. If no delimiter is found then the original string is
+// returned instead. The following attributes are accepted:
+// string = Required. The string to chop.
+// delimiter = Optional. The delimiter used to chop up the string. Defaults to '_'.
+function stringChop(string, delimiter) {
+	var chopped = string;
+	if (delimiter == undefined) {delimiter = '_';}
+	var endIndex = string.lastIndexOf(delimiter);
+	if (endIndex > 1) {chopped = string.slice(0, endIndex);}
+	return chopped;
+};
+
+// Increments a number embedded in the text by one. If no number is found then the original text is returned.
+function incrementText(text) {
+  if (text != undefined) {
+	  var match = text.match(/\d+/);
+	  if (match != null) {
+		var number = new Number(match);
+		var newNumber = number + 1;
+		text = text.replace(number, newNumber);
+	  }
+  }
+  return text;
+};
+
+// Increments the input field ID number by one so ActiveRecord can save new record attributes.
+function incrementInputId(input) {
+  id = $(input).attr("id");
+  id = incrementText(id);
+  $(input).attr("id", id);
+};
+
+// Increments the input field name number by one so ActiveRecord can save new record attributes.
+function incrementInputName(input) {
+  name = $(input).attr("name");
+  name = incrementText(name);
+  $(input).attr("name", name);
+};
+
+// Generates a hidden input field based off original input field data that instructs ActiveRecord to delete
+// a record based on the ID of the input field.
+function generateDestroyInput(input) {
+	$(input).attr("id", stringChop($(input).attr("id")) + "__delete");
+	$(input).attr("name", stringChop($(input).attr("name"), '[') + "[_delete]");
+	$(input).attr("type", "hidden");
+	$(input).attr("value", 1);
+	return input;
+};
+
+// Animates the removal of a DOM element.
+function animateDestroy(id) {
+	$(id).animate({backgroundColor: "#FF0000", border: "0.2em solid #FF0000"}, 500);
+	$(id).fadeOut(500);
+};
+
+// UJS
+$(document).ready(function(){
+	// Nested New
+	$("a.new-nested").click(function(){
+		var parentId = '#' + stringChop($(this).attr("id"));
+		var child = $(parentId).children(":last").clone(true);
+		var childId = child.attr("id");
+		child.attr("id", incrementText(childId));
+		$(parentId).append(child);
+		// Ensure the cloned input fields are unique.
+		$('#' + child.attr("id") + " :input").each(function(){
+		  	incrementInputId(this);
+		  	incrementInputName(this);
+			$(this).attr("value", '');
+			return this;
+		});
+		// Ensure the cloned destroy link is unique.
+		destroyLink = $("a.destroy-nested:last");
+		destroyLink.attr("id", incrementText(destroyLink.attr("id")));
+		// Ensure that the default event does not fire.
+		return false;
+	});
+	
+	// Nested Destroy
+    $("a.destroy-nested").click(function(){
+		try {
+			var id = $(this).attr("id");
+			var parentId = stringChop(id);
+			if (parentId != id) {
+				parentId = '#' + parentId;
+				$(parentId).prepend(generateDestroyInput($(parentId + " input:first").clone()));
+				animateDestroy(parentId);
+			} else {
+				throw "Invalid ID";
+			}
+		} catch (e) {
+			alert("Error: " + e + ". Check that parent ID is defined and/or the link ID includes parent ID as part of the link ID.");
+		}
+		// Ensure that the default event does not fire.
+		return false;
+    });
+
+	// Destroy
+    $("a.destroy").click(function(){
+        var result = confirm("Are you sure you want to delete this?");
+        if (result) {
+			try {
+				var id = $(this).attr("id");
+				var parentId = stringChop(id);
+				if (parentId != id) {
+					animateDestroy('#' + parentId);
+				} else {
+					throw "Invalid ID";
+				}
+				// Finally, call the destroy action.
+	            $.post($(this).attr("href"), "_method=delete");
+			} catch (e) {
+				alert("Error: " + e + ". Check that parent ID is defined and/or the link ID includes parent ID as part of the link ID.");
+			}
+        }
+		// Ensure that the default event does not fire.
+		return false;
+    });
+});

data/rails_generators/ujs_setup/ujs_setup_generator.rb

@@ -0,0 +1,18 @@
+class UjsSetupGenerator < Rails::Generator::Base
+  def manifest
+    record do |m|
+      # Controllers
+      m.file "app/controllers/javascripts_controller.rb", "app/controllers/javascripts_controller.rb" 
+
+      # Views
+      m.directory "app/views/javascripts"
+      m.file "app/views/javascripts/ujs.js.erb", "app/views/javascripts/ujs.js.erb" 
+
+      # JavaScript
+      m.file "public/javascripts/rest.js", "public/javascripts/rest.js"
+
+      # Instructions
+      m.readme "README"
+    end
+  end
+end

data/spec/rest_spec.rb

@@ -0,0 +1,6 @@
+require 'spec_helper'
+
+describe "Rest" do
+  it "should be testable" do
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'spec'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rest'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification 
+name: aeonscope-rest
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Brooke Kuhlmann
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-03 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mislav-will_paginate
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.7
+    version: 
+description: "Ruby on Rails supports RESTful routing out-of-the-box. However, as you move along, you will often find yourself repeating the code for the seven REST actions: index, show, new, create, edit, update, destroy. This gem allows you to get all of the code for free by simply typing 'include Rest' at top of your controller code. That's it! Even better, you can have nested resources as well by adding a 'belongs_to' statement to your controllers much like you would for ActiveRecord models. This is just the tip of the iceburg so make sure to read the RDoc for more info."
+email: aeonscope@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.rdoc
+- README.rdoc
+files: 
+- CHANGELOG.rdoc
+- LICENSE.rdoc
+- README.rdoc
+- Rakefile
+- VERSION.yml
+- lib/actions.rb
+- lib/class_methods.rb
+- lib/resource_helper.rb
+- lib/rest.rb
+- rails_generators/ujs_setup/USAGE
+- rails_generators/ujs_setup/templates/README
+- rails_generators/ujs_setup/templates/app/controllers/javascripts_controller.rb
+- rails_generators/ujs_setup/templates/app/views/javascripts/ujs.js.erb
+- rails_generators/ujs_setup/templates/public/javascripts/rest.js
+- rails_generators/ujs_setup/ujs_setup_generator.rb
+- spec/rest_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/aeonscope/rest
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+- CHANGELOG.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.8.6
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: Enables default REST functionality, more than what you get with Rails out-of-the-box, and keeps your code DRY.
+test_files: 
+- spec/rest_spec.rb
+- spec/spec_helper.rb