doctest2-rspec 0.9.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea7b8c8551ff4d3b9861598da5366b2690f99908de130963b26f33c888013e4f
-  data.tar.gz: 48e512579f8c26c236ef67676dc42e420423e39c3d00698995c20d88ef610c3b
+  metadata.gz: 8ac6495723d91c5649f961e23e4da8179fad01221df7508efb22c88ac73dd5f9
+  data.tar.gz: 61f4870bcd054b409ab3ed94e1f72b21ccbe72599e75db98f4762359b7cc99db
 SHA512:
-  metadata.gz: 7282f3867fb21ad7d793975805c507fd047a46b3f34ca8b2b4f01f93f32d88cbf6dc32d3d4b6b9af622358c04c3793190a074012899d1bd7a89b707660710227
-  data.tar.gz: 7baa68dbc7c58bf486c75dade867f5c7ce4cfb4c3e911ac312c91076436fea297966c720263f53ad5734aaa304f902519a5a0a25b86aea573251b9d63b8cb195
+  metadata.gz: 6ec5f876e9eaaf4822d3442f9103b9759b1742543c2d4d57e57d7e8ecec0faea830b1d565b92bfb5b42c2a92c31dd09e584748a03561376b5b18043595af79c0
+  data.tar.gz: d43fa961e072aa52f6739adc23b2b1321e9242ea4d890689bffed274d1d2ca2da71cffcffd4d975d15ed5df03490be22624296a81cf58f5f73741234a79b8e7e

data/.tool-versions

@@ -1 +1 @@
-ruby 3.2.2
+ruby 3.1.2

data/Gemfile

@@ -2,7 +2,7 @@
 
 source "https://rubygems.org"
 
-# Specify your gem's dependencies in doctest2-minitest.gemspec
+# Specify your gem's dependencies in doctest2-rspec.gemspec
 gemspec
 
 gem "rake", "~> 13.0"

data/Gemfile.lock

@@ -8,14 +8,14 @@ PATH
   specs:
     doctest2-rspec (0.1.0)
       doctest2-core (~> 0.1.0)
-      minitest (~> 5.0)
+      rspec (~> 3.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
+    diff-lcs (1.5.0)
     json (2.6.3)
-    minitest (5.18.0)
     parallel (1.23.0)
     parser (3.2.2.1)
       ast (~> 2.4.1)
@@ -23,6 +23,19 @@ GEM
     rake (13.0.6)
     regexp_parser (2.8.0)
     rexml (3.2.5)
+    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-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.50.2)
       json (~> 2.3)
       parallel (~> 1.10)
@@ -39,7 +52,7 @@ GEM
     unicode-display_width (2.4.2)
 
 PLATFORMS
-  arm64-darwin-22
+  arm64-darwin-21
 
 DEPENDENCIES
   doctest2-core!
@@ -48,4 +61,4 @@ DEPENDENCIES
   rubocop (~> 1.21)
 
 BUNDLED WITH
-   2.4.10
+   2.3.24

data/Justfile

@@ -4,7 +4,7 @@ setup:
   bin/setup
 
 test:
-  bundle exec rake test
+  bundle exec rspec
 
 console:
   bin/console

data/README.md

@@ -1,4 +1,4 @@
-# Doctest2::Minitest
+# Doctest2::Rspec
 
 Read the main README at [../README.md](../README.md)
 

data/lib/doctest2/rspec/be_a_valid_doctest.rb

@@ -0,0 +1,9 @@
+::RSpec::Matchers.define :be_a_valid_doctest do |expected|
+  match do |actual|
+    actual.code_evaluation == actual.result_evaluation
+  end
+
+  failure_message do |actual|
+    "\nexpected: #{actual.result_evaluation}\n     got: #{actual.code_evaluation}\n\n(compared using ==)\n\nWhile running doctest: \n\t#{actual.code_string}\n"
+  end
+end

data/lib/doctest2/rspec/doctest_helpers.rb

@@ -0,0 +1,13 @@
+module Doctest2::RSpec::DoctestHelpers
+  def doctest(source)
+    context "doctests for #{source}" do
+      Doctest2::Core.extract_from(source).each do |doctest|
+        file_location = Pathname.new(doctest.original_file).relative_path_from(Pathname.pwd)
+
+        it "at #{file_location}:#{doctest.line}" do
+          expect(doctest).to be_a_valid_doctest
+        end
+      end
+    end
+  end
+end

data/lib/doctest2/{minitest → rspec}/version.rb

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

data/lib/doctest2/rspec.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'rspec'
+require 'doctest2/core'
+
+
+require_relative "rspec/version"
+require_relative "rspec/be_a_valid_doctest"
+require_relative "rspec/doctest_helpers"
+
+module Doctest2
+  module RSpec
+  end
+end
+
+RSpec.configure do |c|
+  c.extend Doctest2::RSpec::DoctestHelpers
+end

data/sig/doctest2/{minitest.rbs → rspec.rbs}

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: doctest2-rspec
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Qqwy/Marten
@@ -25,20 +25,20 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.1.0
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '3.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.
+        version: '3.0'
+description: Integrates documentation tests with RSpec.
 email:
 - qqwy@gmx.com
 executables: []
@@ -53,15 +53,17 @@ files:
 - 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
+- lib/doctest2/rspec.rb
+- lib/doctest2/rspec/be_a_valid_doctest.rb
+- lib/doctest2/rspec/doctest_helpers.rb
+- lib/doctest2/rspec/version.rb
+- sig/doctest2/rspec.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
+  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: []
@@ -78,8 +80,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
-summary: Run doctests in your Minitest test suite
+summary: Run doctests in your RSpec test suite
 test_files: []

data/lib/doctest2/minitest.rb

@@ -1,39 +0,0 @@
-# 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