puff 0.3.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Polydice, Inc.
+
+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,49 @@
+# Puff
+
+Puff provides Redis integration and instrumentation for Rails.
+
+## Features
+
+* Simple integration (Put your server info in config/puff.yml)
+* High performance by default (hiredis C-based native driver)
+* Rails instrumentation (Using ActiveSupport::Notifications)
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'puff'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install puff
+
+## Usage
+
+After put puff in your Gemfile, use the generator to generate default config file.
+
+```
+rails g puff:config
+```
+
+To use Redis in your Rails apps, using the singleton method:
+
+```
+irb(main):001:0> redis = Puff.redis
+=> #<Redis client v3.0.2 for redis://localhost:6379/0>
+irb(main):002:0> redis.ping
+=> "PONG"
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/generators/puff/config_generator.rb

@@ -0,0 +1,16 @@
+require 'rails/generators'
+
+module Puff
+  module Generators
+    class ConfigGenerator < ::Rails::Generators::Base
+      desc "Creates a Puff configuration file at config/puff.yml"
+
+      source_root File.expand_path('../templates', __FILE__)
+
+      def create_config_file
+        template 'puff.yml', File.join('config', "puff.yml")
+      end
+
+    end
+  end
+end

data/lib/generators/puff/templates/puff.yml

@@ -0,0 +1,13 @@
+Adefaults: &defaults
+  host: localhost
+  port: 6379
+  db: 0
+
+development:
+  <<: *defaults
+
+test:
+  <<: *defaults
+
+production:
+  <<: *defaults

data/lib/puff/engine.rb

@@ -0,0 +1,14 @@
+require 'puff/instrumentation/log_subscriber'
+require 'puff/instrumentation/controller_runtime'
+
+module Puff
+  class Engine < ::Rails::Engine
+    initializer "puff.Instrumentation" do
+      Puff::Instrumentation::LogSubscriber.attach_to(:redis)
+
+      ActiveSupport.on_load(:action_controller) do
+        include Puff::Instrumentation::ControllerRuntime
+      end
+    end
+  end
+end

data/lib/puff/instrumentation/controller_runtime.rb

@@ -0,0 +1,34 @@
+module Puff
+  module Instrumentation
+    module ControllerRuntime
+      extend ActiveSupport::Concern
+
+      protected
+
+      attr_internal :redis_runtime_before_render
+      attr_internal :redis_runtime_during_render
+
+      def cleanup_view_runtime
+        self.redis_runtime_before_render = Puff::Instrumentation::LogSubscriber.reset_runtime
+        runtime = super
+        self.redis_runtime_during_render = Puff::Instrumentation::LogSubscriber.reset_runtime
+        runtime - redis_runtime_during_render
+      end
+
+      def append_info_to_payload(payload)
+        super
+        payload[:redis_runtime] = (redis_runtime_before_render || 0) +
+                                                  (redis_runtime_during_render || 0)  +
+                                                  Puff::Instrumentation::LogSubscriber.reset_runtime
+      end
+
+      module ClassMethods
+        def log_process_action(payload)
+          messages, redis_runtime = super, payload[:redis_runtime]
+          messages << ("Redis: %.1fms" % redis_runtime.to_f) if redis_runtime
+          messages
+        end
+      end
+    end
+  end
+end

data/lib/puff/instrumentation/log_subscriber.rb

@@ -0,0 +1,40 @@
+require 'puff/Instrumentation/redis'
+
+module Puff
+  module Instrumentation
+    class LogSubscriber < ActiveSupport::LogSubscriber
+      def self.runtime=(value)
+          Thread.current["redis_runtime"] = value
+        end
+
+        def self.runtime
+          Thread.current["redis_runtime"] ||= 0
+        end
+
+        def self.reset_runtime
+          rt, self.runtime = runtime, 0
+          rt
+        end
+
+      def request(event)
+        self.class.runtime += event.duration
+        return unless logger.debug?
+
+        name = "%s (%.2fms)" % ["Redis", event.duration]
+        cmds = event.payload[:commands]
+
+        output = "  #{color(name, RED, true)}"
+
+        cmds.each do |name, *args|
+          if args.present?
+            output << "  #{name.to_s.upcase} #{args.join(" ")}"
+          else
+            output << "  #{name.to_s.upcase}"
+          end
+        end
+
+        debug output
+      end
+    end
+  end
+end

data/lib/puff/instrumentation/redis.rb

@@ -0,0 +1,13 @@
+# Monkey Patching for profit.
+
+class Redis
+  class Client
+    alias :old_logging :logging
+
+    def logging(commands, &block)
+      ActiveSupport::Notifications.instrument('request.redis', commands: commands) do
+        return old_logging(commands, &block)
+      end
+    end
+  end
+end

data/lib/puff/version.rb

@@ -0,0 +1,3 @@
+module Puff
+  VERSION = "0.3.0"
+end

data/lib/puff.rb

@@ -0,0 +1,28 @@
+require 'redis'
+require 'redis/connection/hiredis'
+
+require "puff/version"
+require 'puff/engine' if defined?(::Rails::Railtie)
+require "puff/instrumentation/log_subscriber"
+
+module Puff
+  # Generic error
+  class PuffError < RuntimeError; end
+
+  def self.config
+    @config ||= YAML.load(File.open("#{Rails.root}/config/puff.yml"))[Rails.env]
+  end
+
+  def self.config=(config)
+    @config = config
+  end
+
+  def self.redis
+    @redis ||= ::Redis.new(Puff.config)
+  end
+
+  def self.redis=(redis)
+    @redis = redis
+  end
+
+end

data/puff.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'puff/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "puff"
+  gem.version       = Puff::VERSION
+  gem.authors       = ["Richard Lee"]
+  gem.email         = ["rl@polydice.com"]
+  gem.description   = %q{Puff provides Redis integration and instrumentation for Rails.}
+  gem.summary       = %q{Elagant Redis solution for Rails.}
+  gem.homepage      = "https://github.com/polydice/puff"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "railties", "~> 3.1"
+  gem.add_dependency "activesupport", "~> 3.2"
+  gem.add_dependency "redis", "~> 3.0"
+  gem.add_dependency "hiredis", "~> 0.4"
+
+  gem.add_development_dependency "rake",  "~> 10.0"
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: puff
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+  prerelease: 
+platform: ruby
+authors:
+- Richard Lee
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: hiredis
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Puff provides Redis integration and instrumentation for Rails.
+email:
+- rl@polydice.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/puff/config_generator.rb
+- lib/generators/puff/templates/puff.yml
+- lib/puff.rb
+- lib/puff/engine.rb
+- lib/puff/instrumentation/controller_runtime.rb
+- lib/puff/instrumentation/log_subscriber.rb
+- lib/puff/instrumentation/redis.rb
+- lib/puff/version.rb
+- puff.gemspec
+homepage: https://github.com/polydice/puff
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2726262251431638489
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2726262251431638489
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Elagant Redis solution for Rails.
+test_files: []