historical_society 0.1.0

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+db

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rvmrc

@@ -0,0 +1 @@
+rvm use ruby-1.9.2@historical_society --create

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in historical_society.gemspec
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2011 New Leaders Ventures, LLC., Robert Bousquet
+
+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,43 @@
+HistoricalSociety -- Preserve the history of your data, starting with soft delete.
+====================================
+
+## DESCRIPTION
+
+The historical society gem currently provides basic soft delete functionality on an ActiveRecord instance through the use
+of a "deleted_at" timestamp column and a default_scope that excludes the soft deleted records.
+
+_Note: This currently provides a default_scope that excludes soft deleted records.  It also overrides
+the normal #destroy and #delete instance methods so they just set the deleted_at timestamp without
+actually deleting the records from the db._
+
+## INSTALLATION
+
+    $ gem install historical_society
+
+## USAGE
+
+In your model:
+
+    class User < ActiveRecord::Base
+      include HistoricalSociety
+    end
+
+In your queries:
+
+    User.all          # does not include deleted records
+    User.unscoped.all # includes deleted records
+
+    User.find(1)           # raises ActiveRecord::RecordNotFound if user has been soft deleted
+    User.unscoped.find(1)  # finds user record regardless of soft deletion
+
+In relationships:
+
+    @account.users  # finds only users within the account scope that have not been soft deleted
+    @account.users.unscoped # CAREFUL! THIS REMOVES THE ACCOUNT SCOPE TOO!
+
+    # THIS IS PROBABLY WHAT YOU WANT
+    # Removes the default scope on user, but then adds the account scope through an explicit where method.
+
+    User.unscoped.all.where(:account_id => @account.id)
+
+

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+# If you want to make this the default task
+task :default => :spec

data/historical_society.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "historical_society/version"
+
+Gem::Specification.new do |s|
+  s.name        = "historical_society"
+  s.version     = HistoricalSociety::VERSION
+  s.authors     = ["Robert Bousquet"]
+  s.email       = ["rbousquet@newleaders.com"]
+  s.homepage    = "https://github.com/bousquet/historical_society"
+  s.summary     = "Preserve the history of a db record"
+  s.description = "Currently offers soft deletion, and a default scope that excludes 'deleted' records"
+
+  s.rubyforge_project = "historical_society"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "sqlite3"
+  s.add_runtime_dependency "activerecord",  "~> 3.1.0"
+  s.add_runtime_dependency "activesupport", "~> 3.1.0"
+end

data/lib/historical_society.rb

@@ -0,0 +1,36 @@
+require "historical_society/version"
+
+module HistoricalSociety
+  extend ActiveSupport::Concern
+  # Model must include a deleted_at datetime column, default NULL
+  included do
+    default_scope lambda {
+      field = [self.table_name, "deleted_at"].map{|str|"`#{str}`"}.join(".")
+      where(["#{field} IS NULL OR (#{field} IS NOT NULL AND #{field} > ?)", historical_time])
+    }
+  end
+
+  module ClassMethods
+    def historical_time
+      (Time.zone || Time).now
+    end
+  end
+
+  module InstanceMethods
+
+    def destroy
+      set_deleted_at
+    end
+
+    def delete
+      set_deleted_at
+    end
+
+    private
+
+    def set_deleted_at
+      update_attribute(:deleted_at, self.class.historical_time)
+    end
+
+  end
+end

data/lib/historical_society/version.rb

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

data/spec/spec_helper.rb

@@ -0,0 +1,38 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'active_record'
+require 'active_support'
+
+require 'historical_society'
+
+RSpec.configure do |config|
+
+  root = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+  ActiveRecord::Base.establish_connection(
+    :adapter => "sqlite3",
+    :database => "#{root}/db/historical_society.db"
+  )
+
+  ActiveRecord::Base.connection.execute("DROP TABLE IF EXISTS 'users'")
+  ActiveRecord::Base.connection.create_table(:users) do |t|
+    t.string :name
+    t.datetime :deleted_at
+  end
+
+  class User < ActiveRecord::Base
+    include HistoricalSociety
+  end
+
+  config.before(:each) do
+    ActiveRecord::Base.connection.increment_open_transactions
+    ActiveRecord::Base.connection.begin_db_transaction
+  end
+
+  config.after(:each) do
+    ActiveRecord::Base.connection.rollback_db_transaction
+    ActiveRecord::Base.connection.decrement_open_transactions
+  end
+
+end

data/spec/user_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+describe User do
+
+  describe "User queries with paranoia" do
+    let!(:user) { User.create(:name => "Bob") }
+    let!(:deleted_user) { User.create(:name => "Steve", :deleted_at => 5.minutes.ago) }
+
+    it "should be in default scope" do
+      User.all.should include(user)
+    end
+
+    it "should not include undeleted user" do
+      User.all.should_not include(deleted_user)
+    end
+
+    it "should have deleted users in unscoped queries" do
+      User.unscoped.all.should include(user)
+      User.unscoped.all.should include(deleted_user)
+    end
+  end
+
+  describe "User deletion with paranoia" do
+    let!(:user) { User.create(:name => "Bob") }
+
+    before :each do
+      user.destroy
+    end
+
+    it "should have deleted_at time" do
+      user.deleted_at.is_a?(Time).should be_true
+    end
+
+    it "should not be findable by default" do
+      expect { User.find(user.id) }.to raise_error(ActiveRecord::RecordNotFound)
+    end
+
+    it "should be findable via unscoped" do
+      expect { User.unscoped.find(user.id) }.to_not raise_error(ActiveRecord::RecordNotFound)
+    end
+  end
+
+  describe "User with another default_scope" do
+    before :each do
+      class User < ActiveRecord::Base
+        include HistoricalSociety
+        default_scope order(:name)
+      end
+    end
+
+    it "should combine default scopes" do
+      User.scoped.to_sql.should include("ORDER BY name")
+      User.scoped.to_sql.should include("`users`.`deleted_at` IS NOT NULL")
+    end
+  end
+
+
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: historical_society
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Robert Bousquet
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-09-12 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70115113351260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70115113351260
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70115113350340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70115113350340
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &70115113349880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70115113349880
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &70115113349320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70115113349320
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70115113348560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70115113348560
+description: Currently offers soft deletion, and a default scope that excludes 'deleted'
+  records
+email:
+- rbousquet@newleaders.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- historical_society.gemspec
+- lib/historical_society.rb
+- lib/historical_society/version.rb
+- spec/spec_helper.rb
+- spec/user_spec.rb
+homepage: https://github.com/bousquet/historical_society
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: historical_society
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: Preserve the history of a db record
+test_files:
+- spec/spec_helper.rb
+- spec/user_spec.rb