loggerator 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b09044e8590344b2433a544b15a853d63e92d06b
-  data.tar.gz: 1fc9edb37658480a85d314177440e4dd79d568c8
+  metadata.gz: 147fb6d7ba2b85f8916e9b8e5e96ac088baa8fa2
+  data.tar.gz: 699170130066ddbc05ba5ba8f33e1bfccfc2ddda
 SHA512:
-  metadata.gz: baf7c00883dcfec5e32f33feeabb28d9ecf541a0cfe3c72f503b62740d18d38f2465c71dd676da26d7056c33acad54eac304e5274a61f731037787d8f59237e2
-  data.tar.gz: f5912098321f92a9d449e3029a53cc3c33609531e5c0ea5faf02ee6f8793bb75a5fc742689056fe6ec6c247371e82d7149b26b304185de5fca2662d96079d401
+  metadata.gz: e85021a1d1bc361b85a764e8ec65c9ec097eeee232f77ff05cc7ad1f3850afef012dee300b16b2cbae99e9a1aca90edeb03c810b424dd0e27ddea785cd298daf
+  data.tar.gz: 61852b4aada68c3c5c931876d310a777092ee3809fcc424ae7f555667345e8149065548d2fe1f358e0daf0f3d8170af7320c56f346a8e5d2340ab7da05776bc6

data/lib/generators/templates/log.rb.erb

@@ -1,4 +1,4 @@
-Loggerator.default_context = { app: "<%= app_name %>" }
+Loggerator::Log.default_context = { app: "<%= app_name %>" }
 <% if defined?(Loggerator::Metrics) -%>
 Loggerator::Metrics.name   = "<%= app_name %>"
 <% end -%>

data/lib/loggerator/loggerator.rb

@@ -2,23 +2,22 @@ require_relative 'request_store'
 require_relative 'middleware'
 
 module Loggerator
-  extend self
 
   def self.included(mod)
     mod.extend self
   end
 
   def log(data, &block)
-    log_to_stream(stdout, merge_log_contexts(data), &block)
+    Log.to_stream(Log.stdout, Log.contexts(data), &block)
   end
 
-  def log_error(e, data = {})
+  def log_error(e=$!, data = {})
     exception_id = e.object_id
 
     # Log backtrace in reverse order for easier digestion.
     if e.backtrace
       e.backtrace.reverse.each do |backtrace|
-        log_to_stream(stderr, merge_log_contexts(
+        Log.to_stream(Log.stderr, Log.contexts(
           exception_id: exception_id,
           backtrace:    backtrace
         ))
@@ -36,45 +35,28 @@ module Loggerator
 
     data[:status] = e.status if e.respond_to?(:status)
 
-    log_to_stream(stderr, merge_log_contexts(data))
+    Log.to_stream(Log.stderr, Log.contexts(data))
   end
 
   def log_context(data, &block)
-    old = local_context
-    self.local_context = old.merge(data)
+    old = Log.local_context
+    Log.local_context = old.merge(data)
     res = block.call
   ensure
-    self.local_context = old
+    Log.local_context = old
     res
   end
 
-  def default_context=(default_context)
-    @@default_context = default_context
-  end
-
-  def default_context
-    @@default_context ||= {}
-  end
-
-  def stdout=(stream)
-    @@stdout = stream
-  end
-
-  def stdout
-    @@stdout ||= $stdout
-  end
-
-  def stderr=(stream)
-    @@stderr = stream
-  end
+  # Don't expose internals into included modules so name-collisions are reduced
+  module Log
+    extend self
 
-  def stderr
-    @@stderr ||= $stderr
-  end
+    def default_context=(default_context)
+      @@default_context = default_context
+    end
 
-  private
-    def merge_log_contexts(data)
-      default_context.merge(request_context.merge(local_context.merge(data)))
+    def default_context
+      @@default_context ||= {}
     end
 
     def local_context
@@ -85,62 +67,84 @@ module Loggerator
       RequestStore.store[:local_context] = h
     end
 
-    def request_context
-      RequestStore.store[:request_context] || {}
+    def stdout=(stream)
+      @@stdout = stream
+    end
+
+    def stdout
+      @@stdout ||= $stdout
+    end
+
+    def stderr=(stream)
+      @@stderr = stream
     end
 
-    def log_to_stream(stream, data, &block)
+    def stderr
+      @@stderr ||= $stderr
+    end
+
+    def contexts(data)
+      default_context.merge(request_context.merge(local_context.merge(data)))
+    end
+
+    def to_stream(stream, data, &block)
       unless block
         str = unparse(data)
         stream.print(str + "\n")
       else
         data = data.dup
         start = Time.now
-        log_to_stream(stream, data.merge(at: 'start'))
+        to_stream(stream, data.merge(at: 'start'))
         begin
           res = yield
 
-          log_to_stream(stream, data.merge(
+          to_stream(stream, data.merge(
             at: 'finish', elapsed: (Time.now - start).to_f))
           res
         rescue
-          log_to_stream(stream, data.merge(
+          to_stream(stream, data.merge(
             at: 'exception', elapsed: (Time.now - start).to_f))
           raise $!
         end
       end
     end
 
-    def unparse(attrs)
-      attrs.map { |k, v| unparse_pair(k, v) }.compact.join(" ")
-    end
+    private
+      def request_context
+        RequestStore.store[:request_context] || {}
+      end
 
-    def unparse_pair(k, v)
-      v = v.call if v.is_a?(Proc)
-      # only quote strings if they include whitespace
-      if v == nil
-        nil
-      elsif v == true
-        k
-      elsif v.is_a?(Float)
-        "#{k}=#{format("%.3f", v)}"
-      elsif v.is_a?(String) && v =~ /\s/
-        quote_string(k, v)
-      elsif v.is_a?(Time)
-        "#{k}=#{v.iso8601}"
-      else
-        "#{k}=#{v}"
+      def unparse(attrs)
+        attrs.map { |k, v| unparse_pair(k, v) }.compact.join(" ")
       end
-    end
 
-    def quote_string(k, v)
-      # try to find a quote style that fits
-      if !v.include?('"')
-        %{#{k}="#{v}"}
-      elsif !v.include?("'")
-        %{#{k}='#{v}'}
-      else
-        %{#{k}="#{v.gsub(/"/, '\\"')}"}
+      def unparse_pair(k, v)
+        v = v.call if v.is_a?(Proc)
+        # only quote strings if they include whitespace
+        if v == nil
+          nil
+        elsif v == true
+          k
+        elsif v.is_a?(Float)
+          "#{k}=#{format("%.3f", v)}"
+        elsif v.is_a?(String) && v =~ /\s/
+          quote_string(k, v)
+        elsif v.is_a?(Time)
+          "#{k}=#{v.iso8601}"
+        else
+          "#{k}=#{v}"
+        end
       end
-    end
+
+      def quote_string(k, v)
+        # try to find a quote style that fits
+        if !v.include?('"')
+          %{#{k}="#{v}"}
+        elsif !v.include?("'")
+          %{#{k}='#{v}'}
+        else
+          %{#{k}="#{v.gsub(/"/, '\\"')}"}
+        end
+      end
+  end
 end

data/lib/loggerator/metrics.rb

@@ -30,7 +30,6 @@ module Loggerator
     def measure(key, value, units='s')
       log("measure##{name}.#{key}" => "#{value}#{units}")
     end
-
   end
 
   # included Metrics shortcut

data/lib/loggerator/namespace.rb

@@ -4,19 +4,25 @@ module Loggerator
   module Namespace
     include Loggerator
 
-    def log(data={}, &blk)
-      log_namespace!
-      super
+    def self.included(mod)
+      mod.extend self
+    end
+
+    def log(data={}, &block)
+      log_namespace! do
+        super
+      end
     end
 
     def log_error(e, data={})
-      log_namespace!
-      super
+      log_namespace! do
+        super
+      end
     end
 
     private
-      def log_namespace!
-        self.local_context = { ns: self.class.name }
+      def log_namespace!(&block)
+        log_context({ns: kind_of?(Module) ? name : self.class.name }, &block)
       end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: loggerator
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Joshua Mervine
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-23 00:00:00.000000000 Z
+date: 2016-10-12 00:00:00.000000000 Z
 dependencies: []
 description: Simple web application extension for logging, following the 12factor
   pattern.