hoe-debugging 1.5.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d39769e054a2227a063051c68b0599af45f585371f75cccd36410f573d512923
-  data.tar.gz: 47c2207158e4ed4968d7c221c8536bfe29f962506e7c7705830bfd765d6bfbdf
+  metadata.gz: 710365d2aec2b10a796ca148b55d1a5cde267ca71fa586d309d7bca22cea425c
+  data.tar.gz: 638fbb729911666cf26fb2254b2d9a9881c6f61a9c5964fc21ef3e6b37a573f4
 SHA512:
-  metadata.gz: 29f3d8e7cf2944169832cb7f7189baf525c16790b2dc77a49916ba36117ee50d0a5d2c726c40c9cb6ec6a3d41154e4fa704cb7465b02f8503e3fa2da35b1762d
-  data.tar.gz: 22f26dd9e758470f71f891d0cf719e173c1bec60e5c7e56709d46b46a8f645daa70483cc83ecd1fc4cb2f73a60caf765ea8081b8563be06d595f105a4a5c40c2
+  metadata.gz: d7b861f1dbe2c194c02ecbf543e950ba30742e733c3600b8318f6336aad9a49124e8f198cc097361434aac72440ddaf906df33a105f79f9a072c8f12b1b5f3e0
+  data.tar.gz: dcda2861f6bc1b9fff1f5a63e61c28a636687bdabbaaaf3095defa28a091dd55624de5507ed16621769325251f3dee7ecdc67c05c6941eefc195602e7761c445

data/{CHANGELOG.rdoc → CHANGELOG.md}

@@ -1,6 +1,16 @@
-== Changelog for `hoe-debugging`
+## Changelog for `hoe-debugging`
 
-=== 1.5.0 / 2018-11-02
+### 2.0.0 / 2018-11-04
+
+Features:
+
+* Allow multiple suppression files to be active at once. Pull in all
+  suppression files that match a part of the ruby version. Along with
+  this change, the helper method `matching_suppression_file` is
+  renamed to `matching_suppression_files`.
+
+
+### 1.5.0 / 2018-11-02
 
 Features:
 
@@ -8,21 +18,21 @@ Features:
 * Rake task `valgrind:suppression` can generate a suppression file from a previous run's log file. Great for when CI finds things that are hard to reproduce!
 
 
-=== 1.4.2 / 2017-06-19
+### 1.4.2 / 2017-06-19
 
 Features:
 
 * Allow matching suppression file on major Ruby version.
 
 
-=== 1.4.1 / 2017-06-19
+### 1.4.1 / 2017-06-19
 
 Features:
 
 * Support frozen string constants.
 
 
-=== 1.4.0 / 2017-06-19
+### 1.4.0 / 2017-06-19
 
 Features:
 
@@ -34,19 +44,19 @@ Bugfixes:
 * Fixed generation of suppression files.
 
 
-=== 1.3.0 / 2017-01-20
+### 1.3.0 / 2017-01-20
 
 * The rake task now fails if valgrind detects any errors during the run.
 
 
-=== 1.2.1 / 2015-12-16
+### 1.2.1 / 2015-12-16
 
 Features:
 
 * Set larger stack size (via `ulimit -s`) to properly support Ruby 2.1 and later
 
 
-=== 1.2.0 / 2015-01-22
+### 1.2.0 / 2015-01-22
 
 Features:
 
@@ -58,40 +68,40 @@ Bugfixes:
 * Replace references to `Config` with `RbConfig`, for Ruby 2.2 support.
 
 
-=== 1.1.1 / 2012-11-26
+### 1.1.1 / 2012-11-26
 
 Bugfixes:
 
 * Correctly name suppression files for REE.
 
 
-=== 1.1.0 / 2012-09-26
+### 1.1.0 / 2012-09-26
 
 * Valgrind suppressions can be generated with `rake test:valgrind:suppression`
 * If present, valgrind suppressions will be used when valgrinding.
 
-=== 1.0.5 / 2012-06-19
+### 1.0.5 / 2012-06-19
 
 * RSpec support now works with TESTOPTS.
 
-=== 1.0.4 / 2012-06-19
+### 1.0.4 / 2012-06-19
 
 * Adding support for RSpec.
 
-=== 1.0.3 / 2012-02-06
+### 1.0.3 / 2012-02-06
 
 * Fixing compatibility with latter-day versions of rake. #1
 
-=== 1.0.2 / 2011-11-13
+### 1.0.2 / 2011-11-13
 
 * Fixing reference to ::RUBY with rbconfig-based construction of the ruby interpreter path.
 
-=== 1.0.1 / 2009-06-26
+### 1.0.1 / 2009-06-26
 
 * Fix Hoe dependency version.
 * Activate the hoe-git plugin.
 * Fix docs, give Mike some well-deserved credit!
 
-=== 1.0.0 / 2009-06-22
+### 1.0.0 / 2009-06-22
 
 * Birthday!

data/Manifest.txt

@@ -1,5 +1,5 @@
 .rspec
-CHANGELOG.rdoc
+CHANGELOG.md
 LICENSE
 Manifest.txt
 README.md

data/README.md

@@ -60,6 +60,35 @@ rake test:valgrind # when this runs, the errors from that log file will be suppr
 ```
 
 
+## Suppression files
+
+Suppression files can be added to the `suppressions` subdirectory of your project.
+
+As of v2.0.0, `hoe-debugging` will use all suppression files that match any part of your Ruby's version. It uses the Hoe project name and the ruby version name, with an optional trailing `/_.*/`.
+
+For example, if:
+
+* my Hoe project was named `myproject`
+* and my Ruby version was `2.5.1.57` (the `57` is `RUBY_PATCHLEVEL`)
+
+then the following would be found and used:
+
+* `suppressions/myproject_ruby-2.5.1.57.supp`
+* `suppressions/myproject_ruby-2.5.1.57_namespace_deref.supp`
+* `suppressions/myproject_ruby-2.5.1.supp`
+* `suppressions/myproject_ruby-2.5.supp`
+* `suppressions/myproject_ruby-2.supp`
+* `suppressions/myproject_ruby-2_exit_frees.supp`
+
+and the following would **not** be used:
+
+* `suppressions/otherproject_ruby-2.5.1.57.supp` because the project name is wrong
+* `suppressions/myproject_ruby-2.5.1.58.supp` because the patchlevel is wrong
+* `suppressions/myproject_ruby-2.5.2.supp` because the patch is wrong
+* `suppressions/myproject_ruby-2.4.supp` because the minor is wrong
+* `suppressions/myproject_ruby-1.supp` because the major is wrong
+
+
 ## Installation
 
 ```

data/Rakefile

@@ -10,8 +10,7 @@ Hoe.spec "hoe-debugging" do
   developer "John Barnette", "jbarnette@rubyforge.org"
   developer "Mike Dalessio", "mike.dalessio@gmail.com"
 
-  self.extra_rdoc_files = FileList["*.rdoc"]
-  self.history_file     = "CHANGELOG.rdoc"
+  self.history_file     = "CHANGELOG.md"
   self.readme_file      = "README.md"
 
   license "MIT"

data/lib/hoe/debugging.rb

@@ -11,7 +11,7 @@ class Hoe #:nodoc:
   # * <tt>test:valgrind:mem0</tt>
 
   module Debugging
-    VERSION = "1.5.0" #:nodoc:
+    VERSION = "2.0.0" #:nodoc:
 
     ##
     # The exit code of valgrind when it detects an error.
@@ -66,7 +66,8 @@ class Hoe #:nodoc:
     end
 
     def hoe_debugging_check_for_suppression_file options
-      if suppression_file = hoe_debugging_valgrind_helper.matching_suppression_file
+      suppression_files = hoe_debugging_valgrind_helper.matching_suppression_files
+      suppression_files.each do |suppression_file|
         puts "NOTICE: using valgrind suppressions in #{suppression_file.inspect}"
         options << "--suppressions=#{suppression_file}"
       end
@@ -150,10 +151,10 @@ class Hoe #:nodoc:
       end
 
       def version_matches
-        matches = [formatted_ruby_version]
-        matches << formatted_ruby_version.split(".")[0,3].join(".")
-        matches << formatted_ruby_version.split(".")[0,2].join(".")
-        matches << formatted_ruby_version.split(".")[0,1].join(".")
+        matches = [formatted_ruby_version]                          # e.g. "ruby-2.5.1.57"
+        matches << formatted_ruby_version.split(".")[0,3].join(".") # e.g. "ruby-2.5.1"
+        matches << formatted_ruby_version.split(".")[0,2].join(".") # e.g. "ruby-2.5"
+        matches << formatted_ruby_version.split(".")[0,1].join(".") # e.g. "ruby-2"
         matches
       end
 
@@ -188,12 +189,13 @@ class Hoe #:nodoc:
         filename
       end
 
-      def matching_suppression_file
+      def matching_suppression_files
+        matching_files = []
         version_matches.each do |version_string|
-          matches = Dir[File.join(directory, "#{project_name}_#{version_string}*.supp")]
-          return matches[0] if matches[0]
+          matching_files += Dir[File.join(directory, "#{project_name}_#{version_string}.supp")]
+          matching_files += Dir[File.join(directory, "#{project_name}_#{version_string}_*.supp")]
         end
-        nil
+        matching_files
       end
 
       def valgrind

data/spec/hoe_debugging_valgrind_helper_spec.rb

@@ -54,44 +54,41 @@ describe Hoe::Debugging::ValgrindHelper do
     end
   end
 
-  describe "#matching_suppression_file" do
+  describe "#matching_suppression_files" do
     context "there are multiple matches" do
-      it "returns the best match" do
+      it "returns all matches" do
         helper = klass.new "myproj", :directory => suppressions_directory
-        exact_match = File.join(suppressions_directory, "myproj_#{helper.formatted_ruby_version}.supp")
-        inexact_match = File.join(suppressions_directory, "myproj_#{helper.version_matches[1]}.999999999.supp")
-        FileUtils.mkdir_p suppressions_directory
-        FileUtils.touch inexact_match
-        FileUtils.touch exact_match
-        expect(helper.matching_suppression_file).to eq exact_match
-      end
-    end
+        matching_files = helper.version_matches.map do |version_match|
+          File.join(suppressions_directory, "myproj_#{version_match}.supp")
+        end
+        inexact_match = File.join(suppressions_directory, "myproj_#{helper.version_matches[1]}.99999.supp")
+        all_files = matching_files + [inexact_match]
 
-
-    context "there is one inexact match" do
-      it "returns it" do
-        helper = klass.new "myproj", :directory => suppressions_directory
-        inexact_match = File.join(suppressions_directory, "myproj_#{helper.version_matches[1]}.999999999.supp")
         FileUtils.mkdir_p suppressions_directory
-        FileUtils.touch inexact_match
-        expect(helper.matching_suppression_file).to eq inexact_match
+        all_files.each { |f| FileUtils.touch f }
+
+        expect(helper.matching_suppression_files).to eq(matching_files)
       end
-    end
 
-    context "there is one exact match" do
-      it "returns it" do
+      it "returns all matches even with trailing desc" do
         helper = klass.new "myproj", :directory => suppressions_directory
-        exact_match = File.join(suppressions_directory, "myproj_#{helper.formatted_ruby_version}.supp")
+        matching_files = helper.version_matches.map do |version_match|
+          File.join(suppressions_directory, "myproj_#{version_match}_foo.supp")
+        end
+        inexact_match = File.join(suppressions_directory, "myproj_#{helper.version_matches[1]}.99999_foo.supp")
+        all_files = matching_files + [inexact_match]
+
         FileUtils.mkdir_p suppressions_directory
-        FileUtils.touch exact_match
-        expect(helper.matching_suppression_file).to eq exact_match
+        all_files.each { |f| FileUtils.touch f }
+
+        expect(helper.matching_suppression_files).to eq(matching_files)
       end
     end
 
     context "there are zero matches" do
       it "returns nil" do
         helper = klass.new "myproj", :directory => suppressions_directory
-        expect(helper.matching_suppression_file).to be_nil
+        expect(helper.matching_suppression_files).to eq([])
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hoe-debugging
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 2.0.0
 platform: ruby
 authors:
 - John Barnette
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-02 00:00:00.000000000 Z
+date: 2018-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -149,12 +149,12 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files:
-- CHANGELOG.rdoc
+- CHANGELOG.md
 - Manifest.txt
 - README.md
 files:
 - ".rspec"
-- CHANGELOG.rdoc
+- CHANGELOG.md
 - LICENSE
 - Manifest.txt
 - README.md