active_archive 5.1.7 → 5.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 02ef56cf163f46d646a5c33c14aaad6597e413faf018434af73e70293ea7bb9a
-  data.tar.gz: 46d27202b989f81bb8a9bf587d0bd4f6ef701daf18787f2521e6aa0647bfb4e6
+  metadata.gz: 7ad44438d97ef3a4c739a8aabb9f9d61429743b9b2835007fdeed270fcf348b6
+  data.tar.gz: bb7a6181c2c98a989f5bcbc5465686bde9d0126a5f615c315516d8b005b6046f
 SHA512:
-  metadata.gz: a9e6151c972359cca2d7e98ae5e994804905cf0c591554bfae87053cd614e24dfaa75c0081280b62c57d861053cd320126e7b68eb1c7eec6a282412cf1fc86a6
-  data.tar.gz: d40636590b9f9df38dadc4ce971c15d29c5d7b1bf4a7a5817012b2dd757b4153cff8750238a68a2ab2dea92774e44c2d47a2e5cf35f8ec0803dcaf8837e30d66
+  metadata.gz: 893d7bdf1ba645e69c335e99a8b6127b36401d6013bca9ca7f35ea0124177de2dccc78378cd1eb4c57848cd91926ea659dd3db56430906d686a4b41fed50fad9
+  data.tar.gz: dab93ef545dcbc4f86f71442d7b2f91ddf05f533adf3c01ee993574382e782c51a44e27faab88b536627006f39c399d2c15dfce72fdd3bf96f5e2c363d9df4af

data/.reek.yml

@@ -0,0 +1,27 @@
+---
+detectors:
+  Attribute:
+    enabled: false
+  DuplicateMethodCall:
+    enabled: false
+  FeatureEnvy:
+    enabled: false
+  IrresponsibleModule:
+    enabled: false
+  ManualDispatch:
+    enabled: false
+  NestedIterators:
+    max_allowed_nesting: 2
+  NilCheck:
+    enabled: false
+  TooManyStatements:
+    max_statements: 10
+    exclude:
+      - 'ActiveArchive::Base#retrieve_dependent_records'
+      - 'ActiveArchive::Base#set_archived_at'
+  UncommunicativeParameterName:
+    enabled: false
+  UncommunicativeVariableName:
+    enabled: false
+  UtilityFunction:
+    enabled: false

data/.rubocop.yml

@@ -12,7 +12,7 @@ Layout/EmptyLinesAroundModuleBody:
   Enabled: false
 LineLength:
   Max: 100
-Lint/RescueWithoutErrorClass:
+Lint/HandleExceptions:
   Enabled: false
 Lint/ScriptPermission:
   Enabled: false
@@ -20,7 +20,13 @@ Metrics/MethodLength:
   Enabled: false
 Metrics/ModuleLength:
   Enabled: false
+Naming/AccessorMethodName:
+  Enabled: false
 Style/Alias:
   EnforcedStyle: prefer_alias_method
 Style/Documentation:
   Enabled: false
+Style/ExpandPathArguments:
+  Enabled: false
+Style/RescueStandardError:
+  Enabled: false

data/README.md

@@ -43,12 +43,17 @@ end
 
 **Options:**
  * `archive`
+ * `archive_all`
+ * `archive_all!`
  * `destroy`
  * `destroy_all`
+ * `destroy_all!`
  * `delete`
  * `delete_all`
  * `unarchive`
  * `unarchive_all`
+ * `undestroy`
+ * `undestroy_all`
 
 ```ruby
 User.first.archive          #=> archives User record and dependents

data/active_archive.gemspec

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-# coding: utf-8
-
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'active_archive/version'
@@ -24,12 +22,12 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'rails'
 
   spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec'
-  spec.add_development_dependency 'sqlite3'
   spec.add_development_dependency 'database_cleaner'
-  spec.add_development_dependency 'generator_spec'
   spec.add_development_dependency 'fasterer'
+  spec.add_development_dependency 'generator_spec'
+  spec.add_development_dependency 'rake'
   spec.add_development_dependency 'reek'
+  spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'sqlite3'
 end

data/lib/active_archive/base.rb

@@ -10,14 +10,33 @@ module ActiveArchive
       base.instance_eval { define_model_callbacks(:unarchive) }
     end
 
+    def archivable?
+      respond_to?(:archived_at)
+    end
+
     def archived?
       archivable? ? !archived_at.nil? : destroyed?
     end
 
-    def archivable?
-      respond_to?(:archived_at)
+    def unarchived?
+      !archived?
+    end
+
+    def unarchivable?
+      !archivable?
+    end
+
+    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
 
+    alias_method :undestroy, :unarchive
+
     def destroy(force = nil)
       with_transaction_returning_status do
         if unarchivable? || should_force_destroy?(force)
@@ -28,36 +47,62 @@ module ActiveArchive
       end
     end
 
-    alias_method(:archive, :destroy)
-    alias_method(:archive!, :destroy)
+    alias_method :archive, :destroy
 
     def to_archival
       I18n.t("active_archive.archival.#{archived? ? :archived : :unarchived}")
     end
 
-    def unarchive(opts = nil)
-      with_transaction_returning_status do
-        records = should_unarchive_parent_first?(opts) ? unarchival.reverse : unarchival
-        records.each { |rec| rec.call(opts) }
+    private
 
-        self
-      end
-    end
+    def unarchival
+      [
+        lambda do |validate|
+          unarchive_destroyed_dependent_records(validate)
+        end,
+        lambda do |validate|
+          run_callbacks(:unarchive) do
+            set_archived_at(nil, validate)
 
-    alias_method(:unarchive!, :unarchive)
+            each_counter_cache do |assoc_class, counter_cache_column, assoc_id|
+              assoc_class.increment_counter(counter_cache_column, assoc_id)
+            end
 
-    def unarchived?
-      !archived?
+            true
+          end
+        end
+      ]
     end
 
-    def unarchivable?
-      !archivable?
+    def get_archived_record
+      self.class.unscoped.find(id)
     end
 
-    private
+    def set_archived_at(value, force = nil)
+      return self unless archivable?
+      record = get_archived_record
+      record.archived_at = value
 
-    def attempt_notifying_observers(callback)
-      notify_observers(callback) if respond_to?(:notify_observers)
+      begin
+        should_ignore_validations?(force) ? record.save(validate: false) : record.save!
+        @attributes = record.instance_variable_get('@attributes')
+      rescue => error
+        record.destroy
+        raise error
+      end
+    end
+
+    def each_counter_cache
+      _reflections.each do |name, reflection|
+        next unless respond_to?(name.to_sym)
+
+        association = send(name.to_sym)
+
+        next if association.nil?
+        next unless reflection.belongs_to? && reflection.counter_cache_column
+
+        yield(association.class, reflection.counter_cache_column, send(reflection.foreign_key))
+      end
     end
 
     def destroy_with_active_archive(force = nil)
@@ -66,53 +111,74 @@ module ActiveArchive
           save
         else
           set_archived_at(Time.now, force)
+
           each_counter_cache do |assoc_class, counter_cache_column, assoc_id|
             assoc_class.decrement_counter(counter_cache_column, assoc_id)
           end
         end
-        return(true)
+
+        true
       end
 
       archived? ? self : false
     end
 
-    def each_counter_cache
-      _reflections.each do |name, reflection|
-        next unless respond_to?(name.to_sym)
-
-        association = send(name.to_sym)
-
-        next if association.nil?
-        next unless reflection.belongs_to? && reflection.counter_cache_column
+    def add_record_window(_request, name, reflection)
+      qtn = reflection.table_name
+      window = ActiveArchive.configuration.dependent_record_window
+      query = "#{qtn}.archived_at > ? AND #{qtn}.archived_at < ?"
 
-        associated_class = association.class
+      send(name).unscope(where: :archived_at)
+                .where(query, archived_at - window, archived_at + window)
+    end
 
-        yield(associated_class, reflection.counter_cache_column, send(reflection.foreign_key))
+    def unarchive_destroyed_dependent_records(force = nil)
+      destroyed_dependent_relations.each do |relation|
+        relation.to_a.each do |destroyed_dependent_record|
+          destroyed_dependent_record.try(:unarchive, force)
+        end
       end
-    end
 
-    def retrieve_archived_record
-      self.class.unscoped.find(id)
+      reload
     end
 
     # rubocop:disable Metrics/AbcSize
-    def retrieve_dependent_records
-      dependent_records = {}
-
-      self.class.reflections.each do |key, ref|
-        next unless ref.options[:dependent] == :destroy
+    def destroyed_dependent_relations
+      dependent_permanent_reflections(self.class).map do |name, relation|
+        case relation.macro.to_s.gsub('has_', '').to_sym
+        when :many
+          if archived_at
+            add_record_window(send(name), name, relation)
+          else
+            send(name).unscope(where: :archived_at)
+          end
+        when :one, :belongs_to
+          self.class.unscoped { Array(send(name)) }
+        end
+      end
+    end
+    # rubocop:enable Metrics/AbcSize
 
-        records = send(key)
-        next unless records
-        records.respond_to?(:empty?) ? (next if records.empty?) : (records = [] << records)
+    def attempt_notifying_observers(callback)
+      notify_observers(callback)
+    rescue NoMethodError
+      # do nothing
+    end
 
-        dependent_record = records.first
-        dependent_record.nil? ? next : dependent_records[dependent_record.class] = records.map(&:id)
+    def dependent_record_ids
+      dependent_reflections(self.class).reduce({}) do |records, (key, _)|
+        found = Array(send(key)).compact
+        next records if found.empty?
+        records.update(found.first.class => found.map(&:id))
       end
+    end
 
-      dependent_records
+    def permanently_delete_records_after(&block)
+      dependent_records = dependent_record_ids
+      result = yield(block)
+      permanently_delete_records(dependent_records) if result
+      result
     end
-    # rubocop:enable Metrics/AbcSize
 
     def permanently_delete_records(dependent_records)
       dependent_records.each do |klass, ids|
@@ -125,89 +191,18 @@ module ActiveArchive
       end
     end
 
-    def permanently_delete_records_after(&block)
-      dependent_records = retrieve_dependent_records
-      dependent_results = yield(block)
-      permanently_delete_records(dependent_records) if dependent_results
-      dependent_results
-    end
-
-    def unarchival
-      [
-        ->(validate) { unarchive_destroyed_dependent_records(validate) },
-        lambda do |validate|
-          run_callbacks(:unarchive) do
-            set_archived_at(nil, validate)
-            each_counter_cache do |assoc_class, counter_cache_column, assoc_id|
-              assoc_class.increment_counter(counter_cache_column, assoc_id)
-            end
-            return(true)
-          end
-        end
-      ]
-    end
-
-    # rubocop:disable Metrics/LineLength
-    def dependent_records_for_unarchival(name, reflection)
-      record = send(name)
-
-      case reflection.macro.to_s.gsub('has_', '').to_sym
-      when :many
-        records = archived_at ? set_record_window(record, name, reflection) : record.unscope(where: :archived_at)
-      when :one, :belongs_to
-        self.class.unscoped { records = [] << record }
+    def dependent_reflections(klass)
+      klass.reflections.select do |_, reflection|
+        reflection.options[:dependent] == :destroy
       end
-
-      [records].flatten.compact
     end
-    # rubocop:enable Metrics/LineLength
 
-    def unarchive_destroyed_dependent_records(force = nil)
-      self.class.reflections
-          .select { |_, ref| ref.options[:dependent].to_s == 'destroy' && ref.klass.archivable? }
-          .each do |name, ref|
-            dependent_records_for_unarchival(name, ref).each { |rec| rec.try(:unarchive, force) }
-            reload
-          end
-    end
-
-    def set_archived_at(value, force = nil)
-      return self unless archivable?
-      record = retrieve_archived_record
-      record.archived_at = value
-
-      begin
-        should_ignore_validations?(force) ? record.save(validate: false) : record.save!
-
-        if ::ActiveRecord::VERSION::MAJOR >= 5 && ::ActiveRecord::VERSION::MINOR >= 2
-          @mutations_before_last_save = record.send(:mutations_from_database)
-          @attributes_changed_by_setter = HashWithIndifferentAccess.new
-        elsif ::ActiveRecord::VERSION::MAJOR >= 5
-          @previous_mutation_tracker = record.send(:previous_mutation_tracker)
-        elsif ::ActiveRecord::VERSION::MAJOR >= 4
-          @previously_changed = record.instance_variable_get('@previously_changed')
-        end
-
-        @changed_attributes = HashWithIndifferentAccess.new
-        @attributes = record.instance_variable_get('@attributes')
-        @mutation_tracker = nil
-        @mutations_from_database = nil
-      rescue => error
-        record.destroy
-        raise(error)
+    def dependent_permanent_reflections(klass)
+      dependent_reflections(klass).select do |_name, reflection|
+        reflection.klass.archivable?
       end
     end
 
-    def set_record_window(_, name, reflection)
-      qtn = reflection.table_name
-      window = ActiveArchive.configuration.dependent_record_window
-
-      query = "#{qtn}.archived_at > ? AND #{qtn}.archived_at < ?"
-
-      send(name).unscope(where: :archived_at)
-                .where([query, archived_at - window, archived_at + window])
-    end
-
     def should_force_destroy?(force)
       force.is_a?(Hash) ? force[:force] : (force == :force)
     end

data/lib/active_archive/methods.rb

@@ -8,12 +8,20 @@ module ActiveArchive
     end
 
     def archive_all(conditions = nil)
-      conditions ? where(conditions).destroy_all : destroy_all
+      (conditions ? where(conditions) : all).to_a.each(&:archive)
     end
 
+    def archive_all!(conditions = nil)
+      (conditions ? where(conditions) : all).to_a.each { |r| r.send(:archive, :force) }
+    end
+
+    alias_method :destroy_all!, :archive_all!
+
     def unarchive_all(conditions = nil)
       (conditions ? where(conditions) : all).to_a.each(&:unarchive)
     end
 
+    alias_method :undestroy_all, :unarchive_all
+
   end
 end

data/lib/active_archive/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActiveArchive
-  VERSION ||= '5.1.7'
+  VERSION ||= '5.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_archive
 version: !ruby/object:Gem::Version
-  version: 5.1.7
+  version: 5.2.0
 platform: ruby
 authors:
 - Juan Gomez
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-04 00:00:00.000000000 Z
+date: 2018-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: database_cleaner
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: fasterer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: generator_spec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: database_cleaner
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: generator_spec
+  name: reek
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: fasterer
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -123,7 +123,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: reek
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -137,7 +137,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -160,7 +160,7 @@ files:
 - ".DS_Store"
 - ".fasterer.yml"
 - ".gitignore"
-- ".reek"
+- ".reek.yml"
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"

data/.reek

@@ -1,22 +0,0 @@
----
-Attribute:
-  enabled: false
-DuplicateMethodCall:
-  enabled: false
-FeatureEnvy:
-  enabled: false
-IrresponsibleModule:
-  enabled: false
-ManualDispatch:
-  enabled: false
-NestedIterators:
-  max_allowed_nesting: 2
-NilCheck:
-  enabled: false
-TooManyStatements:
-  max_statements: 10
-  exclude:
-    - 'ActiveArchive::Base#retrieve_dependent_records'
-    - 'ActiveArchive::Base#set_archived_at'
-UtilityFunction:
-  enabled: false