doctest2-rspec 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ea7b8c8551ff4d3b9861598da5366b2690f99908de130963b26f33c888013e4f
+  data.tar.gz: 48e512579f8c26c236ef67676dc42e420423e39c3d00698995c20d88ef610c3b
+SHA512:
+  metadata.gz: 7282f3867fb21ad7d793975805c507fd047a46b3f34ca8b2b4f01f93f32d88cbf6dc32d3d4b6b9af622358c04c3793190a074012899d1bd7a89b707660710227
+  data.tar.gz: 7baa68dbc7c58bf486c75dade867f5c7ce4cfb4c3e911ac312c91076436fea297966c720263f53ad5734aaa304f902519a5a0a25b86aea573251b9d63b8cb195

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.2.2

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in doctest2-minitest.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rubocop", "~> 1.21"
+
+# for temporary easy local development
+# gem 'doctest2-core', path: "../doctest2-core"

data/Gemfile.lock

@@ -0,0 +1,51 @@
+PATH
+  remote: ../doctest2-core
+  specs:
+    doctest2-core (0.1.0)
+
+PATH
+  remote: .
+  specs:
+    doctest2-rspec (0.1.0)
+      doctest2-core (~> 0.1.0)
+      minitest (~> 5.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    json (2.6.3)
+    minitest (5.18.0)
+    parallel (1.23.0)
+    parser (3.2.2.1)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.0)
+    rexml (3.2.5)
+    rubocop (1.50.2)
+      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.28.1)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  arm64-darwin-22
+
+DEPENDENCIES
+  doctest2-core!
+  doctest2-rspec!
+  rake (~> 13.0)
+  rubocop (~> 1.21)
+
+BUNDLED WITH
+   2.4.10

data/Justfile

@@ -0,0 +1,16 @@
+setup_and_test: setup test
+
+setup:
+  bin/setup
+
+test:
+  bundle exec rake test
+
+console:
+  bin/console
+
+install:
+  bundle exec rake install
+
+release:
+  bundle exec rake release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 qqwy
+
+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,4 @@
+# Doctest2::Minitest
+
+Read the main README at [../README.md](../README.md)
+

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/doctest2/minitest/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Doctest2
+  module Minitest
+    VERSION = "0.9.0"
+  end
+end

data/lib/doctest2/minitest.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'pathname'
+require_relative "minitest/version"
+
+module Doctest2
+  module Minitest
+    module DoctestHelpers
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        ##
+        # To be used inside the body of a tests-class
+        # It will automatically create test cases for all
+        # 'documentation test' snippets that exist in the comments
+        # above the methods in `klass`.
+        def doctest(klass)
+          doctests = Doctest2::Core.extract_from(klass)
+          return puts "Note: Attempting to extract doctests for #{klass}, but none were found (at: #{caller_locations.first})" if doctests.empty?
+
+          doctests.each do |doctest|
+            file_location = Pathname.new(doctest.original_file).relative_path_from(Pathname.pwd)
+            define_method("test_ (doctest) #{file_location}:#{doctest.line}") do
+              message = "While running doctest: \n\t#{doctest.code_string}\n"
+              begin
+                assert_equal(doctest.result_evaluation, doctest.code_evaluation, message)
+              rescue StandardError => error
+                error.message << "\n\n#{message}"
+                raise error
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/sig/doctest2/minitest.rbs

@@ -0,0 +1,6 @@
+module Doctest2
+  module Minitest
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: doctest2-rspec
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- Qqwy/Marten
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-05-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: doctest2-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Integrates documentation tests with Minitest.
+email:
+- qqwy@gmx.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- ".tool-versions"
+- Gemfile
+- Gemfile.lock
+- Justfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/doctest2/minitest.rb
+- lib/doctest2/minitest/version.rb
+- sig/doctest2/minitest.rbs
+homepage: https://github.com/Qqwy/ruby-doctest2
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Qqwy/ruby-doctest2
+  source_code_uri: https://github.com/Qqwy/ruby-doctest2
+  changelog_uri: https://github.com/Qqwy/ruby-doctest2/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Run doctests in your Minitest test suite
+test_files: []