rspec-specification-coverage 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1011217d1c9f1417e26c1f5d05c0d52eea22a37c95c4ee68885f99aaee5f4eb7
+  data.tar.gz: 2701216d0b6d077ae7197984287ec8405205205773c0b8b6c853523a7e76997a
+SHA512:
+  metadata.gz: cf63950e38feb0a043a0cb7a3f0d402d1eb81897a0e0c4dd33b5c1f22b85d74bf79b68ec774b39f107a7f21f52063d2ad02ade544c271ac444c10f8a68cb944f
+  data.tar.gz: c93b517f646ecdd3ddf88e55fb69c127615fd1c60dc1e0f0092d07f33214d4b023d971ceacdb64530dbe479f268e43d1cfc5a2f1cf1bce9b6de73d0fc88e1aab

data/LICENSE.md

@@ -0,0 +1,23 @@
+The MIT License (MIT)
+=====================
+
+* Copyright © 2023 Marcin Nowicki
+
+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 SOFTWA3RE.

data/README.md

@@ -0,0 +1,170 @@
+# rspec-specification-coverage
+
+Allow specify coverage of files.
+
+## Why
+
+Allow specify the way RSpec files cover the implementation.
+
+### Why such long name
+
+There is a common misconception in the community that RSpec is mainly
+about testing - where it is mostly about specifying with ability to run
+that specification. Well written specification makes most documentation
+redundant - by reading the specification you should understand the
+implementation.
+
+## Usage
+
+### Install
+
+Add following to your Gemfile:
+
+```ruby
+group :test do
+  gem 'rspec-specification-coverage', '~> 0.1', require: false
+end
+```
+
+And run:
+
+```bash
+bundle install
+```
+
+### Basic
+
+Ensures is respective spec file existing for implementation.
+
+The following will ensure that `spec/models/user_spec.rb` file exist:
+
+```ruby
+require 'rspec/specification_coverage'
+
+::RSpec.describe(::RSpec::SpecificationCoverage) do
+  subject(:file) { 'app/models/user.rb' }
+
+  it { is_expected.to(be_covered_with_specification) }
+end
+```
+
+### With Reflection
+
+The following will ensure that in case there are git changes to
+`app/models/user.rb`, respective specification in
+`spec/models/user_spec.rb` also needs to be updated:
+
+```ruby
+it { is_expected.to(be_covered_with_specification.with_reflection) }
+```
+
+### Spec Bigger
+
+The following will ensure that `spec/models/user_spec.rb`
+file is bigger than `app/models/user.rb`.
+
+```ruby
+it { is_expected.to(be_covered_with_specification.spec_bigger) }
+```
+
+### Mentioning Methods
+
+The following will ensure that `spec/models/user_spec.rb`
+file include method names from `app/models/user.rb`.
+
+```ruby
+it { is_expected.to(be_covered_with_specification.mentioning_methods) }
+```
+
+### All
+
+We can mix all above ways together:
+
+```ruby
+it { is_expected.to(be_covered_with_specification.with_reflection.spec_bigger.mentioning_methods) }
+```
+
+## Real Life Example
+
+The following is a running example in one of my projects:
+
+```ruby
+# frozen_string_literal: true
+
+require 'rspec'
+require 'rspec/specification_coverage'
+
+::RSpec.describe(::RSpec::SpecificationCoverage) do
+  ::Dir.glob('app/{helpers,models,channels,mailers}/**/*.rb').each do |a_file|
+    describe a_file do
+      subject(:file) { a_file }
+
+      it { is_expected.to(be_covered_with_specification.with_reflection.spec_bigger.mentioning_methods) }
+    end
+  end
+
+  ::Dir.glob('app/jobs/**/*.rb').each do |a_file|
+    describe a_file do
+      subject(:file) { a_file }
+
+      it { is_expected.to(be_covered_with_specification.with_reflection) }
+    end
+  end
+
+  ::Dir.glob('app/views/**/*.erb').each do |a_file|
+    describe a_file do
+      subject(:file) { a_file }
+
+      it { is_expected.to(be_covered_with_specification.with_reflection) }
+    end
+  end
+
+  ::Dir.glob('lib/**/*.rb').each do |a_file|
+    describe a_file do
+      subject(:file) { a_file }
+
+      it { is_expected.to(be_covered_with_specification(type: :lib).with_reflection.mentioning_methods) }
+    end
+  end
+
+  ::Dir.glob('app/controllers/**/*.rb').each do |a_file|
+    describe a_file do
+      subject(:file) { a_file }
+
+      it {
+        is_expected.to(
+          be_covered_with_specification(type: :requests).with_reflection.spec_bigger.mentioning_methods
+        )
+      }
+
+      it {
+        is_expected.to(
+          be_covered_with_specification(type: :routing).with_reflection.mentioning_methods
+        )
+      }
+    end
+  end
+end
+```
+
+## Development
+
+We use TDD on Guard.
+
+### Setup
+
+```bash
+bash util/setup.sh
+```
+
+### Check if overcommit is operational
+
+```bash
+bash util/overcommit_spec.sh
+```
+
+### Run your TDD reactor
+
+```bash
+bundle exec guard
+```

data/lib/rspec/specification_coverage/git_files_changed.rb

@@ -0,0 +1,24 @@
+# Copyright (c) 2023 by Marcin Nowicki
+# frozen_string_literal: true
+
+require 'active_support/core_ext/module'
+require 'rspec'
+require 'singleton'
+
+# We store it within rspec as it relies on it.
+module RSpec
+  # "RSpec specification coverage" is a term we use to go beyond testing.
+  module SpecificationCoverage
+    # Stores instance of currently changed git files.
+    class GitFilesChanged
+      include ::Singleton
+
+      delegate :include?, to: :ALL
+
+      # All git files changed.
+      ALL = `git status --porcelain | grep -v "^D" | cut -b4-`.split("\n").reject(&:empty?).freeze
+
+      private_constant :ALL
+    end
+  end
+end

data/lib/rspec/specification_coverage/matchers/be_covered_with_specification.rb

@@ -0,0 +1,90 @@
+# Copyright (c) 2023 by Marcin Nowicki
+# frozen_string_literal: true
+
+require 'active_support/core_ext/object/blank'
+require 'rspec'
+require_relative '../spec_from_file'
+
+::RSpec::Matchers.define(:be_covered_with_specification) do |type: nil|
+  match do |actual|
+    @spec_file = ::RSpec::SpecificationCoverage::SpecFromFile.is(actual, type)
+
+    return false unless ::File.exist?(@spec_file)
+
+    if @spec_bigger || @mentioning_methods
+      if ::File.exist?(actual)
+        file_contents = ::File.read(actual)
+        @file_size = file_contents.size
+      else
+        file_contents = nil
+        @file_size = 0
+      end
+      if ::File.exist?(@spec_file)
+        spec_contents = ::File.read(@spec_file)
+        @spec_size = spec_contents.size
+      else
+        spec_contents = nil
+        @spec_size = 0
+      end
+    end
+
+    if @spec_bigger
+      @spec_is_bigger = @spec_size > @file_size
+
+      return false unless @spec_is_bigger
+    end
+
+    if @with_reflection
+      require_relative '../git_files_changed'
+      file_changed = ::RSpec::SpecificationCoverage::GitFilesChanged.instance.include?(actual)
+
+      if file_changed
+        @have_reflection = ::RSpec::SpecificationCoverage::GitFilesChanged.instance.include?(@spec_file)
+
+        return false unless @have_reflection
+      end
+    end
+
+    if @mentioning_methods && @file_size.positive? && @spec_size.positive?
+      @missing_methods = []
+
+      require_relative '../ruby_file_details'
+      file_details = ::RSpec::SpecificationCoverage::RubyFileDetails.new(file_contents)
+      file_details.methods.each do |method|
+        @missing_methods << method unless spec_contents.include?(method)
+      end
+
+      return false if @missing_methods.present?
+    end
+
+    true
+  end
+
+  failure_message do |actual|
+    message = "expected that '#{actual}'\n"
+    message += "would have respective spec '#{@spec_file}'\n"
+    if @spec_bigger && @spec_is_bigger == false
+      message += "which is bigger than the implementation (#{@spec_size} > #{@file_size})\n"
+    end
+    if @with_reflection && @have_reflection == false
+      message += "in case you change '#{actual}' then you have to specify it in '#{@spec_file}'\n"
+    end
+    if @mentioning_methods && @missing_methods.present?
+      message += 'the spec is missing mention of following methods: '
+      message += @missing_methods.join(', ')
+    end
+    message
+  end
+
+  chain :with_reflection do
+    @with_reflection = true
+  end
+
+  chain :spec_bigger do
+    @spec_bigger = true
+  end
+
+  chain :mentioning_methods do
+    @mentioning_methods = true
+  end
+end

data/lib/rspec/specification_coverage/ruby_file_details.rb

@@ -0,0 +1,42 @@
+# Copyright (c) 2023 by Marcin Nowicki
+# frozen_string_literal: true
+
+require 'rspec'
+
+# We store it within rspec as it relies on it.
+module RSpec
+  # "RSpec specification coverage" is a term we use to go beyond testing.
+  module SpecificationCoverage
+    # Text-based ruby file details analysis.
+    class RubyFileDetails
+      # Match method definitions with empty spaces at the beginning.
+      REGEXP_METHODS = /\s+def ([a-z_.?]+)/
+
+      # @param file_contents [String]
+      def initialize(file_contents)
+        @file_contents = file_contents
+      end
+
+      # All methods matching regexp except initialize.
+      #
+      # @return [String]
+      def methods
+        @methods ||= scan(REGEXP_METHODS)
+      end
+
+      private
+
+      # Using external method with "!" methods due to improved performance.
+      # @return [String]
+      def scan(regexp)
+        output = @file_contents.scan(regexp)
+        output.flatten!
+        output.reject! { |method| method == 'initialize' }
+        output.map! { |method| method.gsub(/^self\./, '') }
+        output
+      end
+
+      private_constant :REGEXP_METHODS
+    end
+  end
+end

data/lib/rspec/specification_coverage/spec_from_file.rb

@@ -0,0 +1,64 @@
+# Copyright (c) 2023 by Marcin Nowicki
+# frozen_string_literal: true
+
+require 'rspec'
+
+# We store it within rspec as it relies on it.
+module RSpec
+  # "RSpec specification coverage" is a term we use to go beyond testing.
+  module SpecificationCoverage
+    # Allows getting getting spec name from file name.
+    class SpecFromFile
+      # @param actual [String] for example `app/models/user.rb`
+      # @param type [Symbol] the type, `nil`, `:routing`, `:requests`, `:lib`
+      def self.is(actual, type)
+        new(actual, type).is
+      end
+
+      # @param actual [String] for example `app/models/user.rb`
+      # @param type [Symbol] the type, `nil`, `:routing`, `:requests`, `:lib`
+      def initialize(actual, type)
+        @actual = actual
+        @type = type
+
+        raise(::ArgumentError) unless valid?
+      end
+
+      # @return [String] like `spec/models/user_spec.rb`
+      def is
+        case @type
+        when :routing
+          controller_replaced.gsub(/\.rb$/, "_#{@type}_spec.rb")
+        when :requests
+          controller_replaced.gsub(/\.rb$/, '_spec.rb')
+        when :lib
+          suffix_replaced.gsub(/^lib/, 'spec/lib')
+        else
+          suffix_replaced.gsub(/^lib/, 'spec')
+        end
+      end
+
+      private
+
+      # @return [String]
+      def controller_replaced
+        app_replaced.gsub('_controller.', '.').gsub(%r{/controllers/}, "/#{@type}/")
+      end
+
+      # @return [String]
+      def app_replaced
+        @actual.gsub(/^app/, 'spec')
+      end
+
+      # @return [String]
+      def suffix_replaced
+        app_replaced.gsub(/\.rb$/, '_spec.rb').gsub(/\.erb$/, '.erb_spec.rb')
+      end
+
+      # @return [Boolean]
+      def valid?
+        @actual.is_a?(::String) && (@type.is_a?(::Symbol) || @type.is_a?(::NilClass))
+      end
+    end
+  end
+end

data/lib/rspec/specification_coverage.rb

@@ -0,0 +1,4 @@
+# Copyright (c) 2023 by Marcin Nowicki
+# frozen_string_literal: true
+
+require_relative 'specification_coverage/matchers/be_covered_with_specification'

data/lib/rspec-specification-coverage.rb

@@ -0,0 +1,4 @@
+# Copyright (c) 2023 by Marcin Nowicki
+# frozen_string_literal: true
+
+require_relative 'rspec/specification_coverage/matchers/be_covered_with_specification'

metadata

@@ -0,0 +1,320 @@
+--- !ruby/object:Gem::Specification
+name: rspec-specification-coverage
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Marcin Nowicki
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-01-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 7.0.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 7.0.4.1
+- !ruby/object:Gem::Dependency
+  name: alfonsox
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: bundle-audit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.18'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: guard-rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: guard-yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: mdl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: overcommit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.60'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.60'
+- !ruby/object:Gem::Dependency
+  name: parallel_tests
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.6
+- !ruby/object:Gem::Dependency
+  name: reek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.41'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.41'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rubocop-require_tools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.16'
+- !ruby/object:Gem::Dependency
+  name: rubocop-thread_safety
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+description: Allow specify how RSpec specification files cover the implementation.
+email: pr0d1r2@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.md
+- README.md
+files:
+- LICENSE.md
+- README.md
+- lib/rspec-specification-coverage.rb
+- lib/rspec/specification_coverage.rb
+- lib/rspec/specification_coverage/git_files_changed.rb
+- lib/rspec/specification_coverage/matchers/be_covered_with_specification.rb
+- lib/rspec/specification_coverage/ruby_file_details.rb
+- lib/rspec/specification_coverage/spec_from_file.rb
+homepage: https://github.com/pr0d1r2/rspec-specification-coverage
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/pr0d1r2/rspec-specification-coverage
+  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.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: Specify RSpec specification coverage.
+test_files: []