perfume 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cdbf43b151d7f376a9858e70e92c2a86dc815a73
-  data.tar.gz: 44e31ee400a397f536e36ee94eea30f7abe6fc06
+  metadata.gz: 454092b73948923a75a389d4a257cd138ae50bf8
+  data.tar.gz: 6b5fa43f55f038d41d5335eeb199cc986f39f59b
 SHA512:
-  metadata.gz: 1506aa517bcc89219aabaa16765d51f140fc5d841625f3f8f8a4a7813485f76057fc83e8608bfb8c316c039224ad474bac11efb4286703a200acb98e77a69a07
-  data.tar.gz: cf04e57c3e583617460867bae3d1b45df456daedac7e4206c576c34ee2ed829129bdf5204b24de088bf739a30e2a444af397db8eca361b7c9f011885c02e9e67
+  metadata.gz: a8deebaf11ab4fae66403efb78f2978e5fa928aad29cf75040ff551832a4a44eab95945dde167ab60ec69fccf28884862edf5728f81caa64a1625ea8ca1ccd61
+  data.tar.gz: b6cd61497493f609e3a23c348116e4e97a1dc5e53bbe5b62a108985171a157eb18d33c75d8697e570261eab52cf18c1831308555dd343499c6c051f0567c6781

data/CHANGELOG.md

@@ -4,7 +4,11 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
-...
+## [0.2.0]
+
+### Added
+
+- Logging with new Gallus library bundled.
 
 ## [0.1.0]
 

data/README.md

@@ -20,7 +20,7 @@ shorthands to deal with common problems. At the moment it includes the following
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'perfume', '0.1.0'
+gem 'perfume', '0.2.0'
 ```
 
 And then execute:
@@ -29,7 +29,7 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install perfume --version 0.1.0
+    $ gem install perfume --version 0.2.0
 
 ## Usage
 

data/lib/gallus/event.rb

@@ -0,0 +1,10 @@
+module Gallus
+  Event = Struct.new(:logger, :level, :message, :payload) do
+    attr_reader :recorded_at
+
+    def initialize(*)
+      super
+      @recorded_at = Time.now.utc
+    end
+  end
+end

data/lib/gallus/format/simple_console.rb

@@ -0,0 +1,11 @@
+module Gallus
+  module Format
+    class SimpleConsole
+      def call(event)
+        parts = [ [ event.message, event.payload ].compact.join('; ') ]
+        parts.unshift("#{event.level.name}:") unless event.level == Level::INFO
+        parts.compact.join(' ')
+      end
+    end
+  end
+end

data/lib/gallus/format/simple_log.rb

@@ -0,0 +1,10 @@
+module Gallus
+  module Format
+    class SimpleLog
+      def call(event)
+        message = [ event.message, event.payload ].compact.join('; ')
+        "#{event.level.to_s[0]} @ #{event.recorded_at.iso8601} $ #{event.logger} > #{message}"
+      end
+    end
+  end
+end

data/lib/gallus/level.rb

@@ -0,0 +1,42 @@
+module Gallus
+  class Level
+    include Comparable
+
+    def self.all
+      @all ||= []
+    end
+
+    def self.each(&block)
+      self.all.each(&block)
+    end
+
+    def self.[](name)
+      const_get(name.to_s)
+    end
+
+    attr_reader :name, :id
+
+    def initialize(name, id)
+      @name, @id = name.to_s, id
+
+      self.class.const_set(@name, self)
+      self.class.all << self
+    end
+
+    def <=>(other)
+      self.id <=> other.id
+    rescue => err
+      return nil
+    end
+
+    def to_s
+      name
+    end
+
+    new :TRACE, 1
+    new :DEBUG, 2
+    new :INFO,  3
+    new :WARN,  4
+    new :ERROR, 5
+  end
+end

data/lib/gallus/log.rb

@@ -0,0 +1,98 @@
+module Gallus
+  class Log
+    @@global_context_mutex = Mutex.new
+    @@global_context = {}
+
+    class << self
+      def configure(name = '', &block)
+        Repository.get_or_create_logger(name, &block)
+      end
+
+      def [](name)
+        configure(name)
+      end
+
+      def delete(name)
+        Repository.delete_with_children(name)
+      end
+
+      def define_log_methods!(log_level)
+        Level.each do |level|
+          method_name = level.name.downcase
+          remove_method(method_name) if method_defined?(method_name)
+
+          if level >= log_level
+            define_method(method_name) do |message, payload = {}|
+              log(level, message, payload)
+            end
+          else
+            define_method(method_name) do |message, payload = {}|
+              # supressed...
+            end
+          end
+        end
+      end
+
+      def global_context
+        @@global_context_mutex.synchronize { yield @@global_context }
+      end
+
+      def current_thread_context
+        yield (Thread.current[:log_context] ||= {})
+      end
+
+      def root
+        @@root
+      end
+    end
+
+    attr_accessor :name, :level, :output, :serialization
+
+    def initialize(parent, name, &block)
+      @parent, @name = parent, name.to_s
+
+      if @parent
+        self.level = @parent.level
+        self.output = @parent.output.dup
+        self.serialization = @parent.serialization
+      end
+
+      yield self if block_given?
+    end
+
+    def level=(level)
+      level = level.is_a?(Level) ? level : Level[level.to_s]
+      return if @level == level
+      self.class.class_eval { define_log_methods!(level) }
+      @level = level
+    end
+
+    def context
+      @context ||= {}
+    end
+
+    private
+
+    def merged_context
+      {}.tap do |merged|
+        self.class.global_context { |ctx| merged.merge!(ctx) }
+        self.class.current_thread_context { |ctx| merged.merge!(ctx) }
+        merged.merge!(context)
+      end
+    end
+
+    def log(level, message, payload = {}, &block)
+      payload = merged_context.merge(payload)
+      serialized_payload = serialization.call(Payload.new(payload).to_h)
+      event = Event.new(@name, level, message.to_s, serialized_payload.empty? ? nil : serialized_payload)
+      output.each { |out| out.call(event) }
+    end
+
+    @@root = Log.configure do |log|
+      log.name = 'root'
+      log.level = Level::INFO
+      log.output = []
+      log.serialization = Serialization::Inspect.new
+    end
+  end
+end

data/lib/gallus/output/null.rb

@@ -0,0 +1,8 @@
+module Gallus
+  module Output
+    class Null
+      def call
+      end
+    end
+  end
+end

data/lib/gallus/output/stderr.rb

@@ -0,0 +1,9 @@
+module Gallus
+  module Output
+    class Stderr
+      def initialize(format)
+        super(STDERR, format)
+      end
+    end
+  end
+end

data/lib/gallus/output/stdout.rb

@@ -0,0 +1,9 @@
+module Gallus
+  module Output
+    class Stdout
+      def initialize(format)
+        super(STDOUT, format)
+      end
+    end
+  end
+end

data/lib/gallus/output/stream.rb

@@ -0,0 +1,20 @@
+module Gallus
+  module Output
+    class Stream
+      def initialize(stream, format)
+        @mutex = Mutex.new
+        @stream, @format = stream, format
+      end
+
+      def call(event)
+        @mutex.synchronize { call!(event) }
+      end
+
+      protected
+
+      def call!(event)
+        @stream.write(@format.call(event) + "\n")
+      end
+    end
+  end
+end

data/lib/gallus/payload.rb

@@ -0,0 +1,14 @@
+module Gallus
+  class Payload
+    def initialize(payload)
+      @h = payload.inject({}) do |res,(k,v)|
+        res[k.to_s] = v.is_a?(Proc) ? v.call : v
+        res
+      end
+    end
+
+    def to_h
+      @h
+    end
+  end
+end

data/lib/gallus/repository.rb

@@ -0,0 +1,42 @@
+module Gallus
+  class Repository
+    PARENT_DELIMITER = '::'
+
+    @mutex = Mutex.new
+
+    def self.all
+      @all ||= {}
+    end
+
+    def self.find_parent(name)
+      parent, name = nil, name.dup
+
+      while parent.nil?
+        name = name.split(PARENT_DELIMITER)[0..-2].join(PARENT_DELIMITER)
+        parent = all[name]
+        break if name.empty?
+      end
+
+      parent
+    end
+
+    def self.delete_with_children(name)
+      @mutex.synchronize do
+        all.keys.each { |k| all.delete(k) if k.start_with?(name + PARENT_DELIMITER) }
+        all.delete(name)
+      end
+    end
+
+    def self.get_or_create_logger(name, &block)
+      name, log = name.to_s, nil
+
+      @mutex.synchronize do
+        unless log = all[name]
+          all[name] = (log = Class.new(Log).new(find_parent(name), name, &block))
+        end
+      end
+
+      log
+    end
+  end
+end

data/lib/gallus/serialization/inspect.rb

@@ -0,0 +1,11 @@
+module Gallus
+  module Serialization
+    class JSON
+      def call(payload)
+        require 'json'
+        payload ||= {}
+        payload.to_json
+      end
+    end
+  end
+end

data/lib/gallus/serialization/json.rb

@@ -0,0 +1,10 @@
+module Gallus
+  module Serialization
+    class Inspect
+      def call(payload)
+        payload ||= {}
+        payload.map { |k,v| "#{k}=#{v.inspect}" }.join(" ")
+      end
+    end
+  end
+end

data/lib/gallus.rb

@@ -0,0 +1,18 @@
+require 'date'
+require 'thread'
+
+module Gallus
+  require 'gallus/format/simple_console'
+  require 'gallus/format/simple_log'
+  require 'gallus/output/null'
+  require 'gallus/output/stream'
+  require 'gallus/output/stdout'
+  require 'gallus/output/stderr'
+  require 'gallus/serialization/inspect'
+  require 'gallus/serialization/json'
+  require 'gallus/level'
+  require 'gallus/payload'
+  require 'gallus/event'
+  require 'gallus/repository'
+  require 'gallus/log'
+end

data/lib/perfume/logging/log4r_adapter.rb

@@ -5,13 +5,15 @@ module Perfume
     class Log4rAdapter
       class Event
         def initialize(message, payload)
-          @message, @payload = message, payload || {}
-          @payload_formatted = @payload.map { |k,v| "#{k}=#{v.inspect}" }.join(" ")
-          @s = [ @message,  @payload_formatted.empty? ? nil : @payload_formatted].compact.join("; ")
+          @proc = -> {
+            payload ||= {}
+            payload_formatted = payload.map { |k,v| "#{k}=#{v.is_a?(Proc) ? v.call.inspect : v.inspect}" }.join(" ")
+            str = [ message,  payload_formatted.empty? ? nil : payload_formatted].compact.join("; ")
+          }
         end
 
-        def to_s
-          @s
+        def to_proc
+          @proc
         end
       end
 
@@ -19,13 +21,15 @@ module Perfume
         @log = log
       end
 
-      def method_missing(method, *args, &block)
-        @log.send(method, *args, &block)
+      %w[level level= add name].each do |method|
+        define_method(method) do |*args, &block|
+          @log.send(method, *args, &block)
+        end
       end
 
       %w[debug info warn error fatal].each do |level|
         define_method(level) do |obj_or_msg, payload=nil|
-          @log.send(level, obj_or_msg.is_a?(String) ? Event.new(obj_or_msg, payload).to_s : obj_or_msg)
+          @log.send(level, obj_or_msg.is_a?(String) ? Event.new(obj_or_msg, payload).to_proc : obj_or_msg)
         end
       end
     end

data/lib/perfume/logging/package_logger.rb

@@ -11,7 +11,7 @@ module Perfume
     # outputters, formatters, log level, etc.
     module PackageLogger
       def self.included(klass)
-        klass.const_set(:LOGGER, Logging::Log4rAdapter.new(Log4r::Logger.new(klass.name)))
+        klass.const_set(:LOGGER, Gallus::Log.configure(klass.name))
         klass.extend(ClassMethods)
       end
 

data/lib/perfume/logging.rb

@@ -19,7 +19,7 @@ module Perfume
 
     module ClassMethods
       def log
-        @log ||= Log4rAdapter.new(Log4r::Logger.new(self.name))
+        @log ||= Gallus::Log.configure(self.name)
       end
     end
   end

data/lib/perfume/version.rb

@@ -1,3 +1,3 @@
 module Perfume
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: perfume
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - jobandtalent
@@ -141,6 +141,20 @@ files:
 - bin/console
 - bin/setup
 - docker-compose.yml
+- lib/gallus.rb
+- lib/gallus/event.rb
+- lib/gallus/format/simple_console.rb
+- lib/gallus/format/simple_log.rb
+- lib/gallus/level.rb
+- lib/gallus/log.rb
+- lib/gallus/output/null.rb
+- lib/gallus/output/stderr.rb
+- lib/gallus/output/stdout.rb
+- lib/gallus/output/stream.rb
+- lib/gallus/payload.rb
+- lib/gallus/repository.rb
+- lib/gallus/serialization/inspect.rb
+- lib/gallus/serialization/json.rb
 - lib/perfume.rb
 - lib/perfume/all.rb
 - lib/perfume/console.rb