MultiCache 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bc477b2863688f9bf755ecb2e492681d6073a1fd
+  data.tar.gz: 4b36142080ac799f2d1e7d77415b9c0b4d9c8f29
+SHA512:
+  metadata.gz: aa7fc988e8d6336ee8f54d1a45e96472c2b01505d827730034e783f6ae7a92c2603a59a36b160b0bcb752c71d1cdf8f64ef52ec34012d36b778a9091d9ee0cb0
+  data.tar.gz: e7bd1a5636cc5eb13711ecfa6fa2f352f4ee09b4a1742b52c0cfa0af5af5fa2f3df28b66588563c70257b25352c54dacb1006dd8679a485d1dd175304e150c5a

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at shvamverma@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in MultiCache.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Shivam
+
+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/MultiCache.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'MultiCache/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "MultiCache"
+  spec.version       = MultiCache::VERSION
+  spec.authors       = ["Shivam"]
+  spec.email         = ["shvamverma@gmail.com"]
+
+  spec.summary       = %q{MultiCache provides a framework to help you cache at model level}
+  spec.description   = %q{MultiCache provides a framework to help you cache at model level on redis under a specific namespace}
+  spec.homepage      = "http://www.avanti.in"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "redis", "~>3.2.2"
+  spec.add_development_dependency "redis-namespace", "~>1.5.2"
+end

data/README.md

@@ -0,0 +1,41 @@
+# MultiCache
+
+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/MultiCache`. 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 'MultiCache'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install MultiCache
+
+## 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]/MultiCache. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "MultiCache"
+
+# 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

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/MultiCache.rb

@@ -0,0 +1,151 @@
+require "MultiCache/version"
+
+module MultiCache
+  extend ActiveSupport::Concern
+
+  # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # 
+  # 
+  # After installation:
+  #
+  #   Create config/initializers/init_multi_cache.rb
+  #   and add the line
+  #       Rails.application.config.multi_cache_redis = "<redis-instance>"
+  #     where <redis-instance> is the Redis::Namespace object to be used by 
+  #     MultiCache for caching
+  #     Please ensure that the redis-instance is specified in quotes
+  #     
+  #     
+  # All models where you want to use MultiCache must:
+  #   
+  #   [mandatory]   Define a CLASS method
+  #                 MULTI_CACHE_PREFIXES
+  #                   that returns an array of allowed cache prefixes used by
+  #                   the class   
+  #   
+  #   [mandatory]   Define a CLASS method 
+  #                 GEN_CACHE_CONTENT(ID_OR_OBJ, CACHE_PREFIX)
+  #                   that generates a hash that will be cached
+  #                   ID_OR_OBJ is a hash that contains 
+  #                     {:id => obj_id, :obj => actual_obj_if_available}
+  #                 CACHE_PREFIX is an optional string that can be used to 
+  #                   distinguish between different cached info for the same
+  #                   object.
+  #
+  #   [optional]    Define a CLASS method 
+  #                 PARSE_CACHE_CONTENT(CONTENT, CACHE_PREFIX)
+  #                   that parses the cached content once it is read from 
+  #                   redis. Sometimes some JSON.parses are required. If not
+  #                   defined, the default method is called (which simply returns
+  #                   the cached value as-is)
+  #
+  # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # 
+
+  CACHE_KEY_MASTER_PREFIX   = "MultiCache"
+  CACHE_KEY_SEPARATOR       = "_"
+  MULTICACHE_REDIS          = eval(Rails.application.config.multi_cache_redis)
+
+  included do
+
+    after_save    :destroy_obj_cache
+    after_destroy :destroy_obj_cache
+
+    def self.get_cached(id_or_obj, cache_prefix)
+      id_and_obj = get_id_and_obj(id_or_obj)
+
+      validate_cache_prefix(cache_prefix)
+
+      cache_key = obj_cache_key(id_and_obj[:id], cache_prefix)
+      cached = MULTICACHE_REDIS.hgetall(cache_key)
+
+      if cached.blank?
+        cached = gen_cache_content(id_or_obj, cache_prefix)
+
+        raise "the output of GEN_CACHE_CONTENT must be a hash" if !(cached.is_a?Hash)
+        if cached.present?
+          MULTICACHE_REDIS.hmset(cache_key, *(cached.to_a.reduce([], :+)))
+        end
+        cached = MULTICACHE_REDIS.hgetall(cache_key)
+      end
+
+      parse_cache_content(cached, cache_prefix)
+    end
+
+    # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # 
+    # Cache key determination
+    # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # 
+    def obj_cache_key(cache_prefix)
+      self.class.obj_cache_key(self.id, cache_prefix)
+    end
+
+    def self.obj_cache_key(id, custom_prefix)
+      # Do not change ordering since we match keys using this
+      [fixed_cache_prefix(id), custom_prefix.to_s].join(CACHE_KEY_SEPARATOR)
+    end
+
+    def self.fixed_cache_prefix(id = nil)
+      chain = [CACHE_KEY_MASTER_PREFIX, self.name.to_s]
+      chain.push(id.to_s.strip) if id.present?
+      chain.join(CACHE_KEY_SEPARATOR)
+    end
+
+    # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # 
+    # Cache destruction
+    # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # 
+    def destroy_obj_cache(cb_obj = nil)
+      self.class.destroy_obj_cache(self.id)
+    end
+
+    def self.destroy_obj_cache(id)
+      # Delete cache for one object only
+      prefix = self.fixed_cache_prefix(id)
+      MultiCache.del_from_redis(prefix)
+    end
+
+    def self.destroy_class_cache
+      # Destroy cache for all objects of this class
+      prefix = self.fixed_cache_prefix
+      MultiCache.del_from_redis(prefix)
+    end
+
+    def self.destroy_cache_keys
+      # Destroy cache for all MultiCache
+      MultiCache.del_from_redis(CACHE_KEY_MASTER_PREFIX)
+    end
+
+    # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # 
+    # Misc
+    # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # 
+    def self.parse_cache_content(content, cache_prefix)
+      # Default method. Override in including class.
+      content
+    end
+
+    def self.get_id_and_obj(id_or_obj)
+      id_and_obj = {}
+      if id_or_obj.class == self
+        id_and_obj[:obj] = id_or_obj
+        id_and_obj[:id] = obj.id.to_s
+      else
+        id_and_obj[:id] = id_or_obj.to_s
+        # obj = nil # Load it when necessary
+      end
+      id_and_obj
+    end
+
+    def self.validate_cache_prefix(cache_prefix)
+      if !(multi_cache_prefixes.include?cache_prefix)
+        raise "#{self} Class: cache prefix '#{cache_prefix}' " + 
+              "must be among #{multi_cache_prefixes}"
+      end
+    end
+  end
+
+  def self.del_from_redis(prefix_match) 
+    Thread.new do
+      MULTICACHE_REDIS.keys("#{prefix_match}*").each do |prefix|
+        MULTICACHE_REDIS.del(prefix)
+        # TODO: Use scan instead of keys
+      end
+    end
+  end
+end

data/lib/MultiCache/version.rb

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

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: MultiCache
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Shivam
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.2
+- !ruby/object:Gem::Dependency
+  name: redis-namespace
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+description: MultiCache provides a framework to help you cache at model level on redis
+  under a specific namespace
+email:
+- shvamverma@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- MultiCache.gemspec
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/MultiCache.rb
+- lib/MultiCache/version.rb
+homepage: http://www.avanti.in
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: MultiCache provides a framework to help you cache at model level
+test_files: []