speculate_about 1.0.2 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 418165840fa00627dbf34678bfc9eec5133565b4d9eaf697a8a748242b8fe759
-  data.tar.gz: 4a1cbab184f1b6861ef38112750e4783b257a19d61dbf19ae4a4385aed47fcde
+  metadata.gz: 3be4eb68d6f767c2a376eaf6e7f680b1f0705fff031648c9e700d5f3000280ed
+  data.tar.gz: a9d1aea62f48b208252b0afbc4dab2cf3a3a01bdea7c349ac7e4bca35a110d63
 SHA512:
-  metadata.gz: 251c5d8c14c559797d1246aac8e1ba9cc269be9e68cbe496808768989ffaaf99d0fa2c60d4571ead528cecb7104a7ecee4335119bd28244a9f9678e906855bc1
-  data.tar.gz: 070a7aaa0842f8627876be6516bed4a9cf3615d738bda0d58f0414df4f6b72d5b49302e607960d33dcf524589a4304e3fa31ce30eef5968dfce94e496301e53c
+  metadata.gz: 37e09ca45b41fe4e2226fb95e14057b1d8e30b16417ed93af74364bbf4d292977c32cfd8cf0545308a704ef8c36e88fe20d1b80076114e79d4341e0aa8192763
+  data.tar.gz: e4c9988e54c0987af9122252c0cfbd10496dc425dd21c5cdd7df91a672cb4fdeaef2e26301a7c5a132eb841591005d54749fce15f3cb757dbf2c55ce7387d9d8

data/lib/debugging.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Kernel
+  puts "defining debug__"
+  def debug__(subject=nil, msg: nil, rtrn: nil, debug:)
+    return rtrn || subject unless debug
+
+    $stderr.puts(msg) if msg
+    $stderr.puts(subject.inspect) if subject
+    rtrn || subject
+  end
+
+  def dbg_match(msg, lnb, debug:)
+    designation = name.split("::").last.downcase
+    debug__(msg: "#{lnb.succ}: #{msg} match in :#{designation}", debug:)
+  end
+end
+# SPDX-License-Identifier: Apache-2.0

data/lib/speculate_about.rb

@@ -25,3 +25,4 @@ end
 RSpec.configure do |conf|
   conf.extend SpeculateAbout
 end
+#  SPDX-License-Identifier: Apache-2.0

data/lib/speculations/cli.rb

@@ -8,6 +8,8 @@ module Speculations
           _usage
         when "-v", "--version"
           _version
+        when "-d", "--debug"
+          return _compile_and_maybe_run(args.drop(1), debug: true)
         else
           return _compile_and_maybe_run args
         end
@@ -16,11 +18,11 @@ module Speculations
 
     private
 
-    def _compile_and_maybe_run args
+    def _compile_and_maybe_run(args, debug: false)
       require_relative "../speculations"
       args = Dir.glob(["*.md", "speculations/**/*.md"]) if args.empty?
         args.each do |input_file|
-          Speculations.compile(input_file)
+          Speculations.compile(input_file, debug:)
         end
     end
 

data/lib/speculations/parser/state/candidate.rb

@@ -2,31 +2,47 @@ module Speculations
   class Parser
     module State
       module Candidate extend self
-        def parse line, lnb, node, ctxt
+        def parse line, lnb, node, ctxt, debug: false
           case
           when State.blank_line(line)
+            dbg_match("blank_line", lnb, debug:)
             [:candidate, node, ctxt]
           when match = State.context_match(line)
-            level = match[1].size
-            new_parent = node.parent_of_level(level.pred)
-            node = new_parent.new_context(title: match[2], lnb: lnb, level: level)
-            [:out, node]
+            dbg_match("context", lnb, debug:)
+            _parse_context(match, lnb:, node:)
           when match = State.maybe_include(line)
+            dbg_match("maybe_include", lnb, debug:)
             [:candidate, node, :inc]
           when match = State.maybe_example(line)
+            dbg_match("maybe_example", lnb, debug:)
             [:candidate, node, match[:title]]
           when match = State.ruby_code_block(line)
+            dbg_match("ruby_code_block", lnb, debug:)
+            _parse_ruby_code_block(match, ctxt:, lnb:, node:)
+          else
+            [:out, node]
+          end
+        end
+
+        private
+
+        def _parse_context(match, lnb:, node:)
+          level = match[1].size
+          new_parent = node.parent_of_level(level.pred)
+          node = new_parent.new_context(title: match[2], lnb: lnb, level: level)
+          [:out, node]
+        end
+
+        def _parse_ruby_code_block(match, ctxt:, lnb:, node:)
             if ctxt == :inc
               node = node.new_include(lnb: lnb)
             else
               node = node.new_example(title: ctxt, lnb: lnb)
             end
             [:in, node, (ctxt == :inc ? :includes : :out)]
-          else
-            [:out, node]
-          end
         end
       end
     end
   end
 end
+#  SPDX-License-Identifier: Apache-2.0

data/lib/speculations/parser/state/in.rb

@@ -1,11 +1,14 @@
+# frozen_string_literal: true
+
 module Speculations
   class Parser
     module State
       module In extend self
-
-        def parse line, _lnb, node, ctxt
+        include State
+        def parse line, lnb, node, ctxt, debug: true
           case
           when State.eoblock_match(line)
+            dbg_match("eblock", lnb, debug:)
             [ctxt, node.parent]
           else
             [:in, node.add_line(line), ctxt]
@@ -15,3 +18,4 @@ module Speculations
     end
   end
 end
+# SPDX-License-Identifier: AGPL-3.0-or-later

data/lib/speculations/parser/state/includes.rb

@@ -5,13 +5,16 @@ module Speculations
       module Includes extend self
         include ContextMaker
 
-        def parse line, lnb, node, _ctxt
+        def parse line, lnb, node, _ctxt, debug: true
           case
           when match = State.context_match(line)
+            dbg_match("context", lnb, debug:)
             make_new_context(lnb: lnb, node: node, match: match)
           when match = State.maybe_include(line)
+            dbg_match("maybe_include", lnb, debug:)
             [:candidate, node, :inc]
           when match = State.maybe_example(line)
+            dbg_match("maybe_example", lnb, debug:)
             [:candidate, node, match[:title]]
           else
             [:includes, node]

data/lib/speculations/parser/state/out.rb

@@ -5,13 +5,17 @@ module Speculations
       module Out extend self
         include ContextMaker
 
-        def parse line, lnb, node, _ctxt
+        def parse line, lnb, node, _ctxt, debug: false
+          # debug__(msg: "out #{lnb}: #{line}", debug:)
           case
           when match = State.context_match(line)
+            dbg_match("context", lnb, debug:)
             make_new_context(lnb: lnb, node: node, match: match)
           when match = State.maybe_example(line)
+            dbg_match("maybe_example", lnb, debug:)
             [:candidate, node, match[:title]]
           when match = State.maybe_include(line)
+            dbg_match("maybe_include", lnb, debug:)
             [:candidate, node, :inc]
           else
             [:out, node]

data/lib/speculations/parser.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
+require_relative '../debugging'
+require_relative './parser/context'
+require_relative './parser/state'
 module Speculations
   class Parser
-    require_relative './parser/context'
-    require_relative './parser/state'
-
 
     def self.parsers
       @__parsers__ ||= {
@@ -13,13 +15,13 @@ module Speculations
       }
     end
 
-    def parse_from_file file
+    def parse_from_file(file, debug: false)
       @filename = file
       @input = File
         .new(file)
         .each_line(chomp: true)
         .lazy
-      parse!
+      parse!(debug:)
     end
 
     private
@@ -28,14 +30,17 @@ module Speculations
       @state = :out
     end
 
-    def parse!
+    def parse!(debug:)
       root = node = Context.new(filename: @filename)
       ctxt = nil
       @input.each_with_index do |line, lnb|
         parser = self.class.parsers.fetch(@state)
-        @state, node, ctxt = parser.parse(line, lnb.succ, node, ctxt)
+        old_state = @state
+        @state, node, ctxt = parser.parse(line, lnb.succ, node, ctxt, debug:)
+        debug__(msg: "#{lnb}: #{old_state}-> #{@state}", debug:) if @state != old_state
       end
       root
     end
   end
 end
+# AGPL-3.0-or-later

data/lib/speculations/version.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+
 module Speculations
-  VERSION = "1.0.2"
+  VERSION = "1.0.4"
 end
+# SPDX-License-Identifier: AGPL-3.0-or-later

data/lib/speculations.rb

@@ -1,4 +1,5 @@
 require 'fileutils'
+require_relative 'debugging'
 require_relative 'speculations/parser'
 module Speculations extend self
 
@@ -7,17 +8,21 @@ module Speculations extend self
 # This file was generated from FILENAME with the speculate_about gem, if you modify this file
 # one of two bad things will happen
 # - your documentation specs are not correct
-# - your modifications will be overwritten by the speculate rake task
+# - your modifications will be overwritten by the speculate command line
 # YOU HAVE BEEN WARNED
       EOD
 
-  def compile(infile, outfile=nil)
+  def compile(infile, outfile=nil, debug: false)
     raise ArgumentError, "#{infile} not found" unless File.readable? infile
     outfile ||= _speculation_path(infile)
     if _out_of_date?(outfile, infile)
-      ast  = Speculations::Parser.new.parse_from_file(infile)
+      debug__(msg: "recompiling #{infile} -> #{outfile}", debug:)
+
+      ast  = Speculations::Parser.new.parse_from_file(infile, debug:)
       code = _decorated_ast_code ast, infile
       File.write(outfile, code.join("\n"))
+    else
+      debug__(msg: "#{infile} ignored as it is upto date", debug:)
     end
     outfile
   end
@@ -30,7 +35,7 @@ module Speculations extend self
   end
 
   def _out_of_date?(outf, inf)
-    return true unless File.exists? outf
+    return true unless File.exist? outf
     return File.lstat(outf).mtime <= File.lstat(inf).mtime
   end
 
@@ -42,3 +47,4 @@ module Speculations extend self
     File.join(dest_dir, "#{rspec}_spec.rb")
   end
 end
+#  SPDX-License-Identifier: Apache-2.0

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: speculate_about
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.4
 platform: ruby
 authors:
 - Robert Dober
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-06 00:00:00.000000000 Z
+date: 2024-04-22 00:00:00.000000000 Z
 dependencies: []
 description: Allows Markdown or other text files to be used as literal specs, à la
-  Elixr doctest, but from any file.
+  Elixir doctest, but from any file.
 email: robert.dober@gmail.com
 executables:
 - speculate
@@ -19,6 +19,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - bin/speculate
+- lib/debugging.rb
 - lib/speculate_about.rb
 - lib/speculations.rb
 - lib/speculations/cli.rb
@@ -34,9 +35,9 @@ files:
 - lib/speculations/parser/state/out.rb
 - lib/speculations/parser/state/triggers.rb
 - lib/speculations/version.rb
-homepage: https://github.com/robertdober/speculate
+homepage: https://codeberg.org/lab419/speculate_about
 licenses:
-- Apache-2.0
+- AGPL-3.0-or-later
 metadata: {}
 post_install_message:
 rdoc_options: []
@@ -46,14 +47,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.0
+      version: 3.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.5.6
 signing_key:
 specification_version: 4
 summary: Extract RSpecs from Markdown