create_update_destroy_async 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2bab654a7b0e40f7cff90fcd7d988f9d56c9b2368f2a40cd7eed358746dce7a0
+  data.tar.gz: 96f07c4dc56362f8fd9214a0674315cd9794588d63534ec85ad5f1be20dc6e24
+SHA512:
+  metadata.gz: efe9bfc96f4b39171484e19b678f79652837ba56a0ca08b0defe60bc2fce14fc8a1c7daa22cf55b082912037331e4fbf873dd869a5fa7b448ed151a8ea181e49
+  data.tar.gz: 6bf428544ebb7f0e0d760ded274450fc56409fd83b2c4a0adde210b425882495833a4ec139a40656f3c24336851d3543d4f4b477b5930765ef8ff1af697476a4

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2023 Igor Kasyanchuk
+
+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,139 @@
+# Create/Update/Destroy + Async
+
+[![RailsJazz](https://github.com/igorkasyanchuk/rails_time_travel/blob/main/docs/my_other.svg?raw=true)](https://www.railsjazz.com)
+[![Listed on OpenSource-Heroes.com](https://opensource-heroes.com/badge-v1.svg)](https://opensource-heroes.com/o/railsjazz)
+
+A simple benchmark to grab your attention. Performance difference is noticeable.
+![Performance](docs/benchmark_example.png)
+
+A very simple solution for a very simple but annoying problem.
+An example of problem that this gem solves.
+
+```ruby
+#
+# code that can be improved
+#
+class EventsAPIController < AppController
+  def show
+    @event = Event.find(params[:id])
+
+    # scroll down to see how we can improve this line
+    EventView.create(user: current_user)
+
+    render json: @event
+  end
+end
+```
+
+How code above can be improved (and by improved I mean faster)?
+This API endpoint is responsible to return JSON info about Event.
+
+What in this code can slowdown this API?
+Probably this: `EventView.create(user: current_user)`? This is the only one write operation that we have.
+
+Now, imagine that in our app we have background jobs. We can start a new background job to create event in async mode.
+But what could be even simpler? Correct answer is to use this gem :)
+With help of this gem you can rewrite your code to this:
+
+```ruby
+#
+# improved version, it will work 100% faster
+#
+class EventsAPIController < AppController
+  def show
+    @event = Event.find(params[:id])
+
+    EventView.create_async(user: current_user) # <--- here is a change
+
+    render json: @event
+  end
+end
+```
+
+When we call `.create_async`, it will start a new background job and create new record in the background.
+
+## Usage
+
+You have methods like:
+
+- `.create_async`
+- `.save_async`
+- `.update_async`
+- `.destroy_async`
+
+## Examples
+
+```ruby
+
+# create
+User.create_async(first_name: "John", last_name: "Smith")
+
+# update
+@user.update_async(first_name: "New Name")
+
+# save
+@user.first_name = "New Name"
+@user.save_async
+
+# destroy
+@user.destroy_async
+```
+
+Ideal use case - when you just need to do an atomic action that won't require any logic with object.
+
+## Limitations:
+
+- you need to have some background job service in your app (as far I remember Sidekiq can be started within your app)
+- maybe it won't work with complex associations that are changed in the object (not tested)
+- validations will happen in the background, so you cannot write code like:
+  ```ruby
+    if @user.save_async
+      ... # this won't work as expected
+    else
+      ... # sorry validation happens only in the background
+    end
+  ```
+- you cannot refer variables in your code, because they will be created in the background. Example:
+  ```ruby
+    @user = User.create_async(attrs)
+    puts @user.full_name # this code won't work
+  ```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "create_update_destroy_async"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+## TODO
+
+- how to set queue where it will be executed
+- verify if it works on not with more complext objects, like accept nested attributes
+- options for jobs, like discard_on, priority, etc
+
+## Benchmark
+
+- `rails s -e production`
+- `wrk -c100 http://127.0.0.1:3000/home/index1`
+- stop server
+- `rails s -e production`
+- `wrk -c100 http://127.0.0.1:3000/home/index2`
+- repeat few times to be 100% sure
+
+## Contributing
+
+You are welcome to contribute.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+[<img src="https://github.com/igorkasyanchuk/rails_time_travel/blob/main/docs/more_gems.png?raw=true"
+/>](https://www.railsjazz.com/?utm_source=github&utm_medium=bottom&utm_campaign=create_update_destroy_async)

data/Rakefile

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

data/lib/create_update_destroy_async/active_record_ext.rb

@@ -0,0 +1,26 @@
+module CreateUpdateDestroyAsync
+  module ActiveRecordExt
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def create_async(attributes = {})
+        CreateUpdateDestroyAsync::Jobs::Create.perform_later(self.name, attributes)
+      end
+    end
+
+    def save_async
+      new_attributes = changes.each_with_object({}) do |(k, v), hash|
+        hash[k] = v[1]
+      end
+      CreateUpdateDestroyAsync::Jobs::Save.perform_later(self, new_attributes)
+    end
+
+    def update_async(new_attributes = {})
+      CreateUpdateDestroyAsync::Jobs::Update.perform_later(self, changed_attributes.merge(new_attributes))
+    end
+
+    def destroy_async
+      CreateUpdateDestroyAsync::Jobs::Destroy.perform_later(self)
+    end
+  end
+end

data/lib/create_update_destroy_async/jobs/create.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module CreateUpdateDestroyAsync
+  module Jobs
+    class Create < ActiveJob::Base
+      def perform(klass, attributes = {})
+        model = klass.constantize
+        model.create(attributes)
+      end
+    end
+  end
+end

data/lib/create_update_destroy_async/jobs/destroy.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module CreateUpdateDestroyAsync
+  module Jobs
+    class Destroy < ActiveJob::Base
+      def perform(record)
+        record.destroy
+      end
+    end
+  end
+end

data/lib/create_update_destroy_async/jobs/save.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module CreateUpdateDestroyAsync
+  module Jobs
+    class Save < ActiveJob::Base
+      def perform(record, attributes = {})
+        record.assign_attributes(attributes)
+        record.save
+      end
+    end
+  end
+end

data/lib/create_update_destroy_async/jobs/update.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module CreateUpdateDestroyAsync
+  module Jobs
+    class Update < ActiveJob::Base
+      def perform(record, attributes = {})
+        record.update(attributes)
+      end
+    end
+  end
+end

data/lib/create_update_destroy_async/railtie.rb

@@ -0,0 +1,7 @@
+module CreateUpdateDestroyAsync
+  class Railtie < ::Rails::Railtie
+    ActiveSupport.on_load(:active_record) do
+      ActiveRecord::Base.send(:include, CreateUpdateDestroyAsync::ActiveRecordExt)
+    end
+  end
+end

data/lib/create_update_destroy_async/version.rb

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

data/lib/create_update_destroy_async.rb

@@ -0,0 +1,10 @@
+require "create_update_destroy_async/version"
+require "create_update_destroy_async/jobs/create"
+require "create_update_destroy_async/jobs/save"
+require "create_update_destroy_async/jobs/update"
+require "create_update_destroy_async/jobs/destroy"
+require "create_update_destroy_async/active_record_ext"
+require "create_update_destroy_async/railtie"
+
+module CreateUpdateDestroyAsync
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: create_update_destroy_async
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Igor Kasyanchuk
+- Liubomyr Manastyretskyi
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-05-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: 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'
+- !ruby/object:Gem::Dependency
+  name: activejob
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Execute create/update/destroy operations asynchronously in your Rails
+  app
+email:
+- igorkasyanchuk@gmail.com
+- manastyretskyi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/create_update_destroy_async.rb
+- lib/create_update_destroy_async/active_record_ext.rb
+- lib/create_update_destroy_async/jobs/create.rb
+- lib/create_update_destroy_async/jobs/destroy.rb
+- lib/create_update_destroy_async/jobs/save.rb
+- lib/create_update_destroy_async/jobs/update.rb
+- lib/create_update_destroy_async/railtie.rb
+- lib/create_update_destroy_async/version.rb
+homepage: https://github.com/railsjazz/create_update_destroy_async
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/railsjazz/create_update_destroy_async
+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.7
+signing_key:
+specification_version: 4
+summary: Execute create/update/destroy operations asynchronously in your Rails app
+test_files: []