Module: ActsAsRemovable::ClassMethods

Defined in:
lib/acts_as_removable.rb

Instance Method Summary collapse

Instance Method Details

#_acts_as_removable_options ⇒ Object 



78
79
80
81
82
 
# File 'lib/acts_as_removable.rb', line 78

def _acts_as_removable_options
  @_acts_as_removable_options ||= {
      column_name: 'removed_at'
    }
end

#acts_as_removable(options = {}) ⇒ Object

Add ability to remove ActiveRecord instances

acts_as_removable
acts_as_removable column_name: 'other_column_name'
Options

  • :column_name - A symbol or string with the column to use for removal timestamp.



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
 
# File 'lib/acts_as_removable.rb', line 17

def acts_as_removable(options = {})
  _acts_as_removable_options.merge!(options)

  scope :removed, -> {
    where(all.table[_acts_as_removable_options[:column_name]].not_eq(nil).to_sql)
  }

  scope :actives, -> {
    where(all.table[_acts_as_removable_options[:column_name]].eq(nil).to_sql)
  }

  define_model_callbacks :remove, :unremove

  class_eval do
    def self.before_remove(*args, &block)
      set_callback(:remove, :before, *args, &block)
    end

    def self.after_remove(*args, &block)
      set_callback(:remove, :after, *args, &block)
    end

    def self.before_unremove(*args, &block)
      set_callback(:unremove, :before, *args, &block)
    end

    def self.after_unremove(*args, &block)
      set_callback(:unremove, :after, *args, &block)
    end

    def removed?
      send(self.class._acts_as_removable_options[:column_name]).present?
    end

    def remove(options = {})
      _update_remove_attribute(:remove, Time.now, false, options)
    end

    def remove!(options = {})
      _update_remove_attribute(:remove, Time.now, true, options)
    end

    def unremove(options = {})
      _update_remove_attribute(:unremove, nil, false, options)
    end

    def unremove!(options = {})
      _update_remove_attribute(:unremove, nil, true, options)
    end

    def _update_remove_attribute(callback, value, with_bang = false, options = {})
      self.class.transaction do
        run_callbacks callback.to_sym do
          send("#{self.class._acts_as_removable_options[:column_name]}=", value)
          with_bang ? save!(options) : save(options)
        end
      end
    end
  end
end