Module: Paranoia

Defined in:
lib/paranoia.rb,
lib/paranoia/version.rb

Defined Under Namespace

Modules: Callbacks, Query

Constant Summary collapse

VERSION = 
"2.1.0"
@@default_sentinel_value = 
nil

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.default_sentinel_value ⇒ Object 



11
12
13
 
# File 'lib/paranoia.rb', line 11

def self.default_sentinel_value
  @@default_sentinel_value
end

.default_sentinel_value=(val) ⇒ Object

Change default_sentinel_value in a rails initilizer



7
8
9
 
# File 'lib/paranoia.rb', line 7

def self.default_sentinel_value=(val)
  @@default_sentinel_value = val
end

.included(klazz) ⇒ Object 



15
16
17
18
 
# File 'lib/paranoia.rb', line 15

def self.included(klazz)
  klazz.extend Query
  klazz.extend Callbacks
end

Instance Method Details

#delete ⇒ Object 



67
68
69
 
# File 'lib/paranoia.rb', line 67

def delete
  touch_paranoia_column
end

#destroy ⇒ Object 



59
60
61
62
63
64
65
 
# File 'lib/paranoia.rb', line 59

def destroy
  transaction do
    run_callbacks(:destroy) do
      touch_paranoia_column
    end
  end
end

#paranoia_destroyed? ⇒ Boolean Also known as: deleted?

Returns:

  • (Boolean) 


89
90
91
 
# File 'lib/paranoia.rb', line 89

def paranoia_destroyed?
  send(paranoia_column) != paranoia_sentinel_value
end

#restore!(opts = {}) ⇒ Object Also known as: restore 



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/paranoia.rb', line 71

def restore!(opts = {})
  self.class.transaction do
    run_callbacks(:restore) do
      # Fixes a bug where the build would error because attributes were frozen.
      # This only happened on Rails versions earlier than 4.1.
      noop_if_frozen = ActiveRecord.version < Gem::Version.new("4.1")
      if (noop_if_frozen && !@attributes.frozen?) || !noop_if_frozen
        write_attribute paranoia_column, paranoia_sentinel_value
        update_column paranoia_column, paranoia_sentinel_value
      end
      restore_associated_records if opts[:recursive]
    end
  end

  self
end