mongoid-archivable 1.5.2 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6196888bed37db1654169604ef259efd32fcf17c
-  data.tar.gz: 510d60a14521bffa9a7fc0c1f128ddb2549702fa
+  metadata.gz: 39ea08e10786da69fd02888d73ff5311550115d4
+  data.tar.gz: 763442ac4b4451e46119ff3574a6c64d52cf96bd
 SHA512:
-  metadata.gz: 1f0176ff51fca46ffbbe08af76c0f7d3feadcee54cd1d3445844bd02b21449fcd029cbab63327b196129eeb21e2078b860238e2908401657c148866ad281db43
-  data.tar.gz: 63262b2557d0f08feb5a138c6281f0dc416cac19fd9415b9b70413bea3044955178df39fcd227cf13dd4b86a6896d6336617e2e555f1aed4bded9900fb238d78
+  metadata.gz: e42df539cbf0d48e580c7e4fd10226cdb66f14bb6e799118e00581c2f06699c83bc254a17c23987b970a188b970243f9aaed169fc3189859a6e0703b208fe8a9
+  data.tar.gz: 531755776b89e8dbbbd7363d11bfc9304fc23d66ef9f473523c807f683e0c7ae465af0140131c6dbe670234ae5a56781c1cf0913ffcfad3ac18adab7baa45c15

data/README.md

@@ -48,6 +48,50 @@ User.count # => 1
 User::Archive.count # => 1
 ```
 
+## Standalone Storage
+
+By default, the archived documents will be stored in primary client and database. If you want to use different database or client for all archived documents, you can create the following middleware:
+
+```ruby
+# Rails : config/initializers/mongoid_archivable.rb
+# Ruby : config/mongoid_archivable.rb
+
+Mongoid::Archivable.configure do |config|
+  config.database = "archives"
+  config.client = "secondary"
+end
+```
+
+But if you only want to use different database or client in spesific Mongoid document, you can use this approach:
+
+```ruby
+class User
+  include Mongoid::Document
+  include Mongoid::Archive
+  archive_in database: 'achives', client: 'secondary'
+end
+```
+
+In your mongoid.yml will show like this:
+
+```yaml
+development:
+  clients:
+    default:
+      database: project_development
+      hosts:
+        - localhost:27017
+      options:
+        <<: *client_options
+    secondary:
+      database: archives
+      hosts:
+        - localhost:27018
+      options:
+        <<: *client_options
+```
+
+
 ## Development
 
 Please report any issues to the [GitHub issue tracker](https://github.com/Sign2Pay/mongoid-archivable/issues).

data/lib/mongoid-archivable.rb

@@ -1,3 +1,4 @@
 require 'mongoid/archivable/version'
+require 'mongoid/archivable/config'
 require 'mongoid/archivable/process_localized_fields'
 require 'mongoid/archivable'

data/lib/mongoid/archivable.rb

@@ -1,55 +1,41 @@
 require 'active_support/concern'
 require 'mongoid/archivable/process_localized_fields'
+require 'mongoid/archivable/restoration'
+require 'mongoid/archivable/config'
+require 'mongoid/archivable/gluten'
+require 'mongoid/archivable/depot'
 
 module Mongoid
   module Archivable
     extend ActiveSupport::Concern
 
-    module Restoration
-      # Restores the archived document to its former glory.
-      def restore
-        original_document.save
-        original_document
+    class << self
+      def config
+        @config ||= Config.new
+        @config
       end
 
-      def original_document
-        @original_document ||= begin
-          excluded_attributes = %w(_id original_id original_type archived_at)
-          attrs = attributes.except(*excluded_attributes)
-          attrs = Mongoid::Archivable::ProcessLocalizedFields.call(original_class, attrs)
-
-          original_class.new(attrs) do |doc|
-            doc.id = original_id
-          end
-        end
-      end
-
-      # first, try to retrieve the original_class from the stored :original_type
-      # since previous versions of this gem did not use this field, fall back
-      # to previous method -- removing the '::Archive' from archive class name
-      def original_class_name
-        if respond_to?(:original_type) && original_type.present? # gem version >= 1.3.0, stored as a field.
-          original_type
-        else
-          self.class.to_s.gsub(/::Archive\z/, '') # gem version < 1.3.0, turns "User::Archive" into "User".
-        end
-      end
-
-      def original_class
-        original_class_name.constantize
+      def configure(&proc)
+        yield config
       end
     end
 
     included do
+      mattr_accessor :archive_storage
+      include Mongoid::Archivable::Gluten
+
       const_set('Archive', Class.new)
       const_get('Archive').class_eval do
         include Mongoid::Document
         include Mongoid::Attributes::Dynamic
         include Mongoid::Archivable::Restoration
+        include Mongoid::Archivable::Depot
+        store_in database: ->{ archive_database_name }, client: ->{ archive_client_name }
 
         field :archived_at, type: Time
         field :original_id, type: String
         field :original_type, type: String
+        
       end
 
       before_destroy :archive

data/lib/mongoid/archivable/config.rb

@@ -0,0 +1,16 @@
+module Mongoid
+  module Archivable
+    class Config
+      attr_accessor :database
+      attr_accessor :client
+
+      def get_database
+        database || Mongoid::Config.clients[get_client][:database]
+      end
+
+      def get_client
+        client || :default
+      end
+    end
+  end
+end

data/lib/mongoid/archivable/depot.rb

@@ -0,0 +1,40 @@
+module Mongoid
+  module Archivable
+    module Depot
+      extend ActiveSupport::Concern
+      included do
+        include ClassMethods
+      end
+
+      module ClassMethods
+        def has_archive_storage?
+          !parent.archive_storage.nil?
+        end
+
+        def has_archive_client?
+          has_archive_storage? && !parent.archive_storage[:client].nil?
+        end
+
+        def has_archive_database?
+          has_archive_storage? && !parent.archive_storage[:client].nil?
+        end
+
+        def archive_database_name
+          if has_archive_database?
+            parent.archive_storage[:database]
+          else
+            Mongoid::Archivable.config.get_database
+          end
+        end
+
+        def archive_client_name
+          if has_archive_client?
+            parent.archive_storage[:client]
+          else
+            Mongoid::Archivable.config.get_client
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/archivable/gluten.rb

@@ -0,0 +1,19 @@
+module Mongoid
+  module Archivable
+    module Gluten
+      extend ActiveSupport::Concern
+      included do
+        include ClassMethods
+      end
+      module ClassMethods
+        def archive_in args
+          @@archive_storage = args
+        end
+
+        def archive_storage
+          @@archive_storage
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/archivable/restoration.rb

@@ -0,0 +1,38 @@
+module Mongoid
+  module Archivable
+    module Restoration
+      # Restores the archived document to its former glory.
+      def restore
+        original_document.save
+        original_document
+      end
+
+      def original_document
+        @original_document ||= begin
+          excluded_attributes = %w(_id original_id original_type archived_at)
+          attrs = attributes.except(*excluded_attributes)
+          attrs = Mongoid::Archivable::ProcessLocalizedFields.call(original_class, attrs)
+
+          original_class.new(attrs) do |doc|
+            doc.id = original_id
+          end
+        end
+      end
+
+      # first, try to retrieve the original_class from the stored :original_type
+      # since previous versions of this gem did not use this field, fall back
+      # to previous method -- removing the '::Archive' from archive class name
+      def original_class_name
+        if respond_to?(:original_type) && original_type.present? # gem version >= 1.3.0, stored as a field.
+          original_type
+        else
+          self.class.to_s.gsub(/::Archive\z/, '') # gem version < 1.3.0, turns "User::Archive" into "User".
+        end
+      end
+
+      def original_class
+        original_class_name.constantize
+      end
+    end
+  end
+end

data/lib/mongoid/archivable/version.rb

@@ -1,5 +1,5 @@
 module Mongoid
   module Archivable
-    VERSION = '1.5.2'.freeze
+    VERSION = '1.6.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mongoid-archivable
 version: !ruby/object:Gem::Version
-  version: 1.5.2
+  version: 1.6.0
 platform: ruby
 authors:
 - Joost Baaij
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-02-03 00:00:00.000000000 Z
+date: 2017-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
@@ -101,7 +101,11 @@ files:
 - bin/setup
 - lib/mongoid-archivable.rb
 - lib/mongoid/archivable.rb
+- lib/mongoid/archivable/config.rb
+- lib/mongoid/archivable/depot.rb
+- lib/mongoid/archivable/gluten.rb
 - lib/mongoid/archivable/process_localized_fields.rb
+- lib/mongoid/archivable/restoration.rb
 - lib/mongoid/archivable/version.rb
 - mongoid-archivable.gemspec
 homepage: https://github.com/Sign2Pay/mongoid-archivable