redisize 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b7b65e687f5003dac2ba7e92d42450cea066554ce88bccb49c210ff0a413d41
-  data.tar.gz: 95e775070c058d4f3804d03bb082969146c6e5402aec915d489a11eca262214e
+  metadata.gz: 354b2f1ac302400888ebd67b99b59177d615c685273b21ae4feb4ab3b1c6582f
+  data.tar.gz: 9475c6209ffb1c840bc1da7754dd996e100796e2d37979da9eeee479e97d311e
 SHA512:
-  metadata.gz: b26a2aa8e95fd8de86db627fb45207af2bbebaaaf5fc468b2b4ed8d2f9675a83f8e4852c8d1adbd1150a03bd4dd00a588d2c67c9b5a3ed30f30ddb7f05544c72
-  data.tar.gz: b2493b59261c6c0cbe9962c6dd7e97b635de114695d77373c56608a723b78d9f2e655d59605c2788b4ca978f0e2161b0177c3db7c3c6673126af95dd5e9f1d19
+  metadata.gz: 692729405db96ff8132a4ec0d2eb9bd655000cf5ccb1d39d791c66c2f258f92f2b2f2ae885c8716b5fdebdc322af6478b76119e47f9e2c3c69f09dd0b81678eb
+  data.tar.gz: 17fc2e30bc58f236675a439424c3c7b17a894861febd7595a6d267c9a7c7520cce877ae67a8f94d3ff6c4d8201bdaf3d5cd7d2f480c111787436f88b8c14ae60

data/README.md

@@ -1,8 +1,6 @@
 # Redisize
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/redisize`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+The gem allows to use asynchonous way to cache or just store in redis or any other cache mechanism. For asynchronous caching the Resque or Sidekiq adapters can be used, for synchronous - inline.
 
 ## Installation
 
@@ -22,7 +20,54 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Initialization
+Usually adapter can'be defined automatically of presently installed gems. Curretly are supported sidekiq and resque gems to ansyncronous caching (redisizing). If no such gems are installed, the synchronous **inline** adapter is used. You can redefine manually an adapter as follows:
+
+```ruby
+Redisize.adapter_kind = :inline
+```
+
+Other values are ```:resque```, and ```:sidekiq```.
+And then to use the gem just define in the target object:
+
+```ruby
+include(Redisize)
+```
+
+### In Rails
+
+To use the cache feature with Rails (and ActiveRecord) you have just to wrap a method accessing DB either a record or a relation to a block like this. So to redisize a record value as a json use the follwing:
+
+```ruby
+redisize_json(attrs) do
+   # <JSON generation code>
+   # generate_json(attrs, options)
+end
+```
+
+to drop a JSON value use:
+
+```ruby
+deredisize_json(attrs)
+```
+
+to redisize an SQL:
+
+```ruby
+redisize_sql do
+   relation.as_json(context)
+end
+```
+
+to redisize an record instance use:
+
+```ruby
+redisize_model(slug, by_key: :slug) do
+   self.joins(:slug).where(slugs: {text: slug}).first
+end
+```
+
+Next calls to the block will return a cached value. Updating the record will drop cache for sql or record itself.
 
 ## Development
 
@@ -32,7 +77,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/redisize. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/redisize/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/majioa/redisize. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/majioa/redisize/blob/master/CODE_OF_CONDUCT.md).
 
 
 ## License
@@ -41,4 +86,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Redisize project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/redisize/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Redisize project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/majioa/redisize/blob/master/CODE_OF_CONDUCT.md).

data/lib/redisize/version.rb

@@ -1,3 +1,3 @@
 module Redisize
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

data/lib/redisize.rb

@@ -175,10 +175,6 @@ module Redisize
          end
       end
 
-      def as_json_for instance
-         instance.attribute_names.map {|x|[x, instance.read_attribute(x)] }.to_h
-      end
-
       ### internal methods for enqueued proceeds
       #
       def redisize_model_metas metakey, model_name, attrs, key
@@ -272,7 +268,7 @@ module Redisize
 
    # self -> model instance
    def reredisize_instance
-      attrs = Redisize.as_json_for(self)
+      attrs = self.as_json
       key = Redisize.key_name_for(self.class.polymorphic_base_name, attrs, "instance")
 
       # binding.pry
@@ -282,7 +278,7 @@ module Redisize
 
    # self -> model instance
    def deredisize_instance
-      attrs = Redisize.as_json_for(self)
+      attrs = self.as_json
       key = Redisize.key_name_for(self.class.polymorphic_base_name, attrs, "instance")
 
       # binding.pry
@@ -318,12 +314,12 @@ module Redisize
       def redisize_model value, options = {}, &block
          primary_key = options.fetch(:by_key, self.primary_key).to_s
          key = ["instance", name, primary_key, value]
-         metakey = ["meta", self.class.polymorphic_base_name, primary_key, value]
+         metakey = ["meta", self.polymorphic_base_name, primary_key, value]
 
          # binding.pry
          redisize_cache_fetch(key, expires_in: 1.week) do
             if result = block.call
-               Redisize.enqueue(:redisize_model_metas, metakey, self.name, Redisize.as_json_for(result), key)
+               Redisize.enqueue(:redisize_model_metas, metakey, self.name, result.as_json, key)
             end
 
             result

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redisize
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Pavel «Malo» Skrylev
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-19 00:00:00.000000000 Z
+date: 2023-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -73,7 +73,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: Make json record cacheable to redis