mongomapper-archive 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 218274fec9194eccbbe1b8538965debdde162836
+  data.tar.gz: a2f71f5932d07b4ae3ee4b3820f8ca5f48a2307f
+SHA512:
+  metadata.gz: e271cf71152fa6a6d8ee6ea00cfcc9a7e76f213de46af4584d0ee61b53ec9a7e765ca2ce4d695e5868e43d26de0d186c28393c53855f159c6b956c3fdfa68fff
+  data.tar.gz: 6afcc687a33c7b848e9230be41224f4a7c4d88d19e5dfbc15182ba36b688aa16cf69f44850684ca25c60dca6f67a11d7dd8899e6642f02a94585e1038d6d0f6e

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mongomapper-archive.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 DivShot
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,40 @@
+# Mongomapper::Archive
+
+MongoMapper::Archive (Archive for short) is a plugin for [MongoMapper](http://mongomapper.com/) that adds simple archiving functionality to your models.
+
+Archive doesn't rely on a default scope, only applies to the models you specify, and only hooks into the `before_destroy` callback. It's as unobtrusive as it can be.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mongomapper-archive'
+
+Or install it yourself as:
+
+    $ gem install mongomapper-archive
+
+## Usage
+
+Add it to a model:
+```
+class Post
+  include MongoMapper::Document
+  plugin MongoMapper::Archive
+end
+```
+
+After that, any call to `destroy` a document of this class will first copy the document to a separate collection, *then* destroy the document.
+
+## Limitations
+
+* Archive does not currently provide a means to recover archived documents.
+* Archive adds an `ArchiveDocument` collection to your database.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/lib/archive_document.rb

@@ -0,0 +1,3 @@
+class ArchiveDocument
+  include MongoMapper::Document
+end

data/lib/mongomapper/archive.rb

@@ -0,0 +1,29 @@
+require "archive_document"
+require "mongomapper/archive/version"
+
+module Mongomapper
+  module Archive
+    extend ActiveSupport::Concern
+
+    included do
+      before_destroy :archive
+
+      @archive = create_archive_class
+    end
+
+    module ClassMethods
+      def create_archive_class
+        archive_class_name = :"Archive#{self.name}"
+        const_set(archive_class_name, Class.new(ArchiveDocument)) unless const_defined?(archive_class_name)
+      end
+
+      def archive
+        @archive
+      end
+    end
+
+    def archive
+      self.class.archive.create(self.to_mongo)
+    end
+  end
+end

data/lib/mongomapper/archive/version.rb

@@ -0,0 +1,5 @@
+module Mongomapper
+  module Archive
+    VERSION = "0.0.1"
+  end
+end

data/mongomapper-archive.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mongomapper/archive/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mongomapper-archive"
+  spec.version       = Mongomapper::Archive::VERSION
+  spec.authors       = ["Ben Scofield"]
+  spec.email         = ["git@turrean.com"]
+  spec.description   = "Add simple archive / soft delete functionality to your MongoMapper models."
+  spec.summary       = "Add simple archive / soft delete functionality to your MongoMapper models."
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.test_files    = spec.files.grep(%r{^spec/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency     "mongo_mapper", ">= 0.12.0"
+  spec.add_development_dependency "rspec",        "~> 2.13.0"
+  spec.add_development_dependency "rake"
+end

data/spec/archive_spec.rb

@@ -0,0 +1,15 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Mongomapper::Archive do
+  context 'destroy' do
+    let!(:journal) { Journal.create(title: "My big adventure", body: "I had the *best* day...") }
+
+    it 'should copy the journal to the archive collection' do
+      expect{ journal.destroy }.to change(Journal.archive, :count).by(1)
+    end
+
+    it 'should still destroy the journal' do
+      expect{ journal.destroy }.to change(Journal, :count).by(-1)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rspec'
+require 'mongo_mapper'
+require 'mongomapper/archive'
+
+MongoMapper.database = 'archive-spec'
+
+class Journal
+  include MongoMapper::Document
+  plugin Mongomapper::Archive
+
+  key :title, String
+  key :body, String
+end
+
+RSpec.configure do |config|
+  config.before :suite do
+    MongoMapper.database.connection.drop_database('archive-spec')
+  end
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: mongomapper-archive
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ben Scofield
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mongo_mapper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Add simple archive / soft delete functionality to your MongoMapper models.
+email:
+- git@turrean.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/archive_document.rb
+- lib/mongomapper/archive.rb
+- lib/mongomapper/archive/version.rb
+- mongomapper-archive.gemspec
+- spec/archive_spec.rb
+- spec/spec_helper.rb
+homepage: 
+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: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Add simple archive / soft delete functionality to your MongoMapper models.
+test_files:
+- spec/archive_spec.rb
+- spec/spec_helper.rb