opera 0.2.17 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6b4eeef70ec90ace2eab7861bb9e9801f1e986354a411f2ca426f1380c3a0f7
-  data.tar.gz: b2264478656ffab0e08ae0e50b7b54a4dffdf81d64bb53bb2a27365151700351
+  metadata.gz: 704579e1a9f84d1966d10a7a7dab33b3c51d320a6f44fc968cc41d27e4ddb465
+  data.tar.gz: 47cec8209bd334e31fc3906adf6fafabc48fb49438506e1eac3cc63df2739994
 SHA512:
-  metadata.gz: efb5db089f99b26ab2f085e62a064dcaf31adc46632fccc9e51ab73f22dc611d9341f7f3ddb5b4d1bdf5d1c8b598aab54af5071df891f0696f5b8357bcd1960b
-  data.tar.gz: 0c5e84d50fa8f0a0b5f4a839b97e208925420de362ed42ab60e0731aadfe4b7a25462a6927078feb185dd03c2621aa09562a13d5893b3fdba3bd9de171e01fd6
+  metadata.gz: b83cebe96114838b10845ae364ca6869b445d4a6a0171deb40875db0a719112a856820ace81929740b1914f52a8c083f24e4fe43e11acf3d8b519135da0a2a6b
+  data.tar.gz: 815abc701e8f4634b47c868e9fed8f2b72682eb0fc408efad05afbc9f055f2f2d870c59caf84cafb46993cb5c75e6a2616c67684462fe38828d43b285cfa43e6

data/.github/workflows/release.yml

@@ -9,7 +9,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: [ '2.6', '2.7', '3.0', '3.2', 'jruby' ]
+        ruby-version: [ '3.0', '3.2', 'jruby' ]
 
     steps:
       - uses: actions/checkout@v4

data/.github/workflows/specs.yml

@@ -16,7 +16,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['2.6', '2.7', '3.0', '3.2', 'jruby']
+        ruby-version: ['3.0', '3.2', 'jruby']
 
     steps:
     - uses: actions/checkout@v4

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Opera Changelog
 
+### 0.3.0 - September 20, 2024
+
+- add new syntax for context, params and dependencies readers and accessors
+
+### 0.2.18 - September 20, 2024
+
+- added `output!` method on Result object
+- deleted `to_h` alias for `output`
+
 ### 0.2.17 - July 8, 2024
 
 - minor fix `mode` configuration option.

data/Gemfile.lock

@@ -1,74 +1,71 @@
 PATH
   remote: .
   specs:
-    opera (0.2.16)
+    opera (0.3.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    bigdecimal (3.1.8)
     byebug (11.1.3)
     coderay (1.1.3)
-    concurrent-ruby (1.1.7)
-    diff-lcs (1.4.4)
-    dry-configurable (0.11.6)
+    concurrent-ruby (1.3.4)
+    diff-lcs (1.5.1)
+    dry-configurable (1.2.0)
+      dry-core (~> 1.0, < 2)
+      zeitwerk (~> 2.6)
+    dry-core (1.0.1)
       concurrent-ruby (~> 1.0)
-      dry-core (~> 0.4, >= 0.4.7)
-      dry-equalizer (~> 0.2)
-    dry-container (0.7.2)
+      zeitwerk (~> 2.6)
+    dry-inflector (1.1.0)
+    dry-initializer (3.1.1)
+    dry-logic (1.5.0)
       concurrent-ruby (~> 1.0)
-      dry-configurable (~> 0.1, >= 0.1.3)
-    dry-core (0.5.0)
+      dry-core (~> 1.0, < 2)
+      zeitwerk (~> 2.6)
+    dry-schema (1.13.4)
       concurrent-ruby (~> 1.0)
-    dry-equalizer (0.3.0)
-    dry-inflector (0.2.0)
-    dry-initializer (3.0.4)
-    dry-logic (1.0.8)
-      concurrent-ruby (~> 1.0)
-      dry-core (~> 0.2)
-      dry-equalizer (~> 0.2)
-    dry-schema (1.5.6)
-      concurrent-ruby (~> 1.0)
-      dry-configurable (~> 0.8, >= 0.8.3)
-      dry-core (~> 0.4)
-      dry-equalizer (~> 0.2)
+      dry-configurable (~> 1.0, >= 1.0.1)
+      dry-core (~> 1.0, < 2)
       dry-initializer (~> 3.0)
-      dry-logic (~> 1.0)
-      dry-types (~> 1.4)
-    dry-types (1.4.0)
+      dry-logic (>= 1.4, < 2)
+      dry-types (>= 1.7, < 2)
+      zeitwerk (~> 2.6)
+    dry-types (1.7.2)
+      bigdecimal (~> 3.0)
       concurrent-ruby (~> 1.0)
-      dry-container (~> 0.3)
-      dry-core (~> 0.4, >= 0.4.4)
-      dry-equalizer (~> 0.3)
-      dry-inflector (~> 0.1, >= 0.1.2)
-      dry-logic (~> 1.0, >= 1.0.2)
-    dry-validation (1.6.0)
+      dry-core (~> 1.0)
+      dry-inflector (~> 1.0)
+      dry-logic (~> 1.4)
+      zeitwerk (~> 2.6)
+    dry-validation (1.10.0)
       concurrent-ruby (~> 1.0)
-      dry-container (~> 0.7, >= 0.7.1)
-      dry-core (~> 0.4)
-      dry-equalizer (~> 0.2)
+      dry-core (~> 1.0, < 2)
       dry-initializer (~> 3.0)
-      dry-schema (~> 1.5, >= 1.5.2)
-    method_source (1.0.0)
-    pry (0.13.1)
+      dry-schema (>= 1.12, < 2)
+      zeitwerk (~> 2.6)
+    method_source (1.1.0)
+    pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    pry-byebug (3.9.0)
+    pry-byebug (3.10.1)
       byebug (~> 11.0)
-      pry (~> 0.13.0)
+      pry (>= 0.13, < 0.15)
     rake (12.3.3)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.2)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.2)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.1)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.3)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.3)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    zeitwerk (2.6.18)
 
 PLATFORMS
   ruby

data/README.md

@@ -26,6 +26,8 @@ Or install it yourself as:
 
     $ gem install opera
 
+Note. If you are using Ruby 2.x please use Opera 0.2.x
+
 ## Configuration
 
 Opera is built to be used with or without Rails.
@@ -159,8 +161,16 @@ Some cases and example how to use new operations
 
 ```ruby
 class Profile::Create < Opera::Operation::Base
-  context_accessor :profile
-  dependencies_reader :current_account, :mailer
+  # DEPRECATED
+  # context_accessor :profile
+  context do
+    attr_accessor :profile
+  end
+  # DEPRECATED
+  # dependencies_reader :current_account, :mailer 
+  dependencies do
+    attr_reader :current_account, :mailer
+  end
 
   validate :profile_schema
 
@@ -232,8 +242,17 @@ Profile::Create.call(params: {
 
 ```ruby
 class Profile::Create < Opera::Operation::Base
-  context_accessor :profile
-  dependencies_reader :current_account, :mailer
+  # DEPRECATED
+  # context_accessor :profile
+  context do
+    attr_accessor :profile
+  end
+  # DEPRECATED
+  # dependencies_reader :current_account, :mailer
+  dependencies do
+    attr_reader :current_account, :mailer
+  end
+
 
   validate :profile_schema
 
@@ -282,8 +301,16 @@ Profile::Create.call(params: {
 
 ```ruby
 class Profile::Create < Opera::Operation::Base
-  context_accessor :profile
-  dependencies_reader :current_account, :mailer
+  # DEPRECATED
+  # context_accessor :profile
+  context do
+    attr_accessor :profile
+  end
+  # DEPRECATED
+  # dependencies_reader :current_account, :mailer
+  dependencies do
+    attr_reader :current_account, :mailer
+  end
 
   validate :profile_schema
 
@@ -358,8 +385,16 @@ Profile::Create.call(params: {
 
 ```ruby
 class Profile::Create < Opera::Operation::Base
-  context_accessor :profile
-  dependencies_reader :current_account, :mailer
+  # DEPRECATED
+  # context_accessor :profile
+  context do
+    attr_accessor :profile
+  end
+  # DEPRECATED
+  # dependencies_reader :current_account, :mailer
+  dependencies do
+    attr_reader :current_account, :mailer
+  end
 
   validate :profile_schema
 
@@ -417,8 +452,16 @@ result = Profile::Create.call(params: {
 
 ```ruby
 class Profile::Create < Opera::Operation::Base
-  context_accessor :profile
-  dependencies_reader :current_account, :mailer
+  # DEPRECATED
+  # context_accessor :profile
+  context do
+    attr_accessor :profile
+  end
+  # DEPRECATED
+  # dependencies_reader :current_account, :mailer
+  dependencies do
+    attr_reader :current_account, :mailer
+  end
 
   validate :profile_schema
 
@@ -476,8 +519,16 @@ class Profile::Create < Opera::Operation::Base
     config.transaction_class = Profile
   end
 
-  context_accessor :profile
-  dependencies_reader :current_account, :mailer
+  # DEPRECATED
+  # context_accessor :profile
+  context do
+    attr_accessor :profile
+  end
+  # DEPRECATED
+  # dependencies_reader :current_account, :mailer
+  dependencies do
+    attr_reader :current_account, :mailer
+  end
 
   validate :profile_schema
 
@@ -541,8 +592,16 @@ class Profile::Create < Opera::Operation::Base
     config.transaction_class = Profile
   end
 
-  context_accessor :profile
-  dependencies_reader :current_account, :mailer
+  # DEPRECATED
+  # context_accessor :profile
+  context do
+    attr_accessor :profile
+  end
+  # DEPRECATED
+  # dependencies_reader :current_account, :mailer
+  dependencies do
+    attr_reader :current_account, :mailer
+  end
 
   validate :profile_schema
 
@@ -602,8 +661,16 @@ 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
+  # DEPRECATED
+  # context_accessor :profile
+  context do
+    attr_accessor :profile
+  end
+  # DEPRECATED
+  # dependencies_reader :current_account, :mailer
+  dependencies do
+    attr_reader :current_account, :mailer
+  end
 
   validate :profile_schema
 
@@ -657,8 +724,16 @@ Profile::Create.call(params: {
 
 ```ruby
 class Profile::Create < Opera::Operation::Base
-  context_accessor :profile
-  dependencies_reader :current_account, :mailer
+  # DEPRECATED
+  # context_accessor :profile
+  context do
+    attr_accessor :profile
+  end
+  # DEPRECATED
+  # dependencies_reader :current_account, :mailer
+  dependencies do
+    attr_reader :current_account, :mailer
+  end
 
   validate :profile_schema
 
@@ -719,8 +794,16 @@ Profile::Create.call(params: {
 
 ```ruby
 class Profile::Create < Opera::Operation::Base
-  context_accessor :profile
-  dependencies_reader :current_account, :mailer
+  # DEPRECATED
+  # context_accessor :profile
+  context do
+    attr_accessor :profile
+  end
+  # DEPRECATED
+  # dependencies_reader :current_account, :mailer
+  dependencies do
+    attr_reader :current_account, :mailer
+  end
 
   validate :profile_schema
 
@@ -880,6 +963,7 @@ Opera::Operation::Result.new(output: 'success')
     - failure? - [true, false] - Return true if any error or exception
     - output   - [Anything]    - Return Anything
     - output=(Anything)        - Sets content of operation output
+    - output!                  - Return Anything if Success, raise exception if Failure
     - add_error(key, value)    - Adds new error message
     - add_errors(Hash)         - Adds multiple error messages
     - add_exception(method, message, classname: nil) - Adds new exception
@@ -976,26 +1060,11 @@ end
 
 For creating instance methods that are meant to be read-only and not stored within a context hash, defining these methods as private is a more suitable and clear approach compared to using context_reader with a default. This method ensures that transient dependencies remain well-encapsulated and are not confused with persistent application state.
 
-#### `context_writer`
+### `context|params|depenencies`
 
-The `context_writer` helper method is designed to enable setting of values for specified keys within a `context` hash. This method dynamically defines a method that acts as a setter, allowing for the direct modification of the value associated with a given key.
-
-#### Usage
-```ruby
-context_writer :profile
+The `context|params|depenencies` helper method is designed to enable easy access to and modification of values for specified keys within a `context` hash. This method dynamically defines both getter and setter methods for the designated keys, facilitating straightforward retrieval and update of values.
 
-step :fetch_profile
-
-def fetch_profile
-  self.profile = ProfileFetcher.call # sets context[:profile]
-end
-```
-
-#### `context_accessor`
-
-The `context_accessor` helper method is designed to enable easy access to and modification of values for specified keys within a `context` hash. This method dynamically defines both getter and setter methods for the designated keys, facilitating straightforward retrieval and update of values.
-
-#### Parameters
+#### attr_reader, attr_accessor Parameters
 
 **key (Symbol):** The key(s) for which the getter and setter methods are to be created. These symbols will correspond to keys in the context hash.
 
@@ -1003,7 +1072,9 @@ The `context_accessor` helper method is designed to enable easy access to and mo
 
 #### Usage
 ```ruby
-context_accessor :profile
+context do
+  attr_accessor :profile
+end
 
 step :fetch_profile
 step :update_profile
@@ -1018,16 +1089,19 @@ end
 ```
 
 ```ruby
-context_accessor :profile, default: -> { Profile.new }
+context do
+  attr_accessor :profile, default: -> { Profile.new }
+end
 ```
 
 ```ruby
-context_accessor :profile, :account
+context do
+  attr_accessor :profile, :account
+end
 ```
 
 #### Other methods
 >
-    - [params|dependencies]_reader     - predefined readers for immutable arguments
     - step(Symbol)             - single instruction
       - return [Truthly]       - continue operation execution
       - return [False]         - stops operation execution

data/lib/opera/operation/attributes_dsl.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Opera
+  module Operation
+    class AttributesDSL
+      attr_accessor :klass, :block_name, :allowed
+
+      def initialize(klass:, block_name:, allowed: [:attr_reader])
+        @klass = klass
+        @allowed = allowed
+        @block_name = block_name
+      end
+
+      def attr_reader(*attributes, **options)
+        raise NoMethodError, "You cannot use attr_reader inside #{klass.name}##{block_name}" unless allowed.include?(:attr_reader)
+
+        attributes.each do |attribute|
+          klass.check_method_availability!(attribute)
+
+          method = block_name
+          klass.define_method(attribute) do
+            value = if send(method).key?(attribute)
+              send(method)[attribute]
+            elsif options[:default]
+              instance_exec(&options[:default])
+            end
+
+            if send(method).frozen?
+              send(method)[attribute] || value
+            else
+              send(method)[attribute] ||= value
+            end
+          end
+        end
+      end
+
+      def attr_writer(*attributes, **options)
+        raise NoMethodError, "You cannot use attr_writer inside #{klass.name}##{block_name}" unless allowed.include?(:attr_accessor)
+
+        attributes.each do |attribute|
+          klass.check_method_availability!("#{attribute}=")
+          method = block_name
+          klass.define_method("#{attribute}=") do |value|
+            send(method)[attribute] = value
+          end
+        end
+      end
+
+      def attr_accessor(*attributes, **options)
+        raise NoMethodError, "You cannot use attr_accessor inside #{klass.name}##{block_name}" unless allowed.include?(:attr_accessor)
+
+        attr_reader(*attributes, **options)
+        attr_writer(*attributes)
+      end
+    end
+  end
+end

data/lib/opera/operation/base.rb

@@ -55,42 +55,39 @@ module Opera
           raise(ArgumentError, "Method #{method} is already defined")
         end
 
+        def context(&blk)
+          AttributesDSL.new(klass: self, block_name: :context, allowed: [:attr_reader, :attr_accessor]).instance_exec(&blk)
+        end
+
+        def params(&blk)
+          AttributesDSL.new(klass: self, block_name: :params).instance_exec(&blk)
+        end
+
+        def dependencies(&blk)
+          AttributesDSL.new(klass: self, block_name: :dependencies).instance_exec(&blk)
+        end
+
+        # TODO: Delete with newer version
         %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
-                value = if send(method).key?(attribute)
-                          send(method)[attribute]
-                        elsif options[:default]
-                          instance_exec(&options[:default])
-                        end
-
-                if send(method).frozen?
-                  send(method)[attribute] || value
-                else
-                  send(method)[attribute] ||= value
-                end
-              end
+            send(method) do
+              attr_reader *attributes, **options
             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
+            send(method) do
+              attr_writer *attributes
             end
           end
 
           define_method("#{method}_accessor") do |*attributes, **options|
-            send("#{method}_reader", *attributes, **options)
-            send("#{method}_writer", *attributes)
+            send(method) do
+              attr_reader *attributes, **options
+              attr_writer *attributes, **options
+            end
           end
         end
       end

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

@@ -17,7 +17,7 @@ module Opera
 
             case dry_result
             when Opera::Operation::Result
-              add_instruction_output(instruction, dry_result.to_h)
+              add_instruction_output(instruction, dry_result.output)
 
               unless dry_result.success?
                 result.add_errors(dry_result.errors)

data/lib/opera/operation/result.rb

@@ -3,14 +3,14 @@
 module Opera
   module Operation
     class Result
+      class OutputError < StandardError; end
+
       attr_reader :errors, # Acumulator of errors in validation + steps
                   :exceptions, # Acumulator of exceptions in steps
                   :information, # Temporal object to store related information
                   :executions # Stacktrace or Pipe of the methods evaludated
 
-      attr_accessor :output # Final object returned if success?
-
-      alias to_h output
+      attr_accessor :output # in case of success, it contains the resulting value
 
       def initialize(output: nil, errors: {})
         @errors = errors
@@ -32,6 +32,12 @@ module Opera
         errors.merge(exceptions)
       end
 
+      def output!
+        raise OutputError, 'Cannot retrieve output from a Failure.' if failure?
+
+        output
+      end
+
       # rubocop:disable Metrics/MethodLength
       def add_error(field, message)
         @errors[field] ||= []

data/lib/opera/operation.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'opera/operation/attributes_dsl'
 require 'opera/operation/builder'
 require 'opera/operation/base'
 require 'opera/operation/executor'

data/lib/opera/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Opera
-  VERSION = '0.2.17'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opera
 version: !ruby/object:Gem::Version
-  version: 0.2.17
+  version: 0.3.0
 platform: ruby
 authors:
 - ProFinda Development Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-07-08 00:00:00.000000000 Z
+date: 2024-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-validation
@@ -78,6 +78,7 @@ files:
 - lib/opera.rb
 - lib/opera/errors.rb
 - lib/opera/operation.rb
+- lib/opera/operation/attributes_dsl.rb
 - lib/opera/operation/base.rb
 - lib/opera/operation/builder.rb
 - lib/opera/operation/config.rb