zlog 0.7 → 0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 09e454b71eb8ad7237defaeebfb4c5a04ed1e4c1
-  data.tar.gz: c634bc81b2f2242fa3511a8164712480edcf7661
+  metadata.gz: 95b3fd6c53f48770f2b2751940346071debc8dc4
+  data.tar.gz: 3954a451f924c658cb5a3a0df8b0db729a1bfc3e
 SHA512:
-  metadata.gz: 594b912a1186fab36e5b40f9c2b24f19528cdb4d6c7ab33fbb835cb9bb526542649e48994f838b24917268316e577d7867d93cf293b27c9901fc497ee3f892b2
-  data.tar.gz: 9675234eacea1b2939be8841818237ce67f8fefa5470d892e4b9a065325e20ded7687a89810b20cd93f747fdec198c5d2d5c8e11d9b27a60f979011b3bd2a367
+  metadata.gz: 45b5d98da16c8d21d224ace756249d056be82d7f1c589c147879cb4ab9db9fae2b7b03ae6ccdf8e07ff46014833cc364cdb63776d12bc499a10e8fa00363dc3f
+  data.tar.gz: fd5cbfcfc6f24749f0adb8d2be32d9dd12daf0c040847b7355c40dc54a2d68963a7fb3f3aa3af86bf2a7baad8426172929abd352e8681fd9c14dc834d123b6b9

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.8
+
+* feature: support reading log files for zlog formatter
+* feature: added convertor from json (log file format) to logevent in zlog
+* feature: get a writable logfile from a list of candidates or generate a random one
+
 ## 0.7
 
 * improvement: correctly ordered log levels (now: ... warn ok section error ...)

data/Gemfile

@@ -1,5 +1,6 @@
 source 'https://rubygems.org'
 gem 'logging', '~> 1.8.1'
+gem 'json'
 
 group :development do
   gem 'rake', '~> 10.1.0'

data/README.md

@@ -8,12 +8,12 @@ Logging configuration on top of ruby's `logging` gem (see [github](https://githu
 * supports continuous logging (eg progress indicators which you don't want to clutter your commandline)
 * added section and ok log types
 
-# requirements
+## requirements
 
 * gems:
   * logging
 
-# installation
+## installation
 
 From rubygems:
 
@@ -23,7 +23,7 @@ From source:
 
     gem build *.gemspec && gem install *gem
 
-# example
+## example
 
 Code:
 
@@ -42,4 +42,12 @@ Code:
 
 See the `example` folder for more.
 
+## utility
+
+You can use `zlog` to read and format json-based log files:
+
+    cat file.log | zlog
+
+It will print out a formatted representation of the log.
+
 ![Example image in example/example.output.png](https://raw.github.com/arlimus/zlog/master/example/example.output.png)

data/bin/zlog

@@ -0,0 +1,52 @@
+#!/usr/bin/env ruby
+require 'zlog/cli'
+require 'optparse'
+
+Zlog.init_stdout
+Log = Logging.logger['zlog']
+
+# Define the options for commandline interaction
+options = {}
+opt = OptionParser.new do |opts|
+  opts.banner = "usage: zlog [options]\n       cat my.log | zlog [options]"
+
+  opts.on("-f", "--file FILE", "Read log from file") do |file|
+    options[:file] = file
+  end
+
+  opts.on("-s", "--simple", "Print simple layout") do |v|
+    options[:layout] = :simple
+  end
+
+  opts.on("-n", "--named", "Print simple layout with names") do |v|
+    options[:layout] = :named
+  end
+end
+opt.parse!
+
+# create the commandline object for zlog
+cli = Zlog::CLI.new options
+
+# tiny print helper for reuse
+print_out = lambda{ |line| puts line }
+
+# if we are part of a pipe (eg: cat file.log | zlog), read input from stdin
+# otherwise just try to read from the provided file parameter
+if STDIN.tty?
+  # check if we have a file parameter provided
+  if options[:file].nil?
+    Log.error "you must provide at least a file parameter"
+    puts opt
+    exit 0
+  end
+  # verify that the file exists
+  if not File::file? options[:file]
+    Log.abort "file '#{options[:file]}' doesn't exist"
+  end
+  # read lines from file and format them
+  File::readlines( options[:file] ).each do |line|
+    print_out.( cli.convert_line line )
+  end
+else
+  cli.convert_stdin &print_out
+end

data/lib/zlog/cli.rb

@@ -0,0 +1,35 @@
+require 'zlog'
+
+class Zlog::CLI
+  def initialize opts = {}
+    @layout = case opts[:layout]
+      when :named
+        Zlog::Layouts.named
+      else
+        Zlog::Layouts.simple
+      end
+  end
+
+  def convert_line line, opts = {}
+    e = Zlog::json_2_event(line)
+    if not e.nil?
+      @layout.format(e)
+    end
+  end
+
+  def convert_stdin opts = {}, &handler
+    # collect all results to an array which will be returned
+    # in case that no block is given for processing
+    res = []
+    handler = lambda{|line| res.push line} if not block_given?
+
+    # process each line
+    STDIN.readlines.each do |line|
+      handler.( convert_line line, opts )
+    end
+
+    # return the result, in case we have any
+    res
+  end
+end
+

data/lib/zlog/zlog.rb

@@ -1,11 +1,22 @@
+require 'json'
+
 module Zlog
-  VERSION = "0.7"
+  VERSION = "0.8"
+  extend self
+
+  def init_stdout opts = {layout: :simple, loglevel: nil}
+    # determine the layout from options
+    layout = case opts[:layout]
+      when :named
+        Zlog::Layouts.named
+      else
+        Zlog::Layouts.simple
+      end
 
-  def self.init_stdout opts = {named: false, loglevel: nil}
     # configure the default stdout appender
     Logging.appenders.stdout(
       level: opts[:loglevel],
-      layout: (opts[:named]) ? Zlog::Layouts.named : Zlog::Layouts.simple
+      layout: layout
     )
     # find all non-stdout appenders
     # this prevents duplicates of stdout appender
@@ -13,4 +24,44 @@ module Zlog
     # add back all appenders + our own stdout appender
     Logging.logger.root.appenders = as + ["stdout"]
   end
+
+  def get_writable_logfile *candidates
+    ret = candidates.compact.find do |f|
+      # testing if something is writable, options:
+      # #1: discarged, returns false if the file doesn't exist;
+      #     it would require to check the folder too... :(
+      # File::writable? f
+      #2 trial+error
+      begin
+        File.open(f,"a").close
+        true
+      rescue
+        false
+      end
+    end
+    # in case none of the provided logfiles is writable, create one
+    if ret.nil?
+      # try to get a prefix as the filename from the first provided log file
+      prefix = File::basename( candidates[0].to_s )
+      # determine a random filename
+      File::join( Dir::tmpdir, Dir::Tmpname.make_tmpname( prefix, nil ) )
+    else
+      # return the found good filename
+      ret
+    end
+  end
+
+  def json_2_event str
+    begin
+      j = JSON::load str
+      # LogEvent = Struct.new( :logger, :level, :data, :time, :file, :line, :method )
+      # from: https://github.com/TwP/logging/blob/master/lib/logging/log_event.rb
+      # json example:
+      # {"timestamp":"2013-10-10T18:37:38.513438+02:00","level":"DEBUG",
+      #  "logger":"Log1-debug","message":"debugging info, this won't show up on console"}
+      Logging::LogEvent.new( j['logger'], Logging.level_num(j['level']), j['message'], j['timestamp'] )
+    rescue
+      nil
+    end
+  end
 end

data/test/classes/zlog_layouts_simple_spec.rb

@@ -34,20 +34,20 @@ describe Zlog::Layouts::Simple do
     format(2).must_equal (pattern_for :warning) + "\n"
   end
 
-  it "must add error events" do
-    format(3).must_equal (pattern_for :error) + "\n"
+  it "must add ok events" do
+    format(3).must_equal (pattern_for :ok) + "\n"
   end
 
-  it "must add fatal events" do
-    format(4).must_equal (pattern_for :fatal) + "\n"
+  it "must add section events" do
+    format(4).must_equal (pattern_for :section) + "\n"
   end
 
-  it "must add ok events" do
-    format(5).must_equal (pattern_for :ok) + "\n"
+  it "must add error events" do
+    format(5).must_equal (pattern_for :error) + "\n"
   end
 
-  it "must add section events" do
-    format(6).must_equal (pattern_for :section) + "\n"
+  it "must add fatal events" do
+    format(6).must_equal (pattern_for :fatal) + "\n"
   end
 
   it "must support continuous loggin, 1 step" do

data/test/classes/zlog_layouts_simplenamed_spec.rb

@@ -35,20 +35,20 @@ describe Zlog::Layouts::SimpleNamed do
     format(2).must_equal (pattern_for :warning) + "\n"
   end
 
-  it "must add error events" do
-    format(3).must_equal (pattern_for :error) + "\n"
+  it "must add ok events" do
+    format(3).must_equal (pattern_for :ok) + "\n"
   end
 
-  it "must add fatal events" do
-    format(4).must_equal (pattern_for :fatal) + "\n"
+  it "must add section events" do
+    format(4).must_equal (pattern_for :section) + "\n"
   end
 
-  it "must add ok events" do
-    format(5).must_equal (pattern_for :ok) + "\n"
+  it "must add error events" do
+    format(5).must_equal (pattern_for :error) + "\n"
   end
 
-  it "must add section events" do
-    format(6).must_equal (pattern_for :section) + "\n"
+  it "must add fatal events" do
+    format(6).must_equal (pattern_for :fatal) + "\n"
   end
 
   it "must support continuous loggin, 1 step" do

data/test/classes/zlog_spec.rb

@@ -1,7 +1,63 @@
 require 'minitest_helper'
+require 'tmpdir'
 
 describe Zlog do
   it "can initialize itself to STDOUT" do
     Zlog.must_respond_to :init_stdout
   end
+
+  describe 'get_writable_logfile' do
+
+    before :each do
+      @random_writable = File::join( Dir::tmpdir, Dir::Tmpname.make_tmpname( "", nil ) )
+      @random_non_writable = File::join( '/dev', Dir::Tmpname.make_tmpname("",nil) )
+    end
+
+    it "must give a working writable log file" do
+      Zlog.get_writable_logfile( @random_writable ).
+        must_equal @random_writable
+    end
+
+    it "must give return the first actually writable log file" do
+      Zlog.get_writable_logfile( @random_non_writable, @random_writable ).
+        must_equal @random_writable
+    end
+
+    it "must provide a random file if none of the provided candidates are writable" do
+      f = Zlog.get_writable_logfile( @random_non_writable, @random_writable )
+      f.must_be_instance_of String
+      f.wont_be_empty
+    end
+
+  end
+
+  describe 'json_2_event' do
+    before :each do
+      template = '{"timestamp":"2013-10-10T18:37:38.513438+02:00","level":"%level","logger":"Mocker%level","message":"mock message %level"}'
+      names = ["DEBUG","INFO","WARN","OK","SECTION","ERROR","FATAL"]
+      @examples = (0..(names.length-1)).
+        map do |level|
+          {
+            raw: template.gsub( '%level', names[level] ),
+            level: level,
+            name: names[level]
+          }
+        end
+    end
+
+    it "must give nil on incorrect json" do
+      Zlog.json_2_event( "" ).must_be_nil
+    end
+
+    it "must convert a logging json to a logevent" do
+      @examples.each do |e|
+        r = Zlog.json_2_event e[:raw]
+        r.must_be_instance_of Logging::LogEvent
+        r.level.must_equal e[:level]
+        r.logger.must_equal "Mocker#{e[:name]}"
+        r.data.must_equal "mock message #{e[:name]}"
+      end
+    end
+
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zlog
 version: !ruby/object:Gem::Version
-  version: '0.7'
+  version: '0.8'
 platform: ruby
 authors:
 - Dominik Richter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-06 00:00:00.000000000 Z
+date: 2013-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logging
@@ -26,7 +26,8 @@ dependencies:
         version: 1.8.1
 description: rudimentary simple logging for ruby
 email: dominik.richter@googlemail.com
-executables: []
+executables:
+- zlog
 extensions: []
 extra_rdoc_files: []
 files:
@@ -37,10 +38,12 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- bin/zlog
 - example/example.file.rb
 - example/example.output.png
 - example/example.simple+stdout.rb
 - lib/zlog.rb
+- lib/zlog/cli.rb
 - lib/zlog/layouts.rb
 - lib/zlog/logging.rb
 - lib/zlog/simple_layouts.rb