fast_attributes_rails 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b789314937d4fe9b190cce7f27be1506803447e8
+  data.tar.gz: d9802b4d4caea346145bdccb2b839bf452a39eff
+SHA512:
+  metadata.gz: 8932e7676e3a54707b3256d2ae93cd2a23412c6043f7ea24f9cec8ec9bef0b1e143e6e6fb3aed2e7ec24af26691dd7bc4bf8da4a6eb4b3ba01f9cb916cd06a64
+  data.tar.gz: d18ae5cf462917e8d3117fdd963a5d8e259504d6aa664b98c2c535f4d2506ad3dcbf74e46b8662f49cbd2a95320e99a465f7df611dcc5ce4902be7267c6c24fd

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format d

data/.travis.yml

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

data/CHANGELOG.md

@@ -0,0 +1,194 @@
+**0.9.0 (September 15, 2016)**
+* Attributes via accessors [Phil Schalm](https://github.com/pnomolos)
+```ruby
+class Book
+  extend FastAttributes
+
+  define_attributes attributes: :accessors do
+    attribute :author, String
+  end
+
+  def author
+    @author || "No author set"
+  end
+end
+
+book = Book.new
+book.attributes
+{"author" => "No author set"}
+```
+
+**0.8.0 (September 15, 2016)**
+* Support of default values [Phil Schalm](https://github.com/pnomolos)
+```ruby
+class Product
+  extend FastAttributes
+
+  define_attributes initialize: true, attributes: true do
+    attribute :title, String, default: "Book"
+    attribute :price, Float, default: 10
+  end
+end
+```
+
+**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:
+```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 `Float`  
+
+**0.5.0 (July 16, 2014)**
+* Allow to control any switch statements during typecasting using new DSL.
+
+The default typecasting rule which `fast_attributes` generates for `String` is:
+```ruby
+   case value
+   when nil    then nil
+   when String then value
+   else String(%s)
+   end
+```
+Method `FastAttributes.set_type_casting` allows only to change `else` condition.
+```ruby
+FastAttributes.set_type_casting(String, 'String("#{%s}-suffix")')
+```
+
+Using `FastAttributes.type_cast` method it's possible to define custom `switch` condition
+```ruby
+FastAttributes.type_cast String do   # case value
+  from 'nil', 	 to: 'nil'           # when nil    then nil
+  from 'String', to: '%s'            # when String then value
+  from Array,    to: 'raise "Error"' # when Array  then raise "Error"
+  otherwise 'String(%s)'             # else String(value)
+end                                  # end
+```
+
+* Add support to BigDecimal [Filipe Costa](https://github.com/applift/fast_attributes/pull/2)
+
+**0.4.0 (July 5, 2014)**
+* Allow to override generated methods
+
+**0.3.0 (July 4, 2014)**
+* Support `Float` data type
+
+**0.2.2 (July 2, 2014)**
+* Fix uninitialized `@type_casting` variable
+
+**0.2.1 (June 27, 2014)**
+* Set minimum ruby version to `1.9.2`
+
+**0.2.0 (June 27, 2014)**
+* Add `define_attributes` method which allows to generate `initialize` and `attributes`
+* Raise `FastAttributes::UnsupportedTypeError` error when unknown attribute type is specified
+
+**0.1.0 (June 26, 2014)**
+* Support `Integer`, `String`, `Array`, `Date`, `Time` and `DateTime` attribute types
+
+**0.0.1 (June 20, 2014)**
+* Initial commit

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fast_attributes.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 AppLift GmbH
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,292 @@
+# FastAttributes
+[![Gem Version](http://img.shields.io/gem/v/fast_attributes.svg)](http://rubygems.org/gems/fast_attributes)
+[![Build Status](http://img.shields.io/travis/applift/fast_attributes.svg)](https://travis-ci.org/applift/fast_attributes)
+[![Coverage Status](http://img.shields.io/coveralls/applift/fast_attributes.svg)](https://coveralls.io/r/applift/fast_attributes?branch=master)
+[![Code Climate](http://img.shields.io/codeclimate/github/applift/fast_attributes.svg)](https://codeclimate.com/github/applift/fast_attributes)
+[![Dependency Status](http://img.shields.io/gemnasium/applift/fast_attributes.svg)](https://gemnasium.com/applift/fast_attributes)
+
+## Motivation
+There are already a lot of good and flexible gems which solve a similar problem, allowing attributes to be defined with their types, for example: [virtus](https://github.com/solnic/virtus) or [attrio](https://github.com/jetrockets/attrio). However, the disadvantage of these gems is performance. So, the goal of `fast_attributes` is to provide a simple solution which is fast, understandable and extendable.
+
+This is the [performance benchmark](https://github.com/applift/fast_attributes/blob/master/benchmarks/comparison.rb) of `fast_attributes` compared to other popular gems.
+
+```
+Comparison:
+FastAttributes: without values                       :  1528209.4 i/s
+FastAttributes: integer values for integer attributes:    88794.2 i/s - 17.21x slower
+FastAttributes: string values for integer attributes :    77673.3 i/s - 19.67x slower
+Virtus: integer values for integer attributes        :    21104.7 i/s - 72.41x slower
+Attrio: integer values for integer attributes        :    11932.2 i/s - 128.07x slower
+Attrio: string values for integer attributes         :    11007.2 i/s - 138.84x slower
+Virtus: without values                               :    10151.0 i/s - 150.55x slower
+Attrio: without values                               :     7164.3 i/s - 213.31x slower
+Virtus: string values for integer attributes         :     3195.6 i/s - 478.22x slower
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'fast_attributes'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fast_attributes
+
+## Usage
+
+Define getter/setter methods:
+```ruby
+class Book
+  extend FastAttributes
+
+  attribute :title, :name, String
+  attribute :pages,        Integer
+  attribute :authors,      Array
+  attribute :published,    Date
+  attribute :sold,         Time
+  attribute :finished,     DateTime
+end
+
+book = Book.new
+book.title     = 'There and Back Again'
+book.name      = 'The Hobbit'
+book.pages     = '200'
+book.authors   = 'Tolkien'
+book.published = '1937-09-21'
+book.sold      = '2014-06-25 13:45'
+book.finished  = '1937-08-20 12:35'
+
+#<Book:0x007f9a0110be20
+ @authors=["Tolkien"],
+ @finished=
+  #<DateTime: 1937-08-20T12:35:00+00:00 ((2428766j,45300s,0n),+0s,2299161j)>,
+ @name="The Hobbit",
+ @pages=200,
+ @published=#<Date: 1937-09-21 ((2428798j,0s,0n),+0s,2299161j)>,
+ @sold=2014-06-25 13:45:00 +0200,
+ @title="There and Back Again">
+```
+
+To generate `initialize` and `attributes` methods, attribute definition should be wrapped with `define_attributes`:
+```ruby
+class Book
+  extend FastAttributes
+
+  define_attributes initialize: true, attributes: true do
+    attribute :title, :name, String
+    attribute :pages,        Integer
+    attribute :authors,      Array
+    attribute :published,    Date
+    attribute :sold,         Time
+    attribute :finished,     DateTime
+  end
+end
+
+book = Book.new(
+  title:     'There and Back Again',
+  name:      'The Hobbit',
+  pages:     '200',
+  authors:   'Tolkien',
+  published: '1937-09-21',
+  sold:      '2014-06-25 13:45',
+  finished:  '1937-08-20 12:35'
+)
+
+book.attributes
+{"title"=>"There and Back Again",
+ "name"=>"The Hobbit",
+ "pages"=>200,
+ "authors"=>["Tolkien"],
+ "published"=>#<Date: 1937-09-21 ((2428798j,0s,0n),+0s,2299161j)>,
+ "sold"=>2014-06-25 13:45:00 +0200,
+ "finished"=>
+  #<DateTime: 1937-08-20T12:35:00+00:00 ((2428766j,45300s,0n),+0s,2299161j)>}
+```
+
+## Default values
+
+Requires `define_attributes` to be used with `initialize: true` (this is where the default values are set):
+
+```ruby
+class Book
+  extend FastAttributes
+
+  define_attributes initialize: true do
+    attribute :author, String, default: "Some String"
+  end
+end
+
+book = Book.new
+book.attributes
+{"author" => "Some String"}
+```
+
+## Attributes via accessors
+
+Sometimes you want `attributes` to return the value of your accessors, rather than the instance variables.
+This is slower than using ivars directly, so use `attributes: :accessors`:
+
+```ruby
+class Book
+  extend FastAttributes
+
+  define_attributes attributes: :accessors do
+    attribute :author, String
+  end
+
+  def author
+    @author || "No author set"
+  end
+end
+
+book = Book.new
+book.attributes
+{"author" => "No author set"}
+```
+
+
+## Custom Type
+It's easy to add a custom attribute type.
+```ruby
+FastAttributes.set_type_casting(OpenStruct, 'OpenStruct.new(name: %s)')
+
+class Book
+  extend FastAttributes
+  attribute :author, OpenStruct
+end
+
+book = Book.new
+book.author = 'Rowling'
+book.author
+# => #<OpenStruct name="Rowling">
+```
+
+Notice, that second parameter is a string. It's necessary because this code is compiled into a ruby method in runtime. The placeholder `%s` represents a value which this method accepts.
+
+It's possible to refer to a placeholder several times.
+```ruby
+Size = Class.new(Array)
+FastAttributes.set_type_casting Size, <<-EOS
+  Size[%s, %s]
+EOS
+
+class Square
+  extend FastAttributes
+  attribute :size, Size
+end
+
+square = Square.new
+square.size = 5
+square.size
+# => [5, 5]
+```
+
+Method `FastAttributes.set_type_casting` generates the following template:
+```ruby
+FastAttributes.set_type_casting String, '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. 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
+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
+```
+
+## 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`
+
+## Contributing
+
+1. Fork it ( http://github.com/applift/fast_attributes/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request