speculate_about 0.5.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50dd660d1e2e984b66f854df6f71e1f280ddef2e162d2848a3cf363ffe5751a4
-  data.tar.gz: 56ed0de10d7ee9751ae86deb247e7f8ad8d6b90f3a2e71623d83b0d169f18f59
+  metadata.gz: 691aa57b9ad1035ca6eb20fe75f89b818414dcd33e05acd9d6621e13ee1cfb23
+  data.tar.gz: 286766d1c5243bc9c1c6eb205c6e38ee97b3d06c90f4d77b6d84638a56d465e2
 SHA512:
-  metadata.gz: cd78c231bd7ab5eb1146c8d1f2fb3b19bea52951c30001d373981b748a77404bd5a5b87477bef989fa9707ff1049d9d7d6a91e2c3a0fa1cdc4533351c2a214bc
-  data.tar.gz: dbb334195b9354655edc06a11e52a0e77bee6be0961cc545fafc19ca6f2e0de5ba2c7c818ccde14bbf0fc2b2ba14b42f10fa02b114eb3f39b679763ea8427e2e
+  metadata.gz: cea1cc7dc006a7315fac53026959d444ae5a9bdcad161a94f57df7fdf3bead8cf5ee23aac5b9eaecdd68bc888cbf0df9e290acc4e09435f2b5bd771113ce38c3
+  data.tar.gz: 6dcd950c3ea0bace47c8ecf3e42dd38ff41d747ac92918c30c08e2403e0c6c2471dcf69c1f3eddc04049988c40d555b07f470ee6a3e873cf8c36aa1223828690

data/lib/speculations/parser/context.rb

@@ -4,15 +4,6 @@ module Speculations
       require_relative './context/include'
       require_relative './context/example'
 
-      DISCLAIMER = <<-EOD
-# DO NOT EDIT!!!
-# 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
-# YOU HAVE BEEN WARNED
-      EOD
-
       attr_reader :filename, :level, :lnb, :title, :parent, :root, :tree_level
 
       def new_context(title:, lnb:, level: )
@@ -94,14 +85,10 @@ module Speculations
         if parent
           map_lines(%{# #{filename}:#{lnb}}, %{context "#{title}" do}, indent: -1)
         else
-          _root_header
+          []
         end
       end
 
-      def _root_header
-        map_lines(DISCLAIMER.gsub("FILENAME", filename.inspect).split("\n"), %{RSpec.describe #{filename.inspect} do}, indent: -1)
-      end
-
       def _init_from_parent
         @root = parent.root
         @filename = parent.filename
@@ -109,7 +96,11 @@ module Speculations
       end
 
       def _footer
-        map_lines("end", indent: -1)
+        if parent
+          map_lines("end", indent: -1)
+        else
+          []
+        end
       end
 
       def _realign_levels new_parent

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

@@ -11,17 +11,17 @@ module Speculations
             new_parent = node.parent_of_level(level.pred)
             node = new_parent.new_context(title: match[2], lnb: lnb, level: level)
             [:out, node]
-          when match = State.maybe_example(line)
-            [:candidate, node, match[:title]]
           when match = State.maybe_include(line)
             [:candidate, node, :inc]
+          when match = State.maybe_example(line)
+            [:candidate, node, match[:title]]
           when match = State.ruby_code_block(line)
             if ctxt == :inc
               node = node.new_include(lnb: lnb)
             else
               node = node.new_example(title: ctxt, lnb: lnb)
             end
-            [:in, node]
+            [:in, node, (ctxt == :inc ? :includes : :out)]
           else
             [:out, node]
           end

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

@@ -6,9 +6,9 @@ module Speculations
         def parse line, _lnb, node, ctxt
           case
           when State.eoblock_match(line)
-            [:out, node.parent]
+            [ctxt, node.parent]
           else
-            [:in, node.add_line(line)]
+            [:in, node.add_line(line), ctxt]
           end
         end
       end

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

@@ -0,0 +1,31 @@
+module Speculations
+  class Parser
+    module State
+      module Includes extend self
+
+        def parse line, lnb, node, _ctxt
+          case
+          when match = State.context_match(line)
+            make_new_context(lnb: lnb, node: node, match: match)
+          when match = State.maybe_include(line)
+            [:candidate, node, :inc]
+          when match = State.maybe_example(line)
+            [:candidate, node, match[:title]]
+          else
+            [:includes, node]
+          end
+        end
+
+        private
+
+        def make_new_context(lnb:, match:, node:)
+          level = match[:level].size
+          new_parent = node.parent_of_level(level.pred)
+          node = new_parent.new_context(title: match[:title], lnb: lnb, level: level)
+          [:out, node]
+        end
+
+      end
+    end
+  end
+end

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

@@ -3,10 +3,10 @@ module Speculations::Parser::State::Triggers
   BLANK_RGX   = %r{\A\s*\z}
   CONTEXT_RGX = %r[\A\s{0,3}(?<level>\#{1,7})\s+Context:?\s+(?<title>.*)]
   EOBLOCK_RGX = %r[\A\s{0,3}```\s*\z]
-  GIVEN_RGX   = %r[\A\s{0,3}(?:Given|When)\b]
+  GIVEN_RGX   = %r[\A\s{0,3}(?:Given|When|And)\b]
   EXAMPLE_RGX = %r[\A\s{0,3}Example:?\s+(<?title>.*)]
   RUBY_RGX    = %r[\A\s{0,3}```ruby]
-  THEN_RGX    = %r[\A\s{0,3}(?:Then|But|And|Also)\b\s*(?<title>.*)]
+  THEN_RGX    = %r[\A\s{0,3}(?:Then|But|And|Also|Or)\b\s*(?<title>.*)]
 
   def blank_line line
     BLANK_RGX.match(line)

data/lib/speculations/parser/state.rb

@@ -1,6 +1,7 @@
 module Speculations::Parser::State extend self
   require_relative './state/candidate'
   require_relative './state/in'
+  require_relative './state/includes'
   require_relative './state/out'
   require_relative './state/triggers'
 

data/lib/speculations/parser.rb

@@ -8,6 +8,7 @@ module Speculations
       @__parsers__ ||= {
         candidate: State::Candidate,
         in: State::In,
+        includes: State::Includes,
         out: State::Out
       }
     end
@@ -31,7 +32,8 @@ module Speculations
       root = node = Context.new(filename: @filename)
       ctxt = nil
       @input.each_with_index do |line, lnb|
-        @state, node, ctxt = self.class.parsers.fetch(@state).parse(line, lnb.succ, node, ctxt)
+        parser = self.class.parsers.fetch(@state)
+        @state, node, ctxt = parser.parse(line, lnb.succ, node, ctxt)
       end
       root
     end

data/lib/speculations/version.rb

@@ -1,3 +1,3 @@
 module Speculations
-  VERSION = "0.5.1"
+  VERSION = "1.0.0"
 end

data/lib/speculations.rb

@@ -2,18 +2,33 @@ require 'fileutils'
 require_relative 'speculations/parser'
 module Speculations extend self
 
+      DISCLAIMER = <<-EOD
+# DO NOT EDIT!!!
+# 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
+# YOU HAVE BEEN WARNED
+      EOD
+
   def compile(infile, outfile=nil)
     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)
-      File.write(outfile, ast.to_code.join("\n"))
+      code = _decorated_ast_code ast, infile
+      File.write(outfile, code.join("\n"))
     end
     outfile
   end
 
   private
 
+  def _decorated_ast_code ast, filename
+    [DISCLAIMER.gsub("FILENAME", filename.inspect).split("\n"), %{RSpec.describe #{filename.inspect} do}] +
+    ast.to_code + ["end"]
+  end
+
   def _out_of_date?(outf, inf)
     return true unless File.exists? outf
     return File.lstat(outf).mtime <= File.lstat(inf).mtime

metadata

@@ -1,43 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: speculate_about
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Robert Dober
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-02 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.10'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.10'
+date: 2022-01-30 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.
 email: robert.dober@gmail.com
@@ -57,6 +29,7 @@ files:
 - lib/speculations/parser/state.rb
 - lib/speculations/parser/state/candidate.rb
 - lib/speculations/parser/state/in.rb
+- lib/speculations/parser/state/includes.rb
 - lib/speculations/parser/state/out.rb
 - lib/speculations/parser/state/triggers.rb
 - lib/speculations/version.rb
@@ -72,14 +45,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: Extract RSpecs from Markdown