light-service 0.15.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f400829da41766f56e7f0cb9cfe95aa028ef8ab34bf0bc5794bfafcff3cdcfb1
-  data.tar.gz: 41dbd504ac39a0804eb445b4af086dbcf9986264077994277e17fde98b7bdc3d
+  metadata.gz: d41ecb22a4b0d3cd9779c1e5726c8f34e6f186a34f04ec97ea5928f682f08fd8
+  data.tar.gz: 64f4d7f52607048313e9f39bea158899ef804deb32ae9744715e5969cc7b1567
 SHA512:
-  metadata.gz: e9a1148b82b6e1a0813400b0d23b013ff6f06965f3204bb3fa95101adc8a749223dd334887f7543622b4a829fd17f190c21dd5f601df3aecde8d8451459a76af
-  data.tar.gz: f0aec690e94896dcc13d6caa774003e49ddfa6b74c5acf9272fb7b9d3710d28db4a29601e725e3729deba820013c62b740739d5c6052c4c5ae93fd885cec6fda
+  metadata.gz: 2345b72e3d9581aecaea2fe5eca1bd3c538cdb0cfcd2d943ac021ca4f3ef31913ac4b06011944c017df330f3ee8dc385793e8185f3e79cba6c51fbe6ee6acba6
+  data.tar.gz: 703b9608edfa42bf0d73135fa5b4eafa789e8a31c4239056fd8b7397d6f0a212f8c5c69d66834f1f5b9fe2431b234f8c0373ccaaa86f286d82671bfe8d8b705b

data/.github/workflows/project-build.yml

@@ -0,0 +1,28 @@
+name: CI Tests
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu, macos]
+        ruby: [2.5.3, 2.6.6, 2.7.2]
+        gemfile: [activesupport_5, activesupport_6]
+    continue-on-error: ${{ endsWith(matrix.ruby, 'head') || matrix.ruby == 'debug' }}
+    env: # $BUNDLE_GEMFILE must be set at the job level, so it is set for all steps
+      BUNDLE_GEMFILE: gemfiles/${{ matrix.gemfile }}.gemfile
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - run: bundle install
+      - run: bundle exec rspec spec
+      - run: bundle exec rubocop

data/.travis.yml

@@ -4,10 +4,9 @@ env:
   - RUN_COVERAGE_REPORT=true
 
 rvm:
-  - 2.4.2
   - 2.5.3
-  - 2.6.0
-  - 2.7.0
+  - 2.6.6
+  - 2.7.2
 
 before_install:
   - 'echo ''gem: --no-ri --no-rdoc'' > ~/.gemrc'
@@ -26,9 +25,5 @@ gemfile:
 
 matrix:
   exclude:
-  - rvm: 2.4.2
-    gemfile: gemfiles/activesupport_6.gemfile
-  - rvm: 2.7.0
-    gemfile: gemfiles/activesupport_3.gemfile
-  - rvm: 2.7.0
+  - rvm: 2.7.2
     gemfile: gemfiles/activesupport_4.gemfile

data/README.md

@@ -1,20 +1,15 @@
 ![LightService](https://raw.githubusercontent.com/adomokos/light-service/master/resources/light-service.png)
 
 [![Gem Version](https://img.shields.io/gem/v/light-service.svg)](https://rubygems.org/gems/light-service)
-[![Build Status](https://secure.travis-ci.org/adomokos/light-service.svg)](http://travis-ci.org/adomokos/light-service)
+[![CI Tests](https://github.com/adomokos/light-service/actions/workflows/project-build.yml/badge.svg)](https://github.com/adomokos/light-service/actions/workflows/project-build.yml)
 [![codecov](https://codecov.io/gh/adomokos/light-service/branch/master/graph/badge.svg)](https://codecov.io/gh/adomokos/light-service)
 [![Code Climate](https://codeclimate.com/github/adomokos/light-service.svg)](https://codeclimate.com/github/adomokos/light-service)
 [![License](https://img.shields.io/badge/license-MIT-green.svg)](http://opensource.org/licenses/MIT)
 [![Download Count](https://ruby-gem-downloads-badge.herokuapp.com/light-service?type=total)](https://rubygems.org/gems/light-service)
 
-<br>
+LightService is a powerful and flexible service skeleton framework with an emphasis on simplicity
 
-![Orchestrators-Deprecated](resources/orchestrators_deprecated.svg)
-<br>Version 0.9.0 deprecates Orchestrators and moves all their functionalities into Organizers. Please check out [this PR](https://github.com/adomokos/light-service/pull/132) to see the changes.
-
-<br>
-
-## Table of Content
+## Table of Contents
 * [Why LightService?](#why-lightservice)
 * [Getting Started](#getting-started)
     * [Requirements](#requirements)
@@ -31,9 +26,11 @@
 * [Error Codes](#error-codes)
 * [Action Rollback](#action-rollback)
 * [Localizing Messages](#localizing-messages)
-* [Orchestrator Logic in Organizers](#orchestrator-logic-in-organizers)
+* [Orchestrating Logic in Organizers](#orchestrating-logic-in-organizers)
 * [ContextFactory for Faster Action Testing](#contextfactory-for-faster-action-testing)
 * [Rails support](#rails-support)
+* [Implementations in other languages](#other-implementations)
+* [Contributing](#contributing)
 
 ## Why LightService?
 
@@ -866,9 +863,13 @@ end
 
 To get the value of a `fail!` or `succeed!` message, simply call `#message` on the returned context.
 
-## Orchestrator Logic in Organizers
+## Orchestrating Logic in Organizers
+
+The Organizer - Action combination works really well for simple use cases. However, as business logic gets more complex, or when LightService is used in an ETL workflow, the code that routes the different organizers becomes very complex and imperative.
 
-The Organizer - Action combination works really well for simple use cases. However, as business logic gets more complex, or when LightService is used in an ETL workflow, the code that routes the different organizers becomes very complex and imperative. Let's look at a piece of code that does basic data transformations:
+In the past, this was solved using Orchestrators. As of [Version 0.9.0 Orchestrators have been deprecated](https://github.com/adomokos/light-service/pull/132). All their functionality is now usable directly within Organizers. Read on to understand how to orchestrate workflows from within a single Organizer.
+
+Let's look at a piece of code that does basic data transformations:
 
 ```ruby
 class ExtractsTransformsLoadsData
@@ -942,7 +943,7 @@ To take advantage of another organizer or action, you might need to tweak the co
 
 Use `with_callback` when you want to execute actions with a deferred and controlled callback. It works similar to a Sax parser, I've used it for processing large files. The advantage of it is not having to keep large amount of data in memory. See [this acceptance test](spec/acceptance/organizer/with_callback_spec.rb) as a working example.
 
-`add_to_context` can add key-value pairs on the fly to the context. This functionality is useful when you need a value injected into the context under a specific key right before the subsequent actions are executed. [This test](spec/acceptance/organizer/add_to_context_spec.rb) describes its functionality.
+`add_to_context` can add key-value pairs on the fly to the context. This functionality is useful when you need a value injected into the context under a specific key right before the subsequent actions are executed. Keys are also made available as accessors on the context object and can be used just like methods exposed via `expects` and `promises`. [This test](spec/acceptance/organizer/add_to_context_spec.rb) describes its functionality.
 
 Your action needs a certain key in the context but it's under a different one? Use the function `add_aliases` to alias an existing key in the context under the desired key. Take a look at [this test](spec/acceptance/organizer/add_aliases_spec.rb) to see an example.
 
@@ -1046,6 +1047,13 @@ them through the context. A stub context will be created in the test file using
 
 When specifying `promises`, specs will be created testing for their existence after executing the action.
 
+## Other implementations
+
+| Language | Repo                                                              | Author                                                 |
+| :------- |:------------------------------------------------------------------| :------------------------------------------------------|
+| Python   | [pyservice](https://github.com/adomokos/pyservice)                | [@adomokos](https://github.com/adomokos)               |
+| PHP      | [light-service](https://github.com/douglasgreyling/light-service) | [@douglasgreyling](https://github.com/douglasgreyling) |
+
 ## Contributing
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)

data/RELEASES.md

@@ -1,11 +1,16 @@
 A brief list of new features and changes introduced with the specified version.
 
+### 0.16.0
+* [Drop Ruby 2.4 support](https://github.com/adomokos/light-service/pull/207)
+* [Fix callback current action](https://github.com/adomokos/light-service/pull/209)
+* [Add Context accessors](https://github.com/adomokos/light-service/pull/211)
+* [Switched to GH Actions from Travis CI](https://github.com/adomokos/light-service/pull/212)
+
 ### 0.15.0
 * [Add Rails Generators](https://github.com/adomokos/light-service/pull/194) - LightService actions and organizers can be generated with generators
 * [Add CodeCov](https://github.com/adomokos/light-service/pull/195) - Upload code coverage report to codecov.io
 * [Remove ActiveSupport 3 checks](https://github.com/adomokos/light-service/pull/197) - They are unsupported, no need to tests them any more.
 
-
 ### 0.14.0
 * [Add 'organized_by' to context](https://github.com/adomokos/light-service/pull/192) - Context now have an #organized_by attribute
 

data/lib/light-service/action.rb

@@ -44,6 +44,9 @@ module LightService
             catch(:jump_when_failed) do
               call_before_action(action_context)
               yield(action_context)
+
+              # Reset the stored action in case it was changed downstream
+              action_context.current_action = self
               call_after_action(action_context)
             end
           end

data/lib/light-service/context.rb

@@ -115,9 +115,9 @@ module LightService
     end
 
     def define_accessor_methods_for_keys(keys)
-      return if keys.nil?
+      return if keys.blank?
 
-      keys.each do |key|
+      Array(keys).each do |key|
         next if respond_to?(key.to_sym)
 
         define_singleton_method(key.to_s) { fetch(key) }

data/lib/light-service/context/key_verifier.rb

@@ -111,7 +111,24 @@ module LightService
       end
 
       def reserved_keys
-        %i[message error_code current_action].freeze
+        %i[message error_code current_action organized_by].freeze
+      end
+    end
+
+    class ReservedKeysViaOrganizerVerifier < ReservedKeysVerifier
+      def initialize(context_data)
+        @context = LightService::Context.make(context_data)
+      end
+
+      def violated_keys
+        context.keys.map(&:to_sym) & reserved_keys
+      end
+
+      def error_message
+        <<~ERR
+          reserved keys cannot be added to the context
+          reserved key: [#{format_keys(violated_keys)}]
+        ERR
       end
     end
   end

data/lib/light-service/organizer.rb

@@ -65,9 +65,18 @@ module LightService
         @logger
       end
 
-      def add_to_context(**args)
-        args.map do |key, value|
-          execute(->(ctx) { ctx[key.to_sym] = value })
+      # Set the value as a key on the context hash
+      # and also create convenience accessors for the keys
+      def add_to_context(args)
+        Context::ReservedKeysViaOrganizerVerifier.new(args).verify
+
+        Hash(args).map do |key, value|
+          context_key = lambda do |ctx|
+            ctx[key.to_sym] = value
+            ctx.define_accessor_methods_for_keys(key)
+          end
+
+          execute(context_key)
         end
       end
 

data/lib/light-service/version.rb

@@ -1,3 +1,3 @@
 module LightService
-  VERSION = "0.15.0".freeze
+  VERSION = "0.16.0".freeze
 end

data/light-service.gemspec

@@ -15,8 +15,9 @@ Gem::Specification.new do |gem|
   gem.name          = "light-service"
   gem.require_paths = ["lib"]
   gem.version       = LightService::VERSION
+  gem.required_ruby_version = '>= 2.5.0'
 
-  gem.add_runtime_dependency("activesupport", ">= 3.0.0")
+  gem.add_runtime_dependency("activesupport", ">= 4.0.0")
 
   gem.add_development_dependency("generator_spec", "~> 0.9.4")
   gem.add_development_dependency("test-unit", "~> 3.0") # Needed for generator specs.

data/spec/acceptance/after_actions_spec.rb

@@ -65,6 +65,23 @@ RSpec.describe 'Action after_actions' do
     end
   end
 
+  context 'with callbacks' do
+    it 'ensures the correct :current_action is set' do
+      TestDoubles::TestWithCallback.after_actions = [
+        lambda do |ctx|
+          if ctx.current_action == TestDoubles::IterateCollectionAction
+            ctx.total -= 1000
+          end
+        end
+      ]
+
+      result = TestDoubles::TestWithCallback.call
+
+      expect(result.counter).to eq(3)
+      expect(result.total).to eq(-994)
+    end
+  end
+
   describe 'after_actions can be appended' do
     it 'adds to the :_after_actions collection' do
       TestDoubles::AdditionOrganizer.append_after_actions(

data/spec/acceptance/organizer/add_to_context_spec.rb

@@ -20,6 +20,20 @@ RSpec.describe LightService::Organizer do
     end
   end
 
+  class TestAddToContextReservedWords
+    extend LightService::Organizer
+
+    def self.call(context = LightService::Context.make)
+      with(context).reduce(steps)
+    end
+
+    def self.steps
+      [
+        add_to_context(:message => "yo", "error_code" => "00P5")
+      ]
+    end
+  end
+
   it 'adds items to the context on the fly' do
     result = TestAddToContext.call
 
@@ -27,4 +41,17 @@ RSpec.describe LightService::Organizer do
     expect(result.number).to eq(1)
     expect(result[:something]).to eq('hello')
   end
+
+  it 'adds items to the context as accessors' do
+    result = TestAddToContext.call
+
+    expect(result).to be_success
+    expect(result.something).to eq('hello')
+  end
+
+  it "will not add items as accessors when they are reserved" do
+    expect { TestAddToContextReservedWords.call }.to \
+      raise_error(LightService::ReservedKeysInContextError)
+      .with_message(/:message, :error_code/)
+  end
 end

data/spec/acceptance/organizer/execute_with_add_to_context_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+require 'test_doubles'
+
+RSpec.describe LightService::Organizer do
+  class TestExecuteWithAddToContext
+    extend LightService::Organizer
+
+    def self.call
+      with.reduce(steps)
+    end
+
+    def self.steps
+      [
+        add_to_context(:greeting => "hello"),
+        execute(->(ctx) { ctx.greeting.upcase! })
+      ]
+    end
+  end
+
+  context "when using context values created by add_to_context" do
+    it "is expected to reference them as accessors" do
+      result = TestExecuteWithAddToContext.call
+
+      expect(result).to be_a_success
+      expect(result.greeting).to eq "HELLO"
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: light-service
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.16.0
 platform: ruby
 authors:
 - Attila Domokos
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-28 00:00:00.000000000 Z
+date: 2021-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 4.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: generator_spec
   requirement: !ruby/object:Gem::Requirement
@@ -157,6 +157,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/project-build.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -168,7 +169,6 @@ files:
 - README.md
 - RELEASES.md
 - Rakefile
-- gemfiles/activesupport_4.gemfile
 - gemfiles/activesupport_5.gemfile
 - gemfiles/activesupport_6.gemfile
 - lib/generators/light_service/action_generator.rb
@@ -203,7 +203,6 @@ files:
 - light-service.gemspec
 - resources/fail_actions.png
 - resources/light-service.png
-- resources/orchestrators_deprecated.svg
 - resources/organizer_and_actions.png
 - resources/skip_actions.png
 - spec/acceptance/add_numbers_spec.rb
@@ -228,6 +227,7 @@ files:
 - spec/acceptance/organizer/around_each_with_reduce_if_spec.rb
 - spec/acceptance/organizer/context_failure_and_skipping_spec.rb
 - spec/acceptance/organizer/execute_spec.rb
+- spec/acceptance/organizer/execute_with_add_to_context_spec.rb
 - spec/acceptance/organizer/iterate_spec.rb
 - spec/acceptance/organizer/reduce_if_spec.rb
 - spec/acceptance/organizer/reduce_until_spec.rb
@@ -270,7 +270,7 @@ homepage: https://github.com/adomokos/light-service
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -278,7 +278,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -286,7 +286,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: A service skeleton with an emphasis on simplicity
 test_files:
@@ -312,6 +312,7 @@ test_files:
 - spec/acceptance/organizer/around_each_with_reduce_if_spec.rb
 - spec/acceptance/organizer/context_failure_and_skipping_spec.rb
 - spec/acceptance/organizer/execute_spec.rb
+- spec/acceptance/organizer/execute_with_add_to_context_spec.rb
 - spec/acceptance/organizer/iterate_spec.rb
 - spec/acceptance/organizer/reduce_if_spec.rb
 - spec/acceptance/organizer/reduce_until_spec.rb

data/gemfiles/activesupport_4.gemfile

@@ -1,7 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "activesupport", "~> 4.0"
-
-gemspec :path => "../"

data/resources/orchestrators_deprecated.svg

@@ -1,10 +0,0 @@
-<?xml version="1.0" encoding="utf-8"?>
-<svg version="1.1" 
-     xmlns="http://www.w3.org/2000/svg"
-     xmlns:xlink="http://www.w3.org/1999/xlink"
-     width="350" height="20"
->
-  <text font-size="20" x="0" y="20" font-family="Verdana">
-    <tspan fill="red">Orchestrators are DEPRECATED!</tspan>
-  </text>
-</svg>