ddmemoize 1.0.0a1 → 1.0.0a2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7674a9402beca0c7c7aa4bcf22c5095856bd4c77cd8994ff5677fa0784fd5f5c
-  data.tar.gz: '090adce10054d2c7f63725947ce96ccb2eff67be093dd6042968600994515191'
+  metadata.gz: eecfd413a7d098193d530f6b890934993b41a9bc5ce83caddf6c34a94309db22
+  data.tar.gz: a5f07ddba37a86bf0dc6af6d34426ca9d1b16003f7ae0e20116de174be73afdf
 SHA512:
-  metadata.gz: 1a0df32a98e11ea5280e6d15191057e62397dde1796b73e3fe17b264133f47f8b454da468daf854f0ae3102261206141449832e41d19f83274cb11f4c9bcaecc
-  data.tar.gz: cb30c1743351a11dfcdbaea5a9a907f4587c68cfe1b9265a78a654fcea6bc94a2e495e1628240edfbba0ced548ca20cf6da56484ef843e1a7f0cb0f3d30a7a78
+  metadata.gz: e3dcd35b56f321b3abfffe266d765d78ff969622dff3ec7930a580f2023a32ade26a9dcb642715caca800a9eaf466aae6ec66a6e1c091b01dae3fec901f060e3
+  data.tar.gz: ed990b6c32a034c7aab031a634ca7331556863a4eea6aa5e623c545f8de22a594bc70e4f8a7a336c5555dff9da73c44021064106697035a6a3705314a5471fe6

data/NEWS.md

@@ -1,5 +1,15 @@
 # DDMemoize news
 
+## 1.0.0a2 (2017-12-10)
+
+Features:
+
+* Added telemetry support (#1)
+
+Fixes:
+
+* Fixed handling of objects that override `#equal?` (but why would you do that anyway?) (#2)
+
 ## 1.0.0a1 (2017-12-02)
 
 Initial release.

data/README.md

@@ -30,6 +30,7 @@ Features:
 
 * Supports memoizing functions on frozen objects
 * Releases memoized values when needed in order to reduce memory pressure
+* Optionally records telemetry
 
 ## Installation
 
@@ -78,7 +79,29 @@ Alternatively, prepend `memoized` to the function definition:
   end
 ```
 
-Do not memoie functions that depend on mutable state.
+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:
+
+```ruby
+require 'ddmemoize'
+
+TELEMETRY = DDTelemetry.new
+
+class FibFast
+  DDMemoize.activate(self, telemetry: TELEMETRY)
+
+  # …
+end
+```
+
+To print the collected metrics, call `DDMemoize.print_telemetry`, passing in the telemetry instance:
+
+```ruby
+DDMemoize.print_telemetry(TELEMETRY)
+```
 
 ## Development
 

data/ddmemoize.gemspec

@@ -14,6 +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('ref', '~> 2.0')
 
   spec.files         = `git ls-files -z`.split("\x0")

data/lib/ddmemoize.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require 'ref'
+require 'ddtelemetry'
+require 'singleton'
 
 require_relative 'ddmemoize/version'
 
@@ -13,10 +15,53 @@ module DDMemoize
     end
   end
 
+  # @api private
+  class TelemetryMap
+    include Singleton
+
+    def initialize
+      @map = {}
+    end
+
+    def [](mod)
+      @map[mod]
+    end
+
+    def []=(mod, telemetry)
+      @map[mod] = telemetry
+    end
+  end
+
   NONE = Object.new
 
-  def self.activate(mod)
+  def self.activate(mod, telemetry: nil)
     mod.extend(Mixin)
+    TelemetryMap.instance[mod] = telemetry
+  end
+
+  def self.telemetry_for(mod)
+    TelemetryMap.instance[mod]
+  end
+
+  def self.print_telemetry(telemetry)
+    headers = %w[memoization hit miss %]
+
+    rows_raw = telemetry.counter(:memoization).map do |(name, type), counter|
+      { name: name, type: type, count: counter.value }
+    end
+
+    rows = rows_raw.group_by { |r| r[:name] }.map do |name, rows_for_name|
+      rows_by_type = rows_for_name.group_by { |r| r[:type] }
+
+      num_hit = rows_by_type.fetch(:hit, []).fetch(0, {}).fetch(:count, 0)
+      num_miss = rows_by_type.fetch(:miss, []).fetch(0, {}).fetch(:count, 0)
+      pct = num_hit.to_f / (num_hit + num_miss).to_f
+
+      [name, num_hit.to_s, num_miss.to_s, "#{format('%3.1f', pct * 100)}%"]
+    end
+
+    all_rows = [headers] + rows
+    puts DDTelemetry::Table.new(all_rows).to_s
   end
 
   module Mixin
@@ -25,6 +70,7 @@ module DDMemoize
       alias_method original_method_name, method_name
 
       instance_cache = Hash.new { |hash, key| hash[key] = {} }
+      telemetry = DDMemoize.telemetry_for(self)
 
       define_method(method_name) do |*args|
         instance_method_cache = instance_cache[self]
@@ -35,6 +81,16 @@ module DDMemoize
           value = object ? object.value : NONE
         end
 
+        if telemetry
+          counter_label = is_a?(Class) ? "#{self}.#{method_name}" : "#{self.class}##{method_name}"
+
+          if NONE.equal?(value)
+            telemetry.counter(:memoization).increment([counter_label, :miss])
+          else
+            telemetry.counter(:memoization).increment([counter_label, :hit])
+          end
+        end
+
         if value.equal?(NONE)
           send(original_method_name, *args).tap do |r|
             instance_method_cache[args] = Ref::SoftReference.new(Value.new(r))

data/lib/ddmemoize/version.rb

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

data/samples/fib.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'ddmemoize'
+
+TELEMETRY = DDTelemetry.new
+
+class FibFast
+  DDMemoize.activate(self, telemetry: TELEMETRY)
+
+  memoized def fib(n)
+    case n
+    when 0
+      0
+    when 1
+      1
+    else
+      fib(n - 1) + fib(n - 2)
+    end
+  end
+end
+
+p FibFast.new.fib(1000)
+
+DDMemoize.print_telemetry(TELEMETRY)

data/spec/ddmemoize_spec.rb

@@ -40,6 +40,22 @@ describe DDMemoize do
     memoize :run
   end
 
+  class MemoizationSpecEqual
+    TELEMETRY = ::DDTelemetry.new
+    DDMemoize.activate(self, telemetry: TELEMETRY)
+
+    class EqualToEverythingValue
+      def equal?(*)
+        true
+      end
+    end
+
+    def run
+      EqualToEverythingValue.new
+    end
+    memoize :run
+  end
+
   class MemoizationSpecUpcaserInlineSyntax
     DDMemoize.activate(self)
 
@@ -62,6 +78,16 @@ describe DDMemoize do
     record memoized def run; end
   end
 
+  class MemoizationSpecWithTelemetry
+    TELEMETRY = ::DDTelemetry.new
+    DDMemoize.activate(self, telemetry: TELEMETRY)
+
+    def run(value)
+      value.upcase
+    end
+    memoize :run
+  end
+
   example do
     sample1a = MemoizationSpecSample1.new(10)
     sample1b = MemoizationSpecSample1.new(15)
@@ -82,6 +108,20 @@ describe DDMemoize do
     sample.run(5)
   end
 
+  it 'supports objects that bizarrely override #equal?' do
+    sample = MemoizationSpecEqual.new
+    sample.freeze
+    sample.run
+    sample.run
+    sample.run
+
+    telemetry = MemoizationSpecEqual::TELEMETRY
+    counter = telemetry.counter(:memoization)
+
+    expect(counter.value(['MemoizationSpecEqual#run', :miss])).to eq(1)
+    expect(counter.value(['MemoizationSpecEqual#run', :hit])).to eq(2)
+  end
+
   it 'supports memoized def … syntax' do
     upcaser = MemoizationSpecUpcaserInlineSyntax.new
     expect(upcaser.run('hi')).to eq('HI')
@@ -102,4 +142,35 @@ describe DDMemoize do
   it 'returns method name' do
     expect(MemoizationSpecInlineSyntaxReturn.sym).to eq(:run)
   end
+
+  it 'records telemetry' do
+    sample = MemoizationSpecWithTelemetry.new
+
+    sample.run('denis')
+    sample.run('denis')
+    sample.run('defreyne')
+
+    telemetry = MemoizationSpecWithTelemetry::TELEMETRY
+    counter = telemetry.counter(:memoization)
+
+    expect(counter.value(['MemoizationSpecWithTelemetry#run', :miss])).to eq(2)
+    expect(counter.value(['MemoizationSpecWithTelemetry#run', :hit])).to eq(1)
+  end
+
+  it 'prints recorded telemetry' do
+    sample = MemoizationSpecWithTelemetry.new
+
+    sample.run('denis')
+    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
+  end
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: ddmemoize
 version: !ruby/object:Gem::Version
-  version: 1.0.0a1
+  version: 1.0.0a2
 platform: ruby
 authors:
 - Denis Defreyne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-02 00:00:00.000000000 Z
+date: 2017-12-10 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: ddtelemetry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0a1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0a1
 - !ruby/object:Gem::Dependency
   name: ref
   requirement: !ruby/object:Gem::Requirement
@@ -44,6 +58,7 @@ files:
 - ddmemoize.gemspec
 - lib/ddmemoize.rb
 - lib/ddmemoize/version.rb
+- samples/fib.rb
 - scripts/release
 - spec/ddmemoize_spec.rb
 - spec/spec_helper.rb