rails_best_practices 1.20.0 → 1.22.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b66ea6e0e742d6db68f867fed12f8242aa0d767b7b3fb4728043c97984f455a
-  data.tar.gz: 6f8ff9290459f8436908396fec8612d6050c7f5b278697475c4601e8931c0c19
+  metadata.gz: 36bdd893273a363e797a90d58df2426f0429f94637171cdf803d4cfe3a3c0033
+  data.tar.gz: c2fc8eb82530d50615ecfd423da421c056fb309fd4edcdde91ea5cbe4c9ed2c2
 SHA512:
-  metadata.gz: '03850b2873726ec5f3928bc1a846320927c56793c71221c715bbbc630cd1f10333b52ac9a713a78db3cbf1db6e2f25a34493d06bcce76d184f2447f5d888deb1'
-  data.tar.gz: 72586f6144df24dd9fd11861c443554f3903bc0cd8401bd08b1e6a89ff356d545b475b8e465b7e95e1803dd198517695fb91d81d6a746df9654e51525e638365
+  metadata.gz: 158478715edfea916abf0666e24665ac0da4aa5e6784df370a78f44654f2b817d415866ec363503bb7081011ace66edb0e32197d9d384c394f59cb429dc8d0ee
+  data.tar.gz: c785c39a4050af719e2513241dcff648dec9fe0d6c8bda3717e50da991fbc8d0d03cc1159fff946ad06d2c7378a5b9247146266e1e94d7d85178cbe50181e067

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Next Release
 
+## 1.22.0 (2021-10-27)
+
+* Support atom editor
+
+## 1.21.0 (2021-06-15)
+
+* Disable check by inline comment
+* Add type check for string
+
 ## 1.20.0 (2020-02-29)
 
 * Support ruby 2.7

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 gemspec
 
@@ -6,4 +8,3 @@ gem 'coveralls', require: false
 gem 'guard'
 gem 'guard-rspec'
 gem 'pry'
-gem 'rspec', '~> 2.14.0'

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    rails_best_practices (1.20.0)
+    rails_best_practices (1.22.1)
       activesupport
-      code_analyzer (>= 0.5.1)
+      code_analyzer (>= 0.5.2)
       erubis
       i18n
       json
@@ -13,74 +13,81 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.0.2.1)
+    activesupport (6.1.4.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
     awesome_print (1.8.0)
-    code_analyzer (0.5.1)
+    code_analyzer (0.5.2)
       sexp_processor
-    coderay (1.1.2)
-    concurrent-ruby (1.1.5)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.9)
     coveralls (0.8.23)
       json (>= 1.8, < 3)
       simplecov (~> 0.16.1)
       term-ansicolor (~> 1.3)
       thor (>= 0.19.4, < 2.0)
       tins (~> 1.6)
-    diff-lcs (1.3)
+    diff-lcs (1.4.4)
     docile (1.3.2)
     erubis (2.7.0)
-    ffi (1.11.3)
-    formatador (0.2.5)
-    guard (2.16.1)
+    ffi (1.15.4)
+    formatador (0.3.0)
+    guard (2.18.0)
       formatador (>= 0.2.4)
       listen (>= 2.7, < 4.0)
       lumberjack (>= 1.0.12, < 2.0)
       nenv (~> 0.1)
       notiffany (~> 0.0)
-      pry (>= 0.9.12)
+      pry (>= 0.13.0)
       shellany (~> 0.0)
       thor (>= 0.18.1)
-    guard-rspec (4.3.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
       guard (~> 2.1)
-      rspec (>= 2.14, < 4.0)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
     haml (5.1.2)
       temple (>= 0.8.0)
       tilt
-    i18n (1.7.0)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
     json (2.3.0)
-    listen (3.2.1)
+    listen (3.7.0)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
-    lumberjack (1.0.13)
-    method_source (0.9.2)
-    minitest (5.13.0)
+    lumberjack (1.2.8)
+    method_source (1.0.0)
+    minitest (5.14.4)
     nenv (0.3.0)
     notiffany (0.1.3)
       nenv (~> 0.1)
       shellany (~> 0.0)
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
     rake (13.0.1)
-    rb-fsevent (0.10.3)
+    rb-fsevent (0.11.0)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
     require_all (3.0.0)
-    rspec (2.14.1)
-      rspec-core (~> 2.14.0)
-      rspec-expectations (~> 2.14.0)
-      rspec-mocks (~> 2.14.0)
-    rspec-core (2.14.8)
-    rspec-expectations (2.14.5)
-      diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.14.6)
-    ruby-progressbar (1.10.1)
-    sexp_processor (4.13.0)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    ruby-progressbar (1.11.0)
+    sexp_processor (4.15.3)
     shellany (0.0.1)
     simplecov (0.16.1)
       docile (~> 1.1)
@@ -93,13 +100,12 @@ GEM
     temple (0.8.2)
     term-ansicolor (1.7.1)
       tins (~> 1.0)
-    thor (1.0.1)
-    thread_safe (0.3.6)
+    thor (1.1.0)
     tilt (2.0.10)
     tins (1.22.2)
-    tzinfo (1.2.6)
-      thread_safe (~> 0.1)
-    zeitwerk (2.2.2)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.5.1)
 
 PLATFORMS
   ruby
@@ -114,8 +120,8 @@ DEPENDENCIES
   pry
   rails_best_practices!
   rake
-  rspec (~> 2.14.0)
+  rspec
   slim
 
 BUNDLED WITH
-   2.1.4
+   2.2.22

data/Guardfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # A sample Guardfile
 # More info at https://github.com/guard/guard#readme
 

data/Rakefile

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'

data/assets/result.html.erb

@@ -115,6 +115,8 @@
             <td class='filename'>
               <% if @github %>
                 <a href='<%= @github_name %>/blob/<%= @last_commit_id %>/<%= error.short_filename %>#L<%= error.first_line_number %>' target='_blank'><%= error.short_filename %></a>
+              <% elsif @atom %>
+                <a href='atom://core/open/file?filename=<%= File.expand_path(error.filename) %>&amp;line=<%= error.line_number %>'><%= error.short_filename %></a>
               <% elsif @textmate %>
                 <a href='txmt://open/?url=file://<%= File.expand_path(error.filename) %>&amp;line=<%= error.line_number %>'><%= error.short_filename %></a>
               <% elsif @sublime %>

data/lib/rails_best_practices/analyzer.rb

@@ -104,30 +104,31 @@ module RailsBestPractices
     #
     # @return [Array] all files for parsing
     def parse_files
-      @parse_files ||= begin
-        files = expand_dirs_to_files(@path)
-        files = file_sort(files)
+      @parse_files ||=
+        begin
+          files = expand_dirs_to_files(@path)
+          files = file_sort(files)
 
-        if @options['only'].present?
-          files = file_accept(files, @options['only'])
-        end
+          if @options['only'].present?
+            files = file_accept(files, @options['only'])
+          end
 
-        # By default, tmp, vender, spec, test, features are ignored.
-        %w[vendor spec test features tmp].each do |dir|
-          files = file_ignore(files, File.join(@path, dir)) unless @options[dir]
-        end
+          # By default, tmp, vender, spec, test, features are ignored.
+          %w[vendor spec test features tmp].each do |dir|
+            files = file_ignore(files, File.join(@path, dir)) unless @options[dir]
+          end
 
-        # Exclude files based on exclude regexes if the option is set.
-        @options['exclude'].each do |pattern|
-          files = file_ignore(files, pattern)
-        end
+          # Exclude files based on exclude regexes if the option is set.
+          @options['exclude'].each do |pattern|
+            files = file_ignore(files, pattern)
+          end
 
-        %w[Capfile Gemfile Gemfile.lock].each do |file|
-          files.unshift File.join(@path, file)
-        end
+          %w[Capfile Gemfile Gemfile.lock].each do |file|
+            files.unshift File.join(@path, file)
+          end
 
-        files.compact
-      end
+          files.compact
+        end
     end
 
     # expand all files with extenstion rb, erb, haml, slim, builder and rxml under the dirs
@@ -158,7 +159,10 @@ module RailsBestPractices
       models = files.find_all { |file| file =~ Core::Check::MODEL_FILES }
       mailers = files.find_all { |file| file =~ Core::Check::MAILER_FILES }
       helpers = files.find_all { |file| file =~ Core::Check::HELPER_FILES }
-      others = files.find_all { |file| file !~ Core::Check::MAILER_FILES && file !~ Core::Check::MODEL_FILES && file !~ Core::Check::HELPER_FILES }
+      others =
+        files.find_all do |file|
+          file !~ Core::Check::MAILER_FILES && file !~ Core::Check::MODEL_FILES && file !~ Core::Check::HELPER_FILES
+        end
       models + mailers + helpers + others
     end
 
@@ -194,7 +198,10 @@ module RailsBestPractices
     def load_hg_info
       hg_progressbar = ProgressBar.create(title: 'Hg Info', total: errors.size) if display_bar?
       errors.each do |error|
-        hg_info = `cd #{@runner.class.base_path} && hg blame -lvcu #{error.filename[@runner.class.base_path.size..-1].gsub(/^\//, '')} | sed -n /:#{error.line_number.split(',').first}:/p`
+        info_command = "cd #{@runner.class.base_path}"
+        info_command += " && hg blame -lvcu #{error.filename[@runner.class.base_path.size..-1].gsub(%r{^/}, '')}"
+        info_command += " | sed -n /:#{error.line_number.split(',').first}:/p"
+        hg_info = system(info_command)
         unless hg_info == ''
           hg_commit_username = hg_info.split(':')[0].strip
           error.hg_username = hg_commit_username.split(/\ /)[0..-2].join(' ')
@@ -208,9 +215,11 @@ module RailsBestPractices
     # load git commit and git username info.
     def load_git_info
       git_progressbar = ProgressBar.create(title: 'Git Info', total: errors.size) if display_bar?
-      start = @runner.class.base_path =~ /\/$/ ? @runner.class.base_path.size : @runner.class.base_path.size + 1
+      start = @runner.class.base_path =~ %r{/$} ? @runner.class.base_path.size : @runner.class.base_path.size + 1
       errors.each do |error|
-        git_info = `cd #{@runner.class.base_path} && git blame -L #{error.line_number.split(',').first},+1 #{error.filename[start..-1]}`
+        info_command = "cd #{@runner.class.base_path}"
+        info_command += " && git blame -L #{error.line_number.split(',').first},+1 #{error.filename[start..-1]}"
+        git_info = system(info_command)
         unless git_info == ''
           git_commit, git_username = git_info.split(/\d{4}-\d{2}-\d{2}/).first.split('(')
           error.git_commit = git_commit.split(' ').first.strip
@@ -224,7 +233,10 @@ module RailsBestPractices
     # output errors with html format.
     def output_html_errors
       require 'erubis'
-      template = @options['template'] ? File.read(File.expand_path(@options['template'])) : File.read(File.join(File.dirname(__FILE__), '..', '..', 'assets', 'result.html.erb'))
+      template =
+        @options['template'] ?
+          File.read(File.expand_path(@options['template'])) :
+          File.read(File.join(File.dirname(__FILE__), '..', '..', 'assets', 'result.html.erb'))
 
       if @options['with-github']
         last_commit_id = @options['last-commit-id'] || `cd #{@runner.class.base_path} && git rev-parse HEAD`.chomp
@@ -235,27 +247,29 @@ module RailsBestPractices
       File.open(@options['output-file'], 'w+') do |file|
         eruby = Erubis::Eruby.new(template)
         file.puts eruby.evaluate(
-          errors: errors,
-          error_types: error_types,
-          textmate: @options['with-textmate'],
-          vscode: @options['with-vscode'],
-          sublime: @options['with-sublime'],
-          mvim: @options['with-mvim'],
-          github: @options['with-github'],
-          github_name: @options['github-name'],
-          last_commit_id: last_commit_id,
-          git: @options['with-git'],
-          hg: @options['with-hg']
-        )
+                    errors: errors,
+                    error_types: error_types,
+                    atom: @options['with-atom'],
+                    textmate: @options['with-textmate'],
+                    vscode: @options['with-vscode'],
+                    sublime: @options['with-sublime'],
+                    mvim: @options['with-mvim'],
+                    github: @options['with-github'],
+                    github_name: @options['github-name'],
+                    last_commit_id: last_commit_id,
+                    git: @options['with-git'],
+                    hg: @options['with-hg']
+                  )
       end
     end
 
     def output_xml_errors
       require 'rexml/document'
 
-      document = REXML::Document.new.tap do |d|
-        d << REXML::XMLDecl.new
-      end
+      document =
+        REXML::Document.new.tap do |d|
+          d << REXML::XMLDecl.new
+        end
 
       checkstyle = REXML::Element.new('checkstyle', document)
 
@@ -289,13 +303,10 @@ module RailsBestPractices
 
     # output errors with json format.
     def output_json_errors
-      errors_as_hashes = errors.map do |err|
-        {
-          filename:    err.filename,
-          line_number: err.line_number,
-          message:     err.message
-        }
-      end
+      errors_as_hashes =
+        errors.map do |err|
+          { filename: err.filename, line_number: err.line_number, message: err.message }
+        end
 
       File.open(@options['output-file'], 'w+') do |file|
         file.write JSON.dump(errors_as_hashes)
@@ -316,8 +327,8 @@ module RailsBestPractices
 
     # analyze source codes.
     def analyze_source_codes
-      @bar = ProgressBar.create(title: 'Source Code', total: parse_files.size * 3) if display_bar?
-      %w[lexical prepare review].each { |process| send(:process, process) }
+      @bar = ProgressBar.create(title: 'Source Code', total: parse_files.size * 4) if display_bar?
+      %w[lexical prepare review inline_disable].each { |process| send(:process, process) }
       @bar.finish if display_bar?
     end
 

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
@@ -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|
@@ -371,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 }
@@ -385,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,17 +14,19 @@ 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.
+      # read the checks from yaml config.
       def checks_from_config
         @checks ||= YAML.load_file @config
       end
 
-        # load all checks from the configuration
+      # 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)
@@ -32,13 +34,13 @@ module RailsBestPractices
         end
       end
 
-        # instantiates a check
+      # 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?
+        check_class&.new(options || {})
       end
 
-        # loads the class for a check by calling the given block
+      # loads the class for a check by calling the given block
       def load_check_class(check_name)
         yield(check_name)
       rescue NameError

data/lib/rails_best_practices/core/configs.rb

@@ -2,7 +2,6 @@
 
 module RailsBestPractices
   module Core
-    class Configs < Hash
-    end
+    class Configs < Hash; end
   end
 end

data/lib/rails_best_practices/core/controllers.rb

@@ -5,7 +5,6 @@ require_rel 'klasses'
 module RailsBestPractices
   module Core
     # Controller classes.
-    class Controllers < Klasses
-    end
+    class Controllers < Klasses; end
   end
 end

data/lib/rails_best_practices/core/error.rb

@@ -20,7 +20,7 @@ module RailsBestPractices
       end
 
       def short_filename
-        File.expand_path(filename)[File.expand_path(Core::Runner.base_path).size..-1].sub(/^\//, '')
+        File.expand_path(filename)[File.expand_path(Core::Runner.base_path).size..-1].sub(%r{^/}, '')
       end
 
       def first_line_number

data/lib/rails_best_practices/core/helpers.rb

@@ -5,7 +5,6 @@ require_rel 'modules'
 module RailsBestPractices
   module Core
     # Helper moduels.
-    class Helpers < Modules
-    end
+    class Helpers < Modules; end
   end
 end

data/lib/rails_best_practices/core/mailers.rb

@@ -3,7 +3,6 @@
 module RailsBestPractices
   module Core
     # Mailer classes.
-    class Mailers < Klasses
-    end
+    class Mailers < Klasses; end
   end
 end