rspec-description_consistency 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a0f2e9e090d2bc3707eae5656451fcb48932777e8eee53d9efee4741ae04dfb2
+  data.tar.gz: 8f9e93d88a4e81c1d9f7c30da88747db0a14f8b629dd488d0b0b9a9390140d6b
+SHA512:
+  metadata.gz: f8e9e8cdab51a8e86bf8dc611a9c9df71bea86161d4884914908b2b558ca8d409c284d1b39e35e1cba3612b85492b1b9436a77b50306c1c9546bacfa0e6dc266
+  data.tar.gz: 832491c5965120ff2bdf6e4dabfa099a7b59f41b2f34860b638bfec96e676040708f9606c37681f8e601e5c84e678b6aa03a357a32bf5f7bfb88a3659afd7be4

data/.rspec

@@ -0,0 +1,4 @@
+--format documentation
+--color
+--exclude-pattern spec/applications/**/*.rb
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,22 @@
+require:
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 3.0
+  NewCops: enable
+
+Style/Documentation:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 120
+
+Layout/IndentationWidth:
+  Enabled: false
+
+Layout/ElseAlignment:
+  Enabled: false
+
+Layout/EndAlignment:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-03-14
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at TODO: Write your email address. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Iaroslav Kurbatov
+
+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,106 @@
+# Rspec::DescriptionConsistency
+
+One of the basic RSpec [best practices](https://www.betterspecs.org) advises using specific describe block descriptions if it describes a specific method:
+
+```ruby
+# star.rb
+
+class Star
+  def self.build(...)
+    ...
+  end
+
+  def shape
+    ...
+  end
+```
+
+```ruby
+# star_spec.rb
+
+RSpec.describe Star do
+  describe ".build" do
+    ...
+  end
+
+  describe "#shape" do
+    ...
+  end
+end
+```
+
+If your team follows this convention, you might quickly encounter inconsistencies as your system evolves: you have to make sure that renaming or moving a method is done with appropriate modification to the `describe` block description.
+
+This gem enforces consistency by checking descriptions against the described object methods at runtime.
+
+## 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
+
+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
+
+Add `RSpec::DescriptionConsistency.bind(config)` to your `spec_helper.rb`:
+
+```ruby
+RSpec.configure do |config|
+  RSpec::DescriptionConsistency.bind config
+end
+```
+
+You can provide additional configuration via `RSpec::DescriptionConsistency.configure`:
+
+```ruby
+RSpec::DescriptionConsistency.configure do |config|
+  # Set to `false` to disable (default: `true`).
+  config.enabled = true
+
+  # Exit with specific code if any inconsistencies were detected (default: `0`).
+  # If set to `0`, RSpec's exit code will be preserved.
+  config.exit_code = 1
+
+  # Custom output stream (default: `Rspec.configuration.output_stream`).
+  config.output_stream = 'tmp/rspec-description_consistency.txt'
+end
+```
+
+By default, descriptions are matched against public and protected methods. If you want to indicate that a specific `describe` refers to a private method you can add `private` flag:
+
+```ruby
+describe "#some_private_method", :private do # or `private: true`
+  ...
+end
+```
+
+You can disable consistency verification completely by specifying `description_consistency: false` for `describe` block:
+
+```ruby
+describe ".this_method_will_not_be_checked", description_consistency: false do
+  ...
+end
+```
+
+## 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`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/viralpraxis/rspec-description_consistency. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/viralpraxis/rspec-description_consistency/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Rspec::DescriptionConsistency project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/viralpraxis/rspec-description_consistency/blob/main/CODE_OF_CONDUCT.md).

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/lib/rspec/description_consistency/configuration.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'tempfile'
+require 'singleton'
+
+module RSpec
+  module DescriptionConsistency
+    class Configuration
+      include Singleton
+
+      attr_reader :enabled, :exit_code, :output_stream
+
+      def initialize
+        @exit_code = 0
+        @enabled = true
+        @output_stream = RSpec.configuration.output_stream
+      end
+
+      def enabled=(value)
+        unless value.is_a?(TrueClass) || value.is_a?(FalseClass)
+          raise ArgumentError, 'Expected `enabled` to be either `true` or `false`'
+        end
+
+        @enabled = value
+      end
+
+      def exit_code=(value)
+        unless value.is_a?(Integer) && value >= 0 && value <= 255
+          raise ArgumentError, 'Expected `exit_code` to be an integer between 0 and 255'
+        end
+
+        @exit_code = value
+      end
+
+      def output_stream=(value)
+        if value.is_a?(IO) || value.is_a?(Tempfile)
+          @output_stream = value
+        elsif value.is_a?(String)
+          @output_stream = File.open(value, 'w')
+        else
+          raise ArgumentError, "Unexpected `output_stream` value `#{value.inspect}`"
+        end
+      end
+    end
+  end
+end

data/lib/rspec/description_consistency/consitency_verifier.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module RSpec
+  module DescriptionConsistency
+    class ConsitencyVerifier
+      def self.call(...)
+        new(...).call
+      end
+
+      def initialize(context:, configuration:)
+        @context = context
+        @configuration = configuration
+      end
+
+      def call # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+        return unless top_level_example_group?(context)
+        return unless (method_example_group_context = find_method_description_example_group(context))
+
+        description = method_example_group_context[:description]
+
+        klass = if context[:described_class].is_a?(String)
+          ::Object.const_get(method_example_group_context[:described_class])
+        else
+          context[:described_class]
+        end
+
+        include_private = method_example_group_context[:private]
+
+        return if method_example_group_context[:description_consistency] == false
+        return if correct_method_example_group?(description, klass, include_private: include_private)
+
+        Thread.current[EVALUATION_PERSISTENCE_KEY].add_entry(
+          class_name: klass,
+          method_name: description,
+          payload: method_example_group_context[:location]
+        )
+      end
+
+      private
+
+      attr_reader :context, :configuration
+
+      def correct_method_example_group?(description, klass, include_private:)
+        method_name = description[1..].to_sym
+
+        if description.start_with?('#') && include_private
+          klass.method_defined?(method_name) || klass.private_method_defined?(method_name)
+        elsif description.start_with?('#')
+          klass.method_defined?(method_name)
+        elsif description.start_with?('.')
+          correct_class_method?(method_name, klass, include_private: include_private)
+        end
+      end
+
+      def correct_class_method?(method_name, klass, include_private:)
+        klass.singleton_class.method_defined?(method_name) ||
+          (include_private && klass.singleton_class.private_instance_methods.include?(method_name)) ||
+          activesupport_concern?(method_name, klass)
+      end
+
+      def activesupport_concern?(method_name, klass)
+        if klass.is_a?(Module) && klass.const_defined?(:ClassMethods) &&
+           klass.const_get(:ClassMethods).method_defined?(method_name)
+          true
+        else
+          Object.const_defined?(:ActiveSupport) && ::ActiveSupport.const_defined?(:Concern) &&
+            klass.is_a?(ActiveSupport::Concern) &&
+            ::Object.const_get(klass.name.split('::').first).respond_to?(method_name)
+        end
+      end
+
+      def top_level_example_group?(context)
+        described_class = context[:described_class]
+
+        return true if described_class.is_a?(Module)
+        return true if described_class.is_a?(String) && ::Object.const_defined?(described_class)
+
+        false
+      end
+
+      def find_method_description_example_group(context)
+        loop do
+          return context if context.nil? || context[:description].start_with?('.', '#')
+
+          context = if context.key?(:example_group)
+            context[:example_group]
+          else
+            context[:parent_example_group]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rspec/description_consistency/reporter.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module RSpec
+  module DescriptionConsistency
+    class Reporter
+      def initialize(output_stream:)
+        @output_stream = output_stream
+      end
+
+      def report(state)
+        return if state.data.empty?
+
+        output_stream << <<~TXT
+          RSpec::DescriptionConsistency detected the following potential inconsistencies:
+
+        TXT
+
+        state.data.each do |key, value|
+          output_stream.puts format_violation_entry(key, value)
+        end
+      end
+
+      private
+
+      attr_reader :output_stream
+
+      def format_violation_entry(key, value)
+        value
+          .to_a
+          .map { "#{_1}: #{key[0]}#{key[1]}" }
+          .join("\n")
+      end
+    end
+  end
+end

data/lib/rspec/description_consistency/resource_manager.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module RSpec
+  module DescriptionConsistency
+    module ResourceManager
+      module_function
+
+      def release_io(io)
+        return unless io
+        return if [$stdout, $stderr].include?(io)
+        return if io.closed?
+
+        io.close
+      end
+    end
+  end
+end

data/lib/rspec/description_consistency/state.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'set'
+require 'singleton'
+
+module RSpec
+  module DescriptionConsistency
+    class State
+      attr_reader :data
+
+      def initialize
+        @data = {}
+      end
+
+      def any?
+        @data.any?
+      end
+
+      def add_entry(class_name:, method_name:, payload:)
+        (data[[class_name, method_name]] ||= Set.new) << payload
+      end
+    end
+  end
+end

data/lib/rspec/description_consistency/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Rspec
+  module DescriptionConsistency
+    VERSION = '1.0.0'
+  end
+end

data/lib/rspec/description_consistency.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require_relative 'description_consistency/configuration'
+require_relative 'description_consistency/consitency_verifier'
+require_relative 'description_consistency/reporter'
+require_relative 'description_consistency/resource_manager'
+require_relative 'description_consistency/state'
+
+module RSpec
+  module DescriptionConsistency
+    EVALUATION_PERSISTENCE_KEY = :'__rspec-description_consistency'
+
+    class << self
+      def configuration
+        ::RSpec::DescriptionConsistency::Configuration.instance
+      end
+
+      def configure
+        yield configuration
+      end
+
+      def bind(config) # rubocop:disable Metrics/MethodLength,Metrics/AbcSize
+        config.before(:suite) do
+          Thread.current[EVALUATION_PERSISTENCE_KEY] = ::RSpec::DescriptionConsistency::State.new
+        end
+
+        config.before do |example|
+          configuration = ::RSpec::DescriptionConsistency::Configuration.instance
+          next unless configuration.enabled
+
+          ::RSpec::DescriptionConsistency::ConsitencyVerifier.call(
+            context: example.metadata, configuration: configuration
+          )
+        rescue StandardError => e
+          configuration.error_stream.puts "Encountered unexpected exception: #{e.inspect}"
+        end
+
+        config.after(:suite) do
+          configuration = ::RSpec::DescriptionConsistency::Configuration.instance
+
+          ::RSpec::DescriptionConsistency::Reporter.new(
+            output_stream: ::RSpec::DescriptionConsistency::Configuration.instance.output_stream
+          ).report(Thread.current[EVALUATION_PERSISTENCE_KEY])
+
+          unless [RSpec.configuration.error_stream,
+                  RSpec.configuration.error_stream].include?(configuration.output_stream)
+            ::RSpec::DescriptionConsistency::ResourceManager.release_io(RSpec.configuration.output_stream)
+          end
+
+          next unless Thread.current[EVALUATION_PERSISTENCE_KEY].any?
+
+          exit configuration.exit_code if configuration.exit_code.positive?
+        end
+      end
+    end
+  end
+end

data/rspec-description_consistency.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative 'lib/rspec/description_consistency/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'rspec-description_consistency'
+  spec.version = Rspec::DescriptionConsistency::VERSION
+  spec.authors = ['Iaroslav Kurbatov']
+  spec.email = ['iaroslav2k@gmail.com']
+
+  spec.summary = 'RSpec extension for automatic description consistency verification'
+  spec.description = <<~TXT
+    Automatic checking of consistency of descriptions in context and describe blocks, and class or module methods.
+  TXT
+  spec.homepage = 'https://github.com/viralpraxis/rspec-description_consistency'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 3.0.0'
+
+  spec.metadata['homepage_uri'] = 'https://github.com/viralpraxis/rspec-description_consistency'
+  spec.metadata['changelog_uri'] = 'https://github.com/viralpraxis/rspec-description_consistency/blob/main/CHANGELOG.md'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .github appveyor Gemfile])
+    end
+  end
+  spec.require_paths = ['lib']
+
+  spec.metadata['rubygems_mfa_required'] = 'true'
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: rspec-description_consistency
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Iaroslav Kurbatov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-07-03 00:00:00.000000000 Z
+dependencies: []
+description: 'Automatic checking of consistency of descriptions in context and describe
+  blocks, and class or module methods.
+
+  '
+email:
+- iaroslav2k@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE
+- README.md
+- Rakefile
+- lib/rspec/description_consistency.rb
+- lib/rspec/description_consistency/configuration.rb
+- lib/rspec/description_consistency/consitency_verifier.rb
+- lib/rspec/description_consistency/reporter.rb
+- lib/rspec/description_consistency/resource_manager.rb
+- lib/rspec/description_consistency/state.rb
+- lib/rspec/description_consistency/version.rb
+- rspec-description_consistency.gemspec
+homepage: https://github.com/viralpraxis/rspec-description_consistency
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/viralpraxis/rspec-description_consistency
+  changelog_uri: https://github.com/viralpraxis/rspec-description_consistency/blob/main/CHANGELOG.md
+  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: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key: 
+specification_version: 4
+summary: RSpec extension for automatic description consistency verification
+test_files: []