cachers 4.1.0.2 → 5.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2a5dd5608ba6ae1efe233c8166880def5667638e
-  data.tar.gz: 8fb91ee8790642dee3cdcea75d86cc5a0ff38e93
+  metadata.gz: ba951b8f855fd479feffad68fec3a05863460c65
+  data.tar.gz: 8174a0df81007c58fc53b1c4302f177d6a56baad
 SHA512:
-  metadata.gz: 3cc1dfa4213725c8b7843c8cb902005f136d48e54f3492ea415d39dcecfa670d0d102e075c8d5781f16ee55e64a35b1dfadc0b2d4e116c513202c4f4d7225716
-  data.tar.gz: 3c018e1f5690f43a4916b5cbaaa94f1d9eb0512d0329fb0296f5723c047ca9c8365fe90e4fea9cbb6fa47882bbfb79ecdaf48453e249e88573b3fbd68abfa0fa
+  metadata.gz: 735007953decb93c41a32a445c4f62529fe3b5b9f680ba9bd3a7935ca3f26734934e5cc070d21db1b6b3e58b2832e82076e490154127db782073423647704b71
+  data.tar.gz: 057357ff0ffecf0cfe7af22f07dc6f61904bb1f755c8a24afb36786837bdfc6f382f6bba7e46bf01bde576e62138b0d19b948fa4782f31b79006f33602a251cb

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2016 Mathías Montossi
+Copyright 2017 Museways
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -0,0 +1,114 @@
+[![Gem Version](https://badge.fury.io/rb/cachers.svg)](http://badge.fury.io/rb/cachers)
+[![Code Climate](https://codeclimate.com/github/museways/cachers/badges/gpa.svg)](https://codeclimate.com/github/museways/cachers)
+[![Build Status](https://travis-ci.org/museways/cachers.svg)](https://travis-ci.org/museways/cachers)
+[![Dependency Status](https://gemnasium.com/museways/cachers.svg)](https://gemnasium.com/museways/cachers)
+
+# Cachers
+
+Dedicated classes to isolate redis logic in rails.
+
+## Why
+
+I did this gem to:
+
+- Prevent models to have too much code.
+- Have a convention of how to use cache in models.
+- Increase atomization in complex projects.
+
+## Install
+
+Put this line in your Gemfile:
+```ruby
+gem 'cachers'
+```
+
+Then bundle:
+```
+$ bundle
+```
+
+## Usage
+
+### Definitions
+
+Generate a cacher for a model:
+```
+$ bundle exec rails g cacher like
+```
+
+Add the logic to the cache and uncache methods:
+```ruby
+class LikeCacher < Cachers::Base
+
+  def cache
+    sadd key, record.product.id
+  end
+
+  def uncache
+    srem key, record.product.id
+  end
+
+  private
+
+  def key
+    "users/#{record.user.id}/likes"
+  end
+
+end
+```
+
+NOTE: Updates work automatically, there is no need to add a method to replace values.
+
+### Custom methods
+
+You may want to add some other methods related to the cache:
+```ruby
+class UserCacher < Cachers::Base
+
+  def likes?(product)
+    sismember key, product.id
+  end
+
+  private
+
+  def key
+    "users/#{record.id}/likes"
+  end
+
+end
+```
+
+The public methods will be available to call directly from the model:
+```ruby
+user.likes? product
+```
+
+### Cache management
+
+If you want to manually control the cache, you can use this methods:
+```ruby
+user.cache
+user.recache
+user.uncache
+```
+
+Or to it for all cacheable records:
+```
+$ bundle exec rake cachers:cache
+$ bundle exec rake cachers:recache
+$ bundle exec rake cachers:uncache
+```
+
+## Contributing
+
+Any issue, pull request, comment of any kind is more than welcome!
+
+I will mainly ensure compatibility to Rails, AWS, PostgreSQL, Redis, Elasticsearch and FreeBSD. 
+
+## Credits
+
+This gem is maintained and funded by [museways](https://github.com/museways).
+
+## License
+
+It is free software, and may be redistributed under the terms specified in the MIT-LICENSE file.

data/Rakefile

@@ -4,16 +4,14 @@ rescue LoadError
   puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end
 
-Bundler::GemHelper.install_tasks
+require 'bundler/gem_tasks'
 
 require 'rake/testtask'
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
   t.libs << 'test'
   t.pattern = 'test/**/*_test.rb'
   t.verbose = false
-  t.warning = false
 end
 
 task default: :test

data/lib/cachers.rb

@@ -9,8 +9,8 @@ require 'cachers/version'
 module Cachers
   class << self
 
-    def client
-      @client ||= begin
+    def redis
+      @redis ||= begin
         require 'redis'
         Redis.new YAML.load_file("#{Rails.root}/config/redis.yml")[Rails.env]
       end

data/lib/cachers/concern.rb

@@ -1,9 +1,11 @@
 module Cachers
   module Concern
     extend ActiveSupport::Concern
-    include Delegation
 
     included do
+      %i(extend include).each do |action|
+        send action, Delegation
+      end
       after_commit :cache, on: :create
       after_commit :recache, on: :update
       after_commit :uncache, on: :destroy
@@ -14,7 +16,6 @@ module Cachers
     end
 
     module ClassMethods
-      include Delegation
 
       def cacher
         "#{name}Cacher".constantize

data/lib/cachers/dsl.rb

@@ -2,7 +2,7 @@ module Cachers
   module Dsl
 
     def method_missing(name, *args, &block)
-      Cachers.client.send name, *args, &block
+      Cachers.redis.send name, *args, &block
     end
 
   end

data/lib/cachers/extensions/active_record/base.rb

@@ -8,7 +8,7 @@ module Cachers
 
           def inherited(subclass)
             super
-            if subclass.name && File.exist?("#{Rails.root}/app/cachers/#{subclass.name.underscore}_cacher.rb")
+            if File.exist?("#{Rails.root}/app/cachers/#{subclass.name.underscore}_cacher.rb")
               subclass.include Cachers::Concern
             end
           end

data/lib/cachers/railtie.rb

@@ -1,12 +1,6 @@
 module Cachers
   class Railtie < Rails::Railtie
 
-    config.before_initialize do
-      Dir["#{Rails.root}/app/cachers/**/*_cacher.rb"].each do |file|
-        load file
-      end
-    end
-
     initializer 'cachers.active_record' do
       ActiveSupport.on_load :active_record do
         ::ActiveRecord::Base.include(

data/lib/cachers/version.rb

@@ -1,5 +1,5 @@
 module Cachers
 
-  VERSION = '4.1.0.2'
+  VERSION = '5.1.1'
 
 end

data/lib/generators/cachers/install/install_generator.rb

@@ -7,7 +7,7 @@ module Cachers
       source_root File.expand_path('../templates', __FILE__)
 
       def create_configuration_file
-        copy_file 'configuration.yml', 'config/redis.yml'
+        copy_file 'redis.yml', 'config/redis.yml'
       end
 
     end

metadata

@@ -1,71 +1,66 @@
 --- !ruby/object:Gem::Specification
 name: cachers
 version: !ruby/object:Gem::Version
-  version: 4.1.0.2
+  version: 5.1.1
 platform: ruby
 authors:
 - mmontossi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-14 00:00:00.000000000 Z
+date: 2017-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.2.0
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.3.0
+        version: '5.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.2.0
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.3.0
+        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.18'
+        version: '0.21'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.18'
+        version: '0.21'
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.3'
 description: Dedicated classes to isolate redis logic in rails.
 email:
-- mmontossi@gmail.com
+- hi@museways.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - MIT-LICENSE
+- README.md
 - Rakefile
 - lib/cachers.rb
 - lib/cachers/base.rb
@@ -78,55 +73,9 @@ files:
 - lib/generators/cachers/cacher/cacher_generator.rb
 - lib/generators/cachers/cacher/templates/cacher.rb
 - lib/generators/cachers/install/install_generator.rb
-- lib/generators/cachers/install/templates/configuration.yml
+- lib/generators/cachers/install/templates/redis.yml
 - lib/tasks/cachers.rake
-- test/dummy/Rakefile
-- test/dummy/app/assets/javascripts/application.js
-- test/dummy/app/assets/stylesheets/application.css
-- test/dummy/app/cachers/user_cacher.rb
-- test/dummy/app/controllers/application_controller.rb
-- test/dummy/app/helpers/application_helper.rb
-- test/dummy/app/models/user.rb
-- test/dummy/app/views/layouts/application.html.erb
-- test/dummy/bin/bundle
-- test/dummy/bin/rails
-- test/dummy/bin/rake
-- test/dummy/bin/setup
-- test/dummy/config.ru
-- test/dummy/config/application.rb
-- test/dummy/config/boot.rb
-- test/dummy/config/database.yml
-- test/dummy/config/database.yml.travis
-- test/dummy/config/environment.rb
-- test/dummy/config/environments/development.rb
-- test/dummy/config/environments/production.rb
-- test/dummy/config/environments/test.rb
-- test/dummy/config/initializers/assets.rb
-- test/dummy/config/initializers/backtrace_silencers.rb
-- test/dummy/config/initializers/cookies_serializer.rb
-- test/dummy/config/initializers/filter_parameter_logging.rb
-- test/dummy/config/initializers/inflections.rb
-- test/dummy/config/initializers/mime_types.rb
-- test/dummy/config/initializers/session_store.rb
-- test/dummy/config/initializers/wrap_parameters.rb
-- test/dummy/config/locales/en.yml
-- test/dummy/config/redis.yml
-- test/dummy/config/routes.rb
-- test/dummy/config/secrets.yml
-- test/dummy/db/migrate/20160918232127_create_users.rb
-- test/dummy/db/schema.rb
-- test/dummy/log/development.log
-- test/dummy/log/test.log
-- test/dummy/public/404.html
-- test/dummy/public/422.html
-- test/dummy/public/500.html
-- test/dummy/public/favicon.ico
-- test/generator_test.rb
-- test/model_test.rb
-- test/record_test.rb
-- test/task_test.rb
-- test/test_helper.rb
-homepage: https://github.com/mmontossi/cachers
+homepage: https://github.com/museways/cachers
 licenses:
 - MIT
 metadata: {}
@@ -138,7 +87,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.1.0
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -146,54 +95,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Cachers for rails
-test_files:
-- test/dummy/app/assets/javascripts/application.js
-- test/dummy/app/assets/stylesheets/application.css
-- test/dummy/app/cachers/user_cacher.rb
-- test/dummy/app/controllers/application_controller.rb
-- test/dummy/app/helpers/application_helper.rb
-- test/dummy/app/models/user.rb
-- test/dummy/app/views/layouts/application.html.erb
-- test/dummy/bin/bundle
-- test/dummy/bin/rails
-- test/dummy/bin/rake
-- test/dummy/bin/setup
-- test/dummy/config/application.rb
-- test/dummy/config/boot.rb
-- test/dummy/config/database.yml
-- test/dummy/config/database.yml.travis
-- test/dummy/config/environment.rb
-- test/dummy/config/environments/development.rb
-- test/dummy/config/environments/production.rb
-- test/dummy/config/environments/test.rb
-- test/dummy/config/initializers/assets.rb
-- test/dummy/config/initializers/backtrace_silencers.rb
-- test/dummy/config/initializers/cookies_serializer.rb
-- test/dummy/config/initializers/filter_parameter_logging.rb
-- test/dummy/config/initializers/inflections.rb
-- test/dummy/config/initializers/mime_types.rb
-- test/dummy/config/initializers/session_store.rb
-- test/dummy/config/initializers/wrap_parameters.rb
-- test/dummy/config/locales/en.yml
-- test/dummy/config/redis.yml
-- test/dummy/config/routes.rb
-- test/dummy/config/secrets.yml
-- test/dummy/config.ru
-- test/dummy/db/migrate/20160918232127_create_users.rb
-- test/dummy/db/schema.rb
-- test/dummy/log/development.log
-- test/dummy/log/test.log
-- test/dummy/public/404.html
-- test/dummy/public/422.html
-- test/dummy/public/500.html
-- test/dummy/public/favicon.ico
-- test/dummy/Rakefile
-- test/generator_test.rb
-- test/model_test.rb
-- test/record_test.rb
-- test/task_test.rb
-- test/test_helper.rb
+test_files: []