permanent_records 4.2.7 → 4.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4bdca6f3d0ced279ab4cad8b9d83bd23cb2e2725
-  data.tar.gz: c9c53f6405d8a4146872ec0f52bee8f8b8741ea0
+SHA256:
+  metadata.gz: 2a557f2f7f287f2cbd1990950e869d2a943e5c8593df0dbd41520790d049f3b0
+  data.tar.gz: 8ebc139901710c0599e36873217a70ad936918a1dbf93520797099b2c7e8e40d
 SHA512:
-  metadata.gz: c672b6118fbc111d523d6f3e5a252610383a9a9c8ffb3e047920c4c9c3dcb0d68a418f87c27c4b5c6891f4107f77d95a8612e343f64df80bd31b4ee388a3f311
-  data.tar.gz: 61e651908d6acf7674661c5fd3e0b3b2140efd89686ee1e089a7664a5dcc4da1019a5d9beb3ebd9add1a13b0de392557e733a367e1df2e7e694c743109f4a4ec
+  metadata.gz: 0d547b27a573c1abdc3a85c7803d56452f95c8a8a6f485476f52e18d2173ad67e25e5b9904ad4b9fe6a22fdecaf9ba57b1866a432f940917841202ace3fc9c0a
+  data.tar.gz: e4a8d014f056e37ef0e941cc52251c63acc935051e5103822dd7f8942ce9c086bbad6fc0a20ce687c0f8e35d5d48b12dd2affbf859baab89e83318c6c49f6ca1

data/.rubocop.yml

@@ -1,6 +1,12 @@
+inherit_from: .rubocop_todo.yml
+
 AllCops:
   Exclude:
     - bin/*
+  TargetRubyVersion: 2.0
+
+Metrics/BlockLength:
+  Enabled: false
 
 Metrics/LineLength:
   Max: 120

data/.rubocop_todo.yml

@@ -0,0 +1,12 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2019-10-09 11:48:30 +0200 using RuboCop version 0.50.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 15
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - 'spec/permanent_records_spec.rb'

data/.travis.yml

@@ -1,8 +1,8 @@
 language: ruby
 rvm:
-  - 2.0.0
-  - 2.2.2
-  - 2.3.0
+  - 2.0.0-p648
+  - 2.2.10
+  - 2.3.8
 env:
   - AR_TEST_VERSION: 4.2.0
-  - AR_TEST_VERSION: 4.2.5
+  - AR_TEST_VERSION: 4.2.11.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at permanentrecords@jackcanty.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/README.md

@@ -1,4 +1,4 @@
-# PermanentRecords (Rails 3.1+)
+# PermanentRecords (Rails 4.2)
 
 [http://github.com/JackDanger/permanent_records/](http://github.com/JackDanger/permanent_records/)
 

data/README.rst

@@ -0,0 +1,115 @@
+PermanentRecords (Rails 4.2)
+=============================
+
+http://github.com/JackDanger/permanent_records/
+
+This gem prevents any of your ActiveRecord data from being destroyed.
+Any model that you've given a "deleted\_at" datetime column will have
+that column set rather than let the record be deleted.
+
+What methods does it give me?
+-----------------------------
+
+.. code:: ruby
+
+    User.find(3).destroy          # Sets the 'deleted_at' attribute to Time.now
+                                  # and returns a frozen record. If halted by a
+                                  # before_destroy callback it returns false instead
+
+    User.find(3).destroy(:force)  # Executes the real destroy method, the record
+                                  # will be removed from the database.
+
+    User.destroy_all              # Soft-deletes all User records.
+
+    User.delete_all               # bye bye everything (no soft-deleting here)
+
+There are also two scopes provided for easily searching deleted and not
+deleted records:
+
+.. code:: ruby
+
+    User.deleted.find(...)        # Only returns deleted records.
+
+    User.not_deleted.find(...)    # Only returns non-deleted records.
+
+Note: Your normal finds will, by default, *include* deleted records.
+You'll have to manually use the ``not_deleted`` scope to avoid this:
+
+.. code:: ruby
+
+    User.find(1)                  # Will find record number 1, even if it's deleted.
+
+    User.not_deleted.find(1)      # This is probably what you want, it doesn't find deleted records.
+
+Can I easily undelete records?
+------------------------------
+
+Yes. All you need to do is call the 'revive' method.
+
+.. code:: ruby
+
+    User.find(3).destroy         # The user is now deleted.
+
+    User.find(3).revive          # The user is back to it's original state.
+
+And if you had dependent records that were set to be destroyed along
+with the parent record:
+
+.. code:: ruby
+
+    class User < ActiveRecord::Base
+      has_many :comments, :dependent => :destroy
+    end
+
+    User.find(3).destroy         # All the comments are destroyed as well.
+
+    User.find(3).revive          # All the comments that were just destroyed
+                                 # are now back in pristine condition.
+
+Forcing deletion works the same way: if you hard delete a record, its
+dependent records will also be hard deleted.
+
+Can I use default scopes?
+-------------------------
+
+.. code:: ruby
+
+    default_scope where(:deleted_at => nil)
+
+If you use such a default scope, you will need to simulate the
+``deleted`` scope with a method
+
+.. code:: ruby
+
+    def self.deleted
+      self.unscoped.where('deleted_at IS NOT NULL')
+    end
+
+Is Everything Automated?
+------------------------
+
+Yes. You don't have to change ANY of your code to get permanent
+archiving of all your data with this gem. When you call ``destroy`` on
+any record (or ``destroy_all`` on a class or association) your records
+will all have a deleted\_at timestamp set on them.
+
+Upgrading from 3.x
+------------------
+
+The behaviour of the ``destroy`` method has been updated so that it now
+returns ``false`` when halted by a before\_destroy callback. This is in
+line with behaviour of ActiveRecord. For more information see
+`#47 <https://github.com/JackDanger/permanent_records/issues/47>`__.
+
+Productionizing
+---------------
+
+If you operate a system where destroying or reviving a record takes more
+than about 3 seconds then you'll want to customize
+``PermanentRecords.dependent_record_window = 10.seconds`` or some other
+value that works for you.
+
+Patches welcome, forks celebrated.
+
+Copyright 2015 Jack Danger Canty @ https://jdanger.com released under
+the MIT license

data/Rakefile

@@ -33,7 +33,11 @@ RSpec::Core::RakeTask.new(:rspec) do |t|
   t.rspec_opts = '-f d -c'
 end
 
-task publish: [:rubocop, :rspec] do
+task :pandoc do
+  system('pandoc -s -r markdown -w rst README.md -o README.rst')
+end
+
+task publish: %i[pandoc rubocop rspec] do
   # Ensure the gem builds
   system('gem build permanent_records.gemspec') &&
     # And we didn't leave anything (aside from the gem) uncommitted
@@ -42,4 +46,4 @@ task publish: [:rubocop, :rspec] do
     system("gem push permanent_records-#{version}.gem")
 end
 
-task default: [:rspec, :rubocop]
+task default: %i[rspec rubocop]

data/VERSION

@@ -1 +1 @@
-4.2.7
+4.2.8

data/lib/permanent_records.rb

@@ -22,7 +22,7 @@ module PermanentRecords
       end
     end
 
-    def is_permanent? # rubocop:disable Style/PredicateName
+    def is_permanent? # rubocop:disable Naming/PredicateName
       respond_to?(:deleted_at)
     end
 
@@ -76,11 +76,12 @@ module PermanentRecords
       ]
     end
 
-    def get_deleted_record # rubocop:disable Style/AccessorMethodName
+    def get_deleted_record # rubocop:disable Naming/AccessorMethodName
       self.class.unscoped.find(id)
     end
 
     # rubocop:disable Metrics/MethodLength
+    # rubocop:disable Lint/RescueWithoutErrorClass
     def set_deleted_at(value, force = nil)
       return self unless is_permanent?
       record = get_deleted_record
@@ -104,10 +105,12 @@ module PermanentRecords
         raise e
       end
     end
+    # rubocop:enable Lint/RescueWithoutErrorClass
+    # rubocop:enable Metrics/MethodLength
 
     def each_counter_cache
       _reflections.each do |name, reflection|
-        association = send(name.to_sym)
+        association = respond_to?(name.to_sym) ? send(name.to_sym) : nil
         next if association.nil?
         next unless reflection.belongs_to? && reflection.counter_cache_column
 
@@ -119,6 +122,7 @@ module PermanentRecords
       end
     end
 
+    # rubocop:disable Metrics/MethodLength
     def destroy_with_permanent_records(force = nil)
       run_callbacks(:destroy) do
         if deleted? || new_record?
@@ -134,6 +138,7 @@ module PermanentRecords
       end
       deleted? ? self : false
     end
+    # rubocop:enable Metrics/MethodLength
 
     def add_record_window(_request, name, reflection)
       send(name).unscope(where: :deleted_at).where(
@@ -157,6 +162,7 @@ module PermanentRecords
       reload
     end
 
+    # rubocop:disable Metrics/MethodLength
     def destroyed_dependent_relations
       PermanentRecords.dependent_permanent_reflections(self.class).map do |name, relation|
         cardinality = relation.macro.to_s.gsub('has_', '').to_sym
@@ -172,6 +178,7 @@ module PermanentRecords
         end
       end
     end
+    # rubocop:enable Metrics/MethodLength
 
     def attempt_notifying_observers(callback)
       notify_observers(callback)
@@ -231,8 +238,8 @@ module PermanentRecords
 
   # Included into ActiveRecord for all models
   module IsPermanent
-    def is_permanent? # rubocop:disable Style/PredicateName
-      columns.detect { |c| 'deleted_at' == c.name }
+    def is_permanent? # rubocop:disable Naming/PredicateName
+      columns.detect { |c| c.name == 'deleted_at' }
     end
   end
 
@@ -240,16 +247,16 @@ module PermanentRecords
     if force.is_a?(Hash)
       force[:force]
     else
-      :force == force
+      force == :force
     end
   end
 
   def self.should_revive_parent_first?(order)
-    order.is_a?(Hash) && true == order[:reverse]
+    order.is_a?(Hash) && order[:reverse] == true
   end
 
   def self.should_ignore_validations?(force)
-    force.is_a?(Hash) && false == force[:validate]
+    force.is_a?(Hash) && force[:validate] == false
   end
 
   def self.dependent_record_window

data/permanent_records.gemspec

@@ -1,4 +1,3 @@
-# encoding: utf-8
 Gem::Specification.new do |s|
   s.name = 'permanent_records'
   s.version = File.read('VERSION')
@@ -8,10 +7,10 @@ Gem::Specification.new do |s|
                'Trond Arve Nordheim', 'Josh Teneycke', 'Maximilian Herold',
                'Hugh Evans', 'Sergey Gnuskov', 'aq', 'Joel AZEMAR']
   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.description = <<-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.
+DESCRIPTION
   s.email = 'github@jackcanty.com'
   s.extra_rdoc_files = [
     'LICENSE',
@@ -27,12 +26,12 @@ EOS
   ver = ENV['AR_TEST_VERSION']
   ver = ver.dup.chomp if ver
 
-  s.add_runtime_dependency('activerecord',  ver || '>= 4.2.0')
-  s.add_runtime_dependency('activesupport', ver || '>= 4.2.0')
-  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', '~> 3.5.0')
-  s.add_development_dependency('rubocop', '0.42.0')
-  s.add_development_dependency('sqlite3')
+  s.add_runtime_dependency 'activerecord',  ver || '>= 4.2.0'
+  s.add_runtime_dependency 'activesupport', ver || '>= 4.2.0'
+  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', '>= 3.5.0'
+  s.add_development_dependency 'rubocop', '~> 0.50.0' # freeze to ensure ruby 2.0 compatibility
+  s.add_development_dependency 'sqlite3', '~> 1.3.6' # freeze to ensure specs are working
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: permanent_records
 version: !ruby/object:Gem::Version
-  version: 4.2.7
+  version: 4.2.8
 platform: ruby
 authors:
 - Jack Danger Canty
@@ -17,36 +17,36 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-22 00:00:00.000000000 Z
+date: 2019-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: 4.2.11.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: 4.2.11.1
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: 4.2.11.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: 4.2.11.1
 - !ruby/object:Gem::Dependency
   name: database_cleaner
   requirement: !ruby/object:Gem::Requirement
@@ -93,47 +93,47 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.5.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.42.0
+        version: 0.50.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.42.0
+        version: 0.50.0
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        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.
+        version: 1.3.6
+description: |2
+      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: []
@@ -144,11 +144,14 @@ files:
 - ".document"
 - ".gitignore"
 - ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".travis.yml"
+- CODE_OF_CONDUCT.md
 - CONTRIBUTORS.md
 - Gemfile
 - LICENSE
 - README.md
+- README.rst
 - Rakefile
 - VERSION
 - bin/rspec
@@ -174,10 +177,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Soft-delete your ActiveRecord records
 test_files: []
-has_rdoc: