soulless 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b3a918d43aa402d0de13f3e8bcc28b1d4cbad074
-  data.tar.gz: a706a4c34294af699a1efdbda86dd649ffd278f5
+  metadata.gz: c3da6f6da8006ae59da0d6b1266c2d2882042d15
+  data.tar.gz: 59054e7d56f394f0f81bad19f22fd1029efa7198
 SHA512:
-  metadata.gz: 0187eb34dda842f89d9be39593e3168c1189ae7abbe61343b1ec5e80e14bebbfeaaebfd357f0c1c2257edd643534795f901f91104b2765f5ed614005ec0dd94f
-  data.tar.gz: fab7de2ebac15f30943af023b644e93759131fc40e3a3a46523440e3da42980f88e55aaae551ee1aad1b00e64c705bd6d0e9931821f2b6a39340db62aa2abd1a
+  metadata.gz: b36b03a5ccd3f4e6700caa0b072a8ccf819d4d42c5d4076ef6641ef7a99a35ed335e24dc6a53e115f53abde94e872b1d569919e29d19cc2131ae9b20306ddb46
+  data.tar.gz: 9ff554ead5d5fe0eaed31d8841e5dbaccc0bdae59dc4afa2f9bcd9b9a25be1c146e7a0436bbc8a7829e96e1a1cd085bb019e7638cd9510f91d4a13b00f7f6b99

data/Gemfile

@@ -20,4 +20,8 @@ end
 
 platforms :jruby do
   gem "activerecord-jdbcsqlite3-adapter"
+end
+
+group :development do
+  gem 'coveralls', require: false
 end

data/README.md

@@ -46,59 +46,6 @@ class UserSignupForm
 end
 ```
 
-### Default Values
-
-When defining attributes it's possible to specify default values.
-
-```ruby
-class UserSignupForm
-
-  ...
-  
-  attribute :name, String, default: 'Anthony'
-  
-  ...
-end
-```
-
-### Embedded Values
-
-It's possible to use other Soulless objects as attribute types.
-
-```ruby
-class User
-  include Soulless.model
-
-  attribute :name, String
-  attribute :email, String
-  attribute :password, String
-end
-
-class UserSignupForm
-  include Soulless.model
-  
-  attribute :user, User
-end
-```
-
-### Collection Coercions
-
-Define collections with specific types.
-
-```ruby
-class PhoneNumber
-  include Soulless.model
-  
-  attribute :number, String
-end
-
-class Person
-  include Soulless.model
-  
-  attribute :phone_numbers, Array[PhoneNumber]
-end
-```
-
 ### Processing an Object
 
 Soulless let's _you_ define what happens when your object is ready to be processed.
@@ -260,6 +207,34 @@ person.errors[:spouse] # => ["is invalid"]
 person.spouse.errors[:name] # => ["can't be blank"]
 ```
 
+### Dirty Attributes
+
+Dirty attribute allow you to track changes to a Soulless object before it's saved.
+
+```ruby
+person = Person.name(name: "Anthony", spouse: { name: "Mary Jane Watson" })
+person.name = 'Peter Parker'
+person.changed? # => true
+person.changed # => ["name"]
+person.changes # => { name: ["Anthony", "Peter Parker"] }
+person.name_changed? # => true
+person.name_was # => "Anthony"
+person.name_change # => ["Anthony", "Peter Parker"]
+```
+
+Works on ```has_one``` and ```has_many``` too.
+
+```ruby
+person.spouse.name = 'Gwen Stacy'
+person.spouse.changed? # => true
+person.spouse.changed # => ["name"]
+person.spouse.changes # => { name: ["Mary Jane Watson", "Gwen Stacy"] }
+person.spouse.name_changed? # => true
+person.spouse.name_was # => "Mary Jane Watson"
+person.spouse.name_change # => ["Mary Jane Watson", "Gwen Stacy"]
+person.changed? # => false
+```
+
 ### I18n
 
 Define locales similar to how you would define them in Rails.

data/lib/soulless/dirty.rb

@@ -0,0 +1,48 @@
+module Soulless
+  module Dirty
+    def self.included(base)
+      base.class_eval do
+        def initialize(params = {})
+          super
+          init_dirty(attribute_set.map { |a| a.name })
+        end
+        
+        private
+        def init_dirty(attributes)
+          define_dirty_attributes(attributes)
+          define_dirty_methods(attributes)
+          @changed_attributes = {}
+        end
+        
+        def changes_applied
+          @previously_changed = changed
+          @changed_attributes = {}
+        end
+        
+        def define_dirty_attributes(attributes)
+          self.class.define_attribute_methods(attributes)
+        end
+        
+        def define_dirty_methods(attributes)
+          attributes.each do |attribute|
+            define_dirty_reader(attribute)
+            define_dirty_writer(attribute)
+          end
+        end
+        
+        def define_dirty_reader(name)
+          self.class.send(:define_method, "#{name}".to_sym) do
+            instance_variable_get("@#{name}")
+          end
+        end
+        
+        def define_dirty_writer(name)
+          self.class.send(:define_method, "#{name}=".to_sym) do |value|
+            send("#{name}_will_change!") unless instance_variable_get("@#{name}") == value
+            super(value)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/soulless/model.rb

@@ -4,8 +4,9 @@ module Soulless
       base.class_eval do
         extend ActiveModel::Naming
         extend ActiveModel::Translation
-        include ActiveModel::Validations
         include ActiveModel::Conversion
+        include ActiveModel::Dirty
+        include ActiveModel::Validations
         
         class << self
           def i18n_scope
@@ -20,6 +21,7 @@ module Soulless
         def save
           if valid?
             persist!
+            changes_applied
             true
           else
             false

data/lib/soulless/version.rb

@@ -1,3 +1,3 @@
 module Soulless
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/soulless.rb

@@ -1,22 +1,11 @@
 require 'virtus'
 require 'securerandom'
-require 'active_support/core_ext/array/wrap'
-require 'active_support/core_ext/class/attribute'
-require 'active_support/core_ext/module/delegation'
-require 'active_support/callbacks'
-require 'active_support/concern'
-require 'active_support/inflector'
-require 'active_model/naming'
-require 'active_model/translation'
-require 'active_model/callbacks'
-require 'active_model/validator'
-require 'active_model/errors'
-require 'active_model/validations'
-require 'active_model/conversion'
-require 'active_model/version'
+require 'active_support'
+require 'active_model'
 
-require 'soulless/model'
 require 'soulless/associations'
+require 'soulless/dirty'
+require 'soulless/model'
 require 'soulless/validations'
 require 'soulless/version'
 
@@ -30,6 +19,7 @@ module Soulless
       object.send(:include, Model)
       object.send(:include, Associations)
       object.send(:include, Validations)
+      object.send(:include, Dirty)
     end
     mod
   end

data/spec/dirty_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+describe Soulless::Dirty do
+  before(:each) do
+    @dummy_class = DummyClass.new
+  end
+  
+  it 'should support dirty attributes' do
+    defined?(:changed?).should be_true
+  end
+  
+  it 'should record attribute changes' do
+    @dummy_class.name_changed?.should be_false
+    @dummy_class.name = 'Yaw'
+    @dummy_class.name_changed?.should be_true
+  end
+  
+  it 'should correctly record changes to objects with initialized values' do
+    @dummy_class = DummyClass.new(name: 'Biff')
+    @dummy_class.name_changed?.should be_false
+    @dummy_class.name = 'Anthony'
+    @dummy_class.name_changed?.should be_true
+  end
+  
+  it 'should record changes in a has_one association' do
+    @dummy_association = DummyAssociation.new(spouse: { name: 'Megan' })
+    @dummy_association.spouse.name_changed?.should be_false
+    @dummy_association.spouse.name = 'Megan Jr'
+    @dummy_association.spouse.name_changed?.should be_true
+  end
+  
+  it 'should record changes in a has_many association' do
+    @dummy_association = DummyAssociation.new(friends: [{ name: 'Yaw' }])
+    @dummy_association.friends[0].name_changed?.should be_false
+    @dummy_association.friends[0].name = 'Biff'
+    @dummy_association.friends[0].name_changed?.should be_true
+  end
+  
+  it 'should reset its dirty state when saved' do
+    @dummy_class.name = 'Biff'
+    @dummy_class.save
+    @dummy_class.changed?.should be_false
+  end
+  
+  it 'should not reset its dirty state if validations fail' do
+    @dummy_class.name = nil
+    @dummy_class.save
+    @dummy_class.changed?.should be_true
+  end
+  
+  it 'should record changed made before #save was called in previous_changes' do
+    @dummy_class.name = 'Biff'
+    @dummy_class.save
+    @dummy_class.previous_changes.should_not be_empty
+  end
+end

data/spec/soulless_spec.rb

@@ -16,6 +16,11 @@ describe Soulless do
     @dummy_class.saved.should be_true
   end
   
+  it 'should call #persist! when #update_attributes is called' do
+    @dummy_class.update_attributes(name: 'Biff')
+    @dummy_class.saved.should be_true
+  end
+  
   it 'should not call #persist! if attributes are invalid' do
     @dummy_class.name = nil
     @dummy_class.save.should be_false

data/spec/spec_helper.rb

@@ -1,5 +1,5 @@
-#require 'coveralls'
-#Coveralls.wear!
+require 'coveralls'
+Coveralls.wear!
 
 require File.expand_path("../../spec/dummy/config/environment", __FILE__)
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: soulless
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Anthony Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-07 00:00:00.000000000 Z
+date: 2013-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -123,6 +123,7 @@ files:
 - Rakefile
 - lib/soulless.rb
 - lib/soulless/associations.rb
+- lib/soulless/dirty.rb
 - lib/soulless/locale/en.yml
 - lib/soulless/model.rb
 - lib/soulless/validations.rb
@@ -132,6 +133,7 @@ files:
 - soulless.gemspec
 - spec/associated_validator_spec.rb
 - spec/associations_spec.rb
+- spec/dirty_spec.rb
 - spec/dummy/.gitignore
 - spec/dummy/README.rdoc
 - spec/dummy/Rakefile
@@ -214,6 +216,7 @@ summary: Create Rails style models without the database.
 test_files:
 - spec/associated_validator_spec.rb
 - spec/associations_spec.rb
+- spec/dirty_spec.rb
 - spec/dummy/.gitignore
 - spec/dummy/README.rdoc
 - spec/dummy/Rakefile