status_assignable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 619499be038a8c119a14b9b66a7bf0b922b018c14a4258ccff64c94ca255407d
+  data.tar.gz: 9e34b56aff3b351b09ca01f6d220d6d38cb5af097c7394f09f63db4aced48b2c
+SHA512:
+  metadata.gz: afa83054aab31159694681db991ad7470083bc07ec3869abfb7b1c2f958988f1c069622da27633d98dce610cd3f6de2da52e197db1d8125605754b2f0d800f18
+  data.tar.gz: 84b0626e4ebde55f1a6828c935e1b68f07ac1e3c76ca1bd15b82806cd22b2ee0b1df3deba52009b27b7085027d5c786465df02456c8d0e1cda8811ef7f4a25bf

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,6 @@
+require:
+  - rubocop-rake
+
+AllCops:
+  TargetRubyVersion: 3.0
+  NewCops: enable

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders 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, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at TODO: Write your email address. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 TODO: Write your name
+
+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,125 @@
+# Status Assignable
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'status_assignable', git: 'https://github.com/tieeeeen1994/rails-status-assignable'
+```
+
+After that, run the following command:
+```bash
+rails g status_assignable_patch
+```
+
+This will install the monkey patcher so that the gem can hook itself properly into the Rails application.
+
+## Usage
+
+### Model
+
+In your model, add the following line:
+
+```ruby
+class ModelName < ApplicationRecord
+  include StatusAssignable
+
+  # ...
+end
+```
+
+Then add a new migration that will add a status column to the model's database table:
+
+```bash
+rails g migration AddStatusToModelName
+```
+
+```ruby
+class AddStatusToModelName < ActiveRecord::Migration[<RAILS VERSION>]
+  def change
+    add_column :model_names, :status, :integer, default: 1
+    # 0 = deleted, 1 = active, 2 = inactive
+  end
+end
+```
+
+Your model is now status assignable!
+
+```ruby
+my_model = ModelName.find(1)
+my_model.inactive! # Set the status to inactive
+my_model.inactive? # true
+my_model.deleted! # Set the status to deleted
+my_model.deleted? # true
+my_model.active! # Set the status to active
+my_model.active? # true
+my_model.soft_destroy # Archive the record with callbacks and its associations
+my_model.archive # Alias of soft_destroy
+my_model.soft_delete # Directly update the column in the database and also update its associations
+```
+
+#### Custom Status
+
+You can also add your own status if need be. For example, if you want to add a `pending` status:
+
+```ruby
+class ModelName < ApplicationRecord
+  include StatusAssignable[pending: 3]
+  # ...
+end
+```
+
+This will add a `pending` status for your model. You can then use it like so:
+
+```ruby
+my_model = ModelName.find(1)
+my_model.pending! # Set the status to pending
+my_model.pending? # true
+```
+
+**Take note that the application will raise an exception if the default statuses are overridden. Use different key-value pair for your custom status if that happens.**
+
+### Associations
+
+Model associations are also supported. For example, if you have a `User` that has many `Post`s and `Comment`s, you can add the following line to the `User` model:
+
+```ruby
+class User < ApplicationRecord
+  include StatusAssignable
+
+  has_many :posts, dependent: :destroy, archive: :callbacks
+  has_many :comments, dependent: :delete_all, archive: :assign
+end
+```
+
+The `archive` option can be set to `:callbacks` or `:assign`. If set to `:callbacks`, the associated records will be archived using `soft_destroy`. If set to `:assign`, the associated records will have their status columns assigned directly.
+
+It is important that the associations also are `StatusAssignable`!
+
+### Callbacks
+
+Callbacks are only fired when `archive` or `soft_destroy` is called. `soft_delete` **never** fires callbacks (the association will use callbacks if it has the `archive: :callbacks` option).
+
+There are callback hooks supported for `soft_destroy`: `before_soft_destroy`, `around_soft_destroy`, `after_soft_destroy`. They work like any model callbacks, so use them if need be when archiving a record.
+
+```ruby
+class Post < ApplicationRecord
+  include StatusAssignable
+
+  before_destroy -> { versions.destroy_all }
+  before_soft_destroy :update_and_unlink_versions
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/tieeeeen1994/status_assignable. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/status_assignable/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Status Assignable project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/status_assignable/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[rubocop]

data/lib/generators/status_assignable_patch_generator.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+# Generates a patch for Rails so that status assignable models can have their associations archived when soft deleted.
+class StatusAssignablePatchGenerator < Rails::Generators::Base
+  source_root File.expand_path('templates', __dir__)
+
+  def create_patch_file
+    template 'monkey_patch.rb.erb', File.join('config/initializers/status_assignable.rb')
+  end
+end

data/lib/generators/templates/monkey_patch.rb.erb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+Rails.application.reloader.to_prepare do
+  ActiveRecord::Associations::Builder::Association.singleton_class.prepend StatusAssignable::Association
+end

data/lib/status_assignable/association.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module StatusAssignable
+  # This will allow the model to allow custom :archive option to be valid.
+  # The values accepted by the :archive option are :callbacks and :assign.
+  module Association
+    CUSTOM_VALID_OPTIONS = [:archive].freeze
+    VALID_ARCHIVE_OPTIONS = %i[callbacks assign].freeze
+
+    private
+
+    def valid_options(options)
+      super(options) + CUSTOM_VALID_OPTIONS
+    end
+
+    def define_callbacks(model, reflection)
+      if (archive_option_value = reflection.options[:archive])
+        check_archive_options(archive_option_value)
+      end
+      super(model, reflection)
+    end
+
+    def check_archive_options(archive_option_value)
+      return if VALID_ARCHIVE_OPTIONS.include? archive_option_value
+
+      message = "The :archive option must be one of #{VALID_ARCHIVE_OPTIONS}, but is :#{archive_option_value}"
+      raise ArgumentError, message
+    end
+  end
+end

data/lib/status_assignable/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module StatusAssignable
+  VERSION = '0.1.0'
+end

data/lib/status_assignable.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+require_relative 'status_assignable/version'
+require_relative 'status_assignable/association'
+
+# Allows for soft deletion of records.
+# Include this module in your model to enable soft deletion.
+# e.g:
+#   class User < ApplicationRecord
+#     include StatusAssignable
+#   end
+# This requires a status column with type integer to be present in the model's table.
+module StatusAssignable
+  extend ActiveSupport::Concern
+
+  DEFAULT_STATUSES = { deleted: 0, active: 1, inactive: 2 }.freeze
+
+  def self.status_dictionary
+    @status_dictionary || { deleted: 0, active: 1, inactive: 2 }
+  end
+
+  def self.clear_dictionary
+    @status_dictionary = nil
+  end
+
+  # Allows adding custom statuses to the model's status enum.
+  # @param [Hash<Symbol, Integer>] status_dictionary Custom statuses to add.
+  # @return [StatusAssignable] Itself.
+  def self.[](status_dictionary)
+    resulting_statuses = DEFAULT_STATUSES.merge(status_dictionary)
+    raise ArgumentError, "Default statuses overridden. Don't do this." unless resulting_statuses >= DEFAULT_STATUSES
+    unless resulting_statuses.values.uniq.length == resulting_statuses.values.length
+      raise ArgumentError, 'Status values must be unique.'
+    end
+
+    @status_dictionary = resulting_statuses
+    self
+  end
+
+  included do # rubocop:disable Metrics/BlockLength
+    define_callbacks :soft_destroy, scope: %i[kind name]
+    enum status: StatusAssignable.status_dictionary
+    StatusAssignable.clear_dictionary
+
+    # Updates the status of the record directly to the database.
+    # @return [self, Boolean] Itself if true or false if failed.
+    def soft_delete
+      result = transaction do
+        archive_associations
+        update_columns(archive_params)
+      end
+      result ? self : false
+    end
+
+    # Updates the record through back to back callbacks.
+    # @return [<Type>] Itself if true or false if failed.
+    def soft_destroy
+      result = transaction do
+        run_callbacks :soft_destroy do
+          archive_associations
+          set_paper_trail_event
+          update(archive_params)
+        end
+      end
+      result ? self : false
+    end
+
+    alias_method :archive, :soft_destroy
+
+    private
+
+    def paper_trail_enabled?
+      defined?(PaperTrail) && PaperTrail.request.enabled_for_model?(self.class)
+    end
+
+    def set_paper_trail_event
+      # This uses PaperTrail's on_update method instead of destroy.
+      # However, the code sets it to destroy event due to the nature of the library.
+      self.paper_trail_event = 'destroy' if paper_trail_enabled?
+    end
+
+    def archive_params
+      @archive_params ||= { status: 'deleted', updated_at: Time.current }
+    end
+
+    def archivable_associations
+      @archivable_associations ||= self.class.reflect_on_all_associations.select do |association|
+        association.options[:archive]
+      end
+    end
+
+    def archive_associations
+      archivable_associations.each do |association|
+        archive_procedure = association.options[:archive]
+        query = send(association.name)
+        case archive_procedure
+        when :callbacks
+          query.respond_to?(:each) ? query.each(&:soft_destroy) : query.soft_destroy
+        when :assign
+          query.respond_to?(:update_all) ? query.update_all(archive_params) : query.update_columns(archive_params)
+        end
+      end
+    end
+  end
+end

data/status_assignable.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative 'lib/status_assignable/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'status_assignable'
+  spec.version = StatusAssignable::VERSION
+  spec.authors = ['Tien']
+  spec.email = ['tieeeeen1994@gmail.com']
+  spec.summary = 'Allows models to be assigned a status.'
+  spec.homepage = 'https://github.com/tieeeeen1994/rails-status-assignable'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 3.0.0'
+  spec.metadata['homepage_uri'] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .github appveyor Gemfile])
+    end
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency 'rails', '~> 7.1'
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+  spec.metadata['rubygems_mfa_required'] = 'true'
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: status_assignable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tien
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-03-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+description:
+email:
+- tieeeeen1994@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/status_assignable_patch_generator.rb
+- lib/generators/templates/monkey_patch.rb.erb
+- lib/status_assignable.rb
+- lib/status_assignable/association.rb
+- lib/status_assignable/version.rb
+- status_assignable.gemspec
+homepage: https://github.com/tieeeeen1994/rails-status-assignable
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/tieeeeen1994/rails-status-assignable
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: Allows models to be assigned a status.
+test_files: []