speculate_about 0.1.0 → 0.2.2

checksums.yaml

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

data/lib/speculate_about.rb

@@ -4,23 +4,35 @@ 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)
+    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
+      ENV["SPECULATE_ABOUT_DEBUG"] ? _show(code, path) : instance_eval(code, path)
+    end
   end
 
 
   private
 
-  def _compile path
-    ast  = Speculations::Parser.new.parse_from_file(path)
+  def _compile path, file
+    ast  = Speculations::Parser.new.parse_from_file(path, file)
     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"
+  def _show(code, path)
+     message = "Generated code for #{path}"
+     _underline(message)
+     puts code
+  end
+  def _find_files file, local_path
+    [Dir.pwd, local_path]
+      .flat_map do |dir|
+        Dir.glob(File.join(dir, file))
+    end
+  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, :root, :state
+  attr_reader :filename, :input, :orig_filename, :root, :state
 
   def self.parsers
      @__parsers__ ||= {
@@ -14,8 +14,9 @@ class Speculations::Parser
      }
   end
 
-  def parse_from_file file
+  def parse_from_file file, orig_filename = nil
     @filename = file
+    @orig_filename = orig_filename || file
     @input = File
       .new(file)
       .each_line(chomp: true)
@@ -30,7 +31,7 @@ class Speculations::Parser
   end
 
   def parse!
-    root = node = Context.new(name: "Speculations from #{@filename}", lnb: 0, filename: @filename, parent: nil)
+    root = node = Context.new(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,7 +3,7 @@ class Speculations::Parser::Context
   require_relative './context/example'
   require_relative './context/setup'
 
-  attr_reader :filename, :level, :lnb, :name, :parent, :setup
+  attr_reader :filename, :level, :lnb, :name, :orig_filename, :parent, :potential_name, :setup
 
   def add_child(name:, lnb:)
     raise "Illegal nesting" if parent
@@ -11,8 +11,9 @@ class Speculations::Parser::Context
     children.last
   end
 
-  def add_example(lnb:)
-    examples << Example.new(lnb: lnb, parent: self)
+  def add_example(lnb:, 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,20 +60,25 @@ class Speculations::Parser::Context
   
   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
+  def initialize(lnb:, name:, filename: nil, orig_filename: nil, parent: nil)
+    _init_from_parent filename, orig_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
+  def _init_from_parent filename, orig_filename, parent
+    _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

@@ -2,6 +2,8 @@ class Speculations::Parser::Context::Example
 
   attr_reader :lnb, :name, :parent
 
+  NAMED_EXAMPLE = %r{\A[`~]{3,}ruby\s+:example\s+(.*)}
+
   def add_line line
     lines << line
     self
@@ -22,10 +24,22 @@ class Speculations::Parser::Context::Example
 
   private
 
-  def initialize(lnb:, parent:)
+  def initialize(lnb:, line:, parent:, name: nil)
     @lnb    = lnb
-    @name   = "Example from #{parent.filename}:#{lnb.succ}"
     @parent = parent
+    @name   = _compute_name(lnb: lnb, line: line, parent: parent, name: name)
+  end
+
+  def _compute_name(lnb:, parent:, line:, name:)
+    _, name1 = NAMED_EXAMPLE.match(line).to_a
+    
+    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}"
+    end
   end
 
   def _example_head

data/lib/speculations/parser/state.rb

@@ -9,6 +9,7 @@ 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+(.*)]
 
   def before_match line
     BEFORE_RGX =~ line
@@ -31,4 +32,8 @@ module Speculations::Parser::State extend self
   def include_match line
     INCLUDE_RGX =~ line
   end
+
+  def potential_name line
+    NAME_RGX.match(line)
+  end
 end

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

@@ -13,11 +13,14 @@ module Speculations
             node = node.set_setup(lnb: lnb)
             [:bef, node]
           when State.example_match(line)
-            node = node.add_example(lnb: lnb)
+            node = node.add_example(lnb: lnb, line: line)
             [:exa, node]
           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.2.2"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: speculate_about
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Robert Dober
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-02-01 00:00:00.000000000 Z
+date: 2020-11-11 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
@@ -62,8 +63,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.0.rc.1
+signing_key:
 specification_version: 4
 summary: Extract RSpecs from Markdown
 test_files: []