sweet_notifications 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1c1adad5429dc0a8d3ec40a499531b9fabacc9b5
+  data.tar.gz: 360d747cf1d39ac6bfc3c9583e87adcf110d0f03
+SHA512:
+  metadata.gz: 1e20abf7323c1ccc38984ff3b03105503c8e1e96025d54c3cb0ea23d8de015164923a6c8076f1bbc649b4f1d365bc167a3687a4dc92f96ee2b6724805d8ffd1a
+  data.tar.gz: 2019786e91f894fbb984e351f1d996da0f8b78c3b694026ba8aacee5d213fd50a14a6e541d2416372fb29a345816801383c060065943fe6905c892506a86190d

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+*emfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rubocop.yml

@@ -0,0 +1,19 @@
+AllCops:
+  Exclude:
+    - sweet_notifications.gemspec
+    - lib/sweet_notifications/version.rb
+
+ClassAndModuleChildren:
+  Exclude:
+    - test/**/*.rb
+
+Documentation:
+  Include:
+    - lib/**/*.rb
+
+MethodLength:
+  Exclude:
+    - lib/sweet_notifications/controller_runtime.rb
+
+ModuleFunction:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+gemfile:
+  - gemfiles/rails_4.0.gemfile
+  - gemfiles/rails_4.1.gemfile
+rvm:
+  - 2.0.0
+  - 2.1.2
+matrix:
+  include:
+    - rvm: jruby
+      gemfile: gemfiles/rails_4.1.gemfile
+      env: JRUBY_OPTS="--2.0"

data/Appraisals

@@ -0,0 +1,7 @@
+appraise "rails-4.0" do
+  gem 'rails', '~> 4.0.0'
+end
+
+appraise "rails-4.1" do
+  gem 'rails', '~> 4.1.0'
+end

data/CONTRIBUTING.md

@@ -0,0 +1,20 @@
+## Contributing
+
+Any contributions to SweetNotifications are welcome, whether they are feedback,
+bug reports, or - even better - pull requests.
+
+## Submitting a Pull Request
+1. [Fork the repository.][fork]
+2. [Create a topic branch.][branch]
+3. Add specs for your unimplemented feature or bug fix.
+4. Run `bundle exec rake test`. If your specs pass, return to step 3.
+5. Implement your feature or bug fix.
+6. Run `bundle exec rake default`. If your specs fail, return to step 5.
+7. Run `open coverage/index.html`. If your changes are not completely covered
+   by your tests, return to step 3.
+8. Add, commit, and push your changes.
+9. [Submit a pull request.][pr]
+
+[fork]: http://help.github.com/fork-a-repo/
+[branch]: http://learn.github.com/p/branching.html
+[pr]: http://help.github.com/send-pull-requests/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Ville Lautanala
+
+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,85 @@
+# SweetNotifications [![Build Status](https://travis-ci.org/lautis/sweet_notifications.svg?branch=master)](https://travis-ci.org/lautis/sweet_notifications)
+
+Syntactic sugar for ActiveSupport::LogSubscriber for easy instrumentation and
+logging from third-party libraries.
+
+This gem currently requires Ruby 2.0 or JRuby in 2.0 mode.
+
+## Installation
+
+Add this line to your Rails application's Gemfile:
+
+    gem 'sweet_notifications'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sweet_notifications
+
+## Usage
+
+This library helps with creating ActiveSupport::Notifications subscribers for
+logging purposes. First, there should be a source of notifications:
+
+```ruby
+
+class CandiesController < ApplicationController
+  def index
+    candies = %w{M&M's Gummibears Pez Salmiakki}
+    ActiveSupport::Notifications.instrument 'list.candies', list: candies do
+      sleep 0.5
+      render json: candies
+    end
+  end
+end
+```
+
+Then, subscribe to these notifications using SweetNotifications in an initializer:
+
+```ruby
+SweetNotifications.subscribe :candies do
+  color ActiveSupport::LogSubscriber::GREEN
+  event :list, runtime: true do |event|
+    return unless logger.debug?
+    debug message(event, 'Candy', "listing candies: #{event.payload[:candies]}")
+  end
+end
+```
+
+`SweetNotifications.subscribe` will subscribe to the namespace given as
+argument and, if necessary, create a Rails initializer that will be run when
+the application is initialized.
+
+If this functionality is too much, use `SweetNotification::LogSubscriber` to
+create LogSusbcribers and `SweetNotification.controller_runtime` to bind this
+to the Rails controller logging runtime logging functionality.
+
+```ruby
+class AwesomeLogSubscriber < SweetNotifications::LogSubscriber
+  color ActiveSupport::LogSubscriber::CYAN, ActiveSupport::LogSubscriber::MAGENTA
+  event :cool, runtime: true do |event|
+    info "Cool stuff"
+  end
+
+  event :insanely_great, runtime: false do |event|
+    debug "Insanely greate"
+  end
+end
+
+AwesomeLogSubscriber.attach_to :namespace
+ControllerRuntime = SweetNotifications.controller_runtime(:namespace, AwesomeLogSubscriber)
+
+ActionController::Base.send(:include, ControllerRuntime)
+
+```
+
+## Contributing
+
+See [CONTRIBUTING.md](https://raw.githubusercontent.com/lautis/sweet_notifications/master/CONTRIBUTING.md).
+
+## Copyright
+
+Copyright 2014 Ville Lautanala. Released under [the MIT license](https://github.com/lautis/uglifier/blob/master/LICENSE.txt).

data/Rakefile

@@ -0,0 +1,18 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rubocop/rake_task'
+require 'yard'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = 'test/*_test.rb'
+end
+
+YARD::Rake::YardocTask.new do |t|
+  t.files = ['lib/**/*.rb']
+end
+
+desc 'Check for code style'
+Rubocop::RakeTask.new
+
+task default: [:test, :rubocop]

data/gemfiles/rails_4.0.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 4.0.0"
+
+gemspec :path => "../"

data/gemfiles/rails_4.1.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 4.1.0"
+
+gemspec :path => "../"

data/lib/sweet_notifications/controller_runtime.rb

@@ -0,0 +1,52 @@
+require 'active_support/concern'
+require 'active_support/core_ext/module/attr_internal'
+
+module SweetNotifications
+  # Controller runtime tracking
+  module ControllerRuntime
+    # Define a controller runtime logger for a LogSusbcriber
+    #
+    # @param name [String] title for logging
+    # @return [Module] controller runtime tracking mixin
+    def controller_runtime(name, log_subscriber)
+      runtime_attr = "#{name.to_s.underscore}_runtime".to_sym
+      Module.new do
+        extend ActiveSupport::Concern
+        attr_internal runtime_attr
+
+        protected
+
+        define_method :process_action do |action, *args|
+          log_subscriber.reset_runtime
+          super(action, *args)
+        end
+
+        define_method :cleanup_view_runtime do |&block|
+          runtime_before_render = log_subscriber.reset_runtime
+          send("#{runtime_attr}=",
+               (send(runtime_attr) || 0) + runtime_before_render)
+          runtime = super(&block)
+          runtime_after_render = log_subscriber.reset_runtime
+          send("#{runtime_attr}=", send(runtime_attr) + runtime_after_render)
+          runtime - runtime_after_render
+        end
+
+        define_method :append_info_to_payload do |payload|
+          super(payload)
+          runtime = (send(runtime_attr) || 0) + log_subscriber.reset_runtime
+          payload[runtime_attr] = runtime
+        end
+
+        const_set(:ClassMethods, Module.new do
+          define_method :log_process_action do |payload|
+            messages, runtime = super(payload), payload[runtime_attr]
+            if runtime && runtime != 0
+              messages << format("#{name}: %.1fms", runtime.to_f)
+            end
+            messages
+          end
+        end)
+      end
+    end
+  end
+end

data/lib/sweet_notifications/log_subscriber.rb

@@ -0,0 +1,81 @@
+require 'active_support/log_subscriber'
+require 'request_store'
+require 'securerandom'
+
+module SweetNotifications
+  # LogSubscriber with runtime calculation and improved logging
+  class LogSubscriber < ActiveSupport::LogSubscriber
+    class_attribute :odd_color, :even_color
+
+    # Format a message for logging
+    #
+    # @param event [ActiveSupport::Notifications::Event] subscribed event
+    # @param label [String] label for log messages
+    # @param body [String] the rest
+    # @return [String] formatted message for logging
+    #
+    # ==== Examples
+    #
+    #  event :test do |event|
+    #    message(event, 'Test', 'message body')
+    #  end
+    #  # => "  Test (0.00ms)  message body"
+    def message(event, label, body)
+      @odd = !@odd
+      label_color = @odd ? odd_color : even_color
+
+      format(
+        '  %s (%.2fms)  %s',
+        color(label, label_color, true),
+        event.duration,
+        color(body, nil, !@odd)
+      )
+    end
+
+    class << self
+      # Store aggregated runtime form request specific store
+      def runtime=(value)
+        RequestStore.store["#{@name}_runtime"] = value
+      end
+
+      # Fetch aggregated runtime form request specific store
+      def runtime
+        RequestStore.store["#{@name}_runtime"] || 0
+      end
+
+      # Reset aggregated runtime
+      #
+      # @return Numeric previous runtime value
+      def reset_runtime
+        rt, self.runtime = runtime, 0
+        rt
+      end
+
+      # Set colors for logging title and duration
+      def color(odd, even = nil)
+        self.odd_color = odd
+        self.even_color = even || odd
+      end
+
+      # Define an event subscriber
+      #
+      # @param command [Symbol] event name
+      # @param runtime [Boolean] aggregate runtime for this event
+      # @yield [ActiveSupport::Notifications::Event] handle event
+      def event(command, runtime: true, &block)
+        define_method command do |event|
+          self.class.runtime += event.duration if runtime
+          instance_exec(event, &block) if block
+        end
+      end
+
+      protected
+
+      def inherited(base)
+        base.class_eval do
+          @name ||= SecureRandom.hex
+        end
+      end
+    end
+  end
+end

data/lib/sweet_notifications/railtie.rb

@@ -0,0 +1,36 @@
+require 'rails/railtie'
+
+module SweetNotifications
+  # Rails Railtie integration
+  module Railtie
+    extend self
+    # Attach LogSubscriber and ControllerRuntime to a notifications namespace
+    #
+    # @param name [Symbol] Notifications namespace
+    # @param log_subscriber [LogSubscriber] subscriber to be attached
+    # @param controller_runtime [Module] mixin that logs runtime
+    def initialize_rails(name, log_subscriber, controller_runtime)
+      log_subscriber.attach_to name.to_sym
+      ActiveSupport.on_load(:action_controller) do
+        include controller_runtime
+      end
+    end
+
+    # Create a Railtie for LogSubscriber and ControllerRuntime mixin
+    #
+    # @param name [Symbol] Notifications namespace
+    # @param log_subscriber [LogSubscriber] subscriber to be attached
+    # @param controller_runtime [Module] mixin that logs runtime
+    # @return [Rails::Railtie] Rails initializer
+    def railtie(name, log_subscriber, controller_runtime)
+      Class.new(Rails::Railtie) do
+        railtie_name name
+        initializer "#{name}.notifications" do
+          SweetNotifications::Railtie.initialize_rails(name,
+                                                       log_subscriber,
+                                                       controller_runtime)
+        end
+      end
+    end
+  end
+end

data/lib/sweet_notifications/version.rb

@@ -0,0 +1,3 @@
+module SweetNotifications
+  VERSION = '0.1.0'
+end

data/lib/sweet_notifications.rb

@@ -0,0 +1,42 @@
+require 'sweet_notifications/version'
+require 'sweet_notifications/log_subscriber'
+require 'sweet_notifications/controller_runtime'
+require 'sweet_notifications/railtie'
+
+# Syntactic sugar for ActiveSupport::Notifications subscribers for logging
+# purposes in Rails.
+module SweetNotifications
+  extend ControllerRuntime
+  extend Railtie
+
+  # Subscribe to an ActiveSupport::Notifications namespace.
+  #
+  # This will subscribe to the namespace given as argument and, if necessary,
+  # create a Rails initializer that will be run when the application is
+  # initialized.
+  #
+  # @param name [Symbol] event namespace
+  # @return [Rails::Railtie, ActiveSupport::LogSubscriber] An array consisting
+  #   of a Railtie and a LogSubscriber
+  # @yield event subscription
+  #
+  # ==== Examples
+  #
+  #  SweetNotifications.subscribe :active_record do
+  #    color ActiveSupport::LogSubscriber::GREEN
+  #    event :sql, runtime: true do |event|
+  #      return unless logger.debug?
+  #      debug message(event, event.payload[:name], event.payload[:sql])
+  #    end
+  #  end
+  def self.subscribe(name, &block)
+    log_subscriber = Class.new(SweetNotifications::LogSubscriber, &block)
+    controller_runtime = self.controller_runtime(name, log_subscriber)
+    if Rails.try(:application).try(:initialized?)
+      initialize_rails(name, log_subscriber, controller_runtime)
+      [nil, log_subscriber]
+    else
+      [railtie(name, log_subscriber, controller_runtime), log_subscriber]
+    end
+  end
+end

data/sweet_notifications.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sweet_notifications/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sweet_notifications"
+  spec.version       = SweetNotifications::VERSION
+  spec.authors       = ["Ville Lautanala"]
+  spec.email         = ["lautis@gmail.com"]
+  spec.summary       = %q{Syntactic sugar for ActiveSupport::LogSubscriber.}
+  spec.description   = %q{Syntactic sugar for ActiveSupport::LogSubscriber for easy instrumentation and logging from third-party libraries.}
+  spec.homepage      = "https://github.com/lautis/sweet_notifications"
+  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.0'
+
+  spec.add_runtime_dependency "activesupport", "~> 4.0"
+  spec.add_runtime_dependency "request_store", "~> 1.0"
+  spec.add_runtime_dependency "railties", "~> 4.0"
+  spec.add_development_dependency "actionpack", "~> 4.0"
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "rake", "~> 10.3"
+  spec.add_development_dependency "yard", "~> 0.8.7"
+  spec.add_development_dependency "appraisal", "~> 1.0"
+  spec.add_development_dependency "simplecov", "~> 0.8.2"
+  spec.add_development_dependency "rubocop", "~> 0.22.0"
+end

data/test/controller_runtime_test.rb

@@ -0,0 +1,88 @@
+require 'active_support/test_case'
+require 'active_support/log_subscriber'
+require 'active_support/log_subscriber/test_helper'
+require 'action_controller/log_subscriber'
+require 'action_controller'
+require 'test_helper'
+
+describe SweetNotifications::ControllerRuntime do
+  class TestLogSubscriber < SweetNotifications::LogSubscriber
+  end
+
+  ControllerRuntime = SweetNotifications.controller_runtime('Test',
+                                                            TestLogSubscriber)
+  ActionController::Base.send :include, ControllerRuntime
+
+  class LogSubscribersController < ActionController::Base
+    def create
+      TestLogSubscriber.runtime += 100
+      render text: '100'
+    end
+
+    def show
+      render text: '0'
+    end
+
+    def destroy
+      TestLogSubscriber.runtime += 50
+      render text: 'OK'
+      TestLogSubscriber.runtime += 5
+    end
+  end
+
+  include ActiveSupport::LogSubscriber::TestHelper
+  tests LogSubscribersController
+
+  before do
+    @old_logger = ActionController::Base.logger
+    ActionController::LogSubscriber.attach_to :action_controller
+  end
+
+  after do
+    ActiveSupport::LogSubscriber.log_subscribers.clear
+    ActionController::Base.logger = @old_logger
+  end
+
+  # rubocop:disable AccessorMethodName
+  def set_logger(logger)
+    ActionController::Base.logger = logger
+  end
+  # rubocop:enable AccessorMethodName
+
+  describe '.log_process_action' do
+    it 'emits runtime to log messages' do
+      out = LogSubscribersController.log_process_action(test_runtime: 1234)
+      assert_equal('Test: 1234.0ms', out[0])
+    end
+  end
+
+  describe 'runtime logging' do
+    it 'does not append runtime when it is 0' do
+      get :show, id: 1
+      wait
+      assert_no_match(/Test:/, @logger.logged(:info)[2])
+    end
+
+    it 'appends non-zero runtime' do
+      post :create, test: 1
+      wait
+      expected_message = /\(Views: [\d.]+ms \| Test: 100.0ms\)/
+      assert_match(expected_message, @logger.logged(:info)[2])
+    end
+
+    it 'resets runtime before request' do
+      TestLogSubscriber.runtime += 1000
+      post :create, test: 1
+      wait
+      expected_message = /\(Views: [\d.]+ms \| Test: 100.0ms\)/
+      assert_match(expected_message, @logger.logged(:info)[2])
+    end
+
+    it 'includes runtime after render' do
+      post :destroy, id: 1
+      wait
+      expected_message = /\(Views: [\d.]+ms \| Test: 55.0ms\)/
+      assert_match(expected_message, @logger.logged(:info)[2])
+    end
+  end
+end

data/test/log_subscriber_test.rb

@@ -0,0 +1,150 @@
+require 'test_helper'
+require 'active_support/log_subscriber/test_helper'
+
+describe SweetNotifications::LogSubscriber do
+  include ActiveSupport::LogSubscriber::TestHelper
+
+  def event(name: 'Test', duration: 1, transaction_id: SecureRandom.hex,
+            payload: {})
+    now = Time.now
+    ActiveSupport::Notifications::Event.new(name,
+                                            now,
+                                            now + duration,
+                                            transaction_id,
+                                            payload)
+  end
+
+  describe '.event' do
+    it 'creates event listener for event' do
+      class LogSubscriber < SweetNotifications::LogSubscriber
+        event :test
+      end
+      assert LogSubscriber.new.respond_to?(:test)
+    end
+
+    it 'proxies messages to Rails logger' do
+      class LoggingLogSubscriber < SweetNotifications::LogSubscriber
+        event :test_event do
+          debug 'test, 1-2-3'
+        end
+      end
+      log_subscriber = LoggingLogSubscriber.new
+      log_subscriber.test_event(event)
+      assert_equal ['test, 1-2-3'], @logger.logged(:debug)
+    end
+
+    it 'increments runtime when asked to' do
+      class RuntimeLogSubscriber < SweetNotifications::LogSubscriber
+        event :runtime_event, runtime: true
+        event :no_runtime_event, runtime: false
+      end
+
+      log_subscriber = RuntimeLogSubscriber.new
+      log_subscriber.runtime_event(event(duration: 5))
+      assert_equal 5000.0, RuntimeLogSubscriber.runtime
+      log_subscriber.no_runtime_event(event(duration: 10))
+      assert_equal 5000.0, RuntimeLogSubscriber.runtime
+    end
+
+    it 'does not log anything when not given block' do
+      class MuteLogSubscriber < SweetNotifications::LogSubscriber
+        event :mute_event, runtime: true
+      end
+      log_subscriber = MuteLogSubscriber.new
+      log_subscriber.mute_event(event(duration: 5))
+      assert_equal [], @logger.logged(:info)
+      assert_equal [], @logger.logged(:debug)
+    end
+
+    it 'listens to events when attached to a namespace' do
+      class AttachedLogSubscriber < SweetNotifications::LogSubscriber
+        event :important_stuff, runtime: true do
+          info 'received!'
+        end
+      end
+      AttachedLogSubscriber.attach_to :namespace
+      ActiveSupport::Notifications.instrument 'important_stuff.namespace' do
+        'OK'
+      end
+      assert_equal ['received!'], @logger.logged(:info)
+    end
+  end
+
+  describe '.runtime' do
+    it 'can be incremented' do
+      log_subscriber = Class.new(SweetNotifications::LogSubscriber)
+      assert_equal 0, log_subscriber.runtime
+      log_subscriber.runtime += 1.2
+      assert_equal 1.2, log_subscriber.runtime
+    end
+
+    it 'does not share runtime across subscribers' do
+      first = Class.new(SweetNotifications::LogSubscriber)
+      second = Class.new(SweetNotifications::LogSubscriber)
+
+      first.runtime += 100
+      second.runtime += 200
+      refute_equal first.runtime, second.runtime
+    end
+  end
+
+  describe '.reset_runtime' do
+    before :each do
+      @log_subscriber = Class.new(SweetNotifications::LogSubscriber)
+      @log_subscriber.runtime = 2000
+    end
+
+    it 'returns the current runtime' do
+      assert_equal 2000, @log_subscriber.reset_runtime
+    end
+
+    it 'sets the current runtime to 0' do
+      @log_subscriber.reset_runtime
+      assert_equal 0, @log_subscriber.runtime
+    end
+  end
+
+  describe '#message' do
+    class MessageLogSubscriber < SweetNotifications::LogSubscriber
+      color ActiveSupport::LogSubscriber::CYAN,
+            ActiveSupport::LogSubscriber::MAGENTA
+    end
+
+    subject { MessageLogSubscriber.new }
+
+    it 'uses given colors for title' do
+      subject.colorize_logging = true
+      odd = subject.message(event, 'Label', 'body')
+      even = subject.message(event, 'Label', 'body')
+      assert_match ActiveSupport::LogSubscriber::CYAN, odd
+      assert_match ActiveSupport::LogSubscriber::MAGENTA, even
+    end
+
+    it 'uses only one color when alternate color is not defined' do
+      subject = Class.new(SweetNotifications::LogSubscriber) do
+        color ActiveSupport::LogSubscriber::CYAN
+      end.new
+      subject.colorize_logging = true
+      assert_match(ActiveSupport::LogSubscriber::CYAN,
+                   subject.message(event, 'Label', 'body'))
+
+      assert_match(ActiveSupport::LogSubscriber::CYAN,
+                   subject.message(event, 'Label', 'body'))
+    end
+
+    it 'alternates between bold and normal body text' do
+      subject.colorize_logging = true
+      odd = subject.message(event, 'Label', 'body')
+      even = subject.message(event, 'Label', 'body')
+      assert !odd.include?(ActiveSupport::LogSubscriber::BOLD + 'body')
+      assert even.include?(ActiveSupport::LogSubscriber::BOLD + 'body')
+    end
+
+    it 'does not use colors when setting is disabled' do
+      subject.colorize_logging = false
+      message = subject.message(event, 'Label', 'body')
+      assert !message.include?(ActiveSupport::LogSubscriber::CYAN)
+    end
+
+  end
+end

data/test/railtie_test.rb

@@ -0,0 +1,32 @@
+require 'test_helper'
+
+describe SweetNotifications::Railtie do
+  it 'has a railtie name' do
+    railtie = SweetNotifications.railtie('test_railtie', nil, nil)
+    assert_equal 'test_railtie', railtie.railtie_name
+  end
+
+  describe 'initializer' do
+    it 'adds an initializer' do
+      railtie = SweetNotifications.railtie('log_subscriber', nil, nil)
+      assert_equal 1, railtie.initializers.length
+    end
+
+    it 'attaches log subscriber to namespace' do
+      mock = MiniTest::Mock.new
+      mock.expect :attach_to, true, [:log_subscriber]
+      railtie = SweetNotifications.railtie('log_subscriber', mock, Module.new)
+      railtie.run_initializers
+      assert mock.verify
+    end
+
+    it 'injects controller runtime to ActionController::Base' do
+      log_subscriber = Class.new(SweetNotifications::LogSubscriber)
+      runtime = SweetNotifications.controller_runtime('injection',
+                                                      log_subscriber)
+      railtie = SweetNotifications.railtie('test', log_subscriber, runtime)
+      railtie.run_initializers
+      assert_includes ActionController::Base.ancestors, runtime
+    end
+  end
+end

data/test/sweet_notifications_test.rb

@@ -0,0 +1,60 @@
+require 'test_helper'
+
+describe SweetNotifications do
+  include ActiveSupport::LogSubscriber::TestHelper
+
+  describe '.subscribe' do
+    it 'creates a railtie' do
+      railtie, _ = SweetNotifications.subscribe 'railtie_create' do
+      end
+      assert railtie < Rails::Railtie
+    end
+
+    it 'initializes a log subscriber' do
+      _, log_subscriber = SweetNotifications.subscribe 'subscriber_create' do
+        event :foo, runtime: true
+      end
+      assert log_subscriber < ActiveSupport::LogSubscriber
+      assert log_subscriber.new.public_methods(false).include?(:foo)
+    end
+
+    it 'binds log subscriber to notifications' do
+      railtie, _ = SweetNotifications.subscribe 'sweet' do
+        event :test do |event|
+          info message(event, 'Test', 'blah blah')
+        end
+      end
+
+      railtie.run_initializers
+      ActiveSupport::Notifications.instrument 'test.sweet' do
+        'ok'
+      end
+      assert_match(/Test \(\d\.\d{2}ms\)  blah blah/, @logger.logged(:info)[0])
+    end
+
+    it 'binds to current Rails app directly when the app is initialized' do
+      module ::Rails
+        def self.application
+          Struct.new(:initialized?).new(true)
+        end
+      end
+
+      railtie, _ = SweetNotifications.subscribe 'sweet' do
+        event :direct do |event|
+          info message(event, 'Direct', 'foo bar')
+        end
+      end
+
+      assert_equal nil, railtie
+      module ::Rails
+        class << self
+          undef application
+        end
+      end
+      ActiveSupport::Notifications.instrument 'direct.sweet' do
+        'ok'
+      end
+      assert_match(/Direct \(\d\.\d{2}ms\)  foo bar/, @logger.logged(:info)[0])
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,42 @@
+ENV['RAILS_ENV'] = 'test'
+require 'simplecov'
+
+SimpleCov.start do
+  add_filter 'test'
+  command_name 'Mintest'
+end
+
+require 'minitest/autorun'
+require 'minitest/spec'
+require 'minitest/pride'
+require 'sweet_notifications'
+require 'active_support/test_case'
+require 'securerandom'
+
+class ActiveSupport::TestCase
+  class << self
+    remove_method :describe
+  end
+
+  extend MiniTest::Spec::DSL
+  register_spec_type(/ControllerRuntime$/, ActionController::TestCase)
+  register_spec_type(self)
+end
+
+module ActionController
+  TestRoutes = ActionDispatch::Routing::RouteSet.new
+  TestRoutes.draw do
+    match ':controller(/:action)', via: [:all]
+  end
+
+  class Base
+    include ActionController::Testing
+    include TestRoutes.url_helpers
+  end
+
+  class ActionController::TestCase
+    setup do
+      @routes = TestRoutes
+    end
+  end
+end

metadata

@@ -0,0 +1,227 @@
+--- !ruby/object:Gem::Specification
+name: sweet_notifications
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ville Lautanala
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: request_store
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.22.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.22.0
+description: Syntactic sugar for ActiveSupport::LogSubscriber for easy instrumentation
+  and logging from third-party libraries.
+email:
+- lautis@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Appraisals
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- gemfiles/rails_4.0.gemfile
+- gemfiles/rails_4.1.gemfile
+- lib/sweet_notifications.rb
+- lib/sweet_notifications/controller_runtime.rb
+- lib/sweet_notifications/log_subscriber.rb
+- lib/sweet_notifications/railtie.rb
+- lib/sweet_notifications/version.rb
+- sweet_notifications.gemspec
+- test/controller_runtime_test.rb
+- test/log_subscriber_test.rb
+- test/railtie_test.rb
+- test/sweet_notifications_test.rb
+- test/test_helper.rb
+homepage: https://github.com/lautis/sweet_notifications
+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.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: Syntactic sugar for ActiveSupport::LogSubscriber.
+test_files:
+- test/controller_runtime_test.rb
+- test/log_subscriber_test.rb
+- test/railtie_test.rb
+- test/sweet_notifications_test.rb
+- test/test_helper.rb
+has_rdoc: