rubocop-rspec-documentation 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6835013f9bdd9b919825c399180848fd02c1c5b66ea32a6a16d4558759e1deb9
+  data.tar.gz: 5d3e7ab0db9bbd8dfa22f689126cd254b5d56ee56d9a63377ebbbee0a5ed311a
+SHA512:
+  metadata.gz: cf760e3954900da9d30b32a9884151f8bf85f3d2b91d30d6331d996dbfa590f3c1185cd288aff0e16ca0839fc0462d535e9043161891a8ee204dc2f0a83c4027
+  data.tar.gz: 9f1f527b654bfdcddb6a961830b5f5dcddca00eb4d458c08dd53ca012d2b4e8c9f81972c2eed9af99a4f6434808c6a2437aa981c50b3c84fd1a5d185689bab6c

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+2.7.8

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'devpack', '~> 0.4.1'
+gem 'rake', '~> 13.0'
+gem 'rspec', '~> 3.0'
+gem 'strong_versions', '~> 0.4.5'

data/Gemfile.lock

@@ -0,0 +1,89 @@
+PATH
+  remote: .
+  specs:
+    rubocop-rspec-documentation (0.0.1)
+      rspec-documentation (~> 0.0.7)
+      rubocop (~> 1.52)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    concurrent-ruby (1.2.2)
+    devpack (0.4.1)
+    diff-lcs (1.5.0)
+    htmlbeautifier (1.4.2)
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
+    json (2.6.3)
+    kramdown (2.4.0)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    nokogiri (1.15.2-x86_64-linux)
+      racc (~> 1.4)
+    paint (2.3.0)
+    paintbrush (0.1.3)
+    parallel (1.23.0)
+    parser (3.2.2.3)
+      ast (~> 2.4.1)
+      racc
+    racc (1.7.0)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    redcarpet (3.6.0)
+    regexp_parser (2.8.1)
+    rexml (3.2.5)
+    rouge (4.1.2)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-documentation (0.0.7)
+      htmlbeautifier (~> 1.4)
+      kramdown (~> 2.4)
+      kramdown-parser-gfm (~> 1.1)
+      nokogiri (~> 1.15)
+      paintbrush (~> 0.1.3)
+      redcarpet (~> 3.6)
+      rouge (~> 4.1)
+      rspec (~> 3.12)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.52.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    strong_versions (0.4.5)
+      i18n (>= 0.5)
+      paint (~> 2.0)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  devpack (~> 0.4.1)
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop-rspec-documentation!
+  strong_versions (~> 0.4.5)
+
+BUNDLED WITH
+   2.4.13

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2023 Robert Farrell
+
+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,21 @@
+# Rubocop::Rspec::Documentation
+
+_Rubocop_ extension for [RSpec::Documentation](https://github.com/bobf/rspec-documentation).
+
+See [Rubocop](https://docs.bob.frl/rspec-documentation/rubocop.html) overview in _RSpec::Documentation_ documentation for usage instructions.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_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_PRIOR_TO_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_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+## License
+
+[MIT](LICENSE)

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/exe/rubocop-rspec-documentation

@@ -0,0 +1,2 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true

data/lib/rubocop/rspec/documentation/default.yml

@@ -0,0 +1,35 @@
+---
+AllCops:
+  inherit_mode:
+    merge:
+    - Include
+  Include:
+  - 'rspec-documentation/pages/**/*.md'
+
+RSpec:
+  inherit_mode:
+    merge:
+    - Include
+  Include:
+  - 'rspec-documentation/pages/**/*.md'
+
+Naming/FileName:
+  inherit_mode:
+    merge:
+    - Exclude
+  Exclude:
+  - 'rspec-documentation/pages/**/*.md'
+
+Gemspec/RequiredRubyVersion:
+  inherit_mode:
+    merge:
+    - Exclude
+  Exclude:
+  - 'rspec-documentation/pages/**/*.md'
+
+Style/FrozenStringLiteralComment:
+  inherit_mode:
+    merge:
+    - Exclude
+  Exclude:
+  - 'rspec-documentation/pages/**/*.md'

data/lib/rubocop/rspec/documentation/ruby_extractor.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+
+module RuboCop
+  module RSpecDocumentation
+    # Extracts Ruby code from Markdown documentation files and generates an output compatible
+    # with RuboCop's code extraction mechanism:
+    # https://docs.rubocop.org/rubocop/extensions.html#configuring-an-extension
+    class RubyExtractor
+      def call(processed_source)
+        return nil unless relevant?(processed_source.path)
+
+        specs.select { |spec| spec.path.expand_path.to_s == processed_source.path }
+             .map { |spec| extracted_spec(spec, processed_source) }
+      end
+
+      private
+
+      def specs
+        @specs ||= ::RSpecDocumentation::Documentation.new.page_collection.documents.map(&:specs).flatten
+      end
+
+      def relevant?(path)
+        path.start_with?(::RSpecDocumentation::Util.base_dir.to_s) && Pathname.new(path).extname == '.md'
+      end
+
+      def rspec_documentation_processed_source(spec, processed_source)
+        RuboCop::ProcessedSource.new(spec.source, RUBY_VERSION.to_f, processed_source.path)
+      end
+
+      def extracted_spec(spec, processed_source)
+        {
+          offset: spec.path.readlines[...spec.location - 2].sum(&:size),
+          processed_source: rspec_documentation_processed_source(spec, processed_source)
+        }
+      end
+    end
+  end
+end
+
+RuboCop::Runner.ruby_extractors.unshift(RuboCop::RSpecDocumentation::RubyExtractor.new)

data/lib/rubocop/rspec/documentation/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module RSpec
+    module Documentation
+      VERSION = '0.0.1'
+    end
+  end
+end

data/lib/rubocop/rspec/documentation.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'rspec/documentation'
+require_relative 'documentation/ruby_extractor'
+
+# XXX: This is the "official" way to create a Rubocop plugin, all code below this comment is
+# taken directly from here:
+# https://github.com/rubocop/rubocop-extension-generator/blob/master/lib/rubocop/extension/generator/generator.rb
+
+# The original code is from https://github.com/rubocop/rubocop-rspec/blob/master/lib/rubocop/rspec/inject.rb
+# See https://github.com/rubocop/rubocop-rspec/blob/master/MIT-LICENSE.md
+module RuboCop
+  # RuboCop extension for RSpec::Documentation
+  module RSpecDocumentation
+    PROJECT_ROOT   = Pathname.new(__dir__).parent.parent.expand_path.freeze
+    CONFIG_DEFAULT = PROJECT_ROOT.join('rubocop/rspec/documentation/default.yml').freeze
+    CONFIG         = YAML.safe_load(CONFIG_DEFAULT.read).freeze
+
+    private_constant(:CONFIG_DEFAULT, :PROJECT_ROOT)
+
+    # Because RuboCop doesn't yet support plugins, we have to monkey patch in a bit of our configuration.
+    module Inject
+      def self.defaults!
+        path = CONFIG_DEFAULT.to_s
+        hash = ConfigLoader.send(:load_yaml_configuration, path)
+        config = Config.new(hash, path).tap(&:make_excludes_absolute)
+        puts "configuration from \#{path}" if ConfigLoader.debug?
+        config = ConfigLoader.merge_with_default(config, path)
+        ConfigLoader.instance_variable_set(:@default_configuration, config)
+      end
+    end
+  end
+end
+
+RuboCop::RSpecDocumentation::Inject.defaults!

data/rubocop-rspec-documentation.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative 'lib/rubocop/rspec/documentation/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'rubocop-rspec-documentation'
+  spec.version = RuboCop::RSpec::Documentation::VERSION
+  spec.authors = ['Bob Farrell']
+  spec.email = ['git@bob.frl']
+  spec.licenses = ['MIT']
+
+  spec.summary = 'Rubocop integration with rspec-documentation'
+  spec.description = 'Lint RSpec examples embedded in Markdown files'
+  spec.homepage = 'https://github.com/bobf/rubocop-rspec-documentation'
+  spec.required_ruby_version = '>= 2.7.0'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = spec.homepage
+
+  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 .circleci appveyor])
+    end
+  end
+
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.add_runtime_dependency 'rspec-documentation', '~> 0.0.7'
+  spec.add_runtime_dependency 'rubocop', '~> 1.52'
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-rspec-documentation
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Bob Farrell
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-06-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec-documentation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.7
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.52'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.52'
+description: Lint RSpec examples embedded in Markdown files
+email:
+- git@bob.frl
+executables:
+- rubocop-rspec-documentation
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- exe/rubocop-rspec-documentation
+- lib/rubocop/rspec/documentation.rb
+- lib/rubocop/rspec/documentation/default.yml
+- lib/rubocop/rspec/documentation/ruby_extractor.rb
+- lib/rubocop/rspec/documentation/version.rb
+- rubocop-rspec-documentation.gemspec
+homepage: https://github.com/bobf/rubocop-rspec-documentation
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/bobf/rubocop-rspec-documentation
+  source_code_uri: https://github.com/bobf/rubocop-rspec-documentation
+  changelog_uri: https://github.com/bobf/rubocop-rspec-documentation
+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.1.6
+signing_key:
+specification_version: 4
+summary: Rubocop integration with rspec-documentation
+test_files: []