mark_only 0.0.2 → 1.0.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YjUxYmFlNWJjMzA1M2VmYzA5MTYxNWQyYzVhZjI2MjI1ODk2MGMyZQ==
+    NmQxYjJjY2RlMjFhM2EzYTg2MjdlYjkyOWRmYjMwZmQxZTZkMTBiOA==
   data.tar.gz: !binary |-
-    MzAzM2Q3ZGFjYzgyZjVmMGFkYzIxNmM4YjhhMTMxMGUwYjRlNWE4Mg==
+    Y2Y1MWM5ZjgyOGI1YTcyZGJhZmJjNWVmZmQ4ZDAxNzE1ZDk4NDViMA==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    Y2ZiODM2NWMwOThjNzhjYWFhYTE2NWM3MDdiYmYwYWM2YmNkNzE4ZDVjMGYz
-    ZTU5MDc5NjAyYWVmNDljZWJiYjgyODRhMTgxZDliY2JhZjEzMjVlNTlhNjA2
-    ODg3MWVkN2JhMmE5OWZlMWY0ODNkNWNhMzUzYzBlMGU3YmQzZDA=
+    YjBlODY0NmU1MWMxM2JmNTdiNTY5ZmRhMmI4ZTE2ZDRlYjhiZTExMjc4NDgz
+    MDUyNDJmYTdiYTJhNDdjMDA2NmE4ODk4N2UxZTdmNjBkMmJlZmYxODFhMGQ4
+    MzI5YjhkYmRmMjU4ZTM1ZTU4Mjk2ZWU2MjExNzE4NGNjZmQyYzQ=
   data.tar.gz: !binary |-
-    ZWNkNGU1YjZhNWNiZjE2NzhjZDZjOTY1ZTIzOThjMzYzNDI2NzNjNjcwNGU0
-    ZGE1NDFhZGZmYmYyNWY4OTI5M2Q1NTA4MWNjYzU0N2Q3M2ZjN2I4MTBlZjdh
-    YmI4ZDA3MGQ5NmYxODg3MzQ4MDgwNzU4YzZiZTQyNGVkNzk3ZTM=
+    YjdjOGViMjkwNGFjNTJhMDMzOTZkMTNiYWRhYWRiYzg4NWNlNTYwNTNkNTkz
+    OTE1YTRkMmIzMTgyNTE4MjBhYjFiYTg4NGY5NDQ4ODNhZWIzMzk4ZTFlZTMz
+    ODRkN2I1YzYyMDA5MzcyMzdmN2E4MmNjNmQ1NjM5NTNmNjZmYWI=

data/README.md

@@ -1,10 +1,16 @@
+[![Build Status](https://secure.travis-ci.org/FineLinePrototyping/mark_only.png?branch=master)][travis] [![Gem Version](https://badge.fury.io/rb/mark_only.png)][badgefury]
+
 # Mark Only
 
-Mark Only is a fork of [Paranoia][paranoia] (by Ryan Bigg and others) with significant changes. It only sets a specified column with a specified value on destroy/delete. Like Paranoia it allows before_destroy, etc. callbacks.
+Want to only mark a column with a value when the record is deleted or destroyed, but not unscope it? Then you're in the right place. If you want the records to be out of scope, look at acts_as_paranoid, paranoid, etc.
+
+`mark_only` on the model class sets a specified column with a specified value on destroy/delete and 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. `destroy!` in Rails 4 is supported.
 
-However, it does not unscope marked records. This means that anything that attempts to find the record after a destroy will still find it.
+Once a record is marked, `deleted?`/`destroyed?` methods on a retrieved model instance return false.
 
-To *really* destroy or delete records, use the Paranoia/acts_as_paranoid convention of calling `destroy!` or `delete!`.
+Tested with ActiveRecord 3.1.x, 3.2.x, and 4.0.x via travis and appraisal.
+
+Code originally based on [Paranoia][paranoia] (by Ryan Bigg and others), but heavily modified.
 
 ## Installation & Usage
 
@@ -44,7 +50,9 @@ Use the active_value as `:default`.
 
 ```ruby
 MarkOnly.configure do
-  self.active_value = 'active'
+  # if true, debug log failed attempts to delete/destroy
+  self.debug = false
+  # the value that should indicate that a record is deleted
   self.deleted_value = 'deleted'
 end
 
@@ -53,6 +61,8 @@ end
 
 #### In your model:
 
+To disallow attempts to delete/destroy and instead update the specified column:
+
 ```ruby
 class Client < ActiveRecord::Base
   mark_only :some_column_to_mark
@@ -61,24 +71,15 @@ class Client < ActiveRecord::Base
 end
 ```
 
-If you want a method to be called on destroy, simply provide a _before\_destroy_ callback:
-
-```ruby
-class Client < ActiveRecord::Base
-  mark_only :some_column_to_mark
-
-  before_destroy :some_method
-
-  def some_method
-    # do stuff
-  end
+## Upgrading
 
-  ...
-end
-```
+* v0.0.1 -> v1.0.x: `restore!` no longer supported; the workaround is to use SQL to change a record's mark column to some value other than MarkOnly.deleted_value. Similarly, if you need to really delete or destroy a row in the database corresponding to the record, use SQL.
 
 ## License
 
-This gem is released under the MIT license.
+This gem is released under the [MIT license][lic].
 
+[lic]: http://github.com/FineLinePrototyping/mark_only/blob/master/LICENSE
 [paranoia]: https://github.com/radar/paranoia
+[travis]: http://travis-ci.org/FineLinePrototyping/mark_only
+[badgefury]: http://badge.fury.io/rb/mark_only

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/mark_only_test.rb'
-  #Dir['test/*_test.rb'].each do |testfile|
-  #  load testfile
-  #end
+task :default do |t|
+  if ENV['BUNDLE_GEMFILE'] =~ /gemfiles/
+    load 'test/mark_only_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/mark_only/version.rb

@@ -1,3 +1,3 @@
 module MarkOnly
-  VERSION = "0.0.2"
+  VERSION = "1.0.1"
 end

data/lib/mark_only.rb

@@ -2,34 +2,46 @@ require 'mark_only/version'
 
 module MarkOnly
   class << self
-    [:deleted_value, :active_value].each{|o|attr_accessor o}
-    def configure(&blk); class_eval(&blk); end
+    attr_accessor :debug, :deleted_value
+    def configure(&blk)
+      class_eval(&blk)
+    end
   end
 
-  def self.included(klazz)
-    klazz.extend Query
-  end
+  extend ActiveSupport::Concern
 
-  module Query
-    def mark_only? ; true ; end
+  module ClassMethods
+    def mark_only?
+      true
+    end
+    
+    def delete(id_or_array)
+      logger.debug("will not #{self}.delete #{id_or_array.inspect}", e) if MarkOnly.debug
+      c = "#{quoted_table_name}.#{connection.quote_column_name self.mark_only_column}"
+      self.
+        where(primary_key => id_or_array).
+        where("#{c} != ? OR #{c} IS NULL", MarkOnly.deleted_value).
+        update_all({self.mark_only_column => MarkOnly.deleted_value})
+    end
+    
+    def delete_all(conditions = nil)
+      logger.debug("will not #{self}.delete_all", e) if MarkOnly.debug
+      c = "#{quoted_table_name}.#{connection.quote_column_name self.mark_only_column}"
+      (conditions ? self.where(conditions) : self).
+        where("#{c} != ? OR #{c} IS NULL", MarkOnly.deleted_value).
+        update_all({self.mark_only_column => MarkOnly.deleted_value})
+    end
   end
 
   def destroy
+    logger.debug("will not delete #{self}", e) if MarkOnly.debug
+    update_mark_only_attribute_or_column(self.mark_only_column, MarkOnly.deleted_value) if !deleted? && persisted?
     run_callbacks(:destroy) { delete }
   end
-
+  
   def delete
-    update_attribute_or_column(self.mark_only_column, MarkOnly.deleted_value) if !deleted? && persisted?
-  rescue => e
-    logger.error("failed to set #{self.mark_only_column} to #{MarkOnly.deleted_value} in #{self}", e)
-    raise e
-  end
-
-  def restore!
-    update_attribute_or_column self.mark_only_column, MarkOnly.active_value
-  rescue => e
-    logger.error("failed to set #{self.mark_only_column} to #{MarkOnly.active_value} in #{self}", e)
-    raise e
+    logger.debug("will not delete #{self}", e) if MarkOnly.debug
+    update_mark_only_attribute_or_column(self.mark_only_column, MarkOnly.deleted_value) if !deleted? && persisted?
   end
 
   def destroyed?
@@ -37,36 +49,101 @@ module MarkOnly
   end
   alias :deleted? :destroyed?
 
-  private
+end
 
-  # Rails 3.1 adds update_column. Rails > 3.2.6 deprecates update_attribute, gone in Rails 4.
-  def update_attribute_or_column(*args)
-    respond_to?(:update_column) ? update_column(*args) : update_attribute(*args)
+module MarkOnlyRails4Extensions
+  extend ActiveSupport::Concern
+
+  def destroy!
+    update_mark_only_attribute_or_column(self.mark_only_column, MarkOnly.deleted_value) if !deleted? && persisted?
+    raise ActiveRecord::RecordNotDestroyed.new("#{self} is mark_only")
   end
 end
 
 MarkOnly.configure do
-  self.active_value = 'active'
+  self.debug = false
   self.deleted_value = 'deleted'
 end
 
+class ActiveRecord::Relation
+  # don't use generic naming to try to avoid conflicts, since this isn't model class specific
+  alias_method :mark_only_orig_relation_delete_all, :delete_all
+  def delete_all(*args, &block)
+    if klass.respond_to?(:mark_only?) && klass.mark_only?
+      logger.debug("will not #{self}.delete_all", e) if MarkOnly.debug
+      if args.length > 0 && block_given?
+        where(*args, &block)
+      elsif args.length > 0 && !block_given?
+        where(*args)
+      elsif args.length == 0 && block_given?
+        where(&block)
+      end
+      c = "#{quoted_table_name}.#{connection.quote_column_name self.mark_only_column}"
+      where("#{c} != ? OR #{c} IS NULL", MarkOnly.deleted_value)
+      update_all({self.mark_only_column => MarkOnly.deleted_value})
+    else
+      mark_only_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 :mark_only_orig_relation_destroy_all, :destroy_all
+  def destroy_all(*args, &block)
+    if klass.respond_to?(:mark_only?) && klass.mark_only?
+      logger.debug("will not #{self}.destroy_all", e) if MarkOnly.debug
+      if args.length > 0 && block_given?
+        where(*args, &block)
+      elsif args.length > 0 && !block_given?
+        where(*args)
+      elsif args.length == 0 && block_given?
+        where(&block)
+      end
+      c = "#{quoted_table_name}.#{connection.quote_column_name self.mark_only_column}"
+      where("#{c} != ? OR #{c} IS NULL", MarkOnly.deleted_value)
+      update_all({self.mark_only_column => MarkOnly.deleted_value})
+      #rel.to_a.each {|object| object.run_callbacks(:destroy) { delete }}.tap { reset }
+    else
+      mark_only_orig_relation_destroy_all(*args, &block)
+    end
+  end
+end
+
 class ActiveRecord::Base
+
   def self.mark_only(col_name)
     raise "#{self} must call mark_only with a column name!" unless col_name
     class_attribute :mark_only_column, instance_writer: true
     self.mark_only_column = col_name.to_sym
-    alias :destroy! :destroy
-    alias :delete!  :delete
+    class << self
+      alias_method :mark_only_orig_class_delete, :delete
+      alias_method :mark_only_orig_class_delete_all, :delete_all
+    end
+    alias_method :mark_only_orig_delete, :delete
+    alias_method :mark_only_orig_destroy, :destroy
     include MarkOnly
+    if defined?(ActiveRecord::VERSION::MAJOR) && ActiveRecord::VERSION::MAJOR > 3
+      alias_method :mark_only_orig_destroy!, :destroy!
+      include MarkOnlyRails4Extensions
+    end
+  end
+
+  def self.mark_only?
+    false
   end
 
-  def self.mark_only? ; false ; end
-  def mark_only? ; self.class.mark_only? ; end
+  def mark_only?
+    self.class.mark_only?
+  end
 
-  # Override the persisted method to allow for the paranoia gem.
-  # If a mark_only record is selected, then we only want to check
-  # if it's a new record, not if it is "destroyed".
   def persisted?
     mark_only? ? !new_record? : super
   end
+
+private
+
+  # Rails 3.1 adds update_column. Rails > 3.2.6 deprecates update_attribute, gone in Rails 4.
+  def update_mark_only_attribute_or_column(*args)
+    respond_to?(:update_column) ? update_column(*args) : update_attribute(*args)
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mark_only
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.0.1
 platform: ruby
 authors:
 - Gary S. Weaver
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-18 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: A fork of Paranoia (by Ryan Bigg and others) that updates a specified
-  column with an pre-configured value on destroy, and does no scoping. Supports destroy
-  hooks.
+        version: '0'
+description: Updates a specified column with an pre-configured value on delete/destroy.
+  Supports destroy hooks.
 email:
 - garysweaver@gmail.com
 executables: []
@@ -93,7 +92,7 @@ files:
 - lib/mark_only.rb
 - Rakefile
 - README.md
-homepage: https://github.com/garysweaver/mark_only
+homepage: https://github.com/FineLinePrototyping/mark_only
 licenses:
 - MIT
 metadata: {}
@@ -113,9 +112,8 @@ 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: A fork of Paranoia (by Ryan Bigg and others) that updates a specified column
-  with an pre-configured value on delete/destroy.
+summary: Updates a specified column with an pre-configured value on delete/destroy.
 test_files: []