Run Rubocop to do some style cleanup and consolidation

Author: petergoldstein

Gemfile

@@ -3,6 +3,6 @@ source 'https://rubygems.org'
 gemspec
 
 group :development do
-  gem 'activerecord-jdbcsqlite3-adapter', :platforms => :jruby
-  gem 'sqlite3', :platforms => :ruby
+  gem 'activerecord-jdbcsqlite3-adapter', platforms: :jruby
+  gem 'sqlite3', platforms: :ruby
 end

Rakefile

@@ -3,12 +3,12 @@ Bundler::GemHelper.install_tasks
 
 require 'rspec/core/rake_task'
 
-desc "Run specs"
+desc 'Run specs'
 RSpec::Core::RakeTask.new(:spec)
 
-task :install => [:package] do
-  sh %{sudo gem install pkg/#{NAME}-#{GEM_VERSION}}
+task install: [:package] do
+  sh %(sudo gem install pkg/#{NAME}-#{GEM_VERSION})
 end
 
 desc 'Default: run specs.'
-task :default => :spec
+task default: :spec

acts_as_commentable_with_threading.gemspec

@@ -1,12 +1,12 @@
 Gem::Specification.new do |s|
-  s.name     = "acts_as_commentable_with_threading"
-  s.version  = "2.0.1"
-  s.date     = "2015-12-22"
-  s.summary  = "Polymorphic comments Rails gem - Rails 4+ only"
-  s.email    = "[email protected]"
-  s.homepage = "http://github.com/elight/acts_as_commentable_with_threading"
-  s.description = "Polymorphic threaded comments Rails gem for Rails 4+"
-  s.authors  = ["Evan Light", "Jack Dempsey", "Xelipe", "xxx"]
+  s.name     = 'acts_as_commentable_with_threading'
+  s.version  = '2.0.1'
+  s.date     = '2015-12-22'
+  s.summary  = 'Polymorphic comments Rails gem - Rails 4+ only'
+  s.email    = '[email protected]'
+  s.homepage = 'http://github.com/elight/acts_as_commentable_with_threading'
+  s.description = 'Polymorphic threaded comments Rails gem for Rails 4+'
+  s.authors  = ['Evan Light', 'Jack Dempsey', 'Xelipe', 'xxx']
   s.files    = `git ls-files`.split("\n")
   s.test_files = `git ls-files -- spec/*`.split("\n")
 

lib/acts_as_commentable_with_threading.rb

@@ -12,53 +12,55 @@
 # ActsAsCommentableWithThreading
 module Acts #:nodoc:
   module CommentableWithThreading #:nodoc:
-  extend ActiveSupport::Concern
+    extend ActiveSupport::Concern
 
-  module ClassMethods
-    def acts_as_commentable
-      has_many :comment_threads, :class_name => "Comment", :as => :commentable
-      before_destroy { |record| record.root_comments.destroy_all }
-      include Acts::CommentableWithThreading::LocalInstanceMethods
-      extend Acts::CommentableWithThreading::SingletonMethods
+    module ClassMethods
+      def acts_as_commentable
+        has_many :comment_threads, class_name: 'Comment', as: :commentable
+        before_destroy { |record| record.root_comments.destroy_all }
+        include Acts::CommentableWithThreading::LocalInstanceMethods
+        extend Acts::CommentableWithThreading::SingletonMethods
+      end
     end
-  end
 
-  # This module contains class methods
-  module SingletonMethods
-    # Helper method to lookup for comments for a given object.
-    # This method is equivalent to obj.comments.
-    def find_comments_for(obj)
-      Comment.where(:commentable_id => obj.id, :commentable_type => obj.class.base_class.name).order('created_at DESC')
-    end
+    # This module contains class methods
+    module SingletonMethods
+      # Helper method to lookup for comments for a given object.
+      # This method is equivalent to obj.comments.
+      def find_comments_for(obj)
+        Comment.where(commentable_id: obj.id,
+                      commentable_type: obj.class.base_class.name)
+          .order('created_at DESC')
+      end
 
-    # Helper class method to lookup comments for
-    # the mixin commentable type written by a given user.
-    # This method is NOT equivalent to Comment.find_comments_for_user
-    def find_comments_by_user(user)
-      commentable = self.base_class.name.to_s
-      Comment.where(:user_id => user.id, :commentable_type => commentable).order('created_at DESC')
+      # Helper class method to lookup comments for
+      # the mixin commentable type written by a given user.
+      # This method is NOT equivalent to Comment.find_comments_for_user
+      def find_comments_by_user(user)
+        commentable = base_class.name.to_s
+        Comment.where(user_id: user.id, commentable_type: commentable)
+          .order('created_at DESC')
+      end
     end
-  end
-
-  module LocalInstanceMethods
 
-    # Helper method to display only root threads, no children/replies
-    def root_comments
-      self.comment_threads.where(:parent_id => nil)
-    end
+    module LocalInstanceMethods
+      # Helper method to display only root threads, no children/replies
+      def root_comments
+        comment_threads.where(parent_id: nil)
+      end
 
-    # Helper method to sort comments by date
-    def comments_ordered_by_submitted
-      Comment.where(:commentable_id => id, :commentable_type => self.class.name).order('created_at DESC')
-    end
+      # Helper method to sort comments by date
+      def comments_ordered_by_submitted
+        Comment.where(commentable_id: id, commentable_type: self.class.name)
+          .order('created_at DESC')
+      end
 
-    # Helper method that defaults the submitted time.
-    def add_comment(comment)
-      comments << comment
+      # Helper method that defaults the submitted time.
+      def add_comment(comment)
+        comments << comment
+      end
     end
   end
-
-  end
 end
 
 ActiveRecord::Base.send(:include, Acts::CommentableWithThreading)

lib/generators/acts_as_commentable_upgrade_migration/acts_as_commentable_upgrade_migration_generator.rb

@@ -1,19 +1,21 @@
 class ActsAsCommentableUpgradeMigrationGenerator < Rails::Generators::Base
   include Rails::Generators::Migration
-  
+
   source_root File.expand_path('../templates', __FILE__)
-  
-  # *for the life of me*, i can't figure out why this isn't implemented elsewhere.
+
+  # *for the life of me*, i can't figure out why this isn't
+  # implemented elsewhere.
   def self.next_migration_number(dirname)
     if ActiveRecord::Base.timestamped_migrations
-      Time.now.utc.strftime("%Y%m%d%H%M%S")
+      Time.now.utc.strftime('%Y%m%d%H%M%S')
     else
-      "%.3d" % (current_migration_number(dirname) + 1)
+      format('%.3d', (current_migration_number(dirname) + 1))
     end
   end
 
   def manifest
-    migration_template 'migration.rb', 'db/migrate/acts_as_commentable_upgrade_migration.rb'
+    migration_template 'migration.rb',
+                       'db/migrate/acts_as_commentable_upgrade_migration.rb'
     copy_file 'comment.rb', 'app/models/comment.rb'
   end
 end

lib/generators/acts_as_commentable_upgrade_migration/comment.rb

@@ -1,14 +1,14 @@
 class Comment < ActiveRecord::Base
-  acts_as_nested_set :scope => [:commentable_id, :commentable_type]
+  acts_as_nested_set scope: [:commentable_id, :commentable_type]
 
-  validates :body, :presence => true
-  validates :user, :presence => true
+  validates :body, presence: true
+  validates :user, presence: true
 
   # NOTE: install the acts_as_votable plugin if you
   # want user to vote on the quality of comments.
-  #acts_as_votable
+  # acts_as_votable
 
-  belongs_to :commentable, :polymorphic => true
+  belongs_to :commentable, polymorphic: true
 
   # NOTE: Comments belong to a user
   belongs_to :user
@@ -18,26 +18,27 @@ class Comment < ActiveRecord::Base
   # example in readme
   def self.build_from(obj, user_id, comment)
     new \
-      :commentable => obj,
-      :body        => comment,
-      :user_id     => user_id
+      commentable: obj,
+      body: comment,
+      user_id: user_id
   end
 
-  #helper method to check if a comment has children
+  # helper method to check if a comment has children
   def has_children?
-    self.children.size > 0
+    children.size > 0
   end
 
   # Helper class method to lookup all comments assigned
   # to all commentable types for a given user.
   scope :find_comments_by_user, lambda { |user|
-    where(:user_id => user.id).order('created_at DESC')
+    where(user_id: user.id).order('created_at DESC')
   }
 
   # Helper class method to look up all comments for
   # commentable class name and commentable id.
-  scope :find_comments_for_commentable, lambda { |commentable_str, commentable_id|
-    where(:commentable_type => commentable_str.to_s, :commentable_id => commentable_id).order('created_at DESC')
+  scope :find_comments_for_commentable, lambda { |type, id|
+    where(commentable_type: type.to_s,
+          commentable_id: id).order('created_at DESC')
   }
 
   # Helper class method to look up a commentable object

lib/generators/acts_as_commentable_upgrade_migration/templates/migration.rb

@@ -6,18 +6,18 @@ def self.up
     add_column :comments, :lft, :integer
     add_column :comments, :rgt, :integer
     add_column :comments, :updated_at, :datetime
-    
+
     add_index :comments, :commentable_id
   end
-  
+
   def self.down
     rename_column :comments, :body, :comment
     remove_column :comments, :subject
     remove_column :comments, :parent_id
     remove_column :comments, :lft
     remove_column :comments, :rgt
     remove_column :comments, :updated_at
-    
+
     remove_index :comments, :commentable_id
   end
 end

lib/generators/acts_as_commentable_with_threading_migration/acts_as_commentable_with_threading_migration_generator.rb

@@ -1,19 +1,20 @@
 class ActsAsCommentableWithThreadingMigrationGenerator < Rails::Generators::Base
   include Rails::Generators::Migration
-  
+
   source_root File.expand_path('../templates', __FILE__)
-  
+
   # Complete wtf that this isn't provided elsewhere.
   def self.next_migration_number(dirname)
     if ActiveRecord::Base.timestamped_migrations
-      Time.now.utc.strftime("%Y%m%d%H%M%S")
+      Time.now.utc.strftime('%Y%m%d%H%M%S')
     else
-      "%.3d" % (current_migration_number(dirname) + 1)
+      format('%.3d', (current_migration_number(dirname) + 1))
     end
   end
 
   def manifest
-    migration_template 'migration.rb', 'db/migrate/acts_as_commentable_with_threading_migration.rb'
+    migration_template 'migration.rb',
+                       'db/migrate/acts_as_commentable_with_threading_migration.rb'
     copy_file 'comment.rb', 'app/models/comment.rb'
   end
 end

lib/generators/acts_as_commentable_with_threading_migration/templates/comment.rb

@@ -1,14 +1,14 @@
 class Comment < ActiveRecord::Base
-  acts_as_nested_set :scope => [:commentable_id, :commentable_type]
+  acts_as_nested_set scope: [:commentable_id, :commentable_type]
 
-  validates :body, :presence => true
-  validates :user, :presence => true
+  validates :body, presence: true
+  validates :user, presence: true
 
   # NOTE: install the acts_as_votable plugin if you
   # want user to vote on the quality of comments.
-  #acts_as_votable
+  # acts_as_votable
 
-  belongs_to :commentable, :polymorphic => true
+  belongs_to :commentable, polymorphic: true
 
   # NOTE: Comments belong to a user
   belongs_to :user
@@ -18,26 +18,27 @@ class Comment < ActiveRecord::Base
   # example in readme
   def self.build_from(obj, user_id, comment)
     new \
-      :commentable => obj,
-      :body        => comment,
-      :user_id     => user_id
+      commentable: obj,
+      body: comment,
+      user_id: user_id
   end
 
-  #helper method to check if a comment has children
+  # helper method to check if a comment has children
   def has_children?
-    self.children.any?
+    children.any?
   end
 
   # Helper class method to lookup all comments assigned
   # to all commentable types for a given user.
   scope :find_comments_by_user, lambda { |user|
-    where(:user_id => user.id).order('created_at DESC')
+    where(user_id: user.id).order('created_at DESC')
   }
 
   # Helper class method to look up all comments for
   # commentable class name and commentable id.
-  scope :find_comments_for_commentable, lambda { |commentable_str, commentable_id|
-    where(:commentable_type => commentable_str.to_s, :commentable_id => commentable_id).order('created_at DESC')
+  scope :find_comments_for_commentable, lambda { |type, id|
+    where(commentable_type: type.to_s, commentable_id: id)
+      .order('created_at DESC')
   }
 
   # Helper class method to look up a commentable object

lib/generators/acts_as_commentable_with_threading_migration/templates/migration.rb

@@ -1,12 +1,12 @@
 class ActsAsCommentableWithThreadingMigration < ActiveRecord::Migration
   def self.up
-    create_table :comments, :force => true do |t|
+    create_table :comments, force: true do |t|
       t.integer :commentable_id
       t.string :commentable_type
       t.string :title
       t.text :body
       t.string :subject
-      t.integer :user_id, :null => false
+      t.integer :user_id, null: false
       t.integer :parent_id, :lft, :rgt
       t.timestamps
     end