rubocop-exception_messages 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fc8af98d6bdcef4ebe89488a40c7bbb813ca3a9cbc6c6c87e7ad9fa5a09a1127
+  data.tar.gz: e6f89e17ee748d3f978f4bf332a1ec7d3d9d6f1731ce6d5dbdf2fdb6bb39c852
+SHA512:
+  metadata.gz: debf11ec95b5b9533c58d471b44d142747437fe951c797fa5734723d6eab32ae945e511b24a179590d822155e859f85d983a85365af8a2b6cb3b858353df4b7b
+  data.tar.gz: f8cf2d88a4542efc375d5e9074f0efcee550266a2f69d18ada7dfccadddeb66850b6e7be8df8056d166f0a25c6f49f89bb539e13bb4b9c5984266b2124935ba0

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+### 0.1.0 (2026/09/05)
+
+#### Features
+
+* Initial release with `ExceptionMessages/Casing` and `ExceptionMessages/Punctuation` cops - [@dblock](https://github.com/dblock).
+* Add Danger CI check that enforces a CHANGELOG entry on every pull request - [@dblock](https://github.com/dblock).
+* Add RELEASING.md - [@dblock](https://github.com/dblock).
+* [#2](https://github.com/dblock/rubocop-exception_messages/pull/2): Add test coverage reporting with SimpleCov and Coveralls - [@dblock](https://github.com/dblock).
+* [#3](https://github.com/dblock/rubocop-exception_messages/pull/3): Split RuboCop linting into its own `Lint` CI workflow, separate from `Test` - [@dblock](https://github.com/dblock).
+* [#4](https://github.com/dblock/rubocop-exception_messages/pull/4): Test against Ruby 3.2, 3.3, 3.4 and 4.0 in CI - [@dblock](https://github.com/dblock).
+

data/CONTRIBUTING.md

@@ -0,0 +1,76 @@
+Contributing to rubocop-exception_messages
+===========================================
+
+This gem follows the same contribution flow as most Ruby open-source projects.
+
+#### Fork the Project
+
+Fork the [project on Github](https://github.com/dblock/rubocop-exception_messages) and check out your copy.
+
+```
+git clone https://github.com/contributor/rubocop-exception_messages.git
+cd rubocop-exception_messages
+git remote add upstream https://github.com/dblock/rubocop-exception_messages.git
+```
+
+#### Create a Topic Branch
+
+Make sure your fork is up-to-date and create a topic branch for your feature or bug fix.
+
+```
+git checkout main
+git pull upstream main
+git checkout -b my-feature-branch
+```
+
+#### Bundle Install and Test
+
+Ensure that you can build the project and run tests.
+
+```
+bundle install
+bundle exec rake
+```
+
+#### Write Tests
+
+Add specs for new or changed cop behavior under [spec/rubocop/cop/exception_messages](spec/rubocop/cop/exception_messages), using RuboCop's `expect_offense`/`expect_correction` helpers.
+
+#### Write Code
+
+Implement your feature or bug fix. Ruby style is enforced with RuboCop itself: run `bundle exec rubocop` and fix any style issues highlighted.
+
+Make sure that `bundle exec rake` completes without errors.
+
+#### Update Changelog
+
+Add a line to [CHANGELOG.md](CHANGELOG.md) under *Next Release*, including your name and a link to your Github account.
+
+#### Commit Changes
+
+Make sure git knows your name and email address:
+
+```
+git config --global user.name "Your Name"
+git config --global user.email "contributor@example.com"
+```
+
+Writing good commit messages is important. A commit message should describe what changed, why, and reference issues fixed (if any).
+
+#### Push
+
+```
+git push origin my-feature-branch
+```
+
+#### Make a Pull Request
+
+Go to https://github.com/contributor/rubocop-exception_messages and select your feature branch, then click the pull request button and fill out the form.
+
+#### Be Patient
+
+It may take time for a maintainer to respond. Please be patient and allow for time to review contributions.
+
+#### Thank You
+
+Please do know that we really appreciate and value your time and work. We love you, really.

data/Dangerfile

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+changelog.check!

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Daniel (dB.) Doubrovkine
+
+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,67 @@
+# rubocop-exception_messages
+
+[![Ruby](https://github.com/dblock/rubocop-exception_messages/actions/workflows/test.yml/badge.svg)](https://github.com/dblock/rubocop-exception_messages/actions/workflows/test.yml)
+[![Coverage Status](https://coveralls.io/repos/github/dblock/rubocop-exception_messages/badge.svg?branch=master)](https://coveralls.io/github/dblock/rubocop-exception_messages?branch=master)
+
+RuboCop cops that standardize the style of raised exception messages, consistent with Ruby's own core and standard library exceptions (e.g. `TypeError: no implicit conversion from nil to integer`, `ArgumentError: wrong number of arguments`).
+
+## Rationale
+
+Ruby's built-in exceptions never capitalize or punctuate their messages. This reads naturally when Ruby prints the exception class name, a colon, and the message together in a backtrace (`ArgumentError: block is required`, not `ArgumentError: Block is required.`). These cops help keep custom `raise` messages consistent with that convention.
+
+## Installation
+
+Add to your `Gemfile`:
+
+```ruby
+group :development do
+  gem "rubocop-exception_messages", require: false
+end
+```
+
+Then require it in your `.rubocop.yml`:
+
+```yaml
+plugins:
+  - rubocop-exception_messages
+```
+
+## Cops
+
+### ExceptionMessages/Casing
+
+Checks that raised exception messages start with a lowercase letter.
+
+```ruby
+# bad
+raise ArgumentError, "Block is required"
+raise ArgumentError.new("Block is required")
+
+# good
+raise ArgumentError, "block is required"
+raise ArgumentError.new("block is required")
+```
+
+### ExceptionMessages/Punctuation
+
+Checks that raised exception messages do not end with a period.
+
+```ruby
+# bad
+raise ArgumentError, "block is required."
+raise ArgumentError.new("block is required.")
+
+# good
+raise ArgumentError, "block is required"
+raise ArgumentError.new("block is required")
+```
+
+Both cops support autocorrection (`rubocop -A`).
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md).
+
+## Copyright and License
+
+MIT License, see [LICENSE](LICENSE.txt) for details.

data/RELEASING.md

@@ -0,0 +1,86 @@
+Releasing rubocop-exception_messages
+=====================================
+
+There're no particular rules about when to release rubocop-exception_messages. Release bug fixes frequently, features not so frequently and breaking API changes rarely.
+
+### Release
+
+Run tests, check that all tests succeed locally.
+
+```
+bundle install
+bundle exec rake
+```
+
+Double-check that the [last build succeeded](https://github.com/dblock/rubocop-exception_messages/actions) in GitHub Actions.
+
+Change "Next" in [CHANGELOG.md](CHANGELOG.md) to the new version.
+
+```
+### 0.1.0 (2026/01/01)
+```
+
+Remove the line with "* Your contribution here.", since there will be no more contributions to this release.
+
+Bump the version in [lib/rubocop/exception_messages/version.rb](lib/rubocop/exception_messages/version.rb).
+
+```ruby
+module RuboCop
+  module ExceptionMessages
+    VERSION = '0.1.0'
+  end
+end
+```
+
+Commit your changes.
+
+```
+git add CHANGELOG.md lib/rubocop/exception_messages/version.rb
+git commit -m "Preparing for release, 0.1.0."
+git push origin master
+```
+
+Release.
+
+```
+$ bundle exec rake release
+
+rubocop-exception_messages 0.1.0 built to pkg/rubocop-exception_messages-0.1.0.gem.
+Tagged v0.1.0.
+Pushed git commits and tags.
+Pushed rubocop-exception_messages 0.1.0 to rubygems.org.
+```
+
+### Prepare for the Next Version
+
+Add the next release to [CHANGELOG.md](CHANGELOG.md).
+
+```
+### 0.1.1 (Next)
+
+#### Features
+
+* Your contribution here.
+
+#### Fixes
+
+* Your contribution here.
+```
+
+Bump the version in [lib/rubocop/exception_messages/version.rb](lib/rubocop/exception_messages/version.rb).
+
+```ruby
+module RuboCop
+  module ExceptionMessages
+    VERSION = '0.1.1'
+  end
+end
+```
+
+Commit your changes.
+
+```
+git add CHANGELOG.md lib/rubocop/exception_messages/version.rb
+git commit -m "Preparing for next development iteration, 0.1.1."
+git push origin master
+```

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+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]

data/config/default.yml

@@ -0,0 +1,12 @@
+ExceptionMessages:
+  Enabled: true
+
+ExceptionMessages/Casing:
+  Description: 'Checks that raised exception messages start with a lowercase letter.'
+  Enabled: true
+  VersionAdded: '0.1'
+
+ExceptionMessages/Punctuation:
+  Description: 'Checks that raised exception messages do not end with a period.'
+  Enabled: true
+  VersionAdded: '0.1'

data/lib/rubocop/cop/exception_messages/casing.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module ExceptionMessages
+      # Checks that raised exception messages start with a lowercase letter,
+      # consistent with Ruby's own core and standard library exceptions
+      # (e.g. `TypeError: no implicit conversion from nil to integer`).
+      #
+      # @example
+      #   # bad
+      #   raise ArgumentError, "Block is required"
+      #   raise ArgumentError.new("Block is required")
+      #
+      #   # good
+      #   raise ArgumentError, "block is required"
+      #   raise ArgumentError.new("block is required")
+      class Casing < Base
+        include MessageNode
+        extend AutoCorrector
+
+        MSG = 'Exception messages should start with a lowercase letter.'
+
+        def on_send(node)
+          message_node = raise_message_node(node)
+          return unless message_node
+
+          first_segment = first_string_segment(message_node)
+          return unless first_segment
+
+          content = first_segment.value
+          return if content.empty? || content[0] !~ /[A-Z]/
+
+          add_offense(message_node) do |corrector|
+            corrected = content.sub(/\A./, &:downcase)
+            corrector.replace(first_segment.loc.expression, first_segment.source.sub(content, corrected))
+          end
+        end
+
+        private
+
+        def first_string_segment(message_node)
+          segment = message_node.str_type? ? message_node : message_node.child_nodes.first
+          segment if segment&.str_type?
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/exception_messages/message_node.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module ExceptionMessages
+      # Shared helpers for locating the string literal passed to `raise`.
+      module MessageNode
+        private
+
+        def raise_message_node(node)
+          return unless node.method?(:raise)
+
+          message_arg = extract_message_arg(node.arguments)
+          return unless message_arg
+          return unless message_arg.str_type? || message_arg.dstr_type?
+
+          message_arg
+        end
+
+        def extract_message_arg(args)
+          return if args.empty?
+
+          first_arg = args.first
+          return first_arg.arguments.first if first_arg.send_type? && first_arg.method?(:new)
+
+          args[1]
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/exception_messages/punctuation.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module ExceptionMessages
+      # Checks that raised exception messages do not end with a period,
+      # consistent with Ruby's own core and standard library exceptions
+      # (e.g. `ArgumentError: wrong number of arguments`).
+      #
+      # @example
+      #   # bad
+      #   raise ArgumentError, "block is required."
+      #   raise ArgumentError.new("block is required.")
+      #
+      #   # good
+      #   raise ArgumentError, "block is required"
+      #   raise ArgumentError.new("block is required")
+      class Punctuation < Base
+        include MessageNode
+        extend AutoCorrector
+
+        MSG = 'Exception messages should not end with a period.'
+
+        def on_send(node)
+          message_node = raise_message_node(node)
+          return unless message_node
+
+          last_segment = last_string_segment(message_node)
+          return unless last_segment
+
+          check_segment(message_node, last_segment)
+        end
+
+        private
+
+        def check_segment(message_node, segment)
+          content = segment.value
+          return unless content.end_with?('.')
+          return if content.end_with?('..') # ellipsis-style, not a sentence-ending period
+
+          add_offense(message_node) do |corrector|
+            corrected = content.sub(/\.\z/, '')
+            corrector.replace(segment.loc.expression, segment.source.sub(content, corrected))
+          end
+        end
+
+        def last_string_segment(message_node)
+          segment = message_node.str_type? ? message_node : message_node.child_nodes.last
+          segment if segment&.str_type?
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/exception_messages_cops.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require_relative 'exception_messages/message_node'
+require_relative 'exception_messages/casing'
+require_relative 'exception_messages/punctuation'

data/lib/rubocop/exception_messages/plugin.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'lint_roller'
+
+module RuboCop
+  module ExceptionMessages
+    # A plugin that integrates RuboCop ExceptionMessages with RuboCop's plugin system.
+    class Plugin < LintRoller::Plugin
+      def about
+        LintRoller::About.new(
+          name: 'rubocop-exception_messages',
+          version: VERSION,
+          homepage: 'https://github.com/dblock/rubocop-exception_messages',
+          description: 'RuboCop cops that standardize the style of raised exception messages.'
+        )
+      end
+
+      def supported?(context)
+        context.engine == :rubocop
+      end
+
+      def rules(_context)
+        project_root = Pathname.new(__dir__).join('../../..')
+
+        LintRoller::Rules.new(type: :path, config_format: :rubocop, value: project_root.join('config', 'default.yml'))
+      end
+    end
+  end
+end

data/lib/rubocop/exception_messages/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module ExceptionMessages
+    VERSION = '0.1.0'
+  end
+end

data/lib/rubocop/exception_messages.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RuboCop
+  # RuboCop cops for standardizing the style of raised exception messages.
+  module ExceptionMessages
+  end
+end

data/lib/rubocop-exception_messages.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+
+require_relative 'rubocop/exception_messages/version'
+require_relative 'rubocop/cop/exception_messages_cops'
+require_relative 'rubocop/exception_messages'
+require_relative 'rubocop/exception_messages/plugin'

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-exception_messages
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel (dB.) Doubrovkine
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2026-09-05 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.72'
+description: RuboCop cops that check raised exception messages start with a lowercase
+  letter and do not end with a period, consistent with Ruby's own core and standard
+  library exceptions.
+email:
+- dblock@dblock.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTING.md
+- Dangerfile
+- LICENSE.txt
+- README.md
+- RELEASING.md
+- Rakefile
+- config/default.yml
+- lib/rubocop-exception_messages.rb
+- lib/rubocop/cop/exception_messages/casing.rb
+- lib/rubocop/cop/exception_messages/message_node.rb
+- lib/rubocop/cop/exception_messages/punctuation.rb
+- lib/rubocop/cop/exception_messages_cops.rb
+- lib/rubocop/exception_messages.rb
+- lib/rubocop/exception_messages/plugin.rb
+- lib/rubocop/exception_messages/version.rb
+homepage: https://github.com/dblock/rubocop-exception_messages
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/dblock/rubocop-exception_messages
+  source_code_uri: https://github.com/dblock/rubocop-exception_messages
+  changelog_uri: https://github.com/dblock/rubocop-exception_messages/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+  default_lint_roller_plugin: RuboCop::ExceptionMessages::Plugin
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.16
+signing_key:
+specification_version: 4
+summary: RuboCop cops for standardizing the style of raised exception messages.
+test_files: []