log4r-sequel 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 22db2c5c31f8fbb61fac792ab52976a26e6e0984
-  data.tar.gz: 2ea605f5b25ebc37a19c912403e6e502ca7751a4
+  metadata.gz: 4e2df9143f88d2565644c34dd200a0c66a4d49f5
+  data.tar.gz: c76ec6079a80db159faac195d8890e8757794e25
 SHA512:
-  metadata.gz: eb146d274d9e4bddeb666218f54edb4bda8d26fd95d5b36479c05f42727fb70ea7ce341d1a293b8d089723eb101e897d094dea0fd3720c54933a63ae9cc5f053
-  data.tar.gz: a791ae9d859a3854a88b38f174e8774d2ec53f577c5aa3d291fb4022a1a87c03d2f69053f76101ba8bc8be3a01c3bc0e2cde389819df095507cbe9dd9989f836
+  metadata.gz: 6fbd50621319256bad2e8c8ca51a88e3df425c02da1abdcdfb525f0fa98474b0743aafa60427a081c4f43d503e4ad02b51abc63f27105c0cfa0655866acd3551
+  data.tar.gz: bc46f2fd5e8ef4a268f6ff5151e8f70ca21f03656ec7c720a51d556757ab2a1c8e2298661f669bc72772e66999c8c3f58116f1aa0bf051a1e0bc7cba98f1ba30

data/.travis.yml

@@ -9,5 +9,11 @@ rvm:
 notifications:
   email: false
 
+services:
+  - postgresql
+
+before_script:
+  - psql -c 'create database logs;' -U postgres
+
 bundler_args: --without test --jobs 3 --retry 3
 script: bundle exec rake test

data/README.md

@@ -1,6 +1,21 @@
 # log4r-sequel
 Log4r outputter to a Sequel database handle
 
+- [usage](#usage)
+  - [pre-built gem installation (stable)](#pre-built-gem-installation-stable)
+  - [from-source installation (latest)](#from-source-installation-latest)
+  - [demo](#demo)
+- [supported databases](#supported-databases)
+- [TODO](#todo)
+
+the de-facto standard library for logging in Ruby, [log4r](https://github.com/colbygk/log4r) works very well for a wide array of logging targets:
+  * STDOUT / STDERR
+  * file
+  * email
+  * syslog
+
+and so on, but didn't have a way to output directly to a database - enter `log4r-sequel`
+
 ## usage
 
 ### pre-built gem installation (stable)
@@ -33,13 +48,36 @@ irb(main):001:0> require 'log4r/outputter/sequeloutputter'
 => true
 ```
 
+### demo
+
+```
+$ ruby example/log2postgres.rb
+2016/08/27 17:08.1472342938 | bar | DEBUG | this is a debug message
+2016/08/27 17:08.1472342938 | bar | INFO | this is an info message
+2016/08/27 17:08.1472342938 | bar | WARN | this is a warning
+2016/08/27 17:08.1472342938 | bar | ERROR | this is an error
+2016/08/27 17:08.1472342938 | bar | FATAL | this is a fatal
+$ sqlite3 example/log.sqlite
+SQLite version 3.8.10.2 2015-05-20 18:17:19
+Enter ".help" for usage hints.
+sqlite> select * from logs;
+1|2016/08/27 17:10.1472343022|foo|DEBUG|this is a debug message
+2|2016/08/27 17:10.1472343022|foo|INFO|this is an info message
+3|2016/08/27 17:10.1472343022|foo|WARN|this is a warning
+4|2016/08/27 17:10.1472343022|foo|ERROR|this is an error
+5|2016/08/27 17:10.1472343022|foo|FATAL|this is a fatal
+sqlite>
+```
+
 ## supported databases
   * sqlite3
   * Postgres
-  
+
 ## TODO
-  * allow database name to be semi-dynamically generated - via YAML config, not just by passing the hash directly
   * tests
     * unit tests
-  * marketing
-    * screencast / sample output in README.md
+
+
+## notes
+  * `:database`, `:table`, and `:file` options are passed through `Time.now.strftime(%s)`
+  * sqlite filenames cannot contain underscores (`the scheme sqlite does not accept registry part`)

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/example/log2postgres.rb

@@ -1,8 +1,8 @@
 $LOAD_PATH << sprintf('%s/../lib', File.dirname(__FILE__))
-
-#require 'log4r-sequel'
 require 'log4r/outputter/sequeloutputter'
 
+require 'pg'
+
 file = sprintf('%s/log4r-postgres.yaml', File.dirname(__FILE__))
 Log4r::YamlConfigurator.load_yaml_file(file)
 

data/example/log2sqlite.rb

@@ -1,11 +1,8 @@
 $LOAD_PATH << sprintf('%s/../lib', File.dirname(__FILE__))
+require 'log4r/outputter/sequeloutputter'
 
 require 'sqlite3'
 
-#require 'log4r-sequel'
-require 'log4r/outputter/sequeloutputter'
-require 'log4r/yamlconfigurator'
-
 ## instantiate a logger following the log4r pattern
 file = sprintf('%s/log4r-sqlite.yaml', File.dirname(__FILE__))
 Log4r::YamlConfigurator.load_yaml_file(file)

data/example/log4r-postgres.yaml

@@ -27,7 +27,7 @@ log4r_config:
     server: localhost
     port: 5432
     database: logs
-    table: logs
+    table: logs-%Y/%m/%d-%H:%M.%s
     username: postgres
     password: postgres
     delimiter: '!@#$' # this is used to determine columns needed based on log4 configuration

data/example/log4r-sqlite.yaml

@@ -24,7 +24,7 @@ log4r_config:
       pattern: '%d!@#$%C!@#$%l!@#$%m' # date|level|event/class fullname|message
     # log4r-sequel settings
     engine: sqlite
-    file: log.sqlite
+    file: log-%Y-%m-%d-%H-%M-%s.sqlite
     table: logs
     delimiter: '!@#$' # this is used to determine columns needed based on log4 configuration
     map:

data/lib/log4r/outputter/sequeloutputter.rb

@@ -3,21 +3,9 @@ require 'log4r/yamlconfigurator'
 require 'sequel'
 require 'yaml'
 
-# TODO  should we move this to ../logger.rb
-# TODO .. or should we remove this entirely? it was implemented to let us call connect/configure, but since we do that in initiliaze now, maybe we just pull it
 class Log4r::Logger
-  # +method+ String or Symbol representing the name of the method in the Log4r::Outputter::SequelOutputter class you want to use
-  # +parameters+ arbitrary data type to be passed to :methods
-  def sequel(method, parameters = { })
-    # TODO support methods that take more than one parameter
-    self.outputters.each do |op|
-      next unless op.is_a?(SequelOutputter)
-      return op.send(method.to_sym, parameters)
-    end
-  end
 
   # no parameters, returns the first Log4r::Outputter::Sequel object
-  # TODO is there ever a case where there would be more than one?
   def get_outputter
     self.outputters.each do |op|
       next unless op.is_a?(SequelOutputter)
@@ -57,16 +45,21 @@ class SequelOutputter < Log4r::Outputter
     @engine = config[:engine].to_sym
 
     # error checking on table/column settings
-    @table = config[:table].to_sym
-    @map = config[:map]
+    @table     = Time.now.strftime(config[:table]).to_sym
+    @map       = config[:map]
     @delimiter = config[:delimiter]
-    [@delimiter, @map, @table].each do |required|
-      raise Log4r::ConfigError.new(sprintf("required '%s' key missing from configuration", required)) if required.nil?
+
+    {
+      :delimiter => @delimiter,
+      :map       => @map,
+      :table     => @table,
+    }.each_pair do |key, value|
+      raise Log4r::ConfigError.new(sprintf('required key[%s] missing from configuration', key)) if value.nil?
     end
 
     if @engine.eql?(:postgres)
-      @database = config[:database]
-      @file     = nil
+      @database = Time.now.strftime(config[:database])
+      @file     = @table # this is technically the.. table, but maintaining interface cleanliness
       server    = config[:server]
       port      = config[:port]
       username  = config[:username]
@@ -74,7 +67,7 @@ class SequelOutputter < Log4r::Outputter
       @dbh = Sequel.connect(sprintf('postgres://%s:%s@%s:%s/%s', username, password, server, port, @database))
     elsif @engine.eql?(:sqlite)
       @database = nil # sqlite has one DB per file
-      @file = config[:file]
+      @file = Time.now.strftime(config[:file])
       @dbh = Sequel.connect(sprintf('sqlite://%s', @file))
     else
       raise Log4r::ConfigError.new(sprintf('unable to use engine[%s], allowed[%s]', @engine, KNOWN_ENGINES))
@@ -90,7 +83,7 @@ class SequelOutputter < Log4r::Outputter
 
     @dbh = dbh
 
-    # idempotently create table/columns
+    # idempotently create database/table
     initialize_db
   end
 
@@ -103,9 +96,8 @@ class SequelOutputter < Log4r::Outputter
 
   def write(data)
     raise StandardError.new(sprintf('%s is not connected, run %s.connect(yaml_file)', self.class, self.class)) unless connected?
-     # INSERT INTO `logs`(`id`,`date`,`level`,`class`,`message`) VALUES (1,NULL,NULL,NULL,NULL);
-    tokens = data.split(@delimiter)
-    hash = Hash.new
+    tokens = data.chomp.split(@delimiter)
+    hash   = Hash.new
 
     tokens.each_with_index do |token, i|
       hash[@map[i].to_sym] = token

data/test/functional/test_postgres.rb

@@ -0,0 +1,63 @@
+$LOAD_PATH << sprintf('%s/../../lib', File.dirname(__FILE__))
+require 'log4r/outputter/sequeloutputter'
+
+require 'test/unit'
+
+class TestPostgres < Test::Unit::TestCase
+
+  def setup
+    @good_config = sprintf('%s/../log4r-postgres_test.yaml', File.expand_path(File.dirname(__FILE__)))
+    @table = Time.now.strftime('logs-%Y/%m/%d-%H:%M').to_sym
+
+    begin
+      require 'pg'
+    rescue LoadError
+      omit('[pg] not installed/configured')
+    end
+
+  end
+
+  def teardown; end
+
+  def test_happy_yaml
+    file = @good_config
+    Log4r::YamlConfigurator.load_yaml_file(file)
+
+    logger = nil
+
+    assert_nothing_raised do
+      logger  = Log4r::Logger.get('test')
+    end
+
+    assert_not_nil(logger)
+    assert_equal(0, logger.get_outputter.dbh[@table].count)
+
+    assert_nothing_raised do
+      logger.debug('this is a debug message')
+      logger.info('this is an info message')
+      logger.warn('this is a warning')
+      logger.error('this is an error')
+      logger.fatal('this is a fatal')
+    end
+
+    assert_not_equal(0, logger.get_outputter.dbh[@table].count)
+
+  end
+
+  def test_sad_yaml
+    # TODO pass in bad configs as hashes
+  end
+
+  def test_happy_hash
+    logger = nil
+
+    assert_nothing_raised do
+      #logger = Logger::Log4r.new()
+      p 'DBGZ' if nil?
+    end
+
+    #assert_equal(0, logger.get_outputter.dbh[@table].count)
+
+  end
+
+end

data/test/functional/test_sqlite.rb

@@ -1,7 +1,6 @@
 $LOAD_PATH << sprintf('%s/../../lib', File.dirname(__FILE__))
 require 'log4r/outputter/sequeloutputter'
 
-
 require 'test/unit'
 
 class TestSqlite < Test::Unit::TestCase
@@ -9,6 +8,12 @@ class TestSqlite < Test::Unit::TestCase
   def setup
     @good_config = sprintf('%s/../log4r-sqlite_test.yaml', File.expand_path(File.dirname(__FILE__)))
     @table = :logs
+
+    begin
+      require 'sqlite3'
+    rescue LoadError
+      omit('[sqlite3] not installed/configured')
+    end
   end
 
   def teardown
@@ -41,9 +46,20 @@ class TestSqlite < Test::Unit::TestCase
 
   end
 
-  def test_sad_config
+  def test_sad_yaml
     # TODO pass in bad configs as hashes
   end
 
+  def test_happy_hash
+    logger = nil
+
+    assert_nothing_raised do
+      #logger = Logger::Log4r.new()
+    end
+
+    #assert_equal(0, logger.get_outputter.dbh[@table].count)
+
+
+  end
 
 end

data/test/log4r-postgres_test.yaml

@@ -0,0 +1,42 @@
+---
+log4r_config:
+  loggers:
+  - name: 'test'
+    outputters:
+      - sequel
+      - stdout
+  outputters:
+  # not needed, but feedback is useful
+  - type: StdoutOutputter
+    name: stdout
+    formatter:
+      type: PatternFormatter
+      date_pattern: '%Y/%m/%d %H:%M.%s'
+      pattern: '%d | %C | %l | %m'
+
+  - type: SequelOutputter
+    # traditional Log4r settings
+    name: sequel
+    level: DEBUG
+    formatter:
+      type: PatternFormatter
+      date_pattern: '%Y/%m/%d %H:%M.%s'
+      pattern: '%d!@#$%l!@#$%C!@#$%c!@#$%h!@#$%p!@#$%m'
+
+    # log4r-sequel settings
+    engine: postgres
+    server: localhost
+    port: 5432
+    database: logs
+    table: logs-%Y/%m/%d-%H:%M
+    username: postgres
+    password: postgres
+    delimiter: '!@#$'
+    map:
+      0: 'date'
+      1: 'level'
+      2: 'class'
+      3: 'relative_class'
+      4: 'thread'
+      5: 'pid'
+      6: 'message'

data/test/log4r-sqlite_test.yaml

@@ -21,26 +21,15 @@ log4r_config:
     formatter:
       type: PatternFormatter
       date_pattern: '%Y/%m/%d %H:%M.%s'
-      pattern: '%d!@#$%C!@#$%l!@#$%m' # date|level|event/class fullname|message
+      pattern: '%d!@#$%C!@#$%l!@#$%m'
+
     # log4r-sequel settings
     engine: sqlite
-    file: log.sqlite
+    file: log-%Y-%m-%d-%H-%M.sqlite # underscores are apparently 'invalid'
     table: logs
-    delimiter: '!@#$' # this is used to determine columns needed based on log4 configuration
+    delimiter: '!@#$'
     map:
       0: 'date'
       1: 'level'
       2: 'class'
       3: 'message'
-
-# truncated map from http://log4r.rubyforge.org/rdoc/Log4r/PatternFormatter.html
-#  %c - event short name
-#  %C - event fullname
-#  %d - date
-#  %g - Global Diagnostic Context (GDC)
-#  %t - trace
-#  %m - message
-#  %h - thread name
-#  %p - process ID aka PID
-#  %M - formatted message
-#  %l - Level in string form

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: log4r-sequel
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Conor Horan-Kates
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-27 00:00:00.000000000 Z
+date: 2016-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: log4r
@@ -143,7 +143,9 @@ files:
 - example/log4r-postgres.yaml
 - example/log4r-sqlite.yaml
 - lib/log4r/outputter/sequeloutputter.rb
+- test/functional/test_postgres.rb
 - test/functional/test_sqlite.rb
+- test/log4r-postgres_test.yaml
 - test/log4r-sqlite_test.yaml
 homepage: http://github.com/chorankates/log4r-sequel
 licenses: