rails_best_practices 1.19.3 → 1.21.0

data/lib/rails_best_practices/lexicals/long_line_check.rb

@@ -22,9 +22,13 @@ module RailsBestPractices
           content.each_line do |line|
             line_no += 1
             actual_line_length = line.sub(/\s+$/, '').length
-            if actual_line_length > @max_line_length
-              add_error("line is longer than #{@max_line_length} characters (#{actual_line_length} characters)", filename, line_no)
-            end
+            next unless actual_line_length > @max_line_length
+
+            add_error(
+              "line is longer than #{@max_line_length} characters (#{actual_line_length} characters)",
+              filename,
+              line_no
+            )
           end
         end
       end

data/lib/rails_best_practices/option_parser.rb

@@ -0,0 +1,156 @@
+# frozen_string_literal: true
+
+require 'optparse'
+
+module RailsBestPractices
+  class OptionParser
+    # Usage: rails_best_practices [options] path
+    #    -d, --debug                      debug mode
+    #        --silent                     silent mode
+    #    -f, --format FORMAT              output format (text, html, yaml, 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-vscode                open file by vscode 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
+
+    def self.parse!(argv = ARGV)
+      options = {}
+      OptParse.new do |opts|
+        opts.default_argv = argv
+
+        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, yaml, 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-vscode', 'open file by vscode in html format') do
+          options['with-vscode'] = 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
+    end
+  end
+end

data/lib/rails_best_practices/prepares.rb

@@ -4,7 +4,7 @@ require_rel 'prepares'
 
 module RailsBestPractices
   module Prepares
-    class <<self
+    class << self
       def klasses
         models + mailers + controllers
       end

data/lib/rails_best_practices/prepares/controller_prepare.rb

@@ -3,6 +3,7 @@
 module RailsBestPractices
   module Prepares
     # Remember controllers and controller methods
+
     class ControllerPrepare < Core::Check
       include Core::Check::Classable
       include Core::Check::InheritedResourcesable
@@ -25,43 +26,41 @@ module RailsBestPractices
       add_callback :start_class do |_node|
         @controllers << @klass
         @current_controller_name = @klass.to_s
-        if @inherited_resources
-          @actions = DEFAULT_ACTIONS
-        end
+        @actions = DEFAULT_ACTIONS if @inherited_resources
       end
 
       # remember the action names at the end of class node if the controller is a InheritedResources.
       add_callback :end_class do |node|
-        if @inherited_resources && 'ApplicationController' != @current_controller_name
+        if @inherited_resources && @current_controller_name != 'ApplicationController'
           @actions.each do |action|
-            @methods.add_method(@current_controller_name, action, 'file' => node.file, 'line_number' => node.line_number)
+            @methods.add_method(
+              @current_controller_name,
+              action,
+              'file' => node.file, 'line_number' => node.line_number
+            )
           end
         end
       end
 
       # check if there is a DSL call inherit_resources.
       add_callback :start_var_ref do |_node|
-        if @inherited_resources
-          @actions = DEFAULT_ACTIONS
-        end
+        @actions = DEFAULT_ACTIONS if @inherited_resources
       end
 
       # check if there is a DSL call inherit_resources.
       add_callback :start_vcall do |_node|
-        if @inherited_resources
-          @actions = DEFAULT_ACTIONS
-        end
+        @actions = DEFAULT_ACTIONS if @inherited_resources
       end
 
       # restrict actions for inherited_resources
       add_callback :start_command do |node|
-        if 'include' == node.message.to_s
+        if node.message.to_s == 'include'
           @helpers.add_module_descendant(node.arguments.all.first.to_s, current_class_name)
-        elsif @inherited_resources && 'actions' ==  node.message.to_s
-          if 'all' == node.arguments.all.first.to_s
+        elsif @inherited_resources && node.message.to_s == 'actions'
+          if node.arguments.all.first.to_s == 'all'
             @actions = DEFAULT_ACTIONS
             option_argument = node.arguments.all[1]
-            if option_argument && :bare_assoc_hash == option_argument.sexp_type && option_argument.hash_value('except')
+            if option_argument && option_argument.sexp_type == :bare_assoc_hash && option_argument.hash_value('except')
               @actions -= option_argument.hash_value('except').to_object
             end
           else
@@ -84,14 +83,21 @@ module RailsBestPractices
       #     }
       add_callback :start_def do |node|
         method_name = node.method_name.to_s
-        @methods.add_method(current_class_name, method_name, { 'file' => node.file, 'line_number' => node.line_number }, current_access_control)
+        @methods.add_method(
+          current_class_name,
+          method_name,
+          { 'file' => node.file, 'line_number' => node.line_number },
+          current_access_control
+        )
       end
 
       # ask Reviews::RemoveUnusedMoethodsInHelperReview to check the controllers who include helpers.
       add_callback :after_check do
         descendants = @helpers.map(&:descendants).flatten
         if descendants.present?
-          Reviews::RemoveUnusedMethodsInHelpersReview.interesting_files *descendants.map { |descendant| /#{descendant.underscore}/ }
+          Reviews::RemoveUnusedMethodsInHelpersReview.interesting_files *descendants.map { |descendant|
+                                                                          /#{descendant.underscore}/
+                                                                        }
         end
       end
     end

data/lib/rails_best_practices/prepares/gemfile_prepare.rb

@@ -10,10 +10,10 @@ module RailsBestPractices
         @gems = Prepares.gems
       end
 
-      def check(filename, content)
+      def check(_filename, content)
         content.split("\n").each do |line|
           if line =~ /([^ ]+) \((\d.*)\)/
-            @gems << Core::Gem.new($1, $2)
+            @gems << Core::Gem.new(Regexp.last_match(1), Regexp.last_match(2))
           end
         end
       end

data/lib/rails_best_practices/prepares/helper_prepare.rb

@@ -32,7 +32,12 @@ module RailsBestPractices
       add_callback :start_def do |node|
         if node.file =~ HELPER_FILES
           method_name = node.method_name.to_s
-          @methods.add_method(current_module_name, method_name, { 'file' => node.file, 'line_number' => node.line_number }, current_access_control)
+          @methods.add_method(
+            current_module_name,
+            method_name,
+            { 'file' => node.file, 'line_number' => node.line_number },
+            current_access_control
+          )
         end
       end
     end

data/lib/rails_best_practices/prepares/initializer_prepare.rb

@@ -3,6 +3,7 @@
 module RailsBestPractices
   module Prepares
     # Check all initializers
+
     class InitializerPrepare < Core::Check
       interesting_nodes :method_add_arg, :class
       interesting_files INITIALIZER_FILES
@@ -21,9 +22,8 @@ module RailsBestPractices
       # check if the node is
       #     ActiveRecord::Base.send(:include, ActiveModel::ForbiddenAttributesProtection)
       def include_forbidden_attributes_protection?(node)
-        'ActiveRecord::Base' == node.receiver.to_s &&
-          'send' == node.message.to_s &&
-          ['include', 'ActiveModel::ForbiddenAttributesProtection'] == node.arguments.all.map(&:to_s)
+        node.receiver.to_s == 'ActiveRecord::Base' && node.message.to_s == 'send' &&
+          node.arguments.all.map(&:to_s) == ['include', 'ActiveModel::ForbiddenAttributesProtection']
       end
     end
   end

data/lib/rails_best_practices/prepares/mailer_prepare.rb

@@ -3,6 +3,7 @@
 module RailsBestPractices
   module Prepares
     # Remember the mailer names.
+
     class MailerPrepare < Core::Check
       include Core::Check::Classable
 
@@ -18,7 +19,7 @@ module RailsBestPractices
       # if it is a subclass of ActionMailer::Base,
       # then remember its class name.
       add_callback :start_class do |_node|
-        if 'ActionMailer::Base' == current_extend_class_name
+        if current_extend_class_name == 'ActionMailer::Base'
           @mailers << @klass
         end
       end

data/lib/rails_best_practices/prepares/model_prepare.rb

@@ -3,6 +3,7 @@
 module RailsBestPractices
   module Prepares
     # Remember models and model associations.
+
     class ModelPrepare < Core::Check
       include Core::Check::Classable
       include Core::Check::Accessable
@@ -10,7 +11,17 @@ module RailsBestPractices
       interesting_nodes :class, :def, :defs, :command, :alias
       interesting_files MODEL_FILES
 
-      ASSOCIATION_METHODS = %w[belongs_to has_one has_many has_and_belongs_to_many embeds_many embeds_one embedded_in many one].freeze
+      ASSOCIATION_METHODS = %w[
+        belongs_to
+        has_one
+        has_many
+        has_and_belongs_to_many
+        embeds_many
+        embeds_one
+        embedded_in
+        many
+        one
+      ].freeze
 
       def initialize
         @models = Prepares.models
@@ -21,7 +32,7 @@ module RailsBestPractices
 
       # remember the class name.
       add_callback :start_class do |_node|
-        if 'ActionMailer::Base' != current_extend_class_name
+        if current_extend_class_name != 'ActionMailer::Base'
           @models << @klass
         end
       end
@@ -39,11 +50,14 @@ module RailsBestPractices
       #       }
       #     }
       add_callback :start_def do |node|
-        if @klass &&
-            'ActionMailer::Base' != current_extend_class_name &&
-            (classable_modules.empty? || klasses.any?)
+        if @klass && current_extend_class_name != 'ActionMailer::Base' && (classable_modules.empty? || klasses.any?)
           method_name = node.method_name.to_s
-          @methods.add_method(current_class_name, method_name, { 'file' => node.file, 'line_number' => node.line_number }, current_access_control)
+          @methods.add_method(
+            current_class_name,
+            method_name,
+            { 'file' => node.file, 'line_number' => node.line_number },
+            current_access_control
+          )
         end
       end
 
@@ -60,9 +74,14 @@ module RailsBestPractices
       #       }
       #     }
       add_callback :start_defs do |node|
-        if @klass && 'ActionMailer::Base' != current_extend_class_name
+        if @klass && current_extend_class_name != 'ActionMailer::Base'
           method_name = node.method_name.to_s
-          @methods.add_method(current_class_name, method_name, { 'file' => node.file, 'line_number' => node.line_number }, current_access_control)
+          @methods.add_method(
+            current_class_name,
+            method_name,
+            { 'file' => node.file, 'line_number' => node.line_number },
+            current_access_control
+          )
         end
       end
 
@@ -81,15 +100,31 @@ module RailsBestPractices
         case node.message.to_s
         when 'named_scope', 'scope', 'alias_method'
           method_name = node.arguments.all.first.to_s
-          @methods.add_method(current_class_name, method_name, { 'file' => node.file, 'line_number' => node.line_number }, current_access_control)
+          @methods.add_method(
+            current_class_name,
+            method_name,
+            { 'file' => node.file, 'line_number' => node.line_number },
+            current_access_control
+          )
         when 'alias_method_chain'
           method, feature = *node.arguments.all.map(&:to_s)
-          @methods.add_method(current_class_name, "#{method}_with_#{feature}", { 'file' => node.file, 'line_number' => node.line_number }, current_access_control)
-          @methods.add_method(current_class_name, method.to_s, { 'file' => node.file, 'line_number' => node.line_number }, current_access_control)
+          @methods.add_method(
+            current_class_name,
+            "#{method}_with_#{feature}",
+            { 'file' => node.file, 'line_number' => node.line_number },
+            current_access_control
+          )
+          @methods.add_method(
+            current_class_name,
+            method.to_s,
+            { 'file' => node.file, 'line_number' => node.line_number },
+            current_access_control
+          )
         when 'field'
           arguments = node.arguments.all
           attribute_name = arguments.first.to_s
-          attribute_type = arguments.last.hash_value('type').present? ? arguments.last.hash_value('type').to_s : 'String'
+          attribute_type =
+            arguments.last.hash_value('type').present? ? arguments.last.hash_value('type').to_s : 'String'
           @model_attributes.add_attribute(current_class_name, attribute_name, attribute_type)
         when 'key'
           attribute_name, attribute_type = node.arguments.all.map(&:to_s)
@@ -102,7 +137,12 @@ module RailsBestPractices
       # check alias node to remembr the alias methods.
       add_callback :start_alias do |node|
         method_name = node.new_method.to_s
-        @methods.add_method(current_class_name, method_name, { 'file' => node.file, 'line_number' => node.line_number }, current_access_control)
+        @methods.add_method(
+          current_class_name,
+          method_name,
+          { 'file' => node.file, 'line_number' => node.line_number },
+          current_access_control
+        )
       end
 
       # after prepare process, fix incorrect associations' class_name.
@@ -122,17 +162,17 @@ module RailsBestPractices
 
       private
 
-        # remember associations, with class to association names.
-        def remember_association(node)
-          association_meta = node.message.to_s
-          association_name = node.arguments.all.first.to_s
-          arguments_node = node.arguments.all.last
-          if arguments_node.hash_value('class_name').present?
-            association_class = arguments_node.hash_value('class_name').to_s
-          end
-          association_class ||= association_name.classify
-          @model_associations.add_association(current_class_name, association_name, association_meta, association_class)
+      # remember associations, with class to association names.
+      def remember_association(node)
+        association_meta = node.message.to_s
+        association_name = node.arguments.all.first.to_s
+        arguments_node = node.arguments.all.last
+        if arguments_node.hash_value('class_name').present?
+          association_class = arguments_node.hash_value('class_name').to_s
         end
+        association_class ||= association_name.classify
+        @model_associations.add_association(current_class_name, association_name, association_meta, association_class)
+      end
     end
   end
 end