deleted_at 0.5.0 → 0.6.0.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 29aee507393739895b695138545e5c6898c21d95
-  data.tar.gz: f52a30d0f52ae37e24641f4e5a9c74324bc75186
+SHA256:
+  metadata.gz: 5f702112df5aaab3c584dd6cf56a7f106aee39a41e1474d9e676ba0e960b72ab
+  data.tar.gz: 423ac85c6209fe354ead11a2b4b758ddebc5ec151251303cae885e4f72c69075
 SHA512:
-  metadata.gz: 0b5c88eb056b584f4aebcbe24ebf28fd4e84d78dea0d23e39a23d107e48f2f28aac213c5880028bf38896bb395b6ba1e42341665846ec75dd25406afbf237883
-  data.tar.gz: 128097c8e330be5ca187adb07b9f5ce8ef45a819400f9028b364c53a4af71d53bf34c6b7f128c6b9f804ae84c7e3176d8d9e0380f5a1d8e90f504d57b054e57a
+  metadata.gz: 260846b1749da3892ebc80a52b31d00a2a4f3738613bacfda250cd35582925c6795b76be40bdaafa5c5ac52b326e8da7a66af5ab64431ad26128d299735e1436
+  data.tar.gz: 49f6e710ac42079d03e88e993ebf2178c59a4faa189451255e962077c7dfbdaa23146e0028ca327edb0eafc8574296f56b06a27f00fc7e66bb22c397fd200d0f

data/CHANGELOG.md

@@ -0,0 +1,57 @@
+# DeletedAt
+
+## 0.6.0 _(September 4, 2018)_
+- Added support for Rails 5.2
+- Overhauled injection process for cleaner and more reliable sub-selecting
+
+## 0.5.0 _(June 25, 2018)_
+- Removed use of invasive views in preference of sub-selects
+- Dropped support for Ruby 2.0, 2.1, 2.2
+- Dropped support for Rails 4.1
+- Default `deleted_at` options using `Proc`
+
+## 0.4.0 _(Never Released)_
+- Specs for Rails 4.0-5.1
+  - Uses `combustion` gem for cleaner and more comprehensive testing
+- Added badges to ReadMe
+- Using `:prepend` to leverage ancestry chain
+- Add logger for internal use
+- DRYd up init code
+- Removed partially supported features
+- Added DSL in migrations/schema for adding `deleted_at` timestamps to tables
+
+## 0.3.0 _(May 10, 2017)_
+- Add specs
+- Clean up dependencies
+- Auto-init models after installing views
+- Remove chained `create` methods
+
+## 0.2.6 _(April 06, 2017)_
+- Add warning when no DB connection present
+
+## 0.2.5 _(March 28, 2017)_
+- Extract injections to `.load` method
+
+## 0.2.4 _(February 03, 2017)_
+- Use `becomes` to mask `::All` etc classes
+
+## 0.2.3 _(February 03, 2017)_
+- Chain `create!` method to work properly
+
+## 0.2.2 _(February 03, 2017)_
+- Chain `create` method to work properly
+
+## 0.2.1 _(February 03, 2017)_
+- More reliable table name handling
+- Changed API for installing views (e.g. `destroy_deleted_view`, `uninstall_deleted_view`)
+
+## 0.1.1 _(January 31, 2017)_
+- Added instructions to readme
+- Fixes stack-too-deep edge-case (by moving to `:include` over `:prepend`)
+
+## 0.1.0 _(January 30, 2017)_
+- Renames primary table to `model_name/all`
+- Creates views for each model using `deleted_at`
+  - `model_name/deleted`
+  - `model_name/present`
+- Classes created to read from views (`::All`, `::Present`, `::Deleted`)

data/README.md

@@ -1,12 +1,13 @@
-[![Version      ](https://img.shields.io/gem/v/deleted_at.svg?maxAge=2592000)](https://rubygems.org/gems/deleted_at)
-[![Build Status ](https://travis-ci.org/TwilightCoders/deleted_at.svg)](https://travis-ci.org/TwilightCoders/deleted_at)
-[![Code Climate ](https://api.codeclimate.com/v1/badges/762cdcd63990efa768b0/maintainability)](https://codeclimate.com/github/TwilightCoders/deleted_at/maintainability)
-[![Test Coverage](https://codeclimate.com/github/TwilightCoders/deleted_at/badges/coverage.svg)](https://codeclimate.com/github/TwilightCoders/deleted_at/coverage)
-[![Dependencies ](https://badges.depfu.com/badges/5a2fe8068c0eaa5ad0e25a96373f1725/overview.svg)](https://depfu.com/github/TwilightCoders/deleted_at)
+[![License     ](https://img.shields.io/github/license/TwilightCoders/deleted_at.svg)]()
+[![Version     ](https://img.shields.io/gem/v/deleted_at.svg)](https://rubygems.org/gems/deleted_at)
+[![Build Status](https://travis-ci.org/TwilightCoders/deleted_at.svg)](https://travis-ci.org/TwilightCoders/deleted_at)
+[![Maintenence ](https://api.codeclimate.com/v1/badges/762cdcd63990efa768b0/maintainability)](https://codeclimate.com/github/TwilightCoders/deleted_at/maintainability)
+[![Coverage    ](https://codeclimate.com/github/TwilightCoders/deleted_at/badges/coverage.svg)](https://codeclimate.com/github/TwilightCoders/deleted_at/coverage)
+[![Dependencies](https://img.shields.io/librariesio/github/twilightcoders/deleted_at.svg)](https://depfu.com/github/TwilightCoders/deleted_at)
 
 # DeletedAt
 
-Hide your "deleted" data (unless specifically asked for) without resorting to `default_scope` by leveraging in-line sub-selects. (See the [Upgrading](#upgrading) section)
+Hide your "deleted" data (unless specifically asked for) [without resorting to](https://stackoverflow.com/a/25087337/1454158) `default_scope` by leveraging in-line sub-selects. (See the [Upgrading](#upgrading) section)
 
 ## Requirements
 
@@ -46,14 +47,10 @@ To work properly, the tables that back these models must have a `deleted_at` tim
 ```ruby
 class AddDeletedAtColumnToUsers < ActiveRecord::Migration
 
-  def up
+  def change
     add_column :users, :deleted_at, 'timestamp with time zone'
   end
 
-  def down
-    remove_column :users, :deleted_at, 'timestamp with time zone'
-  end
-
 end
 ```
 
@@ -62,7 +59,7 @@ If you're starting with a brand-new table, the existing `timestamps` DSL has bee
 ```ruby
 class CreatCommentsTable < ActiveRecord::Migration
 
-  def up
+  def change
     create_table :comments do |t|
       # ...
       #  to the `timestamps` DSL
@@ -70,19 +67,48 @@ class CreatCommentsTable < ActiveRecord::Migration
     end
   end
 
-  def down
-    drop_table :comments
+end
+```
+
+## Performance
+
+It's recommended (if your database engine supports it) to add partial indexes to the `deleted_at` columns. Remember that indexes work best when they represent a minority of the rows. It's up to you to determine the best index for your table.
+
+Example 1:
+
+You have a thriving business and your customers love your product and _rarely_ delete their account. You're likely to have way fewer rows `WHERE deleted_at IS NOT NULL`.
+
+```ruby
+class IndexDeletedAtColumns < ActiveRecord::Migration
+
+  def change
+    add_index :users, :deleted_at, where: "deleted_at IS NOT NULL"
   end
 
 end
 ```
 
+Example 2:
+
+You use expiring OAuth2 tokens as part of your application's authentication process. As time grows without bound rows `WHERE deleted_at IS NULL` will pale in comparison.
+
+```ruby
+class IndexDeletedAtColumns < ActiveRecord::Migration
+
+  def change
+    add_index :oauth_tokens, :deleted_at, where: "deleted_at IS NULL"
+  end
+
+end
+```
+
+
 ## [Upgrading](#upgrading)
 
 If you've used `deleted_at` prior to v0.5.0, you'll need to migrate your schema. The new version of `deleted_at` no longer uses views, instead constructing a subselect on the relations. This significantly reduces code polution and monkey patching, as well as reducing the runtime memory usage for rails. Your Database will look (and be) a lot cleaner with no `deleted_at` views and your ERDs will be much cleaner as well.
 
 Here is an example of a migration for upgrading
-```
+```ruby
 require 'deleted_at/legacy'
 
 DeletedAt.disable

data/lib/deleted_at.rb

@@ -41,10 +41,10 @@ module DeletedAt
   end
 
   def self.install(model)
-    logger.warn <<-STR
-    Great news! You're using the new and improved version of DeletedAt. No more table renaming.
-    You'll want to migrate your old models to use the new (non-view based) functionality.
-    Follow the instructions at #{gemspec.homepage}.
+    logger.warn <<~STR
+      Great news! You're using the new and improved version of DeletedAt. No more table renaming.
+      You'll want to migrate your old models to use the new (non-view based) functionality.
+      Follow the instructions at #{gemspec.homepage}.
     STR
   end
 

data/lib/deleted_at/active_record.rb

@@ -5,31 +5,49 @@ module DeletedAt
   module ActiveRecord
 
     def self.prepended(subclass)
-      subclass.const_get(:ActiveRecord_Relation).prepend(DeletedAt::Relation)
-      subclass.const_get(:ActiveRecord_AssociationRelation).prepend(DeletedAt::Relation)
+      subclass.init_deleted_at_relations
       subclass.extend(ClassMethods)
     end
 
+    def initialize(*args)
+      super
+      @destroyed = !deleted_at.nil?
+    end
+
+    def destroy
+      soft_delete
+      super
+    end
+
+    def delete
+      soft_delete
+      super
+    end
+
+    private
+
+    def soft_delete
+      update_columns(self.class.deleted_at_attributes)
+      @destroyed = true
+    end
+
     module ClassMethods
 
       def inherited(subclass)
         super
-        subclass.with_deleted_at self.deleted_at
-      end
-
-      def all
-        const_get(:Present)
+        subclass.init_deleted_at_relations
       end
 
       def const_missing(const)
         case const
-        when :All, :Deleted, :Present
-          all_without_deleted_at.tap do |rel|
-            rel.deleted_at_scope = const
+        when :All, :Deleted
+          all.tap do |_query|
+            _query.deleted_at_scope = const
           end
         else super
         end
       end
+
     end
 
   end

data/lib/deleted_at/core.rb

@@ -8,7 +8,6 @@ module DeletedAt
       class << subclass
         cattr_accessor :deleted_at
         self.deleted_at = {}
-        alias all_without_deleted_at all
       end
 
       subclass.extend(ClassMethods)
@@ -43,6 +42,12 @@ module DeletedAt
         }
       end
 
+      def init_deleted_at_relations
+        instance_variable_get(:@relation_delegate_cache).each do |base, klass|
+          klass.send(:prepend, DeletedAt::Relation)
+        end
+      end
+
     end # End ClassMethods
 
   end

data/lib/deleted_at/relation.rb

@@ -1,5 +1,4 @@
 module DeletedAt
-
   module Relation
 
     def self.prepended(subclass)
@@ -15,58 +14,45 @@ module DeletedAt
     def deleted_at_select
       scoped_arel = case deleted_at_scope
       when :Deleted
-        table.where(table[deleted_at[:column]].not_eq(nil))
+        vanilla.dup.where(table[klass.deleted_at[:column]].not_eq(nil))
       when :Present
-        table.where(table[deleted_at[:column]].eq(nil))
+        vanilla.dup.where(table[klass.deleted_at[:column]].eq(nil))
       end
     end
 
+    def vanilla
+      # @vanilla ||= klass.const_get(:All).unscope(:where).freeze
+      @vanilla ||= klass.unscoped.tap do |rel|
+        rel.deleted_at_scope = :All
+      end.freeze
+    end
 
-    def deleted_at_subselect(arel)
+    # Rails 4.x
+    def from_value
       if (subselect = deleted_at_select)
-        subselect.project(arel_columns(columns.map(&:name)))
-        Arel::Nodes::TableAlias.new(Arel::Nodes::Grouping.new(subselect.ast), table_name)
+        [subselect, table_name]
+      else
+        super
       end
     end
 
-    def build_arel
-      super.tap do |arel|
-        if (subselect = deleted_at_subselect(arel)) && !arel.froms.include?(subselect)
-          DeletedAt.logger.debug("DeletedAt sub-selecting from #{subselect.to_sql}")
-          arel.from(subselect)
-        end
+    # Rails 5.x
+    def from_clause
+      if (subselect = deleted_at_select)
+        ::ActiveRecord::Relation::FromClause.new(subselect, table_name)
+      else
+        super
       end
     end
 
-    # Deletes the records matching +conditions+ without instantiating the records
-    # first, and hence not calling the +destroy+ method nor invoking callbacks. This
-    # is a single SQL DELETE statement that goes straight to the database, much more
-    # efficient than +destroy_all+. Be careful with relations though, in particular
-    # <tt>:dependent</tt> rules defined on associations are not honored. Returns the
-    # number of rows affected.
-    #
-    #   Post.delete_all("person_id = 5 AND (category = 'Something' OR category = 'Else')")
-    #   Post.delete_all(["person_id = ? AND (category = ? OR category = ?)", 5, 'Something', 'Else'])
-    #   Post.where(person_id: 5).where(category: ['Something', 'Else']).delete_all
-    #
-    # Both calls delete the affected posts all at once with a single DELETE statement.
-    # If you need to destroy dependent associations or call your <tt>before_*</tt> or
-    # +after_destroy+ callbacks, use the +destroy_all+ method instead.
-    #
-    # If an invalid method is supplied, +delete_all+ raises an ActiveRecord error:
-    #
-    #   Post.limit(100).delete_all
-    #   # => ActiveRecord::ActiveRecordError: delete_all doesn't support limit
     def delete_all(*args)
-      conditions = args.pop
-      if conditions
-        ActiveSupport::Deprecation.warn(<<-MESSAGE.squish)
+      if args.pop
+        ActiveSupport::Deprecation.warn(<<~STR)
           Passing conditions to delete_all is not supported in DeletedAt
           To achieve the same use where(conditions).delete_all.
-        MESSAGE
+        STR
       end
       update_all(klass.deleted_at_attributes)
     end
   end
-
 end

data/lib/deleted_at/version.rb

@@ -1,3 +1,3 @@
 module DeletedAt
-  VERSION = "0.5.0"
+  VERSION = "0.6.0-1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deleted_at
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0.pre.1
 platform: ruby
 authors:
 - Dale Stevens
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-25 00:00:00.000000000 Z
+date: 2018-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
         version: '6'
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
         version: '6'
@@ -136,12 +136,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2.1
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Soft delete your data, but keep it clean.