Module: ActsAsParanoid

Defined in:
lib/rails3_acts_as_paranoid.rb

Instance Method Summary collapse

Instance Method Details

#acts_as_paranoid(options = {}) ⇒ Object

Raises:

  • (ArgumentError)


13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
# File 'lib/rails3_acts_as_paranoid.rb', line 13

def acts_as_paranoid(options = {})
  raise ArgumentError, "Hash expected, got #{options.class.name}" if not options.is_a?(Hash) and not options.empty?

  configuration = { :column => "deleted_at", :column_type => "time", :recover_dependent_associations => true, :dependent_recovery_window => 5.minutes }
  configuration.update(options) unless options.nil?

  type = case configuration[:column_type]
    when "time" then "Time.now"
    when "boolean" then "true"
    else
      raise ArgumentError, "'time' or 'boolean' expected for :column_type option, got #{configuration[:column_type]}"
  end

  column_reference = "#{self.table_name}.#{configuration[:column]}"

  class_eval "    default_scope where(\"\#{column_reference} IS ?\", nil)\n\n    class << self\n      def is_paranoid?\n        true\n      end\n\n      def with_deleted\n        self.unscoped.where(\"\") #self.unscoped.reload\n      end\n\n      def only_deleted\n        self.unscoped.where(\"\#{column_reference} IS NOT ?\", nil)\n      end\n\n      def delete_all!(conditions = nil)\n        self.unscoped.delete_all!(conditions)\n      end\n\n      def delete_all(conditions = nil)\n        update_all [\"\#{configuration[:column]} = ?\", \#{type}], conditions\n      end\n\n      def paranoid_column\n        :\"\#{configuration[:column]}\"\n      end\n\n      def paranoid_column_type\n        :\"\#{configuration[:column_type]}\"\n      end\n\n      def dependent_associations\n        self.reflect_on_all_associations.select {|a| a.options[:dependent] == :destroy }\n      end\n    end\n\n    def paranoid_value\n      self.send(self.class.paranoid_column)\n    end\n\n    def destroy!\n      before_destroy() if respond_to?(:before_destroy)\n\n      \#{self.name}.delete_all!(:id => self)\n\n      after_destroy() if respond_to?(:after_destroy)\n    end\n\n    def destroy\n      run_callbacks :destroy do\n        if paranoid_value == nil\n          \#{self.name}.delete_all(:id => self.id)\n        else\n          \#{self.name}.delete_all!(:id => self.id)\n        end\n      end\n    end\n\n    def recover(options = {})\n      options = {\n                  :recursive => \#{configuration[:recover_dependent_associations]},\n                  :recovery_window => \#{configuration[:dependent_recovery_window]}\n                }.merge(options)\n\n      self.class.transaction do\n        recover_dependent_associations(options[:recovery_window], options) if options[:recursive]\n\n        self.update_attributes(self.class.paranoid_column.to_sym => nil)\n      end\n    end\n\n    def recover_dependent_associations(window, options)\n      self.class.dependent_associations.each do |association|\n        if association.collection? && self.send(association.name).is_paranoid?\n          self.send(association.name).unscoped do\n            self.send(association.name).deleted_around(paranoid_value, window).each do |object|\n              object.recover(options) if object.respond_to?(:recover)\n            end\n          end\n        elsif association.macro == :has_one && association.klass.is_paranoid?\n          association.klass.unscoped do\n            object = association.klass.deleted_around(paranoid_value, window).send('find_by_'+association.primary_key_name, self.id)\n            object.recover(options) if object && object.respond_to?(:recover)\n          end\n        elsif association.klass.is_paranoid?\n          association.klass.unscoped do\n            id = self.send(association.primary_key_name)\n            object = association.klass.deleted_around(paranoid_value, window).find_by_id(id)\n            object.recover(options) if object && object.respond_to?(:recover)\n          end\n        end\n      end\n    end\n\n    def deleted?\n      !self.\#{configuration[:column]}.nil?\n    end\n\n    scope :deleted_around, lambda {|value, window|\n      if self.class.is_paranoid?\n        if self.class.paranoid_column_type == 'time' && ![true, false].include?(value)\n          self.where(\"\\\#{self.class.paranoid_column} > ? AND \\\#{self.class.paranoid_column} < ?\", (value - window), (value + window))\n        else\n          self.only_deleted\n        end\n      end\n    }\n\n    ActiveRecord::Relation.class_eval do\n      alias_method :delete_all!, :delete_all\n      alias_method :destroy!, :destroy\n    end\n  EOV\nend\n"

#validates_as_paranoidObject



144
145
146
147
148
# File 'lib/rails3_acts_as_paranoid.rb', line 144

def validates_as_paranoid
  class_eval "    send :extend, ParanoidValidations::ClassMethods\n  EOV\nend\n"