dev_suite 0.2.2 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eca02b15867ef75a77fed4586931ab72a98c33202dd3792daf44cc208c0f9e72
-  data.tar.gz: b6bc4187d4e93978fab552d47178792efb7862c9055f868469b138ee37e755e0
+  metadata.gz: 6765c4b9fa4637dafaac36da47cd8adf18652cd0d38804ddcd8641b851669f12
+  data.tar.gz: 3a3b27ad8b9fa4319829175995b1d6ea999e9877d537b1316b531247d6bd4b53
 SHA512:
-  metadata.gz: 70e87b35875abc89df1823e80fd6fda525eb019e992b8e454cdf22043b98b0b731cdc6b111af15ca23bb8818857de387ae996adbeb1d0920413dbe807804119e
-  data.tar.gz: 9c4396647818118bde2c5c82a3b9f0d5ce2775d3c53812070071b4b3d37ebc931786214a3a8a8b6c3c151eb64904bebcf61298ba915dbd99baf64c1e54d13737
+  metadata.gz: c2c9a91ccdfe89d997d66e8441d0b130dacc9edeb5fae6a3f949f1e25ff9aec09c41603597dbc7e017e9e3857c838e88182e4b670c220ea376d28934eb45c6e4
+  data.tar.gz: 4f2e69b97a36b68eb84d2c808ede9072b6f333aebe7f2049d16dc7c55e99592604e9e7234b36471d8d84208fec05cfa27b8ce9b942e93d566159209d7fe652d2

data/.github/workflows/ci.yml

@@ -0,0 +1,37 @@
+name: CI
+
+on:
+  push:
+    branches: [master]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v2
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.0  # Specify your project's Ruby version
+
+      - name: Install dependencies
+        run: bundle install
+
+      - name: Run tests
+        env:
+          CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
+        run: |
+          bundle exec rspec
+
+      - name: Upload coverage to Code Climate
+        env:
+          CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
+        run: |
+          curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+          chmod +x ./cc-test-reporter
+          ./cc-test-reporter before-build
+          bundle exec rspec
+          ./cc-test-reporter after-build --exit-code $?

data/Gemfile

@@ -2,11 +2,16 @@
 
 source "https://rubygems.org"
 
-# Specify your gem's dependencies in dev_suite.gemspec
+# Use the gemspec method to include dependencies specified in the gemspec file
 gemspec
 
-gem "rake", "~> 13.0"
-gem "rspec", "~> 3.9"
-gem "rubocop", "~> 1.65", require: false
-gem "rubocop-shopify", "~> 2.15", require: false
-gem "pry", "~> 0.14"
+# Additional development tools not required as part of the gem's runtime
+group :development, :test do
+  gem "rake", "~> 13.0"
+  gem "pry", "~> 0.14"
+end
+
+group :development do
+  gem "rubocop", "~> 1.65", require: false
+  gem "rubocop-shopify", "~> 2.15", require: false
+end

data/Gemfile.lock

@@ -1,17 +1,20 @@
 PATH
   remote: .
   specs:
-    dev_suite (0.2.2)
+    dev_suite (0.2.4)
       benchmark (~> 0.1)
-      get_process_mem (~> 0.2)
+      get_process_mem (~> 1.0)
+      thor (~> 1.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
     benchmark (0.3.0)
+    bigdecimal (3.1.8)
     coderay (1.1.3)
     diff-lcs (1.5.1)
+    docile (1.4.1)
     ffi (1.17.0)
     ffi (1.17.0-aarch64-linux-gnu)
     ffi (1.17.0-aarch64-linux-musl)
@@ -23,7 +26,8 @@ GEM
     ffi (1.17.0-x86_64-darwin)
     ffi (1.17.0-x86_64-linux-gnu)
     ffi (1.17.0-x86_64-linux-musl)
-    get_process_mem (0.2.7)
+    get_process_mem (1.0.0)
+      bigdecimal (>= 2.0)
       ffi (~> 1.0)
     json (2.7.2)
     language_server-protocol (3.17.0.3)
@@ -70,7 +74,14 @@ GEM
     rubocop-shopify (2.15.1)
       rubocop (~> 1.51)
     ruby-progressbar (1.13.0)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
     strscan (3.1.0)
+    thor (1.3.1)
     unicode-display_width (2.5.0)
 
 PLATFORMS
@@ -93,6 +104,7 @@ DEPENDENCIES
   rspec (~> 3.9)
   rubocop (~> 1.65)
   rubocop-shopify (~> 2.15)
+  simplecov (~> 0.21)
 
 BUNDLED WITH
    2.5.17

data/README.md

@@ -1,7 +1,12 @@
 # DevSuite
 
-[![Gem Version](https://badge.fury.io/rb/dev_suite.svg)](https://badge.fury.io/rb/dev_suite)
-[![Code Climate](https://codeclimate.com/github/patrick204nqh/dev_suite/badges/gpa.svg)](https://codeclimate.com/github/patrick204nqh/dev_suite)
+[![Gem Version](https://img.shields.io/gem/v/dev_suite?color=blue)](https://rubygems.org/gems/dev_suite)
+[![Gem Downloads](https://img.shields.io/gem/dt/dev_suite?color=blue)](https://rubygems.org/gems/dev_suite)
+[![Maintainability](https://api.codeclimate.com/v1/badges/fd83689d39e0f24663fa/maintainability)](https://codeclimate.com/github/patrick204nqh/dev_suite/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/fd83689d39e0f24663fa/test_coverage)](https://codeclimate.com/github/patrick204nqh/dev_suite/test_coverage)
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=patrick204nqh_dev_suite&metric=alert_status)](https://sonarcloud.io/summary/overall?id=patrick204nqh_dev_suite)
+[![Dependencies Status](https://badges.depfu.com/badges/84fefb47a5b99ea19afd20a2aae22e3e/overview.svg)](https://depfu.com/github/patrick204nqh/dev_suite?project_id=44065)
+[![Known Vulnerabilities](https://snyk.io/test/github/patrick204nqh/dev_suite/badge.svg)](https://snyk.io/test/github/patrick204nqh/dev_suite)
 
 Welcome to DevSuite! This gem provides a suite of utilities for developers to enhance their productivity.
 
@@ -40,82 +45,100 @@ require 'dev_suite'
 DevSuite::SomeUtility.do_something
 ```
 
-## Features
+### CLI Commands
 
+DevSuite also provides a command-line interface for various utilities. Below are some general commands:
+
+| Command            | Description                         |
+|--------------------|-------------------------------------|
+| `devsuite version` | Displays the version of DevSuite    |
+| `devsuite help`    | Shows help information for commands |
+
+## Features Overview
+
+### Performance Analysis
 <details>
-  <summary><strong>Performance Analysis</strong></summary>
-  
-  Analyze the performance of your code blocks with detailed benchmark and memory usage reports.
+  <summary>Show more</summary>
   
-  **Usage:**
+  **Purpose**: Quickly analyze the performance of Ruby code blocks, capturing metrics like execution time and memory usage.
+
+  **How to Use**:
   ```ruby
   require 'dev_suite'
-
-  DevSuite::Performance.analyze(description: "My Code Block") do
+  
+  DevSuite::Performance.analyze(description: "Example Analysis") do
     sum = 0
-    1_000_000.times do |i|
-      sum += i
-    end
+    1_000_000.times { |i| sum += i }
     sum
   end
   ```
 
-  **Example output**
+  **Sample Output**:
   ```
-  |            Performance Analysis            |
-  +----------------------------+---------------+
-  | Metric                     | Value         |
-  +----------------------------+---------------+
-  | Description                | My Code Block |
-  | Total Time (s)             | 0.056238      |
-  | User CPU Time (s)          | 0.055662      |
-  | System CPU Time (s)        | 0.000097      |
-  | User + System CPU Time (s) | 0.055759      |
-  | Memory Before (MB)         | 25.39         |
-  | Memory After (MB)          | 25.42         |
-  | Memory Used (MB)           | 0.03          |
-  | Max Memory Used (MB)       | 25.41         |
-  | Min Memory Used (MB)       | 25.41         |
-  | Avg Memory Used (MB)       | 25.41         |
+| Metric              | Value            |
+|---------------------|------------------|
+| Description         | Example Analysis |
+| Total Time (s)      | 0.056238         |
+| User CPU Time (s)   | 0.055662         |
+| System CPU Time (s) | 0.000097         |
+| Memory Before (MB)  | 25.39            |
+| Memory After (MB)   | 25.42            |
+| Memory Used (MB)    | 0.03             |
   ```
 </details>
 
+### Directory Tree Visualization
 <details>
-  <summary><strong>Directory Tree Visualization</strong></summary>
+  <summary>Show more</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.
+  **Purpose**: Visualize the file structure of directories and subdirectories to better understand project organization.
 
-  **Usage:**
+  **How to Use**:
   ```ruby
   require 'dev_suite'
 
-  # Set the base path for the directory you want to visualize
+  # Define the directory path
   base_path = "/path/to/your/directory"
 
-  # Perform the visualization
+  # Execute the visualization
   DevSuite::DirectoryTree.visualize(base_path)
   ```
 
-  **Configuring the Visualization:**
+  **CLI Command**:
+  DevSuite also provides a command-line interface for directory tree visualization. Use the following command to print the directory tree of the specified path:
 
+  ```sh
+  $ devsuite tree [PATH] [OPTIONS]
+  ```
+
+  **CLI Options**:
+  
+  Below is a table describing the available options for the `devsuite tree` command:
+
+  | Option          | Description                                      | Example Usage                                  |
+  |-----------------|--------------------------------------------------|------------------------------------------------|
+  | `--depth`, `-d` | Limit the depth of the directory tree displayed. | `$ devsuite tree /path --depth 2`              |
+  | `--skip-hidden` | Skip hidden files and directories.               | `$ devsuite tree /path --skip-hidden`          |
+  | `--skip-types`  | Exclude files of specific types.                 | `$ devsuite tree /path --skip-types .log .tmp` |
+
+  **Configuration Guide**:
+  Customize the visualization by setting configuration options:
   ```ruby
   DevSuite::DirectoryTree::Config.configure do |config|
-      config.settings.set(:skip_hidden, true)
-      # ...
+    config.settings.set(:skip_hidden, true)
+    # ...
   end
   ```
 
-  **Available Configuration Options:**
+  **Configuration Options**:
+| Setting        | Description                                       | Example Values           |
+|----------------|---------------------------------------------------|--------------------------|
+| `:skip_hidden` | Skips hidden files and directories.               | `true`, `false`          |
+| `:max_depth`   | Limits the depth of the directory tree displayed. | `1`, `2`, `3`, ...       |
+| `:skip_types`  | Excludes files of specific types.                 | `['.log', '.tmp']`, `[]` |
 
-  | Setting        | Description                                      | Example Values           |
-  | -------------- | ------------------------------------------------ | ------------------------ |
-  | `:skip_hidden` | Skip hidden files and directories.               | `true`, `false`          |
-  | `:max_depth`   | Limit the depth of the directory tree displayed. | `1`, `2`, `3`, ...       |
-  | `:skip_types`  | Exclude files of specific types.                 | `['.log', '.tmp']`, `[]` |
-
-  **Example output**
-
-  ```bash
+  **Sample Output**:
+  ```
   /path/to/your/directory/
   ├── project/
   │   ├── src/

data/dev_suite.gemspec

@@ -29,6 +29,12 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  # Runtime dependencies
   spec.add_dependency("benchmark", "~> 0.1")
-  spec.add_dependency("get_process_mem", "~> 0.2")
+  spec.add_dependency("get_process_mem", "~> 1.0")
+  spec.add_dependency("thor", "~> 1.1")
+
+  # Development dependencies
+  spec.add_development_dependency("rspec", "~> 3.9")
+  spec.add_development_dependency("simplecov", "~> 0.21")
 end

data/exe/devsuite

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative "../lib/dev_suite"
+
+DevSuite::CLI::Main.start(ARGV)

data/lib/dev_suite/cli/commands/base.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module CLI
+    module Commands
+      class Base < Thor
+        include ErrorHandler
+
+        desc "execute", "Execute the command"
+        def execute
+          raise NotImplementedError
+        end
+      end
+    end
+  end
+end

data/lib/dev_suite/cli/commands/tree.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module CLI
+    module Commands
+      class Tree < Base
+        desc "visualize PATH", "Visualize the directory structure at given PATH"
+        def execute(path, options: {})
+          Logger.log("Starting visualization for: #{path}", emoji: :start)
+
+          apply_configure(options)
+          visualize(path)
+
+          Logger.log("Visualization complete!", emoji: :success)
+        rescue StandardError => e
+          ErrorHandler.handle_error(e)
+        end
+
+        private
+
+        def visualize(path)
+          DirectoryTree.visualize(path)
+        end
+
+        def apply_configure(options)
+          option_config_mapping = {
+            depth: :max_depth,
+            skip_hidden: :skip_hidden,
+            skip_types: :skip_types,
+          }
+
+          DirectoryTree::Config.configure do |config|
+            option_config_mapping.each do |option_key, config_key|
+              value = options[option_key]
+              config.settings.set(config_key, value) if value
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dev_suite/cli/commands/version.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module CLI
+    module Commands
+      class Version < Base
+        def execute
+          Logger.log("DevSuite version: #{DevSuite::VERSION} is live!", emoji: :start)
+        end
+      end
+    end
+  end
+end

data/lib/dev_suite/cli/commands.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module CLI
+    module Commands
+      require_relative "commands/base"
+      require_relative "commands/version"
+      require_relative "commands/tree"
+    end
+  end
+end

data/lib/dev_suite/cli/main.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module CLI
+    class Main < Thor
+      desc "tree DIRECTORY", "Prints the directory tree"
+      method_option :depth, aliases: "-d", type: :numeric, desc: "Limit the depth of the directory tree displayed"
+      method_option :skip_hidden, type: :boolean, default: false, desc: "Skip hidden files and directories"
+      method_option :skip_types,
+        type: :array,
+        default: [],
+        banner: "TYPE1 TYPE2",
+        desc: "Exclude files of specific types"
+      def tree(path = ".")
+        execute_command(Commands::Tree, path, options: options)
+      end
+
+      desc "version", "Displays the version of the dev_suite gem"
+      def version
+        execute_command(Commands::Version)
+      end
+
+      private
+
+      def execute_command(command_class, *args, **kargs)
+        command_class.new.execute(*args, **kargs)
+      rescue StandardError => e
+        ErrorHandler.handle_error(e)
+      end
+    end
+  end
+end

data/lib/dev_suite/cli.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module CLI
+    require "thor"
+
+    require_relative "cli/commands"
+
+    # Main CLI class
+    require_relative "cli/main"
+  end
+end

data/lib/dev_suite/directory_tree/config.rb

@@ -5,13 +5,38 @@ module DevSuite
     class Config
       include Utils::ConfigTools::Configuration
 
-      attr_reader :settings, :builder, :renderer
+      # Define configuration attributes
+      config_attr :settings, default_value: {}
+      config_attr :builder, default_value: :base
+      config_attr :renderer, default_value: :simple
+      config_attr :visualizer, default_value: :tree
 
-      def initialize(settings: {}, builder: :base, renderer: :simple)
-        @settings = Settings.new(settings)
-        @builder = Builder.create(builder)
-        @renderer = Renderer.create(renderer)
-        freeze # Make the instance of this class immutable as well
+      private
+
+      def validate_attr!(attr, value)
+        case attr
+        when :settings
+          validate_hash!(attr, value)
+        when :builder, :renderer, :visualizer
+          validate_symbol!(attr, value)
+        else
+          raise ArgumentError, "Invalid attribute: #{attr}"
+        end
+      end
+
+      def resolve_attr(attr, value)
+        case attr
+        when :settings
+          Settings.new(value)
+        when :builder
+          Builder.create(value)
+        when :renderer
+          Renderer.create(value)
+        when :visualizer
+          Visualizer.create(value)
+        else
+          super # Return the value directly if no special resolution is needed
+        end
       end
     end
   end

data/lib/dev_suite/directory_tree/directory_tree.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module DirectoryTree
+    require "pathname"
+
+    require_relative "node"
+    require_relative "config"
+    require_relative "settings"
+    require_relative "renderer"
+    require_relative "builder"
+    require_relative "visualizer"
+
+    class << self
+      def visualize(path)
+        visualizer = Config.configuration.visualizer
+        visualizer.visualize(path)
+      end
+    end
+  end
+end

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

@@ -40,15 +40,15 @@ module DevSuite
         end
 
         def hidden_file_skipped?(node)
-          settings.skip_hidden? && node.hidden?
+          settings.get(:skip_hidden) && node.hidden?
         end
 
         def filetype_skipped?(node)
-          node.file? && settings.skip_types.include?(::File.extname(node.name))
+          node.file? && settings.get(:skip_types).include?(::File.extname(node.name))
         end
 
         def exceeds_max_depth?(depth)
-          max_depth = settings.max_depth
+          max_depth = settings.get(:max_depth)
           max_depth && depth > max_depth
         end
 

data/lib/dev_suite/directory_tree/settings.rb

@@ -10,20 +10,9 @@ module DevSuite
           skip_hidden: false,
           skip_types: [],
           max_depth: nil,
+          max_size: 100 * 1024 * 1024, # 100 MB
         }
       end
-
-      def skip_hidden?
-        get(:skip_hidden)
-      end
-
-      def skip_types
-        get(:skip_types)
-      end
-
-      def max_depth
-        get(:max_depth)
-      end
     end
   end
 end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module DirectoryTree
+    module Visualizer
+      class Base
+        def visualize(path)
+          raise NotImplementedError, "You must implement #{self.class}##{__method}"
+        end
+      end
+    end
+  end
+end

data/lib/dev_suite/directory_tree/visualizer/tree.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module DirectoryTree
+    module Visualizer
+      class Tree < Base
+        # Visualizes the directory tree
+        # @param path [String] The base path of the directory
+        def visualize(path)
+          path = Pathname.new(path)
+          validate_path!(path)
+          validate_size!(path)
+
+          root = build_root_node(path)
+          output = render_output(root)
+
+          puts output
+        end
+
+        private
+
+        def validate_path!(path)
+          raise ArgumentError, "Invalid path" unless path.exist?
+        end
+
+        def validate_size!(path)
+          config = Config.configuration
+          max_size = config.settings.get(:max_size)
+          raise ArgumentError, "Directory too large to render" if directory_size(path) > max_size
+        end
+
+        def directory_size(path)
+          path.children.reduce(0) do |size, child|
+            size + (child.directory? ? directory_size(child) : child.size)
+          end
+        end
+
+        def build_root_node(path)
+          config = Config.configuration
+          config.builder.build(path)
+        end
+
+        def render_output(root)
+          config = Config.configuration
+          config.renderer.render(node: root)
+        end
+      end
+    end
+  end
+end

data/lib/dev_suite/directory_tree/visualizer.rb

@@ -2,20 +2,21 @@
 
 module DevSuite
   module DirectoryTree
-    class Visualizer
-      # Visualizes the directory tree
-      # @param path [String] The base path of the directory
-      def visualize(path)
-        root = Config.configuration.builder.build(Pathname.new(path))
-        renderer = Config.configuration.renderer
-        puts renderer.render(node: root)
-      end
-    end
+    module Visualizer
+      require "pathname"
+
+      require_relative "visualizer/base"
+      require_relative "visualizer/tree"
 
-    class << self
-      def visualize(path)
-        visualizer = Visualizer.new
-        visualizer.visualize(path)
+      class << self
+        def create(type)
+          case type
+          when :tree
+            Tree.new
+          else
+            raise ArgumentError, "Unknown renderer type: #{type}"
+          end
+        end
       end
     end
   end