ddmemoize 1.0.0a2 → 1.0.0a3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eecfd413a7d098193d530f6b890934993b41a9bc5ce83caddf6c34a94309db22
-  data.tar.gz: a5f07ddba37a86bf0dc6af6d34426ca9d1b16003f7ae0e20116de174be73afdf
+  metadata.gz: 075c0a1dd9addf300b84957a864cdd5e24a7a7131e0eb69a9c175351d82eee09
+  data.tar.gz: a398a8b1b884a404b413d837dd81f43057d5c1771cdb893e0838cafa4ff16b4a
 SHA512:
-  metadata.gz: e3dcd35b56f321b3abfffe266d765d78ff969622dff3ec7930a580f2023a32ade26a9dcb642715caca800a9eaf466aae6ec66a6e1c091b01dae3fec901f060e3
-  data.tar.gz: ed990b6c32a034c7aab031a634ca7331556863a4eea6aa5e623c545f8de22a594bc70e4f8a7a336c5555dff9da73c44021064106697035a6a3705314a5471fe6
+  metadata.gz: c74d84354fc652fcaec00c1bfeb60ae3e0a718cc8a7431879aefbb4e59e051015ca36e75aec99b913a33646cd93a67558a10317e53d498ce2557bf3289f57bd2
+  data.tar.gz: 1492b6c2cebc1398af73e3d0108967459bacece5bad8f0ed4777a549097a83b33adf97296655640dcdf5ff7effda5590adfadc9c99476165fe7a246d375b32f9

data/NEWS.md

@@ -1,5 +1,11 @@
 # DDMemoize news
 
+## 1.0.0a3 (2017-12-18)
+
+Changes:
+
+* Simplified telemetry support
+
 ## 1.0.0a2 (2017-12-10)
 
 Features:

data/README.md

@@ -83,24 +83,18 @@ Do not memoize functions that depend on mutable state.
 
 ### Telemetry
 
-To activate telemetry for a given class, call `DDMemoize.activate` with a `telemetry` keyword argument, passing in a telemetry instance:
+To activate telemetry, call `DDMemoize.enable_telemetry` after requiring `ddmemoize`.
 
-```ruby
-require 'ddmemoize'
-
-TELEMETRY = DDTelemetry.new
+To print the collected metrics, call `DDMemoize.print_telemetry`:
 
-class FibFast
-  DDMemoize.activate(self, telemetry: TELEMETRY)
-
-  # …
-end
+```ruby
+DDMemoize.print_telemetry
 ```
 
-To print the collected metrics, call `DDMemoize.print_telemetry`, passing in the telemetry instance:
-
-```ruby
-DDMemoize.print_telemetry(TELEMETRY)
+```
+memoization │ hit   miss       %
+────────────┼───────────────────
+FibFast#fib │ 998   1001   49.9%
 ```
 
 ## Development

data/ddmemoize.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.3.0'
 
-  spec.add_runtime_dependency('ddtelemetry', '= 1.0.0a1') # TODO: upgrade
+  spec.add_runtime_dependency('ddtelemetry', '= 1.0.0a2') # TODO: upgrade
   spec.add_runtime_dependency('ref', '~> 2.0')
 
   spec.files         = `git ls-files -z`.split("\x0")

data/lib/ddmemoize/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DDMemoize
-  VERSION = '1.0.0a2'
+  VERSION = '1.0.0a3'
 end

data/lib/ddmemoize.rb

@@ -15,39 +15,31 @@ module DDMemoize
     end
   end
 
-  # @api private
-  class TelemetryMap
-    include Singleton
+  NONE = Object.new
 
-    def initialize
-      @map = {}
-    end
+  def self.activate(mod)
+    mod.extend(Mixin)
+  end
 
-    def [](mod)
-      @map[mod]
+  class << self
+    def enable_telemetry
+      @telemetry_enabled = true
     end
 
-    def []=(mod, telemetry)
-      @map[mod] = telemetry
+    def telemetry_enabled?
+      @telemetry_enabled
     end
-  end
-
-  NONE = Object.new
-
-  def self.activate(mod, telemetry: nil)
-    mod.extend(Mixin)
-    TelemetryMap.instance[mod] = telemetry
-  end
 
-  def self.telemetry_for(mod)
-    TelemetryMap.instance[mod]
+    def telemetry_counter
+      @_telemetry_counter ||= DDTelemetry::Counter.new
+    end
   end
 
-  def self.print_telemetry(telemetry)
+  def self.print_telemetry
     headers = %w[memoization hit miss %]
 
-    rows_raw = telemetry.counter(:memoization).map do |(name, type), counter|
-      { name: name, type: type, count: counter.value }
+    rows_raw = DDMemoize.telemetry_counter.map do |(name, type), count|
+      { name: name, type: type, count: count }
     end
 
     rows = rows_raw.group_by { |r| r[:name] }.map do |name, rows_for_name|
@@ -70,7 +62,7 @@ module DDMemoize
       alias_method original_method_name, method_name
 
       instance_cache = Hash.new { |hash, key| hash[key] = {} }
-      telemetry = DDMemoize.telemetry_for(self)
+      counter_label = "#{self}##{method_name}"
 
       define_method(method_name) do |*args|
         instance_method_cache = instance_cache[self]
@@ -81,13 +73,11 @@ module DDMemoize
           value = object ? object.value : NONE
         end
 
-        if telemetry
-          counter_label = is_a?(Class) ? "#{self}.#{method_name}" : "#{self.class}##{method_name}"
-
+        if DDMemoize.telemetry_enabled?
           if NONE.equal?(value)
-            telemetry.counter(:memoization).increment([counter_label, :miss])
+            DDMemoize.telemetry_counter.increment([counter_label, :miss])
           else
-            telemetry.counter(:memoization).increment([counter_label, :hit])
+            DDMemoize.telemetry_counter.increment([counter_label, :hit])
           end
         end
 

data/samples/fib.rb

@@ -2,10 +2,10 @@
 
 require 'ddmemoize'
 
-TELEMETRY = DDTelemetry.new
+DDMemoize.enable_telemetry
 
 class FibFast
-  DDMemoize.activate(self, telemetry: TELEMETRY)
+  DDMemoize.activate(self)
 
   memoized def fib(n)
     case n
@@ -21,4 +21,4 @@ end
 
 p FibFast.new.fib(1000)
 
-DDMemoize.print_telemetry(TELEMETRY)
+DDMemoize.print_telemetry

data/spec/ddmemoize_spec.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+DDMemoize.enable_telemetry
+
 describe DDMemoize do
   it 'has a version number' do
     expect(DDMemoize::VERSION).not_to be nil
@@ -41,8 +43,7 @@ describe DDMemoize do
   end
 
   class MemoizationSpecEqual
-    TELEMETRY = ::DDTelemetry.new
-    DDMemoize.activate(self, telemetry: TELEMETRY)
+    DDMemoize.activate(self)
 
     class EqualToEverythingValue
       def equal?(*)
@@ -79,8 +80,7 @@ describe DDMemoize do
   end
 
   class MemoizationSpecWithTelemetry
-    TELEMETRY = ::DDTelemetry.new
-    DDMemoize.activate(self, telemetry: TELEMETRY)
+    DDMemoize.activate(self)
 
     def run(value)
       value.upcase
@@ -115,11 +115,10 @@ describe DDMemoize do
     sample.run
     sample.run
 
-    telemetry = MemoizationSpecEqual::TELEMETRY
-    counter = telemetry.counter(:memoization)
+    counter = DDMemoize.telemetry_counter
 
-    expect(counter.value(['MemoizationSpecEqual#run', :miss])).to eq(1)
-    expect(counter.value(['MemoizationSpecEqual#run', :hit])).to eq(2)
+    expect(counter.get(['MemoizationSpecEqual#run', :miss])).to eq(1)
+    expect(counter.get(['MemoizationSpecEqual#run', :hit])).to eq(2)
   end
 
   it 'supports memoized def … syntax' do
@@ -150,11 +149,10 @@ describe DDMemoize do
     sample.run('denis')
     sample.run('defreyne')
 
-    telemetry = MemoizationSpecWithTelemetry::TELEMETRY
-    counter = telemetry.counter(:memoization)
+    counter = DDMemoize.telemetry_counter
 
-    expect(counter.value(['MemoizationSpecWithTelemetry#run', :miss])).to eq(2)
-    expect(counter.value(['MemoizationSpecWithTelemetry#run', :hit])).to eq(1)
+    expect(counter.get(['MemoizationSpecWithTelemetry#run', :miss])).to eq(2)
+    expect(counter.get(['MemoizationSpecWithTelemetry#run', :hit])).to eq(1)
   end
 
   it 'prints recorded telemetry' do
@@ -164,13 +162,6 @@ describe DDMemoize do
     sample.run('denis')
     sample.run('defreyne')
 
-    expected = <<~OUTPUT
-                           memoization │ hit   miss       %
-      ─────────────────────────────────┼───────────────────
-      MemoizationSpecWithTelemetry#run │   2      4   33.3%
-    OUTPUT
-
-    telemetry = MemoizationSpecWithTelemetry::TELEMETRY
-    expect { DDMemoize.print_telemetry(telemetry) }.to output(expected).to_stdout
+    expect { DDMemoize.print_telemetry }.to output(/memoization │ hit\s+miss\s+%/).to_stdout
   end
 end

data/spec/spec_helper.rb

@@ -12,6 +12,6 @@ require 'fuubar'
 
 RSpec.configure do |c|
   c.fuubar_progress_bar_options = {
-    format: '%c/%C |<%b>%i| %p%%',
+    format: '%c/%C |<%b>%i| %p%%', # rubocop:disable Style/FormatStringToken
   }
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ddmemoize
 version: !ruby/object:Gem::Version
-  version: 1.0.0a2
+  version: 1.0.0a3
 platform: ruby
 authors:
 - Denis Defreyne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-10 00:00:00.000000000 Z
+date: 2017-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ddtelemetry
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0a1
+        version: 1.0.0a2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0a1
+        version: 1.0.0a2
 - !ruby/object:Gem::Dependency
   name: ref
   requirement: !ruby/object:Gem::Requirement