has_archive 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ea41cc24909aa00d12d670bb87b110c61b0c26d0
-  data.tar.gz: afdb00510af34d31e7e74520202af15fcd827010
+  metadata.gz: 2bfae8a910ef0352a264b4bccfe65f706b8d7193
+  data.tar.gz: 76135d10842de579e7e205ab65625b3709e73d53
 SHA512:
-  metadata.gz: 152d2c9f84f6ffd3d2fdab88344bd4bda502760fb3e25e88154bc5fdd7c7841ab9d4f169df1471869874b00b126913b07ec8baaa88d9df5f6c0cd632e1d12c0b
-  data.tar.gz: 24f58131b74c3087aaa406eb3d3291885564e18304ec71017644ed3bab7baeb82a6381b9d3af11f75eda888198e91d69ce8ab4dd9652e949664dd5ce67e6a804
+  metadata.gz: 9cf4bdf0569b5e0f5cada23bc7e6d6bb5c57e5a0f4a6166bb6ab60ac1f7021c1271ad4cbf8538cb03942127439d4355cf87e9423769e00a8ba39ffd15ebe4797
+  data.tar.gz: 1025e1e9bfffb0206ac101c90bfb70c6df26f8c8f6947cda5fb75b9354ce030f229f946b112eef84c362f7ce57f532c9d9b459ab82fbf7b76305c8f86a55dc81

data/README.md

@@ -1,6 +1,10 @@
 # HasArchive
 
-This project was born out of frustration with all the options I've found so far for archiving non-current ActiveRecord backed records, so I'm going to give it a go. The initial target will be Rails 4 (point two-ish) on Postgres, and if it goes somewhere, I will begin looking at what else we can support.
+This project was born out of frustration with all the options I've found so far for archiving non-current ActiveRecord backed models, so I'm going to give it a go. The initial target will be Rails 4 (point two-ish) on Postgres, and if it goes somewhere, I will begin looking at what else we can support.
+
+[![Gem Version](https://badge.fury.io/rb/has_archive.svg)](https://badge.fury.io/rb/has_archive)
+
+Please halp. This is far from ready, but if this seems like a useful/worthwhile project to you, please feel free to dig and lend a hand.
 
 ## Installation
 
@@ -20,7 +24,19 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Halp. This is ready for nothing, so far, but if this seems like a useful/worthwhile project to you, please feel free to dig and lend a hand.
+### Setup
+
+1. First, create your archive tables for any models you wish to make archivable. There is a utility method (`HasArchive::MigrationManager.create_archive_for`) to help generate the starting migrations. It must match the columns for the archivable model, plus add an `archived_at` datetime field.
+
+2. Call `has_archive` in your models.
+
+### Archive Controls
+
+Access the archive model directly with `ModelName::Archive`, or use the class method `archived` to union live and archived records.
+
+Archive a record by calling `archive` on it. Optionally, `destroy` may be overridden to work as a "soft delete" by setting `Rails.configuration.has_archive.override_destroy` to `true`.
+
+An archived record may be returned to the main table by calling `restore` on it.
 
 ## Development
 

data/lib/has_archive.rb

@@ -11,13 +11,22 @@ module HasArchive
     eval <<-EVAL
       class #{base}::Archive < #{base}
         self.table_name = "#{base.to_s.underscore}_archives"
+
+        def restore
+          attrs = self.attributes
+          attrs.delete('archived_at')
+          restored = self.class.parent.new(attrs)
+          restored.save && self.destroy(for_real: true)
+          self
+        end
       end
     EVAL
   end
 
   module ClassMethods
-    def archive
-      self::Archive
+    def archived
+      union = self.unscoped.union(self::Archive.unscoped.select(self.attribute_names.map(&:to_sym)))
+      self.from(self.arel_table.create_table_alias(union, self.table_name.to_sym).to_sql)
     end
   end
 
@@ -31,7 +40,6 @@ module HasArchive
 
     def destroy(for_real: false)
       if !for_real && Rails.configuration.has_archive.override_destroy
-        # puts "destroy has been overridden..."
         archive
       else
         super()

data/lib/has_archive/version.rb

@@ -1,3 +1,3 @@
 module HasArchive
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: has_archive
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Matt Morris
@@ -93,7 +93,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Add archives to your ActiveRecord models