ector-multi 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a20f20adbf811c03f487888057135de8267b17e5484792d7ab5a9096379321d4
-  data.tar.gz: f3011de86fd858e580b782059ffc5e36399183252a90c11936f8ffbc114b94a1
+  metadata.gz: c8e4aa1f612414eaba5439d00789aa46958ed335b12c998fcc9bb9147dfb1b82
+  data.tar.gz: 9ae7cca3656321979588be273ae48ee1e08c0a89a2bc97f1abb62fe2497f882b
 SHA512:
-  metadata.gz: 3897ed4e2e54db0fbf30a9a5c63a9ab5265c1c7fd2f810893d913ade99e8f8e8207ac58680efe0d4b334b4f7ca780178010cbff770a9c7936f4033466f4f10cb
-  data.tar.gz: 79472b2e945fe5bb44597a68d042a099cff5019600f066244df1f9d123edad5df2623d181cbdc9bd519bb769cd7e335fb13629246b03a9ba27e3950e6fc85793
+  metadata.gz: b52d9f63225f8a9c994b6e69d431fe5f072d19fc3fbb54b92d088bd5ba0bba8c9ee34af054656414ac0c55ed1937a7af4807a5bef9a016b29beb35be38b6ad88
+  data.tar.gz: 8803a86bb7224de8a6b2dd5fc26c55b55c8bff89963fedb7d1ff1331b3a925cb030ddcd4fcc4dee320b0ab10b76f3d7ec2eeeecb84112e620bf5079f38bb3638

data/README.md

@@ -1,2 +1,103 @@
-# multi
-`Multi` is an object for grouping multiple DB operations that should be performed in a single database transaction.
+# Ector::Multi
+[![Gem Version](https://badge.fury.io/rb/ector-multi.svg)](http://badge.fury.io/rb/ector-multi)
+[![Build Status](https://travis-ci.org/emancu/ector-multi.svg)](https://travis-ci.org/emancu/ector-multi)
+[![Code Climate](https://codeclimate.com/github/emancu/ector-multi/badges/gpa.svg)](https://codeclimate.com/github/emancu/ector-multi)
+[![RubyGem](https://img.shields.io/gem/dt/ector-multi.svg)](https://rubygems.org/gems/ector-multi)
+
+`Ector::Multi` is an object for grouping multiple DB operations that should be performed in a single database transaction.
+
+I literally copy the API and idea from [Ecto::Multi](https://hexdocs.pm/ecto/Ecto.Multi.html), so I'm gonna copy the documentation as well.
+
+## Dependencies
+
+At this moment, `Ector::Multi` requires `ActiveRecord` as a dependency and relies on it for CRUD operations and transactions.
+Eventually, I would like to be ORM-agnostic and be able to configure different ORMs and remove the hard dependency.
+
+## Getting started
+
+`Ector::Multi` is an object for grouping multiple database operations.
+
+`Ector::Multi` makes it possible to pack operations that should be performed in a single database transaction and gives a way to introspect the queued operations without actually performing them. Each operation is given a name that is unique and will identify its result in case of success or failure.
+
+All operations will be executed in the order they were added.
+
+The `Ector::Multi` object should be considered opaque. You can use common ruby techniques to dig into it, but accessing fields or directly modifying them is not advised.
+
+
+## Run
+
+`Ector::Multi` allows you to run arbitrary functions as part of your transaction via `run`.
+This is especially useful when an operation depends on the value of a previous operation.
+For this reason, the function given as a callback to run will receive all changes performed by the multi so far.
+
+The function given to `run` must return _something_ or raise a `Ector::Multi::OperationFailure`. Raising an error will abort any further operations and make the whole multi fail.
+
+## Example
+
+Let’s look at an example definition and usage. The use case we’ll be looking into is resetting a password.
+We need to update the account with proper information, log the request and remove all current sessions:
+
+```ruby
+module PasswordManager
+  def self.reset(account, params)
+    Ector::Multi.new
+    .update(:account, account, params)
+    .create(:log, Log, account_id: account.id, changed_at: Time.now)
+    .destroy_all(:clear_sessions, Session.where(account_id: account.id))
+  end
+end
+```
+
+We can later execute it in the integration layer using `#commit`:
+
+```ruby
+  result = PasswordManager.reset(account, params).commit
+```
+
+The resulting object, a `Ector::Multi::Result`, will tell you if it succeeded or failed. Also, it is possible to dig into the results of each operation.
+
+## Functions
+
+`multi.append(second_mutli)`
+
+Appends the second multi to the first one
+
+`multi.destroy(name, instance)`
+
+Adds a destroy operation to the multi
+
+`multi.delete_all(name, queryable)`
+
+Adds a destroy_all operation to the multi
+
+`multi.error(name, value)`
+
+Causes the multi to fail with the given value
+
+`multi.create(name, model, attributes, &block = nil)`
+
+Adds a create operation to the multi
+
+`Ector::Multi.new`
+
+Returns an empty Ector::Multi object
+
+`multi.prepend(second_multi)`
+
+Prepends the second multi to the first one
+
+`multi.run(name, &run)`
+
+Adds a function to run as part of the multi
+
+`multi.to_list`
+
+Returns the list of operations stored in multi
+
+`multi.update(name, instance, updates, &block = nil)`
+
+Adds an update operation to the multi
+
+`multi.update_all(name, queryable, updates, &block = nil)`
+
+Adds an update_all operation to the multi

data/ector-multi.gemspec

@@ -23,6 +23,6 @@ Gem::Specification.new do |s|
   s.required_ruby_version = '>= 2.2'
 
   s.add_dependency 'activerecord', '~> 5.2'
-  s.add_development_dependency 'protest', '~> 0'
+  s.add_development_dependency 'protest', '~> 0.6'
   s.add_development_dependency 'sqlite3', '~> 0'
 end

data/lib/ector-multi.rb

@@ -8,5 +8,5 @@ require_relative 'ector-multi/operations'
 require_relative 'ector-multi/multi'
 
 module Ector
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/lib/ector-multi/multi.rb

@@ -32,10 +32,6 @@ module Ector
       add_operation Operation::Error.new(name, operation_block(value, nil))
     end
 
-    def merge(multi)
-      raise NotImplemented
-    end
-
     def prepend(multi)
       check_operation_uniqueness!(multi.to_list)
 
@@ -59,7 +55,8 @@ module Ector
     def commit
       results = {}
 
-      operations.find(&:fail_fast?)&.run(results)
+      fail_fast = operations.find(&:fail_fast?)
+      fail_fast.run(results) if fail_fast
 
       ::ActiveRecord::Base.transaction(joinable: false, requires_new: true) do
         operations.each do |operation|

data/test/multi_test.rb

@@ -151,13 +151,6 @@ Protest.describe 'Ector::Multi' do
     end
   end
 
-  context '#merge'
-
-    # test 'returns self' do
-      # assert_equal @multi, @multi.merge(:dummy, ???)
-    # end
-  # end
-
   context '#prepend' do
     setup do
       @left_multi = @multi.run(:left) { }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ector-multi
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Emiliano Mancuso
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-28 00:00:00.000000000 Z
+date: 2018-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement