replace_with_destroy 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 78cf23a4bee5cbddca1e6b2f8b3a694f8514d4ba8f8ef6d89a9d3f29ed85b72d
-  data.tar.gz: 69460f5ef330e5f66d5a98325245ae1b38096d9ece8b7a0eb0bb4de6e252e957
+  metadata.gz: 9651f245d829790a6af5844f5158b3a8ea96a0c2cfbc99dde6c90447aadbe6cf
+  data.tar.gz: 2232361b4341baf823038e34ed8ebe2d1d1c94fec8b0b1f21b7df680bddb2da3
 SHA512:
-  metadata.gz: c797a08f7a595a885988a73f2a04fb21db5dffc351480887aa04d5da9c24264683b0ded4f05a7e15b869e58a39b9844a8d3e39a061e5e8fbde71d8223f0df4ad
-  data.tar.gz: 50a5a6aa7b7d9648639e385546451e6d7b0734846f43a141499d488e113d44a2a582332cf30f02d73e6f18ef3eeeade509537d35f4ad1f4f00f6f5b8b82e13b5
+  metadata.gz: a806b8164eff5ca9b5189529715e7646a24381268656445241ff41997a57152e4a86c89ed6dc2bd402631651fe35eda64db40cc8ced0ecabab30163db99e1ed9
+  data.tar.gz: 33065c4c9e87a5d2344d321f92e18e04e06e70e68aae49d0c3178d692a859f093a20faa708acf64e143a786ed8d166b8cf4a570d9f10c09963f264a985be27d6

data/README.md

@@ -1,8 +1,9 @@
-# ReplaceWithDestroy
-Short description and motivation.
+# Replace with Destroy
+Based on Rails guide [Automatic deletion of join models is direct, no destroy callbacks are triggered.](https://guides.rubyonrails.org/association_basics.html#the-has-many-through-association), which means, Rails will not run destroy callbacks for `has_many` through join model.
 
-## Usage
-How to use my plugin.
+This gem allow you running the destroy callbacks in the join model.
+
+This could be useful if you are using [paranoia](https://github.com/rubysherpas/paranoia) and you want change it to un-active instead delete the join model.
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -21,8 +22,50 @@ Or install it yourself as:
 $ gem install replace_with_destroy
 ```
 
-## Contributing
-Contribution directions go here.
+## Usage
+### *replace_with_destroy* option.  
+Pass the option `replace_with_destroy: true` to the `has_many` method.
+```
+class User < ApplicationRecord
+  has_many :bookings
+  has_many :rooms, through: :bookings, replace_with_destroy: true
+end
+
+class Booking < ApplicationRecord
+  belongs_to :user
+  belongs_to :room
+  
+  after_destroy :my_custom_method
+
+  def my_custom_method
+    # do whatever you want here ...
+  end
+end
+
+class Room < ApplicationRecord
+  ...
+end
+```
+
+Then, given the User `user` with rooms `[1,2,3]` you can change his `rooms` and this automatically call Booking destroy callbacks.
+```
+# given a User with rooms
+> user.room_ids
+[1, 2, 3]
+
+# you can change his rooms
+user.room_ids = [3, 4, 5]
+# this add the rooms 4 and 5 and remove the rooms 1 and 2
+# my_custom_method will be executed for rooms 1 and 2 when being removed
+```
+
+### global *replace_with_destroy* option.
+You can add this behavior for all `has_many` methods without need to pass it as option.
+
+To do that, create an initializer, for example `config/initializers/replace_with_destroy.rb`, and put the following code
+```
+ReplaceWithDestroy::ALL = true
+```
 
 ## License
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -14,11 +14,6 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-
-
-
-
-
 require 'bundler/gem_tasks'
 
 require 'rake/testtask'

data/lib/replace_with_destroy.rb

@@ -27,9 +27,3 @@ module ActiveRecord
 end
 
 ActiveRecord::Associations::Builder::Association::VALID_OPTIONS << :replace_with_destroy
-
-p "+++++++++++++++++++++++++++++++++++++++++++++++++++++"
-p "+++++++++++++++++++++++++++++++++++++++++++++++++++++"
-p "+++++++++++++++++++++++++++++++++++++++++++++++++++++"
-p "+++++++++++++++++++++++++++++++++++++++++++++++++++++"
-p "Running Replace with destroy"

data/lib/replace_with_destroy/version.rb

@@ -1,3 +1,3 @@
 module ReplaceWithDestroy
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: replace_with_destroy
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Alexander Leyva
@@ -30,7 +30,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.0.7.2
-description: Description of ReplaceWithDestroy.
+description: By default automatic deletion of join models is direct, no destroy callbacks
+  are triggered. This gem allow changes the default Rails behavior.
 email:
 - cyberxander90@gmail.com
 executables: []
@@ -42,7 +43,7 @@ files:
 - Rakefile
 - lib/replace_with_destroy.rb
 - lib/replace_with_destroy/version.rb
-homepage: http://rubygems.org/gems/replace_with_destroy
+homepage: https://github.com/cyberxander90/replace_with_destroy
 licenses:
 - MIT
 metadata: {}
@@ -65,5 +66,5 @@ rubyforge_project:
 rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: Summary of ReplaceWithDestroy.
+summary: Call destroy callback on removed records when Rails update join models
 test_files: []