chrome_logger 0.1.0

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,11 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'rack' # to run the example rackup file
+end
+
+group :test do
+  gem 'pry' # 'cause you're going to want it anyway
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Ryan Cook
+
+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,43 @@
+# ChromeLogger
+
+A Ruby library that implements the [Chrome Logger](http://craig.is/writing/chrome-logger) specification as Rack middleware.
+
+See [the example](https://github.com/cookrn/chrome_logger/blob/master/example/config.ru).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'chrome_logger'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install chrome_logger
+
+## Installation on Rails
+
+You probably only want it in certain environments. For `development`, add the following to your `development` group in your `Gemfile`:
+
+    gem 'chrome_logger' , :require => 'chrome_logger/railtie'
+
+## Usage
+
+`env['console']` -- That's all she wrote!
+
+It's just Rack middleware. Check out `example/config.ru`.
+
+## 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
+
+## License
+
+MIT

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+desc "Run the Tests"
+Rake::TestTask.new( :test ) do | t |
+  t.libs    << [ "test" ]
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = true
+end
+
+task :default => :test

data/chrome_logger.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'chrome_logger/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'chrome_logger'
+  spec.version       = ChromeLogger::VERSION
+  spec.authors       = ['Ryan Cook']
+  spec.email         = ['cookrn@gmail.com']
+  spec.description   = %q{Ruby library that implements the ChromeLogger spec on Rack}
+  spec.summary       = %Q{#{ spec.name } v#{ spec.version }}
+  spec.homepage      = 'https://github.com/cookrn/chrome_logger-ruby'
+  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 'multi_json' , '>= 1.3.0'
+
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'rake'
+end

data/example/config.ru

@@ -0,0 +1,26 @@
+require 'chrome_logger'
+use ChromeLogger
+
+app = lambda do | env |
+  env['console'].group 'BIG GROUP'
+  env['console'].log 'hi' , 'there'
+  env['console'].log [ 'now' , 'what' ]
+  env['console'].log( { :key => 1234 } )
+  env['console'].group_end
+
+  # Optionally use either signature
+  env['console'].groupCollapsed 'ANOTHER BIG GROUP'
+  # env['console'].group_collapsed 'ANOTHER BIG GROUP'
+
+  env['console'].log 'yet' , 'again'
+  env['console'].log [ 'wut' , 'wut' ]
+  env['console'].log( { :key => 7890 } )
+
+  # Optionally use other signature
+  env['console'].groupEnd
+  # env['console'].group_end
+
+  [ 200 , {} , [] ]
+end
+
+run app

data/lib/chrome_logger/console.rb

@@ -0,0 +1,49 @@
+class ChromeLogger
+  class Console
+    attr_reader :log_items
+
+    def self.logger_for( *kinds )
+      kinds.each do | kind |
+        class_eval <<-___
+          def #{ kind }( *args )
+            add_log_items '#{ kind }' , *args
+          end
+        ___
+      end
+    end
+
+    def initialize
+      @log_items = []
+    end
+
+    def add_log_items( level , *args )
+      backtrace = caller[ 1 ] # 2 up!
+      item = [ args , backtrace , level ]
+      @log_items << item
+    end
+
+    def data
+      {
+        'version' => ChromeLogger::VERSION,
+        'columns' => [ 'log' , 'backtrace' , 'type' ],
+        'rows'    => log_items
+      }
+    end
+
+    logger_for \
+      :error,
+      :group,
+      :groupCollapsed,
+      :groupEnd,
+      :info,
+      :warn
+
+    alias_method :group_collapsed , :groupCollapsed
+    alias_method :group_end , :groupEnd
+
+    # custom to let chrome plugin decide default
+    def log( *args )
+      add_log_items '' , *args
+    end
+  end
+end

data/lib/chrome_logger/railtie.rb

@@ -0,0 +1,10 @@
+require 'chrome_logger'
+require 'rails/railtie'
+
+class ChromeLogger
+  class Railtie < ::Rails::Railtie
+    initializer 'chrome_logger.rails_initialization' do | app |
+      app.config.middleware.use ChromeLogger
+    end
+  end
+end

data/lib/chrome_logger/serializer.rb

@@ -0,0 +1,33 @@
+require 'base64'
+require 'multi_json'
+
+class ChromeLogger
+  class Serializer
+    attr_reader :console
+
+    def self.serialize( console )
+      serializer = new console
+      serializer.serialize
+    end
+
+    def initialize( console )
+      @console = console
+    end
+
+    def serialize
+      to_base64 to_utf8( to_json console.data )
+    end
+
+    def to_base64( utf8_encoded_json )
+      Base64.encode64 utf8_encoded_json
+    end
+
+    def to_json( data )
+      MultiJson.dump data
+    end
+
+    def to_utf8( json )
+      json.encode 'UTF-8'
+    end
+  end
+end

data/lib/chrome_logger/version.rb

@@ -0,0 +1,3 @@
+class ChromeLogger
+  VERSION = "0.1.0"
+end

data/lib/chrome_logger.rb

@@ -0,0 +1,30 @@
+require 'chrome_logger/console'
+require 'chrome_logger/serializer'
+require 'chrome_logger/version'
+
+class ChromeLogger
+  attr_accessor :app
+
+  DEFAULT_ENV_NAME = 'console'
+  HEADER = 'X-ChromeLogger-Data'
+
+  class << self
+    attr_accessor :env_name
+  end
+  @env_name ||= DEFAULT_ENV_NAME
+
+  def initialize( app )
+    @app = app
+  end
+
+  def call( env )
+    env[ env_name ] = Console.new
+    status , headers , response = app.call env
+    headers[ HEADER ] = Serializer.serialize env[ env_name ]
+    [ status , headers , response ]
+  end
+
+  def env_name
+    self.class.env_name
+  end
+end

data/test/chrome_logger/console_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class ChromeLogger::ConsoleTest < MiniTest::Unit::TestCase
+  def test_something
+    skip
+  end
+end

data/test/chrome_logger/serializer_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class ChromeLogger::SerializerTest < MiniTest::Unit::TestCase
+  def test_something
+    skip
+  end
+end

data/test/chrome_logger_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class ChromeLoggerTest < MiniTest::Unit::TestCase
+  def test_something
+    skip
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,14 @@
+begin
+  require 'pry'
+rescue LoadError
+end
+
+gem 'minitest'
+
+%w(
+  autorun
+  hell
+  pride
+).each { | lib | require "minitest/#{ lib }" }
+
+require 'chrome_logger'

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: chrome_logger
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Ryan Cook
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: &70225244585900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70225244585900
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &70225244584980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70225244584980
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70225244583980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70225244583980
+description: Ruby library that implements the ChromeLogger spec on Rack
+email:
+- cookrn@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- chrome_logger.gemspec
+- example/config.ru
+- lib/chrome_logger.rb
+- lib/chrome_logger/console.rb
+- lib/chrome_logger/railtie.rb
+- lib/chrome_logger/serializer.rb
+- lib/chrome_logger/version.rb
+- test/chrome_logger/console_test.rb
+- test/chrome_logger/serializer_test.rb
+- test/chrome_logger_test.rb
+- test/test_helper.rb
+homepage: https://github.com/cookrn/chrome_logger-ruby
+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.16
+signing_key: 
+specification_version: 3
+summary: chrome_logger v0.1.0
+test_files:
+- test/chrome_logger/console_test.rb
+- test/chrome_logger/serializer_test.rb
+- test/chrome_logger_test.rb
+- test/test_helper.rb