millstone 0.0.2

data/spec/models/associations/has_many_through_without_deleted_association_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+
+class Master < ActiveRecord::Base
+end
+
+class HavingWithDeleted < ActiveRecord::Base
+  set_table_name 'havings'
+
+  acts_as_paranoid
+  belongs_to :parent, :class_name => 'ParentHasMaster', :foreign_key => 'parent_id'
+  belongs_to :master
+end
+
+class HavingWithoutDeleted < ActiveRecord::Base
+  set_table_name 'havings'
+
+  acts_as_paranoid
+  belongs_to :parent, :class_name => 'ParentHasMaster', :foreign_key => 'parent_id'
+  belongs_to :master
+end
+
+class ParentHasMaster < ActiveRecord::Base
+  set_table_name 'time_columns'
+
+  has_many :havings_with_deleted, :class_name => 'HavingWithDeleted', :foreign_key => 'parent_id'
+  has_many :havings_without_deleted, :class_name => 'HavingWithoutDeleted', :foreign_key => 'parent_id'
+
+  has_many :masters_with_deleted, :class_name => 'Master', :through => :havings_with_deleted, :source => :master, :with_deleted => true
+  has_many :masters_without_deleted, :class_name => 'Master', :through => :havings_without_deleted, :source => :master
+end
+
+describe Millstone::ActiveRecord::Associations::HasManyThroughWithoutDeletedAssociation do
+  describe ActiveRecord::Base do
+    let(:parent) { ParentHasMaster.create!(:context => "parent") }
+    let(:master1) { Master.create!(:context => "master1") }
+    let(:master2) { Master.create!(:context => "master2") }
+
+    describe ".has_many", ":with_deleted => false (default)" do
+      before do
+        parent.masters_without_deleted << master1
+        parent.masters_without_deleted << master2
+        parent.masters_without_deleted.delete(master2)
+        parent.reload
+      end
+
+      specify { parent.masters_without_deleted.should include master1 }
+      specify { parent.masters_without_deleted.should_not include master2 }
+    end
+
+    describe ".has_many", ":with_deleted => true" do
+      before do
+        parent.masters_with_deleted << master1
+        parent.masters_with_deleted << master2
+        parent.masters_with_deleted.delete(master2)
+        parent.reload
+      end
+
+      specify { parent.masters_with_deleted.should include master1 }
+      specify { parent.masters_with_deleted.should include master2 }
+    end
+  end
+end

data/spec/models/extension_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+class MillstoneTimeModel < ActiveRecord::Base
+  set_table_name 'time_columns'
+  millstone
+end
+
+class MillstoneBooleanModel < ActiveRecord::Base
+  set_table_name 'boolean_columns'
+  millstone :column => :deleted, :type => :boolean
+end
+
+describe Millstone::ActiveRecord::Extension do
+  describe ActiveRecord::Base do
+    let(:record) { klass.create!(:context => "name") }
+    let(:deleted_record) { klass.with_deleted.first }
+
+    shared_examples "execute destroy and destroy!" do
+      describe "#destroy" do
+        before { record.destroy }
+
+        specify { deleted_record.should eq record }
+        specify { deleted_record.should be_deleted }
+      end
+
+      describe "#destroy!" do
+        before { record.destroy! }
+        specify { deleted_record.should be_nil }
+      end
+    end
+
+    context "as millstone :type => :boolean" do
+      let(:klass) { MillstoneBooleanModel }
+
+      it_behaves_like "execute destroy and destroy!"
+
+      describe "#destroy" do
+        before { record.destroy }
+        specify { deleted_record.deleted.should be_true }
+      end
+    end
+
+    context "as millstone :type => :time" do
+      before { Delorean.time_travel_to 1.hour.ago }
+      after { Delorean.back_to_the_present }
+
+      let(:klass) { MillstoneTimeModel }
+
+      describe "#destroy" do
+        before { record.destroy }
+        specify { deleted_record.deleted_at.to_s.should == Time.now.to_s }
+      end
+    end
+  end
+end

data/spec/models/relation_methods_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+class MillstoneTimeColumn < ActiveRecord::Base
+  set_table_name 'time_columns'
+  millstone
+end
+
+class MillstoneBooleanColumn < ActiveRecord::Base
+  set_table_name 'boolean_columns'
+  millstone :column => :deleted, :type => :boolean
+end
+
+describe Millstone::ActiveRecord::RelationMethods do
+  let (:alive_record) { klass.create!(:context => "alive") }
+  let (:hidden_record) { klass.create!(:context => "hidden", klass.millstone_column => klass.millstone_generate_column_value) }
+
+  describe MillstoneTimeColumn do
+    let(:klass) { MillstoneTimeColumn }
+
+    it_should_behave_like "hide soft deletion marked record"
+    it_should_behave_like "execute soft deletion" do
+      it "should set time to paranoid value" do
+        klass.delete(alive_record)
+        klass.with_deleted.find(alive_record).deleted_at.should be_a Time
+      end
+    end
+    it_should_behave_like "execute hard deletion"
+    it_should_behave_like "check soft deletion"
+  end
+
+  describe MillstoneBooleanColumn do
+    let(:klass) { MillstoneBooleanColumn }
+
+    it_should_behave_like "hide soft deletion marked record"
+    it_should_behave_like "execute soft deletion" do
+      it "should set true to paranoid value" do
+        klass.delete(alive_record)
+        klass.with_deleted.find(alive_record).deleted.should be_true
+      end
+    end
+    it_should_behave_like "execute hard deletion"
+    it_should_behave_like "check soft deletion"
+  end
+end

data/spec/models/validations/uniqueness_with_deleted_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+class UniquenessWithDeleted < ActiveRecord::Base
+  set_table_name 'time_columns'
+
+  millstone
+  validates_uniqueness_of_with_deleted :context
+end
+
+class UniquenessWithoutDeleted < ActiveRecord::Base
+  set_table_name 'time_columns'
+
+  millstone
+  validates_uniqueness_of :context
+end
+
+describe Millstone::ActiveRecord::Validations::UniquenessWithDeletedValidator do
+  describe ActiveRecord::Base do
+    describe ".validates_uniqueness_of" do
+      let(:alive_record) { UniquenessWithoutDeleted.create(:context => "unique1") }
+      let(:hidden_record) do
+        hidden_record = UniquenessWithoutDeleted.create(:context => "unique2")
+        hidden_record.destroy
+        hidden_record
+      end
+
+      specify { UniquenessWithoutDeleted.new(:context => alive_record.context).should_not be_valid }
+      specify { UniquenessWithoutDeleted.new(:context => hidden_record.context).should be_valid }
+    end
+
+    describe ".validates_uniqueness_of_with_deleted" do
+      let(:alive_record) { UniquenessWithDeleted.create(:context => "unique1") }
+      let(:hidden_record) do
+        hidden_record = UniquenessWithDeleted.create(:context => "unique2")
+        hidden_record.destroy
+        hidden_record
+      end
+
+      specify { UniquenessWithDeleted.new(:context => alive_record.context).should_not be_valid }
+      specify { UniquenessWithDeleted.new(:context => hidden_record.context).should_not be_valid }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$:.unshift(File.dirname(__FILE__))
+
+require 'rails'
+require 'active_record'
+require 'action_controller'
+require 'action_view'
+require 'delorean'
+require 'millstone'
+
+require 'rspec/rails'
+
+# 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 Delorean
+  config.mock_with :rspec
+  config.fixture_path = File.join(File.dirname(__FILE__), 'fixtures')
+  config.use_transactional_fixtures = true
+end
+
+CreateTestTables.up
+

data/spec/support/examples/check_soft_deletion.rb

@@ -0,0 +1,6 @@
+shared_examples "check soft deletion" do
+  describe "#deleted?" do
+    specify { alive_record.should_not be_deleted }
+    specify { hidden_record.should be_deleted }
+  end
+end

data/spec/support/examples/execute_hard_deletion.rb

@@ -0,0 +1,43 @@
+shared_examples "delete alive and hidden record" do
+  specify "alive record should be deleted from table" do
+    expect { klass.with_deleted.find(alive_record) }.to raise_error(ActiveRecord::RecordNotFound)
+  end
+
+  specify "hidden record should be deleted from table" do
+    expect { klass.with_deleted.find(hidden_record) }.to raise_error(ActiveRecord::RecordNotFound)
+  end
+end
+
+shared_examples "execute hard deletion" do
+  describe ".delete!" do
+    it_behaves_like "delete alive and hidden record" do
+      before do
+        klass.delete!([alive_record, hidden_record])
+      end
+    end
+  end
+
+  describe ".delete_all!" do
+    it_behaves_like "delete alive and hidden record" do
+      before do
+        klass.delete_all!(["id IN (?)", [alive_record, hidden_record]])
+      end
+    end
+  end
+
+  describe ".destroy!" do
+    it_behaves_like "delete alive and hidden record" do
+      before do
+        klass.destroy!([alive_record, hidden_record])
+      end
+    end
+  end
+
+  describe ".destroy_all!" do
+    it_behaves_like "delete alive and hidden record" do
+      before do
+        klass.destroy_all!(["id IN (?)", [alive_record, hidden_record]])
+      end
+    end
+  end
+end

data/spec/support/examples/execute_soft_deletion.rb

@@ -0,0 +1,57 @@
+shared_examples "execute soft deletion" do
+  describe ".delete_all" do
+    it "should mark deletion to alive record" do
+      expect do
+        klass.delete_all(:id => alive_record)
+      end.should change { klass.with_deleted.find(alive_record).millstone_column_value }
+    end
+
+    it "should not mark deletion to hidden record" do
+      expect do
+        klass.delete_all(:id => hidden_record)
+      end.should_not change { klass.with_deleted.find(hidden_record).millstone_column_value }
+    end
+  end
+
+  describe ".delete" do
+    it "should mark deletion to alive record" do
+      expect do
+        klass.delete(alive_record)
+      end.should change { klass.with_deleted.find(alive_record).millstone_column_value }
+    end
+
+    it "should not mark deletion to hidden record" do
+      expect do
+        klass.delete(hidden_record)
+      end.should_not change { klass.with_deleted.find(hidden_record).millstone_column_value }
+    end
+  end
+
+  describe ".destroy_all" do
+    it "should mark deletion to alive record" do
+      expect do
+        klass.destroy_all(:id => alive_record)
+      end.should change { klass.with_deleted.find(alive_record).millstone_column_value }
+    end
+
+    it "should not mark deletion to hidden record" do
+      expect do
+        klass.destroy_all(:id => hidden_record)
+      end.should_not change { klass.with_deleted.find(hidden_record).millstone_column_value }
+    end
+  end
+
+  describe ".destroy" do
+    it "should mark deletion to alive record" do
+      expect do
+        klass.destroy(alive_record)
+      end.should change { klass.with_deleted.find(alive_record).millstone_column_value }
+    end
+
+    it "should not mark deletion to hidden record" do
+      expect do
+        klass.destroy(hidden_record)
+      end.should raise_error(ActiveRecord::RecordNotFound)
+    end
+  end
+end

data/spec/support/examples/hide_soft_deletion_marked_record.rb

@@ -0,0 +1,98 @@
+shared_examples "hide soft deletion marked record" do
+  before do 
+    klass.delete_all
+    3.times { klass.create!(:context => "alive") }
+    2.times { klass.create!(:context => "hidden", klass.millstone_column => klass.millstone_generate_column_value) }
+  end
+
+  describe ".all" do
+    subject { klass.all }
+    it { should_not include hidden_record }
+    it { should include alive_record }
+  end
+
+  describe ".find" do
+    specify { klass.find(alive_record).should_not be_nil }
+
+    specify do
+      expect { klass.find(hidden_record) }.to raise_error(ActiveRecord::RecordNotFound)
+    end
+
+    context "options :with_deleted" do
+      specify { klass.find(hidden_record, :with_deleted => true).should_not be_nil }
+      specify { klass.find(alive_record, :with_deleted => true).should_not be_nil }
+    end
+
+    context "options :only_deleted" do
+      specify { klass.find(hidden_record, :only_deleted => true).should_not be_nil }
+
+      specify do
+        expect { klass.find(alive_record, :only_deleted => true) }.to raise_error(ActiveRecord::RecordNotFound)
+      end
+    end
+  end
+
+  describe ".count" do
+    subject { klass.count }
+    it "should return record count without hidden record" do
+      should == 3
+    end
+  end
+
+  describe ".with_deleted" do
+    describe ".all" do
+      subject { klass.with_deleted.all }
+      it { should include hidden_record }
+      it { should include alive_record }
+    end
+
+    describe ".find" do
+      context "when specify hidden record" do
+        subject { klass.only_deleted.find(hidden_record) }
+        it { should eq hidden_record }
+      end
+
+      context "when specify alive record" do
+        subject { klass.find(alive_record) }
+        it { should eq alive_record }
+      end
+    end
+
+    describe ".count" do
+      subject { klass.with_deleted.count }
+      it "should return all record count" do
+        should == 5
+      end
+    end
+  end
+
+  describe ".only_deleted" do
+    describe ".all" do
+      subject { klass.only_deleted.all }
+      it { should include hidden_record }
+      it { should_not include alive_record }
+    end
+
+    describe ".find" do
+      context "when specify hidden record" do
+        subject { klass.only_deleted.find(hidden_record) }
+        it { should eq hidden_record }
+      end
+
+      context "when specify alive record" do
+        it "should raise error ActiveRecord::RecordNotFound" do
+          expect do
+            klass.only_deleted.find(alive_record)
+          end.to raise_error(ActiveRecord::RecordNotFound)
+        end
+      end
+    end
+
+    describe ".count" do
+      subject { klass.only_deleted.count }
+      it "should return only hidden record count" do
+        should == 2
+      end
+    end
+  end
+end

data/spec/support/migration.rb

@@ -0,0 +1,49 @@
+require 'active_record'
+
+# database connection
+ActiveRecord::Base.configurations = {'test' => {:adapter => 'sqlite3', :database => ':memory:'}}
+ActiveRecord::Base.establish_connection('test')
+
+class CreateTestTables < ActiveRecord::Migration
+  def self.up
+    create_table :time_columns, :force => true do |t|
+      t.string :context
+      t.datetime :deleted_at
+      t.timestamps
+    end
+
+    create_table :boolean_columns, :force => true do |t|
+      t.string :context
+      t.boolean :deleted
+      t.timestamps
+    end
+
+    create_table :children, :force => true do |t|
+      t.integer :parent_id
+      t.string :context
+      t.datetime :deleted_at
+      t.timestamps
+    end
+
+    create_table :polymorphic_children, :force => true do |t|
+      t.string :polymorphous_type
+      t.integer :polymorphous_id
+      t.string :context
+      t.datetime :deleted_at
+      t.timestamps
+    end
+
+    create_table :masters, :force => true do |t|
+      t.string :context
+      t.timestamps
+    end
+
+    create_table :havings, :force => true do |t|
+      t.integer :parent_id
+      t.integer :master_id
+      t.datetime :deleted_at
+      t.timestamps
+    end
+
+  end
+end

metadata

@@ -0,0 +1,196 @@
+--- !ruby/object:Gem::Specification 
+name: millstone
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Yoshikazu Ozawa
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-09 00:00:00 +09:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 3
+        - 0
+        - 6
+        version: 3.0.6
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 0
+        - 0
+        version: 2.0.0
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rspec-rails
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 0
+        - 0
+        version: 2.0.0
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: delorean
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id006
+description: ActiveRecord plugin which allows you to hide without actually deleting them for Rails3. Millstone is extending ActiveRecord::Relation
+email: 
+- yoshikazu.ozawa@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/millstone.rb
+- lib/millstone/active_record/associations.rb
+- lib/millstone/active_record/associations/belongs_to_association.rb
+- lib/millstone/active_record/associations/belongs_to_polymorphic_association.rb
+- lib/millstone/active_record/associations/has_many_through_without_deleted_association.rb
+- lib/millstone/active_record/extension.rb
+- lib/millstone/active_record/relation_methods.rb
+- lib/millstone/active_record/validations/uniqueness_with_deleted.rb
+- millstone.gemspec
+- spec/models/associations/belongs_to_association_spec.rb
+- spec/models/associations/belongs_to_polymorphic_association_spec.rb
+- spec/models/associations/has_many_through_without_deleted_association_spec.rb
+- spec/models/extension_spec.rb
+- spec/models/relation_methods_spec.rb
+- spec/models/validations/uniqueness_with_deleted_spec.rb
+- spec/spec_helper.rb
+- spec/support/examples/check_soft_deletion.rb
+- spec/support/examples/execute_hard_deletion.rb
+- spec/support/examples/execute_soft_deletion.rb
+- spec/support/examples/hide_soft_deletion_marked_record.rb
+- spec/support/migration.rb
+has_rdoc: true
+homepage: https://github.com/relax4u/millstone
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: ActiveRecord plugin which allows you to hide without actually deleting them for Rails3.
+test_files: 
+- spec/models/associations/belongs_to_association_spec.rb
+- spec/models/associations/belongs_to_polymorphic_association_spec.rb
+- spec/models/associations/has_many_through_without_deleted_association_spec.rb
+- spec/models/extension_spec.rb
+- spec/models/relation_methods_spec.rb
+- spec/models/validations/uniqueness_with_deleted_spec.rb
+- spec/spec_helper.rb
+- spec/support/examples/check_soft_deletion.rb
+- spec/support/examples/execute_hard_deletion.rb
+- spec/support/examples/execute_soft_deletion.rb
+- spec/support/examples/hide_soft_deletion_marked_record.rb
+- spec/support/migration.rb