speculate_about 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 79f9d62e9eca9435df9fc7c9c5851be34190128cb5bf839035ae54623aabd623
+  data.tar.gz: 0ec1ab318bbb646c8fae2fbd40d1c5a0b4b809104559f75499d2edc274dc6862
+SHA512:
+  metadata.gz: f88a8f63272fb0dfe276a00b454d527178ec798378270d62d5ea2d266e01bae8e1260a2edb261444eb0ab3c4582651b3c6f66c7abb0f333d93d0abc50979239e
+  data.tar.gz: ca9364804df625b912058277c01f2b20d526de1a2264c27b7f8d0ceba025074288425d3ed8ce0f9f22c4d31088aa1339daf6bc73f166342b4f18e6a8036bbe45

data/lib/speculate_about.rb

@@ -0,0 +1,29 @@
+require 'rspec'
+
+require 'speculations/parser'
+
+module SpeculateAbout
+  def speculate_about file
+    path = _find_file(file)
+    code = _compile path
+    ENV["SPECULATE_ABOUT_DEBUG"] ? puts(code) : instance_eval(code)
+  end
+
+
+  private
+
+  def _compile path
+    ast  = Speculations::Parser.new.parse_from_file(path)
+    ast.to_code
+  end
+  def _find_file file
+    return file if File.readable? file
+    path = File.join(File.dirname(location), file)
+    return path if File.readable? path
+    raise ArgumentError, "file #{file} neither found in your project dir, neither your spec dir"
+  end
+end
+
+RSpec.configure do |conf|
+  conf.extend SpeculateAbout
+end

data/lib/speculations.rb

@@ -0,0 +1,2 @@
+module Speculations
+end

data/lib/speculations/parser.rb

@@ -0,0 +1,39 @@
+require_relative '../speculations'
+class Speculations::Parser
+  require_relative './parser/context'
+  require_relative './parser/state'
+
+  attr_reader :filename, :input, :root, :state
+
+  def self.parsers
+     @__parsers__ ||= {
+       bef: State::Bef,
+       exa: State::Exa,
+       inc: State::Inc,
+       out: State::Out
+     }
+  end
+
+  def parse_from_file file
+    @filename = file
+    @input = File
+      .new(file)
+      .each_line(chomp: true)
+      .lazy
+    parse!
+  end
+
+  private
+
+  def initialize
+    @state = :out
+  end
+
+  def parse!
+    root = node = Context.new(name: "Speculations from #{@filename}", lnb: 0, filename: @filename, parent: nil)
+    input.each_with_index do |line, lnb|
+      @state, node = self.class.parsers.fetch(@state).parse(line, lnb.succ, node)
+    end
+    root
+  end
+end

data/lib/speculations/parser/context.rb

@@ -0,0 +1,80 @@
+class Speculations::Parser::Context
+  require_relative './context/include'
+  require_relative './context/example'
+  require_relative './context/setup'
+
+  attr_reader :filename, :level, :lnb, :name, :parent, :setup
+
+  def add_child(name:, lnb:)
+    raise "Illegal nesting" if parent
+    children << self.class.new(name: name, lnb: lnb, parent: self)
+    children.last
+  end
+
+  def add_example(lnb:)
+    examples << Example.new(lnb: lnb, parent: self)
+    examples.last
+  end
+
+  def add_include(lnb:)
+    includes << Include.new(lnb: lnb, parent: self)
+    includes.last
+  end
+
+  def children
+     @__children__ ||= []
+  end
+
+  def examples
+     @__examples__ ||= []
+  end
+
+  def includes
+     @__includes__ ||= []
+  end
+
+  def map_lines(*lines, indent: 0)
+    prefix = "  " * (level + indent)
+    lines.flatten.map{ |line| "#{prefix}#{line.strip}" }.join("\n")
+  end
+
+  def set_setup(lnb:)
+    @setup = Setup.new(lnb: lnb, parent: self)
+  end
+
+  def to_code
+    [
+      _header,
+      includes.map(&:to_code),
+      setup&.to_code,
+      examples.map(&:to_code),
+      children.map(&:to_code),
+      _footer
+    ].flatten.compact.join("\n")
+  end
+  
+  private
+
+  def initialize(lnb:, name:, filename: nil, parent: nil)
+    _init_from_parent filename, parent
+    @level    = parent ? parent.level.succ : 1
+    @lnb      = lnb
+    @setup    = nil
+    @name     = name
+    @parent   = parent
+  end
+
+  def _header
+    map_lines(%{context "#{name}" do}, indent: -1)
+  end
+
+  def _init_from_parent filename, parent
+    @filename = parent ? parent.filename : filename
+    raise ArgumentError, "no filename given in root context" unless @filename
+  end
+
+  def _footer
+    map_lines("end", indent: -1)
+  end
+
+end

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

@@ -0,0 +1,34 @@
+class Speculations::Parser::Context::Example
+
+  attr_reader :lnb, :name, :parent
+
+  def add_line line
+    lines << line
+    self
+  end
+
+  def lines
+     @__lines__ ||= [] 
+  end
+
+  def to_code
+    parent.map_lines(_example_head) +
+      "\n" +
+      parent.map_lines(lines, indent: 1) +
+      "\n" +
+      parent.map_lines("end")
+  end
+
+
+  private
+
+  def initialize(lnb:, parent:)
+    @lnb    = lnb
+    @name   = "Example from #{parent.filename}:#{lnb.succ}"
+    @parent = parent
+  end
+
+  def _example_head
+    %{it "#{name}" do}
+  end
+end

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

@@ -0,0 +1,24 @@
+class Speculations::Parser::Context::Include
+
+  attr_reader :lnb, :parent
+
+  def add_line line 
+    lines << line
+    self
+  end
+
+  def lines
+     @__lines__ ||= []
+  end
+
+  def to_code
+    parent.map_lines(lines)
+  end
+
+  private
+
+  def initialize(parent:, lnb:)
+    @parent = parent
+    @lnb    = lnb
+  end
+end

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

@@ -0,0 +1,28 @@
+class Speculations::Parser::Context::Setup
+
+  attr_reader :lnb, :parent
+
+  def add_line line
+    lines << line
+    self
+  end
+
+  def lines
+     @__lines__ ||= []
+  end
+
+  def to_code
+    parent.map_lines("before do") + 
+      "\n" +
+      parent.map_lines(lines, indent: 1) +
+      "\n" +
+      parent.map_lines("end")
+  end
+
+
+  private
+
+  def initialize(lnb:, parent:)
+    @parent = parent
+  end
+end

data/lib/speculations/parser/state.rb

@@ -0,0 +1,34 @@
+module Speculations::Parser::State extend self
+  require_relative './state/bef'
+  require_relative './state/exa'
+  require_relative './state/inc'
+  require_relative './state/out'
+
+  BEFORE_RGX  = %r[\A\s{0,3}```.*\s:before]
+  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]
+  INCLUDE_RGX = %r[\A\s{0,3}```.*\s:include]
+
+  def before_match line
+    BEFORE_RGX =~ line
+  end
+
+  def context_match line
+    if match = CONTEXT_RGX.match(line)
+      match.captures.first
+    end
+  end
+
+  def eoblock_match line
+    EOBLOCK_RGX =~ line
+  end
+
+  def example_match line
+    EXAMPLE_RGX =~ line
+  end
+
+  def include_match line
+    INCLUDE_RGX =~ line
+  end
+end

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

@@ -0,0 +1,17 @@
+module Speculations
+  class Parser
+    module State
+      module Bef extend self
+
+        def parse line, _lnb, node
+          case
+          when State.eoblock_match(line)
+            [:out, node.parent]
+          else
+            [:bef, node.add_line(line)]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module Speculations
+  class Parser
+    module State
+      module Exa extend self
+
+        def parse line, _lnb, node
+          case
+          when State.eoblock_match(line)
+            [:out, node.parent]
+          else
+            [:exa, node.add_line(line)]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module Speculations
+  class Parser
+    module State
+      module Inc extend self
+
+        def parse line, _lnb, node
+          case
+          when State.eoblock_match(line)
+            [:out, node.parent]
+          else
+            [:inc, node.add_line(line)]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+module Speculations
+  class Parser
+    module State
+      module Out extend self
+
+        def parse 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]
+          when State.before_match(line)
+            node = node.set_setup(lnb: lnb)
+            [:bef, node]
+          when State.example_match(line)
+            node = node.add_example(lnb: lnb)
+            [:exa, node]
+          when State.include_match(line)
+            node = node.add_include(lnb: lnb)
+            [:inc, node]
+          else
+            [:out, node]
+          end
+        end
+
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: speculate_about
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Robert Dober
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-02-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+description: Allows Markdown or other text files to be used as literal specs, a la
+  Elixr doctest, but from any file.
+email: robert.dober@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/speculate_about.rb
+- lib/speculations.rb
+- lib/speculations/parser.rb
+- lib/speculations/parser/context.rb
+- lib/speculations/parser/context/example.rb
+- lib/speculations/parser/context/include.rb
+- lib/speculations/parser/context/setup.rb
+- lib/speculations/parser/state.rb
+- lib/speculations/parser/state/bef.rb
+- lib/speculations/parser/state/exa.rb
+- lib/speculations/parser/state/inc.rb
+- lib/speculations/parser/state/out.rb
+homepage: https://github.com/robertdober/speculate
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Extract RSpecs from Markdown
+test_files: []