deep_dirty 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aa08f99165db0f0e0859e69ff59e42770a386749
+  data.tar.gz: 7140bae29f2ab14f146d09aebfd0f1c8292f4f09
+SHA512:
+  metadata.gz: 3aa52d60188245c4b20788e31a051f32b89b94febd9b3c9229f06adc1d25e27be1d118da7664e140fbda4969d9de804d9d1f091cd83ea152eb4d5c914a069ac1
+  data.tar.gz: 2fa0f5ea60ad001ad9a90d0ec152899d658944340079d52cbeb61705d850d672164c8a8115eebc1c8dce650f5e1a6bf76fedb05e016846e71f60359d105a0964

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in deep_dirty.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Laas Toom
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,56 @@
+# DeepDirty
+
+`ActiveModel::Dirty` does not track changes that are _destructive_ or _inplace_:
+
+    user = User.first
+    user.name.upcase!
+    u.changed?          # => false
+
+`DeepDirty` fixes this by adding a `before_validation` hook that compares all attributes to their `before_type_cast` values and records any changes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'deep_dirty'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install deep_dirty
+
+## Usage
+
+In an `ActiveModel` include this module:
+
+    class User < ActiveRecord::Base
+        include DeepDirty
+    end
+
+    user = User.first
+    user.name.upcase!
+    user.valid?
+    user.changed?       # => true
+    user.changes        # => {"name" => ["Test User", "TEST USER"]}
+
+
+Alternatively if you need to check changes without calling validation, use `deep_changed?`:
+
+    user = User.first
+    user.name.upcase!
+    user.changed?       # => false
+    user.deep_changed?  # => true
+    user.changed?       # => true
+    user.changes        # => {"name" => ["Test User", "TEST USER"]}
+
+
+## Contributing
+
+1. Fork it ( https://github.com/borgand/deep_dirty/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+require 'rspec/core/rake_task'
+require "bundler/gem_tasks"
+
+
+# Default directory to look in is `/specs`
+# Run with `rake spec`
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color', '--format', 'doc']
+end
+
+task :default => :spec

data/deep_dirty.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'deep_dirty/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "deep_dirty"
+  spec.version       = DeepDirty::VERSION
+  spec.authors       = ["Laas Toom"]
+  spec.email         = ["laas.toom@gmail.com"]
+  spec.summary       = %q{Dirty tracking that supports implicit destructive changes}
+  spec.description   = %q{Sets up `before_validation` callback that compares every attribute to it's before
+    type cast value and marks all changes detected.}
+  spec.homepage      = "https://github.com/borgand/deep_dirty"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+
+  spec.add_runtime_dependency "activemodel", ">= 3.0.0"
+end

data/lib/deep_dirty.rb

@@ -0,0 +1,30 @@
+require "deep_dirty/version"
+
+module DeepDirty
+  def self.included(base)
+    base.class_eval do
+      before_validation :deep_dirty_check
+    end
+  end
+
+  # apply deep dirty check and then return `changed?`
+  def deep_changed?
+    deep_dirty_check
+    changed?
+  end
+
+  # Compare each attribute to it's value before type cast and mark changes where detected
+  def deep_dirty_check
+    self.attributes.keys.each do |attr|
+      next if attribute_changed?(attr)
+      col = column_for_attribute(attr)
+      uncast_value = read_attribute_before_type_cast(attr)
+      recast_value = col.type_cast(uncast_value)
+      unless recast_value == read_attribute(attr)
+        changed_attributes[attr] = recast_value
+      end
+    end
+    # This should never break validation
+    true
+  end
+end

data/lib/deep_dirty/version.rb

@@ -0,0 +1,3 @@
+module DeepDirty
+  VERSION = "1.0.0"
+end

data/spec/deep_dirty_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+describe DeepDirty do
+  subject do
+    TestSubject.new
+  end
+
+  context "Without changes" do
+    it "does not show changes" do
+      expect(subject).not_to be_changed
+    end
+  end
+
+  context "With explicit changes" do
+    it 'reports model to be changed' do
+      subject.name = 'new name'
+      expect(subject).to be_changed
+    end
+
+    it 'reports attribute as changed' do
+      subject.name = 'new name'
+      expect(subject).to be_name_changed
+    end
+
+    it 'returns new value for attribute' do
+      subject.name = 'New Name'
+      expect(subject.name).to eq('New Name')
+    end
+
+    it 'returns old value for attribute' do
+      subject.name = 'New Name'
+      expect(subject.name_was).to eq('Test User')
+    end
+  end
+
+  context "With implicit changes" do
+    it 'reports model to be deep_changed' do
+      subject.name.upcase!
+      expect(subject).to be_deep_changed
+    end
+
+    it 'reports model to be changed after validation' do
+      subject.name.upcase!
+      # DeepDirty hooks into before_validation
+      subject.validation
+      expect(subject).to be_changed
+    end
+
+    it 'reports attribute as changed after validation' do
+      subject.name.upcase!
+      subject.validation
+      expect(subject).to be_name_changed
+    end
+
+    it 'returns new value for attribute after validation' do
+      subject.name.upcase!
+      subject.validation
+      expect(subject.name).to eq('TEST USER')
+    end
+
+    it 'returns old value for attribute after validation' do
+      subject.name.upcase!
+      subject.validation
+      expect(subject.name_was).to eq('Test User')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'active_model'
+require File.join(File.dirname(__FILE__), '..', 'lib', 'deep_dirty')
+require File.join(File.dirname(__FILE__), 'test_subject')

data/spec/test_subject.rb

@@ -0,0 +1,52 @@
+class TestSubject
+  # These must be run before we can use callbacks
+  extend ActiveModel::Callbacks
+  define_model_callbacks :validation, :only => :before
+
+  include ActiveModel::Dirty
+  include DeepDirty
+
+  attr_accessor :name
+  define_attribute_methods :name
+  
+  def initialize
+    @name = "Test User"
+    @name_before_type_cast = "Test User"
+  end
+
+  def attributes
+    {'name' => @name}
+  end
+
+  def name=(val)
+    name_will_change! unless val == @name
+    @name = val
+  end
+
+  def validation
+    run_callbacks :validation
+  end
+
+  def read_attribute_before_type_cast(attr)
+    case attr
+    when :name, "name"
+      @name_before_type_cast
+    end
+  end
+
+  def read_attribute(attr)
+    case attr
+    when :name, "name"
+      @name
+    end
+  end
+
+  def column_for_attribute(attr)
+    fake_column = Object.new
+    type_cast_value = read_attribute_before_type_cast(attr)
+    fake_column.define_singleton_method(:type_cast) do |value|
+      type_cast_value
+    end
+    fake_column
+  end
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: deep_dirty
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Laas Toom
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: |-
+  Sets up `before_validation` callback that compares every attribute to it's before
+      type cast value and marks all changes detected.
+email:
+- laas.toom@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- deep_dirty.gemspec
+- lib/deep_dirty.rb
+- lib/deep_dirty/version.rb
+- spec/deep_dirty_spec.rb
+- spec/spec_helper.rb
+- spec/test_subject.rb
+homepage: https://github.com/borgand/deep_dirty
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Dirty tracking that supports implicit destructive changes
+test_files:
+- spec/deep_dirty_spec.rb
+- spec/spec_helper.rb
+- spec/test_subject.rb