metaractor 0.5.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8bdc777077d09ca35ca998b494ce9b74e56883e3
-  data.tar.gz: 1d1645bd315927baf24ccbf66a7bc8ee18ff5aed
+SHA256:
+  metadata.gz: 61aa5597f77391b54b18d7a7d31e6b3cef5d00c844702fc3e1ef06c2dc8b0b1d
+  data.tar.gz: 5749efb4aa913aa4e4157e1213abedf689766add06df57544a41ac85aae47b0d
 SHA512:
-  metadata.gz: 0309b7ea31e0629a4f3c076ad489a74e3be15e5ff5252f48743371c0ff55f9de1bacff22bd96c8c9d954749000ebbc525077a518bb7e8b963ddfb9755fb9bf1d
-  data.tar.gz: 80c63031ecbc6553f5e121b7a6eddffbb5051d39b336661c0978a006e2cb628adee35b83324bb427dee68cd6d9a4698322a364682fa6236ff9859f71ebebf3a1
+  metadata.gz: 2c0d070919763827f78dee03c6667022faaf0b1882b65d527c1829f287b3ce7fa33efc91b8b55cb85e0edd1e808917b5d1b2e5d6833a151e33728b40f5df64d8
+  data.tar.gz: a5969b17f7cbe5c2f447e5b43dca00662e6bf8cdf23f96414fb0257d1b4aec4eaf1c02899dbf06947f582739995e015830d06b3857a65d36cfb8c5a260d259d4

data/Dockerfile

@@ -1,48 +1,27 @@
-FROM ruby:2.3.1-alpine
+FROM ruby:2.5.1-alpine
 MAINTAINER Ryan Schlesinger <ryan@outstand.com>
 
-RUN addgroup metaractor && \
-    adduser -S -G metaractor metaractor
+RUN addgroup -g 1000 -S metaractor && \
+    adduser -u 1000 -S -s /bin/ash -G metaractor metaractor && \
+    apk add --no-cache \
+      ca-certificates \
+      tini \
+      su-exec \
+      build-base \
+      git \
+      openssh
 
-ENV GOSU_VERSION 1.9
-ENV DUMB_INIT_VERSION 1.0.3
-
-RUN apk add --no-cache ca-certificates gnupg && \
-    mkdir -p /tmp/build && \
-    cd /tmp/build && \
-    gpg --keyserver pool.sks-keyservers.net --recv-keys B42F6819007F00F88E364FD4036A9C25BF357DD4 && \
-    curl -o gosu -SL "https://github.com/tianon/gosu/releases/download/${GOSU_VERSION}/gosu-amd64" && \
-    curl -o gosu.asc -SL "https://github.com/tianon/gosu/releases/download/${GOSU_VERSION}/gosu-amd64.asc" && \
-    gpg --verify gosu.asc && \
-    chmod +x gosu && \
-    cp gosu /bin/gosu && \
-    wget https://github.com/Yelp/dumb-init/releases/download/v${DUMB_INIT_VERSION}/dumb-init_${DUMB_INIT_VERSION}_amd64 && \
-    wget https://github.com/Yelp/dumb-init/releases/download/v${DUMB_INIT_VERSION}/sha256sums && \
-    grep dumb-init_${DUMB_INIT_VERSION}_amd64$ sha256sums | sha256sum -c && \
-    chmod +x dumb-init_${DUMB_INIT_VERSION}_amd64 && \
-    cp dumb-init_${DUMB_INIT_VERSION}_amd64 /bin/dumb-init && \
-    cd /tmp && \
-    rm -rf /tmp/build && \
-    apk del gnupg && \
-    rm -rf /root/.gnupg
-
-RUN apk add --no-cache \
-    build-base \
-    git \
-    openssh
-
-COPY Gemfile metaractor.gemspec /metaractor/
-COPY lib/metaractor/version.rb /metaractor/lib/metaractor/
-RUN cd /metaractor \
-    && bundle install \
-    && git config --global push.default simple
-COPY . /metaractor/
+WORKDIR /metaractor
 RUN chown -R metaractor:metaractor /metaractor
+USER metaractor
 
-WORKDIR /metaractor
+COPY --chown=metaractor:metaractor Gemfile metaractor.gemspec /metaractor/
+COPY --chown=metaractor:metaractor lib/metaractor/version.rb /metaractor/lib/metaractor/
+RUN git config --global push.default simple
+COPY --chown=metaractor:metaractor . /metaractor/
 
+USER root
 COPY docker-entrypoint.sh /docker-entrypoint.sh
 
-ENV DUMB_INIT_SETSID 0
-ENTRYPOINT ["/docker-entrypoint.sh"]
+ENTRYPOINT ["/sbin/tini", "-g", "--", "/docker-entrypoint.sh"]
 CMD ["rspec", "spec"]

data/README.md

@@ -38,10 +38,67 @@ class HighFiveUser
   # private
   # delegate :user, to: context
 end
+
+result = HighFiveUser.call # not passing user or user_id
+result.failure?
+# => true
+result.valid?
+# => false
+result.errors
+# => ["Required parameters: (user_id or user)"]
 ```
 
 See Interactor's [README](https://github.com/collectiveidea/interactor/blob/master/README.md) for more information.
 
+### Configuration
+Metaractor is meant to be extensible (hence the 'meta').  You can add additional modules in the following way:
+
+```ruby
+# This is an example from Outstand's production app to add some sidekiq magic.
+# Feel free to place this in start up code or a Rails initializer.
+Metaractor.configure do |config|
+  config.prepend_module Metaractor::SidekiqCallbacks
+  config.include_module Metaractor::SidekiqBatch
+end
+```
+
+### Required Parameters
+Metaractor supports complex required parameter statements and you can chain these together in any manner using `and`, `or`, and `xor`.
+```ruby
+required and: [:token, or: [:recipient_id, :recipient] ]
+```
+
+### Optional Parameters
+As optional parameters have no enforcement, they are merely advisory.
+```ruby
+optional :enable_logging
+```
+
+### Custom Validation
+Metaractor supports doing custom validation before any user supplied before_hooks run.
+```ruby
+validate_parameters do
+  if context.foo == :bar
+    require_parameter :bar, message: 'optional missing parameter message'
+  end
+
+  unless context.user.admin?
+    add_parameter_error param: :user, message: 'User must be an admin'
+  end
+end
+```
+
+If you need to require a parameter from a `before_hook` for any reason, use the bang version of the method:
+```ruby
+before do
+  # Be careful with this approach as some user code may run before the parameter validation
+  require_parameter! :awesome if context.mode == :awesome
+end
+```
+
+### Further Reading
+For more examples of all of the above approaches, please see the specs.
+
 ## Development
 
 - `docker build -t outstand/metaractor .`
@@ -50,7 +107,7 @@ See Interactor's [README](https://github.com/collectiveidea/interactor/blob/mast
 To release a new version:
 - Update the version number in `version.rb` and commit the result.
 - `docker build -t outstand/metaractor .`
-- `docker run -it --rm -v ~/.gitconfig:/root/.gitconfig -v ~/.gitconfig.user:/root/.gitconfig.user -v ~/.ssh/id_rsa:/root/.ssh/id_rsa -v ~/.gem:/root/.gem outstand/metaractor rake release`
+- `docker run -it --rm -v ~/.gitconfig:/home/metaractor/.gitconfig -v ~/.gitconfig.user:/home/metaractor/.gitconfig.user -v ~/.ssh/id_rsa:/home/metaractor/.ssh/id_rsa -v ~/.gem:/home/metaractor/.gem outstand/metaractor rake release`
 
 ## Contributing
 

data/docker-compose.yml

@@ -0,0 +1,24 @@
+version: '3.6'
+services:
+  metaractor:
+    build: .
+    image: outstand/metaractor:dev
+    stdin_open: true
+    tty: true
+    volumes:
+      - bundler-data:/usr/local/bundle
+      - .:/metaractor
+  release:
+    image: outstand/metaractor:dev
+    stdin_open: true
+    tty: true
+    command: rake release
+    volumes:
+      - bundler-data:/usr/local/bundle
+      - ~/.gitconfig:/home/metaractor/.gitconfig
+      - ~/.gitconfig.user:/home/metaractor/.gitconfig.user
+      - ~/.ssh/id_rsa:/home/metaractor/.ssh/id_rsa
+      - ~/.gem:/home/metaractor/.gem
+
+volumes:
+  bundler-data:

data/docker-entrypoint.sh

@@ -1,12 +1,20 @@
-#!/bin/dumb-init /bin/sh
+#!/bin/sh
 set -e
 
-if [ "$1" = 'rspec' ] || [ "$1" = 'rake' ]; then
-  set -- bundle exec "$@"
+if [ "$(which "$1")" = '' ]; then
+  if [ "$(ls -A /usr/local/bundle/bin)" = '' ]; then
+    echo 'command not in path and bundler not initialized'
+    echo 'running bundle install'
+    su-exec metaractor bundle install
+  fi
 fi
 
 if [ "$1" = 'bundle' ]; then
-  set -- gosu metaractor "$@"
+  set -- su-exec metaractor "$@"
+elif ls /usr/local/bundle/bin | grep -q "\b$1\b"; then
+  set -- su-exec metaractor bundle exec "$@"
+
+  su-exec metaractor ash -c 'bundle check || bundle install'
 fi
 
 exec "$@"

data/lib/metaractor/chain_failures.rb

@@ -0,0 +1,16 @@
+module Metaractor
+  module ChainFailures
+    def self.included(base)
+      base.class_eval do
+        around :chain_nested_failures
+      end
+    end
+
+    def chain_nested_failures(interactor)
+      interactor.call
+    rescue Interactor::Failure => e
+      context.fail_from_context(context: e.context)
+      raise
+    end
+  end
+end

data/lib/metaractor/context_errors.rb

@@ -0,0 +1,35 @@
+module Metaractor
+  module ContextErrors
+    def errors
+      if super.nil?
+        self.errors = []
+      end
+
+      super
+    end
+
+    def fail_with_error!(message:)
+      add_error(message: message)
+      fail!
+    end
+
+    def fail_with_errors!(messages:)
+      add_errors(messages: messages)
+      fail!
+    end
+
+    def add_error(message:)
+      add_errors(messages: Array(message))
+    end
+
+    def add_errors(messages:)
+      self.errors += messages
+    end
+
+    def error_messages
+      errors.join("\n")
+    end
+  end
+end
+
+Interactor::Context.send(:include, Metaractor::ContextErrors)

data/lib/metaractor/errors.rb

@@ -1,39 +1,28 @@
+require 'forwardable'
+
 module Metaractor
   class Error < StandardError; end
   class InvalidError < Error; end
 
   module Errors
-    def self.included(base)
-      base.class_eval do
-        before :initialize_errors_array
-      end
-    end
-
-    def initialize_errors_array
-      context.errors ||= []
-    end
-
-    def fail_with_error!(message:)
-      add_error(message: message)
-      context.fail!
+    def fail_with_error!(*args)
+      context.fail_with_error!(*args)
     end
 
-    def fail_with_errors!(messages:)
-      add_errors(messages: messages)
-      context.fail!
+    def fail_with_errors!(*args)
+      context.fail_with_errors!(*args)
     end
 
-    def add_error(message:)
-      add_errors(messages: Array(message))
+    def add_error(*args)
+      context.add_error(*args)
     end
 
-    def add_errors(messages:)
-      context.errors ||= []
-      context.errors += messages
+    def add_errors(*args)
+      context.add_errors(*args)
     end
 
     def error_messages
-      context.errors.join("\n")
+      context.error_messages
     end
   end
 end

data/lib/metaractor/fail_from_context.rb

@@ -0,0 +1,13 @@
+module Metaractor
+  module FailFromContext
+    def fail_from_context(context:)
+      return if context.equal?(self)
+
+      invalidate! if context.invalid?
+      add_errors(messages: context.errors)
+      @failure = true
+    end
+  end
+end
+
+Interactor::Context.send(:include, Metaractor::FailFromContext)

data/lib/metaractor/parameters.rb

@@ -99,8 +99,6 @@ module Metaractor
 
         case operator
         when :or
-          # We can't test for #one? here as that breaks interactors with the same setup sharing a context.
-          # This happens in almost all of our organizers.
           return valids.any?, "(#{messages.join(' or ')})"
         when :xor
           return valids.one?, "(#{messages.join(' xor ')})"

data/lib/metaractor/version.rb

@@ -1,3 +1,3 @@
 module Metaractor
-  VERSION = "0.5.0"
+  VERSION = "1.1.0"
 end

data/lib/metaractor.rb

@@ -1,9 +1,12 @@
 require 'metaractor/version'
 require 'interactor'
 require 'metaractor/errors'
+require 'metaractor/context_errors'
 require 'metaractor/parameters'
 require 'metaractor/run_with_context'
 require 'metaractor/context_validity'
+require 'metaractor/chain_failures'
+require 'metaractor/fail_from_context'
 
 module Metaractor
   def self.included(base)
@@ -36,7 +39,8 @@ module Metaractor
     [
       { module: Metaractor::Errors, method: :include },
       { module: Metaractor::Parameters, method: :include },
-      { module: Metaractor::RunWithContext, method: :include }
+      { module: Metaractor::RunWithContext, method: :include },
+      { module: Metaractor::ChainFailures, method: :include }
     ]
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metaractor
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Ryan Schlesinger
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-06-04 00:00:00.000000000 Z
+date: 2018-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: interactor
@@ -80,10 +80,14 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- docker-compose.yml
 - docker-entrypoint.sh
 - lib/metaractor.rb
+- lib/metaractor/chain_failures.rb
+- lib/metaractor/context_errors.rb
 - lib/metaractor/context_validity.rb
 - lib/metaractor/errors.rb
+- lib/metaractor/fail_from_context.rb
 - lib/metaractor/parameters.rb
 - lib/metaractor/run_with_context.rb
 - lib/metaractor/version.rb
@@ -108,7 +112,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.4
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Adds parameter validation and error control to interactor