markdown_exec 2.0.7 → 2.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af8a53f03e48c890798b520b84bd0357ccef4f31d93b97cc7cc8b4b72ca1a035
-  data.tar.gz: cd5983d2ff18ee8e2a29da6bea364c03bdaf6a43871d45b16483a8996d129894
+  metadata.gz: e071fd1fad2603543cbad492e8bed6ee2a1e437f914cf834d3bb99da3a87234f
+  data.tar.gz: ba95432a7a17319cde5eaa821c554a472f8cdfeca8238c370869a560e22fcae7
 SHA512:
-  metadata.gz: 47e4e75e5a4e473ab9e9726cb7774aec95eb4a26d1d48035e3f6a69df0162c6b004fa625f5ae9f3c973bb25f732c9e938c0008dd07abb759f3211258d943fcc8
-  data.tar.gz: 306fc1218c64d57b1ca82191060298f87f9ae996e43f278cd72144fa3b839e3e4e4b8d3168f34c2fca4bd1ba9fa8ca1ab0a42659980d115b2d3293edc5e75238
+  metadata.gz: 0c3586f87853edbb872a7ad8ba766fe1a76d4184ebb6b02d11eaf6227ed152ae75b83c5b291981f0cf9a2208133cf122e8a3fcd4376bd694607f9bfa5d8bc577
+  data.tar.gz: 73a013bc437ba2d5aa87bd9c8a0c8039d6ad8cb6b95767a3b16ab340a90aec26ae1f2c0d0fa355280caa89cb45de7a474b51473683573a147d6cebc91b6522a1

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## [2.0.8] - 2024-06-05
+
+### Added
+
+- Option to automatically resize the menu.
+  Detect the maximum supported screen dimensions.
+  Resize the terminal to the maximum dimensions.
+  Every time the menu is displayed, format it to the terminal dimensions.
+
+### Changed
+
+- Remove "$" from saved file names to simplify handling.
+
 ## [2.0.7] - 2024-06-04
 
 ### Added

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    markdown_exec (2.0.7)
+    markdown_exec (2.0.8)
       clipboard (~> 1.3.6)
       open3 (~> 0.1.1)
       optparse (~> 0.1.1)

data/Rakefile

@@ -89,6 +89,7 @@ task :minitest do
     './lib/object_present.rb',
     './lib/option_value.rb',
     './lib/regexp.rb',
+    './lib/resize_terminal.rb',
     './lib/saved_assets.rb',
     './lib/saved_files_matcher.rb'
   ]

data/bin/tab_completion.sh

@@ -13,7 +13,7 @@ __filedirs_all()
 }
 
 _mde_echo_version() {
-  echo "2.0.7"
+  echo "2.0.8"
 }
 
 _mde() {
@@ -178,4 +178,4 @@ _mde() {
 
 complete -o filenames -o nospace -F _mde mde
 # _mde_echo_version
-# echo "Updated: 2024-06-05 03:00:42 UTC"
+# echo "Updated: 2024-06-06 00:36:41 UTC"

data/lib/hash_delegator.rb

@@ -6,6 +6,7 @@
 require 'clipboard'
 require 'English'
 require 'fileutils'
+require 'io/console'
 require 'open3'
 require 'optparse'
 require 'ostruct'
@@ -31,6 +32,7 @@ require_relative 'hash'
 require_relative 'link_history'
 require_relative 'mdoc'
 require_relative 'regexp'
+require_relative 'resize_terminal'
 require_relative 'std_out_err_logger'
 require_relative 'string_util'
 
@@ -2485,14 +2487,37 @@ module MarkdownExec
                      ))
     end
 
+    # Registers console attributes by modifying the options hash.
+    # This method handles terminal resizing and adjusts the console dimensions 
+    # and pagination settings based on the current terminal size.
+    #
+    # @param opts [Hash] a hash containing various options for the console settings.
+    #   - :console_width [Integer, nil] The width of the console. If not provided or if the terminal is resized, it will be set to the current console width.
+    #   - :console_height [Integer, nil] The height of the console. If not provided or if the terminal is resized, it will be set to the current console height.
+    #   - :console_winsize [Array<Integer>, nil] The dimensions of the console [height, width]. If not provided or if the terminal is resized, it will be set to the current console dimensions.
+    #   - :select_page_height [Integer, nil] The height of the page for selection. If not provided or if not positive, it will be set to the maximum of (console height - 3) or 4.
+    #   - :per_page [Integer, nil] The number of items per page. If :select_page_height is not provided or if not positive, it will be set to the maximum of (console height - 3) or 4.
+    #
+    # @raise [StandardError] If an error occurs during the process, it will be caught and handled by calling HashDelegator.error_handler with 'register_console_attributes' and { abort: true }.
+    #
+    # @example
+    #   opts = { console_width: nil, console_height: nil, select_page_height: nil }
+    #   register_console_attributes(opts)
+    #   # opts will be updated with the current console dimensions and pagination settings.
     def register_console_attributes(opts)
-      unless opts[:console_width]
-        require 'io/console'
-        opts[:console_height], opts[:console_width] = opts[:console_winsize] = IO.console.winsize
+      begin
+        if (resized = @delegate_object[:menu_resize_terminal])
+          resize_terminal
+        end
+
+        if resized || !opts[:console_width]
+          opts[:console_height], opts[:console_width] = opts[:console_winsize] = IO.console.winsize
+        end
+
+        opts[:per_page] = opts[:select_page_height] = [opts[:console_height] - 3, 4].max unless opts[:select_page_height]&.positive?
+      rescue StandardError
+        HashDelegator.error_handler('register_console_attributes', { abort: true })
       end
-      opts[:per_page] = opts[:select_page_height] = [opts[:console_height] - 3, 4].max unless opts[:select_page_height]&.positive?
-    rescue StandardError
-      HashDelegator.error_handler('register_console_attributes', { abort: true })
     end
 
     # Check if the delegate object responds to a given method.

data/lib/markdown_exec/version.rb

@@ -7,5 +7,5 @@ module MarkdownExec
   BIN_NAME = 'mde'
   GEM_NAME = 'markdown_exec'
   TAP_DEBUG = 'MDE_DEBUG'
-  VERSION = '2.0.7'
+  VERSION = '2.0.8'
 end

data/lib/menu.src.yml

@@ -727,6 +727,13 @@
   :opt_name: menu_persist_block_name
   :procname: val_as_str
 
+- :arg_name: BOOL
+  :default: true
+  :description: Resize terminal when displaying menu.
+  :env_var: MDE_MENU_RESIZE_TERMINAL
+  :opt_name: menu_resize_terminal
+  :procname: val_as_bool
+
 - :default: fg_rgbh_ff_ff_ff
   :description: Color of menu task
   :env_var: MDE_MENU_TASK_COLOR

data/lib/menu.yml

@@ -1,4 +1,4 @@
-# MDE - Markdown Executor (2.0.7)
+# MDE - Markdown Executor (2.0.8)
 ---
 - :description: Show current configuration values
   :procname: show_config
@@ -609,6 +609,12 @@
   :env_var: MDE_MENU_PERSIST_BLOCK_NAME
   :opt_name: menu_persist_block_name
   :procname: val_as_str
+- :arg_name: BOOL
+  :default: true
+  :description: Resize terminal when displaying menu.
+  :env_var: MDE_MENU_RESIZE_TERMINAL
+  :opt_name: menu_resize_terminal
+  :procname: val_as_bool
 - :default: fg_rgbh_ff_ff_ff
   :description: Color of menu task
   :env_var: MDE_MENU_TASK_COLOR

data/lib/resize_terminal.rb

@@ -0,0 +1,215 @@
+#!/usr/bin/env bundle exec ruby
+# frozen_string_literal: true
+
+# encoding=utf-8
+require 'io/console'
+require 'timeout'
+
+# This function attempts to resize the terminal to its maximum supported size.
+# It checks if the script is running in an interactive terminal with no arguments.
+# If so, it sends escape sequences to query the terminal size and reads the response.
+# It then compares the current terminal size with the calculated size and adjusts if necessary.
+# If the terminal emulator is unsupported, it prints an error message.
+def resize_terminal(show_dims: false, show_rectangle: false)
+  # Check if running in an interactive terminal and no arguments are provided
+  if $stdin.tty? && ARGV.empty?
+    begin
+      # Save the current state and send the escape sequence to get the cursor position
+      print "\e7\e[r\e[999;999H\e[6n\e8"
+      $stdout.flush
+
+      # Read the response from the terminal
+      response = String.new
+      Timeout.timeout(5) do
+        loop do
+          char = $stdin.getch
+          response << char
+          break if response.include?('R')
+        end
+      end
+
+      if response.empty?
+        warn "Error: No response received from terminal. Response: #{response.inspect}"
+        return 1
+      end
+
+      # Match the response to extract the terminal dimensions
+      match_data = response.match(/\[(\d+);(\d+)R/)
+      unless match_data
+        warn "Error: Failed to match terminal response pattern. Response: #{response.inspect}"
+        return 1
+      end
+
+      calculated_rows, calculated_columns = match_data.captures.map(&:to_i)
+
+      if ENV['COLUMNS'].to_i == calculated_columns && ENV['LINES'].to_i == calculated_rows
+        puts "#{ENV.fetch('TERM', nil)} #{calculated_columns}x#{calculated_rows}"
+      elsif calculated_columns.positive? && calculated_rows.positive?
+        warn "#{ENV.fetch('COLUMNS', nil)}x#{ENV.fetch('LINES', nil)} -> #{calculated_columns}x#{calculated_rows}" if show_dims
+        system("stty cols #{calculated_columns} rows #{calculated_rows}")
+      else
+        warn "Error: Calculated terminal size is invalid. Columns: #{calculated_columns}, Rows: #{calculated_rows}"
+        return 1
+      end
+
+      # Display a text rectangle if the option is enabled
+      display_terminal_rectangle(calculated_columns, calculated_rows) if show_rectangle
+    rescue Timeout::Error
+      warn 'Error: Timeout while reading terminal response. Unsupported terminal emulator.'
+      1
+    rescue StandardError => err
+      warn "Error: #{err.message}. Unsupported terminal emulator."
+      1
+    end
+  else
+    warn 'Usage: resize_terminal'
+  end
+end
+
+# This function draws a rectangle of the given width and height
+# with stars on the edges and empty space inside.
+def display_terminal_rectangle(width, height)
+  puts '*' * width
+  (height - 2).times { puts "*#{' ' * (width - 2)}*" }
+  puts '*' * width
+end
+
+# resize_terminal(show_rectangle: true) if __FILE__ == $PROGRAM_NAME
+return if __FILE__ != $PROGRAM_NAME
+
+require 'minitest/autorun'
+
+class ResizeTerminalTest < Minitest::Test
+  def setup
+    # Backup original ARGV and environment variables
+    @original_argv = ARGV.dup
+    @original_columns = ENV.fetch('COLUMNS', nil)
+    @original_lines = ENV.fetch('LINES', nil)
+  end
+
+  def teardown
+    # Restore original ARGV and environment variables
+    ARGV.replace(@original_argv)
+    ENV['COLUMNS'] = @original_columns
+    ENV['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
+      ARGV.replace([])
+      columns = 40 + (2 * rand(10))
+      ENV['COLUMNS'] = columns.to_s
+      ENV['LINES'] = '24'
+      response = "\e[999;999H\e[6n\e[24;#{columns}R".dup
+      $stdin.stub(:getch, -> { response.slice!(0) || '' }) do
+        assert_output("\e7\e[r\e[999;999H\e[6n\e8xterm-256color #{columns}x24\n") do
+          # assert_output('', '') do
+          resize_terminal
+        end
+      end
+    end
+  end
+
+  def test_resize_terminal_no_response
+    # Simulate interactive terminal with no response
+    $stdin.stub(:tty?, true) do
+      ARGV.replace([])
+      $stdin.stub(:getch, -> { '' }) do
+        # assert_output(nil, /Error: No response received from terminal/) do
+        assert_output(nil, "Error: Timeout while reading terminal response. Unsupported terminal emulator.\n") do
+          assert_equal 1, resize_terminal
+        end
+      end
+    end
+  end
+
+  def test_resize_terminal_invalid_response
+    # Simulate interactive terminal with invalid response
+    $stdin.stub(:tty?, true) do
+      ARGV.replace([])
+      response = "\e[999;999H\e[6n\e[InvalidResponse".dup
+      $stdin.stub(:getch, -> { response.slice!(0) || '' }) do
+        assert_output(nil, /Error: Failed to match terminal response pattern/) do
+          assert_equal 1, resize_terminal
+        end
+      end
+    end
+  end
+
+  def test_resize_terminal_timeout
+    # Simulate interactive terminal with timeout
+    $stdin.stub(:tty?, true) do
+      ARGV.replace([])
+      Timeout.stub(:timeout, ->(_) { raise Timeout::Error }) do
+        assert_output(nil, /Error: Timeout while reading terminal response/) do
+          assert_equal 1, resize_terminal
+        end
+      end
+    end
+  end
+
+  def test_resize_terminal_non_interactive
+    # Simulate non-interactive terminal
+    $stdin.stub(:tty?, false) do
+      assert_output(nil, /Usage: resize_terminal/) do
+        resize_terminal
+      end
+    end
+  end
+
+  #   def test_resize_terminal_display_rectangle
+  #     # Simulate interactive terminal with rectangle display
+  #     $stdin.stub(:tty?, true) do
+  #       ARGV.replace([])
+  #       ENV['COLUMNS'] = '80'
+  #       ENV['LINES'] = '24'
+  #       response = "\e[999;999H\e[6n\e[24;80R".dup
+  #       $stdin.stub(:getch, -> { response.slice!(0) || '' }) do
+  #         expected_output = "\e7\e[r\e[999;999H\e[6n\e8"
+  # #         expected_output = <<-RECTANGLE
+  # # ********************************************************************************
+  # # *                                                                              *
+  # # *                                                                              *
+  # # *                                                                              *
+  # # *                                                                              *
+  # # *                                                                              *
+  # # *                                                                              *
+  # # *                                                                              *
+  # # *                                                                              *
+  # # *                                                                              *
+  # # *                                                                              *
+  # # *                                                                              *
+  # # *                                                                              *
+  # # *                                                                              *
+  # # *                                                                              *
+  # # *                                                                              *
+  # # *                                                                              *
+  # # *                                                                              *
+  # # *                                                                              *
+  # # *                                                                              *
+  # # *                                                                              *
+  # # *                                                                              *
+  # # ********************************************************************************
+  # #         RECTANGLE
+  #         assert_output(expected_output.strip) do
+  #           resize_terminal(show_rectangle: true)
+  #         end
+  #       end
+  #     end
+  #   end
+end

data/lib/saved_assets.rb

@@ -12,7 +12,7 @@ module MarkdownExec
   # method derives a name for stdout redirection.
   #
   class SavedAsset
-    FNR11 = %r{[^!#$%&()\+,\-0-9=A-Z_a-z~]}.freeze
+    FNR11 = %r{[^!#%&()\+,\-0-9=A-Z_a-z~]}.freeze
     # / !"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\]^_`abcdefghijklmnopqrstuvwxyz{|}~
     FNR12 = '_'
     DEFAULT_FTIME = '%F-%H-%M-%S'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: markdown_exec
 version: !ruby/object:Gem::Version
-  version: 2.0.7
+  version: 2.0.8
 platform: ruby
 authors:
 - Fareed Stevenson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-05 00:00:00.000000000 Z
+date: 2024-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clipboard
@@ -173,6 +173,7 @@ files:
 - lib/object_present.rb
 - lib/option_value.rb
 - lib/regexp.rb
+- lib/resize_terminal.rb
 - lib/rspec_helpers.rb
 - lib/saved_assets.rb
 - lib/saved_files_matcher.rb