activerecord_archive 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ac9d3219f20ca205595ab51f2d8e8828529353e18c26771689a2a5e28ca63406
+  data.tar.gz: 50dd7d5cd6b7bdf09e92464eff4595164d82471a046051d97dee739f46b90bd7
+SHA512:
+  metadata.gz: 54e184d8cda7b6557ec32a16ab0fadc09cc39b2b3e3c0ab51e41dd6cb4b31af68c5f7c0a2ebda88d473af8291e92cb2ae1c8d9d4399ea6473bd4176c346f66fa
+  data.tar.gz: 5a06805897fe374fdb27dfb165a7e96a2993f63f3e5619a2a0243dce6dfe8f60e18aa05ffbf1c7a1f0fa2217932e56f3e1ff1e17ad74ef2120d4bb3c81a8e758

data/lib/activerecord_archive.rb

@@ -0,0 +1,132 @@
+module ArchiveMethods # :nodoc:
+  def do_archive(conditions, options = {})
+    options[:prefix] = 'ar_archive_' unless options[:prefix]
+    options[:prefix] = 'ar_archive_' if options[:prefix].blank?
+
+    if self.respond_to?(:table_name)
+      tabname = self.table_name
+    else
+      raise 'MissingTableName'
+    end
+
+    raise 'PrefixAndTableNameTooLong - maximum is 64 characters' if "#{options[:prefix]}#{tabname}".size > 64
+
+    # do a simple query first in case to cause an exception if there is an error in conditions
+    ActiveRecord::Base.connection.execute("
+      SELECT COUNT(*)
+      FROM #{tabname}
+      WHERE #{conditions}
+    ")
+
+    ActiveRecord::Base.connection.execute("
+      CREATE TABLE IF NOT EXISTS #{options[:prefix]}#{tabname}
+        LIKE #{tabname}
+    ")
+
+    ActiveRecord::Base.connection.execute("
+      INSERT INTO #{options[:prefix]}#{tabname}
+        SELECT * FROM #{tabname} WHERE #{conditions}
+    ")
+
+    ActiveRecord::Base.connection.execute("
+      DELETE FROM #{tabname}
+      WHERE EXISTS(
+        SELECT #{options[:prefix]}#{tabname}.id
+        FROM #{options[:prefix]}#{tabname}
+        WHERE #{options[:prefix]}#{tabname}.id = #{tabname}.id)
+    ")
+  end
+
+  def do_restore(conditions, options = {})
+    options[:prefix] = 'ar_archive_' unless options[:prefix]
+    options[:prefix] = 'ar_archive_' if options[:prefix].blank?
+
+    if self.respond_to?(:table_name)
+      tabname = self.table_name
+    else
+      raise 'MissingTableName'
+    end
+
+    raise 'PrefixAndTableNameTooLong - maximum is 64 characters' if "#{options[:prefix]}#{tabname}".size > 64
+
+    # do a simple query first in case to cause an exception if there is an error in conditions
+    ActiveRecord::Base.connection.execute("
+      SELECT COUNT(*)
+      FROM #{options[:prefix]}#{tabname}
+      WHERE #{conditions}
+    ")
+
+    ActiveRecord::Base.connection.execute("
+      INSERT INTO #{tabname}
+        SELECT * FROM #{options[:prefix]}#{tabname} WHERE #{conditions}
+    ")
+
+    ActiveRecord::Base.connection.execute("
+      DELETE FROM #{options[:prefix]}#{tabname}
+      WHERE EXISTS(
+        SELECT #{tabname}.id
+        FROM #{tabname}
+        WHERE #{tabname}.id = #{options[:prefix]}#{tabname}.id)
+    ")
+  end
+end
+
+if Rails::VERSION::MAJOR >= 3
+  require 'active_support/concern'
+
+  module ActiveRecordArchive
+    extend ActiveSupport::Concern
+
+    class_methods do
+      include ArchiveMethods
+
+      # Archive database records
+      #
+      # Caveats: where foreign keys are involved, child records must be archived first
+      #
+      # Examples:
+      #   >> Model.archive('created_at < DATE_SUB(NOW(), INTERVAL 6 MONTH)')
+      #   >> Model.archive('created_at < DATE_SUB(NOW(), INTERVAL 6 MONTH)', prefix: 'arch_')
+      #
+      # Arguments:
+      #   conditions: (String)
+      #   options:
+      #     prefix: (String) - default "ar_archive_"
+      def archive(conditions, options = {})
+        do_archive(conditions, options)
+      end
+
+      # Restore database records
+      #
+      # Caveats: if you used a custom prefix to archive, make sure you use the same prefix to restore
+      #
+      # Examples:
+      #   >> Model.archive('created_at < DATE_SUB(NOW(), INTERVAL 6 MONTH)')
+      #   >> Model.archive('created_at < DATE_SUB(NOW(), INTERVAL 6 MONTH)', prefix: 'arch_')
+      #
+      # Arguments:
+      #   conditions: (String)
+      #   options:
+      #     prefix: (String) - default "ar_archive_"
+      def restore(conditions, options = {})
+        do_restore(conditions, options)
+      end
+    end
+  end
+
+  # include the extension
+  ActiveRecord::Base.send(:include, ActiveRecordArchive)
+else
+  # Rails 2
+  class ActiveRecord::Base # :nodoc:
+    extend ArchiveMethods
+
+    def self.archive(conditions, options = {})
+      do_archive(conditions, options)
+    end
+
+    def self.restore(conditions, options = {})
+      do_restore(conditions, options)
+    end
+  end
+end

metadata

@@ -0,0 +1,44 @@
+--- !ruby/object:Gem::Specification
+name: activerecord_archive
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Vic Spanner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-07-15 00:00:00.000000000 Z
+dependencies: []
+description: A simple archiving extension for ActiveRecord. Archive old records to
+  improve database performance. Restore old records from archive tables.
+email: vic@spannersoftware.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/activerecord_archive.rb
+homepage: https://github.com/vspar/activerecord_archive
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: ActiveRecord Archiving
+test_files: []