doctest2-core 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: beac60bca843e7adbfb3e7e584ebdc0a4b02c4ea7ea25a008260a3ef2ca827fb
+  data.tar.gz: 948397d1ac2588d2fb9b9ad9e8dfccadec21ed41f05c92850e057e3311777289
+SHA512:
+  metadata.gz: aac4fb9d9e308781f2935ca4d5ffadddd7267f29a42f1331ac66226f22910668f44d1f9c4980a77297d7838adcfaee81533d9d94e520fa0fd57c85c304485c88
+  data.tar.gz: 0a32135d3f23c48f74f322724b3e6dc80bbb370cf87dd698b7843bdc00a439b709b08c4b0fdf45bed576ce726a696f44d86a3b37bb5088094064ea899495cf9d

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,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in doctest2-core.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rubocop", "~> 1.21"

data/Gemfile.lock

@@ -0,0 +1,93 @@
+PATH
+  remote: .
+  specs:
+    doctest2-core (0.9.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    coderay (1.1.3)
+    diff-lcs (1.5.0)
+    ffi (1.15.5)
+    formatador (1.1.0)
+    guard (2.18.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.13.0)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    json (2.6.3)
+    listen (3.8.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    lumberjack (1.2.8)
+    method_source (1.0.0)
+    nenv (0.3.0)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    parallel (1.23.0)
+    parser (3.2.2.1)
+      ast (~> 2.4.1)
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    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)
+      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)
+    shellany (0.0.1)
+    thor (1.2.2)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  doctest2-core!
+  guard-rspec
+  pry
+  rake (~> 13.0)
+  rspec
+  rubocop (~> 1.21)
+
+BUNDLED WITH
+   2.1.4

data/Justfile

@@ -0,0 +1,16 @@
+setup_and_test: setup test
+
+setup:
+  bin/setup
+
+test:
+  bundle exec rspec
+
+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,3 @@
+# Doctest2::Core
+
+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/core/base.rb

@@ -0,0 +1,81 @@
+module Doctest2
+  module Core
+    class Base
+
+      def self.analyze(str)
+        self.new(str).analyze
+      end
+
+      CODE_AND_RESULT_REGEXP   = /^\s*#\s*>>\s*(?<code>.*)?#\s*=>\s*(?<result>.*)$/
+      CODE_REGEXP   = /^\s*#\s*>>\s*(?<code>.*)/
+      RESULT_REGEXP = /#\s*=>\s*(?<result>.*)$/
+
+      def initialize(source)
+        if File.exist?(source)
+          @filename = source
+          @str = File.read(source)
+        else
+          @filename = nil
+          @str = source
+        end
+        @state   = :no_match
+        @current = nil
+        @doctests = []
+      end
+
+      def analyze
+        @str.lines.each.with_index do |line, index|
+          case line
+          when CODE_AND_RESULT_REGEXP
+            code = Regexp.last_match['code']
+            result = Regexp.last_match['result']
+            handle_code(code)
+            handle_result(result, index)
+          when CODE_REGEXP
+            handle_code(Regexp.last_match['code'])
+          when RESULT_REGEXP
+            handle_result(Regexp.last_match['result'], index)
+          else
+            handle_no_doctest
+          end
+        end
+
+        @doctests
+      end
+
+      private
+
+      def add_doctest(code_lines, result, line_index)
+        @doctests << Doctest.new(code_lines.join(';'), result, @filename, line_index + 1)
+      end
+
+      def handle_code(code)
+        case @state
+        when :no_match
+          @current_code = [code]
+          @state = :match
+        when :match
+          @current_code << code
+        end
+      end
+
+      def handle_result(result, line_index)
+        case @state
+        when :match
+          add_doctest(@current_code, result, line_index)
+          reset
+        end
+      end
+
+      def handle_no_doctest
+        reset
+      end
+
+      def reset
+        @state = :no_match
+        @current
+      end
+
+    end
+  end
+end

data/lib/doctest2/core/doctest.rb

@@ -0,0 +1,15 @@
+module Doctest2
+  module Core
+    class Doctest < Struct.new(:code_string, :result_string, :original_file, :line)
+
+      def result_evaluation
+        eval(result_string)
+      end
+
+      def code_evaluation
+        eval(code_string)
+      end
+
+    end
+  end
+end

data/lib/doctest2/core/source.rb

@@ -0,0 +1,33 @@
+module Doctest2
+  module Core
+    module Source
+
+      def self.to_filenames(source)
+        case source
+        when Class, Module
+          constant_filenames(source)
+        else
+          [ source ]
+        end
+      end
+
+      def self.constant_filenames(constant)
+        (filenames_of_instance_methods(constant) + filenames_of_methods(constant)).uniq.sort
+      end
+
+      def self.filenames_of_instance_methods(constant)
+        constant.
+          instance_methods(false).
+          map{|m| constant.instance_method(m).source_location}.
+          map(&:first)
+      end
+
+      def self.filenames_of_methods(constant)
+        constant.
+          methods(false).
+          map{|m| constant.method(m).source_location}.
+          map(&:first)
+      end
+    end
+  end
+end

data/lib/doctest2/core/version.rb

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

data/lib/doctest2/core.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative "core/version"
+require_relative "core/base"
+require_relative "core/doctest"
+require_relative "core/source"
+
+module Doctest2
+  module Core
+    def self.extract_from(source)
+      Source.to_filenames(source).
+        flat_map{|code_location| Base.analyze(code_location)}
+    end
+  end
+end

data/sig/doctest2/core.rbs

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

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: doctest2-core
+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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Extract doctests from Ruby files.
+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/core.rb
+- lib/doctest2/core/base.rb
+- lib/doctest2/core/doctest.rb
+- lib/doctest2/core/source.rb
+- lib/doctest2/core/version.rb
+- sig/doctest2/core.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: Forms the basis of extracting and running doctests (documentation tests).
+  Core used by test-framework-specific gems.
+test_files: []