dustbin_lorry 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 568ac189e20ca2025554cbfe3a826ab86604ea06
+  data.tar.gz: 44276bcf3c6d8a08a93766dbb487e73698143509
+SHA512:
+  metadata.gz: ffb7423628877ad045c2305c3466f757956f7610bb91203e1869baec750c995f3e437c970b5d16cb8410cddcf4682af535c292c8c71c1bc6603e4e65b5a98cab
+  data.tar.gz: d80d8158b65f57de5d3a7c2d169e6e71f117f8d898498aae77908fae360a5b77cd98b47999d54c57759356fb5ddcd16865f6a21f1c8ff4de88bac77420a67174

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Ian Pointer
+
+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,35 @@
+# DustbinLorry
+
+DustinLorry: a simple Rack Middleware that dumps information about the Ruby MRI runtime (currently just if the method caches change during a Rack request).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```gem 'dustbin_lorry'```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dustbin_lorry    
+
+## Usage
+
+### Rails
+
+Add ```config.middleware.use 'Rack::DustbinLorry'``` to your ```config/application.rb```. The middleware will use ```Rails.Logger``` to output if any changes occur in the method caches.
+
+### Sinatra
+
+Add ```use DustbinLorry``` like any other Rack Middleware.
+
+## Contributing
+
+1. Fork it ( https://github.com/falloutdurham/dustbinlorry/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/dustbin_lorry.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dustbin_lorry/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dustbin_lorry"
+  spec.version       = DustbinLorry::VERSION
+  spec.authors       = ["Ian Pointer"]
+  spec.email         = ["ian@snappishproductions.com"]
+  spec.summary       = %q{ Output method cache busts to logger }
+  spec.description   = %q{ DustbinLorry is Rack middleware that inspects the method cache
+                           before and after a request and will output to the logger if a change has occurred}
+  spec.homepage      = "https://github.com/falloutdurham/dustbin_lorry"
+  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.required_ruby_version = '>= 2.1'
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-mocks"
+  spec.add_development_dependency "pry"
+end

data/lib/dustbin_lorry.rb

@@ -0,0 +1 @@
+require 'rack/dustbin_lorry'

data/lib/dustbin_lorry/version.rb

@@ -0,0 +1,3 @@
+module DustbinLorry
+  VERSION = '0.0.1'
+end

data/lib/rack/dustbin_lorry.rb

@@ -0,0 +1,36 @@
+module Rack
+  class DustbinLorry
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      cache_before = RubyVM.stat
+      response = @app.call(env)
+      cache_after = RubyVM.stat
+      result = delta_cache(cache_before, cache_after)
+      logger(env).info "Method cache change: #{result}" if result.select{ |k,v| v != 0 }.any?
+      response
+    end
+
+    private
+
+    def delta_cache(before, after)
+      states.each_with_object({}) do |counter, delta|
+        delta[counter] = after[counter] - before[counter]
+      end
+    end
+
+    def states
+      [:global_method_state, :global_constant_state, :class_serial]
+    end
+
+    def logger(env)
+      @logger ||= if defined?(Rails)
+        Rails.logger
+      else
+        env['rack.logger']
+      end
+    end
+  end
+end

data/spec/lib/rack/dustbin_lorry_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+describe Rack::DustbinLorry do
+  let(:app) { double('App') }
+  let(:middleware) { described_class.new(app) }
+
+  context 'on no cache change' do
+    context 'when used without Rails' do
+      let(:env) { double('Rack::Env') }
+      let(:logger) { double('Rack::Logger') }
+
+      it 'does not log' do
+        expect(app).to receive(:call).with(env)
+        expect(env).not_to receive(:[]).with('rack.logger')
+        middleware.call(env)
+      end
+    end
+  end
+  
+  context 'on cache change' do
+    context 'when used with Rails' do
+      let(:env) { double('Rack::Env') }
+      let(:breaking_app) { BREAK = 1 }
+      let(:logger) { double('Rails::Logger') }
+
+      before(:each) {
+        stub_const("Rails", 'Rails') 
+        
+        allow(app).to receive(:call).with(env) { 
+          a = String.new
+          a.extend(Math)
+        }
+        expect(Rails).to receive(:logger).and_return logger
+      }
+
+      it 'uses the Rails logger' do
+        expect(logger).to receive(:info)
+        middleware.call(env)
+      end
+    
+
+      it 'logs a change in the global_method_state' do
+        allow(app).to receive(:call).with(env) {  Object.class_exec { def new_method; end }   }
+        expect(logger).to receive(:info)
+        middleware.call(env)
+      end
+
+      it 'logs a change in the global_constant_state' do 
+        allow(app).to receive(:call).with(env) {  self.class.const_set :"TEST", "test"  }
+        expect(logger).to receive(:info)
+        middleware.call(env)
+      end
+
+      it 'logs a change in the class_serial' do
+        allow(app).to receive(:call).with(env) { Object.class_eval "class Lorry; end" }
+        expect(logger).to receive(:info)
+        middleware.call(env)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rspec'
+require 'rack/dustbin_lorry'
+
+RSpec.configure do |config|
+  config.color = true
+  config.tty = true
+  config.formatter = :documentation
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: dustbin_lorry
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ian Pointer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-24 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: rspec
+  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: rspec-mocks
+  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: pry
+  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: |2-
+   DustbinLorry is Rack middleware that inspects the method cache
+                             before and after a request and will output to the logger if a change has occurred
+email:
+- ian@snappishproductions.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- dustbin_lorry.gemspec
+- lib/dustbin_lorry.rb
+- lib/dustbin_lorry/version.rb
+- lib/rack/dustbin_lorry.rb
+- spec/lib/rack/dustbin_lorry_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/falloutdurham/dustbin_lorry
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Output method cache busts to logger
+test_files:
+- spec/lib/rack/dustbin_lorry_spec.rb
+- spec/spec_helper.rb