no_brainer_soft_delete 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 044d0cb771a1ae6291d91dd63763d9e2361f30ed
+  data.tar.gz: bd57665a669a82646c38c141eddd5f55a3904639
+SHA512:
+  metadata.gz: 49c98211a5ea03bbbb9b2d68e235e6a371c41e07ccad9d6eb63ee3c8cad665c598ef1d4d16742679a25ff603f31dd23ed93c618a4b04f8e61ad07b6ae8897952
+  data.tar.gz: 6e7c7970d59f43807668678b6e30b90d7108f6ac9be97aa688c143f4522644e34dbafd76ff3a401a951aa65411d9056601bf761f4b260e24965e9e4bc36c87d2

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+# NoBrainer Soft Delete Changelog
+
+## 0.1.0 (unreleased)
+_Features_

data/CONTRIBUTING.md

@@ -0,0 +1,35 @@
+# NoBrainer Soft Delete
+
+This is an open source project. Contributions are encouraged. Please refer to the guidelines below prior to contributing.
+
+## Filing an issue
+
+When filing an issue please provide the following details:
+
+  - What you're expecting to happen compared with what's actually happening.
+  - A comprehensive list of steps to reproduce the issue.
+  - Your application's complete `Gemfile.lock`, and `Gemfile.lock` as text in a [Gist](https://gist.github.com) (*not as an image*)
+  - Any relevant stack traces ("Full trace" preferred)
+
+Please remember to format code using triple backticks (\`) so that it is neatly
+formatted when the issue is posted.
+
+## Pull requests
+
+We gladly accept pull requests to add documentation, fix bugs, and
+add new features.
+
+Here's a quick guide:
+
+1. Fork the repo.
+
+2. Run the tests. We only take pull requests with passing tests, and it's great
+to know that you have a clean slate.
+
+3. Create new feature branch, make your changes, and add tests for your changes. Only
+refactoring and documentation changes require no new tests. If you are adding
+functionality or fixing a bug, we need tests!
+
+4. Push to your fork and submit a pull request.
+
+The entire test suite must pass before your feature branch will be merged in.

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in nobrainer_soft_delete.gemspec
+gemspec
+
+gem 'rspec', '~>3.0'
+gem 'timecop'
+
+group :development do
+  gem 'pry'
+end

data/LICENSE.md

@@ -0,0 +1,19 @@
+# The MIT License (MIT)
+
+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,76 @@
+# NoBrainer Soft Delete
+
+This gem adds soft delete functionality inspired by [Paranoia](https://github.com/rubysherpas/paranoia) to NoBrainer for the NoSQL database RethinkDB.
+
+## Installation & Use
+
+This gem requires you to use [RethinkDB](https://rethinkdb.com/) and the gem [NoBrainer](https://github.com/nviennot/nobrainer) in your application.
+
+To install, add this line to your application's Gemfile and run bundle:
+
+```ruby
+gem 'no_brainer_soft_delete'
+```
+
+In the model that you would like to add soft delete functionality to, add this line of code directly below your NoBrainer includes:
+
+```ruby
+  include NoBrainerSoftDelete
+```
+
+That's all there is to it. This single line of code does several things for you:
+  - It adds a `deleted_at` field to your model (with an index)
+  - It scopes your default queries to documents that do not have a `deleted_at` value
+  - It provides access to several class and instance level methods.
+
+__Methods available from NoBrainerSoftDelete:__
+
+`Model.with_deleted`
+
+This method removes *all* scopes, then applies a scope reflecting that documents should be included regardless of the value held at `deleted_at`. It is important to note, this should be the first method called in a query chain as it will override anything prior to it.
+
+```ruby
+# Good
+Model.with_deleted.where(value: 'query_for')
+
+# Bad
+Model.where(value: 'query_for').with_deleted
+```
+
+`Model.only_deleted`
+
+This method removes *all* scopes,, then applies a scope reflecting that documents only be included in the query if the have a value saved to `deleted_at`. It is important to note, this should be the first method called in a query chain as it will override anything prior to it.
+
+`Model.restore(id)`
+
+This method locates a document and restores it.
+
+`instance.deleted?`
+
+Returns a boolean indicating whether or not the document has been soft deleted.
+
+`instance.destroy`
+
+Saves the value of `Time.now` to the `deleted_at` field and renders the document soft deleted. Also performs before/ after destroy callbacks. Returns a boolean indicating whether the operation was successful.
+
+`instance.really_destroy!`
+
+Performs the original destroy operation and completely removes the document from the database. Any instance that has this method called will no longer exist. Use with caution.
+
+`instance.restore`
+
+Erases the value saved to `deleted_at` by setting it to nil. The effectively "un-deletes" the document, and makes it readily accessible again.
+
+## Development
+
+To install the dependencies for this gem on your local machine, run `$ bundle install`.
+
+To run the specs use first start your rethinkdb server, then run `$ bundle exec rspec`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/andrewtpoe/no_brainer_soft_delete. Please refer to the contributing guide for best practices.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:spec) do |t|
+  t.libs << "spec"
+  t.libs << "lib"
+  t.test_files = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec

data/lib/no_brainer_soft_delete/version.rb

@@ -0,0 +1,3 @@
+module NoBrainerSoftDelete
+  VERSION = "0.1.0"
+end

data/lib/no_brainer_soft_delete.rb

@@ -0,0 +1,53 @@
+require 'active_support'
+require 'nobrainer'
+require "no_brainer_soft_delete/version"
+
+module NoBrainerSoftDelete
+  extend ActiveSupport::Concern
+
+  included do
+    # Set the default scope to only retrieve documents that have not been soft deleted
+    default_scope { where(:deleted_at.undefined => true) }
+
+    # Add a deleted_at field to the document, for use with NoBrainerSoftDelete
+    field :deleted_at, index: true, type: Time
+  end
+
+  class_methods do
+    # Returns documents regardless of the value held in deleted_at
+    def with_deleted
+      unscoped.where(:or => [{ :deleted_at.defined => true }, { :deleted_at.undefined => true }])
+    end
+
+    # Returns only documents that have been soft deleted
+    def only_deleted
+      unscoped.where(:deleted_at.defined => true)
+    end
+
+    # Searches for a document and restores it
+    def restore(id, options = {})
+      with_deleted.where(id: id).first.restore(options)
+    end
+  end
+
+  # Returns a boolean indicating whether or not a document has been soft deleted
+  def deleted?
+    !!deleted_at
+  end
+
+  # Sets the deleted_at value to the current time, thus marking the document as deleted
+  def destroy
+    update(deleted_at: Time.now.utc)
+  end
+
+  # Completely removes the document from the database, and runs the callbacks.
+  def really_destroy!
+    _run_destroy_callbacks
+    delete
+  end
+
+  # Sets the deleted_at value to nil, thus no longer marking the document as deleted
+  def restore(options = {})
+    update(deleted_at: nil)
+  end
+end

data/no_brainer_soft_delete.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'no_brainer_soft_delete/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "no_brainer_soft_delete"
+  spec.version       = NoBrainerSoftDelete::VERSION
+  spec.authors       = ["Andrew T. poe"]
+  spec.email         = ["andrewtpoe@gmail.com"]
+  spec.summary       = "Adds soft delete capabilities to NoBrainer"
+  spec.description   = "Extends the NoBrainer ORM to include soft delete capabilities similar to Paranoia for Active Record."
+  spec.homepage      = "https://github.com/andrewtpoe/no_brainer_soft_delete"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  # end
+
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+
+  spec.require_paths = ["lib"]
+  spec.required_ruby_version = ">= 2.2.2"
+
+  spec.add_dependency "activesupport",     ">= 4.1.0"
+  spec.add_dependency "nobrainer", ">=0.32.0"
+  spec.add_dependency "rethinkdb", ">= 2.3.0"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: no_brainer_soft_delete
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrew T. poe
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-07-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+- !ruby/object:Gem::Dependency
+  name: nobrainer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.32.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.32.0
+- !ruby/object:Gem::Dependency
+  name: rethinkdb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Extends the NoBrainer ORM to include soft delete capabilities similar
+  to Paranoia for Active Record.
+email:
+- andrewtpoe@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- lib/no_brainer_soft_delete.rb
+- lib/no_brainer_soft_delete/version.rb
+- no_brainer_soft_delete.gemspec
+homepage: https://github.com/andrewtpoe/no_brainer_soft_delete
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Adds soft delete capabilities to NoBrainer
+test_files: []