dev_suite 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 18cb4bab59f55347094ab11c9772b132446789b2c5a12cdb0a596b9ccd57ab0b
-  data.tar.gz: 212866e22087fa628633af141c349e9831f0d0ad060018aed0f0cd6742cbfb9e
+  metadata.gz: 92f5e3450bc8b204f0be7e25db8a863ebd49d4d5a6990cfad7c6d336ccaf7e5e
+  data.tar.gz: 368e6bd01867d4fc92856b8bc4825e1e5bdc2b3b978e3afa0966139f59216f28
 SHA512:
-  metadata.gz: 29b881d2e2f34f10aced28ff856a56ca75da39c4000c8cd17194d2bd535c7b595799919ba164bf2a55ac61b4e0f3d9833f9e11c028e3fcc51c0b1017ba307aca
-  data.tar.gz: d136f946ff59f6db1d5ac5d14447d302ed6f85df55e1c4b64af2f0cc5a54efa2a48ec4aaffa2a520cb455195af4300aeb0c3ae606da6c4b7aba19ca66a5a6e32
+  metadata.gz: 973f1f20d18eab20229c5df12a304c1370ccbfc56175795c9e55fc6bc2680c0a3a3adae63472bcd3dc15ed964ba4413a5847a55d8fefc28312a119af9b0b91d5
+  data.tar.gz: f31d767559b8cd4fbfa961cafef17a5cbbcda42a78ee5e012147a96a2652fd8b3417e1184a1e5a60925032aa21b6d256902753c799c322aa48e5240016b6f901

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dev_suite (0.1.1)
+    dev_suite (0.1.3)
       benchmark (~> 0.1)
       get_process_mem (~> 0.2)
 

data/README.md

@@ -80,6 +80,37 @@ DevSuite::SomeUtility.do_something
   ```
 </details>
 
+<details>
+  <summary><strong>Directory Tree Visualization</strong></summary>
+  
+  Visualize the structure of directories and their subdirectories with a detailed hierarchical representation. This tool is essential for understanding the organization of your files and directories at a glance.
+
+  **Usage:**
+  ```ruby
+  require 'dev_suite'
+
+  # Set the base path for the directory you want to visualize
+  base_path = "/path/to/your/directory"
+
+  # Perform the visualization
+  DevSuite::DirectoryTree::Visualizer.visualize(base_path)
+  ```
+
+  **Example output**
+  ```
+  /path/to/your/directory/
+  ├── project/
+  │   ├── src/
+  │   │   ├── main.rb
+  │   │   └── helper.rb
+  │   └── spec/
+  │       └── main_spec.rb
+  ├── doc/
+  │   └── README.md
+  └── test/
+      └── test_helper.rb
+  ```
+</details>
 
 ## Development
 

data/lib/dev_suite/{utils/table/column/column.rb → directory_tree/node/base.rb}

@@ -1,14 +1,18 @@
 # frozen_string_literal: true
 
 module DevSuite
-  module Utils
-    module Table
-      class Column
+  module DirectoryTree
+    module Node
+      class Base
         attr_reader :name
 
         def initialize(name)
           @name = name
         end
+
+        def directory?
+          raise NotImplementedError, "Must implement in subclass"
+        end
       end
     end
   end

data/lib/dev_suite/directory_tree/node/directory.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module DevSuite
+  module DirectoryTree
+    module Node
+      class Directory < Base
+        attr_reader :children
+
+        def initialize(name)
+          super
+          @children = []
+        end
+
+        def directory?
+          true
+        end
+
+        def add_child(child)
+          @children << child
+        end
+      end
+    end
+  end
+end

data/lib/dev_suite/directory_tree/node/file.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module DevSuite
+  module DirectoryTree
+    module Node
+      class File < Base
+        def directory?
+          false
+        end
+      end
+    end
+  end
+end

data/lib/dev_suite/directory_tree/node/permission_denied.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module DevSuite
+  module DirectoryTree
+    module Node
+      class PermissionDenied < Base
+        # This class is used to represent a file or directory that the user does not have permission to access.
+        def initialize(name, is_directory)
+          super(name)
+          @is_directory = is_directory
+        end
+
+        def directory?
+          @is_directory
+        end
+
+        def children
+          []
+        end
+      end
+    end
+  end
+end

data/lib/dev_suite/directory_tree/node.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module DirectoryTree
+    module Node
+      require_relative "node/file"
+      require_relative "node/directory"
+      require_relative "node/permission_denied"
+    end
+  end
+end

data/lib/dev_suite/directory_tree/renderer/base.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "pathname"
+
+module DevSuite
+  module DirectoryTree
+    module Renderer
+      class Base
+        def initialize(base_path)
+          @base_path = Pathname.new(base_path)
+        end
+
+        def render
+          root = build_tree(@base_path)
+          render_node(root, "", true)
+        end
+
+        private
+
+        # Builds the tree structure
+        # @param path [Pathname] The path to build the tree from
+        # @return [Node::Base] The root node of the tree
+        def build_tree(path)
+          raise NotImplementedError, "You must implement the build_tree method"
+        end
+
+        # Renders a node in the tree
+        # @param node [Node::Base] The node to render
+        # @param prefix [String] The prefix to add to the node
+        # @param is_last [Boolean] Whether this is the last node in the list
+        # @return [String] The rendered node
+        def render_node(node, prefix, is_last)
+          raise NotImplementedError, "You must implement the render_node method"
+        end
+      end
+    end
+  end
+end

data/lib/dev_suite/directory_tree/renderer/simple.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require_relative "base"
+require_relative "../node"
+
+module DevSuite
+  module DirectoryTree
+    module Renderer
+      class Simple < Base
+        private
+
+        def build_tree(path)
+          return permission_denied_node(path) unless path.readable?
+
+          path.directory? ? directory_node(path) : file_node(path)
+        rescue Errno::EACCES
+          permission_denied_node(path)
+        end
+
+        def render_node(node, prefix = "", is_last = true)
+          is_root = prefix.empty?
+          connector = determine_connector(is_root, is_last)
+          new_prefix = update_prefix(prefix, is_last)
+
+          output = construct_output(node, prefix, connector)
+          output += node_suffix(node)
+
+          if node.directory? && node.children.any?
+            node.children.each_with_index do |child, index|
+              output += render_node(child, new_prefix, index == node.children.size - 1)
+            end
+          end
+
+          output
+        end
+
+        def determine_connector(is_root, is_last)
+          return "" if is_root
+
+          is_last ? "└── " : "├── "
+        end
+
+        def update_prefix(prefix, is_last)
+          "#{prefix}#{is_last ? "    " : "|   "}"
+        end
+
+        def construct_output(node, prefix, connector)
+          "#{prefix}#{connector}#{node.name}"
+        end
+
+        def node_suffix(node)
+          node.directory? ? "/\n" : "\n"
+        end
+
+        def directory_node(path)
+          dir = Node::Directory.new(path.basename.to_s)
+          sorted_children(path).each do |child|
+            dir.add_child(build_tree(child))
+          end
+          dir
+        end
+
+        def file_node(path)
+          Node::File.new(path.basename.to_s)
+        end
+
+        def permission_denied_node(path)
+          Node::PermissionDenied.new(path.basename.to_s, path.directory?)
+        end
+
+        def sorted_children(path)
+          path.children.sort_by { |child| child.basename.to_s.downcase }
+        end
+      end
+    end
+  end
+end

data/lib/dev_suite/directory_tree/renderer.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module DirectoryTree
+    module Renderer
+      require_relative "renderer/simple"
+    end
+  end
+end

data/lib/dev_suite/directory_tree/visualizer.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "pathname"
+require_relative "renderer"
+
+module DevSuite
+  module DirectoryTree
+    class Visualizer
+      class << self
+        # Visualizes the directory tree
+        # @param base_path [String] The base path of the directory
+        def visualize(base_path)
+          new(base_path).visualize
+        end
+      end
+
+      def initialize(base_path, renderer: Renderer::Simple.new(base_path))
+        @renderer = renderer
+      end
+
+      def visualize
+        puts @renderer.render
+      end
+    end
+  end
+end

data/lib/dev_suite/directory_tree.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module DirectoryTree
+    require_relative "directory_tree/visualizer"
+  end
+end

data/lib/dev_suite/performance/reportor/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DevSuite
   module Performance
     module Reportor

data/lib/dev_suite/performance/reportor/simple.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require_relative "base"
-require_relative "../../utils"
 
 module DevSuite
   module Performance

data/lib/dev_suite/utils/color/colorizer.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module Utils
+    module Color
+      class << self
+        def colorize(text, **kargs)
+          Colorizer.new(Config.configuration).colorize(text, **kargs)
+        end
+      end
+
+      class Colorizer
+        attr_reader :config
+
+        def initialize(config = Config.configuration)
+          @config = config
+        end
+
+        def colorize(text, **kargs)
+          puts @config.strategy.colorize(text, **kargs)
+        end
+      end
+    end
+  end
+end

data/lib/dev_suite/utils/color/config.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module Utils
+    module Color
+      class Config
+        attr_accessor :strategy, :palette
+
+        def initialize(strategy: :theme, palette: :default)
+          @palette = Palette.create(palette)
+          @strategy = Strategy.create(strategy, palette: @palette)
+          freeze # Make the instance of this class immutable as well
+        end
+
+        class << self
+          #
+          # Provide global access to a single instance of Config
+          #
+          def configuration
+            @configuration ||= new
+          end
+
+          # Allow block-based configuration
+          def configure
+            yield(configuration)
+          rescue StandardError => e
+            handle_configuration_error(e)
+            raise
+          end
+
+          private
+
+          def handle_configuration_error(error)
+            puts "Configuration error: #{error.message}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dev_suite/utils/color/palette/base.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module Utils
+    module Color
+      module Palette
+        class Base
+          # Define COLORS constant in subclass
+          # Example:
+          # COLORS = {
+          #  red: 31,
+          #  green: 32,
+          #  yellow: 33,
+          #  blue: 34,
+          #  pink: 35,
+          #  light_blue: 36,
+          #  white: 37
+          #  }
+          #
+
+          def colors
+            unless self.class.const_defined?(:COLORS)
+              raise NotImplementedError, "#{self.class} must define COLORS constant"
+            end
+
+            self.class::COLORS
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dev_suite/utils/color/palette/default.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module Utils
+    module Color
+      module Palette
+        class Default < Base
+          COLORS = {
+            red: 31,
+            green: 32,
+            yellow: 33,
+            blue: 34,
+            magenta: 35,
+            cyan: 36,
+            white: 37,
+            default: 39,
+          }.freeze
+        end
+      end
+    end
+  end
+end

data/lib/dev_suite/utils/color/palette.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module Utils
+    module Color
+      module Palette
+        require_relative "palette/base"
+        require_relative "palette/default"
+
+        class << self
+          def create(type)
+            case type
+            when :default
+              Default.new
+            else
+              raise ArgumentError, "Unknown palette type: #{type}"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dev_suite/utils/color/strategy/base.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module Utils
+    module Color
+      module Strategy
+        class Base
+          def colorize(text, **kwargs)
+            raise NotImplementedError
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dev_suite/utils/color/strategy/basic.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module Utils
+    module Color
+      module Strategy
+        class Basic < Base
+          def colorize(text, color: :default)
+            unless valid_color_code?(color)
+              raise ArgumentError, "Invalid color code"
+            end
+
+            "\e[#{color}m#{text}\e[0m"
+          end
+
+          private
+
+          def valid_color_code?(color_code)
+            color_code.is_a?(Integer) && color_code.between?(0, 255)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dev_suite/utils/color/strategy/rgb.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module Utils
+    module Color
+      module Strategy
+        class Rgb < Base
+          def colorize(text, **kwargs)
+            r, g, b = kwargs.values_at(:r, :g, :b)
+
+            unless valid_rgb?(r, g, b)
+              raise ArgumentError, "RGB values must be integers between 0 and 255"
+            end
+
+            "\e[38;2;#{r};#{g};#{b}m#{text}\e[0m"
+          end
+
+          private
+
+          def valid_rgb?(r, g, b)
+            [r, g, b].all? { |value| value.is_a?(Integer) && value.between?(0, 255) }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dev_suite/utils/color/strategy/theme.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module Utils
+    module Color
+      module Strategy
+        class Theme < Base
+          def initialize(palette)
+            super()
+            @palette = palette
+          end
+
+          def colorize(text, color: :default)
+            unless @palette.colors.key?(color)
+              raise ArgumentError, "Invalid color key"
+            end
+
+            color_code = @palette.colors[color]
+
+            unless valid_color_code?(color_code)
+              raise ArgumentError, "Invalid color code"
+            end
+
+            "\e[#{color_code}m#{text}\e[0m"
+          end
+
+          private
+
+          def valid_color_code?(color_code)
+            color_code.is_a?(Integer) && color_code.between?(0, 255)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dev_suite/utils/color/strategy.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module Utils
+    module Color
+      module Strategy
+        require_relative "strategy/base"
+        require_relative "strategy/basic"
+        require_relative "strategy/rgb"
+        require_relative "strategy/theme"
+
+        class << self
+          def create(type, palette: nil)
+            case type
+            when :basic
+              Basic.new
+            when :rgb
+              Rgb.new
+            when :theme
+              raise ArgumentError, "Palette is required for theme strategy" unless palette
+
+              Theme.new(palette)
+            else
+              raise ArgumentError, "Unknown strategy type: #{type}"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dev_suite/utils/color.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module Utils
+    module Color
+      require_relative "color/colorizer"
+      require_relative "color/palette"
+      require_relative "color/strategy"
+      require_relative "color/config"
+    end
+  end
+end

data/lib/dev_suite/utils/table/column.rb

@@ -3,8 +3,12 @@
 module DevSuite
   module Utils
     module Table
-      module Column
-        require_relative "column/column"
+      class Column
+        attr_reader :name
+
+        def initialize(name)
+          @name = name
+        end
       end
     end
   end

data/lib/dev_suite/utils/table/config.rb

@@ -17,8 +17,32 @@ module DevSuite
           },
         }.freeze
 
-        def initialize(custom_settings = {})
-          @settings = deep_merge(DEFAULTS, custom_settings)
+        attr_reader :settings
+
+        def initialize(settings = {})
+          @settings = deep_merge(DEFAULTS, settings)
+        end
+
+        class << self
+          #
+          # Provide global access to a single instance of Config
+          #
+          def configuration
+            @configuration ||= new
+          end
+
+          # Allow block-based configuration
+          def configure
+            yield(configuration)
+          rescue StandardError => e
+            handle_configuration_error(e)
+          end
+
+          private
+
+          def handle_configuration_error(error)
+            puts "Configuration error: #{error.message}"
+          end
         end
 
         def color_for(key)

data/lib/dev_suite/utils/table/formatter.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module Utils
+    module Table
+      module Formatter
+        require_relative "formatter/column_width_calculator"
+        require_relative "formatter/text_aligner"
+      end
+    end
+  end
+end

data/lib/dev_suite/utils/table/renderer/simple.rb

@@ -1,10 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "base"
-require_relative "../formatter/text_aligner"
-require_relative "../formatter/column_width_calculator"
-require_relative "../formatter/colorizer"
-
 module DevSuite
   module Utils
     module Table
@@ -35,7 +30,7 @@ module DevSuite
           # Colorizes the given string with the specified color
           #
           def colorize(str, color)
-            Formatter::Colorizer.colorize(str, color)
+            Utils::Color.colorize(str, color: color)
           end
 
           #

data/lib/dev_suite/utils/table/row.rb

@@ -3,8 +3,12 @@
 module DevSuite
   module Utils
     module Table
-      module Row
-        require_relative "row/row"
+      class Row
+        attr_reader :data
+
+        def initialize(data)
+          @data = data
+        end
       end
     end
   end

data/lib/dev_suite/utils/table/table.rb

@@ -1,10 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "column/column"
-require_relative "row/row"
-require_relative "renderer"
-require_relative "config"
-
 module DevSuite
   module Utils
     module Table

data/lib/dev_suite/utils/table.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module Utils
+    module Table
+      require_relative "table/table"
+      require_relative "table/column"
+      require_relative "table/row"
+      require_relative "table/config"
+      require_relative "table/formatter"
+      require_relative "table/renderer"
+    end
+  end
+end

data/lib/dev_suite/utils.rb

@@ -2,8 +2,7 @@
 
 module DevSuite
   module Utils
-    require_relative "utils/table/table"
-    require_relative "utils/table/config"
-    require_relative "utils/table/renderer/simple"
+    require_relative "utils/color"
+    require_relative "utils/table"
   end
 end

data/lib/dev_suite/version.rb

@@ -1,3 +1,3 @@
 module DevSuite
-  VERSION = "0.1.1"
+  VERSION = "0.1.3"
 end

data/lib/dev_suite.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
 require "dev_suite/version"
+require "dev_suite/utils"
 require "dev_suite/performance"
+require "dev_suite/directory_tree"
 
 module DevSuite
   class Error < StandardError; end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dev_suite
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Huy Nguyen
@@ -61,6 +61,16 @@ files:
 - bin/setup
 - dev_suite.gemspec
 - lib/dev_suite.rb
+- lib/dev_suite/directory_tree.rb
+- lib/dev_suite/directory_tree/node.rb
+- lib/dev_suite/directory_tree/node/base.rb
+- lib/dev_suite/directory_tree/node/directory.rb
+- lib/dev_suite/directory_tree/node/file.rb
+- lib/dev_suite/directory_tree/node/permission_denied.rb
+- lib/dev_suite/directory_tree/renderer.rb
+- lib/dev_suite/directory_tree/renderer/base.rb
+- lib/dev_suite/directory_tree/renderer/simple.rb
+- lib/dev_suite/directory_tree/visualizer.rb
 - lib/dev_suite/performance.rb
 - lib/dev_suite/performance/analyzer.rb
 - lib/dev_suite/performance/data.rb
@@ -73,17 +83,27 @@ files:
 - lib/dev_suite/performance/reportor/base.rb
 - lib/dev_suite/performance/reportor/simple.rb
 - lib/dev_suite/utils.rb
+- lib/dev_suite/utils/color.rb
+- lib/dev_suite/utils/color/colorizer.rb
+- lib/dev_suite/utils/color/config.rb
+- lib/dev_suite/utils/color/palette.rb
+- lib/dev_suite/utils/color/palette/base.rb
+- lib/dev_suite/utils/color/palette/default.rb
+- lib/dev_suite/utils/color/strategy.rb
+- lib/dev_suite/utils/color/strategy/base.rb
+- lib/dev_suite/utils/color/strategy/basic.rb
+- lib/dev_suite/utils/color/strategy/rgb.rb
+- lib/dev_suite/utils/color/strategy/theme.rb
+- lib/dev_suite/utils/table.rb
 - lib/dev_suite/utils/table/column.rb
-- lib/dev_suite/utils/table/column/column.rb
 - lib/dev_suite/utils/table/config.rb
-- lib/dev_suite/utils/table/formatter/colorizer.rb
+- lib/dev_suite/utils/table/formatter.rb
 - lib/dev_suite/utils/table/formatter/column_width_calculator.rb
 - lib/dev_suite/utils/table/formatter/text_aligner.rb
 - lib/dev_suite/utils/table/renderer.rb
 - lib/dev_suite/utils/table/renderer/base.rb
 - lib/dev_suite/utils/table/renderer/simple.rb
 - lib/dev_suite/utils/table/row.rb
-- lib/dev_suite/utils/table/row/row.rb
 - lib/dev_suite/utils/table/table.rb
 - lib/dev_suite/version.rb
 homepage: https://patrick204nqh.github.io

data/lib/dev_suite/utils/table/formatter/colorizer.rb

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-module DevSuite
-  module Utils
-    module Table
-      module Formatter
-        class Colorizer
-          COLORS = {
-            red: 31,
-            green: 32,
-            yellow: 33,
-            blue: 34,
-            magenta: 35,
-            cyan: 36,
-            white: 37,
-            default: 39,
-          }.freeze
-
-          class << self
-            def code_for(color)
-              COLORS[color] || COLORS[:default]
-            end
-
-            def colorize(text, color = :default)
-              color_code = code_for(color)
-              "\e[#{color_code}m#{text}\e[0m"
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/dev_suite/utils/table/row/row.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-module DevSuite
-  module Utils
-    module Table
-      class Row
-        attr_reader :data
-
-        def initialize(data)
-          @data = data
-        end
-      end
-    end
-  end
-end