opera 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a43643bc863d6fd8535fa08b7e55d1d0d3141dd35f24894a8ebbeca55989b25
-  data.tar.gz: 7fb3c80f08215391d687cde118d5cac0e88db838c771ea34c01a2a3c5ba004c5
+  metadata.gz: c87b8365cd3d9a0da8fce865abe9babe04df29df31253697ec01bf45ee81d897
+  data.tar.gz: 313ba34f1abc8e4845b71a4b1f209362ad14c08d79dd30a51b120c52e364ee2f
 SHA512:
-  metadata.gz: 7470108eef670d9038412c4f6e86e4bc88f7b71189d299ebae99f71e61b7c1e09e530ed28ac9a8e55ee3cc2165d0354d25eea5d0bd95d804d994f239021019b1
-  data.tar.gz: d49010222f63b3e669e1d7070863cdcc216e5c19e63471fc672a650ab50e0c9df7e2550613d851363966854024b1c4902b1e8b0faf57cae8038e39028684e50b
+  metadata.gz: 42bdbac9178ca00ea91d998c5d1ee20a125993bc5ac830d5e5f523092527a40d1948a5504b5120d88b72200272994c71839cb2ea6d4361cd1a7402d8e9e76c16
+  data.tar.gz: 1ba960d0d599d5cfc9c0d0c5e788420043fb8bbc4c1608f806bc751b9e4b0dd00744fd3a10a200957ff9fcce7c300c508ca27c5b2d6da3b022601dfb9587dbee

data/CHANGELOG.md

@@ -1,13 +1,18 @@
 # Opera Changelog
 
-## 0.1.0 - September 12, 2020
+### 0.2.3 - July 26, 2021
 
-- Initial release
+- Support context, params and dependencies accessors
+- Removed depreceted `finish` method. Please use `finish!` from today
+
+## 0.2.2 - July 7, 2021
+
+- Test release using Github Actions
 
 ## 0.2.1 - July 7, 2021
 
 - Support for transaction options
 
-## 0.2.2 - July 7, 2021
+## 0.1.0 - September 12, 2020
 
-- Test release using Github Actions
+- Initial release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    opera (0.1.2)
+    opera (0.2.3)
 
 GEM
   remote: https://rubygems.org/
@@ -81,4 +81,4 @@ DEPENDENCIES
   rspec (~> 3.0)
 
 BUNDLED WITH
-   2.1.4
+   2.2.15

data/README.md

@@ -1,5 +1,6 @@
 # Opera
 
+[![Gem Version](https://badge.fury.io/rb/opera.svg)](https://badge.fury.io/rb/opera)
 ![Master](https://github.com/Profinda/opera/actions/workflows/release.yml/badge.svg?branch=master)
 
 
@@ -155,6 +156,9 @@ Some cases and example how to use new operations
 
 ```ruby
 class Profile::Create < Opera::Operation::Base
+  context_accessor :profile
+  dependencies_reader :current_account, :mailer
+
   validate :profile_schema
 
   step :create
@@ -168,15 +172,15 @@ class Profile::Create < Opera::Operation::Base
   end
 
   def create
-    context[:profile] = dependencies[:current_account].profiles.create(params)
+    self.profile = current_account.profiles.create(params)
   end
 
   def send_email
-    dependencies[:mailer]&.send_mail(profile: context[:profile])
+    mailer&.send_mail(profile: profile)
   end
 
   def output
-    result.output = { model: context[:profile] }
+    result.output = { model: profile }
   end
 end
 ```
@@ -225,6 +229,9 @@ Profile::Create.call(params: {
 
 ```ruby
 class Profile::Create < Opera::Operation::Base
+  context_accessor :profile
+  dependencies_reader :current_account, :mailer
+
   validate :profile_schema
 
   step :create
@@ -240,16 +247,17 @@ class Profile::Create < Opera::Operation::Base
   end
 
   def create
-    context[:profile] = dependencies[:current_account].profiles.create(context[:profile_schema_output])
+    self.profile = current_account.profiles.create(context[:profile_schema_output])
   end
 
   def send_email
-    return true unless dependencies[:mailer]
-    dependencies[:mailer].send_mail(profile: context[:profile])
+    return true unless mailer
+
+    mailer.send_mail(profile: profile)
   end
 
   def output
-    result.output = { model: context[:profile] }
+    result.output = { model: profile }
   end
 end
 ```
@@ -271,6 +279,9 @@ Profile::Create.call(params: {
 
 ```ruby
 class Profile::Create < Opera::Operation::Base
+  context_accessor :profile
+  dependencies_reader :current_account, :mailer
+
   validate :profile_schema
 
   step :build_record
@@ -286,29 +297,29 @@ class Profile::Create < Opera::Operation::Base
   end
 
   def build_record
-    context[:profile] = dependencies[:current_account].profiles.build(params)
-    context[:profile].force_name_validation = true
+    self.profile = current_account.profiles.build(params)
+    self.profile.force_name_validation = true
   end
 
   def old_validation
-    return true if context[:profile].valid?
+    return true if profile.valid?
 
     result.add_information(missing_validations: "Please check dry validations")
-    result.add_errors(context[:profile].errors.messages)
+    result.add_errors(profile.errors.messages)
 
     false
   end
 
   def create
-    context[:profile].save
+    profile.save
   end
 
   def send_email
-    dependencies[:mailer].send_mail(profile: context[:profile])
+    mailer.send_mail(profile: profile)
   end
 
   def output
-    result.output = { model: context[:profile] }
+    result.output = { model: profile }
   end
 end
 ```
@@ -344,6 +355,9 @@ Profile::Create.call(params: {
 
 ```ruby
 class Profile::Create < Opera::Operation::Base
+  context_accessor :profile
+  dependencies_reader :current_account, :mailer
+
   validate :profile_schema
 
   step :build_record
@@ -359,8 +373,8 @@ class Profile::Create < Opera::Operation::Base
   end
 
   def build_record
-    context[:profile] = dependencies[:current_account].profiles.build(params)
-    context[:profile].force_name_validation = true
+    self.profile = current_account.profiles.build(params)
+    self.profile.force_name_validation = true
   end
 
   def exception
@@ -368,21 +382,23 @@ class Profile::Create < Opera::Operation::Base
   end
 
   def create
-    context[:profile] = context[:profile].save
+    self.profile = profile.save
   end
 
   def send_email
-    return true unless dependencies[:mailer]
+    return true unless mailer
 
-    dependencies[:mailer].send_mail(profile: context[:profile])
+    mailer.send_mail(profile: profile)
   end
 
   def output
-    result.output(model: context[:profile])
+    result.output(model: profile)
   end
 end
 ```
+
 ##### Call with step throwing exception
+
 ```ruby
 result = Profile::Create.call(params: {
   first_name: :foo,
@@ -398,6 +414,9 @@ result = Profile::Create.call(params: {
 
 ```ruby
 class Profile::Create < Opera::Operation::Base
+  context_accessor :profile
+  dependencies_reader :current_account, :mailer
+
   validate :profile_schema
 
   step :build_record
@@ -412,27 +431,29 @@ class Profile::Create < Opera::Operation::Base
   end
 
   def build_record
-    context[:profile] = dependencies[:current_account].profiles.build(params)
-    context[:profile].force_name_validation = true
+    self.profile = current_account.profiles.build(params)
+    self.profile.force_name_validation = true
   end
 
   def create
-    context[:profile] = context[:profile].save
-    finish
+    self.profile = profile.save
+    finish!
   end
 
   def send_email
-    return true unless dependencies[:mailer]
+    return true unless mailer
 
-    dependencies[:mailer].send_mail(profile: context[:profile])
+    mailer.send_mail(profile: profile)
   end
 
   def output
-    result.output(model: context[:profile])
+    result.output(model: profile)
   end
 end
 ```
+
 ##### Call
+
 ```ruby
 result = Profile::Create.call(params: {
   first_name: :foo,
@@ -452,6 +473,9 @@ class Profile::Create < Opera::Operation::Base
     config.transaction_class = Profile
   end
 
+  context_accessor :profile
+  dependencies_reader :current_account, :mailer
+
   validate :profile_schema
 
   transaction do
@@ -469,21 +493,21 @@ class Profile::Create < Opera::Operation::Base
   end
 
   def create
-    context[:profile] = dependencies[:current_account].profiles.create(params)
+    self.profile = current_account.profiles.create(params)
   end
 
   def update
-    context[:profile].update(example_attr: :Example)
+    profile.update(example_attr: :Example)
   end
 
   def send_email
-    return true unless dependencies[:mailer]
+    return true unless mailer
 
-    dependencies[:mailer].send_mail(profile: context[:profile])
+    mailer.send_mail(profile: profile)
   end
 
   def output
-    result.output = { model: context[:profile] }
+    result.output = { model: profile }
   end
 end
 ```
@@ -514,6 +538,9 @@ class Profile::Create < Opera::Operation::Base
     config.transaction_class = Profile
   end
 
+  context_accessor :profile
+  dependencies_reader :current_account, :mailer
+
   validate :profile_schema
 
   transaction do
@@ -531,21 +558,21 @@ class Profile::Create < Opera::Operation::Base
   end
 
   def create
-    context[:profile] = dependencies[:current_account].profiles.create(params)
+    self.profile = current_account.profiles.create(params)
   end
 
   def update
-    context[:profile].update(updated_at: 1.day.ago)
+    profile.update(updated_at: 1.day.ago)
   end
 
   def send_email
-    return true unless dependencies[:mailer]
+    return true unless mailer
 
-    dependencies[:mailer].send_mail(profile: context[:profile])
+    mailer.send_mail(profile: profile)
   end
 
   def output
-    result.output = { model: context[:profile] }
+    result.output = { model: profile }
   end
 end
 ```
@@ -572,6 +599,9 @@ D, [2020-08-17T12:10:44.898132 #2741] DEBUG -- :    (10.3ms)  COMMIT
 
 ```ruby
 class Profile::Create < Opera::Operation::Base
+  context_accessor :profile
+  dependencies_reader :current_account, :mailer
+
   validate :profile_schema
 
   step :create
@@ -589,21 +619,21 @@ class Profile::Create < Opera::Operation::Base
   end
 
   def create
-    context[:profile] = dependencies[:current_account].profiles.create(params)
+    self.profile = current_account.profiles.create(params)
   end
 
   def update
-    context[:profile].update(updated_at: 1.day.ago)
+    profile.update(updated_at: 1.day.ago)
   end
 
   def send_email
-    return true unless dependencies[:mailer]
+    return true unless mailer
 
-    dependencies[:mailer].send_mail(profile: context[:profile])
+    mailer.send_mail(profile: profile)
   end
 
   def output
-    result.output = { model: context[:profile] }
+    result.output = { model: profile }
   end
 end
 ```
@@ -624,6 +654,9 @@ Profile::Create.call(params: {
 
 ```ruby
 class Profile::Create < Opera::Operation::Base
+  context_accessor :profile
+  dependencies_reader :current_account, :mailer
+
   validate :profile_schema
 
   success :populate
@@ -648,17 +681,17 @@ class Profile::Create < Opera::Operation::Base
   end
 
   def create
-    context[:profile] = dependencies[:current_account].profiles.create(params)
+    self.profile = current_account.profiles.create(params)
   end
 
   def update
-    context[:profile].update(updated_at: 1.day.ago)
+    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')
-    dependencies[:mailer]&.send_mail(profile: context[:profile])
+    mailer&.send_mail(profile: profile)
   end
 
   def output
@@ -791,6 +824,8 @@ Opera::Operation::Result.new(output: 'success')
 
 ## Opera::Operation::Base - Class Methods
 >
+    - context_[reader|writer|accessor] - predefined methods for easy access
+    - [params|dependencies]_reader     - predefined readers for immutable arguments
     - step(Symbol)             - single instruction
       - return [Truthly]       - continue operation execution
       - return [False]         - stops operation execution
@@ -810,7 +845,7 @@ Opera::Operation::Result.new(output: 'success')
     - context [Hash]          - used to pass information between steps - only for internal usage
     - params [Hash]           - immutable and received in call method
     - dependencies [Hash]     - immutable and received in call method
-    - finish                  - this method interrupts the execution of steps after is invoked
+    - finish!                 - this method interrupts the execution of steps after is invoked
 
 ## Development
 

data/lib/opera/operation/base.rb

@@ -3,7 +3,6 @@
 module Opera
   module Operation
     class Base
-      extend Gem::Deprecate
       include Opera::Operation::Builder
 
       attr_accessor :context
@@ -21,12 +20,6 @@ module Opera
         self.class.config
       end
 
-      def finish
-        finish!
-      end
-
-      deprecate :finish, :finish!, 2019, 6
-
       def finish!
         @finished = true
       end
@@ -54,6 +47,41 @@ module Opera
         def reporter
           config.reporter
         end
+
+        def check_method_availability!(method)
+          return if instance_methods(false).none?(method)
+
+          raise(ArgumentError, "Method #{method} is already defined")
+        end
+
+        %i[context params dependencies].each do |method|
+          define_method("#{method}_reader") do |*attributes, **options|
+            attributes.map(&:to_sym).each do |attribute|
+              check_method_availability!(attribute)
+
+              define_method(attribute) do
+                send(method)[attribute] ||= options[:default]
+              end
+            end
+          end
+        end
+
+        %i[context].each do |method|
+          define_method("#{method}_writer") do |*attributes|
+            attributes.map(&:to_sym).each do |attribute|
+              check_method_availability!("#{attribute}=")
+
+              define_method("#{attribute}=") do |value|
+                send(method)[attribute] = value
+              end
+            end
+          end
+
+          define_method("#{method}_accessor") do |*attributes, **options|
+            send("#{method}_reader", *attributes, **options)
+            send("#{method}_writer", *attributes)
+          end
+        end
       end
     end
   end

data/lib/opera/version.rb

@@ -1,3 +1,3 @@
 module Opera
-  VERSION = '0.2.2'
+  VERSION = '0.2.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opera
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - ProFinda Development Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-07-07 00:00:00.000000000 Z
+date: 2021-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-validation