rack-json-logs 1.0 → 1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 15003ab04d1540237ac9c0ad90b88bfc6fac75d3
+  data.tar.gz: 3065e8f738bd77fe534fbca3db4eac7c62d8d77b
+SHA512:
+  metadata.gz: ba81cc889443d56fcc2ba7edc2e8ffd6d78f31ce4a746f3e70031e28ae375d3e31dff7cd6bd79df9a6b29a7ce857deaeb560c683f9daf48551aadb211ca6f4cb
+  data.tar.gz: 43aa158a1cf918fa32fb603a7e9f478d1d7a8736cc71bcb060d372ee95196c9817277c3d3000014c5c42d2834ff9aa4ca8f499c16bdbf91dd7ec2518e21a7510

data/README.md

@@ -121,6 +121,11 @@ Using the command line tool is also easy. Output can be configured, see:
 
 ## Changelog
 
+#### 1.1
+
+- New feature: can pretty print from middleware, for development usage.
+- Refactoring of binary pretty print code into library.
+
 #### 1.0
 
 Production release. Deployed and used in a large-scale system.

data/bin/json-log-pp

@@ -1,9 +1,8 @@
 #!/usr/bin/env ruby
 
 require 'json'
-require 'colorize'
-require 'stringio'
 require 'trollop'
+require File.expand_path('../../lib/rack-json-logs/pretty-printer.rb', __FILE__)
 
 opts = Trollop.options do
   opt :stdout, 'Print stdout.', default: false, short: 'o'
@@ -27,64 +26,12 @@ while line = STDIN.gets
 
   json = json['data'] if json && json['data']
 
+  # only pretty print valid objects
   if json && json.is_a?(Hash) && json['request']
-
-    out = StringIO.new
-
-    status_color = case json['status']
-                   when 200...300; :green
-                   when 300...600; :red
-                   else :cyan; end
-
-
-    resp = 'Response: '
-    resp << "#{json['status']} " if json['status']
-    resp << "(#{(json['duration']*1000).round}ms) " if opts[:duration] && json['duration']
-
-    out.puts '     * * *'
-    out.puts
-    out.puts "Request: #{json['request']}".cyan
-    out.puts resp.send(status_color)
-    out.puts "From: #{json['from']}".cyan if opts[:from] && json['from']
-    out.puts "At: #{Time.at(json['time']).strftime('%b %-e %Y, %-l:%M%P')}"
-    out.puts
-    
-    %w{stdout stderr}.each do |b|
-      next unless opts[b.to_sym]
-      color = b == 'stdout' ? :green : :yellow
-      log = json[b] || ''
-      if log == '' || log == "\n"
-        out.puts "No #{b}.".send(color)
-      else
-        out.puts "#{b}:".cyan
-        out.puts log.send(color)
-      end
-      # Typically log statements start end with a \n, so skiping puts here.
-    end
-
-    if opts[:events] && json['events'] && !json['events'].empty?
-      out.puts 'Events:'.cyan
-      out.puts
-      json['events'].each do |e|
-        out.puts "Event: #{e['type']}"
-        out.puts "At: #{(e['time']*1000).round}ms"
-        out.puts "Value: #{e['value'].to_json}"
-        out.puts
-      end
-    end
-
-    if json['exception']
-      out.puts "Exception: #{json['exception']['message']}".red
-      out.puts json['exception']['backtrace'].map {|e| "  #{e}"}.join("\n").blue if opts[:trace]
-      out.puts
-    end
-
-    STDOUT.print(out.string)
-
+    Rack::JsonLogs.pretty_print(json, STDOUT, opts)
   else
     puts line
   end
-
 end
 
 puts "\nEOF.".red

data/lib/rack-json-logs.rb

@@ -1,4 +1,5 @@
 require 'rack-json-logs/version'
+require 'rack-json-logs/pretty-printer.rb'
 require 'json'
 require 'stringio'
 require 'socket'
@@ -21,12 +22,24 @@ module Rack
   #     for example, you want to log which server the request is from. Defaults
   #     to the machine's hostname.
   #
+  #   :pretty_print
+  #
+  #     When set to true, this will pretty-print the logs, instead of printing
+  #     the json. This is useful in development.
+  #
+  #   :print_options
+  #
+  #     When :pretty_print is set to true, these options will be passed to the
+  #     pretty-printer. Run `json-logs-pp -h` to see what the options are.
+  #
   class JsonLogs
 
     def initialize(app, options={})
       @app = app
       @options = {
-        reraise_exceptions: false
+        reraise_exceptions: false,
+        pretty_print: false,
+        print_options: {trace: true},
       }.merge(options)
       @options[:from] ||= Socket.gethostname
     end
@@ -64,7 +77,13 @@ module Rack
           backtrace: exception.backtrace
         }
       end
-      STDOUT.puts(log.to_json)
+
+      if @options[:pretty_print]
+        JsonLogs.pretty_print(JSON.parse(log.to_json),
+                              STDOUT, @options[:print_options])
+      else
+        STDOUT.puts(log.to_json)
+      end
 
       raise exception if exception && @options[:reraise_exceptions]
 

data/lib/rack-json-logs/pretty-printer.rb

@@ -0,0 +1,77 @@
+require 'colorize'
+require 'stringio'
+
+module Rack
+  class JsonLogs
+
+    def self.pretty_print(json, print_to = STDOUT, opts = {})
+
+      opts = {
+        stdout: false,
+        stderr: false,
+        from: true,
+        trace: false,
+        duration: true,
+        events: false,
+      }.merge(opts)
+
+      out = StringIO.new
+
+      status_color = case json['status']
+                     when 200...300; :green
+                     when 300...600; :red
+                     else :cyan; end
+
+
+      resp = 'Response: '
+      resp << "#{json['status']} " if json['status']
+      if opts[:duration] && json['duration']
+        resp << "(#{(json['duration']*1000).round}ms) "
+      end
+
+      out.puts '     * * *'
+      out.puts
+      out.puts "Request: #{json['request']}".cyan
+      out.puts resp.send(status_color)
+      out.puts "From: #{json['from']}".cyan if opts[:from] && json['from']
+      out.puts "At: #{Time.at(json['time']).strftime('%b %-e %Y, %-l:%M%P')}"
+      out.puts
+
+      %w{stdout stderr}.each do |b|
+        next unless opts[b.to_sym]
+        color = b == 'stdout' ? :green : :yellow
+        log = json[b] || ''
+        if log == '' || log == "\n"
+          out.puts "No #{b}.".send(color)
+        else
+          out.puts "#{b}:".cyan
+          out.puts log.send(color)
+        end
+        # Typically log statements start end with a \n, so skiping puts here.
+      end
+
+      if opts[:events] && json['events'] && !json['events'].empty?
+        out.puts 'Events:'.cyan
+        out.puts
+        json['events'].each do |e|
+          out.puts "Event: #{e['type']}"
+          out.puts "At: #{(e['time']*1000).round}ms"
+          out.puts "Value: #{e['value'].to_json}"
+          out.puts
+        end
+      end
+
+      if json['exception']
+        out.puts "Exception: #{json['exception']['message']}".red
+        if opts[:trace]
+          out.puts json['exception']['backtrace'].map {|e| "  #{e}"}.join("\n").blue
+        end
+        out.puts
+      end
+
+      print_to.print(out.string)
+
+
+    end
+  end
+end

data/lib/rack-json-logs/version.rb

@@ -1,5 +1,5 @@
 module Rack
   class JsonLogs
-    VERSION = '1.0'
+    VERSION = '1.1'
   end
 end

data/test/config.ru

@@ -4,7 +4,7 @@
 $: << File.expand_path('../lib/', __FILE__)
 require 'rack-json-logs'
 
-use Rack::JsonLogs
+use Rack::JsonLogs, pretty_print: true
 
 run ->(env) do
   puts "hello world"

metadata

@@ -1,62 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: rack-json-logs
 version: !ruby/object:Gem::Version
-  version: '1.0'
-  prerelease: 
+  version: '1.1'
 platform: ruby
 authors:
 - Kenneth Ballenegger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-07 00:00:00.000000000 Z
+date: 2014-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: colorize
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: trollop
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Rack::JsonLogs is a gem that helps log sanely in production.
@@ -67,13 +60,14 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/json-log-pp
 - lib/rack-json-logs.rb
+- lib/rack-json-logs/pretty-printer.rb
 - lib/rack-json-logs/version.rb
 - rack-json-logs.gemspec
 - test/.gitignore
@@ -81,27 +75,26 @@ files:
 - test/log
 homepage: ''
 licenses: []
+metadata: {}
 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.24
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Rack::JsonLogs is a gem that helps log sanely in production.
 test_files:
 - test/.gitignore