mp-utils 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 472fb772fc669be45aee52e5f931823934e59cb5f36974536dbfea782024ac9d
-  data.tar.gz: 9c5079304a471c97261ec621457575b1b79c9454a8a60f7d19ee9b0a51a7c777
+  metadata.gz: bd4e848d53092d07f0ffe66865c1dd718fec86eac82143a3c487e7163755d86a
+  data.tar.gz: cd14a3a2876dd20e67591a3da7f1da71ffb79ce6267647a6453884e47724b87e
 SHA512:
-  metadata.gz: 79864c2f162bb4d136ae0762d4196c868e0ce4136a31bb873ce79289478734f442acfc18e882d942b53b15e26c570a8b4d18c144f88d1ceae4573c01121583d8
-  data.tar.gz: cd1ed6a8fdb3c724d1953c0df5107468936b5a4800b537097ca32d3f134123c93f39c45ee327a347037e6246fe23600030128fe12f7371034d11bca9fb347204
+  metadata.gz: c43bbb206cd8778bfef333f1ac572b8d1cb5daadf2bda9c179849aaf8d39e2b77fb7507a165e57308e2b78e6ef8c77bb3025a502011a11a4f32b81a9ed88298c
+  data.tar.gz: 4dd356d68a6304642c639ecc8f82a6e5da7583876d507e726425fcec4fa80cf5b062047412aac2637e07b82a2d0dc6c1678332465eb377f10243a29d779ab9c2

data/lib/mp_utils.rb

@@ -7,4 +7,5 @@ require_relative 'utils/message'
 require_relative 'utils/question'
 require_relative 'utils/version_manager'
 require_relative 'utils/ansi_style_manager'
+require_relative 'utils/directory_structure'
 require_relative 'resources/path_helper'

data/lib/utils/directory_structure.rb

@@ -0,0 +1,215 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+# Class to represent and process a directory structure.
+# It can be initialized with a hash or a YAML file.
+#
+# ## Using HASH
+#
+# The following example shows how to use DirectoryStructure with a hash.
+# ```ruby
+# hash = {
+#   'lib' => {
+#     'version.rb' => nil,
+#     'source' => [
+#       'file_1.rb',
+#       'file_2.rb',
+#       'file_3.rb'
+#     ],
+#     'resource' => {
+#       'images' => [
+#         'potato.png',
+#         'fries.jpeg',
+#         'franch_fries.png'
+#       ],
+#       'scripts' => {
+#         validation: 'teste.rb',
+#         sorting: [
+#           'shellsort.rb',
+#           'quicksort.rb'
+#         ],
+#         'build.rb' => nil
+#       }
+#     },
+#     generated: 'file.generated.rb'
+#   }
+# }
+# directory_structure = DirectoryStructure.new(hash)
+# puts "That is my directory structure:\n#{directory_structure}"
+# # Output:
+# # That is my directory structure:
+# # lib
+# # ╠═ version.rb
+# # ╠═ source
+# # ║  ╠═ file_1.rb
+# # ║  ╠═ file_2.rb
+# # ║  ╚═ file_3.rb
+# # ╠═ resource
+# # ║  ╠═ images
+# # ║  ║  ╠═ potato.png
+# # ║  ║  ╠═ fries.jpeg
+# # ║  ║  ╚═ franch_fries.png
+# # ║  ╚═ scripts
+# # ║     ╠═ validation
+# # ║     ║  ╚═ teste.rb
+# # ║     ╠═ sorting
+# # ║     ║  ╠═ shellsort.rb
+# # ║     ║  ╚═ quicksort.rb
+# # ║     ╚═ build.rb
+# # ╚═ generated
+# #    ╚═ file.generated.rb
+# ```
+#
+# ## Using a YAML/YML File
+#
+# First, you need to create a yml file.
+#
+# Example:
+# ```yml
+# lib:
+#   version.rb:
+#   source:
+#   - file_1.rb
+#   - file_2.rb
+#   - file_3.rb
+#   resource:
+#     images:
+#     - potato.png
+#     - fries.jpeg
+#     - franch_fries.png
+#     scripts:
+#       validation: teste.rb
+#       sorting:
+#       - shellsort.rb
+#       - quicksort.rb
+#       build.rb:
+#   generated: file.generated.rb
+# ```
+#
+# Considering that the file path is passed as a reference.
+#
+# You can initialize the class as in the example below:
+#
+# ```ruby
+# path = 'Replace/By/Your/YAML/FILE/PATH'
+# directory_structure = DirectoryStructure.new(path)
+# puts "That is my directory structure:\n#{directory_structure}"
+# # Output:
+# # That is my directory structure:
+# # lib
+# # ╠═ version.rb
+# # ╠═ source
+# # ║  ╠═ file_1.rb
+# # ║  ╠═ file_2.rb
+# # ║  ╚═ file_3.rb
+# # ╠═ resource
+# # ║  ╠═ images
+# # ║  ║  ╠═ potato.png
+# # ║  ║  ╠═ fries.jpeg
+# # ║  ║  ╚═ franch_fries.png
+# # ║  ╚═ scripts
+# # ║     ╠═ validation
+# # ║     ║  ╚═ teste.rb
+# # ║     ╠═ sorting
+# # ║     ║  ╠═ shellsort.rb
+# # ║     ║  ╚═ quicksort.rb
+# # ║     ╚═ build.rb
+# # ╚═ generated
+# #    ╚═ file.generated.rb
+# ```
+class DirectoryStructure
+  # Initializes the DirectoryStructure object.
+  #
+  # @param content [Hash, String] A hash representing the directory structure or a path to a YAML file.
+  # @raise [RuntimeError] If the content is not a Hash or a valid YAML file path.
+  def initialize(content)
+    if content.is_a?(Hash)
+      @dir_hash = content
+    elsif File.exist?(content)
+      @dir_hash = YAML.load_file(content)
+    else
+      raise 'Need be initialized with a Hash or yaml file path'
+    end
+  end
+
+  # Converts the directory structure to a string representation.
+  #
+  # @return [String] The string representation of the directory structure.
+  def to_s
+    @output = String.new('')
+    process_node(@dir_hash)
+    @output
+  end
+
+  private
+
+  # Generates the indentation string based on the key.
+  #
+  # @param key [Symbol] The key indicating the type of indentation.
+  # @return [String] The indentation string.
+  def generate_indent(key)
+    { middle: '║  ', last: '   ' }[key] || ''
+  end
+
+  # Concatenates the node to the output string with the given prefix and indentation.
+  #
+  # @param node [String] The node to be concatenated.
+  # @param prefix [Symbol] The prefix indicating the type of node.
+  # @param indent [Array<Symbol>] The array of indentation keys.
+  # @return [void]
+  def concant(node, prefix:, indent:)
+    prefix_string = { middle: '╠═ ', last: '╚═ ' }[prefix] || ''
+    indent_string = indent.map { |i| generate_indent(i) }.join
+    @output << "#{indent_string}#{prefix_string}#{node}\n"
+  end
+
+  # Processes an array of nodes and concatenates them to the output string.
+  #
+  # @param array [Array] The array of nodes to be processed.
+  # @param indent [Array<Symbol>] The array of indentation keys.
+  # @return [void]
+  def process_array(array, indent:)
+    array.each_with_index do |item, index|
+      prefix = index == array.size - 1 ? :last : :middle
+      concant(item, prefix: prefix, indent: indent)
+    end
+  end
+
+  # Processes a hash of nodes and concatenates them to the output string.
+  #
+  # @param hash [Hash] The hash of nodes to be processed.
+  # @param level [Integer] The current level of indentation.
+  # @param indent [Array<Symbol>] The array of indentation keys.
+  # @return [void]
+  def process_hash(hash, level:, indent:)
+    hash.each_with_index do |(key, value), index|
+      new_indent = indent.dup
+      prefix = :empty
+
+      if level > new_indent.size
+        prefix = index == hash.size - 1 ? :last : :middle
+        new_indent = indent + [prefix]
+      end
+
+      concant(key, prefix: prefix, indent: indent)
+      process_node(value, indent: new_indent, level: level)
+    end
+  end
+
+  # Processes a node (hash, array, or other) and concatenates it to the output string.
+  #
+  # @param node [Object] The node to be processed.
+  # @param level [Integer] The current level of indentation.
+  # @param indent [Array<Symbol>] The array of indentation keys.
+  # @return [void]
+  def process_node(node, level: 0, indent: [''])
+    if node.is_a?(Hash)
+      process_hash(node, indent: indent, level: level + 1)
+    elsif node.is_a?(Array)
+      process_array(node, indent: indent)
+    elsif !node.nil?
+      concant(node, prefix: :last, indent: indent)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mp-utils
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Marcio F Paludo
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-02 00:00:00.000000000 Z
+date: 2024-07-07 00:00:00.000000000 Z
 dependencies: []
 description: |
   Helpers to facilitate scripts Writing.
@@ -32,6 +32,7 @@ files:
 - lib/utils/ansi_style_manager.rb
 - lib/utils/array.rb
 - lib/utils/constants.rb
+- lib/utils/directory_structure.rb
 - lib/utils/key.rb
 - lib/utils/message.rb
 - lib/utils/question.rb
@@ -42,6 +43,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/MarcioFPaludo/ruby-mp-utils
   source_code_uri: https://github.com/MarcioFPaludo/ruby-mp-utils
+  documentation_uri: https://marciofpaludo.github.io/ruby-mp-utils
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []