evanescence 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a6f2dca734bfb023b9f2c927e49904ca5c34c4247ec619ce704d766ad01f8d66
-  data.tar.gz: c336919947cecc092f7d8e1c4495e4f46097d65bc92ed446c36b64b7c90dbe0c
+  metadata.gz: f68d8f11de5eae7b6526d8b4b040a6645507f18419baf1ffedae2606b122ed08
+  data.tar.gz: 33df762bf878be62d629983e20a8df54206f1fb9842854e7da8571e9ae52ad6e
 SHA512:
-  metadata.gz: 5dd994c61a90b4932917924e347866ba92d60d93431ebc559848e1c43adde7c99bd3e50d6fceb348fc70a837573bc8e8a0a937c991e66afc86fce5c6c70b5f39
-  data.tar.gz: 12ab15620128dda67b0b53480bb7ddea55a0f11769aac037a3b4f3e98c2cb07e7a2e01fab75ce34a0d931f3ea6617ee0176c46ab5fe82a6d8c2876bbc328fc68
+  metadata.gz: 9905ccbb185e07c001ad293199435970f67398cd7c937b388fcdf265eea112c77b4ac1d88f5cc7214fb0fe8f2ab9980faba2dafc46f40e002c6496ca92fa0ea8
+  data.tar.gz: aa2325ccfea0b558bc2518b3359dc537b1ef11a0467d09920f2d1ae90971cadc453582322e6c8a1d765774a3596e41cc44af9a3cfdf7c3477c0981e2e6341f68

data/README.md

@@ -1,6 +1,7 @@
 # Evanescence
 
 [![Push & PR](https://github.com/florindiconescu/evanescence/actions/workflows/main.yml/badge.svg)](https://github.com/florindiconescu/evanescence/actions/workflows/main.yml)
+[![Gem Version](https://badge.fury.io/rb/evanescence.svg)](https://badge.fury.io/rb/evanescence)
 
 In memory cache which can limit the cache size by a maximum number by expiring the least used cached items.
 
@@ -20,6 +21,34 @@ Delete the entire cache: `cache.clear`
 
 Check the cache size: `cache.count`
 
+### In rails with activerecords:
+
+Add `gem "evanescence"` to your gemfile.
+
+In your `ApplicationRecord`:
+```
+require "evanescence/cacheable"
+
+class ApplicationRecord < ActiveRecord::Base
+  extend Evanescence::Cacheable
+  ...
+end
+```
+
+In your model class:
+```
+class Article < ApplicationRecord
+	caches by: :id, max_size: 1000
+	...
+end
+```
+
+In your controller:
+```
+Article.get_by(params[:id])
+```
+
+
 ## Next steps
 Expire the cache after given time.
 

data/lib/evanescence/cacheable.rb

@@ -0,0 +1,21 @@
+module Evanescence
+  module Cacheable
+    def caches(options = {})
+      @by = options[:by]
+      @max_size = options[:max_size]
+      @cache = Evanescence.initialize_cache(max_size:)
+    end
+
+    def get_by(key)
+      cache.read(key) || send("find_by_#{by}", key)&.tap { |object| write_by(key, object) }
+    end
+
+    def write_by(key, value)
+      cache.write(key, value)
+    end
+
+    private
+
+    attr_reader :by, :cache, :max_size
+  end
+end

data/lib/evanescence/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Evanescence
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: evanescence
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - florindiconescu
@@ -66,6 +66,7 @@ files:
 - evanescence.gemspec
 - lib/evanescence.rb
 - lib/evanescence/cache.rb
+- lib/evanescence/cacheable.rb
 - lib/evanescence/version.rb
 - sig/evanescence.rbs
 homepage: https://github.com/florindiconescu/evanescence
@@ -92,7 +93,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.5.5
 signing_key:
 specification_version: 4
 summary: Simple in memory cache