rubocop-rspec_enforce_description 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dbc69dbb07ae8301f42c5557d118a425db2515a45e7a936e1a888cf3198b3af7
+  data.tar.gz: caccd680fe6a7627cf5c36e9c3f1ef8b33d1bfcba3dd5fea816451a199f6cd3f
+SHA512:
+  metadata.gz: d2a0660e8de73f327c9b54489dad658cc7491559a188f967b9b8685ad47248d45dc88acdb559547d9ef4d7a8c9533c2d9ee1afcc7964cb8bd45d16614e463c57
+  data.tar.gz: 468975150ed369b476f250b10a5d1a522ec5d9cb1fb3223465bad57ea75926c7f36226941f3cff05af2d573d41cf54510dda3a41b11878291ae1e722c961d78c

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,145 @@
+AllCops:
+  NewCops: enable
+  DisplayCopNames: true
+  SuggestExtensions: false
+
+# 日本語のコメントを許可する
+Style/AsciiComments:
+  Enabled: false
+
+# self.xx を許可
+Style/RedundantSelf:
+  Enabled: false
+
+# ダブルクォーテーション
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+# 行数チェックは無効化
+Layout/LineLength:
+  Enabled: false
+
+# トップレベルのクラスのドキュメントコメントがありませんを無効化
+Style/Documentation:
+  Enabled: false
+
+# %w()とかで統一する
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    "%": ()
+    "%i": ()
+    "%q": ()
+    "%Q": ()
+    "%r": ()
+    "%s": ()
+    "%w": ()
+    "%W": ()
+    "%x": ()
+
+# ifかunlessかは場合によって選びたい
+Style/IfUnlessModifier:
+  Enabled: false
+
+# if!とunlessは別物
+Style/NegatedIf:
+  Enabled: false
+
+# rakeタスクとかで困る
+Lint/UnusedBlockArgument:
+  Enabled: false
+
+# https://qiita.com/rorensu2236/items/d0d685307b75bdaf179f
+Style/HashEachMethods:
+  Enabled: true
+Style/HashTransformKeys:
+  Enabled: true
+Style/HashTransformValues:
+  Enabled: true
+
+# メトリクス系は一旦全無視で
+Metrics/AbcSize:
+  Enabled: false
+Metrics/BlockLength:
+  Enabled: false
+Metrics/BlockNesting:
+  Enabled: false
+Metrics/ClassLength:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Metrics/ModuleLength:
+  Enabled: false
+Metrics/ParameterLists:
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+# frozen_string_literal記述不可
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: never
+
+# 空メソッドも複数行で書くべき
+Style/EmptyMethod:
+  EnforcedStyle: expanded
+
+# あとで考える
+Style/GuardClause:
+  Enabled: false
+
+# n > 0 使いたい
+Style/NumericPredicate:
+  Enabled: false
+
+# 7桁以上なら数字に_必須
+Style/NumericLiterals:
+  Enabled: false
+
+# rescue => e で書きたい
+Style/RescueStandardError:
+  EnforcedStyle: implicit
+
+# === 使いたい
+Style/CaseEquality:
+  Enabled: false
+
+# 大量引数は避けるべきだがしゃーないときもある
+Naming/MethodParameterName:
+  Enabled: false
+
+# rescue nilを1行で書きたい
+Style/RescueModifier:
+  Enabled: false
+
+# do endブロックをいい感じに
+Layout/BlockAlignment:
+  EnforcedStyleAlignWith: start_of_block
+
+# 複数行ハッシュで無駄なスペース作らないように
+Layout/FirstArrayElementIndentation:
+  EnforcedStyle: consistent
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented_relative_to_receiver
+
+# Lambdaは ->(x) { x } で書く
+Style/Lambda:
+  EnforcedStyle: literal
+
+# 三項演算子のカッコ統一
+Style/TernaryParentheses:
+  EnforcedStyle: require_parentheses_when_complex
+
+# 三項演算子の場合もスタイルを統一しようとするので無効化
+Style/ConditionalAssignment:
+  Enabled: false
+
+# 最初のパラメータに位置を合わせるではなくメソッド呼び出しの行から1段階インデント
+Layout/ArgumentAlignment:
+  EnforcedStyle: with_fixed_indentation
+
+Naming/FileName:
+  Enabled: false

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 thr3a
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,35 @@
+# RuboCop::RspecEnforceDescription
+
+TODO: Delete this and the text below, and describe your 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
+
+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.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG --require=false
+
+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
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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).

data/Rakefile

@@ -0,0 +1,33 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i(spec rubocop)
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList["spec/**/*_spec.rb"]
+end
+
+desc "Generate a new cop with a template"
+task :new_cop, [:cop] do |_task, args|
+  require "rubocop"
+
+  cop_name = args.fetch(:cop) do
+    warn "usage: bundle exec rake new_cop[Department/Name]"
+    exit!
+  end
+
+  generator = RuboCop::Cop::Generator.new(cop_name)
+
+  generator.write_source
+  generator.write_spec
+  generator.inject_require(root_file_path: "lib/rubocop/cop/rspec_enforce_description_cops.rb")
+  generator.inject_config(config_file_path: "config/default.yml")
+
+  puts generator.todo
+end

data/config/default.yml

@@ -0,0 +1,4 @@
+RSpec/EnforceDescription:
+  Description: "RSpecのcontextのdescriptionが「場合」で終わることを強制します。"
+  Enabled: true
+  VersionAdded: "0.1.0"

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

@@ -0,0 +1,41 @@
+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`メソッドが呼び出され、
+        # その最初の引数が文字列リテラルであるパターンにマッチします。
+        # `$_` はその文字列リテラルの値をキャプチャします。
+        def_node_matcher :context_with_description?, <<~PATTERN
+          (send nil? :context (str $_) ...)
+        PATTERN
+
+        # `send`ノード（メソッド呼び出し）が検出されたときに呼び出されます。
+        # このコップは`RESTRICT_ON_SEND`で`:context`に制限されているため、
+        # `context`メソッドの呼び出しに対してのみ実行されます。
+        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)
+          end
+        end
+        # `csend`ノード（条件付きメソッド呼び出し、例: `obj&.method`）に対しても
+        # `on_send`と同じロジックを適用します。
+        alias on_csend on_send
+      end
+    end
+  end
+end

data/lib/rubocop/cop/rspec_enforce_description_cops.rb

@@ -0,0 +1 @@
+require_relative "rspec/enforce_description"

data/lib/rubocop/rspec_enforce_description/plugin.rb

@@ -0,0 +1,29 @@
+require "lint_roller"
+
+module RuboCop
+  module RspecEnforceDescription
+    # A plugin that integrates rubocop-rspec_enforce_description with RuboCop's plugin system.
+    class Plugin < LintRoller::Plugin
+      def about
+        LintRoller::About.new(
+          name: "rubocop-rspec_enforce_description",
+          version: VERSION,
+          homepage: "TODO: Put your plugin's homepage URL here.",
+          description: "TODO: Put your plugin's description here."
+        )
+      end
+
+      def supported?(context)
+        context.engine == :rubocop
+      end
+
+      def rules(_context)
+        LintRoller::Rules.new(
+          type: :path,
+          config_format: :rubocop,
+          value: Pathname.new(__dir__).join("../../../config/default.yml")
+        )
+      end
+    end
+  end
+end

data/lib/rubocop/rspec_enforce_description/version.rb

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

data/lib/rubocop/rspec_enforce_description.rb

@@ -0,0 +1,8 @@
+require_relative "rspec_enforce_description/version"
+
+module RuboCop
+  module RspecEnforceDescription
+    class Error < StandardError; end
+    # Your code goes here...
+  end
+end

data/lib/rubocop-rspec_enforce_description.rb

@@ -0,0 +1,7 @@
+require "rubocop"
+
+require_relative "rubocop/rspec_enforce_description"
+require_relative "rubocop/rspec_enforce_description/version"
+require_relative "rubocop/rspec_enforce_description/plugin"
+
+require_relative "rubocop/cop/rspec_enforce_description_cops"

data/memo.md

@@ -0,0 +1,30 @@
+```
+❯ bundle exec rake new_cop -T
+rake build                    # Build rubocop-rspec_enforce_description-0.1.0.gem into the pkg directory
+rake build:checksum           # Generate SHA512 checksum of rubocop-rspec_enforce_description-0.1.0.gem into the checksums directory
+rake clean                    # Remove any temporary products
+rake clobber                  # Remove any generated files
+rake install                  # Build and install rubocop-rspec_enforce_description-0.1.0.gem into system gems
+rake install:local            # Build and install rubocop-rspec_enforce_description-0.1.0.gem into system gems without network access
+rake new_cop[cop]             # Generate a new cop with a template
+rake release[remote]          # Create tag v0.1.0 and build and push rubocop-rspec_enforce_description-0.1.0.gem to rubygems.org
+rake rubocop                  # Run RuboCop
+rake rubocop:autocorrect      # Autocorrect RuboCop offenses (only when it's safe)
+rake rubocop:autocorrect_all  # Autocorrect RuboCop offenses (safe and unsafe)
+rake spec                     # Run RSpec code examples
+```
+
+```
+❯ bundle exec rake 'new_cop[RSpec/enforce_description]'
+[create] lib/rubocop/cop/rspec/enforce_description.rb
+[create] spec/rubocop/cop/rspec/enforce_description_spec.rb
+[modify] lib/rubocop/cop/rspec_enforce_description_cops.rb - `require_relative 'rspec/enforce_description'` was injected.
+[modify] A configuration for the cop is added into config/default.yml.
+Do 4 steps:
+  1. Modify the description of RSpec/EnforceDescription in config/default.yml
+  2. Implement your new cop in the generated file!
+  3. Commit your new cop with a message such as
+     e.g. "Add new `RSpec/EnforceDescription` cop"
+  4. Run `bundle exec rake changelog:new` to generate a changelog entry
+     for your new cop.
+```

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-rspec_enforce_description
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- thr3a
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-05-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lint_roller
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.72.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.72.2
+description:
+email:
+- thr3a@example.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- LICENSE.txt
+- README.md
+- Rakefile
+- config/default.yml
+- lib/rubocop-rspec_enforce_description.rb
+- lib/rubocop/cop/rspec/enforce_description.rb
+- lib/rubocop/cop/rspec_enforce_description_cops.rb
+- lib/rubocop/rspec_enforce_description.rb
+- lib/rubocop/rspec_enforce_description/plugin.rb
+- lib/rubocop/rspec_enforce_description/version.rb
+- memo.md
+homepage: https://github.com/thr3a/rubocop-rspec_enforce_description
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/thr3a/rubocop-rspec_enforce_description
+  source_code_uri: https://github.com/thr3a/rubocop-rspec_enforce_description
+  default_lint_roller_plugin: RuboCop::RspecEnforceDescription::Plugin
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key:
+specification_version: 4
+summary: Custom cops that define rules for rspec descriptions
+test_files: []