parrot 0.0.1 → 0.0.2

data/Gemfile

@@ -2,3 +2,6 @@ source "http://rubygems.org"
 
 # Specify your gem's dependencies in parrot.gemspec
 gemspec
+
+# jquery-rails is used by the dummy application
+gem "jquery-rails"

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+== MIT License
+
+Copyright (c) 2012 [Tute Costa - tutecosta@gmail.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.md

@@ -1 +1,27 @@
 # Parrot Gem: Simple commenting solution for Rails 3 apps.
+
+# Installation
+
+1. Add <tt>gem 'parrot'</tt> to your Gemfile
+2. Run <tt>rake parrot:install:migrations</tt>
+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
+
+# 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.
+
+# To-do
+
+* Flash responders working?
+* How to reopen parrot's subclasses from parent applications?

data/Rakefile

@@ -1 +1,30 @@
-require "bundler/gem_tasks"
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Parrot'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task :default => :test

data/app/controllers/parrot/application_controller.rb

@@ -0,0 +1,9 @@
+module Parrot
+  class ApplicationController < ActionController::Base
+    # Reading default_url_options from parent app ApplicationController
+    def default_url_options(options = {})
+      app_controller = ::ApplicationController.new
+      app_controller.default_url_options if app_controller.respond_to? :default_url_options
+    end
+  end
+end

data/app/controllers/parrot/comments_controller.rb

@@ -0,0 +1,57 @@
+module Parrot
+  class CommentsController < ApplicationController
+    respond_to :html
+
+    def index
+      @comments = Comment.where(commentable_type: commentable_type.classify, commentable_id: commentable_id)
+      respond_with @comments
+    end
+
+    def new
+      @comment = Comment.new
+      respond_with @comment
+    end
+
+    def create
+      @comment = Comment.new(params[:parrot_comment])
+      @comment.commentable_type = commentable_type.classify
+      @comment.commentable_id = commentable_id
+      @comment.author_id = current_user.id
+      @comment.save
+      @commentable_type = commentable_type
+      respond_with @comment, :location => commentable
+    end
+
+    def destroy
+      @comment = current_user.comments.find params[:id]
+      @comment.destroy
+      respond_with @comment, :location => commentable
+    end
+
+    # Following methods should belong to ApplicationController
+    def commentable_fk
+      commentable_fk = params.select{|k,v| k =~ /_id/ }.keys.first
+    end
+
+    def commentable_type
+      commentable_fk.gsub('_id', '')
+    end
+
+    def commentable_id
+      id = params[commentable_fk]
+      if id.to_i.to_s == id # Numeric id
+        id.to_i
+      else
+        commentable(id).id # Slugged (text, but we store integers)
+      end
+    end
+
+    def commentable(id = nil)
+      commentable_type.classify.constantize.find(id || commentable_id)
+    end
+
+    def debug(object)
+      logger.warn "DEBUGGING: #{object.inspect}"
+    end
+  end
+end

data/app/models/parrot/comment.rb

@@ -0,0 +1,37 @@
+module Parrot
+  class Comment < ActiveRecord::Base
+    self.table_name = :parrot_comments # FIXME: Not needed if I can isolate the gem
+
+    belongs_to :commentable, :polymorphic => true
+    belongs_to :author, :class_name => Parrot.author_class
+
+    before_save :cache_author_data
+
+    attr_accessible :commentable, :body
+
+    validates_presence_of :commentable, :body, :author_id
+
+    def self.siblings_of(other_comment)
+      where(
+        commentable_type: other_comment.commentable_type,
+        commentable_id: other_comment.commentable_id
+      )
+    end
+
+    def self.following(other_comment)
+      siblings_of(other_comment).where("id > #{other_comment.id}")
+    end
+
+    def author
+      Parrot.author_class.find_by_id author_id
+    end
+
+    # An author may delete it's account, we cache/store it's sensitive data
+    def cache_author_data
+      return if author.nil?
+      [:name, :email, :phone].each do |method|
+        self.send(:"author_#{method}=", author.send(method)) if author.respond_to?(method)
+      end
+    end
+  end
+end

data/app/views/parrot/comments/_comment.html.erb

@@ -0,0 +1,13 @@
+<div id="c_<%= comment.id %>" class="comment">
+  <h5>
+    <%= t('date.formats.on') %>
+    <%= parse_date(comment.created_at, t('date.formats.datetime')) %>
+    <% if current_user.present? && current_user == comment.author %>
+      <%= t('orders.show.you_wrote').html_safe %>:
+      <%= button_to t('buttons.destroy'), [comment.commentable, comment], confirm: t('messages.are_you_sure'), method: :delete, class: 'btn btn-danger' %>
+    <% else %>
+      <strong><%= comment.author %></strong> <%= t('parrot.wrote') %>:
+    <% end %>
+  </h5>
+  <p><%= comment.body %></p>
+</div>

data/app/views/parrot/comments/_form.html.erb

@@ -0,0 +1,22 @@
+<% @comment ||= Parrot::Comment.new %>
+<%= form_for([object, @comment]) do |f| %>
+  <% if @comment.errors.any? %>
+    <div id="error_explanation">
+      <h2><%= pluralize(@comment.errors.count, "error") %> prohibited this comment from being saved:</h2>
+
+      <ul>
+      <% @comment.errors.full_messages.each do |msg| %>
+        <li><%= msg %></li>
+      <% end %>
+      </ul>
+    </div>
+  <% end %>
+
+  <div class="field">
+    <%= f.label :body, t('parrot.new_comment') %><br />
+    <%= f.text_area :body %>
+  </div>
+  <div class="actions">
+    <%= f.submit t('parrot.send_comment'), class: 'btn btn-success' %>
+  </div>
+<% end %>

data/app/views/parrot/comments/index.html.erb

@@ -0,0 +1 @@
+<%= render @comments %>

data/app/views/parrot/comments/new.html.erb

@@ -0,0 +1 @@
+<%= render 'form', object: @commentable_type %>

data/config/initializers/parrot.rb

@@ -0,0 +1 @@
+Parrot.author_class = 'User'

data/config/locales/parrot.en.yml

@@ -0,0 +1,8 @@
+en:
+  activerecord:
+    models:
+      comment: Comment
+  parrot:
+    new_comment: "New comment"
+    send_comment: "Send"
+    wrote: wrote

data/config/locales/parrot.es.yml

@@ -0,0 +1,8 @@
+es:
+  activerecord:
+    models:
+      comment: Comentario
+  parrot:
+    new_comment: "Nuevo comentario"
+    send_comment: "Enviar comentario"
+    wrote: escribió

data/config/routes.rb

@@ -0,0 +1,4 @@
+Parrot::Engine.routes.draw do
+  resources :comments
+  root :to => 'comments#index'
+end

data/db/migrate/20120429124205_create_parrot_comments.rb

@@ -0,0 +1,15 @@
+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
+      t.integer :parent_id
+      t.timestamps
+    end
+  end
+end

data/lib/generators/parrot/parrot_generator.rb

@@ -0,0 +1,19 @@
+module Parrot
+  module Generators
+    class ParrotGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path("../templates", __FILE__)
+
+      def model_exists?
+        File.exists?(File.join(destination_root, model_path))
+      end
+
+      def model_path
+        @model_path ||= File.join("app", "models", "#{file_path}.rb")
+      end
+
+      def inject_parrot_content
+        inject_into_class(model_path, class_name, "  parrot_comments\n\n") if model_exists?
+      end
+    end
+  end
+end

data/lib/parrot.rb

@@ -1,4 +1,20 @@
-require "parrot/version"
+require 'parrot/version'
 
 module Parrot
+  mattr_accessor :author_class
+  def self.author_class
+    @@author_class.constantize
+  end
+
+  class Engine < Rails::Engine
+    engine_name 'parrot'
+    # isolate_namespace Parrot # FIXME: tries application url helpers (undefined method `post_comments_path')
+
+    initializer 'parrot' do |app|
+      ActiveSupport.on_load(:active_record) do
+        require File.join(File.dirname(__FILE__), 'parrot', 'model_additions')
+        ::ActiveRecord::Base.send :include, Parrot::Model
+      end
+    end
+  end
 end

data/lib/parrot/model_additions.rb

@@ -0,0 +1,11 @@
+module Parrot
+  module Model
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def parrot_comments
+        has_many :comments, :class_name => Parrot::Comment, :as => :commentable
+      end
+    end
+  end
+end

data/lib/parrot/version.rb

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

data/parrot.gemspec

@@ -1,4 +1,5 @@
 $:.push File.expand_path("../lib", __FILE__)
+
 require "parrot/version"
 
 Gem::Specification.new do |s|
@@ -7,13 +8,13 @@ Gem::Specification.new do |s|
   s.authors     = ["Tute Costa"]
   s.email       = "tutecosta@gmail.com"
   s.homepage    = "http://github.com/tute/parrot"
-  s.summary     = %q{Simple commenting solution for Rails 3 apps.}
+  s.summary     = %q{Simple commenting Rails Engine. Adds commentable behavior to any model easily.}
   s.description = %q{Add simple comments to any Rails resource.}
 
   s.files         = `git ls-files`.split("\n").reject{|f| f =~ /^\./ }
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.require_paths = ["lib"]
 
-  # s.add_dependency "rest-client"
-  # s.add_development_dependency "rspec"
+  s.add_dependency 'rails'
+  s.add_development_dependency 'sqlite3'
+  s.add_development_dependency 'devise'
 end

data/test/dummy/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/test/dummy/app/assets/javascripts/posts.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/test/dummy/app/assets/javascripts/users.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+*/

data/test/dummy/app/assets/stylesheets/posts.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/test/dummy/app/assets/stylesheets/scaffold.css

@@ -0,0 +1,56 @@
+body { background-color: #fff; color: #333; }
+
+body, p, ol, ul, td {
+  font-family: verdana, arial, helvetica, sans-serif;
+  font-size:   13px;
+  line-height: 18px;
+}
+
+pre {
+  background-color: #eee;
+  padding: 10px;
+  font-size: 11px;
+}
+
+a { color: #000; }
+a:visited { color: #666; }
+a:hover { color: #fff; background-color:#000; }
+
+div.field, div.actions {
+  margin-bottom: 10px;
+}
+
+#notice {
+  color: green;
+}
+
+.field_with_errors {
+  padding: 2px;
+  background-color: red;
+  display: table;
+}
+
+#error_explanation {
+  width: 450px;
+  border: 2px solid red;
+  padding: 7px;
+  padding-bottom: 0;
+  margin-bottom: 20px;
+  background-color: #f0f0f0;
+}
+
+#error_explanation h2 {
+  text-align: left;
+  font-weight: bold;
+  padding: 5px 5px 5px 15px;
+  font-size: 12px;
+  margin: -7px;
+  margin-bottom: 0px;
+  background-color: #c00;
+  color: #fff;
+}
+
+#error_explanation ul li {
+  font-size: 12px;
+  list-style: square;
+}