glimpse-rails 0.0.1

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 glimpse-rails.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jerry Cheung
+
+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,40 @@
+# Glimpse::Rails
+
+A [glimpse](https://github.com/dewski/glimpse) plugin for reporting on Rails.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'glimpse-rails'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install glimpse-rails
+
+## Usage
+
+Setup [glimpse](https://github.com/dewski/glimpse#usage), then add this into
+your initializer:
+
+```ruby
+Glimpse.into Glimpse::Views::Rails
+```
+
+## Caveats
+
+This only works for full html responses that have a closing body tag. I plan
+on removing this restriction, but it was simplier to implement with the
+constraint. See `glimpse/rails/railtie.rb` for details.
+
+## 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/app/views/glimpse/views/_rails.html.erb

@@ -0,0 +1,5 @@
+<strong>
+  <span data-defer-to="<%= view.defer_key %>-controller">...</span>
+  <span data-defer-to="<%= view.defer_key %>-sql">...</span>
+  <span data-defer-to="<%= view.defer_key %>-views">...</span>
+</strong>

data/glimpse-rails.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'glimpse/rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "glimpse-rails"
+  spec.version       = Glimpse::Rails::VERSION
+  spec.authors       = ["Jerry Cheung"]
+  spec.email         = ["jollyjerry@gmail.com"]
+  spec.description   = %q{glimpse profiling plugin for Rails}
+  spec.summary       = %q{glimpse profiling plugin for Rails}
+  spec.homepage      = "https://github.com/jch/glimpse-rails"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_dependency "rails", ">= 3"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/glimpse/rails.rb

@@ -0,0 +1,3 @@
+require 'glimpse/rails/version'
+require 'glimpse/rails/railtie'
+require 'glimpse/views/rails'

data/lib/glimpse/rails/railtie.rb

@@ -0,0 +1,35 @@
+module Glimpse
+  module Rails
+    # Overrides ActionController::Base#dispatch to inject glimpse/results
+    # before the end body tag. This evaluates the results partial within a
+    # controller context for #glimpse_enabled? and other helper methods
+    # unavailable in regular middleware.
+    module ControllerMethods
+      extend ActiveSupport::Concern
+
+      def dispatch(name, request) #:nodoc:
+        output = super
+
+        # render_to_string is overridden after the body is closed. Call raw
+        # render_to_body here. See
+        # ActionController::Metal::Rendering#render_to_string
+        glimpse_results = render_to_body(:partial => 'glimpse/results')
+
+        # TODO: gsub! doesn't work. Seems really inefficient to regex replace
+        # the whole body
+        new_body = output.last.body.gsub(/<\/body>/i,  "#{glimpse_results}</body>")
+        output.last.body = new_body
+
+        output
+      end
+    end
+
+    class Railtie < ::Rails::Engine
+      initializer 'glimpse-rails.action_dispatch' do
+        ActiveSupport.on_load :action_controller do
+          include ControllerMethods
+        end
+      end
+    end
+  end
+end

data/lib/glimpse/rails/version.rb

@@ -0,0 +1,5 @@
+module Glimpse
+  module Rails
+    VERSION = "0.0.1"
+  end
+end

data/lib/glimpse/views/rails.rb

@@ -0,0 +1,38 @@
+module Glimpse
+  module Views
+    class Rails < View
+      # This view displays the milliseconds spent in the following:
+      #
+      # * the controller action
+      # * processing sql (0 if no sql is run)
+      # * rendering views
+      #
+      # These values are reported by the ActiveSupport::Notification named
+      # `process_action.action_controller`.
+      #
+      # See also
+      # http://edgeguides.rubyonrails.org/active_support_instrumentation.html
+      def initialize(options = {})
+        @event = nil
+
+        # This isn't fired off until the action is complete. But the glimpse
+        # bar and results are part of the action
+        ActiveSupport::Notifications.subscribe "process_action.action_controller" do |*args|
+          @event = ActiveSupport::Notifications::Event.new(*args)
+        end
+      end
+
+      # Deferred results are injected into the html body after results finish rendering
+      def results
+        {
+          :controller => "#{@event.duration.to_i}ms controller",
+          :sql        => "#{@event.payload[:db_runtime].to_i}ms sql", # not documented?
+          :views      => "#{@event.payload[:view_runtime].to_i}ms views"
+        }
+      rescue
+        # TODO: log an error here, or display it in the view
+        {}
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: glimpse-rails
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jerry Cheung
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: glimpse profiling plugin for Rails
+email:
+- jollyjerry@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/views/glimpse/views/_rails.html.erb
+- glimpse-rails.gemspec
+- lib/glimpse/rails.rb
+- lib/glimpse/rails/railtie.rb
+- lib/glimpse/rails/version.rb
+- lib/glimpse/views/rails.rb
+homepage: https://github.com/jch/glimpse-rails
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: glimpse profiling plugin for Rails
+test_files: []