MultiCache 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: bc477b2863688f9bf755ecb2e492681d6073a1fd
4
+ data.tar.gz: 4b36142080ac799f2d1e7d77415b9c0b4d9c8f29
5
+ SHA512:
6
+ metadata.gz: aa7fc988e8d6336ee8f54d1a45e96472c2b01505d827730034e783f6ae7a92c2603a59a36b160b0bcb752c71d1cdf8f64ef52ec34012d36b778a9091d9ee0cb0
7
+ data.tar.gz: e7bd1a5636cc5eb13711ecfa6fa2f352f4ee09b4a1742b52c0cfa0af5af5fa2f3df28b66588563c70257b25352c54dacb1006dd8679a485d1dd175304e150c5a
@@ -0,0 +1,9 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
@@ -0,0 +1,49 @@
1
+ # Contributor Code of Conduct
2
+
3
+ As contributors and maintainers of this project, and in the interest of
4
+ fostering an open and welcoming community, we pledge to respect all people who
5
+ contribute through reporting issues, posting feature requests, updating
6
+ documentation, submitting pull requests or patches, and other activities.
7
+
8
+ We are committed to making participation in this project a harassment-free
9
+ experience for everyone, regardless of level of experience, gender, gender
10
+ identity and expression, sexual orientation, disability, personal appearance,
11
+ body size, race, ethnicity, age, religion, or nationality.
12
+
13
+ Examples of unacceptable behavior by participants include:
14
+
15
+ * The use of sexualized language or imagery
16
+ * Personal attacks
17
+ * Trolling or insulting/derogatory comments
18
+ * Public or private harassment
19
+ * Publishing other's private information, such as physical or electronic
20
+ addresses, without explicit permission
21
+ * Other unethical or unprofessional conduct
22
+
23
+ Project maintainers have the right and responsibility to remove, edit, or
24
+ reject comments, commits, code, wiki edits, issues, and other contributions
25
+ that are not aligned to this Code of Conduct, or to ban temporarily or
26
+ permanently any contributor for other behaviors that they deem inappropriate,
27
+ threatening, offensive, or harmful.
28
+
29
+ By adopting this Code of Conduct, project maintainers commit themselves to
30
+ fairly and consistently applying these principles to every aspect of managing
31
+ this project. Project maintainers who do not follow or enforce the Code of
32
+ Conduct may be permanently removed from the project team.
33
+
34
+ This code of conduct applies both within project spaces and in public spaces
35
+ when an individual is representing the project or its community.
36
+
37
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
38
+ reported by contacting a project maintainer at shvamverma@gmail.com. All
39
+ complaints will be reviewed and investigated and will result in a response that
40
+ is deemed necessary and appropriate to the circumstances. Maintainers are
41
+ obligated to maintain confidentiality with regard to the reporter of an
42
+ incident.
43
+
44
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage],
45
+ version 1.3.0, available at
46
+ [http://contributor-covenant.org/version/1/3/0/][version]
47
+
48
+ [homepage]: http://contributor-covenant.org
49
+ [version]: http://contributor-covenant.org/version/1/3/0/
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in MultiCache.gemspec
4
+ gemspec
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2017 Shivam
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
@@ -0,0 +1,34 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'MultiCache/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "MultiCache"
8
+ spec.version = MultiCache::VERSION
9
+ spec.authors = ["Shivam"]
10
+ spec.email = ["shvamverma@gmail.com"]
11
+
12
+ spec.summary = %q{MultiCache provides a framework to help you cache at model level}
13
+ spec.description = %q{MultiCache provides a framework to help you cache at model level on redis under a specific namespace}
14
+ spec.homepage = "http://www.avanti.in"
15
+ spec.license = "MIT"
16
+
17
+ # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
18
+ # delete this section to allow pushing this gem to any host.
19
+ if spec.respond_to?(:metadata)
20
+ spec.metadata['allowed_push_host'] = "https://rubygems.org"
21
+ else
22
+ raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
23
+ end
24
+
25
+ spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
26
+ spec.bindir = "exe"
27
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
28
+ spec.require_paths = ["lib"]
29
+
30
+ spec.add_development_dependency "bundler", "~> 1.11"
31
+ spec.add_development_dependency "rake", "~> 10.0"
32
+ spec.add_development_dependency "redis", "~>3.2.2"
33
+ spec.add_development_dependency "redis-namespace", "~>1.5.2"
34
+ end
@@ -0,0 +1,41 @@
1
+ # MultiCache
2
+
3
+ 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.
4
+
5
+ TODO: Delete this and the text above, and describe your gem
6
+
7
+ ## Installation
8
+
9
+ Add this line to your application's Gemfile:
10
+
11
+ ```ruby
12
+ gem 'MultiCache'
13
+ ```
14
+
15
+ And then execute:
16
+
17
+ $ bundle
18
+
19
+ Or install it yourself as:
20
+
21
+ $ gem install MultiCache
22
+
23
+ ## Usage
24
+
25
+ TODO: Write usage instructions here
26
+
27
+ ## Development
28
+
29
+ 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.
30
+
31
+ 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).
32
+
33
+ ## Contributing
34
+
35
+ 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.
36
+
37
+
38
+ ## License
39
+
40
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
41
+
@@ -0,0 +1,2 @@
1
+ require "bundler/gem_tasks"
2
+ task :default => :spec
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "MultiCache"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,151 @@
1
+ require "MultiCache/version"
2
+
3
+ module MultiCache
4
+ extend ActiveSupport::Concern
5
+
6
+ # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
7
+ #
8
+ # After installation:
9
+ #
10
+ # Create config/initializers/init_multi_cache.rb
11
+ # and add the line
12
+ # Rails.application.config.multi_cache_redis = "<redis-instance>"
13
+ # where <redis-instance> is the Redis::Namespace object to be used by
14
+ # MultiCache for caching
15
+ # Please ensure that the redis-instance is specified in quotes
16
+ #
17
+ #
18
+ # All models where you want to use MultiCache must:
19
+ #
20
+ # [mandatory] Define a CLASS method
21
+ # MULTI_CACHE_PREFIXES
22
+ # that returns an array of allowed cache prefixes used by
23
+ # the class
24
+ #
25
+ # [mandatory] Define a CLASS method
26
+ # GEN_CACHE_CONTENT(ID_OR_OBJ, CACHE_PREFIX)
27
+ # that generates a hash that will be cached
28
+ # ID_OR_OBJ is a hash that contains
29
+ # {:id => obj_id, :obj => actual_obj_if_available}
30
+ # CACHE_PREFIX is an optional string that can be used to
31
+ # distinguish between different cached info for the same
32
+ # object.
33
+ #
34
+ # [optional] Define a CLASS method
35
+ # PARSE_CACHE_CONTENT(CONTENT, CACHE_PREFIX)
36
+ # that parses the cached content once it is read from
37
+ # redis. Sometimes some JSON.parses are required. If not
38
+ # defined, the default method is called (which simply returns
39
+ # the cached value as-is)
40
+ #
41
+ # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
42
+
43
+ CACHE_KEY_MASTER_PREFIX = "MultiCache"
44
+ CACHE_KEY_SEPARATOR = "_"
45
+ MULTICACHE_REDIS = eval(Rails.application.config.multi_cache_redis)
46
+
47
+ included do
48
+
49
+ after_save :destroy_obj_cache
50
+ after_destroy :destroy_obj_cache
51
+
52
+ def self.get_cached(id_or_obj, cache_prefix)
53
+ id_and_obj = get_id_and_obj(id_or_obj)
54
+
55
+ validate_cache_prefix(cache_prefix)
56
+
57
+ cache_key = obj_cache_key(id_and_obj[:id], cache_prefix)
58
+ cached = MULTICACHE_REDIS.hgetall(cache_key)
59
+
60
+ if cached.blank?
61
+ cached = gen_cache_content(id_or_obj, cache_prefix)
62
+
63
+ raise "the output of GEN_CACHE_CONTENT must be a hash" if !(cached.is_a?Hash)
64
+ if cached.present?
65
+ MULTICACHE_REDIS.hmset(cache_key, *(cached.to_a.reduce([], :+)))
66
+ end
67
+ cached = MULTICACHE_REDIS.hgetall(cache_key)
68
+ end
69
+
70
+ parse_cache_content(cached, cache_prefix)
71
+ end
72
+
73
+ # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
74
+ # Cache key determination
75
+ # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
76
+ def obj_cache_key(cache_prefix)
77
+ self.class.obj_cache_key(self.id, cache_prefix)
78
+ end
79
+
80
+ def self.obj_cache_key(id, custom_prefix)
81
+ # Do not change ordering since we match keys using this
82
+ [fixed_cache_prefix(id), custom_prefix.to_s].join(CACHE_KEY_SEPARATOR)
83
+ end
84
+
85
+ def self.fixed_cache_prefix(id = nil)
86
+ chain = [CACHE_KEY_MASTER_PREFIX, self.name.to_s]
87
+ chain.push(id.to_s.strip) if id.present?
88
+ chain.join(CACHE_KEY_SEPARATOR)
89
+ end
90
+
91
+ # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
92
+ # Cache destruction
93
+ # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
94
+ def destroy_obj_cache(cb_obj = nil)
95
+ self.class.destroy_obj_cache(self.id)
96
+ end
97
+
98
+ def self.destroy_obj_cache(id)
99
+ # Delete cache for one object only
100
+ prefix = self.fixed_cache_prefix(id)
101
+ MultiCache.del_from_redis(prefix)
102
+ end
103
+
104
+ def self.destroy_class_cache
105
+ # Destroy cache for all objects of this class
106
+ prefix = self.fixed_cache_prefix
107
+ MultiCache.del_from_redis(prefix)
108
+ end
109
+
110
+ def self.destroy_cache_keys
111
+ # Destroy cache for all MultiCache
112
+ MultiCache.del_from_redis(CACHE_KEY_MASTER_PREFIX)
113
+ end
114
+
115
+ # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
116
+ # Misc
117
+ # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
118
+ def self.parse_cache_content(content, cache_prefix)
119
+ # Default method. Override in including class.
120
+ content
121
+ end
122
+
123
+ def self.get_id_and_obj(id_or_obj)
124
+ id_and_obj = {}
125
+ if id_or_obj.class == self
126
+ id_and_obj[:obj] = id_or_obj
127
+ id_and_obj[:id] = obj.id.to_s
128
+ else
129
+ id_and_obj[:id] = id_or_obj.to_s
130
+ # obj = nil # Load it when necessary
131
+ end
132
+ id_and_obj
133
+ end
134
+
135
+ def self.validate_cache_prefix(cache_prefix)
136
+ if !(multi_cache_prefixes.include?cache_prefix)
137
+ raise "#{self} Class: cache prefix '#{cache_prefix}' " +
138
+ "must be among #{multi_cache_prefixes}"
139
+ end
140
+ end
141
+ end
142
+
143
+ def self.del_from_redis(prefix_match)
144
+ Thread.new do
145
+ MULTICACHE_REDIS.keys("#{prefix_match}*").each do |prefix|
146
+ MULTICACHE_REDIS.del(prefix)
147
+ # TODO: Use scan instead of keys
148
+ end
149
+ end
150
+ end
151
+ end
@@ -0,0 +1,3 @@
1
+ module MultiCache
2
+ VERSION = "0.1.0"
3
+ end
metadata ADDED
@@ -0,0 +1,113 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: MultiCache
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Shivam
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2017-10-12 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.11'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.11'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '10.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '10.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: redis
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: 3.2.2
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: 3.2.2
55
+ - !ruby/object:Gem::Dependency
56
+ name: redis-namespace
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: 1.5.2
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: 1.5.2
69
+ description: MultiCache provides a framework to help you cache at model level on redis
70
+ under a specific namespace
71
+ email:
72
+ - shvamverma@gmail.com
73
+ executables: []
74
+ extensions: []
75
+ extra_rdoc_files: []
76
+ files:
77
+ - ".gitignore"
78
+ - CODE_OF_CONDUCT.md
79
+ - Gemfile
80
+ - LICENSE.txt
81
+ - MultiCache.gemspec
82
+ - README.md
83
+ - Rakefile
84
+ - bin/console
85
+ - bin/setup
86
+ - lib/MultiCache.rb
87
+ - lib/MultiCache/version.rb
88
+ homepage: http://www.avanti.in
89
+ licenses:
90
+ - MIT
91
+ metadata:
92
+ allowed_push_host: https://rubygems.org
93
+ post_install_message:
94
+ rdoc_options: []
95
+ require_paths:
96
+ - lib
97
+ required_ruby_version: !ruby/object:Gem::Requirement
98
+ requirements:
99
+ - - ">="
100
+ - !ruby/object:Gem::Version
101
+ version: '0'
102
+ required_rubygems_version: !ruby/object:Gem::Requirement
103
+ requirements:
104
+ - - ">="
105
+ - !ruby/object:Gem::Version
106
+ version: '0'
107
+ requirements: []
108
+ rubyforge_project:
109
+ rubygems_version: 2.4.8
110
+ signing_key:
111
+ specification_version: 4
112
+ summary: MultiCache provides a framework to help you cache at model level
113
+ test_files: []