rails_soft_deletable 0.0.1

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Ngan Pham
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# RailsSoftDeletable
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rails_soft_deletable'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rails_soft_deletable
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/rails_soft_deletable/version.rb

@@ -0,0 +1,3 @@
+module RailsSoftDeletable
+  VERSION = "0.0.1"
+end

data/lib/rails_soft_deletable.rb

@@ -0,0 +1,134 @@
+require "rails_soft_deletable/version"
+
+module RailsSoftDeletable
+  def self.included(base)
+    base.extend Query
+    base.extend Callbacks
+  end
+
+  module Query
+    def soft_deletable?
+      true
+    end
+
+    def with_deleted
+      scoped.tap { |x| x.default_scoped = false }
+    end
+
+    def only_deleted
+      with_deleted.where("#{self.table_name}.#{soft_deletable_column} > 0")
+    end
+    alias :deleted :only_deleted
+
+    def restore(id)
+      if id.is_a?(Array)
+        id.map { |one_id| restore(one_id) }
+      else
+        only_deleted.find(id).restore!
+      end
+    end
+  end
+
+  module Callbacks
+    def self.extended(base)
+      base.define_callbacks :restore
+
+      base.define_singleton_method("before_restore") do |*args, &block|
+        set_callback(:restore, :before, *args, &block)
+      end
+
+      base.define_singleton_method("around_restore") do |*args, &block|
+        set_callback(:restore, :around, *args, &block)
+      end
+
+      base.define_singleton_method("after_restore") do |*args, &block|
+        set_callback(:restore, :after, *args, &block)
+      end
+    end
+  end
+
+  def destroy
+    run_callbacks(:destroy) { delete_or_soft_delete(true) }
+  end
+
+  def delete
+    return if new_record?
+    delete_or_soft_delete
+  end
+
+  def restore!
+    run_callbacks(:restore) do
+      # XXX: Rails >3.2.11 fixes an issue with update_column:
+      # https://github.com/rails/rails/commit/a3c3cfdd0ebba26bb9dfc0bfd4e23a5f336730c0
+      # Since we're on 3.2.11, we cannot use update_column.
+      #   update_column(soft_deletable_column, 0)
+
+      name = soft_deletable_column.to_s
+      updated_count = self.class.unscoped.update_all({ name => 0 }, self.class.primary_key => id)
+      raw_write_attribute(name, 0)
+
+      updated_count == 1
+    end
+  end
+  alias :restore :restore!
+
+  def destroyed?
+    send(soft_deletable_column) && send(soft_deletable_column) > 0
+  end
+  alias :deleted? :destroyed?
+
+  private
+
+  def delete_or_soft_delete(with_transaction = false)
+    destroyed? ? destroy! : touch_soft_deletable_column(with_transaction)
+  end
+
+  def touch_soft_deletable_column(with_transaction=false)
+    if with_transaction
+      with_transaction_returning_status { touch_column }
+    else
+      touch_column
+    end
+  end
+
+  def touch_column
+    raise ActiveRecordError, "can not touch on a new record object" unless persisted?
+
+    current_time = current_time_from_proper_timezone.to_i
+    changes = {}
+
+    changes[soft_deletable_column.to_s] = write_attribute(soft_deletable_column.to_s, current_time)
+
+    changes[self.class.locking_column] = increment_lock if locking_enabled?
+
+    @changed_attributes.except!(*changes.keys)
+    primary_key = self.class.primary_key
+    self.class.unscoped.where(primary_key => self[primary_key]).update_all(changes) == 1
+  end
+end
+
+class ActiveRecord::Base
+  def self.acts_as_soft_deletable(options={})
+    alias :destroy! :destroy
+    alias :delete! :delete
+    include RailsSoftDeletable
+    class_attribute :soft_deletable_column
+
+    self.soft_deletable_column = options[:column] || :deleted_at
+    default_scope { where(self.quoted_table_name + ".#{soft_deletable_column} = 0") }
+  end
+
+  def self.soft_deletable?
+    false
+  end
+
+  def soft_deletable?
+    self.class.soft_deletable?
+  end
+
+  private
+
+  def soft_deletable_column
+    self.class.soft_deletable_column
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require "pathname"
+ROOT_PATH = Pathname.new(__FILE__).join("../..").expand_path
+$LOAD_PATH.unshift(ROOT_PATH.join("lib"))
+
+RSpec.configure do |config|
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = "random"
+
+  # Disable the should syntax compeletely; we use the expect syntax only.
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: rails_soft_deletable
+version: !ruby/object:Gem::Version
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors:
+- Ngan Pham
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  name: rake
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  name: rspec
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0.beta1
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0.beta1
+  type: :development
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  name: debugger
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+description: Soft deletable for ActiveRecord on Rails 3+.
+email:
+- ngan@listia.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/rails_soft_deletable/version.rb
+- lib/rails_soft_deletable.rb
+- spec/spec_helper.rb
+- LICENSE.txt
+- Rakefile
+- README.md
+homepage: https://github.com/listia/rails_soft_deletable
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Soft deletable for ActiveRecord on Rails 3+
+test_files:
+- spec/spec_helper.rb