aeonscope-btech_rest 0.4.4 → 0.5.0

data/CHANGELOG.rdoc

@@ -21,12 +21,19 @@
 * Shortened the gem summary and added a more detailed description.
 * Updated the README file with minor setup and usage clarifications.
 
-= v0.4.x
+= v0.5.0
 
 * Synchronized the summary and descriptions for the gem, README, and GitHub data.
 * Added UJS support for nested new/edit actions.
 * Added UJS support for nested delete actions.
 * Changed the show_destroy_link helper so that the default link ID is suffixed with "_destroy" instead of "_link".
-* Added a build_dom_id helper.  Works the same as the dom_id found in Rails except that new records return a '_0' suffix instead of a "new_" prefix.
+* Added a build_dom_id helper.  Works the same as the dom_id found in Rails except that new records return a '_0' suffix instead of a "new_" prefix easier JavaScript manipulation.
 * Updated the show_destroy_link helper so that when a url option is not supplied an anchor link is used instead (derived from the record ID).
 * Updated all edit and destroy resource helpers so that they accept the parent DOM ID for which to apply UJS manipulation too.
+* Renamed the rest_setup generator to ujs_setup since this is more specific.
+* Changed all JavaScript code to JavaScript coding standards instead of Ruby standards (sorry, always thinking about Ruby instead ;-)
+* Fixed a bug where an error would be thrown when attempting to increment null text.
+* Renamed the build_action_label helper to show_action_label and removed the singularization the label passed in.
+* Deleted the build_resource_form_submit helper since Rails 2.3 makes it so much easier to parse nested resource forms.
+* Improved the README documentation including examples for how you might write your view code.
+

data/README.rdoc

@@ -44,9 +44,9 @@ Update your environment.rb file to include the new gem:
 
 * config.gem "btech_rest"
 
-Type the following from the command line to setup:
+To apply unobtrusive jQuery support, run the following generator (TIP: suffix the command line with -h option for usage):
 
-* script/generate rest_setup
+* script/generate ujs_setup
 
 = Usage
 
@@ -60,6 +60,61 @@ Example:
     include BTech::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:
+
+*index.html.erb*
+
+  <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>
+
+*show.html.erb*
+
+  <h2>Label</h2>
+  <p><%= @post.label %></p>
+
+  <h2>Content</h2>
+  <p><%= @post.content %></p>
+
+  <p><%= link_to "Back", :back %></p>
+
+*new.html.erb*
+
+  <% 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 %>
+
+*edit.html.erb*
+
+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.

data/VERSION.yml

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

data/lib/actions.rb

@@ -140,9 +140,9 @@ module BTech
 			# 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"
+			# * 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") ? "::" : '_'

data/lib/class_methods.rb

@@ -29,8 +29,7 @@ module BTech
 	    # 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!
-	      actions.each {|action| undef_method(action)}
+	      actions.uniq!.each {|action| undef_method action}
 	    end
 	  end
 	end	

data/lib/resource_helper.rb

@@ -24,33 +24,16 @@ module ResourceHelper
   end	
 
 	# 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.
+	# 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
 	
-  # Builds the submit path for a new or edit form based on current controller action. This assumes
-  # that the new/create and edit/update forms are always submitted to the same URL.  Accepts the following parameters:
-  # * *resources* - The array of resource hashes.
-  # * *html_options* - The html options for a form (same as form_for[http://apidock.com/rails/ActionView/Helpers/FormHelper/form_for] html options).
-  def build_resource_form_submit resources = [], html_options = {}
-    case params[:action]
-    # New/create flow.
-    when "new" then return :url => build_resource_url(resources, :create), :html => html_options
-    # Validate/create flow.
-    when "create" then return :url => build_resource_url(resources, :create), :html => html_options
-    # Edit/update flow.
-    when "edit" then return :url => build_resource_url(resources, :update), :html => html_options.merge({:method => :put})
-    # Validate/update flow.
-    when "update" then return :url => build_resource_url(resources, :update), :html => html_options.merge({:method => :put})
-    end
-  end
-  
-  # Builds a more descriptive label based on the current controller action.  Accepts the following parameters:
+  # Show a descriptive label based on the current controller action. Useful for new/edit actions. Accepts the following parameters:
   # * *label* - The action label.
-  def build_action_label label
-    [params[:action].capitalize, label.singularize].compact.join ' '
+  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.
@@ -76,8 +59,8 @@ module ResourceHelper
   # 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_nested_destroy_resource_link resources, parent_dom_id
-		show_destroy_link(:id => parent_dom_id.to_s + "_nested-destroy", :class => "nested-destroy") unless resources.last[:record].new_record?
+	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:

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/{rest_setup → ujs_setup}/templates/README

@@ -1,7 +1,4 @@
 
-Overview
-	REST setup is complete.
-
 Tasks You Need to Complete:
     1.  Update your layouts/application.html.erb as follows:
 

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/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/{rest_setup/rest_setup_generator.rb → ujs_setup/ujs_setup_generator.rb}

@@ -1,4 +1,4 @@
-class RestSetupGenerator < Rails::Generator::Base
+class UjsSetupGenerator < Rails::Generator::Base
   def manifest
     record do |m|
       # Controllers
@@ -8,7 +8,7 @@ class RestSetupGenerator < Rails::Generator::Base
       m.directory "app/views/javascripts"
       m.file "app/views/javascripts/ujs.js.erb", "app/views/javascripts/ujs.js.erb" 
 
-      # JavaScripts
+      # JavaScript
       m.file "public/javascripts/rest.js", "public/javascripts/rest.js"
 
       # Instructions

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: aeonscope-btech_rest
 version: !ruby/object:Gem::Version 
-  version: 0.4.4
+  version: 0.5.0
 platform: ruby
 authors: 
 - Brooke Kuhlmann
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-15 00:00:00 -07:00
+date: 2009-04-18 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -51,12 +51,12 @@ files:
 - lib/btech_rest.rb
 - lib/class_methods.rb
 - lib/resource_helper.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/public/javascripts/rest.js
+- 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
 - test/btech_rest_test.rb
 - test/test_helper.rb
 has_rdoc: true
@@ -84,7 +84,7 @@ requirements: []
 rubyforge_project: 
 rubygems_version: 1.2.0
 signing_key: 
-specification_version: 2
+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: 
 - test/btech_rest_test.rb

data/rails_generators/rest_setup/USAGE

@@ -1,11 +0,0 @@
-Berserk Technologies REST Setup Generator
-
-Description:
-    Configures unobtrusive jQuery support.
-
-Requirements
-	1. jQuery 1.3 or higher.
-	2. jQuery UI 1.7 or higher.
-	
-Usage:
-    script/generate rest_setup

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

@@ -1,7 +0,0 @@
-# Enables the ability to serve up dynamic javascript, namely Unobtrusive JavaScript
-# 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/rest_setup/templates/public/javascripts/rest.js

@@ -1,133 +0,0 @@
-// Chops off the last string segment per delimiter. If no delimiter is found in the string 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 chop_last(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 increment_text(text) {
-  var match = text.match(/\d+/);
-  if (match != null) {
-	var number = new Number(match);
-	var new_number = number + 1;
-	text = text.replace(number, new_number);
-  }
-  return text;
-};
-
-// Suffixes text with a number. Accepts the following arguments:
-// text = Required. The text to suffix.
-// number = Optional. The number to be suffixed to the text. Defaults to 1.
-// delimiter = Optional. The delimiter between the text and number. Defaults to '_'.
-function suffix_num_to_text(text, number, delimiter) {
-	if (text != null) {
-		if (number == undefined) { number = 1; };
-		if (delimiter == undefined) { delimiter = '_'; };
-		return text + delimiter + number;
-	};
-};
-
-// Increments the input field ID number by one so ActiveRecord can save new record attributes.
-function increment_input_id(input) {
-  id = $(input).attr("id");
-  id = increment_text(id);
-  $(input).attr("id", id);
-};
-
-// Increments the input field name number by one so ActiveRecord can save new record attributes.
-function increment_input_name(input) {
-  name = $(input).attr("name");
-  name = increment_text(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 generate_destroy_input(input) {
-	$(input).attr("id", chop_last($(input).attr("id")) + "__delete");
-	$(input).attr("name", chop_last($(input).attr("name"), '[') + "[_delete]");
-	$(input).attr("type", "hidden");
-	$(input).attr("value", 1);
-	return input;
-}
-
-// UJS
-$(document).ready(function(){
-	// Nested New
-	$("a.nested-new").click(function(){
-		var id = $(this).attr("id");
-		var parent_id = '#' + chop_last(id);
-		var clone = $(parent_id + " tr:last").clone(true);
-		var clone_id = clone.attr("id");
-		// Clone for new action.
-		if (clone_id.length > 4 && clone_id.substr(0, 4) == "new_") {
-			clone_id = clone_id.slice(4);
-			clone_id = suffix_num_to_text(clone_id);
-			clone.attr("id", clone_id);
-		}
-		// Clone for edit action.
-		else {
-			clone.attr("id", increment_text(clone_id));
-		}
-		$(parent_id).append(clone);
-		// Ensure all cloned input fields are unique.
-		$.each($('#' + clone.attr("id") + " :input"), function(){
-		  	increment_input_id(this);
-		  	increment_input_name(this);
-			$(this).attr("value", '');
-			return this;
-		});
-		// Ensure default event does not fire.
-		return false;
-	});
-	
-	// Nested Destroy
-    $("a.nested-destroy").click(function(){
-		try {
-			var id = $(this).attr("id");
-			var parent_id = chop_last(id);
-			if (parent_id != id) {
-				parent_id = '#' + parent_id;
-				$(parent_id).prepend(generate_destroy_input($(parent_id + " input:first").clone()));
-				$(parent_id).animate({backgroundColor: "#FF0000"}, 500);
-				$(parent_id).fadeOut(500);
-			} 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 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 parent_id = chop_last(id);
-				if (parent_id != id) {
-					parent_id = '#' + parent_id;
-					$(parent_id).animate({backgroundColor: "#FF0000"}, 500);
-					$(parent_id).fadeOut(500);
-				} 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 default event does not fire.
-		return false;
-    });
-});