fast_attributes 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4c7f1055c9b3373f670d0a951802c291da7e64d3
-  data.tar.gz: c07c8f114c8dedaa380ff9a17901fa1f6b928f87
+  metadata.gz: 77f2e59818faf79d91ebf8f90f76cebc2bab978b
+  data.tar.gz: bb9905bc7899f5c2d4d4e69c8f9c42760e28be3e
 SHA512:
-  metadata.gz: 1490d8927c991b691150524b0febe8abb69f554bc113d4b19c17318b180a37c724b07ab98be843c0aee452462449b69cfac4852b76eb4353c881b354f4beb2c5
-  data.tar.gz: 6d27f9bce17691ecd4bfe988598876a27632abe9b24f52b52d2f5d585195e515a1fc572c3dcde75390379cd0a0fb5ea75194f5559977c07f0a56b649a0166491
+  metadata.gz: 0c6a59bfb0c1a73be212f8c2f9485186aaf3282d90d09633aac841fffd083645d4c12c9afc144781c38f850aa30362661710d1833886a834b544a9d568ae7410
+  data.tar.gz: 009c11fbd431c352d1c8fe72502851a14a1eaeb55c73184c3b2585ccf2db1b6dbdebff910bc27a05cc5e78e503f82398a95d4a719f44ea28600b191aad7bf848

data/.coveralls.yml

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,2 @@
+language: ruby
+script: bundle exec rspec spec

data/CHANGELOG.md

@@ -1,2 +1,5 @@
+**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/README.md

@@ -1,6 +1,64 @@
 # 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)
 
-TODO: Write a gem description
+## Motivation
+There are already a lot of good and flexible gems which solve the similar problem, allow to define attributes with their types, for example: [virtus](https://github.com/solnic/virtus) or [attrio](https://github.com/jetrockets/attrio). But the disadvantage of existing gems is performance. So, the goal of `fast_attributes` is to make a simple solution which is fast, understandable and easy extendable.
+
+This is [performance benchmark](https://github.com/applift/fast_attributes/blob/master/benchmarks/comparison.rb) of `fast_attributes` and other popular gems.
+
+```
+Calculating -------------------------------------
+FastAttributes: without values                       
+                         71131 i/100ms
+FastAttributes: integer values for integer attributes
+                          8410 i/100ms
+FastAttributes: string values for integer attributes 
+                          6869 i/100ms
+Attrio: without values                               
+                           700 i/100ms
+Attrio: integer values for integer attributes        
+                          1165 i/100ms
+Attrio: string values for integer attributes         
+                          1073 i/100ms
+Virtus: without values                               
+                           898 i/100ms
+Virtus: integer values for integer attributes        
+                          2123 i/100ms
+Virtus: string values for integer attributes         
+                           306 i/100ms
+-------------------------------------------------
+FastAttributes: without values                       
+                      1528209.4 (±16.2%) i/s -    1564882 in   1.045527s
+FastAttributes: integer values for integer attributes
+                        88794.2 (±16.0%) i/s -      92510 in   1.078912s
+FastAttributes: string values for integer attributes 
+                        77673.3 (±4.7%) i/s -      82428 in   1.063921s
+Attrio: without values                               
+                         7164.3 (±2.6%) i/s -       7700 in   1.075560s
+Attrio: integer values for integer attributes        
+                        11932.2 (±2.1%) i/s -      12815 in   1.074474s
+Attrio: string values for integer attributes         
+                        11007.2 (±0.9%) i/s -      11803 in   1.072382s
+Virtus: without values                               
+                        10151.0 (±5.5%) i/s -      10776 in   1.065475s
+Virtus: integer values for integer attributes        
+                        21104.7 (±10.4%) i/s -      21230 in   1.019115s
+Virtus: string values for integer attributes         
+                         3195.6 (±1.7%) i/s -       3366 in   1.053637s
+
+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
 

data/benchmarks/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+ruby '2.1.2'
+
+gem 'fast_attributes', '0.0.1'
+gem 'virtus',          '1.0.2'
+gem 'attrio',          '0.7.3'
+gem 'benchmark-ips',   '2.0.0'

data/benchmarks/comparison.rb

@@ -0,0 +1,58 @@
+require 'benchmark/ips'
+require 'fast_attributes'
+require 'virtus'
+require 'attrio'
+
+ATTR_NAMES = [:attr0, :attr1, :attr2, :attr3, :attr4, :attr5, :attr6, :attr7, :attr8, :attr9]
+
+module Initializer
+  def initialize(attributes = {})
+    attributes.each do |attribute, value|
+      public_send("#{attribute}=", value)
+    end
+  end
+end
+
+class FastIntegers
+  extend  FastAttributes
+  include Initializer
+  attribute *ATTR_NAMES, Integer
+end
+
+class AttrioIntegers
+  include Attrio
+  include Initializer
+  define_attributes do
+    ATTR_NAMES.each do |name|
+      attr name, Integer
+    end
+  end
+end
+
+class VirtusIntegers
+  include Virtus.model
+  ATTR_NAMES.each do |name|
+    attribute name, Integer
+  end
+end
+
+Benchmark.ips do |x|
+  x.config(time: 1, warmup: 1)
+
+  integers = {attr0: 0, attr1: 1, attr2: 2, attr3: 3, attr4: 4, attr5: 5, attr6: 6, attr7: 7, attr8: 8, attr9: 9}
+  strings  = {attr0: '0', attr1: '1', attr2: '2', attr3: '3', attr4: '4', attr5: '5', attr6: '6', attr7: '7', attr8: '8', attr9: '9'}
+
+  x.report('FastAttributes: without values                       ') { FastIntegers.new }
+  x.report('FastAttributes: integer values for integer attributes') { FastIntegers.new(integers) }
+  x.report('FastAttributes: string values for integer attributes ') { FastIntegers.new(strings) }
+
+  x.report('Attrio: without values                               ') { AttrioIntegers.new }
+  x.report('Attrio: integer values for integer attributes        ') { AttrioIntegers.new(integers) }
+  x.report('Attrio: string values for integer attributes         ') { AttrioIntegers.new(strings) }
+
+  x.report('Virtus: without values                               ') { VirtusIntegers.new }
+  x.report('Virtus: integer values for integer attributes        ') { VirtusIntegers.new(integers) }
+  x.report('Virtus: string values for integer attributes         ') { VirtusIntegers.new(strings) }
+
+  x.compare!
+end

data/fast_attributes.gemspec

@@ -18,6 +18,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'bundler',   '~> 1.5'
   spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec',     '~> 3.0.0'
+  spec.add_development_dependency 'coveralls', '~> 0.7.0'
 end

data/lib/fast_attributes/version.rb

@@ -1,3 +1,3 @@
 module FastAttributes
-  VERSION = '0.0.1'
+  VERSION = '0.1.0'
 end

data/lib/fast_attributes.rb

@@ -6,21 +6,15 @@ module FastAttributes
       @type_casting ||= {
         'String'   => 'String(%s)',
         'Integer'  => 'Integer(%s)',
+        'Array'    => 'Array(%s)',
         'Date'     => 'Date.parse(%s)',
         'Time'     => 'Time.parse(%s)',
-        'DateTime' => 'DateTime.parse(%s)',
-        'Array'    => 'Array(%s)'
+        'DateTime' => 'DateTime.parse(%s)'
       }
     end
 
-    def default_type_casting
-      '%s'
-    end
-
     def get_type_casting(klass)
-      @type_casting.fetch(type_from_class(klass)) do
-        default_type_casting
-      end
+      @type_casting[type_from_class(klass)]
     end
 
     def add_type_casting(klass, casting)
@@ -41,11 +35,15 @@ module FastAttributes
   end
 
   def attribute(*attributes, klass)
+    unless FastAttributes.type_exists?(klass)
+      raise %(Unsupported attribute type "#{FastAttributes.type_from_class(klass)}")
+    end
+
     @fast_attributes ||= []
     attributes.each do |attribute|
       @fast_attributes << attribute
 
-      type_matching  = FastAttributes.type_exists?(klass) ? "when #{FastAttributes.type_from_class(klass)} then value" : nil
+      type_matching  = "when #{FastAttributes.type_from_class(klass)} then value"
       type_casting   = FastAttributes.get_type_casting(klass) % 'value'
       all_attributes = @fast_attributes.map do |attr|
         "'#{attr}'=>@#{attr}"

data/spec/fast_attributes_spec.rb

@@ -0,0 +1,198 @@
+require 'spec_helper'
+
+describe FastAttributes do
+  describe '.type_casting' do
+    it 'returns predefined type casting rules' do
+      expect(FastAttributes.type_casting).to eq({
+        'String'   => 'String(%s)',
+        'Integer'  => 'Integer(%s)',
+        'Array'    => 'Array(%s)',
+        'Date'     => 'Date.parse(%s)',
+        'Time'     => 'Time.parse(%s)',
+        'DateTime' => 'DateTime.parse(%s)'
+      })
+    end
+  end
+
+  describe '.get_type_casting' do
+    it 'returns type casting function' do
+      expect(FastAttributes.get_type_casting(String)).to eq('String(%s)')
+      expect(FastAttributes.get_type_casting(Time)).to eq('Time.parse(%s)')
+    end
+  end
+
+  describe '.add_type_casting' do
+    after do
+      FastAttributes.remove_type_casting(OpenStruct)
+    end
+
+    it 'adds type to supported type casting list' do
+      FastAttributes.add_type_casting(OpenStruct, 'OpenStruct.new(a: %s)')
+      expect(FastAttributes.get_type_casting(OpenStruct)).to eq('OpenStruct.new(a: %s)')
+    end
+  end
+
+  describe '.remove_type_casting' do
+    before do
+      FastAttributes.add_type_casting(OpenStruct, 'OpenStruct.new(a: %s)')
+    end
+
+    it 'removes type casting function from supported list' do
+      FastAttributes.remove_type_casting(OpenStruct)
+      expect(FastAttributes.get_type_casting(OpenStruct)).to be(nil)
+    end
+  end
+
+  describe '.type_exists?' do
+    it 'checks if type is registered' do
+      expect(FastAttributes.type_exists?(DateTime)).to be(true)
+      expect(FastAttributes.type_exists?(OpenStruct)).to be(false)
+    end
+  end
+
+  describe '.type_from_class' do
+    it 'converts class into type name' do
+      expect(FastAttributes.type_from_class(DateTime)).to eq('DateTime')
+      expect(FastAttributes.type_from_class(OpenStruct)).to eq('OpenStruct')
+    end
+  end
+
+  describe '#attribute' do
+    it 'generates getter methods' do
+      book = Book.new
+      expect(book.respond_to?(:title)).to be(true)
+      expect(book.respond_to?(:name)).to be(true)
+      expect(book.respond_to?(:pages)).to be(true)
+      expect(book.respond_to?(:authors)).to be(true)
+      expect(book.respond_to?(:published)).to be(true)
+      expect(book.respond_to?(:sold)).to be(true)
+      expect(book.respond_to?(:finished)).to be(true)
+    end
+
+    it 'generates setter methods' do
+      book = Book.new
+      expect(book.respond_to?(:title=)).to be(true)
+      expect(book.respond_to?(:name=)).to be(true)
+      expect(book.respond_to?(:pages=)).to be(true)
+      expect(book.respond_to?(:authors=)).to be(true)
+      expect(book.respond_to?(:published=)).to be(true)
+      expect(book.respond_to?(:sold=)).to be(true)
+      expect(book.respond_to?(:finished=)).to be(true)
+    end
+
+    it 'generates attributes method' do
+      book = Book.new
+      expect(book.respond_to?(:attributes)).to be(true)
+    end
+
+    it 'setter methods convert values to correct datatype' do
+      book = Book.new
+      book.title     = 123
+      book.name      = 456
+      book.pages     = '250'
+      book.authors   = 'Jobs'
+      book.published = '2014-06-21'
+      book.sold      = '2014-06-21 20:45:15'
+      book.finished  = '2014-05-20 21:35:20'
+
+      expect(book.title).to eq('123')
+      expect(book.name).to eq('456')
+      expect(book.pages).to be(250)
+      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))
+      expect(book.finished).to eq(DateTime.new(2014, 5, 20, 21, 35, 20))
+    end
+
+    it 'setter methods accept values which are already in a proper type' do
+      book = Book.new
+      book.title     = title     = 'One'
+      book.name      = name      = 'Two'
+      book.pages     = pages     = 250
+      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)
+
+      expect(book.title).to be(title)
+      expect(book.name).to be(name)
+      expect(book.pages).to be(pages)
+      expect(book.authors).to be(authors)
+      expect(book.published).to be(published)
+      expect(book.sold).to be(sold)
+      expect(book.finished).to be(finished)
+    end
+
+    it 'setter methods accept nil values' do
+      book = Book.new
+      book.title     = 'One'
+      book.name      = 'Two'
+      book.pages     = 250
+      book.authors   = %w[Jobs]
+      book.published = Date.new(2014, 06, 21)
+      book.sold      = Time.new(2014, 6, 21, 20, 45, 15)
+      book.finished  = DateTime.new(2014, 05, 20, 21, 35, 20)
+
+      book.title     = nil
+      book.name      = nil
+      book.pages     = nil
+      book.authors   = nil
+      book.published = nil
+      book.sold      = nil
+      book.finished  = nil
+
+      expect(book.title).to be(nil)
+      expect(book.name).to be(nil)
+      expect(book.pages).to be(nil)
+      expect(book.authors).to be(nil)
+      expect(book.published).to be(nil)
+      expect(book.sold).to be(nil)
+      expect(book.finished).to be(nil)
+    end
+
+    it 'setter methods raise an exception when cannot parse values' do
+      book = Book.new
+
+      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.published = 'date' }.to raise_error(ArgumentError)
+      expect{ book.sold = 'time' }.to raise_error(ArgumentError)
+      expect{ book.finished = 'datetime' }.to raise_error(ArgumentError)
+    end
+
+    it 'attributes method return all attributes with nil values by default' do
+      book = Book.new
+      expect(book.attributes).to eq({
+        'title'     => nil,
+        'name'      => nil,
+        'pages'     => nil,
+        'authors'   => nil,
+        'published' => nil,
+        'sold'      => nil,
+        'finished'  => nil,
+      })
+    end
+
+    it 'attributes method return all attributes with their values' do
+      book = Book.new
+      book.title     = 'One'
+      book.name      = 'Two'
+      book.pages     = 250
+      book.authors   = %w[Jobs]
+      book.published = Date.new(2014, 06, 21)
+      book.sold      = Time.new(2014, 6, 21, 20, 45, 15)
+      book.finished  = DateTime.new(2014, 05, 20, 21, 35, 20)
+
+      expect(book.attributes).to eq({
+        'title'     => 'One',
+        'name'      => 'Two',
+        'pages'     => 250,
+        'authors'   => %w[Jobs],
+        'published' => Date.new(2014, 06, 21),
+        'sold'      => Time.new(2014, 6, 21, 20, 45, 15),
+        'finished'  => DateTime.new(2014, 05, 20, 21, 35, 20),
+      })
+    end
+  end
+end

data/spec/fixtures/book.rb

@@ -0,0 +1,10 @@
+class Book
+  extend FastAttributes
+
+  attribute :title, :name, String
+  attribute :pages,        Integer
+  attribute :authors,      Array
+  attribute :published,    Date
+  attribute :sold,         Time
+  attribute :finished,     DateTime
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'coveralls'
+Coveralls.wear!
+
+require 'fast_attributes'
+require 'ostruct'
+require 'date'
+require 'time'
+require 'fixtures/book'

metadata

@@ -1,43 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: fast_attributes
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Kostiantyn Stepaniuk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-20 00:00:00.000000000 Z
+date: 2014-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
 description: Fast attributes with data types
 email:
 - ks@applift.com
@@ -45,15 +73,23 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".coveralls.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- benchmarks/Gemfile
+- benchmarks/comparison.rb
 - fast_attributes.gemspec
 - lib/fast_attributes.rb
 - lib/fast_attributes/version.rb
+- spec/fast_attributes_spec.rb
+- spec/fixtures/book.rb
+- spec/spec_helper.rb
 homepage: https://github.com/applift/fast_attributes
 licenses:
 - MIT
@@ -64,18 +100,21 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Fast attributes with data types
-test_files: []
+test_files:
+- spec/fast_attributes_spec.rb
+- spec/fixtures/book.rb
+- spec/spec_helper.rb