dev_suite 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 18cb4bab59f55347094ab11c9772b132446789b2c5a12cdb0a596b9ccd57ab0b
-  data.tar.gz: 212866e22087fa628633af141c349e9831f0d0ad060018aed0f0cd6742cbfb9e
+  metadata.gz: b962be05b7f06443a5620effcba37759712b4a930654f28782280bdcfb975698
+  data.tar.gz: 3d3987ce785c0211d279a382fcd0dace11ce3e66861629b613e1857ddf9064c5
 SHA512:
-  metadata.gz: 29b881d2e2f34f10aced28ff856a56ca75da39c4000c8cd17194d2bd535c7b595799919ba164bf2a55ac61b4e0f3d9833f9e11c028e3fcc51c0b1017ba307aca
-  data.tar.gz: d136f946ff59f6db1d5ac5d14447d302ed6f85df55e1c4b64af2f0cc5a54efa2a48ec4aaffa2a520cb455195af4300aeb0c3ae606da6c4b7aba19ca66a5a6e32
+  metadata.gz: f5cc89b151a1224cd7fa29c65c05a0d873e400585ad949e5f5b6278bb23aacfda90367036372f659f5596e948217b63cc00a71c71cfcc1a20fe4c72076227257
+  data.tar.gz: 13998cef95d7658837462bb319f5af0664302eeeb54168fc1fe0c9049f3f287df8887665d27eaf69009789cac71541b3d0e457d3f456ce2af35557d2832b2248

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dev_suite (0.1.1)
+    dev_suite (0.1.2)
       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/directory_tree/node/base.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module DevSuite
+  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
+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,61 @@
+# 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 Node::PermissionDenied.new(path.basename.to_s, path.directory?) unless path.readable?
+
+          if path.directory?
+            dir = Node::Directory.new(path.basename.to_s)
+            children = path.children.sort_by { |child| child.basename.to_s.downcase }
+            children.each do |child|
+              dir.add_child(build_tree(child))
+            end
+            dir
+          else
+            Node::File.new(path.basename.to_s)
+          end
+        rescue Errno::EACCES
+          Node::PermissionDenied.new(path.basename.to_s, path.directory?)
+        end
+
+        def render_node(node, prefix = "", is_last = true)
+          # Determine if this is the root node based on the prefix content
+          is_root = prefix.empty?
+
+          # Prepare the connector appropriately, omitting it for the root
+          connector = if is_root
+            ""
+          else
+            (is_last ? "└── " : "├── ")
+          end
+
+          # Compute the new prefix for children
+          new_prefix = "#{prefix}#{is_last ? "    " : "|   "}"
+
+          # Construct the output for the current node, avoiding the connector for the root
+          output = "#{prefix}#{connector}#{node.name}"
+          output += "/\n" if node.directory?
+
+          # Recursively render children if it's a directory
+          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
+          elsif !node.directory?
+            output += "\n"
+          end
+
+          output
+        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/version.rb

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

data/lib/dev_suite.rb

@@ -2,6 +2,7 @@
 
 require "dev_suite/version"
 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.2
 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