memory_profiler 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4c8c5a12cd11ab3f9c5ab852e6bca0cb442ccc25f54997f49243a19aa6cef9b
-  data.tar.gz: 5c0ca217ca3cbc0edca725071512688443ac24a5d3e9f28980d93d3dd30a323f
+  metadata.gz: a33279b5aa11573ac4eb1c99c14d8ec0ac944827da175b6eef03d77bc57c652f
+  data.tar.gz: dc21db4963eb3840031d72de3b095a1a3414265dac0cd7df06de0c83ef0b95ad
 SHA512:
-  metadata.gz: 11d3bf57b920c915a0a98f6cea8798349983b0c64047f481ab1227301ff100a8de16f858ee7d21028d32e3dd04015446f77555bfd050755637714da5d1cc08b3
-  data.tar.gz: 46d2df335163a6ddc35ea3a0eff97573dc7b8a50d671e9aa8940a5acb300ea342d7eb38e10f03f39f3705c4e9ed318a336c68f72ddf39a5cdf4f6bb81b9cc7e5
+  metadata.gz: 421e253a198c2bc3881f57ac9f016bf69a5644f96eef211c1073442ce45b6a79021c3af2cdd77a8f916607080127d96a991c7c4fcd7b650ef107dd93161233ee
+  data.tar.gz: 8582b18f48088f242734d353ddd86a09ee9e2a1b2bb1ccdd1e066dd45ed29da2ef3417f2b1a82667c3863445358464f73fdc89e1e715c621d627469fc7b39be4

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 1.0.2 - 17-06-2024
+
+- Add ability to profile commands via CLI @fatkodima
+
 ## 1.0.1 - 23-10-2022
 
 - Adapts tests to Ruby 3.0 / 3.1

data/README.md

@@ -32,14 +32,23 @@ There are two ways to use `memory_profiler`:
 ### Command Line
 
 The easiest way to use memory_profiler is via the command line, which requires no modifications to your program. The basic usage is:
+
+```
+$ ruby-memory-profiler [options] run [--] command [command-options]
 ```
-$ ruby-memory-profiler [options] <script.rb> [--] [script-options]
+
+Example:
+
+```
+$ ruby-memory-profiler --pretty run -- rubocop --cache false
+
+$ ruby-memory-profiler --max=10 --pretty run -- ruby notify_users.rb 1 2 3 --quiet
 ```
-Where `script.rb` is the program you want to profile.
 
 For a full list of options, execute the following command:
+
 ```
-ruby-memory-profiler -h
+$ ruby-memory-profiler -h
 ```
 
 ### Convenience API

data/lib/memory_profiler/autorun.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "memory_profiler"
+require "base64"
+
+def deserialize_hash(data)
+  Marshal.load(Base64.urlsafe_decode64(data)) if data
+end
+
+options = deserialize_hash(ENV["MEMORY_PROFILER_OPTIONS"]) || {}
+
+at_exit do
+  report = MemoryProfiler.stop
+  report.pretty_print(**options)
+end
+
+MemoryProfiler.start(options)

data/lib/memory_profiler/cli.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "optparse"
+require "base64"
 
 module MemoryProfiler
   class CLI
@@ -14,20 +15,6 @@ module MemoryProfiler
       ignore_files: "memory_profiler/lib"
     }.freeze
 
-    REPORTER_KEYS = [
-      :top, :trace, :ignore_files, :allow_files
-    ].freeze
-
-    RESULTS_KEYS = [
-      :to_file, :color_output, :retained_strings, :allocated_strings,
-      :detailed_report, :scale_bytes, :normalize_paths
-    ].freeze
-
-    private_constant :BIN_NAME, :VERSION_INFO,:STATUS_SUCCESS, :STATUS_ERROR,
-                     :DEFAULTS, :REPORTER_KEYS, :RESULTS_KEYS
-
-    #
-
     def run(argv)
       options = {}
       parser = option_parser(options)
@@ -43,17 +30,24 @@ module MemoryProfiler
         return STATUS_ERROR
       end
 
-      MemoryProfiler.start(reporter_options(options))
-      load script
-
-      STATUS_SUCCESS
+      if script == "run"
+        # We are profiling a command.
+        profile_command(options, argv)
+      else
+        # We are profiling a ruby file.
+        begin
+          MemoryProfiler.start(options)
+          load(script)
+        ensure
+          report = MemoryProfiler.stop
+          report.pretty_print(**options)
+        end
+        STATUS_SUCCESS
+      end
     rescue OptionParser::InvalidOption, OptionParser::InvalidArgument, OptionParser::MissingArgument => e
       puts parser
       puts e.message
       STATUS_ERROR
-    ensure
-      report = MemoryProfiler.stop
-      report&.pretty_print(**results_options(options))
     end
 
     private
@@ -66,7 +60,7 @@ module MemoryProfiler
               A Memory Profiler for Ruby
 
           Usage:
-              #{BIN_NAME} [options] <script.rb> [--] [script-options]
+              #{BIN_NAME} [options] run [--] command [command-options]
         BANNER
 
         opts.separator ""
@@ -138,12 +132,16 @@ module MemoryProfiler
       end
     end
 
-    def reporter_options(options)
-      options.select { |k, _v| REPORTER_KEYS.include?(k) }
+    def profile_command(options, argv)
+      env = {}
+      env["MEMORY_PROFILER_OPTIONS"] = serialize_hash(options) if options.any?
+      gem_path = File.expand_path('../', __dir__)
+      env["RUBYOPT"] = "-I #{gem_path} -r memory_profiler/autorun #{ENV['RUBYOPT']}"
+      exec(env, *argv)
     end
 
-    def results_options(options)
-      options.select { |k, _v| RESULTS_KEYS.include?(k) }
+    def serialize_hash(hash)
+      Base64.urlsafe_encode64(Marshal.dump(hash))
     end
   end
 end

data/lib/memory_profiler/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MemoryProfiler
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: memory_profiler
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Sam Saffron
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-26 00:00:00.000000000 Z
+date: 2024-06-17 00:00:00.000000000 Z
 dependencies: []
 description: Memory profiling routines for Ruby 2.5+
 email:
@@ -23,6 +23,7 @@ files:
 - README.md
 - bin/ruby-memory-profiler
 - lib/memory_profiler.rb
+- lib/memory_profiler/autorun.rb
 - lib/memory_profiler/cli.rb
 - lib/memory_profiler/helpers.rb
 - lib/memory_profiler/monochrome.rb
@@ -52,7 +53,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.20
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Memory profiling routines for Ruby 2.5+