coaster 0.5.7 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d412837bcd6f0a5a4373bc2aa8722a76256bddf964bc9ed16cee5259578e799
-  data.tar.gz: f68f15518cecb6971a01203ffb1f2e6bf974ae87d594bfb3f9bfd1fbb49735d1
+  metadata.gz: 1efdff11e3158914f521590fb64642e9c1834987317b896db24896c31e772bcf
+  data.tar.gz: 3fcdb6480424ddcc27cc50c0568e6b8d9967bf494f8118d174d82e9072c03974
 SHA512:
-  metadata.gz: '08b3cdfaf858436cba05f579637d3bf1209b0612365ef064eaf4b1a03a72c8dfe88eff23913787e3c1a358e4772685fc94f440e910801314a01c8fc01729adb1'
-  data.tar.gz: 6a16cc58fd47a3d295da129c168fd4d2dd23e5ff8741894e40b7bd27a36904a950fdf9799d7be37c47f3742175333fe7562caa994c78cddced66132d664fd1ed
+  metadata.gz: 270b1faeeae2fe9fcccd3e0f2c4d9d8234c7d0288ee949ea29b7faac70e711e5394b2cb06b14da11a6e71fe770c46416e9e8e10fadca2303470171986e6a3911
+  data.tar.gz: c895e44a856beae32d2b46f09547d5c69aba008a46581ee096f9b069e6909251574f6dccf62f899fa3e51771e48acc1ad601f0a46e07a87cb5c8e59b706ea1f4

data/lib/coaster/core_ext/object_translation.rb

@@ -3,8 +3,9 @@ require 'i18n'
 class Object
   class << self
     def _translate(*args)
-      options = args.last.is_a?(Hash) ? args.pop.dup : {}
+      options = args.last.is_a?(Hash) ? args.pop : {}
       options.merge!(_translate_params)
+      options = options.to_hash.symbolize_keys!
 
       key = args.shift
       subkey = nil
@@ -33,22 +34,22 @@ class Object
       end
       options[:tkey] ||= key
       options.merge!(throw: true)
-      options.symbolize_keys!
       result = catch(:exception) do
         I18n.t(key, *args, options)
       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
+          msg = msg.dup
           msg.instance_variable_set(:@missing, missing)
           msg.instance_variable_set(:@tkey, options[:tkey])
           msg
@@ -57,6 +58,7 @@ class Object
           _translate(subkey, *args, options)
         end
       else
+        result = result.dup if result.frozen?
         result.instance_variable_set(:@translated, true)
         result.instance_variable_set(:@tkey, options[:tkey])
         result
@@ -74,7 +76,7 @@ class Object
   # Foo::Bar.new._translate(:force)    #=> ignore 'message' even if message exists
   #
   def _translate(*args)
-    options = args.last.is_a?(Hash) ? args.pop.dup : {}
+    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

data/lib/coaster/core_ext/standard_error.rb

@@ -26,42 +26,43 @@ class StandardError
     @tags = {}
     @level = 'error'
     @attributes = HashWithIndifferentAccess.new
+    @attributes.merge!(cause.attributes || {}) if cause && cause.respond_to?(:attributes)
     @tkey = nil
 
     case message
-      when Exception
-        msg = message
-        set_backtrace(message.backtrace)
-      when StandardError
-        @fingerprint = message.fingerprint
-        @tags = message.tags
-        @level = message.level
-        @tkey = message.tkey
-        @attributes = message.attributes
-        msg = message
-        set_backtrace(message.backtrace)
-      when Hash then
-        hash = message.with_indifferent_access rescue message
-        msg = hash.delete(:m)
-        msg = hash.delete(:msg) || msg
-        msg = hash.delete(:message) || msg
-        @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 = ''
-      else
-        msg = message
+    when Exception
+      msg = message
+      set_backtrace(message.backtrace)
+    when StandardError
+      @fingerprint = message.fingerprint
+      @tags = message.tags
+      @level = message.level
+      @tkey = message.tkey
+      @attributes = message.attributes
+      msg = message
+      set_backtrace(message.backtrace)
+    when Hash then
+      hash = message.with_indifferent_access rescue message
+      msg = hash.delete(:m)
+      msg = hash.delete(:msg) || msg
+      msg = hash.delete(:message) || msg
+      @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 = ''
+    else
+      msg = message
     end
 
     @fingerprint = [] unless @fingerprint.is_a?(Array)
     @tags = {} unless @tags.is_a?(Hash)
-    msg ||= self.class.title
+    msg ||= self.class._translate
     super(msg)
   end
 
@@ -95,6 +96,14 @@ class StandardError
     attributes[:http_status] = value
   end
 
+  def report?
+    attributes.key?(:report) ? attributes[:report] : true
+  end
+
+  def intentional?
+    attributes[:intentional]
+  end
+
   def code
     attributes[:code] || status
   end
@@ -114,6 +123,13 @@ class StandardError
   end
   alias_method :desc, :description
 
+  # more user friendly messages
+  def descriptions
+    return attributes[:descriptions] if attributes[:descriptions]
+    attributes[:descriptions] = {}
+    attributes[:descriptions]
+  end
+
   def object
     attributes[:object] || attributes[:obj]
   end
@@ -124,7 +140,7 @@ class StandardError
   end
 
   def to_hash
-    hash = @attributes.merge(
+    hash = attributes.merge(
       type: self.class.name, status: status,
       http_status: http_status, message: message
     )
@@ -190,16 +206,23 @@ class StandardError
   end
 
   def logging(options = {})
-    logger = options[:logger] || Coaster.logger
-    logger = Rails.logger if logger.nil? && defined?(Rails)
-    return nil unless logger
+    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)

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 = '0.5.7'
+  VERSION = '1.0.4'
 end

data/test/locales/en.yml

@@ -5,8 +5,12 @@ en:
       SampleObject:
         self: 'Coaster SampleObject Translated'
         title: 'Coaster SampleObject Title (%{tkey})'
+        interpolation: 'Coaster SampleObject interpolation test %{test_this}'
       TestStandardError:
+        ExampleError:
+          self: 'Test example error'
         SampleError:
+          self: 'Test sample error'
           test: 'Test this translation'
           title: 'Test this title'
   sample:

data/test/test_object_translation.rb

@@ -48,6 +48,10 @@ module Coaster
       assert_equal 'Coaster SampleObject Title (class.Coaster.Inherited.title)', Inherited._translate(:title)
     end
 
+    def test_interpolation
+      assert_equal 'Coaster SampleObject interpolation test this interpolated', SampleObject._translate('.interpolation', {test_this: 'this interpolated'}.with_indifferent_access)
+    end
+
     def teardown
       I18n.locale = nil
       I18n.default_locale = nil

data/test/test_standard_error.rb

@@ -39,20 +39,16 @@ module Coaster
         raise ExampleError, {wat: 'cha'}
       end
     rescue => e
-      assert_equal({
-        "wat"=>"cha",
-        "type"=>"Coaster::TestStandardError::ExampleError",
-        "status"=>20,
-        "http_status"=>500,
-        "message"=>"Test this title",
-        "cause"=>{
-          "frog"=>"rams",
-          "type"=>"Coaster::TestStandardError::SampleError",
-          "status"=>10,
-          "http_status"=>500,
-          "message"=>"Test this title"
-        }
-      }, e.to_hash)
+      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'
     end
 
     def test_cause_attributes
@@ -62,7 +58,9 @@ module Coaster
         raise ExampleError, {wat: 'cha'}
       end
     rescue => e
-      assert_equal({frog: 'rams', wat: 'cha'}.with_indifferent_access, e.attr)
+      assert_equal e.cause.attr['frog'], 'rams'
+      assert_equal e.attr['frog'], 'rams'
+      assert_equal e.attr['wat'], 'cha'
     end
 
     def test_to_detail
@@ -74,15 +72,15 @@ module Coaster
     rescue => e
       detail = <<-LOG
 [Coaster::TestStandardError::ExampleError] status:20
-	MESSAGE: Test this title
+	MESSAGE: Test sample error
 	@fingerprint: []
 	@tags: {}
 	@level: \"error\"
-	@attributes: {\"wat\"=>\"cha\"}
+	@attributes: {\"frog\"=>\"rams\", \"wat\"=>\"cha\"}
 	@tkey: nil
 	@raven: {}
 	CAUSE: [Coaster::TestStandardError::SampleError] status:10
-		MESSAGE: Test this title
+		MESSAGE: Test sample error
 		@fingerprint: []
 		@tags: {}
 		@level: \"error\"
@@ -108,7 +106,7 @@ LOG
     def test_title_missing
       raise UntitledError, 'untitled'
     rescue => e
-      assert_equal e.title, nil
+      assert_nil e.title
     end
 
     def root_cause_sample1
@@ -138,7 +136,24 @@ LOG
     def test_raven_notes
       raise SampleError, m: 'foofoo', something: 'other'
     rescue => e
-      assert_equal e.notes(the_other: 'something'), {extra: {something: 'other', the_other: 'something'}, fingerprint: [], tags: {}, level: 'error'}.with_indifferent_access
+      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
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: coaster
 version: !ruby/object:Gem::Version
-  version: 0.5.7
+  version: 1.0.4
 platform: ruby
 authors:
 - buzz jung
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-17 00:00:00.000000000 Z
+date: 2020-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -226,7 +226,7 @@ signing_key:
 specification_version: 4
 summary: A little convenient feature for standard library
 test_files:
-- test/locales/en.yml
-- test/test_standard_error.rb
 - test/test_helper.rb
+- test/test_standard_error.rb
+- test/locales/en.yml
 - test/test_object_translation.rb