Module: ActiveArchive::Base

Defined in:
lib/active_archive/base.rb

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.included(base) ⇒ Object 



4
5
6
7
8
9
 
# File 'lib/active_archive/base.rb', line 4

def self.included(base)
  base.extend Methods
  base.extend Scopes

  base.instance_eval { define_model_callbacks(:unarchive) }
end

Instance Method Details

#archivable? ⇒ Boolean

Returns:

  • (Boolean) 


15
16
17
 
# File 'lib/active_archive/base.rb', line 15

def archivable?
  respond_to?(:archived_at)
end

#archived? ⇒ Boolean

Returns:

  • (Boolean) 


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

def archived?
  archivable? ? !archived_at.nil? : destroyed?
end

#destroy(force = nil) ⇒ Object Also known as: archive, archive! 



19
20
21
22
23
24
25
26
27
 
# File 'lib/active_archive/base.rb', line 19

def destroy(force = nil)
  with_transaction_returning_status do
    if unarchivable? || should_force_destroy?(force)
      permanently_delete_records_after { super() }
    else
      destroy_with_active_archive(force)
    end
  end
end

#to_archival ⇒ Object 



32
33
34
 
# File 'lib/active_archive/base.rb', line 32

def to_archival
  I18n.t("active_archive.archival.#{archived? ? :archived : :unarchived}")
end

#unarchivable? ⇒ Boolean

Returns:

  • (Boolean) 


51
52
53
 
# File 'lib/active_archive/base.rb', line 51

def unarchivable?
  !archivable?
end

#unarchive(opts = nil) ⇒ Object Also known as: unarchive! 



36
37
38
39
40
41
42
43
 
# File 'lib/active_archive/base.rb', line 36

def unarchive(opts = nil)
  with_transaction_returning_status do
    records = should_unarchive_parent_first?(opts) ? unarchival.reverse : unarchival
    records.each { |rec| rec.call(opts) }

    self
  end
end

#unarchived? ⇒ Boolean

Returns:

  • (Boolean) 


47
48
49
 
# File 'lib/active_archive/base.rb', line 47

def unarchived?
  !archived?
end