virtus-dirty_attribute 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 04a13c469b7cb547616f8aa120ff80cd43ab0c41
+  data.tar.gz: 772354eeb7ea3e9d6368e73a1b962c17a2b4a55b
+SHA512:
+  metadata.gz: 7f717a6aeff6769d21babd8b8cfa6e556845cd279feb93e7473106b2134de0da68a8e2a1c03f83c368430bef5c0499244eba039f652bcfbeaf978e79f1db193c
+  data.tar.gz: 57ce59a0d9840c0e64a5af9ac0268eb6465798aa8d189b903f72d81f250c130c179b51c6de634ff83aeec668d7dd760b99351a285b464d564b156cba99059893

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+notifications:
+  email:
+  - jingweno@gmail.com

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Jingwen Owen Ou
+
+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.rdoc

@@ -0,0 +1,46 @@
+= Virtus::DirtyAttribute
+
+Support for dirty tracking of virtus attributes.
+
+== Usage
+
+  require 'virtus-drity_attribute'
+
+  class Post
+    include Virtus.model
+    include Virtus::DirtyAttribute
+
+    attribute :title,   String
+    attribute :content, String
+    attribute :meta,    Hash
+  end
+
+  post = Post.new(:title => 'Foo', :meta => { :tags => ['red', 'green'] })
+
+  post.dirty? # => false
+
+  post.title = 'Bar'
+
+  post.dirty? # => true
+
+  post.attribute_dirty?(:title) # => true
+
+  post.meta[:tags] << 'blue'
+
+  post.attribute_dirty?(:meta) # => true
+
+  post.dirty_attributes # => {:title => 'Bar', :meta=>{:tags=>["red", "green", "blue"]}}
+
+== Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2011 Jingwen Owen Ou. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+require 'rake'
+require 'rspec/core/rake_task'
+
+desc "Run specs"
+RSpec::Core::RakeTask.new
+
+desc 'Default: run specs'
+task :default => :spec

data/lib/virtus-dirty_attribute.rb

@@ -0,0 +1,3 @@
+require 'virtus/dirty_attribute/version'
+
+require_relative 'virtus/dirty_attribute'

data/lib/virtus/dirty_attribute.rb

@@ -0,0 +1,86 @@
+require 'virtus'
+require_relative 'dirty_attribute/session'
+
+module Virtus
+  # == Dirty Tracking
+  #
+  # Dirty Tracking is an optional module that you include only if you need it.
+  module DirtyAttribute
+    module ClassMethods
+      def attribute(name, type, options = {})
+        _create_writer_with_dirty_tracking(name)
+        super
+      end
+
+      private
+      def _create_writer_with_dirty_tracking(name)
+        class_eval <<-RUBY, __FILE__, __LINE__ + 1
+          def #{name}=(new_regular_object)
+            prev_object = #{name}
+            new_virtus_object = super
+
+            if attribute_dirty?(:#{name}) && original_attributes[:#{name}] == new_virtus_object
+              attribute_clean!(:#{name})
+            elsif prev_object != new_virtus_object
+              unless original_attributes.key?(:#{name})
+                original_attributes[:#{name}] = prev_object
+              end
+
+              attribute_dirty!(:#{name}, new_regular_object)
+            end
+
+            new_virtus_object
+          end
+        RUBY
+      end
+    end
+
+    module InitiallyClean
+      def initialize(*args)
+        super(*args)
+        clean!
+      end
+    end
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    def dirty?
+      dirty_session.dirty?
+    end
+
+    def clean?
+      !dirty?
+    end
+
+    def attribute_dirty?(name)
+      dirty_session.dirty?(name)
+    end
+
+    def clean!
+      dirty_session.clean!
+    end
+
+    def dirty_attributes
+      dirty_session.dirty_attributes
+    end
+
+    def original_attributes
+      dirty_session.original_attributes
+    end
+
+    private
+    def attribute_dirty!(name, value)
+      dirty_session.dirty!(name, value)
+    end
+
+    def attribute_clean!(name)
+      dirty_session.attribute_clean!(name)
+    end
+
+    def dirty_session
+      @_dirty_session ||= Session.new(self)
+    end
+  end
+end

data/lib/virtus/dirty_attribute/session.rb

@@ -0,0 +1,37 @@
+module Virtus
+  module DirtyAttribute
+    class Session
+      attr_reader :subject
+
+      def initialize(subject)
+        @subject = subject
+      end
+
+      def original_attributes
+        @_original_attributes ||= subject.attributes.dup
+      end
+
+      def dirty_attributes
+        @_dirty_attributes ||= {}
+      end
+
+      def dirty!(name, value)
+        dirty_attributes[name] = value
+      end
+
+      def attribute_clean!(name)
+        dirty_attributes.delete name
+        original_attributes.delete name
+      end
+
+      def dirty?(name = nil)
+        name ? dirty_attributes.key?(name) : dirty_attributes.any?
+      end
+
+      def clean!
+        original_attributes.clear
+        dirty_attributes.clear
+      end
+    end
+  end
+end

data/lib/virtus/dirty_attribute/version.rb

@@ -0,0 +1,5 @@
+module Virtus
+  module DirtyAttribute
+    VERSION = "0.1.0"
+  end
+end

data/spec/acceptance_spec.rb

@@ -0,0 +1,98 @@
+require 'spec_helper'
+
+describe "Dirty tracking" do
+  let(:attribute) { :title }
+  let(:initial_value) { 'Virtus' }
+  let(:other_value) { 'Virtus *dirty* '}
+
+  let(:model) do
+    model = Class.new do
+      include Virtus.model
+      include Virtus::DirtyAttribute
+      include Virtus::DirtyAttribute::InitiallyClean
+    end
+
+    model.attribute attribute, String
+
+    model
+  end
+
+  subject { model.new }
+
+  it { should be_clean }
+
+  it "should not be dirty after instantiating with attributes" do
+    object = model.new attribute => initial_value
+    object.should be_clean
+  end
+
+  context "when object is dirty" do
+    it "should become clean again" do
+      subject[attribute] = initial_value
+      subject.clean!
+
+      subject.should be_clean
+
+      subject.original_attributes.should be_empty
+      subject.dirty_attributes.should be_empty
+    end
+
+    it "should become clean when the attribute goes back to the initial value" do
+      subject[attribute] = initial_value
+      subject.clean!
+
+      subject[attribute] = other_value
+
+      subject.should be_dirty
+      subject.dirty_attributes.should include(attribute)
+
+      subject[attribute] = initial_value
+
+      subject.should be_clean
+      subject.dirty_attributes.should be_empty
+      subject.original_attributes.should be_empty
+    end
+  end
+
+  context "when value is set on a new object" do
+    before do
+      subject[attribute] = initial_value
+    end
+
+    it { should be_dirty }
+
+    it "marks the attribute as dirty" do
+      subject.attribute_dirty?(attribute).should be(true)
+    end
+
+    it "sets new value in dirty_attributes hash" do
+      subject.dirty_attributes[attribute].should == initial_value
+    end
+  end
+
+  context "when other value is set on a new object with attribute already set" do
+    let(:subject) { model.new attribute => initial_value }
+
+    before do
+      subject[attribute] = other_value
+    end
+
+    it "should have different values" do
+      initial_value.should_not == other_value
+    end
+
+    it { should be_dirty }
+
+    it "marks the attribute as dirty" do
+      subject.attribute_dirty?(attribute).should be_true
+    end
+
+    it "sets new value in dirty_attributes hash" do
+      subject.dirty_attributes[attribute].should == other_value
+    end
+
+    it "sets original value" do
+      subject.original_attributes[attribute].should == initial_value
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'bundler/setup'
+require 'virtus-dirty_attribute'

data/virtus-dirty.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'virtus/dirty_attribute/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "virtus-dirty_attribute"
+  spec.version       = Virtus::DirtyAttribute::VERSION
+  spec.authors       = ["Adam Hawkins"]
+  spec.email         = ["adam@hawkins.io"]
+  spec.description   = %q{Dirty Tracking for Virtus objects}
+  spec.summary       = %q{}
+  spec.homepage      = "https://github.com/ahawkins/virtus-dirty_attribute"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_dependency 'virtus', "~> 1.0.0"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: virtus-dirty_attribute
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Adam Hawkins
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: 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'
+description: Dirty Tracking for Virtus objects
+email:
+- adam@hawkins.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.rdoc
+- Rakefile
+- lib/virtus-dirty_attribute.rb
+- lib/virtus/dirty_attribute.rb
+- lib/virtus/dirty_attribute/session.rb
+- lib/virtus/dirty_attribute/version.rb
+- spec/acceptance_spec.rb
+- spec/spec_helper.rb
+- virtus-dirty.gemspec
+homepage: https://github.com/ahawkins/virtus-dirty_attribute
+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.0
+signing_key: 
+specification_version: 4
+summary: ''
+test_files:
+- spec/acceptance_spec.rb
+- spec/spec_helper.rb