Merge pull request #132 from zendesk/craig/validation-error

Enrich the hours validation experience
zendesk · Oct 30, 2018 · e61ced1 · e61ced1
2 parents bf81765 + c7d1130
commit e61ced1
Show file tree

Hide file tree

Showing 3 changed files with 40 additions and 32 deletions.
diff --git a/lib/biz/configuration.rb b/lib/biz/configuration.rb
@@ -8,9 +8,9 @@ def initialize
 
       yield raw if block_given?
 
-      Validation.perform(raw)
-
       raw.freeze
+
+      Validation.perform(self)
     end
 
     def intervals

diff --git a/lib/biz/validation.rb b/lib/biz/validation.rb
@@ -3,23 +3,23 @@
 module Biz
   class Validation
 
-    def self.perform(raw)
-      new(raw).perform
+    def self.perform(configuration)
+      new(configuration).perform
     end
 
-    def initialize(raw)
-      @raw = raw
+    def initialize(configuration)
+      @configuration = configuration
     end
 
     def perform
-      RULES.each do |rule| rule.check(raw) end
+      RULES.each do |rule| rule.check(configuration) end
 
       self
     end
 
     private
 
-    attr_reader :raw
+    attr_reader :configuration
 
     class Rule
 
@@ -28,8 +28,8 @@ def initialize(message, &condition)
         @condition = condition
       end
 
-      def check(raw)
-        fail Error::Configuration, message unless condition.call(raw)
+      def check(configuration)
+        fail Error::Configuration, message if condition.call(configuration)
       end
 
       private
@@ -40,11 +40,11 @@ def check(raw)
     end
 
     RULES = [
-      Rule.new('hours not hash-like') { |raw|
-        raw.hours.respond_to?(:to_h)
+      Rule.new('hours not provided') { |configuration|
+        configuration.intervals.none?
       },
-      Rule.new('hours not provided') { |raw|
-        raw.hours.to_h.any?
+      Rule.new('nonsensical hours provided') { |configuration|
+        configuration.intervals.any?(&:empty?)
       }
     ].freeze
 

diff --git a/spec/validation_spec.rb b/spec/validation_spec.rb
@@ -1,41 +1,49 @@
 # frozen_string_literal: true
 
 RSpec.describe Biz::Validation do
-  let(:raw) { Struct.new(:hours, :holidays, :time_zone).new }
+  let(:configuration) {
+    Biz::Configuration.new do |config| config.hours = hours end
+  }
 
-  subject(:validation) { described_class.new(raw) }
+  subject(:validation) { described_class.new(configuration) }
 
   describe '.perform' do
-    before do raw.hours = {} end
+    let(:hours) { {} }
 
-    it 'performs the validation on the provided raw input' do
+    it 'performs the validation on the provided configuration' do
       expect {
-        described_class.perform(raw)
+        described_class.perform(configuration)
       }.to raise_error Biz::Error::Configuration
     end
   end
 
   describe '#perform' do
-    describe 'when the hours are hash-like' do
-      describe 'and the hours are not empty' do
-        before do raw.hours = {mon: {'09:00' => '17:00'}} end
+    context 'when hours are provided' do
+      let(:hours) { {mon: {'09:00' => '17:00'}} }
 
-        it 'does not raise an error' do
-          expect { validation.perform }.not_to raise_error
-        end
+      it 'does not raise an error' do
+        expect { validation.perform }.not_to raise_error
       end
+    end
 
-      describe 'and the hours are empty' do
-        before do raw.hours = {} end
+    context 'when hours are not provided' do
+      let(:hours) { {} }
 
-        it 'raises a configuration error' do
-          expect { validation.perform }.to raise_error Biz::Error::Configuration
-        end
+      it 'raises a configuration error' do
+        expect { validation.perform }.to raise_error Biz::Error::Configuration
+      end
+    end
+
+    context 'when nonsensical hours are provided' do
+      let(:hours) { {mon: {'09:00' => '09:00'}} }
+
+      it 'raises a configuration error' do
+        expect { validation.perform }.to raise_error Biz::Error::Configuration
       end
     end
 
-    describe 'when the hours are not hash-like' do
-      before do raw.hours = 1 end
+    context 'when a day with no hours is provided' do
+      let(:hours) { {mon: {}} }
 
       it 'raises a configuration error' do
         expect { validation.perform }.to raise_error Biz::Error::Configuration