ruby_memcheck 2.0.1 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 597a64c7109c460a09cfaa57715d6f26a50104e8137c5184d9bf5f658954d07f
-  data.tar.gz: e9524cbead271b0a5eb8abf85213c59d97d6629d1b6e2e2e3c03d0e94beb7970
+  metadata.gz: '0228bfb7a5cb25e9186f0e2702d4ce746b401ce580d8dfaa83af218a513fca8e'
+  data.tar.gz: 35e58e193c25c4d27aecdf46b962b115f443c52d1431c39deb53cb5ddc7c3e6d
 SHA512:
-  metadata.gz: 2b38c33923e1370245b6184b5b4f16b993819bf02dc3fc76a4fc152c2ae10f50d4597b507983b5fafbbcc09933fd63e06c2c057f55f30c613ece717c68e74e45
-  data.tar.gz: 30a0d75f4268ee39cc34cf865bfb7a0414f4bb89ce10995fd8e55517cc8090761c4d21356e908b2d93adf97a5e8200019e577cb4ba61d2361e7caca5097b6049
+  metadata.gz: e8fc3da2b1795fd7bde1a0e91b75c918540d194d875cbd9e8633de442859ac0d3c1eb10d70d1cb6d97655eba5c8262d8ec01e9d9dd8003ba75852bfa4e22314d
+  data.tar.gz: 936e627d62f56650fa074cd904922d154631bc08047ea8c6e1516481e895fa2c40001db02b1335feb287d919b6c06ce119d17bca7533af4ed8f25d12be437692

data/README.md

@@ -9,7 +9,8 @@ This gem provides a sane way to use Valgrind's memcheck on your native extension
     1. [How does it work?](#how-does-it-work)
     1. [Limitations](#limitations)
 1. [Installation](#installation)
-1. [Setup](#setup)
+1. [Running a Ruby script](#running-a-ruby-script)
+1. [Setup for test suites](#setup-for-test-suites)
 1. [Configuration](#configuration)
 1. [Suppression files](#suppression-files)
 1. [License](#license)
@@ -48,7 +49,16 @@ Because of the aggressive heuristics used to filter out false positives, there a
 gem install ruby_memcheck
 ```
 
-## Setup
+## Running a Ruby script
+
+You can run a Ruby script under ruby_memcheck. This will report all memory leaks in all native extensions found in your Ruby script. Simply replace the `ruby` part of your command with `ruby_memcheck`. For example:
+
+```sh
+$ ruby_memcheck -e "puts 'Hello world'"
+Hello world
+```
+
+## Setup for test suites
 
 > **Note**
 > If you encounter errors from Valgrind that looks like this:
@@ -69,7 +79,7 @@ gem install ruby_memcheck
 > sudo make install
 > ```
 
-The easiest way to use this gem is to use it on your test suite (minitest or RSpec) using rake.
+You can use ruby_memcheck on your test suite (Minitest or RSpec) using rake.
 
 0. Install Valgrind.
 1. In your Rakefile, require this gem.

data/exe/ruby_memcheck

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift("#{__dir__}/../lib")
+
+require "ruby_memcheck"
+
+runner = RubyMemcheck::RubyRunner.new
+exit(runner.run(*ARGV))

data/lib/ruby_memcheck/ruby_runner.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module RubyMemcheck
+  class RubyRunner
+    attr_reader :configuration
+    attr_reader :reporter
+
+    def initialize(*args)
+      @configuration =
+        if !args.empty? && args[0].is_a?(Configuration)
+          args.shift
+        else
+          RubyMemcheck.default_configuration
+        end
+    end
+
+    def run(*args, **options)
+      command = configuration.command(args.map { |a| Shellwords.escape(a) })
+
+      @reporter = TestTaskReporter.new(configuration)
+
+      @reporter.setup
+
+      system(command, options)
+      exit_code = $CHILD_STATUS.exitstatus
+
+      @reporter.report_valgrind_errors
+
+      exit_code
+    end
+  end
+end

data/lib/ruby_memcheck/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RubyMemcheck
-  VERSION = "2.0.1"
+  VERSION = "2.1.1"
 end

data/lib/ruby_memcheck.rb

@@ -1,10 +1,13 @@
 # frozen_string_literal: true
 
+require "English"
+require "shellwords"
 require "tempfile"
 require "rake/testtask"
 
 require "ruby_memcheck/configuration"
 require "ruby_memcheck/frame"
+require "ruby_memcheck/ruby_runner"
 require "ruby_memcheck/stack"
 require "ruby_memcheck/test_task_reporter"
 require "ruby_memcheck/test_task"

data/suppressions/ruby.supp

@@ -60,3 +60,12 @@
   fun:rb_callable_method_entry
   ...
 }
+{
+  The date library lazily initializes Regexps using static local variables through the function `regcomp`. The Regexp will end up being reported as a memory leak.
+  Memcheck:Leak
+  ...
+  fun:rb_enc_reg_new
+  ...
+  fun:date__parse
+  ...
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_memcheck
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.1
 platform: ruby
 authors:
 - Peter Zhu
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-08-09 00:00:00.000000000 Z
+date: 2023-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -125,7 +125,8 @@ dependencies:
 description:
 email:
 - peter@peterzhu.ca
-executables: []
+executables:
+- ruby_memcheck
 extensions: []
 extra_rdoc_files: []
 files:
@@ -138,10 +139,12 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- exe/ruby_memcheck
 - lib/ruby_memcheck.rb
 - lib/ruby_memcheck/configuration.rb
 - lib/ruby_memcheck/frame.rb
 - lib/ruby_memcheck/rspec/rake_task.rb
+- lib/ruby_memcheck/ruby_runner.rb
 - lib/ruby_memcheck/stack.rb
 - lib/ruby_memcheck/suppression.rb
 - lib/ruby_memcheck/test_helper.rb