momocop 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f20cc9ff605a765cbb69d7540eab272368da8ec2db1508bf15f68c055256f306
-  data.tar.gz: ae33c4d6d07c9db8707f49694b3609f55297280f3910b2fb98613d52a44b2c7b
+  metadata.gz: 47c9203f322466a1799ecd615eace3f9c0112d959b560211bfc7b1e433d6697b
+  data.tar.gz: 1d63e00519322bf145ad906d40893cbab601dcdc447cd2ae4e7f3910da46e4ee
 SHA512:
-  metadata.gz: f1f054e0cff3c118d11191948622c99e5ccdffde3c09bacc7ea0e9fdffdc6dd2fb61158bc4d30ac7627ac87473a8188de34082780fee715fd7609abe7cadac71
-  data.tar.gz: 8838377046d17cf9f238747d0a0c6de7d2d78fbb0f01c672c391c3252dd47cacd962518b23e3f72ff15aeb3acd17d20e71bf2e3eb98557a8c7fccee982e7a279
+  metadata.gz: ada13b67eda1015615e5ee8725580a595f20125458ff68d35f9a6b9929e6391c6ee7baad478671cd4885dbf31a6f59e529d00b400dd36deabf9d99eb4b9a36a9
+  data.tar.gz: 42dfc6d561aa4e6d80c468e6c3eb3da490a1843b8d5f1b78b992359d7f30279c780190bcc32a5034815d82fb301d88230f05547650587449823b980a44cbc0e3

data/README.ja.md

@@ -48,6 +48,12 @@ Momocop/FactoryBotSingularFactoryName:
   Enabled: true
 Momocop/Layout/LeadingCommentSpace:
   Enabled: true
+Momocop/RspecContextTextPattern:
+  Enabled: true
+Momocop/RspecDescribeTextPattern:
+  Enabled: true
+Momocop/RspecItTextPattern:
+  Enabled: true
 ```
 
 ## Cop一覧
@@ -65,6 +71,9 @@ Momocop/Layout/LeadingCommentSpace:
 |[`Momocop/FactoryBotSingleFactoryPerDefine`](lib/rubocop/cop/momocop/factory_bot_single_factory_per_define.rb)|:white_check_mark:|:white_check_mark:|
 |[`Momocop/FactoryBotSingularFactoryName`](lib/rubocop/cop/momocop/factory_bot_singular_factory_name.rb)|:white_check_mark:|:white_check_mark:|
 |[`Momocop/Layout/LeadingCommentSpace`](lib/rubocop/cop/momocop/layout/leading_comment_space.rb)|||
+|[`Momocop/RspecContextTextPattern`](lib/rubocop/cop/momocop/rspec_context_text_pattern.rb)|||
+|[`Momocop/RspecDescribeTextPattern`](lib/rubocop/cop/momocop/rspec_describe_text_pattern.rb)|||
+|[`Momocop/RspecItTextPattern`](lib/rubocop/cop/momocop/rspec_it_text_pattern.rb)|||
 
 ## 貢献
 

data/README.md

@@ -48,6 +48,12 @@ Momocop/FactoryBotSingularFactoryName:
   Enabled: true
 Momocop/Layout/LeadingCommentSpace:
   Enabled: true
+Momocop/RspecContextTextPattern:
+  Enabled: true
+Momocop/RspecDescribeTextPattern:
+  Enabled: true
+Momocop/RspecItTextPattern:
+  Enabled: true
 ```
 
 ## Cops
@@ -65,6 +71,9 @@ Momocop/Layout/LeadingCommentSpace:
 |[`Momocop/FactoryBotSingleFactoryPerDefine`](lib/rubocop/cop/momocop/factory_bot_single_factory_per_define.rb)|:white_check_mark:|:white_check_mark:|
 |[`Momocop/FactoryBotSingularFactoryName`](lib/rubocop/cop/momocop/factory_bot_singular_factory_name.rb)|:white_check_mark:|:white_check_mark:|
 |[`Momocop/Layout/LeadingCommentSpace`](lib/rubocop/cop/momocop/layout/leading_comment_space.rb)|||
+|[`Momocop/RspecContextTextPattern`](lib/rubocop/cop/momocop/rspec_context_text_pattern.rb)|||
+|[`Momocop/RspecDescribeTextPattern`](lib/rubocop/cop/momocop/rspec_describe_text_pattern.rb)|||
+|[`Momocop/RspecItTextPattern`](lib/rubocop/cop/momocop/rspec_it_text_pattern.rb)|||
 
 ## Contributing
 

data/config/default.yml

@@ -0,0 +1,14 @@
+Momocop/RSpecDescribeTextPattern:
+  Description: 'Ensures that RSpec describe text matches the configured pattern'
+  Enabled: true
+  RequiredPattern: '^(?!When ).+'
+
+Momocop/RSpecContextTextPattern:
+  Description: 'Ensures that RSpec context text starts with When or If'
+  Enabled: true
+  RequiredPattern: '^(When|If) .+'
+
+Momocop/RSpecItTextPattern:
+  Description: 'Ensures that RSpec it block text matches the configured pattern'
+  Enabled: true
+  RequiredPattern: '^(should|will) .+$'

data/lib/momocop/helpers/factory_bot_helper.rb

@@ -75,7 +75,7 @@ module Momocop
 
         # begin
         if body_node.begin_type?
-          body_node&.children&.select { |node| definition_node?(node) } || []
+          body_node&.children&.select { |child_node| definition_node?(child_node) } || []
         # block
         elsif body_node.send_type? && definition_node?(body_node)
           [body_node]

data/lib/momocop/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Momocop
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/lib/rubocop/cop/momocop/factory_bot_single_define_per_file.rb

@@ -32,6 +32,8 @@ module RuboCop
         MSG = 'Only one `FactoryBot.define` block is allowed per file.'
 
         def on_new_investigation
+          return unless processed_source.ast
+
           factory_bot_define_blocks =
             processed_source
             .ast

data/lib/rubocop/cop/momocop/rspec_context_text_pattern.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Momocop
+      class RSpecContextTextPattern < Base
+        extend AutoCorrector
+        include RangeHelp
+
+        MSG = 'RSpec context text must match pattern: %<pattern>s'
+
+        def_node_matcher :context_block?, <<~PATTERN
+          (send nil? :context ...)
+        PATTERN
+
+        def on_send(node)
+          return unless context_block?(node)
+
+          arg = node.first_argument
+          return unless arg&.str_type?
+
+          text = arg.value.to_s
+          pattern = cop_config['RequiredPattern']
+          return if text.match?(Regexp.new(pattern))
+
+          add_offense(
+            node.first_argument.source_range,
+            message: format(MSG, pattern:)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/momocop/rspec_describe_text_pattern.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Momocop
+      class RSpecDescribeTextPattern < Base
+        extend AutoCorrector
+        include RangeHelp
+
+        MSG = 'RSpec describe text must match pattern: %<pattern>s'
+
+        def_node_matcher :describe_block?, <<~PATTERN
+          (send nil? :describe ...)
+        PATTERN
+
+        def on_send(node)
+          return unless describe_block?(node)
+
+          arg = node.first_argument
+          return unless arg&.str_type?
+
+          text = arg.value.to_s
+          pattern = cop_config['RequiredPattern']
+          return if text.match?(Regexp.new(pattern))
+
+          add_offense(
+            node.first_argument.loc.expression,
+            message: format(MSG, pattern:)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/momocop/rspec_it_text_pattern.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Momocop
+      class RSpecItTextPattern < Base
+        extend AutoCorrector
+        include RangeHelp
+
+        MSG = 'RSpec it block text must match pattern: %<pattern>s'
+
+        def_node_matcher :it_block?, <<~PATTERN
+          (send nil? :it ...)
+        PATTERN
+
+        def on_send(node)
+          return unless it_block?(node)
+
+          arg = node.first_argument
+          return unless arg&.str_type?
+
+          text = arg.value.to_s
+          pattern = cop_config['RequiredPattern']
+          return if text.match?(Regexp.new(pattern))
+
+          add_offense(
+            node.first_argument.loc.expression,
+            message: format(MSG, pattern:)
+          )
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: momocop
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - supermomonga
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-08-07 00:00:00.000000000 Z
+date: 2025-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -104,6 +104,9 @@ files:
 - lib/rubocop/cop/momocop/factory_bot_single_factory_per_define.rb
 - lib/rubocop/cop/momocop/factory_bot_singular_factory_name.rb
 - lib/rubocop/cop/momocop/layout/leading_comment_space.rb
+- lib/rubocop/cop/momocop/rspec_context_text_pattern.rb
+- lib/rubocop/cop/momocop/rspec_describe_text_pattern.rb
+- lib/rubocop/cop/momocop/rspec_it_text_pattern.rb
 - sig/momocop.rbs
 homepage: https://github.com/supermomonga/momocop
 licenses: