soulless 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b5f1fdf92746ec9e608ea04972dc9bccca8e7dbb
-  data.tar.gz: 4f85870777d309a49b95e1183537cfde8fb5abca
+  metadata.gz: c6c63b43665d1f50ce110a47e5795d8bd3a15c40
+  data.tar.gz: 31f52968fa34dfd97a1432bc7cbc70e0a538d6f6
 SHA512:
-  metadata.gz: 76939041a34437f9cda7a52bde28c203f11964f29404ae1c6e5714e340594331f31449eadba64fc17320fe0bfd10258496d96f8277c02f8412045145e9279d6a
-  data.tar.gz: 3c03f011a6027fd83c33a26044f62fde6dbb81401cb2f0dbb9ce5b11edfaf93aa06d02b8ca1b2a2abd3d60fc34ecf3bfe6b90d6d1f3db599b56ee22836896f92
+  metadata.gz: 1ec6eebae341e1b509848e5c41ac563476e962364fca7cf63eec12d448e70c1a06a7f87d81fbb7721704b763bb99c24fda8ffe26610204d921dc02d7b6c979ea
+  data.tar.gz: 110ccec9dc80a0425e82da7e2ba4bb389fa6e8f016a1553478df82221459d962b5d0547ee375db73d935b0760b610570ca788ad52111ac737b56e75c4c41f468

data/README.md

@@ -26,16 +26,16 @@ Just define a plain-old-ruby-object, include Soulless and get crackin'!
 ```ruby
 class UserSignupForm
   include Soulless.model
-  
+
   attribute :name, String
   attribute :email, String
   attribute :password, String
-  
+
   validates :name, presence: true
-  
+
   validates :email, presence: true,
                     uniqueness: { model: User }
-  
+
   validates :password, presence: true,
                        lenght: { is_at_least: 8 }
 
@@ -54,7 +54,7 @@ Soulless let's _you_ define what happens when your object is ready to be process
 class UserSignupForm
 
   ...
-  
+
   private
   def persist!
     user = User.create!(name: name, email: email, password: password)
@@ -83,12 +83,12 @@ Soulless lets you define your validations and manage your errors just like you d
 class UserSignupForm
 
   ...
-  
+
   validates :name, presence: true
-  
+
   validates :email, presence: true,
                     uniqueness: { model: User }
-  
+
   validates :password, presence: true,
                        lenght: { minimum: 8 }
 
@@ -120,12 +120,12 @@ If you're using Soulless in Rails it's even possible to validate uniqueness.
 class UserSignupForm
 
   ...
-  
+
   validates :primary_email, presence: true,
                             uniqueness: { model: User, attribute: :email }
-  
+
   ...
-  
+
 end
 ```
 
@@ -140,15 +140,15 @@ When you need associations use ```has_one``` and ```has_many```. Look familiar?
 ```ruby
 class Person
   include Soulless.model
-  
+
   attribute :name, String
-  
+
   validates :name, presence: true
-  
+
   has_one :spouse do
     attribute :name, String
   end
-  
+
   has_many :friends do
     attribute :name, String
   end
@@ -168,17 +168,17 @@ It's also possible for an association to inherit from a parent class and then ex
 ```ruby
 class Person
   include Soulless.model
-  
+
   attribute :name, String
-  
+
   validates :name, presence: true
-  
+
   has_one :spouse, Person do # inherits 'name' and validation from Person
     attribute :anniversary, DateTime
-    
+
     validates :anniversary, presence: true
   end
-  
+
   has_many :friends, Person # just inherit from Person, don't extend
 end
 ```
@@ -188,11 +188,11 @@ Your association has access to it's ```parent``` object as well.
 ```ruby
 class Person
   include Soulless.model
-  
+
   attribute :name, String
-  
+
   validates :name, presence: true
-  
+
   has_one :children do
     attribute :name, String, default: lambda { "#{parent.name} Jr." }
   end
@@ -205,17 +205,17 @@ When you need to make sure an association is valid before processing the object
 class Person
 
   ...
-  
+
   has_one :spouse do
     attribute :name, String
-    
+
     validates :name, presence: true
   end
-  
+
   validates_associated :spouse
-  
+
   ...
-  
+
 end
 
 person = Person.new(name: 'Anthony')
@@ -225,6 +225,44 @@ person.errors[:spouse] # => ["is invalid"]
 person.spouse.errors[:name] # => ["can't be blank"]
 ```
 
+### Callbacks
+
+Soulless supports the validation and save callbacks. You can use these callbacks
+as you would on a Rails model.
+
+```ruby
+class Person
+  include Soulless.model
+
+  attribute :name, String
+
+  validates :name, presence: true
+
+  before_validation :change_name_to_bart_simpson
+
+  before_save :change_name_to_mickey_mouse
+
+  has_one :children do
+    attribute :name, String, default: lambda { "#{parent.name} Jr." }
+  end
+
+  private
+  def change_name_to_bart_simpson
+    self.name = 'Bart Simpson'
+  end
+
+  def change_name_to_mickey_mouse
+    self.name = 'Mickey Mouse'
+  end
+end
+
+person = Person.new(name: 'Anthony')
+person.valid?
+person.name # => "Bart Simpson"
+person.save
+person.name # => "Mickey Mouse"
+```
+
 ### Dirty Attributes
 
 Dirty attribute allow you to track changes to a Soulless object before it's saved.
@@ -262,7 +300,7 @@ To get rid of this annoying issue Soulless implements the ```#inherit_from(klass
 ```ruby
 class User < ActiveRecord::Base
   validates :name, presence: true
-  
+
   validates :email, presence: true,
                     uniqueness: { case_insensitive: true }
 end
@@ -271,7 +309,7 @@ end
 ```ruby
 class UserSignupForm
   include Soulless.model
-  
+
   inherit_from(User)
 end
 ```
@@ -294,7 +332,7 @@ If you don't want to inherit the ```email``` attribute define it using the ```ex
 ```ruby
 class UserSignupForm
   include Soulless.model
-  
+
   inherit_from(User, exclude: :email)
 end
 
@@ -309,7 +347,7 @@ You can also flip it around if you only want the ```name``` attribute by using t
 ```ruby
 class UserSignupForm
   include Soulless.model
-  
+
   inherit_from(User, only: :name)
 end
 
@@ -375,4 +413,4 @@ en:
 
 Soulless is maintained and funded by [Sticksnleaves](http://www.sticksnleaves.com)
 
-Thanks to all of our [contributors](https://github.com/anthonator/soulless/graphs/contributors)
+Thanks to all of our [contributors](https://github.com/anthonator/soulless/graphs/contributors)

data/lib/soulless/model.rb

@@ -4,50 +4,63 @@ module Soulless
       base.class_eval do
         extend ActiveModel::Naming
         extend ActiveModel::Translation
+        extend ActiveModel::Callbacks
         include ActiveModel::Conversion
         include ActiveModel::Dirty
         include ActiveModel::Validations
-        
+
         class << self
           def i18n_scope
             :soulless
           end
         end
-        
+
+        define_model_callbacks :validation, :save
+
         def initialize(params = {})
           init_accessors(attribute_set.map { |a| a.name })
           super
           init_dirty
         end
-        
+
         def persisted?
           false
         end
-    
+
+        def valid_with_callbacks?
+          run_callbacks :validation do
+            valid_without_callbacks?
+          end
+        end
+
+        alias_method_chain :valid?, :callbacks
+
         def save
           if valid?
-            persist!
-            changes_applied
-            true
+            run_callbacks :save do
+              persist!
+              changes_applied
+              true
+            end
           else
             false
           end
         end
-        
+
         def assign_attributes(attributes)
           deep_update(self, attributes)
         end
-    
+
         def update_attributes(attributes)
           assign_attributes(attributes)
           save
         end
-    
+
         private
         def persist!
           raise 'Method persist! not defined...'
         end
-        
+
         def deep_update(object, attributes)
           attributes.each do |key, value|
             if value.kind_of?(Hash)
@@ -60,4 +73,4 @@ module Soulless
       end
     end
   end
-end
+end

data/lib/soulless/version.rb

@@ -1,3 +1,3 @@
 module Soulless
-  VERSION = "0.5.1"
+  VERSION = "0.5.2"
 end

data/spec/soulless_spec.rb

@@ -53,4 +53,9 @@ describe Soulless do
   it '#persisted? should be false' do
     expect(@dummy_class.persisted?).to eq(false)
   end
+
+  it 'should call the before_validation callback' do
+    @dummy_class.save
+    expect(@dummy_class.validation_callback).to eq(true)
+  end
 end

data/spec/support/dummy_class.rb

@@ -1,14 +1,20 @@
 class DummyClass
   include Soulless.model
-  
+
   attribute :name, String, default: 'Anthony'
   attribute :email, String
+  attribute :validation_callback, Boolean
+  attribute :save_callback, Boolean
   attribute :saved, Boolean, default: false
 
   validates :name, presence: true
-  
+
+  before_validation lambda { self.validation_callback = true }
+
+  before_save lambda { self.save_callback = true }
+
   private
   def persist!
     self.saved = true
   end
-end
+end

data/spec/support/dummy_soulless_inheritance.rb

@@ -8,19 +8,3 @@ class DummySoullessInheritance
     self.saved = true
   end
 end
-
-# This is a hack for now. For some reason Travis can't see dummy_class.rb.
-class DummyClass
-  include Soulless.model
-
-  attribute :name, String, default: 'Anthony'
-  attribute :email, String
-  attribute :saved, Boolean, default: false
-
-  validates :name, presence: true
-
-  private
-  def persist!
-    self.saved = true
-  end
-end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: soulless
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors:
 - Anthony Smith