rails_best_practices 1.19.2 → 1.20.1

data/lib/rails_best_practices/cli.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module RailsBestPractices
+  class CLI
+    # Run analyze with ruby code
+    # @param [Array] argv command argments
+    # @return [Boolean] return true, if there is no violation.
+    # @example
+    #   RailsBestPractices::CLI.run(['-d', '-o', 'path/to/file'])
+    def self.run(argv)
+      options = OptionParser.parse!(argv)
+      if !argv.empty? && !File.exist?(argv.first)
+        raise Errno::ENOENT, "#{argv.first} doesn't exist"
+      end
+
+      analyzer = Analyzer.new(argv.first, options)
+      analyzer.analyze
+      analyzer.output
+      analyzer.runner.errors.empty?
+    end
+  end
+end

data/lib/rails_best_practices/command.rb

@@ -1,137 +1,7 @@
 # frozen_string_literal: true
 
 require 'optparse'
-
-# Usage: rails_best_practices [options] path
-#    -d, --debug                      debug mode
-#        --silent                     silent mode
-#    -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
-#        --with-sublime               open file by sublime in html format (requires subl-handler)
-#        --with-mvim                  open file by mvim in html format
-#        --with-github GITHUB_NAME    open file on github in html format, GITHUB_NAME is like railsbp/rails-bestpractices.com
-#        --with-git                   display git commit and username, only support html format
-#        --with-hg                    display hg commit and username, only support html format
-#        --template TEMPLATE          customize erb template
-#        --vendor                     include vendor files
-#        --spec                       include spec files
-#        --test                       include test files
-#        --features                   include features files
-#    -x, --exclude PATTERNS           don't analyze files matching a pattern
-#                                     (comma-separated regexp list)
-#    -o, --only PATTERNS              analyze files only matching a pattern
-#                                     (comma-separated regexp list)
-#    -g, --generate                   generate configuration yaml
-#    -v, --version                    show this version
-#    -h, --help                       show this message
-
-options = {}
-
-OptionParser.new do |opts|
-  opts.banner = 'Usage: rails_best_practices [options] path'
-
-  opts.on('-d', '--debug', 'Debug mode') do
-    options['debug'] = true
-  end
-
-  opts.on('-f', '--format FORMAT', 'output format (text, html, yml, json, xml)') do |format|
-    options['format'] = format
-  end
-
-  opts.on('--without-color', 'only output plain text without color') do
-    options['without-color'] = true
-  end
-
-  opts.on('--with-textmate', 'open file by textmate in html format') do
-    options['with-textmate'] = true
-  end
-
-  opts.on('--with-sublime', 'open file by sublime in html format') do
-    options['with-sublime'] = true
-  end
-
-  opts.on('--with-mvim', 'open file by mvim in html format') do
-    options['with-mvim'] = true
-  end
-
-  opts.on('--with-github GITHUB_NAME', 'open file on github in html format') do |github_name|
-    options['with-github'] = true
-    options['github-name'] = github_name
-  end
-
-  opts.on('--last-commit-id COMMIT_ID', 'last commit id') do |commit_id|
-    options['last-commit-id'] = commit_id
-  end
-
-  opts.on('--with-hg', 'display hg commit and username, only support html format') do
-    options['with-hg'] = true
-  end
-
-  opts.on('--with-git', 'display git commit and username, only support html format') do
-    options['with-git'] = true
-  end
-
-  opts.on('--template TEMPLATE', 'customize erb template') do |template|
-    options['template'] = template
-  end
-
-  opts.on('--output-file OUTPUT_FILE', 'output html file for the analyzing result') do |output_file|
-    options['output-file'] = output_file
-  end
-
-  opts.on('--silent', 'silent mode') do
-    options['silent'] = true
-  end
-
-  %w[vendor spec test features].each do |pattern|
-    opts.on("--#{pattern}", "include #{pattern} files") do
-      options[pattern] = true
-    end
-  end
-
-  opts.on_tail('-v', '--version', 'Show this version') do
-    require 'rails_best_practices/version'
-    puts RailsBestPractices::VERSION
-    exit
-  end
-
-  opts.on_tail('-h', '--help', 'Show this message') do
-    puts opts
-    exit
-  end
-
-  opts.on('-x', '--exclude PATTERNS', "Don't analyze files matching a pattern", '(comma-separated regexp list)') do |list|
-    begin
-      options['exclude'] = list.split(',').map { |x| Regexp.new x }
-    rescue RegexpError => e
-      raise OptionParser::InvalidArgument, e.message
-    end
-  end
-
-  opts.on('-o', '--only PATTERNS', 'Analyze files only matching a pattern', '(comma-separated regexp list)') do |list|
-    begin
-      options['only'] = list.split(',').map { |x| Regexp.new x }
-    rescue RegexpError => e
-      raise OptionParser::InvalidArgument e.message
-    end
-  end
-
-  opts.on('-g', '--generate', 'Generate configuration yaml') do
-    options['generate'] = true
-  end
-
-  opts.on(
-    '-c',
-    '--config CONFIG_PATH', 'configuration file location (defaults to config/rails_best_practices.yml)'
-  ) do |config_path|
-    options['config'] = config_path
-  end
-
-  opts.parse!
-end
-
+options = RailsBestPractices::OptionParser.parse!
 if !ARGV.empty? && !File.exist?(ARGV.first)
   puts "#{ARGV.first} doesn't exist"
   exit 1

data/lib/rails_best_practices/core/check.rb

@@ -3,24 +3,25 @@
 module RailsBestPractices
   module Core
     # A Check class that takes charge of checking the sexp.
+
     class Check < CodeAnalyzer::Checker
-      ALL_FILES = /.*/
-      CONTROLLER_FILES = /app\/(controllers|cells)\/.*\.rb$/
-      MIGRATION_FILES = /db\/migrate\/.*\.rb$/
-      MODEL_FILES = /app\/models\/.*\.rb$/
-      MAILER_FILES = /app\/models\/.*mailer\.rb$|app\/mailers\/.*\.rb/
-      VIEW_FILES = /app\/(views|cells)\/.*\.(erb|haml|slim|builder|rxml)$/
-      PARTIAL_VIEW_FILES = /app\/(views|cells)\/.*\/_.*\.(erb|haml|slim|builder|rxml)$/
-      ROUTE_FILES = /config\/routes.*\.rb/
-      SCHEMA_FILE = /db\/schema\.rb/
-      HELPER_FILES = /app\/helpers\/.*\.rb$/
-      DEPLOY_FILES = /config\/deploy.*\.rb/
-      CONFIG_FILES = /config\/(application|environment|environments\/.*)\.rb/
-      INITIALIZER_FILES = /config\/initializers\/.*\.rb/
-      CAPFILE = /Capfile/
-      GEMFILE_LOCK = /Gemfile\.lock/
-
-      SKIP_FILES = /db\/schema.rb/
+      ALL_FILES = /.*/.freeze
+      CONTROLLER_FILES = %r{app/(controllers|cells)/.*\.rb$}.freeze
+      MIGRATION_FILES = %r{db/migrate/.*\.rb$}.freeze
+      MODEL_FILES = %r{app/models/.*\.rb$}.freeze
+      MAILER_FILES = %r{app/models/.*mailer\.rb$|app/mailers/.*\.rb}.freeze
+      VIEW_FILES = %r{app/(views|cells)/.*\.(erb|haml|slim|builder|rxml)$}.freeze
+      PARTIAL_VIEW_FILES = %r{app/(views|cells)/.*/_.*\.(erb|haml|slim|builder|rxml)$}.freeze
+      ROUTE_FILES = %r{config/routes.*\.rb}.freeze
+      SCHEMA_FILE = %r{db/schema\.rb}.freeze
+      HELPER_FILES = %r{app/helpers/.*\.rb$}.freeze
+      DEPLOY_FILES = %r{config/deploy.*\.rb}.freeze
+      CONFIG_FILES = %r{config/(application|environment|environments/.*)\.rb}.freeze
+      INITIALIZER_FILES = %r{config/initializers/.*\.rb}.freeze
+      CAPFILE = /Capfile/.freeze
+      GEMFILE_LOCK = /Gemfile\.lock/.freeze
+
+      SKIP_FILES = %r{db/schema.rb}.freeze
 
       def initialize(options = {})
         options.each do |key, value|
@@ -33,7 +34,7 @@ module RailsBestPractices
       # @param [String] the file name of node.
       # @return [Boolean] true if the check will need to parse the file.
       def parse_file?(node_file)
-        is_interesting_file?(node_file) and !is_ignored?(node_file)
+        node_file.is_a?(String) && is_interesting_file?(node_file) && !is_ignored?(node_file)
       end
 
       def is_interesting_file?(node_file)
@@ -60,13 +61,10 @@ module RailsBestPractices
       # @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_number)
-        errors << RailsBestPractices::Core::Error.new(
-          filename: filename,
-          line_number: line_number,
-          message: message,
-          type: self.class.to_s,
-          url: url
-        )
+        errors <<
+          RailsBestPractices::Core::Error.new(
+            filename: filename, line_number: line_number, message: message, type: self.class.to_s, url: url
+          )
       end
 
       # errors that violate the rails best practices.
@@ -99,9 +97,9 @@ module RailsBestPractices
         end
       end
 
-      class <<self
+      class << self
         def url(url = nil)
-          url ?  @url = url : @url
+          url ? @url = url : @url
         end
 
         def debug?
@@ -114,6 +112,7 @@ module RailsBestPractices
       end
 
       # Helper to parse the class name.
+
       module Classable
         def self.included(base)
           base.class_eval do
@@ -139,7 +138,7 @@ module RailsBestPractices
             # end of the class
             add_callback :end_class do |_node|
               klasses.pop
-              # @klass = nil
+              @klass = nil
             end
           end
         end
@@ -165,6 +164,7 @@ module RailsBestPractices
       end
 
       # Helper to parse the module name.
+
       module Moduleable
         def self.included(base)
           base.class_eval do
@@ -197,7 +197,15 @@ module RailsBestPractices
       module Callable
         def self.included(base)
           base.class_eval do
-            interesting_nodes :call, :fcall, :var_ref, :vcall, :command_call, :command, :alias, :bare_assoc_hash, :method_add_arg
+            interesting_nodes :call,
+                              :fcall,
+                              :var_ref,
+                              :vcall,
+                              :command_call,
+                              :command,
+                              :alias,
+                              :bare_assoc_hash,
+                              :method_add_arg
 
             # remembe the message of call node.
             add_callback :start_call do |node|
@@ -240,7 +248,7 @@ module RailsBestPractices
               else
                 mark_used(node.message)
                 last_argument = node.arguments.all.last
-                if last_argument.present? && :bare_assoc_hash == last_argument.sexp_type
+                if last_argument.present? && last_argument.sexp_type == :bare_assoc_hash
                   last_argument.hash_values.each { |argument_value| mark_used(argument_value) }
                 end
               end
@@ -283,27 +291,28 @@ module RailsBestPractices
 
             private
 
-              def mark_used(method_node)
-                return if method_node == :call
-                if :bare_assoc_hash == method_node.sexp_type
-                  method_node.hash_values.each { |value_node| mark_used(value_node) }
-                elsif :array == method_node.sexp_type
-                  method_node.array_values.each { |value_node| mark_used(value_node) }
-                else
-                  method_name = method_node.to_s
-                end
-                call_method(method_name)
+            def mark_used(method_node)
+              return if method_node == :call
+
+              if method_node.sexp_type == :bare_assoc_hash
+                method_node.hash_values.each { |value_node| mark_used(value_node) }
+              elsif method_node.sexp_type == :array
+                method_node.array_values.each { |value_node| mark_used(value_node) }
+              else
+                method_name = method_node.to_s
               end
+              call_method(method_name)
+            end
 
-              def call_method(method_name, class_name = nil)
-                name ||= respond_to?(:current_class_name) ? current_class_name : current_module_name
-                if methods.has_method?(name, method_name)
-                  methods.get_method(name, method_name).mark_used
-                end
-                methods.mark_parent_class_method_used(name, method_name)
-                methods.mark_subclasses_method_used(name, method_name)
-                methods.possible_public_used(method_name)
+            def call_method(method_name, class_name = nil)
+              class_name ||= respond_to?(:current_class_name) ? current_class_name : current_module_name
+              if methods.has_method?(class_name, method_name)
+                methods.get_method(class_name, method_name).mark_used
               end
+              methods.mark_parent_class_method_used(class_name, method_name)
+              methods.mark_subclasses_method_used(class_name, method_name)
+              methods.possible_public_used(method_name)
+            end
           end
         end
       end
@@ -317,21 +326,21 @@ module RailsBestPractices
 
             # check if the controller is inherit from InheritedResources::Base.
             add_callback :start_class do |_node|
-              if 'InheritedResources::Base' == current_extend_class_name
+              if current_extend_class_name == 'InheritedResources::Base'
                 @inherited_resources = true
               end
             end
 
             # check if there is a DSL call inherit_resources.
             add_callback :start_var_ref do |node|
-              if 'inherit_resources' == node.to_s
+              if node.to_s == 'inherit_resources'
                 @inherited_resources = true
               end
             end
 
             # check if there is a DSL call inherit_resources.
             add_callback :start_vcall do |node|
-              if 'inherit_resources' == node.to_s
+              if node.to_s == 'inherit_resources'
                 @inherited_resources = true
               end
             end
@@ -350,7 +359,7 @@ module RailsBestPractices
             # check if the method is in the except methods list.
             def excepted?(method)
               is_ignored?(method.file) ||
-              except_methods.any? { |except_method| Exceptable.matches method, except_method }
+                except_methods.any? { |except_method| Exceptable.matches method, except_method }
             end
 
             def internal_except_methods
@@ -370,10 +379,8 @@ module RailsBestPractices
             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 =
+              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 }
@@ -384,6 +391,7 @@ module RailsBestPractices
       end
 
       # Helper to parse the access control.
+
       module Accessable
         def self.included(base)
           base.class_eval do

data/lib/rails_best_practices/core/checks_loader.rb

@@ -14,37 +14,38 @@ module RailsBestPractices
 
       # load all reviews according to configuration.
       def load_reviews
-        load_checks_from_config { |check_name| RailsBestPractices::Reviews.const_get(check_name.gsub(/Check$/, 'Review')) }
+        load_checks_from_config do |check_name|
+          RailsBestPractices::Reviews.const_get(check_name.gsub(/Check$/, 'Review'))
+        end
       end
 
       private
 
-        # read the checks from yaml config.
-        def checks_from_config
-          @checks ||= YAML.load_file @config
-        end
+      # 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
+      # load all checks from the configuration
+      def load_checks_from_config(&block)
+        checks_from_config.each_with_object([]) do |check, active_checks|
+          check_instance = instantiate_check(block, *check)
+          active_checks << check_instance unless check_instance.nil?
         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
+      # instantiates a check
+      def instantiate_check(block, check_name, options)
+        check_class = load_check_class(check_name, &block)
+        check_class&.new(options || {})
+      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
+      # loads the class for a check by calling the given block
+      def load_check_class(check_name)
+        yield(check_name)
+      rescue NameError
+        # nothing to do, the check does not exist
+      end
     end
   end
 end