hickory 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8323da74f958271cc269e96d887a91bd2dc9c332
-  data.tar.gz: '08513b8506eb3d6affff977b7e31c7ab81ee47a8'
+SHA256:
+  metadata.gz: 9d315687d17e63b704dc7748ffad0ca866d5d224c42b2469003faff0061881af
+  data.tar.gz: 63fd0fb477d88a8b853819daa412b4c6440692f34b2de7174d2e80867144d840
 SHA512:
-  metadata.gz: 5ee86b80177c2630e89c80097d022822960f4ab01795db5e439f89cbf61d87f4ac4c9b0be7a0ce25727284856b1ad491b80fe64c2bb4dc5e5a3da6a8e0be9b53
-  data.tar.gz: 875a82f096b38573f50145474f5e2456b0ca9221ad1685faf4fe80cb10cc00b15e0eb60aca3875d1daacaf801be8d07832d86a4e9f71e9922882d56b1d123060
+  metadata.gz: d025b8a858179df3aa938580e1cb9b07daabc7346b029a821f8fae183a4ec093660cf28b688a692c91616c811a97dbda99cba5cfde2045be196781cf8f96951b
+  data.tar.gz: 687f88ddf0731a3974bfc2592e4ff802fca7415eab8f48167e578b829e98f5bff9b2e73938f145146d4ac0bd812a54a6ecab77b5c5668da7fcb389699b73b891

data/.gitignore

@@ -1,3 +1,4 @@
+.byebug_history
 /.bundle/
 /.yardoc
 /_yardoc/

data/Gemfile

@@ -1,4 +1,4 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 

data/Gemfile.lock

@@ -2,21 +2,76 @@ PATH
   remote: .
   specs:
     hickory (0.1.1)
+      activesupport (>= 5.1)
+      railties (>= 5.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    actionpack (6.0.0)
+      actionview (= 6.0.0)
+      activesupport (= 6.0.0)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actionview (6.0.0)
+      activesupport (= 6.0.0)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activesupport (6.0.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.1, >= 2.1.8)
+    builder (3.2.3)
+    byebug (11.0.1)
+    concurrent-ruby (1.1.5)
+    crass (1.0.4)
+    erubi (1.8.0)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    loofah (2.2.3)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (0.9.2)
+    mini_portile2 (2.4.0)
     minitest (5.11.3)
+    nokogiri (1.10.4)
+      mini_portile2 (~> 2.4.0)
+    rack (2.0.7)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.2.0)
+      loofah (~> 2.2, >= 2.2.2)
+    railties (6.0.0)
+      actionpack (= 6.0.0)
+      activesupport (= 6.0.0)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.20.3, < 2.0)
     rake (10.5.0)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    zeitwerk (2.1.9)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler (~> 1.16)
+  byebug (~> 11.0, >= 11.0.1)
   hickory!
   minitest (~> 5.0)
   rake (~> 10.0)
 
 BUNDLED WITH
-   1.16.1
+   1.17.2

data/Rakefile

@@ -1,10 +1,10 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
+require 'bundler/gem_tasks'
+require 'rake/testtask'
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
 end
 
-task :default => :test
+task default: :test

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "hickory"
+require 'bundler/setup'
+require 'hickory'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +10,5 @@ require "hickory"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/hickory.gemspec

@@ -19,7 +19,11 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.add_runtime_dependency 'activesupport', '>= 5.1'
+  spec.add_runtime_dependency 'railties',      '>= 5.1'
+
   spec.add_development_dependency 'bundler', '~> 1.16'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'mocha', '~> 1.9.0'
 end

data/lib/hickory.rb

@@ -1,64 +1,6 @@
 require 'hickory/logger'
+require 'hickory/rails' if defined? ::Rails
 require 'hickory/version'
 
 module Hickory
-  module_function
-
-  def initialize_canonical_logs(app)
-    require 'hickory/ext/rails/rack/logger'
-
-    self.application = app
-    Hickory.ignore_if  = config.ignore_if
-
-    Hickory.remove_existing_log_subscriptions
-    Hickory::LogSubscribers::ActionController.attach_to :action_controller
-    Hickory::LogSubscribers::ActionMailer.attach_to :action_mailer
-    Hickory::LogSubscribers::ActiveJob.attach_to :active_job
-  end
-
-  def application
-    @@application
-  end
-
-  def application=(app)
-    @@application = app
-  end
-
-  def ignore_if
-    @@ignore_if
-  end
-
-  def ignore_if=(check)
-    @@ignore_if = check
-  end
-
-  def config
-    application.config.hickory
-  end
-
-  def remove_existing_log_subscriptions
-    ActiveSupport::LogSubscriber.log_subscribers.each do |subscriber|
-      case subscriber
-      when ActionView::LogSubscriber
-        unsubscribe(:action_view, subscriber)
-      when ActionController::LogSubscriber
-        unsubscribe(:action_controller, subscriber)
-      when ActionMailer::LogSubscriber
-        unsubscribe(:action_mailer, subscriber)
-      when ActiveJob::Logging::LogSubscriber
-        unsubscribe(:active_job, subscriber)
-      end
-    end
-  end
-
-  def unsubscribe(component, subscriber)
-    events = subscriber.public_methods(false).reject { |method| method.to_s == 'call' }
-    events.each do |event|
-      ActiveSupport::Notifications.notifier.listeners_for("#{event}.#{component}").each do |listener|
-        if listener.instance_variable_get('@delegate') == subscriber
-          ActiveSupport::Notifications.unsubscribe listener
-        end
-      end
-    end
-  end
-end
+end

data/lib/hickory/formatters/json.rb

@@ -1,25 +1,31 @@
+require 'json'
+
+require 'active_support/json'
+require 'active_support/tagged_logging'
+
 module Hickory
   module Formatters
     class JSON < ::Logger::Formatter
+      include ActiveSupport::TaggedLogging::Formatter
+
       def initialize(options = {})
-        @key_mappings = Hash.new.tap { |mapping|
+        @key_mapping = Hash.new.tap { |mapping|
           mapping[:message]   = options.fetch(:message_key, :message)
           mapping[:severity]  = options.fetch(:severity_key, :level)
           mapping[:timestamp] = options.fetch(:timestamp_key, :timestamp)
-          mapping[:env]       = options.fetch(:env_key, :env)
         }
       end
 
       def call(severity, time, progname, msg)
         line = msg.tap { |message|
-          message[@key_mappings[:message]]      = msg.delete(:message) unless @key_mappings[:message] == :message
-          message[@key_mappings[:timestamp]]    = time
-          message[@key_mappings[:severity]]     = severity
-          message[@key_mappings[:env]]          = Rails.env
-          message[:progname]                    = progname if progname.present?
+          message[@key_mapping[:message]]   = msg.delete(:message) unless @key_mapping[:message] == :message
+          message[@key_mapping[:timestamp]] = time
+          message[@key_mapping[:severity]]  = severity
+          message[:progname]                = progname unless progname.nil?
+          message[:tags]                    = current_tags unless current_tags.empty?
         }
 
-        line.to_json
+        "#{line.to_json}\n"
       end
     end
   end

data/lib/hickory/formatters/simple.rb

@@ -1,11 +1,18 @@
+require 'active_support/tagged_logging'
+
 module Hickory
   module Formatters
     class Simple < ::Logger::Formatter
+      include ActiveSupport::TaggedLogging::Formatter
+
       def call(severity, time, progname, msg)
         message  = msg.delete(:message)
-        metadata = msg.map {|k,v| "#{k}=#{v}" }.join(' ')
+        metadata = msg.map {|k,v| "#{k}=#{v}" }
+
+        message.prepend "#{tags_text}" unless current_tags.empty?
+        message << " #{metadata.join(' ')}" unless metadata.empty?
 
-        "#{message} #{metadata}\n"
+        "#{message}\n"
       end
     end
   end

data/lib/hickory/log_subscribers/action_controller.rb

@@ -2,7 +2,7 @@ module Hickory
   module LogSubscribers
     class ActionController < ActiveSupport::LogSubscriber
       def process_action(event)
-        return if Hickory.ignore_if.present? && Hickory.ignore_if.call(event)
+        return if Hickory::Rails.ignore_if.present? && Hickory::Rails.ignore_if.call(event)
 
         payload = event.payload
         default_keys = %i[method format controller action user_id request_id]

data/lib/hickory/logger.rb

@@ -34,7 +34,16 @@ module Hickory
         end
       end
     end
-  end
-end
 
-require 'hickory/railtie' if defined?(Rails)
+    delegate :push_tags, :pop_tags, :clear_tags!, to: :formatter
+
+    def tagged(*tags)
+      formatter.tagged(*tags) { yield self }
+    end
+
+    def flush
+      clear_tags!
+      super if defined?(super)
+    end
+  end
+end

data/lib/hickory/rails.rb

@@ -0,0 +1,55 @@
+require 'active_support/log_subscriber'
+require 'active_support/core_ext/module/attribute_accessors'
+
+require 'hickory/rails/railtie'
+require 'hickory/log_subscribers/action_controller'
+require 'hickory/log_subscribers/action_mailer'
+require 'hickory/log_subscribers/active_job'
+
+module Hickory
+  module Rails
+    module_function
+
+    mattr_accessor :application, :ignore_if
+
+    def setup(app)
+      self.application = app
+      self.ignore_if   = config.ignore_if
+
+      remove_existing_log_subscriptions
+      Hickory::LogSubscribers::ActionController.attach_to :action_controller
+      Hickory::LogSubscribers::ActionMailer.attach_to :action_mailer
+      Hickory::LogSubscribers::ActiveJob.attach_to :active_job
+    end
+
+    def config
+      application.config.hickory
+    end
+
+    def remove_existing_log_subscriptions
+      ActiveSupport::LogSubscriber.log_subscribers.each do |subscriber|
+        case subscriber
+        when ActionView::LogSubscriber
+          unsubscribe(:action_view, subscriber)
+        when ActionController::LogSubscriber
+          unsubscribe(:action_controller, subscriber)
+        when ActionMailer::LogSubscriber
+          unsubscribe(:action_mailer, subscriber)
+        when ActiveJob::Logging::LogSubscriber
+          unsubscribe(:active_job, subscriber)
+        end
+      end
+    end
+
+    def unsubscribe(component, subscriber)
+      events = subscriber.public_methods(false).reject { |method| method.to_s == 'call' }
+      events.each do |event|
+        ActiveSupport::Notifications.notifier.listeners_for("#{event}.#{component}").each do |listener|
+          if listener.instance_variable_get('@delegate') == subscriber
+            ActiveSupport::Notifications.unsubscribe listener
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hickory/rails/railtie.rb

@@ -0,0 +1,15 @@
+require 'rails/railtie'
+require 'active_support/ordered_options'
+
+module Hickory
+  module Rails
+    class Railtie < ::Rails::Railtie
+      config.hickory = ActiveSupport::OrderedOptions.new
+      config.hickory.enabled = false
+
+      config.after_initialize do |app|
+        Hickory::Rails.setup(app) if app.config.hickory.enabled
+      end
+    end
+  end
+end

data/lib/hickory/version.rb

@@ -1,3 +1,3 @@
 module Hickory
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: hickory
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - blahed
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-28 00:00:00.000000000 Z
+date: 2019-09-05 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.9.0
 description: 
 email:
 - trvsdnn@gmail.com
@@ -70,15 +112,14 @@ files:
 - bin/setup
 - hickory.gemspec
 - lib/hickory.rb
-- lib/hickory/ext/rails/rack/logger.rb
 - lib/hickory/formatters/json.rb
 - lib/hickory/formatters/simple.rb
 - lib/hickory/log_subscribers/action_controller.rb
 - lib/hickory/log_subscribers/action_mailer.rb
 - lib/hickory/log_subscribers/active_job.rb
-- lib/hickory/log_subscribers/base.rb
 - lib/hickory/logger.rb
-- lib/hickory/railtie.rb
+- lib/hickory/rails.rb
+- lib/hickory/rails/railtie.rb
 - lib/hickory/version.rb
 homepage: 
 licenses:
@@ -99,8 +140,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: An opinionated logger for rails and ruby.

data/lib/hickory/ext/rails/rack/logger.rb

@@ -1,21 +0,0 @@
-require 'active_support/concern'
-require 'rails/rack/logger'
-
-module Rails
-  module Rack
-    # Overwrites defaults of Rails::Rack::Logger that cause
-    # unnecessary logging.
-    # This effectively removes the log lines from the log
-    # that say:
-    # Started GET / for 192.168.2.1...
-    class Logger
-      # Overwrites Rails 3.2 code that logs new requests
-      def call_app(*args)
-        env = args.last
-        @app.call(env)
-      ensure
-        ActiveSupport::LogSubscriber.flush_all!
-      end
-    end
-  end
-end

data/lib/hickory/log_subscribers/base.rb

@@ -1,68 +0,0 @@
-require 'json'
-require 'action_pack'
-require 'active_support/core_ext/class/attribute'
-require 'active_support/log_subscriber'
-# require 'action_view/log_subscriber'
-# require 'action_controller/log_subscriber'
-# require 'request_store'
-
-module Hickory
-  module LogSubscribers
-    class Base < ActiveSupport::LogSubscriber
-      # def logger
-      #   Lograge.logger.presence || super
-      # end
-
-      private
-
-      # def process_main_event(event)
-      #   # return if Lograge.ignore?(event)
-      #
-      #   payload = event.payload
-      #   data = extract_request(event, payload)
-      #   data = before_format(data, payload)
-      #   formatted_message = Lograge.formatter.call(data)
-      #   logger.send(Lograge.log_level, formatted_message)
-      # end
-      #
-      # def extract_request(event, payload)
-      #   data = initial_data(payload)
-      #   data.merge!(extract_status(payload))
-      #   data.merge!(extract_runtimes(event, payload))
-      #   data.merge!(extract_location)
-      #   data.merge!(extract_unpermitted_params)
-      #   data.merge!(custom_options(event))
-      # end
-      #
-      # %i(initial_data extract_status extract_runtimes
-      #    extract_location extract_unpermitted_params).each do |method_name|
-      #   define_method(method_name) { |*_arg| {} }
-      # end
-      #
-      # def extract_status(payload)
-      #   if (status = payload[:status])
-      #     { status: status.to_i }
-      #   elsif (error = payload[:exception])
-      #     exception, message = error
-      #     { status: get_error_status_code(exception), error: "#{exception}: #{message}" }
-      #   else
-      #     { status: 0 }
-      #   end
-      # end
-      #
-      # def get_error_status_code(exception)
-      #   status = ActionDispatch::ExceptionWrapper.rescue_responses[exception]
-      #   Rack::Utils.status_code(status)
-      # end
-      #
-      # def custom_options(event)
-      #   options = Lograge.custom_options(event) || {}
-      #   options.merge event.payload[:custom_payload] || {}
-      # end
-      #
-      # def before_format(data, payload)
-      #   Lograge.before_format(data, payload)
-      # end
-    end
-  end
-end

data/lib/hickory/railtie.rb

@@ -1,18 +0,0 @@
-require 'rails/railtie'
-require 'active_support/ordered_options'
-
-# require 'hickory/log_subscribers/base'
-require 'hickory/log_subscribers/action_controller'
-require 'hickory/log_subscribers/action_mailer'
-require 'hickory/log_subscribers/active_job'
-
-module Hickory
-  class Railtie < Rails::Railtie
-    config.hickory = ActiveSupport::OrderedOptions.new
-    config.hickory.canonical_request_lines = false
-
-    config.after_initialize do |app|
-      Hickory.initialize_canonical_logs(app) if app.config.hickory.canonical_request_lines
-    end
-  end
-end