peek-memcached 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a99b91316f6239884a7c0d26a8600370026e8af9
+  data.tar.gz: 5668ba994c679b151630fe51d2ddc59bb54dfa81
+SHA512:
+  metadata.gz: ebf53c3f92040b9e5dd4c05d8cdcdd3830c776b91d09460919b4cf41e8272381e06e7e8043ab9f11f7c2807283bba635cda90243b67a755f3ae59d280e408f51
+  data.tar.gz: 0514918af003d762bf38386ad59f9358edf18d51c195393586848ca18d5af5f4fb035078f2ab1a51f7e55e1166e8d600bc9d8dcc85aa6304b88eec589da89715

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+*.gem
+mkmf.log
+vendor/*

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Masaki YOSHIDA
+
+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,56 @@
+# Peek::Memcached
+
+Take a peek into the Memcache commands made through Memcached during your application's requests.
+
+Thins this peek view provides:
+
+ * Total number of memcache commands called during the request
+ * The number of memcache `get` and hit commands called during the request
+ * The number of memcache `get` and miss commands called during the request
+ * The number of memcache `set` commands called during the request
+ * The duration of the commands made during the request
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'peek-memcached'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install peek-memcached
+
+## Usage
+
+Add the following to your `config/initializers/peekrb`:
+
+```ruby
+Peek.into Peek ::Views::Memcached
+```
+
+There is an additional JavaScript file peek-memcached provides that gives additional infomation about the requests Memcached makes during the request:
+
+ * Get[HIT]
+ * Get[MISS]
+ * Set
+
+Include the `peek/views/memcachced` JavaScript file in your application:
+
+```coffee
+#= require peek
+#= require peek/views/memcached
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/ReSTARTR/peek-memcached/fork )
+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 a new Pull Request

data/Rakefile

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

data/app/assets/javascripts/peek/views/memcached.coffee

@@ -0,0 +1,11 @@
+$(document).on 'peek:render', (event, requestId, data) ->
+  title = []
+  title.push("Gets[HIT]: #{data.context.memcached.get_hits}")
+  title.push("Gets[MISS]: #{data.context.memcached.get_misses}")
+  title.push("Sets: #{data.context.memcached.sets}")
+
+  $('#peek-memcached-tooltip')
+    .attr('title', title.join('<br>'))
+    .tipsy
+      html: true
+      gravity: $.fn.tipsy.autoNS

data/app/views/peek/views/memcached.html.erb

@@ -0,0 +1 @@
+<strong><span id="peek-memcached-tooltip"><span data-defer-to="<%= view.defer_key %>-duration">...</span> / <span data-defer-to="<%= view.defer_key %>-calls">...</span></span></strong> memcached

data/lib/peek/views/memcached.rb

@@ -0,0 +1,92 @@
+require 'memcached'
+require 'atomic'
+
+Memcached.class_eval do
+  class << self
+    attr_accessor :duration, :calls, :get_hits, :get_misses, :sets
+
+    def init_peek_stats
+      self.duration = Atomic.new(0)
+      self.calls = Atomic.new(0)
+      self.get_hits = Atomic.new(0)
+      self.get_misses = Atomic.new(0)
+      self.sets = Atomic.new(0)
+    end
+  end
+  self.init_peek_stats
+
+  alias :get_orig :get
+
+  def get(keys, decode=true)
+    start = Time.now
+    get_orig(keys, decode)
+  rescue Memcached::NotFound => e
+    hits = false
+    raise e
+  ensure
+    _duration = Time.now - start
+    self.class.duration.update { |v| v + _duration }
+    self.class.calls.update { |v| v + 1 }
+    if hits
+      self.class.get_hits.update { |v| v + 1 }
+    else
+      self.class.get_misses.update { |v| v + 1 }
+    end
+  end
+
+  alias :set_orig :set
+
+  def set(key, value, ttl=@default_ttl, encode=true, flags=::Memcached::FLAGS)
+    start = Time.now
+    set_orig(key, value, ttl, encode, flags)
+  ensure
+    _duration = Time.now - start
+    self.class.duration.update { |v| v + _duration }
+    self.class.calls.update { |v| v + 1 }
+    self.class.sets.update { |v| v + 1 }
+  end
+end
+
+require 'peek/views/view'
+
+module Peek
+  module Views
+    class Memcached < View
+      def duration
+        ::Memcached.duration.value
+      end
+
+      def formatted_duration
+        ms = duration * 1000
+        if ms >= 1000
+          '%.2fms' % ms
+        else
+          '%.0fms' % ms
+        end
+      end
+
+      def context
+        {
+          :get_hits => ::Memcached.get_hits.value,
+          :get_misses => ::Memcached.get_misses.value,
+          :sets => ::Memcached.sets.value,
+        }
+      end
+
+      def results
+        {
+          :duration => formatted_duration,
+          :calls => ::Memcached.calls.value,
+        }
+      end
+
+      private
+
+      def setup_subscribers
+        before_request do
+          ::Memcached.init_peek_stats
+        end
+      end
+    end
+  end
+end

data/lib/peek-memcached/railtie.rb

@@ -0,0 +1,8 @@
+require 'rails'
+
+module Peek
+  module Memcached
+    class Railtie < ::Rails::Engine
+    end
+  end
+end

data/lib/peek-memcached/version.rb

@@ -0,0 +1,5 @@
+module Peek
+  module Memcached
+    VERSION = '0.0.1'
+  end
+end

data/lib/peek-memcached.rb

@@ -0,0 +1,3 @@
+require 'peek/views/memcached'
+require 'peek-memcached/version'
+require 'peek-memcached/railtie'

data/peek-memcached.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'peek-memcached/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "peek-memcached"
+  spec.version       = Peek::Memcached::VERSION
+  spec.authors       = ["Masaki YOSHIDA"]
+  spec.email         = ["yoshida@vasily.jp"]
+  spec.summary       = %q{Take a peek into the Memcached calls made within your Rails application.}
+  spec.description   = %q{Take a peek into the Memcached calls made within your Rails application.}
+  spec.homepage      = "http://github.com/ReSTARTR/peek-memcached"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_dependency "peek"
+  spec.add_dependency "memcached"
+  spec.add_dependency "atomic", '>= 1.0.0'
+end

data/test/peek/views/memcached_test.rb

@@ -0,0 +1,32 @@
+require 'peek-memcached'
+require 'minitest/autorun'
+
+class MemcachedTest < MiniTest::Unit::TestCase
+  def setup
+    Memcached.init_peek_stats
+    @memcached = Memcached.new
+    @memcached.flush
+  end
+
+  def test_get_and_miss
+    assert_raises(::Memcached::NotFound) do
+      @memcached.get('foo')
+    end
+  ensure
+    assert_equal 1, Memcached.calls.value
+    assert_equal 0, Memcached.get_hits.value
+    assert_equal 1, Memcached.get_misses.value
+    assert_equal 0, Memcached.sets.value
+  end
+
+  def test_get_and_hit
+    @memcached.set('foo', 99)
+    result = @memcached.get('foo')
+    assert_equal 99, result
+  rescue ::Memcached::NotFound
+    assert_equal 1, Memcached.calls.value
+    assert_equal 1, Memcached.get_hits.value
+    assert_equal 0, Memcached.get_misses.value
+    assert_equal 1, Memcached.sets.value
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+ENV['RAILS_ENV'] = 'test'
+
+require 'minitest/unit'
+
+require 'minitest/autorun'

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: peek-memcached
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Masaki YOSHIDA
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: peek
+  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: memcached
+  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: atomic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+description: Take a peek into the Memcached calls made within your Rails application.
+email:
+- yoshida@vasily.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/assets/javascripts/peek/views/memcached.coffee
+- app/views/peek/views/memcached.html.erb
+- lib/peek-memcached.rb
+- lib/peek-memcached/railtie.rb
+- lib/peek-memcached/version.rb
+- lib/peek/views/memcached.rb
+- peek-memcached.gemspec
+- test/peek/views/memcached_test.rb
+- test/test_helper.rb
+homepage: http://github.com/ReSTARTR/peek-memcached
+licenses:
+- MIT
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Take a peek into the Memcached calls made within your Rails application.
+test_files:
+- test/peek/views/memcached_test.rb
+- test/test_helper.rb