rubocop-rspec_enforce_description 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dbc69dbb07ae8301f42c5557d118a425db2515a45e7a936e1a888cf3198b3af7
-  data.tar.gz: caccd680fe6a7627cf5c36e9c3f1ef8b33d1bfcba3dd5fea816451a199f6cd3f
+  metadata.gz: cfcbb5a9b7f1801390f8a8910a7dec92bf7e3cc454fe4cc9218ffb8dc2a89141
+  data.tar.gz: e86b98c1b0c6454c0555a249907598d7bc3d838505e7aa801449acc86c5b42d1
 SHA512:
-  metadata.gz: d2a0660e8de73f327c9b54489dad658cc7491559a188f967b9b8685ad47248d45dc88acdb559547d9ef4d7a8c9533c2d9ee1afcc7964cb8bd45d16614e463c57
-  data.tar.gz: 468975150ed369b476f250b10a5d1a522ec5d9cb1fb3223465bad57ea75926c7f36226941f3cff05af2d573d41cf54510dda3a41b11878291ae1e722c961d78c
+  metadata.gz: 04d59e451c73ea5750e6f290bc34f5a6b0b15c89cf3b490064e363f913f87474d701ed2c1b52b34a13413855957fa7cb0e89341dace3931b9e2f824076abfa80
+  data.tar.gz: a6fe75c7c841d0a9accd471b86fab6220d6aa80f5b7cfd5ca05a18c9c83d6af5e6c9e0f183425efb909cc4bb7bc68ace4f006348e7eb8d9ea6d935ee8dfe5063

data/README.md

@@ -1,35 +1,40 @@
-# RuboCop::RspecEnforceDescription
+# rubocop-rspec_enforce_description
 
-TODO: Delete this and the text below, and describe your gem
+RSpecの各ブロックの説明文のルールを提供する[RuboCop](https://github.com/rubocop/rubocop)用のGemです。
+テスト記述の統一や可読性向上に役立ちます。
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rubocop/rspec_enforce_description`. To experiment with that code, run `bin/console` for an interactive prompt.
+# インストール
 
-## Installation
+```sh
+bundle add rubocop-rspec_enforce_description
+```
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+.rubocop.ymlへの設定例
 
-Install the gem and add to the application's Gemfile by executing:
+```yaml
+require:
+  - rubocop/rspec_enforce_description
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG --require=false
+RSpec/EnforceDescription:
+  Enabled: true
+```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+# ルール
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+## contectの説明文の最後が「場合」になっていること
 
-## Usage
+```ruby
+context 'ログインしているとき' do
+  # ...
+end
+# ↑ 警告: Context description should end with [場合].
+```
 
-TODO: Write usage instructions here
+## itの説明文の最後が「こと」になっていること
 
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rubocop-rspec_enforce_description.
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+```ruby
+it '大文字になります' do
+  # ...
+end
+# ↑ 警告: It description should end with [こと].
+```

data/lib/rubocop/cop/rspec/enforce_description.rb

@@ -2,38 +2,33 @@ module RuboCop
   module Cop
     module RSpec
       class EnforceDescription < Base
-        MSG = "Context description should end with [場合].".freeze
-        # `on_send`メソッドが呼び出されるノードの種類を制限します。
-        # ここでは`:context`メソッドの呼び出しに限定しています。
-        RESTRICT_ON_SEND = %i(context).freeze
-
-        # `context`メソッド呼び出しとその説明を抽出するためのノードマッチャーを定義します。
-        # `(send nil? :context (str $_) ...)` は、
-        # レシーバなしで`:context`メソッドが呼び出され、
-        # その最初の引数が文字列リテラルであるパターンにマッチします。
-        # `$_` はその文字列リテラルの値をキャプチャします。
+        MSG_CONTEXT = "Context description should end with [場合].".freeze
+        MSG_IT = "Example description should end with [こと].".freeze
+
+        RESTRICT_ON_SEND = %i(context it).freeze
+
         def_node_matcher :context_with_description?, <<~PATTERN
           (send nil? :context (str $_) ...)
         PATTERN
 
-        # `send`ノード（メソッド呼び出し）が検出されたときに呼び出されます。
-        # このコップは`RESTRICT_ON_SEND`で`:context`に制限されているため、
-        # `context`メソッドの呼び出しに対してのみ実行されます。
+        def_node_matcher :it_with_description?, <<~PATTERN
+          (send nil? :it (str $_) ...)
+        PATTERN
+
         def on_send(node)
-          # `context_with_description?`マッチャーを使用して、ノードが`context`ブロックであり、
-          # その説明を抽出できるかを確認します。
           context_with_description?(node) do |description|
-            # 説明が「場合」で終わっている場合は、違反ではないため処理を終了します。
             return if description.end_with?("場合")
 
-            # 説明が「場合」で終わっていない場合、違反として報告します。
-            # `node.first_argument.loc.expression`は、`context`メソッドの最初の引数（説明文字列）の
-            # ソースコード上の位置を指します。
-            add_offense(node.first_argument.loc.expression, message: MSG)
+            add_offense(node.first_argument.loc.expression, message: MSG_CONTEXT)
+          end
+
+          it_with_description?(node) do |description|
+            return if description.end_with?("こと")
+
+            add_offense(node.first_argument.loc.expression, message: MSG_IT)
           end
         end
-        # `csend`ノード（条件付きメソッド呼び出し、例: `obj&.method`）に対しても
-        # `on_send`と同じロジックを適用します。
+
         alias on_csend on_send
       end
     end

data/lib/rubocop/rspec_enforce_description/version.rb

@@ -1,5 +1,5 @@
 module RuboCop
   module RspecEnforceDescription
-    VERSION = "0.1.0".freeze
+    VERSION = "0.2.0".freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rspec_enforce_description
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - thr3a