markdown_exec 3.5.0 → 3.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a4c6bcbb464222e907cb93cc549ef294d45b83f0f8be5e88e603b87c64eb7a4
-  data.tar.gz: dfce2b71eb6c954e3d438b6036b6543da7bcfe63178ca56971ddb198f49852db
+  metadata.gz: 6becba5a0ff94fb60399da0fc99248fff83905def9c65e4a8e1ae9c597652036
+  data.tar.gz: 98f0d4ad3764fec26b4ed8f1bce1904af1f350853b3e2678847f0557b381e8bf
 SHA512:
-  metadata.gz: c7b2076de902483e3f2362b8319d99f1876c7f41e7ffd1815e92278803d55776f700df721dc16700064c890c7c48628657ef2bf4003ba989b7c6eee1c27a9088
-  data.tar.gz: ed8705a9687dc56cbef235fe0821065653852d5b1e1c05293a9ea53baf08a7a12c24fdc5e909e9dd04047378d664ddb0b8e7d644e38d54c753ef1a470138ce60
+  metadata.gz: b2d1d60bcf1fe258a8be76893b070ab418563e27923c9e8a4370cd04fa5e0d421732c3c51e76e596a5d492885170270437916035530f64ba2e99a98d215bd908
+  data.tar.gz: 306d802cfcfc5bfa9460e2d58a69ac4f9ac0c058a28859243a237682d2622549277ff6f8515f84c51b2a2ede229c3f95eaa9a0ce5b9dbde98bfc2ad862c9aa8f

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## [3.5.1] - 2025-11-14
+
+### Added
+
+- Docker testing environment.
+
+### Changed
+
+- Correct tests for Docker environment.
+- Uses env split mode to parse the shell command.
+
 ## [3.5.0] - 2025-11-13
 
 ### Added

data/Dockerfile.test

@@ -0,0 +1,42 @@
+FROM ruby:3.3-bookworm
+
+ENV LANG C.UTF-8
+
+RUN apt-get update && apt-get install -y --no-install-recommends \
+        build-essential \
+        bsdmainutils \
+        gawk \
+        git \
+        tree \
+        vim
+
+# `markdown_exec` is the name expected by some BATS tests
+WORKDIR /markdown_exec
+
+# Clone the repository (shallow clone for faster builds)
+ARG GIT_BRANCH=main
+RUN git clone --depth 1 --branch ${GIT_BRANCH} https://github.com/fareedst/markdown_exec.git .
+
+# Initialize and update git submodules
+RUN git submodule update --init --recursive
+
+# Install dependencies
+RUN bundle install
+
+# Add aliases
+RUN echo 'alias batsv="bats --verbose-run --show-output-of-passing-tests"' >> ~/.bashrc && \
+    echo 'alias be="bundle exec"' >> ~/.bashrc && \
+    echo 'alias bmde="bin/bmde"' >> ~/.bashrc && \
+    echo 'alias ll="ls -FGlAhp"' >> ~/.bashrc
+
+RUN git submodule add https://github.com/bats-core/bats-core.git test/bats && \
+    git submodule add https://github.com/bats-core/bats-support.git test/test_helper/bats-support && \
+    git submodule add https://github.com/bats-core/bats-assert.git test/test_helper/bats-assert
+
+# make dirs, file for BATS tests
+RUN mkdir -p logs
+RUN mkdir -p docs/research
+RUN echo '04:31 e' > logs/mde_site.local_2024-07-31-20-04-01___examples_save_md_~_test_.out.txt
+RUN ln -s /markdown_exec/test/bats/bin/bats /usr/local/bin/
+
+CMD ["bash"]

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    markdown_exec (3.5.0)
+    markdown_exec (3.5.1)
       clipboard (~> 1.3.6)
       open3 (~> 0.1.1)
       optparse (~> 0.1.1)
@@ -107,6 +107,8 @@ GEM
     mocha (2.4.5)
       ruby2_keywords (>= 0.0.5)
     mutex_m (0.2.0)
+    nokogiri (1.16.6-aarch64-linux)
+      racc (~> 1.4)
     nokogiri (1.16.6-arm64-darwin)
       racc (~> 1.4)
     open3 (0.1.2)
@@ -224,6 +226,7 @@ GEM
     zeitwerk (2.6.16)
 
 PLATFORMS
+  aarch64-linux
   arm64-darwin-21
 
 DEPENDENCIES

data/README.md

@@ -269,36 +269,7 @@ mde --save-executed-script 1 --user-must-approve 1 --config my-config.yml
 
 ## Tab Completion
 
-### Install tab completion
-
-Append a command to load the completion script to your shell configuration file. `mde` must be executable for the command to be composed correctly.
-
-```bash
-echo "source $(mde --pwd)/bin/tab_completion.sh" >> ~/.bash_profile
-```
-
-### Behavior
-
-Press tab for completions appropriate to the current input.
-`mde <...> <prior word> <current word><TAB>`
-
-Completions are calculated based on the current word and the prior word. 
-1. If the current word starts with `-`, present matching options, eg `--version` for the current word `--v`.
-2. Else, if the current word is empty and the prior word is an option that takes an argument, present the type of the argument, eg `.BOOL.` for the option `--user-must-approve`.
-3. Else, if the current word is the type of argument, from the rule above, present the default value for the option. e.g. `1` for the type `.BOOL.` for the option `--user-must-approve`.
-4. Else, if the current word is non-empty, list matching files and folders.
-
-### Example Completions
-
-In the table below, tab is indicated by `!`
-| Input | Completions |
-| :--- | :--- |
-| `mde !` | local files and folders |
-| `mde -!` | all options |
-| `mde --!` | all options |
-| `mde --v!` | `mde --version` |
-| `mde --user-must-approve !` | `mde --user-must-approve .BOOL.`|
-| `mde --user-must-approve .BOOL.!` | `mde --user-must-approve 1` |
+See [Tab Completion Documentation](docs/tab-completion.md) for installation and usage instructions.
 
 ## Example: Interactive Workflow
 
@@ -351,7 +322,29 @@ vars:
 
 # Testing
 
-Execute tests for individual libraries.
+## Docker Testing Environment
+
+For a complete testing environment with all dependencies, use the Docker testing container:
+
+```bash
+# Build the test environment
+docker build -f Dockerfile.test -t markdown-exec-test .
+
+# Run all tests (RSpec, Minitest, and BATS)
+docker run -it markdown-exec-test bash -c 'bundle exec rake test'
+
+# Run individual test suites
+docker run -it markdown-exec-test bash -c 'bundle exec rspec'          # RSpec only
+docker run -it markdown-exec-test bash -c 'bundle exec rake minitest'  # Minitest only
+docker run -it markdown-exec-test bash -c 'bundle exec rake bats'      # BATS tests only
+
+# Enter the container interactively
+docker run --rm -it markdown-exec-test bash
+```
+
+## Local Testing
+
+Execute tests for individual libraries locally:
 
 `bundle exec rake minitest`
 

data/Rakefile

@@ -77,25 +77,25 @@ end
 def execute_with_error_handling(iterator)
   all_error_level = 0
   all_failed_files = []
-  
+
   iterator.each do |item|
     command = yield(item)
     next unless command # Skip if command is nil
-    
-    result = system(command)
+
+    system(command)
     error_level = $?.exitstatus
 
-    if error_level != 0
-      puts "Error: Command '#{command}' failed with exit status #{error_level}."
-      all_error_level = error_level
-      all_failed_files << command
-    end
-  end
+    next unless error_level != 0
 
-  if all_error_level != 0
-    puts "Error: #{all_failed_files.join(', ')} failed."
-    exit all_error_level
+    puts "Error: Command '#{command}' failed with exit status #{error_level}."
+    all_error_level = error_level
+    all_failed_files << command
   end
+
+  return unless all_error_level != 0
+
+  puts "Error: #{all_failed_files.join(', ')} failed."
+  exit all_error_level
 end
 
 desc 'bats'
@@ -114,20 +114,28 @@ task :listtests do
   puts `find lib -name '*.rb' -type f | xargs grep '< Minitest::Test' -l | sort`
 end
 
-desc 'minitest'
-task :minitest do
-  commands = [
-    './lib/argument_processor.rb --verbose',
-    './lib/block_label.rb --verbose',
-    './lib/cached_nested_file_reader.rb --verbose',
-    './lib/collapser.rb --verbose',
+def dev_test_commands
+  dev_dir = File.join(__dir__, 'lib', 'dev')
+  return [] unless Dir.exist?(dev_dir)
+
+  [
     './lib/dev/ansi_codes.rb --verbose',
     './lib/dev/append_to_bash_history.rb --verbose',
     './lib/dev/generate_transition_codes.rb --verbose',
     './lib/dev/hierarchy.rb --verbose',
     './lib/dev/process_command.rb --verbose',
     './lib/dev/process_template.rb --test --verbose',
-    './lib/dev/visibility-controller.rb --verbose',
+    './lib/dev/visibility-controller.rb --verbose'
+  ]
+end
+
+desc 'minitest'
+task :minitest do
+  commands = dev_test_commands + [
+    './lib/argument_processor.rb --verbose',
+    './lib/block_label.rb --verbose',
+    './lib/cached_nested_file_reader.rb --verbose',
+    './lib/collapser.rb --verbose',
     './lib/directory_searcher.rb --verbose',
     './lib/evaluate_shell_expressions.rb --verbose',
     './lib/fcb.rb --verbose',
@@ -164,26 +172,26 @@ end
 desc 'test'
 task :test do
   success = true
-  
+
   # Run all tests and track failures
   rspec_success = system('bundle exec rspec')
   success = false unless rspec_success
-  
+
   Rake::Task['minitest'].invoke
   minitest_success = $?.success?
   success = false unless minitest_success
-  
+
   Rake::Task['bats'].invoke
   bats_success = $?.success?
   success = false unless bats_success
-  
+
   # Report failures and exit with non-zero status if any test failed
   unless success
     failed_tests = []
     failed_tests << 'RSpec' unless rspec_success
     failed_tests << 'Minitest' unless minitest_success
     failed_tests << 'Bats' unless bats_success
-    
+
     puts "\nThe following test suites failed: #{failed_tests.join(', ')}"
     exit 1
   end
@@ -213,7 +221,7 @@ task :update_menu_yml do
   File.write(MENU_YML, menu_options.to_yaml)
   puts `stat #{MENU_YML}`
 end
-task :menu => 'update_menu_yml'
+task menu: 'update_menu_yml'
 
 # write tab_completion.sh with erb
 #

data/bats/block-type-ux-echo.bats

@@ -16,5 +16,5 @@ load 'test_helper'
 @test 'selected block - output of wc includes whitespace' {
   spec_mde_xansi_dname_doc_blocks_expect docs/dev/block-type-ux-echo.md \
    '(VAR_has_count)' '[IAB_has_count]' \
-   'VAR=      14_IAB=      14      14'
+   'VAR=mmaarrkkddoowwnn__eexxeecc_IAB=mmaarrkkddoowwnn__eexxeeccmmaarrkkddoowwnn__eexxeecc'
 }

data/bin/bmde

@@ -1,4 +1,4 @@
-#!/usr/bin/env bundle exec ruby
+#!/usr/bin/env -S bundle exec ruby
 # frozen_string_literal: true
 
 # encoding=utf-8

data/docs/dev/block-type-ux-echo.md

@@ -10,7 +10,8 @@ menu_with_inherited_lines: true
 / This block is not visible. Execute to set a new value, displayed by the block above.
 ```ux :(VAR_has_count)
 init: false
-echo: $(basename `pwd` | wc -c)
+echo: >-
+  $(basename `pwd` | sed 's/./&&/g')
 force: false
 name: VAR
 ```

data/docs/docker-testing.md

@@ -0,0 +1,115 @@
+# Docker Testing Environment
+
+This document describes how to use the Docker testing environment for `markdown_exec`.
+
+## Overview
+
+The `Dockerfile.ruby-3.3-spec` provides a complete testing environment with:
+- Ruby 3.3 on Debian Bookworm
+- All build dependencies
+- Git submodules initialized (BATS testing framework)
+- Development tools and aliases
+- Pre-configured BATS test setup
+
+## Building the Image
+
+```bash
+docker build -f Dockerfile.test -t markdown-exec-test .
+```
+
+You can specify a different Git branch to test:
+
+```bash
+docker build -f Dockerfile.test --build-arg GIT_BRANCH=develop -t markdown-exec-test .
+```
+
+## Running Tests
+
+### Run all BATS tests
+
+```bash
+docker run --rm markdown-exec-test bats test/
+```
+
+### Run specific test file
+
+```bash
+docker run --rm markdown-exec-test bats test/options.bats
+```
+
+### Run with verbose output
+
+```bash
+docker run --rm markdown-exec-test batsv test/
+```
+
+The container includes the `batsv` alias for verbose BATS output.
+
+## Interactive Development
+
+### Enter the container interactively
+
+```bash
+docker run --rm -it markdown-exec-test bash
+```
+
+Once inside, you have access to:
+- `bats` - BATS test runner (available in PATH)
+- `batsv` - Verbose BATS runner (alias)
+- `be` - Bundle exec alias
+- `bmde` - Bin/bmde alias
+- `ll` - Enhanced ls alias
+
+### Mount local directory for development
+
+To work with your local code changes:
+
+```bash
+docker run --rm -it -v "$(pwd)":/markdown_exec markdown-exec-test bash
+```
+
+**Note:** The container clones the repo by default. When mounting your local directory, you may need to adjust paths or rebuild dependencies.
+
+## Running Minitest
+
+```bash
+docker run --rm markdown-exec-test bundle exec rake minitest
+```
+
+## Container Details
+
+- **Working Directory**: `/markdown_exec`
+- **Base Image**: `ruby:3.3-bookworm`
+- **BATS Location**: `/markdown_exec/test/bats/bin/bats` (symlinked to `/usr/local/bin/bats`)
+- **Test Helpers**: Located in `/markdown_exec/test/test_helper/`
+
+## Troubleshooting
+
+### Submodules not initialized
+
+If you encounter issues with BATS submodules, the Dockerfile should handle this automatically. If problems persist:
+
+```bash
+docker run --rm -it markdown-exec-test bash
+cd /markdown_exec
+git submodule update --init --recursive
+```
+
+### Missing test files
+
+The container creates required directories and test files. If tests fail due to missing files, check that the Dockerfile build completed successfully.
+
+### Running tests with local changes
+
+For testing local changes without rebuilding:
+
+1. Build the base image once
+2. Use volume mounting to overlay your local code
+3. Re-run bundle install if dependencies changed:
+
+```bash
+docker run --rm -it -v "$(pwd)":/markdown_exec markdown-exec-test bash
+bundle install
+bats test/
+```
+

data/docs/tab-completion.md

@@ -0,0 +1,33 @@
+# Tab Completion
+
+## Install tab completion
+
+Append a command to load the completion script to your shell configuration file. `mde` must be executable for the command to be composed correctly.
+
+```bash
+echo "source $(mde --pwd)/bin/tab_completion.sh" >> ~/.bash_profile
+```
+
+## Behavior
+
+Press tab for completions appropriate to the current input.
+`mde <...> <prior word> <current word><TAB>`
+
+Completions are calculated based on the current word and the prior word. 
+1. If the current word starts with `-`, present matching options, eg `--version` for the current word `--v`.
+2. Else, if the current word is empty and the prior word is an option that takes an argument, present the type of the argument, eg `.BOOL.` for the option `--user-must-approve`.
+3. Else, if the current word is the type of argument, from the rule above, present the default value for the option. e.g. `1` for the type `.BOOL.` for the option `--user-must-approve`.
+4. Else, if the current word is non-empty, list matching files and folders.
+
+## Example Completions
+
+In the table below, tab is indicated by `!`
+| Input | Completions |
+| :--- | :--- |
+| `mde !` | local files and folders |
+| `mde -!` | all options |
+| `mde --!` | all options |
+| `mde --v!` | `mde --version` |
+| `mde --user-must-approve !` | `mde --user-must-approve .BOOL.`|
+| `mde --user-must-approve .BOOL.!` | `mde --user-must-approve 1` |
+

data/lib/collapser.rb

@@ -1,4 +1,4 @@
-#!/usr/bin/env bundle exec ruby
+#!/usr/bin/env -S bundle exec ruby
 # frozen_string_literal: true
 
 # encoding=utf-8

data/lib/evaluate_shell_expressions.rb

@@ -1,4 +1,4 @@
-#!/usr/bin/env bundle exec ruby
+#!/usr/bin/env -S bundle exec ruby
 # frozen_string_literal: true
 
 # encoding=utf-8

data/lib/find_files.rb

@@ -1,4 +1,4 @@
-#!/usr/bin/env bundle exec ruby
+#!/usr/bin/env -S bundle exec ruby
 # frozen_string_literal: true
 
 # encoding=utf-8
@@ -84,7 +84,6 @@ class TestFindFiles < Minitest::Test
     expected_files = [
       'lib/cli.rb',
       'lib/colorize.rb',
-      'lib/dev/watchfile.sh',
       'lib/markdown_exec.rb',
       'lib/markdown_exec/version.rb'
     ]

data/lib/input_sequencer.rb

@@ -1,4 +1,4 @@
-#!/usr/bin/env bundle exec ruby
+#!/usr/bin/env -S bundle exec ruby
 # frozen_string_literal: true
 
 # encoding=utf-8

data/lib/instance_method_wrapper.rb

@@ -1,4 +1,4 @@
-#!/usr/bin/env bundle exec ruby
+#!/usr/bin/env -S bundle exec ruby
 # frozen_string_literal: true
 
 # encoding=utf-8

data/lib/markdown_exec/version.rb

@@ -8,5 +8,5 @@ module MarkdownExec
   BIN_NAME = 'mde'
   GEM_NAME = 'markdown_exec'
   TAP_DEBUG = 'MDE_DEBUG'
-  VERSION = '3.5.0'
+  VERSION = '3.5.1'
 end

data/lib/markdown_exec.rb

@@ -1104,7 +1104,7 @@ module MarkdownExec
   class TestMarkdownTableFormatter < Minitest::Test
     def test_select_document_if_multiple
       find_path = "#{`pwd`.chomp}/fixtures"
-      value = 'document'
+      value = 'fix'
       searcher = SearchResultsReport.new(value, [find_path])
       options = {
         ansi_formatter_color: false,

data/lib/parameter_expansion.rb

@@ -1,4 +1,4 @@
-#!/usr/bin/env bundle exec ruby
+#!/usr/bin/env -S bundle exec ruby
 # frozen_string_literal: true
 
 # encoding=utf-8

data/lib/resize_terminal.rb

@@ -1,4 +1,4 @@
-#!/usr/bin/env bundle exec ruby
+#!/usr/bin/env -S bundle exec ruby
 # frozen_string_literal: true
 
 # encoding=utf-8
@@ -107,20 +107,6 @@ class ResizeTerminalTest < Minitest::Test
     EnvInterface.set('LINES', @original_lines)
   end
 
-  # def test_resize_terminal_successful
-  #   # Simulate interactive terminal
-  #   $stdin.stub(:tty?, true) do
-  #     ARGV.replace([])
-  #     ENV['COLUMNS'] = '80'
-  #     ENV['LINES'] = '24'
-  #     response = "\e[999;999H\e[6n\e[24;80R"
-  #     $stdin.stub(:getch, -> { response.slice!(0) || '' }) do
-  #       assert_output(nil, /24x80/) do
-  #         resize_terminal
-  #       end
-  #     end
-  #   end
-  # end
   def test_resize_terminal_successful
     # Simulate interactive terminal
     $stdin.stub(:tty?, true) do
@@ -130,7 +116,7 @@ class ResizeTerminalTest < Minitest::Test
       EnvInterface.set('LINES', '24')
       response = "\e[999;999H\e[6n\e[24;#{columns}R".dup
       $stdin.stub(:getch, -> { response.slice!(0) || '' }) do
-        assert_output(/xterm-256color #{columns}x24$/) do
+        assert_output(/xterm(-256color)? #{columns}x24$/) do
           resize_terminal(require_stdout: false)
         end
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: markdown_exec
 version: !ruby/object:Gem::Version
-  version: 3.5.0
+  version: 3.5.1
 platform: ruby
 authors:
 - Fareed Stevenson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-11-13 00:00:00.000000000 Z
+date: 2025-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clipboard
@@ -96,6 +96,7 @@ files:
 - ".rubocop.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
+- Dockerfile.test
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -267,6 +268,8 @@ files:
 - docs/dev/text-decoration.md
 - docs/dev/variable-expansion-multiline.md
 - docs/dev/variable-expansion.md
+- docs/docker-testing.md
+- docs/tab-completion.md
 - docs/ux-blocks-examples.md
 - docs/ux-blocks-init-act.md
 - examples/bash-blocks.md