paranoid42 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e570b02db22769fdd1f075786855bb8a0f69b86c
+  data.tar.gz: 50b87789f4e9598ab3ef6684746cd54692230fd8
+SHA512:
+  metadata.gz: 9bb7953888ba744e8836b14fefa60061fe5df737ba007d5612cd9c8b3e9583cf932224cabf0b689b42ae706c01e6ce17840543717a68c75149b988e81eb5230e
+  data.tar.gz: 332914f9bf6b643c64cccecc22d79b992ba7f53c5aff9ac13bd17f89d935136bc762db0da835e4d7ad3a52437709932b162c58eefbd39064d8748280c4659860

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Anjlab
+
+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,106 @@
+# Paranoid42
+
+[paranoid2](https://github.com/anjlab/paranoid2) ideas (and code) adapted for rails 4.2
+
+Rails 4.2 introduced adequate record, but in order to take advantage of the improvements, default_scope can't be used. Paranoid42 removes the default scope from Paranoid2. This means you have to be explicit about telling your app not to return deleted records.
+
+Paranoid42 removes the default scope and adds a new `not_deleted` method to your paranoid classes.
+
+So this:
+
+```
+> Special.where(name: "test")
+
+SELECT "specials".* FROM "specials" WHERE (deleted_at IS NULL) AND "specials"."name" = $1  [["name", "test"]]
+```
+
+Turns into this:
+
+```
+> Special.not_deleted.where(name: "test")
+
+SELECT "specials".* FROM "specials" WHERE (deleted_at IS NULL) AND "specials"."name" = $1  [["name", "test"]]
+```
+
+If you would rather use a shorter method, just create a method with your preferred name, and reference `not_deleted`:
+
+```
+def active
+  not_deleted
+end
+```
+
+[Benchmarks](https://gist.github.com/effektz/f18e1be522a328a981b9)
+
+## Paranoid2
+
+Rails 4 defines `ActiveRecord::Base#destroy!` so `Paranoid42` gem use `force: true` arg to force destroy.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'paranoid42'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Add `deleted_at: datetime` to your model.
+Generate and run migrations.
+
+```
+rails g migration AddDeletedAtToClients deleted_at:datetime
+```
+```ruby
+class AddDeletedAtToClients < ActiveRecord::Migration
+  def change
+    add_column :clients, :deleted_at, :datetime
+  end
+end
+```
+
+```ruby
+
+class Client < ActiveRecord::Base
+  paranoid
+end
+
+c = Client.find(params[:id])
+
+# will set destroyed_at time
+c.destroy
+
+# will restore object and all it's associations
+c.restore
+
+# will restore only this object without it's associations
+c.restore(associations: false)
+
+# will destroy object for real
+c.destroy(force: true)
+
+# also useful scopes are available
+Client.only_deleted
+
+```
+
+### With paperclip
+
+```ruby
+class Listing < ActiveRecord::Base
+  has_attached_file :image,
+    # ...
+    preserve_files: true
+end
+```
+
+## 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,10 @@
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs.push "spec"
+  t.test_files = FileList['spec/**/*_spec.rb']
+end
+
+task default: :test

data/lib/paranoid42/persistence.rb

@@ -0,0 +1,88 @@
+module Paranoid42
+  module Persistence
+    extend ActiveSupport::Concern
+
+    def destroy(opts = {})
+      with_paranoid(opts) { super() }
+    end
+
+    def destroy!(opts = {})
+      with_paranoid(opts) { super() }
+    end
+
+    def delete(opts = {})
+      with_paranoid(opts) do
+        touch(:deleted_at) if !deleted? && persisted?
+        self.class.unscoped { super() } if paranoid_force
+      end
+    end
+
+    def restore(opts={})
+      return if !destroyed?
+
+      attrs = timestamp_attributes_for_update_in_model
+      current_time = current_time_from_proper_timezone
+      changes = {}
+      attrs.each do |column|
+        changes[column.to_s] = write_attribute(column.to_s, current_time)
+      end
+      changes['deleted_at'] = write_attribute('deleted_at', nil)
+
+      changes[self.class.locking_column] = increment_lock if locking_enabled?
+
+      @changed_attributes.except!(*changes.keys)
+      primary_key = self.class.primary_key
+      self.class.unscoped.where({ primary_key => self[primary_key] }).update_all(changes)
+
+      if opts.fetch(:associations) { true }
+        restore_associations
+      end
+    end
+
+    def restore_associations
+      self.class.reflect_on_all_associations.each do |a|
+        next unless a.klass.paranoid?
+
+        if a.collection?
+          send(a.name).restore_all
+        else
+          a.klass.unscoped { send(a.name).try(:restore) }
+        end
+      end
+    end
+
+    def destroyed?
+      !deleted_at.nil?
+    end
+
+    def persisted?
+      !new_record?
+    end
+
+    alias :deleted? :destroyed?
+
+    def destroy_row
+      if paranoid_force
+        self.deleted_at = Time.now
+        super
+      else
+        delete
+        1
+      end
+    end
+
+    module ClassMethods
+      def paranoid? ; true ; end
+
+      def destroy_all!(conditions = nil)
+        with_paranoid(force: true) do
+          destroy_all(conditions)
+        end
+      end
+
+      def restore_all
+        only_deleted.each &:restore
+      end
+    end
+  end
+end

data/lib/paranoid42/scoping.rb

@@ -0,0 +1,17 @@
+module Paranoid42
+  module Scoping
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+
+      def not_deleted
+        where(deleted_at: nil)
+      end
+
+      def only_deleted
+        where.not(deleted_at: nil)
+      end
+
+    end
+  end
+end

data/lib/paranoid42/version.rb

@@ -0,0 +1,3 @@
+module Paranoid42
+  VERSION = '1.0.0'
+end

data/lib/paranoid42.rb

@@ -0,0 +1,52 @@
+require 'paranoid42/version'
+
+require 'active_support/concern'
+require 'active_record'
+
+require 'paranoid42/persistence'
+require 'paranoid42/scoping'
+
+module Paranoid42
+  extend ActiveSupport::Concern
+
+  def paranoid?
+    self.class.paranoid?
+  end
+
+  def paranoid_force
+    self.class.paranoid_force
+  end
+
+  def with_paranoid value, &block
+    self.class.with_paranoid value, &block
+  end
+
+  module ClassMethods
+    def paranoid? ; false ; end
+
+    def paranoid
+      include Persistence
+      include Scoping
+    end
+
+    alias acts_as_paranoid paranoid
+
+    def with_paranoid opts={}
+      forced = opts[:force] || paranoid_force
+      previous, self.paranoid_force = paranoid_force, forced
+      return yield
+    ensure
+      self.paranoid_force = previous
+    end
+
+    def paranoid_force= value
+      Thread.current['paranoid_force'] = value
+    end
+
+    def paranoid_force
+      Thread.current['paranoid_force']
+    end
+  end
+end
+
+ActiveRecord::Base.send :include, Paranoid42

data/paranoid42.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'paranoid42/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "paranoid42"
+  gem.version       = Paranoid42::VERSION
+  gem.authors       = ["effektz", "yury"]
+  gem.email         = ["alexweidmann@gmail.com", "yury.korolev@gmail.com"]
+  gem.description   = %q{paranoid models for rails 4.2}
+  gem.summary       = %q{paranoid models for rails 4.2}
+  gem.homepage      = "https://github.com/effektz/paranoid42"
+  gem.license       = "MIT"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'activerecord', '>= 4.2.0'
+
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "sqlite3"
+end

data/spec/paranoid42_spec.rb

@@ -0,0 +1,200 @@
+require_relative 'spec_helper'
+
+describe Paranoid42 do
+  it 'has a version number' do
+    Paranoid42::VERSION.wont_be_nil
+  end
+
+  let(:object) { model.new }
+
+  describe PlainModel do
+    let(:model) { PlainModel }
+    before { model.unscoped.delete_all }
+
+    it 'is not paranoid' do
+      model.wont_be :paranoid?
+    end
+
+    it 'has not paranoid object' do
+      object.wont_be :paranoid?
+    end
+
+    it 'has default destroy behavior' do
+      model.count.must_equal 0
+      object.save!
+      model.count.must_equal 1
+      object.destroy
+      object.deleted_at.must_be_nil
+      object.must_be :frozen?
+      model.count.must_equal 0
+      model.unscoped.count.must_equal 0
+    end
+  end
+
+  describe ParanoidModel do
+    let(:model) { ParanoidModel }
+    before { model.unscoped.destroy_all! }
+
+    it 'is paranoid' do
+      model.must_be :paranoid?
+    end
+
+    it 'has paranoid object' do
+      object.must_be :paranoid?
+    end
+
+    it 'returns valid value with to_param' do
+      object.save
+      param = object.to_param
+      object.destroy
+      object.to_param.wont_be_nil
+      object.to_param.must_equal param
+    end
+
+    it "it doesn't actually destroy object" do
+      model.count.must_equal 0
+      object.save!
+      model.count.must_equal 1
+      object.destroy
+      object.deleted_at.wont_be_nil
+      object.must_be :frozen?
+      model.not_deleted.count.must_equal 0
+      model.count.must_equal 1
+    end
+
+    it 'has working only_deleted scope' do
+      a = model.create
+      a.destroy
+      b = model.create
+      model.only_deleted.last.must_equal a
+      model.only_deleted.wont_include b
+    end
+
+    it 'restores' do
+      a = model.create
+      a.destroy
+      a.must_be :destroyed?
+      b = model.only_deleted.find(a.id)
+      b.restore
+      b.reload
+      b.wont_be :destroyed?
+    end
+
+    it 'can be force destroyed' do
+      object.save
+      object.destroy(force: true)
+      object.must_be :destroyed?
+      model.unscoped.count.must_equal 0
+    end
+
+    it 'can be force deleted' do
+      object.save
+      object.delete(force: true)
+      model.unscoped.count.must_equal 0
+    end
+
+    it 'works with relation scopes' do
+      parent1 = ParentModel.create
+      parent2 = ParentModel.create
+      a = model.create(parent_model: parent1)
+      b = model.create(parent_model: parent2)
+      a.destroy
+      b.destroy
+      parent1.paranoid_models.not_deleted.count.must_equal 0
+      parent1.paranoid_models.only_deleted.count.must_equal 1
+      model.create(parent_model: parent1)
+    end
+
+    it 'allows "Model#includes"' do
+      parent1 = ParentModel.create
+      parent2 = ParentModel.create
+      model.create(parent_model: parent1)
+      model.create(parent_model: parent2)
+      model.includes(:parent_model).references(:parent_model).to_a
+    end
+
+    it 'works with has_many_through relationships' do
+      employer = Employer.create
+      employee = Employee.create
+      employer.jobs.count.must_equal 0
+      employer.employees.count.must_equal 0
+      employee.jobs.count.must_equal 0
+      employee.employers.count.must_equal 0
+      job = Job.create employer: employer, employee: employee
+      employer.jobs.count.must_equal 1
+      employer.employees.count.must_equal 1
+      employee.jobs.count.must_equal 1
+      employee.employers.count.must_equal 1
+      employee2 = Employee.create
+      Job.create employer: employer, employee: employee2
+      employee2.destroy
+      employer.jobs.count.must_equal 2
+      employer.employees.not_deleted.count.must_equal 1
+      job.destroy
+      employer.jobs.not_deleted.count.must_equal 1
+      employer.employees.not_deleted.count.must_equal 1
+      employee.jobs.not_deleted.count.must_equal 0
+      employee.employers.not_deleted.count.must_equal 1
+    end
+
+    it 'restores has_many associations' do
+      parent = ParentModel.create
+      a = model.create(parent_model: parent)
+      parent.destroy
+      a.reload
+      parent.must_be :destroyed?
+      a.must_be :destroyed?
+      parent = ParentModel.unscoped.find(parent.id)
+      parent.restore
+      a.reload
+      parent.wont_be :destroyed?
+      a.wont_be :destroyed?
+    end
+
+    it 'restores belongs_to associations' do
+      parent = ParentModel.create
+      a = model.create(parent_model: parent)
+      parent.destroy
+      a.reload
+      parent.must_be :destroyed?
+      a.must_be :destroyed?
+      a.restore
+      a.wont_be :destroyed?
+      a.parent_model.wont_be :destroyed?
+    end
+  end
+
+  describe CallbackModel do
+    let(:model) { CallbackModel }
+
+    it 'delete without callback' do
+      object.save
+      object.delete
+      object.callback_called.must_be_nil
+    end
+
+    it 'destroy with callback' do
+      object.save
+      object.destroy
+      object.callback_called.must_equal true
+    end
+  end
+
+  describe FeaturefulModel do
+    let(:model) { FeaturefulModel }
+    before { model.unscoped.destroy_all! }
+
+    it 'chains paranoid models' do
+      scope = model.where(name: 'foo').only_deleted
+      scope.where_values_hash['name'].must_equal 'foo'
+    end
+
+    it 'validates uniqueness with scope' do
+      a = model.create!(name: 'yury', phone: '9106701550')
+      b = model.create(name: 'effektz', phone: '3034207100')
+      b.wont_be :valid?
+      a.destroy
+      b.must_be :valid?
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+require 'bundler'
+Bundler.require
+
+require 'minitest/autorun'
+
+DB_FILE = 'tmp/test_db'
+
+FileUtils.mkpath File.dirname(DB_FILE)
+FileUtils.rm_f DB_FILE
+
+ActiveRecord::Base.establish_connection adapter: 'sqlite3', :database => DB_FILE
+
+[ 'CREATE TABLE parent_models (id INTEGER NOT NULL PRIMARY KEY, deleted_at DATETIME)',
+  'CREATE TABLE paranoid_models (id INTEGER NOT NULL PRIMARY KEY, parent_model_id INTEGER, deleted_at DATETIME)',
+  'CREATE TABLE featureful_models (id INTEGER NOT NULL PRIMARY KEY, deleted_at DATETIME, name VARCHAR(32), phone VARCHAR(20))',
+  'CREATE TABLE plain_models (id INTEGER NOT NULL PRIMARY KEY, deleted_at DATETIME)',
+  'CREATE TABLE callback_models (id INTEGER NOT NULL PRIMARY KEY, deleted_at DATETIME)',
+  'CREATE TABLE related_models (id INTEGER NOT NULL PRIMARY KEY, parent_model_id INTEGER NOT NULL, deleted_at DATETIME)',
+  'CREATE TABLE employers (id INTEGER NOT NULL PRIMARY KEY, deleted_at DATETIME)',
+  'CREATE TABLE employees (id INTEGER NOT NULL PRIMARY KEY, deleted_at DATETIME)',
+  'CREATE TABLE jobs (id INTEGER NOT NULL PRIMARY KEY, employer_id INTEGER NOT NULL, employee_id INTEGER NOT NULL, deleted_at DATETIME)'
+].each {|script| ActiveRecord::Base.connection.execute script }
+
+require_relative 'spec_models'

data/spec/spec_models.rb

@@ -0,0 +1,61 @@
+class ParentModel < ActiveRecord::Base
+  has_many :paranoid_models, dependent: :destroy
+end
+
+class PlainModel < ActiveRecord::Base
+end
+
+class ParanoidModel < ActiveRecord::Base
+  acts_as_paranoid
+
+  belongs_to :parent_model
+end
+
+class FeaturefulModel < ActiveRecord::Base
+  paranoid
+
+  validates :name, presence: true, uniqueness: true
+  validates :phone, uniqueness: {conditions: -> { not_deleted } }
+
+  scope :find_last, lambda {|name| where(name: name).last }
+end
+
+class CallbackModel < ActiveRecord::Base
+  paranoid
+
+  attr_accessor :callback_called
+
+  before_destroy {|model| model.callback_called = true }
+end
+
+class ParentModel < ActiveRecord::Base
+  paranoid
+  has_many :related_models
+end
+
+class RelatedModel < ActiveRecord::Base
+  paranoid
+
+  belongs_to :parent_model
+end
+
+class Employer < ActiveRecord::Base
+  paranoid
+
+  has_many :jobs
+  has_many :employees, through: :jobs
+end
+
+class Employee < ActiveRecord::Base
+  paranoid
+
+  has_many :jobs
+  has_many :employers, through: :jobs
+end
+
+class Job < ActiveRecord::Base
+  paranoid
+
+  belongs_to :employer
+  belongs_to :employee
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: paranoid42
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- effektz
+- yury
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.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'
+- !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: paranoid models for rails 4.2
+email:
+- alexweidmann@gmail.com
+- yury.korolev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/paranoid42.rb
+- lib/paranoid42/persistence.rb
+- lib/paranoid42/scoping.rb
+- lib/paranoid42/version.rb
+- paranoid42.gemspec
+- spec/paranoid42_spec.rb
+- spec/spec_helper.rb
+- spec/spec_models.rb
+homepage: https://github.com/effektz/paranoid42
+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.4.5
+signing_key: 
+specification_version: 4
+summary: paranoid models for rails 4.2
+test_files:
+- spec/paranoid42_spec.rb
+- spec/spec_helper.rb
+- spec/spec_models.rb