command_extension 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b336b279c2e6e19e9e04149abc4ba63b82ab60f253aea23026fa2f4ab86d02d1
+  data.tar.gz: 4165a879da0fb89326db030b811d38b6d782edd07bb1f1e3af3cedd38ae048a9
+SHA512:
+  metadata.gz: 00e3a9c43047cb206071cc6170eb6834a62b4d6679461bbbc26a7ec0608351125419eb126a02c92620b263618b70e1d76d7b18ff6675328e0f63ef54df239a13
+  data.tar.gz: 454ec55547de9ad7163dcd6b95bfa24e1216a4b9b3bd344eec4c46c154bdaf375b65dafa002d1a437cd0b2c37b23eedd0ab43cca6c4d02706f3a5e21d11bca57

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# idea
+.idea
+
+/Gemfile.lock

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,6 @@
+AllCops:
+  Exclude:
+    - 'command_extension.gemspec'
+
+Style/Documentation:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in command_extension.gemspec
+gemspec
+
+group :development do
+  gem 'rubocop'
+  gem 'simplecov'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Meyvn
+
+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,113 @@
+# CommandExtension
+
+Gem will help if you have a lot of commands with delayed calls, for example delayed jobs or sidekiq, and you want them to be executed only after the AR transaction is completed.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'command_extension'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install command_extension
+
+## Usage
+
+Here's a basic example of a command
+
+```ruby
+class YourCommand
+  include CommandExtension::Base
+  include CommandExtension::AfterCommit
+
+  after_commit :update_something_by_sidekiq
+  
+  def execute
+    ActiveRecord::Base.transaction do
+      ...
+      after_commit do
+        ...
+      end
+    end
+    
+    super
+  end
+  
+  def update_something_by_sidekiq
+    ...
+  end
+end
+```
+
+Another example with subcommand, you are sure that emails will be sent only if the transaction is completed
+
+```ruby
+class BaseCommand
+  include CommandExtension::Base
+  include CommandExtension::AfterCommit
+end
+
+class CreateOrderCommand < BaseCommand
+  def execute
+    ActiveRecord::Base.transaction do
+      order = Order.create()
+      
+      after_commit do
+        SendEmailToBuyer.call_async(order.user_id)
+      end
+
+      subcommand(UpdateUserProfit.new(order)).execute
+      
+      # if an error occurs then nothing will be sent
+      # raise 
+    end
+
+    super
+  end
+end
+
+class UpdateUserProfitCommand < BaseCommand
+  
+  attr_reader :order
+  
+  def initialize(order)
+    @order = order
+    
+    super()
+  end
+  
+  def execute
+    ActiveRecord::Base.transaction do
+      profit = Profit.find_by(user_id: order.seller_id)
+      profit.update_something
+      
+      after_commit do
+        SendEmailToSeller.call_async(order.seller_id)
+      end
+    end
+    
+    super
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/meyvn/command_extension. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## 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,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'command_extension'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/command_extension.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'command_extension/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'command_extension'
+  spec.version       = CommandExtension::VERSION
+  spec.authors       = ['Alexander Fedulin', 'Alexander Strelnikov']
+  spec.email         = ['aristat37@gmail.com']
+
+  spec.summary       = 'Command pattern with after commit logic to avoid AR model callbacks'
+  spec.description   = 'Command pattern with after commit logic to avoid AR model callbacks'
+  spec.homepage      = 'https://github.com/meyvn/command_extension'
+  spec.license       = 'MIT'
+
+  # 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(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.10'
+  spec.add_development_dependency 'singleton', '~> 0.1'
+end

data/lib/command_extension.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'command_extension/version'
+require 'command_extension/base'
+require 'command_extension/after_commit'
+
+module CommandExtension
+end

data/lib/command_extension/after_commit.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module CommandExtension
+  module AfterCommit
+    def self.included(base)
+      base.send :include, InstanceMethods
+      base.extend ClassMethods
+    end
+
+    module InstanceMethods
+      attr_writer :after_commit_queue_enabled
+
+      def after_commit_queue
+        @after_commit_queue ||= []
+      end
+
+      def reset
+        @after_commit_queue = nil
+        super
+      end
+
+      def after_commit(method = nil, &block)
+        after_commit_queue << proc { send(method) } if method
+        after_commit_queue << block if block
+        true
+      end
+
+      def after_commit_queue_enabled
+        @after_commit_queue_enabled = true if @after_commit_queue_enabled.nil?
+        @after_commit_queue_enabled
+      end
+
+      def after_commit_queue_enabled?
+        after_commit_queue_enabled
+      end
+
+      def execute
+        run_after_commit_queue if after_commit_queue_enabled?
+        super
+      end
+
+      def subcommand(command)
+        command.after_commit_queue_enabled = false
+        after_commit do
+          command.run_after_commit_queue
+        end
+        command
+      end
+
+      def run_after_commit_queue
+        self.class.run_after_commit_queue(self)
+        after_commit_queue.each(&:call)
+      end
+    end
+
+    module ClassMethods
+      def after_commit_queue
+        @after_commit_queue ||= []
+      end
+
+      def after_commit(method = nil, &block)
+        after_commit_queue << method if method
+        after_commit_queue << block if block
+        true
+      end
+
+      def run_after_commit_queue(instance)
+        after_commit_queue.each do |m|
+          case m
+          when Symbol, String
+            instance.__send__(m)
+          else
+            instance.instance_eval(m)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/command_extension/base.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module CommandExtension
+  module Base
+    def self.included(base)
+      base.send :include, InstanceMethods
+    end
+
+    module InstanceMethods
+      def execute; end
+
+      def reset; end
+    end
+  end
+end

data/lib/command_extension/version.rb

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

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: command_extension
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alexander Fedulin
+- Alexander Strelnikov
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-05-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: singleton
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+description: Command pattern with after commit logic to avoid AR model callbacks
+email:
+- aristat37@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- command_extension.gemspec
+- lib/command_extension.rb
+- lib/command_extension/after_commit.rb
+- lib/command_extension/base.rb
+- lib/command_extension/version.rb
+homepage: https://github.com/meyvn/command_extension
+licenses:
+- MIT
+metadata: {}
+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.0.4
+signing_key:
+specification_version: 4
+summary: Command pattern with after commit logic to avoid AR model callbacks
+test_files: []