expiring_memoize 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 47ee17e75d5b48533d67f92bc9651c1eb10e15d1944fb9267530e76b5925d18e
+  data.tar.gz: d480dcbf5f10dfc42ae7b49a05bdbb8e5c5dd4f59c49c35d1d25d1dcd6b6a900
+SHA512:
+  metadata.gz: 68ce781238798de20734ad6e7b2ee30e4b8e1a8518d4d93c8fa5511f5a21bddae6cd7565e3b3d7e246ecca977f013c31791ec3ca4046727c9971399b5aa66e35
+  data.tar.gz: 3e660cbb73620eb5116ff422da898549dd9080403592ceb394ded7ef87935f160cb98e2293778c9a621be8ccbe2a3078b94b941007ba1810a1fbc286c2a0aa71

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+/Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.5
+before_install: gem install bundler -v 1.17.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in expiring_memoize.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Rafał Rzepecki
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,89 @@
+# ExpiringMemoize
+
+Memoize a method result, refetching after a time to live has elapsed.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'expiring_memoize'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install expiring_memoize
+
+## Usage
+
+```ruby
+class PriceFetcher
+  def current_price
+    puts 'fetching'
+    rand # say it's an expensive operation here
+  end
+
+  extend ExpiringMemoize
+  memoize :current_price, ttl: Float::INFINITY
+end
+
+fetcher = PriceFetcher.new
+
+puts fetcher.current_price # fetched
+puts fetcher.current_price # uses cached value
+sleep 5
+puts fetcher.current_price # fetched again
+
+# works multi-threaded too;
+# code below fetches only once
+
+fetcher = PriceFetcher.new
+5.times.map do
+  Thread.new do
+    sleep rand
+    puts fetcher.current_price
+  end
+end.join
+```
+
+## Features
+
+- Thread safe.
+  If many threads try to get the value and it's found to be stale, they race to
+  refetch and only one of them does.
+- Exception safe.
+  If the fetch raises an exception it'll bubble up to the caller. Since the
+  value will still be stale, next query will retry the fetch.
+- Time travel safe.
+  Uses `Process.clock_gettime` to provide a monotonic clock. Time adjustment
+  events, eg. sleep, ntpdate etc. do not affect the TTL calculation.
+
+## Implementation details
+
+Per-object data is stored in `@_expiring_memoize_data` instance variable as a
+hash, to avoid polluting the ivar namespace. The memoized method is replaced
+and the original is held in the closure of the replacement.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Known limitations
+
+- Only nullary instance methods are supported.
+- Won't work on platforms where `Process.clock_gettime` is not supported, or
+  where it does not support `CLOCK_MONOTONIC_COARSE`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/dividedmind/expiring_memoize.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "expiring_memoize"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/expiring_memoize.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "expiring_memoize/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "expiring_memoize"
+  spec.version       = ExpiringMemoize::VERSION
+  spec.authors       = ["Rafał Rzepecki"]
+  spec.email         = ["divided.mind@gmail.com"]
+
+  spec.summary       = %q{Memoize with TTL.}
+  spec.description   = %q{Memoize a method result, refetching after a time to live has elapsed.}
+  spec.homepage      = "https://github.com/dividedmind/expiring_memoize"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/expiring_memoize.rb

@@ -0,0 +1,43 @@
+require "expiring_memoize/version"
+
+module ExpiringMemoize
+  # Memoize a nullary method.
+  # @param name [Symbol] method to memoize
+  # @option ttl [Number] time to live of the value, in seconds
+  def memoize name, ttl: Float::INFINITY
+    original = instance_method name
+    raise ArgumentError, 'only nullary methods supported' unless original.arity.zero?
+
+    define_method name do
+      data = ((@_expiring_memoize_data ||= {})[name] ||= {})
+      loop do
+        # no need to synchronize here -- worst case,
+        # we return a value fresher than expected.
+        # (plus, global interpreter lock in MRI makes it safe regardless)
+        unless (ts = data[:timestamp]) && (ExpiringMemoize.gettime - ts) < ttl
+          # value is stale, race to fetch
+          mutex ||= (data[:mutex] ||= Mutex.new)
+          if mutex.try_lock
+            # our thread won the race, let's get the value
+            begin
+              data[:value] = original.bind(self).call
+              data[:timestamp] = ExpiringMemoize.gettime
+            ensure
+              mutex.unlock
+            end
+          else
+            # our thread lost, block on the mutex and try again
+            mutex.synchronize {}
+            next
+          end
+        end
+        return data[:value]
+      end
+    end
+  end
+
+  # @nodoc
+  def self.gettime
+    Process.clock_gettime Process::CLOCK_MONOTONIC_COARSE
+  end
+end

data/lib/expiring_memoize/version.rb

@@ -0,0 +1,3 @@
+module ExpiringMemoize
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: expiring_memoize
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rafał Rzepecki
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-09-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Memoize a method result, refetching after a time to live has elapsed.
+email:
+- divided.mind@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- expiring_memoize.gemspec
+- lib/expiring_memoize.rb
+- lib/expiring_memoize/version.rb
+homepage: https://github.com/dividedmind/expiring_memoize
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6.2
+signing_key: 
+specification_version: 4
+summary: Memoize with TTL.
+test_files: []