action_logic 0.0.6 → 0.1.0

data/lib/action_logic/action_use_case.rb

@@ -15,6 +15,8 @@ module ActionLogic
     module ClassMethods
       def execute(params = {})
         around(params) do |execution_context|
+          raise ActionLogic::InvalidUseCaseError.new("ActionUseCase requires at least one ActionTask") if execution_context.tasks.empty?
+
           execution_context.call
 
           execution_context.tasks.reduce(execution_context.context) do |context, task|

data/lib/action_logic/errors.rb

@@ -1,6 +1,18 @@
 module ActionLogic
+  # Thrown whenever an ActionTask, ActionUseCase or ActionCoordinator's context does not have a key defined for the attribute key in a validations block
   class MissingAttributeError < StandardError; end
+
+  # Thrown whenever an ActionTask, ActionUseCase or ActionCoordinator's context has an attribute and value but the value's type is not the same as that
+  # attributey's type specified in a validations block
   class AttributeTypeError < StandardError; end
+
+  # Thrown whenever an ActionTask, ActionUseCase or ActionCoordinator's context has an attribute and value but the value definition of presence is not satisfied
+  # for the value stored on the context
   class PresenceError < StandardError; end
+
+  # Adding a custom presence definition is possible, but the presence validation will throw an error if the custom presence definition is not a Proc
   class UnrecognizablePresenceValidatorError < StandardError; end
+
+  # ActionUseCases are invalid if they do not define any tasks
+  class InvalidUseCaseError < StandardError; end
 end

data/lib/action_logic/version.rb

@@ -1,3 +1,3 @@
 module ActionLogic
-  VERSION = '0.0.6'
+  VERSION = '0.1.0'
 end

data/spec/action_logic/active_use_case_spec.rb

@@ -32,6 +32,69 @@ module ActionLogic
       expect(result.second).to eq("defined in use case")
     end
 
+    describe "missing tasks" do
+      it "raises error if no tasks are defined" do
+        expect { NoTaskTestUseCase.execute() }.to\
+          raise_error(ActionLogic::InvalidUseCaseError)
+      end
+    end
+
+    describe "around validations" do
+      describe "required attributes and type validation" do
+        it "does not raise error if context has required keys and values are of the correct type" do
+          expect { ValidateAroundTestUseCase.execute(Constants::VALID_ATTRIBUTES) }.to_not raise_error
+        end
+
+        it "raises error if context is missing required keys" do
+          expect { ValidateAroundTestUseCase.execute() }.to\
+            raise_error(ActionLogic::MissingAttributeError)
+        end
+
+        it "raises error if context has required keys but values are not of correct type" do
+          expect { ValidateAroundTestUseCase.execute(Constants::INVALID_ATTRIBUTES) }.to\
+            raise_error(ActionLogic::AttributeTypeError)
+        end
+      end
+
+      describe "custom types" do
+        it "allows validation against custom defined types" do
+          expect { ValidateAroundCustomTypeTestUseCase.execute(:custom_type => CustomType1.new) }.to_not raise_error
+        end
+
+        it "raises error if context has custom type attribute but value is not correct custom type" do
+          expect { ValidateAroundCustomTypeTestUseCase.execute(:custom_type => CustomType2.new) }.to\
+            raise_error(ActionLogic::AttributeTypeError)
+        end
+      end
+
+      describe "presence" do
+        it "validates presence if presence is specified" do
+          expect { ValidateAroundPresenceTestUseCase.execute(:integer_test => 1) }.to_not raise_error
+        end
+
+        it "raises error if context has required key but value is not defined when validation requires presence" do
+          expect { ValidateAroundPresenceTestUseCase.execute(:integer_test => nil) }.to\
+            raise_error(ActionLogic::PresenceError)
+        end
+      end
+
+      describe "custom presence" do
+        it "allows custom presence validation if custom presence is defined" do
+          expect { ValidateAroundCustomPresenceTestUseCase.execute(:array_test => [1]) }.to_not raise_error
+        end
+
+        it "raises error if custom presence validation is not satisfied" do
+          expect { ValidateAroundCustomPresenceTestUseCase.execute(:array_test => []) }.to\
+            raise_error(ActionLogic::PresenceError)
+        end
+
+        it "raises error if custom presence validation is not supported" do
+          expect { ValidateAroundUnrecognizablePresenceTestUseCase.execute(:integer_test => 1) }.to\
+            raise_error(ActionLogic::UnrecognizablePresenceValidatorError)
+        end
+      end
+    end
+
     describe "before validations" do
       describe "required attributes and type validation" do
         it "does not raise error if context has required keys and values are of the correct type" do

data/spec/fixtures/use_cases.rb

@@ -37,6 +37,87 @@ class SimpleTestUseCase3
   end
 end
 
+class NoTaskTestUseCase
+  include ActionLogic::ActionUseCase
+
+  def call
+  end
+
+  def tasks
+    []
+  end
+end
+
+class ValidateAroundTestUseCase
+  include ActionLogic::ActionUseCase
+
+  validates_around Constants::ALL_VALIDATIONS
+
+  def call
+  end
+
+  def tasks
+    [UseCaseTestTask1,
+     UseCaseTestTask2]
+  end
+end
+
+class ValidateAroundCustomTypeTestUseCase
+  include ActionLogic::ActionUseCase
+
+  validates_around :custom_type => { :type => :customtype1, :presence => true }
+
+  def call
+  end
+
+  def tasks
+    [UseCaseTestTask1,
+     UseCaseTestTask2]
+  end
+end
+
+class ValidateAroundUnrecognizablePresenceTestUseCase
+  include ActionLogic::ActionUseCase
+
+  validates_around :integer_test => { :presence => :true }
+
+  def call
+  end
+
+  def tasks
+    [UseCaseTestTask1,
+     UseCaseTestTask2]
+  end
+end
+
+class ValidateAroundPresenceTestUseCase
+  include ActionLogic::ActionUseCase
+
+  validates_around :integer_test => { :presence => true }
+
+  def call
+  end
+
+  def tasks
+    [UseCaseTestTask1,
+     UseCaseTestTask2]
+  end
+end
+
+class ValidateAroundCustomPresenceTestUseCase
+  include ActionLogic::ActionUseCase
+
+  validates_around :array_test => { :presence => ->(array_test) { array_test.any? } }
+
+  def call
+  end
+
+  def tasks
+    [UseCaseTestTask1,
+     UseCaseTestTask2]
+  end
+end
+
 class ValidateBeforeTestUseCase
   include ActionLogic::ActionUseCase
 
@@ -46,7 +127,8 @@ class ValidateBeforeTestUseCase
   end
 
   def tasks
-    []
+    [UseCaseTestTask1,
+     UseCaseTestTask2]
   end
 end
 
@@ -59,7 +141,8 @@ class ValidateBeforePresenceTestUseCase
   end
 
   def tasks
-    []
+    [UseCaseTestTask1,
+     UseCaseTestTask2]
   end
 end
 
@@ -72,7 +155,8 @@ class ValidateBeforeCustomPresenceTestUseCase
   end
 
   def tasks
-    []
+    [UseCaseTestTask1,
+     UseCaseTestTask2]
   end
 end
 
@@ -85,7 +169,8 @@ class ValidateBeforeCustomTypeTestUseCase
   end
 
   def tasks
-    []
+    [UseCaseTestTask1,
+     UseCaseTestTask2]
   end
 end
 
@@ -98,7 +183,8 @@ class ValidateBeforeUnrecognizablePresenceTestUseCase
   end
 
   def tasks
-    []
+    [UseCaseTestTask1,
+     UseCaseTestTask2]
   end
 end
 
@@ -119,7 +205,7 @@ class ValidateAfterTestUseCase
   end
 
   def tasks
-    []
+    [UseCaseTestTask3]
   end
 end
 
@@ -132,7 +218,8 @@ class ValidateAfterMissingAttributesTestUseCase
   end
 
   def tasks
-    []
+    [UseCaseTestTask1,
+     UseCaseTestTask2]
   end
 end
 
@@ -153,7 +240,8 @@ class ValidateAfterInvalidTypeTestUseCase
   end
 
   def tasks
-    []
+    [UseCaseTestTask1,
+     UseCaseTestTask2]
   end
 end
 
@@ -167,7 +255,8 @@ class ValidateAfterCustomTypeTestUseCase
   end
 
   def tasks
-    []
+    [UseCaseTestTask1,
+     UseCaseTestTask2]
   end
 end
 
@@ -181,7 +270,8 @@ class ValidateAfterInvalidCustomTypeTestUseCase
   end
 
   def tasks
-    []
+    [UseCaseTestTask1,
+     UseCaseTestTask2]
   end
 end
 
@@ -195,7 +285,7 @@ class ValidateAfterPresenceTestUseCase
   end
 
   def tasks
-    []
+    [UseCaseTestTask3]
   end
 end
 
@@ -209,7 +299,8 @@ class ValidateAfterInvalidPresenceTestUseCase
   end
 
   def tasks
-    []
+    [UseCaseTestTask1,
+     UseCaseTestTask2]
   end
 end
 
@@ -223,7 +314,8 @@ class ValidateAfterCustomPresenceTestUseCase
   end
 
   def tasks
-    []
+    [UseCaseTestTask1,
+     UseCaseTestTask2]
   end
 end
 
@@ -237,7 +329,8 @@ class ValidateAfterInvalidCustomPresenceTestUseCase
   end
 
   def tasks
-    []
+    [UseCaseTestTask1,
+     UseCaseTestTask2]
   end
 end
 
@@ -251,7 +344,8 @@ class ValidateAfterUnrecognizablePresenceTestUseCase
   end
 
   def tasks
-    []
+    [UseCaseTestTask1,
+     UseCaseTestTask2]
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: action_logic
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.1.0
 platform: ruby
 authors:
 - Rick Winfrey
@@ -73,6 +73,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
 - README.md
@@ -86,6 +87,11 @@ files:
 - lib/action_logic/action_validation.rb
 - lib/action_logic/errors.rb
 - lib/action_logic/version.rb
+- resources/action_coordinator_diagram.png
+- resources/action_task_diagram.png
+- resources/action_use_case_diagram.png
+- resources/diagrams.sketch
+- resources/overview_diagram.png
 - spec/action_logic/action_context_spec.rb
 - spec/action_logic/action_coordinator_spec.rb
 - spec/action_logic/action_task_spec.rb