coaster 1.0.1 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7bb245ac61cf472e066e9f33934edfb00b715b07a2745ba30dcee503d973fbee
-  data.tar.gz: 133b5ae2c21130ff0b9ed27d03388b5f682b7ff95f31c2c455f2a36b62084cf4
+  metadata.gz: cb23e4c7362906cc9877bde117d7f1027adc08726b718526dd16bfe967355553
+  data.tar.gz: f23ecb00881002158f99bc56daa261317f54b0620de3c6766b4fab93dc0d1e31
 SHA512:
-  metadata.gz: c26dfe88f571581a60fac9c5f7a4594ce6929e7dbee7aab4bd3b134e29e595ab8f3ee2dd912110625a810deef1bf5ef0c67e8935c4b9d9a5e1fd459a8a23b2ca
-  data.tar.gz: 983374e824e12b9da051ec0a246e65a6aaa0fe35c1bb75561aaff3398f4ffcd9f63009b6db97f23ff163ba073563400be07368103f9595b28049e489a7f39e3c
+  metadata.gz: b95bdef229ab03c481d31bf5f768ab9e1dec2a7d4d638d3bf1418da33e0665759030de2ef621fad94860b697373b8988dbe61b7955c479e7c9c1e3288c4ac656
+  data.tar.gz: 57982252eddf851fe0245a8b141aeaab2e3213219ef49688ef59004cf9478054a1849e016f80289b5f3e93e2ec84f8b022fb3e8991bfc602aa1401709eebf481

data/lib/coaster/core_ext/object_translation.rb

@@ -39,13 +39,13 @@ class Object
       end
 
       if result.is_a?(I18n::MissingTranslation)
-        Coaster.logger && Coaster.logger.warn(result)
         unless options.key?(:original_missing)
           options.merge!(original_missing: result)
         end
 
         if key_class.superclass == Object || key_class == Object
           return options[:description] if options[:description].present?
+          Coaster.logger && Coaster.logger.warn(result)
           throw :exception, result if options[:original_throw]
           missing = options[:original_missing] || result
           msg = missing.message

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.after_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,15 @@ 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 report?;      attributes.key?(:report) ? attributes[:report] : self.class.report? end
+  def intentional?; attributes.key?(:intentional) ? attributes[:intentional] : 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.
@@ -115,17 +118,15 @@ class StandardError
   end
   alias_method :desc, :description
 
-  def object
-    attributes[:object] || attributes[:obj]
-  end
-  alias_method :obj, :object
-
-  def root_cause
-    cause.respond_to?(:root_cause) ? cause.root_cause : self
+  # more user friendly messages
+  def descriptions
+    return attributes[:descriptions] if attributes[:descriptions]
+    attributes[:descriptions] = {}
+    attributes[:descriptions]
   end
 
   def to_hash
-    hash = @attributes.merge(
+    hash = attributes.merge(
       type: self.class.name, status: status,
       http_status: http_status, message: message
     )
@@ -191,16 +192,25 @@ 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 }
+
+    return unless report?
+    logger = nil
+    if defined?(Rails)
+      return if Rails.env.test? && intentional?
+      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)
@@ -208,5 +218,7 @@ class StandardError
     else
       logger.error(msg)
     end
+
+    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.1'
+  VERSION = '1.0.6'
 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

@@ -139,5 +139,31 @@ LOG
       assert_equal e.notes(the_other: 'something')[:extra][:something], 'other'
       assert_equal e.notes(the_other: 'something')[:extra][:the_other], 'something'
     end
+
+    def test_to_hash
+      aa # raise NameError
+    rescue => e
+      assert_equal e.to_hash['type'], 'NameError'
+      assert_equal e.to_hash['status'], 999999
+      assert_equal e.to_hash['http_status'], 500
+      assert e.to_hash['message'] =~ /undefined local variable or method `aa'/
+    end
+
+    def test_descriptions
+      raise SampleError
+    rescue => e
+      e.descriptions.merge!(a: 1)
+      assert_equal e.descriptions['a'], 1
+    end
+
+    class SampleErrorSub < SampleError; end
+    class SampleErrorSubSub < SampleErrorSub; end
+    SampleError.after_logging(:blah) { @blah = 101 }
+    def test_before_logging
+      e = SampleErrorSubSub.new(m: 'foo')
+      assert !e.after_logging_blocks[:blah].nil?
+      e.logging
+      assert_equal e.instance_variable_get(:@blah), 101
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: coaster
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.6
 platform: ruby
 authors:
 - buzz jung
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-04 00:00:00.000000000 Z
+date: 2020-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n