storage_unit 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f7e3ecd85e04df0d54954b250d3d1f2de3bedcdd
+  data.tar.gz: bf0e2597da2ac992fff271875a22540b697baf9e
+SHA512:
+  metadata.gz: 83ea81551a3f79d5ea0f513fddd36b5cf5561bc493a02753ecd4b5d104961a0af2600fa9e8b7270c35cf128e68b19cb62f5ca4217c7c1ddac250a33f8fa58079
+  data.tar.gz: ac2e270f5056529bd2c37368f0db25d67c486947ce910679bd6eb533babaa019e107d92cd27d5fd7ceb041edcb5f9a74c1402e3830606ab7e2b642a0e1ffbdf1

data/.coveralls.yml

@@ -0,0 +1,2 @@
+service_name: travis-ci
+repo_token: NLvtwz6L7nW32aBVsJK4ph3MelAV48otV

data/.gitignore

@@ -0,0 +1,15 @@
+.bundle/
+log/*.log
+pkg/
+spec/dummy/config/database.yml
+spec/dummy/log/*.log
+spec/dummy/tmp/
+spec/dummy/.sass-cache
+spec/dummy/public/uploads/*
+tmp/*
+coverage/*
+*.gem
+Gemfile.lock
+spec/dummy/db/test.sqlite3
+gemfiles/*.lock
+.ruby-gemset

data/.ruby-version

@@ -0,0 +1 @@
+2.1.1

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+cache: bundler
+script: bundle exec rspec
+notifications:
+  email: false

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright 2014 Department of Better Technology
+
+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,110 @@
+storage_unit
+=========
+
+[![Travis][0]](https://travis-ci.org/dobtco/storage_unit)
+[![Code Climate][1]](https://codeclimate.com/github/dobtco/storage_unit)
+[![Coveralls][2]](https://coveralls.io/r/dobtco/storage_unit)
+[![RubyGem][3]](http://rubygems.org/gems/storage_unit)
+
+:recycle: Soft deletion for Rails 4.1+, done right.
+
+## Goals
+
+- Standard set of "soft deletion" methods (`trash`, `recover`, `trashed?`)
+- Explicit storage_unit dependencies (automatically trash associated records)
+- Low-overhead (minimize queries)
+- No validations on `recover`. (If your records became invalid after they were trashed, check for this yourself)
+- Small, readable codebase
+
+## Non-goals
+
+- Targeting anything less than Rails 4.1
+- Reflection on Rails' associations
+- Generally, anything weird or complex happening behind the scenes
+
+## Installation
+
+```ruby
+# In your Gemfile:
+gem 'storage_unit'
+
+# In a migration:
+add_column :posts, :deleted_at, :datetime
+```
+
+## Usage
+
+```ruby
+class Post < ActiveRecord::Base
+  has_storage_unit
+end
+
+post = Post.create
+Post.all # => [post]
+post.trashed? # => false
+
+post.trash!
+post.trashed? # => true
+Post.all # => []
+Post.with_deleted.all # => [post]
+
+post.recover!
+post.trashed? # => false
+Post.all # => []
+```
+
+### Cascading trashes
+
+```ruby
+class User < ActiveRecord::Base
+  has_storage_unit, cascade: [:posts]
+  has_many :posts
+end
+
+class Post < ActiveRecord::Base
+  has_storage_unit
+end
+
+user = User.create
+post = Post.create
+
+user.trash!
+user.trashed? # => true
+post.trashed? # => true
+
+user.recover!
+user.trashed? # => false
+post.trashed? # => false
+```
+
+### Callbacks
+
+```ruby
+class Post < ActiveRecord::Base
+  has_storage_unit
+  after_recover :ensure_record_is_still_valid
+
+  private
+  def ensure_record_is_still_valid
+    if !valid?
+      # i dunno, trash! this post again? delete it entirely? inform the user? shit is hard.
+    end
+  end
+end
+```
+
+### Use a different column
+
+```ruby
+class Post < ActiveRecord::Base
+  has_storage_unit column: :trashed_at
+end
+```
+
+## License
+MIT.
+
+[0]: https://img.shields.io/travis/dobtco/storage_unit.svg
+[1]: https://img.shields.io/codeclimate/github/dobtco/storage_unit.svg
+[2]: https://img.shields.io/coveralls/dobtco/storage_unit.svg
+[3]: https://img.shields.io/gem/v/storage_unit.svg

data/lib/storage_unit.rb

@@ -0,0 +1,3 @@
+require 'storage_unit/setup'
+require 'storage_unit/core'
+ActiveRecord::Base.send :include, StorageUnit::Setup

data/lib/storage_unit/core.rb

@@ -0,0 +1,59 @@
+module StorageUnit
+  module Core
+    extend ActiveSupport::Concern
+
+    included do
+      default_scope { where(with_deleted_scope_sql) }
+      define_model_callbacks :trash
+      define_model_callbacks :recover
+    end
+
+    module ClassMethods
+      def with_deleted_scope_sql
+        all.table[storage_unit_opts[:column]].eq(nil).to_sql
+      end
+
+      # lifted from acts_as_paranoid, works around https://github.com/rails/rails/issues/4306
+      # with this in place Post.limit(10).with_deleted, will work as expected
+      def with_deleted
+        scope = self.all
+        scope.where_values.delete(with_deleted_scope_sql)
+        scope
+      end
+    end
+
+    def trashed?
+      send(storage_unit_opts[:column]).present?
+    end
+
+    def trash!
+      run_callbacks :trash do
+        update_columns trash_hash(DateTime.now)
+        trash_dependents
+      end
+    end
+
+    def trash_dependents
+      storage_unit_opts[:cascade].each do |x|
+        send(x).update_all trash_hash(DateTime.now)
+      end
+    end
+
+    def recover!(opts = {})
+      run_callbacks :recover do
+        update_columns trash_hash(nil)
+        recover_dependents
+      end
+    end
+
+    def recover_dependents
+      storage_unit_opts[:cascade].each do |x|
+        send(x).with_deleted.update_all trash_hash(nil)
+      end
+    end
+
+    def trash_hash(value)
+      {}.tap { |h| h[storage_unit_opts[:column]] = value }
+    end
+  end
+end

data/lib/storage_unit/setup.rb

@@ -0,0 +1,21 @@
+module StorageUnit
+  module Setup
+    extend ActiveSupport::Concern
+
+    included do
+    end
+
+    module ClassMethods
+      def has_storage_unit(opts = {})
+        cattr_accessor :storage_unit_opts
+
+        self.storage_unit_opts = {
+          column: :deleted_at,
+          cascade: []
+        }.merge(opts)
+
+        include StorageUnit::Core
+      end
+    end
+  end
+end

data/lib/storage_unit/version.rb

@@ -0,0 +1,3 @@
+module StorageUnit
+  VERSION = '0.0.1'
+end

data/spec/setup.rb

@@ -0,0 +1,14 @@
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+
+ActiveRecord::Schema.define(:version => 1) do
+  create_table :users do |t|
+    t.datetime :deleted_at
+    t.datetime :trashed_at
+  end
+
+  create_table :notes do |t|
+    t.integer :user_id
+    t.datetime :deleted_at
+    t.text :body
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require 'coveralls'
+Coveralls.wear!
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  Coveralls::SimpleCov::Formatter,
+  SimpleCov::Formatter::HTMLFormatter
+]
+
+require 'rails/all'
+require 'storage_unit'
+require 'rspec/rails'
+require_relative 'setup'
+
+RSpec.configure do |c|
+  c.use_transactional_fixtures = true
+end

data/spec/storage_unit_spec.rb

@@ -0,0 +1,165 @@
+require 'spec_helper'
+
+class User < ActiveRecord::Base
+  self.table_name = 'users'
+  has_storage_unit
+end
+
+class UserWithTrashedAtColumn < ActiveRecord::Base
+  self.table_name = 'users'
+  has_storage_unit column: :trashed_at
+end
+
+class TrashableNote < ActiveRecord::Base
+  self.table_name = 'notes'
+  has_storage_unit
+  validates :body, presence: true
+end
+
+class UserWithNote < ActiveRecord::Base
+  self.table_name = 'users'
+  has_many :notes, class_name: 'NoteForUser', foreign_key: 'user_id'
+  has_storage_unit cascade: [:notes]
+end
+
+class NoteForUser < TrashableNote
+  belongs_to :user, class_name: 'UserWithNote'
+end
+
+describe 'Options' do
+  describe 'column' do
+    let!(:user) { UserWithTrashedAtColumn.create }
+
+    it 'functions properly' do
+      expect(UserWithTrashedAtColumn.count).to eq 1
+      user.trash!
+      expect(UserWithTrashedAtColumn.count).to eq 0
+    end
+  end
+
+  describe 'cascade' do
+    let!(:user) { UserWithNote.create }
+    let!(:note) { NoteForUser.create(body: 'foo', user: user) }
+
+    describe '#trash!' do
+      it 'trashes associated records' do
+        expect(user.deleted_at).to be_blank
+        expect(note.deleted_at).to be_blank
+        user.trash!
+        expect(user.reload.deleted_at).to be_present
+        expect(note.reload.deleted_at).to be_present
+      end
+    end
+
+    describe '#recover!' do
+      before do
+        user.update_attributes deleted_at: Time.now
+        note.update_attributes deleted_at: Time.now
+      end
+
+      it 'recovers associated records' do
+        expect(user.deleted_at).to be_present
+        expect(note.deleted_at).to be_present
+        user.recover!
+        expect(user.reload.deleted_at).to be_blank
+        expect(note.reload.deleted_at).to be_blank
+      end
+    end
+  end
+end
+
+describe 'Default scope' do
+  let!(:user) { User.create }
+
+  it 'excludes trashed objects' do
+    expect(User.count).to eq 1
+    user.update deleted_at: Time.now
+    expect(User.count).to eq 0
+  end
+
+  it 'can be overridden' do
+    expect(User.count).to eq 1
+    user.update deleted_at: Time.now
+    expect(User.with_deleted.count).to eq 1
+  end
+end
+
+describe '#trashed?' do
+  let!(:user) { User.create }
+  subject { user }
+
+  it { should_not be_trashed }
+
+  context 'when trashed' do
+    before { user.update deleted_at: Time.now }
+    it { should be_trashed }
+  end
+end
+
+describe '#trash!' do
+  let!(:user) { User.create }
+
+  it 'functions properly' do
+    expect(user.deleted_at).to be_blank
+    user.trash!
+    expect(user.deleted_at).to be_present
+    expect(user.reload.deleted_at).to be_present
+  end
+
+  context 'with callbacks' do
+    before do
+      User.before_trash :do_before_trash
+      User.after_trash :do_after_trash
+      User.around_trash :do_around_trash
+    end
+
+    it 'calls them' do
+      expect(user).to receive(:do_before_trash)
+      expect(user).to receive(:do_after_trash)
+      expect(user).to receive(:do_around_trash)
+      user.trash!
+    end
+  end
+end
+
+describe '#recover!' do
+  let!(:user) { User.create(deleted_at: Time.now) }
+
+  it 'functions properly' do
+    expect(user.deleted_at).to be_present
+    user.recover!
+    expect(user.deleted_at).to be_blank
+    expect(user.reload.deleted_at).to be_blank
+  end
+
+  context 'with callbacks' do
+    before do
+      User.before_recover :do_before_recover
+      User.after_recover :do_after_recover
+      User.around_recover :do_around_recover
+    end
+
+    it 'calls them' do
+      expect(user).to receive(:do_before_recover)
+      expect(user).to receive(:do_after_recover)
+      expect(user).to receive(:do_around_recover)
+      user.recover!
+    end
+  end
+
+  context 'when invalid' do
+    let!(:note) do
+      note = TrashableNote.new(deleted_at: Time.now)
+      note.save(validate: false)
+      note
+    end
+
+    it 'does not care' do
+      expect {
+        note.recover!
+      }.to_not raise_error
+
+      expect(note).to_not be_valid
+    end
+  end
+end

data/storage_unit.gemspec

@@ -0,0 +1,27 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+# Maintain your gem's version:
+require "storage_unit/version"
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name = "storage_unit"
+  s.version = StorageUnit::VERSION
+
+  s.required_ruby_version = Gem::Requirement.new('>= 2.0.0')
+  s.authors = ['Adam Becker']
+  s.summary = 'Soft deletion for Rails 4, done right.'
+  s.email = 'adam@dobt.co'
+  s.license = 'MIT'
+
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- {features,spec}/*`.split("\n")
+
+  s.homepage = 'http://github.com/dobtco/storage_unit'
+
+  s.add_dependency 'rails', '~> 4.1', '>= 4.1.0'
+
+  s.add_development_dependency 'coveralls'
+  s.add_development_dependency 'rspec-rails'
+  s.add_development_dependency 'sqlite3'
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: storage_unit
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Adam Becker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - ">="
+      - !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'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  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'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: 
+email: adam@dobt.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.md
+- README.md
+- lib/storage_unit.rb
+- lib/storage_unit/core.rb
+- lib/storage_unit/setup.rb
+- lib/storage_unit/version.rb
+- spec/setup.rb
+- spec/spec_helper.rb
+- spec/storage_unit_spec.rb
+- storage_unit.gemspec
+homepage: http://github.com/dobtco/storage_unit
+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.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Soft deletion for Rails 4, done right.
+test_files:
+- spec/setup.rb
+- spec/spec_helper.rb
+- spec/storage_unit_spec.rb