rails_best_practices 1.19.3 → 1.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4a366fcb2bd3097eb1afcc7fa940b233a4177c6d
-  data.tar.gz: 45c9b324f42e0974e7314c1db9e634c782665e93
+SHA256:
+  metadata.gz: e268c4837f5a1da4ac684c78bef59cd06ce20c69cc41ea9478391242897c5d4b
+  data.tar.gz: 3bfc141a02bfcb95f40f938be6d101ab3e0aed55518eb8c42d2a6c5b2effd246
 SHA512:
-  metadata.gz: fa6aed2c8549d66e9650e456787a57cc32fb052011506e10cdc94ee43803d2016d644ec4e0aae1d9b08d583abb5d2eab7c4dd26eb8754e60bac46a02f8ad4459
-  data.tar.gz: 5558cb09e7a4a4f38af75078762d3dba880bd29a97ea2ba743df3e20edf8ca51a0fd3f440808f29043b8d00d99503257de3e18849ea3d6d355930728dd9187f6
+  metadata.gz: f3c124054e218a06478ef27973a2fc6aed24eb4bc45fac4eebd3274b61a1fea9650c8d9bd366a06657714d22c5905ba00315a75f787556eab5a6527ad947011b
+  data.tar.gz: 4e0f3e83007b69bbba800ff378caf08adf5e87d8fd8e5d913c55ef35052775697f72c7c038cebaf417f13a29cdf654b2ce25effe570ae5e6fabf6988b4735401

data/.gitignore

@@ -1,6 +1,5 @@
 .DS_STORE
 .*.swp
-Gemfile.lock
 pkg/**
 *.gem
 .bundle

data/.travis.yml

@@ -1,5 +1,4 @@
-sudo: false
 language: ruby
-cache: bundler
 rvm:
-  - 2.3.3
+  - 2.6.4
+script: bundle exec rspec spec

data/CHANGELOG.md

@@ -1,20 +1,19 @@
 # Next Release
 
-## 1.19.3
+## 1.21.0 (2021-06-15)
 
-* Fix false positive remove unused method for around_action in
-  controller
-* Fix current_class_name in end_class callback
-
-## 1.19.2
+* Disable check by inline comment
+* Add type check for string
 
-* Integrate with awesomecode.io
-* Update to require_all 2.x
-
-## 1.19.1
+## 1.20.0 (2020-02-29)
 
+* Support ruby 2.7
+* Add the link format for vscode
+* Add cli class
 * Add table_name and module_prefix to model ignored methods
-* Forcing requrie_all version
+* Fix false positive remove unused method for around_action in
+  controller
+* Fix current_class_name in end_class callback
 
 ## 1.19.0 (2017-07-26)
 

data/Gemfile

@@ -1,13 +1,11 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 gemspec
 
 gem 'coveralls', require: false
 
-if RUBY_PLATFORM =~ /darwin/i
-  gem 'growl'
-  gem 'rb-fsevent'
-end
 gem 'guard'
 gem 'guard-rspec'
 gem 'pry'
-gem 'rspec', '~> 2.14.0'
+gem 'rspec'

data/Gemfile.lock

@@ -0,0 +1,125 @@
+PATH
+  remote: .
+  specs:
+    rails_best_practices (1.21.0)
+      activesupport
+      code_analyzer (>= 0.5.2)
+      erubis
+      i18n
+      json
+      require_all (~> 3.0)
+      ruby-progressbar
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.1.3.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    awesome_print (1.8.0)
+    code_analyzer (0.5.2)
+      sexp_processor
+    coderay (1.1.2)
+    concurrent-ruby (1.1.8)
+    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)
+    docile (1.3.2)
+    erubis (2.7.0)
+    ffi (1.11.3)
+    formatador (0.2.5)
+    guard (2.16.1)
+      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)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-rspec (4.3.1)
+      guard (~> 2.1)
+      rspec (>= 2.14, < 4.0)
+    haml (5.1.2)
+      temple (>= 0.8.0)
+      tilt
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
+    json (2.3.0)
+    listen (3.2.1)
+      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.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)
+    rake (13.0.1)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    require_all (3.0.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    ruby-progressbar (1.11.0)
+    sexp_processor (4.15.2)
+    shellany (0.0.1)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    slim (4.0.1)
+      temple (>= 0.7.6, < 0.9)
+      tilt (>= 2.0.6, < 2.1)
+    temple (0.8.2)
+    term-ansicolor (1.7.1)
+      tins (~> 1.0)
+    thor (1.0.1)
+    tilt (2.0.10)
+    tins (1.22.2)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  awesome_print
+  bundler
+  coveralls
+  guard
+  guard-rspec
+  haml
+  pry
+  rails_best_practices!
+  rake
+  rspec
+  slim
+
+BUNDLED WITH
+   2.1.4

data/Guardfile

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

data/README.md

@@ -3,7 +3,7 @@
 [![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/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)
-[![AwesomeCode Status for flyerhzm/rails_best_practices](https://awesomecode.io/projects/d02ecd70-e068-4ad4-b61a-7003ac24b49a/status)](https://awesomecode.io/projects/8)
+[![AwesomeCode Status for flyerhzm/rails_best_practices](https://awesomecode.io/projects/d02ecd70-e068-4ad4-b61a-7003ac24b49a/status)](https://awesomecode.io/repos/flyerhzm/rails_best_practices)
 
 [![Coderwall Endorse](http://api.coderwall.com/flyerhzm/endorsecount.png)](http://coderwall.com/flyerhzm)
 [![Click here to lend your support to: rails best practices and make a donation at www.pledgie.com !](https://pledgie.com/campaigns/12057.png?skin_name=chrome)](https://pledgie.com/campaigns/12057)
@@ -64,6 +64,7 @@ To see the full list of command-line options, run:
         -f, --format FORMAT              output format
             --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 https://github.com/asuth/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 OR full URL to GitHub:FI repo
@@ -182,6 +183,9 @@ Now you can customize this configuration file. The default configuration is as f
     UseScopeAccessCheck: { }
     UseTurboSprocketsRails3Check: { }
 
+Now, at the root directory of a Rails app, run:
+
+    rails_best_practices . -c config/rails_best_practices.yml
 
 You can remove or comment a review to disable it, and you can change the options.
 

data/Rakefile

@@ -1,18 +1,3 @@
-require 'bundler'
-require 'bundler/gem_tasks'
-
-Bundler.setup
-
-require 'rake'
-require 'rspec'
-require 'rspec/core/rake_task'
+# frozen_string_literal: true
 
-$LOAD_PATH.unshift File.expand_path('lib', __dir__)
-require 'rails_best_practices/version'
-
-RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = 'spec/**/*_spec.rb'
-end
-
-task default: :spec
-task test: :spec
+require 'bundler/gem_tasks'

data/assets/result.html.erb

@@ -121,6 +121,8 @@
                 <a href='subl://open?url=file://<%= File.expand_path(error.filename) %>&amp;line=<%= error.line_number %>'><%= error.short_filename %></a>
               <% elsif @mvim %>
                 <a href='mvim://open/?url=file://<%= File.expand_path(error.filename) %>&amp;line=<%= error.line_number %>'><%= error.short_filename %></a>
+              <% elsif @vscode %>
+                <a href='vscode://file/<%= File.expand_path(error.filename) %>:<%= error.line_number %>'><%= error.short_filename %></a>
               <% else %>
                 <%= error.short_filename %>
               <% end %>

data/lib/rails_best_practices.rb

@@ -8,6 +8,8 @@ require 'rails_best_practices/analyzer'
 require 'rails_best_practices/lexicals'
 require 'rails_best_practices/prepares'
 require 'rails_best_practices/reviews'
+require 'rails_best_practices/inline_disables'
+require 'rails_best_practices/option_parser'
+require 'rails_best_practices/cli'
 
-module RailsBestPractices
-end
+module RailsBestPractices; end

data/lib/rails_best_practices/analyzer.rb

@@ -19,7 +19,7 @@ module RailsBestPractices
     attr_reader :path
 
     DEFAULT_CONFIG = File.join(File.dirname(__FILE__), '..', '..', 'rails_best_practices.yml')
-    GITHUB_URL = 'https://github.com/'.freeze
+    GITHUB_URL = 'https://github.com/'
 
     # initialize
     #
@@ -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
@@ -137,14 +138,15 @@ module RailsBestPractices
     def expand_dirs_to_files(*dirs)
       extensions = %w[rb erb rake rhtml haml slim builder rxml rabl]
 
-      dirs.flatten.map { |entry|
+      dirs.flatten.map do |entry|
         next unless File.exist? entry
+
         if File.directory? entry
           Dir[File.join(entry, '**', "*.{#{extensions.join(',')}}")]
         else
           entry
         end
-      }.flatten
+      end.flatten
     end
 
     # sort files, models first, mailers, helpers, and then sort other files by characters.
@@ -157,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
 
@@ -193,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(' ')
@@ -207,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
@@ -223,10 +233,13 @@ 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'] ? @options['last-commit-id'] : `cd #{@runner.class.base_path} && git rev-parse HEAD`.chomp
+        last_commit_id = @options['last-commit-id'] || `cd #{@runner.class.base_path} && git rev-parse HEAD`.chomp
         unless @options['github-name'].start_with?('https')
           @options['github-name'] = GITHUB_URL + @options['github-name']
         end
@@ -234,26 +247,28 @@ 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'],
-          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,
+                    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)
 
@@ -287,13 +302,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)
@@ -314,8 +326,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