aeonscope-btech_rest 0.2.2 → 0.3.0

data/CHANGELOG.rdoc

@@ -1,5 +1,17 @@
-v0.1.0 Initial version.
-v0.2.0 Fixed a bug where a resource with no namespace(s) would result in double slashed prefixes (i.e. "//").
-       Added a resource breadcrumb helper.
-       Added unobtrusive jQuery support.
+= v0.1.0
+
+* Initial version.
+
+= v0.2.0
+
+* Fixed a bug where a resource with no namespace(s) would result in double slashed prefixes (i.e. "//").
+* Added a resource breadcrumb helper.
+* Added unobtrusive jQuery support.
+
+= v0.3.0
+
+* Fixed the RDoc so it would generate properly on GitHub.
+* Fixed the btech_rest.rb requirements so that they are platform agnostic.
+* Added partial support for Rails 2.3 nested forms. You can at least build nested forms and this gem will handle them properly.
+
 

data/LICENSE.rdoc

@@ -1,4 +1,4 @@
-Copyright (c) 2008, 2009 "Berserk Technologies":http://www.berserktech.com
+Copyright (c) 2008, 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

data/README.rdoc

@@ -20,23 +20,23 @@ How is that for being {DRY}[http://en.wikipedia.org/wiki/DRY]? Read on to learn
 
 = License
 
-Copyright (c) 2008-2009 {Berserk Technologies}[http://www.berserktech.com].
-See the included {LICENSE}[link:LICENSE.rdoc] file for more info.
+Copyright (c) 2008-2009 Brooke Kuhlmann of {Berserk Technologies}[http://www.berserktech.com].
+See the included LICENSE for more info.
 
 = History
 
-See the {CHANGELOG}[link:CHANGELOG.rdoc] file for more info.
+See the CHANGELOG file for more info.
 
 = Requirements
 
 1. 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.
-2. {mislav-will_paginate}[http://github.com/mislav/will_paginate/tree/master] gem. This is automatically installed/updated for you unless the correct version is detected.
+2. mislav-will_paginate[http://github.com/mislav/will_paginate/tree/master] gem. This is automatically installed/updated for you unless the correct version is detected.
 
 = Installation
 
 Type the following from the command line to install:
 
-* *MacOS/Linux*: sudo gem install btech_rest
+* *UNIX*: sudo gem install btech_rest
 * *Windows*: gem install btech_rest
 
 Type the following from the command line to setup:
@@ -57,17 +57,17 @@ Example:
 
 To customize the RESTful behavior of your controller, use any combination of these three macros:
 
-* {belongs_to}[link:lib/class_method.rb] - 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}[link:lib/class_method.rb] - Allows you to customize the default behavior of your controller(s). There is a lot you can do with this, so follow the link and read the method comments to learn more.
-* {disabled_actions}[link:lib/class_method.rb] - Allows you to disable any of the default REST actions. Follow the link to learn more.
+* *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 BTech::Rest
-     belongs_to :posts
-     resource_options :label => "My Wicked Comments"
-     disabled_actions :show, :destroy
+    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:
@@ -79,31 +79,31 @@ Here is the breakdown, line-by-line, of the example shown above:
 
 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"
+* *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"
+* *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
 

data/Rakefile

@@ -0,0 +1,51 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "btech_rest"
+    gem.summary = "Easily adhere to DRY principals and add default REST functionality to your controllers."
+		gem.required_ruby_version = ">= 1.8.6"
+		gem.add_dependency "mislav-will_paginate", ">= 2.3.7"
+		gem.rdoc_options << "CHANGELOG.rdoc"
+    gem.authors = ["Brooke Kuhlmann"]
+    gem.email = "aeonscope@gmail.com"
+    gem.homepage = "http://github.com/aeonscope/btech-rest"
+    # gem.install_message = "Now you're being resourcefull!"
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = 'btech-rest'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = false
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test

data/VERSION.yml

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

data/lib/actions.rb

@@ -11,7 +11,7 @@ module BTech
 					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 = @resources.last[:model].name.underscore.pluralize
+					records_name = get_model_name.pluralize
 					records = @resources.last[:model].all.paginate(:page => params[:page], :per_page => 10)
 	      end
 				instance_variable_set "@#{records_name}", records
@@ -20,7 +20,7 @@ module BTech
 	    # Default show action.  Feel free to override.
 	    def show
 	      build_resources
-	      render :partial => @resources.last[:show_partial], :layout => true, :locals => {model_to_sym(@resources.last[:model]) => get_record, :resources => @resources}
+	      render :partial => @resources.last[:show_partial], :layout => true, :locals => {get_model_symbol => get_record, :resources => @resources}
 	    end
 
 	    # Default new action.  Feel free to override.
@@ -38,7 +38,7 @@ module BTech
 	    # Default create action.  Feel free to override.
 	    def create
 	      build_resources
-	      if get_record.update_attributes params[model_to_sym(@resources.last[:model])]
+	      if get_record.update_attributes params[get_model_symbol]
 	        redirect_to build_resource_url(@resources)
 	      else
 	        render_new_or_edit
@@ -48,7 +48,7 @@ module BTech
 	    # Default update action.  Feel free to override.
 	    def update
 	      build_resources
-	      if get_record.update_attributes params[model_to_sym(@resources.last[:model])]
+	      if get_record.update_attributes params[get_model_symbol]
 	        redirect_to build_resource_url(@resources)
 	      else
 	        render_new_or_edit
@@ -67,7 +67,7 @@ module BTech
 
 	    # Convenience method for rendering the new or edit partial.
 	    def render_new_or_edit
-	      render :partial => @resources.last[:new_or_edit_partial], :layout => true, :locals => {model_to_sym(@resources.last[:model]) => get_record, :resources => @resources}
+	      render :partial => @resources.last[:new_or_edit_partial], :layout => true, :locals => {get_model_symbol => get_record, :resources => @resources}
 	    end
 
 	    # Builds the RESTful parent URL based on an array of resources.
@@ -102,8 +102,19 @@ module BTech
 
 	    private
 	
+			# Answers the name of the current model.
+			def get_model_name
+				@resources.last[:model].name.underscore
+			end
+			
+			# Answers the symbol of the current model.
+			def get_model_symbol
+				get_model_name.to_sym
+			end
+	
+			# Answers the current record (a.k.a. the record of the last resource).
 			def get_record
-				instance_variable_get "@#{@resources.last[:model].name.underscore}"
+				instance_variable_get "@#{get_model_name}"
 			end
 	
 	    # Builds all resources for the controller(s).
@@ -115,14 +126,9 @@ module BTech
 	        @resources.reverse!
 	      end
 	      # Convenience for holding the current record and for form manipulation.
-				instance_variable_set "@#{@resources.last[:model].name.underscore}", @resources.last[:record]
+				instance_variable_set "@#{get_model_name}", @resources.last[:record]
 	    end
 	
-			# Converts a model name to a symbol.
-			def model_to_sym model
-				model.name.underscore.to_sym
-			end
-	
 			# Convenience method for answering back a properly camelized controller name.
 			def camelize_controller_name name
 				name = name.gsub(/^(\w)/) {|c| c.capitalize}

data/lib/btech_rest.rb

@@ -1,6 +1,6 @@
-require File.dirname(__FILE__) + "/class_methods.rb"
-require File.dirname(__FILE__) + "/actions.rb"
-require File.dirname(__FILE__) + "/resource_helper.rb"
+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 BTech
 	module Rest

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: aeonscope-btech_rest
 version: !ruby/object:Gem::Version 
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors: 
 - Brooke Kuhlmann
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-10 00:00:00 -07:00
+date: 2009-04-11 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -29,12 +29,13 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- README.rdoc
 - LICENSE.rdoc
+- README.rdoc
 files: 
 - CHANGELOG.rdoc
 - LICENSE.rdoc
 - README.rdoc
+- Rakefile
 - VERSION.yml
 - lib/actions.rb
 - lib/btech_rest.rb
@@ -46,9 +47,8 @@ has_rdoc: true
 homepage: http://github.com/aeonscope/btech-rest
 post_install_message: 
 rdoc_options: 
-- CHANGELOG.rdoc
-- --inline-source
 - --charset=UTF-8
+- CHANGELOG.rdoc
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -70,5 +70,6 @@ rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
 summary: Easily adhere to DRY principals and add default REST functionality to your controllers.
-test_files: []
-
+test_files: 
+- test/btech_rest_test.rb
+- test/test_helper.rb