commontator 4.0.2 → 4.1.1

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

@@ -0,0 +1,106 @@
+module Commontator
+  class Comment < ActiveRecord::Base
+    belongs_to :creator, :polymorphic => true
+    belongs_to :editor, :polymorphic => true
+    belongs_to :thread
+
+    has_one :commontable, :through => :thread
+
+    validates_presence_of :creator, :on => :create
+    validates_presence_of :editor, :on => :update
+    validates_presence_of :thread
+    validates_presence_of :body
+
+    validates_uniqueness_of :body, :scope => [:creator_type, :creator_id, :thread_id],
+                                   :message => 'has already been posted'
+
+    protected
+
+    cattr_accessor :acts_as_votable_initialized
+
+    public
+
+    def is_votable?
+      return true if acts_as_votable_initialized
+      return false unless self.class.respond_to?(:acts_as_votable)
+      self.class.acts_as_votable
+      self.class.acts_as_votable_initialized = true
+    end
+
+    def get_vote_by(user)
+      return nil unless is_votable?
+      votes.where(:voter_type => user.class.name, :voter_id => user.id).first
+    end
+
+    def is_modified?
+      !editor.nil?
+    end
+
+    def is_deleted?
+      !deleted_at.blank?
+    end
+
+    def delete_by(user)
+      return false if is_deleted?
+      self.deleted_at = Time.now
+      self.editor = user
+      self.save
+    end
+
+    def undelete_by(user)
+      return false unless is_deleted?
+      self.deleted_at = nil
+      self.editor = user
+      self.save
+    end
+
+    def created_timestamp
+      config = thread.config
+      "#{config.comment_create_verb_past.capitalize} on " + \
+        created_at.strftime(config.timestamp_format)
+    end
+
+    def updated_timestamp
+      config = thread.config
+      is_modified? ? ("Last #{config.comment_edit_verb_past} on " + \
+        updated_at.strftime(config.timestamp_format)) : ''
+    end
+
+    ##################
+    # Access Control #
+    ##################
+
+    def can_be_read_by?(user)
+      ((!is_deleted? || thread.config.deleted_comments_are_visible) &&\
+        thread.can_be_read_by?(user)) ||\
+      thread.can_be_edited_by?(user)
+    end
+
+    def can_be_created_by?(user)
+      !thread.is_closed? && user == creator && thread.can_be_read_by?(user)
+    end
+
+    def can_be_edited_by?(user)
+      (!thread.is_closed? && !is_deleted? &&\
+        (thread.comments.last == self || thread.config.can_edit_old_comments) &&\
+        user == creator && thread.config.can_edit_own_comments && thread.can_be_read_by?(user)) ||\
+      (thread.config.admin_can_edit_comments && thread.can_be_edited_by?(user))
+    end
+
+    def can_be_deleted_by?(user)
+      (!thread.is_closed? && (!is_deleted? || editor == user) &&\
+        (thread.comments.last == self || thread.config.can_delete_old_comments) &&\
+        user == creator && thread.config.can_delete_own_comments &&\
+        thread.can_be_read_by?(user)) ||\
+      thread.can_be_edited_by?(user)
+    end
+
+    def can_be_voted_on?
+      !thread.is_closed? && is_votable? && !is_deleted? && thread.config.can_vote_on_comments
+    end
+
+    def can_be_voted_on_by?(user)
+      can_be_voted_on? && user && user.is_commontator && user != creator && thread.can_be_read_by?(user)
+    end
+  end
+end

data/app/models/commontator/thread.rb

@@ -101,24 +101,24 @@ module Commontator
     # Access Control #
     ##################
 
-    # Reader and poster capabilities
+    # Reader capabilities (user can be nil or false)
     def can_be_read_by?(user)
-      (!commontable.nil? && \
-        (!is_closed? || config.closed_threads_are_readable) && \
-        config.can_read_thread_proc.call(self, user)) || \
-        can_be_edited_by?(user)
+      (!commontable.nil? &&\
+        (!is_closed? || config.closed_threads_are_readable) &&\
+        config.can_read_thread_proc.call(self, user)) ||\
+      can_be_edited_by?(user)
     end
 
     # Thread moderator capabilities
     def can_be_edited_by?(user)
-      (!commontable.nil? && \
-        config.can_edit_thread_proc.call(self, user)) || \
-        (!user.nil? && user.is_commontator && \
-        user.commontator_config.user_admin_proc.call(user))
+      !commontable.nil? && user && user.is_commontator &&\
+      (user.commontator_config.user_admin_proc.call(user) ||\
+        config.can_edit_thread_proc.call(self, user))
     end
 
     def can_subscribe?(user)
-      !commontable.nil? && config.can_subscribe_to_thread && !is_closed? && can_be_read_by?(user)
+      !is_closed? && user && user.is_commontator &&\
+      config.can_subscribe_to_thread && can_be_read_by?(user)
     end
   end
 end

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

@@ -0,0 +1,124 @@
+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
+      commontable.try(:commontable_config) || Commontator
+    end
+
+    def ordered_comments
+      (config.can_vote_on_comments && config.comments_ordered_by_votes) ? \
+        comments.order("cached_votes_down - cached_votes_up") : comments
+    end
+
+    def is_closed?
+      !closed_at.blank?
+    end
+
+    def subscribers
+      subscriptions.collect{|s| s.subscriber}
+    end
+
+    def active_subscribers
+      subscribers.select{|s| s.is_commontator && s.commontator_config.subscription_email_enable_proc.call(s)}
+    end
+
+    def subscription_for(subscriber)
+      return nil if subscriber.nil? || !subscriber.is_commontator
+      subscriber.subscriptions.where(:thread_id => self.id).first
+    end
+
+    def is_subscribed?(subscriber)
+      !subscription_for(subscriber).blank?
+    end
+
+    def subscribe(subscriber)
+      return false if is_subscribed?(subscriber) || !subscriber.is_commontator
+      subscription = Subscription.new
+      subscription.subscriber = subscriber
+      subscription.thread = self
+      subscription.save
+    end
+
+    def unsubscribe(subscriber)
+      subscription = subscription_for(subscriber)
+      return false if subscription.blank?
+      subscription.destroy
+    end
+
+    def add_unread_except_for(subscriber)
+      Subscription.transaction do
+        subscriptions.each{|s| s.add_unread unless s.subscriber == subscriber}
+      end
+    end
+
+    def mark_as_read_for(subscriber)
+      return if !subscription_for(subscriber)
+      subscription_for(subscriber).mark_as_read
+    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
+
+    # Creates a new empty thread and assigns it to the commontable
+    # The old thread is kept in the database for archival purposes
+    def clear(user = nil)
+      return if commontable.blank?
+      new_thread = Thread.new
+      new_thread.commontable = commontable
+      with_lock do
+        self.commontable = nil
+        self.closed_at = Time.now
+        self.closer = user
+        save!
+        new_thread.save!
+        subscriptions.each do |s|
+          s.thread = new_thread
+          s.save!
+          s.mark_as_read
+        end
+      end
+    end
+
+    ##################
+    # Access Control #
+    ##################
+
+    # Reader capabilities (user can be nil or false)
+    def can_be_read_by?(user)
+      (!commontable.nil? &&\
+        (!is_closed? || config.closed_threads_are_readable) &&\
+        config.can_read_thread_proc.call(self, user)) ||\
+      can_be_edited_by?(user)
+    end
+
+    # Thread moderator capabilities
+    def can_be_edited_by?(user)
+      !commontable.nil? && user && user.is_commontator &&\
+      (user.commontator_config.user_admin_proc.call(user) ||\
+        config.can_edit_thread_proc.call(self, user))
+    end
+
+    def can_subscribe?(user)
+      can_be_read_by?(user) && !is_closed? && user &&\
+      user.is_commontator && config.can_subscribe_to_thread
+    end
+  end
+end

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

@@ -4,41 +4,43 @@
 %>
   
 <div id="comment_<%= comment.id.to_s %>_div" class="comment">
-  <span id="comment_<%= comment.id.to_s %>_commontator_span" class="comment_commontator">
-    <% if !user.nil? && user.commontator_config.user_name_clickable %>
-      <%= link_to commontator_name(comment.creator), main_app.polymorphic_path(comment.creator) %>
-    <% else %>
-      <%= commontator_name(comment.creator) %>
+  <div id="comment_<%= comment.id.to_s %>_top_div" class="comment_div">
+    <span id="comment_<%= comment.id.to_s %>_commontator_span" class="comment_commontator">
+      <% if user && user.commontator_config.user_name_clickable %>
+        <%= link_to commontator_name(comment.creator), main_app.polymorphic_path(comment.creator) %>
+      <% else %>
+        <%= commontator_name(comment.creator) %>
+      <% end %>
+    </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 %>_gravatar_image_span" class="comment_gravatar_image">
+      <%= commontator_gravatar_image comment.creator %>
+    </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 %><%= " by #{commontator_name(comment.editor)}" %>
     <% end %>
-    &nbsp;&nbsp;
-    <span id="comment_<%= comment.id.to_s %>_timestamp_span" class="comment_timestamp">
-      <%= comment.timestamp %><%= " by #{commontator_name(comment.editor)}" if comment.is_modified? %>
     </span>
-  </span>
-  
-  <span id="comment_<%= comment.id.to_s %>_actions_span" class="comment_actions">
-    <%= render :partial => 'commontator/comments/actions',
-               :locals => {:comment => comment,
-                           :user => user} %>
-  </span>
-  
-  <br clear="all"/>
-  
-  <span id="comment_<%= comment.id.to_s %>_gravatar_image_span" class="comment_gravatar_image">
-    <%= commontator_gravatar_image comment.creator %>
-  </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>
-
-<br clear="all"/>

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

@@ -0,0 +1,47 @@
+<% # Clients of this partial must supply the following variables:
+   # comment
+   # user
+%>
+  
+<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">
+      <% if user && user.commontator_config.user_name_clickable %>
+        <%= link_to commontator_name(comment.creator), main_app.polymorphic_path(comment.creator) %>
+      <% else %>
+        <%= commontator_name(comment.creator) %>
+      <% end %>
+    </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 %>_gravatar_image_span" class="comment_gravatar_image">
+      <%= commontator_gravatar_image comment.creator %>
+    </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 %><%= " by #{commontator_name(comment.editor)}" %>
+    <% end %>
+    </span>
+    <% end %>
+  </div>
+</div>

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

@@ -1,4 +1,4 @@
-<% # Clients of this partial must provide the following variable:
+<% # Clients of this partial must provide the following variables:
    # comment
    # user
 %>
@@ -30,7 +30,11 @@
   </span>
 
   <span id="comment_<%= comment.id %>_vote_count_span" class="comment_vote_count">
-    <p>+ <%= comment.upvotes.size %><br><br>- <%= comment.downvotes.size %></p>
+    <% if comment.thread.config.combine_upvotes_and_downvotes %>
+      <p><%= "%+d" % (comment.upvotes.size - comment.downvotes.size) %></p>
+    <% else %>
+      <p>+<%= comment.upvotes.size %>/-<%= comment.downvotes.size %></p>
+    <% end %>
   </span>
 
   <span id="comment_<%= comment.id %>_downvote_span" class="comment_downvote">

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

@@ -0,0 +1,61 @@
+<% # 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) %>
+
+  <span id="comment_<%= comment.id %>_upvote_span" class="comment_upvote">
+    <% 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_hover.png",
+              :onmouseover => "this.src='/assets/commontator/upvote.png'",
+              :onmouseout => "this.src='/assets/commontator/upvote_hover.png'" %>
+      <% end %>
+    <% else %>
+      <%= image_tag "commontator/upvote_hover.png" %>
+    <% end %>
+  </span>
+
+  <span id="comment_<%= comment.id %>_vote_count_span" class="comment_vote_count">
+    <% if comment.thread.config.combine_upvotes_and_downvotes %>
+      <p>+<%= "%+d" % (comment.upvotes.size - comment.downvotes.size) %></p>
+    <% else %>
+      <p>+<%= comment.upvotes.size %>/-<%= comment.downvotes.size %></p>
+    <% end %>
+  </span>
+
+  <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_hover.png",
+              :onmouseover => "this.src='/assets/commontator/downvote.png'",
+              :onmouseout => "this.src='/assets/commontator/downvote_hover.png'" %>
+      <% end %>
+    <% else %>
+      <%= image_tag "commontator/downvote_hover.png" %>
+    <% end %>
+  </span>
+<% end %>