undestroyable 0.0.1 → 0.0.2

data/README.md

@@ -1,23 +1,88 @@
-# Strategies
+# General [![Build Status](https://secure.travis-ci.org/kot-begemot/undestroyable.png?branch=master)](http://travis-ci.org/kot-begemot/undestroyable)
 
-* none
-    Deletes record, as with usual destroy method.
-* column
-    Updates deleted_at column of the record. This is default strategy,
-    if undestroyable is activated for model.
-* table
-    Move table into separate column
-* database
-    Move table into separate database
+An aim for this gem is to provide an agile and comfortable way for Ruby developers to get rid of unnecessary data within their project databases.
+Weather I succeed with it or not is up to you. I will appreciate any advice or help.
+
+# System Configuration
+
+  In order to setup system configuration add somewhere in project following code
+
+    require 'undestroyable'
+
+    Undestroyable.config.setup do
+      orm :active_record
+    end
+
+  After that you may activate undestroyable for specific model
+
+    class Country < ActiveRecord::Base
+      undestroyable
+    end
+
+  Default strategy is: :column. You may overwrite system strategy by providing a block to `undestroyable`
+
+    class Country < ActiveRecord::Base
+      undestroyable do
+        strategy :dump
+      end
+    end
+
+  That will save objects dump into 'dump' table.
+  There is also a possibility for setting default system starategy:
+
+    Undestroyable.config.setup do
+      orm :active_record
+      strategy :table
+      table_suffix :old
+    end
+
+    class Country < ActiveRecord::Base
+      undestroyable
+    end
+
+  That will move deleted record from 'countries' table into 'countries_deleted'. In case 'countries_deleted' contains 'deleted_at' filed it will be updated.
+  If, due to some reason, a different table name is required it can also be provided:
+
+    Undestroyable.config.setup do
+      orm :active_record
+      strategy :table
+      table_suffix :old
+    end
+
+    class Country < ActiveRecord::Base
+      undestroyable do
+        table_name :scrap
+      end
+    end
+
+  In that case, the record will be moved from 'countries' table into 'scrap_deleted'.
 
 # Options:
 
+* orm (*ONLY FOR SYSTEM CONFIG*)
+    Specifies which orm is used by project
+* strategy
+    Specifies which strategy should be used
 * table_name
     Same as model table.
 * table_suffix
     Default prefix is: deleted
 * full_table_name
     table_prefix + table_name + table_suffix.
+* connection
+    Keeps connection information. _NB!_ Compulsary for :database startegy.
+
+# Strategies
+
+* none
+    Deletes record, as with usual destroy method.
+* column
+    Updates deleted_at column of the record. This is default strategy,
+    if undestroyable is activated for model.
+* table
+    Move record into separate table
+* database
+    Move record into separate table in remote database
 
 # Simple usage example:
 
@@ -27,11 +92,11 @@
 
 # Complicated usage example:
 
-    class ConceptCat < ActiveRecord::Base
+    class ConceptCat < Vehicle
       undstroyable do
         startegy :database
         connection { adapter: "sqlite3", dbfile: ":memory:"}
         table_name :scrap
         table_suffix :metalic
       end
-    end
+    end

data/lib/undestroyable/version.rb

@@ -1,3 +1,3 @@
 module Undestroyable
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: undestroyable
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-02 00:00:00.000000000Z
+date: 2012-05-03 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &78020570 !ruby/object:Gem::Requirement
+  requirement: &80073320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 3.0.0
   type: :development
   prerelease: false
-  version_requirements: *78020570
+  version_requirements: *80073320
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &78020340 !ruby/object:Gem::Requirement
+  requirement: &80073080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 3.0.0
   type: :development
   prerelease: false
-  version_requirements: *78020340
+  version_requirements: *80073080
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &78020140 !ruby/object:Gem::Requirement
+  requirement: &80072870 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *78020140
+  version_requirements: *80072870
 - !ruby/object:Gem::Dependency
   name: database_cleaner
-  requirement: &78019870 !ruby/object:Gem::Requirement
+  requirement: &80072600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,18 +54,7 @@ dependencies:
         version: 0.7.2
   type: :development
   prerelease: false
-  version_requirements: *78019870
-- !ruby/object:Gem::Dependency
-  name: ruby-debug19
-  requirement: &78019660 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *78019660
+  version_requirements: *80072600
 description: An aim or this gem is to provide an agile and comfortable way for Ruby
   developers to get rid of unnecessary data within their project databases.
 email: