coaster 1.2.2 → 1.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b275d9ddd61f4631acadb1fee4ebfd3fb1d0bb0856621b732b431721940b460
-  data.tar.gz: f10dfe4a4583ee7ca7594ee514f384d428b3795ff421b420a86b70a89319389e
+  metadata.gz: '095940670cdfde3eac7e9c3ab8818386b9070cf4d19ac405e144296e2bdb2c25'
+  data.tar.gz: 468278966fcdad4349921586d9520a2dd0b84188f52f5f089678f09b88ea7ef8
 SHA512:
-  metadata.gz: 57169b9c338d9499983fbe438d5739d2b82539652f448ed3e703e9c94570fb6f719f16aa628ea7b8928f1db475ed1e3d490acad9b8246ba43792a563cc9fa3a9
-  data.tar.gz: 7dcb832e9d9e855973a6743ec05c12a25fcd78d58806d5b7b2e1c8f85faf6896f397ac82ed008a600dc8d273597593c3ff651cc7f13c0b3637a0c43a07c52056
+  metadata.gz: 9a332cd5b18dd1963a010293352c80939d99c968f4c83d52f02aebf0d50d444eb2ed82ed0590afded4eed2712b58eb550b7ca1f1f90389d42011b920435a7929
+  data.tar.gz: 4fe3cddcca27bc17f0c189e9eb829b68f52f07b9a4b4c6c2a9dcbbaca883c2d2cb4e89f134c159fc0a94888049ac990dbb6c26d7811681f32d995a4e8dcbc22d

data/lib/coaster/core_ext/standard_error.rb

@@ -58,23 +58,23 @@ class StandardError
       msg = hash.delete(:msg) || msg
       msg = hash.delete(:message) || msg
       hash[:description] ||= hash.delete(:desc) if hash[:desc].present?
+      hash[:dev_message] ||= hash.delete(:dm) if hash[:dm].present?
       @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
       @attributes.merge!(hash)
     when String then
       msg = message
     when FalseClass, NilClass then
-      msg = ''
+      msg = nil
     else
       msg = message
     end
 
     @fingerprint = [] unless @fingerprint.is_a?(Array)
     @tags = {} unless @tags.is_a?(Hash)
-    msg ||= self.class._translate
+    msg = cause.message if msg.blank? && cause
     super(msg)
   end
 
@@ -116,10 +116,10 @@ class StandardError
 
   # 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
-    attributes[:description] || attributes[:desc]
-  end
+  def description; attributes[:description] || attributes[:desc] end
   alias_method :desc, :description
+  def dev_message; attributes[:dev_message] end
+  alias_method :dm, :dev_message
 
   def _translate(*args)
     return description if description.present?
@@ -133,7 +133,8 @@ class StandardError
   # user friendly message, for overid
   def user_message
     return description if description.present?
-    _translate
+    return _translate if tkey.present? || dev_message.present?
+    "#{_translate} (#{to_origin_s})"
   end
 
   # another user friendly messages
@@ -143,6 +144,15 @@ class StandardError
     attributes[:descriptions]
   end
 
+  # https://github.com/getsentry/sentry-ruby/blob/fbbc7a51ed10684d0e8b7bd9d2a1b65a7351c9ef/lib/raven/event.rb#L162
+  # sentry message use `to_s` method
+  # https://ruby-doc.org/core-2.5.1/Exception.html#method-i-to_s
+  alias to_origin_s to_s
+
+  def to_s
+    "#{_translate} (#{dev_message || to_origin_s})"
+  end
+
   def to_hash
     hash = attributes.merge(
       type: self.class.name, status: status,

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

@@ -66,17 +66,4 @@ 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.2.2'
+  VERSION = '1.3.4'
 end

data/test/test_standard_error.rb

@@ -21,74 +21,106 @@ module Coaster
     end
 
     def test_standard_messages
-      e = StandardError.new('asdf')
-      assert_equal 'asdf', e.message
+      e = StandardError.new('developer message')
+      assert_equal "standard error translation (developer message)", e.to_s
+      assert_equal "standard error translation (developer message)", 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 translation (developer message)', e.user_message
       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
+      e = StandardError.new(m: 'developer message', desc: 'user message')
+      assert_equal "user message (developer message)", e.to_s
+      assert_equal "user message (developer message)", e.message
+      assert_equal 'user message', e.description
+      assert_equal 'user message', e.desc
+      assert_equal 'user message', e._translate
+      assert_equal 'user message', 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
+      e = UntitledError.new('developer message')
+      assert_equal "standard error translation (developer message)", e.to_s
+      assert_equal "standard error translation (developer message)", 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 translation (developer message)', e.user_message
       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
+      e = UntitledError.new(m: 'developer message', desc: 'user message')
+      assert_equal "user message (developer message)", e.to_s
+      assert_equal "user message (developer message)", e.message
+      assert_equal 'user message', e.description
+      assert_equal 'user message', e.desc
+      assert_equal 'user message', e._translate
+      assert_equal 'user message', e.user_message
+      assert_equal 'standard error title', e.title
+      e = UntitledError.new(tkey: 'no.translation')
+      assert_equal "translation missing: en.no.translation (Coaster::TestStandardError::UntitledError)", e.to_s
+      assert_equal "translation missing: en.no.translation (Coaster::TestStandardError::UntitledError)", e.message
+      assert_nil e.description
+      assert_nil e.desc
+      assert_equal 'translation missing: en.no.translation', e._translate
+      assert_equal "translation missing: en.no.translation", e.user_message
       assert_equal 'standard error title', e.title
     end
 
     def test_with_translation_class
-      e = SampleError.new('asdf')
-      assert_equal 'asdf', e.message
+      e = SampleError.new
+      assert_equal "Test sample error (Coaster::TestStandardError::SampleError)", e.to_s
+      assert_equal "Test sample error (Coaster::TestStandardError::SampleError)", e.message
+      assert_nil e.description
+      assert_nil e.desc
+      assert_equal 'Test sample error', e._translate
+      assert_equal 'Test sample error (Coaster::TestStandardError::SampleError)', e.user_message
+      assert_equal 'Test this title',  e.title
+      e = SampleError.new(beet: 'apple')
+      assert_equal "Test sample error (Coaster::TestStandardError::SampleError)", e.to_s
+      assert_equal "Test sample error (Coaster::TestStandardError::SampleError)", e.message
+      assert_nil e.description
+      assert_nil e.desc
+      assert_equal 'Test sample error', e._translate
+      assert_equal 'Test sample error (Coaster::TestStandardError::SampleError)', e.user_message
+      assert_equal 'Test this title',  e.title
+      e = SampleError.new('developer message')
+      assert_equal "Test sample error (developer message)", e.to_s
+      assert_equal "Test sample error (developer message)", e.message
+      assert_nil e.description
+      assert_nil e.desc
+      assert_equal 'Test sample error', e._translate
+      assert_equal 'Test sample error (developer message)', e.user_message
+      assert_equal 'Test this title', e.title
+      e = SampleError.new(dm: 'developer message')
+      assert_equal "Test sample error (developer message)", e.to_s
+      assert_equal "Test sample error (developer message)", 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
+      e = SampleError.new(m: 'developer message', desc: 'user message')
+      assert_equal "user message (developer message)", e.to_s
+      assert_equal "user message (developer message)", e.message
+      assert_equal 'user message', e.description
+      assert_equal 'user message', e.desc
+      assert_equal 'user message', e._translate
+      assert_equal 'user message', e.user_message
       assert_equal 'Test this title', e.title
       e = SampleError.new(tkey: 'sample.interpolation', value: 'blah')
-      assert_equal 'Test sample error', e.message
+      assert_equal "Sample Interpolation blah (Coaster::TestStandardError::SampleError)", e.to_s
+      assert_equal "Sample Interpolation blah (Coaster::TestStandardError::SampleError)", e.message
       assert_nil e.description
       assert_nil e.desc
       assert_equal 'Sample Interpolation blah', e._translate
       assert_equal 'Sample Interpolation blah', e.user_message
-      assert_equal 'Sample Interpolation blah / Test sample error', e.to_s
       assert_equal 'Test this title', e.title
     end
 
     def test_message
       raise SampleError, {m: 'beer is proof'}
     rescue => e
-      assert_equal 'beer is proof', e.message
+      assert_equal "Test sample error (beer is proof)", e.message
     end
 
     def test_attributes
@@ -108,12 +140,12 @@ module Coaster
       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 "Test example error (Test sample error (#{SampleError.name}))", 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']
+      assert_equal "Test sample error (Coaster::TestStandardError::SampleError)", e.to_hash['cause']['message']
     end
 
     def test_cause_attributes
@@ -137,7 +169,7 @@ module Coaster
     rescue => e
       detail = <<-LOG
 [Coaster::TestStandardError::ExampleError] status:20
-	MESSAGE: Test sample error
+	MESSAGE: Test example error (Test sample error (Coaster::TestStandardError::SampleError))
 	@fingerprint: []
 	@tags: {}
 	@level: \"error\"
@@ -145,7 +177,7 @@ module Coaster
 	@tkey: nil
 	@raven: {}
 	CAUSE: [Coaster::TestStandardError::SampleError] status:10
-		MESSAGE: Test sample error
+		MESSAGE: Test sample error (Coaster::TestStandardError::SampleError)
 		@fingerprint: []
 		@tags: {}
 		@level: \"error\"
@@ -194,7 +226,7 @@ LOG
       begin
         root_cause_sample3
       rescue => e
-        assert_equal 'a', e.root_cause.message
+        assert_equal "standard error translation (a)", e.root_cause.message
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: coaster
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.3.4
 platform: ruby
 authors:
 - buzz jung
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-13 00:00:00.000000000 Z
+date: 2020-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -80,62 +80,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry-stack_explorer
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry-byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry-doc
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement