mmcgrana-scrolls 0.0.6

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 scrolls.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright © Heroku 2012
+
+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,50 @@
+# Scrolls
+
+Logging gem, compiled from many different internal projects in order to make
+it easier to add logging to projects. Basically I grew tired of moving this
+file around.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'scrolls'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install scrolls
+
+## Usage
+
+It's pretty easy to use:
+
+    require 'scrolls'
+
+Put this somewhere early on in your application:
+
+    Scrolls::Log.start
+
+Use it:
+
+    Scrolls.log(:testing => true, :at => "readme")
+
+## Thanks
+
+I only compiled this library, many others made it work. Here are some of the
+authors of projects that I've used to get an idea of a consistent log gem:
+
+* Mark McGranaghan
+* Noah Zoschke
+* Mark Fine
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/scrolls/version.rb

@@ -0,0 +1,3 @@
+module Scrolls
+  VERSION = "0.0.6"
+end

data/lib/scrolls.rb

@@ -0,0 +1,110 @@
+require "thread"
+
+require "scrolls/version"
+
+module Scrolls
+  extend self
+
+  def log(data, &blk)
+    Log.log(data, &blk)
+  end
+
+  def log_exception(data, e)
+    Log.log_exception(data, e)
+  end
+
+  module Log
+    extend self
+
+    attr_accessor :stream
+
+    def start(out = nil)
+      # This allows log_exceptions below to pick up the defined output,
+      # otherwise stream out to STDERR
+      @defined = out.nil? ? false : true
+      sync_stream(out)
+      log(:log => true, :start => true)
+    end
+
+    def sync_stream(out = nil)
+      out = STDOUT if out.nil?
+      @stream = out
+      @stream.sync = true
+    end
+
+    def mtx
+      @mtx ||= Mutex.new
+    end
+
+    def write(data)
+      msg = unparse(data)
+      mtx.synchronize do
+        @stream.puts(msg)
+      end
+    end
+
+    def unparse(data)
+      data.map do |(k, v)|
+        if (v == true)
+          k.to_s
+        elsif v.is_a?(Float)
+          "#{k}=#{format("%.3f", v)}"
+        elsif v.nil?
+          nil
+        else
+          v_str = v.to_s
+          if (v_str =~ /^[a-zA-z0-9\-\_\.]+$/)
+            "#{k}=#{v_str}"
+          else
+            "#{k}=\"#{v_str.sub(/".*/, "...")}\""
+          end
+        end
+      end.compact.join(" ")
+    end
+
+    def log(data, &blk)
+      unless blk
+        write(data)
+      else
+        start = Time.now
+        res = nil
+        log(data.merge(:at => :start))
+        begin
+          res = yield
+        rescue StandardError, Timeout::Error => e
+          log(data.merge(
+            :at           => :exception,
+            :reraise      => true,
+            :class        => e.class,
+            :message      => e.message,
+            :exception_id => e.object_id.abs,
+            :elapsed      => Time.now - start
+          ))
+          raise(e)
+        end
+        log(data.merge(:at => :finish, :elapsed => Time.now - start))
+        res
+      end
+    end
+
+    def log_exception(data, e)
+      sync_stream(STDERR) unless @defined
+      log(data.merge(
+        :exception    => true,
+        :class        => e.class,
+        :message      => e.message,
+        :exception_id => e.object_id.abs
+      ))
+      if e.backtrace
+        bt = e.backtrace.reverse
+        bt[0, bt.size-6].each do |line|
+          log(data.merge(
+            :exception    => true,
+            :exception_id => e.object_id.abs,
+            :site         => line.gsub(/[`'"]/, "")
+          ))
+        end
+      end
+    end
+  end
+end

data/scrolls.gemspec

@@ -0,0 +1,16 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/scrolls/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Heroku"]
+  gem.email         = ["curt@heroku.com"]
+  gem.description   = "Logging, easier, more consistent."
+  gem.summary       = "When do we log? All the time."
+  gem.homepage      = "https://github.com/asenchi/scrolls"
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "mmcgrana-scrolls"
+  gem.require_paths = ["lib"]
+  gem.version       = Scrolls::VERSION
+end

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: mmcgrana-scrolls
+version: !ruby/object:Gem::Version
+  version: 0.0.6
+  prerelease: 
+platform: ruby
+authors:
+- Heroku
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-01 00:00:00.000000000 Z
+dependencies: []
+description: Logging, easier, more consistent.
+email:
+- curt@heroku.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/scrolls.rb
+- lib/scrolls/version.rb
+- scrolls.gemspec
+homepage: https://github.com/asenchi/scrolls
+licenses: []
+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.21
+signing_key: 
+specification_version: 3
+summary: When do we log? All the time.
+test_files: []