rails_best_practices 1.16.0 → 1.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6148fbef051b64b71999a14775871a94ed3bd984
-  data.tar.gz: 62ec9d8506b481f0a1ae715e9524f0bffdf00590
+  metadata.gz: c0b67ef3e8abe665b14bf2dd398755f5b1d84e05
+  data.tar.gz: 4ea8cfbcb9a26b10b070e86b2deac14e2f9ea751
 SHA512:
-  metadata.gz: b3252c4c6a5a54919b419965d77e4baf7d68c7bfe21142ad09586ff333502211e7da1df85e15eb01a911c2ee96302255476658977251fc2aeeb08ab19aa27984
-  data.tar.gz: b0c595abc0835de3d4afad189d7531ed9807c261405d2a8d911c018562cbb8df8b1a69027a60df3dc6d22f073cdf86e6fc6abe00ce44381411ffffe766b972b9
+  metadata.gz: c032c3904c6f27437c7b8be4a728c74ab543d6f14d1c2d620d8dac8dda029de46aa15f52c31b86d07e45dee2544f7165d991c7dc652731c7227e76970574eefe
+  data.tar.gz: dada2172b41c479b90ec443f8a99a9a04bf68833ceea23b5f39ba5e9c572b8686797079c1c15eead93c2a7ea066fe40970f4257342055215574b804e6049e0a9

data/.travis.yml

@@ -2,7 +2,4 @@ sudo: false
 language: ruby
 cache: bundler
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1
-  - 2.2
+  - 2.3.0

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Next Release
 
+## 1.17.0 (2016-07-14)
+
+* Detect index option in column creation
+* Check against activerecord not rails
+* Optimize methods of Klass for performance
+
 ## 1.16.0 (2016-02-22)
 
 * Add check destroy return value review

data/lib/rails_best_practices/analyzer.rb

@@ -145,7 +145,6 @@ module RailsBestPractices
       }.flatten
     end
 
-
     # sort files, models first, mailers, helpers, and then sort other files by characters.
     #
     # models and mailers first as for prepare process.

data/lib/rails_best_practices/core/check.rb

@@ -130,7 +130,8 @@ module RailsBestPractices
 
             # remember the class name
             add_callback :start_class do |node|
-              @klass = Core::Klass.new(node.class_name.to_s, node.base_class.to_s, classable_modules)
+              base_class_name = node.base_class.is_a?(CodeAnalyzer::Nil) ? nil : node.base_class.to_s
+              @klass = Core::Klass.new(node.class_name.to_s, base_class_name, classable_modules)
               klasses << @klass
             end
 

data/lib/rails_best_practices/core/checks_loader.rb

@@ -17,6 +17,7 @@ module RailsBestPractices
       end
 
       private
+
         # read the checks from yaml config.
         def checks_from_config
           @checks ||= YAML.load_file @config

data/lib/rails_best_practices/core/klasses.rb

@@ -14,19 +14,14 @@ module RailsBestPractices
 
     # Class info includes class name, extend class name and module names.
     class Klass
+      attr_reader :extend_class_name, :class_name
+
       def initialize(class_name, extend_class_name, modules)
-        @class_name = class_name
-        @extend_class_name = extend_class_name
         @modules = modules.dup
-      end
-
-      def class_name
-        @modules.map { |modu| "#{modu}::" }.join("") + @class_name
-      end
-
-      def extend_class_name
-        if @extend_class_name.present?
-          @modules.map { |modu| "#{modu}::" }.join("") + @extend_class_name
+        base = @modules.map { |modu| "#{modu}::" }.join("")
+        @class_name =  base + class_name
+        if extend_class_name
+          @extend_class_name = base + extend_class_name
         end
       end
 

data/lib/rails_best_practices/core/methods.rb

@@ -132,6 +132,7 @@ module RailsBestPractices
       end
 
       private
+
         # Methods of a class.
         #
         # @param [String] class name

data/lib/rails_best_practices/core/runner.rb

@@ -103,6 +103,7 @@ module RailsBestPractices
       end
 
       private
+
         # parse html template code, erb, haml and slim.
         #
         # @param [String] filename is the filename of the erb, haml or slim code.

data/lib/rails_best_practices/prepares/model_prepare.rb

@@ -121,6 +121,7 @@ module RailsBestPractices
       end
 
       private
+
         # remember associations, with class to association names.
         def remember_association(node)
           association_meta = node.message.to_s

data/lib/rails_best_practices/reviews/add_model_virtual_attribute_review.rb

@@ -42,6 +42,7 @@ module RailsBestPractices
       end
 
       private
+
         # check an attribute assignment node, if there is a array reference node in the right value of assignment node,
         # then remember this attribute assignment.
         def assign(node)

data/lib/rails_best_practices/reviews/always_add_db_index_review.rb

@@ -10,8 +10,9 @@ module RailsBestPractices
     # Review process:
     #   only check the command and command_calls nodes and at the end of review process,
     #   if the receiver of command node is "create_table", then remember the table names
-    #   if the receiver of command_call node is "integer" and suffix with id, then remember it as foreign key
-    #   if the sujbect of command_call node is "string", the name of it is _type suffixed and there is an integer column _id suffixed, then remember it as polymorphic foreign key
+    #   if the receiver of command_call node is "integer" or "string" and suffix with _id, then remember it as foreign key
+    #   if the receiver of command_call node is "string", the name of it is _type suffixed and there is an integer or string column _id suffixed, then remember it as polymorphic foreign key
+    #   if the receiver of command_call node is remembered as foreign key and it have argument non-false "index", then remember the index columns
     #   if the receiver of command node is "add_index", then remember the index columns
     #   after all of these, at the end of review process
     #
@@ -81,6 +82,7 @@ module RailsBestPractices
       end
 
       private
+
         # remember the node as index columns, when used outside a table
         # block, i.e.
         #   add_index :table_name, :column_name
@@ -109,7 +111,6 @@ module RailsBestPractices
           @table_nodes[@table_name] = node
         end
 
-
         # remember foreign key columns
         def remember_foreign_key_columns(node)
           table_name = @table_name
@@ -121,12 +122,22 @@ module RailsBestPractices
             else
               @foreign_keys[table_name] << foreign_key_column
             end
+            foreign_id_column = foreign_key_column
           elsif foreign_key_column =~ /(.*?)_type$/
             if @foreign_keys[table_name].delete("#{$1}_id")
               @foreign_keys[table_name] << ["#{$1}_id", "#{$1}_type"]
             else
               @foreign_keys[table_name] << foreign_key_column
             end
+            foreign_id_column = "#{$1}_id"
+          end
+
+          if foreign_id_column
+            index_node = node.arguments.all.last.hash_value('index')
+            if index_node.present? and "false" != index_node.to_s
+              @index_columns[table_name] ||= []
+              @index_columns[table_name] << foreign_id_column
+            end
           end
         end
 

data/lib/rails_best_practices/reviews/hash_syntax_review.rb

@@ -21,6 +21,7 @@ module RailsBestPractices
       end
 
       protected
+
         # check if hash node is empty.
         def empty_hash?(node)
           s(:hash, nil) == node || s(:bare_assoc_hash, nil) == node

data/lib/rails_best_practices/reviews/isolate_seed_data_review.rb

@@ -53,6 +53,7 @@ module RailsBestPractices
       end
 
       private
+
         # check assignment node,
         # if the right vavlue is a method_add_arg node with message "new",
         # then remember the left value as new variable.

data/lib/rails_best_practices/reviews/keep_finders_on_their_own_model_review.rb

@@ -35,6 +35,7 @@ module RailsBestPractices
       end
 
       private
+
         # check if the call node is the finder of other model.
         #
         # the message of the node should be one of find, all, first or last,

data/lib/rails_best_practices/reviews/law_of_demeter_review.rb

@@ -33,6 +33,7 @@ module RailsBestPractices
       end
 
       private
+
         # check if the call node can use delegate to avoid violating law of demeter.
         #
         # if the receiver of receiver of the call node matchs any in model names,

data/lib/rails_best_practices/reviews/move_code_into_controller_review.rb

@@ -35,6 +35,7 @@ module RailsBestPractices
       end
 
       private
+
         # check if the node is a finder call node.
         def finder?(node)
           node.receiver.const? && FINDERS.include?(node.message.to_s)

data/lib/rails_best_practices/reviews/move_code_into_helper_review.rb

@@ -36,6 +36,7 @@ module RailsBestPractices
       end
 
       private
+
         # check if the arguments of options_for_select are complex.
         #
         # if the first argument is an array,

data/lib/rails_best_practices/reviews/move_finder_to_named_scope_review.rb

@@ -27,6 +27,7 @@ module RailsBestPractices
       end
 
       private
+
         # check if the method_add_arg node is a finder.
         #
         # if the receiver of method_add_arg node is a constant,

data/lib/rails_best_practices/reviews/needless_deep_nesting_review.rb

@@ -49,6 +49,7 @@ module RailsBestPractices
       end
 
       private
+
         # check nested route.
         #
         # if the receiver of the method_add_block is with message "resources" or "resource",

data/lib/rails_best_practices/reviews/overuse_route_customizations_review.rb

@@ -64,6 +64,7 @@ module RailsBestPractices
       end
 
       private
+
         # check command_call node to calculate the count of member and collection custom routes.
         # this is for rails2 syntax.
         #

data/lib/rails_best_practices/reviews/protect_mass_assignment_review.rb

@@ -18,7 +18,7 @@ module RailsBestPractices
       # we treat it as mass assignment by default.
       add_callback :start_class do |node|
         @mass_assignement = true
-        check_rails_version
+        check_activerecord_version
         check_whitelist_attributes_config
         check_include_forbidden_attributes_protection_config
       end
@@ -52,8 +52,9 @@ module RailsBestPractices
       end
 
       private
-        def check_rails_version
-          if Prepares.gems.gem_version("rails").to_i > 3
+
+        def check_activerecord_version
+          if Prepares.gems.gem_version("activerecord").to_i > 3
             @mass_assignement = false
           end
         end

data/lib/rails_best_practices/reviews/remove_empty_helpers_review.rb

@@ -22,6 +22,7 @@ module RailsBestPractices
       end
 
       protected
+
         def empty_body?(module_node)
           s(:bodystmt, s(:stmts_add, s(:stmts_new), s(:void_stmt)), nil, nil, nil) == module_node.body
         end

data/lib/rails_best_practices/reviews/remove_unused_methods_in_controllers_review.rb

@@ -100,6 +100,7 @@ module RailsBestPractices
       end
 
       protected
+
         def methods
           @controller_methods
         end

data/lib/rails_best_practices/reviews/remove_unused_methods_in_helpers_review.rb

@@ -32,6 +32,7 @@ module RailsBestPractices
       end
 
       protected
+
         def methods
           @helper_methods
         end

data/lib/rails_best_practices/reviews/remove_unused_methods_in_models_review.rb

@@ -86,6 +86,7 @@ module RailsBestPractices
       end
 
       protected
+
         def methods
           @model_methods
         end

data/lib/rails_best_practices/reviews/replace_complex_creation_with_factory_method_review.rb

@@ -48,6 +48,7 @@ module RailsBestPractices
       end
 
       private
+
         # check the call node to see if it is with message "save" or "save!",
         # and the count attribute assignment on the receiver of the call node is greater than @assign_count defined,
         # then it is a complex creation, should be replaced with factory method.

data/lib/rails_best_practices/reviews/restrict_auto_generated_routes_review.rb

@@ -85,6 +85,7 @@ module RailsBestPractices
       end
 
       private
+
         # check resources call, if the routes generated by resources does not exist in the controller.
         def check_resources(node)
           _check(node, RESOURCES_METHODS)

data/lib/rails_best_practices/reviews/simplify_render_in_views_review.rb

@@ -31,6 +31,7 @@ module RailsBestPractices
       end
 
       protected
+
         def include_partial?(hash_node)
           hash_node.hash_keys.include?("partial") && !hash_node.hash_value("partial").to_s.include?('/')
         end

data/lib/rails_best_practices/reviews/use_before_filter_review.rb

@@ -38,13 +38,14 @@ module RailsBestPractices
         @first_sentences.each do |first_sentence, def_nodes|
           if def_nodes.size > @customize_count
             add_error "use before_filter for #{def_nodes.map { |node| node.method_name.to_s }.join(',')}",
-              node.file,
-              def_nodes.map(&:line_number).join(',')
+                      node.file,
+                      def_nodes.map(&:line_number).join(',')
           end
         end
       end
 
       private
+
         # check method define node, and remember the first sentence.
         def remember_first_sentence(node)
           first_sentence = node.body.statements.first

data/lib/rails_best_practices/reviews/use_model_association_review.rb

@@ -42,6 +42,7 @@ module RailsBestPractices
       end
 
       private
+
         # check an attribute assignment node, if its message is xxx_id,
         # then remember the receiver of the attribute assignment in @assignments.
         def attribute_assignment(node)

data/lib/rails_best_practices/reviews/use_multipart_alternative_as_content_type_of_email_review.rb

@@ -29,6 +29,7 @@ module RailsBestPractices
       end
 
       private
+
         # check if rails's syntax mailer views are canonical.
         #
         # @param [String] name method name in action_mailer

data/lib/rails_best_practices/reviews/use_observer_review.rb

@@ -47,6 +47,7 @@ module RailsBestPractices
       end
 
       private
+
         # check a command node, if it is a callback definition, such as after_create, before_create,
         # then save the callback methods in @callbacks
         def remember_callback(node)

data/lib/rails_best_practices/reviews/use_parentheses_in_method_def_review.rb

@@ -19,6 +19,7 @@ module RailsBestPractices
       end
 
       protected
+
         def no_parentheses_around_parameters?(def_node)
           :parent != def_node[2][0]
         end

data/lib/rails_best_practices/reviews/use_query_attribute_review.rb

@@ -42,13 +42,14 @@ module RailsBestPractices
           if query_attribute_node = query_attribute_node(condition_node)
             receiver_node = query_attribute_node.receiver
             add_error "use query attribute (#{receiver_node.receiver}.#{receiver_node.message}?)",
-              node.file,
-              query_attribute_node.line_number
+                      node.file,
+                      query_attribute_node.line_number
           end
         end
       end
 
       private
+
         # recursively check conditional statement nodes to see if there is a call node that may be
         # possible query attribute.
         def query_attribute_node(conditional_statement_node)

data/lib/rails_best_practices/reviews/use_scope_access_review.rb

@@ -28,6 +28,7 @@ module RailsBestPractices
       end
 
       private
+
         # check a if node to see
         #
         # if the conditional statement is compared with current_user or current_user.id,

data/lib/rails_best_practices/version.rb

@@ -1,4 +1,4 @@
 # encoding: utf-8
 module RailsBestPractices
-  VERSION = "1.16.0"
+  VERSION = "1.17.0"
 end

data/spec/rails_best_practices/reviews/always_add_db_index_review_spec.rb

@@ -295,6 +295,33 @@ module RailsBestPractices
         runner.after_review
         expect(runner.errors.size).to eq(0)
       end
+
+      it "should detect index option in column creation" do
+        content = <<-EOF
+        ActiveRecord::Schema.define(version: 20100603080629) do
+          create_table "comments", force: true do |t|
+            t.string "content"
+            t.integer "post_id", index: true
+            t.string "user_id", index: { unique: true }
+            t.integer "image_id", index: false
+            t.integer "link_id"
+          end
+          create_table "posts", force: true do |t|
+          end
+          create_table "users", id: :string, force: true do |t|
+          end
+          create_table "images", force: true do |t|
+          end
+          create_table "links", force: true do |t|
+          end
+        end
+        EOF
+        runner.review('db/schema.rb', content)
+        runner.after_review
+        expect(runner.errors.size).to eq(2)
+        expect(runner.errors[0].to_s).to eq("db/schema.rb:2 - always add db index (comments => [image_id])")
+        expect(runner.errors[1].to_s).to eq("db/schema.rb:2 - always add db index (comments => [link_id])")
+      end
     end
   end
 end

data/spec/rails_best_practices/reviews/protect_mass_assignment_review_spec.rb

@@ -138,13 +138,13 @@ module RailsBestPractices
         end
       end
 
-      context "rails 4" do
-        it "should not protect mass assignment for rails 4" do
+      context "activerecord 4" do
+        it "should not protect mass assignment for activerecord 4" do
           content =<<-EOF
   GEM
     remote: http://rubygems.org
     specs:
-      rails (4.0.0)
+      activerecord (4.0.0)
           EOF
           runner.prepare('Gemfile.lock', content)
           content =<<-EOF
@@ -155,12 +155,12 @@ module RailsBestPractices
           expect(runner.errors.size).to eq(0)
         end
 
-        it "should protect mass assignment for rails 3" do
+        it "should protect mass assignment for activerecord 3" do
           content =<<-EOF
   GEM
     remote: http://rubygems.org
     specs:
-      rails (3.2.13)
+      activerecord (3.2.13)
           EOF
           runner.prepare('Gemfile.lock', content)
           content =<<-EOF
@@ -172,7 +172,6 @@ module RailsBestPractices
         end
       end
 
-
       it "should not check ignored files" do
         runner = Core::Runner.new(prepares: [Prepares::GemfilePrepare.new, Prepares::ConfigPrepare.new, Prepares::InitializerPrepare.new],
                                   reviews: ProtectMassAssignmentReview.new(ignored_files: /app\/models\/user\.rb/))

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_best_practices
 version: !ruby/object:Gem::Version
-  version: 1.16.0
+  version: 1.17.0
 platform: ruby
 authors:
 - Richard Huang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-22 00:00:00.000000000 Z
+date: 2016-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport