rails_best_practices 1.15.1 → 1.15.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aad6be6297629a1706250552dd2dc67a88d088f4
-  data.tar.gz: 7416b40f8860088f0ef6734f44fb7dc68531a226
+  metadata.gz: 16424767a639f93e65221ccb0a759de20b7ce9fa
+  data.tar.gz: ce5f1080da4406d14d893246af12360ada46308f
 SHA512:
-  metadata.gz: d3ccfe6ee0f2164b49c2d00db11505d858b0750c9167d39e7e9e3da251d3d7e4a122e7601dc158efc462bcc5a422c94c65e6e02ccce95fa68ac2a787fd30eaad
-  data.tar.gz: 1be5179a45ca10b0b5ebb3436bf56af16fcca01a35ff93d8846365eb8390bda417750945ea2c21eec659b68cbde1cfd17e67dbdbecbddb1ad2f2d4c5a337d93d
+  metadata.gz: 998a80e8e4399e80a8cb555ac596a2758c8beea6bd2f7e8fe13017b4a8931baa40efd2f892a899733dd94803418bdadde63069e21cd351e5dee9db49a2ce8adc
+  data.tar.gz: fb113c8116c5b0e575d2b6fed6e500b83bad9d96fbace45bdbfbb1eca6f5ebf77648ba1af5e16a09327e7a6eb1dc90e9a29e4b1268e9b4cfd2c8b57fe03caaaf

data/lib/rails_best_practices/core/check.rb

@@ -347,13 +347,7 @@ module RailsBestPractices
             # check if the method is in the except methods list.
             def excepted?(method)
               is_ignored?(method.file) ||
-              except_methods.any? do |except_method|
-                class_name, method_name = except_method.split('#')
-                (class_name == '*' && method_name == method.method_name) ||
-                  (method_name == '*' && class_name == method.class_name) ||
-                  (method_name == '*' && class_name == Prepares.klasses.find { |klass| klass.class_name == method.class_name }.try(:extend_class_name)) ||
-                  (class_name == method.class_name && method_name == method.method_name)
-              end
+              except_methods.any? { |except_method| Exceptable.matches method, except_method }
             end
 
             def internal_except_methods
@@ -361,6 +355,29 @@ module RailsBestPractices
             end
           end
         end
+
+        def self.matches method, except_method
+          class_name, method_name = except_method.split('#')
+
+          method_name = ".*" if method_name == "*"
+          method_expression = Regexp.new method_name
+          matched = method.method_name =~ method_expression
+
+          if matched
+            class_name = ".*" if class_name == "*"
+            class_expression = Regexp.new class_name
+
+            class_names = Prepares.klasses
+                                  .select { |klass| klass.class_name == method.class_name }
+                                  .map(&:extend_class_name)
+                                  .compact
+
+            class_names.unshift method.class_name
+            matched = class_names.any? { |name| name =~ class_expression }
+          end
+
+          !!matched
+        end
       end
 
       # Helper to parse the access control.

data/lib/rails_best_practices/core/checks_loader.rb

@@ -0,0 +1,48 @@
+# encoding: utf-8
+module RailsBestPractices
+  module Core
+    class ChecksLoader
+      def initialize(config)
+        @config = config
+      end
+
+      # load all lexical checks.
+      def load_lexicals
+        load_checks_from_config { |check_name| RailsBestPractices::Lexicals.const_get(check_name) }
+      end
+
+      # load all reviews according to configuration.
+      def load_reviews
+        load_checks_from_config { |check_name| RailsBestPractices::Reviews.const_get(check_name.gsub(/Check$/, 'Review')) }
+      end
+
+      private
+        # read the checks from yaml config.
+        def checks_from_config
+          @checks ||= YAML.load_file @config
+        end
+
+        # load all checks from the configuration
+        def load_checks_from_config(&block)
+          checks_from_config.inject([]) do |active_checks, check|
+            check_instance = instantiate_check(block, *check)
+            active_checks << check_instance unless check_instance.nil?
+            active_checks
+          end
+        end
+
+        # instantiates a check
+        def instantiate_check(block, check_name, options)
+          check_class = load_check_class(check_name, &block)
+          check_class.new(options || {}) unless check_class.nil?
+        end
+
+        # loads the class for a check by calling the given block
+        def load_check_class(check_name, &block)
+          block.call(check_name)
+        rescue NameError
+          # nothing to do, the check does not exist
+        end
+    end
+  end
+end

data/lib/rails_best_practices/core/runner.rb

@@ -43,9 +43,11 @@ module RailsBestPractices
         lexicals = Array(options[:lexicals])
         prepares = Array(options[:prepares])
         reviews = Array(options[:reviews])
-        @lexicals = lexicals.empty? ? load_lexicals : lexicals
+
+        checks_loader = ChecksLoader.new(@config)
+        @lexicals = lexicals.empty? ? checks_loader.load_lexicals : lexicals
         @prepares = prepares.empty? ? load_prepares : prepares
-        @reviews = reviews.empty? ? load_reviews : reviews
+        @reviews = reviews.empty? ? checks_loader.load_reviews : reviews
         load_plugin_reviews if reviews.empty?
 
         @lexical_checker ||= CodeAnalyzer::CheckingVisitor::Plain.new(checkers: @lexicals)
@@ -66,7 +68,7 @@ module RailsBestPractices
         @lexical_checker.after_check
       end
 
-      # parepare the file.
+      # prepare the file.
       #
       # @param [String] filename of the file
       # @param [String] content of the file
@@ -101,7 +103,7 @@ module RailsBestPractices
       end
 
       private
-        # parse html tempalte code, erb, haml and slim.
+        # parse html template code, erb, haml and slim.
         #
         # @param [String] filename is the filename of the erb, haml or slim code.
         # @param [String] content is the source code of erb, haml or slim file.
@@ -132,41 +134,11 @@ module RailsBestPractices
           content
         end
 
-        # load all lexical checks.
-        def load_lexicals
-          checks_from_config.inject([]) { |active_checks, check|
-            begin
-              check_name, options = *check
-              klass = RailsBestPractices::Lexicals.const_get(check_name)
-              options = Hash(options)
-              active_checks << (options.empty? ? klass.new : klass.new(options))
-            rescue
-              # the check does not exist in the Lexicals namepace.
-            end
-            active_checks
-          }
-        end
-
         # load all prepares.
         def load_prepares
           Prepares.constants.map { |prepare| Prepares.const_get(prepare).new }
         end
 
-        # load all reviews according to configuration.
-        def load_reviews
-          checks_from_config.inject([]) { |active_checks, check|
-            begin
-              check_name, options = *check
-              klass = RailsBestPractices::Reviews.const_get(check_name.gsub(/Check$/, 'Review'))
-              options = Hash(options)
-              active_checks << (options.empty? ? klass.new : klass.new(options))
-            rescue
-              # the check does not exist in the Reviews namepace.
-            end
-            active_checks
-          }
-        end
-
         # load all plugin reviews.
         def load_plugin_reviews
           begin
@@ -183,19 +155,6 @@ module RailsBestPractices
             end
           end
         end
-
-        # read the checks from yaml config.
-        def checks_from_config
-          @checks ||= YAML.load_file @config
-        end
-
-        # read the file content.
-        #
-        # @param [String] filename
-        # @return [String] file conent
-        def read_file(filename)
-          File.open(filename, "r:UTF-8") { |f| f.read }
-        end
     end
   end
 end

data/lib/rails_best_practices/reviews/remove_unused_methods_in_controllers_review.rb

@@ -105,7 +105,7 @@ module RailsBestPractices
         end
 
         def internal_except_methods
-          %w(rescue_action).map { |method_name| "*\##{method_name}" } +
+          %w(rescue_action default_url_options).map { |method_name| "*\##{method_name}" } +
             %w(Devise::OmniauthCallbacksController).map { |controller_name| "#{controller_name}#*" }
         end
 

data/lib/rails_best_practices/reviews/restrict_auto_generated_routes_review.rb

@@ -29,6 +29,9 @@ module RailsBestPractices
       # check if the generated routes have the corresponding actions in controller for rails routes.
       add_callback :start_command, :start_command_call do |node|
         if "resources" == node.message.to_s
+          if (mod = module_option(node))
+            @namespaces << mod
+          end
           check_resources(node)
           @resource_controllers << node.arguments.all.first.to_s
         elsif "resource" == node.message.to_s
@@ -40,6 +43,7 @@ module RailsBestPractices
       add_callback :end_command do |node|
         if "resources" == node.message.to_s
           @resource_controllers.pop
+          @namespaces.pop if module_option(node)
         elsif "resource" == node.message.to_s
           @resource_controllers.pop
         end
@@ -52,6 +56,10 @@ module RailsBestPractices
           @namespaces << node.arguments.all.first.to_s if check_method_add_block?(node)
         when "resources", "resource"
           @resource_controllers << node.arguments.all.first.to_s if check_method_add_block?(node)
+        when 'scope'
+          if check_method_add_block?(node) && (mod = module_option(node))
+            @namespaces << mod
+          end
         else
         end
       end
@@ -64,6 +72,10 @@ module RailsBestPractices
             @namespaces.pop
           when "resources", "resource"
             @resource_controllers.pop
+          when 'scope'
+            if check_method_add_block?(node) && module_option(node)
+              @namespaces.pop
+            end
           end
         end
       end
@@ -143,6 +155,13 @@ module RailsBestPractices
           end
         end
 
+        def module_option(node)
+          option_node = node.arguments[1].last
+          if option_node && option_node.sexp_type == :bare_assoc_hash && hash_key_exist?(option_node, 'module')
+            option_node.hash_value('module').to_s
+          end
+        end
+
         def option_with_hash(node)
           node.arguments.all.size > 1 && :bare_assoc_hash == node.arguments.all[1].sexp_type
         end

data/lib/rails_best_practices/reviews/use_observer_review.rb

@@ -22,7 +22,7 @@ module RailsBestPractices
       interesting_files MODEL_FILES
       url "http://rails-bestpractices.com/posts/19-use-observer"
 
-      def initialize
+      def initialize(options = {})
         super
         @callbacks = []
       end

data/lib/rails_best_practices/version.rb

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

data/spec/rails_best_practices/core/checks_loader_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+module RailsBestPractices::Core
+  describe ChecksLoader do
+    let(:checks_loader) { ChecksLoader.new(RailsBestPractices::Analyzer::DEFAULT_CONFIG) }
+
+    describe "load_lexicals" do
+      it "should load lexical checks from the default configuration" do
+        lexicals = checks_loader.load_lexicals
+        expect(lexicals.map(&:class)).to include(RailsBestPractices::Lexicals::RemoveTrailingWhitespaceCheck)
+      end
+    end
+
+    describe "load_reviews" do
+      it "should load the reviews from the default the configuration" do
+        reviews = checks_loader.load_reviews
+        expect(reviews.map(&:class)).to include(RailsBestPractices::Reviews::AlwaysAddDbIndexReview)
+      end
+    end
+  end
+end

data/spec/rails_best_practices/core/except_methods_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+
+module RailsBestPractices::Core
+  describe Check::Exceptable do
+    let(:method) { Method.new "BlogPost", "approve", "public", {} }
+
+    context "wildcard class and method" do
+      let(:except_method) { '*#*' }
+
+      it "matches" do
+        expect(Check::Exceptable.matches(method, except_method)).to eql true
+      end
+    end
+
+    context "wildcard class and matching explicit method" do
+      let(:except_method) { '*#approve' }
+
+      it "matches" do
+        expect(Check::Exceptable.matches(method, except_method)).to eql true
+      end
+    end
+
+    context "wildcard class and non-matching explicit method" do
+      let(:except_method) { '*#disapprove' }
+
+      it "matches" do
+        expect(Check::Exceptable.matches(method, except_method)).to eql false
+      end
+    end
+
+    context "matching class and wildcard method" do
+      let(:except_method) { 'BlogPost#*' }
+
+      it "matches" do
+        expect(Check::Exceptable.matches(method, except_method)).to eql true
+      end
+    end
+
+    context "non-matching class and wildcard method" do
+      let(:except_method) { 'User#*' }
+
+      it "matches" do
+        expect(Check::Exceptable.matches(method, except_method)).to eql false
+      end
+    end
+
+    context "matching class and matching method" do
+      let(:except_method) { 'BlogPost#approve' }
+
+      it "matches" do
+        expect(Check::Exceptable.matches(method, except_method)).to eql true
+      end
+    end
+
+    context "non-matching class and non-matching method" do
+      let(:except_method) { 'User#disapprove' }
+
+      it "matches" do
+        expect(Check::Exceptable.matches(method, except_method)).to eql false
+      end
+    end
+  end
+end

data/spec/rails_best_practices/reviews/restrict_auto_generated_routes_review_spec.rb

@@ -186,7 +186,7 @@ module RailsBestPractices
           end
 
           describe "namespace" do
-            it "should restrict auto-generated routes" do
+            before do
               content =<<-EOF
               class Admin::CommentsController < ApplicationController
                 def show; end
@@ -198,7 +198,9 @@ module RailsBestPractices
               end
               EOF
               runner.prepare('app/controllers/admin/comments_controller.rb', content)
+            end
 
+            it "should restrict auto-generated routes" do
               content =<<-EOF
               RailsBestPracticesCom::Application.routes.draw do
                 namespace :admin do
@@ -210,6 +212,30 @@ module RailsBestPractices
               expect(runner.errors.size).to eq(1)
               expect(runner.errors[0].to_s).to eq("config/routes.rb:3 - restrict auto-generated routes admin/comments (except: [:index])")
             end
+
+            it "should restrict auto-generated routes with scope :module" do
+              content =<<-EOF
+              RailsBestPracticesCom::Application.routes.draw do
+                scope module: :admin do
+                  resources :comments
+                end
+              end
+              EOF
+              runner.review('config/routes.rb', content)
+              expect(runner.errors.size).to eq(1)
+              expect(runner.errors[0].to_s).to eq("config/routes.rb:3 - restrict auto-generated routes admin/comments (except: [:index])")
+            end
+
+            it "should restrict auto-generated routes with resources :module" do
+              content =<<-EOF
+              RailsBestPracticesCom::Application.routes.draw do
+                resources :comments, module: :admin
+              end
+              EOF
+              runner.review('config/routes.rb', content)
+              expect(runner.errors.size).to eq(1)
+              expect(runner.errors[0].to_s).to eq("config/routes.rb:2 - restrict auto-generated routes admin/comments (except: [:index])")
+            end
           end
 
           describe "nested routes" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_best_practices
 version: !ruby/object:Gem::Version
-  version: 1.15.1
+  version: 1.15.2
 platform: ruby
 authors:
 - Richard Huang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-05 00:00:00.000000000 Z
+date: 2014-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -200,7 +200,6 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gemtest"
 - ".gitignore"
 - ".rspec"
 - ".ruby-version"
@@ -218,6 +217,7 @@ files:
 - lib/rails_best_practices/command.rb
 - lib/rails_best_practices/core.rb
 - lib/rails_best_practices/core/check.rb
+- lib/rails_best_practices/core/checks_loader.rb
 - lib/rails_best_practices/core/configs.rb
 - lib/rails_best_practices/core/controllers.rb
 - lib/rails_best_practices/core/error.rb
@@ -294,9 +294,11 @@ files:
 - spec/fixtures/lib/rails_best_practices/plugins/reviews/not_use_rails_root_review.rb
 - spec/rails_best_practices/analyzer_spec.rb
 - spec/rails_best_practices/core/check_spec.rb
+- spec/rails_best_practices/core/checks_loader_spec.rb
 - spec/rails_best_practices/core/configs_spec.rb
 - spec/rails_best_practices/core/controllers_spec.rb
 - spec/rails_best_practices/core/error_spec.rb
+- spec/rails_best_practices/core/except_methods_spec.rb
 - spec/rails_best_practices/core/gems_spec.rb
 - spec/rails_best_practices/core/helpers_spec.rb
 - spec/rails_best_practices/core/klasses_spec.rb
@@ -406,9 +408,11 @@ test_files:
 - spec/fixtures/lib/rails_best_practices/plugins/reviews/not_use_rails_root_review.rb
 - spec/rails_best_practices/analyzer_spec.rb
 - spec/rails_best_practices/core/check_spec.rb
+- spec/rails_best_practices/core/checks_loader_spec.rb
 - spec/rails_best_practices/core/configs_spec.rb
 - spec/rails_best_practices/core/controllers_spec.rb
 - spec/rails_best_practices/core/error_spec.rb
+- spec/rails_best_practices/core/except_methods_spec.rb
 - spec/rails_best_practices/core/gems_spec.rb
 - spec/rails_best_practices/core/helpers_spec.rb
 - spec/rails_best_practices/core/klasses_spec.rb