attr-gather 1.1.3 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07ef681505341f374e4374d1baf4b5a8630a34b5dc87dc4fcaec159b2a7efeb2
-  data.tar.gz: 680bc4891c2a140b6af5e780d97dba80e7ceb5aa750f8a0fe88dffcf7327c9f5
+  metadata.gz: d5a781371ace4374427a2510da9860b10014caf039fcfd4aa620886f252d57a9
+  data.tar.gz: a0d1d564f206b30246e67d017e8a814c43529b120c6ff8499ef0198d5847ad7a
 SHA512:
-  metadata.gz: 4a634990d091aff5b530c06341e2cb2fdbad34cbec9f4b4dee073245822f45633fab79cbb8c4b76ee95dcda62d56a5b1ec856ac4b7500d04f9478a548664e070
-  data.tar.gz: 6c1dddb4c8478d28ced0677c2b1b4b86343404f645721dde7af77ed9cdc44e880f1ece2fd3a271b26ed85b2325b7b8d4c5ce6cffaa5e1e9b4c2b589c0430dfb7
+  metadata.gz: 52823ab8e9b562de9b23b8bdbe6bc08354bb85f71bd51580ab746fd4adce30cade4d27d55c3bf67a294bbb101f61eae485bc006537c89aefcba57ca28f3e8e39
+  data.tar.gz: '0998be6201c8b8292297390064233d0ad04c17b5b8d84ceebf76f0766e5d84fdfafb7edc0d2a4621825f2efafd66b192f89a3fbd38d6462b16ecbecbea7abc01'

data/.github/mergify.yml

@@ -13,7 +13,10 @@ pull_request_rules:
     conditions:
       - author~=^dependabot(|-preview)\[bot\]$
       - "#approved-reviews-by>=1"
-      - "check-success=build-test-lint"
+      - "check-success~=build-test-lint (2.4.x)"
+      - "check-success~=build-test-lint (2.5.x)"
+      - "check-success~=build-test-lint (2.6.x)"
+      - "check-success~=build-test-lint (2.7.x)"
     actions:
       merge:
         method: squash

data/.github/workflows/doc.yml

@@ -16,7 +16,7 @@ jobs:
           bundle install --without=local --jobs 4 --retry 3
           bundle exec yard
       - name: Deploy Docs
-        uses: JamesIves/github-pages-deploy-action@master
+        uses: JamesIves/github-pages-deploy-action@4.1.3
         if: github.ref == 'master'
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

data/.github/workflows/ruby.yml

@@ -4,6 +4,9 @@ on: [push]
 jobs:
   build-test-lint:
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: ["2.5.x", "2.6.x", "2.7.x"]
     steps:
       - uses: actions/checkout@v1
       - name: Set up Ruby 2.6

data/.rubocop.yml

@@ -5,6 +5,7 @@ AllCops:
   UseCache: true
   CacheRootDirectory: './tmp/cache'
   TargetRubyVersion: 2.5
+  NewCops: enable
 
 Metrics/BlockLength:
   Exclude:
@@ -14,7 +15,7 @@ Metrics/ModuleLength:
   Exclude:
     - spec/**/*.rb
 
-Metrics/LineLength:
+Layout/LineLength:
   Exclude:
     - ./attr-gather.gemspec
     - ./bin/**/*

data/.ruby-version

@@ -1 +1 @@
-2.6.5
+2.6.6

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    attr-gather (1.1.3)
+    attr-gather (1.5.1)
       dry-container (~> 0.7)
 
 GEM
@@ -9,46 +9,42 @@ GEM
   specs:
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
-    ast (2.4.1)
+    ast (2.4.2)
     backport (1.1.2)
-    benchmark (0.1.0)
+    benchmark (0.1.1)
     coderay (1.1.3)
-    concurrent-ruby (1.1.7)
-    diff-lcs (1.3)
+    concurrent-ruby (1.1.8)
+    diff-lcs (1.4.4)
     domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
-    dry-configurable (0.11.6)
+    dry-configurable (0.12.1)
       concurrent-ruby (~> 1.0)
-      dry-core (~> 0.4, >= 0.4.7)
-      dry-equalizer (~> 0.2)
+      dry-core (~> 0.5, >= 0.5.0)
     dry-container (0.7.2)
       concurrent-ruby (~> 1.0)
       dry-configurable (~> 0.1, >= 0.1.3)
-    dry-core (0.4.9)
+    dry-core (0.6.0)
       concurrent-ruby (~> 1.0)
     dry-equalizer (0.3.0)
     dry-inflector (0.2.0)
     dry-initializer (3.0.4)
-    dry-logic (1.0.8)
+    dry-logic (1.2.0)
       concurrent-ruby (~> 1.0)
-      dry-core (~> 0.2)
-      dry-equalizer (~> 0.2)
-    dry-schema (1.5.5)
+      dry-core (~> 0.5, >= 0.5)
+    dry-schema (1.6.2)
       concurrent-ruby (~> 1.0)
       dry-configurable (~> 0.8, >= 0.8.3)
-      dry-core (~> 0.4)
-      dry-equalizer (~> 0.2)
+      dry-core (~> 0.5, >= 0.5)
       dry-initializer (~> 3.0)
       dry-logic (~> 1.0)
-      dry-types (~> 1.4)
-    dry-types (1.4.0)
+      dry-types (~> 1.5)
+    dry-types (1.5.1)
       concurrent-ruby (~> 1.0)
       dry-container (~> 0.3)
-      dry-core (~> 0.4, >= 0.4.4)
-      dry-equalizer (~> 0.3)
+      dry-core (~> 0.5, >= 0.5)
       dry-inflector (~> 0.1, >= 0.1.2)
       dry-logic (~> 1.0, >= 1.0.2)
-    dry-validation (1.5.6)
+    dry-validation (1.6.0)
       concurrent-ruby (~> 1.0)
       dry-container (~> 0.7, >= 0.7.1)
       dry-core (~> 0.4)
@@ -56,81 +52,94 @@ GEM
       dry-initializer (~> 3.0)
       dry-schema (~> 1.5, >= 1.5.2)
     e2mmap (0.1.0)
-    ffi (1.13.1)
+    ffi (1.15.1)
     ffi-compiler (1.0.1)
       ffi (>= 1.0.0)
       rake
-    http (4.4.1)
+    http (5.0.0)
       addressable (~> 2.3)
       http-cookie (~> 1.0)
       http-form_data (~> 2.2)
-      http-parser (~> 1.2.0)
+      llhttp-ffi (~> 0.0.1)
     http-cookie (1.0.3)
       domain_name (~> 0.5)
     http-form_data (2.3.0)
-    http-parser (1.2.1)
-      ffi-compiler (>= 1.0, < 2.0)
     jaro_winkler (1.5.4)
-    maruku (0.7.3)
+    kramdown (2.3.1)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    llhttp-ffi (0.0.1)
+      ffi-compiler (~> 1.0)
+      rake (~> 13.0)
     method_source (1.0.0)
-    mini_portile2 (2.4.0)
-    nokogiri (1.10.10)
-      mini_portile2 (~> 2.4.0)
-    parallel (1.19.2)
-    parser (2.7.2.0)
+    mini_portile2 (2.5.3)
+    nokogiri (1.11.7)
+      mini_portile2 (~> 2.5.0)
+      racc (~> 1.4)
+    parallel (1.20.1)
+    parser (3.0.1.1)
       ast (~> 2.4.1)
-    pry (0.13.1)
+    pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
     public_suffix (4.0.6)
+    racc (1.5.2)
     rainbow (3.0.0)
-    rake (13.0.1)
+    rake (13.0.3)
+    regexp_parser (2.1.1)
     reverse_markdown (2.0.0)
       nokogiri
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.0)
-      rspec-support (~> 3.9.0)
-    rspec-expectations (3.9.0)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.0)
-    rubocop (0.75.1)
-      jaro_winkler (~> 1.5.1)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.16.0)
       parallel (~> 1.10)
-      parser (>= 2.6)
+      parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.7.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
-    rubocop-performance (1.5.1)
-      rubocop (>= 0.71.0)
-    ruby-progressbar (1.10.1)
-    solargraph (0.39.17)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.7.0)
+      parser (>= 3.0.1.1)
+    rubocop-performance (1.11.3)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.11.0)
+    solargraph (0.41.1)
       backport (~> 1.1)
       benchmark
       bundler (>= 1.17.2)
       e2mmap
       jaro_winkler (~> 1.5)
-      maruku (~> 0.7, >= 0.7.3)
-      nokogiri (~> 1.9, >= 1.9.1)
-      parser (~> 2.3)
+      kramdown (~> 2.3)
+      kramdown-parser-gfm (~> 1.1)
+      parser (~> 3.0)
       reverse_markdown (>= 1.0.5, < 3)
-      rubocop (~> 0.52)
+      rubocop (>= 0.52)
       thor (~> 1.0)
       tilt (~> 2.0)
       yard (~> 0.9, >= 0.9.24)
-    thor (1.0.1)
+    thor (1.1.0)
     tilt (2.0.10)
     unf (0.1.4)
       unf_ext
     unf_ext (0.0.7.7)
-    unicode-display_width (1.6.1)
-    yard (0.9.25)
+    unicode-display_width (2.0.0)
+    yard (0.9.26)
 
 PLATFORMS
   ruby
@@ -149,4 +158,4 @@ DEPENDENCIES
   yard
 
 BUNDLED WITH
-   2.1.4
+   2.2.11

data/README.md

@@ -1,10 +1,148 @@
 # attr-gather
 
-[![Actions Status](https://github.com/ianks/attr-gather/workflows/.github/workflows/ruby.yml/badge.svg)](https://github.com/ianks/attr-gather/actions)
+![Actions Status](https://github.com/ianks/attr-gather/workflows/Build%20+%20Test%20+%20Lint/badge.svg)
+[![Maintainability](https://api.codeclimate.com/v1/badges/b825a3bc37ad6a76e005/maintainability)](https://codeclimate.com/github/ianks/attr-gather/maintainability)
 
-A gem for creating simple workflows to enhance entities with extra attributes.
-At a high level, `attr-gather` provides a process to sync attributes from many
-sources (third party APIs, legacy databases, etc).
+A gem for creating workflows that "enhance" entities with extra attributes. At a high level, [attr-gather](https://github.com/ianks/attr-gather) provides a process to fetch information from many data sources (such as third party APIs, legacy databases, etc.) in a fully parallelized fashion.
+
+## Usage
+
+### Defining your workflow
+
+```ruby
+# define a workflow
+class EnhanceProfile
+  include Attr::Gather::Workflow
+
+  # contains all the task implementations
+  container TasksContainer
+
+  # filter out invalid data using a Dry::Validation::Contract
+  # anything that doesn't match this schema will be filtered out
+  filter_with_contract do
+    params do
+      required(:user_id).filled(:integer)
+
+      optional(:user).hash do
+        optional(:name).filled(:string)
+        optional(:email).filled(:string)
+        optional(:gravatar).filled(:string)
+        optional(:email_info).hash do
+          optional(:deliverable).filled(:bool?)
+          optional(:free).filled(:bool?)
+        end
+      end
+    end
+  end
+
+  # each task returns a hash of data that will be merged into the result
+  task :fetch_post do |t|
+    t.depends_on = []
+  end
+
+  # will run in parallel
+  task :fetch_user do |t|
+    t.depends_on = [:fetch_post]
+  end
+
+  # will run in parallel
+  task :fetch_email_info do |t|
+    t.depends_on = [:fetch_user]
+  end
+end
+```
+
+### Defining some tasks
+
+```ruby
+class PostFetcher
+  def call(attrs)
+    res = HTTP.get("https://jsonplaceholder.typicode.com/posts/#{attrs[:id]}")
+    post = JSON.parse(res.to_s, symbolize_names: true)
+
+    { title: post[:title], user_id: post[:userId], body: post[:body] }
+  end
+end
+```
+
+```ruby
+class UserFetcher
+  # will have access to the PostFetcher attributes here
+  def call(attrs)
+    res = HTTP.get("https://jsonplaceholder.typicode.com/users/#{attrs[:user_id]}")
+    user = JSON.parse(res.to_s, symbolize_names: true)
+
+    { user: { name: user[:name], email: user[:email] } }
+  end
+end
+```
+
+```ruby
+class EmailInfoFetcher
+  # will have access to the PostFetcher attributes here
+  def call(user:)
+    res = HTTP.timeout(3).get("https://api.trumail.io/v2/lookups/json?email=#{user[:email]}")
+    info = JSON.parse(res.to_s, symbolize_names: true)
+
+    # will deep merge with the final result
+    { user: { email_info: { deliverable: info[:deliverable], free: info[:free] } } }
+  end
+end
+```
+
+### Registering your tasks
+
+```ruby
+class MyContainer
+  extend Dry::Container::Mixin
+  
+  register :fetch_post, PostFetcher
+  register :fetch_user, UserFetcher
+  register :fetch_email_info, EmailInfoFetcher
+end
+```
+
+### Run it!
+
+```ruby
+enhancer = EnhanceUserProfile.new
+enhancer.call(id: 12).value!
+```
+
+And this is the result...
+
+```ruby
+{
+  :id => 12,
+  :user_id => 2,
+  :user => {
+    :email => "Shanna@melissa.tv",
+    :name => "Ervin Howell",
+    :email_info => { :deliverable => true, :free => true },
+    :gravatar => "https://www.gravatar.com/avatar/241af7d19a0a7438794aef21e4e19b79"
+  }
+}
+```
+
+You can even preview it as an SVG!
+
+```ruby
+enhancer.to_dot(preview: true) # requires graphviz (brew install graphviz)
+```
+
+## Features
+
+- Offers DSL for defining workflows and merging the results from each task
+- Execution engine optimally parallelizes the execution of the workflow dependency graph using [concurrent-ruby](https://github.com/ruby-concurrency/concurrent-ruby) Promises
+- Very easy to unit test
+- Ability to filter out bad/junky data using [dry-validation](https://dry-rb.org/gems/dry-validation) contracts
+
+## What are the main difference between this Ruby project and similar ones?
+
+- Operates on a single entity rather than a list, so easily adoptable in existing systems
+- Focuses on the "fetching" and filtering of data solely, and not transformation or storage
+- Focuses on having a clean PORO interface to make testing simple
+- Provides a declarative interface for merging results from many sources (APIs, legacy databases, etc.) which allows for prioritization
 
 ## Links
 

data/Rakefile

@@ -23,7 +23,7 @@ rescue LoadError
   warn 'Could not load yarddoc rake task'
 end
 
-task default: %i[spec lint]
+task default: %i[spec lint doc]
 
 namespace :examples do
   desc 'Run all examples'

data/attr-gather.gemspec

@@ -15,6 +15,8 @@ Gem::Specification.new do |spec|
   spec.homepage = 'https://github.com/ianks/attr-gather'
   spec.license = 'MIT'
 
+  spec.required_ruby_version = '>= 2.5'
+
   # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
 
   spec.metadata['homepage_uri'] = spec.homepage

data/examples/post_enhancer.rb

@@ -28,7 +28,7 @@ class MyContainer
   end
 
   register :email_info do |user:, **_attrs|
-    res = HTTP.timeout(3).get("https://api.trumail.io/v2/lookups/json?email=#{user[:email]}")
+    res = HTTP.get("https://api.trumail.io/v2/lookups/json?email=#{user[:email]}")
     info = JSON.parse(res.to_s, symbolize_names: true)
 
     { user: { email_info: { deliverable: info[:deliverable], free: info[:free] } } }

data/lib/attr/gather/aggregators.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'attr/gather/aggregators/base'
 require 'attr/gather/concerns/registrable'
 
 module Attr

data/lib/attr/gather/aggregators/base.rb

@@ -13,28 +13,26 @@ module Attr
       class Base
         attr_accessor :filter
 
-        NOOP_FILTER ||= Filters::Noop.new
+        NOOP_FILTER = Filters::Noop.new
 
         def initialize(**opts)
           @filter = opts.delete(:filter) || NOOP_FILTER
         end
 
+        def with(**opts)
+          self.class.new(filter: @filter, **opts)
+        end
+
         def call(_original_input, _results_array)
           raise NotImplementedError
         end
 
         private
 
-        def wrap_result(result)
-          Concurrent::Promise.fulfill(result)
-        end
-
         def unwrap_result(res)
-          unvalidated = res.result.value!
-
-          return unvalidated if filter.nil?
+          return res if filter.nil?
 
-          filter.call(unvalidated).value
+          filter.call(res).value
         end
       end
     end

data/lib/attr/gather/aggregators/deep_merge.rb

@@ -12,49 +12,64 @@ module Attr
         # Initialize a new DeepMerge aggregator
         #
         # @param reverse [Boolean] deep merge results in reverse order
-        # @param merge_input [Boolean] include input in aggregation result
+        # @param merge_input [Boolean] merge the result with the initial input
+        # @param array_strategy [Symbol] strategy for handling arrays, one of (:concat, :overwrite)
         #
         # @api private
-        def initialize(reverse: false, merge_input: true, **)
+        def initialize(reverse: false, merge_input: true, array_strategy: :concat, **)
+          unless ARRAY_STRATEGY.include?(array_strategy)
+            raise ArgumentError, 'array_strategy must be one of: :concat, :overwrite'
+          end
+
           @reverse = reverse
           @merge_input = merge_input
+          @array_strategy = array_strategy
+
           super
         end
 
         def call(input, execution_results)
           execution_results = execution_results.reverse_each if reverse?
-          initial = unwrap_initial_input(input)
 
-          result = execution_results.reduce(initial) do |memo, res|
+          execution_results.reduce(@merge_input ? input : EMPTY_HASH) do |memo, res|
             deep_merge(memo, unwrap_result(res))
           end
-
-          wrap_result(result)
         end
 
         private
 
-        def unwrap_initial_input(input)
-          merge_input? ? filter.call(input.dup).value : {}
-        end
-
-        def reverse?
-          @reverse
-        end
+        ARRAY_STRATEGY = %i[concat overwrite].freeze
 
-        def merge_input?
-          @merge_input
-        end
+        private_constant :ARRAY_STRATEGY
 
         def deep_merge(hash, other)
-          Hash[hash].merge(other) do |_, orig, new|
+          hash.to_h.merge(other) do |_, orig, new|
             if orig.respond_to?(:to_hash) && new.respond_to?(:to_hash)
-              deep_merge(Hash[orig], Hash[new])
+              deep_merge(orig.to_h, new.to_h)
+            elsif concattable?(orig, new)
+              orig + new
             else
               new
             end
           end
         end
+
+        def concattable?(orig, new)
+          return false unless @array_strategy == :concat
+
+          concattable_class?(orig) && concattable_class?(new)
+        end
+
+        def concattable_class?(obj)
+          return true if obj.is_a?(Array)
+          return true if obj.is_a?(Set)
+
+          false
+        end
+
+        def reverse?
+          @reverse
+        end
       end
     end
   end

data/lib/attr/gather/aggregators/shallow_merge.rb

@@ -12,7 +12,7 @@ module Attr
         # Initialize a new DeepMerge aggregator
         #
         # @param reverse [Boolean] merge results in reverse order
-        # @param merge_input [Boolean] include input in aggregation result
+        # @param merge_input [Boolean] merge the result with the initial input
         #
         # @api private
         def initialize(reverse: false, merge_input: true, **)
@@ -23,28 +23,17 @@ module Attr
 
         def call(input, execution_results)
           execution_results = execution_results.reverse_each if reverse?
-          initial = unwrap_initial_input(input)
 
-          result = execution_results.reduce(initial) do |memo, res|
+          execution_results.reduce(@merge_input ? input : EMPTY_HASH) do |memo, res|
             memo.merge(unwrap_result(res))
           end
-
-          wrap_result(result)
         end
 
         private
 
-        def unwrap_initial_input(input)
-          merge_input? ? filter.call(input.dup).value : {}
-        end
-
         def reverse?
           @reverse
         end
-
-        def merge_input?
-          @merge_input
-        end
       end
     end
   end

data/lib/attr/gather/filters/contract.rb

@@ -14,8 +14,8 @@ module Attr
         # @param dry_contract [Dry::Contract]
         def initialize(dry_contract)
           validate_dry_contract!(dry_contract)
-
           @dry_contract = dry_contract
+          super()
         end
 
         def call(input)

data/lib/attr/gather/filters/noop.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'attr/gather/filters/base'
+
 module Attr
   module Gather
     module Filters

data/lib/attr/gather/version.rb

@@ -2,6 +2,6 @@
 
 module Attr
   module Gather
-    VERSION = '1.1.3'
+    VERSION = '1.5.1'
   end
 end

data/lib/attr/gather/workflow/callable.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
-require 'attr/gather/workflow/task_executor'
-require 'attr/gather/workflow/async_task_executor'
+require 'concurrent/promise'
 
 module Attr
   module Gather
@@ -21,42 +20,39 @@ module Attr
         #
         # @param input [Hash]
         #
-        # @return [Concurrent::Promise]
+        # @return [Concurrent::Promise<Hash>]
         #
         # @note For more information, check out {https://dry-rb.org/gems/dry-monads/1.0/result}
         #
         # @api public
         def call(input)
-          final_results = []
+          task_promises = {}
 
-          each_task_batch.reduce(input.dup) do |aggregated_input, batch|
-            executor_results = execute_batch(aggregated_input, batch)
-            final_results << executor_results
-            aggregator.call(aggregated_input, executor_results).value!
+          final_results = self.class.tasks.to_a.map do |task|
+            task_promises[task] = execute_task(input, task, task_promises)
           end
 
-          aggregator.call(input.dup, final_results.flatten(1))
+          Concurrent::Promise.zip(*final_results).then do |results|
+            aggregator.call(input, results)
+          end
         end
 
         private
 
-        # Enumator for task batches
-        #
-        # @return [Enumerator]
-        #
-        # @api private
-        def each_task_batch
-          self.class.tasks.each_batch
-        end
-
         # Executes a batch of tasks
         #
         # @return [Array<TaskExecutionResult>]
         #
         # @api private
-        def execute_batch(aggregated_input, batch)
-          executor = AsyncTaskExecutor.new(batch, container: container)
-          executor.call(aggregated_input)
+        def execute_task(initial_input, task, task_promises)
+          task_proc = container.resolve(task.name)
+          dep_promises = task.depends_on.map { |t| task_promises[t] }
+          input_promise = Concurrent::Promise.zip(*dep_promises)
+
+          input_promise.then do |results|
+            dep_input = aggregator.call(initial_input, results)
+            task_proc.call(dep_input)
+          end
         end
 
         # @api private
@@ -69,7 +65,7 @@ module Attr
           return @aggregator if defined?(@aggregator) && !@aggregator.nil?
 
           @aggregator = self.class.aggregator
-          @aggregator.filter ||= filter
+          @aggregator.filter ||= filter if @aggregator.respond_to?(:filter=)
 
           @aggregator
         end

data/lib/attr/gather/workflow/dot_serializer.rb

@@ -33,8 +33,7 @@ module Attr
 
         def serialize_row(task)
           row = all_dependants_for_task(task).map { |dt| [task, dt] }
-          lines = row.map { |item| item.map(&:name).join(' -> ') + ';' }
-          lines
+          row.map { |item| "#{item.map(&:name).join(' -> ')};" }
         end
 
         def all_dependants_for_task(input_task)

data/lib/attr/gather/workflow/dsl.rb

@@ -16,7 +16,7 @@ module Attr
         #
         # @example
         #   class EnhanceUserProfile
-        #     extend Attr::Gather::Workflow
+        #     include Attr::Gather::Workflow
         #
         #     # ...
         #
@@ -36,12 +36,62 @@ module Attr
         #
         # @api public
         def task(task_name, opts = EMPTY_HASH)
-          task = Task.new(name: task_name, **opts)
-          yield task
-          tasks << task
+          conf = OpenStruct.new
+          yield conf
+          tasks << ({ name: task_name, **opts, **conf.to_h })
           self
         end
 
+        # Defines a task with name and options
+        #
+        # @param task_name [Symbol] the name of the task
+        #
+        # @example
+        #   class EnhanceUserProfile
+        #     include Attr::Gather::Workflow
+        #
+        #     # ...
+        #
+        #     fetch :user_info do |t|
+        #       t.depends_on = [:fetch_gravatar_info]
+        #     end
+        #   end
+        #
+        # Calling `fetch` will yield a task object which you can configure like
+        # a PORO. Tasks will be registered for execution in the workflow.
+        #
+        # @yield [Attr::Gather::Workflow::Task] A task to configure
+        #
+        # @api public
+        def fetch(task_name, opts = EMPTY_HASH)
+          task(task_name, opts)
+        end
+
+        # Defines a task with name and options
+        #
+        # @param task_name [Symbol] the name of the task
+        #
+        # @example
+        #   class EnhanceUserProfile
+        #     include Attr::Gather::Workflow
+        #
+        #     # ...
+        #
+        #     step :fetch_user_info do |t|
+        #       t.depends_on = [:email_info]
+        #     end
+        #   end
+        #
+        # Calling `step` will yield a task object which you can configure like
+        # a PORO. Tasks will be registered for execution in the workflow.
+        #
+        # @yield [Attr::Gather::Workflow::Task] A task to configure
+        #
+        # @api public
+        def step(task_name, opts = EMPTY_HASH)
+          task(task_name, opts)
+        end
+
         # Defines a container for task dependencies
         #
         # Using a container  makes it easy to re-use workflows with different
@@ -55,7 +105,7 @@ module Attr
         #   end
         #
         #   class EnhanceUserProfile
-        #     extend Attr::Gather::Workflow
+        #     include Attr::Gather::Workflow
         #
         #     container LegacySystem
         #   end
@@ -79,17 +129,26 @@ module Attr
         #
         # @example
         #   class EnhanceUserProfile
-        #     extend Attr::Gather::Workflow
+        #     include Attr::Gather::Workflow
         #
         #     aggregator :deep_merge
         #   end
         #
+        # @example
+        #   class EnhanceUserProfile
+        #     include Attr::Gather::Workflow
+        #
+        #     aggregator MyCustomAggregator
+        #   end
+        #
         # @param agg [#call] the aggregator to use
         #
         # @api public
         def aggregator(agg = nil, opts = EMPTY_HASH)
           @aggregator = if agg.nil? && !defined?(@aggregator)
                           Aggregators.default
+                        elsif agg.respond_to?(:new)
+                          agg.new(filter: filter, **opts)
                         elsif agg
                           Aggregators.resolve(agg, filter: filter, **opts)
                         else
@@ -119,7 +178,7 @@ module Attr
         #   end
         #
         #   class EnhanceUserProfile
-        #     extend Attr::Gather::Workflow
+        #     include Attr::Gather::Workflow
         #
         #     # Any of the key/value pairs that had validation errors will be
         #     # filtered from the output.
@@ -151,7 +210,7 @@ module Attr
         # @example
         #
         #   class EnhanceUserProfile
-        #     extend Attr::Gather::Workflow
+        #     include Attr::Gather::Workflow
         #
         #     # Any of the key/value pairs that had validation errors will be
         #     # filtered from the output.
@@ -172,7 +231,7 @@ module Attr
         #
         # @api public
         def filter_with_contract(arg = nil, &blk)
-          contract = block_given? ? build_inline_contract_filter(&blk) : arg
+          contract = blk ? build_inline_contract_filter(&blk) : arg
           filter(:contract, contract)
         end
 

data/lib/attr/gather/workflow/task.rb

@@ -1,19 +1,32 @@
 # frozen_string_literal: true
 
+require 'dry-equalizer'
+
 module Attr
   module Gather
     module Workflow
       # @api private
       class Task
-        attr_accessor :depends_on, :name
+        send :include, Dry::Equalizer(:name, :depends_on)
+
+        attr_accessor :name, :depends_on
 
+        # Initialize a new DeepMerge aggregator
+        #
+        # @param name [String] name of the task
+        # @param depends_on [Array<Task>] tasks needed before running this task
+        #
+        # @api private
         def initialize(name:, depends_on: [])
           @name = name
           @depends_on = depends_on
         end
 
+        # Check if this task depends on a given task
+        #
+        # @param other_task [Task] task to check
         def depends_on?(other_task)
-          depends_on.include?(other_task.name)
+          depends_on.include?(other_task)
         end
 
         def fullfilled_given_remaining_tasks?(task_list)

data/lib/attr/gather/workflow/task_graph.rb

@@ -9,6 +9,7 @@ module Attr
       # @api private
       class TaskGraph
         class UnfinishableError < StandardError; end
+
         class InvalidTaskDepedencyError < StandardError; end
 
         include TSort
@@ -20,7 +21,9 @@ module Attr
           tasks.each { |t| self << t }
         end
 
-        def <<(task)
+        def <<(hash)
+          name, depends_on = hash.values_at :name, :depends_on
+          task = build_task(name, depends_on)
           validate_for_insert!(task)
 
           registered_tasks.each do |t|
@@ -68,6 +71,16 @@ module Attr
 
         private
 
+        def build_task(name, depends_on)
+          deps = depends_on.map do |dep_name|
+            registered_tasks.find do |task|
+              task.name == dep_name
+            end
+          end
+
+          Task.new(name: name, depends_on: deps)
+        end
+
         def tsort_each_child(node, &blk)
           to_h[node].each(&blk)
         end
@@ -99,7 +112,7 @@ module Attr
         end
 
         def depended_on_tasks_exist?(task)
-          task.depends_on.all? { |t| registered_tasks.map(&:name).include?(t) }
+          task.depends_on.all? { |t| registered_tasks.include?(t) }
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: attr-gather
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.5.1
 platform: ruby
 authors:
 - Ian Ker-Seymer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-10-22 00:00:00.000000000 Z
+date: 2021-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -115,14 +115,11 @@ files:
 - lib/attr/gather/filters/result.rb
 - lib/attr/gather/version.rb
 - lib/attr/gather/workflow.rb
-- lib/attr/gather/workflow/async_task_executor.rb
 - lib/attr/gather/workflow/callable.rb
 - lib/attr/gather/workflow/dot_serializer.rb
 - lib/attr/gather/workflow/dsl.rb
 - lib/attr/gather/workflow/graphable.rb
 - lib/attr/gather/workflow/task.rb
-- lib/attr/gather/workflow/task_execution_result.rb
-- lib/attr/gather/workflow/task_executor.rb
 - lib/attr/gather/workflow/task_graph.rb
 homepage: https://github.com/ianks/attr-gather
 licenses:
@@ -138,7 +135,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/attr/gather/workflow/async_task_executor.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-require 'attr/gather/workflow/task_executor'
-
-module Attr
-  module Gather
-    module Workflow
-      # @api private
-      class AsyncTaskExecutor < TaskExecutor
-        def initialize(batch, container:)
-          super(batch, container: container)
-          @executor = :io
-        end
-      end
-    end
-  end
-end

data/lib/attr/gather/workflow/task_execution_result.rb

@@ -1,77 +0,0 @@
-# frozen_string_literal: true
-
-module Attr
-  module Gather
-    module Workflow
-      # A wrapper containing information and results of a task execution
-      #
-      # @!attribute [r] started_at
-      #   @return [Time] time which the execution occured
-      #
-      # @!attribute [r] task
-      #   @return [Attr::Gather::Workflow::Task] task that was run
-      #
-      # @!attribute [r] result
-      #   @return [Concurrent::Promise] the result promise of the the task
-      #
-      # @api public
-      class TaskExecutionResult
-        include Concerns::Identifiable
-
-        attr_reader :task, :result, :started_at, :uuid
-
-        def initialize(task, result, started_at: Time.now, uuid: SecureRandom.uuid) # rubocop:disable Metrics/LineLength
-          @task = task
-          @result = result
-          @started_at = started_at
-          @uuid = uuid
-        end
-
-        # @!attribute [r] state
-        #   @return [:unscheduled, :pending, :processing, :rejected, :fulfilled]
-        def state
-          result.state
-        end
-
-        # Extracts the result, this is an unsafe operation that blocks the
-        # operation, and returns either the value or an exception.
-        #
-        # @note For more information, check out {https://ruby-concurrency.github.io/concurrent-ruby/1.1.5/Concurrent/Concern/Obligation.html#value!-instance_method}
-        def value!
-          result.value!
-        end
-
-        # Chain a new block result to be executed after resolution
-        #
-        # @return [TaskExecutionResult] the new task execution result
-        # @yield The block operation to be performed asynchronously.
-        def then(*args, &block)
-          new_result = result.then(*args, &block)
-          self.class.new(task, new_result, started_at: @started_at, uuid: @uuid)
-        end
-
-        # Catch an async exception when a failure occurs
-        #
-        # @return [TaskExecutionResult] the new task execution result
-        # @yield The block operation to be performed asynchronously.
-        def catch(*args, &block)
-          new_result = result.catch(*args, &block)
-          self.class.new(task, new_result, started_at: @started_at, uuid: @uuid)
-        end
-
-        # Executes a block after the result is fulfilled
-        # Represents the TaskExecutionResult as a hash
-        #
-        # @return [Hash]
-        def as_json
-          value = result.value
-
-          { started_at: started_at,
-            task: task.as_json,
-            state: state,
-            value: value }
-        end
-      end
-    end
-  end
-end

data/lib/attr/gather/workflow/task_executor.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-require 'concurrent'
-require 'attr/gather/workflow/task_execution_result'
-
-module Attr
-  module Gather
-    module Workflow
-      # @api private
-      class TaskExecutor
-        attr_reader :batch, :container, :executor
-
-        def initialize(batch, container:)
-          @batch = batch
-          @container = container
-          @executor = :immediate
-        end
-
-        def call(input)
-          batch.map do |task|
-            task_proc = container.resolve(task.name)
-            result = Concurrent::Promise.execute(executor: executor) do
-              task_proc.call(input)
-            end
-            TaskExecutionResult.new(task, result)
-          end
-        end
-      end
-    end
-  end
-end