fast_attributes 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 714fe623705696e372c8b188c47dd28e59a79462
-  data.tar.gz: 36390f23832e5c3c2253a0f2f54628254fb9faa6
+  metadata.gz: 9c90efa52db1c0c48916b37d6229a101e99e32fb
+  data.tar.gz: dfd651948c3f0700ccfb4d421fb1ad47009da8df
 SHA512:
-  metadata.gz: 758076d95b01e4b721ccfe1674708514584024ce84f94e37fcaf9eb09019c4851ee5b2ba3ea8dbe3dca8ea4119e9a31806252e2cef6f1e6db011d7d4fd91f797
-  data.tar.gz: c433c6a45235e96011f55b6314abc087038d1872d8a6f08ac1159d1282f651d53139b351c6622115f0f346adf8183b61e3c66301bce1878cb91be49744aaaa79
+  metadata.gz: b2eec805647af281fa932263b04cbbdcb3aff1f6d7e564e9a48ec5480f064e59258e493d4be24685e3f104ffa1e8ac19dc6bf972386c838b7b86bbad4105cdb8
+  data.tar.gz: 60c51d7ccba9ca05ca50852bc3943d90b0081131a7756446d91de9b454bfa7f0c1bf438cef4c7a0eac1b49cb11eddb53c0995e5dff4c4091578fcdcee56f9e74

data/.travis.yml

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

data/CHANGELOG.md

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

data/README.md

@@ -107,6 +107,25 @@ book.attributes
  "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"}
+```
+
 ## Custom Type
 It's easy to add a custom attribute type.
 ```ruby
@@ -123,7 +142,7 @@ 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. 
+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
@@ -183,7 +202,7 @@ 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) 
+  otherwise 'String(%s)'               #   else String(%s)
                                        #   end
   on_error 'TypeError', act: 'nil'     # rescue TypeError => e
                                        #   nil
@@ -210,7 +229,7 @@ end
 order = Order.new
 order.terms_of_service = 'yes'
 order.terms_of_service
-# => true 
+# => true
 order.terms_of_service = 'no'
 order.terms_of_service
 # => false

data/lib/fast_attributes.rb

@@ -4,6 +4,7 @@ require 'time'
 require 'fast_attributes/version'
 require 'fast_attributes/builder'
 require 'fast_attributes/type_cast'
+require 'fast_attributes/default_attributes'
 
 module FastAttributes
   TRUE_VALUES  = {true => nil, 1 => nil, '1' => nil, 't' => nil, 'T' => nil, 'true' => nil, 'TRUE' => nil, 'on' => nil, 'ON' => nil}

data/lib/fast_attributes/builder.rb

@@ -10,17 +10,24 @@ module FastAttributes
       @methods    = Module.new
     end
 
-    def attribute(*attributes, type)
+    def attribute(*attributes, type, options)
+      unless options.is_a?(Hash)
+        (attributes ||= []) << type
+        type = options
+        options = {}
+      end
+
       unless FastAttributes.type_exists?(type)
         raise UnsupportedTypeError, %(Unsupported attribute type "#{type.inspect}")
       end
 
-      @attributes << [attributes, type]
+      @attributes << [attributes, type, options || {}]
     end
 
     def compile!
       compile_getter
       compile_setter
+      set_defaults
 
       if @options[:initialize]
         compile_initialize
@@ -36,17 +43,17 @@ module FastAttributes
     private
 
     def compile_getter
-      each_attribute do |attribute, _|
+      each_attribute do |attribute, *|
         @methods.module_eval <<-EOS, __FILE__, __LINE__ + 1
-          def #{attribute}  # def name
-            @#{attribute}   #   @name
-          end               # end
+          def #{attribute} # def name
+            @#{attribute}  #   @name
+          end              # end
         EOS
       end
     end
 
     def compile_setter
-      each_attribute do |attribute, type|
+      each_attribute do |attribute, type, *|
         type_cast   = FastAttributes.get_type_casting(type)
         method_body = type_cast.compile_method_body(attribute, 'value')
 
@@ -59,9 +66,15 @@ module FastAttributes
     end
 
     def compile_initialize
+      attribute_string = if FastAttributes.default_attributes(@klass).empty?
+                           "attributes"
+                         else
+                           "FastAttributes.default_attributes(self.class).merge(attributes)"
+                         end
+
       @methods.module_eval <<-EOS, __FILE__, __LINE__ + 1
         def initialize(attributes = {})
-          attributes.each do |name, value|
+          #{attribute_string}.each do |name, value|
             public_send("\#{name}=", value)
           end
         end
@@ -90,10 +103,16 @@ module FastAttributes
       @klass.send(:include, @methods)
     end
 
+    def set_defaults
+      each_attribute do |attribute, type, options|
+        FastAttributes.add_default_attribute(@klass, attribute, options[:default]) if options[:default]
+      end
+    end
+
     def each_attribute
-      @attributes.each do |attributes, type|
+      @attributes.each do |attributes, type, options = {}|
         attributes.each do |attribute|
-          yield attribute, type
+          yield attribute, type, options
         end
       end
     end

data/lib/fast_attributes/default_attributes.rb

@@ -0,0 +1,33 @@
+module FastAttributes
+  class << self
+    SINGLETON_CLASSES = [::NilClass, ::TrueClass, ::FalseClass, ::Numeric,  ::Symbol].freeze
+
+    def default_attributes(klass)
+      return {} unless (@default_attributes || {})[klass]
+      @default_attributes[klass].each_with_object({}) do |(attribute, value), memo|
+        memo[attribute] = if value.respond_to?(:call)
+                            value.call
+                          elsif cloneable?(value)
+                            value.clone
+                          else
+                            value
+                          end
+      end
+    end
+
+    def add_default_attribute(klass, attribute, value)
+      @default_attributes ||= {}
+      @default_attributes[klass] ||= {}
+      @default_attributes[klass][attribute] = value
+    end
+
+    def cloneable?(value)
+      case value
+      when *SINGLETON_CLASSES
+        false
+      else
+        true
+      end
+    end
+  end
+end

data/lib/fast_attributes/version.rb

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

data/spec/fast_attributes_spec.rb

@@ -364,4 +364,37 @@ describe FastAttributes do
       end
     end
   end
+
+  describe "default attributes" do
+    it "sets the default values" do
+      class_with_defaults = ClassWithDefaults.new
+
+      expect(class_with_defaults.title).to eq('a title')
+      expect(class_with_defaults.pages).to be(10)
+      expect(class_with_defaults.authors).to eq([1, 2, 4])
+    end
+
+    it "allows you to override default values" do
+      class_with_defaults = ClassWithDefaults.new(title: 'Something', authors: [1, 5, 7])
+
+      expect(class_with_defaults.title).to eq('Something')
+      expect(class_with_defaults.pages).to be(10)
+      expect(class_with_defaults.authors).to eq([1, 5, 7])
+    end
+
+    it "allows callable default values" do
+      class_with_defaults = ClassWithDefaults.new
+
+      expect(class_with_defaults.callable).to eq("callable value")
+    end
+
+    it "doesn't use the same instance between multiple instances" do
+      class_with_defaults = ClassWithDefaults.new
+      class_with_defaults.authors << 2
+
+      class_with_defaults2 = ClassWithDefaults.new
+
+      expect(class_with_defaults2.authors).to eq([1, 2, 4])
+    end
+  end
 end

data/spec/fixtures/classes.rb

@@ -113,3 +113,14 @@ class DefaultLenientAttributes
   attribute :rate,      :float
   attribute :active,    :boolean
 end
+
+class ClassWithDefaults
+  extend FastAttributes
+
+  define_attributes initialize: true, attributes: true do
+    attribute :title, String, default: "a title"
+    attribute :pages, Integer, default: 10
+    attribute :authors, Array, default: [1, 2, 4]
+    attribute :callable, String, default: lambda { "callable value" }
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fast_attributes
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Kostiantyn Stepaniuk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-31 00:00:00.000000000 Z
+date: 2016-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -101,6 +101,7 @@ files:
 - fast_attributes.gemspec
 - lib/fast_attributes.rb
 - lib/fast_attributes/builder.rb
+- lib/fast_attributes/default_attributes.rb
 - lib/fast_attributes/type_cast.rb
 - lib/fast_attributes/version.rb
 - spec/fast_attributes/type_cast_spec.rb