fast_attributes 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 156410fa3391841eaf2b70060f777f96e70b17cb
-  data.tar.gz: d272b8684e3b06afe7de0562a06f116f9de9f168
+  metadata.gz: 714fe623705696e372c8b188c47dd28e59a79462
+  data.tar.gz: 36390f23832e5c3c2253a0f2f54628254fb9faa6
 SHA512:
-  metadata.gz: 5770eaeb6359e8fe89fe78301fc6e8dc4242c02edcf99b132def5c27fed34b3e30d2c270c33a4b8ad2f01695d48789ae93d40ef35f8abdef86acaf1984db035d
-  data.tar.gz: 087d805216430a6cb94d7dd8bce84b72f8fdc644f1853f957aefb39941109f054f0f0ff1c985902a2d7f018a8f863698ec097a81cb8c87494367b7303888182c
+  metadata.gz: 758076d95b01e4b721ccfe1674708514584024ce84f94e37fcaf9eb09019c4851ee5b2ba3ea8dbe3dca8ea4119e9a31806252e2cef6f1e6db011d7d4fd91f797
+  data.tar.gz: c433c6a45235e96011f55b6314abc087038d1872d8a6f08ac1159d1282f651d53139b351c6622115f0f346adf8183b61e3c66301bce1878cb91be49744aaaa79

data/CHANGELOG.md

@@ -1,3 +1,63 @@
+**0.7.0 (August 31, 2014)**
+* Support `boolean` data type as a lenient type.
+```ruby
+class Product
+  extend FastAttributes
+  attribute :active, :boolean
+end
+
+product = Product.new
+product.active = 1
+product.active # true
+```
+
+* Add support of lenient data types. It allows to define attribute which doesn't correspond to a specific ruby class
+```ruby
+FastAttributes.type_cast :lenient_attribute do
+  from '"yes"', to: 'true'
+  from '"no"',  to: 'false'
+  otherwise 'nil'
+end
+    
+class LenientAttributes
+  extend FastAttributes
+  attribute :terms_of_service, :lenient_attribute
+end
+    
+lenient = LenientAttribute.new
+lenient.terms_of_service = 'yes'
+lenient.terms_of_service # true
+```
+
+* Allow to define default data types using class or symbol.
+```ruby
+class Book
+  extend FastAttributes
+
+  attribute :title      String
+  attribute :pages,     Integer
+  attribute :price,     BigDecimal
+  attribute :authors,   Array
+  attribute :published, Date
+  attribute :sold,      Time
+  attribute :finished,  DateTime
+  attribute :rate,      Float
+end
+
+class LenientBook
+  extend FastAttributes
+
+  attribute :title,     :string
+  attribute :pages,     :integer
+  attribute :price,     :big_decimal
+  attribute :authors,   :array
+  attribute :published, :date
+  attribute :sold,      :time
+  attribute :finished,  :date_time
+  attribute :rate,      :float
+end
+```
+
 **0.6.0 (July 20, 2014)**
 * Throw custom `FastAttributes::TypeCast::InvalidValueError` exception when value has invalid type.
 How auto-generated method looks like:

data/README.md

@@ -175,7 +175,7 @@ end
 #   end
 # end
 ```
-Notice, placeholder `%a` represents method name.
+Notice, placeholder `%a` represents method name. Also, `set_type_casting` method generates lenient date type. See [Lenient Data Types](https://github.com/applift/fast_attributes/blob/lenient_data_types/README.md#lenient-data-types) section.
 
 If you need to conrol the whole type casting process, you can use the following DSL:
 ```ruby
@@ -192,6 +192,51 @@ FastAttributes.type_cast String do     # begin
 end                                    # end
 ```
 
+## Lenient Data Types
+It's also possible to define a lenient data type which doesn't correspond to any of ruby classes:
+```ruby
+FastAttributes.type_cast :yes_no do
+  from '"yes"', to: 'true'
+  from '"no"',  to: 'false'
+  otherwise 'nil'
+end
+
+class Order
+  extend FastAttributes
+
+  attribute :terms_of_service, :yes_no
+end
+
+order = Order.new
+order.terms_of_service = 'yes'
+order.terms_of_service
+# => true 
+order.terms_of_service = 'no'
+order.terms_of_service
+# => false
+order.terms_of_service = 42
+order.terms_of_service
+# => nil
+```
+
+All default data types have lenient notation:
+```ruby
+class Book
+  extend FastAttributes
+
+  attribute :title,     :string
+  attribute :pages,     :integer
+  attribute :price,     :big_decimal
+  attribute :authors,   :array
+  attribute :published, :date
+  attribute :sold,      :time
+  attribute :finished,  :date_time
+  attribute :rate,      :float
+  attribute :active,    :boolean
+end
+```
+Notice, `Boolean` attribute can be defined only via symbol, `fast_attribute` doesn't create `Boolean` class.
+
 ## Extensions
 * [fast_attributes-uuid](https://github.com/applift/fast_attributes-uuid) - adds support of `UUID` to `fast_attributes`
 

data/lib/fast_attributes/builder.rb

@@ -12,7 +12,7 @@ module FastAttributes
 
     def attribute(*attributes, type)
       unless FastAttributes.type_exists?(type)
-        raise UnsupportedTypeError, %(Unsupported attribute type "#{type.name}")
+        raise UnsupportedTypeError, %(Unsupported attribute type "#{type.inspect}")
       end
 
       @attributes << [attributes, type]

data/lib/fast_attributes/version.rb

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

data/lib/fast_attributes.rb

@@ -6,6 +6,9 @@ require 'fast_attributes/builder'
 require 'fast_attributes/type_cast'
 
 module FastAttributes
+  TRUE_VALUES  = {true => nil, 1 => nil, '1' => nil, 't' => nil, 'T' => nil, 'true' => nil, 'TRUE' => nil, 'on' => nil, 'ON' => nil}
+  FALSE_VALUES = {false => nil, 0 => nil, '0' => nil, 'f' => nil, 'F' => nil, 'false' => nil, 'FALSE' => nil, 'off' => nil, 'OFF' => nil}
+
   class << self
     def type_casting
       @type_casting ||= {}
@@ -16,7 +19,8 @@ module FastAttributes
     end
 
     def set_type_casting(klass, casting)
-      type_cast klass do
+      symbol = klass.name.gsub(/([a-z])([A-Z])/, '\1_\2').downcase.to_sym  # DateTime => :date_time
+      type_cast symbol, klass do
         from 'nil',      to: 'nil'
         from klass.name, to: '%s'
         otherwise casting
@@ -31,10 +35,12 @@ module FastAttributes
       type_casting.has_key?(klass)
     end
 
-    def type_cast(klass, &block)
-      type_cast = TypeCast.new(klass)
-      type_cast.instance_eval(&block)
-      type_casting[klass] = type_cast
+    def type_cast(*types_or_classes, &block)
+      types_or_classes.each do |type_or_class|
+        type_cast = TypeCast.new(type_or_class)
+        type_cast.instance_eval(&block)
+        type_casting[type_or_class] = type_cast
+      end
     end
   end
 
@@ -58,4 +64,18 @@ module FastAttributes
   set_type_casting Time,       'Time.parse(%s)'
   set_type_casting DateTime,   'DateTime.parse(%s)'
   set_type_casting BigDecimal, 'Float(%s);BigDecimal(%s.to_s)'
+
+  type_cast :boolean do
+    otherwise <<-EOS
+      if FastAttributes::TRUE_VALUES.has_key?(%s)
+        true
+      elsif FastAttributes::FALSE_VALUES.has_key?(%s)
+        false
+      elsif %s.nil?
+        nil
+      else
+        raise FastAttributes::TypeCast::InvalidValueError, %(Invalid value "\#{%s}" for attribute "%a" of type ":boolean")
+      end
+    EOS
+  end
 end

data/spec/fast_attributes_spec.rb

@@ -53,9 +53,10 @@ describe FastAttributes do
 
   describe '#attribute' do
     it 'raises an exception when type is not supported' do
-      type  = Class.new(Object) { def self.name; 'CustomType' end }
+      type  = Class.new(Object) { def self.inspect; 'CustomType' end }
       klass = Class.new(Object) { extend FastAttributes }
       expect{klass.attribute(:name, type)}.to raise_error(FastAttributes::UnsupportedTypeError, 'Unsupported attribute type "CustomType"')
+      expect{klass.attribute(:name, :type)}.to raise_error(FastAttributes::UnsupportedTypeError, 'Unsupported attribute type ":type"')
     end
 
     it 'generates getter methods' do
@@ -113,7 +114,7 @@ describe FastAttributes do
       expect(book.title).to eq('123')
       expect(book.name).to eq('456')
       expect(book.pages).to be(250)
-      expect(book.price).to eq(BigDecimal.new("2.55"))
+      expect(book.price).to eq(BigDecimal.new('2.55'))
       expect(book.authors).to eq(%w[Jobs])
       expect(book.published).to eq(Date.new(2014, 6, 21))
       expect(book.sold).to eq(Time.new(2014, 6, 21, 20, 45, 15))
@@ -126,7 +127,7 @@ describe FastAttributes do
       book.title     = title     = 'One'
       book.name      = name      = 'Two'
       book.pages     = pages     = 250
-      book.price     = price     = BigDecimal.new("2.55")
+      book.price     = price     = BigDecimal.new('2.55')
       book.authors   = authors   = %w[Jobs]
       book.published = published = Date.new(2014, 06, 21)
       book.sold      = sold      = Time.new(2014, 6, 21, 20, 45, 15)
@@ -149,7 +150,7 @@ describe FastAttributes do
       book.title     = 'One'
       book.name      = 'Two'
       book.pages     = 250
-      book.price     = BigDecimal.new("2.55")
+      book.price     = BigDecimal.new('2.55')
       book.authors   = %w[Jobs]
       book.published = Date.new(2014, 06, 21)
       book.sold      = Time.new(2014, 6, 21, 20, 45, 15)
@@ -208,6 +209,113 @@ describe FastAttributes do
       placeholder.title = 'attribute name 2'
       expect(placeholder.title).to eq('title%a%title%title!')
     end
+
+    it 'generates lenient attributes which do not correspond to a particular data type' do
+      lenient_attribute = LenientAttributes.new
+      expect(lenient_attribute.terms_of_service).to be(nil)
+
+      lenient_attribute.terms_of_service = 'yes'
+      expect(lenient_attribute.terms_of_service).to be(true)
+
+      lenient_attribute.terms_of_service = 'no'
+      expect(lenient_attribute.terms_of_service).to be(false)
+
+      lenient_attribute.terms_of_service = 42
+      expect(lenient_attribute.terms_of_service).to be(nil)
+    end
+
+    it 'allows to define attributes using symbols as a data type' do
+      book = DefaultLenientAttributes.new
+      book.title     = title     = 'One'
+      book.pages     = pages     = 250
+      book.price     = price     = BigDecimal.new('2.55')
+      book.authors   = authors   = %w[Jobs]
+      book.published = published = Date.new(2014, 06, 21)
+      book.sold      = sold      = Time.new(2014, 6, 21, 20, 45, 15)
+      book.finished  = finished  = DateTime.new(2014, 05, 20, 21, 35, 20)
+      book.rate      = rate      = 4.1
+
+      expect(book.title).to be(title)
+      expect(book.pages).to be(pages)
+      expect(book.price).to eq(price)
+      expect(book.authors).to be(authors)
+      expect(book.published).to be(published)
+      expect(book.sold).to be(sold)
+      expect(book.finished).to be(finished)
+      expect(book.rate).to be(rate)
+    end
+
+    context 'boolean attribute' do
+      let(:object) { DefaultLenientAttributes.new }
+
+      context 'when value is not set' do
+        it 'return nil' do
+          expect(object.active).to be(nil)
+        end
+      end
+
+      context 'when value represents true' do
+        it 'returns true' do
+          object.active = true
+          expect(object.active).to be(true)
+
+          object.active = 1
+          expect(object.active).to be(true)
+
+          object.active = '1'
+          expect(object.active).to be(true)
+
+          object.active = 't'
+          expect(object.active).to be(true)
+
+          object.active = 'T'
+          expect(object.active).to be(true)
+
+          object.active = 'true'
+          expect(object.active).to be(true)
+
+          object.active = 'TRUE'
+          expect(object.active).to be(true)
+
+          object.active = 'on'
+          expect(object.active).to be(true)
+
+          object.active = 'ON'
+          expect(object.active).to be(true)
+        end
+      end
+
+      context 'when value represents false' do
+        it 'returns false' do
+          object.active = false
+          expect(object.active).to be(false)
+
+          object.active = 0
+          expect(object.active).to be(false)
+
+          object.active = '0'
+          expect(object.active).to be(false)
+
+          object.active = 'f'
+          expect(object.active).to be(false)
+
+          object.active = 'F'
+          expect(object.active).to be(false)
+
+          object.active = 'false'
+          expect(object.active).to be(false)
+
+          object.active = 'FALSE'
+          expect(object.active).to be(false)
+
+          object.active = 'off'
+          expect(object.active).to be(false)
+
+          object.active = 'OFF'
+          expect(object.active).to be(false)
+        end
+      end
+    end
   end
 
   describe '#define_attributes' do

data/spec/fixtures/classes.rb

@@ -87,3 +87,29 @@ class PlaceholderClass
   attribute :value, Placeholder
   attribute :title, Placeholder
 end
+
+FastAttributes.type_cast :lenient_attribute do
+  from '"yes"', to: 'true'
+  from '"no"',  to: 'false'
+  otherwise 'nil'
+end
+
+class LenientAttributes
+  extend FastAttributes
+
+  attribute :terms_of_service, :lenient_attribute
+end
+
+class DefaultLenientAttributes
+  extend FastAttributes
+
+  attribute :title,     :string
+  attribute :pages,     :integer
+  attribute :price,     :big_decimal
+  attribute :authors,   :array
+  attribute :published, :date
+  attribute :sold,      :time
+  attribute :finished,  :date_time
+  attribute :rate,      :float
+  attribute :active,    :boolean
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fast_attributes
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Kostiantyn Stepaniuk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-20 00:00:00.000000000 Z
+date: 2014-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -136,3 +136,4 @@ test_files:
 - spec/fast_attributes_spec.rb
 - spec/fixtures/classes.rb
 - spec/spec_helper.rb
+has_rdoc: