rails_best_practices 1.19.0 → 1.19.1

data/lib/rails_best_practices/prepares/schema_prepare.rb

@@ -14,7 +14,7 @@ module RailsBestPractices
       end
 
       add_callback :start_command do |node|
-        if "create_table" == node.message.to_s
+        if 'create_table' == node.message.to_s
           @last_klazz = node.arguments.all.first.to_s.classify
         end
       end

data/lib/rails_best_practices/reviews/add_model_virtual_attribute_review.rb

@@ -16,7 +16,7 @@ module RailsBestPractices
     class AddModelVirtualAttributeReview < Review
       interesting_nodes :def
       interesting_files CONTROLLER_FILES
-      url "https://rails-bestpractices.com/posts/2010/07/21/add-model-virtual-attribute/"
+      url 'https://rails-bestpractices.com/posts/2010/07/21/add-model-virtual-attribute/'
 
       # check method define nodes to see if there are some attribute assignments that can use model virtual attribute instead in review process.
       #
@@ -60,7 +60,7 @@ module RailsBestPractices
         # and if the arguments of this attribute assignments has duplicated entries (different message and same arguments),
         # then this node needs to add a virtual attribute.
         def call_assignment(node)
-          if ["save", "save!"].include? node.message.to_s
+          if ['save', 'save!'].include? node.message.to_s
             receiver = node.receiver.to_s
             add_error "add model virtual attribute (for #{receiver})" if params_dup?(assignments(receiver).collect {|h| h[:arguments]})
           end

data/lib/rails_best_practices/reviews/always_add_db_index_review.rb

@@ -25,7 +25,7 @@ module RailsBestPractices
     class AlwaysAddDbIndexReview < Review
       interesting_nodes :command, :command_call
       interesting_files SCHEMA_FILE
-      url "https://rails-bestpractices.com/posts/2010/07/24/always-add-db-index/"
+      url 'https://rails-bestpractices.com/posts/2010/07/24/always-add-db-index/'
 
       def initialize(options={})
         super(options)
@@ -41,7 +41,7 @@ module RailsBestPractices
       add_callback :start_command_call do |node|
         if %w(integer string).include? node.message.to_s
           remember_foreign_key_columns(node)
-        elsif "index" == node.message.to_s
+        elsif 'index' == node.message.to_s
           remember_index_columns_inside_table(node)
         end
       end
@@ -55,9 +55,9 @@ module RailsBestPractices
       # then remember it with _id suffixed column as polymorphic foreign key.
       add_callback :start_command do |node|
         case node.message.to_s
-        when "create_table"
+        when 'create_table'
           remember_table_nodes(node)
-        when "add_index"
+        when 'add_index'
           remember_index_columns_outside_table(node)
         end
       end
@@ -134,7 +134,7 @@ module RailsBestPractices
 
           if foreign_id_column
             index_node = node.arguments.all.last.hash_value('index')
-            if index_node.present? and "false" != index_node.to_s
+            if index_node.present? and 'false' != index_node.to_s
               @index_columns[table_name] ||= []
               @index_columns[table_name] << foreign_id_column
             end
@@ -147,7 +147,7 @@ module RailsBestPractices
             foreign_keys.delete_if do |key|
               if key =~ /_id$/
                 class_name = Prepares.model_associations.get_association_class_name(table, key[0..-4])
-                class_name ? !@table_nodes[class_name.gsub("::", "").tableize] : !@table_nodes[key[0..-4].pluralize]
+                class_name ? !@table_nodes[class_name.gsub('::', '').tableize] : !@table_nodes[key[0..-4].pluralize]
               end
             end
           end
@@ -167,7 +167,7 @@ module RailsBestPractices
             foreign_id_keys = foreign_keys.select { |key| key.size == 1 && key.first =~ /_id/ }
             foreign_type_keys = foreign_keys.select { |key| key.size == 1 && key.first =~ /_type/ }
             foreign_id_keys.each do |id_key|
-              if type_key = foreign_type_keys.detect { |type_key| type_key.first == id_key.first.sub(/_id/, '') + "_type" }
+              if type_key = foreign_type_keys.detect { |type_key| type_key.first == id_key.first.sub(/_id/, '') + '_type' }
                 foreign_keys.delete(id_key)
                 foreign_keys.delete(type_key)
                 foreign_keys << id_key + type_key

data/lib/rails_best_practices/reviews/check_save_return_value_review.rb

@@ -15,7 +15,7 @@ module RailsBestPractices
       include Classable
       interesting_nodes :call, :command_call, :method_add_arg, :if, :ifop, :elsif, :unless, :if_mod, :unless_mod, :assign, :binary
       interesting_files ALL_FILES
-      url "https://rails-bestpractices.com/posts/2012/11/02/check-the-return-value-of-save-otherwise-use-save/"
+      url 'https://rails-bestpractices.com/posts/2012/11/02/check-the-return-value-of-save-otherwise-use-save/'
 
       add_callback :start_if, :start_ifop, :start_elsif, :start_unless, :start_if_mod, :start_unless_mod do |node|
         @used_return_value_of = node.conditional_statement.all_conditions

data/lib/rails_best_practices/reviews/default_scope_is_evil_review.rb

@@ -12,12 +12,12 @@ module RailsBestPractices
     class DefaultScopeIsEvilReview < Review
       interesting_nodes :command
       interesting_files MODEL_FILES
-      url "https://rails-bestpractices.com/posts/2013/06/15/default_scope-is-evil/"
+      url 'https://rails-bestpractices.com/posts/2013/06/15/default_scope-is-evil/'
 
       # check all command nodes' message
       add_callback :start_command do |node|
-        if "default_scope" == node.message.to_s
-          add_error "default_scope is evil"
+        if 'default_scope' == node.message.to_s
+          add_error 'default_scope is evil'
         end
       end
     end

data/lib/rails_best_practices/reviews/dry_bundler_in_capistrano_review.rb

@@ -15,12 +15,12 @@ module RailsBestPractices
     class DryBundlerInCapistranoReview < Review
       interesting_nodes :command
       interesting_files DEPLOY_FILES
-      url "https://rails-bestpractices.com/posts/2010/09/02/dry-bundler-in-capistrano/"
+      url 'https://rails-bestpractices.com/posts/2010/09/02/dry-bundler-in-capistrano/'
 
       # check call node to see if it is with message "namespace" and argument "bundler".
       add_callback :start_command do |node|
-        if "namespace" == node.message.to_s && "bundler" == node.arguments.all[0].to_s
-          add_error "dry bundler in capistrano"
+        if 'namespace' == node.message.to_s && 'bundler' == node.arguments.all[0].to_s
+          add_error 'dry bundler in capistrano'
         end
       end
     end

data/lib/rails_best_practices/reviews/hash_syntax_review.rb

@@ -16,7 +16,7 @@ module RailsBestPractices
       # check hash node to see if it is ruby 1.8 style.
       add_callback :start_hash, :start_bare_assoc_hash do |node|
         if !empty_hash?(node) && hash_is_18?(node) && valid_keys?(node)
-          add_error "change Hash Syntax to 1.9"
+          add_error 'change Hash Syntax to 1.9'
         end
       end
 

data/lib/rails_best_practices/reviews/isolate_seed_data_review.rb

@@ -21,7 +21,7 @@ module RailsBestPractices
     class IsolateSeedDataReview < Review
       interesting_nodes :call, :assign
       interesting_files MIGRATION_FILES
-      url "https://rails-bestpractices.com/posts/2010/07/24/isolating-seed-data/"
+      url 'https://rails-bestpractices.com/posts/2010/07/24/isolating-seed-data/'
 
       def initialize(options={})
         super(options)
@@ -45,10 +45,10 @@ module RailsBestPractices
       # and the receiver of the call node is included in @new_variables,
       # then you should isolate it to seed data.
       add_callback :start_call do |node|
-        if ["create", "create!"].include? node.message.to_s
-          add_error("isolate seed data")
-        elsif ["save", "save!"].include? node.message.to_s
-          add_error("isolate seed data") if new_record?(node)
+        if ['create', 'create!'].include? node.message.to_s
+          add_error('isolate seed data')
+        elsif ['save', 'save!'].include? node.message.to_s
+          add_error('isolate seed data') if new_record?(node)
         end
       end
 
@@ -59,7 +59,7 @@ module RailsBestPractices
         # then remember the left value as new variable.
         def remember_new_variable(node)
           right_value = node.right_value
-          if :method_add_arg == right_value.sexp_type && "new" == right_value.message.to_s
+          if :method_add_arg == right_value.sexp_type && 'new' == right_value.message.to_s
             @new_variables << node.left_value.to_s
           end
         end

data/lib/rails_best_practices/reviews/keep_finders_on_their_own_model_review.rb

@@ -17,7 +17,7 @@ module RailsBestPractices
     class KeepFindersOnTheirOwnModelReview < Review
       interesting_nodes :method_add_arg
       interesting_files MODEL_FILES
-      url "https://rails-bestpractices.com/posts/2010/07/23/keep-finders-on-their-own-model/"
+      url 'https://rails-bestpractices.com/posts/2010/07/23/keep-finders-on-their-own-model/'
 
       FINDERS = %w(find all first last)
 
@@ -31,7 +31,7 @@ module RailsBestPractices
       #
       # then it should keep finders on its own model.
       add_callback :start_method_add_arg do |node|
-        add_error "keep finders on their own model" if other_finder?(node)
+        add_error 'keep finders on their own model' if other_finder?(node)
       end
 
       private

data/lib/rails_best_practices/reviews/law_of_demeter_review.rb

@@ -16,7 +16,7 @@ module RailsBestPractices
     class LawOfDemeterReview < Review
       interesting_nodes :call
       interesting_files ALL_FILES
-      url "https://rails-bestpractices.com/posts/2010/07/24/the-law-of-demeter/"
+      url 'https://rails-bestpractices.com/posts/2010/07/24/the-law-of-demeter/'
 
       ASSOCIATION_METHODS = %w(belongs_to has_one)
 
@@ -28,7 +28,7 @@ module RailsBestPractices
       # then it violates the law of demeter.
       add_callback :start_call do |node|
         if :call == node.receiver.sexp_type && need_delegate?(node)
-          add_error "law of demeter"
+          add_error 'law of demeter'
         end
       end
 
@@ -45,8 +45,8 @@ module RailsBestPractices
           association_name = node.receiver.message.to_s
           association = model_associations.get_association(class_name, association_name)
           attribute_name = node.message.to_s
-          association && ASSOCIATION_METHODS.include?(association["meta"]) &&
-            is_association_attribute?(association["class_name"], association_name, attribute_name)
+          association && ASSOCIATION_METHODS.include?(association['meta']) &&
+            is_association_attribute?(association['class_name'], association_name, attribute_name)
         end
 
         def is_association_attribute?(association_class, association_name, attribute_name)

data/lib/rails_best_practices/reviews/move_code_into_controller_review.rb

@@ -12,7 +12,7 @@ module RailsBestPractices
     class MoveCodeIntoControllerReview < Review
       interesting_nodes :method_add_arg, :assign
       interesting_files VIEW_FILES
-      url "https://rails-bestpractices.com/posts/2010/07/24/move-code-into-controller/"
+      url 'https://rails-bestpractices.com/posts/2010/07/24/move-code-into-controller/'
 
       FINDERS = %w(find all first last)
 
@@ -22,7 +22,7 @@ module RailsBestPractices
       # and the message of the method_add_arg node is one of the find, all, first and last,
       # then it is a finder and should be moved to controller.
       add_callback :start_method_add_arg do |node|
-        add_error "move code into controller" if finder?(node)
+        add_error 'move code into controller' if finder?(node)
       end
 
       # check assign nodes.
@@ -31,7 +31,7 @@ module RailsBestPractices
       # and the message of the right value node is one of the find, all, first and last,
       # then it is a finder and should be moved to controller.
       add_callback :start_assign do |node|
-        add_error "move code into controller", node.file, node.right_value.line_number if finder?(node.right_value)
+        add_error 'move code into controller', node.file, node.right_value.line_number if finder?(node.right_value)
       end
 
       private

data/lib/rails_best_practices/reviews/move_code_into_helper_review.rb

@@ -19,7 +19,7 @@ module RailsBestPractices
     class MoveCodeIntoHelperReview < Review
       interesting_nodes :method_add_arg
       interesting_files VIEW_FILES
-      url "https://rails-bestpractices.com/posts/2010/07/24/move-code-into-helper/"
+      url 'https://rails-bestpractices.com/posts/2010/07/24/move-code-into-helper/'
 
       def initialize(options = {})
         super(options)
@@ -43,7 +43,7 @@ module RailsBestPractices
         # and the size of array is greater than @array_count you defined,
         # then it is complext.
         def complex_select_options?(node)
-          "options_for_select" == node[1].message.to_s &&
+          'options_for_select' == node[1].message.to_s &&
             :array == node.arguments.all.first.sexp_type &&
             node.arguments.all.first.array_size > @array_count
         end

data/lib/rails_best_practices/reviews/move_code_into_model_review.rb

@@ -13,7 +13,7 @@ module RailsBestPractices
     class MoveCodeIntoModelReview < Review
       interesting_nodes :if, :unless, :elsif, :ifop, :if_mod, :unless_mod
       interesting_files VIEW_FILES
-      url "https://rails-bestpractices.com/posts/2010/07/24/move-code-into-model/"
+      url 'https://rails-bestpractices.com/posts/2010/07/24/move-code-into-model/'
 
       def initialize(options={})
         super(options)

data/lib/rails_best_practices/reviews/move_finder_to_named_scope_review.rb

@@ -15,7 +15,7 @@ module RailsBestPractices
     class MoveFinderToNamedScopeReview < Review
       interesting_nodes :method_add_arg
       interesting_files CONTROLLER_FILES
-      url "https://rails-bestpractices.com/posts/2010/07/14/move-finder-to-named_scope/"
+      url 'https://rails-bestpractices.com/posts/2010/07/14/move-finder-to-named_scope/'
 
       FINDERS = %w(find all first last)
 
@@ -23,7 +23,7 @@ module RailsBestPractices
       # and it has a hash argument,
       # then the call node is the finder that should be moved to model's named_scope.
       add_callback :start_method_add_arg do |node|
-        add_error "move finder to named_scope" if finder?(node)
+        add_error 'move finder to named_scope' if finder?(node)
       end
 
       private

data/lib/rails_best_practices/reviews/move_model_logic_into_model_review.rb

@@ -15,7 +15,7 @@ module RailsBestPractices
     class MoveModelLogicIntoModelReview < Review
       interesting_nodes :def
       interesting_files CONTROLLER_FILES
-      url "https://rails-bestpractices.com/posts/2010/07/21/move-model-logic-into-the-model/"
+      url 'https://rails-bestpractices.com/posts/2010/07/21/move-model-logic-into-the-model/'
 
       def initialize(options = {})
         super(options)

data/lib/rails_best_practices/reviews/needless_deep_nesting_review.rb

@@ -24,7 +24,7 @@ module RailsBestPractices
     class NeedlessDeepNestingReview < Review
       interesting_nodes :method_add_block
       interesting_files ROUTE_FILES
-      url "https://rails-bestpractices.com/posts/2010/07/22/needless-deep-nesting/"
+      url 'https://rails-bestpractices.com/posts/2010/07/22/needless-deep-nesting/'
 
       def initialize(options = {})
         super(options)
@@ -61,16 +61,16 @@ module RailsBestPractices
         # if so, it is the needless deep nesting.
         def recursively_check(node)
           shallow = @shallow_nodes.include? node
-          if [:command_call, :command].include?(node[1].sexp_type) && ["resources", "resource"].include?(node[1].message.to_s)
+          if [:command_call, :command].include?(node[1].sexp_type) && ['resources', 'resource'].include?(node[1].message.to_s)
             hash_node = node[1].arguments.grep_node(sexp_type: :bare_assoc_hash)
-            shallow = (hash_node && "true" == hash_node.hash_value("shallow").to_s) unless shallow
+            shallow = (hash_node && 'true' == hash_node.hash_value('shallow').to_s) unless shallow
             @counter += 1
             node.block_node.statements.each do |stmt_node|
               @shallow_nodes << stmt_node if shallow
               recursively_check(stmt_node)
             end
             @counter -= 1
-          elsif [:command_call, :command].include?(node.sexp_type) && ["resources", "resource"].include?(node.message.to_s)
+          elsif [:command_call, :command].include?(node.sexp_type) && ['resources', 'resource'].include?(node.message.to_s)
             add_error "needless deep nesting (nested_count > #{@nested_count})", @file, node.line_number if @counter >= @nested_count && !@shallow_nodes.include?(node)
           end
         end

data/lib/rails_best_practices/reviews/not_rescue_exception_review.rb

@@ -13,11 +13,11 @@ module RailsBestPractices
     class NotRescueExceptionReview < Review
       interesting_nodes :rescue
       interesting_files ALL_FILES
-      url "https://rails-bestpractices.com/posts/2012/11/01/don-t-rescue-exception-rescue-standarderror/"
+      url 'https://rails-bestpractices.com/posts/2012/11/01/don-t-rescue-exception-rescue-standarderror/'
 
       # check rescue node to see if its type is Exception
       add_callback :start_rescue do |rescue_node|
-        if rescue_node.exception_classes.any? { |rescue_class| "Exception" == rescue_class.to_s }
+        if rescue_node.exception_classes.any? { |rescue_class| 'Exception' == rescue_class.to_s }
           add_error "Don't rescue Exception", rescue_node.file, rescue_node.exception_classes.first.line_number
         end
       end

data/lib/rails_best_practices/reviews/not_use_default_route_review.rb

@@ -19,13 +19,13 @@ module RailsBestPractices
     class NotUseDefaultRouteReview < Review
       interesting_nodes :command_call, :command
       interesting_files ROUTE_FILES
-      url "https://rails-bestpractices.com/posts/2010/07/22/not-use-default-route-if-you-use-restful-design/"
+      url 'https://rails-bestpractices.com/posts/2010/07/22/not-use-default-route-if-you-use-restful-design/'
 
       # check all command nodes
       add_callback :start_command do |node|
-        if "match" == node.message.to_s &&
-          ":controller(/:action(/:id(.:format)))" == node.arguments.all.first.to_s
-          add_error "not use default route"
+        if 'match' == node.message.to_s &&
+          ':controller(/:action(/:id(.:format)))' == node.arguments.all.first.to_s
+          add_error 'not use default route'
         end
       end
     end

data/lib/rails_best_practices/reviews/not_use_time_ago_in_words_review.rb

@@ -12,12 +12,12 @@ module RailsBestPractices
     class NotUseTimeAgoInWordsReview < Review
       interesting_nodes :fcall
       interesting_files VIEW_FILES, HELPER_FILES
-      url "https://rails-bestpractices.com/posts/2012/02/10/not-use-time_ago_in_words/"
+      url 'https://rails-bestpractices.com/posts/2012/02/10/not-use-time_ago_in_words/'
 
       # check fcall node to see if its message is time_ago_in_words or distance_of_time_in_words_to_now
       add_callback :start_fcall do |node|
-        if "time_ago_in_words" == node.message.to_s || "distance_of_time_in_words_to_now" == node.message.to_s
-          add_error "not use time_ago_in_words"
+        if 'time_ago_in_words' == node.message.to_s || 'distance_of_time_in_words_to_now' == node.message.to_s
+          add_error 'not use time_ago_in_words'
         end
       end
     end

data/lib/rails_best_practices/reviews/overuse_route_customizations_review.rb

@@ -17,7 +17,7 @@ module RailsBestPractices
     class OveruseRouteCustomizationsReview < Review
       interesting_nodes :command_call, :method_add_block
       interesting_files ROUTE_FILES
-      url "https://rails-bestpractices.com/posts/2010/07/22/overuse-route-customizations/"
+      url 'https://rails-bestpractices.com/posts/2010/07/22/overuse-route-customizations/'
 
       VERBS = %w(get post update delete)
 
@@ -46,7 +46,7 @@ module RailsBestPractices
         # then calculate the count of call nodes, whose message is get, post, update or delete,
         # it is just the count of member and collection custom routes.
         def member_and_collection_count_for_rails3(node)
-          "resources" == node[1].message.to_s ? node.grep_nodes_count(sexp_type: :command, message: VERBS) : 0
+          'resources' == node[1].message.to_s ? node.grep_nodes_count(sexp_type: :command, message: VERBS) : 0
         end
     end
   end

data/lib/rails_best_practices/reviews/protect_mass_assignment_review.rb

@@ -13,7 +13,7 @@ module RailsBestPractices
     class ProtectMassAssignmentReview < Review
       interesting_files MODEL_FILES
       interesting_nodes :class, :command, :var_ref, :vcall, :fcall
-      url "https://rails-bestpractices.com/posts/2012/03/06/protect-mass-assignment/"
+      url 'https://rails-bestpractices.com/posts/2012/03/06/protect-mass-assignment/'
 
       # we treat it as mass assignment by default.
       add_callback :start_class do |node|
@@ -28,7 +28,7 @@ module RailsBestPractices
       add_callback :end_class do |node|
         check_active_record(node)
 
-        add_error "protect mass assignment" if @mass_assignement
+        add_error 'protect mass assignment' if @mass_assignement
       end
 
       # check if it is attr_accessible or attr_protected command,
@@ -54,19 +54,19 @@ module RailsBestPractices
       private
 
         def check_activerecord_version
-          if Prepares.gems.gem_version("activerecord").to_i > 3
+          if Prepares.gems.gem_version('activerecord').to_i > 3
             @mass_assignement = false
           end
         end
 
         def check_whitelist_attributes_config
-          if "true" == Prepares.configs["config.active_record.whitelist_attributes"]
+          if 'true' == Prepares.configs['config.active_record.whitelist_attributes']
             @whitelist_attributes = true
           end
         end
 
         def check_include_forbidden_attributes_protection_config
-          if "true" == Prepares.configs["railsbp.include_forbidden_attributes_protection"]
+          if 'true' == Prepares.configs['railsbp.include_forbidden_attributes_protection']
             @mass_assignement = false
           end
         end
@@ -78,25 +78,25 @@ module RailsBestPractices
         end
 
         def check_strong_parameters(command_node)
-          if "include" == command_node.message.to_s && "ActiveModel::ForbiddenAttributesProtection" == command_node.arguments.all.first.to_s
+          if 'include' == command_node.message.to_s && 'ActiveModel::ForbiddenAttributesProtection' == command_node.arguments.all.first.to_s
             @mass_assignement = false
           end
         end
 
         def check_devise(command_node)
-          if "devise" == command_node.message.to_s
+          if 'devise' == command_node.message.to_s
             @mass_assignement = false
           end
         end
 
         def check_authlogic(node)
-          if [node.to_s, node.message.to_s].include? "acts_as_authentic"
+          if [node.to_s, node.message.to_s].include? 'acts_as_authentic'
             @mass_assignement = false
           end
         end
 
         def check_active_record(const_path_ref_node)
-          if "ActiveRecord::Base" != const_path_ref_node.base_class.to_s
+          if 'ActiveRecord::Base' != const_path_ref_node.base_class.to_s
             @mass_assignement = false
           end
         end