immortal 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 60ac9bd43b41aa290750329470ab9cd76e8adcb3
-  data.tar.gz: a779e1fb76253a4148f62e186c347be7ed19c847
+  metadata.gz: 487cc9848fc342f7f15e64970c3f470462396991
+  data.tar.gz: 271bf192210787e34fbb19c642178ddde59f587c
 SHA512:
-  metadata.gz: 34bddc9c389145c501948b6255821a30424cd126fca8e6367a1ee65f7d99d32ea96fe53c684575d3c0c184f9c962fca802c1786e351e6b65d4ce858669ad70cf
-  data.tar.gz: a34d764cdc236d6cb6f055c32bdeb2eab35448390171af5988eaa0accca696e2a843d87f683cd65a9f753624b97168fb1569e5d4994c8ddfd4e85fb9bdda9db2
+  metadata.gz: 0edc1fa5dba903469dbc21284009b4edf3f62dbb1eeaaec32078d6ba591705da2d40de0ae6eab9d92d6a55b8a2d35a7f6282001e9cd492dc9808416f24d8768a
+  data.tar.gz: 5deeee14ae09920532785f3b64d98d6579436274982ae2772508c779ac992a6973028b407dab0af4fd5ccaa1f2a9d76b6c08ba4b6ece4a5b90de11ef93473f3a

data/.gitignore

@@ -3,3 +3,6 @@ pkg/*
 .bundle
 .Gemfile.lock
 Gemfile.lock
+bin
+spec/examples.txt
+.byebug_history

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--format progress
+--color

data/.rubocop.yml

@@ -0,0 +1 @@
+require: 'rubocop-rspec'

data/CHANGELOG.md

@@ -0,0 +1,114 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+## [3.0.0]
+### Added
+
+- Modern gem management
+- Contributor Covenant CoC
+
+### Changed
+
+- Upgraded rspec and tests syntax
+
+### Deprecated
+
+- Rails versions smaller than 4.1.x
+
+### Removed
+
+- Support for rails versions below 4.1.x
+
+### Fixed
+### Security
+
+## [2.0.0]
+### Deprecated
+
+- Rails versions smaller than 4.0.x
+
+### Removed
+
+- Support for rails versions below 4.0.x
+
+## [1.0.5]
+
+### Changed
+
+- Use separate internal accessors for with/only_deleted singular association readers
+
+## [1.0.4] 
+### Changed
+
+- Extract with_deleted singular assoc readers to separate module
+
+## [1.0.3] 
+### Added
+
+- Added back feature where using immortal finders doesn't unscope association scopes.
+
+## [1.0.2] 
+### Added
+
+- Added with/only_deleted singular association readers (see specs)
+
+## [1.0.1] 
+### Added
+
+- Made compatible with Rails 3.1.X
+
+## [1.0.0] 
+### Changed
+
+- Changed the API, made it compatible with Rails 3.1, removed functionality
+
+## [0.1.6] 
+### Fixed
+
+- issue 2: with_deleted breaks associations
+
+## [0.1.5] 
+### Added
+
+- "without deleted" scope to join model by overriding
+  HasManyThroughAssociation#construct_conditions rather than simply adding to
+  has_many conditions.
+
+## [0.1.4] 
+### Fixed
+
+- Bug where ALL records of any dependent associations were immortally deleted if
+  assocation has `:dependant => :delete_all` option set
+
+## [0.1.3] 
+### Fixed
+
+- Bug where join model is not immortal
+
+## [0.1.2] 
+### Fixed
+
+- Loading issue when the `deleted` column doesn't exist (or even the table)
+
+## [0.1.1] 
+### Fixed
+
+- Behavior with `has_many :through` associations
+
+[Unreleased]: https://github.com/teambox/immortal/compare/v3.0.0...HEAD
+[3.0.0]: https://github.com/teambox/immortal/compare/v2.0.0...v3.0.0
+[2.0.0]: https://github.com/teambox/immortal/compare/v1.0.5...v2.0.0
+[1.0.5]: https://github.com/teambox/immortal/compare/v1.0.4...v1.0.5
+[1.0.4]: https://github.com/teambox/immortal/compare/v1.0.3...v1.0.4
+[1.0.3]: https://github.com/teambox/immortal/compare/v1.0.2...v1.0.3
+[1.0.2]: https://github.com/teambox/immortal/compare/v1.0.1...v1.0.2
+[1.0.1]: https://github.com/teambox/immortal/compare/v1.0.0...v1.0.1
+[1.0.0]: https://github.com/teambox/immortal/compare/v0.1.6...v1.0.0
+[0.1.6]: https://github.com/teambox/immortal/compare/v0.1.5...v0.1.6
+[0.1.5]: https://github.com/teambox/immortal/compare/v0.1.4...v0.1.5
+[0.1.4]: https://github.com/teambox/immortal/compare/v0.1.3...v0.1.4
+[0.1.3]: https://github.com/teambox/immortal/compare/v0.1.2...v0.1.3
+[0.1.2]: https://github.com/teambox/immortal/compare/v0.1.1...v0.1.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at nflamel@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Redbooth
+
+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

@@ -1,30 +1,38 @@
 # Immortal
 
-Make any ActiveRecord model paranoid by just including `Immortal`, and instead of being deleted from the database, the object will just marked as 'deleted' with a boolean field in the database.
+Make any ActiveRecord model paranoid by just including `Immortal`, and instead
+of being deleted from the database, the object will just marked as 'deleted'
+with a boolean field in the database.
 
 ## Installation
 
 Add the gem dependency to your Gemfile:
 
-    gem 'immortal'
+```ruby
+gem 'immortal'
+```
 
 ## Usage
 
-    class User < ActiveRecord::Base
-      include Immortal
-    end
+```ruby
+class User < ActiveRecord::Base
+  include Immortal
+end
+```
 
 And add a boolean field called `deleted` to that model:
 
-    class AddDeletedToUsers < ActiveRecord::Migration
-      def self.up
-        add_column :users, :deleted, :boolean
-      end
+```ruby
+class AddDeletedToUsers < ActiveRecord::Migration
+  def self.up
+    add_column :users, :deleted, :boolean
+  end
 
-      def self.down
-        remove_column :users, :deleted
-      end
-    end
+  def self.down
+    remove_column :users, :deleted
+  end
+end
+```
 
 ## TODO
 
@@ -38,34 +46,3 @@ If you want to improve immortal
 2. Create a topic branch `git checkout -b my_feature`
 3. Push it! `git push origin my_feature`
 4. Open a pull request
-
-## CHANGELOG
-
-- 1.0.5 Use separate internal accessors for with/only_deleted singular association readers
-- 1.0.4 Extract with_deleted singular assoc readers to separate module
-- 1.0.3 Added back feature where using immortal finders doesn't unscope association scopes.
-- 1.0.2 Added with/only_deleted singular association readers (see specs)
-- 1.0.1 Made compatible with Rails 3.1.X
-- 1.0.0 Changed the API, made it compatible with Rails 3.1, removed
-  functionality
-- 0.1.6 Fixing immortal issue 2: with_deleted breaks associations
-- 0.1.5 Add "without deleted" scope to join model by overriding HasManyThroughAssociation#construct_conditions
-    rather than simply adding to has_many conditions.
-- 0.1.4 fix bug where ALL records of any dependent associations were
-  immortally deleted if assocation has :dependant => :delete_all option
-  set
-- 0.1.3 fix bug where join model is not immortal
-- 0.1.2 fix loading issue when the `deleted` column doesn't exist (or even the table)
-- 0.1.1 fix behavior with `has_many :through` associations
-
-## License
-
-(The MIT License)
-
-Copyright (c) Teambox
-
-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/Rakefile

@@ -1,2 +1,2 @@
-require 'bundler'
-Bundler::GemHelper.install_tasks
+require "bundler/gem_tasks"
+task :default => :spec

data/immortal.gemspec

@@ -1,28 +1,35 @@
-# -*- encoding: utf-8 -*-
-$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'immortal/version'
 
-Gem::Specification.new do |s|
-  s.name        = 'immortal'
-  s.version     = '2.0.0'
-  s.authors     = [
+Gem::Specification.new do |spec|
+  spec.name          = 'immortal'
+  spec.version       = Immortal::VERSION
+  spec.authors       = [
     'Jordi Romero', 'Saimon Moore', 'Pau Ramon', 'Carlos Saura', 'Andres Bravo',
     'Fran Casas', 'Pau Perez'
   ]
-  s.email       = ['jordi@jrom.net', 'saimon@saimonmoore.net']
-  s.homepage    = 'http://github.com/teambox/immortal'
-  s.summary     = 'Replacement for acts_as_paranoid for Rails 4'
-  s.description = 'Typical paranoid gem built for Rails 4 and with the ' \
-                  "minimum code needed to satisfy acts_as_paranoid's API"
-  s.license     = 'MIT'
+  spec.email         = ['jordi@jrom.net', 'saimon@saimonmoore.net']
+  spec.homepage      = 'http://github.com/teambox/immortal'
+  spec.summary       = 'Replacement for acts_as_paranoid for Rails 4'
+  spec.description   = 'Typical paranoid gem built for Rails 4 and with the ' \
+                       "minimum code needed to satisfy acts_as_paranoid's API"
+  spec.license       = 'MIT'
 
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {spec}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
-  s.require_paths = ['lib']
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = %w[lib]
 
-  s.add_dependency 'activerecord', '~> 4.0.0'
-  s.add_development_dependency 'rspec', '~> 2.6.0'
-  s.add_development_dependency 'sqlite3'
-  s.add_development_dependency 'byebug'
-  s.add_development_dependency 'rake', '~> 10.0'
+  spec.add_dependency 'activerecord', '~> 4.1.0'
+  spec.add_development_dependency 'rspec', '~> 3.6.0'
+  spec.add_development_dependency 'rspec-its'
+  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-rspec'
+  spec.add_development_dependency 'reek'
 end

data/lib/immortal.rb

@@ -1,31 +1,34 @@
 require 'immortal/belongs_to'
 
+# Include +Immortal+ module to activate soft delete on your model.
 module Immortal
+  COLUMN_NAME = 'deleted'.freeze
 
   def self.included(base)
     base.send :extend, ClassMethods
     base.send :include, InstanceMethods
     base.send :include, BelongsTo
+
     base.class_eval do
       class << self
-        alias :mortal_delete_all :delete_all
-        alias :delete_all :immortal_delete_all
+        alias_method :mortal_delete_all, :delete_all
+        alias_method :delete_all, :immortal_delete_all
       end
     end
   end
 
   module ClassMethods
-
+    # @return [Boolean] whether the model supports immortal or not
     def immortal?
-      self.included_modules.include?(::Immortal::InstanceMethods)
+      included_modules.include?(::Immortal::InstanceMethods)
     end
 
     def without_default_scope
-      new_scope = self.unscoped
-      our_scope = self.current_scope || self.unscoped
+      new_scope = unscoped
+      our_scope = current_scope || unscoped
 
       non_immortal_constraints_sql = our_scope.arel.constraints.to_a.map do |constraint|
-        constraint.to_sql.split('AND').reject{|clause| clause.include?('deleted')}
+        constraint.to_sql.split('AND').reject { |clause| clause.include?(COLUMN_NAME) }
       end.flatten.join(' AND ')
 
       new_scope = new_scope.merge(our_scope.except(:where))
@@ -37,7 +40,7 @@ module Immortal
     end
 
     def exists?(id = false)
-      where(deleted: false).exists?(id)
+      mortal.exists?(id)
     end
 
     def count_with_deleted(*args)
@@ -48,38 +51,24 @@ module Immortal
 
     def count_only_deleted(*args)
       without_default_scope do
-        where(deleted: true).count(*args)
+        immortal.count(*args)
       end
     end
 
-    def where_with_deleted(*args)
+    def where_with_deleted(conditions)
       without_default_scope do
-        where(*args)
+        where(conditions)
       end
     end
 
-    def find_with_deleted(*args)
-      ActiveSupport::Deprecation.warn('[immortal] we are deprecating #find_with_deleted use where_with_deleted instead')
+    def where_only_deleted(conditions)
       without_default_scope do
-        find(*args)
-      end
-    end
-
-    def where_only_deleted(*args)
-      without_default_scope do
-        where(deleted: true).where(args)
-      end
-    end
-
-    def find_only_deleted(*args)
-      ActiveSupport::Deprecation.warn('[immortal] we are deprecating #find_only_deleted use where_only_deleted instead')
-      without_default_scope do
-        where(deleted: true).find(*args)
+        immortal.where(conditions)
       end
     end
 
     def immortal_delete_all(conditions = nil)
-      unscoped.where(conditions).update_all(deleted: 1)
+      unscoped.where(conditions).update_all(COLUMN_NAME => 1)
     end
 
     def delete_all!(*args)
@@ -87,26 +76,31 @@ module Immortal
     end
 
     def undeleted_clause_sql
-      unscoped.where(deleted: false).constraints.first.to_sql
+      unscoped.mortal.constraints.first.to_sql
     end
 
     def deleted_clause_sql
-      unscoped.where(arel_table[:deleted].eq(true)).constraints.first.to_sql
+      unscoped.where(arel_table[COLUMN_NAME].eq(true)).constraints.first.to_sql
     end
-
   end
 
   module InstanceMethods
     def self.included(base)
-      unless base.table_exists? && base.columns_hash["deleted"] && !base.columns_hash["deleted"].null
-        Kernel.warn "[Immortal] The 'deleted' column in #{base.to_s} is nullable, change the column to not accept NULL values"
+      unless base.table_exists? && base.columns_hash[COLUMN_NAME] && !base.columns_hash[COLUMN_NAME].null
+        Kernel.warn(
+          "[Immortal] The '#{COLUMN_NAME}' column in #{base} is nullable, " \
+          'change the column to not accept NULL values'
+        )
       end
 
       base.class_eval do
-        default_scope { ->{ where(deleted: false) } } if arel_table[:deleted]
+        scope(:mortal, -> { where(COLUMN_NAME => false) })
+        scope(:immortal, -> { where(COLUMN_NAME => true) })
 
-        alias :mortal_destroy :destroy
-        alias :destroy :immortal_destroy
+        default_scope { -> { mortal } } if arel_table[COLUMN_NAME]
+
+        alias_method :mortal_destroy, :destroy
+        alias_method :destroy, :immortal_destroy
       end
     end
 
@@ -123,23 +117,35 @@ module Immortal
     end
 
     def destroy_without_callbacks
-      self.class.unscoped.where(id: id).update_all(deleted: true, updated_at: current_time_from_proper_timezone)
+      scoped_record.update_all(
+        COLUMN_NAME => true,
+        updated_at: current_time_from_proper_timezone
+      )
+
       @destroyed = true
       reload
       freeze
     end
 
     def recover!
-      self.class.unscoped.where(id: id).update_all(deleted: false, updated_at: current_time_from_proper_timezone)
+      scoped_record.update_all(
+        COLUMN_NAME => false,
+        updated_at: current_time_from_proper_timezone
+      )
+
       @destroyed = false
       reload
     end
 
     private
 
+    # @return [ActiveRecord::Relation]
+    def scoped_record
+      self.class.unscoped.where(id: id)
+    end
+
     def current_time_from_proper_timezone
       ActiveRecord::Base.default_timezone == :utc ? Time.now.utc : Time.now
     end
-
   end
 end