metaractor 3.0.1 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8b28e07d981c3224d3e209a34961e685de8859e7bec198c8f64ac08456219e7
-  data.tar.gz: d2ea3446b24661a347bb38087df37b6208ce62a742f7a7edfd2332a7137e1acd
+  metadata.gz: 3a84ca8402879e172bd7dfb5cd494b41de2639e85080b3052c503a68d4406234
+  data.tar.gz: 6db8d581e34cb71fcbf27bcb590978d31301b7ad232fc478e31d7d9fae213eff
 SHA512:
-  metadata.gz: 61e4852078088812a0a53b33601d555aa8a2bdd3b5d50f56bd96c8c50729f45aa7a788eb305f82bb747f973bfde421c2904385c35a4428687bd7f9621ab382e3
-  data.tar.gz: 2cd047d8213c8c4197395545ab4f1b448aea33c6985f0ec0dc6901a66d923195be2ac510e0a73ee414643200d22b5d5b8c88da90ce53cb22d7cb9f35b825beaa
+  metadata.gz: 364eb4ae9ddcf5a836ea876ecece48013c16b20b4a82a354c4e277d954df3cb828ba8252d48b3302dbd597f908f6c52a73909124cb3101a2e6a6b69e2f97afc6
+  data.tar.gz: dd45bf611c8edfafadc6fce753f682f429803082157a66f5c9c92e3a2daa7981d98483a65fd88bd73a5bf55c8cfd83edc92692e48e58186631fdf2a38397bf67

data/.buildkite/pipeline.yml

@@ -0,0 +1,93 @@
+env:
+  BUILDKITE_PLUGIN_DOCKER_CACHE_S3_BUCKET: "outstand-buildkite-cache"
+  # BUILDKITE_PLUGIN_DOCKER_CACHE_VOLUME_DEBUG: "true"
+  BUILDKITE_PLUGIN_DOCKER_COMPOSE_SHELL: "false"
+  # BUILDKITE_PLUGIN_DOCKER_COMPOSE_UPLOAD_CONTAINER_LOGS: "always"
+  BUILDKITE_PLUGIN_DOCKER_COMPOSE_PULL_RETRIES: 5
+  BUILDKITE_PLUGIN_DOCKER_COMPOSE_PUSH_RETRIES: 5
+  PLUGIN_DOCKER_COMPOSE_VERSION: "03d746fbf5171b217b732ff7d8a3e417d664df1c"
+  PLUGIN_DOCKER_CACHE_VERSION: "50ecc80f736a4a3a0ab1f5990e58ae8e536c85e1"
+  WORKSPACE_DIR: "${BUILDKITE_BUILD_CHECKOUT_PATH}"
+
+steps:
+  - label: ":docker: Build"
+    key: build
+    plugins:
+      - seek-oss/aws-sm#v2.3.1:
+          env:
+            DOCKER_LOGIN_PASSWORD: "/buildkite/docker_password"
+
+      - docker-login#v2.1.0:
+          username: outstandci
+          retries: 2
+
+      - ecr#v2.5.0:
+          login: true
+          region: "us-east-1"
+
+      - https://github.com/outstand/docker-compose-buildkite-plugin.git#${PLUGIN_DOCKER_COMPOSE_VERSION}:
+          build: metaractor
+          image-repository: 786715713882.dkr.ecr.us-east-1.amazonaws.com/ci-images
+          config:
+            - compose.yml
+
+  - label: ":bundler: :rubygems:"
+    key: bundle_install
+    command: bundle install
+    depends_on: build
+    plugins:
+      - seek-oss/aws-sm#v2.3.1:
+          env:
+            DOCKER_LOGIN_PASSWORD: "/buildkite/docker_password"
+
+      - docker-login#v2.1.0:
+          username: outstandci
+          retries: 2
+
+      - ecr#v2.5.0:
+          login: true
+          region: "us-east-1"
+
+      - https://github.com/outstand/docker-compose-buildkite-plugin.git#${PLUGIN_DOCKER_COMPOSE_VERSION}:
+          run: metaractor
+          dependencies: false
+          config:
+            - compose.yml
+
+      - https://github.com/outstand/docker-cache-buildkite-plugin.git#${PLUGIN_DOCKER_CACHE_VERSION}:
+          name: bundler-cache
+          keys:
+            - v1-bundler-cache-{{ arch }}-{{ checksum "metaractor.gemspec" }}-{{ checksum "Gemfile" }}
+            - v1-bundler-cache-{{ arch }}-
+          save: true
+          volumes:
+            - bundler-data
+
+  - label: ":ruby: Specs"
+    command: rspec spec
+    depends_on: bundle_install
+    plugins:
+      - seek-oss/aws-sm#v2.3.1:
+          env:
+            DOCKER_LOGIN_PASSWORD: "/buildkite/docker_password"
+
+      - docker-login#v2.1.0:
+          username: outstandci
+          retries: 2
+
+      - ecr#v2.5.0:
+          login: true
+          region: "us-east-1"
+
+      - https://github.com/outstand/docker-compose-buildkite-plugin.git#${PLUGIN_DOCKER_COMPOSE_VERSION}:
+          run: metaractor
+          config:
+            - compose.yml
+
+      - https://github.com/outstand/docker-cache-buildkite-plugin.git#${PLUGIN_DOCKER_CACHE_VERSION}:
+          name: bundler-cache
+          keys:
+            - v1-bundler-cache-{{ arch }}-{{ checksum "metaractor.gemspec" }}-{{ checksum "Gemfile" }}
+            - v1-bundler-cache-{{ arch }}-
+          volumes:
+            - bundler-data

data/.rspec

@@ -1,2 +1,4 @@
 --color
 --require spec_helper
+--format progress
+--format RSpec::Buildkite::AnnotationFormatter

data/Deskfile

@@ -0,0 +1,3 @@
+rspec() {
+  docker compose run --rm metaractor rspec "$@"
+}

data/Dockerfile

@@ -1,30 +1,78 @@
-FROM ruby:2.6.5-alpine
+FROM outstand/su-exec:latest as su-exec
+FROM outstand/fixuid as fixuid
+
+FROM ruby:2.7.6-bullseye
 LABEL maintainer="Ryan Schlesinger <ryan@outstand.com>"
 
-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
+SHELL ["/bin/bash", "-o", "pipefail", "-c"]
+ENV DEBIAN_FRONTEND=noninteractive
+
+RUN set -eux; \
+      \
+      groupadd -g 1000 metaractor && \
+      useradd -u 1000 -g metaractor -ms /bin/bash metaractor && \
+      \
+      apt-get update -y; \
+      apt-get install -y \
+        ca-certificates \
+        curl \
+        git \
+        build-essential \
+        tini \
+      ; \
+      apt-get clean; \
+      rm -f /var/lib/apt/lists/*_*
+
+# install su-exec
+COPY --from=su-exec /sbin/su-exec /sbin/su-exec
 
-ENV BUNDLER_VERSION 2.1.4
-RUN gem install bundler -v ${BUNDLER_VERSION} -i /usr/local/lib/ruby/gems/$(ls /usr/local/lib/ruby/gems) --force
+# install fixuid
+COPY --from=fixuid /usr/local/bin/fixuid /usr/local/bin/fixuid
+RUN set -eux; \
+      \
+      chmod 4755 /usr/local/bin/fixuid; \
+      USER=metaractor; \
+      GROUP=metaractor; \
+      mkdir -p /etc/fixuid; \
+      printf "user: $USER\ngroup: $GROUP\n" > /etc/fixuid/config.yml
+
+ENV BUNDLER_VERSION 2.3.20
+ENV GITHUB_CLI_VERSION 2.14.4
+ENV GITHUB_CLI_CHECKSUM b0073fdcc07d1de5a19a1a782c7ad9f593f991da06a809ea39f0b6148869aa96
+RUN set -eux; \
+      \
+      mkdir -p /tmp/build; \
+      cd /tmp/build; \
+      \
+      gem install bundler -v ${BUNDLER_VERSION} -i /usr/local/lib/ruby/gems/$(ls /usr/local/lib/ruby/gems) --force; \
+      curl -fsSL https://github.com/cli/cli/releases/download/v${GITHUB_CLI_VERSION}/gh_${GITHUB_CLI_VERSION}_linux_amd64.deb -o gh_${GITHUB_CLI_VERSION}_linux_amd64.deb; \
+      echo "${GITHUB_CLI_CHECKSUM}  gh_${GITHUB_CLI_VERSION}_linux_amd64.deb" | sha256sum --check; \
+      apt-get update -y; \
+      apt-get install -y --no-install-recommends \
+        ./gh_${GITHUB_CLI_VERSION}_linux_amd64.deb \
+      ; \
+      apt-get clean; \
+      rm -f /var/lib/apt/lists/*_*; \
+      rm -rf /tmp/build
+
+COPY brew-shim /usr/bin/brew
 
 WORKDIR /metaractor
-RUN chown -R metaractor:metaractor /metaractor
+RUN set -eux; \
+      \
+      chown -R metaractor:metaractor /metaractor
+
 USER 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
+RUN set -eux; \
+      \
+      git config --global push.default simple
 COPY --chown=metaractor:metaractor . /metaractor/
 
 USER root
 COPY docker-entrypoint.sh /docker-entrypoint.sh
 
-ENTRYPOINT ["/sbin/tini", "-g", "--", "/docker-entrypoint.sh"]
+ENTRYPOINT ["/usr/bin/tini", "-g", "--", "/docker-entrypoint.sh"]
 CMD ["rspec", "spec"]

data/Gemfile

@@ -1,5 +1,4 @@
 source 'https://rubygems.org'
 
 gemspec
-gem 'pry-byebug'
-gem 'awesome_print'
+gem 'rspec-buildkite', github: 'outstand/rspec-buildkite', branch: 'error-output'

data/README.md

@@ -1,4 +1,4 @@
-# Metaractor
+# Metaractor [![Build status](https://badge.buildkite.com/70063a5154eb7366b8b7fd65a875c5f64301bc60f6d29a2ad7.svg)](https://buildkite.com/outstand/metaractor)
 Adds parameter validation and error control to [interactor](https://github.com/collectiveidea/interactor).
 
 ## Installation
@@ -103,6 +103,24 @@ This works with `allow_blank` and can also be anything that responds to `#call`.
 parameter :role, allow_blank: true, default: -> { context.default_role }
 ```
 
+#### Typecasting/Coersion
+You can supply Metaractor with a callable that will typecast incoming parameters:
+```ruby
+optional :needs_to_be_a_string, type: ->(value) { value.to_s }
+```
+
+You can also configure Metaractor with named types and use them:
+```ruby
+Metaractor.configure do |config|
+  config.register_type(:boolean, ->(value) { ActiveModel::Type::Boolean.new.cast(value) })
+end
+```
+```ruby
+required :is_awesome, type: :boolean
+```
+
+**Note**: Typecasters will _not_ be called on `nil` values.
+
 ### Custom Validation
 Metaractor supports doing custom validation before any user supplied before_hooks run.
 ```ruby

data/brew-shim

@@ -0,0 +1,10 @@
+#!/bin/bash
+
+set -euo pipefail
+
+# Docker host has the following git config:
+# helper = !$(brew --prefix)/bin/gh auth git-credential
+#
+# We're going to lie inside the container so we can find the local gh
+
+echo "/usr"

data/{docker-compose.yml → compose.yml}

@@ -1,24 +1,35 @@
-version: '3.6'
 services:
   metaractor:
     build: .
     image: outstand/metaractor:dev
     stdin_open: true
     tty: true
+    environment:
+      FIXUID:
+      FIXGID:
+      BUILDKITE:
+      BUILDKITE_BUILD_URL:
+      BUILDKITE_JOB_ID:
+      BUILDKITE_AGENT_ACCESS_TOKEN:
     volumes:
       - bundler-data:/usr/local/bundle
       - .:/metaractor
+
   release:
     image: outstand/metaractor:dev
     stdin_open: true
     tty: true
     command: rake release
+    environment:
+      FIXUID:
+      FIXGID:
     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
+      - ~/.config/gh/hosts.yml:/home/metaractor/.config/gh/hosts.yml
+      - ~/.local/share/gem/credentials:/home/metaractor/.local/share/gem/credentials
+      - ~/.local/share/gem/credentials:/home/metaractor/.gem/credentials
 
 volumes:
   bundler-data:

data/docker-entrypoint.sh

@@ -1,5 +1,20 @@
-#!/bin/sh
-set -e
+#!/bin/bash
+
+set -euo pipefail
+
+su-exec ${FIXUID:?Missing FIXUID var}:${FIXGID:?Missing FIXGID var} fixuid
+
+chown_dir() {
+  dir=$1
+  if [[ -d ${dir} ]] && [[ "$(stat -c %u:%g ${dir})" != "${FIXUID}:${FIXGID}" ]]; then
+    echo chown $dir
+    chown metaractor:metaractor $dir
+  fi
+}
+
+chown_dir /usr/local/bundle
+chown_dir /home/metaractor/.local/share/gem
+chown_dir /home/metaractor/.gem
 
 if [ "$(which "$1")" = '' ]; then
   if [ "$(ls -A /usr/local/bundle/bin)" = '' ]; then
@@ -14,7 +29,7 @@ if [ "$1" = 'bundle' ]; then
 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'
+  su-exec metaractor bash -c 'bundle check || bundle install'
 fi
 
 exec "$@"

data/lib/metaractor/errors.rb

@@ -71,18 +71,19 @@ module Metaractor
 
     def add(error: {}, errors: {}, object: nil)
       trees = []
-      [error, errors].each do |h| 
+      [error, errors].each do |h|
         tree = nil
         if h.is_a? Metaractor::Errors
           tree = Sycamore::Tree.from(h.instance_variable_get(:@tree))
         else
-          tree = Sycamore::Tree.from(h)
+          tree = Sycamore::Tree.from(normalize_error_hash(h))
         end
 
         unless tree.empty?
-          if tree.nodes.any? {|node| tree.strict_leaf?(node) }
+          if tree.nodes.any? { |node| tree.strict_leaf?(node) }
             raise ArgumentError, "Invalid hash!"
           end
+
           trees << tree
         end
       end
@@ -220,5 +221,34 @@ module Metaractor
       end
     end
 
+    def normalize_error_hash(hash)
+      deep_transform_values_in_object(hash, &method(:transform_delegator))
+    end
+
+    def transform_delegator(value)
+      if value.is_a?(Delegator)
+        if value.respond_to?(:to_hash)
+          deep_transform_values_in_object(value.to_hash, &method(:transform_delegator))
+        elsif value.respond_to?(:to_a)
+          deep_transform_values_in_object(value.to_a, &method(:transform_delegator))
+        else
+          value
+        end
+      else
+        value
+      end
+    end
+
+    # Lifted from Rails
+    def deep_transform_values_in_object(object, &block)
+      case object
+      when Hash
+        object.transform_values { |value| deep_transform_values_in_object(value, &block) }
+      when Array
+        object.map { |e| deep_transform_values_in_object(e, &block) }
+      else
+        yield(object)
+      end
+    end
   end
 end

data/lib/metaractor/parameters.rb

@@ -14,6 +14,7 @@ module Metaractor
         before :remove_blank_values
         before :apply_defaults
         before :validate_required_parameters
+        before :apply_types
       end
     end
 
@@ -37,6 +38,10 @@ module Metaractor
         @options[key]
       end
 
+      def has_key?(key)
+        @options.has_key?(key)
+      end
+
       def dig(name, *names)
         @options.dig(name, *names)
       end
@@ -142,7 +147,7 @@ module Metaractor
 
     def apply_defaults
       parameters.each do |name, parameter|
-        next unless parameter[:default]
+        next unless parameter.has_key?(:default)
 
         unless context.has_key?(name)
           context[name] = _parameter_default(name)
@@ -160,6 +165,23 @@ module Metaractor
       end
     end
 
+    def apply_types
+      parameters.each do |name, parameter|
+        next unless parameter[:type]
+
+        if context.has_key?(name) && context[name] != nil
+          callable = parameter[:type]
+
+          if callable.is_a?(Symbol)
+            callable = Metaractor.types[callable]
+            raise ArgumentError, "No such type: #{parameter[:type]}" if callable.nil?
+          end
+
+          context[name] = callable.call(context[name])
+        end
+      end
+    end
+
     def validate_required_parameters
       context.errors ||= []
 

data/lib/metaractor/version.rb

@@ -1,3 +1,3 @@
 module Metaractor
-  VERSION = "3.0.1"
+  VERSION = "3.2.0"
 end

data/lib/metaractor.rb

@@ -77,4 +77,16 @@ module Metaractor
   def self.hash_formatter=(callable)
     @hash_formatter = callable
   end
+
+  def self.types
+    @types ||= {}
+  end
+
+  def self.register_type(type, callable)
+    types[type] = callable
+  end
+
+  def self.clear_types!
+    @types = {}
+  end
 end

data/metaractor.gemspec

@@ -11,7 +11,10 @@ Gem::Specification.new do |spec|
   spec.email         = ['ryan@outstand.com']
 
   spec.summary       = %q{Adds parameter validation and error control to interactor}
-  spec.homepage      = 'https://github.com/outstand/metaractor'
+  spec.metadata      = {
+    "homepage_uri" => "https://github.com/outstand/metaractor",
+    "source_code_uri" => "https://github.com/outstand/metaractor"
+  }
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.bindir        = 'exe'
@@ -27,4 +30,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec', '~> 3.9'
   spec.add_development_dependency 'awesome_print', '~> 1.8'
   spec.add_development_dependency 'pry-byebug', '~> 3.9'
+  spec.add_development_dependency 'activemodel', '~> 6.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metaractor
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.2.0
 platform: ruby
 authors:
 - Ryan Schlesinger
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-21 00:00:00.000000000 Z
+date: 2022-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: interactor
@@ -122,6 +122,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
 description: 
 email:
 - ryan@outstand.com
@@ -129,14 +143,17 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".buildkite/pipeline.yml"
 - ".gitignore"
 - ".rspec"
+- Deskfile
 - Dockerfile
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
-- docker-compose.yml
+- brew-shim
+- compose.yml
 - docker-entrypoint.sh
 - lib/metaractor.rb
 - lib/metaractor/chain_failures.rb
@@ -153,10 +170,12 @@ files:
 - lib/metaractor/spec.rb
 - lib/metaractor/version.rb
 - metaractor.gemspec
-homepage: https://github.com/outstand/metaractor
+homepage: 
 licenses:
 - Apache-2.0
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/outstand/metaractor
+  source_code_uri: https://github.com/outstand/metaractor
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -172,7 +191,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Adds parameter validation and error control to interactor