lmc-store 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 04e07e855624916fd37f2f210a6f27608e44c54bf7c2d612e7bbe6b0094337d8
+  data.tar.gz: 0ca77b61e18be6592be9320a5268cad3a9126ce9efb4aa8221f05f2f52382607
+SHA512:
+  metadata.gz: b3c860a67b88eea73664d403a7c2f8d8b141cc0c0ebe0311eb5e6263d33724b8ac46bb615ab3b47a73c558fcf39a08b19542d98ce0d8ae2aaf63b2b845a3a180
+  data.tar.gz: fe5458a0fbd3917573c97304cc0005031b9021ac65a820df57359ee722031b4d488a97e4e08b4a06d0b97341e27f399b3e29a49510d537bf39004c288b33ba64

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+gemspec
+
+gem "rake"
+gem "rspec"

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2019 Robin Roestenburg
+
+MIT License
+
+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,26 @@
+LMC (LocalMemCache) store
+------------------
+
+[lmc_store](http://github.com/anteo/lmc_store) is an ActiveSupport::Cache::Store implementation for
+[LocalMemCache](http://localmemcache.rubyforge.org/) in Rails.
+
+## Disclaimer
+
+This gem was created because there are no other gems for modern Rails >= 6.
+While it is in alpha stage, use it at your own risk.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'lmc_store'
+
+And then execute:
+
+    $ bundle
+
+If using Rails, in `config/application.rb`:
+
+    config.cache_store = :lmc_store
+
+Done!

data/Rakefile

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

data/lib/active_support/cache/lmc_store.rb

@@ -0,0 +1,157 @@
+require 'active_support'
+require 'localmemcache'
+require 'concurrent/utility/monotonic_time'
+require 'monitor'
+require 'tmpdir'
+
+class ActiveSupport::Cache::LmcStore < ActiveSupport::Cache::Store
+  DEFAULT_DIR  = Dir.tmpdir
+  DEFAULT_NAME = 'localmemcache'
+  DEFAULT_SIZE = 16.megabytes # also the minimum size, as localmemcache is unreliable below this value
+
+  def initialize(options = {})
+    super options
+
+    directory = options.fetch(:directory, DEFAULT_DIR)
+    name      = options.fetch(:name, DEFAULT_NAME)
+    size      = options.fetch(:size, DEFAULT_SIZE)
+
+    data_store_options = {
+      filename: Pathname.new(directory).join(name).to_s,
+      size_mb:  [DEFAULT_SIZE, size].max / 1.megabyte
+    }
+
+    @data           = LocalMemCache.new(data_store_options)
+    @max_prune_time = options[:max_prune_time] || 2
+    @monitor        = Monitor.new
+    @pruning        = false
+  end
+
+  def self.supports_cache_versioning?
+    true
+  end
+
+  def clear(options = nil)
+    synchronize do
+      @data.clear
+    end
+  end
+
+  def cleanup(options = nil)
+    options = merged_options(options)
+    instrument(:cleanup, size: used_bytes) do
+      keys = synchronize { @data.keys }
+      keys.each do |key|
+        payload = @data[key]
+        entry   = deserialize_entry(payload) if payload
+        delete_entry(key, **options) if entry&.expired?
+      end
+    end
+  end
+
+  def prune(target_size, max_time = nil)
+    return if pruning?
+    @pruning = true
+    begin
+      start_time = Concurrent.monotonic_time
+      cleanup
+      instrument(:prune, target_size, from: used_bytes) do
+        loop do
+          key, _ = @data.random_pair
+          delete_entry(key, **options)
+          return if used_bytes <= target_size || (max_time && Concurrent.monotonic_time - start_time > max_time)
+        end
+      end
+    ensure
+      @pruning = false
+    end
+  end
+
+  def pruning?
+    @pruning
+  end
+
+  def increment(name, amount = 1, options = nil)
+    modify_value(name, amount, options)
+  end
+
+  def decrement(name, amount = 1, options = nil)
+    modify_value(name, -amount, options)
+  end
+
+  def delete_matched(matcher, options = nil)
+    options = merged_options(options)
+    instrument(:delete_matched, matcher.inspect) do
+      matcher = key_matcher(matcher, options)
+      keys    = synchronize { @data.keys }
+      keys.each do |key|
+        delete_entry(key, **options) if key.match(matcher)
+      end
+    end
+  end
+
+  def inspect # :nodoc:
+    "#<#{self.class.name} entries=#{@data.size}, free=#{free_bytes}/#{total_bytes}, options=#{@options.inspect}>"
+  end
+
+  def synchronize(&block)
+    @monitor.synchronize(&block)
+  end
+
+  def total_bytes
+    @data.shm_status[:total_bytes]
+  end
+
+  def free_bytes
+    @data.shm_status[:free_bytes]
+  end
+
+  def used_bytes
+    total_bytes - free_bytes
+  end
+
+  private
+
+  attr_reader :data
+
+  def cached_size(key, payload)
+    (key.to_s.bytesize + payload.bytesize) * 2
+  end
+
+  def read_entry(key, **options)
+    entry = nil
+    synchronize do
+      payload = @data[key]
+      entry   = deserialize_entry(payload) if payload
+    end
+    entry
+  end
+
+  def write_entry(key, entry, **options)
+    payload = serialize_entry(entry)
+    synchronize do
+      cached_size = cached_size(key, payload)
+      prune(total_bytes * 0.75, @max_prune_time) if free_bytes < cached_size
+      @data[key] = payload
+      true
+    end
+  end
+
+  def delete_entry(key, **options)
+    synchronize do
+      payload = @data.delete(key)
+      !!payload
+    end
+  end
+
+  def modify_value(name, amount, options)
+    options = merged_options(options)
+    synchronize do
+      if (num = read(name, options))
+        num = num.to_i + amount
+        write(name, num, options)
+        num
+      end
+    end
+  end
+end

data/lib/lmc-store.rb

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

data/lmc-store.gemspec

@@ -0,0 +1,15 @@
+Gem::Specification.new do |s|
+  s.name          = "lmc-store"
+  s.version       = "0.0.1"
+  s.summary       = "Rails cache store implementation for LocalMemCache (a modern one)"
+  s.authors       = ["Anton Argirov"]
+  s.email         = "anton.argirov@gmail.com"
+  s.files         = Dir.glob("{lib,spec}/**/*") + %w(Gemfile Rakefile LICENSE.txt lmc-store.gemspec README.md)
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ['lib']
+  s.homepage      = "https://github.com/anteo/lmc-store"
+  s.license       = "MIT"
+
+  s.add_dependency 'activesupport', ['>=0']
+  s.add_dependency 'localmemcache', ['~>0.4.0']
+end

data/spec/active_support/cache/lmc_store_spec.rb

@@ -0,0 +1,139 @@
+require 'spec_helper'
+require 'lmc-store'
+require 'securerandom'
+
+describe ActiveSupport::Cache::LmcStore do
+  describe 'caching' do
+    subject { described_class.new }
+    before { subject.clear }
+
+    describe 'read/write/delete' do
+      context 'when cache is empty' do
+        it '#read returns nil' do
+          expect(subject.read('foo')).to be_nil
+        end
+
+        it '#write returns true' do
+          expect(subject.write('foo', '1337')).to be true
+        end
+
+        it '#delete returns false' do
+          expect(subject.delete('foo')).to be false
+        end
+      end
+
+      context 'when cache is not empty' do
+        before do
+          subject.write('foo', '1337')
+        end
+
+        it '#read returns cached value' do
+          expect(subject.read('foo')).to eq('1337')
+        end
+
+        it '#write returns true' do
+          expect(subject.write('foo', '1338')).to be true
+        end
+
+        it '#delete returns true' do
+          expect(subject.delete('foo')).to be true
+        end
+      end
+
+      it 'caches structured values' do
+        data = { foo: 12.34, bar: 56, qux: nil }
+        subject.write('foo', data)
+        expect(subject.read('foo')).to eq(data)
+      end
+    end
+
+    describe '#fetch' do
+      it 'persists values' do
+        subject.fetch('foo') { '1337' }
+        result = subject.fetch('foo') { '1338' }
+        expect(result).to eq '1337'
+      end
+
+      it 'is lazy' do
+        generator = double('value')
+        allow(generator).to receive(:value).once
+
+        2.times do
+          subject.fetch('foo') { generator.value }
+        end
+      end
+    end
+  end
+
+  describe 'eviction' do
+    def blob(size_mb)
+      SecureRandom.random_bytes(size_mb.megabytes)
+    end
+
+    subject { described_class.new(size: 16.megabytes) }
+    before { subject.clear }
+
+    it 'evicts items' do
+      expect(subject).to receive(:prune).at_least(1).and_call_original
+
+      16.times do |index|
+        subject.write(index.to_s, blob(1))
+      end
+    end
+  end
+
+  describe 'persistence' do
+    subject { described_class.new }
+
+    before do
+      fork do
+        subject.clear
+        subject.write 'foo', 'bar'
+        exit 0
+      end
+      Process.wait
+    end
+
+    it 'can read on-disk data' do
+      expect(subject.read('foo')).to eq 'bar'
+    end
+  end
+
+  describe 'concurrency' do
+    def cache_factory
+      described_class.new
+    end
+
+    it 'in the same thread' do
+      cache1 = cache_factory
+      cache2 = cache_factory
+
+      cache1.write('foo', 'bar1')
+      cache2.write('foo', 'bar2')
+
+      expect(cache1.read('foo')).to eq 'bar2'
+    end
+
+    it 'across multiple processes' do
+      cache_factory.clear
+
+      (0..4).each do |process_index|
+        fork do
+          cache = cache_factory
+          (0..99).each do |index|
+            cache.write((index * 5 + process_index).to_s, "cache#{process_index}")
+          end
+          exit 0
+        end
+      end
+
+      Process.wait
+
+      cache = cache_factory
+      (0..499).each do |index|
+        expect(cache.read(index.to_s)).to match /cache\d/
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'active_support'
+
+ActiveSupport.cache_format_version = 7.0

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: lmc-store
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Anton Argirov
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-04-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: localmemcache
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+description:
+email: anton.argirov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/active_support/cache/lmc_store.rb
+- lib/lmc-store.rb
+- lmc-store.gemspec
+- spec/active_support/cache/lmc_store_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/anteo/lmc-store
+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: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: Rails cache store implementation for LocalMemCache (a modern one)
+test_files:
+- spec/active_support/cache/lmc_store_spec.rb
+- spec/spec_helper.rb