soft_destroyable 0.1.0 → 0.1.1

data/Gemfile

@@ -0,0 +1 @@
+gemspec

data/README.textile

@@ -0,0 +1,77 @@
+h2. SoftDestroyable
+
+Allows one to annotate an ActiveRecord module as being soft_destroyable.
+
+h3. Why another soft_destroy implementation?
+
+This gem was inspired by "acts_as_paranoid":http://github.com/technoweenie/acts_as_paranoid and
+"rails3_acts_as_paranoid":https://github.com/goncalossilva/rails3_acts_as_paranoid, both of which are great gems.
+I found that rails3_acts_as_paranoid did not handle associations the way I wanted (at least at the time I wrote this),
+so I wrote this implementation instead.   
+
+h3. Details
+
+This changes the behavior of the +destroy+ method to become a soft-destroy, which
+will set the +deleted_at+ attribute to <tt>Time.now</tt>, and the +deleted+ attribute to <tt>true</tt>
+It exposes the +revive+ method to reverse the effects of +destroy+.
+It also exposes the +destroy!+ method which can be used to <b>really</b> destroy an object and it's associations.
+
+Standard ActiveRecord destroy callbacks are _not_ called, however you can override +before_soft_destroy+, +after_soft_destroy+,
+and +before_destroy!+ on your soft_destroyable models.
+
+Standard ActiveRecord dependent options :destroy, :restrict, :nullify, :delete_all, and :delete are supported and will
+behave as expected.  +revive+ will _not_ undo the effects of +nullify+, +delete_all+, and +delete+.
++restrict+ is _not_ effected by the +deleted?+ state.  In other words, deleted child models will still restrict
+destroying the parent.
+
+The +delete+ operation is _not_ modified by this module.
+
+The operations: +destroy+, +destroy!+, and +revive+ are automatically delegated to the dependent association records.
+in a single transaction.
+
+Scopes are provided for +deleted+ and +not_deleted+.   The standard +all+ scope is not polluted, so will still
+return all records, deleted or not.
+
+Examples:
+
+Author: Michael Kintzer
+
+h3. Examples
+
+* Migrate your model to add +deleted+ and +deleted_at+ attributes.   There are helpers provided for this:
+
+create_table :mytable do |t|
+ t.soft_destroyable
+end
+
+change_table :mytable do |t|
+ t.soft_destroyable
+end
+
+* Annotate your model to be soft_destroyable
+
+  class Parent
+    has_many :children, :dependent => :restrict
+    has_many :animals, :dependent => :nullify
+    soft_destroyable
+
+* That's it!
+
+h3. Testing
+
+* make sure you have rails and sqlite gems installed.
+* rake test
+
+h3. Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+h3. Copyright
+
+Copyright (c) 2010-11 Michael Kintzer, released under the MIT license

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/soft_destroyable.gemspec

@@ -0,0 +1,106 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{soft_destroyable}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Michael Kintzer"]
+  s.date = %q{2011-03-05}
+  s.description = %q{Rails 3 ActiveRecord compatible soft destroy implementation supporting dependent associations}
+  s.email = %q{rockrep@yahoo.com}
+  s.extra_rdoc_files = [
+    "README.textile"
+  ]
+  s.files = [
+    "Gemfile",
+    "MIT-LICENSE",
+    "README.textile",
+    "Rakefile",
+    "VERSION",
+    "init.rb",
+    "install.rb",
+    "lib/soft_destroyable.rb",
+    "lib/soft_destroyable/is_soft_destroyable.rb",
+    "lib/soft_destroyable/table_definition.rb",
+    "soft_destroyable.gemspec",
+    "spec/support/soft_destroy_spec_helper.rb",
+    "test/basic_test.rb",
+    "test/callback_test.rb",
+    "test/class_method_test.rb",
+    "test/dependent_delete_all_test.rb",
+    "test/dependent_delete_test.rb",
+    "test/dependent_destroy_test.rb",
+    "test/dependent_nullify_test.rb",
+    "test/dependent_restrict_test.rb",
+    "test/non_dependent_test.rb",
+    "test/test_helper.rb",
+    "test/through_associations_test.rb",
+    "uninstall.rb"
+  ]
+  s.homepage = %q{http://github.com/rockrep/soft_destroyable}
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Rails 3 ActiveRecord compatible soft destroy implementation}
+  s.test_files = [
+    "spec/support/soft_destroy_spec_helper.rb",
+    "test/basic_test.rb",
+    "test/callback_test.rb",
+    "test/class_method_test.rb",
+    "test/dependent_delete_all_test.rb",
+    "test/dependent_delete_test.rb",
+    "test/dependent_destroy_test.rb",
+    "test/dependent_nullify_test.rb",
+    "test/dependent_restrict_test.rb",
+    "test/non_dependent_test.rb",
+    "test/test_helper.rb",
+    "test/through_associations_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<soft_destroyable>, [">= 0"])
+      s.add_development_dependency(%q<rails>, [">= 3.0"])
+      s.add_development_dependency(%q<sqlite3>, [">= 1.3.3"])
+      s.add_development_dependency(%q<rails>, [">= 3.0"])
+      s.add_development_dependency(%q<sqlite3>, [">= 1.3.3"])
+      s.add_development_dependency(%q<rails>, [">= 3.0"])
+      s.add_development_dependency(%q<sqlite3>, [">= 1.3.3"])
+      s.add_development_dependency(%q<rails>, [">= 3.0"])
+      s.add_development_dependency(%q<sqlite3>, [">= 1.3.3"])
+      s.add_development_dependency(%q<rails>, [">= 3.0"])
+      s.add_development_dependency(%q<sqlite3>, [">= 1.3.3"])
+    else
+      s.add_dependency(%q<soft_destroyable>, [">= 0"])
+      s.add_dependency(%q<rails>, [">= 3.0"])
+      s.add_dependency(%q<sqlite3>, [">= 1.3.3"])
+      s.add_dependency(%q<rails>, [">= 3.0"])
+      s.add_dependency(%q<sqlite3>, [">= 1.3.3"])
+      s.add_dependency(%q<rails>, [">= 3.0"])
+      s.add_dependency(%q<sqlite3>, [">= 1.3.3"])
+      s.add_dependency(%q<rails>, [">= 3.0"])
+      s.add_dependency(%q<sqlite3>, [">= 1.3.3"])
+      s.add_dependency(%q<rails>, [">= 3.0"])
+      s.add_dependency(%q<sqlite3>, [">= 1.3.3"])
+    end
+  else
+    s.add_dependency(%q<soft_destroyable>, [">= 0"])
+    s.add_dependency(%q<rails>, [">= 3.0"])
+    s.add_dependency(%q<sqlite3>, [">= 1.3.3"])
+    s.add_dependency(%q<rails>, [">= 3.0"])
+    s.add_dependency(%q<sqlite3>, [">= 1.3.3"])
+    s.add_dependency(%q<rails>, [">= 3.0"])
+    s.add_dependency(%q<sqlite3>, [">= 1.3.3"])
+    s.add_dependency(%q<rails>, [">= 3.0"])
+    s.add_dependency(%q<sqlite3>, [">= 1.3.3"])
+    s.add_dependency(%q<rails>, [">= 3.0"])
+    s.add_dependency(%q<sqlite3>, [">= 1.3.3"])
+  end
+end
+

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: soft_destroyable
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Michael Kintzer
@@ -19,9 +19,55 @@ date: 2011-03-05 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
+  type: :runtime
+  prerelease: false
+  name: soft_destroyable
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
   name: rails
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  type: :development
   prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  name: sqlite3
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 29
+        segments: 
+        - 1
+        - 3
+        - 3
+        version: 1.3.3
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: rails
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -31,12 +77,74 @@ dependencies:
         - 3
         - 0
         version: "3.0"
+  requirement: *id004
+- !ruby/object:Gem::Dependency 
   type: :development
-  version_requirements: *id001
+  prerelease: false
+  name: sqlite3
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 29
+        segments: 
+        - 1
+        - 3
+        - 3
+        version: 1.3.3
+  requirement: *id005
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: rails
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
+  requirement: *id006
 - !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
   name: sqlite3
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 29
+        segments: 
+        - 1
+        - 3
+        - 3
+        version: 1.3.3
+  requirement: *id007
+- !ruby/object:Gem::Dependency 
+  type: :development
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  name: rails
+  version_requirements: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
+  requirement: *id008
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: sqlite3
+  version_requirements: &id009 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -47,8 +155,38 @@ dependencies:
         - 3
         - 3
         version: 1.3.3
+  requirement: *id009
+- !ruby/object:Gem::Dependency 
   type: :development
-  version_requirements: *id002
+  prerelease: false
+  name: rails
+  version_requirements: &id010 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
+  requirement: *id010
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: sqlite3
+  version_requirements: &id011 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 29
+        segments: 
+        - 1
+        - 3
+        - 3
+        version: 1.3.3
+  requirement: *id011
 description: Rails 3 ActiveRecord compatible soft destroy implementation supporting dependent associations
 email: rockrep@yahoo.com
 executables: []
@@ -56,10 +194,11 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- README
+- README.textile
 files: 
+- Gemfile
 - MIT-LICENSE
-- README
+- README.textile
 - Rakefile
 - VERSION
 - init.rb
@@ -67,6 +206,7 @@ files:
 - lib/soft_destroyable.rb
 - lib/soft_destroyable/is_soft_destroyable.rb
 - lib/soft_destroyable/table_definition.rb
+- soft_destroyable.gemspec
 - spec/support/soft_destroy_spec_helper.rb
 - test/basic_test.rb
 - test/callback_test.rb

data/README

@@ -1,18 +0,0 @@
-SoftDestroyable
-===============
-
-Description goes here.
-
-== Note on Patches/Pull Requests
-
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
-
-== Copyright
-
-Copyright (c) 2010-11 Michael Kintzer, released under the MIT license