permanent_records 4.1.0 → 4.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b06f61ce3509014ff0b75f3d8cc1377a96c46ba3
-  data.tar.gz: de86eadce595b382db87f524ecadf2555b6b2f77
+  metadata.gz: 8fc77ef2eb0c9943d477c2bb228a11d31c1fd0a7
+  data.tar.gz: 748645f6c54d8f067c20c494ed451d9cdccaffd3
 SHA512:
-  metadata.gz: a57f2492aa6117680c5b018e7887a840daf17ebd2b11b857ab7f6ef77858e223ab078ee0eb1b075873fef321135c097a8870349b2c1dcaa9ac23a35cc657ea71
-  data.tar.gz: f188ea9d53635618d4baa67daedf8afe5be7b6f7021952482e41d483f91343b063b07bfd8d976b0da30cc5af9c10054b0426487537cc8945ebc4051b7a676c4b
+  metadata.gz: c72d7ef29d6a675e511d67194a265c6b2b183a7d629deed3fc63b9e911a75dbd8b59c2a7e57c81cd15d9c12af6a8f4a6115b9fe5b6cbf059139c3ee8465c7dcf
+  data.tar.gz: 925ce8fe43fae831d5bd73291bce29d9d0d6747c89d6a08e2d2b49239b27c328352576c73a4f3afb4c1bdae82974ba955a94fe3e7ee9c3e6d262c23eaa0421f8

data/.travis.yml

@@ -2,6 +2,7 @@ language: ruby
 rvm:
   - 2.0.0
   - 2.2.2
+  - 2.3.0
 env:
   - AR_TEST_VERSION: 4.2.0
   - AR_TEST_VERSION: 4.2.5

data/Rakefile

@@ -1,16 +1,19 @@
 require 'bundler'
 require 'yaml'
+require 'English'
 Bundler::GemHelper.install_tasks
 
-$config = YAML::load_file File.expand_path('spec/support/database.yml', File.dirname(__FILE__))
+CONFIG = YAML.load_file(
+  File.expand_path('spec/support/database.yml', File.dirname(__FILE__))
+)
 
 def test_database_exists?
-  system "psql -l | grep -q #{$config['test'][:database]}"
-  $?.success?
+  system "psql -l | grep -q #{CONFIG['test'][:database]}"
+  $CHILD_STATUS.success?
 end
 
 def create_test_database
-  system "createdb #{$config['test'][:database]}"
+  system "createdb #{CONFIG['test'][:database]}"
 end
 
 namespace :db do
@@ -19,9 +22,13 @@ namespace :db do
   end
 end
 
-task :default => [:spec]
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
 
 desc 'Run all tests'
-task :spec => 'db:create' do
+task spec: 'db:create' do
   exec 'rspec'
 end
+
+task default: [:spec, :rubocop]
+

data/VERSION

@@ -1 +1 @@
-4.1.0
+4.1.1

data/ci

@@ -3,5 +3,5 @@ for version in `grep AR_TEST_VERSION .travis.yml | awk '{print $3}'`; do
   export AR_TEST_VERSION=$version
   echo "Testing against ActiveRecord $version"
   bundle
-  bundle exec rspec
+  bundle exec rake
 done

data/lib/permanent_records.rb

@@ -1,40 +1,47 @@
+# PermanentRecords works with ActiveRecord to set deleted_at columns with a
+# timestamp reflecting when a record was 'deleted' instead of actually deleting
+# the record. All dependent records and associations are treated exactly as
+# you'd expect: If there's a deleted_at column then the record is preserved,
+# otherwise it's deleted.
 module PermanentRecords
-
   # This module defines the public api that you can
   # use in your model instances.
   #
   # * is_permanent? #=> true/false, depending if you have a deleted_at column
   # * deleted?      #=> true/false, depending if you've called .destroy
-  # * destroy       #=> sets deleted_at, your record is now in the .destroyed scope
+  # * destroy       #=> sets deleted_at, your record is now in
+  #                     the .destroyed scope
   # * revive        #=> undo the destroy
-  module ActiveRecord
+  module ActiveRecord # rubocop:disable Metrics/ModuleLength
     def self.included(base)
-
       base.extend Scopes
       base.extend IsPermanent
 
       base.instance_eval do
         define_model_callbacks :revive
-
-        before_revive :revive_destroyed_dependent_records
       end
     end
 
-    def is_permanent?
+    def is_permanent? # rubocop:disable Style/PredicateName
       respond_to?(:deleted_at)
     end
 
     def deleted?
       if is_permanent?
-        !!deleted_at
+        !!deleted_at # rubocop:disable Style/DoubleNegation
       else
         destroyed?
       end
     end
 
-    def revive(validate = nil)
+    def revive(options = nil)
       with_transaction_returning_status do
-        run_callbacks(:revive) { set_deleted_at(nil, validate) }
+        if PermanentRecords.should_revive_parent_first?(options)
+          revival.reverse
+        else
+          revival
+        end.each { |p| p.call(options) }
+
         self
       end
     end
@@ -51,23 +58,46 @@ module PermanentRecords
 
     private
 
+    def revival
+      [
+        lambda do |validate|
+          revive_destroyed_dependent_records(validate)
+        end,
+        lambda do |validate|
+          run_callbacks(:revive) { set_deleted_at(nil, validate) }
+        end
+      ]
+    end
+
+    # rubocop:disable Style/AccessorMethodName
+    def get_deleted_record
+      # Looking for parent on STI case
+      if respond_to?(:parent_id) && parent_id.present?
+        self.class.unscoped.find(parent_id)
+      else
+        self.class.unscoped.find(id)
+      end
+    end
+
+    # rubocop:disable Metrics/MethodLength
     def set_deleted_at(value, force = nil)
       return self unless is_permanent?
-      record = self.class.unscoped.find(id)
+      record = get_deleted_record
       record.deleted_at = value
       begin
-        # we call save! instead of update_attribute so an ActiveRecord::RecordInvalid
-        # error will be raised if the record isn't valid. (This prevents reviving records that
-        # disregard validation constraints,)
+        # we call save! instead of update_attribute so an
+        # ActiveRecord::RecordInvalid error will be raised if the record isn't
+        # valid. (This prevents reviving records that disregard validation
+        # constraints,)
         if PermanentRecords.should_ignore_validations?(force)
-          record.save(:validate => false)
+          record.save(validate: false)
         else
           record.save!
         end
         @attributes = record.instance_variable_get('@attributes')
-      rescue Exception => e
-        # trigger dependent record destruction (they were revived before this record,
-        # which cannot be revived due to validations)
+      rescue => e
+        # trigger dependent record destruction (they were revived before this
+        # record, which cannot be revived due to validations)
         record.destroy
         raise e
       end
@@ -81,28 +111,36 @@ module PermanentRecords
       deleted? ? self : false
     end
 
-    def revive_destroyed_dependent_records
-      self.class.reflections.select do |name, reflection|
-        'destroy' == reflection.options[:dependent].to_s && reflection.klass.is_permanent?
-      end.each do |name, reflection|
-        cardinality = reflection.macro.to_s.gsub('has_', '')
-        if cardinality == 'many'
-          records = send(name).unscoped.where(
-            [
-              "#{reflection.quoted_table_name}.deleted_at > ?" +
-              " AND " +
-              "#{reflection.quoted_table_name}.deleted_at < ?",
-              deleted_at - PermanentRecords.dependent_record_window,
-              deleted_at + PermanentRecords.dependent_record_window
-            ]
-          )
-        elsif cardinality == 'one' or cardinality == 'belongs_to'
-          self.class.unscoped do
-            records = [] << send(name)
+    def add_record_window(_request, name, reflection)
+      send(name).unscope(where: :deleted_at).where(
+        [
+          "#{reflection.quoted_table_name}.deleted_at > ?" \
+          ' AND ' \
+          "#{reflection.quoted_table_name}.deleted_at < ?",
+          deleted_at - PermanentRecords.dependent_record_window,
+          deleted_at + PermanentRecords.dependent_record_window
+        ]
+      )
+    end
+
+    # TODO: Feel free to refactor this without polluting the ActiveRecord
+    # namespace.
+    # rubocop:disable Metrics/AbcSize
+    def revive_destroyed_dependent_records(force = nil)
+      PermanentRecords.dependent_permanent_reflections(self.class)
+                      .each do |name, reflection|
+        cardinality = reflection.macro.to_s.gsub('has_', '').to_sym
+        case cardinality
+        when :many
+          if deleted_at
+            add_record_window(send(name), name, reflection)
+          else
+            send(name)
           end
-        end
-        [records].flatten.compact.each do |dependent|
-          dependent.revive
+        when :one, :belongs_to
+          self.class.unscoped { Array(send(name)) }
+        end.to_a.flatten.compact.each do |dependent|
+          dependent.revive(force)
         end
 
         # and update the reflection cache
@@ -111,46 +149,34 @@ module PermanentRecords
     end
 
     def attempt_notifying_observers(callback)
-      begin
-        notify_observers(callback)
-      rescue NoMethodError => e
-        # do nothing: this model isn't being observed
-      end
+      notify_observers(callback)
+    rescue NoMethodError # rubocop:disable Lint/HandleExceptions
+      # do nothing: this model isn't being observed
     end
 
-    # return the records corresponding to an association with the `:dependent => :destroy` option
-    def get_dependent_records
-      dependent_records = {}
-
+    # return the records corresponding to an association with the `:dependent
+    # => :destroy` option
+    def dependent_record_ids
       # check which dependent records are to be destroyed
-      klass = self.class
-      klass.reflections.each do |key, reflection|
-        if reflection.options[:dependent] == :destroy
-          next unless records = self.send(key) # skip if there are no dependent record instances
-          if records.respond_to? :size
-            next unless records.size > 0 # skip if there are no dependent record instances
-          else
-            records = [] << records
-          end
-          dependent_record = records.first
-          next if dependent_record.nil?
-          dependent_records[dependent_record.class] = records.map(&:id)
-        end
-      end
-      dependent_records
-    end
-
-    # If we force the destruction of the record, we will need to force the destruction of dependent records if the
-    # user specified `:dependent => :destroy` in the model.
-    # By default, the call to super/destroy_with_permanent_records (i.e. the &block param) will only soft delete
-    # the dependent records; we keep track of the dependent records
-    # that have `:dependent => :destroy` and call destroy(force) on them after the call to super
-    def permanently_delete_records_after(&block)
-      dependent_records = get_dependent_records
-      result = block.call
-      if result
-        permanently_delete_records(dependent_records)
+      PermanentRecords.dependent_reflections(self.class)
+                      .reduce({}) do |records, (key, _)|
+        found = Array(send(key)).compact
+        next records unless found.size > 0
+        records.update found.first.class => found.map(&:id)
       end
+    end
+
+    # If we force the destruction of the record, we will need to force the
+    # destruction of dependent records if the user specified `:dependent =>
+    # :destroy` in the model.  By default, the call to
+    # super/destroy_with_permanent_records (i.e. the &block param) will only
+    # soft delete the dependent records; we keep track of the dependent records
+    # that have `:dependent => :destroy` and call destroy(force) on them after
+    # the call to super
+    def permanently_delete_records_after(&_block)
+      dependent_records = dependent_record_ids
+      result = yield
+      permanently_delete_records(dependent_records) if result
       result
     end
 
@@ -158,11 +184,8 @@ module PermanentRecords
     def permanently_delete_records(dependent_records)
       dependent_records.each do |klass, ids|
         ids.each do |id|
-          record = begin
-            klass.unscoped.find id
-          rescue ::ActiveRecord::RecordNotFound
-            next # the record has already been deleted, possibly due to another association with `:dependent => :destroy`
-          end
+          record = klass.unscoped.where(klass.primary_key => id).first
+          next unless record
           record.deleted_at = nil
           record.destroy(:force)
         end
@@ -170,6 +193,7 @@ module PermanentRecords
     end
   end
 
+  # ActiveRelation scopes
   module Scopes
     def deleted
       where arel_table[:deleted_at].not_eq(nil)
@@ -180,22 +204,27 @@ module PermanentRecords
     end
   end
 
+  # Included into ActiveRecord for all models
   module IsPermanent
-    def is_permanent?
-      columns.detect {|c| 'deleted_at' == c.name}
+    def is_permanent? # rubocop:disable Style/PredicateName
+      columns.detect { |c| 'deleted_at' == c.name }
     end
   end
 
   def self.should_force_destroy?(force)
-    if Hash === force
+    if force.is_a?(Hash)
       force[:force]
     else
       :force == force
     end
   end
 
+  def self.should_revive_parent_first?(order)
+    order.is_a?(Hash) && true == order[:reverse]
+  end
+
   def self.should_ignore_validations?(force)
-    Hash === force && false == force[:validate]
+    force.is_a?(Hash) && false == force[:validate]
   end
 
   def self.dependent_record_window
@@ -205,7 +234,19 @@ module PermanentRecords
   def self.dependent_record_window=(time_value)
     @dependent_record_window = time_value
   end
+
+  def self.dependent_reflections(klass)
+    klass.reflections.select do |_, reflection|
+      # skip if there are no dependent record instances
+      reflection.options[:dependent] == :destroy
+    end
+  end
+
+  def self.dependent_permanent_reflections(klass)
+    dependent_reflections(klass).select do |_name, reflection|
+      reflection.klass.is_permanent?
+    end
+  end
 end
 
 ActiveRecord::Base.send :include, PermanentRecords::ActiveRecord
-

data/permanent_records.gemspec

@@ -1,20 +1,27 @@
 # encoding: utf-8
 Gem::Specification.new do |s|
-  s.name = "permanent_records"
+  s.name = 'permanent_records'
   s.version = File.read('VERSION')
   s.license = 'MIT'
 
-  s.authors = ["Jack Danger Canty", "David Sulc", "Joe Nelson", "Trond Arve Nordheim", "Josh Teneycke", "Maximilian Herold", "Hugh Evans"]
-  s.summary = "Soft-delete your ActiveRecord records"
-  s.description = "Never Lose Data. Rather than deleting rows this sets Record#deleted_at and gives you all the scopes you need to work with your data."
-  s.email = "github@jackcanty.com"
+  s.authors = ['Jack Danger Canty', 'David Sulc', 'Joe Nelson',
+               'Trond Arve Nordheim', 'Josh Teneycke', 'Maximilian Herold',
+               'Hugh Evans']
+  s.summary = 'Soft-delete your ActiveRecord records'
+  s.description = <<-EOS
+Never Lose Data. Rather than deleting rows this sets Record#deleted_at and
+gives you all the scopes you need to work with your data.
+EOS
+  s.email = 'github@jackcanty.com'
   s.extra_rdoc_files = [
-    "LICENSE",
-    "README.md"
+    'LICENSE',
+    'README.md'
   ]
-  s.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  s.homepage = "https://github.com/JackDanger/permanent_records"
-  s.require_paths = ["lib"]
+  s.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  s.homepage = 'https://github.com/JackDanger/permanent_records'
+  s.require_paths = ['lib']
 
   # For testing against multiple AR versions
   ver = ENV['AR_TEST_VERSION']
@@ -22,10 +29,10 @@ Gem::Specification.new do |s|
 
   s.add_runtime_dependency('activerecord',  ver || '>= 4.2.0')
   s.add_runtime_dependency('activesupport', ver || '>= 4.2.0')
-  s.add_development_dependency('rake') # For Travis-ci
-  s.add_development_dependency('sqlite3')
-  s.add_development_dependency('pry-byebug')
   s.add_development_dependency('database_cleaner', '>= 1.5.1')
+  s.add_development_dependency('pry-byebug')
+  s.add_development_dependency('rake') # For Travis-ci
   s.add_development_dependency('rspec', '~> 2.14.1')
+  s.add_development_dependency('rubocop')
+  s.add_development_dependency('sqlite3')
 end
-

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: permanent_records
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 4.1.1
 platform: ruby
 authors:
 - Jack Danger Canty
@@ -14,7 +14,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-14 00:00:00.000000000 Z
+date: 2016-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -45,21 +45,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 4.2.0
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: database_cleaner
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.5.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.5.1
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -73,7 +73,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry-byebug
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -87,35 +87,50 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: database_cleaner
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+- !ruby/object:Gem::Dependency
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.1
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.1
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.14.1
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.14.1
-description: Never Lose Data. Rather than deleting rows this sets Record#deleted_at
-  and gives you all the scopes you need to work with your data.
+        version: '0'
+description: |
+  Never Lose Data. Rather than deleting rows this sets Record#deleted_at and
+  gives you all the scopes you need to work with your data.
 email: github@jackcanty.com
 executables: []
 extensions: []
@@ -155,8 +170,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Soft-delete your ActiveRecord records
 test_files: []
+has_rdoc: