opera 0.2.6 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d61667567e16b2d1e328826229d79e9c2551cafd013ab7f7f5b8f68f6ddb88d
-  data.tar.gz: a29639d3fc66ac1cb0fbf72523e00124230230fc18cd5d86838ea5d4d7ff6690
+  metadata.gz: b5bbb67e42e162ac6cbea3ac242a707d270110035cf618f84ea8cc5e33a60de8
+  data.tar.gz: 512a3bf21c0a6e686e41e9eb25ed21634612f4e004bd7ece8c3e3177664bcbcd
 SHA512:
-  metadata.gz: 863d1b065902feb3c1affd29b348f53d295a34a1717d960367df191dfce98a344c4de4a13909cfabae5ef9bf669c8372beae6bc2593ef868c7896be92af5952b
-  data.tar.gz: f427a8932e93bd86b4d3fce9eb72b8f453ba3f3c57362d288c4de2621dd6c0d1d535005f713999f75aa70a5ace67476a46cb787f18d293d28575e25bf540090f
+  metadata.gz: 8d55665d552e5be5d23f150d17f121700b958fc8dfdd92ef1c4cc82d9d4329b03e8a4c08c8204bff87897e65d0c2858c06df8677748b9a437795476e47b6dd62
+  data.tar.gz: 939e7abdc56c89ff03131ff98d9721dde54224891711923073bc5377a7389f46c660b7a8f909e13204ec74f565be6217a21c12e00e522dc18ecf1cbff42a6dc6

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Opera Changelog
 
+### 0.2.7 - October 29, 2021
+
+- Adds `finish_if` step to DSL
+
 ### 0.2.6 - October 29, 2021
 
 - New method Result#failures that returns combined errors and exceptions

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    opera (0.2.6)
+    opera (0.2.7)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -144,6 +144,8 @@ end
 
 [Success](#user-content-success)
 
+[Finish if](#user-content-finish-if)
+
 [Inner Operation](#user-content-inner-operation)
 
 [Inner Operations](#user-content-inner-operations)
@@ -712,6 +714,67 @@ Profile::Create.call(params: {
 #<Opera::Operation::Result:0x007fd0248e5638 @errors={"mailer"=>["Missing dependency"]}, @exceptions={}, @information={}, @executions=[:profile_schema, :populate, :create, :update, :send_email, :output], @output={:model=>#<Profile id: 40, user_id: nil, linkedin_uid: nil, picture: nil, headline: nil, summary: nil, first_name: "foo", last_name: "bar", created_at: "2019-01-03 12:21:35", updated_at: "2019-01-02 12:21:35", agree_to_terms_and_conditions: nil, registration_status: "", account_id: 1, start_date: nil, supervisor_id: nil, picture_processing: false, statistics: {}, data: {}, notification_timestamps: {}, suggestions: {}, notification_settings: {}, contact_information: []>}>
 ```
 
+### Finish If
+
+```ruby
+class Profile::Create < Opera::Operation::Base
+  context_accessor :profile
+  dependencies_reader :current_account, :mailer
+
+  validate :profile_schema
+
+  step :create
+  finish_if :profile_create_only
+  step :update
+
+  success do
+    step :send_email
+    step :output
+  end
+
+  def profile_schema
+    Dry::Validation.Schema do
+      required(:first_name).filled
+    end.call(params)
+  end
+
+  def create
+    self.profile = current_account.profiles.create(params)
+  end
+
+  def profile_create_only
+    dependencies[:create_only].present?
+  end
+
+  def update
+    profile.update(updated_at: 1.day.ago)
+  end
+
+  # NOTE: We can add an error in this step and it won't break the execution
+  def send_email
+    result.add_error('mailer', 'Missing dependency')
+    mailer&.send_mail(profile: profile)
+  end
+
+  def output
+    result.output = { model: context[:profile] }
+  end
+end
+```
+
+#### Example with information (real and total) from benchmark
+
+```ruby
+Profile::Create.call(params: {
+  first_name: :foo,
+  last_name: :bar
+}, dependencies: {
+  create_only: true,
+  current_account: Account.find(1)
+})
+#<Opera::Operation::Result:0x007fd0248e5638 @errors={}, @exceptions={}, @information={}, @executions=[:profile_schema, :create, :profile_create_only], @output={}>
+```
+
 ### Inner Operation
 
 ```ruby

data/lib/opera/operation/builder.rb

@@ -3,7 +3,7 @@
 module Opera
   module Operation
     module Builder
-      INSTRUCTIONS = %I[validate transaction benchmark step success operation operations].freeze
+      INSTRUCTIONS = %I[validate transaction benchmark step success finish_if operation operations].freeze
 
       def self.included(base)
         base.extend(ClassMethods)

data/lib/opera/operation/executor.rb

@@ -46,6 +46,8 @@ module Opera
           Instructions::Executors::Transaction.new(operation).call(instruction)
         when :benchmark
           Instructions::Executors::Benchmark.new(operation).call(instruction)
+        when :finish_if
+          Instructions::Executors::FinishIf.new(operation).call(instruction)
         else
           raise(UnknownInstructionError, "Unknown instruction #{instruction[:kind]}")
         end

data/lib/opera/operation/instructions/executors/finish_if.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Opera
+  module Operation
+    module Instructions
+      module Executors
+        class FinishIf < Executor
+          def call(instruction)
+            instruction[:kind] = :step
+            operation.finish! if super
+          end
+        end
+      end
+    end
+  end
+end

data/lib/opera/operation.rb

@@ -8,6 +8,7 @@ require 'opera/operation/config'
 require 'opera/operation/instructions/executors/success'
 require 'opera/operation/instructions/executors/transaction'
 require 'opera/operation/instructions/executors/benchmark'
+require 'opera/operation/instructions/executors/finish_if'
 require 'opera/operation/instructions/executors/validate'
 require 'opera/operation/instructions/executors/operation'
 require 'opera/operation/instructions/executors/operations'
@@ -15,6 +16,5 @@ require 'opera/operation/instructions/executors/step'
 
 module Opera
   module Operation
-
   end
 end

data/lib/opera/version.rb

@@ -1,3 +1,3 @@
 module Opera
-  VERSION = '0.2.6'
+  VERSION = '0.2.7'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opera
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.2.7
 platform: ruby
 authors:
 - ProFinda Development Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-10-29 00:00:00.000000000 Z
+date: 2021-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-validation
@@ -84,6 +84,7 @@ files:
 - lib/opera/operation/config.rb
 - lib/opera/operation/executor.rb
 - lib/opera/operation/instructions/executors/benchmark.rb
+- lib/opera/operation/instructions/executors/finish_if.rb
 - lib/opera/operation/instructions/executors/operation.rb
 - lib/opera/operation/instructions/executors/operations.rb
 - lib/opera/operation/instructions/executors/step.rb