redisize 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4dd240d50c272014c6d147455c340d73dee4cba93015ce7f37a7f43af920e44b
+  data.tar.gz: 604bf60003f3e2ca84037a70d46769c3e791bc56a108b6e0190a5442a00edc88
+SHA512:
+  metadata.gz: f69e2bbf3956f302194e1d3cda8afe59e9408e7823f7fbe5eee755a2c8fb3c78cf5a7edf66a7292181226e2dccde925eacf5c501475469387cf7f7d30ab709fd
+  data.tar.gz: 99a168322bc6fbe43a8f920f9310ec11bae7f57cd7fdf128024cfcd9be0547cf075c9f730558c8cdd0fb8b16426b937b54734a581e3d21195114f91bfe1e4aa0

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock
+*~
+*.sw*

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at majioa@yandex.ru. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in redisize.gemspec
+gemspec
+
+gem "rake", ">= 12.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Pavel «Malo» Skrylev
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,44 @@
+# 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
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'redisize'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install redisize
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## 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).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## 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).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/TODO

@@ -0,0 +1,6 @@
+adapters
+# add: sucker_punch
+   # add ActiveJob::Base
+   # add: DelayedJobs
+   # add: dynflow
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "redisize"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/redisize/adapter/inline.rb

@@ -0,0 +1,11 @@
+module Redisize
+   module Adapter
+      class Inline
+         class << self
+            def enqueue method, *args
+               Redisize.send(method, *args)
+            end
+         end
+      end
+   end
+end

data/lib/redisize/adapter/resque.rb

@@ -0,0 +1,21 @@
+module Redisize
+   module Adapter
+      class Resque
+         @queue = :caching
+
+         class << self
+            def enqueue *args
+               ::Resque.enqueue(self, *args)
+            end
+
+            def lock_workers _method, *_args
+               @queue
+            end
+
+            def perform method, *args
+               Redisize.send(method, *args)
+            end
+         end
+      end
+   end
+end

data/lib/redisize/adapter/sidekiq.rb

@@ -0,0 +1,20 @@
+module Redisize
+   module Adapter
+      class Sidekiq
+         include ::Sidekiq::Worker
+         sidekiq_options queue: 'caching'
+         sidekiq_options limits: { caching: 1 }
+         sidekiq_options process_limits: { caching: 1 }
+
+         def perform method, *args
+            Redisize.send(method, *args)
+         end
+
+         class << self
+            def enqueue *args
+               self.perform_async(*args)
+            end
+         end
+      end
+   end
+end

data/lib/redisize/cache/rails.rb

@@ -0,0 +1,21 @@
+module Redisize
+   module Cache
+      module Rails
+         def redisize_cache_write key, object, options = {}
+            ::Rails.cache.write(key, object, options)
+         end
+
+         def redisize_cache_read key
+            ::Rails.cache.read(key)
+         end
+
+         def redisize_cache_fetch key, options = {}, &block
+            ::Rails.cache.fetch(key, options, &block)
+         end
+
+         def redisize_cache_delete key
+            ::Rails.cache.delete(key)
+         end
+      end
+   end
+end

data/lib/redisize/log/rails.rb

@@ -0,0 +1,17 @@
+module Redisize
+   module Log
+      module Rails
+         def redisize_log_info *args
+            ::Rails.logger.info(*args)
+         end
+
+         def redisize_log_debug *args
+            ::Rails.logger.debug(*args)
+         end
+
+         def redisize_log_error *args
+            ::Rails.logger.error(*args)
+         end
+      end
+   end
+end

data/lib/redisize/orm/active_record.rb

@@ -0,0 +1,13 @@
+module Redisize
+   module ORM
+      module ActiveRecord
+         def self.included kls
+            kls.class_eval do
+               after_create :deredisize_model
+               after_save :reredisize_instance
+               after_destroy :deredisize_instance, :deredisize_model
+            end
+         end
+      end
+   end
+end

data/lib/redisize/version.rb

@@ -0,0 +1,3 @@
+module Redisize
+  VERSION = "0.1.0"
+end

data/lib/redisize.rb

@@ -0,0 +1,307 @@
+require "redisize/version"
+
+module Redisize
+   class << self
+      attr_writer :adapter
+
+      ADAPTERS = {
+         sidekiq: :Sidekiq, # req: Sidekiq::LimitFetch
+         resque: :Resque,
+         inline: :TrueClass
+      }
+
+      ORMS = {
+         ActiveRecord: 'active_record'
+      }
+
+      LOGS = {
+         Rails: 'rails'
+      }
+
+      CACHES = {
+         Rails: 'rails'
+      }
+
+      # system method
+      def included kls
+         kls.extend(Redisize::ClassMethods)
+
+         # init orm, log, and cache
+         init_orm_for(kls)
+         init_log_for(kls)
+         init_cache_for(kls)
+      end
+
+      def init_orm_for kls
+         orm = kls.ancestors.reduce(nil) { |res, anc| res || ORMS.keys.find {|re| /#{re}/ =~ anc.to_s } }
+
+         if orm
+            require("redisize/orm/#{ORMS[orm]}")
+            kls.include(Redisize::ORM.const_get(orm))
+         end
+      end
+
+      def init_log_for kls
+         log = Object.constants.reduce(nil) { |res, anc| res || LOGS.keys.find {|re| /#{re}/ =~ anc.to_s } }
+
+         if log
+            require("redisize/log/#{LOGS[log]}")
+            Redisize.include(Redisize::Log.const_get(log))
+            Redisize.extend(Redisize::Log.const_get(log))
+            kls.extend(Redisize::Log.const_get(log))
+         end
+      end
+
+      def init_cache_for kls
+         cache = Object.constants.reduce(nil) { |res, anc| res || CACHES.keys.find {|re| /#{re}/ =~ anc.to_s } }
+
+         if cache
+            require("redisize/cache/#{CACHES[cache]}")
+            Redisize.include(Redisize::Cache.const_get(cache))
+            Redisize.extend(Redisize::Cache.const_get(cache))
+            kls.extend(Redisize::Cache.const_get(cache))
+         end
+      end
+
+      def adapter_kind= value
+         self.adapter = acquire_adapter(ADAPTERS[value] && value || :inline)
+      end
+
+      def acquire_adapter kind
+         require("redisize/adapter/#{kind}")
+         Redisize::Adapter.const_get(kind.capitalize)
+      end
+
+      def adapter
+         @adapter ||=
+            ADAPTERS.reduce(nil) do |res, (kind, prc)|
+               res || Object.constants.include?(prc) && acquire_adapter(kind) || nil
+            end
+      end
+
+      def enqueue method, *args
+         adapter.enqueue(method, *args)
+      end
+
+      def filtered_for attrs, klass
+         filtered = attrs.select {|attr| klass.attribute_types.keys.include?(attr) }
+      end
+
+      def assign_reverse_key key, host_key
+         # binding.pry
+         if value = redisize_cache_read(key)
+            redisize_cache_write(key, value | [ host_key ], expires_in: 1.day)
+            redisize_log_debug("Updated key #{key.inspect} with value #{host_key.inspect}")
+         else
+            redisize_cache_write(key, [ host_key ], expires_in: 1.day)
+            redisize_log_debug("Created key #{key.inspect} with value #{host_key.inspect}")
+         end
+      end
+
+      def drop_key key
+         # binding.pry
+         if value = redisize_cache_read(key)
+            if key.first == "meta"
+               size = value.size
+
+               value.each { |rkey| drop_key(rkey) }
+            end
+
+            redisize_log_debug("Removed key #{key.inspect}#{size && " with #{size} subkeys"}")
+            redisize_cache_delete(key)
+         end
+      end
+
+      def rekey key, type = "meta"
+         [type.to_s] + key[1..-1]
+      end
+
+      def key_name_for model_name, attrs, type = "meta"
+         primary_key = model_name.constantize.primary_key
+         [type, model_name, primary_key, attrs[primary_key].to_s]
+      end
+
+      def parse_sql_key key
+         key[-1].split(/\s(join|from)\s/i)[1..-1].map do |part|
+            part.strip.split(/[\s\"]/).reject {|x| x.blank? }.first
+         end.uniq.map do |table|
+            table.singularize.camelize.constantize rescue nil
+         end.compact.each do |klass|
+            assign_reverse_key(["meta", klass.name], key)
+         end
+      end
+
+      def parse_instance_attrs model_name, attrs, key
+         model = model_name.constantize
+         children =
+            attrs.map do |x, value|
+               (value.is_a?(Array) || value.is_a?(Hash)) && x || nil
+            end.compact
+
+         children.each do |many|
+            name = /^_(?<_name>.*)/ =~ many && _name || many.to_s
+
+            instance = nil
+            if klass = model.reflections[name]&.klass || many.singularize.camelize.constantize rescue nil
+               attres_in = attrs[many]
+               attres = attres_in.is_a?(Hash) && [attres_in] || attres_in
+               attres.each do |attrs|
+                  if attrs[klass.primary_key]
+                     assign_reverse_key(key_name_for(klass.name, attrs), key)
+                  else
+                     assign_reverse_key(["meta", klass.name], key)
+                  end
+                  parse_instance_attrs(klass.name, attrs, key)
+               end
+
+               assign_reverse_key(["meta", klass.name], key)
+            end
+         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
+         # binding.pry
+         drop_key(metakey)
+         drop_key(metakey[0..1])
+         parse_instance_attrs(model_name, attrs, key)
+         assign_reverse_key(metakey, key)
+      end
+
+      # +redisize_sql_metas+ updates all the meta keys for the result value
+      #
+      def redisize_sql_metas key, attres
+         model_name = key[1]
+         primary_key = key[2]
+
+         # binding.pry
+         attres.map do |attrs|
+            metakey = ["meta", model_name, primary_key, attrs[primary_key]]
+
+            parse_instance_attrs(model_name, attrs, key)
+            assign_reverse_key(metakey, key)
+         end
+
+         parse_sql_key(key)
+      end
+
+      def deredisize_instance_metas key
+         metakey = rekey(key)
+
+         # binding.pry
+         drop_key(metakey)
+         redisize_cache_delete(key)
+      end
+
+      def reredisize_instance_metas key
+         metakey = rekey(key)
+         # binding.pry
+
+         drop_key(metakey)
+         assign_reverse_key(metakey, key)
+      end
+
+      def deredisize_model_metas model_name
+         # binding.pry
+         drop_key(["meta", model_name])
+      end
+
+      def deredisize_json_metas key
+         # binding.pry
+         drop_key(key)
+      end
+
+      def redisize_json_metas key, attrs
+         metakey = key_name_for(key[1], attrs)
+
+         # binding.pry
+         parse_instance_attrs(key[1], attrs, key)
+         assign_reverse_key(metakey, key)
+      end
+   end
+
+   # self -> model instance
+   def redisize_json scheme, &block
+      primary_key = self.class.primary_key
+      key = ["json", self.class.polymorphic_name, primary_key, self[primary_key].to_s, scheme]
+
+      # binding.pry
+      redisize_cache_fetch(key, expires_in: 1.week) do
+         value = block.call
+
+         Redisize.enqueue(:redisize_json_metas, key, value)
+
+         value
+      end
+   end
+
+   # self -> model instance
+   def deredisize_json scheme, &block
+      primary_key = self.class.primary_key
+      key = ["json", self.class.polymorphic_name, primary_key, self[primary_key], scheme]
+
+      # binding.pry
+      Redisize.enqueue(:deredisize_json_metas, key)
+   end
+
+   # self -> model instance
+   def deredisize_model
+      Redisize.enqueue(:deredisize_model_metas, self.class.polymorphic_name)
+   end
+
+   # self -> model instance
+   def reredisize_instance
+      attrs = Redisize.as_json_for(self)
+      key = Redisize.key_name_for(self.class.polymorphic_name, attrs, "instance")
+
+      # binding.pry
+      redisize_cache_write(key, self, expires_in: 1000.years)
+      Redisize.enqueue(:reredisize_instance_metas, key)
+   end
+
+   # self -> model instance
+   def deredisize_instance
+      attrs = Redisize.as_json_for(self)
+      key = Redisize.key_name_for(self.class.polymorphic_name, attrs, "instance")
+
+      # binding.pry
+      Redisize.enqueue(:deredisize_instance_metas, key)
+   end
+
+   module ClassMethods
+      # self -> model class
+      def redisize_sql &block
+         key = ["sql", self.name, self.primary_key, self.all.to_sql]
+
+         # binding.pry
+         redisize_cache_fetch(key, expires_in: 1.day) do
+            value = block.call
+
+            Redisize.enqueue(:redisize_sql_metas, key, value)
+
+            value
+         end
+      end
+
+      # self -> model class
+      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_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)
+            end
+
+            result
+         end
+      end
+   end
+end

data/redisize.gemspec

@@ -0,0 +1,30 @@
+require_relative 'lib/redisize/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "redisize"
+  spec.version       = Redisize::VERSION
+  spec.authors       = ["Pavel «Malo» Skrylev"]
+  spec.email         = ["majioa@yandex.ru"]
+
+  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.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"
+
+  # 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.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.add_development_dependency('pry')
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: redisize
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pavel «Malo» Skrylev
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-07-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Make json record cacheable to redis via various adapters like Resque,
+  Sidekiq, etc
+email:
+- majioa@yandex.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- TODO
+- bin/console
+- bin/setup
+- lib/redisize.rb
+- lib/redisize/adapter/inline.rb
+- lib/redisize/adapter/resque.rb
+- lib/redisize/adapter/sidekiq.rb
+- lib/redisize/cache/rails.rb
+- lib/redisize/log/rails.rb
+- lib/redisize/orm/active_record.rb
+- lib/redisize/version.rb
+- redisize.gemspec
+homepage: https://github.com/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
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: Make json record cacheable to redis
+test_files: []