statsd-instrument 3.5.10 → 3.5.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 58bc5f73b44ea7c3ac8268feaeb9defc2da36b9a7a5565cb11d34324f84f5381
-  data.tar.gz: 0d781d4945f02d7e1eb1bc89e68d647bac0b7062f7d26371b8aef95821080e06
+  metadata.gz: 41254f0057c645926c54b36ec4bf937352444740f0cae248b1feed1f35ce4044
+  data.tar.gz: 3d2131889385d2755a738d735ca9a20dba0342e645d58312c4007b7a1835b249
 SHA512:
-  metadata.gz: 901993924629290a116505b73eea09c84dd422fb1fd96a274733e9b26223b73ec3087599b419e325c1e4728fd45f964bb2a800d881ae207fb90e84c4950e8e02
-  data.tar.gz: cdd79db9829b2317795330fba20238a122a04cfa15b65b53d2b910a50bb315d961bbcf1714a479c61adbf4a4a378272e71dd9132afe9607eaa96611b20ce332a
+  metadata.gz: 46a4f427f2e298c242a84c7f90a715a7d4397c28ad5db8f89f8b669e3867c7b253a5858a61e35768fada113b56202dc43d91cffb68b9626ea79c26fd15d10a67
+  data.tar.gz: 99b1979f9b3b9a4e502c78a42bfa48348600eece64646ddfdd2470ae1d3b4cc52123e3edaef539886c667ff2e9eca98051c55c5fec7c6ccc76e1404e2f5f2800

data/.github/workflows/benchmark.yml

@@ -8,7 +8,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v1
+    - uses: actions/checkout@v3
 
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
@@ -22,15 +22,15 @@ jobs:
     - name: Run throughput benchmark on branch
       run: benchmark/local-udp-throughput
 
-    - uses: actions/checkout@v1
+    - uses: actions/checkout@v3
       with:
-        ref: 'master'
+        ref: 'main'
 
     - name: Install dependencies if needed
       run: bundle check || bundle install --jobs 4 --retry 3
 
-    - name: Run benchmark on master
+    - name: Run benchmark on main
       run: benchmark/send-metrics-to-local-udp-receiver
 
-    - name: Run throughput benchmark on master
+    - name: Run throughput benchmark on main
       run: benchmark/local-udp-throughput

data/.github/workflows/lint.yml

@@ -8,7 +8,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v1
+    - uses: actions/checkout@v3
 
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1

data/.github/workflows/tests.yml

@@ -16,7 +16,7 @@ jobs:
         # ...
 
     steps:
-    - uses: actions/checkout@v1
+    - uses: actions/checkout@v3
 
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1

data/CHANGELOG.md

@@ -6,6 +6,15 @@ section below.
 
 ## Unreleased changes
 
+## Version 3.5.12
+
+- Update CONTRIBUTING docs about release process
+- Rename branch `master` to `main`.
+
+## Version 3.5.11
+
+- Fix a bug where passing `nil` to `clone_with_options` did not overwrite existing values
+
 ## Version 3.5.10
 
 - Fix rubocop 1.30 compatibilitty

data/CONTRIBUTING.md

@@ -59,5 +59,5 @@ we are depending on the current behavior of the library.
 
 1. Update the version number in `lib/statsd/instrument/version.rb`.
 2. Move the "Unreleased changes" items in [CHANGELOG.md](./CHANGELOG.md) to a new section for the release.
-3. Commit these changes.
-4. Run `bundle exec rake release`.
+3. Open a PR with these changes, have it reviewed and merged.
+4. The new version will be automatically uploaded by our deployment pipeline.

data/benchmark/README.md

@@ -23,7 +23,7 @@ To benchmark your changes:
      be available if you check out another branch.
 2. Run these scripts on your pull request branch. The results will be stored in
    a temporary file.
-3. Checkout the latest version of `master`.
+3. Checkout the latest version of `main`.
 4. Run the benchmark again. The benchmark script will now print a comparison
-   between your branch and master.
+   between your branch and main.
 5. Include the output in your pull request description.

data/benchmark/send-metrics-to-dev-null-log

@@ -6,9 +6,9 @@ require "tmpdir"
 require "benchmark/ips"
 
 revision = %x(git rev-parse HEAD).rstrip
-base_revision = %x(git rev-parse origin/master).rstrip
+base_revision = %x(git rev-parse origin/main).rstrip
 branch = if revision == base_revision
-  "master"
+  "main"
 else
   %x(git rev-parse --abbrev-ref HEAD).rstrip
 end
@@ -39,7 +39,7 @@ end
 
 if report.entries.length == 1
   puts
-  puts "To compare the performance of this revision against another revision (e.g. master),"
+  puts "To compare the performance of this revision against another revision (e.g. main),"
   puts "check out a different branch and run this benchmark script again."
 elsif ENV["KEEP_RESULTS"]
   puts

data/benchmark/send-metrics-to-local-udp-receiver

@@ -20,9 +20,9 @@ end
 
 def benchmark_implementation(name, env = {})
   revision = %x(git rev-parse HEAD).rstrip
-  base_revision = %x(git rev-parse origin/master).rstrip
+  base_revision = %x(git rev-parse origin/main).rstrip
   branch = if revision == base_revision
-    "master"
+    "main"
   else
     %x(git rev-parse --abbrev-ref HEAD).rstrip
   end
@@ -60,7 +60,7 @@ def benchmark_implementation(name, env = {})
 
   if report.entries.length == 1
     puts
-    puts "To compare the performance of this revision against another revision (e.g. master),"
+    puts "To compare the performance of this revision against another revision (e.g. main),"
     puts "check out a different branch and run this benchmark script again."
   elsif ENV["KEEP_RESULTS"]
     puts

data/lib/statsd/instrument/client.rb

@@ -378,6 +378,8 @@ module StatsD
         ))
       end
 
+      NO_CHANGE = Object.new
+
       # Instantiates a new StatsD client that uses the settings of the current client,
       # except for the provided overrides.
       #
@@ -386,11 +388,11 @@ module StatsD
       #   will be disposed after the block returns
       # @return The return value of the block will be passed on as return value.
       def with_options(
-        sink: nil,
-        prefix: nil,
-        default_sample_rate: nil,
-        default_tags: nil,
-        datagram_builder_class: nil
+        sink: NO_CHANGE,
+        prefix: NO_CHANGE,
+        default_sample_rate: NO_CHANGE,
+        default_tags: NO_CHANGE,
+        datagram_builder_class: NO_CHANGE
       )
         client = clone_with_options(
           sink: sink,
@@ -404,18 +406,19 @@ module StatsD
       end
 
       def clone_with_options(
-        sink: nil,
-        prefix: nil,
-        default_sample_rate: nil,
-        default_tags: nil,
-        datagram_builder_class: nil
+        sink: NO_CHANGE,
+        prefix: NO_CHANGE,
+        default_sample_rate: NO_CHANGE,
+        default_tags: NO_CHANGE,
+        datagram_builder_class: NO_CHANGE
       )
         self.class.new(
-          sink: sink || @sink,
-          prefix: prefix || @prefix,
-          default_sample_rate: default_sample_rate || @default_sample_rate,
-          default_tags: default_tags || @default_tags,
-          datagram_builder_class: datagram_builder_class || @datagram_builder_class,
+          sink: sink == NO_CHANGE ? @sink : sink,
+          prefix: prefix == NO_CHANGE ? @prefix : prefix,
+          default_sample_rate: default_sample_rate == NO_CHANGE ? @default_sample_rate : default_sample_rate,
+          default_tags: default_tags == NO_CHANGE ? @default_tags : default_tags,
+          datagram_builder_class:
+            datagram_builder_class == NO_CHANGE ? @datagram_builder_class : datagram_builder_class,
         )
       end
 

data/lib/statsd/instrument/rubocop.rb

@@ -51,7 +51,7 @@ module RuboCop
       end
 
       def keyword_arguments(node)
-        return nil if node.arguments.empty?
+        return if node.arguments.empty?
 
         last_argument = if node.arguments.last&.type == :block_pass
           node.arguments[node.arguments.length - 2]

data/lib/statsd/instrument/version.rb

@@ -2,6 +2,6 @@
 
 module StatsD
   module Instrument
-    VERSION = "3.5.10"
+    VERSION = "3.5.12"
   end
 end

data/test/client_test.rb

@@ -223,4 +223,18 @@ class ClientTest < Minitest::Test
     original_client.increment("metric")
     client_with_other_options.increment("metric")
   end
+
+  def test_clone_can_remove_prefix
+    # Both clients will use the same sink.
+    mock_sink = mock("sink")
+    mock_sink.stubs(:sample?).returns(true)
+    mock_sink.expects(:<<).with("foo.metric:1|c").returns(mock_sink)
+    mock_sink.expects(:<<).with("metric:1|c").returns(mock_sink)
+
+    original_client = StatsD::Instrument::Client.new(sink: mock_sink, prefix: "foo")
+    client_with_other_options = original_client.clone_with_options(prefix: nil)
+
+    original_client.increment("metric")
+    client_with_other_options.increment("metric")
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: statsd-instrument
 version: !ruby/object:Gem::Version
-  version: 3.5.10
+  version: 3.5.12
 platform: ruby
 authors:
 - Jesse Storimer
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-05 00:00:00.000000000 Z
+date: 2023-08-25 00:00:00.000000000 Z
 dependencies: []
 description: A StatsD client for Ruby apps. Provides metaprogramming methods to inject
   StatsD instrumentation into your code.
@@ -122,7 +122,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.13
+rubygems_version: 3.4.18
 signing_key: 
 specification_version: 4
 summary: A StatsD client for Ruby apps