ddmemoize 1.0.0a3 → 1.0.0rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 075c0a1dd9addf300b84957a864cdd5e24a7a7131e0eb69a9c175351d82eee09
-  data.tar.gz: a398a8b1b884a404b413d837dd81f43057d5c1771cdb893e0838cafa4ff16b4a
+  metadata.gz: 9547603b886803ad9fa2067849ae488e7ac6279d728d5951104b0e59090201ee
+  data.tar.gz: 9bfd235ca2a6ec06517ba1f92de0fbc15ec10f48cf2818b8a32b0a649c92a0d5
 SHA512:
-  metadata.gz: c74d84354fc652fcaec00c1bfeb60ae3e0a718cc8a7431879aefbb4e59e051015ca36e75aec99b913a33646cd93a67558a10317e53d498ce2557bf3289f57bd2
-  data.tar.gz: 1492b6c2cebc1398af73e3d0108967459bacece5bad8f0ed4777a549097a83b33adf97296655640dcdf5ff7effda5590adfadc9c99476165fe7a246d375b32f9
+  metadata.gz: b0572237f3ee8bf2b46f1c6332034046c39c808e3a1d5f6731a4524e52572f4d42dcfab7d471ff4f533eeb3ec504c46243076ccd5578634092828cbf70e93816
+  data.tar.gz: b2401d5d3748383301346edd247aa3702a7ead1ac67bbf2085ed71d9f4de54f85dc7ff3ee60659d15b82655b955039b77e372da768bd5a0714bf343dfbd893d1

data/.travis.yml

@@ -3,11 +3,16 @@ language: ruby
 rvm:
   - "2.3"
   - "2.4"
+  - "2.5"
 
 branches:
   only:
     - "master"
 
+before_install:
+  - gem update --system
+  - gem install bundler -v 1.16.0
+
 cache: bundler
 
 sudo: false

data/NEWS.md

@@ -1,5 +1,11 @@
 # DDMemoize news
 
+## 1.0.0rc1 (2018-01-04)
+
+Changes:
+
+* Renamed telemetry to metrics
+
 ## 1.0.0a3 (2017-12-18)
 
 Changes:

data/README.md

@@ -30,7 +30,7 @@ Features:
 
 * Supports memoizing functions on frozen objects
 * Releases memoized values when needed in order to reduce memory pressure
-* Optionally records telemetry
+* Optionally records metrics
 
 ## Installation
 
@@ -81,14 +81,14 @@ Alternatively, prepend `memoized` to the function definition:
 
 Do not memoize functions that depend on mutable state.
 
-### Telemetry
+### Metrics
 
-To activate telemetry, call `DDMemoize.enable_telemetry` after requiring `ddmemoize`.
+To activate metrics, call `DDMemoize.enable_metrics` after requiring `ddmemoize`.
 
-To print the collected metrics, call `DDMemoize.print_telemetry`:
+To print the collected metrics, call `DDMemoize.print_metrics`:
 
 ```ruby
-DDMemoize.print_telemetry
+DDMemoize.print_metrics
 ```
 
 ```

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.0a2') # TODO: upgrade
+  spec.add_runtime_dependency('ddmetrics', '= 1.0.0rc1') # TODO: upgrade
   spec.add_runtime_dependency('ref', '~> 2.0')
 
   spec.files         = `git ls-files -z`.split("\x0")

data/lib/ddmemoize.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'ref'
-require 'ddtelemetry'
+require 'ddmetrics'
 require 'singleton'
 
 require_relative 'ddmemoize/version'
@@ -22,24 +22,28 @@ module DDMemoize
   end
 
   class << self
-    def enable_telemetry
-      @telemetry_enabled = true
+    def enable_metrics
+      @metrics_enabled = true
     end
 
-    def telemetry_enabled?
-      @telemetry_enabled
+    def metrics_enabled?
+      @metrics_enabled
     end
 
-    def telemetry_counter
-      @_telemetry_counter ||= DDTelemetry::Counter.new
+    def metrics_counter
+      @_metrics_counter ||= DDMetrics::Counter.new
     end
   end
 
-  def self.print_telemetry
+  def self.print_metrics
     headers = %w[memoization hit miss %]
 
-    rows_raw = DDMemoize.telemetry_counter.map do |(name, type), count|
-      { name: name, type: type, count: count }
+    rows_raw = DDMemoize.metrics_counter.map do |label, count|
+      {
+        name: label.fetch(:method),
+        type: label.fetch(:type),
+        count: count,
+      }
     end
 
     rows = rows_raw.group_by { |r| r[:name] }.map do |name, rows_for_name|
@@ -53,7 +57,7 @@ module DDMemoize
     end
 
     all_rows = [headers] + rows
-    puts DDTelemetry::Table.new(all_rows).to_s
+    puts DDMetrics::Table.new(all_rows).to_s
   end
 
   module Mixin
@@ -62,7 +66,7 @@ module DDMemoize
       alias_method original_method_name, method_name
 
       instance_cache = Hash.new { |hash, key| hash[key] = {} }
-      counter_label = "#{self}##{method_name}"
+      full_method_name = "#{self}##{method_name}"
 
       define_method(method_name) do |*args|
         instance_method_cache = instance_cache[self]
@@ -73,11 +77,11 @@ module DDMemoize
           value = object ? object.value : NONE
         end
 
-        if DDMemoize.telemetry_enabled?
+        if DDMemoize.metrics_enabled?
           if NONE.equal?(value)
-            DDMemoize.telemetry_counter.increment([counter_label, :miss])
+            DDMemoize.metrics_counter.increment(method: full_method_name, type: :miss)
           else
-            DDMemoize.telemetry_counter.increment([counter_label, :hit])
+            DDMemoize.metrics_counter.increment(method: full_method_name, type: :hit)
           end
         end
 

data/lib/ddmemoize/version.rb

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

data/samples/fib.rb

@@ -2,7 +2,7 @@
 
 require 'ddmemoize'
 
-DDMemoize.enable_telemetry
+DDMemoize.enable_metrics
 
 class FibFast
   DDMemoize.activate(self)
@@ -21,4 +21,4 @@ end
 
 p FibFast.new.fib(1000)
 
-DDMemoize.print_telemetry
+DDMemoize.print_metrics

data/scripts/release

@@ -2,38 +2,28 @@
 # frozen_string_literal: true
 
 require 'fileutils'
+require 'json'
+require 'netrc'
 require 'octokit'
+require 'shellwords'
+require 'uri'
 
 def run(*args)
-  puts 'I will execute the following:'
-  puts '    ' + args.map { |a| a =~ /\s/ ? a.inspect : a }.join(' ')
-  print 'Is this correct? [y/N] '
-  res = gets
-  unless res.strip.casecmp('y').zero?
-    warn 'Answer was not Y; release aborted.'
-    exit 1
-  end
-
-  system('echo', *args)
+  puts('<exec> ' + args.map { |s| Shellwords.escape(s) }.join(' '))
   system(*args)
-
-  print 'Continue? [y/N] '
-  res = gets
-  unless res.strip.casecmp('y').zero?
-    warn 'Answer was not Y; release aborted.'
-    exit 1
-  end
-
-  true
 end
 
+gem_name = 'ddmemoize'
+version_constant = 'DDMemoize::VERSION'
+gem_path = 'ddmemoize'
+
 puts '=== Logging in to GitHub’s API…'
 client = Octokit::Client.new(netrc: true)
 puts
 
 puts '=== Deleting old *.gem files…'
 Dir['*.gem'].each do |fn|
-  puts "  #{fn}…"
+  puts "deleting #{fn}…"
   FileUtils.rm_f(fn)
 end
 puts
@@ -45,13 +35,41 @@ unless File.readlines('NEWS.md').drop(2).first =~ / \(\d{4}-\d{2}-\d{2}\)$/
 end
 puts
 
+puts '=== Reading version…'
+require "./lib/#{gem_path}/version"
+version = eval(version_constant) # rubocop:disable Security/Eval
+puts "Version = #{version}"
+puts
+
 puts '=== Building new gem…'
 run('gem', 'build', 'ddmemoize.gemspec')
 puts
 
-puts '=== Reading version…'
-require './lib/ddmemoize/version'
-puts "Version = #{DDMemoize::VERSION}"
+puts '=== Verifying that gems were built properly…'
+gem_filename = "#{gem_name}-#{version}.gem"
+unless File.file?(gem_filename)
+  warn "Error: Could not find gem: #{gem_filename}"
+  exit 1
+end
+puts
+
+puts '=== Verifying that gem version does not yet exist…'
+url = URI.parse("https://rubygems.org/api/v1/versions/#{gem_name}.json")
+response = Net::HTTP.get_response(url)
+existing_versions =
+  case response.code
+  when '404'
+    []
+  when '200'
+    JSON.parse(response.body).map { |e| e.fetch('number') }
+  else
+    warn "Error: Couldn’t fetch version information for #{gem_name} (status #{response.code})"
+    exit 1
+  end
+if existing_versions.include?(version)
+  warn "Error: #{gem_name} v#{version} already exists"
+  exit 1
+end
 puts
 
 puts '=== Verifying that release does not yet exist…'

data/spec/ddmemoize_spec.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-DDMemoize.enable_telemetry
+DDMemoize.enable_metrics
 
 describe DDMemoize do
   it 'has a version number' do
@@ -79,7 +79,7 @@ describe DDMemoize do
     record memoized def run; end
   end
 
-  class MemoizationSpecWithTelemetry
+  class MemoizationSpecWithMetrics
     DDMemoize.activate(self)
 
     def run(value)
@@ -115,10 +115,10 @@ describe DDMemoize do
     sample.run
     sample.run
 
-    counter = DDMemoize.telemetry_counter
+    counter = DDMemoize.metrics_counter
 
-    expect(counter.get(['MemoizationSpecEqual#run', :miss])).to eq(1)
-    expect(counter.get(['MemoizationSpecEqual#run', :hit])).to eq(2)
+    expect(counter.get(method: 'MemoizationSpecEqual#run', type: :miss)).to eq(1)
+    expect(counter.get(method: 'MemoizationSpecEqual#run', type: :hit)).to eq(2)
   end
 
   it 'supports memoized def … syntax' do
@@ -142,26 +142,26 @@ describe DDMemoize do
     expect(MemoizationSpecInlineSyntaxReturn.sym).to eq(:run)
   end
 
-  it 'records telemetry' do
-    sample = MemoizationSpecWithTelemetry.new
+  it 'records metrics' do
+    sample = MemoizationSpecWithMetrics.new
 
     sample.run('denis')
     sample.run('denis')
     sample.run('defreyne')
 
-    counter = DDMemoize.telemetry_counter
+    counter = DDMemoize.metrics_counter
 
-    expect(counter.get(['MemoizationSpecWithTelemetry#run', :miss])).to eq(2)
-    expect(counter.get(['MemoizationSpecWithTelemetry#run', :hit])).to eq(1)
+    expect(counter.get(method: 'MemoizationSpecWithMetrics#run', type: :miss)).to eq(2)
+    expect(counter.get(method: 'MemoizationSpecWithMetrics#run', type: :hit)).to eq(1)
   end
 
-  it 'prints recorded telemetry' do
-    sample = MemoizationSpecWithTelemetry.new
+  it 'prints recorded metrics' do
+    sample = MemoizationSpecWithMetrics.new
 
     sample.run('denis')
     sample.run('denis')
     sample.run('defreyne')
 
-    expect { DDMemoize.print_telemetry }.to output(/memoization │ hit\s+miss\s+%/).to_stdout
+    expect { DDMemoize.print_metrics }.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%%', # rubocop:disable Style/FormatStringToken
+    format: '%c/%C |<%b>%i| %p%%',
   }
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: ddmemoize
 version: !ruby/object:Gem::Version
-  version: 1.0.0a3
+  version: 1.0.0rc1
 platform: ruby
 authors:
 - Denis Defreyne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-18 00:00:00.000000000 Z
+date: 2018-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: ddtelemetry
+  name: ddmetrics
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0a2
+        version: 1.0.0rc1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0a2
+        version: 1.0.0rc1
 - !ruby/object:Gem::Dependency
   name: ref
   requirement: !ruby/object:Gem::Requirement
@@ -82,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.7.4
 signing_key: 
 specification_version: 4
 summary: Adds support for memoizing functions