futo-spec 0.4.2 → 0.4.99.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 48d8df4da9a931c852aae9634f50935faf9ca0cb0b7a2710cd84e1aa2d4324a4
-  data.tar.gz: b6b77baf4d97717ca952d68b4990a1dbfe6f386788aaad15e3d96676be2d538e
+  metadata.gz: '014822bd29f154dddac018ec8d3ec88e5ab3f41946ae5dd18bd5a1913adcde02'
+  data.tar.gz: 9845a20cdada8b9d5d438ff8310c1f84ea1bb6527803cbf080101812f3e888cc
 SHA512:
-  metadata.gz: f0cf9e38aef828267575780c27d53629ae3f719ba90882f44582594edee317721ef4b6dc516363f2b3a6e1bc0a6b3cc343ff3b87b6f3aa687cfb25e2c267d82f
-  data.tar.gz: 65ed1cd537b0550fcfd4087e40ff78d3eeed8a276a764ff9275131a4be38e39258015379b7adbf15e8366bdd6ff29fe4070d9af266c1568a87794cf2dfa7b0c6
+  metadata.gz: c0dd84772c65f807ea39411c2c88572ba01c601b342aa074d9d7498a3aa118a7aa3c3d6c0baf52c5d9437b7f2f0d3c698acf1d22dd37fb17a5813170720144e7
+  data.tar.gz: 8e42690d846e3278b745c31f3da3364f42492d98175906b1ce6d90168833a2ac73bea023b508844cecf11affa9b0c2770b83dc7d09cdb7feb004a023087a327c

data/bin/futo

@@ -1,40 +1,58 @@
 #!/usr/bin/env ruby_executeable_hooks
 require 'fileutils'
 require 'futo-spec'
+require 'paint/pa'
 
-output_version_only = false
-opts = {}
+opts = Set.new
 
 def futo_init_directories
-  FileUtils.mkdir_p("#{Dir.pwd}/futo/chizus")
-  FileUtils.mkdir("#{Dir.pwd}/futo/_glue")
+  dirs = ['chizus/shared','_glue']
+  dirs.each do |dd|
+    FileUtils.mkdir_p("#{Dir.pwd}/futo/#{dd}")
+  end
+  File.new("#{Dir.pwd}/futo/_glue/env.rb", "w")
 end
 
+def check_debug_envvar
+  if ENV.has_key?('DEBUG') && ENV['DEBUG'] == 'true'
+    $debug = true
+  end
+end
+
+exec_cases = true
+
 ARGV.each do |arg|
-  if arg == '-d' || arg == '--dry-run'
-    opts.store(:dry, true)
-  elsif arg == '-md' || arg == '--markdown'
-    opts.store(:markdown, true)
+  if arg == '--init'
+    exec_cases = false
+    pa 'setting futo directories ...', :yellow, :bright
+    futo_init_directories
+    pa 'init complete.', :yellow
   elsif arg == '-v' || arg == '--version'
-    output_version_only = true
+    exec_cases = false
     puts Gem.loaded_specs['futo-spec'].version
-  elsif arg == '--init'
-    futo_init_directories
+  elsif arg == '-D' || arg == '--debug'
+    $debug = true
+  elsif arg == '-d' || arg == '--dry-run'
+    opts << :dry_run
+  elsif arg == '-md' || arg == '--markdown'
+    opts << :markdown
   elsif arg == '-h' || arg == '--headless'
-    opts.store(:headless, true)
-  elsif arg == '-v' || arg == '--version'
-    output_version_only = true
+    opts << :headless
   elsif arg.end_with? '.futo'
-    opts.store(:specified_file, arg)
+    opts << :specified_file
+    $specified_file = arg
   elsif arg.include? ':'
-    opts.store(:specified_line, arg)
+    opts << :specified_line
   elsif not arg.start_with? '-'
     # support passing a file name without having to type .futo
-    opts.store(:specified_file, "#{arg}.futo")
+    opts << :specified_file
+    $specified_file = "#{arg}.futo"
   end
 end
 
-unless output_version_only
+if exec_cases
+  puts
+  check_debug_envvar
   fs = FutoSpec.new(opts)
   fs.run
 end

data/lib/context_breakpoint.rb

@@ -0,0 +1,13 @@
+class BreakpointContext
+  def initialize(bind)
+    @local_vars = bind.local_variable_get(:local_vars)
+  end
+  def method_missing(symbol, *args)
+    if @local_vars.include? symbol.to_s
+      @local_vars[symbol.to_s]
+    end
+  end
+  def contextual_breakpoint
+    breakpoint
+  end
+end

data/lib/futo-spec.rb

@@ -1,13 +1,29 @@
-require 'byebug'; alias :breakpoint :byebug
+require 'set'
 require 'find'
+require 'byebug'; alias :breakpoint :byebug
 require 'paint/pa'
 require 'rspec/expectations'
 require 'rspec'
+require 'whirly'
 require_relative './markdown_generator'
+require_relative './context_breakpoint'
 
 
 BULLET_POINTS_REGEX = /[\->]*/
 
+COLORS = {
+  init:     :gray,
+  setup:    :gray,
+  debug:    :gray,
+  log:      :yellow,
+  exec:     :yellow,
+  support:  'cornflower blue',
+  out:      'dark khaki',
+  warning:  'coral',
+  missing:  :yellow,
+  error:    :red,
+}
+
 RSpec.configure do |config|
   config.expect_with :rspec do |c|
     c.syntax = :should
@@ -16,11 +32,11 @@ end
 
 def logd(msg, *colors)
   if $debug
-    unless colors
-      puts msg
+    unless colors.length > 0
+      pa msg, COLORS[:debug]
     else
       if colors.first == :bb
-        pa msg, :yellow, :bright
+        pa msg, COLORS[:debug], :bright
       else
         pa msg, *colors
       end
@@ -29,6 +45,10 @@ def logd(msg, *colors)
 end
 alias :dpa :logd
 
+def pout(msg)
+  pa msg, COLORS[:out]
+end
+
 class FutoBullet
   attr_accessor :label, :associated_commands
   def initialize(h)
@@ -72,69 +92,56 @@ class FutoSpec
   include RSpec::Matchers
   attr_accessor :cases, :chizu, :unmatched, :included_ins
 
-  def check_and_set_debug
-    if ENV.has_key? 'DEBUG'
-      if ENV.fetch('DEBUG') == 'true'
-        $debug = true
-      end
-    end
-  end
-
   def initialize(opts={})
+    Whirly.configure spinner: "dots"
+    Whirly.configure append_newline: false
+    Whirly.configure color: false
+
     @cases = Array.new
-    @chizu_array = Array.new
-    @unmatched = Array.new
+    @chizu_files = Array.new
+    @chizus = Array.new
+    @unmatched = Set.new
     @included_ins = Array.new
 
-    check_and_set_debug
-
-    if opts.include? :dry
-      $dry_run = true if opts[:dry]
-      pa 'dry run', :gray
+    if $debug
+      dpa '-- debug mode --'
+      puts
     end
 
-    if opts.include? :markdown
-      $markdown = true if opts[:markdown]
-      pa 'markdown mode', :gray, :bright
+    if opts.include? :dry_run
+      $dry_run = true
+      pa 'dry run', COLORS[:init], :bright
     end
 
-    if opts.include? :headless
-      $headless = true if opts[:headless]
+    if opts.include? :specified_file
+      dpa "specified file: #{$specified_file}"
     end
 
-    if opts.include? :specified_line
-      puts "line specified: #{opts.fetch(:specified_line)}"
-      specified_line = opts.fetch(:specified_line)
-    elsif opts.include? :specified_file
-      puts "specific file requested: #{opts.fetch(:specified_file)}"
-      specified_file = opts.fetch(:specified_file)
+    if opts.include? :headless
+      $headless = true
+      dpa 'headless mode'
     end
 
-    if $markdown
-      unless specified_file
-        raise ArgumentError, "please specify a file when using --markdown option."
-      else
-        test_case_lines = process_specific_file(specified_file)
-        generate_markdown_and_print(test_case_lines)
-        pa 'finished markdown.', :gray, :bright
-      end
+    if opts.include? :markdown
+      markdown_only
     else
       look_for_envrb_and_parse
-      find_and_load_chizu_files
-
-      if specified_line
-        test_case_lines = process_specific_line(specified_line)
-        dpa "line specified: #{specified_line} test case lines: #{test_case_lines}", :red
-      elsif specified_file
-        test_case_lines = process_specific_file(specified_file)
-      else
-        test_case_lines = discover_and_process_spec_files
-      end
-
+      test_case_lines = process_specified_file
       create_test_cases(test_case_lines)
-      dpa "test cases loaded: #{@cases.length}", :bb
+      find_matching_chizu_files
+      process_chizu_files
+      match_cases_to_chizus
+    end
+  end
 
-      match_chizus_to_test_cases
+  def markdown_only
+    pa 'markdown mode', COLORS[:init], :bright
+    unless $specified_file
+      raise ArgumentError, "please specify a file when using --markdown option."
+    else
+      test_case_lines = process_specified_file
+      generate_markdown_and_print(test_case_lines)
+      pa 'finished markdown.', COLORS[:init]
     end
   end
 
@@ -142,7 +149,7 @@ class FutoSpec
     if Dir.children(Dir.pwd).include? 'futo'
       if Dir.children("#{Dir.pwd}/futo").include? '_glue'
         if Dir.children("#{Dir.pwd}/futo/_glue").include? 'env.rb'
-          dpa 'found futo/_glue/env.rb', :gray
+          dpa 'found futo/_glue/env.rb', COLORS[:init]
           load 'futo/_glue/env.rb'
         end
       end
@@ -150,7 +157,7 @@ class FutoSpec
   end
 
   def discover_and_process_spec_files
-    dpa "no file specified, discovering all .futo or .spec files ...", :yellow, :bright
+    dpa "no file specified, discovering all .futo or .spec files ...", COLORS[:init], :bright
     futo_files = []
     test_case_lines = []
 
@@ -165,11 +172,13 @@ class FutoSpec
     return test_case_lines
   end
 
-  def process_specific_file(fn)
-    dpa "process_specific_file: #{fn}", :yellow
-    path = "futo/#{fn}"
+  def process_specified_file
+    dpa "process_specified_file: #{$specified_file}"
+    path = "futo/#{$specified_file}"
     File.open(path) do |file|
       file_lines = file.readlines(chomp:true)
+      # add one blank line to facilitate saving the last test case
+      file_lines << ''
       return file_lines
     end
   end
@@ -214,7 +223,11 @@ class FutoSpec
   end
 
   def add_case_to_spec
-    @cases << FutoCase.new(@new_case_label, @new_case_bullets)
+    # don't add the last test case
+    unless @new_case_label == ''
+      dpa "adding new test case: #{@new_case_label}"
+      @cases << FutoCase.new(@new_case_label, @new_case_bullets)
+    end
   end
 
   def begin_new_case
@@ -271,7 +284,7 @@ class FutoSpec
     if File.exist?(fn)
       load(fn)
     else
-      pa "failed to find setup file #{fn} for line: #{line}", :red
+      pa "failed to find setup file #{fn} for line: #{line}", COLORS[:red]
     end
     puts
   end
@@ -283,29 +296,29 @@ class FutoSpec
       l0 = line.gsub('(DONE)','').gsub('(done)','')
       ll = l0.lstrip.rstrip
       if is_newline? ll
-        dpa "found newline: #{ll}", :yellow
+        dpa "found newline: #{ll}, saving existing case and starting a new one"
         add_case_to_spec
         begin_new_case
       else
         if is_mock_data? ll
-          dpa "found mock data: #{ll}", :yellow
+          dpa "found mock data: #{ll}", COLORS[:setup]
           load_mock_data(ll)
         elsif is_bullet? ll
-          dpa "found bullet: #{ll}", :yellow
+          dpa "found bullet: #{ll}", COLORS[:setup]
           new_bullet(ll)
         elsif is_asterisk? ll
-          dpa "found asterisk, treating as description: #{ll}", :yellow
+          dpa "found asterisk, treating as description: #{ll}", COLORS[:setup]
           label = ll.gsub('*', '').lstrip
           new_label(label)
         elsif is_description? ll
-          dpa "found new description: #{ll}", :yellow
+          dpa "found new description: #{ll}", COLORS[:setup]
           new_label(ll)
         else
-          raise RuntimeError, "could not find entry type for string #{ll}"
+          raise RuntimeError, "could not find matching chizu entry type for: #{ll}"
         end
       end
+      dpa "test cases loaded: #{@cases.length}"
     end
-
     # catch anything left over
     add_case_to_spec
   end
@@ -324,28 +337,37 @@ class FutoSpec
     return single
   end
 
-  def find_and_load_chizu_files
-    chizu_files = []
-    search_dir = "#{Dir.pwd}/futo/chizus"
-    Find.find(search_dir) do |ff|
-      chizu_files << ff if ff.end_with? '.chizu'
-      chizu_files << ff if ff.end_with? '.rb'
+  def find_matching_chizu_files
+    without_suffix = $specified_file.chomp('.futo')
+    base = "#{Dir.pwd}/futo/chizus"
+    path = "#{base}/#{without_suffix}.chizu"
+    unless File.exist? path
+      pa "#{$specified_file}: couldn't find matching .chizu file", COLORS[:warning]
+    else
+      dpa "loading matching #{$specified_file}.chizu ...", COLORS[:setup]
+      @chizu_files << path
     end
 
-    dpa "loading chizu ...", :yellow, :bright
-    chizu_files.each {|ff| load_chizu_commands ff}
-    dpa "chizu load complete, files below:", :yellow
-    @chizu_array.each do |cc|
-      dpa "- #{cc} -", :yellow
-      dpa "commands: #{cc.associated_commands}", :yellow
+    search_dir = "#{base}/shared"
+    dpa "loading shared chizus ...", COLORS[:setup]
+    Find.find(search_dir) do |ff|
+      if ff.end_with? 'chizu'
+        dpa "loading #{ff}"
+        @chizu_files << ff
+      end
     end
   end
 
+  def process_chizu_files
+    @chizu_files.each {|ff| load_chizu_commands ff}
+  end
+
   def add_new_chizu(kkey, commands)
-    @chizu_array << ChizuEntry.new(kkey, commands)
+    @chizus << ChizuEntry.new(kkey, commands)
   end
 
   def load_chizu_commands(ff)
+    dpa "loading chizu commands from file: #{ff}"
     File.open(ff) do |file|
       lines = file.readlines(chomp:true)
       kkey = ''
@@ -393,8 +415,7 @@ class FutoSpec
           elsif ll == "\n" || ll == ''
             next
           else
-            breakpoint
-            puts
+            pa "encountered unexpected line: #{ll}", :red, :bright
           end
         end
       end
@@ -415,16 +436,15 @@ class FutoSpec
     end
   end
 
-  #def load_commands_into_test_cases_from_chizu
-  def match_chizus_to_test_cases
-    if @chizu_array.length == 0
+  def match_cases_to_chizus
+    if @chizus.length == 0
       set_all_unmatched
     else
       @cases.each_with_index do |test_case, tc_index|
         test_case.bullet_points.each do |bullet|
           dpa "matching bullet: #{bullet}", :bb
           matched = false
-          @chizu_array.each do |chizu|
+          @chizus.each do |chizu|
             if process_bullet_chizu_match(bullet, chizu)
               bullet.associated_commands = chizu.associated_commands
               matched = true
@@ -434,7 +454,7 @@ class FutoSpec
           dpa "matched? #{bullet.label} : #{matched}", :bb
           if ! matched
             unless @unmatched.include? bullet.label
-              dpa "couldn't find a match for #{bullet.label}", :red
+              dpa "couldn't find a match for #{bullet.label}", COLORS[:error]
               @unmatched << bullet.label
             end
           end
@@ -445,57 +465,85 @@ class FutoSpec
 
   def process_bullet_chizu_match(bullet, chizu)
     matched = false
-    dpa "chizu: #{chizu.kkey}", :yellow
+    dpa "chizu: #{chizu.kkey}", COLORS[:init]
     if is_todo? chizu
-      #logd "found todo: #{chizu}", :yellow
+      logd "found todo: #{chizu}", COLORS[:init]
       # todos aren't considered completed so they are unmatched
     elsif is_included_in? chizu
-      #logd "found included_in: #{chizu}", :yellow
+      #logd "found included_in: #{chizu}", COLORS[:init]
       @included_ins << chizu
     else
       if bullet.label == chizu.kkey
-        logd "matched: #{bullet.label} #{chizu.kkey}", :blue
         matched = true
       end
     end
     return matched
   end
 
-  def output_unmatched_commands
-    puts
-    pa "Missing chizu entries:", :yellow
-    puts
-    @unmatched.each do |label|
-      pa "On '#{label}' do", :yellow
-      pa '  # TODO', :yellow
-      pa 'end', :yellow
-      puts
-    end
-  end
-
   def run
     exec_cases unless $dry_run
     output_unmatched_commands if @unmatched.length > 0
   end
 
+  def breakpoint_with_local_vars(local_vars)
+    bind = binding
+    bind.local_variable_set(:ish, '555')
+    eval('breakpoint; puts "ishly: #{ish}"', bind).binding
+    puts
+  end
+
+
   def run_commands_in_block_context(bullet)
+    local_vars = {}
     bullet.associated_commands.each do |cmd|
-      pa cmd, :cyan if cmd != 'breakpoint'
       begin
-        binding = eval(cmd, binding)
+        pa "  #{cmd}", COLORS[:support] if cmd != 'breakpoint' # agb ignore
+        bind = binding
+        local_vars.each_pair do |kk, vv|
+          bind.local_variable_set(kk, vv)
+        end
+        unless cmd == 'breakpoint'
+          result = bind.eval(cmd)
+        else
+          c = BreakpointContext.new(bind)
+          c.contextual_breakpoint
+        end
+        dpa "result: #{result}"
+        if cmd.include? '='
+          new_var = cmd.split('=').first.rstrip
+          local_vars.store(new_var, result)
+        end
       rescue RSpec::Expectations::ExpectationNotMetError => e
-        pa e, :red
+        pa e, COLORS[:error], :bright
+        raise e
       end
     end
   end
 
   def exec_cases
-    puts
+    puts; puts
     @cases.each do |test_case|
-      pa "case: #{test_case.description}", :gray
+      title = "case: #{test_case.description}"
+      pa "\u22EF" * ( title.length + 5 ), COLORS[:exec]
+      pa "  case: #{test_case.description}", COLORS[:exec], :bright
+      puts
       test_case.bullet_points.each do |bullet|
+        pa "\u229A #{bullet}", COLORS[:exec]
         run_commands_in_block_context(bullet)
       end
     end
+    puts; puts; puts
+  end
+
+  def output_unmatched_commands
+    puts
+    pa "Missing chizu entries:", COLORS[:missing], :bright
+    puts
+    @unmatched.each do |label|
+      pa "On '#{label}' do", COLORS[:missing]
+      pa '  # TODO', COLORS[:missing]
+      pa 'end', COLORS[:missing]
+      puts
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: futo-spec
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.99.1
 platform: ruby
 authors:
 - Sean Felipe Wolfe
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-21 00:00:00.000000000 Z
+date: 2021-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: paint
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: whirly
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -59,7 +73,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '11.1'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -75,10 +89,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - bin/futo
-- lib/exec_block_context.rb
+- lib/context_breakpoint.rb
 - lib/futo-spec.rb
-- lib/futo-spec/futo_logger.rb
-- lib/futo-spec/self-test/futo/_glue/mocks/basics.setup.rb
 - lib/markdown_generator.rb
 homepage: https://rubygems.org/gems/futo-spec
 licenses:

data/lib/exec_block_context.rb

@@ -1,6 +0,0 @@
-class BlockContext
-  attr_accessor :vars
-  def initialize
-    @vars = []
-  end
-end

data/lib/futo-spec/futo_logger.rb

@@ -1,13 +0,0 @@
-require 'paint/pa'
-
-def logd(msg, color=nil)
-  if ENV.has_key? 'DEBUG'
-    if ENV.fetch('DEBUG') == 'true'
-      unless color
-        puts msg
-      else
-        pa msg, color
-      end
-    end
-  end
-end

data/lib/futo-spec/self-test/futo/_glue/mocks/basics.setup.rb

@@ -1,2 +0,0 @@
-$foo = 'bar'
-BAZ = 'ish'