dev_suite 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 368efd66d4aa6229bbb00ceac32f7c505f35543e2ba5834dc9dd3509f27e4c55
-  data.tar.gz: c2af717b31f413ea03ebdcbdc0b47f70b895c29d66e82f12e685d1b1f7e75657
+  metadata.gz: 18cb4bab59f55347094ab11c9772b132446789b2c5a12cdb0a596b9ccd57ab0b
+  data.tar.gz: 212866e22087fa628633af141c349e9831f0d0ad060018aed0f0cd6742cbfb9e
 SHA512:
-  metadata.gz: eb257b7bc6c8436de804fe32510380319d77d30656259739767fa2739885867df47e0c1a5d6cc1b6111214e272863b1ff0c235c053ff9b71056c622bc8324032
-  data.tar.gz: 4b568c9210885a684b4edfad0d07ddd4a7daab5f4dbcdb959fc4e30870b190e2d9f867fc4dc503b6264f59c4dd877bb1af1dd884f5776a7cbfeec1ef7bdd5076
+  metadata.gz: 29b881d2e2f34f10aced28ff856a56ca75da39c4000c8cd17194d2bd535c7b595799919ba164bf2a55ac61b4e0f3d9833f9e11c028e3fcc51c0b1017ba307aca
+  data.tar.gz: d136f946ff59f6db1d5ac5d14447d302ed6f85df55e1c4b64af2f0cc5a54efa2a48ec4aaffa2a520cb455195af4300aeb0c3ae606da6c4b7aba19ca66a5a6e32

data/Gemfile

@@ -7,6 +7,6 @@ gemspec
 
 gem "rake", "~> 13.0"
 gem "rspec", "~> 3.9"
-gem "rubocop", "~> 1.65"
-gem "rubocop-shopify", "~> 2.15"
+gem "rubocop", "~> 1.65", require: false
+gem "rubocop-shopify", "~> 2.15", require: false
 gem "pry", "~> 0.14"

data/Gemfile.lock

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

data/README.md

@@ -1,5 +1,8 @@
 # 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)
+
 Welcome to DevSuite! This gem provides a suite of utilities for developers to enhance their productivity.
 
 ## Installation
@@ -40,7 +43,7 @@ DevSuite::SomeUtility.do_something
 ## Features
 
 <details>
-  <summary><strong>Performance Analysis with DevSuite::Performance::Analyzer</strong></summary>
+  <summary><strong>Performance Analysis</strong></summary>
   
   Analyze the performance of your code blocks with detailed benchmark and memory usage reports.
   
@@ -49,10 +52,34 @@ DevSuite::SomeUtility.do_something
   require 'dev_suite'
 
   DevSuite::Performance::Analyzer.analyze(description: "My Code Block") do
-    # Your code here
+    sum = 0
+    1_000_000.times do |i|
+      sum += i
+    end
+    sum
   end
   ```
-</detail>
+
+  **Example 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         |
+  ```
+</details>
+
 
 ## Development
 
@@ -84,4 +111,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the DevSuite project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/patrick204nqh/dev_suite/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the DevSuite project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/patrick204nqh/dev_suite/blob/master/CODE_OF_CONDUCT.md).

data/dev_suite.gemspec

@@ -9,8 +9,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["patrick204nqh@gmail.com"]
 
   spec.summary       = "A suite of development tools."
-  spec.description   = "Provides tools for performance analysis, folder structure visualization, " \
-    "and custom curl command generation."
+  spec.description   = "This gem provides a suite of utilities for developers to enhance their productivity."
   spec.homepage      = "https://patrick204nqh.github.io"
   spec.license       = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")

data/lib/dev_suite/performance/analyzer.rb

@@ -1,8 +1,7 @@
 # frozen_string_literal: true
 
-require_relative "reporting/report_generator"
-require_relative "profiling/benchmark_profiler"
-require_relative "profiling/memory_profiler"
+require_relative "reportor"
+require_relative "profiler"
 
 module DevSuite
   module Performance
@@ -21,8 +20,8 @@ module DevSuite
 
       def initialize(description: "Block")
         @description = description
-        @benchmark_profiler = Profiling::BenchmarkProfiler.new
-        @memory_profiler = Profiling::MemoryProfiler.new
+        @benchmark_profiler = Profiler::Benchmark.new
+        @memory_profiler = Profiler::Memory.new
         @memory_usage = Data::MemoryUsage.new
       end
 
@@ -54,12 +53,12 @@ module DevSuite
       # @param benchmark_result [Benchmark::Tms] The benchmark result
       # @param memory_stats [Hash] The memory statistics
       def generate_report(benchmark_result, memory_stats)
-        report_generator = Reporting::ReportGenerator.new(
+        reportor = Reportor::Simple.new(
           @description,
           benchmark_result,
           memory_stats,
         )
-        report_generator.generate
+        reportor.generate
       end
     end
   end

data/lib/dev_suite/performance/data.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module Performance
+    module Data
+      require_relative "data/memory_usage"
+    end
+  end
+end

data/lib/dev_suite/performance/{profiling/base_profiler.rb → profiler/base.rb}

@@ -2,8 +2,8 @@
 
 module DevSuite
   module Performance
-    module Profiling
-      class BaseProfiler
+    module Profiler
+      class Base
         def run(&block)
           raise NotImplementedError, "Subclasses must implement the run method"
         end

data/lib/dev_suite/performance/{profiling/benchmark_profiler.rb → profiler/benchmark.rb}

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
 require "benchmark"
-require_relative "base_profiler"
+require_relative "base"
 
 module DevSuite
   module Performance
-    module Profiling
-      class BenchmarkProfiler < BaseProfiler
+    module Profiler
+      class Benchmark < Base
         def run(&block)
-          Benchmark.measure do
+          ::Benchmark.measure do
             block.call
           end
         end

data/lib/dev_suite/performance/{profiling/memory_profiler.rb → profiler/memory.rb}

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-require_relative "base_profiler"
+require_relative "base"
 require_relative "../data/memory_usage"
 
 module DevSuite
   module Performance
-    module Profiling
-      class MemoryProfiler < BaseProfiler
+    module Profiler
+      class Memory < Base
         attr_reader :max_memory, :min_memory, :average_memory
 
         def initialize

data/lib/dev_suite/performance/profiler.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module Performance
+    module Profiler
+      require_relative "profiler/benchmark"
+      require_relative "profiler/memory"
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module DevSuite
+  module Performance
+    module Reportor
+      class Base
+        def generate
+          raise NotImplementedError, "Subclasses must implement the generate method"
+        end
+      end
+    end
+  end
+end

data/lib/dev_suite/performance/{reporting/report_generator.rb → reportor/simple.rb}

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
-require_relative "../../utils/table/table"
-require_relative "../../utils/table/config"
-require_relative "../../utils/table/renderer/simple"
+require_relative "base"
+require_relative "../../utils"
 
 module DevSuite
   module Performance
-    module Reporting
-      class ReportGenerator
+    module Reportor
+      class Simple < Base
         def initialize(description, benchmark_result, memory_stats)
+          super()
           @description = description
           @benchmark_result = benchmark_result
           @memory_stats = memory_stats

data/lib/dev_suite/performance/reportor.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module Performance
+    module Reporting
+      require_relative "reportor/simple"
+    end
+  end
+end

data/lib/dev_suite/performance.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module Performance
+    require_relative "performance/analyzer"
+  end
+end

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module Utils
+    module Table
+      module Column
+        require_relative "column/column"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module Utils
+    module Table
+      module Renderer
+        require_relative "renderer/base"
+        require_relative "renderer/simple"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module Utils
+    module Table
+      module Row
+        require_relative "row/row"
+      end
+    end
+  end
+end

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

@@ -2,7 +2,7 @@
 
 require_relative "column/column"
 require_relative "row/row"
-require_relative "renderer/simple"
+require_relative "renderer"
 require_relative "config"
 
 module DevSuite

data/lib/dev_suite/utils.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module Utils
+    require_relative "utils/table/table"
+    require_relative "utils/table/config"
+    require_relative "utils/table/renderer/simple"
+  end
+end

data/lib/dev_suite/version.rb

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

data/lib/dev_suite.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dev_suite
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Huy Nguyen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-09 00:00:00.000000000 Z
+date: 2024-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: benchmark
@@ -38,8 +38,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
-description: Provides tools for performance analysis, folder structure visualization,
-  and custom curl command generation.
+description: This gem provides a suite of utilities for developers to enhance their
+  productivity.
 email:
 - patrick204nqh@gmail.com
 executables: []
@@ -61,19 +61,28 @@ files:
 - bin/setup
 - dev_suite.gemspec
 - lib/dev_suite.rb
+- lib/dev_suite/performance.rb
 - lib/dev_suite/performance/analyzer.rb
+- lib/dev_suite/performance/data.rb
 - lib/dev_suite/performance/data/memory_usage.rb
-- lib/dev_suite/performance/profiling/base_profiler.rb
-- lib/dev_suite/performance/profiling/benchmark_profiler.rb
-- lib/dev_suite/performance/profiling/memory_profiler.rb
-- lib/dev_suite/performance/reporting/report_generator.rb
+- lib/dev_suite/performance/profiler.rb
+- lib/dev_suite/performance/profiler/base.rb
+- lib/dev_suite/performance/profiler/benchmark.rb
+- lib/dev_suite/performance/profiler/memory.rb
+- lib/dev_suite/performance/reportor.rb
+- lib/dev_suite/performance/reportor/base.rb
+- lib/dev_suite/performance/reportor/simple.rb
+- lib/dev_suite/utils.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/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