rails_best_practices 1.15.4 → 1.15.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4f58c94e40ab3dcb7632dc9f975de4133eefb801
-  data.tar.gz: 5997c946de7c2a0f14a45d65882f6c47ae9b57dd
+  metadata.gz: 226e897e70ff9eef8f71618f89f0477e251b98b6
+  data.tar.gz: d306ab46262bb3b6cc11efa62c3d46b5ef12a056
 SHA512:
-  metadata.gz: ec037490d306afd4d767eaebeb94c782b8c572a07a282f11d123dd964f6711876c4c7b4cbafa7b82b25d8a9bc8a8986dfd4bb6458ffbdcc30f94fe38d17f900d
-  data.tar.gz: cefcea37746e5a2a92005f5920f8ca7e5ba7a41040e8743a775a4a2ea12bcc4e8cd059b8daae6849a93f777b7e649e40ef8ea30dc5b886bfeb9b46be98c7281f
+  metadata.gz: 2a22ae71b9e6b399c29987eb78a0ca19046b2823a2853e82b9e6b6772403daa1e6192b9f68330fefb658800c12547ac49cb0874d3fa615b14bd78a33e25d0f8e
+  data.tar.gz: 80cb58e6262aa89f8781c8cfd8cd37b92131c247d2a8d2c114453a3f370b3969e507f458b946a08bf3a6bac7bf029c9b343642a53c15997197a01e1f0a90b967

data/.travis.yml

@@ -1,5 +1,7 @@
+sudo: false
 language: ruby
+cache: bundler
 rvm:
   - 1.9.3
   - 2.0.0
-  - 2.1.1
+  - 2.1

data/Gemfile

@@ -9,4 +9,5 @@ if RUBY_PLATFORM =~ /darwin/i
 end
 gem 'pry'
 gem 'guard'
+gem 'rspec', '~> 2.14.0'
 gem 'guard-rspec'

data/README.md

@@ -7,7 +7,7 @@
 [![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 !](https://pledgie.com/campaigns/12057.png?skin_name=chrome)](https://pledgie.com/campaigns/12057)
 
-rails_best_practices is a code metric tool to check the quality of rails codes.
+rails_best_practices is a code metric tool to check the quality of rails code.
 
 it supports following ORM/ODMs:
 
@@ -40,14 +40,14 @@ or html output
 
     rails_best_practices -f html .
 
-By default rails_best_practices will do parse codes in vendor, spec, test and features directories. 
+By default rails_best_practices will do parse codes in vendor, spec, test and features directories.
 
 ### Excluding folders
 
 To exclude folder simply call it with -e or --exclude
 
     rails_best_practices -e "db/migrate" .
-    
+
 To exclude multiple folders, separate them with comma
 
     rails_best_practices -e "db/migrate,vendor" .
@@ -57,7 +57,7 @@ To exclude multiple folders, separate them with comma
 To see full list of commandline options call:
 
     $ rails_best_practices -h
-    
+
     Usage: rails_best_practices [options]
         -d, --debug                      Debug mode
         -f, --format FORMAT              output format

data/assets/result.html.erb

@@ -47,6 +47,9 @@
        display: none;
        float: left;
       }
+      .result tbody tr{
+        display: none;
+      }
     </style>
 <%
   def columnize(arr, col_count)
@@ -140,23 +143,45 @@
     <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.7.2/jquery.min.js"></script>
     <script type="text/javascript">
       $(function() {
-        $('ul li').show();
-        $('input.error-type[type=checkbox]').prop('checked', true).click(function() {
+
+        keys = location.hash.slice(2).split("|");
+        keys = keys.filter(function(item){
+          return item != "";
+        });
+        keys.forEach(function(item){
+          $('.'+item).show();
+          $('input.error-type#'+item+'[type=checkbox]').prop('checked', true);
+        });
+
+        $('input.error-type[type=checkbox]').click(function() {
           if ($(this).attr('checked')) {
             $(this).prop('checked', true);
             $('.'+$(this).val()).show();
+
+            new_hash = location.hash.replace("|"+$(this).val().toString(), "");
+            location.hash = new_hash+"|"+$(this).val();
           } else {
             $(this).prop('checked', false);
             $('.'+$(this).val()).hide();
+
+            new_hash = location.hash.replace("|"+$(this).val().toString(), "");
+            location.hash = new_hash
           }
         });
+
         $('#show-all').click(function() {
+          $('input.error-type[type=checkbox]').each(function(index, item){
+            new_hash = location.hash.replace("|"+$(item).val().toString(), "");
+            location.hash = new_hash+"|"+$(item).val();
+          });
           $('input.error-type[type=checkbox]').prop('checked', true);
           $('table.result tbody tr').show();
         });
+
         $('#show-none').click(function() {
           $('input.error-type[type=checkbox]').prop('checked', false);
           $('table.result tbody tr').hide();
+          location.hash = "";
         });
       });
     </script>

data/lib/rails_best_practices/analyzer.rb

@@ -1,5 +1,4 @@
 # encoding: utf-8
-require 'ap'
 require 'colored'
 require 'fileutils'
 require 'json'
@@ -70,6 +69,9 @@ module RailsBestPractices
       when "yaml"
         @options["output-file"] ||= "rails_best_practices_output.yaml"
         output_yaml_errors
+      when "xml"
+        @options["output-file"] ||= "rails_best_practices_output.xml"
+        output_xml_errors
       else
         output_terminal_errors
       end
@@ -246,6 +248,36 @@ module RailsBestPractices
       end
     end
 
+    def output_xml_errors
+      require 'rexml/document'
+
+      document = REXML::Document.new.tap do |d|
+        d << REXML::XMLDecl.new
+      end
+
+      checkstyle = REXML::Element.new('checkstyle', document)
+
+      errors.group_by(&:filename).each do |file, group|
+        REXML::Element.new('file', checkstyle).tap do |f|
+          f.attributes['name'] = file
+          group.each do |error|
+            REXML::Element.new('error', f).tap do |e|
+              e.attributes['line'] = error.line_number
+              e.attributes['column'] = 0
+              e.attributes['severity'] = 'error'
+              e.attributes['message'] = error.message
+              e.attributes['source'] = 'com.puppycrawl.tools.checkstyle.' + error.type
+            end
+          end
+        end
+      end
+
+      formatter = REXML::Formatters::Default.new
+      File.open(@options["output-file"], 'w+') do |result|
+        formatter.write(document, result)
+      end
+    end
+
     # output errors with yaml format.
     def output_yaml_errors
       File.open(@options["output-file"], "w+") do |file|

data/lib/rails_best_practices/command.rb

@@ -4,7 +4,7 @@ require "optparse"
 # Usage: rails_best_practices [options] path
 #    -d, --debug                      debug mode
 #        --silent                     silent mode
-#    -f, --format FORMAT              output format (text, html, yml, json)
+#    -f, --format FORMAT              output format (text, html, yml, json, xml)
 #        --output-file FILE           output html file for the analyzing result
 #        --without-color              only output plain text without color
 #        --with-textmate              open file by textmate in html format
@@ -35,7 +35,7 @@ OptionParser.new do |opts|
     options["debug"] = true
   end
 
-  opts.on("-f", "--format FORMAT", "output format (text, html, yml, json)") do |format|
+  opts.on("-f", "--format FORMAT", "output format (text, html, yml, json, xml)") do |format|
     options["format"] = format
   end
 

data/lib/rails_best_practices/prepares/route_prepare.rb

@@ -22,7 +22,7 @@ module RailsBestPractices
           add_resources_routes(node)
         when "resource"
           add_resource_routes(node)
-        when "get", "post", "put", "delete"
+        when "get", "post", "put", "patch", "delete"
           first_argument = node.arguments.all.first
           second_argument = node.arguments.all[1]
           if @controller_names.last

data/lib/rails_best_practices/reviews/add_model_virtual_attribute_review.rb

@@ -3,7 +3,7 @@ module RailsBestPractices
   module Reviews
     # Make sure to add a model virual attribute to simplify model creation.
     #
-    # See the best practice details here http://rails-bestpractices.com/posts/4-add-model-virtual-attribute
+    # See the best practice details here http://rails-bestpractices.com/posts/2010/07/21/add-model-virtual-attribute/
     #
     # Implementation:
     #
@@ -16,7 +16,7 @@ module RailsBestPractices
     class AddModelVirtualAttributeReview < Review
       interesting_nodes :def
       interesting_files CONTROLLER_FILES
-      url "http://rails-bestpractices.com/posts/4-add-model-virtual-attribute"
+      url "http://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.
       #

data/lib/rails_best_practices/reviews/always_add_db_index_review.rb

@@ -3,7 +3,7 @@ module RailsBestPractices
   module Reviews
     # Review db/schema.rb file to make sure every reference key has a database index.
     #
-    # See the best practice details here http://rails-bestpractices.com/posts/21-always-add-db-index
+    # See the best practice details here http://rails-bestpractices.com/posts/2010/07/24/always-add-db-index/
     #
     # Implementation:
     #
@@ -24,7 +24,7 @@ module RailsBestPractices
     class AlwaysAddDbIndexReview < Review
       interesting_nodes :command, :command_call
       interesting_files SCHEMA_FILE
-      url "http://rails-bestpractices.com/posts/21-always-add-db-index"
+      url "http://rails-bestpractices.com/posts/2010/07/24/always-add-db-index/"
 
       def initialize(options={})
         super(options)

data/lib/rails_best_practices/reviews/check_save_return_value_review.rb

@@ -4,7 +4,7 @@ module RailsBestPractices
     # Review all code to make sure we either check the return value of "save"
     # or use "save!"
     #
-    # See the best practice details here http://rails-bestpractices.com/posts/703-check-the-return-value-of-save-otherwise-use-save
+    # See the best practice details here http://rails-bestpractices.com/posts/2012/11/02/check-the-return-value-of-save-otherwise-use-save/
     #
     # Implementation:
     #
@@ -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 "http://rails-bestpractices.com/posts/703-check-the-return-value-of-save-otherwise-use-save"
+      url "http://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

@@ -3,7 +3,7 @@ module RailsBestPractices
   module Reviews
     # Review model files to make sure not use default_scope
     #
-    # See the best practice details here http://rails-bestpractices.com/posts/806-default_scope-is-evil
+    # See the best practice details here http://rails-bestpractices.com/posts/2013/06/15/default_scope-is-evil/
     #
     # Implementation:
     #
@@ -12,7 +12,7 @@ module RailsBestPractices
     class DefaultScopeIsEvilReview < Review
       interesting_nodes :command
       interesting_files MODEL_FILES
-      url "http://rails-bestpractices.com/posts/806-default_scope-is-evil"
+      url "http://rails-bestpractices.com/posts/2013/06/15/default_scope-is-evil/"
 
       # check all command nodes' message
       add_callback :start_command do |node|

data/lib/rails_best_practices/reviews/dry_bundler_in_capistrano_review.rb

@@ -3,7 +3,7 @@ module RailsBestPractices
   module Reviews
     # Review config/deploy.rb file to make sure using the bundler's capistrano recipe.
     #
-    # See the best practice details here http://rails-bestpractices.com/posts/51-dry-bundler-in-capistrano
+    # See the best practice details here http://rails-bestpractices.com/posts/2010/09/02/dry-bundler-in-capistrano/
     #
     # Implementation:
     #
@@ -15,7 +15,7 @@ module RailsBestPractices
     class DryBundlerInCapistranoReview < Review
       interesting_nodes :command
       interesting_files DEPLOY_FILES
-      url "http://rails-bestpractices.com/posts/51-dry-bundler-in-capistrano"
+      url "http://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|

data/lib/rails_best_practices/reviews/isolate_seed_data_review.rb

@@ -3,7 +3,7 @@ module RailsBestPractices
   module Reviews
     # Make sure not to insert data in migration, move them to seed file.
     #
-    # See the best practice details here http://rails-bestpractices.com/posts/20-isolating-seed-data.
+    # See the best practice details here http://rails-bestpractices.com/posts/2010/07/24/isolating-seed-data/
     #
     # Implementation:
     #
@@ -21,7 +21,7 @@ module RailsBestPractices
     class IsolateSeedDataReview < Review
       interesting_nodes :call, :assign
       interesting_files MIGRATION_FILES
-      url "http://rails-bestpractices.com/posts/20-isolating-seed-data"
+      url "http://rails-bestpractices.com/posts/2010/07/24/isolating-seed-data/"
 
       def initialize(options={})
         super(options)

data/lib/rails_best_practices/reviews/keep_finders_on_their_own_model_review.rb

@@ -3,7 +3,7 @@ module RailsBestPractices
   module Reviews
     # Review model files to make sure finders are on their own model.
     #
-    # See the best practice details here http://rails-bestpractices.com/posts/13-keep-finders-on-their-own-model.
+    # See the best practice details here http://rails-bestpractices.com/posts/2010/07/23/keep-finders-on-their-own-model/
     #
     # Implementation:
     #
@@ -17,7 +17,7 @@ module RailsBestPractices
     class KeepFindersOnTheirOwnModelReview < Review
       interesting_nodes :method_add_arg
       interesting_files MODEL_FILES
-      url "http://rails-bestpractices.com/posts/13-keep-finders-on-their-own-model"
+      url "http://rails-bestpractices.com/posts/2010/07/23/keep-finders-on-their-own-model/"
 
       FINDERS = %w(find all first last)
 

data/lib/rails_best_practices/reviews/law_of_demeter_review.rb

@@ -3,7 +3,7 @@ module RailsBestPractices
   module Reviews
     # Review to make sure not to avoid the law of demeter.
     #
-    # See the best practice details here http://rails-bestpractices.com/posts/15-the-law-of-demeter.
+    # See the best practice details here http://rails-bestpractices.com/posts/2010/07/24/the-law-of-demeter/
     #
     # Implementation:
     #
@@ -16,7 +16,7 @@ module RailsBestPractices
     class LawOfDemeterReview < Review
       interesting_nodes :call
       interesting_files ALL_FILES
-      url "http://rails-bestpractices.com/posts/15-the-law-of-demeter"
+      url "http://rails-bestpractices.com/posts/2010/07/24/the-law-of-demeter/"
 
       ASSOCIATION_METHODS = %w(belongs_to has_one)
 

data/lib/rails_best_practices/reviews/move_code_into_controller_review.rb

@@ -3,7 +3,7 @@ module RailsBestPractices
   module Reviews
     # Review a view file to make sure there is no finder, finder should be moved to controller.
     #
-    # See the best practice details here http://rails-bestpractices.com/posts/24-move-code-into-controller.
+    # See the best practice details here http://rails-bestpractices.com/posts/2010/07/24/move-code-into-controller/
     #
     # Implementation:
     #
@@ -12,7 +12,7 @@ module RailsBestPractices
     class MoveCodeIntoControllerReview < Review
       interesting_nodes :method_add_arg, :assign
       interesting_files VIEW_FILES
-      url "http://rails-bestpractices.com/posts/24-move-code-into-controller"
+      url "http://rails-bestpractices.com/posts/2010/07/24/move-code-into-controller/"
 
       FINDERS = %w(find all first last)
 

data/lib/rails_best_practices/reviews/move_code_into_helper_review.rb

@@ -3,7 +3,7 @@ module RailsBestPractices
   module Reviews
     # Review a view file to make sure there is no complex options_for_select message call.
     #
-    # See the best practice details here http://rails-bestpractices.com/posts/26-move-code-into-helper.
+    # See the best practice details here http://rails-bestpractices.com/posts/2010/07/24/move-code-into-helper/
     #
     # TODO: we need a better soluation, any suggestion?
     #
@@ -19,7 +19,7 @@ module RailsBestPractices
     class MoveCodeIntoHelperReview < Review
       interesting_nodes :method_add_arg
       interesting_files VIEW_FILES
-      url "http://rails-bestpractices.com/posts/26-move-code-into-helper"
+      url "http://rails-bestpractices.com/posts/2010/07/24/move-code-into-helper/"
 
       def initialize(options = {})
         super(options)

data/lib/rails_best_practices/reviews/move_code_into_model_review.rb

@@ -3,7 +3,7 @@ module RailsBestPractices
   module Reviews
     # Review a view file to make sure there is no complex logic call for model.
     #
-    # See the best practice details here http://rails-bestpractices.com/posts/25-move-code-into-model.
+    # See the best practice details here http://rails-bestpractices.com/posts/2010/07/24/move-code-into-model/
     #
     # Implementation:
     #
@@ -13,7 +13,7 @@ module RailsBestPractices
     class MoveCodeIntoModelReview < Review
       interesting_nodes :if, :unless, :elsif, :ifop, :if_mod, :unless_mod
       interesting_files VIEW_FILES
-      url "http://rails-bestpractices.com/posts/25-move-code-into-model"
+      url "http://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

@@ -3,7 +3,7 @@ module RailsBestPractices
   module Reviews
     # Review a controller file to make sure there are no complex finder.
     #
-    # See the best practice details here http://rails-bestpractices.com/posts/1-move-finder-to-named_scope.
+    # See the best practice details here http://rails-bestpractices.com/posts/2010/07/14/move-finder-to-named_scope/
     #
     # Implementation:
     #
@@ -15,7 +15,7 @@ module RailsBestPractices
     class MoveFinderToNamedScopeReview < Review
       interesting_nodes :method_add_arg
       interesting_files CONTROLLER_FILES
-      url "http://rails-bestpractices.com/posts/1-move-finder-to-named_scope"
+      url "http://rails-bestpractices.com/posts/2010/07/14/move-finder-to-named_scope/"
 
       FINDERS = %w(find all first last)
 

data/lib/rails_best_practices/reviews/move_model_logic_into_model_review.rb

@@ -3,7 +3,7 @@ module RailsBestPractices
   module Reviews
     # Review a controller file to make sure that complex model logic should not exist in controller, should be moved into a model.
     #
-    # See the best practice details here http://rails-bestpractices.com/posts/7-move-model-logic-into-the-model.
+    # See the best practice details here http://rails-bestpractices.com/posts/2010/07/21/move-model-logic-into-the-model/
     #
     # Implementation:
     #
@@ -15,7 +15,7 @@ module RailsBestPractices
     class MoveModelLogicIntoModelReview < Review
       interesting_nodes :def
       interesting_files CONTROLLER_FILES
-      url "http://rails-bestpractices.com/posts/7-move-model-logic-into-the-model"
+      url "http://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

@@ -3,7 +3,7 @@ module RailsBestPractices
   module Reviews
     # Review config/routes.rb file to make sure not to use too deep nesting routes.
     #
-    # See the best practice details here http://rails-bestpractices.com/posts/11-needless-deep-nesting.
+    # See the best practice details here http://rails-bestpractices.com/posts/2010/07/22/needless-deep-nesting/
     #
     # Implementation:
     #
@@ -24,7 +24,7 @@ module RailsBestPractices
     class NeedlessDeepNestingReview < Review
       interesting_nodes :method_add_block
       interesting_files ROUTE_FILES
-      url "http://rails-bestpractices.com/posts/11-needless-deep-nesting"
+      url "http://rails-bestpractices.com/posts/2010/07/22/needless-deep-nesting/"
 
       def initialize(options = {})
         super(options)

data/lib/rails_best_practices/reviews/not_rescue_exception_review.rb

@@ -4,7 +4,7 @@ module RailsBestPractices
     # Review all code to make sure we don't rescue Exception
     # This is a common mistake by Java or C# devs in ruby.
     #
-    # See the best practice details here http://rails-bestpractices.com/posts/702-don-t-rescue-exception-rescue-standarderror
+    # See the best practice details here http://rails-bestpractices.com/posts/2012/11/01/don-t-rescue-exception-rescue-standarderror/
     #
     # Implementation:
     #
@@ -13,7 +13,7 @@ module RailsBestPractices
     class NotRescueExceptionReview < Review
       interesting_nodes :rescue
       interesting_files ALL_FILES
-      url "http://rails-bestpractices.com/posts/702-don-t-rescue-exception-rescue-standarderror"
+      url "http://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|

data/lib/rails_best_practices/reviews/not_use_default_route_review.rb

@@ -3,7 +3,7 @@ module RailsBestPractices
   module Reviews
     # Review config/routes file to make sure not use default route that rails generated.
     #
-    # See the best practice details here http://rails-bestpractices.com/posts/12-not-use-default-route-if-you-use-restful-design
+    # See the best practice details here http://rails-bestpractices.com/posts/2010/07/22/not-use-default-route-if-you-use-restful-design/
     #
     # Implementation:
     #
@@ -19,7 +19,7 @@ module RailsBestPractices
     class NotUseDefaultRouteReview < Review
       interesting_nodes :command_call, :command
       interesting_files ROUTE_FILES
-      url "http://rails-bestpractices.com/posts/12-not-use-default-route-if-you-use-restful-design"
+      url "http://rails-bestpractices.com/posts/2010/07/22/not-use-default-route-if-you-use-restful-design/"
 
       # check all command call nodes, compare with rails2 default route
       add_callback :start_command_call do |node|

data/lib/rails_best_practices/reviews/not_use_time_ago_in_words_review.rb

@@ -3,7 +3,7 @@ module RailsBestPractices
   module Reviews
     # Review view and helper files to make sure not use time_ago_in_words or distance_of_time_in_words_to_now.
     #
-    # See the best practice details here http://rails-bestpractices.com/posts/105-not-use-time_ago_in_words.
+    # See the best practice details here http://rails-bestpractices.com/posts/2012/02/10/not-use-time_ago_in_words/
     #
     # Implementation:
     #
@@ -12,7 +12,7 @@ module RailsBestPractices
     class NotUseTimeAgoInWordsReview < Review
       interesting_nodes :fcall
       interesting_files VIEW_FILES, HELPER_FILES
-      url "http://rails-bestpractices.com/posts/105-not-use-time_ago_in_words"
+      url "http://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|

data/lib/rails_best_practices/reviews/overuse_route_customizations_review.rb

@@ -3,7 +3,7 @@ module RailsBestPractices
   module Reviews
     # Review config/routes.rb file to make sure there are no overuse route customizations.
     #
-    # See the best practice details here http://rails-bestpractices.com/posts/10-overuse-route-customizations.
+    # See the best practice details here http://rails-bestpractices.com/posts/2010/07/22/overuse-route-customizations/
     #
     # Implementation:
     #
@@ -28,7 +28,7 @@ module RailsBestPractices
     class OveruseRouteCustomizationsReview < Review
       interesting_nodes :command_call, :method_add_block
       interesting_files ROUTE_FILES
-      url "http://rails-bestpractices.com/posts/10-overuse-route-customizations"
+      url "http://rails-bestpractices.com/posts/2010/07/22/overuse-route-customizations/"
 
       VERBS = %w(get post update delete)
 

data/lib/rails_best_practices/reviews/protect_mass_assignment_review.rb

@@ -3,7 +3,7 @@ module RailsBestPractices
   module Reviews
     # Review model files to make sure to use attr_accessible, attr_protected or strong_parameters to protect mass assignment.
     #
-    # See the best practices details here http://rails-bestpractices.com/posts/148-protect-mass-assignment.
+    # See the best practices details here http://rails-bestpractices.com/posts/2012/03/06/protect-mass-assignment/
     #
     # Implmentation:
     #
@@ -13,7 +13,7 @@ module RailsBestPractices
     class ProtectMassAssignmentReview < Review
       interesting_files MODEL_FILES
       interesting_nodes :class, :command, :var_ref, :vcall, :fcall
-      url "http://rails-bestpractices.com/posts/148-protect-mass-assignment"
+      url "http://rails-bestpractices.com/posts/2012/03/06/protect-mass-assignment/"
 
       # we treat it as mass assignment by default.
       add_callback :start_class do |node|

data/lib/rails_best_practices/reviews/remove_empty_helpers_review.rb

@@ -3,7 +3,7 @@ module RailsBestPractices
   module Reviews
     # Review a helper file to make sure it is not an empty moduel.
     #
-    # See the best practice details here http://rails-bestpractices.com/posts/72-remove-empty-helpers.
+    # See the best practice details here http://rails-bestpractices.com/posts/2011/04/09/remove-empty-helpers/
     #
     # Implementation:
     #
@@ -12,7 +12,7 @@ module RailsBestPractices
     class RemoveEmptyHelpersReview < Review
       interesting_nodes :module
       interesting_files HELPER_FILES
-      url "http://rails-bestpractices.com/posts/72-remove-empty-helpers"
+      url "http://rails-bestpractices.com/posts/2011/04/09/remove-empty-helpers/"
 
       # check the body of module node, if it is nil, then it should be removed.
       add_callback :start_module do |module_node|

data/lib/rails_best_practices/reviews/replace_complex_creation_with_factory_method_review.rb

@@ -4,8 +4,7 @@ module RailsBestPractices
     # Review a controller file to make sure that complex model creation should not exist in
     # controller, should be replaced with factory method.
     #
-    # See the best practice details here
-    # http://rails-bestpractices.com/posts/6-replace-complex-creation-with-factory-method.
+    # See the best practice details here http://rails-bestpractices.com/posts/2010/07/21/replace-complex-creation-with-factory-method/
     #
     # Implementation:
     #
@@ -18,7 +17,7 @@ module RailsBestPractices
     class ReplaceComplexCreationWithFactoryMethodReview < Review
       interesting_nodes :def
       interesting_files CONTROLLER_FILES
-      url "http://rails-bestpractices.com/posts/6-replace-complex-creation-with-factory-method"
+      url "http://rails-bestpractices.com/posts/2010/07/21/replace-complex-creation-with-factory-method/"
 
       def initialize(options = {})
         super(options)

data/lib/rails_best_practices/reviews/replace_instance_variable_with_local_variable_review.rb

@@ -3,8 +3,7 @@ module RailsBestPractices
   module Reviews
     # Review a partail view file to make sure there is no instance variable.
     #
-    # See the best practice details here
-    # http://rails-bestpractices.com/posts/27-replace-instance-variable-with-local-variable.
+    # See the best practice details here http://rails-bestpractices.com/posts/2010/07/24/replace-instance-variable-with-local-variable/
     #
     # Implementation:
     #
@@ -14,7 +13,7 @@ module RailsBestPractices
     class ReplaceInstanceVariableWithLocalVariableReview < Review
       interesting_nodes :var_ref, :vcall
       interesting_files PARTIAL_VIEW_FILES
-      url "http://rails-bestpractices.com/posts/27-replace-instance-variable-with-local-variable"
+      url "http://rails-bestpractices.com/posts/2010/07/24/replace-instance-variable-with-local-variable/"
 
       # check ivar node in partial view file,
       # it is an instance variable, and should be replaced with local variable.

data/lib/rails_best_practices/reviews/restrict_auto_generated_routes_review.rb

@@ -3,7 +3,7 @@ module RailsBestPractices
   module Reviews
     # Review a route file to make sure all auto-generated routes have corresponding actions in controller.
     #
-    # See the best practice details here http://rails-bestpractices.com/posts/86-restrict-auto-generated-routes
+    # See the best practice details here http://rails-bestpractices.com/posts/2011/08/19/restrict-auto-generated-routes/
     #
     # Implementation:
     #
@@ -15,7 +15,7 @@ module RailsBestPractices
     class RestrictAutoGeneratedRoutesReview < Review
       interesting_nodes :command, :command_call, :method_add_block
       interesting_files ROUTE_FILES
-      url "http://rails-bestpractices.com/posts/86-restrict-auto-generated-routes"
+      url "http://rails-bestpractices.com/posts/2011/08/19/restrict-auto-generated-routes/"
 
       RESOURCE_METHODS = ["show", "new", "create", "edit", "update", "destroy"]
       RESOURCES_METHODS = RESOURCE_METHODS + ["index"]

data/lib/rails_best_practices/reviews/simplify_render_in_controllers_review.rb

@@ -3,7 +3,7 @@ module RailsBestPractices
   module Reviews
     # Review a controller file to make sure using simplified syntax for render.
     #
-    # See the best practice details here http://rails-bestpractices.com/posts/62-simplify-render-in-controllers.
+    # See the best practice details here http://rails-bestpractices.com/posts/2010/12/12/simplify-render-in-controllers/
     #
     # Implementation:
     #
@@ -14,7 +14,7 @@ module RailsBestPractices
     class SimplifyRenderInControllersReview < Review
       interesting_nodes :command
       interesting_files CONTROLLER_FILES
-      url "http://rails-bestpractices.com/posts/62-simplify-render-in-controllers"
+      url "http://rails-bestpractices.com/posts/2010/12/12/simplify-render-in-controllers/"
 
       # check command node in the controller file,
       # if its message is render and the arguments contain a key action, template or file,

data/lib/rails_best_practices/reviews/simplify_render_in_views_review.rb

@@ -3,7 +3,7 @@ module RailsBestPractices
   module Reviews
     # Review a view file to make sure using simplified syntax for render.
     #
-    # See the best practice details here http://rails-bestpractices.com/posts/61-simplify-render-in-views.
+    # See the best practice details here http://rails-bestpractices.com/posts/2010/12/04/simplify-render-in-views/
     #
     # Implementation:
     #
@@ -13,7 +13,7 @@ module RailsBestPractices
     class SimplifyRenderInViewsReview < Review
       interesting_nodes :command
       interesting_files VIEW_FILES
-      url "http://rails-bestpractices.com/posts/61-simplify-render-in-views"
+      url "http://rails-bestpractices.com/posts/2010/12/04/simplify-render-in-views/"
 
       VALID_KEYS = %w(object collection locals)
 

data/lib/rails_best_practices/reviews/use_before_filter_review.rb

@@ -4,7 +4,7 @@ module RailsBestPractices
     # Review a controller file to make sure to use before_filter to remove duplicated first code
     # line_number in different action.
     #
-    # See the best practice detailed here http://rails-bestpractices.com/posts/22-use-before_filter.
+    # See the best practice detailed here http://rails-bestpractices.com/posts/2010/07/24/use-before_filter/
     #
     # Implementation:
     #
@@ -14,7 +14,7 @@ module RailsBestPractices
     class UseBeforeFilterReview < Review
       interesting_nodes :class
       interesting_files CONTROLLER_FILES
-      url "http://rails-bestpractices.com/posts/22-use-before_filter"
+      url "http://rails-bestpractices.com/posts/2010/07/24/use-before_filter/"
 
       def initialize(options = {})
         super()
@@ -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_number_and_column
+          first_sentence = first_sentence.remove_line_and_column
           unless first_sentence == s(:nil)
             @first_sentences[first_sentence] ||= []
             @first_sentences[first_sentence] << node

data/lib/rails_best_practices/reviews/use_model_association_review.rb

@@ -3,7 +3,7 @@ module RailsBestPractices
   module Reviews
     # review a controller file to make sure to use model association instead of foreign key id assignment.
     #
-    # See the best practice details here http://rails-bestpractices.com/posts/2-use-model-association.
+    # See the best practice details here http://rails-bestpractices.com/posts/2010/07/19/use-model-association/
     #
     # Implementation:
     #
@@ -16,7 +16,7 @@ module RailsBestPractices
     class UseModelAssociationReview < Review
       interesting_nodes :def
       interesting_files CONTROLLER_FILES
-      url "http://rails-bestpractices.com/posts/2-use-model-association"
+      url "http://rails-bestpractices.com/posts/2010/07/19/use-model-association/"
 
       # check method define nodes to see if there are some attribute assignments that can use model association instead.
       #

data/lib/rails_best_practices/reviews/use_multipart_alternative_as_content_type_of_email_review.rb

@@ -3,8 +3,7 @@ module RailsBestPractices
   module Reviews
     # Make sure to use multipart/alternative as content_type of email.
     #
-    # See the best practice details here
-    # http://rails-bestpractices.com/posts/41-use-multipart-alternative-as-content_type-of-email.
+    # See the best practice details here http://rails-bestpractices.com/posts/2010/08/05/use-multipart-alternative-as-content_type-of-email/
     #
     # Implementation:
     #
@@ -14,7 +13,7 @@ module RailsBestPractices
     class UseMultipartAlternativeAsContentTypeOfEmailReview < Review
       interesting_nodes :class, :def
       interesting_files MAILER_FILES
-      url "http://rails-bestpractices.com/posts/41-use-multipart-alternative-as-content_type-of-email"
+      url "http://rails-bestpractices.com/posts/2010/08/05/use-multipart-alternative-as-content_type-of-email/"
 
       # check class node to remember the ActionMailer class name.
       add_callback :start_class do |node|

data/lib/rails_best_practices/reviews/use_observer_review.rb

@@ -3,7 +3,7 @@ module RailsBestPractices
   module Reviews
     # Make sure to use observer (sorry we only check the mailer deliver now).
     #
-    # See the best practice details here http://rails-bestpractices.com/posts/19-use-observer.
+    # See the best practice details here http://rails-bestpractices.com/posts/2010/07/24/use-observer/
     #
     # TODO: we need a better solution, any suggestion?
     #
@@ -20,7 +20,7 @@ module RailsBestPractices
     class UseObserverReview < Review
       interesting_nodes :def, :command
       interesting_files MODEL_FILES
-      url "http://rails-bestpractices.com/posts/19-use-observer"
+      url "http://rails-bestpractices.com/posts/2010/07/24/use-observer/"
 
       def initialize(options = {})
         super

data/lib/rails_best_practices/reviews/use_query_attribute_review.rb

@@ -3,7 +3,7 @@ module RailsBestPractices
   module Reviews
     # Make sure to use query attribute instead of nil?, blank? and present?.
     #
-    # See the best practice details here http://rails-bestpractices.com/posts/56-use-query-attribute.
+    # See the best practice details here http://rails-bestpractices.com/posts/2010/10/03/use-query-attribute/
     #
     # Implementation:
     #
@@ -16,7 +16,7 @@ module RailsBestPractices
     class UseQueryAttributeReview < Review
       interesting_nodes :if, :unless, :elsif, :ifop, :if_mod, :unless_mod
       interesting_files ALL_FILES
-      url "http://rails-bestpractices.com/posts/56-use-query-attribute"
+      url "http://rails-bestpractices.com/posts/2010/10/03/use-query-attribute/"
 
       QUERY_METHODS = %w(nil? blank? present?)
 

data/lib/rails_best_practices/reviews/use_say_with_time_in_migrations_review.rb

@@ -4,8 +4,7 @@ module RailsBestPractices
     # Review a migration file to make sure to use say or say_with_time for customized data changes
     # to produce a more readable output.
     #
-    # See the best practice detials here
-    # http://rails-bestpractices.com/posts/46-use-say-and-say_with_time-in-migrations-to-make-a-useful-migration-log.
+    # See the best practice detials here http://rails-bestpractices.com/posts/2010/08/19/use-say-and-say_with_time-in-migrations-to-make-a-useful-migration-log/
     #
     # Implementation:
     #
@@ -17,7 +16,7 @@ module RailsBestPractices
     class UseSayWithTimeInMigrationsReview < Review
       interesting_nodes :defs
       interesting_files MIGRATION_FILES
-      url "http://rails-bestpractices.com/posts/46-use-say-and-say_with_time-in-migrations-to-make-a-useful-migration-log"
+      url "http://rails-bestpractices.com/posts/2010/08/19/use-say-and-say_with_time-in-migrations-to-make-a-useful-migration-log/"
 
       WITH_SAY_METHODS = %w(say say_with_time)
 

data/lib/rails_best_practices/reviews/use_scope_access_review.rb

@@ -3,7 +3,7 @@ module RailsBestPractices
   module Reviews
     # Review a controller to make sure to use scope access instead of manually checking current_user and redirect.
     #
-    # See the best practice details here http://rails-bestpractices.com/posts/3-use-scope-access.
+    # See the best practice details here http://rails-bestpractices.com/posts/2010/07/20/use-scope-access/
     #
     # Implementation:
     #
@@ -16,7 +16,7 @@ module RailsBestPractices
     class UseScopeAccessReview < Review
       interesting_nodes :if, :unless, :elsif, :ifop, :if_mod, :unless_mod
       interesting_files CONTROLLER_FILES
-      url "http://rails-bestpractices.com/posts/3-use-scope-access"
+      url "http://rails-bestpractices.com/posts/2010/07/20/use-scope-access/"
 
       # check if node.
       #

data/lib/rails_best_practices/reviews/use_turbo_sprockets_rails3_review.rb

@@ -3,7 +3,7 @@ module RailsBestPractices
   module Reviews
     # Prepare Gemfile and review Capfile file to make sure using turbo-sprocket-rails3
     #
-    # See the best practice details here http://rails-bestpractices.com/posts/704-speed-up-assets-precompile-with-turbo-sprockets-rails3
+    # See the best practice details here http://rails-bestpractices.com/posts/2012/11/23/speed-up-assets-precompile-with-turbo-sprockets-rails3/
     #
     # Implementation:
     #
@@ -12,7 +12,7 @@ module RailsBestPractices
     class UseTurboSprocketsRails3Review < Review
       interesting_nodes :command
       interesting_files CAPFILE
-      url "http://rails-bestpractices.com/posts/704-speed-up-assets-precompile-with-turbo-sprockets-rails3"
+      url "http://rails-bestpractices.com/posts/2012/11/23/speed-up-assets-precompile-with-turbo-sprockets-rails3/"
 
       # check command node to see if load 'deploy/assets'
       add_callback :start_command do |node|

data/lib/rails_best_practices/version.rb

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

data/rails_best_practices.gemspec

@@ -16,7 +16,6 @@ Gem::Specification.new do |s|
   s.required_rubygems_version = ">= 1.3.6"
 
   s.add_dependency("activesupport")
-  s.add_dependency("awesome_print")
   s.add_dependency("code_analyzer", ">= 0.4.3")
   s.add_dependency("colored")
   s.add_dependency("erubis")
@@ -30,6 +29,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency("haml")
   s.add_development_dependency("slim")
   s.add_development_dependency("bundler")
+  s.add_development_dependency("awesome_print")
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/spec/rails_best_practices/analyzer_spec.rb

@@ -47,6 +47,7 @@ module RailsBestPractices
         subject.stub(:output_terminal_errors)
         subject.stub(:output_html_errors)
         subject.stub(:output_yaml_errors)
+        subject.stub(:output_xml_errors)
 
         subject.output
       end
@@ -74,6 +75,15 @@ module RailsBestPractices
           expect(subject).to have_received(:output_html_errors)
         end
       end
+
+      context "when format is xml" do
+        let(:format) { "xml" }
+
+        it "runs xml output" do
+          expect(subject).to have_received(:output_xml_errors)
+        end
+      end
+
     end
 
     describe "output_terminal_errors" do

data/spec/rails_best_practices/prepares/route_prepare_spec.rb

@@ -469,7 +469,7 @@ module RailsBestPractices
             expect(routes.size).to eq(0)
           end
 
-          it "should add resource routes with get/post/put/delete routes" do
+          it "should add resource routes with get/post/put/patch/delete routes" do
             content =<<-EOF
             RailsBestPracticesCom::Application.routes.draw do
               resources :posts, only: [:show] do
@@ -481,14 +481,15 @@ module RailsBestPractices
                 post :create, on: :member
                 member do
                   put :update
+                  patch :update
                 end
               end
             end
             EOF
             runner.prepare('config/routes.rb', content)
             routes = Prepares.routes
-            expect(routes.size).to eq(6)
-            expect(routes.map(&:to_s)).to eq(["PostsController#show", "PostsController#list", "PostsController#search", "PostsController#available", "PostsController#create", "PostsController#update"])
+            expect(routes.size).to eq(7)
+            expect(routes.map(&:to_s)).to eq(["PostsController#show", "PostsController#list", "PostsController#search", "PostsController#available", "PostsController#create", "PostsController#update", "PostsController#update"])
           end
 
           it "should add custom resources routes with {}" do

data/spec/rails_best_practices/reviews/use_scope_access_review_spec.rb

@@ -6,7 +6,7 @@ module RailsBestPractices
       let(:runner) { Core::Runner.new(reviews: UseScopeAccessReview.new) }
 
       context "if" do
-        it "shoud use scope access" do
+        it "should use scope access" do
           content = <<-EOF
           class PostsController < ApplicationController
             def edit
@@ -24,7 +24,7 @@ module RailsBestPractices
           expect(runner.errors[0].to_s).to eq("app/controllers/posts_controller.rb:5 - use scope access")
         end
 
-        it "shoud use scope access with if in one line" do
+        it "should use scope access with if in one line" do
           content = <<-EOF
           class PostsController < ApplicationController
             def edit
@@ -39,7 +39,7 @@ module RailsBestPractices
           expect(runner.errors[0].to_s).to eq("app/controllers/posts_controller.rb:5 - use scope access")
         end
 
-        it "shoud use scope access with '? :'" do
+        it "should use scope access with '? :'" do
           content = <<-EOF
           class PostsController < ApplicationController
             def edit
@@ -54,7 +54,7 @@ module RailsBestPractices
           expect(runner.errors[0].to_s).to eq("app/controllers/posts_controller.rb:5 - use scope access")
         end
 
-        it "shoud use scope access by comparing with id" do
+        it "should use scope access by comparing with id" do
           content = <<-EOF
           class PostsController < ApplicationController
             def edit
@@ -72,7 +72,7 @@ module RailsBestPractices
           expect(runner.errors[0].to_s).to eq("app/controllers/posts_controller.rb:5 - use scope access")
         end
 
-        it "shoud use scope access with current_user ==" do
+        it "should use scope access with current_user ==" do
           content = <<-EOF
           class PostsController < ApplicationController
             def edit
@@ -90,7 +90,7 @@ module RailsBestPractices
           expect(runner.errors[0].to_s).to eq("app/controllers/posts_controller.rb:5 - use scope access")
         end
 
-        it "shoud use scope access by current_user.id ==" do
+        it "should use scope access by current_user.id ==" do
           content = <<-EOF
           class PostsController < ApplicationController
             def edit
@@ -110,7 +110,7 @@ module RailsBestPractices
       end
 
       context "unless" do
-        it "shoud use scope access" do
+        it "should use scope access" do
           content = <<-EOF
           class PostsController < ApplicationController
             def edit
@@ -128,7 +128,7 @@ module RailsBestPractices
           expect(runner.errors[0].to_s).to eq("app/controllers/posts_controller.rb:5 - use scope access")
         end
 
-        it "shoud use scope access by comparing with id" do
+        it "should use scope access by comparing with id" do
           content = <<-EOF
           class PostsController < ApplicationController
             def edit
@@ -146,7 +146,7 @@ module RailsBestPractices
           expect(runner.errors[0].to_s).to eq("app/controllers/posts_controller.rb:5 - use scope access")
         end
 
-        it "shoud use scope access with current_user ==" do
+        it "should use scope access with current_user ==" do
           content = <<-EOF
           class PostsController < ApplicationController
             def edit
@@ -164,7 +164,7 @@ module RailsBestPractices
           expect(runner.errors[0].to_s).to eq("app/controllers/posts_controller.rb:5 - use scope access")
         end
 
-        it "shoud use scope access by current_user.id ==" do
+        it "should use scope access by current_user.id ==" do
           content = <<-EOF
           class PostsController < ApplicationController
             def edit

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_best_practices
 version: !ruby/object:Gem::Version
-  version: 1.15.4
+  version: 1.15.6
 platform: ruby
 authors:
 - Richard Huang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-12 00:00:00.000000000 Z
+date: 2015-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -24,20 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: awesome_print
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: code_analyzer
   requirement: !ruby/object:Gem::Requirement
@@ -206,6 +192,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: a code metric tool for rails codes, written in Ruby.
 email:
 - flyerhzm@gmail.com
@@ -413,7 +413,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: a code metric tool for rails codes.