atacama 0.1.9 → 0.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bad140ab2ab9b93fcd0d3d67ae9765cac0a6ef2e
-  data.tar.gz: 5ba6c31aedd1f8175bece9df427ab9f57eeee6f5
+  metadata.gz: 4167c02e2fbe257dc68db7fab4de63e5f6d12c10
+  data.tar.gz: 719fd17923503f7f0cb4aaac835156f5a1efe481
 SHA512:
-  metadata.gz: aa1c928c33fa5dd1bd466c45f2c9d7c2b5bdff68012647dbdab19222864c94b78df88cde3700726bd6fa9e2a93b27b1009621486aa39f77d57ee1cb53fe0520d
-  data.tar.gz: 56e6c4edc97a07ef00c685620ef9c54437200ec66716c5d12eba193769b48fc5486fad8e194c39459ea7364427414f58eeb7a0f9be51d46a66de0353971a8772
+  metadata.gz: a54f18d7cf601e141ba8f3cb5a62c2bed2415dd875dc75a00ac509ef398da7e13ba90813f58ed502d16e7974907dff0f6d0cdffb69e93956af7d592b7e079b0c
+  data.tar.gz: 4e9a3108aff20d51ca6d8dd847b7f06564012c8f48a5411a91170c987f164397292b80e1ea045a1c9395929cc7db49c9803b12c947bb211ec858f99433278c2f

data/Gemfile.lock

@@ -1,12 +1,13 @@
 PATH
   remote: .
   specs:
-    atacama (0.1.9)
+    atacama (0.1.10)
       dry-types (~> 0.13.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    coderay (1.1.2)
     concurrent-ruby (1.0.5)
     dry-configurable (0.7.0)
       concurrent-ruby (~> 1.0)
@@ -28,7 +29,11 @@ GEM
       dry-equalizer (~> 0.2)
       dry-inflector (~> 0.1, >= 0.1.2)
       dry-logic (~> 0.4, >= 0.4.2)
+    method_source (0.9.2)
     minitest (5.11.3)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
     rake (10.5.0)
 
 PLATFORMS
@@ -38,6 +43,7 @@ DEPENDENCIES
   atacama!
   bundler (~> 1.16)
   minitest (~> 5.0)
+  pry
   rake (~> 10.0)
 
 BUNDLED WITH

data/Rakefile

@@ -12,3 +12,7 @@ task default: :test
 task :watch do
   exec 'docker run -v `pwd`:/app:cached -it spatialnetworks/alpine bash -l -c "gem install rerun && bundle && /usr/local/bundle/bin/rerun -x rake"'
 end
+
+task :debug do
+  exec 'docker run -v `pwd`:/app:cached -it spatialnetworks/alpine bash -l -c "bundle && rake"'
+end

data/atacama.gemspec

@@ -28,4 +28,5 @@ Gem::Specification.new do |spec|
   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 'pry'
 end

data/lib/atacama.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'dry-types'
 require 'atacama/version'
 require 'atacama/contract'
@@ -21,4 +23,24 @@ module Atacama
   rescue Dry::Types::ConstraintError => exception
     yield exception
   end
+
+  # Generate more human readable error messages for type errors.
+  #
+  # @param klass [Class] the class dispatching the exception
+  # @param exception [Dry::Types::]
+  def self.format_exception(klass, exception, description)
+    [
+      '',
+      '',
+      'Source:',
+      "  #{klass}",
+      '',
+      'Description:',
+      "  #{description}",
+      '',
+      'Error:',
+      "  The value #{exception.input.inspect} failed the following test: #{exception.result}",
+      ''
+    ].join("\n")
+  end
 end

data/lib/atacama/contract.rb

@@ -91,7 +91,9 @@ module Atacama
       # @param value [Any] the object to type check
       def validate_return(value)
         Atacama.check(return_type, value) do |e|
-          raise ReturnTypeMismatchError, "#{self} return value invalid: #{e.message}"
+          raise ReturnTypeMismatchError, Atacama.format_exception(self, e,
+            'The return value was an incorrect type.',
+          )
         end
       end
 

data/lib/atacama/contract/validator.rb

@@ -25,8 +25,11 @@ module Atacama
 
     def detect_invalid_types!
       options.each do |key, parameter|
-        Atacama.check parameter.type, context[key] do |e|
-          raise OptionTypeMismatchError, %(#{klass} option :#{key} invalid: #{e.message})
+        value = context[key]
+        Atacama.check parameter.type, value do |e|
+          raise OptionTypeMismatchError, Atacama.format_exception(klass, e,
+            "The value #{value.inspect} for #{key.inspect} is the incorrect type"
+          )
         end
       end
     end

data/lib/atacama/transaction.rb

@@ -35,7 +35,9 @@ module Atacama
         returns(
           Types.Instance(Result).constructor do |options|
             Atacama.check(type, options.value) do |e|
-              raise ResultTypeMismatchError, "Invalid Result value for #{self}: #{e.message}"
+              raise ResultTypeMismatchError, Atacama.format_exception(self, e,
+                "Option(#{key.inspect}) returned from the Transaction was the incorrect type.",
+              )
             end
 
             options

data/lib/atacama/types.rb

@@ -16,8 +16,11 @@ module Atacama
       Instance(Values::Option).constructor do |value_object|
         if value_object.is_a? Values::Option
           map.each do |key, type|
-            Atacama.check(type, value_object.value[key]) do |e|
-              raise OptionTypeMismatchError, "#{self} Invalid Option value type: #{e.message}"
+            value = value_object.value[key]
+            Atacama.check(type, value) do |e|
+              raise OptionTypeMismatchError, Atacama.format_exception(self, e,
+                "The Option() #{key.inspect} value #{value.inspect} is the incorrect type."
+              )
             end
           end
         end
@@ -36,7 +39,9 @@ module Atacama
       Instance(Values::Return).constructor do |value_object|
         if value_object.is_a?(Values::Return)
           Atacama.check(type, value_object.value) do |e|
-            raise ReturnTypeMismatchError, "#{self} Invalid Return Value type: #{e.message}"
+            raise ReturnTypeMismatchError, Atacama.format_exception(self, e,
+              "The Return() value #{value_object.value.inspect} does not match the declared type."
+            )
           end
         end
 

data/lib/atacama/version.rb

@@ -1,3 +1,3 @@
 module Atacama
-  VERSION = '0.1.9'.freeze
+  VERSION = '0.1.10'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: atacama
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.1.10
 platform: ruby
 authors:
 - Tyler Johnston
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Service objects using composable contracts
 email:
 - tyler@spatialnetworks.com