sunrise-comments 0.1.0

data/README.rdoc

@@ -0,0 +1,21 @@
+= Sunrise Comments
+
+== Install
+
+  rails generate sunrise:comments:install
+  
+In generated migration add "comments_count" column for counter cache:
+
+  add_column :posts, :comments_count, :integer, :default => 0
+  
+  rake db:migrate
+
+== Usage
+
+  class Post < ActiveRecord::Base
+    include Sunrise::Comments::Base
+  end
+  
+  class User < ActiveRecord::Base
+    include Sunrise::Comments::Author
+  end

data/Rakefile

@@ -0,0 +1,46 @@
+# encoding: utf-8
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require File.join(File.dirname(__FILE__), 'lib', 'sunrise', 'comments', 'version')
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the sunrise plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the sunrise plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Sunrise Comments'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "sunrise-comments"
+    s.version = Sunrise::Comments::VERSION.dup
+    s.summary = "Rails CMS"
+    s.description = "Sunrise is a Aimbulance CMS"
+    s.email = "galeta.igor@gmail.com"
+    s.homepage = "https://github.com/galetahub/sunrise-comments"
+    s.authors = ["Igor Galeta", "Pavlo Galeta"]
+    s.files =  FileList["[A-Z]*", "{app,config,lib}/**/*"]
+    s.extra_rdoc_files = FileList["[A-Z]*"] - %w(Gemfile Rakefile)
+    
+    s.add_dependency('sunrise', "~> #{s.version}")
+  end
+  
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end

data/app/controllers/comments_controller.rb

@@ -0,0 +1,62 @@
+class CommentsController < ApplicationController
+  before_filter :find_author
+  before_filter :find_comment, :only => [:edit, :update, :destroy]
+  
+  authorize_resource
+  
+  respond_to :js, :only => [:create, :edit, :update, :destroy]
+  
+  cache_sweeper :comment_sweeper, :only => [:create, :update, :destroy]
+  
+  def new
+    @comment = Comment.new
+    @comment.author = @author
+    respond_with(@comment)
+  end
+  
+  def create
+    @comment = Comment.new(params[:comment])
+    @comment.author = @author
+    @comment.save
+    
+    respond_with(@comment, respond_options)
+  end
+  
+  def edit
+    respond_with(@comment)
+  end
+  
+  def update
+    @comment.update_attributes(params[:comment])
+    respond_with(@comment, respond_options)
+  end
+  
+  def destroy
+    @comment.destroy
+    respond_with(@comment, respond_options)
+  end
+  
+  protected
+    
+    def find_author
+      @author = current_user
+    end
+    
+    def find_comment
+      @comment = Comment.find(params[:id])
+    end
+    
+    def respond_options(options = {})
+      options = { :location => root_path }.merge(options)
+      
+      if @comment.commentable
+        options[:location] = polymorphic_path(@comment.commentable)
+      end
+      
+      options
+    end
+    
+    def current_ability
+      @current_ability ||= ::Ability.new(@author)
+    end
+end

data/app/sweepers/comment_sweeper.rb

@@ -0,0 +1,22 @@
+class CommentSweeper < ActionController::Caching::Sweeper
+	observe Comment
+	
+	def after_create(item)
+		expire(item)
+	end
+	
+	def after_update(item)
+		expire(item)
+	end
+	
+	def after_destroy(item)
+		expire(item)
+	end
+	
+	private
+	
+	  def expire(item=nil)
+  	  expire_fragment(%r{/comments})
+	    StructureSweeper.sweep!
+	  end
+end

data/app/views/comments/_block.html.erb

@@ -0,0 +1,10 @@
+<%= content_tag(:div, :id => dom_id(model, :block), :class => "comment-block") do %>
+	<h3><img src="/images/coment_title.png" alt="коментарi" /></h3>
+	<div class="comment-container">
+	  <%= render :partial => 'comments/form', :locals => { :comment => model.comments.new, :model => model } %>
+		
+		<%= content_tag(:div, :id => dom_id(model, :comments)) do %>
+		  <%= render :partial => 'comments/comment', :collection => model.comments %>
+		<% end %>
+	</div>
+<% end %>

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

@@ -0,0 +1,18 @@
+<%= content_tag(:div, :id => dom_id(comment), :class => "block") do %>
+  <%= record_asset_tag(comment.author, :avatar, "avatar_default.jpg", :type => :preview, :class => "autor-pic") %>
+  <span class="cover"></span>
+	
+	<div class="coment-area">
+		<div class="comment-cont">
+			<strong class="autor"><%= comment.author.name %></strong>
+			<div class="txt">
+				<%=raw comment.content_html %>
+			</div>
+			
+			<% if can? :delete, comment %>
+	      <%= link_to 'видалити', comment_path(comment), :remote => true, 
+	        :method => :delete, :class => 'destroy', :confirm => t('sunrise.comments.destroy_confirm') %>
+	    <% end %>
+		</div>
+	</div>
+<% end %>

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

@@ -0,0 +1,33 @@
+<%= content_tag(:div, :id => dom_id(model, :form), :class => "block") do %>
+  <% if user_signed_in? %>
+	  <%= record_asset_tag(current_user, :avatar, "avatar_default.jpg", :type => :preview, :class => "autor-pic") %>
+	  
+	  <span class="cover"></span>
+	  <div class="coment-area">
+		  <div class="comment-cont">
+			  <strong class="autor"><%= current_user.name %></strong>
+			  
+			  <div class="txtarea">
+          <noscript><p><%= t('sunrise.comments.noscript') %></p></noscript>
+          <%= form_for comment, :as => :comment, :remote => true do |f| %>
+            <%= f.hidden_field :commentable_type %>
+            <%= f.hidden_field :commentable_id %>
+            
+            <%= f.text_area :content, :title => t('sunrise.comments.tooltip'), 
+              :"data-disable-with" => t('sunrise.comments.loading') %>
+            
+            <div class="ok">
+					    <%= f.submit t('sunrise.comments.create'), :type => "image", :src => "/images/but_public.png", 
+					      :"data-disable-with" => t('sunrise.comments.loading'), :class => "but" %>
+				    </div>
+          <% end %>
+        </div>
+		  </div>
+	  </div>
+	<% else %>
+	  <div class="comments-notice">
+      <%= t('sunrise.comments.notice') %>, <%= link_to 'войдите', new_user_session_path(:ref => request.path) %> 
+      или <%= link_to 'зарегистрируйтесь', new_user_path(:ref => request.path) %>.
+    </div>
+	<% end %>
+<% end %>

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

@@ -0,0 +1,8 @@
+<% model = @comment.commentable %>
+<% if @comment.errors.empty? %>
+  //$('#<%= dom_id(model, :block) %>').replaceWith("<%= escape_javascript(render(:partial => "block", :locals => { :model => model })) %>");
+  $('#<%= dom_id(model, :comments) %>').prepend("<%= escape_javascript(render(:partial => 'comment', :object => @comment)) %>");
+  $('#<%= dom_id(model, :form) %>').replaceWith("<%= escape_javascript(render(:partial=>"form", :locals=>{ :comment => model.comments.new, :model => model })) %>");
+<% else %>
+  $('#<%= dom_id(model, :form) %>').replaceWith("<%= escape_javascript(render(:partial=>"form", :locals=>{ :comment => @comment, :model => model })) %>");
+<% end %>

data/app/views/comments/destroy.js.erb

@@ -0,0 +1,2 @@
+$('#<%= dom_id(@comment)%>').slideUp('slow');
+//$('#comments_count').html(<%= @comment.comments_count %>);

data/config/locales/ru.yml

@@ -0,0 +1,15 @@
+ru:
+  sunrise:
+    comments:
+      title: "Комментарии"
+      noscript: "Вам необходимо включить поддержку Javascript, чтобы добавить комментарий"
+      tooltip: "Оставьте свой ​​комментарий ..."
+      create: "Отправить"
+      loading: "Загрузка ..."
+      notice: "Комментарии могут оставлять только зарегистрированные пользователи"
+      destroy_confirm: "Удалить комментарий?"
+      expand:
+        one: "Показать %{count} ответ"
+        few: "Показать %{count} ответa"
+        many: "Показать %{count} ответов"
+        other: "Показать %{count} ответов"

data/config/locales/uk.yml

@@ -0,0 +1,15 @@
+uk:
+  sunrise:
+    comments:
+      title: "Коментарі"
+      noscript: "Вам необхідно включити підтримку Javascript, щоб додати коментар"
+      tooltip: "Залиште свiй коментар ..."
+      create: "Опублікувати"
+      loading: "Завантаження ..."
+      notice: "Коментарі можуть залишати тільки зареєстровані користувачі"
+      destroy_confirm: "Видалити коментар?"
+      expand:
+        one: "Показати %{count} відповідь"
+        few: "Показати %{count} відповіді"
+        many: "Показати %{count} відповідей"
+        other: "Показати %{count} відповідей"

data/config/routes.rb

@@ -0,0 +1,7 @@
+Rails.application.routes.draw do
+  resources :comments, :only => [:new, :create, :edit, :update, :destroy]  
+  
+  namespace :manage do
+    resources :comments
+  end
+end

data/lib/generators/sunrise/comments/USAGE

@@ -0,0 +1,11 @@
+Usage:
+  rails generate sunrise:comments:install [options]
+
+Options:
+  [--migrations]  # Indicates when to generate migrations
+                  # Default: true
+                 
+Example:
+  rails g sunrise:comments:install
+  
+  rails g sunrise:comments:install --skip-migrations

data/lib/generators/sunrise/comments/install_generator.rb

@@ -0,0 +1,34 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module Sunrise
+  module Comments
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+      
+      source_root File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+      class_option :migrations, :type => :boolean, :default => true, :description => "Generate migrations files"
+
+      desc "Generates comment migration and model"
+
+      def self.current_time
+        @current_time ||= Time.now
+        @current_time += 1.minute
+      end
+
+      def self.next_migration_number(dirname)
+        current_time.strftime("%Y%m%d%H%M%S")
+      end
+      
+      def create_model
+        copy_file('comment.rb', 'app/models/comment.rb')
+      end
+      
+      def create_migration
+        if options.migrations
+          migration_template "create_comments.rb", File.join('db/migrate', "sunrise_create_comments.rb")
+        end
+      end
+    end
+  end
+end

data/lib/generators/sunrise/comments/templates/comment.rb

@@ -0,0 +1,29 @@
+class Comment < ActiveRecord::Base
+  include Sunrise::Models::Comment
+  
+  attr_accessible :user_name, :user_email, :content, :is_follow
+
+  # Validations
+  validates :content, :presence => true, :length => { :maximum => 500 }
+  validates :commentable_type, :presence => true, :inclusion => { :in => %w( Post ) }
+  validates :author_type, :inclusion => { :in => %w( User ) }, :allow_blank => true
+  
+  with_options :if => :anonymous? do |anonymous|
+    anonymous.validates :user_name, :length => { :maximum => 100 }, :presence => true,
+              :format => { :with => /\A[^[:cntrl:]\\<>\/&]*\z/ }
+    anonymous.validates :user_email, :length => { :within => 6..100 }, :presence => true,
+              :format => { :with => /^([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})$/i }
+  end
+
+  # Format comment content
+  auto_html_for :content do
+    html_escape
+    big_words :length => 80, :tag => "span"
+    image
+    youtube :width => 500, :height => 300
+    vimeo :width => 500, :height => 300
+    link :target => "_blank", :rel => "nofollow"
+    simple_format
+    sanitize
+  end
+end

data/lib/generators/sunrise/comments/templates/create_comments.rb

@@ -0,0 +1,25 @@
+class SunriseCreateComments < ActiveRecord::Migration
+  def self.up
+    create_table :comments do |t|
+      t.string :user_name, :limit => 50
+      t.string :user_email, :limit => 50
+      t.text :content, :null => false
+      t.text :content_html
+      t.integer :commentable_id, :default => 0, :null => false
+      t.string :commentable_type, :limit => 15, :default => "", :null => false
+      t.boolean :is_follow, :default => false
+
+      t.integer :author_id
+      t.string :author_type, :limit => 25
+    
+      t.timestamps
+    end
+    
+    add_index :comments, [:author_type, :author_id]
+    add_index :comments, [:commentable_type, :commentable_id]
+  end
+
+  def self.down
+    drop_table :comments
+  end
+end

data/lib/sunrise-comments.rb

@@ -0,0 +1,2 @@
+# encoding: utf-8
+require 'sunrise/comments'

data/lib/sunrise/comments.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+module Sunrise  
+  module Comments
+    autoload :Base, 'sunrise/comments/base'
+    autoload :Author, 'sunrise/comments/author'
+    
+    # Default way to setup Sunrise. 
+    def self.setup
+      yield self
+    end
+  end
+end
+
+require 'sunrise/comments/version'
+require 'sunrise/comments/engine'

data/lib/sunrise/comments/author.rb

@@ -0,0 +1,21 @@
+module Sunrise
+  module Comments
+    module Author
+      def self.included(base)
+        base.send :include, InstanceMethods
+        base.send :extend, ClassMethods
+      end
+      
+      module ClassMethods
+        def self.extended(base)
+          base.class_eval do
+            has_many :comments, :as => :author, :dependent => :delete_all
+          end
+        end
+      end
+      
+      module InstanceMethods
+      end
+    end
+  end
+end

data/lib/sunrise/comments/base.rb

@@ -0,0 +1,21 @@
+module Sunrise
+  module Comments
+    module Base
+      def self.included(base)
+        base.send :include, InstanceMethods
+        base.send :extend, ClassMethods
+      end
+      
+      module ClassMethods
+        def self.extended(base)
+          base.class_eval do
+            has_many :comments, :as => :commentable, :dependent => :delete_all
+          end
+        end
+      end
+      
+      module InstanceMethods
+      end
+    end
+  end
+end

data/lib/sunrise/comments/engine.rb

@@ -0,0 +1,18 @@
+require 'rails'
+require 'sunrise-comments'
+
+module Sunrise
+  module Comments
+    class Engine < ::Rails::Engine
+      config.before_initialize do
+        Sunrise::Plugin.register :comments do |plugin|
+          plugin.model = 'sunrise/models/comment'
+          plugin.menu = false
+          plugin.version = Sunrise::Comments::VERSION.dup
+        end
+        
+        Sunrise::Plugins.activate(:comments)
+      end
+    end
+  end
+end

data/lib/sunrise/comments/version.rb

@@ -0,0 +1,5 @@
+module Sunrise
+  module Comments
+    VERSION = "0.1.0".freeze
+  end
+end

data/lib/sunrise/models/comment.rb

@@ -0,0 +1,51 @@
+# encoding: utf-8
+module Sunrise
+  module Models
+    module Comment
+      def self.included(base)
+        base.send :include, InstanceMethods
+        base.send :extend, ClassMethods
+      end
+      
+      module ClassMethods
+        def self.extended(base)
+          base.class_eval do
+            belongs_to :commentable, :polymorphic => true, :counter_cache => true
+            belongs_to :author, :polymorphic => true
+            
+            before_validation :make_author
+            
+            default_scope order("#{quoted_table_name}.id DESC")
+            scope :recently, order("#{quoted_table_name}.created_at DESC")
+            scope :siblings_for, lambda { |item| where(["commentable_type = ? AND commentable_id = ?", item.commentable_type, item.commentable_id]) }
+            scope :follows, where(:is_follow => true)
+          end
+        end
+      end
+      
+      module InstanceMethods
+      
+        def comments_count
+          @comments_count ||= siblings.count
+        end
+        
+        def siblings
+          self.class.siblings_for(self)
+        end
+        
+        def anonymous?
+          author.nil?
+        end
+    
+        protected
+    
+          def make_author
+           unless author.nil?
+             self.user_email = author.email if author.respond_to?(:email)
+             self.user_name = author.name if author.respond_to?(:name)
+           end
+          end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification 
+name: sunrise-comments
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Igor Galeta
+- Pavlo Galeta
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-18 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: sunrise
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 0
+        - 1
+        - 0
+        version: 0.1.0
+  type: :runtime
+  version_requirements: *id001
+description: Sunrise is a Aimbulance CMS
+email: galeta.igor@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- Rakefile
+- app/controllers/comments_controller.rb
+- app/sweepers/comment_sweeper.rb
+- app/views/comments/_block.html.erb
+- app/views/comments/_comment.html.erb
+- app/views/comments/_form.html.erb
+- app/views/comments/create.js.erb
+- app/views/comments/destroy.js.erb
+- config/locales/ru.yml
+- config/locales/uk.yml
+- config/routes.rb
+- lib/generators/sunrise/comments/USAGE
+- lib/generators/sunrise/comments/install_generator.rb
+- lib/generators/sunrise/comments/templates/comment.rb
+- lib/generators/sunrise/comments/templates/create_comments.rb
+- lib/sunrise-comments.rb
+- lib/sunrise/comments.rb
+- lib/sunrise/comments/author.rb
+- lib/sunrise/comments/base.rb
+- lib/sunrise/comments/engine.rb
+- lib/sunrise/comments/version.rb
+- lib/sunrise/models/comment.rb
+homepage: https://github.com/galetahub/sunrise-comments
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.2
+signing_key: 
+specification_version: 3
+summary: Rails CMS
+test_files: []
+