parrot 0.0.2 → 0.0.3

data/README.md

@@ -7,21 +7,33 @@
 3. Run <tt>rake db:migrate</tt>
 4. Run <tt>rails g parrot MODEL_NAME</tt>
 5. Add subresources to routes
-
-     resources RESOURCE_NAME do
-       resources :parrot_comments, controller: 'parrot/comments', path: 'comments'
-     end
-
-6. Add commenting relation to your commenters:
-
-    has_many :comments, :class_name => Parrot::Comment, :foreign_key => :author_id
+   <pre>
+   resources RESOURCE_NAME do
+     resources :parrot_comments, controller: 'parrot/comments', path: 'comments'
+   end
+   </pre>
 
 # Notes
 
-* By default it calls to_s on commenter name. You may want to alias it to name
-  for example, so it doesn't show the Ruby "ugly" object.
+Given <tt>@comment = Parrot::Comment.find(id)</tt>:
+
+* <tt>rails g parrot MODEL_NAME</tt> (4th step of the installation) adds a
+  <tt>parrot_comments</tt> class method in the model. It sets a polymorphic
+  relation with <tt>Parrot::Comment</tt>, whose name is <tt>commentable</tt>.
+  You can call <tt>@post.comments</tt> to get related comments, or
+  <tt>@comment.commentable</tt> to get the related entry of a given comment.
+* The default "author" model is <tt>User</tt>. You may change it from
+  <tt>config/initializers/parrot.rb</tt>. You can call
+  <tt>@comment.author</tt> to get comment's author.
+* Parrot views calls <tt>to_s</tt> method on the comment's <tt>author</tt>.
+  You may want to alias it, or the "ugly" Ruby object will be shown:
+  <tt>alias_method :to_s, :name</tt>
+* You may define <tt>after_comment_path</tt> method on commentable model for
+  defining where the user should be redirected after commenting (related
+  resource by default).
 
 # To-do
 
 * Flash responders working?
-* How to reopen parrot's subclasses from parent applications?
+* Wiki: how to reopen parrot's subclasses from parent applications?
+  (<tt>to_prepare</tt>).

data/app/controllers/parrot/comments_controller.rb

@@ -19,18 +19,18 @@ module Parrot
       @comment.author_id = current_user.id
       @comment.save
       @commentable_type = commentable_type
-      respond_with @comment, :location => commentable
+      respond_with @comment, :location => after_comment_path(commentable, @comment)
     end
 
     def destroy
       @comment = current_user.comments.find params[:id]
       @comment.destroy
-      respond_with @comment, :location => commentable
+      respond_with @comment, :location => after_comment_path(commentable, @comment)
     end
 
     # Following methods should belong to ApplicationController
     def commentable_fk
-      commentable_fk = params.select{|k,v| k =~ /_id/ }.keys.first
+      commentable_fk = params.select{|k,v| k =~ /_id/ }.keys.last
     end
 
     def commentable_type
@@ -39,10 +39,10 @@ module Parrot
 
     def commentable_id
       id = params[commentable_fk]
-      if id.to_i.to_s == id # Numeric id
+      if id.to_i.to_s == id # Numeric id?
         id.to_i
       else
-        commentable(id).id # Slugged (text, but we store integers)
+        commentable(id).id # Slugged (coming as text, but we need numeric id)
       end
     end
 
@@ -50,6 +50,10 @@ module Parrot
       commentable_type.classify.constantize.find(id || commentable_id)
     end
 
+    def after_comment_path(commentable, comment)
+      commentable.respond_to?(:after_comment_path) ? commentable.after_comment_path(comment) : commentable
+    end
+
     def debug(object)
       logger.warn "DEBUGGING: #{object.inspect}"
     end

data/lib/parrot/version.rb

@@ -1,3 +1,3 @@
 module Parrot
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/test/dummy/db/migrate/20120429002431_create_parrot_comments.rb

@@ -2,6 +2,9 @@ class CreateParrotComments < ActiveRecord::Migration
   def change
     create_table :parrot_comments do |t|
       t.integer :author_id
+      t.string  :author_name
+      t.string  :author_email
+      t.string  :author_phone
       t.string  :commentable_type
       t.integer :commentable_id
       t.text    :body

data/test/dummy/db/schema.rb

@@ -15,6 +15,9 @@ ActiveRecord::Schema.define(:version => 20120429124205) do
 
   create_table "parrot_comments", :force => true do |t|
     t.integer  "author_id"
+    t.string   "author_name"
+    t.string   "author_email"
+    t.string   "author_phone"
     t.string   "commentable_type"
     t.integer  "commentable_id"
     t.text     "body"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: parrot
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-08 00:00:00.000000000 Z
+date: 2012-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70103229606760 !ruby/object:Gem::Requirement
+  requirement: &70272666574300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70103229606760
+  version_requirements: *70272666574300
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70103229606340 !ruby/object:Gem::Requirement
+  requirement: &70272666573820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70103229606340
+  version_requirements: *70272666573820
 - !ruby/object:Gem::Dependency
   name: devise
-  requirement: &70103229605920 !ruby/object:Gem::Requirement
+  requirement: &70272666573380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70103229605920
+  version_requirements: *70272666573380
 description: Add simple comments to any Rails resource.
 email: tutecosta@gmail.com
 executables: []