destroyed_at 0.1.0

checksums.yaml

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

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,2 @@
+rvm:
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in destroyed_at.gemspec
+gemspec

data/README.md

@@ -0,0 +1,111 @@
+# DestroyedAt #
+
+[![Build Status](https://secure.travis-ci.org/dockyard/destroyed_at.png?branch=master)](http://travis-ci.org/dockyard/destroyed_at)
+[![Dependency Status](https://gemnasium.com/dockyard/destroyed_at.png?travis)](https://gemnasium.com/dockyard/destroyed_at)
+[![Code Climate](https://codeclimate.com/github/dockyard/destroyed_at.png)](https://codeclimate.com/github/dockyard/destroyed_at)
+
+## Looking for help? ##
+
+If it is a bug [please open an issue on GitHub](https://github.com/dockyard/destroyed_at/issues).
+
+## Installation ##
+
+Add the `destroyed_at` gem to your `Gemfile`
+
+```ruby
+gem 'destroyed_at'
+```
+
+You can either mixin the modules on a case-by-case basis:
+
+```ruby
+class User < ActiveRecord::Base
+  include DestroyedAt
+end
+```
+
+or make the changes globally:
+
+```ruby
+class ActiveRecord::Base
+  include DestroyedAt
+end
+```
+
+Each model's table that is expected to have this behavior **must** have
+a `destroyed_at` column of type `DateTime`.
+
+## Usage ##
+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
+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.
+
+## 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
+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 
+# => true
+```
+
+### Undestroying ###
+```ruby
+class User < ActiveRecord::Base
+  include DestroyedAt
+end
+
+user = User.create
+user.destroy
+user.undestroy
+# => true
+```
+
+## Authors ##
+
+* [Michael Dupuis](http://twitter.com/michaeldupuisjr)
+* [Brian Cardarella](http://twitter.com/bcardarella)
+
+[We are very thankful for the many contributors](https://github.com/dockyard/destroyed_at/graphs/contributors)
+
+## Versioning ##
+
+This gem follows [Semantic Versioning](http://semver.org)
+
+## Want to help? ##
+
+Please do! We are always looking to improve this gem. Please see our
+[Contribution Guidelines](https://github.com/dockyard/destroyed_at/blob/master/CONTRIBUTING.md)
+on how to properly submit issues and pull requests.
+
+## Legal ##
+
+[DockYard](http://dockyard.com), LLC &copy; 2013
+
+[@dockyard](http://twitter.com/dockyard)
+
+[Licensed under the MIT license](http://www.opensource.org/licenses/mit-license.php)
+

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task :default => :test

data/destroyed_at.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'destroyed_at/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "destroyed_at"
+  spec.version       = DestroyedAt::VERSION
+  spec.authors       = ["Michael Dupuis Jr."]
+  spec.email         = ["michael.dupuis@dockyard.com"]
+  spec.description   = %q{Safe destroy for ActiveRecord.}
+  spec.summary       = %q{Safe destroy for ActiveRecord.}
+  spec.homepage      = "https://github.com/dockyard/destroyed_at"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "activerecord", "~> 3.2"
+  spec.add_development_dependency "minitest", "~> 5"
+  spec.add_development_dependency "m"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "timecop"
+  spec.add_development_dependency "database_cleaner"
+end

data/lib/destroyed_at.rb

@@ -0,0 +1,48 @@
+require "destroyed_at/version"
+
+module DestroyedAt
+  def self.included(klass)
+    klass.instance_eval do
+      default_scope { where(destroyed_at: nil) }
+      after_initialize :_set_destruction_state
+      define_model_callbacks :undestroy
+    end
+  end
+
+  # Set an object's destroyed_at time.
+  def destroy
+    run_callbacks(:destroy) do
+      destroy_associations
+      self.update_attribute(:destroyed_at, DateTime.current)
+      @destroyed = true
+    end
+  end
+
+  # Set an object's destroyed at time to nil.
+  def undestroy
+    state = nil
+    run_callbacks(:undestroy) do
+      if state = self.update_attribute(:destroyed_at, nil)
+        @destroyed = false
+        _undestroy_associations
+      end
+    end
+    state
+  end
+
+  private
+
+  def _set_destruction_state
+    @destroyed = destroyed_at.present?
+  end
+
+  def _undestroy_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 }
+    end
+  end
+end

data/lib/destroyed_at/version.rb

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

data/test/destroyed_at_test.rb

@@ -0,0 +1,101 @@
+require 'test_helper'
+
+describe 'Destroying AR models' do
+  it 'Calling destroy on a model should only safe destroy record' do
+    user = User.create
+    user.destroy
+    User.all.must_be_empty
+    User.unscoped.all.wont_be_empty
+  end
+
+  it 'Destroying a model will set the timestamp it was destroyed at' do
+    date = DateTime.current
+    Timecop.freeze(date) do
+      user = User.create
+      user.destroy
+      user.destroyed_at.inspect.must_equal date.inspect
+    end
+  end
+
+  it 'can undestroy records' do
+    user = User.create(:destroyed_at => DateTime.current)
+    User.all.must_be_empty
+    user.reload
+    user.undestroy
+    User.all.wont_be_empty
+  end
+
+  it 'will run destroy callbacks' do
+    person = Person.create
+    person.before_flag.wont_equal true
+    person.after_flag.wont_equal true
+    person.destroy
+    person.before_flag.must_equal true
+    person.after_flag.must_equal true
+  end
+
+  it 'will run undestroy callbacks' do
+    person = Person.create(:destroyed_at => DateTime.current)
+    person.before_flag.wont_equal true
+    person.after_flag.wont_equal true
+    person.undestroy
+    person.before_flag.must_equal true
+    person.after_flag.must_equal true
+  end
+
+  it 'will properly destroy relations' do
+    user = User.create(:profile => Profile.new, :car => Car.new)
+    user.reload
+    user.profile.wont_be_nil
+    user.car.wont_be_nil
+    user.destroy
+    Profile.count.must_equal 0
+    Profile.unscoped.count.must_equal 1
+    Car.count.must_equal 0
+    Car.unscoped.count.must_equal 0
+  end
+
+  it 'can undestroy relationships' do
+    user = User.create(:destroyed_at => DateTime.current)
+    Profile.create(:destroyed_at => DateTime.current, :user => user)
+    Profile.count.must_equal 0
+    user.undestroy
+    Profile.count.must_equal 1
+  end
+
+  it 'will not undestroy 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
+    Show.count.must_equal 0
+  end
+
+  it 'will respect has many associations' do
+    user = User.create(:destroyed_at => DateTime.current)
+    Dinner.create(:destroyed_at => DateTime.current, :user => user)
+    Dinner.count.must_equal 0
+    user.undestroy
+    Dinner.count.must_equal 1
+  end
+
+  it 'will respect has many through associations' do
+    #user = User.create(:destroyed_at => DateTime.current, :fleets => [Fleet.new(:destroyed_at => DateTime.current, :car => Car.new)])
+    user = User.create(:destroyed_at => DateTime.current)
+    car = Car.create
+    fleet = Fleet.create(:destroyed_at => DateTime.current, :car => car)
+    user.fleets = [fleet]
+    user.cars.count.must_equal 0
+    user.undestroy
+    user.cars.count.must_equal 1
+  end
+
+  it 'properly sets #destroyed?' do
+    user = User.create
+    user.destroy
+    user.destroyed?.must_equal true
+    user = User.unscoped.last
+    user.destroyed?.must_equal true
+    user.undestroy
+    user.destroyed?.must_equal false
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,88 @@
+require 'bundler/setup'
+require 'destroyed_at'
+require 'minitest/autorun'
+require 'active_record'
+require 'byebug'
+require 'timecop'
+require 'database_cleaner'
+
+class Minitest::Spec
+  class << self
+    alias :context :describe
+  end
+
+  before do
+    DatabaseCleaner.start
+  end
+
+  after do
+    DatabaseCleaner.clean
+  end
+end
+
+ActiveRecord::Base.establish_connection(
+  :adapter => defined?(JRUBY_VERSION) ? 'jdbcsqlite3' : 'sqlite3',
+  :database => ':memory:'
+)
+
+DatabaseCleaner.strategy = :truncation
+
+ActiveRecord::Base.connection.execute(%{CREATE TABLE users (id INTEGER PRIMARY KEY, destroyed_at DATETIME, type STRING);})
+ActiveRecord::Base.connection.execute(%{CREATE TABLE profiles (id INTEGER PRIMARY KEY, destroyed_at DATETIME, user_id INTEGER);})
+ActiveRecord::Base.connection.execute(%{CREATE TABLE cars (id INTEGER PRIMARY KEY, user_id INTEGER);})
+ActiveRecord::Base.connection.execute(%{CREATE TABLE dinners (id INTEGER PRIMARY KEY, destroyed_at DATETIME, user_id INTEGER);})
+ActiveRecord::Base.connection.execute(%{CREATE TABLE shows (id INTEGER PRIMARY KEY, destroyed_at DATETIME, user_id INTEGER);})
+ActiveRecord::Base.connection.execute(%{CREATE TABLE fleets (id INTEGER PRIMARY KEY, destroyed_at DATETIME, user_id INTEGER, car_id INTEGER);})
+
+class User < ActiveRecord::Base
+  include DestroyedAt
+  has_one :profile, :dependent => :destroy
+  has_one :car, :dependent => :destroy
+  has_many :dinners, :dependent => :destroy
+  has_one :show
+  has_many :fleets
+  has_many :cars, :through => :fleets, :dependent => :destroy
+end
+
+class Person < User
+  before_destroy :set_before_flag
+  after_destroy  :set_after_flag
+
+  before_undestroy :set_before_flag
+  after_undestroy  :set_after_flag
+
+  attr_accessor :before_flag, :after_flag
+
+  def set_before_flag
+    self.before_flag = true
+  end
+
+  def set_after_flag
+    self.after_flag = true
+  end
+end
+
+class Profile < ActiveRecord::Base
+  include DestroyedAt
+  belongs_to :user
+end
+
+class Car < ActiveRecord::Base
+  belongs_to :user
+  has_many :fleets
+end
+
+class Dinner < ActiveRecord::Base
+  include DestroyedAt
+  belongs_to :user
+end
+
+class Show < ActiveRecord::Base
+  include DestroyedAt
+end
+
+class Fleet < ActiveRecord::Base
+  include DestroyedAt
+  belongs_to :user
+  belongs_to :car
+end

metadata

@@ -0,0 +1,182 @@
+--- !ruby/object:Gem::Specification
+name: destroyed_at
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michael Dupuis Jr.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: m
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Safe destroy for ActiveRecord.
+email:
+- michael.dupuis@dockyard.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- README.md
+- Rakefile
+- destroyed_at.gemspec
+- lib/destroyed_at.rb
+- lib/destroyed_at/version.rb
+- test/destroyed_at_test.rb
+- test/test_helper.rb
+homepage: https://github.com/dockyard/destroyed_at
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.0
+signing_key: 
+specification_version: 4
+summary: Safe destroy for ActiveRecord.
+test_files:
+- test/destroyed_at_test.rb
+- test/test_helper.rb