rails_best_practices 1.20.1 → 1.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e7a2b67944c27b7a11e48f2c490a4ea1080fc4df39ad1d59b20cdeaedfb4b083
-  data.tar.gz: d96f6d7da9909bac895162f70ae1247a98a8df39da7fd2ce17365e959568c4f6
+  metadata.gz: e268c4837f5a1da4ac684c78bef59cd06ce20c69cc41ea9478391242897c5d4b
+  data.tar.gz: 3bfc141a02bfcb95f40f938be6d101ab3e0aed55518eb8c42d2a6c5b2effd246
 SHA512:
-  metadata.gz: 244acdd4067af5f87364236d4fe5bc40d5a4d68b98d1c6786aaf0e53c7766626ef670c4aaa61d793a47bba643fddcd2cbd545a4697dff8d0a3d6f7238912c2b5
-  data.tar.gz: 9b4ca4c95172317d9017691399fcb9211295bad98959477fa8fa24a054a7a6283dc7cdbabd926e925ccf0f3ea9bfe1dde3e594cc42a2db7bd3b37758cb7bdc6e
+  metadata.gz: f3c124054e218a06478ef27973a2fc6aed24eb4bc45fac4eebd3274b61a1fea9650c8d9bd366a06657714d22c5905ba00315a75f787556eab5a6527ad947011b
+  data.tar.gz: 4e0f3e83007b69bbba800ff378caf08adf5e87d8fd8e5d913c55ef35052775697f72c7c038cebaf417f13a29cdf654b2ce25effe570ae5e6fabf6988b4735401

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Next Release
 
+## 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.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rails_best_practices (1.20.1)
+    rails_best_practices (1.21.0)
       activesupport
       code_analyzer (>= 0.5.2)
       erubis

data/lib/rails_best_practices.rb

@@ -8,6 +8,7 @@ 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'
 

data/lib/rails_best_practices/analyzer.rb

@@ -326,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
 

data/lib/rails_best_practices/core/runner.rb

@@ -65,6 +65,9 @@ module RailsBestPractices
             checkers: @prepares.reject { |checker| checker.is_a? Prepares::GemfilePrepare }
           )
         @review_checker ||= CodeAnalyzer::CheckingVisitor::Default.new(checkers: @reviews)
+
+        @inlnie_disable ||= InlineDisables::InlineDisable.new
+        @inline_disable_checker ||= CodeAnalyzer::CheckingVisitor::Plain.new(checkers: [@inlnie_disable])
       end
 
       # lexical analysis the file.
@@ -106,11 +109,27 @@ module RailsBestPractices
         @review_checker.after_check
       end
 
+      # disable check by inline comment the file.
+      #
+      # @param [String] filename of the file
+      # @param [String] content of the file
+      def inline_disable(filename, content)
+        content = parse_html_template(filename, content)
+        @inline_disable_checker.check(filename, content)
+      end
+
+      def after_inline_disable
+        @inline_disable_checker.after_check
+      end
+
       # get all errors from lexicals and reviews.
       #
       # @return [Array] all errors from lexicals and reviews
       def errors
-        @errors ||= (@reviews + @lexicals).collect(&:errors).flatten
+        @errors ||= begin
+          reported_errors = (@reviews + @lexicals).collect(&:errors).flatten
+          reported_errors.reject { |error| @inlnie_disable.disabled?(error) }
+        end
       end
 
       private

data/lib/rails_best_practices/inline_disables.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_rel 'inline_disables'

data/lib/rails_best_practices/inline_disables/comment_ripper.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module RailsBestPractices
+  module InlineDisables
+    class CommentRipper < Ripper::SexpBuilder
+      attr_reader :comments
+
+      def initialize(*arg)
+        super
+        @comments = []
+      end
+
+      def on_comment(*arg)
+        # [sexp_type, statement, [lineno, column]] = super
+        comments << super
+      end
+    end
+  end
+end

data/lib/rails_best_practices/inline_disables/inline_disable.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module RailsBestPractices
+  module InlineDisables
+    class InlineDisable < Core::Check
+      interesting_files ALL_FILES
+      url '#'
+
+      def initialize(*args)
+        super
+        @disabled_errors = []
+      end
+
+      def check(filename, content)
+        comments = CommentRipper.new(content).tap(&:parse).comments
+        comments.each do |_sexp_type, statement, (line_number, _column)|
+          add_as_disable_errors(filename, statement, line_number)
+        end
+      end
+
+      def disabled?(error)
+        error_key = [error.filename, error.line_number, error.type.split('::').last].join('-')
+        disabled_error_keys.include?(error_key)
+      end
+
+      private
+
+      def disabled_error_keys
+        @disabled_error_keys ||= Set.new(@disabled_errors.map { |e| [e.filename, e.line_number, e.type].join('-') })
+      end
+
+      def add_as_disable_errors(filename, statement, line_number)
+        match = statement.match(/rails_b(?:est_)?p(?:ractices)?:disable (.*)/)
+        return unless match
+
+        check_names = match[1].split(',')
+        check_names.each do |check_name|
+          add_as_disable_error(filename, check_name.gsub(/Check$/, 'Review'), line_number)
+        end
+      end
+
+      def add_as_disable_error(filename, check_name, line_number)
+        @disabled_errors <<
+          RailsBestPractices::Core::Error.new(
+            filename: filename, line_number: line_number, message: 'disable by inline comment', type: check_name, url: url
+          )
+      end
+    end
+  end
+end

data/lib/rails_best_practices/version.rb

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

data/spec/rails_best_practices/inline_disables/inline_disable_spec.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+module RailsBestPractices
+  module InlineDisables
+    describe InlineDisable do
+      let(:runner) { Core::Runner.new(reviews: Reviews::MoveModelLogicIntoModelReview.new) }
+
+      it 'moves model logic into model' do
+        content = <<-EOF
+        class PostsController < ApplicationController
+          def publish
+            @post = Post.find(params[:id])
+            @post.update_attributes(:is_published, true)
+            @post.approved_by = current_user
+
+            if @post.created_at > Time.now - 7.days
+              @post.popular = 100
+            else
+              @post.popular = 0
+            end
+
+            redirect_to post_url(@post)
+          end
+        end
+        EOF
+        runner.review('app/controllers/posts_controller.rb', content)
+        runner.inline_disable('app/controllers/posts_controller.rb', content)
+
+        expect(runner.errors.size).to eq(1)
+        expect(runner.errors[0].to_s).to eq(
+          'app/controllers/posts_controller.rb:2 - move model logic into model (@post use_count > 4)'
+        )
+      end
+
+      it 'is no error is output' do
+        content = <<-EOF
+        class PostsController < ApplicationController
+          def publish # rails_best_practices:disable MoveModelLogicIntoModelCheck
+            @post = Post.find(params[:id])
+            @post.update_attributes(:is_published, true)
+            @post.approved_by = current_user
+
+            if @post.created_at > Time.now - 7.days
+              @post.popular = 100
+            else
+              @post.popular = 0
+            end
+
+            redirect_to post_url(@post)
+          end
+        end
+        EOF
+        runner.review('app/controllers/posts_controller.rb', content)
+        runner.inline_disable('app/controllers/posts_controller.rb', content)
+
+        expect(runner.errors.size).to eq(0)
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_best_practices
 version: !ruby/object:Gem::Version
-  version: 1.20.1
+  version: 1.21.0
 platform: ruby
 authors:
 - Richard Huang
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-08 00:00:00.000000000 Z
+date: 2021-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -235,6 +235,9 @@ files:
 - lib/rails_best_practices/core/routes.rb
 - lib/rails_best_practices/core/runner.rb
 - lib/rails_best_practices/core_ext/erubis.rb
+- lib/rails_best_practices/inline_disables.rb
+- lib/rails_best_practices/inline_disables/comment_ripper.rb
+- lib/rails_best_practices/inline_disables/inline_disable.rb
 - lib/rails_best_practices/lexicals.rb
 - lib/rails_best_practices/lexicals/long_line_check.rb
 - lib/rails_best_practices/lexicals/remove_tab_check.rb
@@ -314,6 +317,7 @@ files:
 - spec/rails_best_practices/core/routes_spec.rb
 - spec/rails_best_practices/core/runner_spec.rb
 - spec/rails_best_practices/core_ext/erubis_spec.rb
+- spec/rails_best_practices/inline_disables/inline_disable_spec.rb
 - spec/rails_best_practices/lexicals/long_line_check_spec.rb
 - spec/rails_best_practices/lexicals/remove_tab_check_spec.rb
 - spec/rails_best_practices/lexicals/remove_trailing_whitespace_check_spec.rb
@@ -424,6 +428,7 @@ test_files:
 - spec/rails_best_practices/core/routes_spec.rb
 - spec/rails_best_practices/core/runner_spec.rb
 - spec/rails_best_practices/core_ext/erubis_spec.rb
+- spec/rails_best_practices/inline_disables/inline_disable_spec.rb
 - spec/rails_best_practices/lexicals/long_line_check_spec.rb
 - spec/rails_best_practices/lexicals/remove_tab_check_spec.rb
 - spec/rails_best_practices/lexicals/remove_trailing_whitespace_check_spec.rb