speculate_about 0.5.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7194ffffa00a4292176dafa4120ea24ddf47e8aa6b6ed04d8be2dfaeefcfb8b
-  data.tar.gz: bb6b85091a5c9c59465f7df1f2369f33aa6e3090c249ee4cdc9184a9ef1580e3
+  metadata.gz: 68c9156823395a28b426d374248458dd846e438e3ab0d6b31330e0357db4473e
+  data.tar.gz: 6ac9fb5014c33af83186983cf26f0770ebf7f4f2ef07c070d067f2f30477e658
 SHA512:
-  metadata.gz: 2e88641b31f6adf08b14730b619fbc31828f4d04b8058946cb1b9b71d7cecf05695d9d1b59849184b31220d88d7fd0d821e0b318f24cc68d803ed303cb792b97
-  data.tar.gz: 7de92ee9f101df89939eea6b8c0b42513d88222bbef60fa51fe2a9413add66e50b5f1da0ca7ff46d7ca02811b31be7ceb925c45509a3ad8c5dabb82fcc28f5e0
+  metadata.gz: ee238e533857ea54f7bc47059824e06f264018419e07551338a33b8f319a64c070d59169f37e2c4f266a750cea7603c9d5fc9b45caf5ef3d9f94359fa37aed5d
+  data.tar.gz: b84407b46a432412f6a78e84e2cc3d07c3f381a6a93cbc18a45d5d3ea9c19b5f77209aa79bf8cef4cc9f811a1806ea7f84c6e8e208d025ccc3312475f75d4566

data/lib/speculate_about.rb

@@ -0,0 +1,27 @@
+require 'rspec'
+require_relative 'speculations/parser'
+module SpeculateAbout
+
+  def speculate_about(infile)
+    raise ArgumentError, "#{infile} not found" unless File.readable? infile
+    ast  = Speculations::Parser.new.parse_from_file(infile)
+    code = ast.to_code.join("\n")
+    ENV["SPECULATE_ABOUT_DEBUG"] ? _show(code, infile) : instance_eval(code, infile)
+  end
+
+  private
+  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
+
+RSpec.configure do |conf|
+  conf.extend SpeculateAbout
+end

data/lib/speculations/parser/context.rb

@@ -4,15 +4,6 @@ module Speculations
       require_relative './context/include'
       require_relative './context/example'
 
-      DISCLAIMER = <<-EOD
-# DO NOT EDIT!!!
-# This file was generated from FILENAME with the speculate_about gem, if you modify this file
-# one of two bad things will happen
-# - your documentation specs are not correct
-# - your modifications will be overwritten by the speculate rake task
-# YOU HAVE BEEN WARNED
-      EOD
-
       attr_reader :filename, :level, :lnb, :title, :parent, :root, :tree_level
 
       def new_context(title:, lnb:, level: )
@@ -94,14 +85,10 @@ module Speculations
         if parent
           map_lines(%{# #{filename}:#{lnb}}, %{context "#{title}" do}, indent: -1)
         else
-          _root_header
+          []
         end
       end
 
-      def _root_header
-        map_lines(DISCLAIMER.gsub("FILENAME", filename.inspect).split("\n"), %{RSpec.describe #{filename.inspect} do}, indent: -1)
-      end
-
       def _init_from_parent
         @root = parent.root
         @filename = parent.filename
@@ -109,7 +96,11 @@ module Speculations
       end
 
       def _footer
-        map_lines("end", indent: -1)
+        if parent
+          map_lines("end", indent: -1)
+        else
+          []
+        end
       end
 
       def _realign_levels new_parent

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

@@ -6,7 +6,7 @@ module Speculations::Parser::State::Triggers
   GIVEN_RGX   = %r[\A\s{0,3}(?:Given|When)\b]
   EXAMPLE_RGX = %r[\A\s{0,3}Example:?\s+(<?title>.*)]
   RUBY_RGX    = %r[\A\s{0,3}```ruby]
-  THEN_RGX    = %r[\A\s{0,3}(?:Then|But|And|Also)\b\s*(?<title>.*)]
+  THEN_RGX    = %r[\A\s{0,3}(?:Then|But|And|Also|Or)\b\s*(?<title>.*)]
 
   def blank_line line
     BLANK_RGX.match(line)

data/lib/speculations/version.rb

@@ -1,3 +1,3 @@
 module Speculations
-  VERSION = "0.5.0"
+  VERSION = "0.6.1"
 end

data/lib/speculations.rb

@@ -2,18 +2,33 @@ require 'fileutils'
 require_relative 'speculations/parser'
 module Speculations extend self
 
+      DISCLAIMER = <<-EOD
+# DO NOT EDIT!!!
+# This file was generated from FILENAME with the speculate_about gem, if you modify this file
+# one of two bad things will happen
+# - your documentation specs are not correct
+# - your modifications will be overwritten by the speculate rake task
+# YOU HAVE BEEN WARNED
+      EOD
+
   def compile(infile, outfile=nil)
     raise ArgumentError, "#{infile} not found" unless File.readable? infile
     outfile ||= _speculation_path(infile)
     if _out_of_date?(outfile, infile)
       ast  = Speculations::Parser.new.parse_from_file(infile)
-      File.write(outfile, ast.to_code.join("\n"))
+      code = _decorated_ast_code ast, infile
+      File.write(outfile, code.join("\n"))
     end
     outfile
   end
 
   private
 
+  def _decorated_ast_code ast, filename
+    [DISCLAIMER.gsub("FILENAME", filename.inspect).split("\n"), %{RSpec.describe #{filename.inspect} do}] +
+    ast.to_code + ["end"]
+  end
+
   def _out_of_date?(outf, inf)
     return true unless File.exists? outf
     return File.lstat(outf).mtime <= File.lstat(inf).mtime

metadata

@@ -1,43 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: speculate_about
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Robert Dober
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-01 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.10'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.10'
+date: 2022-01-22 00:00:00.000000000 Z
+dependencies: []
 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
@@ -47,6 +19,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - bin/speculate
+- lib/speculate_about.rb
 - lib/speculations.rb
 - lib/speculations/cli.rb
 - lib/speculations/parser.rb
@@ -63,7 +36,7 @@ homepage: https://github.com/robertdober/speculate
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -71,15 +44,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
-signing_key: 
+rubygems_version: 3.3.3
+signing_key:
 specification_version: 4
 summary: Extract RSpecs from Markdown
 test_files: []