sevencop 0.26.1 → 0.27.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ae1550d29e9e7aeb18b9f63d2e8f167ef5a7d871f2e953551e7be6c86038430
-  data.tar.gz: fba303001375952d8f8f1e3de021a9a5b155adc79440bb526342391c81be2a9b
+  metadata.gz: 9a2d0d56a1f5cbd0bc259bf81abbd5f2120f0a79e535ff9fafe6793de262dfb0
+  data.tar.gz: a43deda18fed1e061b3442a4bfb6ed27f7af6b71522adde160fe530326462722
 SHA512:
-  metadata.gz: a32371dd923b0922ae7072b11d6917cf876eec46061a3fe0a7229a5bac2713d77b66f75ef7259f15838173d20dbd7f039dcb4af0ce0c456216091906eda7f6c4
-  data.tar.gz: a5cece615fd407987d77a5e7d5db08ef78c816a07c3330da17fdd5d778552dfd4ff1d249d044b95540ce06a04b873623853b42a5e466bbe4d389fb284784f75a
+  metadata.gz: f4888e9cd333099c4ec83c9d0b71349572ad471f4788efe1d8eee377f10286eb6d5c8534e6bb427ad52303f5fcf24e77fc7f3df9aab9ebc35ac726e0098b940f
+  data.tar.gz: 1cc3e089fa3e922131dd91e4e2c1c7fa6f835a1619bc8c9234f7f86af4e677a0d033583ea8f4eb1cfc3f1da5abc93222eb8506749c616c434350275a18859af0

data/.rubocop.yml

@@ -32,7 +32,9 @@ RSpec/ExampleLength:
 RSpec/FilePath:
   CustomTransform:
     RSpecDescribeHttpEndpoint: rspec_describe_http_endpoint
+    RSpecEmptyLineAfterLet: rspec_empty_line_after_let
     RSpecExamplesInSameGroup: rspec_examples_in_same_group
+    RSpecMemoizedHelperBlockDelimiter: rspec_memoized_helper_block_delimiter
 
 RSpec/MultipleExpectations:
   Enabled: false

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sevencop (0.26.1)
+    sevencop (0.27.0)
       activesupport
       rubocop
 

data/README.md

@@ -45,7 +45,9 @@ Note that all cops are `Enabled: false` by default.
 - [Sevencop/RailsWhereNot](lib/rubocop/cop/sevencop/rails_where_not.rb)
 - [Sevencop/RequireOrdered](lib/rubocop/cop/sevencop/require_ordered.rb)
 - [Sevencop/RSpecDescribeHttpEndpoint](lib/rubocop/cop/sevencop/rspec_describe_http_endpoint.rb)
+- [Sevencop/RSpecEmptyLineAfterLet](lib/rubocop/cop/sevencop/rspec_empty_line_after_let.rb)
 - [Sevencop/RSpecExamplesInSameGroup](lib/rubocop/cop/sevencop/rspec_examples_in_same_group.rb)
+- [Sevencop/RSpecMemoizedHelperBlockDelimiter](lib/rubocop/cop/sevencop/rspec_memoized_helper_block_delimiter.rb)
 
 ## Notes
 

data/config/default.yml

@@ -141,6 +141,14 @@ Sevencop/RSpecDescribeHttpEndpoint:
   Include:
     - spec/requests/**/*.rb
 
+Sevencop/RSpecEmptyLineAfterLet:
+  Description: |
+    Insert empty line after `let`.
+  Enabled: false
+  VersionAdded: '0.27'
+  Include:
+    - spec/**/*
+
 Sevencop/RSpecExamplesInSameGroup:
   Description: |
     Combine examples in the same groups in the time-consuming kinds of specs.
@@ -150,3 +158,11 @@ Sevencop/RSpecExamplesInSameGroup:
   Include:
     - spec/controllers/**/*
     - spec/requests/**/*
+
+Sevencop/RSpecMemoizedHelperBlockDelimiter:
+  Description: |
+    Use do-end block delimiter on RSpec memoized helper.
+  Enabled: false
+  VersionAdded: '0.27'
+  Include:
+    - spec/**/*

data/lib/rubocop/cop/sevencop/rails_date_and_time_calculation.rb

@@ -8,7 +8,7 @@ module RuboCop
       # Prefer ActiveSupport date and time helper.
       #
       # @safety
-      #   This cop is unsafe becuase it considers that `n.days` is a Duration,
+      #   This cop is unsafe because it considers that `n.days` is a Duration,
       #   and `date` in `date == Date.current` is a Date, but there is no guarantee.
       #
       # @example
@@ -700,6 +700,14 @@ module RuboCop
           end
         end
 
+        # Determine whether this node should be enclosed in parentheses
+        # when it is used as a receiver of a method call in autocorrection.
+        # @param node [RuboCop::AST::Node]
+        # @return [Boolean]
+        def enclose_by_parentheses?(node)
+          node.send_type? && node.operator_method?
+        end
+
         # @param node [RuboCop::AST::SendNode]
         # @param method_name [Symbol]
         # @return [Boolean]
@@ -743,7 +751,7 @@ module RuboCop
           receiver:
         )
           receiver_source = receiver.source
-          receiver_source = "(#{receiver_source})" if receiver.operator_method?
+          receiver_source = "(#{receiver_source})" if enclose_by_parentheses?(receiver)
           [receiver_source, method].join('.')
         end
 

data/lib/rubocop/cop/sevencop/rspec_empty_line_after_let.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require 'set'
+
+module RuboCop
+  module Cop
+    module Sevencop
+      # Insert empty line after `let`.
+      #
+      # Since `let` defines a method, it should be written in the same style as `def`.
+      #
+      # @example
+      #   # bad
+      #   context 'with something' do
+      #     let(:foo) do
+      #       'foo'
+      #     end
+      #     let(:bar) do
+      #       'bar'
+      #     end
+      #   end
+      #
+      #   # good
+      #   context 'with something' do
+      #     let(:foo) do
+      #       'foo'
+      #     end
+      #
+      #     let(:bar) do
+      #       'bar'
+      #     end
+      #   end
+      #
+      #   # good
+      #   context 'with something' do
+      #     let(:foo) do
+      #       'foo'
+      #     end
+      #   end
+      class RSpecEmptyLineAfterLet < Base
+        extend AutoCorrector
+
+        MSG = 'Insert empty line after `let`.'
+
+        # @param node [RuboCop::AST::BlockNode]
+        # @return [void]
+        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
+          return unless bad?(node)
+
+          add_offense(node) do |corrector|
+            corrector.insert_after(node.location.end, "\n")
+          end
+        end
+
+        private
+
+        # @!method let?(node)
+        #   @param node [RuboCop::AST::BlockNode]
+        #   @return [Boolean]
+        def_node_matcher :let?, <<~PATTERN
+          (block
+            (send
+              nil?
+              {:let :let!}
+              ...
+            )
+            ...
+          )
+        PATTERN
+
+        # @param node [RuboCop::AST::BlockNode]
+        # @return [Boolean]
+        def bad?(node)
+          let?(node) &&
+            !empty_line_after?(node) &&
+            !last_child?(node)
+        end
+
+        # @param node [RuboCop::AST::BlockNode]
+        # @return [Boolean]
+        def empty_line_after?(node)
+          processed_source[node.location.end.line].strip.empty?
+        end
+
+        # @param node [RuboCop::AST::BlockNode]
+        # @return [Boolean]
+        def last_child?(node)
+          !node.parent&.begin_type? ||
+            node.equal?(node.parent.children.last)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/sevencop/rspec_memoized_helper_block_delimiter.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+require 'set'
+
+module RuboCop
+  module Cop
+    module Sevencop
+      # Use do-end block delimiter on RSpec memoized helper.
+      #
+      # Since these helpers define methods, they should be written in the same style as `def`.
+      #
+      # @example
+      #   # bad
+      #   let(:foo) { 'bar' }
+      #
+      #   # good
+      #   let(:foo) do
+      #     'bar'
+      #   end
+      #
+      #   # bad
+      #   subject(:foo) { 'bar' }
+      #
+      #   # good
+      #   subject(:foo) do
+      #     'bar'
+      #   end
+      class RSpecMemoizedHelperBlockDelimiter < Base
+        extend AutoCorrector
+
+        include ConfigurableEnforcedStyle
+        include RangeHelp
+
+        MSG = 'Use do-end block delimiter on RSpec memoized helper.'
+
+        # @param node [RuboCop::AST::BlockNode]
+        # @return [void]
+        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
+          return unless bad?(node)
+
+          add_offense(
+            node.location.begin.with(
+              end_pos: node.location.end.end_pos
+            )
+          ) do |corrector|
+            autocorrect(corrector, node)
+          end
+        end
+
+        private
+
+        # @!method memoized_helper?(node)
+        #   @param node [RuboCop::AST::Node]
+        #   @return [Boolean]
+        def_node_matcher :memoized_helper?, <<~PATTERN
+          (block
+            (send
+              nil?
+              {
+                :let
+                :let!
+                :subject
+              }
+              ...
+            )
+            ...
+          )
+        PATTERN
+
+        # @param corrector [RuboCop::Cop::Corrector]
+        # @param node [RuboCop::AST::BlockNode]
+        # @return [void]
+        def autocorrect(
+          corrector,
+          node
+        )
+          corrector.insert_before(node.location.begin, ' ') unless whitespace_before?(node.location.begin)
+          corrector.replace(node.location.begin, 'do')
+          corrector.replace(node.location.end, 'end')
+          wrap_in_newlines(corrector, node) if node.single_line?
+        end
+
+        # @param node [RuboCop::AST::BlockNode]
+        # @return [Boolean]
+        def bad?(node)
+          memoized_helper?(node) && node.braces?
+        end
+
+        # @param range [Parser::Source::Range]
+        # @return [Boolean]
+        def whitespace_before?(range)
+          range.source_buffer.source[range.begin_pos - 1].match?(/\s/)
+        end
+
+        # @param corrector [RuboCop::Cop::Corrector]
+        # @param node [RuboCop::AST::BlockNode]
+        # @return [void]
+        def wrap_in_newlines(
+          corrector,
+          node
+        )
+          corrector.wrap(
+            node.location.begin.with(
+              begin_pos: node.location.begin.end_pos,
+              end_pos: node.location.end.begin_pos
+            ),
+            "\n",
+            "\n"
+          )
+        end
+      end
+    end
+  end
+end

data/lib/sevencop/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Sevencop
-  VERSION = '0.26.1'
+  VERSION = '0.27.0'
 end

data/lib/sevencop.rb

@@ -21,4 +21,6 @@ require_relative 'rubocop/cop/sevencop/rails_uniqueness_validator_explicit_case_
 require_relative 'rubocop/cop/sevencop/rails_where_not'
 require_relative 'rubocop/cop/sevencop/require_ordered'
 require_relative 'rubocop/cop/sevencop/rspec_describe_http_endpoint'
+require_relative 'rubocop/cop/sevencop/rspec_empty_line_after_let'
 require_relative 'rubocop/cop/sevencop/rspec_examples_in_same_group'
+require_relative 'rubocop/cop/sevencop/rspec_memoized_helper_block_delimiter'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sevencop
 version: !ruby/object:Gem::Version
-  version: 0.26.1
+  version: 0.27.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-11-01 00:00:00.000000000 Z
+date: 2022-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -73,7 +73,9 @@ files:
 - lib/rubocop/cop/sevencop/rails_where_not.rb
 - lib/rubocop/cop/sevencop/require_ordered.rb
 - lib/rubocop/cop/sevencop/rspec_describe_http_endpoint.rb
+- lib/rubocop/cop/sevencop/rspec_empty_line_after_let.rb
 - lib/rubocop/cop/sevencop/rspec_examples_in_same_group.rb
+- lib/rubocop/cop/sevencop/rspec_memoized_helper_block_delimiter.rb
 - lib/sevencop.rb
 - lib/sevencop/config_loader.rb
 - lib/sevencop/cop_concerns.rb