Module: HashDelegatorSelf

Included in:
MarkdownExec::HashDelegatorParent
Defined in:
lib/hash_delegator.rb

Instance Method Summary collapse

Instance Method Details

#apply_color_from_hash(string, color_methods, color_key, default_method: 'plain') ⇒ String

Applies an ANSI color method to a string using a specified color key. The method retrieves the color method from the provided hash. If the color key is not present in the hash, it uses a default color method.

Parameters:

  • string (String) —

    The string to be colored.

  • color_methods (Hash) —

    A hash where keys are color names (String/Symbol) and values are color methods.

  • color_key (String, Symbol) —

    The key representing the desired

    color method in the color_methods hash.
  • default_method (String) (defaults to: 'plain') —

    (optional) Default color method to use if color_key is not found in color_methods. Defaults to ‘plain’.

Returns:

  • (String) —

    The colored string.



69
70
71
72
73
 
# File 'lib/hash_delegator.rb', line 69

def apply_color_from_hash(string, color_methods, color_key,
                          default_method: 'plain')
  color_method = color_methods.fetch(color_key, default_method).to_sym
  AnsiString.new(string.to_s).send(color_method)
end

#block_find(blocks, msg, value, default = nil) ⇒ Object?

Searches for the first element in a collection where the specified message sent to an element matches a given value. This method is particularly useful for finding a specific hash-like object within an enumerable collection. If no match is found, it returns a specified default value.

Parameters:

  • blocks (Enumerable) —

    The collection of hash-like objects to search.

  • msg (Symbol, String) —

    The message to send to each element of the collection.

  • value (Object) —

    The value to match against the result of the message sent to each element.

  • default (Object, nil) (defaults to: nil) —

    The default value to return if no match is found (optional).

Returns:

  • (Object, nil) —

    The first matching element or the default value if no match is found.



91
92
93
 
# File 'lib/hash_delegator.rb', line 91

def block_find(blocks, msg, value, default = nil)
  blocks.find { |item| item.send(msg) == value } || default
end

#code_merge(*bodies) ⇒ Object 



95
96
97
 
# File 'lib/hash_delegator.rb', line 95

def code_merge(*bodies)
  merge_lists(*bodies)
end

#count_matches_in_lines(lines, regex) ⇒ Object 



99
100
101
 
# File 'lib/hash_delegator.rb', line 99

def count_matches_in_lines(lines, regex)
  lines.count { |line| line.to_s.match(regex) }
end

#create_directory_for_file(file_path) ⇒ Object 



103
104
105
 
# File 'lib/hash_delegator.rb', line 103

def create_directory_for_file(file_path)
  FileUtils.mkdir_p(File.dirname(file_path))
end

#create_file_and_write_string_with_permissions(file_path, content, chmod_value) ⇒ Object

Creates a file at the specified path, writes the given

content to it, and sets file permissions if required.

Handles any errors encountered during the process.

Parameters:

  • file_path (String) —

    The path where the file will be created.

  • content (String) —

    The content to write into the file.

  • chmod_value (Integer) —

    The file permission value to set; skips if zero.



116
117
118
119
120
121
122
123
 
# File 'lib/hash_delegator.rb', line 116

def create_file_and_write_string_with_permissions(file_path, content,
                                                  chmod_value)
  create_directory_for_file(file_path)
  File.write(file_path, content)
  set_file_permissions(file_path, chmod_value) unless chmod_value.zero?
rescue StandardError
  error_handler('create_file_and_write_string_with_permissions')
end

#default_block_title_from_body(fcb) ⇒ Object

Updates the title of an FCB object from its body content if the title is nil or empty.



131
132
133
134
135
 
# File 'lib/hash_delegator.rb', line 131

def default_block_title_from_body(fcb)
  return fcb.title unless fcb.title.nil? || fcb.title.empty?

  fcb.derive_title_from_body
end

#delete_consecutive_blank_lines!(blocks_menu) ⇒ Object

delete the current line if it is empty and the previous is also empty



138
139
140
141
142
143
144
145
146
 
# File 'lib/hash_delegator.rb', line 138

def delete_consecutive_blank_lines!(blocks_menu)
  blocks_menu.process_and_conditionally_delete! do
    |prev_item, current_item, _next_item|
    prev_item&.fetch(:chrome, nil) &&
      !(prev_item && prev_item.oname.present?) &&
      current_item&.fetch(:chrome, nil) &&
      !(current_item && current_item.oname.present?)
  end
end

#error_handler(name = '', opts = {}, error: $!) ⇒ Object 



148
149
150
151
152
153
 
# File 'lib/hash_delegator.rb', line 148

def error_handler(name = '', opts = {}, error: $!)
  Exceptions.error_handler(
    "HashDelegator.#{name} -- #{error}",
    opts
  )
end

#indent_all_lines(body, indent = nil) ⇒ String

Indents all lines in a given string with a specified indentation string.

Parameters:

  • body (String) —

    A multi-line string to be indented.

  • indent (String) (defaults to: nil) —

    The string used for indentation (default is an empty string).

Returns:

  • (String) —

    A single string with each line indented as specified.



160
161
162
163
164
 
# File 'lib/hash_delegator.rb', line 160

def indent_all_lines(body, indent = nil)
  return body unless indent&.non_empty?

  body.lines.map { |line| indent + line.chomp }.join("\n")
end

#initialize_fcb_names(fcb) ⇒ Object 



166
167
168
 
# File 'lib/hash_delegator.rb', line 166

def initialize_fcb_names(fcb)
  fcb.oname = fcb.dname = fcb.title || ''
end

#join_code_lines(lines) ⇒ Object 



170
171
172
 
# File 'lib/hash_delegator.rb', line 170

def join_code_lines(lines)
  ((lines || []) + ['']).join("\n")
end

#merge_lists(*args) ⇒ Object 



174
175
176
177
178
179
 
# File 'lib/hash_delegator.rb', line 174

def merge_lists(*args)
  # Filters out nil values, flattens the arrays, and ensures an
  #  empty list is returned if no valid lists are provided.
  merged = args.compact.flatten
  merged.empty? ? [] : merged
end

#next_link_state(block_name_from_cli:, was_using_cli:, block_state:, block_name: nil) ⇒ Object 



181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/hash_delegator.rb', line 181

def next_link_state(
  block_name_from_cli:, was_using_cli:, block_state:, block_name: nil
)
  # Set block_name based on block_name_from_cli
  block_name = @cli_block_name if block_name_from_cli

  # Determine the state of breaker based on was_using_cli and the block type
  # true only when block_name is nil, block_name_from_cli is false,
  # was_using_cli is true, and the block_state.block.shell equals
  # BlockType::BASH. In all other scenarios, breaker is false.
  breaker = !block_name &&
            !block_name_from_cli &&
            was_using_cli &&
            block_state.block.type == BlockType::SHELL

  # Reset block_name_from_cli if the conditions are not met
  block_name_from_cli ||= false

  [block_name, block_name_from_cli, breaker]
end

#parse_yaml_data_from_body(body) ⇒ Object 



202
203
204
205
206
207
 
# File 'lib/hash_delegator.rb', line 202

def parse_yaml_data_from_body(body)
  body&.any? ? YAML.load(body.join("\n")) : {}
rescue StandardError
  error_handler("parse_yaml_data_from_body for body: #{body}",
                { abort: true })
end

#read_required_blocks_from_temp_file(temp_blocks_file_path) ⇒ Array<String>

Reads required code blocks from a temporary file specified

by an environment variable.

Returns:

  • (Array<String>) —

    Lines read from the temporary file, or an empty array if file is not found or path is empty.



213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/hash_delegator.rb', line 213

def read_required_blocks_from_temp_file(temp_blocks_file_path)
  return [] if temp_blocks_file_path.to_s.empty?

  if File.exist?(temp_blocks_file_path)
    File.readlines(
      temp_blocks_file_path, chomp: true
    )
  else
    []
  end
end

#remove_file_without_standard_errors(path) ⇒ Object 



225
226
227
 
# File 'lib/hash_delegator.rb', line 225

def remove_file_without_standard_errors(path)
  FileUtils.rm_f(path)
end

#safeval(str) ⇒ Object

Evaluates the given string as Ruby code within a safe context. If an error occurs, it calls the error_handler method with ‘safeval’.

Parameters:

  • str (String) —

    The string to be evaluated.

Returns:

  • (Object) —

    The result of evaluating the string.



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/hash_delegator.rb', line 233

def safeval(str)
  # # Restricting to evaluate only expressions
  # unless str.match?(/\A\s*\w+\s*[\+\-\*\/\=\%\&\|\<\>\!]+\s*\w+\s*\z/)
  #   error_handler('safeval') # 'Invalid expression'
  #   return
  # end

  # # Whitelisting allowed operations
  # allowed_methods = %w[+ - * / == != < > <= >= && || % &
  #  |]
  # unless allowed_methods.any? { |op| str.include?(op) }
  #   error_handler('safeval', 'Operation not allowed')
  #   return
  # end

  # # Sanitize input (example: removing potentially harmful characters)
  # str = str.gsub(/[^0-9\+\-\*\/\(\)\<\>\!\=\%\&\|]/, '')
  # Evaluate the sanitized string
  result = nil
  binding.eval("result = #{str}")

  result
rescue StandardError # catches NameError, StandardError
  pp $!, $@
  pp "code: #{str}"
  error_handler('safeval')
  exit 1
end

#set_file_permissions(file_path, chmod_value) ⇒ Object 



262
263
264
 
# File 'lib/hash_delegator.rb', line 262

def set_file_permissions(file_path, chmod_value)
  File.chmod(chmod_value, file_path)
end

#tables_into_columns!(blocks_menu, delegate_object) ⇒ Object

find tables in multiple lines and format horizontally



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/hash_delegator.rb', line 267

def tables_into_columns!(blocks_menu, delegate_object)
  return unless delegate_object[:tables_into_columns]

  lines = blocks_menu.map(&:oname)
  text_tables = TableExtractor.extract_tables(
    lines,
    regexp: delegate_object[:table_parse_regexp]
  )
  return unless text_tables.count.positive?

  text_tables.each do |table|
    next unless table[:columns].positive?

    range = table[:start_index]..(table[:start_index] + table[:rows] - 1)
    lines = blocks_menu[range].map(&:dname)
    formatted = MarkdownTableFormatter.format_table(
      column_count: table[:columns],
      decorate: {
        border: delegate_object[:table_border_color],
        header_row: delegate_object[:table_header_row_color],
        row: delegate_object[:table_row_color],
        separator_line: delegate_object[:table_separator_line_color]
      },
      lines: lines
    )

    unless formatted.count == range.size
      # warn [__LINE__, range, lines, formatted].inspect
      raise 'Invalid result from MarkdownTableFormatter.format_table()'
    end

    # read indentation from first line
    indent = blocks_menu[range.first].oname.split('|', 2).first

    # replace text in each block
    range.each.with_index do |block_ind, ind|
      ### format oname to dname
      blocks_menu[block_ind].dname = indent + formatted[ind]
    end
  end
end

#tty_prompt_without_disabled_symbol ⇒ TTY::Prompt

Creates a TTY prompt with custom settings. Specifically,

it disables the default 'cross' symbol and

defines a lambda function to handle interrupts.

Returns:

  • (TTY::Prompt) —

    A new TTY::Prompt instance with specified configurations.



314
315
316
317
318
319
320
321
322
 
# File 'lib/hash_delegator.rb', line 314

def tty_prompt_without_disabled_symbol
  TTY::Prompt.new(
    interrupt: lambda {
      puts # next line in case not at start
      raise TTY::Reader::InputInterrupt
    },
    symbols: { cross: ' ' }
  )
end

#update_menu_attrib_yield_selected(fcb:, messages:, configuration: {}, &block) ⇒ Object

Updates the attributes of the given fcb object and

conditionally yields to a block.

It initializes fcb names and sets the default block title from fcb’s body. If the fcb has a body and meets certain conditions,

it yields to the given block.

Parameters:

  • fcb (Object) —

    The fcb object whose attributes are to be updated.

  • selected_types (Array<Symbol>) —

    A list of message types to determine if yielding is applicable.

  • block (Block) —

    An optional block to yield to if conditions are met.



334
335
336
337
338
339
340
341
342
 
# File 'lib/hash_delegator.rb', line 334

def update_menu_attrib_yield_selected(fcb:, messages:, configuration: {},
                                      &block)
  initialize_fcb_names(fcb)
  return unless fcb.body

  default_block_title_from_body(fcb)
  MarkdownExec::Filter.yield_to_block_if_applicable(fcb, messages, configuration,
                                                    &block)
end

#yield_line_if_selected(line, selected_types, &block) ⇒ Object

Yields a line as a new block if the selected message type includes :line.

Parameters:

  • line (String) —

    The line to be processed.

  • selected_types (Array<Symbol>) —

    A list of message types to check.

  • block (Proc) —

    The block to be called with the line data.



348
349
350
351
352
 
# File 'lib/hash_delegator.rb', line 348

def yield_line_if_selected(line, selected_types, &block)
  return unless block && block_type_selected?(selected_types, :line)

  block.call(:line, MarkdownExec::FCB.new(body: [line]))
end