rails_best_practices 1.21.0 → 1.23.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e268c4837f5a1da4ac684c78bef59cd06ce20c69cc41ea9478391242897c5d4b
-  data.tar.gz: 3bfc141a02bfcb95f40f938be6d101ab3e0aed55518eb8c42d2a6c5b2effd246
+  metadata.gz: cdd81904314b75ffb168757035157e2e28627f890691ee869b567721485bb7ab
+  data.tar.gz: 98bd1b3d60c5a0218af2597f0ddf2a9d82f7375f2fe8466fc11d0f26f2f38e8b
 SHA512:
-  metadata.gz: f3c124054e218a06478ef27973a2fc6aed24eb4bc45fac4eebd3274b61a1fea9650c8d9bd366a06657714d22c5905ba00315a75f787556eab5a6527ad947011b
-  data.tar.gz: 4e0f3e83007b69bbba800ff378caf08adf5e87d8fd8e5d913c55ef35052775697f72c7c038cebaf417f13a29cdf654b2ce25effe570ae5e6fabf6988b4735401
+  metadata.gz: e7bc62f7d7c9e69b69eadd2abc323aefd5e107135a29e6d91333f178c5f945621eb7b04d030745837335a706b0cd7a6628ec384d28ba407cbebb83e1f938cf1d
+  data.tar.gz: b6c9dfba7e08e08cad07fbc74fcc5c66f3ee24659e07376365afea89b9f6490b98b0c6c4925c74782788369cbdc9788fbb8764607464b16e1c97f34b2835276c

data/.github/workflows/main.yml

@@ -0,0 +1,48 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test_ruby_2_6:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6']
+    env: # $BUNDLE_GEMFILE must be set at the job level, so it is set for all steps
+      BUNDLE_GEMFILE: Gemfile.ruby-2.6
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    - name: Run tests
+      run: bundle exec rspec spec
+  test_ruby_2_7_above:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.7', '3.0', '3.1']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    - name: Run tests
+      run: bundle exec rspec spec

data/.ruby-version

@@ -0,0 +1 @@
+3.1.0

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Next Release
 
+## 1.23.1 (2022-02-12)
+
+* Do not strict activesupport dependency version
+
+## 1.23.0 (2022-01-31)
+
+* Support hash short syntax
+
+## 1.22.0 (2021-10-27)
+
+* Support atom editor
+
 ## 1.21.0 (2021-06-15)
 
 * Disable check by inline comment

data/Gemfile

@@ -8,4 +8,3 @@ gem 'coveralls', require: false
 gem 'guard'
 gem 'guard-rspec'
 gem 'pry'
-gem 'rspec'

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    rails_best_practices (1.21.0)
+    rails_best_practices (1.23.1)
       activesupport
-      code_analyzer (>= 0.5.2)
+      code_analyzer (~> 0.5.5)
       erubis
       i18n
       json
@@ -13,79 +13,80 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.3.2)
+    activesupport (7.0.2.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)
+    code_analyzer (0.5.5)
       sexp_processor
-    coderay (1.1.2)
-    concurrent-ruby (1.1.8)
+    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.8.10)
+    i18n (1.9.1)
       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.14.4)
+    lumberjack (1.2.8)
+    method_source (1.0.0)
+    minitest (5.15.0)
     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 (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)
+    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.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.2)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
     ruby-progressbar (1.11.0)
-    sexp_processor (4.15.2)
+    sexp_processor (4.16.0)
     shellany (0.0.1)
     simplecov (0.16.1)
       docile (~> 1.1)
@@ -98,12 +99,11 @@ GEM
     temple (0.8.2)
     term-ansicolor (1.7.1)
       tins (~> 1.0)
-    thor (1.0.1)
+    thor (1.1.0)
     tilt (2.0.10)
     tins (1.22.2)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
-    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
@@ -122,4 +122,4 @@ DEPENDENCIES
   slim
 
 BUNDLED WITH
-   2.1.4
+   2.2.22

data/Gemfile.ruby-2.6

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+gemspec
+
+gem 'activesupport', '~> 6.1.4'
+gem 'coveralls', require: false
+
+gem 'guard'
+gem 'guard-rspec'
+gem 'pry'

data/Gemfile.ruby-2.6.lock

@@ -0,0 +1,130 @@
+PATH
+  remote: .
+  specs:
+    rails_best_practices (1.23.1)
+      activesupport
+      code_analyzer (~> 0.5.5)
+      erubis
+      i18n
+      json
+      require_all (~> 3.0)
+      ruby-progressbar
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.1.4.6)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    awesome_print (1.9.2)
+    code_analyzer (0.5.5)
+      sexp_processor
+    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.5.0)
+    docile (1.4.0)
+    erubis (2.7.0)
+    ffi (1.15.5)
+    formatador (1.1.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.13.0)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    haml (5.2.2)
+      temple (>= 0.8.0)
+      tilt
+    i18n (1.9.1)
+      concurrent-ruby (~> 1.0)
+    json (2.6.1)
+    listen (3.7.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    lumberjack (1.2.8)
+    method_source (1.0.0)
+    minitest (5.15.0)
+    nenv (0.3.0)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rake (13.0.6)
+    rb-fsevent (0.11.1)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    require_all (3.0.0)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    ruby-progressbar (1.11.0)
+    sexp_processor (4.16.0)
+    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.1.0)
+      temple (>= 0.7.6, < 0.9)
+      tilt (>= 2.0.6, < 2.1)
+    sync (0.5.0)
+    temple (0.8.2)
+    term-ansicolor (1.7.1)
+      tins (~> 1.0)
+    thor (1.2.1)
+    tilt (2.0.10)
+    tins (1.31.0)
+      sync
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.5.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport (~> 6.1.4)
+  awesome_print
+  bundler
+  coveralls
+  guard
+  guard-rspec
+  haml
+  pry
+  rails_best_practices!
+  rake
+  rspec
+  slim
+
+BUNDLED WITH
+   1.17.3

data/README.md

@@ -284,7 +284,7 @@ Follow us on twitter: <http://twitter.com/railsbp>
 Send us email: <team@railsbp.com>
 
 
-Copyright © 2009 - 2013 Richard Huang (flyerhzm@gmail.com), released under the MIT license
+Copyright © 2009 - 2022 Richard Huang (flyerhzm@gmail.com), released under the MIT license
 
 
 [1]: https://github.com/railsbp/rails_best_practices/wiki/How-to-write-your-own-check-list

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

@@ -249,6 +249,7 @@ module RailsBestPractices
         file.puts eruby.evaluate(
                     errors: errors,
                     error_types: error_types,
+                    atom: @options['with-atom'],
                     textmate: @options['with-textmate'],
                     vscode: @options['with-vscode'],
                     sublime: @options['with-sublime'],

data/lib/rails_best_practices/core/check.rb

@@ -204,7 +204,7 @@ module RailsBestPractices
                               :command_call,
                               :command,
                               :alias,
-                              :bare_assoc_hash,
+                              :assoc_new,
                               :method_add_arg
 
             # remembe the message of call node.
@@ -269,9 +269,12 @@ module RailsBestPractices
             #     def to_xml(options = {})
             #       super options.merge(exclude: :visible, methods: [:is_discussion_conversation])
             #     end
-            add_callback :start_bare_assoc_hash do |node|
-              if node.hash_keys.include? 'methods'
-                mark_used(node.hash_value('methods'))
+            add_callback :start_assoc_new do |node|
+              if node.key == 'methods'
+                mark_used(node.value)
+              end
+              if node.value.nil?
+                mark_used(node.key)
               end
             end
 
@@ -294,7 +297,9 @@ module RailsBestPractices
             def mark_used(method_node)
               return if method_node == :call
 
-              if method_node.sexp_type == :bare_assoc_hash
+              if method_node.is_a?(String)
+                method_name = method_node
+              elsif 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) }

data/lib/rails_best_practices/option_parser.rb

@@ -10,6 +10,7 @@ module RailsBestPractices
     #    -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-atom                  open file by atom in html format
     #        --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)
@@ -49,6 +50,10 @@ module RailsBestPractices
           options['without-color'] = true
         end
 
+        opts.on('--with-atom', 'open file by atom in html format') do
+          options['with-atom'] = true
+        end
+
         opts.on('--with-textmate', 'open file by textmate in html format') do
           options['with-textmate'] = true
         end

data/lib/rails_best_practices/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailsBestPractices
-  VERSION = '1.21.0'
+  VERSION = '1.23.1'
 end

data/rails_best_practices.gemspec

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
-require File.expand_path('lib/rails_best_practices/version', __dir__)
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rails_best_practices/version'
 
 Gem::Specification.new do |spec|
   spec.name        = 'rails_best_practices'
@@ -16,13 +18,13 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 1.9.0'
   spec.required_rubygems_version = '>= 1.3.6'
 
-  spec.add_dependency('activesupport')
-  spec.add_dependency('code_analyzer', '>= 0.5.2')
-  spec.add_dependency('erubis')
-  spec.add_dependency('i18n')
-  spec.add_dependency('json')
-  spec.add_dependency('require_all', '~> 3.0')
-  spec.add_dependency('ruby-progressbar')
+  spec.add_runtime_dependency('activesupport')
+  spec.add_runtime_dependency('code_analyzer', '~> 0.5.5')
+  spec.add_runtime_dependency('erubis')
+  spec.add_runtime_dependency('i18n')
+  spec.add_runtime_dependency('json')
+  spec.add_runtime_dependency('require_all', '~> 3.0')
+  spec.add_runtime_dependency('ruby-progressbar')
 
   spec.add_development_dependency('awesome_print')
   spec.add_development_dependency('bundler')

data/spec/rails_best_practices/reviews/remove_unused_methods_in_models_review_spec.rb

@@ -556,6 +556,28 @@ module RailsBestPractices
         end
       end
 
+      if RUBY_VERSION.to_f > 3.0
+        context 'short syntax value' do
+          it 'does not remove unused method' do
+            content = <<-EOF
+            class Post < ActiveRecord::Base
+              def build
+                new(value:)
+              end
+
+              def value
+                'value'
+              end
+            end
+            EOF
+            runner.prepare('app/models/post.rb', content)
+            runner.review('app/models/post.rb', content)
+            runner.after_review
+            expect(runner.errors.size).to eq(1)
+          end
+        end
+      end
+
       context 'callbacks' do
         it 'does not remove unused method' do
           content = <<-EOF

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_best_practices
 version: !ruby/object:Gem::Version
-  version: 1.21.0
+  version: 1.23.1
 platform: ruby
 authors:
 - Richard Huang
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-15 00:00:00.000000000 Z
+date: 2022-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -28,16 +28,16 @@ dependencies:
   name: code_analyzer
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.2
+        version: 0.5.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.2
+        version: 0.5.5
 - !ruby/object:Gem::Dependency
   name: erubis
   requirement: !ruby/object:Gem::Requirement
@@ -200,12 +200,15 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/main.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
+- ".ruby-version"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
+- Gemfile.ruby-2.6
+- Gemfile.ruby-2.6.lock
 - Guardfile
 - MIT_LICENSE
 - README.md
@@ -403,7 +406,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: a code metric tool for rails codes.

data/.travis.yml

@@ -1,4 +0,0 @@
-language: ruby
-rvm:
-  - 2.6.4
-script: bundle exec rspec spec