guard_against_physical_delete 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e4f57f099c2f498d498bc4080d1241c0ca4973cc
+  data.tar.gz: 766a9b52dbea30d3d2208da40eeb83dac8f1ffc6
+SHA512:
+  metadata.gz: 44ca59e3608e8d8752095629dabdecb5fcfc9e5be8683490569629aa339d94edfb3b7472765937f49558c8a4ce2d92de7c573120762b8182b46d9cbca4473ffc
+  data.tar.gz: 9fb8466de8aa5b87275590a8f185a68757534407b0ad56864906b91ffd06961ed635a14197fe78ec39336216ddb67072cfa7612ccf1737c0e854b9bcc3e0fcd0

data/.gitignore

@@ -0,0 +1,4 @@
+.bundle
+test.db
+coverage
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0

data/Gemfile

@@ -0,0 +1,20 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+gem 'activerecord', '>= 3.0.10'
+gem "bundler"
+
+group :development do
+  gem 'sqlite3'
+  gem "rdoc", "~> 3.12"
+  gem "jeweler", "~> 1.8.3"
+  gem 'database_cleaner'
+
+  gem 'rspec', '< 2.99'
+  gem 'simplecov', :platforms => [:ruby_19, :ruby_20, :ruby_21]
+  gem 'countdownlatch'
+end

data/License.txt

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2011 COOKPAD Inc.
+
+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.rdoc

@@ -0,0 +1,17 @@
+= guard_against_physical_delete
+
+guard_against_physical_delete is monkey patch for ActiveRecord.
+This patch prevent deleting record physically.
+set logical delete column name. (default is :deleted_at)
+  Logical.logical_delete_column = :removed_at
+  Logical.first.delete #=> raise GuardAgainstPhysicalDelete::PhysicalDeleteError
+  Logical.physical_delete { Logical.first.delete } #=> allow physical_delete
+
+== Support
+active_record 3.0.10, >= 3.2
+
+== Copyright
+
+Copyright (c) 2012 morita shingo. See License.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "guard_against_physical_delete"
+  gem.homepage = "http://github.com/cookpad/guard_against_physical_delete"
+  #gem.license = "MIT"
+  gem.summary = "Guard against physical delete"
+  gem.description = "Guard against physical delete"
+  gem.email = "morita@cookpad.com"
+  gem.authors = ["MORITA shingo"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+
+Dir['lib/tasks/*.rake'].each { |rake| load rake }
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+desc  "Run all specs with rcov"
+RSpec::Core::RakeTask.new(:rcov) do |t|
+  t.rcov = true
+  t.rcov_opts = %w{--rails --exclude osx\/objc,gems\/,spec\/,features\/}
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "guard_against_delete #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/guard_against_physical_delete.gemspec

@@ -0,0 +1,54 @@
+# 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 = "guard_against_physical_delete"
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["MORITA shingo"]
+  s.date = "2012-03-06"
+  s.description = "Guard against physical delete"
+  s.email = "morita@cookpad.com"
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^spec/}) }
+  s.homepage = "http://github.com/cookpad/guard_against_physical_delete"
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.15"
+  s.summary = "Guard against physical delete"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activerecord>, [">= 3.0.10"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<sqlite3>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_development_dependency(%q<database_cleaner>, [">= 0"])
+    else
+      s.add_dependency(%q<activerecord>, [">= 3.0.10"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<sqlite3>, [">= 0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_dependency(%q<database_cleaner>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activerecord>, [">= 3.0.10"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<sqlite3>, [">= 0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+    s.add_dependency(%q<database_cleaner>, [">= 0"])
+  end
+end
+

data/lib/guard_against_physical_delete.rb

@@ -0,0 +1,11 @@
+require 'active_record'
+require 'guard_against_physical_delete/physical_delete_error'
+require 'guard_against_physical_delete/relation'
+require 'guard_against_physical_delete/base'
+
+ActiveSupport.on_load :active_record do
+  ActiveRecord::Base.send(:include, GuardAgainstPhysicalDelete::Base)
+  ActiveRecord::Relation.send(:include, GuardAgainstPhysicalDelete::Relation)
+
+  require 'guard_against_physical_delete/support_counter_cache'
+end

data/lib/guard_against_physical_delete/base.rb

@@ -0,0 +1,57 @@
+module GuardAgainstPhysicalDelete
+  module Base
+    def self.included(obj)
+      obj.extend ClassMethods
+      obj.class_eval do
+        class_attribute :logical_delete_column
+
+        class << self
+          alias_method :set_logical_delete_column, :logical_delete_column=
+        end
+
+        set_logical_delete_column :deleted_at
+      end
+      obj.send(:include, InstanceMethods)
+    end
+
+    module ClassMethods
+
+      def physical_delete
+        physical_delete_permission[self.name] += 1
+        yield
+      ensure
+        physical_delete_permission[self.name] -= 1
+      end
+
+      def logical_delete?
+        self.column_names.include? logical_delete_column.to_s
+      end
+
+      def delete_permitted?
+        return true unless physical_delete_permission[self.name].zero?
+        return false if logical_delete?
+        return true
+      end
+
+      private
+
+      THREAD_LOCAL_KEY = :__GuardAgainstPhysicalDelete__thread_local_permission__
+      private_constant :THREAD_LOCAL_KEY if RUBY_VERSION >= '1.9.3'
+
+      def physical_delete_permission
+        Thread.current[THREAD_LOCAL_KEY] ||= Hash.new { |h,k| h[k] = 0 }
+      end
+    end
+
+    module InstanceMethods
+      def hard_delete
+        self.class.physical_delete { destroy }
+      end
+
+      def soft_delete
+        self.__send__(:"#{self.class.logical_delete_column}=", Time.now)
+        self.save!
+      end
+    end
+  end
+end

data/lib/guard_against_physical_delete/physical_delete_error.rb

@@ -0,0 +1,3 @@
+module GuardAgainstPhysicalDelete
+  class PhysicalDeleteError < StandardError; end
+end

data/lib/guard_against_physical_delete/relation.rb

@@ -0,0 +1,16 @@
+module GuardAgainstPhysicalDelete
+  module Relation
+    def self.included(obj)
+      obj.class_eval do
+        def delete_all_with_check_permit(conditions = nil)
+          unless @klass.delete_permitted?
+            raise GuardAgainstPhysicalDelete::PhysicalDeleteError, @klass.name
+          end
+          delete_all_without_check_permit(conditions)
+        end
+
+        alias_method_chain :delete_all, :check_permit
+      end
+    end
+  end
+end

data/lib/guard_against_physical_delete/support_counter_cache.rb

@@ -0,0 +1,12 @@
+if ActiveRecord::VERSION::STRING >= "4.1"
+  require 'guard_against_physical_delete/support_counter_cache/associations/builder/belongs_to'
+  ActiveRecord::Associations::Builder::BelongsTo.send(:include, GuardAgainstPhysicalDelete::SupportCounterCache::Associations::Builder::BelongsTo)
+elsif ActiveRecord::VERSION::STRING >= "3.2"
+  require 'guard_against_physical_delete/support_counter_cache/3.2_and_4.0/associations/builder/belongs_to'
+  ActiveRecord::Associations::Builder::BelongsTo.send(:include, GuardAgainstPhysicalDelete::SupportCounterCache::Associations::Builder::BelongsTo)
+elsif ActiveRecord::VERSION::STRING == "3.0.10"
+  require 'guard_against_physical_delete/support_counter_cache/3.0.10/associations'
+  ActiveRecord::Base.send(:include, GuardAgainstPhysicalDelete::SupportCounterCache::Associations)
+else
+  raise "guard_against_physical_delete doesn't support ActiveRecord version #{ActiveRecord::VERSION::STRING}"
+end

data/lib/guard_against_physical_delete/support_counter_cache/3.0.10/associations.rb

@@ -0,0 +1,43 @@
+module GuardAgainstPhysicalDelete
+  module SupportCounterCache
+    module Associations
+      def self.included(obj)
+        class << obj
+          def add_counter_cache_callbacks_with_logical_delete(reflection)
+            add_counter_cache_callbacks_without_logical_delete(reflection)
+            return unless logical_delete?
+            add_logical_delete_counter_cache_callback(reflection)
+          end
+          alias_method_chain :add_counter_cache_callbacks, :logical_delete
+
+          def add_logical_delete_counter_cache_callback(reflection)
+            cache_column = reflection.counter_cache_column
+
+            logical_delete_method_name = "belongs_to_counter_cache_before_logical_delete_for_#{reflection.name}".to_sym
+            define_method(logical_delete_method_name) do
+              delete_column = self.logical_delete_column
+              next unless send("#{delete_column}_changed?")
+              next unless send("#{delete_column}_was").nil?
+              association = send(reflection.name)
+              association.class.decrement_counter(cache_column, association.id) unless association.nil?
+            end
+
+            revive_method_name = "belongs_to_counter_cache_before_revive_for_#{reflection.name}".to_sym
+            define_method(revive_method_name) do
+              delete_column = self.logical_delete_column
+              next unless send("#{delete_column}_changed?")
+              next if send("#{delete_column}_was").nil?
+              next unless send(delete_column).nil?
+
+              clear_association_cache
+              association = send(reflection.name)
+              association.class.increment_counter(cache_column, association.id) unless association.nil?
+            end
+
+            before_update(logical_delete_method_name, revive_method_name)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/guard_against_physical_delete/support_counter_cache/3.2_and_4.0/associations/builder/belongs_to.rb

@@ -0,0 +1,50 @@
+module GuardAgainstPhysicalDelete
+  module SupportCounterCache
+    module Associations
+      module Builder
+        module BelongsTo
+          def self.included(obj)
+            obj.class_eval do
+              def add_counter_cache_callbacks_with_logical_delete(reflection)
+                add_counter_cache_callbacks_without_logical_delete(reflection)
+                return unless model.logical_delete?
+                add_logical_delete_counter_cache_callback(reflection)
+              end
+              alias_method_chain :add_counter_cache_callbacks, :logical_delete
+
+              def add_logical_delete_counter_cache_callback(reflection)
+                cache_column = reflection.counter_cache_column
+                name = self.name
+
+                logical_delete_method_name = "belongs_to_counter_cache_after_logical_delete_for_#{name}".to_sym
+                mixin.redefine_method(logical_delete_method_name) do
+                  delete_column = self.logical_delete_column
+                  next unless send("#{delete_column}_changed?")
+                  next unless send("#{delete_column}_was").nil?
+                  record = send(name)
+                  record.class.decrement_counter(cache_column, record.id) unless record.nil?
+                end
+
+                mixin.redefine_method("belongs_to_counter_cache_after_update_for_#{name}") do
+                  # do nothing
+                end if mixin.method_defined?("belongs_to_counter_cache_after_update_for_#{name}")
+
+                revive_method_name = "belongs_to_counter_cache_after_revive_for_#{name}".to_sym
+
+                mixin.redefine_method(revive_method_name) do
+                  delete_column = self.logical_delete_column
+                  next unless send("#{delete_column}_changed?")
+                  next if send("#{delete_column}_was").nil?
+                  next unless send(delete_column).nil?
+                  record = send(name)
+                  record.class.increment_counter(cache_column, record.id) unless record.nil?
+                end
+                model.after_update(logical_delete_method_name, revive_method_name)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/guard_against_physical_delete/support_counter_cache/associations/builder/belongs_to.rb

@@ -0,0 +1,59 @@
+module GuardAgainstPhysicalDelete
+  module SupportCounterCache
+    module Associations
+      module Builder
+        module BelongsTo
+          def self.included(obj)
+            class << obj
+              private
+              def add_counter_cache_methods_with_logical_delete(mixin)
+                add_counter_cache_methods_without_logical_delete mixin
+                add_logical_delete_counter_cache_methods(mixin)
+              end
+              alias_method_chain :add_counter_cache_methods, :logical_delete
+
+              def add_logical_delete_counter_cache_methods(mixin)
+                mixin.class_eval do
+                  def belongs_to_counter_cache_after_logical_delete(reflection)
+                    cache_column = reflection.counter_cache_column
+                    delete_column = self.logical_delete_column
+                    return unless send("#{delete_column}_changed?")
+                    return unless send("#{delete_column}_was").nil?
+
+                    record = send(reflection.name)
+                    record.class.decrement_counter(cache_column, record.id) unless record.nil?
+                  end
+
+                  def belongs_to_counter_cache_after_revive(reflection)
+                    cache_column = reflection.counter_cache_column
+                    delete_column = self.logical_delete_column
+                    return unless send("#{delete_column}_changed?")
+                    return if send("#{delete_column}_was").nil?
+                    return unless send(delete_column).nil?
+                    record = send(reflection.name)
+                    record.class.increment_counter(cache_column, record.id) unless record.nil?
+                  end
+                end
+                mixin.redefine_method("belongs_to_counter_cache_after_update_for_#{name}") do
+                  # do nothing
+                end if mixin.method_defined?("belongs_to_counter_cache_after_update_for_#{name}")
+              end
+
+              def add_counter_cache_callbacks_with_logical_delete(model, reflection)
+                add_counter_cache_callbacks_without_logical_delete model, reflection
+
+                return unless model.logical_delete?
+
+                model.after_update lambda { |record|
+                  record.belongs_to_counter_cache_after_logical_delete(reflection)
+                  record.belongs_to_counter_cache_after_revive(reflection)
+                }
+              end
+              alias_method_chain :add_counter_cache_callbacks, :logical_delete
+            end
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: guard_against_physical_delete
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- MORITA shingo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.10
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.10
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+- !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: Guard against physical delete
+email: morita@cookpad.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- License.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- guard_against_physical_delete.gemspec
+- lib/guard_against_physical_delete.rb
+- lib/guard_against_physical_delete/base.rb
+- lib/guard_against_physical_delete/physical_delete_error.rb
+- lib/guard_against_physical_delete/relation.rb
+- lib/guard_against_physical_delete/support_counter_cache.rb
+- lib/guard_against_physical_delete/support_counter_cache/3.0.10/associations.rb
+- lib/guard_against_physical_delete/support_counter_cache/3.2_and_4.0/associations/builder/belongs_to.rb
+- lib/guard_against_physical_delete/support_counter_cache/associations/builder/belongs_to.rb
+homepage: http://github.com/cookpad/guard_against_physical_delete
+licenses: []
+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.4.5.1
+signing_key: 
+specification_version: 3
+summary: Guard against physical delete
+test_files: []