coaster 1.0.3 → 1.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df1ca619424ece483c0dc2dd1f6ae0fde7c725752ab5593b8c0219baf219a4ea
-  data.tar.gz: 465e303a6d645d934df100415de58202fbc09cdccc3ebe27eee9a519c6d58ae4
+  metadata.gz: 30a1cd3050a41f9d174b8f163bc73c86519e46535c875664e044d09b5bf5f1a6
+  data.tar.gz: 309a1fd5431ced086709b694f9f7a95f330f5342dc09841729f491ab6f8276ca
 SHA512:
-  metadata.gz: 0c091ac873ec7798bf4e7d412184474a8c9d528fe1c654dd1034f3b997938453976f69465d32a5c3ac5340ae468e15c33d84de905790901964cdf969dc6d1e88
-  data.tar.gz: f7b9c0f618501191fa8f1c881cf41a03c0304f5d14b1163bc38d986b1321bd7c41048085756133e3654c75b41bf9d51c25292e5e2a7709e483d6c754443e09cd
+  metadata.gz: 9d93263418966554adf4ec4f509a2cd77f8ab3f478d1aeaa9188e1b36856e1ba5dad2ae8e988bbfb28a5324b790da7dc23e429e6f1e0df1f369d0008414dc45d
+  data.tar.gz: be7411b223a6db84e0e53d738010ad4a620f73b9e2424cb0bfa3c5b9ab5a47bf0d16797c419aa5fd393bc291a67a6946db29f7b783cd79a0230ff3a88a4fdd37

data/lib/coaster/core_ext/standard_error.rb

@@ -4,19 +4,34 @@ class StandardError
   cattr_accessor :cleaner, :cause_cleaner
 
   class << self
-    def status
-      999999 # Unknown
-    end
+    def status; 999999 end # Unknown
     alias_method :code, :status
-
-    def http_status
-      500
-    end
+    def http_status;  500 end
+    def report?;      true end
+    def intentional?; false end
 
     def title
       t = _translate('.title')
       t.instance_variable_defined?(:@missing) ? nil : t
     end
+
+    def before_logging(name, &block)
+      @before_logging_blocks ||= {}
+      @before_logging_blocks[name] = block
+    end
+    def before_logging_blocks
+      @before_logging_blocks ||= {}
+      superclass <= StandardError ? superclass.before_logging_blocks.merge(@before_logging_blocks) : @before_logging_blocks
+    end
+
+    def after_logging(name, &block)
+      @after_logging_blocks ||= {}
+      @after_logging_blocks[name] = block
+    end
+    def after_logging_blocks
+      @after_logging_blocks ||= {}
+      superclass <= StandardError ? superclass.after_logging_blocks.merge(@after_logging_blocks) : @after_logging_blocks
+    end
   end
 
   attr_accessor :tags, :level, :tkey, :fingerprint
@@ -66,17 +81,11 @@ class StandardError
     super(msg)
   end
 
-  def safe_message
-    message || ''
-  end
-
-  def status
-    self.class.status
-  end
-
-  def title
-    attributes[:title] || self.class.title
-  end
+  def safe_message; message || '' end
+  def status;       self.class.status end
+  def before_logging_blocks; self.class.before_logging_blocks end
+  def after_logging_blocks; self.class.after_logging_blocks end
+  def root_cause;   cause.respond_to?(:root_cause) ? cause.root_cause : self end
 
   def attributes
     return @attributes if defined?(@attributes)
@@ -88,21 +97,25 @@ class StandardError
   end
   alias_method :attr, :attributes
 
-  def http_status
-    attributes[:http_status] || self.class.http_status
-  end
-
-  def http_status=(value)
-    attributes[:http_status] = value
-  end
-
-  def code
-    attributes[:code] || status
-  end
-
-  def code=(value)
-    attributes[:code] = value
-  end
+  def http_status;         attributes[:http_status] || self.class.http_status end
+  def http_status=(value); attributes[:http_status] = value end
+  def code;         attributes[:code] || status end
+  def code=(value); attributes[:code] = value end
+  def title;        attributes[:title] || self.class.title end
+  def it_might_happen?;      attributes[:it] == :might_happen      end
+  def it_should_not_happen?; attributes[:it] == :should_not_happen end
+  def report?
+    return attributes[:report] if attributes.key?(:report)
+    return false if it_might_happen?
+    self.class.report?
+  end
+  def intentional? # not logging in test
+    return attributes[:intentional] if attributes.key?(:intentional)
+    return true if it_should_not_happen?
+    self.class.intentional?
+  end
+  def object;       attributes[:object] || attributes[:obj] end
+  alias_method :obj, :object
 
   # description is user friendly messages, do not use error's message
   # error message is not user friendly in many cases.
@@ -122,15 +135,6 @@ class StandardError
     attributes[:descriptions]
   end
 
-  def object
-    attributes[:object] || attributes[:obj]
-  end
-  alias_method :obj, :object
-
-  def root_cause
-    cause.respond_to?(:root_cause) ? cause.root_cause : self
-  end
-
   def to_hash
     hash = attributes.merge(
       type: self.class.name, status: status,
@@ -198,16 +202,24 @@ class StandardError
   end
 
   def logging(options = {})
-    logger = options[:logger] || Coaster.logger
-    logger = Rails.logger if logger.nil? && defined?(Rails)
-    return nil unless logger
+    before_logging_blocks.values.each { |blk| instance_exec &blk }
+
+    logger = nil
+    if defined?(Rails)
+      return if Rails.env.test? && (intentional? || !report?)
+      logger = Rails.logger 
+    end
+    logger = options[:logger] || Coaster.logger || logger
+    return unless logger
 
     cl = options[:cleaner] || cleaner
     msg = to_detail
 
     if cl && backtrace
+      bt = cl.clean(backtrace)
+      bt = bt[0..2] if intentional?
       msg += "\tBACKTRACE:\n\t"
-      msg += cl.clean(backtrace).join("\n\t")
+      msg += bt.join("\n\t")
     end
 
     if level && logger.respond_to?(level)
@@ -215,5 +227,8 @@ class StandardError
     else
       logger.error(msg)
     end
+    msg
+  ensure
+    after_logging_blocks.values.each { |blk| instance_exec &blk }
   end
 end

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

@@ -38,7 +38,7 @@ class StandardError
 
   def capture(options = {})
     return if options.key?(:report) && !options[:report]
-    return if attributes.key?(:report) && !attributes[:report]
+    return unless report?
     nt = notes(options)
     Raven.capture_exception(self, level: nt[:level]) do |event|
       event.user.merge!(nt[:user] || {})

data/lib/coaster/version.rb

@@ -1,3 +1,3 @@
 module Coaster
-  VERSION = '1.0.3'
+  VERSION = '1.0.8'
 end

data/test/test_helper.rb

@@ -6,3 +6,8 @@ require 'pry'
 require 'rubygems'
 require 'bundler/setup'
 require 'coaster'
+
+class Raven
+  def self.capture_exception(*args)
+  end
+end

data/test/test_standard_error.rb

@@ -155,5 +155,28 @@ LOG
       e.descriptions.merge!(a: 1)
       assert_equal e.descriptions['a'], 1
     end
+
+    class SampleErrorSub < SampleError; end
+    class SampleErrorSubSub < SampleErrorSub
+      def it_might_happen?; true end
+    end
+    SampleError.after_logging(:blah) do 
+      self.attributes[:abc] = 100
+      @blah = 101
+    end
+    def test_before_logging
+      e = SampleErrorSubSub.new(m: 'foo')
+      assert !e.after_logging_blocks[:blah].nil?
+      e.logging
+      assert_equal e.attributes[:abc], 100
+      assert_equal e.instance_variable_get(:@blah), 101
+    end
+    class SampleErrorMightHappen < SampleErrorSub
+      def it_might_happen?; true end
+    end
+    def test_might_happen
+      e = SampleErrorMightHappen.new('fbar')
+      assert !e.report?
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: coaster
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.8
 platform: ruby
 authors:
 - buzz jung
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-07 00:00:00.000000000 Z
+date: 2020-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -226,7 +226,7 @@ signing_key:
 specification_version: 4
 summary: A little convenient feature for standard library
 test_files:
-- test/test_helper.rb
-- test/test_standard_error.rb
-- test/locales/en.yml
 - test/test_object_translation.rb
+- test/locales/en.yml
+- test/test_standard_error.rb
+- test/test_helper.rb