fast_attributes 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 77f2e59818faf79d91ebf8f90f76cebc2bab978b
-  data.tar.gz: bb9905bc7899f5c2d4d4e69c8f9c42760e28be3e
+  metadata.gz: c733dbbfc7afd222369f25c9db5870a364549e8d
+  data.tar.gz: 22bd1f76a4b062a408d7d2c9ebf307e393f64c2b
 SHA512:
-  metadata.gz: 0c6a59bfb0c1a73be212f8c2f9485186aaf3282d90d09633aac841fffd083645d4c12c9afc144781c38f850aa30362661710d1833886a834b544a9d568ae7410
-  data.tar.gz: 009c11fbd431c352d1c8fe72502851a14a1eaeb55c73184c3b2585ccf2db1b6dbdebff910bc27a05cc5e78e503f82398a95d4a719f44ea28600b191aad7bf848
+  metadata.gz: ebfd89f2154c563f8bb5ab26c7b6ffcf62668b174f76717edd190660b6ff8af46e48d026e7ae08a61477c5df26c15bd7f8962d8f44bc9947f46fd0f1c2b96fa6
+  data.tar.gz: 9992ea942ef045861f5920fa8ff4b23fa6f9f0e2bac5ea8ad95dc521a03fd8a9dd769fd7cd6c0b4a1c63d81c81d051d64e8266afb3f51fd58b28dab648cf8382

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+**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
 

data/README.md

@@ -2,6 +2,8 @@
 [![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 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.
@@ -76,7 +78,74 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+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: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">
+```
 
 ## Contributing
 

data/fast_attributes.gemspec

@@ -22,4 +22,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec',     '~> 3.0.0'
   spec.add_development_dependency 'coveralls', '~> 0.7.0'
+  spec.add_development_dependency 'simplecov', '~> 0.8.2'
 end

data/lib/fast_attributes/builder.rb

@@ -0,0 +1,94 @@
+module FastAttributes
+  class UnsupportedTypeError < TypeError
+  end
+
+  class Builder
+    def initialize(klass, options = {})
+      @klass      = klass
+      @options    = options
+      @attributes = []
+    end
+
+    def attribute(*attributes, type)
+      unless FastAttributes.type_exists?(type)
+        raise UnsupportedTypeError, %(Unsupported attribute type "#{type.name}")
+      end
+
+      @attributes << [attributes, type]
+    end
+
+    def compile!
+      compile_getter!
+      compile_setter!
+
+      if @options[:initialize]
+        compile_initialize!
+      end
+
+      if @options[:attributes]
+        compile_attributes!
+      end
+    end
+
+    private
+
+    def compile_getter!
+      each_attribute do |attribute, _|
+        @klass.class_eval <<-EOS, __FILE__, __LINE__ + 1
+          def #{attribute}  # def name
+            @#{attribute}   #  @name
+          end               # end
+        EOS
+      end
+    end
+
+    def compile_setter!
+      each_attribute do |attribute, type|
+        type_matching  = "when #{type.name} then value"
+        type_casting   = FastAttributes.get_type_casting(type) % 'value'
+
+        @klass.class_eval <<-EOS, __FILE__, __LINE__ + 1
+          def #{attribute}=(value)              # def name=(value)
+            @#{attribute} = case value          #   @name = case value
+                            when nil then nil   #           when nil    then nil
+                              #{type_matching}  #           when String then value
+                            else                #           else
+                              #{type_casting}   #             String(value)
+                            end                 #           end
+          end
+        EOS
+      end
+    end
+
+    def compile_initialize!
+      @klass.class_eval <<-EOS, __FILE__, __LINE__ + 1
+        def initialize(attributes = {})
+          attributes.each do |name, value|
+            public_send("\#{name}=", value)
+          end
+        end
+      EOS
+    end
+
+    def compile_attributes!
+      attributes = @attributes.flat_map(&:first)
+      attributes = attributes.map do |attribute|
+        "'#{attribute}' => @#{attribute}"
+      end
+
+      @klass.class_eval <<-EOS, __FILE__, __LINE__ + 1
+        def attributes                # def attributes
+          {#{attributes.join(', ')}}  #   {'name' => @name, ...}
+        end                           # end
+      EOS
+    end
+
+    def each_attribute
+      @attributes.each do |attributes, type|
+        attributes.each do |attribute|
+          yield attribute, type
+        end
+      end
+    end
+  end
+end

data/lib/fast_attributes/version.rb

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

data/lib/fast_attributes.rb

@@ -1,72 +1,48 @@
-require 'fast_attributes/version'
+require 'date'
+require 'time'
 
 module FastAttributes
   class << self
     def type_casting
       @type_casting ||= {
-        'String'   => 'String(%s)',
-        'Integer'  => 'Integer(%s)',
-        'Array'    => 'Array(%s)',
-        'Date'     => 'Date.parse(%s)',
-        'Time'     => 'Time.parse(%s)',
-        'DateTime' => 'DateTime.parse(%s)'
+        String   => 'String(%s)',
+        Integer  => 'Integer(%s)',
+        Array    => 'Array(%s)',
+        Date     => 'Date.parse(%s)',
+        Time     => 'Time.parse(%s)',
+        DateTime => 'DateTime.parse(%s)'
       }
     end
 
     def get_type_casting(klass)
-      @type_casting[type_from_class(klass)]
+      @type_casting[klass]
     end
 
-    def add_type_casting(klass, casting)
-      type_casting[type_from_class(klass)] = casting
+    def set_type_casting(klass, casting)
+      type_casting[klass] = casting
     end
 
     def remove_type_casting(klass)
-      type_casting.delete(type_from_class(klass))
+      type_casting.delete(klass)
     end
 
     def type_exists?(klass)
-      type_casting.has_key?(type_from_class(klass))
-    end
-
-    def type_from_class(klass)
-      klass.name
+      type_casting.has_key?(klass)
     end
   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  = "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}"
-      end
-
-      class_eval <<-EOS, __FILE__, __LINE__ + 1
-        def #{attribute}                                             # def name
-          @#{attribute}                                              #  @name
-        end                                                          # end
-
-        def #{attribute}=(value)                                     # def name=(value)
-          @#{attribute} = case value                                 #   @name = case value
-                          when nil then nil                          #           when nil    then nil
-                          #{type_matching}                           #           when String then value
-                          else                                       #           else
-                            #{type_casting}                          #             String(value)
-                          end                                        #           end
-        end                                                          # end
+  def define_attributes(options = {}, &block)
+    builder = Builder.new(self, options)
+    builder.instance_eval(&block)
+    builder.compile!
+  end
 
-        def attributes                                               # def attributes
-          {#{all_attributes.join(',')}}                              #   {'name'=>@name}
-        end                                                          # end
-      EOS
-    end
+  def attribute(*attributes, type)
+    builder = Builder.new(self)
+    builder.attribute *attributes, type
+    builder.compile!
   end
 end
+
+require 'fast_attributes/version'
+require 'fast_attributes/builder'

data/spec/fast_attributes_spec.rb

@@ -4,12 +4,12 @@ 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)'
+        String   => 'String(%s)',
+        Integer  => 'Integer(%s)',
+        Array    => 'Array(%s)',
+        Date     => 'Date.parse(%s)',
+        Time     => 'Time.parse(%s)',
+        DateTime => 'DateTime.parse(%s)'
       })
     end
   end
@@ -21,20 +21,20 @@ describe FastAttributes do
     end
   end
 
-  describe '.add_type_casting' do
+  describe '.set_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)')
+      FastAttributes.set_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)')
+      FastAttributes.set_type_casting(OpenStruct, 'OpenStruct.new(a: %s)')
     end
 
     it 'removes type casting function from supported list' do
@@ -50,14 +50,13 @@ describe FastAttributes do
     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')
+  describe '#attribute' do
+    it 'raises an exception when type is not supported' do
+      type  = Class.new(Object) { def self.name; 'CustomType' end }
+      klass = Class.new(Object) { extend FastAttributes }
+      expect{klass.attribute(:name, type)}.to raise_error(FastAttributes::UnsupportedTypeError, 'Unsupported attribute type "CustomType"')
     end
-  end
 
-  describe '#attribute' do
     it 'generates getter methods' do
       book = Book.new
       expect(book.respond_to?(:title)).to be(true)
@@ -80,11 +79,6 @@ describe FastAttributes do
       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
@@ -160,39 +154,37 @@ describe FastAttributes do
       expect{ book.sold = 'time' }.to raise_error(ArgumentError)
       expect{ book.finished = 'datetime' }.to raise_error(ArgumentError)
     end
+  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),
-      })
+  describe '#define_attributes' do
+    describe 'option initialize: true' do
+      it 'generates initialize method' do
+        reader = Reader.new(name: 104, age: '23')
+        expect(reader.name).to eq('104')
+        expect(reader.age).to be(23)
+      end
+    end
+
+    describe 'option attributes: true' do
+      it 'generates attributes method' do
+        publisher = Publisher.new
+        expect(publisher.attributes).to eq({'name' => nil, 'books' => nil})
+
+        reader = Reader.new
+        expect(reader.attributes).to eq({'name' => nil, 'age' => nil})
+      end
+
+      it 'attributes method return all attributes with their values' do
+        publisher = Publisher.new
+        publisher.name  = 101
+        publisher.books = '20'
+        expect(publisher.attributes).to eq({'name' => '101', 'books' => 20})
+
+        reader = Reader.new
+        reader.name = 102
+        reader.age  = '25'
+        expect(reader.attributes).to eq({'name' => '102', 'age' => 25})
+      end
     end
   end
 end

data/spec/fixtures/classes.rb

@@ -0,0 +1,37 @@
+class Book
+  extend FastAttributes
+
+  attribute :title, :name, String
+  attribute :pages,        Integer
+  attribute :authors,      Array
+  attribute :published,    Date
+  attribute :sold,         Time
+  attribute :finished,     DateTime
+end
+
+class Author
+  extend FastAttributes
+
+  define_attributes initialize: true do
+    attribute :name, String
+    attribute :age,  Integer
+  end
+end
+
+class Publisher
+  extend FastAttributes
+
+  define_attributes attributes: true do
+    attribute :name,  String
+    attribute :books, Integer
+  end
+end
+
+class Reader
+  extend FastAttributes
+
+  define_attributes initialize: true, attributes: true do
+    attribute :name, String
+    attribute :age,  Integer
+  end
+end

data/spec/spec_helper.rb

@@ -1,8 +1,17 @@
-require 'coveralls'
-Coveralls.wear!
+if ENV['CI']
+  require 'coveralls'
+  Coveralls.wear! do
+    add_filter 'spec'
+  end
+else
+  require 'simplecov'
+  SimpleCov.start do
+    add_filter 'spec'
+  end
+end
 
 require 'fast_attributes'
 require 'ostruct'
 require 'date'
 require 'time'
-require 'fixtures/book'
+require 'fixtures/classes'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fast_attributes
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Kostiantyn Stepaniuk
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.7.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.2
 description: Fast attributes with data types
 email:
 - ks@applift.com
@@ -86,9 +100,10 @@ files:
 - benchmarks/comparison.rb
 - fast_attributes.gemspec
 - lib/fast_attributes.rb
+- lib/fast_attributes/builder.rb
 - lib/fast_attributes/version.rb
 - spec/fast_attributes_spec.rb
-- spec/fixtures/book.rb
+- spec/fixtures/classes.rb
 - spec/spec_helper.rb
 homepage: https://github.com/applift/fast_attributes
 licenses:
@@ -116,5 +131,5 @@ specification_version: 4
 summary: Fast attributes with data types
 test_files:
 - spec/fast_attributes_spec.rb
-- spec/fixtures/book.rb
+- spec/fixtures/classes.rb
 - spec/spec_helper.rb

data/spec/fixtures/book.rb

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