cacheflow 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ed9289534d7be914a8031cf433b80a715f09c20d
+  data.tar.gz: 5790af33bcd0fd95b166d1426756ece322f305e0
+SHA512:
+  metadata.gz: c19673a2d24c9fa317035753b31f85ec1e69efb6a62a960344b08385f7a576c0d29f136760499989c2a0852c0bfbd6edfd0daf3210dbd14f167bcdd17ab1515f
+  data.tar.gz: 176fe8f019a0328916ca81921725d17d1a2e5578fe0cb11523e4e4fe3a50fd3fb8106b5668a6f6ef26c41691351e376a187929f6e59823194c5ad96f10eff5d6

data/.gitignore

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

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.1.0
+
+- First release

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2017 Andrew Kane
+
+MIT License
+
+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,30 @@
+# Cacheflow
+
+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
+
+## Installation
+
+Add this line to your application’s Gemfile:
+
+```ruby
+gem 'cacheflow'
+```
+
+When your log level is set to `DEBUG` (Rails default in development), all commands to Memcached and Redis are logged.
+
+## History
+
+View the [changelog](https://github.com/ankane/cacheflow/blob/master/CHANGELOG.md)
+
+## Contributing
+
+Everyone is encouraged to help improve this project. Here are a few ways you can help:
+
+- [Report bugs](https://github.com/ankane/cacheflow/issues)
+- Fix bugs and [submit pull requests](https://github.com/ankane/cacheflow/pulls)
+- Write, clarify, or fix documentation
+- Suggest or add new features

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/cacheflow.gemspec

@@ -0,0 +1,29 @@
+# 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

data/lib/cacheflow.rb

@@ -0,0 +1,15 @@
+require "active_support"
+require "cacheflow/version"
+
+module Cacheflow
+  def self.activate
+    require "cacheflow/memcached" if defined?(Dalli)
+    require "cacheflow/redis" if defined?(Redis)
+  end
+end
+
+if defined?(Rails)
+  require "cacheflow/railtie"
+else
+  Cacheflow.activate
+end

data/lib/cacheflow/memcached.rb

@@ -0,0 +1,27 @@
+module Cacheflow
+  module Memcached
+    module Notifications
+      def request(op, *args)
+        payload = {
+          op: op,
+          args: args
+        }
+        ActiveSupport::Notifications.instrument("query.memcached", payload) do
+          super
+        end
+      end
+    end
+
+    class Instrumenter < ActiveSupport::LogSubscriber
+      def query(event)
+        return unless logger.debug?
+
+        name = "%s (%.2fms)" % ["Memcached", event.duration]
+        debug "  #{color(name, BLUE, true)} #{event.payload[:op].to_s.upcase} #{event.payload[:args].join(" ")}"
+      end
+    end
+  end
+end
+
+Dalli::Server.prepend(Cacheflow::Memcached::Notifications)
+Cacheflow::Memcached::Instrumenter.attach_to(:memcached)

data/lib/cacheflow/railtie.rb

@@ -0,0 +1,7 @@
+module Cashflow
+  class Railtie < Rails::Railtie
+    initializer "cacheflow" do
+      Cacheflow.activate
+    end
+  end
+end

data/lib/cacheflow/redis.rb

@@ -0,0 +1,32 @@
+module Cacheflow
+  module Redis
+    module Notifications
+      def logging(commands)
+        payload = {
+          commands: commands
+        }
+        ActiveSupport::Notifications.instrument("query.redis", payload) do
+          super
+        end
+      end
+    end
+
+    class Instrumenter < ActiveSupport::LogSubscriber
+      def query(event)
+        return unless logger.debug?
+
+        name = "%s (%.2fms)" % ["Redis", event.duration]
+
+        commands = []
+        event.payload[:commands].map do |op, *args|
+          commands << "#{op.to_s.upcase} #{args.join(" ")}".strip
+        end
+
+        debug "  #{color(name, RED, true)} #{commands.join(" >> ")}"
+      end
+    end
+  end
+end
+
+Redis::Client.prepend(Cacheflow::Redis::Notifications)
+Cacheflow::Redis::Instrumenter.attach_to(:redis)

data/lib/cacheflow/version.rb

@@ -0,0 +1,3 @@
+module Cacheflow
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: cacheflow
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrew Kane
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-09-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  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
+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: []
+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.13
+signing_key: 
+specification_version: 4
+summary: Colorized logging for Memcached and Redis
+test_files: []