futo-spec 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cd4211c90f029d68c7e7b1647d8956f7a5ab650404e49b0353afbd174ac2e41a
+  data.tar.gz: f190309bd7c5651f34cb148b8f543df54fbcc24ab1c48bcf197934c0f5fbca58
+SHA512:
+  metadata.gz: 8be475a8f8b8b1df8ccf73e34062cbaf471f5b82500f90289e01db8a6f6f96e87e1e591a772f150296936dcf34b0acd1ba48a29519a7b2c49a41118aaeb82569
+  data.tar.gz: 2fb890864d848a81f465d38be8f4a6ef0eb0f3bd6e837a7c703bf624ee50d01e57600f16e46fd2c7925d73dbf5785ec1eacc3d792fe1acdea4e2a86ef2597801

data/bin/futo

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require 'futo-spec'
+if ARGV.include? '--dry-run'
+  $dry_run = true
+  ARGV.delete('--dry-run')
+end
+
+fs = FutoSpec.new(ARGV[1])
+fs.run($dry_run)

data/lib/futo-spec.rb

@@ -0,0 +1,301 @@
+require 'paint/pa'
+require 'rspec/expectations'
+require 'find'
+require 'rspec'
+
+
+BULLET_POINTS_REGEX = /[\->]*/
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :should
+  end
+end
+
+
+class FutoBullet
+  attr_accessor :label, :associated_commands
+  def initialize(h)
+    @label = h
+    @associated_commands = Array.new
+  end
+  def to_s; return @label; end
+end
+
+class FutoCase
+  attr_accessor :description, :bullet_points
+  def initialize(h, b_arr)
+    @description = h
+    @bullet_points = b_arr
+  end
+  def to_s; return @description; end
+end
+
+class ChizuEntry
+  attr_accessor :kkey, :associated_commands
+  def initialize(h, c_arr)
+    @kkey = h
+    @associated_commands = c_arr
+  end
+  def to_s; return @kkey; end
+end
+
+class FutoSpec
+  include RSpec::Matchers
+  attr_accessor :cases, :chizu, :unmatched
+
+  def initialize(specified_file=nil)
+    @cases = Array.new
+    @chizu = Array.new
+    @unmatched = Array.new
+
+    test_case_lines = nil
+    unless specified_file
+      test_case_lines = discover_and_process_futo_files
+    else
+      test_case_lines = process_specific_file(specified_file)
+    end
+
+    look_for_envrb_and_parse
+    find_and_load_chizu_files
+    create_test_cases_and_load_bullet_points(test_case_lines)
+    load_commands_into_test_cases_from_chizu
+  end
+
+  def look_for_envrb_and_parse
+    if Dir.children("#{Dir.pwd}/futo-spec").include? '_glue'
+      if Dir.children("#{Dir.pwd}/futo-spec/_glue").include? 'env.rb'
+        puts 'found futo-spec/_glue/env.rb'
+        load 'futo-spec/_glue/env.rb'
+      end
+    end
+  end
+
+  def discover_and_process_futo_files
+    futo_files = []
+    test_case_lines = []
+
+    Find.find('./futo-spec/') do |ff|
+      if ff.end_with? '.futo' or ff.end_with? 'spec'
+        futo_files << ff
+      end
+    end
+
+    futo_files.each { |ff| test_case_lines += process_specific_file(ff) }
+    return test_case_lines
+  end
+
+  def specific_line_requested(desc)
+    spl = desc.split(':')
+    desc_file = spl.first
+    idx = spl.last.to_i - 1 # line numbers are 1-indexed
+
+    File.open(desc_file) do |file|
+      all_lines = file.readlines(chomp:true)
+      specified_line = all_lines[idx]
+      return specified_line
+    end
+  end
+
+  def process_specific_file(spec)
+    if spec.include? ':'
+      return specific_line_requested(spec)
+    else
+      File.open(spec) do |file|
+        file_lines = file.readlines(chomp:true)
+        return file_lines
+      end
+    end
+  end
+
+  def add_case_to_spec
+    @cases << FutoCase.new(@new_case_label, @new_case_bullets)
+  end
+
+  def begin_new_case
+    @new_case_label = ''
+    @new_case_bullets = Array.new
+  end
+
+  def new_bullet(line)
+    label = line.sub(BULLET_POINTS_REGEX, '').lstrip
+    #puts label
+    @new_case_bullets << FutoBullet.new(label)
+  end
+
+  def new_label(line)
+    @new_case_label = line
+  end
+
+  def is_newline?(line)
+    return line == ''
+  end
+
+  def is_initialize?(line)
+    return line.start_with?('** initialize with:') ||
+      line.start_with?('**')
+  end
+
+  def init_test(line)
+    prefix = line.split(':').last.lstrip
+    fn = "./initialize/#{prefix}.initialize.rb"
+    if File.exist?(fn)
+      load(fn)
+    else
+      pa "failed to find setup file #{fn} for line: #{line}", :red
+    end
+    puts
+  end
+
+  def is_bullet?(line)
+    return line.start_with?('-') || line.start_with?('>')
+  end
+
+  def create_test_cases_and_load_bullet_points(test_case_lines)
+    begin_new_case
+
+    test_case_lines.each do |line|
+      l0 = line.gsub('(DONE)','').gsub('(done)','')
+      ll = l0.lstrip.rstrip
+      if is_newline? ll
+        add_case_to_spec
+        begin_new_case
+      else
+        if is_initialize? ll
+          init_test(ll)
+        elsif is_bullet? ll
+          new_bullet(ll)
+        else
+          new_label(ll)
+        end
+      end
+    end
+
+    # catch anything left over
+    add_case_to_spec
+  end
+
+  def single_quoted_line?(line)
+    single = false
+    line.chars.each do |char|
+      if char == '"'
+        break
+      end
+      if char == "'"
+        single = true
+        break
+      end
+    end
+    return single
+  end
+
+  def find_and_load_chizu_files
+    chizu_files = []
+
+    Find.find('futo-spec/_glue/chizu/') do |ff|
+      chizu_files << ff if ff.end_with? 'chizu'
+      chizu_files << ff if ff.end_with? 'rb'
+    end
+
+    chizu_files.each {|ff| load_chizu ff}
+  end
+
+  def load_chizu(ff)
+    File.open(ff) do |file|
+      lines = file.readlines(chomp:true)
+      kkey = ''
+      commands = Array.new
+      lines.each do |ll|
+        using_single_quotes = single_quoted_line?(ll)
+        if ll.start_with? 'On'
+          if using_single_quotes
+            kkey = ll.split("'")[1]
+          else
+            kkey = ll.split('"')[1]
+          end
+        elsif ll.start_with? 'end'
+          @chizu << ChizuEntry.new(kkey, commands)
+          kkey = ''
+          commands = Array.new
+        elsif ll == "\n" || ll == ''
+          next
+        else
+          commands << ll.lstrip
+        end
+      end
+    end
+  end
+
+  def is_todo?(chizu)
+    if chizu.associated_commands.include?('# TODO') ||
+        chizu.associated_commands.include?('#TODO') ||
+        chizu.associated_commands.include?('TODO')
+      return true
+    else
+      return false
+    end
+  end
+
+  def load_commands_into_test_cases_from_chizu
+    @cases.each do |test_case|
+      test_case.bullet_points.each do |bullet|
+        matched = false
+        if @chizu.length == 0
+          # no chizus found, everything will be unmatched
+          @unmatched << bullet
+        else
+          @chizu.each do |chizu|
+            if is_todo? chizu
+              next
+            else
+              if bullet.label == chizu.kkey
+                matched = true
+                bullet.associated_commands = chizu.associated_commands
+              end
+            end
+          end
+          if ! matched
+            unless @unmatched.include? bullet
+              @unmatched << bullet
+            end
+          end
+        end
+      end
+    end
+  end
+
+  def output_unmatched_commands
+    puts
+    pa "Missing chizu entries:", :yellow
+    puts
+    @unmatched.each do |un|
+      pa "On '#{un.label}' do", :yellow
+      pa '  # TODO', :yellow
+      pa 'end', :yellow
+      puts
+    end
+  end
+
+  def run(dry_run=false)
+    exec_cases unless dry_run
+    output_unmatched_commands
+  end
+
+  def exec_cases
+    puts
+    @cases.each do |test_case|
+      test_case.bullet_points.each do |bullet|
+        #puts
+        pa "case: #{bullet.label}", :gray
+        bullet.associated_commands.each do |cmd|
+          pa cmd, :cyan if cmd != 'breakpoint'
+          begin
+            eval cmd
+          rescue RSpec::Expectations::ExpectationNotMetError => e
+            pa e, :red
+          end
+        end
+      end
+    end
+  end
+end

data/lib/spec/_glue/chizu/self.chizu

@@ -0,0 +1,39 @@
+On 'lines with bullets should map as a normal test case' do
+  puts "lines with bullets test case"
+end
+
+On 'lines without bullets should map as a test description' do
+  # TODO
+end
+
+On 'newlines \n should start a new case' do
+  # TODO
+end
+
+On 'when specific line requested with colon :, only specific line should run' do
+  # TODO
+end
+
+On 'if specific line is description not bullet point, all bullets in that case should run' do
+  # TODO
+end
+
+On 'what to do with long bullets or descriptions that have a <Cr for readability ?' do
+  # TODO
+end
+
+On 'unmatched description steps, should generate a sample chizu to copypaste' do
+  # TODO
+end
+
+On 'single quotes' do
+  # TODO
+end
+
+On 'double quotes' do
+  # TODO
+end
+
+On 'should be parsed as a test description *and* bullet' do
+  # TODO
+end

data/lib/spec/_glue/initialize/basics.setup.rb

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

data/lib/spec/basics.futo

@@ -0,0 +1,16 @@
+basic mapping
+** initialize with: basics **
+- lines with bullets should map as a normal test case
+- lines without bullets should map as a test description
+- newlines \n should start a new case
+
+specific line
+- when specific line requested with colon :, only specific line should run
+- if specific line is description not bullet point, all bullets in that case should run
+
+wrapped / long lines
+- what to do with long bullets or descriptions that have a <Cr> for readability ?
+
+state
+- lines starting with "** using setup:" load state for the whole file
+- will need levels of scope for this

data/lib/spec/edge_cases.futo

@@ -0,0 +1,17 @@
+missing / unmatched steps
+- unmatched description steps, should generate a sample chizu to copy-paste
+
+single vs double quotes
+- single quotes
+- double quotes
+
+test point with only one line, without a bullet -
+
+desc file which starts with a blank line
+
+single lines which start with a dash -
+- should be parsed as a test description *and* bullet
+
+unmatched should work properly
+- matched should not appear in unmatched output
+- see commit :2087519 for the fix; an indentation problem caused a bug

data/lib/spec/rspec.futo

@@ -0,0 +1,4 @@
+check should syntax
+- author personally prefers should
+- others erroneously prefer expect.to
+-> should probably expect to handle both.

data/lib/spec/todos.futo

@@ -0,0 +1,3 @@
+variable scoping
+- local variable scoping / local to a block in a chizu step
+- @ and $ already work

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: futo-spec
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- Sean Felipe Wolfe
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-09-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: paint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: apparition
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: webdrivers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec-expectations
+  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'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+description: Write your test notes in bullet point format, then map to test engine
+  actions. Like Cucumber, but * - >  instead of Gherkin.
+email: sean@addlightness.tech
+executables:
+- futo
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/futo
+- lib/futo-spec.rb
+- lib/spec/_glue/chizu/self.chizu
+- lib/spec/_glue/initialize/basics.setup.rb
+- lib/spec/basics.futo
+- lib/spec/edge_cases.futo
+- lib/spec/rspec.futo
+- lib/spec/todos.futo
+homepage: https://rubygems.org/gems/futo-spec
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Test engine using bullet points. Like you're writing on an envelope.
+test_files: []