shallow_attributes 0.9.0 → 0.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8d9c84f7e0cad4b197b19de9247b98e29355907f
-  data.tar.gz: be6015df6fed9d6efb0d65abc9f2a6a2a4bcadd2
+  metadata.gz: eae949ec12824705349bf498a92b2f524bd912a0
+  data.tar.gz: 1d3a7b3754419370e910cd6b90978425ff12010b
 SHA512:
-  metadata.gz: 1eca913e91af6856f031b0e677d115f315d079de53d263601e6b7a51df4f186799813d26f30f3d21ae4536faa34e571debc767ed2db76d911cf30f97610140fb
-  data.tar.gz: 9f430c8bbe5c73d3a2ad22b0f6cdbe8d0a9b8309e7d5e15291735dea260facc1f7406e532bd53eca02e1c11a698acfb440c4ea5cc472f0fdec5c3ac4b0f6efa5
+  metadata.gz: 109b2b4f4e0f699c1d4ba567c988ddc6da547e7be22b10f063b347f1489fc1f1a6c81325822ca7427ce7bca7dc6f3a7b1c1ecafb2609ab0cf0099023eb4adf8b
+  data.tar.gz: 32b707b41127ab624d0566a6d0fbbb455326c0b36085daacf8a71d0d6d1685d5a3e63c9b9c8deafad65dbb5f01ef44a8305969f0bd513a57837fc5655bf91489

data/.travis.yml

@@ -4,11 +4,14 @@ cache: bundler
 before_install: gem install bundler -v 1.11.2
 rvm:
   - 2.0.0
-  - 2.1.8
-  - 2.2.4
-  - 2.3.0
+  - 2.1.9
+  - 2.2.5
+  - 2.3.1
+  - 2.4.0
   - jruby-head
   - rbx-2
+  - ruby-head
 matrix:
   allow_failures:
     - rvm: rbx-2
+    - rvm: ruby-head

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+# ShallowAttributes Changes
+## HEAD

data/Gemfile

@@ -6,3 +6,5 @@ gemspec
 if !ENV['TRAVIS']
   gem 'yard', require: false
 end
+
+gem 'coveralls', require: false

data/README.md

@@ -1,18 +1,20 @@
 # ShallowAttributes
 [![Build Status](https://travis-ci.org/davydovanton/shallow_attributes.svg?branch=master)](https://travis-ci.org/davydovanton/shallow_attributes)
 [![Code Climate](https://codeclimate.com/github/davydovanton/shallow_attributes/badges/gpa.svg)](https://codeclimate.com/github/davydovanton/shallow_attributes)
+[![Coverage Status](https://coveralls.io/repos/github/davydovanton/shallow_attributes/badge.svg?branch=master)](https://coveralls.io/github/davydovanton/shallow_attributes?branch=master)
 [![Inline docs](http://inch-ci.org/github/davydovanton/shallow_attributes.svg?branch=master)](http://inch-ci.org/github/davydovanton/shallow_attributes)
 
-Simple and lightweight Virtus analog.
+Simple and lightweight Virtus analog without any dependencies. [Documentation][doc-link].
 
 ## 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, fast_attributes or attrio. However, the disadvantage of these
-gems is performance or API. So, the goal of ShallowAttributes is to provide a simple solution which is similar
-to the Virtus API, simple, fast, understandable and extendable.
+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][virtus-link], [fast_attributes][fast-attributes-link]
+or [attrio][attrio-link]. However, the disadvantage of these gems is performance or API. So, the goal
+of `ShallowAttributes` is to provide a simple solution which is similar to the `Virtus` API, simple, fast,
+understandable and extendable.
 
-This is [the performance benchmark](https://gist.github.com/davydovanton/7cf0da532eae71381cbd) of ShallowAttributes compared to virtus gems.
+This is [the performance benchmark][performance-benchmark] of ShallowAttributes compared to virtus gems.
 
 ## Installation
 
@@ -31,6 +33,15 @@ Or install it yourself as:
     $ gem install shallow_attributes
 
 ## Examples
+### Table of contents
+* [Using ShallowAttributes with Classes](#using-shallowattributes-with-classes)
+* [Default Values](#default-values)
+* [Embedded Value](#embedded-value)
+* [Custom Coercions](#custom-coercions)
+* [Collection Member Coercions](#collection-member-coercions)
+* [Note about Member Coercions](#important-note-about-member-coercions)
+* [Overriding setters](#overriding-setters)
+* [ActiveModel validation](#activemodel-validation)
 
 ### Using ShallowAttributes with Classes
 You can create classes extended with Virtus and define attributes:
@@ -53,11 +64,11 @@ class SuperUser < User
 end
 
 user = User.new(name: 'Anton', age: 31)
-user.name # => "Anton"
+user.name       # => "Anton"
 
 user.age = '31' # => 31
-user.age = nil # => nil
-user.age.class # => Fixnum
+user.age = nil  # => nil
+user.age.class  # => Fixnum
 
 user.birthday = 'November 18th, 1983' # => #<DateTime: 1983-11-18T00:00:00+00:00 (4891313/2,0/1,2299161)>
 
@@ -65,11 +76,11 @@ user.attributes # => { name: "Anton", age: 31, birthday: nil }
 
 # mass-assignment
 user.attributes = { name: 'Jane', age: 21 }
-user.name # => "Jane"
-user.age  # => 21
+user.name       # => "Jane"
+user.age        # => 21
 
 super_user = SuperUser.new
-user.age = nil # => 0
+user.age = nil  # => 0
 ```
 
 ### Default Values
@@ -109,7 +120,7 @@ page.reset_attribute(:views)  # => 0
 page.views                    # => 0
 ```
 
-## Embedded Value
+### Embedded Value
 
 ``` ruby
 class City
@@ -142,7 +153,7 @@ user = User.new(address: {
   }
 })
 
-user.address.street # => "Street 1/2"
+user.address.street    # => "Street 1/2"
 user.address.city.name # => "NYC"
 ```
 
@@ -165,7 +176,7 @@ end
 
 user = User.new
 user.info = '{"email":"john@domain.com"}' # => {"email"=>"john@domain.com"}
-user.info.class # => Hash
+user.info.class                           # => Hash
 
 # With a custom attribute encapsulating coercion-specific configuration
 class NoisyString
@@ -228,15 +239,49 @@ user = User.new(
     { :address => '1234 Any St.', :locality => 'Anytown', :region => "DC", :postal_code => "21234" } ])
 
 user.phone_numbers # => [#<PhoneNumber:0x007fdb2d3bef88 @number="212-555-1212">, #<PhoneNumber:0x007fdb2d3beb00 @number="919-444-3265">]
-user.addresses # => [#<Address:0x007fdb2d3be448 @address="1234 Any St.", @locality="Anytown", @region="DC", @postal_code="21234">]
-
-user.attributes # => {
-                # =>   :phone_numbers => [
-                # =>     { :number => '212-555-1212' },
-                # =>     { :number => '919-444-3265' } ],
-                # =>   :addresses => [
-                # =>     { :address => '1234 Any St.', :locality => 'Anytown', :region => "DC", :postal_code => "21234" } ]
-                # => }
+user.addresses     # => [#<Address:0x007fdb2d3be448 @address="1234 Any St.", @locality="Anytown", @region="DC", @postal_code="21234">]
+
+user.attributes
+# => {
+# =>   :phone_numbers => [
+# =>     { :number => '212-555-1212' },
+# =>     { :number => '919-444-3265' }
+# =>   ],
+# =>   :addresses => [
+# =>     {
+# =>       :address => '1234 Any St.',
+# =>       :locality => 'Anytown',
+# =>       :region => "DC",
+# =>       :postal_code => "21234"
+# =>     }
+# =>   ]
+# => }
+```
+
+### IMPORTANT note about member coercions
+
+ShallowAttributes performs coercions only when a value is being assigned. If you mutate the value later on using its own interfaces then coercion won't be triggered.
+
+Here's an example:
+
+``` ruby
+class Book
+  include ShallowAttributes
+  attribute :title, String
+end
+
+class Library
+  include ShallowAttributes
+  attribute :books, Array, of: Book
+end
+
+library = Library.new
+
+# This will coerce Hash to a Book instance
+library.books = [ { :title => 'Introduction' } ]
+
+# This WILL NOT COERCE the value because you mutate the books array with Array#<<
+library.books << { :title => 'Another Introduction' }
 ```
 
 ### Overriding setters
@@ -286,11 +331,16 @@ user.valid? # => true
 
 ## Ruby version support
 
-ShallowAttributes is known to work correctly with the following rubies:
+ShallowAttributes is [known to work correctly][travis-link] with the following rubies:
 
-* 2.3+
+* 2.0
+* 2.1
+* 2.2
+* 2.3
+* 2.4
+* jruby-head
 
-In future I want ot support other ruby sersion/platforms.
+Also we run rbx-2 buld too.
 
 ## Contributing
 
@@ -298,8 +348,14 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/davydo
 This project is intended to be a safe, welcoming space for collaboration, and contributors are expected
 to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
 
+
+[doc-link]: http://www.rubydoc.info/github/davydovanton/shallow_attributes/master
+[virtus-link]: https://github.com/solnic/virtus
+[fast-attributes-link]: https://github.com/applift/fast_attributes
+[attrio-link]: https://github.com/jetrockets/attrio
+[performance-benchmark]: https://gist.github.com/davydovanton/d14b51ab63e3fab63ecb
+[travis-link]: https://travis-ci.org/davydovanton/shallow_attributes

data/Rakefile

@@ -7,4 +7,4 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList['test/**/*_test.rb']
 end
 
-task :default => :test
+task default: :test

data/lib/shallow_attributes/class_methods.rb

@@ -6,6 +6,19 @@ module ShallowAttributes
   #
   # @since 0.1.0
   module ClassMethods
+    # Inject our default values into subclasses.
+    #
+    # @private
+    #
+    # @param [Object] subclass
+    #
+    def inherited(subclass)
+      super
+      if respond_to?(:default_values)
+        subclass.default_values.merge!(default_values)
+      end
+    end
+
     # Returns hash which contain default values for each attribute
     #
     # @private
@@ -14,16 +27,11 @@ module ShallowAttributes
     #
     # @since 0.1.0
     def default_values
-      if superclass.respond_to?(:default_values)
-        @default_values.merge!(superclass.default_values) { |_, v, _| v }
-      else
-        @default_values
-      end
+      @default_values ||= {}
     end
 
     # Returns all class attributes.
     #
-    #
     # @example Create new User instance
     #   class User
     #     include ShallowAttributes
@@ -66,8 +74,7 @@ module ShallowAttributes
     def attribute(name, type, options = {})
       options[:default] ||= [] if type == Array
 
-      @default_values ||= {}
-      @default_values[name] = options.delete(:default)
+      default_values[name] = options.delete(:default)
 
       initialize_setter(name, type, options)
       initialize_getter(name)
@@ -89,7 +96,12 @@ module ShallowAttributes
     def initialize_setter(name, type, options)
       module_eval <<-EOS, __FILE__, __LINE__ + 1
         def #{name}=(value)
-          @#{name} = ShallowAttributes::Type.coerce(#{type}, value, #{options})
+          @#{name} = if value.is_a?(#{type}) && !value.is_a?(Array)
+            value
+          else
+            ShallowAttributes::Type.coerce(#{type}, value, #{options})
+          end
+
           @attributes[:#{name}] = @#{name}
         end
       EOS

data/lib/shallow_attributes/instance_methods.rb

@@ -12,11 +12,11 @@ module ShallowAttributes
     # @private
     #
     # @since 0.1.0
-    TO_H_PROC = -> (value) { value.respond_to?(:to_hash) ? value.to_hash : value }
+    TO_H_PROC = ->(value) { value.respond_to?(:to_hash) ? value.to_hash : value }
 
     # Initialize instance object with specific attributes
     #
-    # @param [Hash] attributes the attributes contained in the class
+    # @param [Hash] attrs the attributes contained in the class
     #
     # @example Create new User instance
     #   class User
@@ -30,7 +30,11 @@ module ShallowAttributes
     #
     # @since 0.1.0
     def initialize(attrs = {})
-      @attributes = attrs.delete_if { |key, _| !default_values.key?(key) }
+      @attributes = {}
+      attrs.each_pair do |key, value|
+        key = key.to_sym
+        @attributes[key] = value if default_values.key?(key)
+      end
       define_attributes
       define_default_attributes
     end
@@ -131,7 +135,7 @@ module ShallowAttributes
     # @return the object
     #
     # @since 0.1.0
-    def coerce(value, options = {})
+    def coerce(value, _options = {})
       self.attributes = value
       self
     end

data/lib/shallow_attributes/type.rb

@@ -17,33 +17,6 @@ module ShallowAttributes
     class InvalidValueError < TypeError
     end
 
-    # Convert value object to specific Type class
-    #
-    # @private
-    #
-    # @param [Class] type the type class object
-    # @param [Object] value the value that should be submit to the necessary type
-    # @param [Hash] options the options to create a message with.
-    # @option options [String] :of The type of array
-    # @option options [boolean] :allow_nil cast `nil` to integer or float
-    #
-    # @example Convert integer to sting type
-    #   ShallowAttributes::Type.coerce(String, 1)
-    #     # => '1'
-    #
-    # @example Convert string to custom hash type
-    #   ShallowAttributes::Type.instance_for(JsonType, '{"a"=>1}')
-    #     # => { a: 1 }
-    #
-    # @return the converted value object
-    #
-    # @since 0.1.0
-    def self.coerce(type, value, options = {})
-      type_instance(type).coerce(value, options)
-    end
-
-  private
-
     # Hash object with cached type objects.
     #
     # @private
@@ -58,25 +31,54 @@ module ShallowAttributes
       ::Time     => ShallowAttributes::Type::Time.new
     }.freeze
 
-    # Returns class object for specific Type class
-    #
-    # @private
-    #
-    # @param [Class] type the type class object
-    #
-    # @example Returns Sting type class
-    #   ShallowAttributes::Type.instance_for(String)
-    #     # => ShallowAttributes::Type::Sting class
-    #
-    # @example Returns other type class
-    #   ShallowAttributes::Type.instance_for(MySpecialStringType)
-    #     # => MySpecialStringType class
-    #
-    # @return [Class]
-    #
-    # @since 0.1.0
-    def self.type_instance(klass)
-      DEFAULT_TYPE_OBJECTS[klass] || ShallowAttributes::Type.const_get(klass.name).new
+    class << self
+      # Convert value object to specific Type class
+      #
+      # @private
+      #
+      # @param [Class] type the type class object
+      # @param [Object] value the value that should be submit to the necessary type
+      # @param [Hash] options the options to create a message with.
+      # @option options [String] :of The type of array
+      # @option options [boolean] :allow_nil cast `nil` to integer or float
+      #
+      # @example Convert integer to sting type
+      #   ShallowAttributes::Type.coerce(String, 1)
+      #     # => '1'
+      #
+      # @example Convert string to custom hash type
+      #   ShallowAttributes::Type.instance_for(JsonType, '{"a"=>1}')
+      #     # => { a: 1 }
+      #
+      # @return the converted value object
+      #
+      # @since 0.1.0
+      def coerce(type, value, options = {})
+        type_instance(type).coerce(value, options)
+      end
+
+    private
+
+      # Returns class object for specific Type class
+      #
+      # @private
+      #
+      # @param [Class] type the type class object
+      #
+      # @example Returns Sting type class
+      #   ShallowAttributes::Type.instance_for(String)
+      #     # => ShallowAttributes::Type::Sting class
+      #
+      # @example Returns other type class
+      #   ShallowAttributes::Type.instance_for(MySpecialStringType)
+      #     # => MySpecialStringType class
+      #
+      # @return [Class]
+      #
+      # @since 0.1.0
+      def type_instance(klass)
+        DEFAULT_TYPE_OBJECTS[klass] || ShallowAttributes::Type.const_get(klass.name).new
+      end
     end
   end
 end

data/lib/shallow_attributes/type/boolean.rb

@@ -39,7 +39,7 @@ module ShallowAttributes
       # @return [boolean]
       #
       # @since 0.1.0
-      def coerce(value, options = {})
+      def coerce(value, _options = {})
         if TRUE_VALUES.include?(value)
           true
         elsif FALSE_VALUES.include?(value)

data/lib/shallow_attributes/type/date_time.rb

@@ -22,7 +22,7 @@ module ShallowAttributes
       # @return [DateTime]
       #
       # @since 0.1.0
-      def coerce(value, options = {})
+      def coerce(value, _options = {})
         case value
         when ::DateTime then value
         when ::Time then ::DateTime.parse(value.to_s)

data/lib/shallow_attributes/type/float.rb

@@ -1,6 +1,6 @@
 module ShallowAttributes
   module Type
-    # Abstract class for typecast object to Float type.
+    # This class needs for cange object type to Float.
     #
     # @abstract
     #

data/lib/shallow_attributes/type/integer.rb

@@ -1,6 +1,6 @@
 module ShallowAttributes
   module Type
-    # Abstract class for typecast object to Integer type.
+    # This class cange object to Integer.
     #
     # @abstract
     #

data/lib/shallow_attributes/type/string.rb

@@ -20,7 +20,7 @@ module ShallowAttributes
       # @return [Sting]
       #
       # @since 0.1.0
-      def coerce(value, options = {})
+      def coerce(value, _options = {})
         case value
         when ::Array then value.join
         when ::Hash, ::Class then error(value)

data/lib/shallow_attributes/type/time.rb

@@ -22,7 +22,7 @@ module ShallowAttributes
       # @return [Time]
       #
       # @since 0.1.0
-      def coerce(value, options = {})
+      def coerce(value, _options = {})
         case value
         when ::Time then value
         when ::Integer then ::Time.at(value)

data/lib/shallow_attributes/version.rb

@@ -2,5 +2,5 @@ module ShallowAttributes
   # Defines the full version
   #
   # @since 0.1.0
-  VERSION = "0.9.0".freeze
+  VERSION = "0.9.2".freeze
 end

data/shallow_attributes.gemspec

@@ -22,5 +22,4 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.11"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.0"
-  spec.add_development_dependency "simplecov", '~> 0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shallow_attributes
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.2
 platform: ruby
 authors:
 - Anton Davydov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-24 00:00:00.000000000 Z
+date: 2017-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,20 +52,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  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'
 description: Attributes for Plain Old Ruby Objects
 email:
 - antondavydov.o@gmail.com
@@ -75,13 +61,12 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
 - lib/shallow_attributes.rb
 - lib/shallow_attributes/class_methods.rb
 - lib/shallow_attributes/instance_methods.rb

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "shallow_attributes"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here