fast_attributes 0.5.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7b5f750706150406ddcaa4787a9dece903c0c392
-  data.tar.gz: 3c365ac0da073679f56adffa0af47ff96ac8105c
+  metadata.gz: 156410fa3391841eaf2b70060f777f96e70b17cb
+  data.tar.gz: d272b8684e3b06afe7de0562a06f116f9de9f168
 SHA512:
-  metadata.gz: 132afa531200fe1b2ded5ae0a17b0d9d0e232f6dd7d3216d55281e52e19c0ecec322f861c05b8aa353fb6c3cc52c9efc76716b173a1ea64d040508d9fcf66f99
-  data.tar.gz: 38ef6165ba6fe8f57b5d8c67974671b9de4b5990b5d0d5176c79226432560e5deb85fd33bb1f073ef77f237b7ba8bf2088319547ad40c21a4752fe55573e603e
+  metadata.gz: 5770eaeb6359e8fe89fe78301fc6e8dc4242c02edcf99b132def5c27fed34b3e30d2c270c33a4b8ad2f01695d48789ae93d40ef35f8abdef86acaf1984db035d
+  data.tar.gz: 087d805216430a6cb94d7dd8bce84b72f8fdc644f1853f957aefb39941109f054f0f0ff1c985902a2d7f018a8f863698ec097a81cb8c87494367b7303888182c

data/.travis.yml

@@ -1,2 +1,6 @@
 language: ruby
 script: bundle exec rspec spec
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.1

data/CHANGELOG.md

@@ -1,8 +1,54 @@
+**0.6.0 (July 20, 2014)**
+* Throw custom `FastAttributes::TypeCast::InvalidValueError` exception when value has invalid type.
+How auto-generated method looks like:
+```ruby
+FastAttributes.set_type_casting(String, 'String(%s)')
+# def name=(value)
+#   @name = begin
+#     case value
+#     when nil    then nil
+#     when String then value
+#     else String(value)
+#     end
+#   rescue => e
+#     raise FastAttributes::TypeCast::InvalidValueError, %(Invalid value "#{value}" for attribute "name" of type "String")
+#   end
+# end
+```
+
+* Add `on_error` method to override default rescue block:
+```ruby
+FastAttributes.type_cast String do
+  from 'nil', 	 to: 'nil'
+  from 'String', to: '%s'
+  otherwise 'String(%s)'
+  on_error 'ArgumentError', act: 'nil'
+  on_error 'TypeError',     act: '""'
+  on_error 'StandardError', act: 'e.message'
+end
+
+# def name=(value)
+#   @name = begin
+#     case value
+#     when nil    then nil
+#     when String then value
+#     else String(value)
+#     end
+#   rescue ArgumentError => e
+#     nil
+#   rescue TypeError => e
+#     ""
+#   rescue StandardError => e
+#     e.message
+#   end
+# end
+```
+
 **0.5.2 (July 18, 2014)**
 * Throw proper exception when type casting function is not defined
 
 **0.5.1 (July 16, 2014)**
-* Fix `BigDecimal` type casting. It threw an exception when input value was `Integer` or `Float`  
+* Fix `BigDecimal` type casting. It threw an exception when input value was `Float`  
 
 **0.5.0 (July 16, 2014)**
 * Allow to control any switch statements during typecasting using new DSL.

data/README.md

@@ -143,23 +143,53 @@ square.size
 # => [5, 5]
 ```
 
-Method `FastAttributes.set_type_casting` generates the following code:
+Method `FastAttributes.set_type_casting` generates the following template:
 ```ruby
 FastAttributes.set_type_casting String, 'String(%s)'
-# case %s
-# when nil    then nil
-# when String then %s
-# else String(%s)
+# begin
+#   case %s
+#   when nil    then nil
+#   when String then %s
+#   else String(%s)
+#   end
+# rescue => e
+#   raise FastAttributes::TypeCast::InvalidValueError, %(Invalid value "\#{%s}" for attribute "%a" of type "String")
 # end
 ```
+and when the attribute is defined, `fast_attributes` generates the following setter method:
+```ruby
+class A
+  extend FastAttributes
+  attribute :name, String
+end
+
+# def name=(value)
+#   @name = begin
+#     case value
+#     when nil    then nil
+#     when String then value
+#     else String(value)
+#     end
+#   rescue => e
+#     raise FastAttributes::TypeCast::InvalidValueError, %(Invalid value "#{value}" for attribute "name" of type "String")
+#   end
+# end
+```
+Notice, placeholder `%a` represents method name.
 
 If you need to conrol the whole type casting process, you can use the following DSL:
 ```ruby
-FastAttributes.type_cast String do  # case String
-  from 'nil',    to: 'nil'          # when nil    then nil
-  from 'String', to: '%s'           # when String then %s
-  otherwise 'String(%s)'            # else String(%s) 
-end                                 # end
+FastAttributes.type_cast String do     # begin
+                                       #   case String
+  from 'nil',    to: 'nil'             #   when nil    then nil
+  from 'String', to: '%s'              #   when String then %s
+  otherwise 'String(%s)'               #   else String(%s) 
+                                       #   end
+  on_error 'TypeError', act: 'nil'     # rescue TypeError => e
+                                       #   nil
+  on_error 'StandardError', act: '""'  # rescue StandardError => e
+                                       #   ""
+end                                    # end
 ```
 
 ## Extensions

data/lib/fast_attributes.rb

@@ -32,7 +32,7 @@ module FastAttributes
     end
 
     def type_cast(klass, &block)
-      type_cast = TypeCast.new
+      type_cast = TypeCast.new(klass)
       type_cast.instance_eval(&block)
       type_casting[klass] = type_cast
     end

data/lib/fast_attributes/builder.rb

@@ -47,12 +47,12 @@ module FastAttributes
 
     def compile_setter
       each_attribute do |attribute, type|
-        type_cast = FastAttributes.get_type_casting(type)
-        template  = escape_template(type_cast.template, 'value')
+        type_cast   = FastAttributes.get_type_casting(type)
+        method_body = type_cast.compile_method_body(attribute, 'value')
 
         @methods.module_eval <<-EOS, __FILE__, __LINE__ + 1
           def #{attribute}=(value)
-            @#{attribute} = #{template}
+            @#{attribute} = #{method_body}
           end
         EOS
       end
@@ -97,19 +97,5 @@ module FastAttributes
         end
       end
     end
-
-    private
-
-    def escape_template(template, argument_name)
-      template.gsub(/%+s/) do |match|
-        match.each_char.each_slice(2).map do |placeholder|
-          case placeholder
-          when %w[% s] then argument_name
-          when %w[% %] then '%'
-          else placeholder.join
-          end
-        end.join
-      end
-    end
   end
 end

data/lib/fast_attributes/type_cast.rb

@@ -3,9 +3,30 @@ module FastAttributes
     class UnknownTypeCastingError < StandardError
     end
 
-    def initialize
-      @if_conditions  = []
-      @else_condition = %q(raise FastAttributes::TypeCast::UnknownTypeCastingError, 'Type casting is not defined')
+    class InvalidValueError < TypeError
+    end
+
+    def initialize(type)
+      @type              = type
+      @if_conditions     = []
+      @else_condition    = %q(raise FastAttributes::TypeCast::UnknownTypeCastingError, 'Type casting is not defined')
+      @rescue_conditions = nil
+      @default_rescue    = %(raise FastAttributes::TypeCast::InvalidValueError, %(Invalid value "\#{%s}" for attribute "%a" of type "#{@type}"))
+    end
+
+    class << self
+      def escape_template(template, attribute_name, argument_name)
+        template.gsub(/%+a|%+s/) do |match|
+          match.each_char.each_slice(2).map do |placeholder|
+            case placeholder
+              when %w[% a] then attribute_name
+              when %w[% s] then argument_name
+              when %w[% %] then '%'
+              else placeholder.join
+            end
+          end.join
+        end
+      end
     end
 
     def from(condition, options = {})
@@ -16,8 +37,13 @@ module FastAttributes
       @else_condition = else_condition
     end
 
-    def template
-      @template ||= begin
+    def on_error(error, options = {})
+      @rescue_conditions ||=[]
+      @rescue_conditions << [error, options[:act]]
+    end
+
+    def type_casting_template
+      @type_casting_template ||= begin
         if @if_conditions.any?
           conditions = @if_conditions.map do |from, to|
             "when #{from}\n" +
@@ -34,5 +60,22 @@ module FastAttributes
         end
       end
     end
+
+    def rescue_template
+      rescues = @rescue_conditions || [['', @default_rescue]]
+      rescues.map do |error, action|
+        "rescue #{error} => e\n" +
+        "  #{action}"
+      end.join("\n")
+    end
+
+    def compile_method_body(attribute_name, argument_name)
+      method_body = "begin\n" +
+                    "  #{type_casting_template}\n" +
+                    "#{rescue_template}\n" +
+                    "end"
+
+      self.class.escape_template(method_body, attribute_name, argument_name)
+    end
   end
 end

data/lib/fast_attributes/version.rb

@@ -1,3 +1,3 @@
 module FastAttributes
-  VERSION = '0.5.2'
+  VERSION = '0.6.0'
 end

data/spec/fast_attributes/type_cast_spec.rb

@@ -1,12 +1,20 @@
 require 'spec_helper'
 
 describe FastAttributes::TypeCast do
-  describe '#template' do
-    let(:type_cast) { FastAttributes::TypeCast.new }
+  describe '.escape_template' do
+    it 'replaces placeholder with proper values' do
+      template = '% %s %%s %%%s %%%%s % %a %%a %%%a %%%%a'
+      escaped  = FastAttributes::TypeCast.escape_template(template, 'price', 'arg')
+      expect(escaped).to eq('% arg %s %arg %%s % price %a %price %%a')
+    end
+  end
+
+  describe '#type_casting_template' do
+    let(:type_cast) { FastAttributes::TypeCast.new(String) }
 
     describe 'without any conditions' do
       it 'return exception' do
-        expect(type_cast.template.gsub(' ', '')).to eq <<-EOS.gsub(' ', '').chomp
+        expect(type_cast.type_casting_template.gsub(' ', '')).to eq <<-EOS.gsub(' ', '').chomp
           raise FastAttributes::TypeCast::UnknownTypeCastingError, 'Type casting is not defined'
         EOS
       end
@@ -18,7 +26,7 @@ describe FastAttributes::TypeCast do
       end
 
       it 'returns one when statement' do
-        expect(type_cast.template.gsub(' ', '')).to eq <<-EOS.gsub(' ', '').chomp
+        expect(type_cast.type_casting_template.gsub(' ', '')).to eq <<-EOS.gsub(' ', '').chomp
           case %s
           when nil
             nil
@@ -37,7 +45,7 @@ describe FastAttributes::TypeCast do
       end
 
       it 'returns three when statements' do
-        expect(type_cast.template.gsub(' ', '')).to eq <<-EOS.gsub(' ', '').chomp
+        expect(type_cast.type_casting_template.gsub(' ', '')).to eq <<-EOS.gsub(' ', '').chomp
           case %s
           when String
             String(%s)
@@ -60,7 +68,7 @@ describe FastAttributes::TypeCast do
       end
 
       it 'returns 2 when statements and overrides default else condition' do
-        expect(type_cast.template.gsub(' ', '')).to eq <<-EOS.gsub(' ', '').chomp
+        expect(type_cast.type_casting_template.gsub(' ', '')).to eq <<-EOS.gsub(' ', '').chomp
           case %s
           when Date
             Date.parse(%s)
@@ -79,10 +87,84 @@ describe FastAttributes::TypeCast do
       end
 
       it 'returns otherwise statement only' do
-        expect(type_cast.template.gsub(' ', '')).to eq <<-EOS.gsub(' ', '').chomp
+        expect(type_cast.type_casting_template.gsub(' ', '')).to eq <<-EOS.gsub(' ', '').chomp
           42 * %s
         EOS
       end
     end
   end
+
+  describe '#rescue_template' do
+    let(:type_cast) { FastAttributes::TypeCast.new(Float) }
+
+    describe 'when on_error is not defined' do
+      it 'raises default error message' do
+        expect(type_cast.rescue_template.gsub(' ', '')).to eq <<-EOS.gsub(' ', '').chomp
+          rescue => e
+            raise FastAttributes::TypeCast::InvalidValueError, %(Invalid value "\#{%s}" for attribute "%a" of type "Float")
+        EOS
+      end
+    end
+
+    describe 'when on_error is defined' do
+      before do
+        type_cast.on_error 'ArgumentError', act: '"%s" + "%a"'
+      end
+
+      it 'overrides default action' do
+        expect(type_cast.rescue_template.gsub(' ', '')).to eq <<-EOS.gsub(' ', '').chomp
+          rescue ArgumentError => e
+            "%s" + "%a"
+        EOS
+      end
+    end
+
+    describe 'when several on_error methods is called' do
+      before do
+        type_cast.on_error 'ArgumentError', act: '0'
+        type_cast.on_error 'StandardError', act: '1'
+      end
+
+      it 'generates several rescue conditions' do
+        expect(type_cast.rescue_template.gsub(' ', '')).to eq <<-EOS.gsub(' ', '').chomp
+          rescue ArgumentError => e
+            0
+          rescue StandardError => e
+            1
+        EOS
+      end
+    end
+  end
+
+  describe '#compile_method_body' do
+    let(:type_cast) { FastAttributes::TypeCast.new(Float) }
+
+    before do
+      type_cast.from 'nil',   to: 'nil'
+      type_cast.from 'Float', to: '%s'
+      type_cast.otherwise 'Float(%s)'
+      type_cast.on_error 'ArgumentError', act: 'raise "a %s %a"'
+      type_cast.on_error 'StandardError', act: 'raise "b %s %a"'
+    end
+
+
+    it 'generates type casting method' do
+      expect(type_cast.compile_method_body('price', 'argument').gsub(' ', '')).to eq <<-EOS.gsub(' ', '').chomp
+        begin
+          case argument
+          when nil
+            nil
+          when Float
+            argument
+          else
+            Float(argument)
+          end
+        rescue ArgumentError => e
+          raise "a argument price"
+        rescue StandardError => e
+          raise "b argument price"
+        end
+      EOS
+    end
+  end
 end

data/spec/fast_attributes_spec.rb

@@ -178,16 +178,19 @@ describe FastAttributes do
     end
 
     it 'setter methods raise an exception when cannot parse values' do
-      book = Book.new
+      object = BasicObject.new
+      def object.to_s; 'BasicObject'; end
+      def object.to_str; 1/0 end
 
-      expect{ book.title = BasicObject.new }.to raise_error(TypeError)
-      expect{ book.name = BasicObject.new }.to raise_error(TypeError)
-      expect{ book.pages = 'number' }.to raise_error(ArgumentError)
-      expect{ book.price = 'bigdecimal' }.to raise_error(ArgumentError)
-      expect{ book.published = 'date' }.to raise_error(ArgumentError)
-      expect{ book.sold = 'time' }.to raise_error(ArgumentError)
-      expect{ book.finished = 'datetime' }.to raise_error(ArgumentError)
-      expect{ book.rate = 'float' }.to raise_error(ArgumentError)
+      book = Book.new
+      expect{ book.title = object }.to raise_error(FastAttributes::TypeCast::InvalidValueError, 'Invalid value "BasicObject" for attribute "title" of type "String"')
+      expect{ book.name = object }.to raise_error(FastAttributes::TypeCast::InvalidValueError,  'Invalid value "BasicObject" for attribute "name" of type "String"')
+      expect{ book.pages = 'number' }.to raise_error(FastAttributes::TypeCast::InvalidValueError, 'Invalid value "number" for attribute "pages" of type "Integer"')
+      expect{ book.price = 'bigdecimal' }.to raise_error(FastAttributes::TypeCast::InvalidValueError, 'Invalid value "bigdecimal" for attribute "price" of type "BigDecimal"')
+      expect{ book.published = 'date' }.to raise_error(FastAttributes::TypeCast::InvalidValueError, 'Invalid value "date" for attribute "published" of type "Date"')
+      expect{ book.sold = 'time' }.to raise_error(FastAttributes::TypeCast::InvalidValueError, 'Invalid value "time" for attribute "sold" of type "Time"')
+      expect{ book.finished = 'datetime' }.to raise_error(FastAttributes::TypeCast::InvalidValueError, 'Invalid value "datetime" for attribute "finished" of type "DateTime"')
+      expect{ book.rate = 'float' }.to raise_error(FastAttributes::TypeCast::InvalidValueError, 'Invalid value "float" for attribute "rate" of type "Float"')
     end
 
     it 'setter method can escape placeholder using double %' do
@@ -195,6 +198,16 @@ describe FastAttributes do
       placeholder.value = 3
       expect(placeholder.value).to eq('value %s %value %%s 2')
     end
+
+    it 'setter method can accept %a placeholder which return attribute name' do
+      placeholder = PlaceholderClass.new
+
+      placeholder.title = 'attribute name 1'
+      expect(placeholder.title).to eq('title')
+
+      placeholder.title = 'attribute name 2'
+      expect(placeholder.title).to eq('title%a%title%title!')
+    end
   end
 
   describe '#define_attributes' do

data/spec/fixtures/classes.rb

@@ -77,10 +77,13 @@ class Placeholder < String
 end
 
 FastAttributes.type_cast Placeholder do
+  from '"attribute name 1"', to: '"%a"'
+  from '"attribute name 2"', to: %q("%a%%a%%%a%#{%a<<'!'}")
   otherwise '"%s %%s %%%s %%%%s #{5%%%s}"'
 end
 
 class PlaceholderClass
   extend FastAttributes
   attribute :value, Placeholder
+  attribute :title, Placeholder
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fast_attributes
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.6.0
 platform: ruby
 authors:
 - Kostiantyn Stepaniuk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-18 00:00:00.000000000 Z
+date: 2014-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler