markdown_exec 2.8.3 → 2.8.4

data/lib/success_result.rb

@@ -0,0 +1,112 @@
+#!/usr/bin/env -S bundle exec ruby
+# frozen_string_literal: true
+
+# encoding=utf-8
+
+# frozen_string_literal: true
+
+require 'singleton'
+
+##
+# SuccessResult represents a successful outcome when no specific result value is produced.
+#
+# This class follows the Null Object pattern for successful cases, ensuring a consistent
+# interface with methods such as #success? and #failure?. It is implemented as a singleton,
+# meaning there is only one instance of SuccessResult available.
+#
+# Example:
+#   result = SomeService.call
+#   if result.success?
+#     # proceed knowing the operation succeeded
+#   else
+#     # handle failure
+#   end
+#
+class SuccessResult
+  include Singleton
+
+  ##
+  # Indicates that the result is a success.
+  #
+  # @return [Boolean] always true for SuccessResult
+  def success?
+    true
+  end
+
+  ##
+  # Indicates that the result is not a failure.
+  #
+  # @return [Boolean] always false for SuccessResult
+  def failure?
+    false
+  end
+
+  ##
+  # Provides a default message for the successful result.
+  #
+  # @return [String] a message indicating success
+  def message
+    'Success'
+  end
+
+  ##
+  # Returns a string representation of this SuccessResult.
+  #
+  # @return [String]
+  def to_s
+    'SuccessResult'
+  end
+end
+
+# Default instance for ease-of-use.
+DEFAULT_SUCCESS_RESULT = SuccessResult.instance
+
+return unless $PROGRAM_NAME == __FILE__
+
+require 'bundler/setup'
+Bundler.require(:default)
+
+require 'minitest/autorun'
+require 'mocha/minitest'
+
+require_relative 'ww'
+
+##
+# Tests for the SuccessResult class.
+#
+# This suite verifies that the SuccessResult singleton behaves as expected:
+# - It is a singleton (all calls to SuccessResult.instance return the same object)
+# - The #success? method returns true and #failure? returns false
+# - The default message and string representation are correct.
+#
+class SuccessResultTest < Minitest::Test
+  def test_singleton
+    instance1 = SuccessResult.instance
+    instance2 = SuccessResult.instance
+    assert_same instance1, instance2, "Expected the singleton instances to be identical"
+  end
+
+  def test_success_method
+    sr = SuccessResult.instance
+    assert sr.success?, "Expected success? to return true"
+  end
+
+  def test_failure_method
+    sr = SuccessResult.instance
+    refute sr.failure?, "Expected failure? to return false"
+  end
+
+  def test_message
+    sr = SuccessResult.instance
+    assert_equal 'Success', sr.message, "Expected message to be 'Success'"
+  end
+
+  def test_to_s
+    sr = SuccessResult.instance
+    assert_equal 'SuccessResult', sr.to_s, "Expected to_s to return 'SuccessResult'"
+  end
+
+  def test_default_success_result_constant
+    assert_same SuccessResult.instance, DEFAULT_SUCCESS_RESULT, "Expected DEFAULT_SUCCESS_RESULT to be the same singleton instance"
+  end
+end

data/lib/text_analyzer.rb

@@ -1,3 +1,4 @@
+#!/usr/bin/env -S bundle exec ruby
 # frozen_string_literal: true
 
 module TextAnalyzer

data/lib/ww.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
 
 # encoding=utf-8
+require 'bundler/setup' # Bundler enforces gem versions
 require 'pp'
 require 'stringio'
 
-LOG_LEVELS = %i[debug info warn error fatal]
+LOG_LEVELS = %i[debug info warn error fatal].freeze
 
 $debug = $DEBUG || !ENV['WW'].nil?
 
@@ -15,7 +16,8 @@ if $debug && ENV['WW_MINIMUM'].nil?
 end
 
 def ww(*objs, **kwargs)
-  return objs.size == 1 ? objs.first : objs unless $debug
+  # return the last item in the list, as the label is usually first
+  return objs.last unless $debug
 
   ww0(*objs, **kwargs.merge(locations: caller_locations))
 end
@@ -55,12 +57,11 @@ def ww0(*objs,
   # Combine all parts into the final message
   header = "#{time_prefix}#{level_prefix} #{category_prefix}"
   trace = backtrace + objs
+  io = StringIO.new
   formatted_message = if single_line
-                        io = StringIO.new
                         PP.singleline_pp(trace, io)
                         "#{header} #{io.string}"
                       else
-                        io = StringIO.new
                         PP.pp(trace, io)
                         "#{header}\n#{io.string}"
                       end
@@ -76,14 +77,15 @@ def ww0(*objs,
     file.puts(formatted_message)
   end
 
-  objs.size == 1 ? objs.first : objs
+  # return the last item in the list, as the label is usually first
+  objs.last
 end
 
 class Array
   unless defined?(deref)
     def deref
-      map(&:deref).select do |line|
-        !%r{^/(vendor|\.bundle)/}.match(line)
+      map(&:deref).reject do |line|
+        %r{^/(vendor|\.bundle)/}.match(line)
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: markdown_exec
 version: !ruby/object:Gem::Version
-  version: 2.8.3
+  version: 2.8.4
 platform: ruby
 authors:
 - Fareed Stevenson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-02-28 00:00:00.000000000 Z
+date: 2025-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clipboard
@@ -108,17 +108,24 @@ files:
 - assets/select_a_file.png
 - bats/bats.bats
 - bats/block-hide.bats
+- bats/block-type-bash.bats
+- bats/block-type-link.bats
 - bats/block-type-opts.bats
+- bats/block-type-port.bats
+- bats/block-type-ux-allowed.bats
 - bats/block-type-ux-auto.bats
+- bats/block-type-ux-chained.bats
+- bats/block-type-ux-echo-hash.bats
 - bats/block-type-ux-echo.bats
 - bats/block-type-ux-exec.bats
+- bats/block-type-ux-hidden.bats
+- bats/block-type-ux-invalid.bats
 - bats/block-type-ux-preconditions.bats
 - bats/block-type-ux-readonly.bats
 - bats/block-type-ux-require.bats
 - bats/block-type-ux-row-format.bats
 - bats/block-type-ux-transform.bats
 - bats/block-type-vars.bats
-- bats/block-types.bats
 - bats/border.bats
 - bats/cli.bats
 - bats/command-substitution.bats
@@ -126,6 +133,7 @@ files:
 - bats/fail.bats
 - bats/history.bats
 - bats/import.bats
+- bats/indented-block-type-vars.bats
 - bats/indented-multi-line-output.bats
 - bats/line-decor-dynamic.bats
 - bats/line-wrapping.bats
@@ -138,6 +146,7 @@ files:
 - bats/table-column-truncate.bats
 - bats/table.bats
 - bats/test_helper.bash
+- bats/variable-expansion-multiline.bats
 - bats/variable-expansion.bats
 - bin/bmde
 - bin/colorize_env_vars.sh
@@ -151,9 +160,14 @@ files:
 - docs/dev/block-type-bash.md
 - docs/dev/block-type-opts.md
 - docs/dev/block-type-port.md
+- docs/dev/block-type-ux-allowed.md
 - docs/dev/block-type-ux-auto.md
+- docs/dev/block-type-ux-chained.md
+- docs/dev/block-type-ux-echo-hash.md
 - docs/dev/block-type-ux-echo.md
 - docs/dev/block-type-ux-exec.md
+- docs/dev/block-type-ux-hidden.md
+- docs/dev/block-type-ux-invalid.md
 - docs/dev/block-type-ux-preconditions.md
 - docs/dev/block-type-ux-readonly.md
 - docs/dev/block-type-ux-require.md
@@ -167,6 +181,7 @@ files:
 - docs/dev/document-shell.md
 - docs/dev/import-missing.md
 - docs/dev/import.md
+- docs/dev/indented-block-type-vars.md
 - docs/dev/indented-multi-line-output.md
 - docs/dev/line-decor-dynamic.md
 - docs/dev/line-wrapping.md
@@ -186,6 +201,7 @@ files:
 - docs/dev/table-indent.md
 - docs/dev/table-invalid.md
 - docs/dev/text-decoration.md
+- docs/dev/variable-expansion-multiline.md
 - docs/dev/variable-expansion.md
 - examples/bash-blocks.md
 - examples/block-names.md
@@ -258,12 +274,14 @@ files:
 - lib/input_sequencer.rb
 - lib/instance_method_wrapper.rb
 - lib/link_history.rb
+- lib/logged_struct.rb
 - lib/markdown_exec.rb
 - lib/markdown_exec/version.rb
 - lib/mdoc.rb
 - lib/menu.src.yml
 - lib/menu.yml
 - lib/namer.rb
+- lib/null_result.rb
 - lib/object_present.rb
 - lib/option_value.rb
 - lib/regexp.rb
@@ -272,8 +290,10 @@ files:
 - lib/saved_assets.rb
 - lib/saved_files_matcher.rb
 - lib/shared.rb
+- lib/shell_session.rb
 - lib/streams_out.rb
 - lib/string_util.rb
+- lib/success_result.rb
 - lib/table_extractor.rb
 - lib/tap.rb
 - lib/text_analyzer.rb