Cleaned Comment model

- Properly grouped statements
- Replaced double quotes with single quotes
- Made set_sk a private method

models/comment.rb

@@ -6,6 +6,8 @@ class Comment < Content
   include Mongoid::Timestamps
   include Mongoid::MagicCounterCache
   include ActiveModel::MassAssignmentSecurity
+  include Tire::Model::Search
+  include Tire::Model::Callbacks
 
   voteable self, :up => +1, :down => -1
 
@@ -17,21 +19,11 @@ class Comment < Content
   field :anonymous_to_peers, type: Boolean, default: false
   field :commentable_id, type: String
   field :at_position_list, type: Array, default: []
+  field :sk, type: String, default: nil
 
   index({author_id: 1, course_id: 1})
   index({_type: 1, comment_thread_id: 1, author_id: 1, updated_at: 1})
 
-  field :sk, type: String, default: nil
-  before_save :set_sk  
-  def set_sk()
-    # this attribute is explicitly write-once
-    if self.sk.nil?
-      self.sk = (self.parent_ids.dup << self.id).join("-") 
-    end
-  end
-
-  include Tire::Model::Search
-  include Tire::Model::Callbacks
 
   index_name Content::ES_INDEX_NAME
 
@@ -45,10 +37,10 @@ class Comment < Content
     indexes :created_at, type: :date, included_in_all: false
     indexes :updated_at, type: :date, included_in_all: false
   end
-  
+
 
   belongs_to :comment_thread, index: true
-  belongs_to :author, class_name: "User", index: true
+  belongs_to :author, class_name: 'User', index: true
 
   attr_accessible :body, :course_id, :anonymous, :anonymous_to_peers, :endorsed, :endorsement
 
@@ -59,13 +51,13 @@ class Comment < Content
 
   counter_cache :comment_thread
 
-  before_destroy :destroy_children # TODO async
-
+  before_destroy :destroy_children
   before_create :set_thread_last_activity_at
   before_update :set_thread_last_activity_at
+  before_save :set_sk
 
   def self.hash_tree(nodes)
-    nodes.map{|node, sub_nodes| node.to_hash.merge("children" => hash_tree(sub_nodes).compact)}
+    nodes.map { |node, sub_nodes| node.to_hash.merge('children' => hash_tree(sub_nodes).compact) }
   end
 
   # This should really go somewhere else, but sticking it here for now. This is
@@ -76,9 +68,9 @@ class Comment < Content
   # actually creates the subtree.
   def self.flatten_subtree(x)
     if x.is_a? Array
-      x.flatten.map{|y| self.flatten_subtree(y)}
+      x.flatten.map { |y| self.flatten_subtree(y) }
     elsif x.is_a? Hash
-      x.to_a.map{|y| self.flatten_subtree(y)}.flatten
+      x.to_a.map { |y| self.flatten_subtree(y) }.flatten
     else
       x
     end
@@ -99,20 +91,20 @@ class Comment < Content
       self.class.hash_tree(subtree_hash).first
     else
       as_document.slice(*%w[body course_id endorsed endorsement anonymous anonymous_to_peers created_at updated_at at_position_list])
-                 .merge("id" => _id)
-                 .merge("user_id" => author_id)
-                 .merge("username" => author_username) 
-                 .merge("depth" => depth)
-                 .merge("closed" => comment_thread.nil? ? false : comment_thread.closed)
-                 .merge("thread_id" => comment_thread_id)
-                 .merge("parent_id" => parent_ids[-1])
-                 .merge("commentable_id" => comment_thread.nil? ? nil : comment_thread.commentable_id)
-                 .merge("votes" => votes.slice(*%w[count up_count down_count point]))
-                 .merge("abuse_flaggers" => abuse_flaggers)
-                 .merge("type" => "comment")
+          .merge('id' => _id)
+          .merge('user_id' => author_id)
+          .merge('username' => author_username)
+          .merge('depth' => depth)
+          .merge('closed' => comment_thread.nil? ? false : comment_thread.closed)
+          .merge('thread_id' => comment_thread_id)
+          .merge('parent_id' => parent_ids[-1])
+          .merge('commentable_id' => comment_thread.nil? ? nil : comment_thread.commentable_id)
+          .merge('votes' => votes.slice(*%w[count up_count down_count point]))
+          .merge('abuse_flaggers' => abuse_flaggers)
+          .merge('type' => 'comment')
     end
   end
-  
+
   def commentable_id
     #we need this to have a universal access point for the flag rake task
     if self.comment_thread_id
@@ -149,16 +141,22 @@ class Comment < Content
   end
 
   def self.by_date_range_and_thread_ids from_when, to_when, thread_ids
-     #return all content between from_when and to_when
+    #return all content between from_when and to_when
 
-     self.where(:created_at.gte => (from_when)).where(:created_at.lte => (to_when)).
-       where(:comment_thread_id.in => thread_ids)
+    self.where(:created_at.gte => (from_when)).where(:created_at.lte => (to_when)).
+        where(:comment_thread_id.in => thread_ids)
   end
-  
-private
+
+  private
 
   def set_thread_last_activity_at
     self.comment_thread.update_attribute(:last_activity_at, Time.now.utc)
   end
 
+  def set_sk
+    # this attribute is explicitly write-once
+    if self.sk.nil?
+      self.sk = (self.parent_ids.dup << self.id).join("-")
+    end
+  end
 end