cacheflow 0.1.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ac0a2640873e62e3bbb8770586da459cc7de3657
-  data.tar.gz: 5359925b29dd20b4006c44c214ab5313b2114313
+SHA256:
+  metadata.gz: dc96e1e878dacf8275f2113b546cfab2d64baa98df3187c6b828c6f5397e9d6a
+  data.tar.gz: 181f8cd6e5c6c0f1abd5a349d5ebef1892c31e609148577c6a262b1c4ba2c9f7
 SHA512:
-  metadata.gz: 6148305fbd5825dd61031e813b080c105076b45ab341b12a7fa908f440d9e4125d457ea2ee4039cd02614dcb99fa8fee967e920c5a34c0192389afb9fe49bfd6
-  data.tar.gz: c3382fb7dc4f4c125ecc9c1d3e234060103d316540fb968a32e35b9a5d76e36ab84ba181fc509f216feb6ffad92944c4677aece4a9769f4a3fbbf71b9555ce99
+  metadata.gz: f174f62627d4c487ca492cf416cefa2369f713bfaefcac323ab6d0db8eae60aa29730af6d999db188f7a41c8413a4162fe6f4ed5a63aa773d72e9bfa1c1c17be
+  data.tar.gz: 1a58a047b78cc91760e7336bd3b014d716d01c7ccc8312ef5c8a045fdeaf5ebb1647a7b97b7e8136475a624215c4ba5e5dca8e13fba13333517d878203ab25df

data/CHANGELOG.md

@@ -1,8 +1,21 @@
-## 0.1.1
+## 0.3.0 (2022-09-05)
+
+- Added support for `redis` 5 and `redis-client` gems
+- Dropped support for Ruby < 2.7 and Active Support < 6
+
+## 0.2.1 (2022-01-12)
+
+- Fixed deprecation warning with Dalli 3
+
+## 0.2.0 (2022-01-10)
+
+- Dropped support for Ruby < 2.6 and Active Support < 5.2
+
+## 0.1.1 (2017-11-13)
 
 - Added `silence` method
 - Added `silence_sidekiq!` method
 
-## 0.1.0
+## 0.1.0 (2017-09-30)
 
 - First release

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2017 Andrew Kane
+Copyright (c) 2017-2022 Andrew Kane
 
 MIT License
 

data/README.md

@@ -2,16 +2,16 @@
 
 Colorized logging for Memcached and Redis
 
-![Screenshot](https://gist.githubusercontent.com/ankane/64d630db934c5222587794232a690864/raw/880b70fdbd2d11ccc8475f4616397184918852e8/console.png)
-
 Works with the Rails cache, as well as [Dalli](https://github.com/petergoldstein/dalli) and [Redis](https://github.com/redis/redis-rb) clients directly
 
+[![Build Status](https://github.com/ankane/cacheflow/workflows/build/badge.svg?branch=master)](https://github.com/ankane/cacheflow/actions)
+
 ## Installation
 
 Add this line to your application’s Gemfile:
 
 ```ruby
-gem 'cacheflow', group: :development
+gem "cacheflow", group: :development
 ```
 
 When your log level is set to `DEBUG` (Rails default in development), all commands to Memcached and Redis are logged.
@@ -26,12 +26,16 @@ Cacheflow.silence do
 end
 ```
 
-To silence logging for only [Sidekiq](https://github.com/mperham/sidekiq) commands, create an initializer with:
+To silence logging for [Sidekiq](https://github.com/mperham/sidekiq) commands, create an initializer with:
 
 ```ruby
 Cacheflow.silence_sidekiq!
 ```
 
+## Data Protection
+
+If you use Cacheflow in an environment with [personal data](https://en.wikipedia.org/wiki/Personally_identifiable_information) and store that data in Memcached or Redis, it can end up in your app logs. To avoid this, silence logging for those calls.
+
 ## History
 
 View the [changelog](https://github.com/ankane/cacheflow/blob/master/CHANGELOG.md)
@@ -44,3 +48,12 @@ Everyone is encouraged to help improve this project. Here are a few ways you can
 - Fix bugs and [submit pull requests](https://github.com/ankane/cacheflow/pulls)
 - Write, clarify, or fix documentation
 - Suggest or add new features
+
+To get started with development:
+
+```sh
+git clone https://github.com/ankane/cacheflow.git
+cd cacheflow
+bundle install
+bundle exec rake test
+```

data/lib/cacheflow/memcached.rb

@@ -23,5 +23,9 @@ module Cacheflow
   end
 end
 
-Dalli::Server.prepend(Cacheflow::Memcached::Notifications)
+if defined?(Dalli::Protocol::Binary)
+  Dalli::Protocol::Binary.prepend(Cacheflow::Memcached::Notifications)
+else
+  Dalli::Server.prepend(Cacheflow::Memcached::Notifications)
+end
 Cacheflow::Memcached::Instrumenter.attach_to(:memcached)

data/lib/cacheflow/redis.rb

@@ -1,5 +1,27 @@
 module Cacheflow
   module Redis
+    # redis 5 / redis-client
+    module ClientNotifications
+      def call(command, redis_config)
+        payload = {
+          commands: [command]
+        }
+        ActiveSupport::Notifications.instrument("query.redis", payload) do
+          super
+        end
+      end
+
+      def call_pipelined(commands, redis_config)
+        payload = {
+          commands: commands
+        }
+        ActiveSupport::Notifications.instrument("query.redis", payload) do
+          super
+        end
+      end
+    end
+
+    # redis 4
     module Notifications
       def logging(commands)
         payload = {
@@ -28,5 +50,12 @@ module Cacheflow
   end
 end
 
-Redis::Client.prepend(Cacheflow::Redis::Notifications)
+if defined?(RedisClient)
+  RedisClient.register(Cacheflow::Redis::ClientNotifications)
+end
+
+if Redis::VERSION.to_i < 5
+  Redis::Client.prepend(Cacheflow::Redis::Notifications)
+end
+
 Cacheflow::Redis::Instrumenter.attach_to(:redis)

data/lib/cacheflow/version.rb

@@ -1,3 +1,3 @@
 module Cacheflow
-  VERSION = "0.1.1"
+  VERSION = "0.3.0"
 end

data/lib/cacheflow.rb

@@ -1,10 +1,13 @@
+# dependencies
 require "active_support"
+
+# modules
 require "cacheflow/version"
 
 module Cacheflow
   def self.activate
     require "cacheflow/memcached" if defined?(Dalli)
-    require "cacheflow/redis" if defined?(Redis)
+    require "cacheflow/redis" if defined?(Redis) || defined?(RedisClient)
   end
 
   def self.silenced?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cacheflow
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Andrew Kane
-autorequire: 
-bindir: exe
+autorequire:
+bindir: bin
 cert_chain: []
-date: 2017-11-13 00:00:00.000000000 Z
+date: 2022-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,107 +16,33 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: dalli
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: redis
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-description: 
-email:
-- andrew@chartkick.com
+        version: '6'
+description:
+email: andrew@ankane.org
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
 - CHANGELOG.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
-- cacheflow.gemspec
 - lib/cacheflow.rb
 - lib/cacheflow/memcached.rb
 - lib/cacheflow/railtie.rb
 - lib/cacheflow/redis.rb
 - lib/cacheflow/version.rb
 homepage: https://github.com/ankane/cacheflow
-licenses: []
+licenses:
+- MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -124,16 +50,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: Colorized logging for Memcached and Redis
 test_files: []

data/.gitignore

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

data/Gemfile

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

data/Rakefile

@@ -1,10 +0,0 @@
-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/cacheflow.gemspec

@@ -1,29 +0,0 @@
-# coding: utf-8
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "cacheflow/version"
-
-Gem::Specification.new do |spec|
-  spec.name          = "cacheflow"
-  spec.version       = Cacheflow::VERSION
-  spec.authors       = ["Andrew Kane"]
-  spec.email         = ["andrew@chartkick.com"]
-
-  spec.summary       = "Colorized logging for Memcached and Redis"
-  spec.homepage      = "https://github.com/ankane/cacheflow"
-
-  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_dependency "activesupport"
-
-  spec.add_development_dependency "bundler"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "minitest"
-  spec.add_development_dependency "dalli"
-  spec.add_development_dependency "redis"
-end