expiring_memory_store 0.1.2 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 57f921197804eacb997b64aef1c87565d8adc47cfba73c98538f2f7d2ec68336
+  data.tar.gz: 0d9dbb97ff8d42f575573709adc440c1eb27df8abb7150b0268da785cf8bfa26
+SHA512:
+  metadata.gz: b2d3debd19a816a55be0457d8eeb12449ab70ea329cc499925603c28c2ca7e4053e5935abd2bcd19a4fdb234a094590f97f2b1532d1bd32778e9edb51bedf681
+  data.tar.gz: '048b7c734a7febb2cdd6d5fb05f0f4b1686be9885888dfa771fe4c716c29971af725b774b08bd309ff8073900fdaac7c0c5663ec1f8fd0cac441b26b2fa93b5f'

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2008 [Matthew Rudy Jacobs]
+Copyright (C) 2013 Michael Grosser <michael@grosser.it>
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/lib/expiring_memory_store.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+class ExpiringMemoryStore
+  MAX_EXPIRES_IN = 2**32
+
+  def initialize
+    @data = {}
+    @mutex = Mutex.new
+  end
+
+  def get(key)
+    _get(key)[1]
+  end
+
+  def set(key, value, expires_in: MAX_EXPIRES_IN)
+    @data[key] = { value: value, expires_at: now + expires_in }
+    value
+  end
+
+  def add(key, value, **args)
+    @mutex.synchronize do
+      return false if _get(key)[0]
+      set(key, value, **args)
+      return true
+    end
+  end
+
+  def fetch(key, **args)
+    @mutex.synchronize do
+      success, value = _get(key)
+      return value if success
+      value = yield
+      set key, value, **args
+    end
+  end
+
+  # remove everything that is expired to prevent leaking memory over time
+  def cleanup
+    @mutex.synchronize do
+      now = now()
+      @data.delete_if { |_key, info| info[:expires_at] < now }
+      true
+    end
+  end
+
+  private
+
+  def _get(key)
+    return [false, nil] unless (info = @data[key])
+    return [false, nil] unless info[:expires_at] > now
+    [true, info[:value]]
+  end
+
+  def now
+    Process.clock_gettime(Process::CLOCK_MONOTONIC)
+  end
+end

data/lib/expiring_memory_store/version.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+class ExpiringMemoryStore
+  VERSION = "1.0.0"
+end

metadata

@@ -1,69 +1,46 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: expiring_memory_store
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 2
-  version: 0.1.2
+version: !ruby/object:Gem::Version
+  version: 1.0.0
 platform: ruby
-authors: 
-- Matthew Rudy Jacobs
+authors:
+- Michael Grosser
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-06-28 00:00:00 +02:00
-default_executable: 
+date: 2019-05-03 00:00:00.000000000 Z
 dependencies: []
-
 description: 
-email: dunno@dunno.com
+email: michael@grosser.it
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - MIT-LICENSE
-- Rakefile
-- Readme.md
-- VERSION
-- expiring_memory_store.gemspec
-- init.rb
-- lib/active_support/cache/expiring_memory_store.rb
-- test/expiring_memory_store_test.rb
-has_rdoc: true
-homepage: http://github.com/matthewrudy/expiring_memory_store
-licenses: []
-
+- lib/expiring_memory_store.rb
+- lib/expiring_memory_store/version.rb
+homepage: https://github.com/grosser/expiring_memory_store
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
-require_paths: 
+rdoc_options: []
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 2.7.6
 signing_key: 
-specification_version: 3
-summary: Fallback when original is not present or somethings not right.
-test_files: 
-- test/expiring_memory_store_test.rb
+specification_version: 4
+summary: Fast & Simple Ruby In-Memory Store with expiration
+test_files: []

data/Rakefile

@@ -1,38 +0,0 @@
-require 'rake'
-require 'rake/testtask'
-require 'rake/rdoctask'
-
-desc 'Default: run unit tests.'
-task :default => :test
-
-desc 'Test the expiring_memory_store plugin.'
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = true
-end
-
-desc 'Generate documentation for the expiring_memory_store plugin.'
-Rake::RDocTask.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'ExpiringMemoryStore'
-  rdoc.options << '--line-numbers' << '--inline-source'
-  rdoc.rdoc_files.include('README')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-begin
-  require 'jeweler'
-  project_name = 'expiring_memory_store'
-  Jeweler::Tasks.new do |gem|
-    gem.name = project_name
-    gem.summary = "Fallback when original is not present or somethings not right."
-    gem.email = "dunno@dunno.com"
-    gem.homepage = "http://github.com/matthewrudy/#{project_name}"
-    gem.authors = ["Matthew Rudy Jacobs"]
-  end
-
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install jeweler"
-end

data/Readme.md

@@ -1,28 +0,0 @@
-ExpiringMemoryStore
-===================
-
-Expiring MemoryStore is a modification to the default Rails MemoryStore which adds the :expires_in functionality that is so useful with Memcache.
-Although this increases the memory overhead slightly,
-it ensures that caches can be expired easily, without restarting your webserver.
-
-Just add;
-  config.cache_store = :expiring_memory_store
-to your environment.rb.
-
-Example
-=======
-
-  >> Rails.cache.write('are you there?', :im_still_here, :expires_in => 30)
-  => :im_still_here
-
-  >> Rails.cache.read('are you there?')
-  => :im_still_here
-
-wait 30 seconds
-
-  >> Rails.cache.read('are you there?')
-  => nil
-
-WICKED!!!
-
-Copyright (c) 2008 [Matthew Rudy Jacobs], released under the MIT license

data/VERSION

@@ -1 +0,0 @@
-0.1.2

data/expiring_memory_store.gemspec

@@ -1,43 +0,0 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
-# -*- encoding: utf-8 -*-
-
-Gem::Specification.new do |s|
-  s.name = %q{expiring_memory_store}
-  s.version = "0.1.2"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Matthew Rudy Jacobs"]
-  s.date = %q{2010-06-28}
-  s.email = %q{dunno@dunno.com}
-  s.files = [
-    "MIT-LICENSE",
-     "Rakefile",
-     "Readme.md",
-     "VERSION",
-     "expiring_memory_store.gemspec",
-     "init.rb",
-     "lib/active_support/cache/expiring_memory_store.rb",
-     "test/expiring_memory_store_test.rb"
-  ]
-  s.homepage = %q{http://github.com/matthewrudy/expiring_memory_store}
-  s.rdoc_options = ["--charset=UTF-8"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.6}
-  s.summary = %q{Fallback when original is not present or somethings not right.}
-  s.test_files = [
-    "test/expiring_memory_store_test.rb"
-  ]
-
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-    else
-    end
-  else
-  end
-end
-

data/init.rb

@@ -1 +0,0 @@
-require 'active_support/cache/expiring_memory_store'

data/lib/active_support/cache/expiring_memory_store.rb

@@ -1,33 +0,0 @@
-require 'active_support'
-module ActiveSupport
-  module Cache
-    # Like MemoryStore, but caches are expired after the period specified in the :expires_in option.
-    class ExpiringMemoryStore < MemoryStore
-
-      def read(name, options = nil)
-        super
-        value, expiry = @data[name]
-        if expiry && expiry < Time.now
-          delete(name)
-          return nil
-        end
-        return value
-      end
-
-      def write(name, value, options = nil)
-        super
-        @data[name] = [value.freeze, expires_at(options)].freeze
-        return value
-      end
-      
-      private
-        
-        def expires_at(options)
-          if expires_in = options && options[:expires_in]
-            return expires_in.from_now if expires_in != 0
-          end
-          return nil
-        end
-    end
-  end
-end

data/test/expiring_memory_store_test.rb

@@ -1,140 +0,0 @@
-require 'rubygems'
-require 'test/unit'
-require 'mocha'
-
-gem 'activesupport', '>=2.3'
-require File.dirname(__FILE__) + '/../init'
-
-class CacheStoreTest < Test::Unit::TestCase
-  def setup
-    @cache = ActiveSupport::Cache.lookup_store(:expiring_memory_store)
-  end
-
-  def test_fetch_without_cache_miss
-    @cache.stubs(:read).with('foo', {}).returns('bar')
-    @cache.expects(:write).never
-    assert_equal 'bar', @cache.fetch('foo') { 'baz' }
-  end
-
-  def test_fetch_with_cache_miss
-    @cache.stubs(:read).with('foo', {}).returns(nil)
-    @cache.expects(:write).with('foo', 'baz', {})
-    assert_equal 'baz', @cache.fetch('foo') { 'baz' }
-  end
-
-  def test_fetch_with_forced_cache_miss
-    @cache.expects(:read).never
-    @cache.expects(:write).with('foo', 'bar', :force => true)
-    @cache.fetch('foo', :force => true) { 'bar' }
-  end
-end
-
-# Tests the base functionality that should be identical across all cache stores.
-module CacheStoreBehavior
-  def test_should_read_and_write_strings
-    @cache.write('foo', 'bar')
-    assert_equal 'bar', @cache.read('foo')
-  end
- 
-  def test_should_read_and_write_hash
-    @cache.write('foo', {:a => "b"})
-    assert_equal({:a => "b"}, @cache.read('foo'))
-  end
- 
-  def test_should_read_and_write_nil
-    @cache.write('foo', nil)
-    assert_equal nil, @cache.read('foo')
-  end
- 
-  def test_fetch_without_cache_miss
-    @cache.write('foo', 'bar')
-    assert_equal 'bar', @cache.fetch('foo') { 'baz' }
-  end
- 
-  def test_fetch_with_cache_miss
-    assert_equal 'baz', @cache.fetch('foo') { 'baz' }
-  end
- 
-  def test_fetch_with_forced_cache_miss
-    @cache.fetch('foo', :force => true) { 'bar' }
-  end
- 
-  def test_increment
-    @cache.write('foo', 1, :raw => true)
-    assert_equal 1, @cache.read('foo', :raw => true).to_i
-    assert_equal 2, @cache.increment('foo')
-    assert_equal 2, @cache.read('foo', :raw => true).to_i
-    assert_equal 3, @cache.increment('foo')
-    assert_equal 3, @cache.read('foo', :raw => true).to_i
-  end
- 
-  def test_decrement
-    @cache.write('foo', 3, :raw => true)
-    assert_equal 3, @cache.read('foo', :raw => true).to_i
-    assert_equal 2, @cache.decrement('foo')
-    assert_equal 2, @cache.read('foo', :raw => true).to_i
-    assert_equal 1, @cache.decrement('foo')
-    assert_equal 1, @cache.read('foo', :raw => true).to_i
-  end
-end
-
-class ExpiringMemoryStoreTest < Test::Unit::TestCase
-  def setup
-    @cache = ActiveSupport::Cache.lookup_store(:expiring_memory_store)
-  end
-
-  include CacheStoreBehavior
-
-  def test_store_objects_should_be_immutable
-    @cache.write('foo', 'bar')
-    assert_raise(ActiveSupport::FrozenObjectError) { @cache.read('foo').gsub!(/.*/, 'baz') }
-    assert_equal 'bar', @cache.read('foo')
-  end
-  
-  def test_by_default_values_should_not_expire
-    time_now = Time.now
-    Time.stubs(:now).returns(time_now)
-    
-    @cache.write('foo', 'bar')
-    assert_equal 'bar', @cache.read('foo')
-    
-    Time.stubs(:now).returns(time_now + 5.years )
-    assert_equal 'bar', @cache.read('foo')
-  end
-  
-  def test_values_should_not_expire_if_expires_in_is_set_to_zero
-    time_now = Time.now
-    Time.stubs(:now).returns(time_now)
-    
-    @cache.write('foo', 'bar', :expires_in => 0)
-    assert_equal 'bar', @cache.read('foo')
-    
-    Time.stubs(:now).returns(time_now + 5.years )
-    assert_equal 'bar', @cache.read('foo')
-  end
-  
-  def test_values_should_expire_is_param_is_set
-    time_now = Time.now
-    Time.stubs(:now).returns(time_now)
-    
-    @cache.write('foo', 'bar', :expires_in => 1.year)
-    assert_equal 'bar', @cache.read('foo')
-    
-    Time.stubs(:now).returns(time_now + 5.years )
-    assert_equal nil, @cache.read('foo')
-  end
-  
-  def test_values_should_expire_when_the_param_tells_it_to
-    time_now = Time.now
-    Time.stubs(:now).returns(time_now)
-    
-    @cache.write('foo', 'bar', :expires_in => 1.year)
-    assert_equal 'bar', @cache.read('foo')
-    
-    Time.stubs(:now).returns(time_now + 1.year - 1 )
-    assert_equal 'bar', @cache.read('foo')
-    
-    Time.stubs(:now).returns(time_now + 1.year + 1 )
-    assert_equal nil, @cache.read('foo')
-  end
-end