speculate_about 0.2.2 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5abf0f1d0b408b81d4b2b9644eeaaca4137bcf0180f298bb94145b275a847ecd
-  data.tar.gz: a040f692852c90de48d3d1a758ecda31ce8a3d1f36920ce44145d396f7666aca
+  metadata.gz: 1d08ccbaea3017274bdc86160387aeed915eba6aac5e5119cca48c2e8f4a53a3
+  data.tar.gz: dd53be1c870c773d263a59b03204b469c593e0244df48ea19aaac1be87a45b5d
 SHA512:
-  metadata.gz: d6d2d63515ade99e8eaac787572359c3b707301263d4ebbee6ce3df03546426262202e092eef337239cf9a82e92096e8fa7318756b405f46900c0514fd1d1d4c
-  data.tar.gz: 5ca6224cf00ab3ee4cd13d8ba2df5cfc83bcc7d516a018435f097ed509f94a27cc2ec9df054a2cc43b2215a3399a0b79c4279c00b01b9fd27181e0c0ac905597
+  metadata.gz: 222b7eff1615cae7c4e3af5fbaffae7812e9e1144de7884b5a3b7d798e7647f9ea259dddf632e5262977d6a07da1234f22457c84eb656c225ba7745b1a317f49
+  data.tar.gz: 70c8e9c20f41acc002bfdda9ae3fa6f63561538730989c63e25e0460a65785b21d5835c9f16efc4f41ccaf22a51b179a27bc77c42a7585afa0474d2e95a9dcb8

data/lib/speculate_about.rb

@@ -3,11 +3,11 @@ require 'rspec'
 require 'speculations/parser'
 
 module SpeculateAbout
-  def speculate_about file
+  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, file
+      code = _compile path, _readable(path), alternate_syntax: alternate_syntax 
       ENV["SPECULATE_ABOUT_DEBUG"] ? _show(code, path) : instance_eval(code, path)
     end
   end
@@ -15,14 +15,13 @@ module SpeculateAbout
 
   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 _show(code, path)
-     message = "Generated code for #{path}"
-     _underline(message)
-     puts code
+  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]
@@ -30,6 +29,11 @@ module SpeculateAbout
         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)

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

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|But|And)\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,50 @@ 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)
+            node.set_name(nil)
+            [: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

@@ -1,3 +1,3 @@
 module SpeculateAbout
-  VERSION = "0.2.2"
+  VERSION = "0.4.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: speculate_about
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.4.2
 platform: ruby
 authors:
 - Robert Dober
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-11 00:00:00.000000000 Z
+date: 2020-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -63,7 +63,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.0.rc.1
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: Extract RSpecs from Markdown