undeletable 0.0.1 → 1.0.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ODZmMjIyMGQ4MzIyOTI0OWY5OTQ0ZmExYjBjYjYwY2YzYjIwZWJlOQ==
+    MjI3YzE0ZTIyZjIxODVkYTVlOGY2NDlmNTMwMjY5NmE4ZmRhYWE1Yw==
   data.tar.gz: !binary |-
-    ZjU0YzUyOTEwNDQ4OGRkNmZmNjk5ZDhjYjU1MmViZWMwYTcyMWJmYQ==
+    ZmUxOTc4OTNjZDMzZjRjZDRkNTMxNjAwZDRjMzk1YTY2ODkzNzJhNA==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    ZjY1OGUzMmU0MTZhNmNkYWZlODMwNDY2YTM2YmE3YmRmZjcxMWJlODgxNGQ0
-    MTE4OGYyNTJhOTI3OGU0NzFkNjRhYmVmMTNlNmZkOWRkNzQ1YTMzY2I0ZjQ4
-    NTk5NjJmZDM0NjYwNzMzY2FhYmE3MjQyNTQ5YjYwMGQ2MTgxNTQ=
+    NDhjMzQwM2Q4ZDUyYjhiYzllMGU4ZTRiYTc4MWQzZjI5MTk3Nzc5OWNkYjMz
+    MWE4OGY0ZmZmMGVlMmM2YzdkMmQwYjA0Mjg5MzdhZDVmNjkwM2Y1ZDMxODU1
+    MDEzODUzM2EzY2U1YjZmZDM0MDg1NzY3ODUzNDk5YzNiZDhlMmY=
   data.tar.gz: !binary |-
-    YmZmODYzZTRjMGMzNTUyNTQyM2ZlNTA0ODM5YzI4YmJmZjc5NDFjZmVkYTU3
-    NWE5ZWU3OGRiNjI2ZDg3M2YzOTdmOWEwYjc2ODZjYjBkYmEwN2I3NWZjODgw
-    NTk5MmUzNThhZGE5MjEwYzE3YjhlMGRhYWY3NDk2OWMzMzU5NGM=
+    ODZmYjIxNjA1OGI0M2JlZTI4ZWU3ZDU3NGQzYWE2M2YwMjNkZjkzMjYxMmJi
+    ZTlhN2UxM2JlNTJhMDdmMzkxZGQ3ODdmZjA3Yzc1NDYyZjYyZGU0MzQ4ZDFk
+    ZTU5MTdlZjhlM2FhNDY1MzVjNTJjNzBjMDUxMjNjZmRmZjM1NmQ=

data/README.md

@@ -1,10 +1,12 @@
+[![Build Status](https://secure.travis-ci.org/FineLinePrototyping/undeletable.png?branch=master)][travis] [![Gem Version](https://badge.fury.io/rb/undeletable.png)][badgefury]
+
 # Undeletable
 
-The `undeletable` class method disables the ability to `delete`/`destroy` an ActiveRecord model instance, and `undeletable!` raises an error if a `delete`/`destroy!` is attempted. Can support destroy callbacks if raise not enabled.
+`undeletable` on the model class disables the ability to `delete`/`destroy` on instance, model class, and via relation, using the default ActiveRecord version of those, and supports destroy callbacks if raise not enabled. `undeletable!` on the model class will raise an error when those are attempted. `destroy!` in Rails 4 is supported.
 
-Similar to paranoid/acts_as_paranoid, the bang methods, `destroy!` and `delete!` are provided in case the original destroy/delete methods are needed.
+Tested with ActiveRecord 3.1.x, 3.2.x, and 4.0.x via travis and appraisal.
 
-Undeletable is a fork of [Paranoia][paranoia] (by Ryan Bigg and others) but heavily modified to just disallow normal deletion.
+Code originally based on [Paranoia][paranoia] (by Ryan Bigg and others), but extremely modified to the point it really shares little in common now.
 
 ## Installation & Usage
 
@@ -28,7 +30,7 @@ Updating is as simple as `bundle update undeletable`.
 
 ```ruby
 Undeletable.configure do
-  # if true and with_raise not used, will debug log failed attempts to delete/destroy the models
+  # if true, debug log failed attempts to delete/destroy when not raising error
   self.debug = false
 end
 
@@ -57,8 +59,15 @@ class Client < ActiveRecord::Base
 end
 ```
 
+## Upgrading
+
+* v0.0.1 -> v1.0.x: `delete!` and `destroy!` no longer supported for now. `destroy!` has a Rails 4 naming conflict with same named method, and attempting to provide support for ActiveRecord::Relation made it too complicated for now (problems with infinite recursion requiring more state to setup and check, etc.). If you need to delete or destroy an undeletable model, the workaround is to comment the undeletable method on the class.
+
 ## License
 
-This gem is released under the MIT license.
+This gem is released under the [MIT license][lic].
 
+[lic]: http://github.com/FineLinePrototyping/undeletable/blob/master/LICENSE
 [paranoia]: https://github.com/radar/paranoia
+[travis]: http://travis-ci.org/FineLinePrototyping/undeletable
+[badgefury]: http://badge.fury.io/rb/undeletable

data/Rakefile

@@ -1,11 +1,15 @@
-require 'bundler'
-Bundler::GemHelper.install_tasks
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+require 'appraisal'
 
-task :test do
-  load 'test/undeletable_test.rb'
-  #Dir['test/*_test.rb'].each do |testfile|
-  #  load testfile
-  #end
+task :default do |t|
+  if ENV['BUNDLE_GEMFILE'] =~ /gemfiles/
+    load 'test/undeletable_test.rb'
+  else
+    exec 'bundle install && bundle exec rake appraise'
+  end
 end
 
-task :default => :test
+task :appraise => ['appraisal:install'] do |t|
+  exec 'bundle install && bundle exec rake appraisal'
+end

data/lib/undeletable.rb

@@ -3,55 +3,131 @@ require 'undeletable/version'
 module Undeletable
   class << self
     attr_accessor :debug
-    def configure(&blk); class_eval(&blk); end
+    def configure(&blk)
+      class_eval(&blk)
+    end
   end
 
-  def self.included(klazz)
-    klazz.extend Query
-  end
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    def undeletable?
+      true
+    end
 
-  module Query
-    def undeletable? ; true ; end
+    def raise_on_delete?
+      self.raise_on_delete
+    end
+    
+    def delete(id_or_array)
+      raise ActiveRecord::ReadOnlyRecord.new("#{self} is undeletable") if raise_on_delete?
+      logger.debug("will not #{self}.delete #{id_or_array.inspect}", e) if Undeletable.debug
+    end
+    
+    def delete_all(conditions = nil)
+      raise ActiveRecord::ReadOnlyRecord.new("#{self} is undeletable") if raise_on_delete?
+      logger.debug("will not #{self}.delete_all", e) if Undeletable.debug
+    end
   end
 
   def destroy
-    raise ActiveRecord::ReadOnlyRecord.new("#{self} is undeletable") if self.raise_on_delete
+    raise ActiveRecord::ReadOnlyRecord.new("#{self} is undeletable") if raise_on_delete?
     logger.debug("will not delete #{self}", e) if Undeletable.debug
     run_callbacks(:destroy) { delete }
   end
-
+  
   def delete
-    raise ActiveRecord::ReadOnlyRecord.new("#{self} is undeletable") if self.raise_on_delete
+    raise ActiveRecord::ReadOnlyRecord.new("#{self} is undeletable") if raise_on_delete?
     logger.debug("will not delete #{self}", e) if Undeletable.debug
   end
 
-  # I'm hoping this won't fail checks!
-  #def destroyed?
-  #end
-  #alias :deleted? :destroyed?
+end
+
+module UndeletableRails4Extensions
+  extend ActiveSupport::Concern
+
+  def destroy!
+    raise ActiveRecord::RecordNotDestroyed.new("#{self} is undeletable")
+  end
 end
 
 Undeletable.configure do
   self.debug = false
 end
 
+class ActiveRecord::Relation
+  # don't use generic naming to try to avoid conflicts, since this isn't model class specific
+  alias_method :undeletable_orig_relation_delete_all, :delete_all
+  def delete_all(*args, &block)
+    if klass.respond_to?(:undeletable?) && klass.undeletable?
+      raise ActiveRecord::ReadOnlyRecord.new("#{self} is undeletable") if klass.raise_on_delete?
+      logger.debug("will not #{self}.delete_all", e) if Undeletable.debug
+    else
+      undeletable_orig_relation_delete_all(*args, &block)
+    end
+  end
+
+  # don't use generic naming to try to avoid conflicts, since this isn't model class specific
+  alias_method :undeletable_orig_relation_destroy_all, :destroy_all
+  def destroy_all(*args, &block)
+    if klass.respond_to?(:undeletable?) && klass.undeletable?
+      raise ActiveRecord::ReadOnlyRecord.new("#{self} is undeletable") if klass.raise_on_delete?
+      logger.debug("will not #{self}.destroy_all", e) if Undeletable.debug
+      if conditions
+        where(*args, &block).to_a.each {|object| object.run_callbacks(:destroy) { delete } }.tap { reset }
+      else
+        to_a.each {|object| object.run_callbacks(:destroy) { delete } }.tap { reset }
+      end
+    else
+      undeletable_orig_relation_destroy_all(*args, &block)
+    end
+  end
+end
+
 class ActiveRecord::Base
-  def self.undeletable(args = nil)
-    class_attribute :raise_on_delete, instance_writer: true
-    self.raise_on_delete = false
-    alias :destroy! :destroy
-    alias :delete!  :delete
-    include Undeletable
+
+  def self.undeletable
+    undeletable_init(false)
+  end
+
+  def self.undeletable!
+    undeletable_init(true)
   end
 
-  def self.undeletable!(args = nil)
+  def self.undeletable?
+    false
+  end
+
+  def undeletable?
+    self.class.undeletable?
+  end
+
+  def self.raise_on_delete?
+    false
+  end
+
+  def raise_on_delete?
+    self.class.raise_on_delete?
+  end  
+  
+private
+
+  def self.undeletable_init(raise_on_delete_val)
+    class_attribute :undeletable_enabled, instance_writer: true
+    self.undeletable_enabled = true
     class_attribute :raise_on_delete, instance_writer: true
-    self.raise_on_delete = true
-    alias :destroy! :destroy
-    alias :delete!  :delete
+    self.raise_on_delete = raise_on_delete_val
+    class << self
+      alias_method :undeletable_orig_class_delete, :delete
+      alias_method :undeletable_orig_class_delete_all, :delete_all
+    end
+    alias_method :undeletable_orig_delete, :delete
+    alias_method :undeletable_orig_destroy, :destroy
     include Undeletable
+    if defined?(ActiveRecord::VERSION::MAJOR) && ActiveRecord::VERSION::MAJOR > 3
+      alias_method :undeletable_orig_destroy!, :destroy!
+      include UndeletableRails4Extensions
+    end
   end
-
-  def self.undeletable? ; false ; end
-  def undeletable? ; self.class.undeletable? ; end
 end
+

data/lib/undeletable/version.rb

@@ -1,3 +1,3 @@
 module Undeletable
-  VERSION = "0.0.1"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: undeletable
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Gary S. Weaver
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-19 00:00:00.000000000 Z
+date: 2013-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,42 +16,42 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3.1'
 - !ruby/object:Gem::Dependency
-  name: activerecord
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 3.0.0
-  type: :development
+        version: '3.1'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3.1'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -67,22 +67,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.8.7
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.8.7
-description: Ignores or raises error on destroy/delete of an ActiveRecord model instance,
-  but is not marked as read-only and can be created/updated. This is a significantly
-  modified fork of the Paranoia gem (by Ryan Bigg and others).
+        version: '0'
+description: Ignores or raises error on destroy/delete of an ActiveRecord model, but
+  is not marked as read-only and can be created/updated.
 email:
 - garysweaver@gmail.com
 executables: []
@@ -93,7 +92,7 @@ files:
 - lib/undeletable.rb
 - Rakefile
 - README.md
-homepage: https://github.com/garysweaver/undeletable
+homepage: https://github.com/FineLinePrototyping/undeletable
 licenses:
 - MIT
 metadata: {}
@@ -113,7 +112,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.0.6
 signing_key: 
 specification_version: 4
 summary: Stop destroy/delete on certain ActiveRecord models without disallowing other