never_wastes 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1e0cc58ce583493943546b8be381efee31dd739f
-  data.tar.gz: 39ed990d9e2afe0b9736a310bc5f8081fe61e434
+  metadata.gz: c85ab18840099a907e37896a9fbdf155c84720fb
+  data.tar.gz: 9bfc863a688d3193001729ec8f7a3935cd27172f
 SHA512:
-  metadata.gz: f14b5a37fcb42b11bb6dc13a96a15fb2804f4c4b9010797e48c649bf5c7c7d6a41fbf439af7519e903aacf3675e541f728dbbe8c39204be86b8aed1080dd085e
-  data.tar.gz: e25fc6d3963feba0e963f96318dc8563e93af1ff4589bdcd91e586076c03c1e6ec015c8e785596e316ef85fae966afcc9cccf02e39d4ebdcd260036c96d20c1a
+  metadata.gz: 654a6ce77cf9a29bff70389bc8acc7f862a340cc575573cae72b4294513686d3af5f6a512a5d5fdf27e5447c7c304a229c67c70019624a3c4ca37275b5741c02
+  data.tar.gz: 738da964f16210ba589c578e99d5ffa0f06de65a5a68191fe548e589adb9c721687c82fd3844ffcdbd0cb67b6f4d72e8f328a6612daa62b8246be60d03600573

data/README.md

@@ -10,6 +10,8 @@ It's similar to acts_as_paranoid but simpler.
 
 ## Usage
 
+### Migrations
+
 First, add deleted column in your models.
 
     class AddDeletedToYourModels < ActiveRecord::Migration
@@ -29,12 +31,38 @@ If you need a timestamp, you can also add deleted_at column.
       end
     end
 
+If you need to have unique index for that table, waste_id will help.
+
+    class AddDeletedToYourModels < ActiveRecord::Migration
+      def change
+        add_column :your_models, :deleted, :boolean, :null => false, :default => false
+        add_column :your_models, :deleted_at, :datetime
+        add_column :your_models, :waste_id, :integer, :null => false, :default => 0
+      end
+    end
+
+The waste_id supposed to be 0 when it's not deleted.
+When the record is softly deleted, its primary key is copied to waste_id to be unique in all deleted records.
+This helps you add unique index for some typical column like 'name' as the following example;
+
+    class AddNameIndexToYourModels < ActiveRecord::Migration
+      def up
+        add_index :your_models, [:name, :waste_id], :unique => true
+      end
+
+      # down is needed
+    end
+
+### Declaration
+
 Next step is to specify never_wastes in your model which needs soft delete.
 
     class YourModel < ActiveRecord::Base
       never_wastes
     end
 
+### Use APIs
+
 Then you can use destroy for soft delete.
 
     model.destroy

data/lib/never_wastes.rb

@@ -23,14 +23,10 @@ module NeverWastes
   module SoftDestroy
     def self.included(base)
       base.class_eval do
-        class_attribute :never_wastes_boolean_column_name, :never_wastes_datetime_column_name
+        class_attribute :never_wastes_boolean_column_name, :never_wastes_datetime_column_name, :never_wastes_id_column_name
         self.never_wastes_boolean_column_name = :deleted
         self.never_wastes_datetime_column_name = :deleted_at
-        def self.soft_destroy_stamps
-          stamps = {never_wastes_boolean_column_name => true}
-          stamps[never_wastes_datetime_column_name] = self.current_time if column_names.include?(never_wastes_datetime_column_name.to_s)
-          stamps
-        end
+        self.never_wastes_id_column_name = :waste_id
 
         alias_method :destroy!, :destroy
 
@@ -38,7 +34,7 @@ module NeverWastes
           @destroying_softly = true
           ret = with_transaction_returning_status do
             run_callbacks :destroy do
-              stamps = self.class.soft_destroy_stamps
+              stamps = soft_destroy_stamps
               self.class.where(self.class.primary_key.to_sym => id).update_all(stamps)
               stamps.each {|key, value| send("#{key}=", value)}
               @destroyed = true
@@ -59,12 +55,28 @@ module NeverWastes
 
           alias_method :delete_all!, :delete_all
           def delete_all_softly
-            update_all(deleted: true, deleted_at: self.current_time)
+            updates = sanitize_sql_for_assignment(never_wastes_boolean_column_name => true)
+            if column_names.include?(never_wastes_datetime_column_name.to_s)
+              updates << ","
+              updates << sanitize_sql_for_assignment(never_wastes_datetime_column_name => current_time)
+            end
+            if column_names.include?(never_wastes_id_column_name.to_s)
+              updates << ","
+              updates << "#{never_wastes_id_column_name.to_s} = #{primary_key}"
+            end
+            update_all(updates)
           end
           alias_method :delete_all, :delete_all_softly
         end
 
         private
+        def soft_destroy_stamps
+          stamps = {self.class.never_wastes_boolean_column_name => true}
+          stamps[self.class.never_wastes_datetime_column_name] = self.class.current_time if self.class.column_names.include?(self.class.never_wastes_datetime_column_name.to_s)
+          stamps[self.class.never_wastes_id_column_name] = id if self.class.column_names.include?(self.class.never_wastes_id_column_name.to_s)
+          stamps
+        end
+
         # useful in callbacks
         def destroying_softly?
           @destroying_softly

data/lib/never_wastes/version.rb

@@ -1,3 +1,3 @@
 module NeverWastes
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

data/spec/fake_app.rb

@@ -8,7 +8,13 @@ ActiveRecord::Base.establish_connection('test')
 #migrations
 class CreateAllTables < ActiveRecord::Migration
   def self.up
-    create_table(:users) {|t| t.string :name; t.boolean :deleted; t.datetime :deleted_at }
+    create_table(:users) do |t|
+      t.string :name
+      t.boolean :deleted, :null => false, :default => false
+      t.datetime :deleted_at
+      t.integer :waste_id, :null => false, :default => 0
+    end
+    add_index :users, [:name, :waste_id], :unique => true
   end
 end
 

data/spec/never_wastes_spec.rb

@@ -19,6 +19,12 @@ describe User do
         subject { User.new(name: user.name) }
         it { should be_valid }
       end
+
+      context "when the same name user exists and is deleted, and the other is going to be deleted, when there is an unique index" do
+        before { user.destroy }
+        let(:other) { User.create!(name: user.name) }
+        it { expect { other.destroy }.not_to raise_error }
+      end
     end
   end
 
@@ -28,13 +34,15 @@ describe User do
 
     context 'when user is not deleted' do
       its(:deleted) { should be_false }
-      its(:deleted_at) { should be_nil}
+      its(:deleted_at) { should be_nil }
+      its(:waste_id) { should eq(0) }
     end
 
     context 'when user is deleted' do
       before { user.destroy }
       its(:deleted) { should be_true }
       its(:deleted_at) { should_not be_nil }
+      its(:waste_id) { should eq(user.id)}
     end
   end
 
@@ -92,12 +100,14 @@ describe User do
           subject { undelete_user.reload }
           its(:deleted) { should be_false }
           its(:deleted_at) { should be_nil}
+          its(:waste_id) { should eq(0) }
         end
 
         context 'when user is deleted' do
           subject { delete_users.first.reload }
           its(:deleted) { should be_true }
           its(:deleted_at) { should_not be_nil }
+          its(:waste_id) { should eq(delete_users.first.id) }
         end
       end
     end

data/spec/spec_helper.rb

@@ -6,6 +6,7 @@ $LOAD_PATH.unshift(File.dirname(__FILE__))
 # Merge keys is often used in mongoid.yml
 # See: http://redmine.ruby-lang.org/issues/show/4300
 if RUBY_VERSION >= '1.9.2'
+  require 'yaml'
   YAML::ENGINE.yamler = 'syck'
 end
 require 'active_record'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: never_wastes
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - nay3
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-24 00:00:00.000000000 Z
+date: 2013-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport