rails_best_practices 1.18.1 → 1.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b28f335fee20969fe2276bdd1167772552262162
-  data.tar.gz: aff5bdb928fbae84063f42e0b79bc72c2766d11c
+  metadata.gz: a21a8ed1b2556fb543a2e0198c20cc0e1717408c
+  data.tar.gz: 5590f1f768fbe89156474a9b6c6e2d3876f0ab7b
 SHA512:
-  metadata.gz: 9650af54486b7bf655ed79287e43e70c43314d2353a3a68680ff9a17a7c4548056b48b67e3e0ce7d4d9af76f5d087138d6119e6026c816f70e566e63b38883ca
-  data.tar.gz: ea4bb8533886d4bd11e25af6eb19c2a354aae861ccf7f9fba22636b0d78da6d97a15626984c9d7ec72b48440107a1766790845c4df8964621e9cbf7fb5811695
+  metadata.gz: 9ade021d411ca4b45c36628ba5a9bed899b0ffcde8b5ca7289171c08aa2493b5c9a04cad2af7758cb50a0f8fdae1f9b5ec4d40396a97145a33d7b32c7630ea82
+  data.tar.gz: 4ac6bfab4420bac0d7476b2694123fa43d21eb5936a85bdea86f0cb3a17e86d308efac99927aa5325d467bc4bb4b1d6e4c41b7d67405198491add9ee63bf60dc

data/.travis.yml

@@ -2,4 +2,4 @@ sudo: false
 language: ruby
 cache: bundler
 rvm:
-  - 2.3.0
+  - 2.3.3

data/CHANGELOG.md

@@ -1,8 +1,11 @@
 # Next Release
 
-## 1.18.1
+## 1.19.0 (2017-07-26)
 
+* RestrictAutoGeneratedRoutesCheck is compatibale with rails api_only
+* Remove Rails 2 support
 * Remove haml ugly option
+* Fix RemoveUnusedMethodsInControllers warning at inline routes
 
 ## 1.18.0 (2017-03-01)
 

data/Gemfile

@@ -4,10 +4,10 @@ gemspec
 gem 'coveralls', require: false
 
 if RUBY_PLATFORM =~ /darwin/i
-  gem 'rb-fsevent'
   gem 'growl'
+  gem 'rb-fsevent'
 end
-gem 'pry'
 gem 'guard'
-gem 'rspec', '~> 2.14.0'
 gem 'guard-rspec'
+gem 'pry'
+gem 'rspec', '~> 2.14.0'

data/README.md

@@ -1,7 +1,7 @@
 # rails_best_practices
 
 [![Gem Version](https://badge.fury.io/rb/rails_best_practices.svg)](http://badge.fury.io/rb/rails_best_practices)
-[![Build Status](https://secure.travis-ci.org/railsbp/rails_best_practices.svg)](http://travis-ci.org/railsbp/rails_best_practices)
+[![Build Status](https://secure.travis-ci.org/flyerhzm/rails_best_practices.svg)](http://travis-ci.org/flyerhzm/rails_best_practices)
 [![Coverage Status](https://coveralls.io/repos/railsbp/rails_best_practices/badge.svg?branch=master)](https://coveralls.io/r/railsbp/rails_best_practices)
 
 [![Coderwall Endorse](http://api.coderwall.com/flyerhzm/endorsecount.png)](http://coderwall.com/flyerhzm)

data/Rakefile

@@ -6,7 +6,6 @@ Bundler.setup
 require "rake"
 require "rspec"
 require "rspec/core/rake_task"
-require 'rubocop/rake_task'
 
 $LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
 require "rails_best_practices/version"
@@ -15,7 +14,5 @@ RSpec::Core::RakeTask.new(:spec) do |spec|
   spec.pattern = "spec/**/*_spec.rb"
 end
 
-RuboCop::RakeTask.new
-
-task :default => [:spec, :rubocop]
+task :default => :spec
 task :test => :spec

data/lib/rails_best_practices/analyzer.rb

@@ -4,7 +4,7 @@ require 'json'
 require 'ruby-progressbar'
 
 module RailsBestPractices
-  # RailsBestPractices Analyzer helps you to analyze your rails code, according to best practices on http://rails-bestpractices.
+  # RailsBestPractices Analyzer helps you to analyze your rails code, according to best practices on https://rails-bestpractices.
   # if it finds any violatioins to best practices, it will give you some readable suggestions.
   #
   # The analysis process is partitioned into two parts,
@@ -180,7 +180,7 @@ module RailsBestPractices
     # output errors on terminal.
     def output_terminal_errors
       errors.each { |error| plain_output(error.to_s, 'red') }
-      plain_output("\nPlease go to http://rails-bestpractices.com to see more useful Rails Best Practices.", 'green')
+      plain_output("\nPlease go to https://rails-bestpractices.com to see more useful Rails Best Practices.", 'green')
       if errors.empty?
         plain_output("\nNo warning found. Cool!", 'green')
       else
@@ -226,7 +226,7 @@ module RailsBestPractices
 
       if @options["with-github"]
         last_commit_id = @options["last-commit-id"] ? @options["last-commit-id"] : `cd #{@runner.class.base_path} && git rev-parse HEAD`.chomp
-        unless @options["github-name"].start_with?('http')
+        unless @options["github-name"].start_with?('https')
           @options["github-name"] = GITHUB_URL + @options["github-name"]
         end
       end

data/lib/rails_best_practices/core/routes.rb

@@ -22,7 +22,7 @@ module RailsBestPractices
 
         # mappings can be specified by e.g.
         #   post 'some/:pattern' => 'controller#action'
-        if action_name =~ /^(\w+)#(\w+)$/
+        if action_name.is_a?(String) && action_name =~ /\A(\w+)#(\w+)\z/
           controller_name = $1
           action_name = $2
         end

data/lib/rails_best_practices/lexicals/remove_tab_check.rb

@@ -3,10 +3,10 @@ module RailsBestPractices
   module Lexicals
     # Make sure there are no tabs in files.
     #
-    # See the best practice details here http://rails-bestpractices.com/posts/2011/07/04/remove-tab/
+    # See the best practice details here https://rails-bestpractices.com/posts/2011/07/04/remove-tab/
     class RemoveTabCheck < Core::Check
       interesting_files ALL_FILES
-      url "http://rails-bestpractices.com/posts/2011/07/04/remove-tab/"
+      url "https://rails-bestpractices.com/posts/2011/07/04/remove-tab/"
 
       # check if the content of file contains a tab.
       #

data/lib/rails_best_practices/lexicals/remove_trailing_whitespace_check.rb

@@ -3,10 +3,10 @@ module RailsBestPractices
   module Lexicals
     # Make sure there are no trailing whitespace in codes.
     #
-    # See the best practice details here http://rails-bestpractices.com/posts/2010/12/02/remove-trailing-whitespace/
+    # See the best practice details here https://rails-bestpractices.com/posts/2010/12/02/remove-trailing-whitespace/
     class RemoveTrailingWhitespaceCheck < Core::Check
       interesting_files ALL_FILES
-      url "http://rails-bestpractices.com/posts/2010/12/02/remove-trailing-whitespace/"
+      url "https://rails-bestpractices.com/posts/2010/12/02/remove-trailing-whitespace/"
 
       # check if the content of file contain a trailing whitespace.
       #

data/lib/rails_best_practices/prepares/route_prepare.rb

@@ -37,6 +37,10 @@ module RailsBestPractices
               else
                 action_names = [second_argument.hash_value("to").to_s]
               end
+            elsif :symbol_literal == first_argument.sexp_type && second_argument.try(:sexp_type) && \
+              :symbol_literal == second_argument.sexp_type
+              action_names = node.arguments.all.select \
+                {|arg| :symbol_literal == arg.sexp_type }.map(&:to_s)
             else
               action_names = [first_argument.to_s]
             end
@@ -109,6 +113,7 @@ module RailsBestPractices
         end
       end
 
+      # TODO: should remove but breaks some tests
       # remember route for rails2.
       add_callback :start_command_call do |node|
         case node.message.to_s

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/2010/07/21/add-model-virtual-attribute/
+    # See the best practice details here https://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/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.
       #

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/2010/07/24/always-add-db-index/
+    # See the best practice details here https://rails-bestpractices.com/posts/2010/07/24/always-add-db-index/
     #
     # Implementation:
     #
@@ -25,7 +25,7 @@ module RailsBestPractices
     class AlwaysAddDbIndexReview < Review
       interesting_nodes :command, :command_call
       interesting_files SCHEMA_FILE
-      url "http://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)

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", "update_attributes"
     # and "create" or use "save!", "update_attributes!", or "create!", respectively.
     #
-    # See the best practice details here http://rails-bestpractices.com/posts/2012/11/02/check-the-return-value-of-save-otherwise-use-save/
+    # See the best practice details here https://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/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

@@ -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/2013/06/15/default_scope-is-evil/
+    # See the best practice details here https://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/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|

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/2010/09/02/dry-bundler-in-capistrano/
+    # See the best practice details here https://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/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|

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/2010/07/24/isolating-seed-data/
+    # See the best practice details here https://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/2010/07/24/isolating-seed-data/"
+      url "https://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/2010/07/23/keep-finders-on-their-own-model/
+    # See the best practice details here https://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/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)
 

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/2010/07/24/the-law-of-demeter/
+    # See the best practice details here https://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/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)
 

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/2010/07/24/move-code-into-controller/
+    # See the best practice details here https://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/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)
 

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/2010/07/24/move-code-into-helper/
+    # See the best practice details here https://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/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)

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/2010/07/24/move-code-into-model/
+    # See the best practice details here https://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/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

@@ -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/2010/07/14/move-finder-to-named_scope/
+    # See the best practice details here https://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/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)
 

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/2010/07/21/move-model-logic-into-the-model/
+    # See the best practice details here https://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/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

@@ -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/2010/07/22/needless-deep-nesting/
+    # See the best practice details here https://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/2010/07/22/needless-deep-nesting/"
+      url "https://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/2012/11/01/don-t-rescue-exception-rescue-standarderror/
+    # See the best practice details here https://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/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|

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/2010/07/22/not-use-default-route-if-you-use-restful-design/
+    # See the best practice details here https://rails-bestpractices.com/posts/2010/07/22/not-use-default-route-if-you-use-restful-design/
     #
     # Implementation:
     #
@@ -19,18 +19,9 @@ module RailsBestPractices
     class NotUseDefaultRouteReview < Review
       interesting_nodes :command_call, :command
       interesting_files ROUTE_FILES
-      url "http://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 call nodes, compare with rails2 default route
-      add_callback :start_command_call do |node|
-        if "map" == node.receiver.to_s && "connect" == node.message.to_s &&
-          (":controller/:action/:id" == node.arguments.all.first.to_s ||
-           ":controller/:action/:id.:format" == node.arguments.all.first.to_s)
-          add_error "not use default route"
-        end
-      end
-
-      # check all command nodes, compare with rails3 default route
+      # 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