RubyGems - yarder - Versions diffs - 0.0.1 - Mend

yarder 0.0.1

Files changed (77) hide show

data/MIT-LICENSE +20 -0
data/README.md +87 -0
data/Rakefile +38 -0
data/lib/tasks/yarder_tasks.rake +4 -0
data/lib/yarder.rb +15 -0
data/lib/yarder/action_controller/log_subscriber.rb +74 -0
data/lib/yarder/action_view/log_subscriber.rb +31 -0
data/lib/yarder/active_record/log_subscriber.rb +75 -0
data/lib/yarder/active_resource/log_subscriber.rb +34 -0
data/lib/yarder/configuration.rb +8 -0
data/lib/yarder/core_ext/object/blank.rb +105 -0
data/lib/yarder/logger.rb +55 -0
data/lib/yarder/rack/logger.rb +72 -0
data/lib/yarder/railtie.rb +69 -0
data/lib/yarder/tagged_logging.rb +102 -0
data/lib/yarder/version.rb +3 -0
data/test/action_controller/log_subscriber_test.rb +165 -0
data/test/action_view/log_subscriber_test.rb +89 -0
data/test/active_record/log_subscriber_test.rb +87 -0
data/test/active_resource/log_subscriber_test.rb +42 -0
data/test/dummy/README.rdoc +261 -0
data/test/dummy/Rakefile +7 -0
data/test/dummy/app/assets/javascripts/application.js +13 -0
data/test/dummy/app/assets/javascripts/widgets.js +2 -0
data/test/dummy/app/assets/stylesheets/application.css +13 -0
data/test/dummy/app/assets/stylesheets/scaffold.css +56 -0
data/test/dummy/app/assets/stylesheets/widgets.css +4 -0
data/test/dummy/app/controllers/application_controller.rb +3 -0
data/test/dummy/app/controllers/log_subscriber_controller.rb +56 -0
data/test/dummy/app/controllers/widgets_controller.rb +83 -0
data/test/dummy/app/helpers/application_helper.rb +2 -0
data/test/dummy/app/helpers/widgets_helper.rb +2 -0
data/test/dummy/app/models/widget.rb +3 -0
data/test/dummy/app/views/customers/_customer.html.erb +1 -0
data/test/dummy/app/views/good_customers/_good_customer.html.erb +1 -0
data/test/dummy/app/views/layouts/application.html.erb +14 -0
data/test/dummy/app/views/test/_customer.erb +1 -0
data/test/dummy/app/views/test/hello_world.erb +1 -0
data/test/dummy/app/views/widgets/_form.html.erb +17 -0
data/test/dummy/app/views/widgets/edit.html.erb +6 -0
data/test/dummy/app/views/widgets/index.html.erb +21 -0
data/test/dummy/app/views/widgets/new.html.erb +5 -0
data/test/dummy/app/views/widgets/show.html.erb +5 -0
data/test/dummy/config.ru +4 -0
data/test/dummy/config/application.rb +69 -0
data/test/dummy/config/boot.rb +10 -0
data/test/dummy/config/database.yml +22 -0
data/test/dummy/config/environment.rb +5 -0
data/test/dummy/config/environments/development.rb +31 -0
data/test/dummy/config/environments/production.rb +64 -0
data/test/dummy/config/environments/test.rb +35 -0
data/test/dummy/config/initializers/backtrace_silencers.rb +7 -0
data/test/dummy/config/initializers/inflections.rb +15 -0
data/test/dummy/config/initializers/mime_types.rb +5 -0
data/test/dummy/config/initializers/secret_token.rb +7 -0
data/test/dummy/config/initializers/session_store.rb +8 -0
data/test/dummy/config/initializers/wrap_parameters.rb +10 -0
data/test/dummy/config/locales/en.yml +5 -0
data/test/dummy/config/routes.rb +69 -0
data/test/dummy/db/migrate/20120927084605_create_widgets.rb +8 -0
data/test/dummy/db/schema.rb +16 -0
data/test/dummy/log/development.log +19 -0
data/test/dummy/log/test.log +10694 -0
data/test/dummy/public/404.html +26 -0
data/test/dummy/public/422.html +26 -0
data/test/dummy/public/500.html +25 -0
data/test/dummy/public/favicon.ico +0 -0
data/test/dummy/script/rails +6 -0
data/test/logger_test.rb +126 -0
data/test/rack/logger_test.rb +68 -0
data/test/support/fake_models.rb +12 -0
data/test/support/integration_case.rb +5 -0
data/test/support/multibyte_test_helpers.rb +19 -0
data/test/tagged_logging_test.rb +155 -0
data/test/test_helper.rb +31 -0
data/test/yarder_test.rb +7 -0
metadata +236 -0

data/test/dummy/public/404.html ADDED Viewed

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The page you were looking for doesn't exist (404)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/404.html -->
+  <div class="dialog">
+    <h1>The page you were looking for doesn't exist.</h1>
+    <p>You may have mistyped the address or the page may have moved.</p>
+  </div>
+</body>
+</html>

data/test/dummy/public/422.html ADDED Viewed

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The change you wanted was rejected (422)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/422.html -->
+  <div class="dialog">
+    <h1>The change you wanted was rejected.</h1>
+    <p>Maybe you tried to change something you didn't have access to.</p>
+  </div>
+</body>
+</html>

data/test/dummy/public/500.html ADDED Viewed

@@ -0,0 +1,25 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>We're sorry, but something went wrong (500)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/500.html -->
+  <div class="dialog">
+    <h1>We're sorry, but something went wrong.</h1>
+  </div>
+</body>
+</html>

data/test/dummy/public/favicon.ico ADDED Viewed

File without changes

data/test/dummy/script/rails ADDED Viewed

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require File.expand_path('../../config/boot',  __FILE__)
+require 'rails/commands'

data/test/logger_test.rb ADDED Viewed

@@ -0,0 +1,126 @@
+require 'stringio'
+require 'fileutils'
+require 'tempfile'
+require 'test_helper'
+class BufferedLoggerTest < ActiveSupport::TestCase
+  include MultibyteTestHelpers
+  Logger = Yarder::Logger
+  def setup
+    @message = "A debug message"
+    @integer_message = 12345
+    @output = StringIO.new
+    @logger = Logger.new(@output)
+  end
+  def test_write_binary_data_to_existing_file
+    t = Tempfile.new ['development', 'log']
+    t.binmode
+    t.write 'hi mom!'
+    t.close
+    f = File.open(t.path, 'w')
+    f.binmode
+    logger = Logger.new f
+    logger.level = Logger::DEBUG
+    str = "\x80"
+    str.force_encoding("ASCII-8BIT")
+    logger.add Logger::DEBUG, str
+  ensure
+    logger.close
+    t.close true
+  end
+  def test_write_binary_data_create_file
+    fname = File.join Dir.tmpdir, 'lol', 'rofl.log'
+    FileUtils.mkdir_p File.dirname(fname)
+    f = File.open(fname, 'w')
+    f.binmode
+    logger = Logger.new f
+    logger.level = Logger::DEBUG
+    str = "\x80"
+    str.force_encoding("ASCII-8BIT")
+    logger.add Logger::DEBUG, str
+  ensure
+    logger.close
+    File.unlink fname
+  end
+  def test_should_log_debugging_message_when_debugging
+    @logger.level = Logger::DEBUG
+    @logger.add(Logger::DEBUG, @message)
+    assert @output.string.include?(@message)
+  end
+  def test_should_not_log_debug_messages_when_log_level_is_info
+    @logger.level = Logger::INFO
+    @logger.add(Logger::DEBUG, @message)
+    assert ! @output.string.include?(@message)
+  end
+  def test_should_add_message_passed_as_block_when_using_add
+    @logger.level = Logger::INFO
+    @logger.add(Logger::INFO) {@message}
+    assert @output.string.include?(@message)
+  end
+  def test_should_add_message_passed_as_block_when_using_shortcut
+    @logger.level = Logger::INFO
+    @logger.info {@message}
+    assert @output.string.include?(@message)
+  end
+  def test_should_convert_message_to_string
+    @logger.level = Logger::INFO
+    @logger.info @integer_message
+    assert @output.string.include?(@integer_message.to_s)
+  end
+  def test_should_convert_message_to_string_when_passed_in_block
+    @logger.level = Logger::INFO
+    @logger.info {@integer_message}
+    assert @output.string.include?(@integer_message.to_s)
+  end
+  def test_should_not_evaluate_block_if_message_wont_be_logged
+    @logger.level = Logger::INFO
+    evaluated = false
+    @logger.add(Logger::DEBUG) {evaluated = true}
+    assert evaluated == false
+  end
+  def test_should_not_mutate_message
+    message_copy = @message.dup
+    @logger.info @message
+    assert_equal message_copy, @message
+  end
+  def test_should_know_if_its_loglevel_is_below_a_given_level
+    Logger::Severity.constants.each do |level|
+      next if level.to_s == 'UNKNOWN'
+      @logger.level = Logger::Severity.const_get(level) - 1
+      assert @logger.send("#{level.downcase}?"), "didn't know if it was #{level.downcase}? or below"
+    end
+  end
+  # This test will fail on JRuby versions lower than 1.7 due to UTF-8 Encoding issues
+  # so only run on MRI and JRuby 1.7 and later
+  unless defined?(JRUBY_VERSION) && JRUBY_VERSION.to_f < 1.7
+    def test_buffer_multibyte
+      @logger.info(UNICODE_STRING)
+      @logger.info(BYTE_STRING)
+      assert @output.string.include?(UNICODE_STRING)
+      byte_string = @output.string.dup
+      byte_string.force_encoding("ASCII-8BIT")
+      assert byte_string.include?(BYTE_STRING)
+    end
+  end
+end

data/test/rack/logger_test.rb ADDED Viewed

@@ -0,0 +1,68 @@
+require 'test_helper'
+# TODO These tests are fragile because they rely on the output being added
+# to the last line of the log file. See if there is a better way to do this
+class LoggerTest < ActiveSupport::IntegrationCase
+  class MyLogger < Yarder::Logger
+    def flush(*)
+    end
+  end
+  setup do
+    @output = StringIO.new
+    Rails.logger = Yarder::TaggedLogging.new(MyLogger.new(@output))
+    visit('/widgets')
+  end
+  test 'writes a hash to the log file when a request is received' do
+    assert_equal Hash, entry.class
+  end
+  test 'fills in the client_ip' do
+    assert_equal "127.0.0.1", entry['@fields']['client_ip']
+  end
+  test 'fills in the method' do
+    assert_equal "GET", entry['@fields']['method']
+  end
+  test 'fills in the path' do
+    assert_equal "/widgets", entry['@fields']['path']
+  end
+  test 'fills in the status' do
+    assert_equal "/widgets", entry['@fields']['path']
+  end
+  test 'fills in the total_duration' do
+    assert entry['@fields']['total_duration'].to_f >= 0, "total_duration was not a positive number"
+  end
+  test 'fills in the rendering_duration' do
+    assert entry['@fields']['rendering_duration'].to_f >= 0, "rendering_duration was not a positive number"
+  end
+  test 'fills in the sql_duration' do
+    assert entry['@fields']['rendering_duration'].to_f >= 0, "sql_duration was not a positive number"
+  end
+  test 'fills in the method name tag' do
+    assert_equal 32, entry['@fields']['uuid'].size
+  end
+  test 'fills in the string tag' do
+    assert_match "Hello", entry['@tags'].first
+  end
+  test 'fills in the proc tag' do
+    assert_match "Proc", entry['@tags'].last
+  end
+  #TODO Add tests for view and SQL rendering summaries
+  def entry
+    JSON.parse(@output.string)
+  end
+end

data/test/support/fake_models.rb ADDED Viewed

@@ -0,0 +1,12 @@
+require "active_model"
+class Customer < Struct.new(:name, :id)
+  extend ActiveModel::Naming
+  include ActiveModel::Conversion
+end
+class BadCustomer < Customer
+end
+class GoodCustomer < Customer
+end

data/test/support/integration_case.rb ADDED Viewed

@@ -0,0 +1,5 @@
+# Define a bare test case to use with Capybara
+class ActiveSupport::IntegrationCase < ActiveSupport::TestCase
+  include Capybara::DSL
+  include Rails.application.routes.url_helpers
+end

data/test/support/multibyte_test_helpers.rb ADDED Viewed

@@ -0,0 +1,19 @@
+# encoding: utf-8
+module MultibyteTestHelpers
+  UNICODE_STRING = 'こにちわ'
+  ASCII_STRING = 'ohayo'
+  BYTE_STRING = "\270\236\010\210\245".force_encoding("ASCII-8BIT")
+  def chars(str)
+    ActiveSupport::Multibyte::Chars.new(str)
+  end
+  def inspect_codepoints(str)
+    str.to_s.unpack("U*").map{|cp| cp.to_s(16) }.join(' ')
+  end
+  def assert_equal_codepoints(expected, actual, message=nil)
+    assert_equal(inspect_codepoints(expected), inspect_codepoints(actual), message)
+  end
+end

data/test/tagged_logging_test.rb ADDED Viewed

@@ -0,0 +1,155 @@
+require 'yarder/logger'
+require 'yarder/tagged_logging'
+class TaggedLoggingTest < ActiveSupport::TestCase
+  class MyLogger < Yarder::Logger
+  end
+  setup do
+    @output = StringIO.new
+    @logger = Yarder::TaggedLogging.new(MyLogger.new(@output))
+  end
+  test 'sets logger.formatter if missing and extends it with a tagging API' do
+    logger = ::Logger.new(StringIO.new)
+    # assert_nil logger.formatter #TODO This assertion is failing but I do not think it is end of the world
+    Yarder::TaggedLogging.new(logger)
+    assert_not_nil logger.formatter
+    assert logger.formatter.respond_to?(:tagged)
+  end
+  test 'fills in the severity' do
+    @logger.info "Severity Test"
+    assert_equal "INFO", JSON.parse(@output.string)['@fields']['severity']
+  end
+  test "tagged once" do
+    @logger.tagged("BCX") { @logger.info "Funky time" }
+    assert_equal "BCX", JSON.parse(@output.string)['@tags'][0]
+    assert_equal "Funky time", JSON.parse(@output.string)['@message']
+  end
+  test "tagged twice" do
+    @logger.tagged("BCX") { @logger.tagged("Jason") { @logger.info "Funky time" } }
+    assert_equal "BCX", JSON.parse(@output.string)['@tags'][0]
+    assert_equal "Jason", JSON.parse(@output.string)['@tags'][1]
+  end
+  test "tagged thrice at once" do
+    @logger.tagged("BCX", "Jason", "New") { @logger.info "Funky time" }
+    assert_equal "BCX", JSON.parse(@output.string)['@tags'][0]
+    assert_equal "Jason", JSON.parse(@output.string)['@tags'][1]
+    assert_equal "New", JSON.parse(@output.string)['@tags'][2]
+  end
+  test "tagged are flattened" do
+    @logger.tagged("BCX", %w(Jason New)) { @logger.info "Funky time" }
+    assert_equal "BCX", JSON.parse(@output.string)['@tags'][0]
+    assert_equal "Jason", JSON.parse(@output.string)['@tags'][1]
+    assert_equal "New", JSON.parse(@output.string)['@tags'][2]
+  end
+  test "push and pop tags directly" do
+    assert_equal %w(A B C), @logger.push_tags('A', ['B', ' ', ['C']])
+    @logger.info 'a'
+    assert_equal %w(C), @logger.pop_tags
+    @logger.info 'b'
+    assert_equal %w(B), @logger.pop_tags(1)
+    @logger.info 'c'
+    assert_equal [], @logger.clear_tags!
+    @logger.info 'd'
+   # assert_equal "[A] [B] [C] a\n[A] [B] b\n[A] c\nd\n",  JSON.parse(@output.string)['@tags']
+    first_log = JSON.parse(@output.string.split("\n")[0])
+    assert_equal "A", first_log['@tags'][0]
+    assert_equal "B", first_log['@tags'][1]
+    assert_equal "C", first_log['@tags'][2]
+    assert_equal "a", first_log['@message']
+    second_log = JSON.parse(@output.string.split("\n")[1])
+    assert_equal "A", second_log['@tags'][0]
+    assert_equal "B", second_log['@tags'][1]
+    assert_equal "b", second_log['@message']
+    third_log = JSON.parse(@output.string.split("\n")[2])
+    assert_equal "A", third_log['@tags'][0]
+    assert_equal "c", third_log['@message']
+    fourth_log = JSON.parse(@output.string.split("\n")[3])
+    assert fourth_log['@tags'].empty?
+    assert_equal "d", fourth_log['@message']
+  end
+  test "does not strip message content" do
+    @logger.info " Hello"
+    assert_equal " Hello", JSON.parse(@output.string)['@message']
+  end
+  test "provides access to the logger instance" do
+    @logger.tagged("BCX") { |logger| logger.info "Funky time" }
+    assert_equal "BCX", JSON.parse(@output.string)['@tags'][0]
+    assert_equal "Funky time", JSON.parse(@output.string)['@message']
+  end
+  test "tagged once with blank and nil" do
+    @logger.tagged(nil, "", "New") { @logger.info "Funky time" }
+    assert_equal "New", JSON.parse(@output.string)['@tags'].last
+  end
+  test "keeps each tag in their own thread" do
+    @logger.tagged("BCX") do
+      Thread.new do
+        @logger.tagged("OMG") { @logger.info "Cool story bro" }
+      end.join
+      @logger.info "Funky time"
+    end
+    # Sub-thread
+    main_thread = JSON.parse(@output.string.split("\n").first)
+    assert_equal "OMG", main_thread['@tags'][0]
+    assert_equal "Cool story bro", main_thread['@message']
+    # Main thread
+    main_thread = JSON.parse(@output.string.split("\n").last)
+    assert_equal "BCX", main_thread['@tags'][0]
+    assert_equal "Funky time", main_thread['@message']
+  end
+  test "cleans up the taggings on flush" do
+    @logger.tagged("BCX") do
+      Thread.new do
+        @logger.tagged("OMG") do
+          @logger.flush
+          @logger.info "Cool story bro"
+        end
+      end.join
+    end
+    first_log = JSON.parse(@output.string.split("\n").first)
+    assert first_log['@tags'].empty?
+    assert_equal "Cool story bro", first_log['@message']
+  end
+  test "mixed levels of tagging" do
+    @logger.tagged("BCX") do
+      @logger.tagged("Jason") { @logger.info "Funky time" }
+      @logger.info "Junky time!"
+    end
+    first_log = JSON.parse(@output.string.split("\n").first)
+    assert_equal "BCX", first_log['@tags'][0]
+    assert_equal "Jason", first_log['@tags'][1]
+    assert_equal "Funky time", first_log['@message']
+    second_log = JSON.parse(@output.string.split("\n").last)
+    assert_equal "BCX", second_log['@tags'][0]
+    assert_equal "Junky time!", second_log['@message']
+  end
+end