operationable 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0ade6d51c19fadefd0b41528d0f81f1da2ddbdf6
-  data.tar.gz: b890c49175142c5ed3067f407e52117dffbef8e5
+  metadata.gz: c0b48986600bb3d52c71cc98dfae222e6176174c
+  data.tar.gz: 0dc6951d98772dba0340786efecbb05ae19f1541
 SHA512:
-  metadata.gz: 3466d1c15547a9b30dd3e32442f5bf2785c9255edd647681f2b7ce5126e7b7c3ff4ea1b82c4ce73dfe44f06048037b1212f10277dedac359862b20b2b92e3a43
-  data.tar.gz: f3ba44086bc63975640ae53b77f26b21bed05d649d7e8bcec466d96fa241e152b1e822fdef7ec3cb0cb430d7ae51adf411d65c1d148bc4b07b260e346fce535c
+  metadata.gz: 46c5261c17ac837b67ef19a3fb4bc9e0bffb7295fa92f5cfcf006416c0d6916fbadc816b238be85f1fed81803f2a83e0ef9ba32c37930d02c76262218ee57825
+  data.tar.gz: 0ff656bb174f40715220172692e2911676cb8411a0c3ffa8b83c1bb189157b919be871bfd50f5458102ceea8719fcd20ca9d61ee54858085f9cfced4c3dff056

data/README.md

@@ -1,8 +1,6 @@
 # Operationable
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/operationable`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+This gem is solving the problem with ActiveRecord callbacks hell.
 
 ## Installation
 
@@ -22,7 +20,98 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Call operation at your controllers
+
+```
+class EntityController < ApplicationController
+  def create
+    op = EntityOperation::Create.new(@entity, current_user)
+
+    if op.process
+      render json: @entity, status: :created
+    else
+      render json: { errors: @entity.errors }, status: :unprocessable_entity
+    end
+  end
+end
+```
+
+Move you model callbacks to operation
+
+
+```
+module EntityOperation
+  class Create < Operationable::Create
+    class Builder < Operationable::Builder
+      def build
+        record
+      end
+    end
+
+    class Serializer < Operationable::Serializer
+      RECORD_FIELDS = [].freeze
+      USER_FIELDS = %i(id role email name).freeze
+    end
+
+    class Specification < Operationable::Specification
+      def should_callback_one
+        true
+      end
+    end
+
+    class Runner < Operationable::Runners::Separate
+      def initialize_callbacks
+        push_to_queue(:callback_one)
+        push_to_queue(:callback_two, :low)
+        push_to_queue(:callback_three, :high)
+      end
+    end
+
+    class Callback < Operationable::Callback
+      def callback_one
+        AnotherEntities.update_all(field: 123)
+      end
+    end
+  end
+end
+```
+
+#Operation
+
+Exiting operations: create, update, destroy or use raw Operationable::Operation.
+Operationable::Create(Update, Destory) inherited from Operationable::Operation
+
+#Builder
+
+Builder useful for that things you usually do at before_create/update/destroy callbacks.
+
+#Specification
+
+Specification decides run or not run callback based on boolean value returned from should_ prefixed callback name.
+If specification not described, callback will called at any case.
+
+#Runner
+
+Exists two types for Runners - Serial and Separate runner. Serial callbacks will run one after another, at described order.
+Separate runners not related one for another and can be run simultaneously.
+
+Serial adapter creates one background job, separate for each callback.
+
+push_to_queue(callback_name, queue_name) if queue_name not passed, callback will run synchronously
+
+Operations work via ActiveJob, so you can use any adapter that you want.
+
+#Serializer
+
+Serializer used to define what values should be passed to job(redis do not accept AR instances or other complex structures).
+Also you don't need all record fields should passed to callbacks.
+
+#Callback
+
+Class that contain callback methods, that will called after model saved in runtime or in background
+
+#Validators
+TODO: describe validators
 
 ## Development
 
@@ -32,7 +121,11 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/operationable. 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.
+Contributions are welcome!
+
+Contributors:
+[korbutvitaliy](https://github.com/korbutvitaliy)
+[kirillsuhodolov](https://github.com/KirillSuhodolov)
 
 
 ## License

data/lib/operationable/runners/base.rb

@@ -26,11 +26,10 @@ module Operationable
       def initialize_callbacks
       end
 
-      def push_to_queue(callback_method_name, queue=nil)
-        callbacks << {
-          callback_method_name: callback_method_name.to_s,
-          queue: queue.to_s
-        }
+      def push_to_queue(*callback_method_names, queue: nil)
+        callback_method_names.each do |callback_method_name|
+          callbacks << { callback_method_name: callback_method_name.to_s, queue: queue.to_s }
+        end
       end
 
       def callback_names

data/lib/operationable/version.rb

@@ -1,3 +1,3 @@
 module Operationable
-  VERSION = "0.1.7"
+  VERSION = "0.1.8"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: operationable
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - Kirill Suhodolov
@@ -99,13 +99,7 @@ files:
 - lib/operations/create.rb
 - lib/operations/destroy.rb
 - lib/operations/update.rb
-- operationable-0.1.0.gem
-- operationable-0.1.1.gem
-- operationable-0.1.2.gem
-- operationable-0.1.3.gem
-- operationable-0.1.4.gem
-- operationable-0.1.5.gem
-- operationable-0.1.6.gem
+- operationable-0.1.7.gem
 - operationable.gemspec
 - spec/operationable_spec.rb
 - spec/spec_helper.rb