coaster 1.0.5 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71910814edd2fcc1011e2f7bbc0d5003d3ffacca49d8a60f4869859d7c911afd
-  data.tar.gz: 5898b403bcb2263ff96c70721f724b5f91d9e52dff474f90a9ea854effba5676
+  metadata.gz: c85271d1d65e61c492464d2e3bc610bad2fa784ba3da758e246c599ba655262c
+  data.tar.gz: b2715ff440d638cdd164338a1c55b4c689cdad95e54a65b66c29d8ad5e7d7d75
 SHA512:
-  metadata.gz: dd1a8ee8e2f472633ef7ea34588cde48d77cb053ad186aac02702c806afbb4dd8829ece4892e456413ca6c840afa77d637f9fa2e068922319b4a4bd850ded75e
-  data.tar.gz: 8996da8e600df0d704353b89daba9f2c97b4261e4b77c7be32aa32644cb8c8018ef8b4f323de6186f5e6deeabe44f304ca0979a4c1b96abf714300487e0d11db
+  metadata.gz: f74c50dce4b7d64a44ec89a67814d2ce2ee1b9c8b89b75aae0fe4dbe05182ac444ac7903f1a5585d227cdb890f566727506722c9878ed12bcd1a583aea42080f
+  data.tar.gz: 19fd1dad72c06d49b5f3a380519a5f1ec7677c201d0485e6eceea866739513989decadafd396733dcffb66392b9ef8dd609feb2a510d307c9ab6e60e36a6faa8

data/lib/coaster.rb

@@ -5,7 +5,7 @@ require 'active_support/core_ext/string'
 require 'active_support/core_ext/hash/slice'
 
 module Coaster
-  mattr_accessor :logger
+  mattr_writer   :logger
   mattr_writer   :default_fingerprint
 
   DEFAULT_FINGERPRINT = [:default, :class].freeze
@@ -18,6 +18,16 @@ module Coaster
     def default_fingerprint
       @@default_fingerprint ||= DEFAULT_FINGERPRINT
     end
+
+    def logger
+      return @@logger if defined?(@@logger) && @@logger
+      return Rails.logger if defined?(Rails)
+      nil
+    end
+  end
+
+  def logger
+    self.class.logger
   end
 end
 

data/lib/coaster/core_ext/object_translation.rb

@@ -4,7 +4,7 @@ class Object
   class << self
     def _translate(*args)
       options = args.last.is_a?(Hash) ? args.pop : {}
-      options.merge!(_translate_params)
+      options = _translate_params.merge(options)
       options = options.to_hash.symbolize_keys!
 
       key = args.shift
@@ -45,7 +45,10 @@ class Object
 
         if key_class.superclass == Object || key_class == Object
           return options[:description] if options[:description].present?
-          Coaster.logger && Coaster.logger.warn(result)
+          if Coaster.logger 
+            Coaster.logger.info(options[:original_missing])
+            Coaster.logger.debug(caller.join("\n"))
+          end
           throw :exception, result if options[:original_throw]
           missing = options[:original_missing] || result
           msg = missing.message
@@ -61,6 +64,7 @@ class Object
         result = result.dup if result.frozen?
         result.instance_variable_set(:@translated, true)
         result.instance_variable_set(:@tkey, options[:tkey])
+        result.instance_variable_set(:@missing, options[:original_missing])
         result
       end
     end
@@ -78,16 +82,7 @@ class Object
   def _translate(*args)
     options = (args.last.is_a?(Hash) ? args.pop : {}).with_indifferent_access
     key = args.shift || (respond_to?(:tkey) ? tkey : nil)
-
-    if respond_to?(:description) && description.present? && description != 'false' && description != self.class.name
-      if !key.is_a?(String) && key != :force
-        desc = description
-        return desc unless desc.instance_variable_get(:@raw)
-      end
-      options.merge!(description: description)
-    end
-
-    options.merge!(_translate_params)
+    options = _translate_params.merge(options)
     self.class._translate(key, *args, options)
   end
 

data/lib/coaster/core_ext/standard_error.rb

@@ -9,10 +9,24 @@ class StandardError
     def http_status;  500 end
     def report?;      true end
     def intentional?; false end
+    def title; _translate('.title') end
 
-    def title
-      t = _translate('.title')
-      t.instance_variable_defined?(:@missing) ? nil : t
+    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
 
@@ -43,6 +57,7 @@ class StandardError
       msg = hash.delete(:m)
       msg = hash.delete(:msg) || msg
       msg = hash.delete(:message) || msg
+      hash[:description] ||= hash.delete(:desc) if hash[:desc].present?
       @fingerprint = hash.delete(:fingerprint) || hash.delete(:fingerprints)
       @tags = hash.delete(:tags) || hash.delete(:tag)
       @level = hash.delete(:level) || hash.delete(:severity) || @level
@@ -65,6 +80,8 @@ class StandardError
 
   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
@@ -82,23 +99,40 @@ class StandardError
   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 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
+  # description is user friendly message as a attribute, do not use error's message
   # error message is not user friendly in many cases.
   def description
-    dsc = attributes[:description] || attributes[:desc]
-    return dsc if dsc
-    msg = safe_message.dup
-    msg.instance_variable_set(:@raw, true)
-    msg
+    attributes[:description] || attributes[:desc]
   end
   alias_method :desc, :description
 
-  # more user friendly messages
+  def _translate(*args)
+    return description if description.present?
+    super
+  end
+
+  # user friendly message, for overid
+  def user_message
+    return description if description.present?
+    _translate
+  end
+
+  # another user friendly messages
   def descriptions
     return attributes[:descriptions] if attributes[:descriptions]
     attributes[:descriptions] = {}
@@ -120,13 +154,6 @@ class StandardError
     hash
   end
 
-  def _translate_params
-    attributes.merge(
-      type: self.class.name, status: status,
-      http_status: http_status, message: message
-    )
-  end
-
   def to_json
     Oj.dump(to_hash.with_indifferent_access, mode: :compat)
   end
@@ -172,13 +199,17 @@ class StandardError
   end
 
   def logging(options = {})
-    return unless report?
-    logger = nil
-    if defined?(Rails)
-      return if Rails.env.test? && intentional?
-      logger = Rails.logger 
+    before_logging_blocks.values.each { |blk| instance_exec &blk }
+
+    if !report? || intentional?
+      if defined?(Rails)
+        return if Rails.env.test?
+      else
+        return
+      end
     end
-    logger = options[:logger] || Coaster.logger || logger
+
+    logger = options[:logger] || Coaster.logger
     return unless logger
 
     cl = options[:cleaner] || cleaner
@@ -196,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

@@ -66,4 +66,17 @@ class StandardError
     capture(options)
     just_logging(options)
   end
+
+  # https://github.com/getsentry/sentry-ruby/blob/fbbc7a51ed10684d0e8b7bd9d2a1b65a7351c9ef/lib/raven/event.rb#L162
+  # sentry use `to_s` as a message
+  alias to_origin_s to_s
+  def message
+    to_origin_s
+  end
+
+  def to_s
+    str = super # https://ruby-doc.org/core-2.5.1/Exception.html#method-i-to_s
+    str = "#{user_message} / #{str}" if user_message.present?
+    str
+  end
 end

data/lib/coaster/version.rb

@@ -1,3 +1,3 @@
 module Coaster
-  VERSION = '1.0.5'
+  VERSION = '1.2.1'
 end

data/test/locales/en.yml

@@ -1,5 +1,8 @@
 en:
   class:
+    StandardError: 
+      self: 'standard error translation'
+      title: 'standard error title'
     Coaster:
       self: 'Coaster Translated'
       SampleObject:

data/test/test_helper.rb

@@ -6,3 +6,12 @@ require 'pry'
 require 'rubygems'
 require 'bundler/setup'
 require 'coaster'
+require 'logger'
+
+class Raven
+  def self.capture_exception(*args)
+  end
+end
+
+Coaster.logger = Logger.new(STDOUT)
+Coaster.logger.level = Logger::WARN

data/test/test_object_translation.rb

@@ -37,6 +37,7 @@ module Coaster
     def test_translation_sub
       assert_equal 'Coaster SampleObject Title (class.Coaster.SampleObject.title)', SampleObject._translate('.title')
       assert_equal 'Coaster SampleObject Title (class.Coaster.SampleObject.title)', SampleObject._translate(:title)
+      assert_nil SampleObject._translate(:title).instance_variable_get(:@missing)
     end
 
     def test_translation_with_key
@@ -46,6 +47,7 @@ module Coaster
     def test_translation_inheritance
       assert_equal 'Coaster SampleObject Translated', Inherited._translate
       assert_equal 'Coaster SampleObject Title (class.Coaster.Inherited.title)', Inherited._translate(:title)
+      assert Inherited._translate.instance_variable_get(:@missing)
     end
 
     def test_interpolation

data/test/test_standard_error.rb

@@ -20,6 +20,63 @@ module Coaster
       I18n.enforce_available_locales = false
     end
 
+    def test_standard_messages
+      e = StandardError.new('asdf')
+      assert_equal 'asdf', e.message
+      assert_nil e.description
+      assert_nil e.desc
+      assert_equal 'standard error translation', e._translate
+      assert_equal 'standard error translation', e.user_message
+      assert_equal 'standard error translation / asdf', e.to_s
+      assert_equal 'standard error title', e.title
+      e = StandardError.new(m: 'foo', desc: 'bar')
+      assert_equal 'foo', e.message
+      assert_equal 'bar', e.description
+      assert_equal 'bar', e.desc
+      assert_equal 'bar', e._translate
+      assert_equal 'bar', e.user_message
+      assert_equal 'standard error title', e.title
+      assert_equal 'bar / foo', e.to_s
+    end
+
+    def test_no_translation_class
+      e = UntitledError.new('asdf')
+      assert_equal 'asdf', e.message
+      assert_nil e.description
+      assert_nil e.desc
+      assert_equal 'standard error translation', e._translate
+      assert_equal 'standard error translation', e.user_message
+      assert_equal 'standard error translation / asdf', e.to_s
+      assert_equal 'standard error title', e.title
+      e = UntitledError.new(m: 'foo', desc: 'bar')
+      assert_equal 'foo', e.message
+      assert_equal 'bar', e.description
+      assert_equal 'bar', e.desc
+      assert_equal 'bar', e._translate
+      assert_equal 'bar', e.user_message
+      assert_equal 'bar / foo', e.to_s
+      assert_equal 'standard error title', e.title
+    end
+
+    def test_with_translation_class
+      e = SampleError.new('asdf')
+      assert_equal 'asdf', e.message
+      assert_nil e.description
+      assert_nil e.desc
+      assert_equal 'Test sample error', e._translate
+      assert_equal 'Test sample error', e.user_message
+      assert_equal 'Test sample error / asdf', e.to_s
+      assert_equal 'Test this title', e.title
+      e = SampleError.new(m: 'foo', desc: 'bar')
+      assert_equal 'foo', e.message
+      assert_equal 'bar', e.description
+      assert_equal 'bar', e.desc
+      assert_equal 'bar', e._translate
+      assert_equal 'bar', e.user_message
+      assert_equal 'bar / foo', e.to_s
+      assert_equal 'Test this title', e.title
+    end
+
     def test_message
       raise SampleError, {m: 'beer is proof'}
     rescue => e
@@ -39,16 +96,16 @@ module Coaster
         raise ExampleError, {wat: 'cha'}
       end
     rescue => e
-      assert_equal e.to_hash['wat'], 'cha'
-      assert_equal e.to_hash['type'], 'Coaster::TestStandardError::ExampleError'
-      assert_equal e.to_hash['status'], 20
-      assert_equal e.to_hash['http_status'], 500
-      assert_equal e.to_hash['message'], 'Test sample error'
-      assert_equal e.to_hash['cause']['frog'], 'rams'
-      assert_equal e.to_hash['cause']['type'], 'Coaster::TestStandardError::SampleError'
-      assert_equal e.to_hash['cause']['status'], 10
-      assert_equal e.to_hash['cause']['http_status'], 500
-      assert_equal e.to_hash['cause']['message'], 'Test sample error'
+      assert_equal 'cha', e.to_hash['wat']
+      assert_equal 'Coaster::TestStandardError::ExampleError', e.to_hash['type']
+      assert_equal 20, e.to_hash['status']
+      assert_equal 500, e.to_hash['http_status']
+      assert_equal 'Test sample error', e.to_hash['message']
+      assert_equal 'rams', e.to_hash['cause']['frog']
+      assert_equal 'Coaster::TestStandardError::SampleError', e.to_hash['cause']['type']
+      assert_equal 10, e.to_hash['cause']['status']
+      assert_equal 500, e.to_hash['cause']['http_status']
+      assert_equal 'Test sample error', e.to_hash['cause']['message']
     end
 
     def test_cause_attributes
@@ -58,9 +115,9 @@ module Coaster
         raise ExampleError, {wat: 'cha'}
       end
     rescue => e
-      assert_equal e.cause.attr['frog'], 'rams'
-      assert_equal e.attr['frog'], 'rams'
-      assert_equal e.attr['wat'], 'cha'
+      assert_equal 'rams', e.cause.attr['frog']
+      assert_equal 'rams', e.attr['frog']
+      assert_equal 'cha', e.attr['wat']
     end
 
     def test_to_detail
@@ -94,19 +151,19 @@ LOG
     def test_translation
       raise SampleError, {tkey: '.test'}
     rescue => e
-      assert_equal e._translate, 'Test this translation'
+      assert_equal 'Test this translation', e._translate
     end
 
     def test_title
       raise SampleError, 'foobar'
     rescue => e
-      assert_equal e.title, 'Test this title'
+      assert_equal 'Test this title', e.title
     end
 
     def test_title_missing
       raise UntitledError, 'untitled'
     rescue => e
-      assert_nil e.title
+      assert_equal 'standard error title', e.title
     end
 
     def root_cause_sample1
@@ -129,31 +186,54 @@ LOG
       begin
         root_cause_sample3
       rescue => e
-        assert_equal e.root_cause.message, 'a'
+        assert_equal 'a', e.root_cause.message
       end
     end
 
     def test_raven_notes
       raise SampleError, m: 'foofoo', something: 'other'
     rescue => e
-      assert_equal e.notes(the_other: 'something')[:extra][:something], 'other'
-      assert_equal e.notes(the_other: 'something')[:extra][:the_other], 'something'
+      assert_equal 'other', e.notes(the_other: 'something')[:extra][:something]
+      assert_equal 'something', e.notes(the_other: 'something')[:extra][:the_other]
     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'/
+      assert_equal 'NameError', e.to_hash['type']
+      assert_equal 999999, e.to_hash['status']
+      assert_equal 500, e.to_hash['http_status']
+      assert_match /undefined local variable or method `aa'/, e.to_hash['message']
     end
 
     def test_descriptions
       raise SampleError
     rescue => e
       e.descriptions.merge!(a: 1)
-      assert_equal e.descriptions['a'], 1
+      assert_equal 1, e.descriptions['a']
+    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 100, e.attributes[:abc]
+      assert_equal 101, e.instance_variable_get(:@blah)
+    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.5
+  version: 1.2.1
 platform: ruby
 authors:
 - buzz jung
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-08 00:00:00.000000000 Z
+date: 2020-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 6.0.3.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 6.0.3.1
 - !ruby/object:Gem::Dependency
   name: attr_extras
   requirement: !ruby/object:Gem::Requirement
@@ -70,114 +70,114 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry-stack_explorer
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: shoulda
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: shoulda-context
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
 description: Ruby Core Extensions
 email: buzz@frograms.com
 executables: []
@@ -221,12 +221,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: A little convenient feature for standard library
 test_files:
+- test/test_object_translation.rb
 - test/test_helper.rb
 - test/test_standard_error.rb
 - test/locales/en.yml
-- test/test_object_translation.rb