volatile_map 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 741ca5ddadf8ec48692705ea3baa57ddaa9ec1b9ed5549ad6de8bce5118f0a08
-  data.tar.gz: b199789a380616de7861d97401d05b49960b80bad32e1328a7bc06fe2965df0b
+  metadata.gz: 1a2771a72fbf86ca6d707d5e73d7ec3bc413f6f87b2c240a2dce1d89ccaf3a27
+  data.tar.gz: c03992f176a51f3aee3bac6a6fe31fbc4c9d35154451350c4706fc0d5f91955c
 SHA512:
-  metadata.gz: 35b9afc7c775fc1db235ce0630fbffadf6749a3fa42c402e380dc3782d34a48695c3a0e02c70fe45508f62bdd728d4f1012728c4cf075a0e1400354016af68da
-  data.tar.gz: 0f923260addb0b974b82437b6a63461302a43abdb18a133f7ba938fd143b1a8c0f5b64e33b08ae02fd808e3b30280929f322e666afc01a631d0b47a1811677fc
+  metadata.gz: 3b53c5a983029d81b43c7b61e03b978d9c12af401e187d9e41e041d84a2eabb0ea8198ab9c0d46615f7bf333d9e25108586be86e2ddfbfe00ec03354bb9630fe
+  data.tar.gz: f1235f6e0088e7ac8c4dca138741e32f65f07aaa8228d2ed1f266382bf4c14d6bbda0539d610d8dcea98c0d970ccea1728b457536d984ca886785e767747acb9

data/README.md

@@ -26,7 +26,7 @@ gem install volatile_map
 require "volatile_map"
 
 # TTL is in seconds (Float or Integer)
-cache = VolatileMap.new(0.5)
+cache = VolatileMap.new(ttl: 0.5)
 
 cache["session"] = { user_id: 42 }
 cache["session"]            # => { user_id: 42 }
@@ -42,7 +42,10 @@ cache["session"]            # => nil
 
 ### API
 
-- `VolatileMap.new(ttl)` — construct a map with the given TTL in seconds.
+- `VolatileMap.new(ttl:, strict: false)` — construct a map with the given TTL
+  in seconds. The optional `strict:` keyword is stored on the instance and
+  exposed via `strict?`; when `true`, the keys will return `nil` when they
+  expire even if they are not claimed by the VM.
 - `map[key] = value` — store a value; resets the entry's timestamp.
 - `map[key]` — retrieve a value; returns `nil` if missing or expired.
   Refreshes the timestamp on a hit.
@@ -51,6 +54,7 @@ cache["session"]            # => nil
   Also evicts and refreshes like `[]`.
 - `map.size` — number of entries currently stored.
 - `map.ttl` — the configured TTL in seconds.
+- `map.strict?` — whether the map was constructed with `strict: true`.
 
 ### Semantics
 

data/ext/volatile_map/volatile_map.c

@@ -18,6 +18,8 @@ static size_t vm_live_count = 0;
 static rb_postponed_job_handle_t vm_drain_job_handle;
 #endif
 
+static ID ttl_id, strict_id;
+
 struct vm_drain_ctx {
   double now;
   double ttl;
@@ -128,6 +130,7 @@ VALUE alloc_volatile_map(VALUE klass) {
 
   vm->storage = rb_hash_new();
   vm->ttl = 0.0;
+  vm->is_strict = false;
   vm_live_count++;
 
   ensure_dirty_capacity();
@@ -142,13 +145,23 @@ static VolatileMap *vm_get(VALUE self) {
   return vm;
 }
 
-static VALUE vm_initialize(VALUE self, VALUE ttl) {
+static VALUE vm_initialize(int argc, VALUE *argv, VALUE self) {
   VolatileMap *vm = vm_get(self);
-  double ttl_value = NUM2DBL(ttl);
+  VALUE opts;
+  VALUE kwargs[2];
+  ID keys[2] = {ttl_id, strict_id};
+
+  rb_scan_args(argc, argv, ":", &opts);
+
+  rb_get_kwargs(opts, keys, 1, 1, kwargs);
+
+  double ttl_value = NUM2DBL(kwargs[0]);
+  VALUE is_strict = kwargs[1];
 
   if(ttl_value <= 0.0) rb_raise(rb_eArgError, "TTL must be positive");
 
   vm->ttl = ttl_value;
+  vm->is_strict = (is_strict != Qundef && RTEST(is_strict));
 
   return self;
 }
@@ -157,6 +170,10 @@ static VALUE vm_ttl(VALUE self) {
   return DBL2NUM(vm_get(self)->ttl);
 }
 
+static VALUE vm_strict(VALUE self) {
+  return vm_get(self)->is_strict ? Qtrue : Qfalse;
+}
+
 static VALUE vm_aset(VALUE self, VALUE key, VALUE value) {
   VolatileMap *vm = vm_get(self);
   VALUE entry = rb_ary_new_from_args(2, value, DBL2NUM(now_seconds()));
@@ -174,7 +191,7 @@ static VALUE vm_aref(VALUE self, VALUE key) {
 
   double now = now_seconds();
 
-  if(is_stale(vm->ttl, entry, now)) {
+  if(vm->is_strict && is_stale(vm->ttl, entry, now)) {
     rb_hash_delete(vm->storage, key);
 
     return Qnil;
@@ -224,12 +241,16 @@ static VALUE vm_key(VALUE self, VALUE key) {
 void Init_volatile_map(void) {
   rb_require("volatile_map/version");
 
+  ttl_id = rb_intern("ttl");
+  strict_id = rb_intern("strict");
+
   VALUE volatile_map_class = rb_define_class("VolatileMap", rb_cObject);
 
   rb_define_alloc_func(volatile_map_class, alloc_volatile_map);
 
-  rb_define_method(volatile_map_class, "initialize", vm_initialize, 1);
+  rb_define_method(volatile_map_class, "initialize", vm_initialize, -1);
   rb_define_method(volatile_map_class, "ttl", vm_ttl, 0);
+  rb_define_method(volatile_map_class, "strict?", vm_strict, 0);
   rb_define_method(volatile_map_class, "[]=", vm_aset, 2);
   rb_define_method(volatile_map_class, "[]", vm_aref, 1);
   rb_define_method(volatile_map_class, "delete", vm_delete, 1);

data/ext/volatile_map/volatile_map.h

@@ -7,6 +7,7 @@
 typedef struct volatile_map_struct {
   VALUE storage;
   double ttl;
+  bool is_strict;
 } VolatileMap;
 
 VALUE alloc_volatile_map(VALUE klass);

data/lib/volatile_map/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class VolatileMap
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: volatile_map
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Mehmet Emin INAC