rollbacker 1.0.0

data/spec/change_validator_spec.rb

@@ -0,0 +1,74 @@
+require File.dirname(__FILE__) + '/spec_helper'
+require 'rollbacker/config'
+
+describe Rollbacker::ChangeValidator do
+  describe ":destroy" do
+    let(:action) { :destroy }
+    it "should not be valid if the model is a new record" do
+      model     = Model.new
+      config    = Rollbacker::Config.new(action)
+      validator = Rollbacker::ChangeValidator.new(action, config.options, model)
+      model.should be_new_record
+      validator.changes.should == {}
+      validator.should_not be_valid
+    end
+    it "should be valid if the model is persisted" do
+      model     = Model.create
+      config    = Rollbacker::Config.new(action)
+      validator = Rollbacker::ChangeValidator.new(action, config.options, model)
+      model.should be_persisted
+      validator.changes.should == {}
+      validator.should be_valid
+    end
+  end
+
+  [:create, :update].each do |action|
+    describe ":#{ action }" do
+      it "should be invalid if model has no change" do
+        model     = Model.new
+        config    = Rollbacker::Config.new(action)
+        validator = Rollbacker::ChangeValidator.new(action, config.options, model)
+        validator.changes.should == {}
+        validator.should_not be_valid
+      end
+      it "should be valid if model changed" do
+        model     = Model.new(name: "Name")
+        config    = Rollbacker::Config.new(action)
+        validator = Rollbacker::ChangeValidator.new(action, config.options, model)
+        model.should be_changed
+        validator.changes.should == {'name' => [nil, 'Name']}
+        validator.should be_valid
+      end
+      it "should ignore fields from :except config" do
+        model     = Model.new(name: "Name", value: "Value")
+        config    = Rollbacker::Config.new(action, :except => :name)
+        validator = Rollbacker::ChangeValidator.new(action, config.options, model)
+        model.should be_changed
+        model.changes.keys.should be_include('name')
+        model.changes.keys.should be_include('value')
+        validator.changes.should == {'value' => [nil, 'Value']}
+      end
+      it "should select changes from :only config" do
+        model     = Model.new(name: "Name", value: "Value")
+        config    = Rollbacker::Config.new(action, :only => :value)
+        validator = Rollbacker::ChangeValidator.new(action, config.options, model)
+        model.should be_changed
+        model.changes.keys.should be_include('name')
+        model.changes.keys.should be_include('value')
+        validator.changes.should == {'value' => [nil, 'Value']}
+      end
+      it "should be able to merge changes from current rollbacker_change record" do
+        model     = Model.new(name: "Newer")
+        config    = Rollbacker::Config.new(action)
+        validator = Rollbacker::ChangeValidator.new(action, config.options, model)
+        model.should be_changed
+        model.changes.keys.should be_include('name')
+        model.changes.keys.should_not be_include('value')
+        validator.changes({
+          'value' => [nil, 'Old Value'],
+          'name'  => [nil, 'Old Name']
+        }).should == {'name' => [nil, 'Newer'], 'value'=> [nil, 'Old Value']}
+      end
+    end
+  end
+end

data/spec/config_spec.rb

@@ -0,0 +1,48 @@
+require File.dirname(__FILE__) + '/spec_helper'
+require 'rollbacker/config'
+
+describe Rollbacker::Config do
+
+  describe 'Configuration' do
+    it "should parse actions and options from a config array" do
+      config = Rollbacker::Config.new(:create, 'update', {:only => :username})
+      config.actions.should_not be_nil
+      config.options.should_not be_nil
+      config.actions.should have(2).items
+      config.actions.should =~ [:create, :update]
+      config.options.should == {:only => ["username"], :except => []}
+    end
+
+    it "should parse actions and options from a config array when options are absent" do
+      config = Rollbacker::Config.new(:create, 'update')
+      config.actions.should_not be_nil
+      config.actions.should have(2).items
+      config.actions.should =~ [:create, :update]
+      config.options.should == {:only => [], :except => []}
+    end
+
+    it "should parse actions" do
+      config = Rollbacker::Config.new(:create)
+      config.actions.should_not be_nil
+      config.actions.should have(1).item
+      config.actions.should =~ [:create]
+      config.options.should == {:only => [], :except => []}
+    end
+  end
+
+  describe 'Configuration Validation' do
+    it "should raise a Rollbacker::Error if no action is specified" do
+      lambda {
+        Rollbacker::Config.new
+      }.should raise_error(Rollbacker::Error)
+    end
+
+    it "should raise a Rollbacker::Error if an invalid action is specified" do
+      lambda {
+        Rollbacker::Config.new(:create, :view)
+      }.should raise_error(Rollbacker::Error)
+    end
+
+  end
+
+end

data/spec/database_rollback_spec.rb

@@ -0,0 +1,45 @@
+require File.dirname(__FILE__) + '/spec_helper'
+require 'rollbacker/user'
+require 'rollbacker/status'
+
+describe Rollbacker::DatabaseRollback do
+  include Rollbacker::Status
+
+  before(:each) do
+    Thread.current[:rollbacker_disabled] = nil
+    @user = Rollbacker::User.current_user = User.create
+  end
+
+  [:create, :update, :destroy].each do |action|
+    it "should respond with around_#{action}" do
+      model = Model.new(name: 'name')
+      config     = Rollbacker::Config.new(action)
+      callback = Rollbacker::DatabaseRollback.new(config.options)
+      callback.should respond_to("around_#{action}")
+    end
+  end
+
+  it "should rollback using without_rollbacker" do
+    model = Model.new
+    model.should_receive(:"_rollbacker_action=").with(:create).and_return(:create)
+    config = Rollbacker::Config.new('create')
+    callback = Rollbacker::DatabaseRollback.new(config.options)
+
+    lambda {
+      without_rollbacker do
+        callback.send :around_create, model
+      end
+    }.should_not raise_exception(ActiveRecord::Rollback)
+  end
+
+  it "should rollback as default with a object with changes" do
+    model = Model.new(name: 'name')
+    model.should_receive(:"_rollbacker_action=").with(:create).and_return(:create)
+    config = Rollbacker::Config.new('create')
+    callback = Rollbacker::DatabaseRollback.new(config.options)
+
+    lambda {
+      callback.send :around_create, model
+    }.should raise_exception(ActiveRecord::Rollback)
+  end
+end

data/spec/my_model_spec.rb

@@ -0,0 +1,36 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe MyModel do
+  let(:model) { MyModel.new(name: 'Name', value: 'Value') }
+
+  context "new record" do
+    it 'add create callback to history' do
+      lambda {
+        model.save
+      }.should_not change(MyModel, :count)
+      model.history.should == ['after_rollback_on_create']
+    end
+  end
+
+  context "persisted record" do
+    before(:each) do
+      model.skip_before_create = true
+      model.save
+    end
+    it 'add update callback to history' do
+      lambda {
+        model.update_attribute(:name, 'Newer')
+      }.should_not change(MyModel, :count)
+      model.history.should == ['after_rollback_on_update']
+    end
+    pending 'add destroy callback to history' do
+      lambda {
+        model.destroy
+      }.should_not change(MyModel, :count)
+      # Currently the result of this test is:
+      # model.history.should == ['after_rollback_on_update']
+      # See more details here: https://github.com/rails/rails/issues/7640
+      model.history.should == ['after_rollback_on_destroy']
+    end
+  end
+end

data/spec/recorder_spec.rb

@@ -0,0 +1,125 @@
+require File.dirname(__FILE__) + '/spec_helper'
+require 'rollbacker/user'
+
+describe Rollbacker::Recorder do
+
+  before(:each) do
+    @user = Rollbacker::User.current_user = User.create
+  end
+
+  [:create, :update].each do |action|
+    it "should NOT be created an rollbacker_change record for #{action} actions if no changes" do
+      model = Model.new
+      model.stub(:_rollbacker_action).and_return(action)
+      model.save if action.eql?(:update)
+
+      config = Rollbacker::Config.new(action)
+      # recorder = Rollbacker::Recorder.new(action, config.options)
+      recorder = Rollbacker::Recorder.new(config.options)
+
+      lambda {
+        recorder.send "after_rollback", model
+      }.should_not change(RollbackerChange, :count)
+    end
+  end
+
+  [:destroy, :update].each do |action|
+    it "should NOT be created change record for #{action} actions if model is a new record" do
+      model = Model.new
+      model.stub(:_rollbacker_action).and_return(action)
+
+      config = Rollbacker::Config.new(action)
+      # recorder = Rollbacker::Recorder.new(action, config.options)
+      recorder = Rollbacker::Recorder.new(config.options)
+
+      lambda {
+        recorder.send "after_rollback", model
+      }.should_not change(RollbackerChange, :count)
+    end
+  end
+
+  describe "on :create" do
+    let(:action) { :create }
+    it "should be create the change record after model rollback" do
+      model = Model.new(name: "Changed")
+      model.stub(:_rollbacker_action).and_return(action)
+      config = Rollbacker::Config.new(action)
+
+      # recorder = Rollbacker::Recorder.new(action, config.options)
+      recorder = Rollbacker::Recorder.new(config.options)
+      lambda {
+        recorder.send "after_rollback", model
+      }.should change(RollbackerChange, :count).by(1)
+
+      change_record = RollbackerChange.last
+      change_record.action.should           == action.to_s
+      change_record.rollbackable_id.should     == model.id
+      change_record.rollbackable_type.should   == model.class.to_s
+      change_record.user_id.should          == @user.id
+      change_record.user_type.should        == @user.class.to_s
+      change_record.rollbacked_changes.should  == {'name' => [nil, 'Changed'] }
+    end
+
+  end
+
+  describe "on :update" do
+    let(:action) { :update }
+    let(:model)  { Model.create(name: "Name") }
+    it "should create the change record" do
+      model.name  = 'Changed'
+      model.stub(:_rollbacker_action).and_return(action)
+      config      = Rollbacker::Config.new(action)
+      # recorder    = Rollbacker::Recorder.new(action, config.options)
+      recorder    = Rollbacker::Recorder.new(config.options)
+      lambda {
+        recorder.send "after_rollback", model
+      }.should change(RollbackerChange, :count).by(1)
+
+      change_record = RollbackerChange.last
+      change_record.action.should           == action.to_s
+      change_record.rollbackable_id.should  == model.id
+      change_record.rollbackable_type.should== model.class.to_s
+      change_record.user_id.should          == @user.id
+      change_record.user_type.should        == @user.class.to_s
+      change_record.rollbacked_changes.should  == {'name' => ['Name', 'Changed'] }
+    end
+
+    it "should only update rollbacked_changes field if the change record already exist" do
+      edit1 = RollbackerChange.create(rollbackable: model, user: @user, action: action, rollbacked_changes: {'name'=>[nil, 'Name']})
+      # Update
+      model.name  = 'Changed'
+      model.stub(:_rollbacker_action).and_return(action)
+      config      = Rollbacker::Config.new(action)
+      # recorder    = Rollbacker::Recorder.new(action, config.options)
+      recorder    = Rollbacker::Recorder.new(config.options)
+
+      lambda {
+        recorder.send "after_rollback", model
+      }.should_not change(RollbackerChange, :count)
+
+      edit2 = RollbackerChange.last
+      edit1.id.should == edit2.id
+      edit2.action.should             == action.to_s
+      edit2.rollbackable_id.should    == model.id
+      edit2.rollbackable_type.should  == model.class.to_s
+      edit2.user_id.should            == @user.id
+      edit2.user_type.should          == @user.class.to_s
+      edit2.rollbacked_changes.should == {'name' => ['Name', 'Changed'] }
+    end
+  end
+
+  it 'should pass the model, record, user, and action to any supplied block' do
+    model     = Model.create
+    model.stub(:_rollbacker_action).and_return(:create)
+    config    = Rollbacker::Config.new(:create)
+    # recorder  = Rollbacker::Recorder.new(:create, config.options) do |model, record, user, action|
+    recorder  = Rollbacker::Recorder.new(config.options) do |model, record, user, action|
+      model.should  == model
+      record.should be_is_a(RollbackerChange)
+      user.should   == @user
+      action.should == :create
+    end
+    recorder.after_rollback(model)
+  end
+
+end

data/spec/rollbacker_change_spec.rb

@@ -0,0 +1,19 @@
+require File.dirname(__FILE__) + '/spec_helper'
+require 'rollbacker/rollbacker_change'
+
+describe RollbackerChange do
+  before(:each) do
+    @rollbackable = Model.create
+    @user = User.create
+  end
+
+  it 'should provide access to the rollbacked model object' do
+    record = RollbackerChange.create(:rollbackable => @rollbackable, :user => @user, :action => :create)
+    record.rollbackable.should == @rollbackable
+  end
+  it 'should provide access to the user associated with the rollbacker_change' do
+    record = RollbackerChange.create(:rollbackable => @rollbackable, :user => @user, :action => :create)
+    record.user.should == @user
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require 'rspec'
+require 'rollbacker'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  config.include TransactionalSpecs
+  # RSpec uses it's own mocking framework by default. If you prefer to
+  # use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+end

data/spec/status_spec.rb

@@ -0,0 +1,44 @@
+require File.dirname(__FILE__) + '/spec_helper'
+require 'rollbacker/status'
+
+describe Rollbacker::Status do
+  it "should be enabled if set to enabled" do
+    obj = Class.new { include Rollbacker::Status }.new
+    obj.enable_rollbacker!
+    obj.should be_rollbacker_enabled
+    obj.should_not be_rollbacker_disabled
+  end
+
+  it "should be disabled if set to disabled" do
+    obj = Class.new { include Rollbacker::Status }.new
+    obj.disable_rollbacker!
+    obj.should_not be_rollbacker_enabled
+    obj.should be_rollbacker_disabled
+  end
+
+  it "should allow auditing as a specified user for a block of code" do
+    obj = Class.new { include Rollbacker::Status }.new
+    user1 = "user1"
+    user2 = "user2"
+    Rollbacker::User.current_user = user1
+
+    obj.rollbacker_as(user2) { Rollbacker::User.current_user.should == user2 }
+    Rollbacker::User.current_user.should == user1
+  end
+
+  it "should allow a block of code to be executed with rollbacker disabled" do
+    obj = Class.new { include Rollbacker::Status }.new
+    obj.enable_rollbacker!
+    obj.should be_rollbacker_enabled
+    obj.without_rollbacker { obj.should be_rollbacker_disabled }
+    obj.should be_rollbacker_enabled
+  end
+
+  it "should allow a block of code to be executed with rollbacker enabled" do
+    obj = Class.new { include Rollbacker::Status }.new
+    obj.disable_rollbacker!
+    obj.should be_rollbacker_disabled
+    obj.with_rollbacker { obj.should be_rollbacker_enabled }
+    obj.should be_rollbacker_disabled
+  end
+end

data/spec/support/db_setup.rb

@@ -0,0 +1,51 @@
+require 'active_support/core_ext'
+require 'active_record'
+require 'generators/rollbacker/migration/templates/migration'
+require 'fileutils'
+
+tmpdir = File.join(File.dirname(__FILE__), '..', '..', 'tmp')
+FileUtils.mkdir(tmpdir) unless File.exist?(tmpdir)
+test_db = File.join(tmpdir, 'test.db')
+
+connection_spec = {
+  :adapter => 'sqlite3',
+  :database => test_db
+}
+
+# Delete any existing instance of the test database
+FileUtils.rm test_db, :force => true
+
+# Create a new test database
+ActiveRecord::Base.establish_connection(connection_spec)
+
+# ActiveRecord::Base.connection.initialize_schema_migrations_table
+
+class CreateUser < ActiveRecord::Migration
+  def self.up
+    create_table :users, :force => true do |t|
+      t.column :username, :string
+    end
+  end
+
+  def self.down
+    drop_table :users
+  end
+end
+
+class CreateModel < ActiveRecord::Migration
+  def self.up
+    create_table :models, :force => true do |t|
+      t.column :name, :string
+      t.column :value, :string
+      t.column :user_id, :integer
+    end
+  end
+
+  def self.down
+    drop_table :models
+  end
+end
+
+CreateUser.up
+CreateModel.up
+CreateRollbackerChangesTable.up

data/spec/support/model_setup.rb

@@ -0,0 +1,29 @@
+class User < ActiveRecord::Base; end
+class Model < ActiveRecord::Base
+  belongs_to :user
+end
+
+class MyModel < ActiveRecord::Base
+  include ActiveRecord::Transactions::ClassMethods
+  self.table_name = 'models'
+
+  before_create  :raise_rollback!, :unless => :skip_before_create
+  before_destroy :raise_rollback!
+  before_update  :raise_rollback!
+  after_rollback(:on => :create){|record| record.send(:do_after_rollback, :create)}
+  after_rollback(:on => :update){|record| record.send(:do_after_rollback, :update)}
+  after_rollback(:on => :destroy){|record| record.send(:do_after_rollback, :destroy)}
+  attr_accessor :skip_before_create
+
+  def history
+    @history ||= []
+  end
+private
+  def raise_rollback!
+    raise ActiveRecord::Rollback
+  end
+
+  def do_after_rollback(on)
+    history << "after_rollback_on_#{on}"
+  end
+end

data/spec/support/transactional_specs.rb

@@ -0,0 +1,17 @@
+module TransactionalSpecs
+
+  def self.included(base)
+    base.class_eval do
+      around(:each) do |spec|
+        begin
+          spec.call
+        ensure
+          [User, Model, RollbackerChange].each do |clazz|
+            clazz.delete_all
+          end
+        end
+      end
+    end
+  end
+
+end

data/spec/user_spec.rb

@@ -0,0 +1,25 @@
+require File.dirname(__FILE__) + '/spec_helper'
+require 'rollbacker/user'
+
+describe Rollbacker::User do
+  it "should return the same user that's set on the same thread" do
+    user = "user"
+    Rollbacker::User.current_user = user
+    Rollbacker::User.current_user.should == user
+  end
+
+  it "should not return the same user from a different thread" do
+    user = "user"
+    user2 = "user2"
+
+    Rollbacker::User.current_user = user
+
+    Thread.new do
+      Rollbacker::User.current_user.should be_nil
+      Rollbacker::User.current_user = user2
+      Rollbacker::User.current_user.should == user2
+    end
+
+    Rollbacker::User.current_user.should == user
+  end
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: rollbacker
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Marcos G. Zimmermann
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3-ruby
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Rollbacker allows you to declaratively specify what CRUD operations should
+  be audited. The changes of objects are added to a queue where the auditor can approve
+  and reject those changes.
+email:
+- mgzmaster@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- init.rb
+- lib/generators/rollbacker.rb
+- lib/generators/rollbacker/migration/migration_generator.rb
+- lib/generators/rollbacker/migration/templates/migration.rb
+- lib/rollbacker.rb
+- lib/rollbacker/base.rb
+- lib/rollbacker/change_validator.rb
+- lib/rollbacker/config.rb
+- lib/rollbacker/database_rollback.rb
+- lib/rollbacker/recorder.rb
+- lib/rollbacker/rollbacker_change.rb
+- lib/rollbacker/spec_helpers.rb
+- lib/rollbacker/status.rb
+- lib/rollbacker/user.rb
+- lib/rollbacker/version.rb
+- rollbacker.gemspec
+- spec/base_spec.rb
+- spec/change_validator_spec.rb
+- spec/config_spec.rb
+- spec/database_rollback_spec.rb
+- spec/my_model_spec.rb
+- spec/recorder_spec.rb
+- spec/rollbacker_change_spec.rb
+- spec/spec_helper.rb
+- spec/status_spec.rb
+- spec/support/db_setup.rb
+- spec/support/model_setup.rb
+- spec/support/transactional_specs.rb
+- spec/user_spec.rb
+homepage: http://github.com/marcosgz/rollbacker
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Rollbacker is a manage tool for auditing changes to your ActiveRecord
+test_files:
+- spec/base_spec.rb
+- spec/change_validator_spec.rb
+- spec/config_spec.rb
+- spec/database_rollback_spec.rb
+- spec/my_model_spec.rb
+- spec/recorder_spec.rb
+- spec/rollbacker_change_spec.rb
+- spec/spec_helper.rb
+- spec/status_spec.rb
+- spec/support/db_setup.rb
+- spec/support/model_setup.rb
+- spec/support/transactional_specs.rb
+- spec/user_spec.rb