lizmat / objectcache

A role to cache objects

NAME

ObjectCache - A role to cache objects

SYNOPSIS

use ObjectCache;

sub id(%h --> Int:D) {
    %h<id> or die "must have an id";
}

class Article does ObjectCache[&id] {
    has $.id;
    # has many more attributes
}

say Article.new(id => 42666789).WHICH;  # Article|42666789

DESCRIPTION

The ObjectCache role mixes the logic of creating a proper ObjectType class and making sure that each unique ObjectType only exists once in memory, into a class.

The role takes a Callable parameterization to indicate how a unique ID should be created from the parameters given (as a hash) with the call to the new method. You can also adapt the given hash making sure any default values are properly applied. If there's already an object created with the returned ID, then no new object will be created but the one from the cache will be returned.

A class is considered to be an object type if the .WHICH method returns an object of the ObjAt class.

This is specifically important when using set operators (such as (elem), or Sets, Bags or Mixes, or any other functionality that is based on the === operator functionality, such as unique and squish.

The format of the value that is being returned by WHICH is only valid during a run of a process. So it should not be stored in any permanent medium.

Removing objects from cache

The ObjectCache role contains a private method !EVICT. If you'd like to have the ability to remove an object from the cache, you should create a method in your class that will call this method:

class Article does ObjectCache[&id] {
    method remove-from-cache() { self!EVICT }
    # more stuff
}

The !EVICT method returns the object that is removed from the cache, or Nil if the object was not in the cache.

Clearing the cache completely

The ObjectCache role contains a private method !CLEAR. If you'd like to have the ability to cleare the cache completely, you should create a method in your class that will call this method:

class Article does ObjectCache[&id] {
    method clear-cache() { self!CLEAR }
    # more stuff
}

The !CLEAR method returns the number of objects that have been removed from the cache.

AUTHOR

Elizabeth Mattijsen [email protected]

Source can be located at: https://github.com/lizmat/ObjectCache . Comments and Pull Requests are welcome.

If you like this module, or what I’m doing more generally, committing to a small sponsorship would mean a great deal to me!

COPYRIGHT AND LICENSE

Copyright 2020, 2021, 2024 Elizabeth Mattijsen

This library is free software; you can redistribute it and/or modify it under the Artistic License 2.0.

objectcache's Issues

Choose constructor?

In line with my REST use case from #1, I wonder if I could wrap fetch instead of new, essentially memoizing a factory method?

I don't mind refactoring to use new to construct the objects, and do a fetch from the constructor, but that seems like I would be overloading my constructor in a way I'm not sure I like.

Clear cache?

Another lizmat module that does exactly what I was trying to figure out how to do!

The documentation does not suggest a way to remove an object from cache. I was going to use it to avoid unnecessarily fetching an API object I already have, but I would like to be able to drop my cached data so I can re-fetch it.