sapience 0.2.4 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 712bcdf7d21dacd21c564c2026a0fffafda3330d
-  data.tar.gz: 7d0750dea5d0aa3a4c806aec4840149afe98d585
+  metadata.gz: f2ab0f8b23cf762ed9d05be6a9c3da70561f0d72
+  data.tar.gz: da71798a51acb98d05f161264663da01de0e29d0
 SHA512:
-  metadata.gz: 9bed0ad7909f79a32193073372f1f41807bb2ede3c8f0069893b1124239e83349d0518d2c5585c16429ff2814fe24fe411ad3116db04f88307007bf3b3ccd12b
-  data.tar.gz: b9e635cf195f309a22db4f3a092d2119a9f70f98e61b1329eb9900b44890db771b9e2079757e5f0e5e7669bbdc6a24fa88b375d253129cd465bfd1c50165e2b1
+  metadata.gz: 3b8a2241815ad570724c0be06c4f51964577d3b9c38c20f13e3f9273300858bedf9bf5e9b4ffa627803a027824b7a8b826c41a89fa7af94c0b72eef5873547db
+  data.tar.gz: b460a771ddbaf06da86ba135563903ccac31c5b0b661db44fb005b2040070c52b2bc003346d5286771790d0a848207dc19c21dd65849c8226564aa22bd4e24ae

data/.codeclimate.yml

@@ -0,0 +1,21 @@
+---
+engines:
+  csslint:
+    enabled: false
+  duplication:
+    enabled: true
+    config:
+      languages:
+        - ruby
+  eslint:
+    enabled: false
+  fixme:
+    enabled: true
+  rubocop:
+    enabled: true
+ratings:
+  paths:
+    - "**.rb"
+exclude_paths:
+  - config/
+  - spec/

data/.simplecov

@@ -1,19 +1,22 @@
-require "simplecov-json"
-require "codeclimate-test-reporter"
-require "coveralls"
+if ENV['CODECLIMATE_REPO_TOKEN']
+  require "codeclimate-test-reporter"
+  CodeClimate::TestReporter.start
 
-CodeClimate::TestReporter.start
-SimpleCov.maximum_coverage_drop 1
+  # require "coveralls"
+  # Coveralls.wear!
+else
+  require "simplecov-json"
+  SimpleCov.maximum_coverage_drop 1
 
-SimpleCov.formatters = [
-  SimpleCov::Formatter::HTMLFormatter,
-  SimpleCov::Formatter::JSONFormatter,
-  CodeClimate::TestReporter::Formatter,
-  Coveralls::SimpleCov::Formatter,
-]
+  SimpleCov.formatters = [
+    SimpleCov::Formatter::HTMLFormatter,
+    SimpleCov::Formatter::JSONFormatter,
+  ]
 
-SimpleCov.start do
-  add_filter "/spec/"
-  add_filter "/bin/"
-  add_filter "/gemfiles/"
-end
+  SimpleCov.start do
+    add_filter "/spec/"
+    add_filter "/bin/"
+    add_filter "/gemfiles/"
+  end
+
+end

data/.travis.yml

@@ -3,8 +3,8 @@ language: ruby
 services:
   - docker
 script:
-  - docker-compose run rspec
-  - docker-compose run test_app
+  - docker-compose run -e TRAVIS=$TRAVIS -e TRAVIS_BRANCH=$TRAVIS_BRANCH -e TRAVIS_JOB_ID=$TRAVIS_JOB_ID -e TRAVIS_PULL_REQUEST=$TRAVIS_PULL_REQUEST rspec
+  - docker-compose run -e TRAVIS=$TRAVIS -e TRAVIS_BRANCH=$TRAVIS_BRANCH -e TRAVIS_JOB_ID=$TRAVIS_JOB_ID -e TRAVIS_PULL_REQUEST=$TRAVIS_PULL_REQUEST test_app
 notifications:
   slack:
-    secure: apFwkfBQ+3NDJgcLNCHQori9qtr6ePaN3Xx7Sy7NVWwYm9BHNxoX/FN8/hxR63JjXrf1C0hK0FLQ0TiA0BN9PgEEIecg78BvWUwMClDDiwhyYN3H0Bbg35PUFtgDIrOGpu/TYlxNmdHEDYEAxaWsl9wSds8pAJsN6m7VTjGfBwJUDcOiM4L1eRpbp7smPqOjmuQFuOJnO8YkPb+6nUfz53cJrMRUdha89Vgmvnw6cP4/Ms1TsL3vKmMSVbGGh/6WNKPjU6IbuUjwlsh6a9xWxQOk6Wnis/Z+kA+T0XbLMuTLLmzRDuql1tjJeMPi+wukmK1a7GjpPkpkzAgwLQ/CkjTBfIRbMyaBYSuAciuOY8PDtCcT4WLwEvdZbkFmhAdSr1RYxIBpONVfZ/5DT3bpk71+O74OIBqxG6NmkiZ0B6u9/KxbnIINLVAcVaqsN8sdSqWlWKzPm45BfGPXGjmGGgIVFU31rs+W5Zs7IYMNUjZxabYKIv9TsBONbogfbcoGZA+rWWUnQdjypNWJS9wyQDvJ4btxqy8YhDfaV6gF30Un5JcAggMutzKJiYi+qAeh0uN3/9XoXV2N6XBnh58h8ny1NY+0vklWhtFGR1wfFAqkDskvCIZabSeJ5bFM6FtNbNKq9tYciS+eAO1vEYQVDFt9eY2uZF2mFDKRnEegHMU=
+    secure: apFwkfBQ+3NDJgcLNCHQori9qtr6ePaN3Xx7Sy7NVWwYm9BHNxoX/FN8/hxR63JjXrf1C0hK0FLQ0TiA0BN9PgEEIecg78BvWUwMClDDiwhyYN3H0Bbg35PUFtgDIrOGpu/TYlxNmdHEDYEAxaWsl9wSds8pAJsN6m7VTjGfBwJUDcOiM4L1eRpbp7smPqOjmuQFuOJnO8YkPb+6nUfz53cJrMRUdha89Vgmvnw6cP4/Ms1TsL3vKmMSVbGGh/6WNKPjU6IbuUjwlsh6a9xWxQOk6Wnis/Z+kA+T0XbLMuTLLmzRDuql1tjJeMPi+wukmK1a7GjpPkpkzAgwLQ/CkjTBfIRbMyaBYSuAciuOY8PDtCcT4WLwEvdZbkFmhAdSr1RYxIBpONVfZ/5DT3bpk71+O74OIBqxG6NmkiZ0B6u9/KxbnIINLVAcVaqsN8sdSqWlWKzPm45BfGPXGjmGGgIVFU31rs+W5Zs7IYMNUjZxabYKIv9TsBONbogfbcoGZA+rWWUnQdjypNWJS9wyQDvJ4btxqy8YhDfaV6gF30Un5JcAggMutzKJiYi+qAeh0uN3/9XoXV2N6XBnh58h8ny1NY+0vklWhtFGR1wfFAqkDskvCIZabSeJ5bFM6FtNbNKq9tYciS+eAO1vEYQVDFt9eY2uZF2mFDKRnEegHMU=

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## v0.2.3 - Unreleased
+
+- Adds debugging and coverage for sneakers integration
+
 ## v0.2.2
 
 - Add an instance method for the `#name` of the appender

data/Gemfile

@@ -2,11 +2,3 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in sapience.gemspec
 gemspec
-
-gem "pry-nav"
-gem "sentry-raven"
-gem "dogstatsd-ruby"
-gem "rails", "~> 5.0.0.1"
-gem "grape"
-gem "active_model_serializers", "~> 0.10.0"
-gem "rspec-wait"

data/README.md

@@ -62,6 +62,7 @@ Sapience.configure do |config|
     { sentry: { dsn: "https://username:password@app.getsentry.com/00000" } },
     { datadog: { url: "udp://localhost:8125" } },
   ]
+  config.log_executor    = :single_thread_executor
 end
 ```
 
@@ -70,6 +71,7 @@ Sapience provides a default configuration that will be used unless another file
 ```yaml
 ---
 default:
+  log_executor: single_thread_executor
   log_level: info
   appenders:
     - stream:
@@ -77,6 +79,7 @@ default:
         formatter: color
 
 test:
+  log_executor: immediate_executor
   log_level: warn
   appenders:
     - stream:
@@ -84,6 +87,7 @@ test:
         formatter: color
 
 development:
+  log_executor: single_thread_executor
   log_level: debug
   appenders:
     - stream:
@@ -91,6 +95,7 @@ development:
         formatter: color
 
 production:
+  log_executor: single_thread_executor
   log_level: warn
   appenders:
     - stream:

data/config/default.yml

@@ -1,5 +1,6 @@
 ---
 default:
+  log_executor: single_thread_executor
   log_level: info
   appenders:
     - stream:
@@ -7,6 +8,7 @@ default:
         formatter: color
 
 test:
+  log_executor: immediate_executor
   log_level: warn
   appenders:
     - stream:
@@ -14,6 +16,7 @@ test:
         formatter: color
 
 development:
+  log_executor: single_thread_executor
   log_level: debug
   appenders:
     - stream:
@@ -21,6 +24,7 @@ development:
         formatter: color
 
 production:
+  log_executor: single_thread_executor
   log_level: warn
   appenders:
     - stream:

data/docker-compose.yml

@@ -4,6 +4,12 @@ volumes:
     driver: local
 
 services:
+  rabbitmq:
+    image: rabbitmq:latest
+    environment:
+      RABBITMQ_DEFAULT_USER: sapience
+      RABBITMQ_DEFAULT_PASS: tests
+
   rails:
     image: ruby:2.3
     cpu_shares: 4
@@ -24,12 +30,17 @@ services:
 
       # Mount the 'gems' volume on the folder that stores bundled gems:
       - gems:/usr/local/bundle
+
+
   rspec:
     extends:
       service: rails
     entrypoint: /usr/src/app/dev-entrypoint.sh
     command: bundle exec rake
+    depends_on:
+      - rabbitmq
     environment:
+      CODECLIMATE_REPO_TOKEN: 204dc055302da6aed94379e249aa0645636d1d1794920c62db05c5fa968215de
       PATH: /usr/src/app/bin:/usr/local/bundle/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
 
   test_app:
@@ -38,5 +49,8 @@ services:
     working_dir: /usr/src/app/test_app
     entrypoint: /usr/src/app/dev-entrypoint.sh
     command: bundle exec rspec
+    depends_on:
+      - rabbitmq
     environment:
+      AMQP: amqp://sapience:tests@rabbitmq:5672
       PATH: /usr/src/app/bin:/usr/local/bundle/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin

data/lib/sapience/appender/stream.rb

@@ -108,7 +108,6 @@ module Sapience
       #  Ruby or Rails Loggers
       def log(log)
         return false unless should_log?(log)
-
         # Since only one appender thread will be writing to the file at a time
         # it is not necessary to protect access to the file with a semaphore
         # Allow this logger to filter out log levels lower than it's own

data/lib/sapience/base.rb

@@ -128,6 +128,7 @@ module Sapience
     def push_tags(*tags)
       Sapience.push_tags(*tags)
     end
+    alias_method :tags=, :push_tags
 
     # :nodoc:
     def pop_tags(quantity = 1)
@@ -144,6 +145,21 @@ module Sapience
       Sapience.fast_tag(tag, &block)
     end
 
+    # Returns [Sapience::Formatters::Default] formatter default for this subscriber
+    def default_formatter
+      Sapience::Formatters::Default.new
+    end
+
+    # Allow application name to be set globally or per subscriber
+    def application
+      Sapience.config.application
+    end
+
+    # Allow host name to be set globally or per subscriber
+    def host
+      Sapience.config.host
+    end
+
     # Thread specific context information to be logged with every log entry
     #
     # Add a payload to all log calls on This Thread within the supplied block
@@ -271,13 +287,15 @@ module Sapience
         payload = payload.nil? ? self.payload : self.payload.merge(payload)
       end
 
+      merged_tags = merge_tags_with_payload(payload)
       # Add caller stack trace
       backtrace = extract_backtrace if index >= Sapience.config.backtrace_level_index
 
-      log = Log.new(level, Thread.current.name, name, message, payload, Time.now, nil, tags, index, exception, nil, backtrace)
+      log = Log.new(level, Thread.current.name, name, message, payload, Time.now, nil, merged_tags, index, exception, nil, backtrace)
 
       # Logging Hash only?
       # logger.info(name: 'value')
+
       if payload.nil? && exception.nil? && message.is_a?(Hash)
         payload           = message.dup
         min_duration      = payload.delete(:min_duration) || 0.0
@@ -291,13 +309,21 @@ module Sapience
         end
         log.payload = payload if payload.size > 0
       end
-
       self.log(log) if include_message?(log)
     end
     # rubocop:enable AbcSize, PerceivedComplexity, CyclomaticComplexity, LineLength
 
     SELF_PATTERN = File.join("lib", "sapience")
 
+    def merge_tags_with_payload(payload = {})
+      merged_tags = tags.dup
+      if payload.is_a?(Hash)
+        payload_tags = payload.delete(:tags) || []
+        merged_tags.concat(payload_tags) if payload_tags.size > 0
+      end
+      merged_tags.uniq
+    end
+
     # Extract the callers backtrace leaving out Sapience
     def extract_backtrace
       stack = caller
@@ -346,6 +372,9 @@ module Sapience
         if self.payload
           payload = payload.nil? ? self.payload : self.payload.merge(payload)
         end
+
+        merged_tags = merge_tags_with_payload(payload)
+
         if exception
           logged_exception = exception
           backtrace        = nil
@@ -370,7 +399,8 @@ module Sapience
             logged_exception = nil
             backtrace        = exception.backtrace
           end
-          log = Log.new(level, Thread.current.name, name, message, payload, end_time, duration, tags, index, logged_exception, metric, backtrace) # rubocop:disable LineLength
+
+          log = Log.new(level, Thread.current.name, name, message, payload, end_time, duration, merged_tags, index, logged_exception, metric, backtrace) # rubocop:disable LineLength
           self.log(log) if include_message?(log)
           fail exception
         elsif duration >= min_duration
@@ -378,7 +408,7 @@ module Sapience
           # Add caller stack trace
           backtrace = extract_backtrace if index >= Sapience.config.backtrace_level_index
 
-          log = Log.new(level, Thread.current.name, name, message, payload, end_time, duration, tags, index, nil, metric, backtrace) # rubocop:disable LineLength
+          log = Log.new(level, Thread.current.name, name, message, payload, end_time, duration, merged_tags, index, nil, metric, backtrace) # rubocop:disable LineLength
           self.log(log) if include_message?(log)
         end
       end

data/lib/sapience/configuration.rb

@@ -1,30 +1,38 @@
 require "ostruct"
 
 module Sapience
+  UnkownLogLevel = Class.new(StandardError)
+  InvalidLogExecutor = Class.new(StandardError)
+
   # rubocop:disable ClassVars
   class Configuration
     attr_reader :default_level, :backtrace_level, :backtrace_level_index
     attr_writer :host
-    attr_accessor :application, :ap_options, :appenders
+    attr_accessor :application, :ap_options, :appenders, :log_executor
 
+    SUPPORTED_EXECUTORS = %i(single_thread_executor immediate_executor).freeze
     DEFAULT = {
       log_level:   :info,
       application: "Sapience",
       host:        nil,
       ap_options:  { multiline: false },
       appenders:   [{ stream: { io: STDOUT, formatter: :color } }],
+      log_executor: :single_thread_executor,
     }.freeze
 
     # Initial default Level for all new instances of Sapience::Logger
     def initialize(options = {}) # rubocop:disable AbcSize
       fail ArgumentError, "options need to be a hash" unless options.is_a?(Hash)
-      @options             = DEFAULT.merge(options.deep_symbolize_keys!)
+      @options             = DEFAULT.merge(options.deep_symbolize_keyz!)
+      @options[:log_executor] &&= @options[:log_executor].to_sym
+      validate_log_executor!(@options[:log_executor])
       self.default_level   = @options[:log_level].to_sym
       self.backtrace_level = @options[:log_level].to_sym
       self.application     = @options[:application]
       self.host            = @options[:host]
       self.ap_options      = @options[:ap_options]
       self.appenders       = @options[:appenders]
+      self.log_executor    = @options[:log_executor]
     end
 
     # Sets the global default log level
@@ -44,25 +52,35 @@ module Sapience
     def level_to_index(level) # rubocop:disable AbcSize, PerceivedComplexity, CyclomaticComplexity
       return if level.nil?
 
-      index =
-      if level.is_a?(Symbol)
-        LEVELS.index(level)
-      elsif level.is_a?(String)
-        level = level.downcase.to_sym
+      case level
+      when Symbol
         LEVELS.index(level)
-      elsif level.is_a?(Integer) && defined?(::Logger::Severity)
-        # Mapping of Rails and Ruby Logger levels to Sapience levels
-        @@map_levels ||= begin
-          levels = []
-          ::Logger::Severity.constants.each do |constant|
-            levels[::Logger::Severity.const_get(constant)] = LEVELS.find_index(constant.downcase.to_sym) || LEVELS.find_index(:error) # rubocop:disable LineLength
-          end
-          levels
-        end
-        @@map_levels[level]
+      when String
+        LEVELS.index(level.downcase.to_sym)
+      when Integer
+        map_levels[level] || fail_with_unkown_log_level!(level)
+      else
+        fail_with_unkown_log_level!(level)
       end
-      fail "Invalid level:#{level.inspect} being requested. Must be one of #{LEVELS.inspect}" unless index
-      index
+    end
+
+    def fail_with_unkown_log_level!(level)
+      fail UnkownLogLevel,
+        "Invalid level:#{level.inspect} being requested." \
+        " Must be one of #{LEVELS.inspect}"
+    end
+
+    # Mapping of Rails and Ruby Logger levels to Sapience levels
+    def map_levels
+      return [] unless defined?(::Logger::Severity)
+      @@map_levels ||=
+        ::Logger::Severity.constants.each_with_object([]) do |constant, levels|
+          levels[::Logger::Severity.const_get(constant)] = level_by_index_or_error(constant)
+        end
+    end
+
+    def level_by_index_or_error(constant)
+      LEVELS.find_index(constant.downcase.to_sym) || LEVELS.find_index(:error)
     end
 
     def default_level_index
@@ -92,6 +110,9 @@ module Sapience
       @host ||= Socket.gethostname
     end
 
-
+    def validate_log_executor!(log_executor)
+      return true if SUPPORTED_EXECUTORS.include?(log_executor)
+      fail InvalidLogExecutor, "#{log_executor} is unsupported. Use (#{SUPPORTED_EXECUTORS.join(", ")})"
+    end
   end
 end

data/lib/sapience/core_ext/hash.rb

@@ -1,25 +1,28 @@
 class Hash
   # Returns a Hash with all keys symbolized
-  def deep_symbolize_keys!
-    deep_transform_keys! { |key| key.to_sym rescue key } # rubocop:disable RescueModifier
+  def deep_symbolize_keyz!
+    deep_transform_keyz! { |key| key.to_sym rescue key } # rubocop:disable RescueModifier
   end
+  alias_method :deep_symbolize_keys!, :deep_symbolize_keyz!
 
-  def deep_transform_keys!(&block)
-    _deep_transform_keys_in_object!(self, &block)
+  def deep_transform_keyz!(&block)
+    _deep_transform_keyz_in_object!(self, &block)
   end
+  alias_method :deep_transform_keys!, :deep_transform_keyz!
 
-  def _deep_transform_keys_in_object!(object, &block)
+  def _deep_transform_keyz_in_object!(object, &block)
     case object
     when Hash
       object.keys.each do |key|
         value = object.delete(key)
-        object[yield(key)] = _deep_transform_keys_in_object!(value, &block)
+        object[yield(key)] = _deep_transform_keyz_in_object!(value, &block)
       end
       object
     when Array
-      object.map! { |e| _deep_transform_keys_in_object!(e, &block) }
+      object.map! { |e| _deep_transform_keyz_in_object!(e, &block) }
     else
       object
     end
   end
+  alias_method :_deep_transform_keys_in_object!, :_deep_transform_keyz_in_object!
 end

data/lib/sapience/core_ext/symbol.rb

@@ -0,0 +1,15 @@
+class Symbol
+  def camelize(uppercase_first_letter = true)
+    string = to_s
+    string = if uppercase_first_letter
+               string.sub(/^[a-z\d]*/) { $&.capitalize }
+             else
+               string.sub(/^(?:(?=\b|[A-Z_])|\w)/) { $&.downcase }
+             end
+    string.gsub!(/(?:_|(\/))([a-z\d]*)/i) do
+      "#{Regexp.last_match(1)}#{Regexp.last_match(2).capitalize}"
+    end
+    string.gsub!(/\//, "::")
+    string
+  end unless :sym.respond_to?(:camelize)
+end

data/lib/sapience/core_ext/thread.rb

@@ -1,4 +1,5 @@
 require "thread"
+
 class Thread
   # Returns the name of the current thread
   # Default:

data/lib/sapience/extensions/action_cable/tagged_logger_proxy.rb

@@ -1,4 +1,6 @@
 class ActionCable::Connection::TaggedLoggerProxy # rubocop:disable ClassAndModuleChildren
+  alias_method :orig_tag, :tag
+
   def tag(logger, &block)
     current_tags = tags - logger.tags
     logger.tagged(*current_tags, &block)

data/lib/sapience/extensions/action_controller/live.rb

@@ -1,5 +1,7 @@
 # Log actual exceptions, not a string representation
+
 module ActionController::Live # rubocop:disable ClassAndModuleChildren
+  undef_method :log_error
   def log_error(exception)
     logger.fatal(exception)
   end