opera 0.2.1 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1289d8fac87c7236cf48c043f9901589bbc04965946fac600d5b056d850c006e
-  data.tar.gz: 8aa8a43aeb813b0f388a2f49e814b924426685ac7a00d5b0b224df29f740aea6
+  metadata.gz: e5d9c893a5fbb54c998d21da587625c5c4395325cba2e626daaecc7a09c8dfcb
+  data.tar.gz: 718d329ba4593be294625339bf7803764c3daba1b6af28d44bbd0d466d5bc0ac
 SHA512:
-  metadata.gz: e759a1bde5f394fb1baa50c7f268f2c094b2321c57536a3a10ba6a909800736fc31a98b8fdec1bf786626693e4a7e65e7f0a1806665d5d962b5a257f10af8aea
-  data.tar.gz: 4cc58219c20a9f11a2bfad9e9963a0254951609e93ef698b6d89a37a10a55adc5aa1684472b15efbdb82909aa8eadcbbdd0b7c21d85be6573cc8a67da6de29c5
+  metadata.gz: 723969ac97c573f821395a239ed57fb4fcd8f39ab8ffe7f1d492c848b4625ab7e2b6a1e6a1460cddf5500fa1a486bb43aa6849e2d7bbd1e984ba915321f9aeff
+  data.tar.gz: eb67bdc92c6d8f6156566e00bae3da4b7cbe9ea7eb7911c287952726fae6b3d703258efe495ef9fcfcdb4b847b2593358d859e72426a75e1ce2fec70017091b8

data/.github/workflows/release.yml

@@ -0,0 +1,66 @@
+name: Release
+
+on:
+  push:
+    branches: [ master ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: [ '2.6', '2.7', '3.0' ]
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+        # change this to (see https://github.com/ruby/setup-ruby#versioning):
+        # uses: ruby/setup-ruby@v1
+        uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: false # runs 'bundle install' and caches installed gems automatically
+      - name: Install gems
+        run: bundle install
+      - name: Run tests
+        run: bundle exec rspec
+
+  tag:
+    needs: test
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Tag automatically
+        run: git tag v`cat lib/opera/version.rb | grep 'VERSION' | awk '{ print $3 $4 }' | sed "s/'//g"`
+
+      - name: Push tags
+        run: git push origin --tags
+
+  publish:
+    needs: tag
+    name: Build + Publish
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby 2.6
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: 2.6.x
+
+      - name: Publish to RubyGems
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+          gem build *.gemspec
+          gem push *.gem
+        env:
+          GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.github/workflows/specs.yml

@@ -8,14 +8,11 @@
 name: Specs
 
 on:
-  push:
-    branches: [ master ]
   pull_request:
     branches: []
 
 jobs:
   test:
-
     runs-on: ubuntu-latest
     strategy:
       matrix:

data/CHANGELOG.md

@@ -1,9 +1,27 @@
 # Opera Changelog
 
-## 0.1.0 - September 12, 2020
+### 0.2.5 - August 3, 2021
 
-- Initial release
+- make sure that `default` option in accessors is always lambda
+
+### 0.2.4 - July 26, 2021
+
+- prevent default from overwrite falsy values
+- allow params and dependencies to get defaults
+
+### 0.2.3 - July 26, 2021
+
+- 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.1.0 - September 12, 2020
+
+- Initial release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    opera (0.1.2)
+    opera (0.2.5)
 
 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,6 +1,7 @@
 # Opera
 
-![Master](https://github.com/Profinda/opera/actions/workflows/ruby.yml/badge.svg?branch=master)
+[![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)
 
 
 Simple DSL for services/interactions classes.
@@ -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,47 @@ 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
+                value = send(method).key?(attribute) ? send(method)[attribute] : self.instance_exec(&options[:default])
+
+                if send(method).frozen?
+                  send(method)[attribute] || value
+                else
+                  send(method)[attribute] ||= value
+                end
+              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.1'
+  VERSION = '0.2.5'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opera
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.5
 platform: ruby
 authors:
 - ProFinda Development Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-07-07 00:00:00.000000000 Z
+date: 2021-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-validation
@@ -59,9 +59,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/gem-push.yml"
+- ".github/workflows/release.yml"
 - ".github/workflows/specs.yml"
-- ".github/workflows/tag.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"

data/.github/workflows/gem-push.yml

@@ -1,31 +0,0 @@
-name: Ruby Gem
-
-on:
-  push:
-    branches: [ master ]
-
-jobs:
-  build:
-    name: Build + Publish
-    runs-on: ubuntu-latest
-    permissions:
-      contents: read
-      packages: write
-
-    steps:
-    - uses: actions/checkout@v2
-    - name: Set up Ruby 2.6
-      uses: actions/setup-ruby@v1
-      with:
-        ruby-version: 2.6.x
-
-    - name: Publish to RubyGems
-      run: |
-        mkdir -p $HOME/.gem
-        touch $HOME/.gem/credentials
-        chmod 0600 $HOME/.gem/credentials
-        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
-        gem build *.gemspec
-        gem push *.gem
-      env:
-        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.github/workflows/tag.yml

@@ -1,22 +0,0 @@
-# This is a basic workflow to help you get started with Actions
-
-name: Tag
-
-# Controls when the workflow will run
-on:
-  # Triggers the workflow on push or pull request events but only for the master branch
-  push:
-    branches: [ master ]
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v2
-
-      - name: Tag automatically
-        run: git tag v`cat lib/opera/version.rb | grep 'VERSION' | awk '{ print $3 $4 }' | sed "s/'//g"`
-
-      - name: Push tags
-        run: git push origin --tags