softie 0.0.1 → 1.0.0

data.tar.gz.asc

@@ -2,17 +2,17 @@
 Version: GnuPG/MacGPG2 v2.0.19 (Darwin)
 Comment: GPGTools - http://gpgtools.org
 
-iQIcBAABAgAGBQJRScSfAAoJEH1ncb0Txu7XV9gQAJURRT9GuhUyJDHHYyd1wZT7
-PSTIcJgkp9BpnD0bOCs2zar0SoOYBW77BybJ/PuRD6EMsm7+nrdnT5rpbBmYanLi
-SBKGHE0wAPufkr/hO4S8KStjcU11MRZwWmXKK3p7r4q4WbiQVDizurMPjPdbeZkB
-6slYAILvHD9XHsV6EYiEXjojpWzZO7L74EJceimshiSb78gt9FaS2Z0Sc7B92UiV
-qrjEtV8r7hQxoAqfIF/ugJkHgyJkJJ1J6mQedztTXnpUSGGXcbHKDbXLHcI5LoAq
-NzzPUdj6gN2BBq7gYPv4bL6BSR80eiEo5gdHYTFJqoPB+DxnbFdPYf6USbW3v2HT
-Gz9LC56uFBDho4qFPerClj9ntuOQnm+cI6tFSzKSDUzR365NGVXDNz2N6jXh3A7Z
-O7Dnd4ULD3sQyLF8z4R13QJaegiTD20qP09S+ZhYt8MNgRoO3eMASQSAnrswbZ6g
-vhIBHp/WScur3rvGFMsML0siocOHAJFPIvDwe2Uoh3PR/PmVJplMN5DNJHTqkuTf
-plW8LJIxW5JlgcFXcZPwoy2xdgEws8tbOshSchLDIvyfBx1zSa8NhFxmxC7jLS9w
-oNm6AYMmroFHwTUHV4eIHCCKqCUGDV3ZNt4sd5BtTYO9/GZ+61LVwSCEVKrM9rS/
-bFcGoYfZKl/SvlCBUMux
-=A5ej
+iQIcBAABAgAGBQJRSr8SAAoJEH1ncb0Txu7XtxoP/jgZPcbK6zZtubUFZGC0HiPY
+GiXpPJaPQ2Tn0ERBOgvHHVTf2uqgWnQaSVTuYIitzj66GBvr3YSpHF4F7ynZSOOI
+Jm15ChX4v57F2pqa1H4zz7YkxBVaAqmQIGjizt8staijgcfIp7fU+f34F6Okshw3
+U9/bbq6v2aCi7wJxIaqIBQiNVC4S1CxP6/ZR9e4YPfYVt0Gl4IRZQa9r2ISiPAst
+T0XymgYGTRFGDntVE1Q6x0by/TFgeKIH+BwaMWYRp8Turk65M7oWO+bpzjZ8jVf4
+Xy3hZnmKHmHgHybtY1fB6EEFAglhueJ5lZVTSjYsUsoK6qHjezOC8PC73lRr8R7H
+SNs3usylRfV+3cGgo5YpTYZ8LljRbKDM0q9ORTTBrVh/Rq9ZRXoXMMVp0EIk+9gP
+FamxC0YVA+GKTRNFNU6iSryWyJmU8LcPo0rutyhd/JKdNhKEwU3rooBXVOQuSJmM
+J5N1hbUizPcfaKM4wGUBE3tvW3Bi02FJVbW6NhbuI6lGdw1KqxhJtpOT7M1p//37
+5fAutg7n/qtH5RBarOd9cMQA9KWyih5tAieCrVSX+yFrdsRf6bs2OrOPmW13abmy
+vCNHwPPPHJT4APPAjbvhIyzMbPiHW5fk5gKugTO20Dx5FgvhP478rfCKWBBj/hzq
+0zDm6PsQVXyyrReS1MH5
+=lQsK
 -----END PGP SIGNATURE-----

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - "1.9.3"
+  - "2.0.0"
+  - "rbx-19mode"
+services:
+  - mongodb

data/Gemfile

@@ -1,3 +1,5 @@
 source 'https://rubygems.org'
 
 gemspec
+gem "bson_ext"
+gem "debugger"

data/README.md

@@ -1,6 +1,15 @@
 # Softie
 
-TODO: Write a gem description
+[![Build Status](https://travis-ci.org/PerfectlyNormal/softie.png)](https://travis-ci.org/PerfectlyNormal/softie)
+
+Softie has troubles letting go.
+It is a plugin for [MongoMapper](http://mongomapper.com/), and lets records be soft-deleted easily.
+
+It contains the bare minimum that I use at the moment.
+Softie does not add a default scope, but it does add *a* scope (configurable).
+Softie does not override `#destroy`, `#delete` and other methods.
+
+The app this was extracted from stores which `User` deleted the record in `deleted_by`. This feature is disabled by default, but can easily be enabled, and the field name and class configured.
 
 ## Installation
 
@@ -8,17 +17,41 @@ Add this line to your application's Gemfile:
 
     gem 'softie'
 
-And then execute:
-
-    $ bundle
-
 Or install it yourself as:
 
     $ gem install softie
 
+## Configuration
+
+Either load it into all models, or individual models:
+
+    # add to all models
+    MongoMapper::Document.plugin Softie
+
+    # add to a specific model
+    class Item
+      include MongoMapper::Document
+      plugin Softie
+    end
+
+Then call `softie` to configure it
+
+    softie [options]
+
+The supported options are as follows:
+
+* `key`: Symbol. Defaults to `:deleted_at`
+* `scope`: Symbol. Defaults to `:active`. Set to a falsy value to disable.
+* `deleted_by_field`: Symbol. Defaults to `:deleted_by`
+* `deleted_by_class`: Class. Defaults to `nil`. Set to a class to enable this functionality.
+
 ## Usage
 
-TODO: Write usage instructions here
+Call `deleted!` on your document. This sets `deleted_at` to `Time.now.utc` and saves the document. If you are tracking who deleted it, pass it as `deleted!(by: current_user)`.
+
+To restore a document, call `restore!`.
+
+If you want to handle saving manually, use `deleted` and `restore`.
 
 ## Contributing
 

data/Rakefile

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

data/lib/softie.rb

@@ -1,4 +1,59 @@
 require "softie/version"
 
 module Softie
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    def softie(options = {})
+      class_attribute :softie_options
+
+      self.softie_options = {
+        key: :deleted_at,
+        scope: :active,
+        deleted_by_class: nil,
+        deleted_by_key: :deleted_by
+      }.merge(options)
+
+      key softie_options[:key], Time
+
+      if softie_options[:deleted_by_class]
+        key softie_options[:deleted_by_key],
+            softie_options[:deleted_by_class]
+      end
+
+      scope softie_options[:scope], lambda {
+        where(softie_options[:key] => nil)
+      } if softie_options[:scope]
+    end
+  end
+
+  def deleted(options = {})
+    public_send("#{softie_options[:key]}=", Time.now.utc)
+
+    if softie_options[:deleted_by_class]
+      public_send("#{softie_options[:deleted_by_key]}=", options.delete(:by))
+    end
+  end
+
+  def deleted!(options = {})
+    deleted(options)
+    save
+  end
+
+  def restore
+    public_send("#{softie_options[:key]}=", nil)
+
+    if softie_options[:deleted_by_class]
+      public_send("#{softie_options[:deleted_by_key]}=", nil)
+    end
+  end
+
+  def restore!
+    restore
+    save
+  end
+
+  def deleted?
+    public_send(softie_options[:key]) != nil
+  end
 end

data/lib/softie/version.rb

@@ -1,3 +1,3 @@
 module Softie
-  VERSION = "0.0.1"
+  VERSION = "1.0.0"
 end

data/softie.gemspec

@@ -8,16 +8,19 @@ Gem::Specification.new do |spec|
   spec.version       = Softie::VERSION
   spec.authors       = ["Per Christian B. Viken"]
   spec.email         = ["perchr@northblue.org"]
-  spec.description   = %q{Write a gem description}
-  spec.summary       = %q{Write a gem summary}
-  spec.homepage      = "https://eastblue.org/blag/"
+  spec.summary       = %q{MongoMapper plugin that adds soft-delete functionality}
+  spec.description   = %q{Softie adds soft-delete functionality to MongoMapper documents with minimal fuss}
+  spec.homepage      = "https://github.com/PerfectlyNormal/softie"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.test_files    = spec.files.grep(%r{^spec/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.specification_version = 3
+  spec.add_runtime_dependency     "mongo_mapper", ">= 0.9.0"
+  spec.add_development_dependency "rspec",        "~> 2.11"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "timecop"
 end

data/spec/softie_spec.rb

@@ -0,0 +1,225 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Softie do
+
+  describe "with defaults" do
+    before :each do
+      @article = DefaultArticle.new(title: "Softie with Defaults")
+    end
+
+    it "should add a .active scope" do
+      DefaultArticle.should respond_to(:active)
+    end
+
+    it "should add a key called :deleted_at" do
+      @article.keys.keys.should include("deleted_at")
+    end
+
+    it "should not add a key called :deleted_by" do
+      @article.keys.keys.should_not include("deleted_by")
+    end
+
+    it "should add a method for deleting" do
+      @article.should respond_to(:deleted!)
+    end
+
+    it "should add a method for checking if the document is deleted" do
+      @article.should respond_to(:deleted?)
+    end
+
+    it "should add a method for restoring" do
+      @article.should respond_to(:restore!)
+    end
+
+  end
+
+  describe "#deleted?" do
+    before :each do
+      @article = DefaultArticle.new(title: "Softie with Defaults")
+    end
+
+    it "should not be true by default" do
+      @article.should_not be_deleted
+    end
+
+    it "should be true after a call to #deleted!" do
+      @article.deleted!
+      @article.should be_deleted
+    end
+
+    it "should be false after a call to #restore!" do
+      @article.deleted!
+      @article.restore!
+      @article.should_not be_deleted
+    end
+  end
+
+  describe "#deleted" do
+    before :each do
+      @article = DefaultArticle.new(title: "Softie with Defaults")
+    end
+
+    it "should store the current time" do
+      time = Time.utc(2013, 03, 20, 13, 37, 42)
+      Timecop.freeze(time) do
+        @article.deleted
+        @article.deleted_at.should == time
+      end
+    end
+
+    it "does not saves the document" do
+      @article.should_not_receive(:save)
+      @article.deleted
+    end
+
+    describe "with deleted_by functionality" do
+      it "should store the user" do
+        article = ArticleWithDeletedBy.new(title: "deleted_by is a User")
+        user    = User.new(name: "Dummy User")
+
+        article.deleted(by: user)
+        article.deleted_by.should eq(user)
+      end
+    end
+  end
+
+  describe "#deleted!" do
+    before :each do
+      @article = DefaultArticle.new(title: "Softie with Defaults")
+    end
+
+    it "should store the current time" do
+      time = Time.utc(2013, 03, 20, 13, 37, 42)
+      Timecop.freeze(time) do
+        @article.deleted!
+        @article.deleted_at.should == time
+      end
+    end
+
+    it "saves the document" do
+      @article.should_receive(:save).and_return(true)
+      @article.deleted!
+    end
+
+    describe "with deleted_by functionality" do
+      it "should store the user" do
+        article = ArticleWithDeletedBy.new(title: "deleted_by is a User")
+        user    = User.new(name: "Dummy User")
+
+        article.deleted!(by: user)
+        article.deleted_by.should eq(user)
+      end
+    end
+  end
+
+  describe "#restore" do
+    before :each do
+      @article = DefaultArticle.new(title: "Softie with Defaults")
+      @article.deleted
+    end
+
+    it "should not be deleted any more" do
+      @article.restore
+      @article.should_not be_deleted
+    end
+
+    it "does not save the document" do
+      @article.should_not_receive(:save)
+      @article.restore
+    end
+
+    describe "with deleted_by functionality" do
+      it "should clear the user" do
+        article = ArticleWithDeletedBy.new(title: "deleted_by is a User")
+        user    = User.new(name: "Dummy User")
+        article.deleted!(by: user)
+
+        article.restore
+        article.deleted_by.should be_nil
+      end
+    end
+  end
+
+  describe "#restore!" do
+    before :each do
+      @article = DefaultArticle.new(title: "Softie with Defaults")
+      @article.deleted!
+    end
+
+    it "should not be deleted any more" do
+      @article.restore!
+      @article.should_not be_deleted
+    end
+
+    it "saves the document" do
+      @article.should_receive(:save).and_return(true)
+      @article.restore!
+    end
+
+    describe "with deleted_by functionality" do
+      it "should clear the user" do
+        article = ArticleWithDeletedBy.new(title: "deleted_by is a User")
+        user    = User.new(name: "Dummy User")
+        article.deleted!(by: user)
+
+        article.restore!
+        article.deleted_by.should be_nil
+      end
+    end
+  end
+
+  describe "#deleted_by" do
+    describe "when enabled" do
+      it "should add a key called deleted_by" do
+        ArticleWithDeletedBy.new(
+          title: "deleted_by is a User"
+        ).keys.keys.should include("deleted_by")
+      end
+    end
+
+    describe "when not enabled" do
+      it "should not add the deleted_by key" do
+        @article = NonDefaultArticle.new(title: "Not tracking user")
+        @article.keys.keys.should_not include("deleted_by")
+      end
+    end
+
+    describe "enabled with a different key name" do
+      before :each do
+        @article = ArticleWithWasDeletedBy.new(title: "deleted_by key is was_deleted_by")
+      end
+
+      it "should add a key called was_deleted_by" do
+        @article.keys.keys.should include("was_deleted_by")
+      end
+
+      it "should not add the default key" do
+        @article.keys.keys.should_not include("deleted_by")
+      end
+    end
+  end
+
+  describe "with a different key name" do
+    before :each do
+      @article = NonDefaultArticle.new(title: "Different key names")
+    end
+
+    it "should add a key called was_deleted" do
+      @article.keys.keys.should include("was_deleted")
+    end
+
+    it "should not add a key called deleted_at" do
+      @article.keys.keys.should_not include("deleted_at")
+    end
+
+    it "should look at the right key in the scope" do
+      NonDefaultArticle.active.to_hash.should include(was_deleted: nil)
+    end
+  end
+
+  describe "with the scope disabled" do
+    it "should not generate the method" do
+      ArticleWithoutScope.should_not respond_to(:active)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,60 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rspec'
+require 'timecop'
+require 'mongo_mapper'
+require 'softie'
+
+MongoMapper.database = 'softie-spec'
+
+class DefaultArticle
+  include MongoMapper::Document
+  plugin Softie
+
+  key :title, String
+  softie
+end
+
+class NonDefaultArticle
+  include MongoMapper::Document
+  plugin Softie
+
+  key :title, String
+  softie key: :was_deleted
+end
+
+class ArticleWithoutScope
+  include MongoMapper::Document
+  plugin Softie
+
+  key :title, String
+  softie scope: false
+end
+
+class User
+  include MongoMapper::Document
+  key :name
+end
+
+class ArticleWithDeletedBy
+  include MongoMapper::Document
+  plugin Softie
+
+  key :title, String
+  softie deleted_by_class: ::User
+end
+
+class ArticleWithWasDeletedBy
+  include MongoMapper::Document
+  plugin Softie
+
+  key :title, String
+  softie deleted_by_class: ::User, deleted_by_key: :was_deleted_by
+end
+
+RSpec.configure do |config|
+  config.before :suite do
+    MongoMapper.database.connection.drop_database('softie-spec')
+  end
+end

metadata

@@ -2,31 +2,47 @@
 name: softie
 version: !ruby/object:Gem::Version
   prerelease: 
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Per Christian B. Viken
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-20 00:00:00.000000000 Z
+date: 2013-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: mongo_mapper
+  type: :runtime
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: rspec
   type: :development
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.11'
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.11'
 - !ruby/object:Gem::Dependency
   name: rake
   type: :development
@@ -43,7 +59,24 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Write a gem description
+- !ruby/object:Gem::Dependency
+  name: timecop
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Softie adds soft-delete functionality to MongoMapper documents with minimal
+  fuss
 email:
 - perchr@northblue.org
 executables: []
@@ -51,6 +84,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -58,7 +92,9 @@ files:
 - lib/softie.rb
 - lib/softie/version.rb
 - softie.gemspec
-homepage: https://eastblue.org/blag/
+- spec/softie_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/PerfectlyNormal/softie
 licenses:
 - MIT
 post_install_message: 
@@ -82,5 +118,7 @@ rubyforge_project:
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Write a gem summary
-test_files: []
+summary: MongoMapper plugin that adds soft-delete functionality
+test_files:
+- spec/softie_spec.rb
+- spec/spec_helper.rb

metadata.gz.asc

@@ -2,17 +2,17 @@
 Version: GnuPG/MacGPG2 v2.0.19 (Darwin)
 Comment: GPGTools - http://gpgtools.org
 
-iQIcBAABAgAGBQJRScSfAAoJEH1ncb0Txu7XJe4P/ir7Vkix2PHzV/KThqYxjSaF
-Urjxxc2Ty7v3F6nQjkTazhzfXrWDSoMwsNYbCNGFDeiVY1VerWEo/VDevlGBmg3W
-vo9WOO0vAC9+HmAWlCU43dnFwicAhMsg5KNFjcX9BdbSItCYkegB/cxr0mLqzvno
-c+YSXkYuXWzjO2yQ5nYNk0Kxw312xK2pa49AgwJTwujM3dT/fPOVYWues1+bjVGY
-WphjYPUEhYEInqoRImJeVC6u163geUh8fq1OuBW9iv4M1JMGdWgeCxm24i1cSy9c
-zx2axyNgZC6P6Vx5ZcKXGSsIcWKgGBR40Tf2CcjbruI1gS5W+lv8NKGrHZPH/LhQ
-BhLXMqHRdco21jr7YjrwA2Tgihh1OMdqBZppp2HNihsl2uaLkbSHWY/xBUmEYx/L
-E68M4bEVKcE2sJ77H1BO3YUMJqpGPvussaEd58sgcnDTcN1MNQtkPDZVoLP681aD
-JP+J3OlQ8moQjsL1Lxh/5kM7jNU0tAuHSUgbVyNf8zypriZoCS2MaSCi6ZaxwxNZ
-V58ggLNYOP1N7jYT/2eTJpUxOW7egbnIjRzjnb8pITY2SjSAHUfXZvrr2ivWohv1
-TqBcAhHwMJ1rTcAa8NEbyh1KgZ512w8CD43g6nOpT63AVLSpXqbHhh9ta0gxbAHh
-dKu4EJHyWY4fUTY2FQFo
-=Mw2L
+iQIcBAABAgAGBQJRSr8SAAoJEH1ncb0Txu7XO3QP/0vsmqsmbR9UqHmqz1HMTe6b
+NcRYXn9GzcJWNtH+0S+saFip1+ZF5wxZADXveGepYwRDXiOCAjVUg1gGYy1Q9VxX
+dnhBvahlT1egfr/tVmNQ3RXdlZ7b4SK4HRtqisu+/fR/w/rRMULnmDJJvDJ5vWBb
+A/u2X6IItiEZRHb++d6qTV/rP3vuOIRMlyYJXjcO6pmKBrEUVjwT+oENZoCmWTr9
+yeSAo0g7ji/Iulvc4RGH8YHt0Iz2CrdUXtH8PiLKoxjf0xIXfmrmxzpWQQbbqQwn
+Z4kpauUERj+uBEL3qeDSNdIT8Q1L3Ybq6mO7+o6UDMBCZTslU+yux4rx64j62WUT
+6+j/4C5b+b9AL8DInnxWEgve/GPVMIhd3q3Oglmi25PXfqfy5yfum0x0VVDC7dSl
+QtBm1i/xb3MaHnTxDW/yvSc1/Azi3AzUWmPQtkna/iTwHvjQyFi9SMYxTvy39HWD
+SkTTtK24c4sWelyEHpRb8xtLDCskFSD40e9Zfy0QDyDdiu2PdFlM1GMidEeSAV0l
+bckTJjARIZ4bKc7XphnOGiPv8eg9IYsN9ntxwqTCn/lELEmO3FCaN18S/n/OLo9O
+4JbQn1oyGWL48ilB04wJ5n0Bn1H/KB0nY6VNgibYL/Y2E/j2m6/pg0QOBnEsSX6b
+GOm8KDfiPnWCarfqZZIi
+=v7t2
 -----END PGP SIGNATURE-----