dev_suite 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92f5e3450bc8b204f0be7e25db8a863ebd49d4d5a6990cfad7c6d336ccaf7e5e
-  data.tar.gz: 368e6bd01867d4fc92856b8bc4825e1e5bdc2b3b978e3afa0966139f59216f28
+  metadata.gz: 76f0e8870b8fe2bb1c8af41e541bd09f792662f49c1a869d5ddcf5fd4ae94584
+  data.tar.gz: 17a921feedc29e07133ce357fbb3b37ecd15800cd30f4fd3087d62f4a810970d
 SHA512:
-  metadata.gz: 973f1f20d18eab20229c5df12a304c1370ccbfc56175795c9e55fc6bc2680c0a3a3adae63472bcd3dc15ed964ba4413a5847a55d8fefc28312a119af9b0b91d5
-  data.tar.gz: f31d767559b8cd4fbfa961cafef17a5cbbcda42a78ee5e012147a96a2652fd8b3417e1184a1e5a60925032aa21b6d256902753c799c322aa48e5240016b6f901
+  metadata.gz: a32bb7865ee17f49b639d687950cfafeecc51df0dc9e2e7a7ef62018ea185fd522081f8c7b70c0346d0b77ec4d119030c7e9464cf38f4928dad11ee756baa01a
+  data.tar.gz: 668586bdbd2339888ef486a5e2fb424aa0f3532d8fa80e27f92f569e59506b2237852683725560e55109eb93c5af63d51e6333aceea5dcb018604574733be5ef

data/Gemfile.lock

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

data/README.md

@@ -51,7 +51,7 @@ DevSuite::SomeUtility.do_something
   ```ruby
   require 'dev_suite'
 
-  DevSuite::Performance::Analyzer.analyze(description: "My Code Block") do
+  DevSuite::Performance.analyze(description: "My Code Block") do
     sum = 0
     1_000_000.times do |i|
       sum += i
@@ -93,7 +93,7 @@ DevSuite::SomeUtility.do_something
   base_path = "/path/to/your/directory"
 
   # Perform the visualization
-  DevSuite::DirectoryTree::Visualizer.visualize(base_path)
+  DevSuite::DirectoryTree.visualize(base_path)
   ```
 
   **Example output**

data/lib/dev_suite/directory_tree/config.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module DirectoryTree
+    class Config
+      attr_reader :renderer
+
+      def initialize(renderer: :simple)
+        @renderer = Renderer.create(renderer)
+        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

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

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "base"
-
 module DevSuite
   module DirectoryTree
     module Node

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

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "base"
-
 module DevSuite
   module DirectoryTree
     module Node

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

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "base"
-
 module DevSuite
   module DirectoryTree
     module Node

data/lib/dev_suite/directory_tree/node.rb

@@ -3,6 +3,7 @@
 module DevSuite
   module DirectoryTree
     module Node
+      require_relative "node/base"
       require_relative "node/file"
       require_relative "node/directory"
       require_relative "node/permission_denied"

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

@@ -6,17 +6,24 @@ module DevSuite
   module DirectoryTree
     module Renderer
       class Base
-        def initialize(base_path)
-          @base_path = Pathname.new(base_path)
-        end
+        def render(path)
+          raise ArgumentError, "Invalid path" unless valid_path?(path)
 
-        def render
-          root = build_tree(@base_path)
+          root = build_tree(Pathname.new(path))
           render_node(root, "", true)
         end
 
         private
 
+        def valid_path?(path)
+          [
+            path.is_a?(String),
+            ::File.exist?(path),
+            ::File.directory?(path),
+            ::File.readable?(path),
+          ].all?
+        end
+
         # Builds the tree structure
         # @param path [Pathname] The path to build the tree from
         # @return [Node::Base] The root node of the tree

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

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "base"
-require_relative "../node"
-
 module DevSuite
   module DirectoryTree
     module Renderer

data/lib/dev_suite/directory_tree/renderer.rb

@@ -3,7 +3,19 @@
 module DevSuite
   module DirectoryTree
     module Renderer
+      require_relative "renderer/base"
       require_relative "renderer/simple"
+
+      class << self
+        def create(type)
+          case type
+          when :simple
+            Simple.new
+          else
+            raise ArgumentError, "Unknown renderer type: #{type}"
+          end
+        end
+      end
     end
   end
 end

data/lib/dev_suite/directory_tree/visualizer.rb

@@ -1,25 +1,27 @@
 # 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
+      attr_reader :config
+
+      def initialize(config = Config.configuration)
+        @config = config
       end
 
-      def initialize(base_path, renderer: Renderer::Simple.new(base_path))
-        @renderer = renderer
+      # Visualizes the directory tree
+      # @param path [String] The base path of the directory
+      def visualize(path)
+        puts @config.renderer.render(path)
       end
+    end
 
-      def visualize
-        puts @renderer.render
+    class << self
+      def visualize(path)
+        visualizer = Visualizer.new
+        visualizer.visualize(path)
       end
     end
   end

data/lib/dev_suite/directory_tree.rb

@@ -2,6 +2,9 @@
 
 module DevSuite
   module DirectoryTree
+    require_relative "directory_tree/node"
+    require_relative "directory_tree/renderer"
     require_relative "directory_tree/visualizer"
+    require_relative "directory_tree/config"
   end
 end

data/lib/dev_suite/performance/analyzer.rb

@@ -1,23 +1,8 @@
 # frozen_string_literal: true
 
-require_relative "reportor"
-require_relative "profiler"
-
 module DevSuite
   module Performance
     class Analyzer
-      class << self
-        # Generates a performance report
-        # @param benchmark_result [Benchmark::Tms] The benchmark result
-        # @param memory_stats [Hash] The memory statistics
-        def analyze(description: "Block", &block)
-          raise ArgumentError, "No block given" unless block_given?
-
-          analyzer = new(description: description)
-          analyzer.analyze(&block)
-        end
-      end
-
       def initialize(description: "Block")
         @description = description
         @benchmark_profiler = Profiler::Benchmark.new
@@ -29,6 +14,8 @@ module DevSuite
       # @param block [Proc] The block to be analyzed
       # @raise [ArgumentError] If no block is given
       def analyze(&block)
+        raise ArgumentError, "No block given" unless block_given?
+
         memory_before = @memory_usage.current
         benchmark_result = profile_benchmark(&block)
         memory_after = @memory_usage.current
@@ -61,5 +48,12 @@ module DevSuite
         reportor.generate
       end
     end
+
+    class << self
+      def analyze(description: "Block", &block)
+        analyzer = Analyzer.new(description: description)
+        analyzer.analyze(&block)
+      end
+    end
   end
 end

data/lib/dev_suite/performance/profiler/benchmark.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "benchmark"
-require_relative "base"
 
 module DevSuite
   module Performance

data/lib/dev_suite/performance/profiler/memory.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "base"
-require_relative "../data/memory_usage"
-
 module DevSuite
   module Performance
     module Profiler

data/lib/dev_suite/performance/profiler.rb

@@ -3,6 +3,7 @@
 module DevSuite
   module Performance
     module Profiler
+      require_relative "profiler/base"
       require_relative "profiler/benchmark"
       require_relative "profiler/memory"
     end

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

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "base"
-
 module DevSuite
   module Performance
     module Reportor

data/lib/dev_suite/performance/reportor.rb

@@ -3,6 +3,7 @@
 module DevSuite
   module Performance
     module Reporting
+      require_relative "reportor/base"
       require_relative "reportor/simple"
     end
   end

data/lib/dev_suite/performance.rb

@@ -2,6 +2,9 @@
 
 module DevSuite
   module Performance
+    require_relative "performance/data"
+    require_relative "performance/profiler"
+    require_relative "performance/reportor"
     require_relative "performance/analyzer"
   end
 end

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

@@ -3,12 +3,6 @@
 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
 
@@ -20,6 +14,15 @@ module DevSuite
           puts @config.strategy.colorize(text, **kargs)
         end
       end
+
+      class << self
+        def colorize(text, **kargs)
+          raise ArgumentError, "Text to colorize must be a string" unless text.is_a?(String)
+
+          colorizer = Colorizer.new
+          colorizer.colorize(text, **kargs)
+        end
+      end
     end
   end
 end

data/lib/dev_suite/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dev_suite
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Huy Nguyen
@@ -62,6 +62,7 @@ files:
 - dev_suite.gemspec
 - lib/dev_suite.rb
 - lib/dev_suite/directory_tree.rb
+- lib/dev_suite/directory_tree/config.rb
 - lib/dev_suite/directory_tree/node.rb
 - lib/dev_suite/directory_tree/node/base.rb
 - lib/dev_suite/directory_tree/node/directory.rb