x-ray-machine 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0a96ac18783ffbb5d0c77256f0cdb11e3cf7c2ce
+  data.tar.gz: a8b664e63e6450c3f0cb3012c397a9d65af50802
+SHA512:
+  metadata.gz: 3dec83fd88b356ae3fe723dd451537fdd483d2555dd3f63d888af90e476bd6adaa1c4c4aa1d25e5da3490313a4c1c53bafa6369756b5d6ec2d1731d5fd9522a5
+  data.tar.gz: 4542b55289dcaa18d99aadca5f3ba18475b0bc8a663ede503bb02baa2d4297dc093bf2134f66fdf656775a80851aa010897749c0bfda6f7b1bdea33a8aa03799

data/.gitignore

@@ -0,0 +1,2 @@
+.bundle
+*.gem

data/.rspec

@@ -0,0 +1 @@
+-c -f p -r spec_helper

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,132 @@
+PATH
+  remote: .
+  specs:
+    x-ray-machine (0.0.0)
+      rails (~> 4.0, >= 4.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.1.8)
+      actionpack (= 4.1.8)
+      actionview (= 4.1.8)
+      mail (~> 2.5, >= 2.5.4)
+    actionpack (4.1.8)
+      actionview (= 4.1.8)
+      activesupport (= 4.1.8)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    actionview (4.1.8)
+      activesupport (= 4.1.8)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+    activemodel (4.1.8)
+      activesupport (= 4.1.8)
+      builder (~> 3.1)
+    activerecord (4.1.8)
+      activemodel (= 4.1.8)
+      activesupport (= 4.1.8)
+      arel (~> 5.0.0)
+    activesupport (4.1.8)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    arel (5.0.1.20140414130214)
+    builder (3.2.2)
+    celluloid (0.16.0)
+      timers (~> 4.0.0)
+    coderay (1.1.0)
+    diff-lcs (1.2.5)
+    erubis (2.7.0)
+    ffi (1.9.6)
+    formatador (0.2.5)
+    guard (2.10.1)
+      formatador (>= 0.2.4)
+      listen (~> 2.7)
+      lumberjack (~> 1.0)
+      pry (>= 0.9.12)
+      thor (>= 0.18.1)
+    guard-rspec (4.3.1)
+      guard (~> 2.1)
+      rspec (>= 2.14, < 4.0)
+    hike (1.2.3)
+    hitimes (1.2.2)
+    i18n (0.6.11)
+    json (1.8.1)
+    listen (2.8.3)
+      celluloid (>= 0.15.2)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+    lumberjack (1.0.9)
+    mail (2.6.3)
+      mime-types (>= 1.16, < 3)
+    method_source (0.8.2)
+    mime-types (2.4.3)
+    minitest (5.4.3)
+    multi_json (1.10.1)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (4.1.8)
+      actionmailer (= 4.1.8)
+      actionpack (= 4.1.8)
+      actionview (= 4.1.8)
+      activemodel (= 4.1.8)
+      activerecord (= 4.1.8)
+      activesupport (= 4.1.8)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.1.8)
+      sprockets-rails (~> 2.0)
+    railties (4.1.8)
+      actionpack (= 4.1.8)
+      activesupport (= 4.1.8)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.3.2)
+    rb-fsevent (0.9.4)
+    rb-inotify (0.9.5)
+      ffi (>= 0.5.0)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.7)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.3)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.2)
+    slop (3.6.0)
+    sprockets (2.11.3)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sprockets-rails (2.2.0)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (>= 2.8, < 4.0)
+    thor (0.19.1)
+    thread_safe (0.3.4)
+    tilt (1.4.1)
+    timers (4.0.1)
+      hitimes
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.7)
+  guard-rspec (~> 4.3)
+  rspec (~> 3.1)
+  x-ray-machine!

data/Guardfile

@@ -0,0 +1,8 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/README.md

@@ -0,0 +1,100 @@
+# X Ray Machine
+
+![X-Ray](./x-ray.jpg)
+
+Ever wanted to log and profile your external API calls in a Rails app the
+same way Rails does with active record? Look no further, as the `x-ray-machine`
+is the thing that will enable you to do that!
+
+## Usage
+
+As per usual add this to your `Gemfile`
+
+```ruby
+gem 'x-ray-machine'
+```
+
+Then just call `XRay.whatevers` with some marker you wanna see in the logs
+(it can be an url or anything stringy) and then give it a block to measure.
+
+```ruby
+class MyThing
+  def talk_to_elastic_search
+    url = figure_the_url
+
+    XRay.elastic_search url do
+      make_the_actual_request url
+    end
+  end
+
+  def talk_to_twitter_api
+    XRay.twitter "loading recent tweets" do
+      load_some_tweets_for_fun_and_profit
+    end
+  end
+
+  def craaaazy_stuff
+    XRay.baaacooon "fat acids hitting the brain" do
+      i_wonder_if_spacemen_eat_bacon
+    end
+  end
+end
+```
+
+This will show something like this in your rails console
+
+```log
+ElasticSearch (5.1ms)  /url?bla=bla&bla
+Twitter (100.2ms) loading recent tweets
+Baaacooon (10.1ms) fat acids hitting the brain
+```
+
+## Marking Cached Results
+
+In case you want to mark a query as cached, you can use the `ray`
+object that is passed down the block, and mark it as cached
+
+```ruby
+url = "some/url.thing"
+
+XRay.heavy_request url do |ray|
+  if result = find_in_cache(url)
+    ray.cached = true
+  else
+    result = make_the_actual_request(url)
+  end
+end
+```
+
+After that your log entry will look like so
+
+```log
+HeavyRequest CACHE (0.1ms)  /url?bla=bla&bla
+```
+
+
+## Customization & Configuration
+
+Normally, the `XRay` object will use `method_missing` and automatically
+guess the name for the entry and use a random color for it, but you can
+customize things
+
+```ruby
+XRayMachine.config do |config|
+  config.elastic_search = {
+    color: :yellow,         # color for the line
+    title: "ES",            # title for the entries
+    show_in_summary: false  # show/hide the results in the summary
+  }
+end
+```
+
+__NOTE__: the name you use with the `config` should match the one
+that you use on the `XRay` class to track your queries.
+
+
+## Copyright & License
+
+All code in this repository is released under the terms of the MIT License
+
+Copyright (C) 2014 Nikolay Nemshilov

data/bin/bundler

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'bundler' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('bundler', 'bundler')

data/bin/coderay

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'coderay' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('coderay', 'coderay')

data/bin/erubis

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'erubis' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('erubis', 'erubis')

data/bin/guard

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'guard' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('guard', 'guard')

data/bin/htmldiff

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'htmldiff' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('diff-lcs', 'htmldiff')

data/bin/ldiff

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'ldiff' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('diff-lcs', 'ldiff')

data/bin/listen

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'listen' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('listen', 'listen')

data/bin/pry

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'pry' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('pry', 'pry')

data/bin/rackup

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rackup' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rack', 'rackup')

data/bin/rails

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rails' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('railties', 'rails')

data/bin/rake

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rake', 'rake')

data/bin/rspec

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'rspec')

data/bin/sprockets

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'sprockets' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('sprockets', 'sprockets')

data/bin/thor

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'thor' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('thor', 'thor')

data/bin/tilt

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'tilt' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('tilt', 'tilt')

data/lib/x-ray-machine.rb

@@ -0,0 +1,2 @@
+# just a gem hook
+require_relative "./x_ray_machine"

data/lib/x_ray_machine.rb

@@ -0,0 +1,12 @@
+module XRayMachine
+  # x-ray all everything!
+end
+
+require_relative "./x_ray_machine/version"
+require_relative "./x_ray_machine/x_ray"
+require_relative "./x_ray_machine/config"
+require_relative "./x_ray_machine/log_subscriber"
+require_relative "./x_ray_machine/summary"
+require_relative "./x_ray_machine/railtie"
+
+XRay = XRayMachine::XRay

data/lib/x_ray_machine/config.rb

@@ -0,0 +1,79 @@
+module XRayMachine
+
+  def self.config(&block)
+    yield options
+  end
+
+  def self.options
+    @options ||= Options.new
+  end
+
+  class Options
+    COLORS = {
+      red:     "\e[31m",
+      green:   "\e[32m",
+      yellow:  "\e[33m",
+      blue:    "\e[34m",
+      magenta: "\e[35m",
+      cyan:    "\e[36m"
+    }
+
+    def initialize
+      @streams = {}
+    end
+
+    def method_missing(name, config=nil)
+      name = name[0, name.size - 1] if name[name.size - 1] == "="
+      name = name.to_sym
+
+      if config
+        @streams[name] = fill_defaults_for(config)
+      else
+        @streams[name] ||= generate_options_for(name)
+      end
+    end
+
+  private
+
+    def generate_options_for(name)
+      fill_defaults_for title: name.to_s.gsub(/(^|_)([a-z])/) { |m| $2.upcase }
+    end
+
+    def fill_defaults_for(config)
+      {
+        color: available_colors[0],
+        show_in_summary: true
+      }.merge config
+    end
+
+    def available_colors
+      used_colors = @streams.map{|_,o| o[:color] }.compact
+      COLORS.keys - used_colors
+    end
+  end
+
+  class Config
+    attr_reader :title, :color, :show_in_summary
+
+    def self.for(stream)
+      options = XRayMachine.options.__send__ stream
+      title   = options[:title]
+      color   = options[:color]
+      show_in_summary = options[:show_in_summary]
+
+      new title, color, show_in_summary
+    end
+
+    def initialize(title, color, show_in_summary)
+      @title = title
+      @color = XRayMachine::Options::COLORS[color] || XRayMachine::Options::COLORS[:red]
+      @show_in_summary = show_in_summary
+    end
+
+    alias :show_in_summary? :show_in_summary
+
+    def to_h
+      {title: title, color: color, show_in_summary: show_in_summary}
+    end
+  end
+end

data/lib/x_ray_machine/log_subscriber.rb

@@ -0,0 +1,23 @@
+module XRayMachine
+  class LogSubscriber < ActiveSupport::LogSubscriber
+    def self.runtimes
+      Thread.current["x_ray_machine_runtimes"] ||= Hash.new{|k,_| 0}
+    end
+
+    def self.reset_runtimes
+      Thread.current["x_ray_machine_runtimes"] = nil
+    end
+
+    def request(event)
+      group  = event.payload[:group]
+      config = XRayMachine::Config.for(group)
+
+      self.class.runtimes[group] += event.duration
+
+      name  = config.title
+      name += " CACHE" if event.payload[:cache]
+      name  = '%s (%.1fms)' % [name, event.duration]
+      debug "  #{color(name, config.color, true)}  #{event.payload[:query]}"
+    end
+  end
+end

data/lib/x_ray_machine/railtie.rb

@@ -0,0 +1,13 @@
+module XRayMachine
+  class Railtie < Rails::Railtie
+    railtie_name :x_ray_machine
+
+    config.before_initialize do |app|
+      XRayMachine::LogSubscriber.attach_to :xraymachine
+
+      ActiveSupport.on_load(:action_controller) do
+        include XRayMachine::Summary::Runtime
+      end
+    end
+  end
+end

data/lib/x_ray_machine/summary.rb

@@ -0,0 +1,41 @@
+module XRayMachine
+  class Summary
+    def self.add(payload)
+      payload_sum = XRayMachine::LogSubscriber.runtimes.map{|k,v| v}.inject(0){|a,b| a+b}
+
+      # most of the times things are lazyloaded
+      if payload[:view_runtime] && payload[:view_runtime] > payload_sum
+        payload[:view_runtime] -= payload_sum
+      end
+    end
+
+    def self.messages
+      XRayMachine::LogSubscriber.runtimes.map do |stream_name, duration|
+        stream = XRayMachine::Config.for(stream_name)
+        if stream.show_in_summary?
+          "%s: %.1fms" % [stream.title, duration]
+        end
+      end.compact
+    end
+
+    module Runtime
+      extend ActiveSupport::Concern
+
+    protected
+
+      def append_info_to_payload(payload)
+        super.tap do
+          XRayMachine::Summary.add(payload)
+        end
+      end
+
+      module ClassMethods
+        def log_process_action(payload)
+          super.tap do |messages|
+            messages += XRayMachine::Summary.messages
+          end
+        end
+      end
+    end
+  end
+end

data/lib/x_ray_machine/version.rb

@@ -0,0 +1,3 @@
+module XRayMachine
+  VERSION = "1.0.0"
+end

data/lib/x_ray_machine/x_ray.rb

@@ -0,0 +1,25 @@
+module XRayMachine
+  class XRay
+    def cached
+      @cached || false
+    end
+
+    def cached=(val)
+      @cached = val
+    end
+
+    alias :cached? :cached
+
+    def self.method_missing(name, query, &block)
+      options = {group: name, query: query, cache: false}
+
+      ActiveSupport::Notifications.instrument "request.xraymachine", options do
+        ray = XRayMachine::XRay.new
+
+        block.call(ray).tap do |result|
+          options[:cache] = true if ray.cached?
+        end
+      end
+    end
+  end
+end

data/spec/lib/x_ray_machine/config_spec.rb

@@ -0,0 +1,55 @@
+require "spec_helper"
+
+describe XRayMachine::Config do
+
+  before { XRayMachine.instance_eval{ @options = nil } }
+
+  describe ".config" do
+
+    it "allows to config things" do
+      XRayMachine.config do |config|
+        config.thing = {title: "Thingy"}
+      end
+
+      expect(XRayMachine.options.instance_variable_get("@streams")).to eq({
+        thing: {title: "Thingy", color: :red, show_in_summary: true}
+      })
+    end
+
+    it "allows to override colors and the summary settings" do
+      XRayMachine.config do |config|
+        config.thing = {title: "Thingy", color: :yellow, show_in_summary: false}
+      end
+
+      expect(XRayMachine.options.instance_variable_get("@streams")).to eq({
+        thing: {title: "Thingy", color: :yellow, show_in_summary: false}
+      })
+    end
+
+  end
+
+  describe ".for" do
+    subject { XRayMachine::Config.for("some_thing").to_h }
+
+    it "generates a new config if the settings are missing" do
+      is_expected.to eq({title: "SomeThing", color: "\e[31m", show_in_summary: true})
+    end
+
+    it "uses the user settings when it configured" do
+      XRayMachine.config { |c| c.some_thing = {title: "ST", color: :yellow} }
+
+      is_expected.to eq({title: "ST", color: "\e[33m", show_in_summary: true})
+    end
+
+    it "returns the same object every time" do
+      is_expected.to eq(XRayMachine::Config.for("some_thing").to_h)
+    end
+
+    it "picks different colors for different things" do
+      colors = (1..3).to_a.map{|i| XRayMachine::Config.for("thing_#{i}").color }
+      expect(colors).to eq ["\e[31m", "\e[32m", "\e[33m"]
+    end
+
+  end
+
+end

data/spec/lib/x_ray_machine/log_subscriber_spec.rb

@@ -0,0 +1,48 @@
+require "spec_helper"
+
+describe XRayMachine::LogSubscriber do
+  before { XRayMachine::LogSubscriber.reset_runtimes }
+
+  describe ".runtimes" do
+    subject { XRayMachine::LogSubscriber.runtimes }
+
+    it { is_expected.to be_a Hash }
+    it { is_expected.to eq({}) }
+
+    it "returns the same object all the time" do
+      other_object = XRayMachine::LogSubscriber.runtimes
+
+      is_expected.to be other_object
+    end
+  end
+
+  describe "#request" do
+    let(:subscriber) { XRayMachine::LogSubscriber.new }
+    let(:event) { double("Event", duration: 11, payload: payload) }
+    let(:payload) { {query: "some/query/data", cache: false, group: "external_api"} }
+
+    subject { subscriber.request(event) }
+
+    before do
+      def subscriber.debug(string=nil)
+        @debug ||= string
+      end
+    end
+
+    it "saves the duration in the runtimes list" do
+      expect{ subject }.to change{ XRayMachine::LogSubscriber.runtimes }.to({"external_api" => 11})
+    end
+
+    it "dumps the data in the debugging stream" do
+      expect{ subject }.to change{ subscriber.debug }
+        .to("  \e[1m\e[34mExternalApi (11.0ms)\e[0m  some/query/data")
+    end
+
+    it "marks things cached when the payload have a cache:true option" do
+      payload[:cache] = true
+
+      expect{ subject }.to change{ subscriber.debug }
+      .to("  \e[1m\e[34mExternalApi CACHE (11.0ms)\e[0m  some/query/data")
+    end
+  end
+end

data/spec/lib/x_ray_machine/summary_spec.rb

@@ -0,0 +1,55 @@
+require "spec_helper"
+
+describe XRayMachine::Summary do
+
+  before do
+    XRayMachine.instance_eval { @options = nil }
+    XRayMachine::LogSubscriber.reset_runtimes
+    XRayMachine::LogSubscriber.runtimes.merge!({
+      one: 11, two: 22, three: 33
+    })
+  end
+
+  describe ".add" do
+    let(:payload) { {view_runtime: 123} }
+
+    subject { XRayMachine::Summary.add(payload) }
+
+    it "substracts the custom runtime from the views runtime" do
+      expect{ subject }.to change{ payload }.to({view_runtime: 57})
+    end
+
+    it "doesn't change the view runtime when it's less than the recorded rintimes" do
+      payload[:view_runtime] = 10
+
+      expect{ subject }.not_to change{ payload }
+    end
+
+    it "doesn't explode when the view data is missing" do
+      payload.delete :view_runtime
+
+      expect{ subject }.not_to raise_error
+    end
+  end
+
+  describe ".messages" do
+    subject { XRayMachine::Summary.messages }
+
+    it "generates a list of summary messages from the recorded runtimes" do
+      is_expected.to eq ["One: 11.0ms", "Two: 22.0ms", "Three: 33.0ms"]
+    end
+
+    it "respect the title settings" do
+      XRayMachine.config{ |c| c.one = {title: "Custom One"} }
+
+      is_expected.to eq ["Custom One: 11.0ms", "Two: 22.0ms", "Three: 33.0ms"]
+    end
+
+    it "hides runtimes that are configured to be hidden from the summary" do
+      XRayMachine.config{ |c| c.one = {show_in_summary: false} }
+
+      is_expected.to eq ["Two: 22.0ms", "Three: 33.0ms"]
+    end
+  end
+
+end

data/spec/lib/x_ray_machine/x_ray_spec.rb

@@ -0,0 +1,44 @@
+require "spec_helper"
+
+describe XRay do
+
+  before do
+    ActiveSupport::Notifications.instance_eval do
+      def self.instrument(*args, &block)
+        @args = args
+        yield
+      end
+    end
+  end
+
+  def active_support_args
+    ActiveSupport::Notifications.instance_eval { @args }
+  end
+
+  describe ".method_missing" do
+    it "runs whatevers" do
+      XRay.whatevers "query/data" do
+      end
+
+      expect(active_support_args).to eq [
+        "request.xraymachine", {group: :whatevers, query: "query/data", cache: false}
+      ]
+    end
+
+    it "returns whatever the block yields" do
+      result = XRay.whatevers("query/data") { "yielded result" }
+      expect(result).to eq "yielded result"
+    end
+
+    it "sends a ray in and allows to mark it as cached" do
+      XRay.whatevers "query/data" do |ray|
+        ray.cached = true
+      end
+
+      expect(active_support_args).to eq [
+        "request.xraymachine", {group: :whatevers, query: "query/data", cache: true}
+      ]
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require "rails"
+require File.dirname(__FILE__)+ "/../lib/x_ray_machine"
+
+RSpec.configure do |config|
+  config.raise_errors_for_deprecations!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

data/x-ray-machine.gemspec

@@ -0,0 +1,23 @@
+require File.dirname(__FILE__)+ '/lib/x_ray_machine/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "x-ray-machine"
+  spec.version       = XRayMachine::VERSION
+  spec.authors       = ["Nikolay Nemshilov"]
+  spec.email         = ["nemshilov@gmail.com"]
+  spec.description   = "Better instrumentation/logging utility for Rails"
+  spec.summary       = "Better instrumentation/logging utility for Rails. Seriously"
+  spec.homepage      = "https://github.com/MadRabbit/x-ray-machine"
+  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_runtime_dependency 'rails', '~> 4.0', '>= 4.0.0'
+
+  spec.add_development_dependency "bundler",  "~> 1.7"
+  spec.add_development_dependency "rspec",    "~> 3.1"
+  spec.add_development_dependency "guard-rspec", "~> 4.3"
+end

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: x-ray-machine
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Nikolay Nemshilov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+description: Better instrumentation/logging utility for Rails
+email:
+- nemshilov@gmail.com
+executables:
+- bundler
+- coderay
+- erubis
+- guard
+- htmldiff
+- ldiff
+- listen
+- pry
+- rackup
+- rails
+- rake
+- rspec
+- sprockets
+- thor
+- tilt
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- README.md
+- bin/bundler
+- bin/coderay
+- bin/erubis
+- bin/guard
+- bin/htmldiff
+- bin/ldiff
+- bin/listen
+- bin/pry
+- bin/rackup
+- bin/rails
+- bin/rake
+- bin/rspec
+- bin/sprockets
+- bin/thor
+- bin/tilt
+- lib/x-ray-machine.rb
+- lib/x_ray_machine.rb
+- lib/x_ray_machine/config.rb
+- lib/x_ray_machine/log_subscriber.rb
+- lib/x_ray_machine/railtie.rb
+- lib/x_ray_machine/summary.rb
+- lib/x_ray_machine/version.rb
+- lib/x_ray_machine/x_ray.rb
+- spec/lib/x_ray_machine/config_spec.rb
+- spec/lib/x_ray_machine/log_subscriber_spec.rb
+- spec/lib/x_ray_machine/summary_spec.rb
+- spec/lib/x_ray_machine/x_ray_spec.rb
+- spec/spec_helper.rb
+- x-ray-machine.gemspec
+- x-ray.jpg
+homepage: https://github.com/MadRabbit/x-ray-machine
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Better instrumentation/logging utility for Rails. Seriously
+test_files:
+- spec/lib/x_ray_machine/config_spec.rb
+- spec/lib/x_ray_machine/log_subscriber_spec.rb
+- spec/lib/x_ray_machine/summary_spec.rb
+- spec/lib/x_ray_machine/x_ray_spec.rb
+- spec/spec_helper.rb