aeonscope-rest 1.0.0 → 1.1.0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: aeonscope-rest
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Brooke Kuhlmann
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-03 00:00:00 -07:00
+date: 2009-08-26 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -30,7 +30,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 2.3.7
+        version: 2.3.10
     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
@@ -47,19 +47,24 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION.yml
-- lib/actions.rb
 - lib/class_methods.rb
+- lib/instance_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
+- rails_generators/rest_setup/USAGE
+- rails_generators/rest_setup/rest_setup_generator.rb
+- rails_generators/rest_setup/templates/README
+- rails_generators/rest_setup/templates/app/controllers/javascripts_controller.rb
+- rails_generators/rest_setup/templates/app/views/javascripts/ujs.js.erb
+- rails_generators/rest_setup/templates/config/initializers/pagination.rb
+- rails_generators/rest_setup/templates/public/javascripts/jquery.rest.js
+- rails_generators/rest_setup/templates/public/themes/default/images/icons/rest/destroy.png
+- rails_generators/rest_setup/templates/public/themes/default/images/icons/rest/edit.png
+- rails_generators/rest_setup/templates/public/themes/default/images/icons/rest/new.png
+- rails_generators/rest_setup/templates/public/themes/default/images/icons/rest/show.png
 - spec/rest_spec.rb
 - spec/spec_helper.rb
-has_rdoc: true
+has_rdoc: false
 homepage: http://github.com/aeonscope/rest
 post_install_message: 
 rdoc_options: 
@@ -85,7 +90,7 @@ 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.
+summary: Enables default REST functionality, UJS support (jQuery), and keeps your code DRY.
 test_files: 
 - spec/rest_spec.rb
 - spec/spec_helper.rb

data/lib/actions.rb

@@ -1,230 +0,0 @@
-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/rails_generators/ujs_setup/templates/public/javascripts/rest.js

@@ -1,119 +0,0 @@
-// 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

@@ -1,18 +0,0 @@
-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