coaster 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 109c0d535c90fff69341b21151d50f1f1fd98e5a
-  data.tar.gz: 80258772bb07341f0d9f2689a1da836c100c8d14
+  metadata.gz: 1c0875c0a591628d41eb57139f27f95434d8a007
+  data.tar.gz: f1d04dde597d9b223940aedef18d435ba0c7f5e6
 SHA512:
-  metadata.gz: 9b21238d86071189b72fe88181bbfb449ceadea509bdefd389d08e91e61b4b1c0dc6d0ded7d71277f8c117a34883625437add893a1f6b5f6c85b3f4137d68e63
-  data.tar.gz: e475df00ff8751a6bc14e37653a69cf646f0e70bc2e3a4e9125a0f587fbc5868c2c4065d8b2ec1c7942cd4a1d8cc3572a6a4b551421018779ec6402aaa865979
+  metadata.gz: e8c6027c675c4df5964f6693762f684fe65d0049862b9851fdd0387bde053b8198899f64e0c428cb39d62c07dc68498e2f813c6aae636259608de2c9bd2e28dd
+  data.tar.gz: 5c1125644b1a374a1d13ff5f4f5c9e4d5025b9e463d3955a9b5f364c2686fdcfa36755124ee7a4116e756f0ecd0df1563aa1198702150f2007723710f5c7b64b

data/README.md

@@ -1,2 +1,88 @@
 # Coaster
 
+## Object Translation
+
+Translate by object class name.
+```ruby
+                                  # Translation key
+Coupon._translate                 #=> en.class.Coupon.self
+Coupon::Discount._translate       #=> en.class.Coupon.Discount.self
+Coupon._translate('.title')       #=> en.class.Coupon.title
+Coupon._translate('root')         #=> en.root
+```
+
+Pass translation params.
+```ruby
+class Coupon
+  class << self
+    def _translation_params
+      {name: 'Buzz'}
+    end
+  end
+end
+
+Coupon._translate #=> I18n.t('en.class.Coupon.self', {name: 'Buzz'})
+```
+
+Inheritance fallback.
+```ruby
+class Order
+end
+
+class CreditCard < Order
+end
+
+# in en.yml only defined Order translation.
+# use superclass _translate
+CreditCard._translate #=> I18n.t('en.class.CreditCard.self') not exists
+                      #=> I18n.t('en.class.Order.self') returned
+```
+
+instance 에서도 사용할 수 있다.
+```ruby
+Foo::Bar.new._translate            #=> return translation 'class.Foo.Bar.self'
+Foo::Bar.new._translate('.title')  #=> return translation 'class.Foo.Bar.title'
+Foo::Bar.new._translate('title')   #=> return translation 'title'
+Foo::Bar.new._translate(:force)    #=> ignore 'message' even if message exists
+```
+
+그런데 다른점은 instance에 message 메서드가 존재할 경우 다음과 같이 message를 활용한다.
+```ruby
+error = Order::Error.new('error message')
+error._translate(:force) #=> "error message"
+```
+
+
+## StandardError features
+
+아래는 동일하다.
+```ruby
+raise Order::Error, 'order error occurred'
+raise Order::Error, {message: 'order error occurred'}
+raise Order::Error, {msg: 'order error occurred'}
+raise Order::Error, {m: 'order error occurred'}
+```
+
+에러에 추가로 attribute를 추가하고 싶다면 Hash에 아무거나 넣으면 된다.
+```ruby
+ex = catch { raise Order::Error, {m: 'message', order: order} }
+ex.attributes[:order] #=> order instance
+```
+
+Hash로 전달되는 특수한 attribute가 있다.
+
+1. desc, description: `ex.description`으로 꺼낼 수 있다. `ex.message`는 사용자 친화적이지
+   않은 메시지라서 사용자 친화적인 메시지를 넣으려면 description을 쓰면 된다. description이 없으면
+   message를 리턴한다.
+1. obj, object: `ex.object`로 꺼낼수 있다.
+1. http_status: `ex.http_status`로 꺼낼수 있다. 기본값은 Error Class에서 지정된 상수값.
+
+
+그 외에 error instance variable로 등록되는 attribute가 있다.
+1. tags: [ActiveSupport::TaggedLogging|http://api.rubyonrails.org/classes/ActiveSupport/TaggedLogging.html]에 사용된다.
+1. level: debug, info 등등의 로깅 레벨
+1. tkey: Object Translation 에서 사용된다. 기본값은 '.self'와 동일하다.
+
+## StandardError raven extenstion
+
+...

data/lib/coaster/core_ext/object_translation.rb

@@ -40,7 +40,7 @@ class Object
         end
 
         if key_class.superclass == Object || key_class == Object
-          options[:message] || options['message'] ||
+          options[:description] ||
          (options[:original_missing] && options[:original_missing].message) ||
           result.message
         else
@@ -66,9 +66,11 @@ class Object
     options = args.last.is_a?(Hash) ? args.pop.dup : {}
     key = args.shift || (respond_to?(:tkey) ? tkey : nil)
 
-    if !key.is_a?(String) && key != :force
-      if respond_to?(:message) && message.present? && message != 'false' && message != self.class.name
-        return message
+    if respond_to?(:description) && description.present? && description != 'false' && description != self.class.name
+      if !key.is_a?(String) && key != :force
+        return description
+      else
+        options.merge!(description: description)
       end
     end
 

data/lib/coaster/version.rb

@@ -1,3 +1,3 @@
 module Coaster
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: coaster
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - buzz jung