ruby_memcheck 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 16ee16450f130947ac172a2a7f7dcc7c0161fb3f7a851cd525e908533fed0ebc
-  data.tar.gz: d3de0b6abf7d4c0e0226983fe45aa86403d0cfa3d28171d288c5ed29b0e276fb
+  metadata.gz: 5d5d9a9370f2c62f82adb6bccb89e003e7fd42662a3ea786fc6625689e55e85f
+  data.tar.gz: dc82e568dc90d505363dae4f486c1b2f849141328d0a4326ae7a0d8bfe712739
 SHA512:
-  metadata.gz: aa62176e0585fecb9988d7f874b4207088317b1f97fa00a6b7d17e6336cabe0955a19957b34e6ce6efb496ee75a837b8eca3cc857733da6d7ecfe01e9ac05394
-  data.tar.gz: 0e11133ec13c7e186aadb3bbcc99f85e0248c8891a66379bae6bd98836f4fc75f2928918382f94d14da650362c36a8283756e3a83ba37aff0e98ab226e6c17cb
+  metadata.gz: 4c0a004789b25d7407fd7ffcacdd3c155e73f1662f7fbeda7d8abc17b79d3dc24d5c7dafe95ee0b35cd48e860eec156293a5cdc1077f86148e979a6fab09144f
+  data.tar.gz: 06513eb0786d509df597c2efd929050669d8825bb09badd2d2f9d9ec9ee0df9bfa21ce43fbbc34f55d736b2c0eb0d497c96c658a5e7fe93a190633dcfb47bda8

data/.github/workflows/test.yml

@@ -23,9 +23,9 @@ jobs:
       - run: sudo apt-get install -y libc6-dbg
       - name: Install Valgrind from source
         run: |
-          wget https://sourceware.org/pub/valgrind/valgrind-3.20.0.tar.bz2
-          tar xvf valgrind-3.20.0.tar.bz2
-          cd valgrind-3.20.0
+          wget https://sourceware.org/pub/valgrind/valgrind-3.21.0.tar.bz2
+          tar xvf valgrind-3.21.0.tar.bz2
+          cd valgrind-3.21.0
           ./configure
           make
           sudo make install

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:
@@ -61,15 +71,15 @@ gem install ruby_memcheck
 > You can install Valgrind from source using the following commands:
 > ```
 > sudo apt-get install -y libc6-dbg
-> wget https://sourceware.org/pub/valgrind/valgrind-3.20.0.tar.bz2
-> tar xvf valgrind-3.20.0.tar.bz2
-> cd valgrind-3.20.0
+> wget https://sourceware.org/pub/valgrind/valgrind-3.21.0.tar.bz2
+> tar xvf valgrind-3.21.0.tar.bz2
+> cd valgrind-3.21.0
 > ./configure
 > make
 > 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.0"
+  VERSION = "2.1.0"
 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

@@ -12,13 +12,6 @@
   fun:require_internal
   ...
 }
-{
-  Remove this after Ruby 2.7.7, 3.0.5, 3.1.3 are relased. See: https://github.com/Shopify/ruby_memcheck/issues/6
-  Memcheck:Leak
-  ...
-  fun:stack_chunk_alloc
-  ...
-}
 {
   recursive_list_access creates a hash called `list` that is stored on the threadptr_recursive_hash. This is reported as a memory leak.
   Memcheck:Leak
@@ -58,3 +51,12 @@
   fun:strscan_do_scan
   ...
 }
+{
+  The callcache table (RCLASS_CC_TBL) is lazily created, so it is allocated when the first method that gets cached. If this happens in a native extension, it may be reported as a memory leak.
+  Memcheck:Leak
+  ...
+  fun:rb_id_table_create
+  ...
+  fun:rb_callable_method_entry
+  ...
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_memcheck
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Peter Zhu
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-08-04 00:00:00.000000000 Z
+date: 2023-08-14 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