never_wastes 0.0.1 → 0.0.2

data/README.md

@@ -0,0 +1,53 @@
+# Never Wastes
+
+Never Wastes adds soft delete to ActiveRecord.
+
+It's similar to acts_as_paranoid but simpler. 
+
+## Usage
+
+First, add deleted column in your models.
+
+    class AddDeletedToYourModels < ActiveRecord::Migration
+      def change
+        add_column :your_models, :deleted, :boolean, :null => false, :default => false
+      end
+    end
+
+Currently it supports boolean "deleted" column only. 
+
+Next step is to specify never_wastes in your model which needs soft delete.
+
+    class YourModel << ActiveRecord::Base
+      never_wastes
+    end
+
+Then you can use destroy for soft delete.
+
+    model.destroy
+
+If you want to hart delete, use destroy!.
+
+    model.destroy!
+
+You can get non-deleted models by default.
+
+    models = YourModel.all # deleted models are not included
+
+If you need to get models with deleted ones, you can use with_deleted.
+
+    models = YourModel.with_deleted.all
+
+In your destroy callbacks, you can use softly_destroying? to check if you are in soft delete or hard delete.
+
+   after_destroy :delete_files
+   private
+   def delete_files
+     return if sortly_destroying?
+     # delete files associated with the model object
+   end
+
+Use never_wastes? to check if a model supports soft delete or not.
+
+    YourModel.never_wastes?
+

data/lib/never_wastes/version.rb

@@ -1,3 +1,3 @@
 module NeverWastes
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: never_wastes
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -21,6 +21,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
+- README.md
 - Rakefile
 - lib/never_wastes.rb
 - lib/never_wastes/version.rb