delayed_crud 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bd40962c309572ce01973c6ee3f7ab8c76b5ceb46aa59e8019e8cbf5102493ca
+  data.tar.gz: 43902ed47039a512a205236902bec343634d72c7aac9747ad0903efbdb078a76
+SHA512:
+  metadata.gz: e6f5927e32e11a6278c328a0b59868672acaff72cd91dfd5b0e1951440851fb065a700a8c9168815ecee1d271f405ff974e4faacaaaef3ce6b53e6fa44c6c24f
+  data.tar.gz: ed880f6215e19602ea851d88d929b2f01a61ea057c527d66b7c11e70fda0741168e4b8e84ff345f51e6da9e3663bcfa742e2cd69e25ab84e1f1cc5469f948469

data/.rubocop.yml

@@ -0,0 +1,23 @@
+AllCops:
+  TargetRubyVersion: 2.6
+  NewCops: enable
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/ClassLength:
+  Max: 200
+
+Metrics/MethodLength:
+  Max: 20
+
+Metrics/AbcSize:
+  Max: 20

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+## [Unreleased]
+
+## [0.1.1] - 2024-02-24
+
+- Updaate readme
+
+## [0.1.0] - 2024-02-24
+
+- Initial release

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 slmusayev@gmail.com. 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 Suleyman Musayev
+
+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,51 @@
+# DelayedCrud
+
+The `delayed_crud` gem simplifies database CRUD operations in your Ruby on Rails applications by utilizing preconfigured Sidekiq background jobs.
+
+## Installation
+To install the gem run the following command in the terminal:
+
+  $ bundle add delayed_crud
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+  $ gem install delayed_crud
+
+## Usage
+
+This gem provides three convenient methods for common CRUD operations, each accepting timer arguments with keywords `:in` and `:after`. Please note that the timer starts counting down as soon as the code line is executed. Since the gem relies on `sidekiq`, the execution timing might not be precise.
+
+### delayed_create
+The `delayed_create` method can be used on a model instance and accepts instance attributes in a hash along with a timer argument.
+
+```ruby
+  Customer.delayed_create({ status: :new }, in: 10.minutes.from_now)
+```
+
+### delayed_update
+The `delayed_update` method works on an existing record and accepts update attributes in a hash along with a timer argument.
+
+```ruby
+  HeatedDiscussion.delayed_update({ frozen: false }, after: 24.hours)
+```
+
+### delayed_destroy
+The `delayed_destroy` method can be used on an existing record and accepts only a timer argument. The record will be destroyed once the timer expires.
+
+```ruby
+TrialAccount.delayed_destroy(in: 1.week.from_now)
+```
+
+## Contributing
+
+The best way to contribute would be to fork this repo, create a new branch from main, to merge the branch into main of the fork once the new code is in place and then open a pull request to merge forked main into the main of the present repo.
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/msuliq/delayed_crud. 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/msuliq/delayed_crud/blob/main/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 DelayedCrud project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/msuliq/delayed_crud/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/delayed_crud.gemspec

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative "lib/delayed_crud/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "delayed_crud"
+  spec.version = DelayedCrud::VERSION
+  spec.authors = ["Suleyman Musayev"]
+  spec.email = ["slmusayev@gmail.com"]
+
+  spec.summary = "The `delayed_crud` gem provides method to perform database CRUD
+   operations in Ruby on Rails applications as preconfigured `sidekiq` background job."
+  spec.description = "This gem provides three convenient methods for common CRUD operations:
+   `delayed_create`, `delayed_update` and `delayed_destroy` as preconfigured `sidekiq`
+   background job for Ruby on Rails applications."
+
+  spec.homepage = "https://github.com/msuliq/delayed_crud"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.0.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/msuliq/delayed_crud"
+  spec.metadata["changelog_uri"] = "https://github.com/msuliq/delayed_crud/blob/main/CHANGELOG.md"
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  # 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", "~> 5.0"
+  spec.add_dependency "sidekiq", "~> 2.15"
+end

data/lib/delayed_crud/background_job_handler/sidekiq_handler.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "delayed_crud/worker/sidekiq_worker"
+
+module DelayedCrud
+  module BackgroundJobHandler
+    module SidekiqHandler # :nodoc:
+      def self.delayed_create(record, attributes, options)
+        DelayedCrud::Worker::SidekiqWorker.perform_with_delay(operation: :create, record: record,
+                                                              attributes: attributes, options: options)
+      end
+
+      def self.delayed_update(record, attributes, options)
+        DelayedCrud::Worker::SidekiqWorker.perform_with_delay(operation: :update, record: record,
+                                                              attributes: attributes, options: options)
+      end
+
+      def self.delayed_destroy(record, options)
+        DelayedCrud::Worker::SidekiqWorker.perform_with_delay(operation: :destroy, record: record, options: options)
+      end
+    end
+  end
+end

data/lib/delayed_crud/background_job_handler.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+Dir[File.expand_path("background_job_handler/*.rb", __dir__)].sort.each do |file|
+  require_relative file
+end
+
+module DelayedCrud
+  module BackgroundJobHandler # :nodoc:
+    module_function
+
+    def delayed_create(record, attributes, options = {})
+      handler_instance.delayed_create(record, attributes, options)
+    end
+
+    def delayed_update(record, attributes, options = {})
+      handler_instance.delayed_update(record, attributes, options)
+    end
+
+    def delayed_destroy(record, options = {})
+      handler_instance.delayed_destroy(record, options)
+    end
+
+    def handler_instance
+      handler_class = "#{DelayedCrud.queue_adapter.to_s.capitalize}Handler"
+      DelayedCrud::BackgroundJobHandler.const_get(handler_class)
+    end
+  end
+end

data/lib/delayed_crud/job/sidekiq_job.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "sidekiq"
+
+module DelayedCrud
+  module Job # :nodoc:
+    module SidekiqJob # :nodoc:
+      class DelayedCrudJob # :nodoc:
+        include Sidekiq::Worker
+
+        sidekiq_options queue: :default, tags: ["delayed_crud_job"]
+
+        def perform(class_name, record_id, operation, attributes = {})
+          record = record_id ? class_name.constantize.find(record_id) : class_name.constantize
+
+          case operation.to_sym
+          when :create, :update
+            record.send(operation, attributes)
+          when :destroy
+            record.send(operation)
+          else
+            raise ArgumentError, "Unsupported operation: #{operation}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/delayed_crud/model_extension.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "delayed_crud/background_job_handler"
+
+module DelayedCrud
+  module ModelExtension # :nodoc:
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def delayed_create(attributes, options = {})
+        DelayedCrud::BackgroundJobHandler.delayed_create(new, attributes, options)
+      end
+    end
+
+    def delayed_update(options = {})
+      background_job_handler.delayed_update(self, options)
+    end
+
+    def delayed_destroy(options = {})
+      background_job_handler.delayed_destroy(self, options)
+    end
+
+    private
+
+    def background_job_handler
+      @background_job_handler ||= DelayedCrud::BackgroundJobHandler
+    end
+  end
+end

data/lib/delayed_crud/railtie.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "delayed_crud/model_extension"
+
+module DelayedCrud
+  class Railtie < Rails::Railtie # :nodoc:
+    # Include the model extension into ActiveRecord::Base
+    ActiveSupport.on_load(:active_record) do
+      ActiveRecord::Base.include DelayedCrud::ModelExtension
+    end
+  end
+end

data/lib/delayed_crud/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module DelayedCrud
+  VERSION = "0.1.1"
+end

data/lib/delayed_crud/worker/sidekiq_worker.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "sidekiq"
+require "delayed_crud/job/sidekiq_job"
+
+module DelayedCrud
+  module Worker
+    module SidekiqWorker # :nodoc:
+      def self.perform_with_delay(operation:, record:, attributes: {}, options: {})
+        raise ArgumentError, "Missing operation for a delayed transaction" if operation.nil?
+
+        delay = DelayedCrud.calculate_delay(options[:in] || options[:after])
+
+        record_id = record.try(:id)
+        serialized_attributes = attributes.transform_keys(&:to_s)
+        class_name = record_id ? record.class.name : record.name
+
+        Sidekiq::Client.enqueue_in(delay.seconds, DelayedCrud::Job::SidekiqJob::DelayedCrudJob, class_name, record_id,
+                                   operation.to_s, serialized_attributes)
+      end
+    end
+  end
+end

data/lib/delayed_crud/worker.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "delayed_crud/worker/sidekiq_worker"
+
+module DelayedCrud
+  module Worker; end # :nodoc:
+end

data/lib/delayed_crud.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require "delayed_crud/version"
+require "delayed_crud/railtie" if defined?(Rails::Railtie)
+
+module DelayedCrud # :nodoc:
+  class << self
+    attr_accessor :queue_adapter
+  end
+
+  def self.configure
+    yield self
+  end
+
+  def self.setup
+    return if queue_adapter
+
+    self.queue_adapter = :sidekiq
+  end
+
+  def self.calculate_delay(time_specification)
+    raise ArgumentError, "Cannot perform transaction without time specification" unless time_specification
+
+    if time_specification.respond_to?(:from_now)
+      delay = (time_specification.from_now - Time.now).to_i
+    elsif time_specification.respond_to?(:to_i)
+      delay = (time_specification - Time.now).to_i
+    else
+      raise ArgumentError, "Invalid time specification: #{time_specification}"
+    end
+
+    unless delay.positive?
+      raise ArgumentError,
+            "Cannot perform #{operation} with negative time specification: #{options[:in] || options[:after]}"
+    end
+
+    delay
+  end
+
+  class Error < StandardError; end
+end
+
+DelayedCrud.setup

data/sig/delayed_crud.rbs

@@ -0,0 +1,4 @@
+module DelayedCrud
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: delayed_crud
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Suleyman Musayev
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-02-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.15'
+description: |-
+  This gem provides three convenient methods for common CRUD operations:
+     `delayed_create`, `delayed_update` and `delayed_destroy` as preconfigured `sidekiq`
+     background job for Ruby on Rails applications.
+email:
+- slmusayev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- delayed_crud.gemspec
+- lib/delayed_crud.rb
+- lib/delayed_crud/background_job_handler.rb
+- lib/delayed_crud/background_job_handler/sidekiq_handler.rb
+- lib/delayed_crud/job/sidekiq_job.rb
+- lib/delayed_crud/model_extension.rb
+- lib/delayed_crud/railtie.rb
+- lib/delayed_crud/version.rb
+- lib/delayed_crud/worker.rb
+- lib/delayed_crud/worker/sidekiq_worker.rb
+- sig/delayed_crud.rbs
+homepage: https://github.com/msuliq/delayed_crud
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/msuliq/delayed_crud
+  source_code_uri: https://github.com/msuliq/delayed_crud
+  changelog_uri: https://github.com/msuliq/delayed_crud/blob/main/CHANGELOG.md
+  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: The `delayed_crud` gem provides method to perform database CRUD operations
+  in Ruby on Rails applications as preconfigured `sidekiq` background job.
+test_files: []