rails_best_practices 1.14.0 → 1.14.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f156688bf7014687ef1fbe360333886dabc39369
-  data.tar.gz: 18c27a29f89c40d5c4fc621719685f5b281cc480
+  metadata.gz: 9d6e0107b4ea24053498f1c9996cf1109cd7f7ca
+  data.tar.gz: 136b20157ca9b1f557d69955fc320e018be97749
 SHA512:
-  metadata.gz: e59f2708ddd9c4e71d2e3d9be3544ddd05411d9ca038387a33bcc3c48ebf1a059d945421137b151ddaad9a4c67b91d17944e0f7caae70a5fed3cd21cfc6a9657
-  data.tar.gz: 51edce3a83696df402cebe5e20e32b1108c8dd2d594d05f54d47215585e7364b1cd929967e7fb6bf7ea6296b5904e7720426c23d843e7b251b7053a5fe059f95
+  metadata.gz: c565ecd5732afe084d926f71fdd4780e4a6201d79f6fa9406a5acf115faced692731935b042b87ee7915e76adab2cce1fe481c00e718002e913854199cd21f89
+  data.tar.gz: 0d9f67c5435ee528e2f0f17ad1d866bb3f4ee88c340ece9732002ea8247a5f21ec3a4417eda96c994f45e43f353020cf59959f809012a875d2055c37cf6fe9fe

data/.travis.yml

@@ -1,5 +1,4 @@
 language: ruby
 rvm:
-  - 1.9.2
   - 1.9.3
   - 2.0.0

data/README.md

@@ -1,10 +1,11 @@
 # rails_best_practices
 
+[![Gem Version](https://badge.fury.io/rb/rails_best_practices.png)](http://badge.fury.io/rb/rails_best_practices)
 [![Build Status](https://secure.travis-ci.org/railsbp/rails_best_practices.png)](http://travis-ci.org/railsbp/rails_best_practices)
-[![Coverage
-Status](https://coveralls.io/repos/railsbp/rails_best_practices/badge.png?branch=master)](https://coveralls.io/r/railsbp/rails_best_practices)
-[![Coderwall Endorse](http://api.coderwall.com/flyerhzm/endorsecount.png)](http://coderwall.com/flyerhzm)
+[![Coverage Status](https://coveralls.io/repos/railsbp/rails_best_practices/badge.png?branch=master)](https://coveralls.io/r/railsbp/rails_best_practices)
+[![Code Climate](https://codeclimate.com/repos/51eb7073f3ea00179b00db0b/badges/095127e7bb641dbc825b/gpa.png)](https://codeclimate.com/repos/51eb7073f3ea00179b00db0b/feed)
 
+[![Coderwall Endorse](http://api.coderwall.com/flyerhzm/endorsecount.png)](http://coderwall.com/flyerhzm)
 [![Click here to lend your support to: rails best practices and make a donation at www.pledgie.com !](http://www.pledgie.com/campaigns/12057.png?skin_name=chrome)](http://www.pledgie.com/campaigns/12057)
 
 rails_best_practices is a code metric tool to check the quality of rails codes.

data/lib/rails_best_practices/core/check.rb

@@ -46,7 +46,7 @@ module RailsBestPractices
       # @param [String] message, is the string message for violation of the rails best practice
       # @param [String] filename, is the filename of source code
       # @param [Integer] line_number, is the line number of the source code which is reviewing
-      def add_error(message, filename = @node.file, line_number = @node.line)
+      def add_error(message, filename = @node.file, line_number = @node.line_number)
         errors << RailsBestPractices::Core::Error.new(
           filename: filename,
           line_number: line_number,

data/lib/rails_best_practices/core/methods.rb

@@ -12,7 +12,7 @@ module RailsBestPractices
       #
       # @param [String] class name
       # @param [String] method name
-      # @param [Hash] method meta, file and line, {"file" => "app/models/post.rb", "line" => 5}
+      # @param [Hash] method meta, file and line, {"file" => "app/models/post.rb", "line_number" => 5}
       # @param [String] access control, public, protected or private
       def add_method(class_name, method_name, meta={}, access_control="public")
         return if class_name == ""
@@ -141,15 +141,15 @@ module RailsBestPractices
         end
     end
 
-    # Method info includes class name, method name, access control, file, line, used.
+    # Method info includes class name, method name, access control, file, line_number, used.
     class Method
-      attr_reader :access_control, :class_name, :method_name, :used, :file, :line
+      attr_reader :access_control, :class_name, :method_name, :used, :file, :line_number
 
       def initialize(class_name, method_name, access_control, meta)
         @class_name = class_name
         @method_name = method_name
         @file = meta["file"]
-        @line = meta["line"]
+        @line_number = meta["line_number"]
         @access_control = access_control
         @used = false
       end
@@ -163,6 +163,7 @@ module RailsBestPractices
       def publicize
         @access_control = "public"
       end
+
     end
   end
 end

data/lib/rails_best_practices/prepares/controller_prepare.rb

@@ -32,7 +32,7 @@ module RailsBestPractices
       add_callback :end_class do |node|
         if @inherited_resources && "ApplicationController" != current_class_name
           @actions.each do |action|
-            @methods.add_method(current_class_name, action, {"file" => node.file, "line" => node.line})
+            @methods.add_method(current_class_name, action, {"file" => node.file, "line_number" => node.line_number})
           end
         end
       end
@@ -73,16 +73,16 @@ module RailsBestPractices
       # the remembered methods (@methods) are like
       #     {
       #       "PostsController" => {
-      #         "save" => {"file" => "app/controllers/posts_controller.rb", "line" => 10, "unused" => false},
-      #         "find" => {"file" => "app/controllers/posts_controller.rb", "line" => 10, "unused" => false}
+      #         "save" => {"file" => "app/controllers/posts_controller.rb", "line_number" => 10, "unused" => false},
+      #         "find" => {"file" => "app/controllers/posts_controller.rb", "line_number" => 10, "unused" => false}
       #       },
       #       "CommentsController" => {
-      #         "create" => {"file" => "app/controllers/comments_controller.rb", "line" => 10, "unused" => false},
+      #         "create" => {"file" => "app/controllers/comments_controller.rb", "line_number" => 10, "unused" => false},
       #       }
       #     }
       add_callback :start_def do |node|
         method_name = node.method_name.to_s
-        @methods.add_method(current_class_name, method_name, {"file" => node.file, "line" => node.line}, current_access_control)
+        @methods.add_method(current_class_name, method_name, {"file" => node.file, "line_number" => node.line_number}, current_access_control)
       end
 
       # ask Reviews::RemoveUnusedMoethodsInHelperReview to check the controllers who include helpers.

data/lib/rails_best_practices/prepares/helper_prepare.rb

@@ -24,14 +24,14 @@ module RailsBestPractices
       # the remembered methods (@methods) are like
       #     {
       #       "PostsHelper" => {
-      #         "create_time" => {"file" => "app/helpers/posts_helper.rb", "line" => 10, "unused" => false},
-      #         "update_time" => {"file" => "app/helpers/posts_helper.rb", "line" => 10, "unused" => false}
+      #         "create_time" => {"file" => "app/helpers/posts_helper.rb", "line_number" => 10, "unused" => false},
+      #         "update_time" => {"file" => "app/helpers/posts_helper.rb", "line_number" => 10, "unused" => false}
       #       }
       #     }
       add_callback :start_def do |node|
         if node.file =~ HELPER_FILES
           method_name = node.method_name.to_s
-          @methods.add_method(current_module_name, method_name, {"file" => node.file, "line" => node.line}, current_access_control)
+          @methods.add_method(current_module_name, method_name, {"file" => node.file, "line_number" => node.line_number}, current_access_control)
         end
       end
     end

data/lib/rails_best_practices/prepares/model_prepare.rb

@@ -30,11 +30,11 @@ module RailsBestPractices
       # the remembered methods (@methods) are like
       #     {
       #       "Post" => {
-      #         "save" => {"file" => "app/models/post.rb", "line" => 10, "unused" => false, "unused" => false},
-      #         "find" => {"file" => "app/models/post.rb", "line" => 10, "unused" => false, "unused" => false}
+      #         "save" => {"file" => "app/models/post.rb", "line_number" => 10, "unused" => false, "unused" => false},
+      #         "find" => {"file" => "app/models/post.rb", "line_number" => 10, "unused" => false, "unused" => false}
       #       },
       #       "Comment" => {
-      #         "create" => {"file" => "app/models/comment.rb", "line" => 10, "unused" => false, "unused" => false},
+      #         "create" => {"file" => "app/models/comment.rb", "line_number" => 10, "unused" => false, "unused" => false},
       #       }
       #     }
       add_callback :start_def do |node|
@@ -42,7 +42,7 @@ module RailsBestPractices
             "ActionMailer::Base" != current_extend_class_name &&
             (classable_modules.empty? || klasses.any?)
           method_name = node.method_name.to_s
-          @methods.add_method(current_class_name, method_name, {"file" => node.file, "line" => node.line}, current_access_control)
+          @methods.add_method(current_class_name, method_name, {"file" => node.file, "line_number" => node.line_number}, current_access_control)
         end
       end
 
@@ -51,17 +51,17 @@ module RailsBestPractices
       # the remembered methods (@methods) are like
       #     {
       #       "Post" => {
-      #         "save" => {"file" => "app/models/post.rb", "line" => 10, "unused" => false, "unused" => false},
-      #         "find" => {"file" => "app/models/post.rb", "line" => 10, "unused" => false, "unused" => false}
+      #         "save" => {"file" => "app/models/post.rb", "line_number" => 10, "unused" => false, "unused" => false},
+      #         "find" => {"file" => "app/models/post.rb", "line_number" => 10, "unused" => false, "unused" => false}
       #       },
       #       "Comment" => {
-      #         "create" => {"file" => "app/models/comment.rb", "line" => 10, "unused" => false, "unused" => false},
+      #         "create" => {"file" => "app/models/comment.rb", "line_number" => 10, "unused" => false, "unused" => false},
       #       }
       #     }
       add_callback :start_defs do |node|
         if @klass && "ActionMailer::Base" != current_extend_class_name
           method_name = node.method_name.to_s
-          @methods.add_method(current_class_name, method_name, {"file" => node.file, "line" => node.line}, current_access_control)
+          @methods.add_method(current_class_name, method_name, {"file" => node.file, "line_number" => node.line_number}, current_access_control)
         end
       end
 
@@ -80,11 +80,11 @@ module RailsBestPractices
         case node.message.to_s
         when *%w(named_scope scope alias_method)
           method_name = node.arguments.all.first.to_s
-          @methods.add_method(current_class_name, method_name, {"file" => node.file, "line" => node.line}, current_access_control)
+          @methods.add_method(current_class_name, method_name, {"file" => node.file, "line_number" => node.line_number}, current_access_control)
         when "alias_method_chain"
           method, feature = *node.arguments.all.map(&:to_s)
-          @methods.add_method(current_class_name, "#{method}_with_#{feature}", {"file" => node.file, "line" => node.line}, current_access_control)
-          @methods.add_method(current_class_name, "#{method}", {"file" => node.file, "line" => node.line}, current_access_control)
+          @methods.add_method(current_class_name, "#{method}_with_#{feature}", {"file" => node.file, "line_number" => node.line_number}, current_access_control)
+          @methods.add_method(current_class_name, "#{method}", {"file" => node.file, "line_number" => node.line_number}, current_access_control)
         when "field"
           arguments = node.arguments.all
           attribute_name = arguments.first.to_s
@@ -102,7 +102,7 @@ module RailsBestPractices
       # check alias node to remembr the alias methods.
       add_callback :start_alias do |node|
         method_name = node.new_method.to_s
-        @methods.add_method(current_class_name, method_name, {"file" => node.file, "line" => node.line}, current_access_control)
+        @methods.add_method(current_class_name, method_name, {"file" => node.file, "line_number" => node.line_number}, current_access_control)
       end
 
       # after prepare process, fix incorrect associations' class_name.

data/lib/rails_best_practices/reviews/always_add_db_index_review.rb

@@ -74,7 +74,7 @@ module RailsBestPractices
           table_node = @table_nodes[table]
           foreign_key.each do |column|
             if not_indexed?(table, column)
-              add_error "always add db index (#{table} => [#{Array(column).join(', ')}])", table_node.file, table_node.line
+              add_error "always add db index (#{table} => [#{Array(column).join(', ')}])", table_node.file, table_node.line_number
             end
           end
         end

data/lib/rails_best_practices/reviews/move_code_into_controller_review.rb

@@ -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 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/needless_deep_nesting_review.rb

@@ -70,7 +70,7 @@ module RailsBestPractices
             end
             @counter -= 1
           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 if @counter >= @nested_count && !@shallow_nodes.include?(node)
+            add_error "needless deep nesting (nested_count > #{@nested_count})", @file, node.line_number if @counter >= @nested_count && !@shallow_nodes.include?(node)
           end
         end
     end

data/lib/rails_best_practices/reviews/not_rescue_exception_review.rb

@@ -18,7 +18,7 @@ module RailsBestPractices
       # 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 }
-          add_error "not rescue Exception", rescue_node.file, rescue_node.exception_classes.first.line
+          add_error "not rescue Exception", rescue_node.file, rescue_node.exception_classes.first.line_number
         end
       end
     end

data/lib/rails_best_practices/reviews/overuse_route_customizations_review.rb

@@ -46,7 +46,7 @@ module RailsBestPractices
       # then they are overuse route customizations.
       add_callback :start_command_call do |node|
         if member_and_collection_count_for_rails2(node) > @customize_count
-          add_error "overuse route customizations (customize_count > #{@customize_count})", node.file, node.receiver.line
+          add_error "overuse route customizations (customize_count > #{@customize_count})", node.file, node.receiver.line_number
         end
       end
 
@@ -59,7 +59,7 @@ module RailsBestPractices
       # then they are overuse route customizations.
       add_callback :start_method_add_block do |node|
         if member_and_collection_count_for_rails3(node) > @customize_count
-          add_error "overuse route customizations (customize_count > #{@customize_count})", node.file, node.line
+          add_error "overuse route customizations (customize_count > #{@customize_count})", node.file, node.line_number
         end
       end
 

data/lib/rails_best_practices/reviews/remove_unused_methods_in_controllers_review.rb

@@ -94,7 +94,7 @@ module RailsBestPractices
         end
         @controller_methods.get_all_unused_methods.each do |method|
           if !excepted?(method)
-            add_error "remove unused methods (#{method.class_name}##{method.method_name})", method.file, method.line
+            add_error "remove unused methods (#{method.class_name}##{method.method_name})", method.file, method.line_number
           end
         end
       end

data/lib/rails_best_practices/reviews/remove_unused_methods_in_helpers_review.rb

@@ -26,7 +26,7 @@ module RailsBestPractices
       add_callback :after_check do
         @helper_methods.get_all_unused_methods.each do |method|
           if !excepted?(method)
-            add_error "remove unused methods (#{method.class_name}##{method.method_name})", method.file, method.line
+            add_error "remove unused methods (#{method.class_name}##{method.method_name})", method.file, method.line_number
           end
         end
       end

data/lib/rails_best_practices/reviews/remove_unused_methods_in_models_review.rb

@@ -80,7 +80,7 @@ module RailsBestPractices
       add_callback :after_check do
         @model_methods.get_all_unused_methods.each do |method|
           if !excepted?(method) && method.method_name !~ /=$/
-            add_error "remove unused methods (#{method.class_name}##{method.method_name})", method.file, method.line
+            add_error "remove unused methods (#{method.class_name}##{method.method_name})", method.file, method.line_number
           end
         end
       end

data/lib/rails_best_practices/reviews/use_before_filter_review.rb

@@ -2,14 +2,14 @@
 module RailsBestPractices
   module Reviews
     # Review a controller file to make sure to use before_filter to remove duplicated first code
-    # line in different action.
+    # line_number in different action.
     #
     # See the best practice detailed here http://rails-bestpractices.com/posts/22-use-before_filter.
     #
     # Implementation:
     #
     # Review process:
-    #   check all first code line in method definitions (actions),
+    #   check all first code line_number in method definitions (actions),
     #   if they are duplicated, then they should be moved to before_filter.
     class UseBeforeFilterReview < Review
       interesting_nodes :class
@@ -21,11 +21,11 @@ module RailsBestPractices
         @customize_count = options['customize_count'] || 2
       end
 
-      # check class define node to see if there are method define nodes whose first code line are duplicated.
+      # check class define node to see if there are method define nodes whose first code line_number are duplicated.
       #
       # it will check every def nodes in the class node until protected or private identification,
-      # if there are defn nodes who have the same first code line,
-      # then these duplicated first code lines should be moved to before_filter.
+      # if there are defn nodes who have the same first code line_number,
+      # then these duplicated first code line_numbers should be moved to before_filter.
       add_callback :start_class do |node|
         @first_sentences = {}
 
@@ -39,7 +39,7 @@ module RailsBestPractices
           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).join(',')
+              def_nodes.map(&:line_number).join(',')
           end
         end
       end
@@ -49,7 +49,7 @@ module RailsBestPractices
         def remember_first_sentence(node)
           first_sentence = node.body.statements.first
           return unless first_sentence
-          first_sentence = first_sentence.remove_line_and_column
+          first_sentence = first_sentence.remove_line_number_and_column
           unless first_sentence == s(:nil)
             @first_sentences[first_sentence] ||= []
             @first_sentences[first_sentence] << node

data/lib/rails_best_practices/reviews/use_query_attribute_review.rb

@@ -43,7 +43,7 @@ module RailsBestPractices
             receiver_node = query_attribute_node.receiver
             add_error "use query attribute (#{receiver_node.receiver}.#{receiver_node.message}?)",
               node.file,
-              query_attribute_node.line
+              query_attribute_node.line_number
           end
         end
       end

data/lib/rails_best_practices/reviews/use_say_with_time_in_migrations_review.rb

@@ -39,7 +39,7 @@ module RailsBestPractices
                            child_node
                          end
           if :call == receiver_node.sexp_type
-            add_error("use say with time in migrations", node.file, child_node.line)
+            add_error("use say with time in migrations", node.file, child_node.line_number)
           end
         end
       end

data/lib/rails_best_practices/version.rb

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

data/rails_best_practices.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |s|
 
   s.add_dependency("activesupport")
   s.add_dependency("awesome_print")
-  s.add_dependency("code_analyzer")
+  s.add_dependency("code_analyzer", ">= 0.4.0")
   s.add_dependency("colored")
   s.add_dependency("erubis")
   s.add_dependency("i18n")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_best_practices
 version: !ruby/object:Gem::Version
-  version: 1.14.0
+  version: 1.14.1
 platform: ruby
 authors:
 - Richard Huang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-21 00:00:00.000000000 Z
+date: 2013-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.4.0
 - !ruby/object:Gem::Dependency
   name: colored
   requirement: !ruby/object:Gem::Requirement
@@ -398,7 +398,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.0.6
 signing_key: 
 specification_version: 4
 summary: a code metric tool for rails codes.