soft_deleter 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b07926d2e933d2130b86b24432f696a7cb55426accf3c921e111707abeba93f2
-  data.tar.gz: c220f8ad356001fcc61ad1d4bfc372302b02fd5c253d7772c7d9692c096e3b7c
+  metadata.gz: 128f9591b3e2fa2005aa7bb7722c83291a341af111d2f208bdba0bd5bcd050dd
+  data.tar.gz: 6e2cd7dea9ebfdee761cbad7a615920da78a378394ed51c9a8f67b48571af08b
 SHA512:
-  metadata.gz: e534f6c8e9c0cf861b779a6bea0060ca792b2ba9dd37bf4558c805ecfc7039895ddf3684c3892d91edb826a2af4e6294bc1cda8134ed420af369d6f399c1c5ec
-  data.tar.gz: 1239740720c61a1c008dd9dff21c5f4f8d3590bea20c86d2a4d50f909c6c151012bfdfc3e4016bcc10bbcd120adc7ce576d7e7ebd7307d9efec2e0ab2279f3bf
+  metadata.gz: a99e22f07eda44d726c803aa9f0a2c95f831a1f2af52788663c32b4eb577eadda9fec044a822f03c161e8533fee514e6de18faa9de7b411d9f866d92bce4c757
+  data.tar.gz: f4b7c19000066067279b95a79e85895a78a1db457f769a5801e6adb3f5c4b213f5a479d791ab17c91dc6ab548c50b2c5341cfd14fbff6883caaf901d428e8159

data/README.md

@@ -1,8 +1,5 @@
 # SoftDeleter
-Short description and motivation.
-
-## Usage
-How to use my plugin.
+soft delete Rails plugin.
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -17,10 +14,105 @@ $ bundle
 ```
 
 Or install it yourself as:
-```bash
+```
 $ gem install soft_deleter
 ```
 
+## Usage
+### Introduce
+Soft delete model User.
+```
+bundle exec rails g soft_deleter user
+```
+It creates migration file to create user with attributes which is needed to introduce soft delete.<br/>
+Add some attributes to migration file, like name, email, age, ...etc.<br />
+And excute `bundle exec rails db:migrate`. That's all.<br />
+<br />
+Or if you already have User model, and you want introduce soft delete in it,
+create migration file and add lines like bellow
+```ruby
+class AddSoftDeleterAttributesToUsers < ActiveRecord::Migration[7.0]
+  def change
+    add_column :users, :deleter_type, :string
+    add_column :users, :deleter_id, :integer
+    add_column :users, :deleted_at, :timestamp
+  end
+end
+```
+and excute `bundle exec rails db:migrate`<br />
+Here, `deleter_type` and `deleter_id`, these are the infomations who soft delete.<br />
+Like `current_admin`, when admin which is "Admin" class does soft delete user record, admin's class name and id can be recorded.
+<br /><br />
+And add line to model
+```ruby
+class User < ApplicationRecord
+  include SoftDeleter
+end
+```
+This line is added automatically if you use `rails g soft_deleter user` command to make user model.
+
+### scope
+When you load users whitout soft deleted records, you need to scope like bellow.
+```ruby
+users = User.enabled.all
+```
+If you don't use enabled scope, you will load users in all records including soft deleted.<br />
+Otherwise, if you need to load records with soft deleted, excute like bellow.
+```ruby
+deleted_users = User.deleted.all
+```
+
+### Soft delete
+```ruby
+user = User.enabled.first
+user.soft_delete                 # soft delete
+user.soft_delete!                # soft delete or raise if fail to soft delete
+user.restore                     # restore soft deleted user
+```
+If your app have some models other than user, like `Admin` model,<br />
+and you need to record to that Admin user did soft delete.<br />
+Then,
+```ruby
+user = User.enabled.first
+
+admin = Admin.enabled.first     # soft deleted by admin user
+user.soft_delete(admin)         # soft delete and set admin to deleter
+user.soft_delete!(admin)        # raise if fail to soft delete
+
+user.deleter                    # => <Admin:0x00007f37f96a0c88
+user.deleter_type               # => Admin(id: integer, ...
+user.deleter_id                 # => "admin.id" if deleter is not set, "user.id"
+user.soft_deleted?              # => true
+user.alive?                     # => false
+```
+
+## Associations
+If associations some models, User, Book, Section.
+```ruby
+# User model
+class User < ApplicationRecord
+  include SoftDeleter
+  has_many :books, dependent: :destroy
+end
+
+# Book model
+class Book < ApplicationRecord
+  include SoftDeleter
+  belongs_to :user
+  has_many :sections, dependent: :destroy
+end
+
+# Section model
+class Section < ApplicationRecord
+  include SoftDeleter
+  belongs_to :book
+end
+```
+So, if you excute `user.soft_delete`, then associations books, and sections are soft deleted.<br />
+And excute `user.restore`, then associations books, and sections are restored.<br />
+It works with dependent destroy descriptions. If not, it doesn't work.
+
+
 ## Contributing
 Contribution directions go here.
 

data/lib/soft_deleter/version.rb

@@ -1,3 +1,3 @@
 module SoftDeleter
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: soft_deleter
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - testCodeV01
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-15 00:00:00.000000000 Z
+date: 2023-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,20 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 7.0.7
-- !ruby/object:Gem::Dependency
-  name: rspec-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: SoftDeleter.
 email:
 - qft-tk-1213@tk-labo.com