speculate_about 0.1.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6c603b51bd04471204c4584fb1697f5a27dd7b578abd012c805046e7d9a49dc
-  data.tar.gz: 82f31cc63352e6d3c380b860a40a1f84a2f133b7b4f8a391363176f57d808415
+  metadata.gz: d53e888a2cad71c7c20205f0f34d7ededa3df3feceef7d567f051d362a36ccb8
+  data.tar.gz: ee00700ca0a19000b8098cb3022b462da0537477d58ee912f250aba6b02e3e7c
 SHA512:
-  metadata.gz: bd30e3a46232a0d38b0d0725aa89df98f7d724faef50e350e3bacf106c552e279569087b830f93a656015dca03f5fe1e0ff0c511484a2c12ac3331ebb8e5c51a
-  data.tar.gz: f48a6400a5bd1d6971780e5c8261d957b64af79c96baa544dd21b4050240343da77bc48141b4d0097da32ee4ee4ff5d065c7d3aa0df65584a71caf99b4724d09
+  metadata.gz: 3ced515885a50ff873cc4b471fe03eab69dc3e7c4f409e4e5ff392a91bfd94a08946aae7eb866607b27ecad62104beee68d8a52230fa2e216e1a544800a4ef0e
+  data.tar.gz: 792619744dab6387ad2e70c7fa53eb49c3b8b9f26470a5de7c92477c3cc274075d7cff720b5fb8dc0a87bf71d2af016517e72449d56298824d3f865253b64192

data/lib/speculate_about.rb

@@ -3,24 +3,40 @@ require 'rspec'
 require 'speculations/parser'
 
 module SpeculateAbout
-  def speculate_about file
-    path = _find_file(file, File.dirname( caller.first ))
-    code = _compile path, file
-    ENV["SPECULATE_ABOUT_DEBUG"] ? puts(code) : instance_eval(code)
+  def speculate_about file, alternate_syntax: false
+    paths = _find_files(file, File.dirname( caller.first ))
+    raise ArgumentError, "no files found for pattern #{file}" if paths.empty?
+    paths.each do |path|
+      code = _compile path, _readable(path), alternate_syntax: alternate_syntax 
+      ENV["SPECULATE_ABOUT_DEBUG"] ? _show(code, path) : instance_eval(code, path)
+    end
   end
 
 
   private
 
-  def _compile path, file
-    ast  = Speculations::Parser.new.parse_from_file(path, file)
+  def _compile path, file, alternate_syntax: false
+    ast  = Speculations::Parser.new.parse_from_file(path, file, alternate_syntax: alternate_syntax)
     ast.to_code
   end
-  def _find_file file, local_path
-    return file if File.readable? file
-    local_file = File.join(local_path, file)
-    return local_file if File.readable? local_file
-    raise ArgumentError, "file #{file.inspect} not found"
+  def _readable(path)
+    d = File.dirname(path)
+    File.join(File.basename(d), File.basename(path))
+  end
+  def _find_files file, local_path
+    [Dir.pwd, local_path]
+      .flat_map do |dir|
+        Dir.glob(File.join(dir, file))
+    end
+  end
+  def _show(code, path)
+     message = "Generated code for #{path}"
+     _underline(message)
+     puts code
+  end
+  def _underline(message, ul: "=")
+    puts message
+    puts message.gsub(/./, ul)
   end
 end
 

data/lib/speculations/parser.rb

@@ -3,7 +3,7 @@ class Speculations::Parser
   require_relative './parser/context'
   require_relative './parser/state'
 
-  attr_reader :filename, :input, :orig_filename, :root, :state
+  attr_reader :alternate_syntax, :filename, :input, :orig_filename, :root, :state
 
   def self.parsers
      @__parsers__ ||= {
@@ -14,7 +14,8 @@ class Speculations::Parser
      }
   end
 
-  def parse_from_file file, orig_filename = nil
+  def parse_from_file file, orig_filename = nil, alternate_syntax: false
+    @alternate_syntax = alternate_syntax
     @filename = file
     @orig_filename = orig_filename || file
     @input = File
@@ -31,7 +32,7 @@ class Speculations::Parser
   end
 
   def parse!
-    root = node = Context.new(name: "Speculations from #{@filename}", lnb: 0, filename: @filename, orig_filename: orig_filename, parent: nil)
+    root = node = Context.new(alternate_syntax: alternate_syntax, name: "Speculations from #{@filename}", lnb: 0, filename: @filename, orig_filename: orig_filename, parent: nil)
     input.each_with_index do |line, lnb|
       @state, node = self.class.parsers.fetch(@state).parse(line, lnb.succ, node)
     end

data/lib/speculations/parser/context.rb

@@ -3,16 +3,17 @@ class Speculations::Parser::Context
   require_relative './context/example'
   require_relative './context/setup'
 
-  attr_reader :filename, :level, :lnb, :name, :orig_filename, :parent, :setup
+  attr_reader :alternate_syntax, :filename, :level, :lnb, :name, :orig_filename, :parent, :potential_name, :setup
 
   def add_child(name:, lnb:)
     raise "Illegal nesting" if parent
-    children << self.class.new(name: name, lnb: lnb, parent: self)
+    children << self.class.new(alternate_syntax: alternate_syntax, name: name, lnb: lnb, parent: self)
     children.last
   end
 
   def add_example(lnb:, line:)
-    examples << Example.new(lnb: lnb, parent: self, line: line)
+    examples << Example.new(lnb: lnb, parent: self, line: line, name: potential_name)
+    @potential_name = nil
     examples.last
   end
 
@@ -38,6 +39,10 @@ class Speculations::Parser::Context
     lines.flatten.map{ |line| "#{prefix}#{line.strip}" }.join("\n")
   end
 
+  def set_name(potential_name)
+    @potential_name = potential_name
+  end
+
   def set_setup(lnb:)
     @setup = Setup.new(lnb: lnb, parent: self)
   end
@@ -55,8 +60,9 @@ class Speculations::Parser::Context
   
   private
 
-  def initialize(lnb:, name:, filename: nil, orig_filename: nil, parent: nil)
+  def initialize(alternate_syntax: false, lnb:, name:, filename: nil, orig_filename: nil, parent: nil)
     _init_from_parent filename, orig_filename, parent
+    @alternate_syntax = alternate_syntax
     @level         = parent ? parent.level.succ : 1
     @lnb           = lnb
     @setup         = nil
@@ -69,8 +75,12 @@ class Speculations::Parser::Context
   end
 
   def _init_from_parent filename, orig_filename, parent
-    @filename = parent ? parent.filename : filename
+    _set_filename filename, orig_filename, parent
     @orig_filename = parent ? parent.orig_filename : orig_filename
+  end
+
+  def _set_filename filename, orig_filename, parent
+    @filename = parent ? parent.filename : filename
     raise ArgumentError, "no filename given in root context" unless @filename
   end
 

data/lib/speculations/parser/context/example.rb

@@ -24,16 +24,18 @@ class Speculations::Parser::Context::Example
 
   private
 
-  def initialize(lnb:, line:, parent:)
+  def initialize(lnb:, line:, parent:, name: nil)
     @lnb    = lnb
     @parent = parent
-    @name   = _compute_name(lnb: lnb, line: line, parent: parent)
+    @name   = _compute_name(lnb: lnb, line: line, parent: parent, name: name)
   end
 
-  def _compute_name(lnb:, parent:, line:)
-    _, name = NAMED_EXAMPLE.match(line).to_a
+  def _compute_name(lnb:, parent:, line:, name:)
+    _, name1 = NAMED_EXAMPLE.match(line).to_a
     
-    if name&.empty? == false # SIC
+    if name1&.empty? == false # SIC
+      "#{name1} (#{parent.orig_filename}:#{lnb.succ})"
+    elsif name
       "#{name} (#{parent.orig_filename}:#{lnb.succ})"
     else
       "Example from #{parent.orig_filename}:#{lnb.succ}"

data/lib/speculations/parser/state.rb

@@ -9,6 +9,9 @@ module Speculations::Parser::State extend self
   EOBLOCK_RGX = %r[\A\s{0,3}```\s*\z]
   EXAMPLE_RGX = %r[\A\s{0,3}```.*\s:example]
   INCLUDE_RGX = %r[\A\s{0,3}```.*\s:include]
+  NAME_RGX    = %r[\A\s{0,3}Example:?\s+(.*)]i
+  RUBY_RGX    = %r[\A\s{0,3}```ruby]
+  WS_RGX      = %r[\A\s*\z]
 
   def before_match line
     BEFORE_RGX =~ line
@@ -31,4 +34,16 @@ module Speculations::Parser::State extend self
   def include_match line
     INCLUDE_RGX =~ line
   end
+
+  def potential_name line
+    NAME_RGX.match(line)
+  end
+
+  def ruby_match line
+    RUBY_RGX =~ line
+  end
+
+  def ws_match line
+    WS_RGX =~ line
+  end
 end

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

@@ -4,6 +4,42 @@ module Speculations
       module Out extend self
 
         def parse line, lnb, node
+          if node.alternate_syntax
+            _parse_alternate line, lnb, node
+          else
+            _parse_classical line, lnb, node
+          end
+        end
+
+        private
+
+        def _parse_alternate line, lnb, node
+          case
+          when name = State.context_match(line)
+            node = node.parent if node.parent
+            new_node = node.add_child(name: name, lnb: lnb)
+            new_node.set_name(nil)
+            [:out, new_node]
+          when State.ws_match(line)
+            [:out, node]
+          when name = State.potential_name(line)
+            node.set_name(name[1])
+            [:out, node]
+          when State.ruby_match(line)
+            if node.potential_name
+              node = node.add_example(lnb: lnb, line: line)
+              [:exa, node]
+            else
+              node = node.add_include(lnb: lnb)
+              [:inc, node]
+            end
+          else
+            node.set_name(nil)
+            [:out, node]
+          end
+        end
+
+        def _parse_classical line, lnb, node
           case
           when name = State.context_match(line)
             node = node.parent if node.parent
@@ -18,6 +54,9 @@ module Speculations
           when State.include_match(line)
             node = node.add_include(lnb: lnb)
             [:inc, node]
+          when name = State.potential_name(line)
+            node.set_name(name[1])
+            [:out, node]
           else
             [:out, node]
           end

data/lib/speculations/version.rb

@@ -0,0 +1,3 @@
+module SpeculateAbout
+  VERSION = "0.3.0"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: speculate_about
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Robert Dober
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-03-18 00:00:00.000000000 Z
+date: 2020-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -24,7 +24,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.9'
-description: Allows Markdown or other text files to be used as literal specs, a la
+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
 executables: []
@@ -43,11 +43,12 @@ files:
 - lib/speculations/parser/state/exa.rb
 - lib/speculations/parser/state/inc.rb
 - lib/speculations/parser/state/out.rb
+- lib/speculations/version.rb
 homepage: https://github.com/robertdober/speculate
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -63,7 +64,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Extract RSpecs from Markdown
 test_files: []