atacama 0.1.11 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 23e77b61623e59ca62d315b9e14ea61827d1abf1
-  data.tar.gz: 251c83f5c96b2cb842ac255a2f255713bca31aa2
+SHA256:
+  metadata.gz: 4276fcd0b870a97b83a3be44fb100758f5211c60d6a2457e2b874e7493fe599b
+  data.tar.gz: fd54fc14b128af9b090e73b986082588e6cf671fcc0cf99b8f5c0cb1c4518d36
 SHA512:
-  metadata.gz: 051fec105bb6ab9d8cd3bc448532578dd57229bc9ef3ffede667ab94c72ecc8f7ebe56dcbbacb8e1fee85cd692d37350dfbda4dc26c56c0300e750829b7e64bc
-  data.tar.gz: 5fab8599b156fe206a28a1fa357e4f9886a4aa29c14cc33682818b34e3a0e407afb814e88a8e527fa33bff335bb7f2194f42773ae18fba2291c100f98e48dd24
+  metadata.gz: aa1f42aa04e922b35aeee8fa3fbe471ad16f0533756ae039127809775932dcfb992fcc33f469c6bdf114a6922ee6d8e9fe2d3db27fec328a276cc90f84384ae1
+  data.tar.gz: 338d66d627f30c353f1310ab4232df3cfa74cbefc128c6e1d7dd72030c0069441120b1cf6075ca71103cf702ab0b5912772ac69d85b9fd1c142e96d0980850d8

data/Gemfile.lock

@@ -1,34 +1,36 @@
 PATH
   remote: .
   specs:
-    atacama (0.1.11)
-      dry-types (~> 0.13.2)
+    atacama (0.2.0)
+      dry-types
 
 GEM
   remote: https://rubygems.org/
   specs:
     coderay (1.1.2)
-    concurrent-ruby (1.0.5)
-    dry-configurable (0.7.0)
+    concurrent-ruby (1.1.6)
+    dry-configurable (0.11.3)
       concurrent-ruby (~> 1.0)
-    dry-container (0.6.0)
+      dry-core (~> 0.4, >= 0.4.7)
+      dry-equalizer (~> 0.2)
+    dry-container (0.7.2)
       concurrent-ruby (~> 1.0)
       dry-configurable (~> 0.1, >= 0.1.3)
-    dry-core (0.4.7)
+    dry-core (0.4.9)
+      concurrent-ruby (~> 1.0)
+    dry-equalizer (0.3.0)
+    dry-inflector (0.2.0)
+    dry-logic (1.0.6)
       concurrent-ruby (~> 1.0)
-    dry-equalizer (0.2.1)
-    dry-inflector (0.1.2)
-    dry-logic (0.4.2)
-      dry-container (~> 0.2, >= 0.2.6)
       dry-core (~> 0.2)
       dry-equalizer (~> 0.2)
-    dry-types (0.13.2)
+    dry-types (1.3.1)
       concurrent-ruby (~> 1.0)
       dry-container (~> 0.3)
       dry-core (~> 0.4, >= 0.4.4)
-      dry-equalizer (~> 0.2)
+      dry-equalizer (~> 0.3)
       dry-inflector (~> 0.1, >= 0.1.2)
-      dry-logic (~> 0.4, >= 0.4.2)
+      dry-logic (~> 1.0, >= 1.0.2)
     method_source (0.9.2)
     minitest (5.11.3)
     pry (0.12.2)
@@ -41,10 +43,10 @@ PLATFORMS
 
 DEPENDENCIES
   atacama!
-  bundler (~> 1.16)
-  minitest (~> 5.0)
+  bundler
+  minitest
   pry
-  rake (~> 10.0)
+  rake
 
 BUNDLED WITH
-   1.16.3
+   1.17.2

data/README.md

@@ -30,7 +30,7 @@ Or install it yourself as:
 
 The basic object is `Contract`. It enforces type contracts by utilizing `dry-types`.
 
-```
+```ruby
 class UserFetcher < Atacama::Contract
   option :id, Types::Strict::Number.gt(0)
   returns Types.Instance(User)
@@ -43,19 +43,30 @@ end
 UserFetcher.call(id: 1)
 ```
 
-With the use of two classes, we can compose together multiple Contracts to yield a pipeline
-of changes to execute.
+With the use of two classes, we can compose together multiple Contracts to yield a pipeline of changes to execute.
 
-```
+Steps contain two flow control objects:
+* `Option(key: value)` which informs the Transformer to take this value and yield it to the subsequent steps in the chain.
+* `Return(value)` halts execution and early returns from the pipeline. Useful for things like validation and error handling.
+
+The `Transformer` always returns a value object.
+
+```ruby
 class UserFetcher < Atacama::Step
   option :id, type: Types::Strict::Number.gt(0)
   returns Types.Option(model: Types.Instance(User))
 
+  # Both #Option and #Return are flow control values that tell the transaction what is a
+  # value object and what should halt execution and return.
   def call
-    Option(model: User.find(id))
+    Option(model: User.find!(id))
+  rescue ActiveRecord::RecordNotFound
+    Return(Error.new('Not found'))
   end
 end
 
+# Around steps allow for yielding to child steps for things like instrumentation or
+# ActiveRecord::Transactions.
 class Duration < Atacama::Step
   def call
     start = Time.now
@@ -64,11 +75,19 @@ class Duration < Atacama::Step
   end
 end
 
+# The transaction class descends the queue of steps, yielding options to each step
+# defined.
+#
+# Steps can be defined with:
+#   * Procs
+#   * Class references
+#   * Instance methods
+#
 class UpdateUser < Atacama::Transformer
-  option :model, type: Types.Instance(User)
+  option :id, type: Types::Strict::Number.gt(0)
   option :attributes, type: Types::Strict::Hash
 
-  returns_option :model, Types.Instance(User)
+  returns_option :model, Types.Instance(User) | Types.Instance(Error)
 
   step :duration, with: Duration do
     step :find, with: UserFetcher
@@ -90,14 +109,47 @@ UpdateUser.call(id: 1, attributes: {
 Any step can be mocked out without the need for a third party library. Just pass any object that
 responds to `#call` in the class initializer.
 
-```
+```ruby
 UpdateUser.new(steps: {
-  save: lambda do |**|
+  save: lambda do
     puts "skipping save"
   end
 })
 ```
 
+Sometimes you need to compose these objects together and inject dependencies. Those injected values
+will be passed in to the object when it's later invoked with `#call`.
+
+```ruby
+UpdateUser.inject(id: 1).call(attributes: { email: 'hello@world.com' })
+```
+
+Injected contracts can then be used inside of a Contract. Useful for Polymorphic objects.
+
+```ruby
+class HistoryCreate < Atacama::Step
+  option :history_class, type: Types::Strict::Class
+  option :model, type: Types.Instance(ActiveRecord::Base)
+
+  def call
+    history_class.from_model(model)
+  end
+end
+
+class UpdateUser < Atacama::Transformer
+  option :id, type: Types::Strict::Number.gt(0)
+  option :attributes, type: Types::Strict::Hash
+
+  returns_option :model, Types.Instance(User) | Types.Instance(Error)
+
+  step :duration, with: Duration do
+    step :find, with: UserFetcher
+    step :save, with: Saver
+    step :history, with: HistoryCreate.inject(history_class: UserHistory)
+  end
+end
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/atacama.gemspec

@@ -23,10 +23,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'dry-types', '~> 0.13.2'
+  spec.add_dependency 'dry-types'
 
-  spec.add_development_dependency 'bundler', '~> 1.16'
-  spec.add_development_dependency 'minitest', '~> 5.0'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'rake'
   spec.add_development_dependency 'pry'
 end

data/lib/atacama/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Atacama
-  VERSION = '0.1.11'.freeze
+  VERSION = '0.2.0'.freeze
 end

metadata

@@ -1,71 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: atacama
 version: !ruby/object:Gem::Version
-  version: 0.1.11
+  version: 0.2.0
 platform: ruby
 authors:
 - Tyler Johnston
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-13 00:00:00.000000000 Z
+date: 2020-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-types
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.13.2
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.13.2
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -127,8 +127,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: DRY Service Objects