soulless 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: afcfdbb737a946c2f08e73de14f36121acf79300
-  data.tar.gz: 32c52dad7be7cd46dc5bc63176e24131b06f1909
+  metadata.gz: 86071e11077e8f0fbb5a648383a33fa2285f44d0
+  data.tar.gz: 0e204049ea4b6007dbb9280398e2e3d3101e964a
 SHA512:
-  metadata.gz: 711338a9d4b320d44cf6aff3f5bc340da6b520b31dafd049c1c7749d76df2053b543fd334e1ec95a964fa9e81460e5c41e1397a2a1286916ce3613b68c2bc5c3
-  data.tar.gz: 82d067106ed7b91d224ee12e0b89ddbd4b24fc020938e55e2bfd0c2c129089590cbe37d4c21bf8cc320105a4fcb42f5266f7057f4131789981990a079cb8dd90
+  metadata.gz: f938f7ff9708a8661dfdb79e54f0c89227e62feab7362166e4e605223551d4e720f93ea98b569c58ee8c7d31e8da4cd3249016b1bd7bfa81733ad39b148b86ad
+  data.tar.gz: 61e9fde6e2a30146dfcc7d24025b9a2c60db26e50857df20753f1566ff50bb1b102b9091636bb3e49a70f10fb20007711e057618969d427a509a6b4d5e9d2dec

data/.travis.yml

@@ -2,6 +2,7 @@ language: ruby
 rvm:
   - 2.2.2
   - 2.3.0
+  - 2.4.0
   - ruby-head
   - jruby-head
 env:

data/README.md

@@ -44,7 +44,7 @@ end
 Soulless lets you define your validations and manage your errors just like you did in Rails.
 
 ```ruby
-class UserSignupForm
+class UserSignupForm < Soulless::Model
 
   ...
 
@@ -61,14 +61,14 @@ class UserSignupForm
 end
 ```
 
-Check to see if your object is valid by calling ```valid?```.
+Check to see if your object is valid by calling `valid?`.
 
 ```ruby
 form = UserSignupForm.new(name: name, email: email)
 form.valid? # => false
 ```
 
-See what errors are popping up using the ```errors``` attribute.
+See what errors are popping up using the `errors` attribute.
 
 ```ruby
 form = UserSignupForm.new(name: name, email: email)
@@ -81,7 +81,7 @@ form.errors[:password] # => ["is too short (minimum is 8 characters)"]
 If you're using Soulless in Rails it's even possible to validate uniqueness.
 
 ```ruby
-class UserSignupForm
+class UserSignupForm < Soulless::Model
 
   ...
 
@@ -93,9 +93,9 @@ class UserSignupForm
 end
 ```
 
-Just let the validator know what ActiveRecord model to use when performing the validation using the ```model``` option.
+Just let the validator know what ActiveRecord model to use when performing the validation using the `model` option.
 
-If your Soulless object attribute doesn't match up to the ActiveRecord model attribute just map it using the ```attribute``` option.
+If your Soulless object attribute doesn't match up to the ActiveRecord model attribute just map it using the `attribute` option.
 
 ### Callbacks
 
@@ -141,7 +141,7 @@ person.name_change # => ["Anthony", "Peter Parker"]
 
 One of the biggest pitfalls of the form object pattern is duplication of code. It's not uncommon for a form object to define attributes and validations that are identical to the model it represets.
 
-To get rid of this annoying issue Soulless implements the ```#inherit_from(klass, options = {})``` method. This method will allow a Soulless model to inherit attributes and validations from any Rails model, Soulless model or Virtus object.
+To get rid of this annoying issue Soulless implements the `#inherit_from(klass, options = {})` method. This method will allow a Soulless model to inherit attributes and validations from any Rails model, Soulless model or Virtus object.
 
 ```ruby
 class User < ActiveRecord::Base
@@ -158,7 +158,7 @@ class UserSignupForm < Soulless::Model
 end
 ```
 
-The ```UserSignupForm``` has automatically been defined with the ```name``` and ```email``` attributes and validations.
+The `UserSignupForm` has automatically been defined with the `name` and `email` attributes and validations.
 
 ```ruby
 UserSignupForm.attributes # => name and email attributes
@@ -169,9 +169,9 @@ form.errors.messages # => { name: ["can't be blank"], email: ["can't be blank"]
 
 If your model is using the uniqueness validator it will automatically convert it to the [uniqueness validator provided by Soulless](https://github.com/anthonator/soulless#uniqueness-validations).
 
-The ```#inherit_from(klass, options = {})``` method also allows you to provide options for managing inherited attributes.
+The `#inherit_from(klass, options = {})` method also allows you to provide options for managing inherited attributes.
 
-If you don't want to inherit the ```email``` attribute define it using the ```exclude``` option.
+If you don't want to inherit the `email` attribute define it using the `exclude` option.
 
 ```ruby
 class UserSignupForm < Soulless::Model
@@ -184,7 +184,7 @@ form.valid? # => false
 form.errors.messages # => { name: ["can't be blank"] }
 ```
 
-You can also flip it around if you only want the ```name``` attribute by using the ```only``` option.
+You can also flip it around if you only want the `name` attribute by using the `only` option.
 
 ```ruby
 class UserSignupForm < Soulless::Model
@@ -199,17 +199,45 @@ form.errors.messages # => { name: ["can't be blank"] }
 
 #### Available Options
 
-```only``` - Only inherit the attributes and validations for the provided attributes. Any attributes not specified will be ignored. Accepts strings, symbols and an array of strings or symbols.
+`only` - Only inherit the attributes and validations for the provided attributes. Any attributes not specified will be ignored. Accepts strings, symbols and an array of strings or symbols.
+
+`exclude` - Don't inherit the attributes and validations for the provided attributes. Accepts strings, symbols and an array of strings or symbols.
+
+`skip_validators` - Only inherit attributes. Don't inherit any validators. Accepts a boolean.
+
+`use_database_default` - Use the value of the `default` migration option as the default value for an attribute. Accepts either a boolean (for all attributes), a string or symbol for a single attribute or an array of strings and symbols for multiple attributes.
 
-```exclude``` - Don't inherit the attributes and validations for the provided attributes. Accepts strings, symbols and an array of strings or symbols.
+`additional_attributes` - Used to specify attributes that cannot automatically be added to the form model. These are generally attributes that have been specified using `attr_accessor`. Accepts a string, symbol or an array of strings and symbols for multiple attributes.
 
-```skip_validators``` - Only inherit attributes. Don't inherit any validators. Accepts a boolean.
+`validate_attribute_on` - By default any validation that specifies an `:on` option will not be inherited. This option will allow you to inherit a validator that uses the `:on` with a specific value. Example usage: `validate_password_on: :create`. Accepts a string or symbol. This option will accept any value that the Rails `:on` validator option can accept.
 
-```use_database_default``` - Use the value of the ```default``` migration option as the default value for an attribute. Accepts either a boolean (for all attributes), a string or symbol for a single attribute or an array of strings and symbols for multiple attributes.
+### Serialization
 
-```additional_attributes``` - Used to specify attributes that cannot automatically be added to the form model. These are generally attributes that have been specified using ```attr_accessor```. Accepts a string, symbol or an array of strings and symbols for multiple attributes.
+Soulless automatically handles serializing and deserializing Soulless models
+using the standard ActiveRecord serialization methods.
+
+```ruby
+class Profile < Soulless::Model
+  attribute :first_name, String
+  attribute :last_name, String
+
+  ...
+end
+
+class User < ActiveRecord::Base
+  serialize :profile, Profile
+
+  ...
+end
+
+user = User.new
+user.profile = { first_name: 'Anthony', last_name: 'Smith' }
+user.profile # => Profile(first_name: 'Anthony', last_name: 'Smith')
+```
 
-```validate_attribute_on``` - By default any validation that specifies an ```:on``` option will not be inherited. This option will allow you to inherit a validator that uses the ```:on``` with a specific value. Example usage: ```validate_password_on: :create```. Accepts a string or symbol. This option will accept any value that the Rails ```:on``` validator option can accept.
+If you want to implement your own serialization/deserialization process just
+implement your own `self.load(value)` and `self.dump(value)` methods on your
+model.
 
 ### I18n
 

data/lib/soulless/model.rb

@@ -5,6 +5,7 @@ module Soulless
     extend ActiveModel::Translation
 
     extend Soulless::Inheritance
+    extend Soulless::Serialization
 
     include ActiveModel::AttributeMethods
     include ActiveModel::Dirty

data/lib/soulless/serialization.rb

@@ -0,0 +1,21 @@
+module Soulless
+  module Serialization
+    def load(value)
+      if value.is_a?(Array)
+        value.map do |data|
+          self.new(data)
+        end
+      elsif value.is_a?(Hash)
+        self.new(value)
+      elsif value.is_a?(String)
+        self.new(JSON.parse(value))
+      else
+        value
+      end
+    end
+
+    def dump(value)
+      value.to_json
+    end
+  end
+end

data/lib/soulless/version.rb

@@ -1,3 +1,3 @@
 module Soulless
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/lib/soulless.rb

@@ -5,6 +5,7 @@ require 'soulless/attributes'
 require 'soulless/callbacks'
 require 'soulless/dirty'
 require 'soulless/inheritance'
+require 'soulless/serialization'
 require 'soulless/validations'
 require 'soulless/model'
 require 'soulless/version'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: soulless
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Anthony Smith
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-14 00:00:00.000000000 Z
+date: 2017-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -110,6 +110,7 @@ files:
 - lib/soulless/dirty.rb
 - lib/soulless/inheritance.rb
 - lib/soulless/model.rb
+- lib/soulless/serialization.rb
 - lib/soulless/validations.rb
 - lib/soulless/validations/uniqueness_validator.rb
 - lib/soulless/version.rb
@@ -134,7 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.7
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Rails models without the database (and Rails)