cache_json 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5447969541ae8237cf12f05f7cd4f4d9765ecf698d18987557dc3c38d4226e98
+  data.tar.gz: 6623c07f0e8b5adcb2db3c1689ef8f3cbde3cf3836a6e520a08c460877f825c6
+SHA512:
+  metadata.gz: 46e08e0520e82b99a050e57d8478a8d87350240cbf2725e8679aac7d51e3142fcdf08109597d6f69dc0ed9f41c4513373e0be28ca1d905bd69e8ba5971281a6f
+  data.tar.gz: 0445a7014e507e7af83e3023460e1670adb53e965492810bfe0e438b33b6b46069808f16f23a59e16d3da4e69a3a470397c88ba80bc58bcacfc98ebaeb2c29f8

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 2.0.2

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 paul@loopsupport.com. 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 [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    cache_json (1.0.0)
+      redis (>= 3.3.5, < 5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    mock_redis (0.21.0)
+    rake (10.5.0)
+    redis (4.1.2)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    timecop (0.9.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  cache_json!
+  mock_redis (~> 0.21.0)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  timecop (~> 0.9.1)
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Paul Gut
+
+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,71 @@
+# Cache JSON
+
+This gem lets you easily cache the results of any computation to Redis. The cache is automatically populated when the `results` method is called.
+
+The cache expires after a specified time, unless you explicitly clear it before that. You can use the provided Sidekiq job to periodically refresh the cache.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cache_json'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cache_json
+
+## Usage
+
+All you need is a class with a `compute_results` method (make sure you use keyword arguments):
+
+```ruby
+class ExpensiveJob
+
+  include CacheJSON::Base
+
+  cache_json_options(
+    time_to_expire: 1.hour, # Specify how long the cache lives
+  )
+
+  def compute_results(first_arg:, second_arg:)
+    # Compute some stuff and return the results
+    # The results will then be cached *for those specific arguments*
+  end
+end
+
+# If the cache exists, return it. Otherwise, populate it and return it
+ExpensiveJob.new.results(first_arg: "foo", second_arg: "bar")
+
+# Clear the cache for all arguments
+ExpensiveJob.new.clear_cache!
+```
+
+If you'd like to specify some global defaults, you can put them in `config/initializers/cache_json.rb`
+
+```ruby
+CacheJSON.configure do |config|
+  config.time_to_expire = 6.hours
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/loopsupport/cache_json. 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](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the CacheJSON project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/loopsupport/cache_json/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

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

@@ -0,0 +1,34 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "cache_json/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "cache_json"
+  spec.version       = CacheJSON::VERSION
+  spec.authors       = ["Paul Gut"]
+  spec.email         = ["paul@loopsupport.com"]
+
+  spec.summary       = "Extremely simple Redis caching for any Ruby class"
+  spec.description   = "Extremely simple Redis caching for any Ruby class"
+  spec.homepage      = "https://github.com/loopsupport/cache_json"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/loopsupport/cache_json"
+
+  # 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_dependency 'redis', '>= 3.3.5', '< 5'
+  spec.add_development_dependency 'timecop', '~> 0.9.1'
+  spec.add_development_dependency 'mock_redis', '~> 0.21.0'
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/cache_json.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require "json"
+require "cache_json/version"
+require "cache_json/base"
+require "cache_json/configure"

data/lib/cache_json/base.rb

@@ -0,0 +1,89 @@
+module CacheJSON::Base
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  def results(args)
+    options = self.class.cache_json_full_options
+    cache = Cache.new(args: args, options: options)
+    if cache.get_cached_results
+      # Rails.logger.info "Got #{self.class} results from cache" if options[:logging_enabled]
+      cache.get_cached_results
+    else
+      # Rails.logger.info "Generating #{self.class} cached results" if options[:logging_enabled]
+      results = compute_results(args)
+      cache.set_cached_results(results)
+      JSON.parse(results.to_json) # stringify keys
+    end
+  end
+
+  def clear_cache!
+    Cache.new(options: self.class.cache_json_full_options).clear_cache!
+  end
+
+  class Cache
+    attr_accessor :args
+    attr_accessor :options
+
+    def initialize(args: {}, options:)
+      @args = args
+      @options = options
+    end
+
+    def get_cached_results
+      return @get_cached_results if @get_cached_results
+
+      results_json = $redis.get(full_key)
+      if results_json
+        @get_cached_results = JSON.parse(results_json)
+      end
+    end
+
+    def set_cached_results(results)
+      $redis.set(full_key, results.to_json)
+      $redis.expire(full_key, options[:time_to_expire].to_i)
+    end
+
+    def clear_cache!
+      $redis.keys.select do |key|
+        key.include?(base_key)
+      end.each do |key|
+        # Rails.logger.info "Deleting #{self.class} cached results" if options[:logging_enabled]
+        $redis.del(key)
+      end
+    end
+
+    def full_key
+      @full_key ||= "#{base_key}-#{arguments_signature}"
+    end
+
+    def base_key
+      @base_key ||= "CacheJSON-#{options[:class_name]}"
+    end
+
+    def arguments_signature
+      args.to_a.sort_by do |row|
+        row[0]
+      end.map do |row|
+        "#{row[0]}:#{row[1]}"
+      end.join("-")
+    end
+  end
+
+  module ClassMethods
+    # Setter
+    def cache_json_options(options_hash)
+      cache_json_class_specific_overrides.merge!(options_hash)
+    end
+
+    # Just the class-specific overrides
+    def cache_json_class_specific_overrides
+      @cache_json_class_specific_overrides ||= {}
+    end
+
+    # Getter (inherits from global defaults)
+    def cache_json_full_options
+      CacheJSON::Config.options.merge(cache_json_class_specific_overrides).merge(class_name: self.to_s)
+    end
+  end
+end

data/lib/cache_json/configure.rb

@@ -0,0 +1,20 @@
+module CacheJSON
+
+  class Config
+    @time_to_expire = 3600 # 1 hour
+
+    def self.options
+      {
+        time_to_expire: time_to_expire
+      }
+    end
+
+    class << self
+      attr_accessor :time_to_expire
+    end
+  end
+
+  def self.configure
+    yield(CacheJSON::Config) if block_given?
+  end
+end

data/lib/cache_json/version.rb

@@ -0,0 +1,3 @@
+module CacheJSON
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: cache_json
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Paul Gut
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-07-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.5
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.5
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+- !ruby/object:Gem::Dependency
+  name: mock_redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Extremely simple Redis caching for any Ruby class
+email:
+- paul@loopsupport.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cache_json.gemspec
+- lib/cache_json.rb
+- lib/cache_json/base.rb
+- lib/cache_json/configure.rb
+- lib/cache_json/version.rb
+homepage: https://github.com/loopsupport/cache_json
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/loopsupport/cache_json
+  source_code_uri: https://github.com/loopsupport/cache_json
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Extremely simple Redis caching for any Ruby class
+test_files: []