coaster 1.3.3 → 1.3.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 33d174be37c41745be18836a83e051931f9c7eff099bc65d4bfbdb292e467732
-  data.tar.gz: 8c822b6bad5a1d334057a5cd577e8f236b201cfc74cd8ce6bd1c6586190880ab
+  metadata.gz: 03f82d0ec684919dbdd18695f9c9b44accf45defa3260b7fcfeaadaf511b5869
+  data.tar.gz: 963dd53ba23fe26a009308b6065d25d58ec0a32713980479840f86d4fd71ed71
 SHA512:
-  metadata.gz: 58cfb38ecda73be57102b58e19d1badabc1a6ddf87717df4d8e6dc74b918fdf7f4e7d3569cffdb32968c3a5adc79b33930b14e534e6d1176656b22048a7a2951
-  data.tar.gz: 2886f1c69b87eda652641e8f28e48fb1514c8e8d1fe0d65973a93d63553426ea8dedd6012f27058b483f3ec293233e1468a1c67763a02ac1e0208804b9b1ff80
+  metadata.gz: ce52bb11a0aa053e521ff7261b079ae47e424846ecb7937596112cb5ec2a42b56a0f13afddb222a1c1bc333685f94c9fc97478865067fd44b1ce9eb5596515be
+  data.tar.gz: 7b6278654542c48270b3c817d1bf15f404da41c0bf36d546f9f7dac2f229a322c119fe0760690acd7011511433808a8fa228e8d62b53300cb21fc0bb9a3af9a9

data/lib/coaster/core_ext/require_more.rb

@@ -0,0 +1,22 @@
+def require_more
+  required_file_path = caller[0].split(':', 2).first
+  load_name = nil
+  load_path_index = $LOAD_PATH.each_with_index do |load_path, ix|
+    scanned = required_file_path.scan(/(#{load_path})#{File::SEPARATOR}(.*)/).first
+    next false unless scanned
+    load_name = scanned[1]
+    break ix
+  end
+
+  return false unless load_path_index
+
+  more_load_paths = $LOAD_PATH.drop(load_path_index + 1)
+  more_load_paths.each do |load_path|
+    path = File.join(load_path, load_name)
+    if File.exists?(path)
+      return require_dependency path
+    end
+  end
+
+  raise LoadError, "cannot require more -- #{load_name}"
+end

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

@@ -0,0 +1,69 @@
+class StandardError
+  attr_writer :raven
+
+  alias_method :initialize_original, :initialize
+  def initialize(message = nil, cause = $!)
+    initialize_original(message, cause)
+    @raven = (attributes.delete(:raven) || attributes.delete(:sentry) || {}).with_indifferent_access
+  end
+
+  def raven
+    @raven ||= {}.with_indifferent_access
+  end
+
+  def raven_fingerprint
+    (fingerprint || Coaster.default_fingerprint).flatten.map do |fp|
+      if fp == true || fp == :class
+        self.class.name
+      elsif fp == :default
+        '{{ default }}'
+      else
+        fp
+      end
+    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] || {})
+    nt = raven.merge(opts)
+
+    nt[:tags] ||= (tags && tags.merge(nt[:tags] || {})) || {}
+    nt[:tags] = nt[:tags].merge(environment: Rails.env) if defined?(Rails)
+    nt[:level] ||= self.level
+    nt[:extra] = attributes.merge(nt[:extra])
+    nt
+  end
+
+  def capture(options = {})
+    return if options.key?(:report) && !options[:report]
+    return unless report?
+    nt = notes(options)
+    Sentry.capture_exception(self, level: nt[:level]) do |scope|
+      scope.user.merge!(nt[:user] || {})
+      scope.tags.merge!(nt[:tags])
+      scope.extra.merge!(nt[:extra])
+      scope.fingerprint = raven_fingerprint
+    end
+  rescue => e
+    msg = "#{e.class.name}: #{e.message}"
+    msg += "\n\t" + e.backtrace.join("\n\t")
+    Sentry.logger.error(msg)
+  end
+
+  # options
+  #   :logger
+  #   :cleaner
+  #   :fingerprint
+  #   :tags
+  #   :level
+  #   :extra
+  #   :report
+  #   and others are merged to extra
+  alias_method :just_logging, :logging
+  def logging(options = {})
+    capture(options)
+    just_logging(options)
+  end
+end

data/lib/coaster/core_ext/standard_error.rb

@@ -53,17 +53,23 @@ class StandardError
       msg = message
       set_backtrace(message.backtrace)
     when Hash then
+      @coaster = true # coaster 확장을 사용한 에러임을 확인할 수 있음.
       hash = message.with_indifferent_access rescue message
       msg = hash.delete(:m)
       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)
       @attributes.merge!(hash)
+      if @attributes[:description] == :translate
+        @attributes.delete(:description)
+        @attributes[:description] = _translate
+      end
+      msg = "#{_translate} (#{msg || self.class.name})"
+      msg = "#{msg} {#{cause.message}}" if cause
     when String then
       msg = message
     when FalseClass, NilClass then
@@ -74,7 +80,7 @@ class StandardError
 
     @fingerprint = [] unless @fingerprint.is_a?(Array)
     @tags = {} unless @tags.is_a?(Hash)
-    msg = cause.message if msg.blank? && cause
+    msg = "{#{cause.message}}" if msg.blank? && cause
     super(msg)
   end
 
@@ -118,8 +124,6 @@ class StandardError
   # error message is not user friendly in many cases.
   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?
@@ -132,9 +136,9 @@ class StandardError
 
   # user friendly message, for overid
   def user_message
-    return description if description.present?
-    return _translate  if tkey.present?
-    "#{_translate} (#{to_origin_s})"
+    return _translate if description.present? || tkey.present?
+    return "#{_translate} (#{message})" unless defined?(@coaster)
+    message
   end
 
   # another user friendly messages
@@ -144,15 +148,6 @@ 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,
@@ -176,7 +171,7 @@ class StandardError
     lg = "[#{self.class.name}] status:#{status}"
     lg += "\n\tMESSAGE: #{safe_message.gsub(/\n/, "\n\t\t")}"
     instance_variables.each do |var|
-      if var.to_s.start_with?('@_')
+      if var.to_s.start_with?('@_') || var.to_s == '@coaster'
         next
       elsif var.to_s == '@spell_checker'
         next

data/lib/coaster/core_ext.rb

@@ -1,3 +1,4 @@
+require_relative 'core_ext/require_more'
 require_relative 'core_ext/array'
 require_relative 'core_ext/date'
 require_relative 'core_ext/month'

data/lib/coaster/version.rb

@@ -1,3 +1,3 @@
 module Coaster
-  VERSION = '1.3.3'
+  VERSION = '1.3.7'
 end

data/test/test_standard_error.rb

@@ -22,8 +22,8 @@ module Coaster
 
     def test_standard_messages
       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_equal "developer message", e.to_s
+      assert_equal "developer message", e.message
       assert_nil e.description
       assert_nil e.desc
       assert_equal 'standard error translation', e._translate
@@ -41,8 +41,8 @@ module Coaster
 
     def test_no_translation_class
       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_equal "developer message", e.to_s
+      assert_equal "developer message", e.message
       assert_nil e.description
       assert_nil e.desc
       assert_equal 'standard error translation', e._translate
@@ -68,8 +68,8 @@ module Coaster
 
     def test_with_translation_class
       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_equal "Coaster::TestStandardError::SampleError", e.to_s
+      assert_equal "Coaster::TestStandardError::SampleError", e.message
       assert_nil e.description
       assert_nil e.desc
       assert_equal 'Test sample error', e._translate
@@ -84,21 +84,36 @@ module Coaster
       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_equal "developer message", e.to_s
+      assert_equal "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')
+      e = SampleError.new(desc: 'user message')
+      assert_equal "user message (Coaster::TestStandardError::SampleError)", e.to_s
+      assert_equal "user message (Coaster::TestStandardError::SampleError)", 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(m: 'developer message', desc: :translate)
       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.description
+      assert_equal "Test sample error", e.desc
       assert_equal 'Test sample error', e._translate
-      assert_equal 'Test sample error (Coaster::TestStandardError::SampleError)', e.user_message
+      assert_equal 'Test sample error', e.user_message
       assert_equal 'Test this title', e.title
+      e = SampleError.new(desc: :translate)
+      assert_equal "Test sample error (Coaster::TestStandardError::SampleError)", e.to_s
+      assert_equal "Test sample error (Coaster::TestStandardError::SampleError)", e.message
+      assert_equal "Test sample error", e.description
+      assert_equal "Test sample error", e.desc
+      assert_equal "Test sample error", e._translate
+      assert_equal "Test sample error", e.user_message
       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
@@ -140,7 +155,7 @@ 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 example error (Test sample error (#{SampleError.name}))", e.to_hash['message']
+      assert_equal "Test example error (Coaster::TestStandardError::ExampleError) {Test sample error (Coaster::TestStandardError::SampleError)}", 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']
@@ -152,9 +167,10 @@ module Coaster
       begin
         raise SampleError, {frog: 'rams'}
       rescue => e
-        raise ExampleError, {wat: 'cha'}
+        raise ExampleError, {m: 'abc', wat: 'cha'}
       end
     rescue => e
+      assert_equal 'Test example error (abc) {Test sample error (Coaster::TestStandardError::SampleError)}', e.message
       assert_equal 'rams', e.cause.attr['frog']
       assert_equal 'rams', e.attr['frog']
       assert_equal 'cha', e.attr['wat']
@@ -169,7 +185,7 @@ module Coaster
     rescue => e
       detail = <<-LOG
 [Coaster::TestStandardError::ExampleError] status:20
-	MESSAGE: Test example error (Test sample error (Coaster::TestStandardError::SampleError))
+	MESSAGE: Test example error (Coaster::TestStandardError::ExampleError) {Test sample error (Coaster::TestStandardError::SampleError)}
 	@fingerprint: []
 	@tags: {}
 	@level: \"error\"
@@ -226,7 +242,7 @@ LOG
       begin
         root_cause_sample3
       rescue => e
-        assert_equal "standard error translation (a)", e.root_cause.message
+        assert_equal "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.3.3
+  version: 1.3.7
 platform: ruby
 authors:
 - buzz jung
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-14 00:00:00.000000000 Z
+date: 2021-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -152,8 +152,10 @@ files:
 - lib/coaster/core_ext/date.rb
 - lib/coaster/core_ext/month.rb
 - lib/coaster/core_ext/object_translation.rb
+- lib/coaster/core_ext/require_more.rb
 - lib/coaster/core_ext/standard_error.rb
 - lib/coaster/core_ext/standard_error/raven.rb
+- lib/coaster/core_ext/standard_error/sentry.rb
 - lib/coaster/serialized_properties.rb
 - lib/coaster/version.rb
 - test/locales/en.yml
@@ -164,7 +166,7 @@ homepage: http://github.com/frograms/coaster
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -179,12 +181,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.1.6
+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_standard_error.rb
+- test/test_helper.rb
+- test/test_object_translation.rb