redisize 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b7b65e687f5003dac2ba7e92d42450cea066554ce88bccb49c210ff0a413d41
-  data.tar.gz: 95e775070c058d4f3804d03bb082969146c6e5402aec915d489a11eca262214e
+  metadata.gz: 71df00d9c001e09d06c90fc75ea318e50330dd6cebf2d804b0fd91ed329bb11b
+  data.tar.gz: caa72c28e9750012bccd1fc59caedfd27b5eb10bba75c38ba1f325e7e1527c94
 SHA512:
-  metadata.gz: b26a2aa8e95fd8de86db627fb45207af2bbebaaaf5fc468b2b4ed8d2f9675a83f8e4852c8d1adbd1150a03bd4dd00a588d2c67c9b5a3ed30f30ddb7f05544c72
-  data.tar.gz: b2493b59261c6c0cbe9962c6dd7e97b635de114695d77373c56608a723b78d9f2e655d59605c2788b4ca978f0e2161b0177c3db7c3c6673126af95dd5e9f1d19
+  metadata.gz: 17a578a95fdeb9a8c70fbea3d73c0642fa04ea37de713b8f386ad9b26e2ebd5802e2d66430f5e1698a16f227467bdf01abc6d7fd2cdf1b2479e3fadfd8acc515
+  data.tar.gz: fddd7a97b499514ac78a21168dfb5af6e21b10d5f28cdcc3001ec081812b565670fb8571e3a358e8759dae7bc929ab72825f16b437bae6398b8bfcb85ab3bc8f

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/support/enumerable.rb

@@ -0,0 +1,20 @@
+module Redisize
+   module Support
+      module Enumerable
+         def self.included kls
+            kls.class_eval do
+               def redisize
+                  case self
+                  when Hash
+                     redisize_hash { map { |x| x.jsonize } }
+                  when Array
+                     redisize_array { map { |x| x.jsonize } }
+                  else
+                     x.jsonize
+                  end
+               end
+            end
+         end
+      end
+   end
+end

data/lib/redisize/version.rb

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

data/lib/redisize.rb

@@ -16,6 +16,9 @@ module Redisize
    module ORM
       autoload :ActiveRecord, File.join(__dir__, 'redisize/orm/active_record.rb')
    end
+   module Support
+      autoload :Enumerable, File.join(__dir__, 'redisize/support/enumerable.rb')
+   end
 
    class << self
       attr_writer :adapter
@@ -30,6 +33,10 @@ module Redisize
          ActiveRecord: 'active_record'
       }
 
+      SUPPORTS = {
+         Enumerable: 'enumerable'
+      }
+
       LOGS = {
          Rails: 'rails'
       }
@@ -42,10 +49,11 @@ module Redisize
       def included kls
          kls.extend(Redisize::ClassMethods)
 
-         # init orm, log, and cache
+         # init orm, log, cache, and support classes
          init_orm_for(kls)
          init_log_for(kls)
          init_cache_for(kls)
+         init_support_for(kls)
       end
 
       def init_orm_for kls
@@ -57,6 +65,17 @@ module Redisize
          end
       end
 
+      def init_support_for kls
+         sup = Object.constants.reduce(nil) { |res, anc| res || SUPPORTS.keys.find {|re| /#{re}/ =~ anc.to_s } }
+
+         if sup
+            require("redisize/support/#{SUPPORTS[sup]}")
+            cls = sup.to_s.constantize
+            cls.include(Redisize::Support.const_get(sup))
+            cls.include(Redisize::ClassMethods)
+         end
+      end
+
       def init_log_for kls
          log = Object.constants.reduce(nil) { |res, anc| res || LOGS.keys.find {|re| /#{re}/ =~ anc.to_s } }
 
@@ -75,6 +94,7 @@ module Redisize
             require("redisize/cache/#{CACHES[cache]}")
             Redisize.include(Redisize::Cache.const_get(cache))
             Redisize.extend(Redisize::Cache.const_get(cache))
+            Enumerable.include(Redisize::Cache.const_get(cache))
             kls.extend(Redisize::Cache.const_get(cache))
          end
       end
@@ -175,10 +195,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
@@ -189,9 +205,9 @@ module Redisize
          assign_reverse_key(metakey, key)
       end
 
-      # +redisize_sql_metas+ updates all the meta keys for the result value
+      # +redisize_array_metas+ updates all the meta keys for the result array value
       #
-      def redisize_sql_metas key, attres
+      def redisize_array_metas key, attres
          model_name = key[1]
          primary_key = key[2]
 
@@ -272,7 +288,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 +298,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
@@ -300,15 +316,48 @@ module Redisize
          end
       end
 
+      def primary_key_with key_name_in = nil
+        key_name_in || self.respond_to?(:primary_key) && self.primary_key || case self
+            when ActiveRecord
+               self.map.first&.class&.primary_key
+            when ActiveRecord::Scoping, ActiveRecord::Reflection, ActiveRecord::Associations
+               self.values.map.first&.class&.primary_key
+            end
+      end
+
       # self -> model class
       def redisize_sql &block
          key = ["sql", self.name, self.primary_key, self.all.to_sql]
 
+         redisize_by_key(key, &block)
+      end
+
+      # self -> model class
+      def redisize_hash key_name_in = nil, &block
+         key_name = primary_key_with(key_name_in)
+
+         key = ["by_key", *self.values.map do |x|
+            key_name && x.respond_to?(key_name) ? x.send(key_name).to_s : x.to_s
+         end ]
+
+         redisize_by_key(key, &block)
+      end
+
+      # self -> model class
+      def redisize_array key_name_in = nil, &block
+         key_name = primary_key_with(key_name_in)
+
+         key = ["by_key", *self.map { |x| key_name ? x.send(key_name).to_s : x.to_s } ]
+
+         redisize_by_key(key, &block)
+      end
+
+      def redisize_by_key key, &block
          # binding.pry
          redisize_cache_fetch(key, expires_in: 1.day) do
             value = block.call
 
-            Redisize.enqueue(:redisize_sql_metas, key, value)
+            Redisize.enqueue(:redisize_array_metas, key, value)
 
             value
          end
@@ -318,12 +367,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

data/redisize.gemspec

@@ -8,15 +8,15 @@ Gem::Specification.new do |spec|
 
   spec.summary       = %q{Make json record cacheable to redis}
   spec.description   = %q{Make json record cacheable to redis via various adapters like Resque, Sidekiq, etc}
-  spec.homepage      = "https://github.com/majioa/redisize"
+  spec.homepage      = "https://codeberg.org/majioa/redisize"
   spec.license       = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
 
   spec.metadata["allowed_push_host"] = "https://rubygems.org"
 
   spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/majioa/redisize"
-  spec.metadata["changelog_uri"] = "https://github.com/majioa/redisize/CHANGELOG.md"
+  spec.metadata["source_code_uri"] = "https://codeberg.org/majioa/redisize"
+  spec.metadata["changelog_uri"] = "https://codeberg.org/majioa/redisize/CHANGELOG.md"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redisize
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - Pavel «Malo» Skrylev
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-19 00:00:00.000000000 Z
+date: 2024-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -48,16 +48,17 @@ files:
 - lib/redisize/cache/rails.rb
 - lib/redisize/log/rails.rb
 - lib/redisize/orm/active_record.rb
+- lib/redisize/support/enumerable.rb
 - lib/redisize/version.rb
 - redisize.gemspec
-homepage: https://github.com/majioa/redisize
+homepage: https://codeberg.org/majioa/redisize
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-  homepage_uri: https://github.com/majioa/redisize
-  source_code_uri: https://github.com/majioa/redisize
-  changelog_uri: https://github.com/majioa/redisize/CHANGELOG.md
+  homepage_uri: https://codeberg.org/majioa/redisize
+  source_code_uri: https://codeberg.org/majioa/redisize
+  changelog_uri: https://codeberg.org/majioa/redisize/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -73,7 +74,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