perfume 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 454092b73948923a75a389d4a257cd138ae50bf8
-  data.tar.gz: 6b5fa43f55f038d41d5335eeb199cc986f39f59b
+  metadata.gz: 03528ec0794024092661cf896356eb5d9cb6c13b
+  data.tar.gz: 9630838ee4a98b5bcb7572373da237c841390931
 SHA512:
-  metadata.gz: a8deebaf11ab4fae66403efb78f2978e5fa928aad29cf75040ff551832a4a44eab95945dde167ab60ec69fccf28884862edf5728f81caa64a1625ea8ca1ccd61
-  data.tar.gz: b6cd61497493f609e3a23c348116e4e97a1dc5e53bbe5b62a108985171a157eb18d33c75d8697e570261eab52cf18c1831308555dd343499c6c051f0567c6781
+  metadata.gz: 1b01545fa77bab4667234b0bc9ff5f55b9542c660e17127b4e8320f7f7ed478d587b6c2fcb722faef136f01b69770c25dd21cf6c9906cc4d3d5970340732297e
+  data.tar.gz: 1b730f6be75d0ba73521d18d549bd1f5b1e9e398a6a9698e9e1a091895f84061a3d72c96d7678e02c0bbecaba996da21e3a3b32558661b680134d764141add02

data/CHANGELOG.md

@@ -4,6 +4,14 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+...
+
+## [0.3.0]
+
+### Changed
+
+- Logging artifacts moved out from perfume and transferred into gallus.
+
 ## [0.2.0]
 
 ### Added

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.2.0'
+gem 'perfume', '0.3.0'
 ```
 
 And then execute:
@@ -29,7 +29,7 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install perfume --version 0.2.0
+    $ gem install perfume --version 0.3.0
 
 ## Usage
 

data/hacking/benchmarks.rb

@@ -0,0 +1,47 @@
+# Usage: LEVEL=INFO N=10000 bundle exec ruby hacking/benchmarks.rb
+
+require 'log4r'
+require 'gallus'
+require 'stringio'
+require 'benchmark'
+
+LEVEL = ENV.fetch('LEVEL', 'INFO')
+
+$gallus = Gallus::Log.configure('test') do |log|
+  log.level = LEVEL
+  log.output << Gallus::Output::Stream.new(StringIO.new, Gallus::Format::SimpleLog.new)
+end
+
+N = ENV.fetch('N', 10000).to_i
+calls = []
+
+N.times do
+  %w[debug info warn error].each do |level|
+    calls << level
+  end
+end
+
+Log4r::IOOutputter.new('stream', StringIO.new, formatter: Log4r::PatternFormatter.new(pattern: "%l @ %d $ %C - %m"))
+
+$log4r = Log4r::Logger.new('test')
+$log4r.level = Log4r.const_get(LEVEL)
+$log4r.add('stream')
+
+payload = { one: 1, two: "Two", three: Object.new, four: "Yada! yada! yada!" }
+
+Benchmark.bm do |x|
+  x.report("Log4r: ") do
+    calls.dup.shuffle.each do |level|
+      $log4r.send(level) do
+        formatted_payload = payload.map { |k,v| "#{k}=#{v.inspect}" }.join(" ")
+        "This is fancy little message; #{formatted_payload}"
+      end
+    end
+  end
+
+  x.report("Gallus: ") do
+    calls.dup.shuffle.each do |level|
+      $gallus.send(level, "This is fancy little message", payload)
+    end
+  end
+end

data/lib/gallus/format/simple_console.rb

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

data/lib/gallus/format/simple_log.rb

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

data/lib/gallus/log.rb

@@ -46,15 +46,16 @@ module Gallus
       end
     end
 
-    attr_accessor :name, :level, :output, :serialization
+    attr_accessor :name, :level, :serialization
+    attr_reader :output
 
     def initialize(parent, name, &block)
       @parent, @name = parent, name.to_s
 
-      if @parent
+      if parent
+        @output = (@parent.output || []).dup
+        @serialization = @parent.serialization
         self.level = @parent.level
-        self.output = @parent.output.dup
-        self.serialization = @parent.serialization
       end
 
       yield self if block_given?
@@ -91,7 +92,6 @@ module Gallus
     @@root = Log.configure do |log|
       log.name = 'root'
       log.level = Level::INFO
-      log.output = []
       log.serialization = Serialization::Inspect.new
     end
   end

data/lib/gallus/logging.rb

@@ -0,0 +1,17 @@
+module Gallus
+  module Logging
+    def self.included(klass)
+      klass.extend(ClassMethods)
+    end
+
+    def log
+      self.class.log
+    end
+
+    module ClassMethods
+      def log
+        @log ||= ::Gallus::Log.configure(self.name)
+      end
+    end
+  end
+end

data/lib/gallus/output/stderr.rb

@@ -1,8 +1,8 @@
 module Gallus
   module Output
-    class Stderr
+    class Stderr < Stream
       def initialize(format)
-        super(STDERR, format)
+        super($stderr, format)
       end
     end
   end

data/lib/gallus/output/stdout.rb

@@ -1,8 +1,8 @@
 module Gallus
   module Output
-    class Stdout
+    class Stdout < Stream
       def initialize(format)
-        super(STDOUT, format)
+        super($stdout, format)
       end
     end
   end

data/lib/gallus/package_logging.rb

@@ -0,0 +1,20 @@
+module Gallus
+  # Public: Similarly to Perfume::Logging no point to initialize global logger for your
+  # modules/packages. Include this mixin to define LOGGER constant and log class method
+  # shortcut.
+  #
+  # Often used practice is to define such top level logger as a parent with default
+  # outputters, formatters, log level, etc.
+  module PackageLogging
+    def self.included(klass)
+      klass.const_set(:LOG, ::Gallus::Log.configure(klass.name))
+      klass.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def log
+        const_get(:LOG)
+      end
+    end
+  end
+end

data/lib/gallus.rb

@@ -1,4 +1,4 @@
-require 'date'
+require 'time'
 require 'thread'
 
 module Gallus
@@ -15,4 +15,6 @@ module Gallus
   require 'gallus/event'
   require 'gallus/repository'
   require 'gallus/log'
+  require 'gallus/logging'
+  require 'gallus/package_logging'
 end

data/lib/perfume/all.rb

@@ -1,5 +1,4 @@
 module Perfume
-  require 'perfume/logging'
   require 'perfume/service'
   require 'perfume/promise'
   require 'perfume/shell'

data/lib/perfume/service.rb

@@ -1,12 +1,13 @@
 require 'active_support/core_ext/hash/keys'
 require 'perfume/super_object'
+require 'gallus'
 
 module Perfume
   # Public: The pattern is simple, our Service is a struct with init arguments that
   # additionally is callable. It also comes with class level `call` method that
   # executes stuff on new instance of the object.
   class Service < SuperObject
-    include Logging
+    include Gallus::Logging
 
     # Public: Shorthand to instantionante with arguments and perform call in one shot.
     # You should actually always intend to use this method as it's easier to mock

data/lib/perfume/version.rb

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

data/perfume.gemspec

@@ -24,8 +24,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "minitest", "~> 5.8"
   spec.add_development_dependency "minitest-reporters", "~> 1.1"
   spec.add_development_dependency "mocha", "~> 1.1"
+  spec.add_development_dependency "log4r", "~> 1.1", ">= 1.0"
   # spec.add_development_dependency "rake-bump", "~> 0.4"
 
   spec.add_dependency "activesupport", "~> 4.2", ">= 3.0"
-  spec.add_dependency "log4r", "~> 1.1", ">= 1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: perfume
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - jobandtalent
@@ -82,45 +82,45 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: log4r
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '1.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :runtime
+        version: '1.0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '1.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: log4r
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '4.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '4.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '3.0'
 description: Bunch of tools and utilities for common day-to-day tasks while working
   with microservices.!
 email:
@@ -141,16 +141,19 @@ files:
 - bin/console
 - bin/setup
 - docker-compose.yml
+- hacking/benchmarks.rb
 - 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/logging.rb
 - lib/gallus/output/null.rb
 - lib/gallus/output/stderr.rb
 - lib/gallus/output/stdout.rb
 - lib/gallus/output/stream.rb
+- lib/gallus/package_logging.rb
 - lib/gallus/payload.rb
 - lib/gallus/repository.rb
 - lib/gallus/serialization/inspect.rb
@@ -160,10 +163,6 @@ files:
 - lib/perfume/console.rb
 - lib/perfume/core_ext/dir.rb
 - lib/perfume/exit.rb
-- lib/perfume/logging.rb
-- lib/perfume/logging/command_line_output_formatter.rb
-- lib/perfume/logging/log4r_adapter.rb
-- lib/perfume/logging/package_logger.rb
 - lib/perfume/promise.rb
 - lib/perfume/service.rb
 - lib/perfume/shell.rb

data/lib/perfume/logging/command_line_output_formatter.rb

@@ -1,25 +0,0 @@
-module Perfume
-  module Logging
-    # Internal: For command line apps we rather don't want to display all the logging information
-    # to the user. Just to avoid noise, INFO messages are displayed as is, and any other log levels
-    # are prefixed with the level name. Example:
-    #
-    #   This is simple info message.
-    #   And another one.
-    #   WARN: Uups, something's not right here...
-    #   And another info message.
-    #   DEBUG: We need to go deeper!
-    #   ERROR: Limbo!
-    #
-    class CommandLineOutputFormatter < Log4r::Formatter
-      def initialize
-        @info_formatter = Log4r::PatternFormatter.new(:pattern => "%m")
-        @else_formatter = Log4r::PatternFormatter.new(:pattern => "%l: %m")
-      end
-
-      def format(logevent)
-        (Log4r::INFO == logevent.level ? @info_formatter : @else_formatter).format(logevent)
-      end
-    end
-  end
-end

data/lib/perfume/logging/log4r_adapter.rb

@@ -1,37 +0,0 @@
-module Perfume
-  module Logging
-    # Internal: Adapter for Log4r logging system. It's a poor version of what Slf4j does to Log4j in
-    # java apps. Just tiny layer to improve on logging payloads.
-    class Log4rAdapter
-      class Event
-        def initialize(message, payload)
-          @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_proc
-          @proc
-        end
-      end
-
-      def initialize(log)
-        @log = log
-      end
-
-      %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_proc : obj_or_msg)
-        end
-      end
-    end
-  end
-end

data/lib/perfume/logging/package_logger.rb

@@ -1,25 +0,0 @@
-require 'log4r'
-require 'perfume/logging/log4r_adapter'
-
-module Perfume
-  module Logging
-    # Public: Similarly to Perfume::Logging no point to initialize global logger for your
-    # modules/packages. Include this mixin to define LOGGER constant and log class method
-    # shortcut.
-    #
-    # Often used practice is to define such top level logger as a parent with default
-    # outputters, formatters, log level, etc.
-    module PackageLogger
-      def self.included(klass)
-        klass.const_set(:LOGGER, Gallus::Log.configure(klass.name))
-        klass.extend(ClassMethods)
-      end
-
-      module ClassMethods
-        def log
-          const_get(:LOGGER)
-        end
-      end
-    end
-  end
-end

data/lib/perfume/logging.rb

@@ -1,26 +0,0 @@
-require 'log4r'
-
-module Perfume
-  # Public: Log4r is awesome, but why initialize it for every class manually if you
-  # can use simple extension that will do it for you. This one injects class and
-  # instance `log` methods to access class logger.
-  module Logging
-    require 'perfume/logging/log4r_adapter'
-    require 'perfume/logging/command_line_output_formatter'
-    require 'perfume/logging/package_logger'
-
-    def self.included(klass)
-      klass.extend(ClassMethods)
-    end
-
-    def log
-      self.class.log
-    end
-
-    module ClassMethods
-      def log
-        @log ||= Gallus::Log.configure(self.name)
-      end
-    end
-  end
-end