speculate_about 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 669757a09c549512732274147c0b65dc3d71c3446b73490f961ae61b4e6a7d2b
-  data.tar.gz: 68b1e0f9babc9630616b14b16bf5ad60a9974983495dc7c575287dfbb29472a0
+  metadata.gz: a40862f65330fcfdc48e0b22fb9a09447269ecad7ca0582522ecda4450b3257a
+  data.tar.gz: a65d170a63cdd08c0dfa711854beaf876a5810d84f9a82eab489ffcaa0331e57
 SHA512:
-  metadata.gz: 4253cedda25c3f32eaf71b0bbe5a99376f05e42e1dd8ab1e4ca818d12f99d6ac88404883ba25e74318d4de094d4614bad63ac397cde6f71f2835d32109586e5e
-  data.tar.gz: 2766bdc6aafb5f70c7ab73ec3b24e82ef025f6bbdfefd95de4d1bc797478de37de60ee60ff50c2895ead4c22e03117f432b6924252abae42419de5f46cf26ab9
+  metadata.gz: 1c42854aae7633c76e4d4cb8ce663915b55c48529833920252c3f2b57546cbe59490940db5c375a7468fede051cb237510255c3e5894b9e3ab87aa1feda126e1
+  data.tar.gz: 9c0e44f422c8638346fb416a3b4451a7a17001f1f9db08e70dbf4ed526b5b377fca96fb54ab9b1b3354d9fbbe91e2b97dde1b0bf15f2a261eec697677f7bc030

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,22 +3,23 @@ class Speculations::Parser::Context
   require_relative './context/example'
   require_relative './context/setup'
 
-  attr_reader :filename, :level, :lnb, :name, :orig_filename, :parent, :potential_name, :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, name: potential_name)
-    @potential_name = nil
+    reset_context
     examples.last
   end
 
   def add_include(lnb:)
     includes << Include.new(lnb: lnb, parent: self)
+    @given = false
     includes.last
   end
 
@@ -30,6 +31,10 @@ class Speculations::Parser::Context
      @__examples__ ||= []
   end
 
+  def given?
+    @given
+  end
+
   def includes
      @__includes__ ||= []
   end
@@ -39,8 +44,20 @@ class Speculations::Parser::Context
     lines.flatten.map{ |line| "#{prefix}#{line.strip}" }.join("\n")
   end
 
+  def reset_context
+    @potential_name = nil
+    @given = false
+    self
+  end
+
+  def set_given given
+    @given = given
+    self
+  end
+
   def set_name(potential_name)
     @potential_name = potential_name
+    self
   end
 
   def set_setup(lnb:)
@@ -60,8 +77,10 @@ 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
+    @given         = false
     @level         = parent ? parent.level.succ : 1
     @lnb           = lnb
     @setup         = nil
@@ -74,8 +93,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/state.rb

@@ -8,8 +8,12 @@ module Speculations::Parser::State extend self
   CONTEXT_RGX = %r[\A\s{0,3}\#{1,7}\s+Context\s+(.*)]
   EOBLOCK_RGX = %r[\A\s{0,3}```\s*\z]
   EXAMPLE_RGX = %r[\A\s{0,3}```.*\s:example]
+  GIVEN_RGX   = %r[\A\s{0,3}(?:Given|When)\b]
   INCLUDE_RGX = %r[\A\s{0,3}```.*\s:include]
-  NAME_RGX    = %r[\A\s{0,3}Example:\s+(.*)]
+  NAME_RGX    = %r[\A\s{0,3}Example:?\s+(.*)]i
+  RUBY_RGX    = %r[\A\s{0,3}```ruby]
+  THEN_RGX    = %r[\A\s{0,3}Then\s+(.*)]
+  WS_RGX      = %r[\A\s*\z]
 
   def before_match line
     BEFORE_RGX =~ line
@@ -28,6 +32,10 @@ module Speculations::Parser::State extend self
   def example_match line
     EXAMPLE_RGX =~ line
   end
+  
+  def given_match line
+    GIVEN_RGX =~ line
+  end
 
   def include_match line
     INCLUDE_RGX =~ line
@@ -36,4 +44,16 @@ module Speculations::Parser::State extend self
   def potential_name line
     NAME_RGX.match(line)
   end
+
+  def ruby_match line
+    RUBY_RGX =~ line
+  end
+
+  def then_match line
+    THEN_RGX.match(line)
+  end
+
+  def ws_match line
+    WS_RGX =~ line
+  end
 end

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

@@ -4,6 +4,49 @@ 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)
+            [:out, new_node.reset_context]
+          when State.ws_match(line)
+            [:out, node]
+          when name = State.potential_name(line)
+            node.set_name(name[1])
+            node.set_given(false)
+            [:out, node]
+          when name = State.then_match(line)
+            node.set_name(name[1])
+            node.set_given(false)
+            [:out, node]
+          when State.given_match(line)
+            [:out, node.set_given(true)]
+          when State.ruby_match(line)
+            if node.potential_name
+              node = node.add_example(lnb: lnb, line: line)
+              [:exa, node]
+            elsif node.given?
+              node = node.add_include(lnb: lnb)
+              [:inc, node]
+            else
+              [:out, node]
+            end
+          else
+            [:out, node.reset_context]
+          end
+        end
+
+        def _parse_classical line, lnb, node
           case
           when name = State.context_match(line)
             node = node.parent if node.parent

data/lib/speculations/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: speculate_about
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Robert Dober
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-23 00:00:00.000000000 Z
+date: 2020-11-15 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: []