coaster 0.2.1 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2c58a466dfd273e9573f9aae56ea3eb2e2bec440
-  data.tar.gz: a0a164c43f5fe9425581b14872e8b394c336e462
+  metadata.gz: ff07fb211e83da4a3ec0ea6d4fa1feef919b811a
+  data.tar.gz: a3d02429755c8269e99df86cd5d714d76d60967d
 SHA512:
-  metadata.gz: f066892ea068143a9dbfdba6b774d2548557af98b5674aa9867e01f5adca711b089ab59f4a916721388ae36e7b1e5d8b04d78b14ac5ba7454e974531fef060c5
-  data.tar.gz: dd633c17c96eba2394bf91caff61c6333f1d01b57d77f71440c03d7d9005bff0d2fc51306f397b347d7b96826b5bbd3d65cbe6ade7325bed669ba57b37010a91
+  metadata.gz: 3477640a65dbcc0fa4fefcd82883b2287bc37254922258e0cfc5f58fb91a96a7f3e608a690d767e98b705dbc0019cd3112ef7b284653b0bd9ef7621278a61d95
+  data.tar.gz: 1a51dc6965dc02a94922fcaeba376bc97e4a9322da48e0a27bf9dd3f560fe845710de4de36e3dd8a8a20d1493c612bf6a07ed3bc71fa634676c8dc7ce3a1a88f

data/lib/coaster/core_ext/standard_error/raven.rb

@@ -4,22 +4,11 @@ class StandardError
   alias_method :initialize_original, :initialize
   def initialize(message = nil, cause = $!)
     initialize_original(message, cause)
-    @raven = (attributes.delete(:raven) || {}).with_indifferent_access
-    @raven[:fingerprint] ||= attributes[:fingerprint] || [:default]
+    @raven = (attributes.delete(:raven) || attributes.delete(:sentry) || {}).with_indifferent_access
   end
 
-  def fingerprint=(*fp)
-    raven[:fingerprint] = fp
-  end
-
-  def fingerprint
-    raven[:fingerprint]
-  end
-
-  def capture(options = {})
-    notes = raven.merge(options || {})
-
-    notes[:fingerprint] = notes[:fingerprint].flatten.map do |fp|
+  def raven_fingerprint
+    (fingerprint || Coaster.default_raven_fingerprint).flatten.map do |fp|
       if fp == true || fp == :class
         self.class.name
       elsif fp == :default
@@ -27,13 +16,25 @@ class StandardError
       else
         fp
       end
-    end
-    notes[:tags] ||= {}
+    end.flatten
+  end
+
+  def notes(options = {})
+    opts = options ? options.dup : {}
+    extra_opts = opts.slice!(:fingerprint, :tags, :level, :extra)
+    opts[:extra] = extra_opts.merge(opts[:extra] || {})
+    notes = raven.merge(opts)
+
+    notes[:fingerprint] ||= raven_fingerprint
+    notes[:tags] ||= (tags && tags.merge(notes[:tags] || {})) || {}
     notes[:tags] = notes[:tags].merge(environment: Rails.env) if defined?(Rails)
     notes[:level] ||= self.level
-    notes[:extra] = (notes[:extra] || {}).merge(attributes)
+    notes[:extra] = attributes.merge(notes[:extra])
+    notes
+  end
 
-    Raven.annotate_exception(self, notes)
+  def capture(options = {})
+    Raven.annotate_exception(self, notes(options))
     Raven.capture_exception(self)
   rescue => e
     msg = "#{e.class.name}: #{e.message}"
@@ -41,9 +42,17 @@ class StandardError
     Raven.logger.error(msg)
   end
 
+  # options
+  #   :logger
+  #   :cleaner
+  #   :fingerprint
+  #   :tags
+  #   :level
+  #   :extra
+  #   and others are merged to extra
   alias_method :just_logging, :logging
   def logging(options = {})
-    capture(options[:raven])
+    capture(options)
     just_logging(options)
   end
 end

data/lib/coaster/core_ext/standard_error.rb

@@ -1,5 +1,3 @@
-require 'active_support/core_ext/class/attribute_accessors'
-require 'active_support/core_ext/string'
 require 'coaster/core_ext/object_translation'
 
 class StandardError
@@ -21,10 +19,11 @@ class StandardError
     end
   end
 
-  attr_accessor :tags, :level, :tkey
+  attr_accessor :tags, :level, :tkey, :fingerprint
 
   def initialize(message = nil, cause = $!)
-    @tags = []
+    @fingerprint = Coaster.default_fingerprint
+    @tags = {}
     @level = 'error'
     @attributes = HashWithIndifferentAccess.new
     @tkey = nil
@@ -34,6 +33,7 @@ class StandardError
         msg = message
         set_backtrace(message.backtrace)
       when StandardError
+        @fingerprint = message.fingerprint
         @tags = message.tags
         @level = message.level
         @tkey = message.tkey
@@ -42,10 +42,11 @@ class StandardError
         set_backtrace(message.backtrace)
       when Hash then
         hash = message.with_indifferent_access rescue message
-        msg = hash[:message]
-        msg = hash[:msg] if msg.nil?
-        msg = hash[:m] if msg.nil?
-        @tags = Array(hash.delete(:tags) || hash.delete(:tag))
+        msg = hash.delete(:m)
+        msg = hash.delete(:msg) || msg
+        msg = hash.delete(:message) || msg
+        @fingerprint = hash.delete(:fingerprint) || hash.delete(:fingerprints)
+        @tags = hash.delete(:tags) || hash.delete(:tag)
         @level = hash.delete(:level) || hash.delete(:severity) || @level
         @tkey = hash.delete(:tkey)
         msg = cause.message if msg.nil? && cause
@@ -59,6 +60,8 @@ class StandardError
         @attributes[:object] = message
     end
 
+    @fingerprint = [] unless @fingerprint.is_a?(Array)
+    @tags = {} unless @tags.is_a?(Hash)
     msg = nil if msg == false
     super(msg)
     set_backtrace(cause.backtrace) if cause
@@ -161,6 +164,18 @@ class StandardError
     lg << "\n"
   end
 
+  def rails_tag
+    (fingerprint || Coaster.default_fingerprint).flatten.map do |fp|
+      if fp == true || fp == :class
+        self.class.name
+      elsif fp == :default || fp == '{{ default }}'
+        nil
+      else
+        fp
+      end
+    end.compact
+  end
+
   def logging(options = {})
     logger = options[:logger]
     logger = Rails.logger if logger.nil? && defined?(Rails)
@@ -174,7 +189,7 @@ class StandardError
       msg += cleaner.clean(backtrace).join("\n\t\t")
     end
 
-    logger.tagged(*tags) do
+    logger.tagged(*rails_tag) do
       if logger.respond_to?(level)
         logger.send(level, msg)
       else

data/lib/coaster/version.rb

@@ -1,3 +1,3 @@
 module Coaster
-  VERSION = '0.2.1'
+  VERSION = '0.3.3'
 end

data/lib/coaster.rb

@@ -1,13 +1,23 @@
 require 'active_support/core_ext/hash/indifferent_access'
 require 'active_support/core_ext/module/attribute_accessors'
+require 'active_support/core_ext/class/attribute_accessors'
+require 'active_support/core_ext/string'
+require 'active_support/core_ext/hash/slice'
 
 module Coaster
   mattr_accessor :logger
+  mattr_writer   :default_fingerprint
+
+  DEFAULT_FINGERPRINT = [:default, :class]
 
   class << self
     def configure
       yield self
     end
+
+    def default_fingerprint
+      @@default_fingerprint ||= DEFAULT_FINGERPRINT
+    end
   end
 end
 

data/test/test_standard_error.rb

@@ -1,5 +1,6 @@
 require 'test_helper'
 require 'minitest/autorun'
+require 'coaster/core_ext/standard_error/raven'
 
 module Coaster
   class TestStandardError < Minitest::Test
@@ -74,16 +75,20 @@ module Coaster
       detail = <<-LOG
 [Coaster::TestStandardError::ExampleError] status:20
 	MESSAGE: Coaster::TestStandardError::SampleError
-	@tags: []
+	@fingerprint: []
+	@tags: {}
 	@level: \"error\"
 	@attributes: {\"wat\"=>\"cha\"}
 	@tkey: nil
+	@raven: {}
 	CAUSE: [Coaster::TestStandardError::SampleError] status:10
 		MESSAGE: Coaster::TestStandardError::SampleError
-		@tags: []
+		@fingerprint: []
+		@tags: {}
 		@level: \"error\"
 		@attributes: {\"frog\"=>\"rams\"}
 		@tkey: nil
+		@raven: {}
 LOG
       assert_equal(detail, e.to_detail)
     end
@@ -129,5 +134,11 @@ LOG
         assert_equal e.root_cause.message, 'a'
       end
     end
+
+    def test_raven_notes
+      raise SampleError, m: 'foofoo', something: 'other'
+    rescue => e
+      assert_equal e.notes(the_other: 'something'), {something: 'other', the_other: 'something'}.with_indifferent_access
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: coaster
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.3
 platform: ruby
 authors:
 - buzz jung
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-06 00:00:00.000000000 Z
+date: 2016-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n