destroyed_at 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 27eab1991579adb70e518846349f055c1b3987eb
-  data.tar.gz: 0dfd9c729a38a9b6e8a39111cfb1e3ea25e0051c
+  metadata.gz: d0cbd15c416464ff4ef00e2af5b0a037bf72691e
+  data.tar.gz: 7f0cdd43d097e1f28b8c557ba444fa1f0befc6f6
 SHA512:
-  metadata.gz: bca0bb1c670c15093a97181d81fc4437382abebb78bcfb6fb46aeafe8605df76dc1c52c875e8b6fa091a9db20d16945e3e759b19e40a0f9db929be7955ecb6d8
-  data.tar.gz: f691ed1739ba388af682df654ddfd9261c8efaddfcda9e805628f14e32619eaaab7f665efc630bda8814d62650164305ed2e77b1f2fb106e3f89d695bb60163e
+  metadata.gz: bb3d75a9b8ab6488912479cc5623556f4f23e84d2235ecd6b668e1a2417037abf43ee377aa27b26504fb32a8878e0cb8c92540f3a6188d231dc917c2e5b9f2aa
+  data.tar.gz: ca2b3311fcec370efa0d5ab14d0fa6c5b11b7a36e8282f931f54501f399c173c2c0d0d18af81f124e49afb66351510ac268631eb89fbf239f990712133c32079

data/.gitignore

@@ -1,5 +1,6 @@
 *.gem
 *.rbc
+*.swp
 .bundle
 .config
 .yardoc
@@ -15,3 +16,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+bin/

data/CONTRIBUTING.md

@@ -0,0 +1,24 @@
+# Contribution Guidelines #
+
+## Submitting a new issue ##
+
+If you want to ensure that your issue gets fixed *fast* you should
+attempt to reproduce the issue in an isolated example application that
+you can share.
+
+## Making a pull request ##
+
+If you'd like to submit a pull request please adhere to the following:
+
+1. Your code *must* be tested. Please TDD your code!
+2. No single-character variables
+3. Two-spaces instead of tabs
+4. Single-quotes instead of double-quotes unless you are using string
+   interpolation or escapes.
+5. General Rails/Ruby naming conventions for files and classes
+
+Please note that you must adhere to each of the aforementioned rules.
+Failure to do so will result in an immediate closing of the pull
+request. If you update and rebase the pull request to follow the
+guidelines your pull request will be re-opened and considered for
+inclusion.

data/README.md

@@ -32,6 +32,8 @@ class ActiveRecord::Base
 end
 ```
 
+**Please note you will need to make a migration**
+
 Each model's table that is expected to have this behavior **must** have
 a `destroyed_at` column of type `DateTime`.
 
@@ -40,50 +42,80 @@ Allows you to "destroy" an object without deleting the record or
 associated records.
 
 ### Destroying ###
-Overides the `destroy` method to set `destroyed_at` on an object. The
+Overides `#destroy` to set `#destroyed_at` to the current time on an object. The
 default scope of the class is then set to return objects that have not
 been destroyed (i.e., have `nil` for their destroyed_at value).
 
 `#destroyed?` will be `true` when your model is destroyed; it will be
-`false` when your model has been undestroyed.
+`false` when your model has been restored.
+
+```ruby
+class User < ActiveRecord::Base
+  include DestroyedAt
+end
 
-## Undestroying ###
-When you'd like to "undestroy" a record, call the `undestroy` method on
-the instance. This will set its `destroyed_at` value to `nil`, thereby
+user = User.create
+user.destroy 
+# => true
+user.destroyed_at
+# => <DateTime>
+```
+
+### Restoring ####
+When you'd like to "restore" a record, call the `#restore` method on
+the instance. This will set its `#destroyed_at` value to `nil`, thereby
 including it in the default scope of the class again.
 
 To include this functionality on `has_many through` relationships,
 be sure to `include DestroyedAt` on the through model, as well as the
 parent model.
 
-#### Callbacks ####
-`before_undestroy` and `after_undestroy` callbacks are added to your
-model. They work similarly to the `before_destroy` and `after_destroy`
-callbacks.
-
-### Destroying ###
 ```ruby
 class User < ActiveRecord::Base
   include DestroyedAt
 end
 
 user = User.create
-user.destroy 
+user.destroy
+user.restore
 # => true
+user.destroyed_at
+# => nil
 ```
 
-### Undestroying ###
+### Callbacks ###
+`before_restore` and `after_restore` callbacks are added to your
+model. They work similarly to the `before_destroy` and `after_destroy`
+callbacks.
+
 ```ruby
 class User < ActiveRecord::Base
-  include DestroyedAt
+  before_restore :before_restore_action
+  after_restore  :after_restore_action
+  
+  private
+  
+  def before_restore_action
+    ...
+  end
+  
+  def after_restore_action
+    ...
+  end
 end
+```
 
-user = User.create
-user.destroy
-user.undestroy
-# => true
+### Validations ###
+
+If you are using the `uniqueness` validator you will need to run it as:
+
+```ruby
+validates :email, uniqueness: { conditions: -> { where(destroyed_at: nil) } }
 ```
 
+Rails will by default not include default_scopes when querying for uniqueness. Rather than monkey 
+patching the validator we believe this is the best solution.
+
 ## Authors ##
 
 * [Michael Dupuis](http://twitter.com/michaeldupuisjr)

data/lib/destroyed_at.rb

@@ -5,7 +5,7 @@ module DestroyedAt
     klass.instance_eval do
       default_scope { where(destroyed_at: nil) }
       after_initialize :_set_destruction_state
-      define_model_callbacks :undestroy
+      define_model_callbacks :restore
     end
   end
 
@@ -18,13 +18,13 @@ module DestroyedAt
     end
   end
 
-  # Set an object's destroyed at time to nil.
-  def undestroy
+  # Set an object's destroyed_at time to nil.
+  def restore
     state = nil
-    run_callbacks(:undestroy) do
+    run_callbacks(:restore) do
       if state = self.update_attribute(:destroyed_at, nil)
         @destroyed = false
-        _undestroy_associations
+        _restore_associations
       end
     end
     state
@@ -33,16 +33,18 @@ module DestroyedAt
   private
 
   def _set_destruction_state
-    @destroyed = destroyed_at.present?
+    @destroyed = destroyed_at.present? if respond_to?(:destroyed_at)
+    # Don't stop the other callbacks from running
+    true
   end
 
-  def _undestroy_associations
+  def _restore_associations
     reflections.select { |key, value| value.options[:dependent] == :destroy }.keys.each do |key|
       assoc = association(key)
       if assoc.options[:through] && assoc.options[:dependent] == :destroy
         assoc = association(assoc.options[:through])
       end
-      assoc.scoped.unscoped.each { |r| r.undestroy if r.respond_to? :undestroy }
+      assoc.scoped.unscoped.each { |r| r.restore if r.respond_to? :restore }
     end
   end
 end

data/lib/destroyed_at/version.rb

@@ -1,3 +1,3 @@
 module DestroyedAt
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/test/destroyed_at_test.rb

@@ -17,11 +17,11 @@ describe 'Destroying AR models' do
     end
   end
 
-  it 'can undestroy records' do
+  it 'can restore records' do
     user = User.create(:destroyed_at => DateTime.current)
     User.all.must_be_empty
     user.reload
-    user.undestroy
+    user.restore
     User.all.wont_be_empty
   end
 
@@ -34,11 +34,11 @@ describe 'Destroying AR models' do
     person.after_flag.must_equal true
   end
 
-  it 'will run undestroy callbacks' do
+  it 'will run restore callbacks' do
     person = Person.create(:destroyed_at => DateTime.current)
     person.before_flag.wont_equal true
     person.after_flag.wont_equal true
-    person.undestroy
+    person.restore
     person.before_flag.must_equal true
     person.after_flag.must_equal true
   end
@@ -55,18 +55,18 @@ describe 'Destroying AR models' do
     Car.unscoped.count.must_equal 0
   end
 
-  it 'can undestroy relationships' do
+  it 'can restore relationships' do
     user = User.create(:destroyed_at => DateTime.current)
     Profile.create(:destroyed_at => DateTime.current, :user => user)
     Profile.count.must_equal 0
-    user.undestroy
+    user.restore
     Profile.count.must_equal 1
   end
 
-  it 'will not undestroy relationships that have no destroy dependency' do
+  it 'will not restore relationships that have no destroy dependency' do
     user = User.create(:destroyed_at => DateTime.current, :show => Show.new(:destroyed_at => DateTime.current))
     Show.count.must_equal 0
-    user.undestroy
+    user.restore
     Show.count.must_equal 0
   end
 
@@ -74,7 +74,7 @@ describe 'Destroying AR models' do
     user = User.create(:destroyed_at => DateTime.current)
     Dinner.create(:destroyed_at => DateTime.current, :user => user)
     Dinner.count.must_equal 0
-    user.undestroy
+    user.restore
     Dinner.count.must_equal 1
   end
 
@@ -85,7 +85,7 @@ describe 'Destroying AR models' do
     fleet = Fleet.create(:destroyed_at => DateTime.current, :car => car)
     user.fleets = [fleet]
     user.cars.count.must_equal 0
-    user.undestroy
+    user.restore
     user.cars.count.must_equal 1
   end
 
@@ -95,7 +95,12 @@ describe 'Destroying AR models' do
     user.destroyed?.must_equal true
     user = User.unscoped.last
     user.destroyed?.must_equal true
-    user.undestroy
+    user.restore
     user.destroyed?.must_equal false
   end
+
+  it 'properly selects columns' do
+    User.create
+    User.select(:id).must_be_kind_of ActiveRecord::Relation
+  end
 end

data/test/test_helper.rb

@@ -48,8 +48,8 @@ class Person < User
   before_destroy :set_before_flag
   after_destroy  :set_after_flag
 
-  before_undestroy :set_before_flag
-  after_undestroy  :set_after_flag
+  before_restore :set_before_flag
+  after_restore  :set_after_flag
 
   attr_accessor :before_flag, :after_flag
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: destroyed_at
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Michael Dupuis Jr.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-28 00:00:00.000000000 Z
+date: 2013-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -145,6 +145,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .travis.yml
+- CONTRIBUTING.md
 - Gemfile
 - README.md
 - Rakefile
@@ -173,7 +174,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.0
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Safe destroy for ActiveRecord.