soft_deleter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b07926d2e933d2130b86b24432f696a7cb55426accf3c921e111707abeba93f2
+  data.tar.gz: c220f8ad356001fcc61ad1d4bfc372302b02fd5c253d7772c7d9692c096e3b7c
+SHA512:
+  metadata.gz: e534f6c8e9c0cf861b779a6bea0060ca792b2ba9dd37bf4558c805ecfc7039895ddf3684c3892d91edb826a2af4e6294bc1cda8134ed420af369d6f399c1c5ec
+  data.tar.gz: 1239740720c61a1c008dd9dff21c5f4f8d3590bea20c86d2a4d50f909c6c151012bfdfc3e4016bcc10bbcd120adc7ce576d7e7ebd7307d9efec2e0ab2279f3bf

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2023 
+
+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,28 @@
+# SoftDeleter
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "soft_deleter"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install soft_deleter
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"

data/lib/generators/soft_deleter_generator.rb

@@ -0,0 +1,19 @@
+class SoftDeleterGenerator < Rails::Generators::NamedBase
+  argument :attributes, type: :array, default: []
+
+  def out
+    snake_name = name.underscore
+    add_attributes = attributes.map do |attr|
+      arg = "#{attr.name}:#{attr.type}"
+      arg += ":index" if attr.has_index?
+      arg += ":uniq" if attr.has_uniq_index?
+      arg += "{#{attr.attr_options[:limit]}}" if attr.attr_options.present?
+      arg
+    end.join(" ")
+    
+    system("bundle exec rails g model #{name} #{add_attributes} deleter_type:string deleter_id:integer deleted_at:timestamp")
+    system("sed -e '2i \\  include SoftDeleter' app/models/#{snake_name}.rb > app/models/_tmp.rb")
+    system("rm app/models/#{snake_name}.rb")
+    system("mv app/models/_tmp.rb app/models/#{snake_name}.rb")
+  end
+end

data/lib/soft_deleter/railtie.rb

@@ -0,0 +1,4 @@
+module SoftDeleter
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/soft_deleter/version.rb

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

data/lib/soft_deleter.rb

@@ -0,0 +1,100 @@
+require "soft_deleter/version"
+require "soft_deleter/railtie"
+
+module SoftDeleter
+  extend ActiveSupport::Concern
+
+  included do
+    scope :enabled, -> { where(deleted_at: nil) }
+    scope :deleted, -> { where.not(deleted_at: nil) }
+  end
+
+  class_methods do
+    def included_tables
+      result = %i[has_many has_one].map { |a| self.reflect_on_all_associations(a) }.flatten.filter_map do |i|
+        next unless %i[destroy delete delete_all].include?(i.options[:dependent]) && i.options.keys.exclude?(:through)
+
+        i.options[:class_name]&.underscore&.pluralize&.to_sym || i.name
+      end.compact
+      result
+    end
+  end
+
+  def soft_delete!(deleter = self)
+    ActiveRecord::Base.transaction do
+      with_associations(:soft_delete_witout_associations!, deleter)
+    end
+
+    true
+  end
+
+  def soft_delete(deleter = self)
+    ActiveRecord::Base.transaction do
+      with_associations(:soft_delete_witout_associations, deleter)
+    end
+
+    true
+  end
+
+  def restore
+    ActiveRecord::Base.transaction do
+      with_associations(:restore_without_associations)
+    end
+  end
+
+  def deleter_type
+    self[:deleter_type].constantize if self.soft_deleted?
+  end
+
+  def soft_deleted?
+    self.deleted_at.present?
+  end
+
+  def alive?
+    self.deleted_at.nil?
+  end
+
+  def deleter
+    self.deleter_type&.find_by(id: self.deleter_id)
+  end
+
+  protected
+
+  def with_associations(callback, deleter = nil)
+    child_tables = self.class.included_tables
+    childs = child_tables.map do |child_table|
+      self.send(child_table)
+    end.flatten
+
+    childs.compact.each { |child| child.with_associations(callback, deleter) }
+
+    send(callback, deleter) if deleter.present?
+    send(callback) if deleter.blank?
+  end
+
+  private
+
+  def soft_delete_witout_associations!(deleter)
+    update!(
+      deleter_type: deleter.class.to_s,
+      deleter_id: deleter.id,
+      deleted_at: Time.zone.now
+    )
+  end
+
+  def soft_delete_witout_associations(deleter)
+    update(
+      deleter_type: deleter.class.to_s,
+      deleter_id: deleter.id,
+      deleted_at: Time.zone.now
+    )
+  end
+
+  def restore_without_associations
+    update(
+      deleter_type: nil,
+      deleter_id: nil,
+      deleted_at: nil
+    )
+  end
+end

data/lib/tasks/soft_deleter_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :soft_deleter do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: soft_deleter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- testCodeV01
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-08-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !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
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/generators/soft_deleter_generator.rb
+- lib/soft_deleter.rb
+- lib/soft_deleter/railtie.rb
+- lib/soft_deleter/version.rb
+- lib/tasks/soft_deleter_tasks.rake
+homepage: https://github.com/testCodeV01
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://github.com/testCodeV01
+  source_code_uri: https://github.com/testCodeV01/soft_deleter
+  changelog_uri: https://github.com/testCodeV01
+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: []
+rubygems_version: 3.3.3
+signing_key: 
+specification_version: 4
+summary: SoftDeleter.
+test_files: []