Rename to macros

vectordotdev · Aug 21, 2016 · af779f1 · af779f1
1 parent a74e1f5
commit af779f1
Show file tree

Hide file tree

Showing 27 changed files with 43 additions and 43 deletions.
diff --git a/lib/timber.rb b/lib/timber.rb
@@ -2,7 +2,7 @@
 require "json" # brings to_json to the core classes
 
 # Base (must come first, order matters)
-require "timber/core"
+require "timber/macros"
 require "timber/patterns"
 require "timber/config"
 require "timber/context"

diff --git a/lib/timber/context.rb b/lib/timber/context.rb
@@ -61,7 +61,7 @@ def valid?
       def json_payload
         @json_payload ||= {
           _root_key => {
-            :_dt => Core::DateFormatter.format(_dt),
+            :_dt => Macros::DateFormatter.format(_dt),
             :_version => _version
           }
         }

diff --git a/lib/timber/context_snapshot.rb b/lib/timber/context_snapshot.rb
@@ -20,7 +20,7 @@ def context_hash(options = {})
         filtered = stack.select { |context| !(options[:except] || []).include?(context.class) }
         filtered.each do |context|
           specific_hash = context.as_json_with_index(indexes[context])
-          hash.replace(Core::DeepMerger.merge(hash, specific_hash))
+          hash.replace(Macros::DeepMerger.merge(hash, specific_hash))
         end
         hash["_version"] = CONTEXT_VERSION
       end

diff --git a/lib/timber/contexts/exception.rb b/lib/timber/contexts/exception.rb
@@ -28,7 +28,7 @@ def message
 
       private
         def json_payload
-          @json_payload ||= Core::DeepMerger.merge({
+          @json_payload ||= Macros::DeepMerger.merge({
             _root_key => {
               # order is relevant for logfmt styling
               :name => name,

diff --git a/lib/timber/contexts/http_request.rb b/lib/timber/contexts/http_request.rb
@@ -6,7 +6,7 @@ class HTTPRequest < Context
 
       private
         def json_payload
-          @json_payload ||= Core::DeepMerger.merge({
+          @json_payload ||= Macros::DeepMerger.merge({
             _root_key => {
               # order is relevant for logfmt styling
               :method => method,

diff --git a/lib/timber/contexts/http_requests/action_controller_specific.rb b/lib/timber/contexts/http_requests/action_controller_specific.rb
@@ -31,7 +31,7 @@ def format
         private
           def json_payload
             @json_payload ||= {
-              Rack._root_key => Core::DeepMerger.merge({
+              Rack._root_key => Macros::DeepMerger.merge({
                 _root_key => {
                   # order is relevant for logfmt styling
                   :controller => controller,

diff --git a/lib/timber/contexts/http_response.rb b/lib/timber/contexts/http_response.rb
@@ -7,7 +7,7 @@ class HTTPResponse < Context
 
       private
         def json_payload
-          @json_payload ||= Core::DeepMerger.merge({
+          @json_payload ||= Macros::DeepMerger.merge({
             _root_key => {
               # order is relevant for logfmt styling
               :status => status,

diff --git a/lib/timber/contexts/logger.rb b/lib/timber/contexts/logger.rb
@@ -14,7 +14,7 @@ def initialize(level, progname)
 
       private
         def json_payload
-          @json_payload ||= Core::DeepMerger.merge({
+          @json_payload ||= Macros::DeepMerger.merge({
             _root_key => {
               # order is relevant for logfmt styling
               :level => level,

diff --git a/lib/timber/contexts/organization.rb b/lib/timber/contexts/organization.rb
@@ -22,7 +22,7 @@ def valid?
 
       private
         def json_payload
-          @json_payload ||= Core::DeepMerger.merge({
+          @json_payload ||= Macros::DeepMerger.merge({
             _root_key => {
               # order is relevant for logfmt styling
               :id => id,

diff --git a/lib/timber/contexts/server.rb b/lib/timber/contexts/server.rb
@@ -12,7 +12,7 @@ def hostname
 
       private
         def json_payload
-          @json_payload ||= Core::DeepMerger.merge({
+          @json_payload ||= Macros::DeepMerger.merge({
             _root_key => {
               :hostname => hostname
             }

diff --git a/lib/timber/contexts/servers/heroku_specific.rb b/lib/timber/contexts/servers/heroku_specific.rb
@@ -32,7 +32,7 @@ def parts
 
           def json_payload
             @json_payload ||= {
-              Server._root_key => Core::DeepMerger.merge({
+              Server._root_key => Macros::DeepMerger.merge({
                 _root_key => {
                   # order is relevant for logfmt styling
                   :process_type => process_type,

diff --git a/lib/timber/contexts/sql_queries/active_record_specific.rb b/lib/timber/contexts/sql_queries/active_record_specific.rb
@@ -38,7 +38,7 @@ def transaction_id
         private
           def json_payload
             @json_payload ||= {
-              SQLQuery._root_key => Core::DeepMerger.merge({
+              SQLQuery._root_key => Macros::DeepMerger.merge({
                 _root_key => {
                   :binds => binds.as_json,
                   :connection_id => connection_id,

diff --git a/lib/timber/contexts/sql_query.rb b/lib/timber/contexts/sql_query.rb
@@ -7,7 +7,7 @@ class SQLQuery < Context
 
       private
         def json_payload
-          @json_payload ||= Core::DeepMerger.merge({
+          @json_payload ||= Macros::DeepMerger.merge({
             _root_key => {
               # order is relevant for logfmt styling
               :sql => sql,

diff --git a/lib/timber/contexts/template_render.rb b/lib/timber/contexts/template_render.rb
@@ -6,7 +6,7 @@ class TemplateRender < Context
 
       private
         def json_payload
-          @json_payload ||= Core::DeepMerger.merge({
+          @json_payload ||= Macros::DeepMerger.merge({
             _root_key => {
               # order is relevant for logfmt styling
               :name => name,

diff --git a/lib/timber/contexts/template_renders/action_view_specific.rb b/lib/timber/contexts/template_renders/action_view_specific.rb
@@ -31,7 +31,7 @@ def layout
         private
           def json_payload
             @json_payload ||= {
-              TemplateRender._root_key => Core::DeepMerger.merge({
+              TemplateRender._root_key => Macros::DeepMerger.merge({
                 _root_key => {
                   :cache_hits => cache_hits,
                   :count => count,

diff --git a/lib/timber/contexts/user.rb b/lib/timber/contexts/user.rb
@@ -27,7 +27,7 @@ def valid?
 
       private
         def json_payload
-          @json_payload ||= Core::DeepMerger.merge({
+          @json_payload ||= Macros::DeepMerger.merge({
             _root_key => {
               # order is relevant for logfmt styling
               :id => id,

diff --git a/lib/timber/core.rb b/lib/timber/core.rb
diff --git a/lib/timber/core/rejecter.rb b/lib/timber/core/rejecter.rb
diff --git a/lib/timber/log_devices/io.rb b/lib/timber/log_devices/io.rb
@@ -37,7 +37,7 @@ def context_hash
           end
 
           def encoded_hash
-            @encoded_hash ||= Core::LogfmtEncoder.encode(context_hash)
+            @encoded_hash ||= Macros::LogfmtEncoder.encode(context_hash)
           end
       end
 

diff --git a/lib/timber/log_line.rb b/lib/timber/log_line.rb
@@ -21,7 +21,7 @@ def initialize(message)
     end
 
     def formatted_dt
-      @formatted_dt ||= Core::DateFormatter.format(dt)
+      @formatted_dt ||= Macros::DateFormatter.format(dt)
     end
 
     private

diff --git a/lib/timber/macros.rb b/lib/timber/macros.rb
@@ -0,0 +1,4 @@
+require "timber/macros/compactor"
+require "timber/macros/date_formatter"
+require "timber/macros/deep_merger"
+require "timber/macros/logfmt_encoder"
diff --git a/lib/timber/macros/compactor.rb b/lib/timber/macros/compactor.rb
@@ -0,0 +1,16 @@
+module Timber
+  module Macros
+    module Compactor
+      def self.compact(hash)
+        new_hash = {}
+        hash.each do |k, v|
+          deep_v = v.is_a?(Hash) ? compact(v) : v
+          if !v.nil? && v != [] && v != {}
+            new_hash[k] = v
+          end
+        end
+        new_hash
+      end
+    end
+  end
+end
diff --git a/lib/timber/core/date_formatter.rb → lib/timber/macros/date_formatter.rb b/lib/timber/core/date_formatter.rb → lib/timber/macros/date_formatter.rb
@@ -1,5 +1,5 @@
 module Timber
-  module Core
+  module Macros
     module DateFormatter
       def self.format(dt)
         dt.send(APISettings::DATE_FORMAT, APISettings::DATE_FORMAT_PRECISION)

diff --git a/lib/timber/core/deep_merger.rb → lib/timber/macros/deep_merger.rb b/lib/timber/core/deep_merger.rb → lib/timber/macros/deep_merger.rb
@@ -1,5 +1,5 @@
 module Timber
-  module Core
+  module Macros
     # Deep merges hash keys
     module DeepMerger
       def self.merge(first, second)

diff --git a/lib/timber/core/logfmt_encoder.rb → lib/timber/macros/logfmt_encoder.rb b/lib/timber/core/logfmt_encoder.rb → lib/timber/macros/logfmt_encoder.rb
@@ -1,5 +1,5 @@
 module Timber
-  module Core
+  module Macros
     # Encodes a hash into a logfmt string
     module LogfmtEncoder
       KEY_DELIMITER = ".".freeze

diff --git a/lib/timber/patterns/to_json.rb b/lib/timber/patterns/to_json.rb
@@ -8,7 +8,7 @@ def as_json(*args)
         @as_json[args] ||= begin
           hash = json_payload # only call the function once incase it is not cached
           hash = hash.respond_to?(:as_json) ? hash.as_json(*args) : hash
-          hash.reject { |k,v| v.nil? || v == [] || v == {} }
+          Macros::Compactor.compact(hash)
         end
       end
 

diff --git a/spec/timber/core/logfmt_encoder_spec.rb → spec/timber/macros/logfmt_encoder_spec.rb b/spec/timber/core/logfmt_encoder_spec.rb → spec/timber/macros/logfmt_encoder_spec.rb
@@ -1,6 +1,6 @@
 require "spec_helper"
 
-describe Timber::Core::LogfmtEncoder do
+describe Timber::Macros::LogfmtEncoder do
   describe ".encode" do
     subject { described_class.encode(target) }