sequel-paranoid 0.6.2 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 00ea7005b5cef0b88e4dd80e5592dd83b55ec5ee
-  data.tar.gz: 0754305ae29e1968e0cf9dba290d798e00a1ec1a
+  metadata.gz: e14a35d77873153c4dd8983fb9e338796ccbfab5
+  data.tar.gz: 40feef72715beab3225246870ffdf84e241ed44c
 SHA512:
-  metadata.gz: 0d1c1864e7b354a34bfdaef9c082da089f141e642c0f68ee91e1437a9c875d6f7f3509f862dcbb98f61092e9a23d674276e35dd709f78d5d21c30b7ff8fc7086
-  data.tar.gz: c80715773eda084fc7479794f10b528dfbbbb48696d73cda96de8be8932cb06a9f177d233b6c1b80299afd7a004f3cc3dc9230acf76d33829847b6fcaecb62fa
+  metadata.gz: e84e46393bb292be70bb7c00f9f77a77c7dde85b2468c022f5c66aaa0dabe8fab5a93b2f6744f3a609ae9176b9a7677e35599b55700c5506a2b7ffcaef249470
+  data.tar.gz: 489045f17951b5390d17902511793e14b2d215ed4af44f473baf8598cf1bf2e2da9e8ef7cb39d962b7d73a9ecc3d9bddaed9398caa89e49eb86f5c126802512a

data/lib/sequel/plugins/paranoid.rb

@@ -2,46 +2,115 @@ require 'sequel'
 
 module Sequel::Plugins
   module Paranoid
+
     def self.configure(model, options = {})
-      options = {
+      model.sequel_paranoid_options = options = {
         :deleted_at_field_name      => :deleted_at,
         :deleted_by_field_name      => :deleted_by,
+        :delete_method_name         => :soft_delete,
         :enable_deleted_by          => false,
         :deleted_scope_name         => :deleted,
-        :non_deleted_scope_name     => :present,
+        :non_deleted_scope_name     => :not_deleted,
         :ignore_deletion_scope_name => :with_deleted,
         :enable_default_scope       => false,
-        :deleted_column_default     => nil
-      }.merge(options)
+        :soft_delete_on_destroy     => false,
+        :deleted_column_default     => nil,
+        :include_validation_helpers => false,
+      }.update(options)
+
+      delete_attributes = proc do |*args|
+        destroy_options = args.first || {}
+
+        attrs = {}
+        # set the deletion time
+        attrs[options[:deleted_at_field_name]] = Time.now
+
+        # set the deletion author
+        if options[:enable_deleted_by] && destroy_options && destroy_options[:deleted_by]
+          attrs[options[:deleted_by_field_name]] = destroy_options[:deleted_by]
+        end
+
+        attrs
+      end
+
+      ds_mod = Module.new do
+        # scope for deleted items
+        define_method(options[:deleted_scope_name]) do
+          send(options[:ignore_deletion_scope_name]).exclude(Sequel.qualify(model.table_name, options[:deleted_at_field_name]) => options[:deleted_column_default])
+        end
+
+        # scope for non-deleted items
+        define_method(options[:non_deleted_scope_name]) do
+          filter(Sequel.qualify(model.table_name, options[:deleted_at_field_name]) => options[:deleted_column_default])
+        end
+
+        # scope for both
+        define_method(options[:ignore_deletion_scope_name]) do
+          unfiltered
+        end
+
+        # soft delete the records without callbacks.
+        define_method(options[:delete_method_name]) do |*args|
+          update(delete_attributes.call(*args))
+        end
+
+      end
+
+      im_mod = Module.new do
+
+        define_method(options[:delete_method_name]) do |*args|
+          self.set(delete_attributes.call(*args))
+          self.save
+        end
+
+      end
 
       model.instance_eval do
-        #
-        # Inject the scopes for the deleted and the existing entries.
-        #
+        dataset_module ds_mod
+        include im_mod
 
-        dataset_module do
-          # scope for deleted items
-          define_method(options[:deleted_scope_name]) do
-            send(options[:ignore_deletion_scope_name]).exclude(Sequel.qualify(model.table_name, options[:deleted_at_field_name]) => options[:deleted_column_default])
-          end
+        plugin SoftDeleteOnDestroy if options[:soft_delete_on_destroy]
+        plugin EnableDefaultScope if options[:enable_default_scope]
+        plugin Validations if options[:include_validation_helpers]
+      end
+    end
 
-          # scope for non-deleted items
-          define_method(options[:non_deleted_scope_name]) do
-            filter(Sequel.qualify(model.table_name, options[:deleted_at_field_name]) => options[:deleted_column_default])
-          end
+    module ClassMethods
+      attr_accessor :sequel_paranoid_options
 
-          # scope for both
-          define_method(options[:ignore_deletion_scope_name]) do
-            unfiltered
-          end
+      ::Sequel::Plugins.inherited_instance_variables(self, :@sequel_paranoid_options=>:hash_dup)
+    end
+
+    module InstanceMethods
+
+      #
+      # Method for undeleting an instance.
+      #
+      def recover
+        opts = self.class.sequel_paranoid_options
+        send("#{opts[:deleted_at_field_name]}=".to_sym, opts[:deleted_column_default])
+
+        if opts[:enable_deleted_by] && self.respond_to?(opts[:deleted_by_field_name].to_sym)
+          send("#{opts[:deleted_by_field_name]}=", nil)
         end
 
-        #
-        # Overwrite the "_destroy_delete" method which is used by sequel to
-        # delete an object. This makes sure, we run all the hook correctly and
-        # in a transaction.
-        #
-        define_method("destroy") do |*args|
+        save
+      end
+
+      #
+      # Check if an instance is deleted.
+      #
+
+      def deleted?
+        opts = self.class.sequel_paranoid_options
+        send(opts[:deleted_at_field_name]) != opts[:deleted_column_default]
+      end
+
+    end
+
+    module SoftDeleteOnDestroy
+      module InstanceMethods
+        def destroy(*args)
           # Save the variables threadsafe (because the locks have not been
           # initialized by sequel yet).
           Thread.current["_paranoid_destroy_args_#{self.object_id}"] = args
@@ -49,28 +118,37 @@ module Sequel::Plugins
           super(*args)
         end
 
-        define_method("_destroy_delete") do
+        #
+        # Overwrite the "_destroy_delete" method which is used by sequel to
+        # delete an object. This makes sure, we run all the hook correctly and
+        # in a transaction.
+        #
+
+        def _destroy_delete
           # _destroy_delete does not take arguments.
           destroy_options = Thread.current["_paranoid_destroy_args_#{self.object_id}"].first
           Thread.current["_paranoid_destroy_args_#{self.object_id}"] = nil
 
-          # set the deletion time
-          self.send("#{options[:deleted_at_field_name]}=", Time.now)
+          send(self.class.sequel_paranoid_options[:delete_method_name], destroy_options)
+        end
+      end
+    end
 
-          # set the deletion author
-          if options[:enable_deleted_by] && destroy_options && destroy_options[:deleted_by]
-            self.send("#{options[:deleted_by_field_name]}=", destroy_options[:deleted_by])
-          end
+    module EnableDefaultScope
 
-          self.save
+      def self.configure(model)
+        model.class_eval do
+          set_dataset(send(sequel_paranoid_options[:non_deleted_scope_name]))
         end
+      end
+
+      module InstanceMethods
 
         #
         # Sequel patch to allow updates to deleted instances
         # when default scope is enabled
         #
-
-        define_method("_update_without_checking") do |columns|
+        def _update_without_checking(columns)
           # figure out correct pk conditions (see base#this)
           conditions = this.send(:joined_dataset?) ? qualified_pk_hash : pk_hash
 
@@ -80,38 +158,49 @@ module Sequel::Plugins
           # run the original update on the with_deleted dataset
           update_with_deleted_dataset.update(columns)
 
-        end if(options[:enable_default_scope])
-
-        #
-        # Method for undeleting an instance.
-        #
-
-        define_method("recover") do
-          self.send("#{options[:deleted_at_field_name]}=".to_sym, options[:deleted_column_default])
-
-          if options[:enable_deleted_by] && self.respond_to?(options[:deleted_by_field_name].to_sym)
-            self.send("#{options[:deleted_by_field_name]}=", nil)
-          end
-
-          self.save
         end
 
-        #
-        # Check if an instance is deleted.
-        #
+      end
+    end
 
-        define_method("deleted?") do
-          send(options[:deleted_at_field_name]) != options[:deleted_column_default]
-        end
+    module Validations
 
+      def self.apply(base)
+        base.plugin :validation_helpers
+      end
+
+      module InstanceMethods
         #
-        # Inject the default scope that filters deleted entries.
+        # Enhance validates_unique to support :paranoid => true for paranoid
+        # uniqueness checking.
         #
-
-        if options[:enable_default_scope]
-          set_dataset(self.send(options[:non_deleted_scope_name]))
+        def validates_unique(*columns)
+          return super(*columns) unless columns.last.kind_of?(Hash) && columns.last.delete(:paranoid)
+
+          opts = self.class.sequel_paranoid_options
+          if deleted?
+            columns = columns.map { |c|
+              case c
+              when Array, Symbol
+                [ c, opts[:deleted_at_field_name] ].flatten
+              else
+                c
+              end
+            }
+
+            super(*columns) { |ds|
+              ds = ds.send(opts[:deleted_scope_name])
+              block_given? ? yield(ds) : ds
+            }
+          else
+            super(*columns) { |ds|
+              ds = ds.send(opts[:non_deleted_scope_name])
+              block_given? ? yield(ds) : ds
+            }
+          end
         end
       end
+
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sequel-paranoid
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.7.0
 platform: ruby
 authors:
 - Sascha Depold
@@ -24,7 +24,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Use this plugin to mark a model instance as deleted without loosing its
+description: Use this plugin to mark a model instance as deleted without losing its
   actual data.
 email: sascha@depold.com
 executables: []
@@ -52,8 +52,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
-summary: A plugin for the Ruby ORM Sequel, that allows soft deletion of database entries.
+summary: A plugin for the Ruby ORM Sequel that allows soft deletion of database entries.
 test_files: []