linearly 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2528725570ecfd8cced2b0718a9859be207fa15ffd6cb265bdd5976f5eb626e4
-  data.tar.gz: 478800acf301111d2f714ccd236fa9d9cecbb0d9ffc2b09c0dddf093dd382986
+  metadata.gz: 50a3c517f78d9e37fad6f7fbf445cc5d3569244b85163e2a1974e7d247c957ba
+  data.tar.gz: cf2e7d85b851095308eced41285adcc3ae9c86786d1338d7b80052511ac2e9e5
 SHA512:
-  metadata.gz: 4cab82060fe000080f29ba4a01b90cbf8081af67879bc8119da01f0ea6c16fd42a6677b7490cc3135b5e004517c6521cdbc33c0d9af1fbe024f8c45c6947a97d
-  data.tar.gz: a4e40ef75656a065a48dee68662b141150dacbca4c2e1e950385fa3359bca844cf1b32bc7dac71d83dbd1d8b2493edccb472d0f4b23b62453fbb10249e700e6e
+  metadata.gz: 1a8f5d4f0bd5304e53fdc41558b6ce9c3722d342706a2d312aab8293cd40eb999248adff0fc7d1f5934620c4232d2e79f02aa62344c43745c366cf916246e1d1
+  data.tar.gz: 3f625d7a397cb45021381d9e3413a031989d0a1d4311fab12a3f9047d10c7281b1b2ac69a11bb45a15d194029fc64ad833a280b8f4917d5646b570411d152798

data/lib/linearly/errors/broken_contract.rb

@@ -36,18 +36,31 @@ module Linearly
 
       # Constructor for a {BrokenContract} error
       #
+      # @param source [Object]
       # @param failures [Hash<Symbol, Validation::Failure>]
       #
       # @api public
       # @example
       #   Linearly::Errors::BrokenContract::Inputs.new(
+      #     Steps::HelloWorld,
       #     key: Linearly::Validation::Failure::Missing.instance,
       #   )
       #   => #<Linearly::Errors::BrokenContract::Inputs:
-      #        failed input expectations: [key]>
-      def initialize(failures)
+      #        failed input expectations on Steps::HelloWorld: [key]>
+      def initialize(source, failures)
+        @source = source
         @failures = failures
-        super("#{copy}: [#{keys.join(', ')}]")
+        super("#{copy} on #{source_string}: [#{keys.join(', ')}]")
+      end
+
+      private
+
+      # Stringify the source to put it in the error message
+      #
+      # @return [String]
+      # @api private
+      def source_string
+        @source.is_a?(Class) ? @source.name : @source.class.name
       end
 
       # {Inputs} means a {BrokenContract} on inputs.

data/lib/linearly/flow.rb

@@ -79,9 +79,9 @@ module Linearly
     # @api private
     def steps
       [
-        Validation::Inputs.new(inputs),
+        Validation::Inputs.new(self, inputs),
         *@steps.map(&Runner.method(:new)),
-        Validation::Outputs.new(outputs),
+        Validation::Outputs.new(self, outputs),
       ]
     end
 

data/lib/linearly/runner.rb

@@ -28,9 +28,9 @@ module Linearly
     # @api private
     def steps
       [
-        Validation::Inputs.new(step.inputs),
+        Validation::Inputs.new(step, step.inputs),
         step,
-        Validation::Outputs.new(step.outputs),
+        Validation::Outputs.new(step, step.outputs),
       ]
     end
   end

data/lib/linearly/validation.rb

@@ -7,13 +7,16 @@ module Linearly
   class Validation
     # Constructor for a {Validation}
     #
+    # @param source [Object] source of the validation, to be passed to errors
+    #        for better messaging.
     # @param expectations [Hash<Symbol, Expectation>] a hash of per-field
     #        expectations. An expectation can be +true+ (just checking for field
     #        presence), a class name (checking for value type) or a +Proc+
     #        taking a value and returning a +Boolean+.
     #
     # @api private
-    def initialize(expectations)
+    def initialize(source, expectations)
+      @source = source
       @expectations =
         expectations
         .map { |key, expectation| [key, Expectation.to_proc(expectation)] }
@@ -28,7 +31,7 @@ module Linearly
     # @api private
     def call(state)
       Validator
-        .new(expectations, state)
+        .new(@source, expectations, state)
         .validate(error_class)
     end
 
@@ -70,11 +73,14 @@ module Linearly
     class Validator
       # Constructor method for a {Validator}
       #
+      # @param source [Object] source of the validation, to be passed to errors
+      #        for better messaging.
       # @param expectations [Hash<Symbol, Expectation>]
       # @param state [Statefully::State]
       #
       # @api private
-      def initialize(expectations, state)
+      def initialize(source, expectations, state)
+        @source = source
         @expectations = expectations
         @state = state
       end
@@ -88,7 +94,7 @@ module Linearly
       def validate(error_class)
         failures = invalid.merge(missing).freeze
         return @state if failures.empty?
-        @state.fail(error_class.new(failures))
+        @state.fail(error_class.new(@source, failures))
       end
 
       private

data/lib/linearly/version.rb

@@ -1,3 +1,3 @@
 module Linearly
-  VERSION = '0.1.3'.freeze
+  VERSION = '0.1.4'.freeze
 end

data/spec/errors/broken_contract_spec.rb

@@ -9,17 +9,21 @@ module Linearly
           unexpected: Validation::Failure::Unexpected.instance,
         }
       end
-      let(:error) { described_class.new(failures) }
+      let(:error) { described_class.new('string', failures) }
 
       describe BrokenContract::Inputs do
-        let(:message) { 'failed input expectations: [missing, unexpected]' }
+        let(:message) do
+          'failed input expectations on String: [missing, unexpected]'
+        end
 
         it { expect(error.message).to eq message }
         it { expect(error.failures).to eq failures }
       end
 
       describe BrokenContract::Outputs do
-        let(:message) { 'failed output expectations: [missing, unexpected]' }
+        let(:message) do
+          'failed output expectations on String: [missing, unexpected]'
+        end
 
         it { expect(error.message).to eq message }
         it { expect(error.failures).to eq failures }

data/spec/validation_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 module Linearly
   describe Validation do
-    let(:validation) { described_class.new(expectations).call(state) }
+    let(:validation) { described_class.new('string', expectations).call(state) }
     let(:state)      { Statefully::State.create(key: 'val') }
 
     shared_examples 'validation_fails' do |error_class|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: linearly
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Marcin Wyszynski