soft_evict_cache 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7d7e60d3d8f66aff63eda2a979293a47591fe314
+  data.tar.gz: d96610c2b95d5fcc3deffb3e3f83ae0d7a9bedd5
+SHA512:
+  metadata.gz: c4476231fe4c884649cd8cdfbe6089c8718f509cfeee73c33e93070386c519af65fa7bda9501849781159a4ae373bd1e96180bc1aca0a6c1cfd3dbda5c1a07ea
+  data.tar.gz: 59c7d983c5dec3d40680ab719edd8b0c492317801f392d767045014549a26c1425807b0384fd636b32e3e627e7157c893834c0037a8329555314aa84435d4cfb

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.2
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in soft_evict_cache.gemspec
+gemspec

data/README.md

@@ -0,0 +1,45 @@
+# SoftEvictCache
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/soft_evict_cache`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'soft_evict_cache'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install soft_evict_cache
+
+## Usage
+
+Create a cache as follows:
+
+```ruby
+value = 0
+cache = SoftEvictCache::SingleValueCache.build(30, 60) do
+  value += 1
+end
+cache.value
+```
+
+The timeouts are calculated AFTER the block completes.
+
+## 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/gja/soft_evict_cache.

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 "soft_evict_cache"
+
+# 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

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/lib/soft_evict_cache/single_value_cache.rb

@@ -0,0 +1,48 @@
+module SoftEvictCache
+  class SingleValueCache
+    class << self
+      def build(soft_evict, hard_evict, &next_value)
+        new(soft_evict, hard_evict, next_value)
+      end
+    end
+
+    class Entry < Struct.new(:value, :soft_evict_at, :hard_evict_at)
+      def soft_evicted?
+        soft_evict_at < Time.now
+      end
+
+      def valid?
+        Time.now < hard_evict_at
+      end
+    end
+
+    def initialize(soft_evict, hard_evict, next_value)
+      @soft_evict = soft_evict
+      @hard_evict = hard_evict
+      @next_value = next_value
+      @agent = Concurrent::Agent.new(Entry.new(nil, Time.now - 1, Time.now - 1))
+    end
+
+    def update_entry(old_entry)
+      return old_entry unless old_entry.soft_evicted?
+      value = @next_value.call
+      Entry.new(value, Time.now + @soft_evict, Time.now + @hard_evict)
+    end
+
+    def value
+      current_entry = @agent.value
+      if current_entry.valid?
+        @agent.send { |old_entry| update_entry(old_entry) } if current_entry.soft_evicted?
+        current_entry.value
+      else
+        promise = Concurrent::Promise.new
+        @agent.send do |old_entry|
+          new_entry = update_entry(old_entry)
+          promise.set(new_entry.value)
+          new_entry
+        end
+        promise.value
+      end
+    end
+  end
+end

data/lib/soft_evict_cache/version.rb

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

data/lib/soft_evict_cache.rb

@@ -0,0 +1,7 @@
+require "soft_evict_cache/version"
+
+require "concurrent"
+
+module SoftEvictCache
+  autoload :SingleValueCache, "soft_evict_cache/single_value_cache"
+end

data/soft_evict_cache.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'soft_evict_cache/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "soft_evict_cache"
+  spec.version       = SoftEvictCache::VERSION
+  spec.authors       = ["Tejas Dinkar"]
+  spec.email         = ["tejas@gja.in"]
+
+  spec.summary       = %q{A Soft Evict Cache For Ruby}
+  spec.homepage      = "https://github.com/gja/soft_evict_cache"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "concurrent-ruby", "~> 1.0.2"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: soft_evict_cache
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tejas Dinkar
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: 
+email:
+- tejas@gja.in
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/soft_evict_cache.rb
+- lib/soft_evict_cache/single_value_cache.rb
+- lib/soft_evict_cache/version.rb
+- soft_evict_cache.gemspec
+homepage: https://github.com/gja/soft_evict_cache
+licenses: []
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A Soft Evict Cache For Ruby
+test_files: []