cache_utils 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a539d683e68d801fdd17735c49d5e15ad47e5c3f
+  data.tar.gz: 06f2c3deda727144695de513fe6e9fb9a2d8520f
+SHA512:
+  metadata.gz: 9eeeb919ac72942c52704bc5e332ab84f859e6aabb85fc83478ed420ef34b814f25f1ca3eeee8c7a1258ea96ce5f3caa81a59029ec31c647448cbc2813c9f9d5
+  data.tar.gz: 01bff05e89a7c6107923bad3f2bcecc8d66284f680bb2ef25d28715c8b5831e39da41b88337c107e99372b79ef8d028a2bf621efe100143b8e1e6608c8302357

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.13.6

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 m@finotto.org. 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_utils.gemspec
+gemspec

data/README.md

@@ -0,0 +1,36 @@
+# CacheUtils
+
+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/cache_utils`. 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 'cache_utils'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cache_utils
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. 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]/cache_utils. 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.
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

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

@@ -0,0 +1,28 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cache_utils/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'cache_utils'
+  spec.version       = CacheUtils::VERSION
+  spec.authors       = ['Michele Finotto']
+  spec.email         = ['m@finotto.org']
+
+  spec.summary       = 'Caching utilities built on top of Rails caching'
+  spec.description   = 'Caching utilities built on top of Rails caching'
+  spec.homepage      = 'https://github.com/michele/cache_utils'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_dependency 'rails', '> 4'
+end

data/lib/cache_utils/controller.rb

@@ -0,0 +1,65 @@
+module CacheUtils
+  module Controller
+    extend ActiveSupport::Concern
+
+    def cache_bundle(*objects)
+      objects.map { |o| cache_key_for(o) }.join(':')
+    end
+
+    def cache_key_for(object)
+      if object.respond_to?(:cache_key)
+        object.cache_key
+      elsif object.is_a?(Hash)
+        serialize_hash(object)
+      else
+        object.to_s
+      end
+    end
+
+    def cache_if(condition, name = {}, options = nil, &block)
+      if condition
+        Rails.cache.fetch(name, options, &block)
+      else
+        yield
+      end
+    end
+
+    def render_with_cache(object, condition, name = {}, options = nil)
+      render jsonapi: cache_if(condition, name, options) {
+                        ActiveModelSerializers::SerializableResource.new(object).to_json
+                      }, raw: true
+    end
+
+    private
+
+    def serialize_hash(hash)
+      Digest::MD5.hexdigest(hash.to_a.sort_by { |k, _v| k.to_s }.map do |k, v|
+        val = if v.is_a?(Hash)
+                serialize_hash(v)
+              elsif v.is_a?(Array)
+                v.map(&:to_s).sort
+              elsif v.respond_to?(:cache_key)
+                v.cache_key
+              else
+                v.to_s
+      end
+        [k, val]
+      end.flatten.join('.'))
+    end
+  end
+end
+
+def serialize_hash(hash)
+  hash.to_a.sort_by { |k, _v| k.to_s }.map do |k, v|
+    val = if v.is_a?(Hash)
+            serialize_hash(v)
+          elsif v.is_a?(Array)
+            v.map(&:to_s).sort
+          elsif v.respond_to?(:cache_key)
+            v.cache_key
+          else
+            v.to_s
+    end
+    [k, val]
+  end.flatten.join('.')
+end

data/lib/cache_utils/model.rb

@@ -0,0 +1,19 @@
+module CacheUtils
+  module Model
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def cache_key
+        to_s.pluralize.underscore + '/index'
+      end
+    end
+
+    included do
+      after_save :purge_cache
+    end
+
+    def purge_cache
+      Rails.cache.data.del(*(Rails.cache.data.keys(cache_key) + [self.class.cache_key]))
+    end
+  end
+end

data/lib/cache_utils/railtie.rb

@@ -0,0 +1,15 @@
+require 'cache_utils/controller'
+require 'cache_utils/model'
+module CacheUtils
+  class Railtie < Rails::Railtie
+    initializer 'cache_utils.action_controller' do
+      ActiveSupport.on_load(:action_controller) do
+        # ActionController::Base gets a method that allows controllers to include the new behavior
+        ActionController::API.send :include, CacheUtils::Controller # ActiveSupport::Concern
+      end
+      ActiveSupport.on_load(:active_record) do
+        ActiveRecord::Base.send :include, CacheUtils::Model
+      end
+    end
+  end
+end

data/lib/cache_utils/version.rb

@@ -0,0 +1,3 @@
+module CacheUtils
+  VERSION = '0.1.3'.freeze
+end

data/lib/cache_utils.rb

@@ -0,0 +1,7 @@
+require 'cache_utils/version'
+require 'cache_utils/model'
+require 'cache_utils/controller'
+require 'cache_utils/railtie' if defined?(Rails)
+
+module CacheUtils
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: cache_utils
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- Michele Finotto
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-06-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '4'
+description: Caching utilities built on top of Rails caching
+email:
+- m@finotto.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cache_utils.gemspec
+- lib/cache_utils.rb
+- lib/cache_utils/controller.rb
+- lib/cache_utils/model.rb
+- lib/cache_utils/railtie.rb
+- lib/cache_utils/version.rb
+homepage: https://github.com/michele/cache_utils
+licenses: []
+metadata: {}
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Caching utilities built on top of Rails caching
+test_files: []