opinio 0.4.1 → 0.5

data/README.rdoc

@@ -30,15 +30,16 @@ The most common way to quickly get Opinio working is:
   rails g opinio:install comment
 
 This will generate the *Comment* model, migration and also generate the opinio initializer for customization of the engine.
-A `opinio_model` will be added on the `routes.rb`. This method adds the default urls for the model that will acts as the comment
+A +opinio_model+ will be added on the +routes.rb+. This method adds the default urls for the model that will act as the comment
+in your app.
 
-In order to add the comments functionallity to a model, you use the *opinio_subjectum* method
+In order to add the comments functionality to a model, you use the *opinio_subjectum* method
 
   class Post < ActiveRecord::Base
     opinio_subjectum
   end
 
-On the `routes.rb` you should simply add an `opinio` for your resource that will have comments
+On the +routes.rb+ you should simply add an +opinio+ for your resource that will have comments
 
   resources :posts do
     opinio
@@ -56,12 +57,12 @@ Alternatively you can render just the comments or just the form like this:
   <%= render_comments_form @post %>
 
 If you need to render the comments with a specific page or limit
-you can use Kaminari's configurations like `paginates_per 10` on your comment model
+you can use Kaminari's configurations like +paginates_per 10+ on your comment model
 or you can customize it for specific views on the helpers
 
   <%= render_comments @post, :page => params[:page], :limit => 5 %>
 
-This can also be used on the `comments_for` helper.
+This can also be used on the +comments_for+ helper.
 
 == Customization
 
@@ -142,8 +143,7 @@ For issues please use the github {issues tracker}[https://github.com/Draiken/opi
 
 === TODO
 
-  * Haml views
   * Better controller overriding (coding and documentation)
   * Support for deeper levels of replies
-  * Refactor the `comments_for` helper
+  * Refactor the +comments_for+ helper
   * Extract documentation to wiki

data/app/controllers/opinio/comments_controller.rb

@@ -10,14 +10,19 @@ class Opinio::CommentsController < ApplicationController
     @comment = resource.comments.build(params[:comment])
     @comment.owner = send(Opinio.current_user_method)
     if @comment.save
-      messages = {:notice => I18n.translate('opinio.comment.sent', :default => "Comment sent successfully.")}
+      flash_area = :notice
+      message = t('opinio.messages.comment_sent')
     else
-      messages = {:error => I18n.translate('opinio.comment.error', :default => "Error sending the comment.")}
+      flash_area = :error
+      message = t('opinio.messages.comment_sending_error')
     end
 
     respond_to do |format|
       format.js
-      format.html { redirect_to( resource, :flash => messages ) }
+      format.html do
+        set_flash(flash_area, message)
+        redirect_to(resource.is_a?(Opinio.model_name.constantize) ? resource.commentable : resource)
+      end
     end
   end
 
@@ -26,7 +31,7 @@ class Opinio::CommentsController < ApplicationController
 
     if can_destroy_opinio?(@comment)
       @comment.destroy
-      flash[:notice] = I18n.translate('opinio.comment.destroyed', :default => "Comment removed successfully")
+      set_flash(:notice, t('opinio.messages.comment_destroyed'))
     else
       #flash[:error]  = I18n.translate('opinio.comment.not_permitted', :default => "Not permitted")
       logger.warn "user #{send(Opinio.current_user_method)} tried to remove a comment from another user #{@comment.owner.id}"
@@ -38,6 +43,5 @@ class Opinio::CommentsController < ApplicationController
       format.html { redirect_to( @comment.commentable ) }
     end
   end
-
   
 end

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

@@ -2,12 +2,12 @@
 <li id="comment_<%= comment.id %>">
   <span>User: <%= comment.owner.id %></span>
   <p>
-    <%= comment.body %>
+    <%= simple_format(comment.body) %>
   </p>
-  <%= link_to 'Destroy', comment_path(comment), :method => :delete, :remote => true %>
+  <%= link_to t('opinio.actions.delete'), comment_path(comment), :method => :delete, :remote => true %>
   <%# this enables only 1 level of replies %>
   <% if Opinio.accept_replies && !reply %>
-    <span><%= link_to t("opinio.reply", :default => "Reply"), reply_comment_path(comment), :remote => true %></span>
+    <span><%= link_to t('opinio.actions.reply'), reply_comment_path(comment), :remote => true %></span>
     <ul id="comment_<%= comment.id %>_replies" class="replies">
       <%= render :partial => "opinio/comments/comment", :collection => comment.comments, :locals => {:reply => true} %>
     </ul>

data/app/views/opinio/comments/_comment.html.haml

@@ -0,0 +1,10 @@
+- reply = defined?(reply) ? reply : false
+%li{:id => "comment_#{comment.id}"}
+  %span User: #{comment.owner.id}
+  %p= simple_format(comment.body)
+  = link_to t('opinio.actions.delete'), comment_path(comment), :method => :delete, :remote => true
+  -# this enables only 1 level of replies
+  -if Opinio.accept_replies && !reply
+    %span= link_to t('opinio.actions.reply'), reply_comment_path(comment), :remote => true
+    %ul.replies{:id => "comment_#{comment.id}_replies"}
+      = render :partial => "opinio/comments/comment", :collection => comment.comments, :locals => {:reply => true}

data/app/views/opinio/comments/_comments.html.erb

@@ -6,7 +6,7 @@
   <% unless comments.empty? %>
     <%= render :partial => 'opinio/comments/comment', :collection => comments %>
   <% else %>
-    <li id="no_comments"><%= t 'opinio.no_comments_found', :default => "No comments found" %></li>
+    <li id="no_comments"><%= t('opinio.messages.no_comments_found') %></li>
   <% end %>
 </ul>
 

data/app/views/opinio/comments/_comments.html.haml

@@ -0,0 +1,9 @@
+%div= paginate comments
+
+%ul#comments
+  - unless comments.empty?
+    = render :partial => 'opinio/comments/comment', :collection => comments
+  - else
+    %li#no_comments= t('opinio.messages.no_comments_found')
+
+%div= paginate comments

data/app/views/opinio/comments/_new.html.erb

@@ -1,18 +1,17 @@
 <div id="new_comment">
   <% if send(Opinio.current_user_method) %>
-    <h3>Send Comments</h3>
-    <%= form_for Comment.new, :remote => true do |f| %>
+    <h3><%= t('opinio.messages.add_comment') %></h3>
+    <%= form_for Comment.new, :remote => false do |f| %>
       <p>
-        <%= f.label :body, "Comment" %>
-        <%= f.text_area :body, :id => "Comment" %>
+        <%= f.text_area :body %>
       </p>
       <%= hidden_field_tag :commentable_id, commentable.id %>
       <%= hidden_field_tag :commentable_type, commentable.class.base_class.name.to_s %>
-      <%= f.submit "Send Comment" %>
+      <%= f.submit t('opinio.actions.add') %>
     <% end %>
   <% else %>
     <p>
-      Must be logged in to comment.
+      <%= t('opinio.messages.must_be_logged_in_to_comment') %>
     </p>
   <% end %>
 </div>

data/app/views/opinio/comments/_new.html.haml

@@ -0,0 +1,10 @@
+#new_comment
+  - if send(Opinio.current_user_method)
+    %h3= t('opinio.messages.add_comment')
+    = form_for Comment.new, :remote => false do |f|
+      %p= f.text_area :body
+      = hidden_field_tag :commentable_id, commentable.id
+      = hidden_field_tag :commentable_type, commentable.class.base_class.name.to_s
+      = f.submit t('opinio.actions.add')
+  - else
+    %p= t('opinio.messages.must_be_logged_in_to_comment')

data/app/views/opinio/comments/create.js.erb

@@ -1,14 +1,15 @@
-$('#no_comments').fadeOut()
+$('#no_comments').hide();
 <% if @comment.valid? %>
   <% if @reply %>
     if($('#comment_<%= @comment.commentable_id %> ul').length == 0)
-      $('#comment_<%= @comment.commentable_id %>').append('<ul id="comment_<%= @comment.commentable_id %>_replies" class="replies"></ul>')
-    $('#comment_<%= @comment.commentable_id %>_replies').append("<%= escape_javascript( render @comment, :locals => {:reply => @reply} ) %>")
-    $('#commentable_id').val('<%= @comment.commentable.commentable_id %>')
-    $('#commentable_type').val('<%= @comment.commentable.commentable_type %>')
+      $('#comment_<%= @comment.commentable_id %>').append('<ul id="comment_<%= @comment.commentable_id %>_replies" class="replies"></ul>');
+    $('#comment_<%= @comment.commentable_id %>_replies').append("<%= escape_javascript( render @comment, :locals => {:reply => @reply} ) %>");
+    $('#commentable_id').val('<%= @comment.commentable.commentable_id %>');
+    $('#commentable_type').val('<%= @comment.commentable.commentable_type %>');
   <% else %>
-    $('#comments').prepend("<%= escape_javascript( render @comment, :locals => {:reply => @reply} ) %>")
+    $('#comments').<%= Opinio.sort_order == 'ASC' ? 'append' : 'prepend'%>("<%= escape_javascript( render @comment, :locals => {:reply => @reply} ) %>");
   <% end %>
+  $('textarea#comment_body').val('');
 <% else %>
   $('#comments').prepend("<%= escape_javascript(flash[:notice]) %>");
   $('#comments').prepend("<%= escape_javascript(flash[:error]) %>");

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

@@ -1,4 +1,4 @@
-<h1>Comments</h1>
+<h1><%= t('opinio.messages.comments') %></h1>
 
 <%= paginate @comments %>
 

data/app/views/opinio/comments/index.html.haml

@@ -0,0 +1,7 @@
+%h1= t('opinio.messages.comments')
+
+= paginate @comments
+
+= render :partial => "opinio/comments/comments", :locals => { :comments => @comments }
+
+= paginate @comments

data/app/views/opinio/comments/reply.js.erb

@@ -1,4 +1,4 @@
-$("#commentable_id").val('<%= @commentable_id %>')
-$("#commentable_type").val('<%= @commentable_type %>')
-$("#new_comment textarea").val('')
-$("#new_comment textarea").focus()
+$("#commentable_id").val('<%= @commentable_id %>');
+$("#commentable_type").val('<%= @commentable_type %>');
+$("#new_comment textarea").val('');
+$("#new_comment textarea").focus();

data/config/locales/opinio.en.yml

@@ -0,0 +1,16 @@
+en:
+  opinio:
+    actions:
+      delete: 'Delete'
+      reply: 'Reply'
+      add: 'Add comment'
+    messages:
+      no_comments_found: 'No comments found'
+      must_be_logged_in_to_comment: 'Must be logged in to comment.'
+      add_comment: 'Add comment'
+      comments: 'Comments'
+      comment_sent: 'Comment sent successfully.'
+      comment_sending_error: 'Error while sending the comment.'
+      comment_destroyed: 'Comment removed successfully.'
+      comment_interval: 'You must wait %{time} seconds to comment again.'
+      cannot_be_comment_of_comment: "Cannot reply another comment's reply"

data/lib/generators/opinio/install/templates/initializers/opinio.erb

@@ -14,4 +14,15 @@ Opinio.setup do |config|
   # Here you can change the method called to check who is the current user
   # config.current_user_method = :current_user
 
+  # Strip html tags on save comment
+  config.strip_html_tags_on_save = true
+
+  # Comments sort order by created_at (DESC or ASC)
+  # Note: you can override that easily within each opinio subjectum
+  config.sort_order = 'DESC'
+
+  # Wether or not the default opinio controller should set the flash
+  # when creating/removing comments
+  config.set_flash = true
+
 end

data/lib/generators/opinio/views/views_generator.rb

@@ -2,12 +2,26 @@ module Opinio
   module Generators
     class ViewsGenerator < Rails::Generators::Base
 
-      source_root File.expand_path('../../../../../app/views', __FILE__)
+      source_root File.expand_path('../../../../../app/views/opinio/comments', __FILE__)
+
+      class_option :haml, :desc => 'Generate HAML views instead of ERB.', :type => :boolean
 
       def copy_views
-        directory "opinio", "app/views/opinio"
+        html_names = ["_comment", "_comments", "_new", "index"]
+        js_names = ["create", "destroy", "reply"]
+        html_names.each do |name|
+          copy_file "#{name}.html.#{view_language}", "app/views/opinio/comments/#{name}.html.#{view_language}"
+        end
+        js_names.each do |name|
+          copy_file "#{name}.js.erb", "app/views/opinio/comments/#{name}.js.erb"
+        end
+      end
+
+      def view_language
+        options.haml? ? 'haml' : 'erb'
       end
 
+
     end
   end
 end 

data/lib/opinio.rb

@@ -1,10 +1,10 @@
 module Opinio
-  autoload :Schema, 'opinio/schema'
+  require 'opinio/schema'
 
   module Controllers
-    autoload :Helpers, 'opinio/controllers/helpers'
-    autoload :InternalHelpers, 'opinio/controllers/internal_helpers'
-    autoload :Replies, 'opinio/controllers/replies'
+    require 'opinio/controllers/helpers'
+    require 'opinio/controllers/internal_helpers'
+    require 'opinio/controllers/replies'
   end
 
   mattr_accessor :model_name
@@ -31,6 +31,15 @@ module Opinio
   mattr_accessor :current_user_method
   @@current_user_method = :current_user
 
+  mattr_accessor :strip_html_tags_on_save
+  @@strip_html_tags_on_save = true
+
+  mattr_accessor :sort_order
+  @@sort_order = 'DESC'
+
+  mattr_accessor :set_flash
+  @@set_flash = true
+
   def self.setup
     yield self
   end

data/lib/opinio/controllers/internal_helpers.rb

@@ -28,6 +28,10 @@ module Opinio
       def resource_name
         Opinio.model_name
       end
+
+      def set_flash(name, message)
+        flash[name] = message if Opinio.set_flash
+      end
     end
   end
 end

data/lib/opinio/opinio_model.rb

@@ -71,6 +71,11 @@ module Opinio
           send :include, RepliesSupport
         end
 
+        if Opinio.strip_html_tags_on_save
+          send :include, ActionView::Helpers::SanitizeHelper
+          before_save :strip_html_tags
+        end
+
       end
     end
 
@@ -93,12 +98,7 @@ module Opinio
           if (Time.now - last_comment.created_at).round >= self.comments_interval
             true
           else
-            errors.add(
-              :created_at,
-              I18n.t('opinio.comment_interval',
-                     :time => self.comments_interval,
-                     :default => "You must wait %{time} seconds to comment again.")
-            )
+            errors.add(:created_at, I18n.translate('opinio.messages.comment_interval', :time => self.comments_interval))
             false
           end
         else
@@ -110,11 +110,15 @@ module Opinio
       def cannot_be_comment_of_a_comments_comment
         if new_record? && self.commentable_type == Opinio.model_name
           if commentable.commentable_type == Opinio.model_name
-            errors.add :base, I18n.translate('opinio.cannot_be_comment_of_comment', :default => 'Cannot reply another comment\'s reply')
+            errors.add :base, I18n.t('opinio.messages,cannot_be_comment_of_comment')
           end
         end
       end
 
+      def strip_html_tags
+        self.body = strip_tags(self.body)
+      end
+
     end
   end
 end

data/lib/opinio/opinio_subjectum.rb

@@ -12,7 +12,7 @@ module Opinio
         has_many :comments,
                  :class_name => Opinio.model_name,
                  :as => :commentable,
-                 :order => options.reverse_merge(:order => "created_at DESC")[:order],
+                 :order => options.reverse_merge(:order => "created_at #{Opinio.sort_order}")[:order],
                  :dependent => :destroy
 
 

data/lib/opinio/version.rb

@@ -1,5 +1,5 @@
 module Opinio
   class Version
-    VERSION = '0.4.1'
+    VERSION = '0.5'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: opinio
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: '0.5'
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-23 00:00:00.000000000Z
+date: 2012-04-26 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &2153246840 !ruby/object:Gem::Requirement
+  requirement: &2164731680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '3'
   type: :runtime
   prerelease: false
-  version_requirements: *2153246840
+  version_requirements: *2164731680
 - !ruby/object:Gem::Dependency
   name: kaminari
-  requirement: &2153246340 !ruby/object:Gem::Requirement
+  requirement: &2164881320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2153246340
+  version_requirements: *2164881320
 - !ruby/object:Gem::Dependency
   name: jquery-rails
-  requirement: &2153245840 !ruby/object:Gem::Requirement
+  requirement: &2165159760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2153245840
+  version_requirements: *2165159760
 description: Opinio is an engine used to add comments functionallity to rails 3 applications.
 email:
 - luiz.felipe.gp@gmail.com
@@ -53,11 +53,15 @@ extra_rdoc_files: []
 files:
 - app/controllers/opinio/comments_controller.rb
 - app/views/opinio/comments/_comment.html.erb
+- app/views/opinio/comments/_comment.html.haml
 - app/views/opinio/comments/_comments.html.erb
+- app/views/opinio/comments/_comments.html.haml
 - app/views/opinio/comments/_new.html.erb
+- app/views/opinio/comments/_new.html.haml
 - app/views/opinio/comments/create.js.erb
 - app/views/opinio/comments/destroy.js.erb
 - app/views/opinio/comments/index.html.erb
+- app/views/opinio/comments/index.html.haml
 - app/views/opinio/comments/reply.js.erb
 - lib/generators/opinio/install/install_generator.rb
 - lib/generators/opinio/install/templates/initializers/opinio.erb
@@ -78,6 +82,7 @@ files:
 - lib/opinio/shared_examples.rb
 - lib/opinio/version.rb
 - lib/opinio.rb
+- config/locales/opinio.en.yml
 - MIT-LICENSE
 - Rakefile
 - Gemfile-rails-3.0.x