memento 0.3.0

data/lib/memento/active_record_methods.rb

@@ -0,0 +1,74 @@
+module Memento::ActiveRecordMethods
+  
+  IGNORE_ATTRIBUTES = [:updated_at, :created_at]
+  
+  def self.included(base)
+    base.send :extend, ClassMethods
+  end
+  
+  module ClassMethods
+    
+    def memento_changes(*action_types)
+      include InstanceMethods
+      
+      self.memento_options = action_types.last.is_a?(Hash) ? action_types.pop : {}
+      
+      action_types = Memento::Action::Base.action_types if action_types.empty?
+      action_types.map!(&:to_s).uniq!
+      unless (invalid = action_types - Memento::Action::Base.action_types).empty?
+        raise ArgumentError.new("Invalid memento_changes: #{invalid.to_sentence}; allowed are only #{Memento::Action::Base.action_types.to_sentence}")
+      end
+      
+      action_types.each do |action_type|
+        callback_exists = send(:"after_#{action_type}_callback_chain").any? do |callback|
+          callback.method.to_sym == :"record_#{action_type}"
+        end
+        send :"after_#{action_type}", :"record_#{action_type}" unless callback_exists
+      end
+      
+      has_many :memento_states, :class_name => "Memento::State", :as => :record
+    end
+    
+    def memento_options
+      read_inheritable_attribute(:memento_options) || write_inheritable_attribute(:memento_options,{})
+    end
+    
+    def memento_options=(options)
+      options.symbolize_keys!
+      options[:ignore] = [options[:ignore]].flatten.map(&:to_sym) if options[:ignore]
+      write_inheritable_attribute(:memento_options, memento_options.merge(options))
+    end
+  end
+  
+  module InstanceMethods
+    
+    def attributes_for_memento
+      filter_attributes_for_memento(attributes)
+    end
+    
+    def changes_for_memento
+      filter_attributes_for_memento(changes)
+    end
+    
+    private
+    
+    def filter_attributes_for_memento(hash)
+      hash.delete_if do |key, value| 
+        ignore_attributes_for_memento.include?(key.to_sym)
+      end
+    end
+    
+    def ignore_attributes_for_memento
+      Memento::ActiveRecordMethods::IGNORE_ATTRIBUTES + (self.class.memento_options[:ignore] || [])
+    end
+    
+    Memento::Action::Base.action_types.each do |action_type|
+      define_method :"record_#{action_type}" do
+        Memento.instance.add_state(action_type, self)
+      end
+    end
+  end
+  
+end
+
+ActiveRecord::Base.send(:include, Memento::ActiveRecordMethods) if defined?(ActiveRecord::Base)

data/lib/memento/result.rb

@@ -0,0 +1,36 @@
+class Memento::ResultArray < Array
+  
+  def errors
+    self.find_all{ |result| result.failed? }
+  end
+  
+  def failed?
+    self.any?{ |result| result.failed? }
+  end
+  
+  def success?
+    !failed?
+  end
+  
+end
+
+class Memento::Result
+  
+  attr_reader :object, :state
+  
+  def initialize(object, state)
+    @object, @state = object, state
+  end
+  
+  def error
+    @object.errors[:memento_undo]
+  end
+  
+  def failed?
+    !!error
+  end
+  
+  def success?
+    !failed?
+  end
+end

data/lib/memento/session.rb

@@ -0,0 +1,29 @@
+class Memento::Session < ActiveRecord::Base
+  set_table_name "memento_sessions"
+  
+  has_many :states, :class_name => "Memento::State", :dependent => :delete_all
+  belongs_to :user
+  validates_presence_of :user
+  
+  def add_state(action_type, record)
+    states.store(action_type, record)
+  end
+  
+  def undo
+    states.map(&:undo).inject(Memento::ResultArray.new) do |results, result|
+      result.state.destroy if result.success?
+      results << result
+    end
+  ensure
+    destroy if states.count.zero?
+  end
+  
+  def undo!
+    transaction do
+      returning(undo) do |results|
+        raise Memento::ErrorOnRewind if results.failed?
+      end
+    end
+  end
+  
+end

data/lib/memento/state.rb

@@ -0,0 +1,47 @@
+class Memento::State < ActiveRecord::Base
+  set_table_name "memento_states"
+  
+  belongs_to :session, :class_name => "Memento::Session"
+  belongs_to :record, :polymorphic => true
+  
+  validates_presence_of :session
+  validates_presence_of :record
+  validates_presence_of :action_type
+  validates_inclusion_of :action_type, :in => Memento::Action::Base.action_types, :allow_blank => true
+  
+  before_create :set_record_data
+  
+  def self.store(action_type, record)
+    self.new(:action_type => action_type.to_s, :record => record) do |state|
+      state.save if state.fetch?
+    end
+  end
+  
+  def undo
+    Memento::Result.new(action.undo, self)
+  end
+  
+  def record_data
+    @record_data ||= Memento.serializer.load(read_attribute(:record_data))
+  end
+  
+  def record_data=(data)
+    @record_data = nil
+    write_attribute(:record_data, Memento.serializer.dump(data))
+  end
+  
+  def fetch?
+    action.fetch?
+  end
+  
+  private
+  
+  def set_record_data
+    self.record_data = action.fetch
+  end
+  
+  def action
+    "memento/action/#{action_type}".classify.constantize.new(self)
+  end
+  
+end

data/memento.gemspec

@@ -0,0 +1,79 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{memento}
+  s.version = "0.3.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Yolk Sebastian Munz & Julia Soergel GbR"]
+  s.date = %q{2010-01-26}
+  s.email = %q{sebastian@yo.lk}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc",
+     "TODO"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "TODO",
+     "VERSION.yml",
+     "generators/memento_migration/memento_migration_generator.rb",
+     "generators/memento_migration/templates/migration.rb",
+     "lib/memento.rb",
+     "lib/memento/action.rb",
+     "lib/memento/action/create.rb",
+     "lib/memento/action/destroy.rb",
+     "lib/memento/action/update.rb",
+     "lib/memento/action_controller_methods.rb",
+     "lib/memento/active_record_methods.rb",
+     "lib/memento/result.rb",
+     "lib/memento/session.rb",
+     "lib/memento/state.rb",
+     "memento.gemspec",
+     "rails/init.rb",
+     "spec/memento/action/create_spec.rb",
+     "spec/memento/action/destroy_spec.rb",
+     "spec/memento/action/update_spec.rb",
+     "spec/memento/action_controller_methods_spec.rb",
+     "spec/memento/active_record_methods_spec.rb",
+     "spec/memento/result_spec.rb",
+     "spec/memento/session_spec.rb",
+     "spec/memento/state_spec.rb",
+     "spec/memento_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/yolk/memento}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Undo for Rails/ActiveRecord - covers destroy, update and create}
+  s.test_files = [
+    "spec/memento/action/create_spec.rb",
+     "spec/memento/action/destroy_spec.rb",
+     "spec/memento/action/update_spec.rb",
+     "spec/memento/action_controller_methods_spec.rb",
+     "spec/memento/active_record_methods_spec.rb",
+     "spec/memento/result_spec.rb",
+     "spec/memento/session_spec.rb",
+     "spec/memento/state_spec.rb",
+     "spec/memento_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/rails/init.rb

@@ -0,0 +1 @@
+require 'memento'

data/spec/memento/action/create_spec.rb

@@ -0,0 +1,82 @@
+require File.join(File.dirname(__FILE__), '..', '..', 'spec_helper')
+
+describe Memento::Action::Create, "when object is created" do
+  before do
+    setup_db
+    setup_data
+    Memento.instance.start(@user)
+    @project = Project.create!(:name => "P1", :closed_at => 3.days.ago).reload
+    Memento.instance.stop
+  end
+  
+  after do
+    shutdown_db
+  end
+    
+  it "should create memento_state for ar-object with no data" do
+    Memento::State.count.should eql(1)
+    Memento::State.first.action_type.should eql("create")
+    Memento::State.first.record.should eql(@project) # it was destroyed, remember?
+    Memento::State.first.reload.record_data.should eql(nil)
+  end
+  
+  it "should create object" do
+    Project.find_by_id(@project.id).should_not be_nil
+    Project.count.should eql(1)
+  end
+  
+  it "should allow undoing the creation" do
+    Memento::Session.last.undo
+    Project.count.should eql(0)
+  end
+  
+  describe "when undoing the creation" do
+    it "should give back undone_object" do
+      Memento::Session.last.undo.map{|e| e.object.class }.should eql([Project])
+    end
+
+    it "should not undo the creatio if object was modified" do
+      Project.last.update_attribute(:created_at, 1.minute.ago)
+      undone = Memento::Session.last.undo
+      Project.count.should eql(1)
+      undone.first.should_not be_success
+      undone.first.error.should be_was_changed
+    end
+    
+    describe "when record was already destroyed" do
+      it "should give back fake unsaved record with id set" do
+        Project.last.destroy
+        @undone = Memento::Session.last.undo
+        @undone.size.should eql(1)
+        @undone.first.object.should be_kind_of(Project)
+        @undone.first.object.id.should eql(@project.id)
+        @undone.first.object.name.should be_nil
+        @undone.first.object.should be_new_record
+        Project.count.should eql(0)
+      end
+    end
+  end
+  
+  
+  
+end
+
+describe Memento::Action::Create, "when object without timestamp is created" do
+  before do
+    setup_db
+    setup_data
+    Memento.instance.memento(@user) do
+      @obj = TimestamplessObject.create!(:name => "O1").reload
+    end
+  end
+  
+  after do
+    shutdown_db
+  end
+  
+  describe "when undoing the creation" do
+    it "should give back undone_object" do
+      Memento::Session.last.undo.map{|e| e.object.class }.should eql([TimestamplessObject])
+    end
+  end
+end

data/spec/memento/action/destroy_spec.rb

@@ -0,0 +1,43 @@
+require File.join(File.dirname(__FILE__), '..', '..', 'spec_helper')
+
+describe Memento::Action::Destroy, "when object gets destroyed" do
+  before do
+    setup_db
+    setup_data
+    @project = Project.create!(:name => "P1", :closed_at => 3.days.ago).reload
+    Memento.instance.start(@user)
+    @project.destroy
+  end
+  
+  after do
+    Memento.instance.stop
+    shutdown_db
+  end
+    
+  it "should create memento_state for ar-object with full attributes_for_memento" do
+    Memento::State.count.should eql(1)
+    Memento::State.first.action_type.should eql("destroy")
+    Memento::State.first.record.should be_nil # it was destroyed, remember?
+    Memento::State.first.reload.record_data.should == @project.attributes_for_memento
+  end
+  
+  it "should destroy object" do
+    Project.find_by_id(@project.id).should be_nil
+    Project.count.should be_zero
+  end
+  
+  it "should allow undoing the destruction" do
+    Project.count.should be_zero
+    Memento::Session.last.undo
+    Project.count.should eql(1)
+    Project.first.attributes_for_memento.reject{|k, v| k.to_sym == :id }.should == (
+      @project.attributes_for_memento.reject{|k, v| k.to_sym == :id }
+    )
+  end
+  
+  it "should give back undone_object on undoing the destruction" do
+    Memento::Session.last.undo.map{|e| e.object.class }.should eql([Project])
+  end
+  
+  
+end

data/spec/memento/action/update_spec.rb

@@ -0,0 +1,213 @@
+require File.join(File.dirname(__FILE__), '..', '..', 'spec_helper')
+
+describe Memento::Action::Update do
+  before do
+    setup_db
+    setup_data
+    @time1 = 3.days.ago
+    @time2 = 2.days.ago
+    @project = Project.create!(:name => "P1", :closed_at => @time1, :notes => "Bla bla").reload
+    @customer = Customer.create!(:name => "C1")
+  end
+  
+  after do
+    shutdown_db
+  end
+  
+  describe "when object gets updated" do
+    
+    before do
+      Memento.instance.memento(@user) do
+        @project.update_attributes(:name => "P2", :closed_at => @time2, :customer => @customer, :notes => "Bla bla")
+      end
+    end
+    
+    it "should create memento_state for ar-object from changes_for_memento" do
+      Memento::State.count.should eql(1)
+      Memento::State.first.action_type.should eql("update")
+      Memento::State.first.record.should eql(@project)
+      Memento::State.first.record_data.keys.sort.should eql(%w(name closed_at customer_id).sort)
+      Memento::State.first.record_data["name"].should eql(["P1", "P2"])
+      Memento::State.first.record_data["customer_id"].should eql([nil, @customer.id])
+      Memento::State.first.record_data["closed_at"][0].utc.to_s.should eql(@time1.utc.to_s)
+      Memento::State.first.record_data["closed_at"][1].utc.to_s.should eql(@time2.utc.to_s)
+    end
+  
+    it "should update object" do
+      @project.reload.name.should eql("P2")
+      @project.customer.should eql(@customer)
+      @project.closed_at.to_s.should eql(@time2.to_s)
+      @project.should_not be_changed
+      Project.count.should eql(1)
+    end
+  
+    it "should allow undoing the update" do
+      undone = Memento::Session.last.undo.first
+      undone.should be_success
+      undone.object.should_not be_changed
+      undone.object.name.should eql("P1")
+      undone.object.customer.should be_nil
+      undone.object.closed_at.to_s.should eql(@time1.to_s)
+    end
+  
+    describe "when record was destroyed before undo" do
+      before do
+        @project.destroy
+      end
+    
+      it "should return fake object with error" do
+        undone = Memento::Session.last.undo.first
+        undone.should_not be_success
+        undone.error.should be_was_destroyed
+        undone.object.class.should eql(Project)
+        undone.object.id.should eql(1)
+      end
+    end
+  
+    describe "when record was changed before undo" do
+    
+      describe "with mergeable unrecorded changes" do
+        before do
+          @project.update_attributes({:notes => "Bla!"})
+          @result = Memento::Session.first.undo.first
+          @object = @result.object
+        end
+    
+        it "should be success" do
+          @result.should be_success
+        end
+    
+        it "should return correctly updated object" do
+          @object.class.should eql(Project)
+          @object.name.should eql("P1")
+          @object.customer.should be_nil
+          @object.closed_at.to_s.should eql(@time1.to_s)
+          @object.notes.should eql("Bla!")
+        end
+      end
+  
+      describe "with mergeable recorded changes" do
+        before do
+          Memento.instance.memento(@user) do
+            @project.update_attributes({:notes => "Bla!"})
+          end
+          Memento::State.last.update_attribute(:created_at, 1.minute.from_now)
+          @result = Memento::Session.first.undo.first
+          @object = @result.object
+        end
+    
+        it "should be success" do
+          @result.should be_success
+        end
+    
+        it "should return correctly updated object" do
+          @object.class.should eql(Project)
+          @object.name.should eql("P1")
+          @object.customer.should be_nil
+          @object.closed_at.to_s.should eql(@time1.to_s)
+          @object.notes.should eql("Bla!")
+        end
+    
+        describe "when second state is undone" do
+          before do
+            @result = Memento::Session.first.undo.first
+            @object = @result.object
+          end
+    
+          it "should be success" do
+            @result.should be_success
+          end
+
+          it "should return correctly updated object" do
+            @object.class.should eql(Project)
+            @object.name.should eql("P1")
+            @object.customer.should be_nil
+            @object.closed_at.to_s.should eql(@time1.to_s)
+            @object.notes.should eql("Bla bla")
+          end
+        end
+      end
+
+      describe "with unmergeable unrecorded changes" do
+        before do
+          @project.update_attributes({:name => "P3"})
+          @result = Memento::Session.last.undo.first
+          @object = @result.object
+        end
+
+        it "should fail" do
+          @result.should be_failed
+        end
+        
+        it "should set error" do
+          @result.error.should be_was_changed
+        end
+    
+        it "should return not undone object" do
+          @object.name.should eql("P3")
+          @object.customer.should eql(@customer)
+          @object.closed_at.to_s.should eql(@time2.to_s)
+          @object.should_not be_changed
+        end
+      end
+    
+      describe "with unmergeable recorded changes" do
+        before do
+          Memento.instance.memento(@user) do
+            @project.update_attributes!({:name => "P3"})
+          end
+          Memento::State.last.update_attribute(:created_at, 1.minute.from_now)
+          @result = Memento::Session.first.undo.first
+          @object = @result.object
+        end
+    
+        it "should fail" do
+          @result.should be_failed
+        end
+    
+        it "should return not undone object" do
+          @object.name.should eql("P3")
+          @object.customer.should eql(@customer)
+          @object.closed_at.to_s.should eql(@time2.to_s)
+          @object.should_not be_changed
+        end
+      
+        describe "when second state is undone" do
+          before do
+            @result = Memento::Session.last.undo.first
+            @object = @result.object
+          end
+        
+          it "should be success" do
+            @result.should be_success
+          end
+
+          it "should return correctly updated object" do
+            @object.class.should eql(Project)
+            @object.name.should eql("P2")
+            @object.customer.should eql(@customer)
+            @object.closed_at.to_s.should eql(@time2.to_s)
+            @object.notes.should eql("Bla bla")
+          end
+        end
+      end
+    end
+  
+  end
+  
+  describe "when object gets updated with no changes" do
+    
+    before do
+      Memento.instance.memento(@user) do
+        @project.update_attributes(:name => "P1", :customer => nil, :notes => "Bla bla")
+      end
+    end
+    
+    it "should not create session/state" do
+      Memento::Session.count.should eql(0)
+      Memento::State.count.should eql(0)
+    end
+    
+  end
+  
+end