opera 0.1.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9012fc7c78d543bde97172bb8504d8835fbdc051c9842498544c7c86669638c9
-  data.tar.gz: 78021a04133da9fbacb96275c369337213a08822c710f325ce6d78b04970db37
+  metadata.gz: c87b8365cd3d9a0da8fce865abe9babe04df29df31253697ec01bf45ee81d897
+  data.tar.gz: 313ba34f1abc8e4845b71a4b1f209362ad14c08d79dd30a51b120c52e364ee2f
 SHA512:
-  metadata.gz: fd9778459fceeda84e49684a18d11ef82b3ba593824c568bee8bce2cd92d311f8020cd128e3274da6d09ace98890ccb1b69eec778e63cf87a9352c24fea3c3e5
-  data.tar.gz: 879bd00727c7554e5fda0620564fccefbcd4da64ca25e04216d259df1c94d5f289df9c3506a82f262288b53f2c1cb6b2131789a641f0a57e33ddf23a438f278d
+  metadata.gz: 42bdbac9178ca00ea91d998c5d1ee20a125993bc5ac830d5e5f523092527a40d1948a5504b5120d88b72200272994c71839cb2ea6d4361cd1a7402d8e9e76c16
+  data.tar.gz: 1ba960d0d599d5cfc9c0d0c5e788420043fb8bbc4c1608f806bc751b9e4b0dd00744fd3a10a200957ff9fcce7c300c508ca27c5b2d6da3b022601dfb9587dbee

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

@@ -0,0 +1,34 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Specs
+
+on:
+  pull_request:
+    branches: []
+
+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

data/CHANGELOG.md

@@ -1,6 +1,18 @@
 # Opera Changelog
 
+### 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/Dockerfile

@@ -1,4 +1,4 @@
-FROM ruby:2.7.1
+FROM ruby:3
 
 MAINTAINER ProFinda Developers <dev@profinda.com>
 

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,9 @@
 # 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)
+
+
 Simple DSL for services/interactions classes.
 
 Opera was born to mimic some of the philosophy of the dry gems but keeping the DSL simple.
@@ -31,6 +35,7 @@ Simply initialise the configuration and chose what method you want to use to rep
 Opera::Operation::Config.configure do |config|
   config.transaction_class = ActiveRecord::Base
   config.transaction_method = :transaction
+  config.transaction_options = { requires_new: true }
   config.reporter = defined?(Rollbar) ? Rollbar : Rails.logger
 end
 ```
@@ -151,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
@@ -164,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
 ```
@@ -221,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
@@ -236,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
 ```
@@ -267,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
@@ -282,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
 ```
@@ -340,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
@@ -355,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
@@ -364,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,
@@ -394,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
@@ -408,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,
@@ -448,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
@@ -465,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
 ```
@@ -510,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
@@ -527,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
 ```
@@ -568,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
@@ -585,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
 ```
@@ -620,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
@@ -644,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
@@ -787,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
@@ -806,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/operation/config.rb

@@ -3,11 +3,12 @@
 module Opera
   module Operation
     class Config
-      attr_accessor :transaction_class, :transaction_method, :reporter
+      attr_accessor :transaction_class, :transaction_method, :transaction_options, :reporter
 
       def initialize
         @transaction_class = self.class.transaction_class
         @transaction_method = self.class.transaction_method || :transaction
+        @transaction_options = self.class.transaction_options
         @reporter = custom_reporter || self.class.reporter
       end
 
@@ -20,7 +21,7 @@ module Opera
       end
 
       class << self
-        attr_accessor :transaction_class, :transaction_method, :reporter
+        attr_accessor :transaction_class, :transaction_method, :transaction_options, :reporter
 
         def configure
           yield self

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

@@ -8,7 +8,8 @@ module Opera
           class RollbackTransactionError < Opera::Error; end
 
           def call(instruction)
-            transaction_class.send(transaction_method) do
+            arguments = transaction_options ? [transaction_method, transaction_options] : [transaction_method]
+            transaction_class.send(*arguments) do
               super
 
               return if !operation.finished? && result.success?
@@ -26,6 +27,10 @@ module Opera
           def transaction_method
             config.transaction_method
           end
+
+          def transaction_options
+            config.transaction_options
+          end
         end
       end
     end

data/lib/opera/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opera
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.3
 platform: ruby
 authors:
 - ProFinda Development Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-08 00:00:00.000000000 Z
+date: 2021-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-validation
@@ -59,6 +59,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/release.yml"
+- ".github/workflows/specs.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -113,7 +115,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: Use simple DSL language to keep your Operations clean and maintainable