commontator 4.5.4 → 4.6.0

data/app/models/commontator/thread.rb~

@@ -0,0 +1,159 @@
+module Commontator
+  class Thread < ActiveRecord::Base
+    belongs_to :closer, :polymorphic => true
+    belongs_to :commontable, :polymorphic => true
+
+    has_many :comments, :dependent => :destroy
+    has_many :subscriptions, :dependent => :destroy
+
+    validates_presence_of :commontable, :unless => :is_closed?
+    validates_uniqueness_of :commontable_id,
+                            :scope => :commontable_type,
+                            :allow_nil => true
+
+    def config
+      @config ||= commontable.try(:commontable_config) || Commontator
+    end
+
+    def will_paginate?
+      return false if config.comments_per_page.nil? || !comments.respond_to?(:paginate)
+      require 'commontator/link_renderer'
+      true
+    end
+
+    def is_filtered?
+      will_paginate? || config.comment_filter
+    end
+
+    def filtered_comments
+      cf = config.comment_filter
+      return comments if cf.nil?
+      comments.where(cf)
+    end
+
+    def ordered_comments(override = false)
+      vc = override ? comments : filtered_comments
+      case config.comment_order.to_sym
+      when :l then vc.order('id DESC')
+      when :ve then vc.order('cached_votes_down - cached_votes_up')
+      when :vl then vc.order('cached_votes_down - cached_votes_up', 'id DESC')
+      else vc
+      end
+    end
+
+    def paginated_comments(page = 1, per_page = config.comments_per_page)
+      oc = ordered_comments
+      return oc unless will_paginate?
+      oc.paginate(:page => page, :per_page => per_page)
+    end
+
+    def new_comment_page(per_page = config.comments_per_page)
+      return 1 if per_page.nil? || per_page.to_i <= 0
+      comment_index = \
+        case config.comment_order.to_sym
+        when :l
+          1 # First comment
+        when :ve
+          comment_arel = Comment.arel_table
+          # Last comment with rating = 0
+          filtered_comments.where((comment_arel[:cached_votes_up] - comment_arel[:cached_votes_down]).gteq 0).count
+        when :vl
+          comment_arel = Comment.arel_table
+          # First comment with rating = 0
+          filtered_comments.where((comment_arel[:cached_votes_up] - comment_arel[:cached_votes_down]).gt 0).count + 1
+        else
+          filtered_comments.count # Last comment
+        end
+      (comment_index.to_f/per_page.to_i).ceil
+    end
+
+    def is_closed?
+      !closed_at.blank?
+    end
+
+    def close(user = nil)
+      return false if is_closed?
+      self.closed_at = Time.now
+      self.closer = user
+      save
+    end
+
+    def reopen
+      return false unless is_closed? && !commontable.nil?
+      self.closed_at = nil
+      save
+    end
+
+    def subscribers
+      subscriptions.collect{|s| s.subscriber}
+    end
+
+    def subscription_for(subscriber)
+      return nil if !subscriber || !subscriber.is_commontator
+      subscriber.subscriptions.where(:thread_id => self.id).first
+    end
+
+    def subscribe(subscriber)
+      return false unless subscriber.is_commontator && !subscription_for(subscriber)
+      subscription = Subscription.new
+      subscription.subscriber = subscriber
+      subscription.thread = self
+      subscription.save
+    end
+
+    def unsubscribe(subscriber)
+      subscription = subscription_for(subscriber)
+      return false unless subscription
+      subscription.destroy
+    end
+
+    def mark_as_read_for(subscriber)
+      subscription = subscription_for(subscriber)
+      return false unless subscription
+      subscription.touch
+    end
+
+    # Creates a new empty thread and assigns it to the commontable
+    # The old thread is kept in the database for archival purposes
+    def clear
+      return if commontable.blank? || !is_closed?
+      new_thread = Thread.new
+      new_thread.commontable = commontable
+
+      with_lock do
+        self.commontable = nil
+        save!
+        new_thread.save!
+        subscriptions.each do |s|
+          s.thread = new_thread
+          s.save!
+        end
+      end
+    end
+
+    ##################
+    # Access Control #
+    ##################
+
+    # Reader capabilities (user can be nil or false)
+    def can_be_read_by?(user)
+      return true if can_be_edited_by?(user)
+      !commontable.nil? &&\
+      config.thread_read_proc.call(self, user)
+    end
+
+    # Thread moderator capabilities
+    def can_be_edited_by?(user)
+      !commontable.nil? && !user.nil? && user.is_commontator &&\
+      config.thread_moderator_proc.call(self, user)
+    end
+
+    def can_subscribe?(user)
+      thread_sub = config.thread_subscription.to_sym
+      !is_closed? && !user.nil? && user.is_commontator &&\
+      (thread_sub == :m || thread_sub == :b) &&\
+      can_be_read_by?(user)
+    end
+  end
+end
+

data/app/views/commontator/comments/_actions.html.erb

@@ -27,3 +27,4 @@
               :class => "comment_#{del_string}_link",
               :remote => true %>
 <% end %>
+

data/app/views/commontator/comments/_body.html.erb

@@ -4,5 +4,6 @@
 
 <%= simple_format comment.is_deleted? ? \
       t('commontator.comment.status.deleted_by',
-        :deleter_name => comment.editor.commontator_name) : \
+        :deleter_name => Commontator.commontator_name(comment.editor)) : \
       comment.body %>
+

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

@@ -1,7 +1,8 @@
 <% # Clients of this partial must provide the following variables:
    # comment
    #
-   # Additionally, they can override the following variables:
+   # Optionally, they can also supply the following variables:
+   per_page ||= nil
    thread ||= nil
    no_remote ||= false
 %>
@@ -22,6 +23,8 @@
 
 <%= form_for([commontator, thread, comment],
              :remote => !no_remote) do |f| %>
+
+  <%= hidden_field_tag :per_page, per_page %>
   
   <div class="comment_form_field">
     <%= f.text_area :body, :rows => '7' %>
@@ -33,3 +36,4 @@
   </div>
   
 <% end %>
+

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

@@ -0,0 +1,39 @@
+<% # Clients of this partial must provide the following variables:
+   # comment
+   #
+   # Optionally, they can also supply the following variables:
+   per_page ||= nil
+   thread ||= nil
+   no_remote ||= false
+%>
+
+<% config = comment.thread.config %>
+
+<% if comment.errors.any? %>
+  <div class="comment_error_explanation">
+    <h3><%= t "commontator.comment.errors.#{comment.id.blank? ? 'create' : 'update'}" %></h3>
+
+    <ul>
+      <% comment.errors.full_messages.each do |msg| %>
+        <li><%= msg %></li>
+      <% end %>
+    </ul>
+  </div>
+<% end %>
+
+<%= form_for([commontator, thread, comment],
+             :remote => !no_remote) do |f| %>
+
+  <%= f.hidden_field :per_page, per_page %>
+  
+  <div class="comment_form_field">
+    <%= f.text_area :body, :rows => '7' %>
+  </div>
+  
+  <div class="comment_form_actions">
+    <%= f.submit t("commontator.comment.actions.#{comment.id.blank? ? 'create' : 'update'}") %>
+    <%= f.submit t('commontator.comment.actions.cancel'), :name => 'cancel' %>
+  </div>
+  
+<% end %>
+

data/app/views/commontator/comments/_list.html.erb

@@ -4,8 +4,8 @@
 %>
 
 <% comments.each do |comment| %>
-  <% next unless comment.can_be_read_by?(user) %>
   <%= render :partial => 'commontator/comments/show',
              :locals => {:comment => comment,
                          :user => user} %>
 <% end %>
+

data/app/views/commontator/comments/_show.html.erb

@@ -4,9 +4,10 @@
 %>
 
 <% creator = comment.creator
-   name = creator.commontator_name
-   link = creator.commontator_link(main_app)
-   avatar = creator.commontator_avatar(self) %>
+   name = Commontator.commontator_name(creator) || ''
+   link = Commontator.commontator_link(creator) || ''
+   avatar = Commontator.commontator_avatar(creator, self) || ''
+%>
 
 <div id="comment_<%= comment.id.to_s %>_div" class="comment">
   <div id="comment_<%= comment.id.to_s %>_top_div" class="comment_div">
@@ -45,3 +46,4 @@
     </span>
   </div>
 </div>
+

data/app/views/commontator/comments/_show.html.erb~

@@ -0,0 +1,49 @@
+<% # Clients of this partial must supply the following variables:
+   # comment
+   # user
+%>
+
+<% creator = comment.creator
+   name = Commontator.commontator_name(creator) || ''
+   link = Commontator.commontator_link(creator) || ''
+   avatar = Commontator.commontator_avatar(creator, self) || ''
+%>
+
+<div id="comment_<%= comment.id.to_s %>_div" class="comment">
+  <div id="comment_<%= comment.id.to_s %>_top_div" class="comment_div">
+    <span id="comment_<%= comment.id.to_s %>_commontator_span" class="comment_commontator">
+      <%= link.blank? ? name : link_to(name, link) %>
+    </span>
+    <span id="comment_<%= comment.id.to_s %>_actions_span" class="comment_actions">
+      <%= render :partial => 'commontator/comments/actions',
+                 :locals => {:comment => comment,
+                             :user => user} %>
+    </span>
+  </div>
+  <div id="comment_<%= comment.id.to_s %>_middle_div" class="comment_div">
+    <span id="comment_<%= comment.id.to_s %>_avatar_span" class="comment_avatar">
+      <%= avatar %>
+    </span>
+    <span id="comment_<%= comment.id.to_s %>_votes_span" class="comment_votes">
+      <%= render :partial => 'commontator/comments/votes',
+                 :locals => {:comment => comment,
+                             :user => user} %>
+    </span>
+    <div id="comment_<%= comment.id.to_s %>_body_div" class="comment_body">
+      <%= render :partial => 'commontator/comments/body',
+                 :locals => {:comment => comment} %>
+    </div>
+  </div>
+  <div id="comment_<%= comment.id.to_s %>_bottom_div" class="comment_div">
+    <span id="comment_<%= comment.id.to_s %>_created_timestamp_span" class="comment_timestamp">
+      <%= comment.created_timestamp %>
+    </span>
+    <br/>
+    <span id="comment_<%= comment.id.to_s %>_updated_timestamp_span" class="comment_timestamp">
+    <% if comment.is_modified? %>
+      <%= comment.updated_timestamp %>
+    <% end %>
+    </span>
+  </div>
+</div>
+

data/app/views/commontator/comments/_votes.html.erb

@@ -37,7 +37,7 @@
 
   <span id="comment_<%= comment.id %>_vote_count_span" class="comment_vote_count">
     <% config = comment.thread.config %>
-    <%= config.voting_text_proc.call(config.comment_voting,
+    <%= config.vote_count_proc.call(comment.thread,
           comment.upvotes.size, comment.downvotes.size) %>
   </span>
 
@@ -66,3 +66,4 @@
   </span>
   <% end %>
 <% end %>
+

data/app/views/commontator/comments/_votes.html.erb~

@@ -0,0 +1,69 @@
+<% # Clients of this partial must provide the following variables:
+   # comment
+   # user
+%>
+
+<% if comment.can_be_voted_on? %>
+  <% can_vote = comment.can_be_voted_on_by?(user) %>
+  <% vote = comment.get_vote_by(user) %>
+  <% comment_voting = comment.thread.config.comment_voting.to_sym %>
+
+  <% if comment_voting == :ld || comment_voting == :l %>
+  <% vtype = (comment_voting == :ld) ? 'upvote' : 'like' %>
+  <span id="comment_<%= comment.id %>_<%= vtype %>_span"
+        class="comment_<%= vtype %>">
+    <% if can_vote && (vote.blank? || !vote.vote_flag) %>
+      <%= form_tag commontator.upvote_comment_path(comment),
+            :method => :put,
+            :remote => true do %>
+        <%= image_submit_tag "commontator/upvote.png",
+              :onmouseover => "this.src='/assets/commontator/upvote_hover.png'",
+              :onmouseout => "this.src='/assets/commontator/upvote.png'" %>
+      <% end %>
+    <% elsif can_vote %>
+      <%= form_tag commontator.unvote_comment_path(comment),
+            :method => :put,
+            :remote => true do %>
+        <%= image_submit_tag "commontator/upvote_active.png",
+              :onmouseover => "this.src='/assets/commontator/upvote.png'",
+              :onmouseout => "this.src='/assets/commontator/upvote_active.png'"
+        %>
+      <% end %>
+    <% else %>
+      <%= image_tag "commontator/upvote_disabled.png" %>
+    <% end %>
+  </span>
+  <% end %>
+
+  <span id="comment_<%= comment.id %>_vote_count_span" class="comment_vote_count">
+    <% config = comment.thread.config %>
+    <%= config.vote_count_proc.call(config.comment_voting,
+          comment.upvotes.size, comment.downvotes.size) %>
+  </span>
+
+  <% if comment_voting == :ld %>
+  <span id="comment_<%= comment.id %>_downvote_span" class="comment_downvote">
+    <% if can_vote && (vote.blank? || vote.vote_flag) %>
+      <%= form_tag commontator.downvote_comment_path(comment),
+            :method => :put,
+            :remote => true do %>
+        <%= image_submit_tag "commontator/downvote.png",
+              :onmouseover => "this.src='/assets/commontator/downvote_hover.png'",
+              :onmouseout => "this.src='/assets/commontator/downvote.png'" %>
+      <% end %>
+    <% elsif can_vote %>
+      <%= form_tag commontator.unvote_comment_path(comment),
+            :method => :put,
+            :remote => true do %>
+        <%= image_submit_tag "commontator/downvote_active.png",
+              :onmouseover => "this.src='/assets/commontator/downvote.png'",
+              :onmouseout => "this.src='/assets/commontator/downvote_active.png'"
+        %>
+      <% end %>
+    <% else %>
+      <%= image_tag "commontator/downvote_disabled.png" %>
+    <% end %>
+  </span>
+  <% end %>
+<% end %>
+

data/app/views/commontator/comments/cancel.js.erb

@@ -9,3 +9,4 @@ $("#thread_<%= @thread.id %>_new_comment_div").hide();
 $("#thread_<%= @thread.id %>_new_comment_link_span").fadeIn();
 
 <%= javascript_proc %>
+

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

@@ -1,7 +1,8 @@
-$("#thread_<%= @thread.id %>_comment_list_div").html("<%= escape_javascript(
-    render :partial => 'list',
-           :locals => {:comments => @thread.ordered_comments,
-                       :user => @user}) %>");
+<%= render :partial => 'commontator/threads/show',
+           :locals => {:thread => @thread,
+                       :user => @user,
+                       :page => @thread.new_comment_page(@per_page),
+                       :per_page => @per_page} %>
 
 $("#thread_<%= @thread.id %>_new_comment_div").hide();
 
@@ -10,3 +11,4 @@ $("#thread_<%= @thread.id %>_new_comment_link_span").fadeIn();
 $("#comment_<%= @comment.id.to_s %>_div").hide().fadeIn()[0].scrollIntoView();
 
 <%= javascript_proc %>
+

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

@@ -0,0 +1,14 @@
+<%= render :partial => 'commontator/threads/show',
+           :locals => {:thread => @thread,
+                       :user => @user,
+                       :page => @thread.new_comment_page_for(@comment, @per_page),
+                       :per_page => @per_page} %>
+
+$("#thread_<%= @thread.id %>_new_comment_div").hide();
+
+$("#thread_<%= @thread.id %>_new_comment_link_span").fadeIn();
+
+$("#comment_<%= @comment.id.to_s %>_div").hide().fadeIn()[0].scrollIntoView();
+
+<%= javascript_proc %>
+

data/app/views/commontator/comments/delete.js.erb

@@ -15,3 +15,4 @@ $("#comment_<%= @comment.id %>_votes_span").html("<%= escape_javascript(
                      :user => @user}) %>");
 
 <%= javascript_proc %>
+