action_logic 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cb88bf14abd86df63ae10d679391a032ac66245f
-  data.tar.gz: 9a98e3cf999ed6390c9f239960945c2f2efb9767
+  metadata.gz: b6d36552e9a95bd397f6841f5ea609b870885349
+  data.tar.gz: f2e121ac6007fcd73d09a88988053adc7892fe4a
 SHA512:
-  metadata.gz: 3a6102dceee026431347f921772b4919584a8253bbb54a1fdd68b64adbc84f3c0aa970b686735c20871dfb14a56913d1e0a3c18ca0f7a06535402c9b30e111ce
-  data.tar.gz: 50db9e8264312f9cd1a7dd7f38e1bf0ee711bcdfd895bce653a316e4d5e09a5d1b4346946033c59d186799b825ed6dad62a39b2f8c4dc0522a373f6f4206df4c
+  metadata.gz: 8ae1e86d81b1d5799d95089eb6319402610046880d7c1856ce420fba6865a6029191e606d5093c595e839179773b16e91f10fb53bc4e1489300fd9202474afb0
+  data.tar.gz: 869e66643e26a901d707f4887539649ebe13e160199fc361190099be4b46dfe0761eb3e75d40805e12f8db72faf2c92f9ae865d375ce2ca66238f3686a008488

data/.gitignore

@@ -0,0 +1,2 @@
+coverage/
+*.gem

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,72 @@
+PATH
+  remote: .
+  specs:
+    action_logic (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.0)
+    coveralls (0.8.3)
+      json (~> 1.8)
+      rest-client (>= 1.6.8, < 2)
+      simplecov (~> 0.10.0)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.1)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    domain_name (0.5.25)
+      unf (>= 0.0.5, < 1.0.0)
+    http-cookie (1.0.2)
+      domain_name (~> 0.5)
+    json (1.8.3)
+    method_source (0.8.2)
+    mime-types (2.6.2)
+    netrc (0.11.0)
+    pry (0.10.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rest-client (1.8.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 3.0)
+      netrc (~> 0.7)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.2)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    simplecov (0.10.0)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    slop (3.6.0)
+    term-ansicolor (1.3.2)
+      tins (~> 1.0)
+    thor (0.19.1)
+    tins (1.6.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  action_logic!
+  coveralls (~> 0.8.3)
+  pry (~> 0.10)
+  rspec (~> 3.3)
+  simplecov (~> 0.10.0)
+
+BUNDLED WITH
+   1.10.6

data/README.md

@@ -0,0 +1,6 @@
+# ActionLogic
+[![Gem Version](https://badge.fury.io/rb/action_logic.svg)](https://badge.fury.io/rb/action_logic)
+[![Code Climate](https://codeclimate.com/github/rewinfrey/action_logic/badges/gpa.svg)](https://codeclimate.com/github/rewinfrey/action_logic)
+[![Coverage Status](https://coveralls.io/repos/rewinfrey/action_logic/badge.svg?branch=master&service=github)](https://coveralls.io/github/rewinfrey/action_logic?branch=master)
+
+[![Codeship Status for rewinfrey/action_logic](https://codeship.com/projects/7737cf40-6808-0133-84a7-460d97cd31f0/status?branch=master)](https://codeship.com/projects/114179)

data/action_logic.gemspec

@@ -0,0 +1,24 @@
+require File.expand_path('../lib/action_logic/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name = 'action_logic'
+  s.summary = 'Business logic abstraction'
+  s.homepage = 'https://github.com/rewinfrey/action_logic'
+  s.license = 'MIT'
+
+  s.files = `git ls-files`.split($\)
+	s.executables = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  s.test_files = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ["lib"]
+  s.version = ActionLogic::VERSION
+
+  s.authors = ["Rick Winfrey"]
+  s.email = 'rick.winfrey@gmail.com'
+  s.date = '2015-11-03'
+  s.description = 'Provides common interfaces for validating and abstracting business logic'
+
+  s.add_development_dependency("rspec", "~> 3.3")
+  s.add_development_dependency("pry", "~> 0.10")
+  s.add_development_dependency("simplecov", "~> 0.10.0")
+  s.add_development_dependency("coveralls", "~> 0.8.3")
+end

data/lib/action_logic/action_context.rb

@@ -0,0 +1,39 @@
+require 'ostruct'
+
+module ActionLogic
+  class ActionContext < OpenStruct
+    SUCCESS = :success
+    FAILURE = :failure
+    HALTED  = :halted
+
+    def initialize(params = {})
+      params[:status] ||= SUCCESS
+      super(params)
+    end
+
+    def update!(status, message)
+      self.status = status
+      self.message = message
+    end
+
+    def fail!(message = "")
+      update!(FAILURE, message)
+    end
+
+    def halt!(message = "")
+      update!(HALTED, message)
+    end
+
+    def success?
+      self.status == SUCCESS
+    end
+
+    def failure?
+      self.status == FAILURE
+    end
+
+    def halted?
+      self.status == HALTED
+    end
+  end
+end

data/lib/action_logic/action_coordinator.rb

@@ -0,0 +1,42 @@
+require 'action_logic/action_core'
+require 'action_logic/action_validation'
+
+module ActionLogic
+  module ActionCoordinator
+    include ActionLogic::ActionValidation
+    include ActionLogic::ActionCore
+
+    def self.included(klass)
+      klass.extend ClassMethods
+      klass.extend ActionLogic::ActionCore::ClassMethods
+      klass.extend ActionLogic::ActionValidation::ClassMethods
+    end
+
+    module ClassMethods
+      def execute(params = {})
+        around(params) do |execution_context|
+          execution_context.call
+
+          next_execution_context = execution_context.plan.keys.first
+
+          while (next_execution_context) do
+            execution_context.context = next_execution_context.execute(execution_context.context)
+            next_execution_context = execution_context.plan[next_execution_context][execution_context.context.status]
+
+            # From the perspective of the coordinator, the status of the context should be
+            # :success as long as the state transition plan defines the next execution context
+            # for a given current exection context and its resulting context state.
+            # However, because normally a context in a state of :halted or :failure would
+            # be considered a "breaking" state, the status of a context that is :halted or :failure
+            # has to be reset to the default :success status only within the execution context of
+            # the coordinator and only when the next execution context is defined within the
+            # state transition plan. Otherwise, the context is return as is, without mutating its :status.
+            execution_context.context.status = :success if next_execution_context
+          end
+
+          execution_context.context
+        end
+      end
+    end
+  end
+end

data/lib/action_logic/action_core.rb

@@ -0,0 +1,45 @@
+module ActionLogic
+  module ActionCore
+    attr_accessor :context
+
+    def initialize(params)
+      self.context = make_context(params)
+    end
+
+    def make_context(params = {})
+      ActionContext.new(params)
+    end
+
+    def break?
+      context.status == :failure ||
+        context.status == :halted
+    end
+
+    module ClassMethods
+      def around(params, &block)
+        execution_context = self.new(params)
+
+        return execution_context.context if execution_context.break?
+
+        execution_context.set_validation_rules
+        execution_context.validations!(:before)
+        execution_context.validations!(:around)
+
+        begin
+          block.call(execution_context)
+        rescue => e
+          if execution_context.respond_to?(:error)
+            execution_context.error(e)
+          else
+            raise e
+          end
+        end
+
+        execution_context.validations!(:after)
+        execution_context.validations!(:around)
+
+        execution_context.context
+      end
+    end
+  end
+end

data/lib/action_logic/action_task.rb

@@ -0,0 +1,24 @@
+require 'action_logic/action_core'
+require 'action_logic/action_validation'
+
+module ActionLogic
+  module ActionTask
+    include ActionLogic::ActionValidation
+    include ActionLogic::ActionCore
+
+    def self.included(klass)
+      klass.extend ClassMethods
+      klass.extend ActionLogic::ActionCore::ClassMethods
+      klass.extend ActionLogic::ActionValidation::ClassMethods
+    end
+
+    module ClassMethods
+      def execute(params = {})
+        around(params) do |execution_context|
+          execution_context.call
+          execution_context.context
+        end
+      end
+    end
+  end
+end

data/lib/action_logic/action_use_case.rb

@@ -0,0 +1,28 @@
+require 'action_logic/action_core'
+require 'action_logic/action_validation'
+
+module ActionLogic
+  module ActionUseCase
+    include ActionLogic::ActionValidation
+    include ActionLogic::ActionCore
+
+    def self.included(klass)
+      klass.extend ClassMethods
+      klass.extend ActionLogic::ActionCore::ClassMethods
+      klass.extend ActionLogic::ActionValidation::ClassMethods
+    end
+
+    module ClassMethods
+      def execute(params = {})
+        around(params) do |execution_context|
+          execution_context.call
+
+          execution_context.tasks.reduce(execution_context.context) do |context, task|
+            execution_context.context = task.execute(context)
+            execution_context.context
+          end
+        end
+      end
+    end
+  end
+end

data/lib/action_logic/action_validation.rb

@@ -0,0 +1,111 @@
+require 'action_logic/errors'
+
+module ActionLogic
+  module ActionValidation
+
+    module ClassMethods
+      def validates_before(args)
+        @validates_before = args
+      end
+
+      def validates_after(args)
+        @validates_after = args
+      end
+
+      def validates_around(args)
+        @validates_around = args
+      end
+
+      def get_validates_before
+        @validates_before
+      end
+
+      def get_validates_after
+        @validates_after
+      end
+
+      def get_validates_around
+        @validates_around
+      end
+    end
+
+    def validations
+      [:validate_attributes!,
+       :validate_types!,
+       :validate_presence!]
+    end
+
+    def validate!(validation, validation_rules)
+      return if validation_rules.empty?
+      send(validation, validation_rules)
+    end
+
+    def validations!(validation_order)
+      case validation_order
+      when :before then validations.each { |validation| validate!(validation, @before_validation_rules) }
+      when :after  then validations.each { |validation| validate!(validation, @after_validation_rules) }
+      when :around then validations.each { |validation| validate!(validation, @around_validation_rules) }
+      end
+    end
+
+    def set_validation_rules
+      @before_validation_rules ||= self.class.get_validates_before || {}
+      @after_validation_rules  ||= self.class.get_validates_after  || {}
+      @around_validation_rules ||= self.class.get_validates_around || {}
+    end
+
+    def validate_attributes!(validations)
+      existing_attributes = context.to_h.keys
+      expected_attributes = validations.keys || []
+      missing_attributes  = expected_attributes - existing_attributes
+
+      raise ActionLogic::MissingAttributeError.new(missing_attributes) if missing_attributes.any?
+    end
+
+    def validate_types!(validations)
+      return unless validations.values.find { |expected_validation| expected_validation[:type] }
+
+      type_errors = validations.reduce([]) do |collection, (expected_attribute, expected_validation)|
+        next unless expected_validation[:type]
+
+        if type_to_sym(context.to_h[expected_attribute]) != expected_validation[:type]
+          collection << "Attribute: #{expected_attribute} with value: #{context.to_h[expected_attribute]} was expected to be of type #{expected_validation[:type]} but is #{type_to_sym(context.to_h[expected_attribute])}"
+        end
+        collection
+      end
+
+      raise ActionLogic::AttributeTypeError.new(type_errors) if type_errors.any?
+    end
+
+    def validate_presence!(validations)
+      return unless validations.values.find { |expected_validation| expected_validation[:presence] }
+
+      presence_errors = validations.reduce([]) do |collection, (expected_attribute, expected_validation)|
+        next unless expected_validation[:presence]
+
+        if expected_validation[:presence] == true
+          collection << "Attribute: #{expected_attribute} is missing value in context but presence validation was specified" unless context[expected_attribute]
+        elsif expected_validation[:presence].class == Proc
+          collection << "Attribute: #{expected_attribute} is missing value in context but custom presence validation was specified" unless expected_validation[:presence].call(context[expected_attribute])
+        else
+          raise ActionLogic::UnrecognizablePresenceValidatorError.new("Presence validator: #{expected_validation[:presence]} is not a supported format")
+        end
+
+        collection
+      end || []
+
+      raise ActionLogic::PresenceError.new(presence_errors) if presence_errors.any?
+    end
+
+    def type_to_sym(value)
+      case value.class.name.downcase.to_sym
+      when :fixnum     then :integer
+      when :falseclass then :boolean
+      when :trueclass  then :boolean
+      when :nilclass   then :nil
+      else
+        value.class.name.downcase.to_sym
+      end
+    end
+  end
+end

data/lib/action_logic/errors.rb

@@ -0,0 +1,6 @@
+module ActionLogic
+  class MissingAttributeError < StandardError; end
+  class AttributeTypeError < StandardError; end
+  class PresenceError < StandardError; end
+  class UnrecognizablePresenceValidatorError < StandardError; end
+end

data/lib/action_logic/version.rb

@@ -0,0 +1,3 @@
+module ActionLogic
+  VERSION = '0.0.4'
+end

data/spec/action_logic/action_context_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+require 'action_logic'
+require 'fixtures/constants'
+
+module ActionLogic
+  describe ActionContext do
+    subject { ActionContext.new }
+
+    describe "initialization" do
+      it "sets a default success attribute on the context" do
+        expect(subject.status).to eq(described_class::SUCCESS)
+      end
+    end
+
+    describe "success?" do
+      it "returns true if the context is successful" do
+        expect(subject.success?).to be_truthy
+      end
+    end
+
+    describe "failing a context" do
+      it "sets the context status as failed" do
+        subject.fail!
+
+        expect(subject.status).to eq(:failure)
+      end
+
+      it "does not require a message" do
+        subject.fail!
+
+        expect(subject.message).to be_empty
+      end
+
+      it "allows a custom failure message to be defined" do
+        failure_message = Constants::FAILURE_MESSAGE
+        subject.fail!(failure_message)
+
+        expect(subject.message).to eq(failure_message)
+      end
+
+      it "responds to directly query" do
+        subject.fail!
+
+        expect(subject.failure?).to be_truthy
+      end
+    end
+
+    describe "halting a context" do
+      it "sets the context status as halted" do
+        subject.halt!
+
+        expect(subject.status).to eq(:halted)
+      end
+
+      it "does not require a message" do
+        subject.halt!
+
+        expect(subject.message).to be_empty
+      end
+
+      it "allows a custom halted message to be defined" do
+        halt_message  = Constants::HALT_MESSAGE
+        subject.halt!(halt_message)
+
+        expect(subject.message).to eq(halt_message)
+      end
+
+      it "responds to direct query" do
+        subject.halt!
+
+        expect(subject.halted?).to be_truthy
+      end
+    end
+  end
+end

data/spec/action_logic/action_coordinator_spec.rb

@@ -0,0 +1,162 @@
+require 'spec_helper'
+require 'action_logic'
+require 'fixtures/coordinators'
+require 'fixtures/custom_types'
+
+module ActionLogic
+  describe ActionCoordinator do
+    context "no failures and no halts" do
+      it "evaluates all use cases defined by the state transition plan" do
+        result = TestCoordinator1.execute()
+
+        expect(result.test_coordinator1).to be_truthy
+        expect(result.test_use_case1).to be_truthy
+        expect(result.test_task1).to be_truthy
+        expect(result.test_use_case2).to be_truthy
+        expect(result.test_task2).to be_truthy
+        expect(result.test_use_case3).to be_truthy
+        expect(result.test_task3).to be_truthy
+      end
+    end
+
+    context "with halts" do
+      it "evaluates all use cases defined by the state transition plan" do
+        result = HaltedTestCoordinator1.execute()
+
+        expect(result.halted_test_coordinator1).to be_truthy
+        expect(result.halted_test_use_case1).to be_truthy
+        expect(result.halted_test_task1).to be_truthy
+        expect(result.test_use_case2).to be_truthy
+        expect(result.test_task2).to be_truthy
+        expect(result.test_use_case3).to be_truthy
+        expect(result.test_task3).to be_truthy
+      end
+    end
+
+    context "with failures" do
+      it "evaluates all use cases defined by the state transition plan" do
+        result = FailureTestCoordinator1.execute()
+
+        expect(result.failure_test_coordinator1).to be_truthy
+        expect(result.failure_test_use_case1).to be_truthy
+        expect(result.failure_test_task1).to be_truthy
+        expect(result.test_use_case2).to be_truthy
+        expect(result.test_task2).to be_truthy
+        expect(result.test_use_case3).to be_truthy
+        expect(result.test_task3).to be_truthy
+      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
+          expect { ValidateBeforeTestCoordinator.execute(Constants::VALID_ATTRIBUTES) }.to_not raise_error
+        end
+
+        it "raises error if context is missing required keys" do
+          expect { ValidateBeforeTestCoordinator.execute() }.to\
+            raise_error(ActionLogic::MissingAttributeError)
+        end
+
+        it "raises error if context has required key but is not of correct type" do
+          expect { ValidateBeforeTestCoordinator.execute(Constants::INVALID_ATTRIBUTES) }.to\
+            raise_error(ActionLogic::AttributeTypeError)
+        end
+      end
+
+      describe "custom types" do
+        it "allows validation against custom defined types" do
+          expect { ValidateBeforeCustomTypeTestCoordinator.execute(Constants::CUSTOM_TYPE_ATTRIBUTES1) }.to_not raise_error
+        end
+
+        it "raises error if context has custom type attribute but value is not correct custom type" do
+          expect { ValidateBeforeCustomTypeTestCoordinator.execute(Constants::CUSTOM_TYPE_ATTRIBUTES2) }.to\
+            raise_error(ActionLogic::AttributeTypeError)
+        end
+      end
+
+      describe "presence" do
+        it "validates presence if presence is specified" do
+          expect { ValidateBeforePresenceTestCoordinator.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 { ValidateBeforePresenceTestCoordinator.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 { ValidateBeforeCustomPresenceTestCoordinator.execute(:array_test => [1]) }.to_not raise_error
+        end
+
+        it "raises error if custom presence validation is not satisfied" do
+          expect { ValidateBeforeCustomPresenceTestCoordinator.execute(:array_test => []) }.to\
+            raise_error(ActionLogic::PresenceError)
+        end
+
+        it "raises error if custom presence validation is not supported" do
+          expect { ValidateBeforeUnrecognizablePresenceTestCoordinator.execute(:integer_test => 1) }.to\
+            raise_error(ActionLogic::UnrecognizablePresenceValidatorError)
+        end
+      end
+    end
+
+    describe "after validations" do
+      describe "required attributes and type validation" do
+        it "does not raise error if the task sets all required keys and values are of the correct type" do
+          expect { ValidateAfterTestCoordinator.execute() }.to_not raise_error
+        end
+
+        it "raises error if task does not provide the necessary keys" do
+          expect { ValidateAfterMissingAttributesTestCoordinator.execute() }.to\
+            raise_error(ActionLogic::MissingAttributeError)
+        end
+
+        it "raises error if task has required key but is not of correct type" do
+          expect { ValidateAfterInvalidTypeTestCoordinator.execute() }.to\
+            raise_error(ActionLogic::AttributeTypeError)
+        end
+      end
+
+      describe "custom types" do
+        it "allows validation against custom defined types" do
+          expect { ValidateAfterCustomTypeTestCoordinator.execute() }.to_not raise_error
+        end
+
+        it "raises error if context has custom type attribute but value is not correct custom type" do
+          expect { ValidateAfterInvalidCustomTypeTestCoordinator.execute() }.to\
+            raise_error(ActionLogic::AttributeTypeError)
+        end
+      end
+
+      describe "presence" do
+        it "validates presence if presence is specified" do
+          expect { ValidateAfterPresenceTestCoordinator.execute() }.to_not raise_error
+        end
+
+        it "raises error if context has required key but value is not defined when validation requires presence" do
+          expect { ValidateAfterInvalidPresenceTestCoordinator.execute() }.to\
+            raise_error(ActionLogic::PresenceError)
+        end
+      end
+
+      describe "custom presence" do
+        it "allows custom presence validation if custom presence is defined" do
+          expect { ValidateAfterCustomPresenceTestCoordinator.execute() }.to_not raise_error
+        end
+
+        it "raises error if custom presence validation is not satisfied" do
+          expect { ValidateAfterInvalidCustomPresenceTestCoordinator.execute() }.to\
+            raise_error(ActionLogic::PresenceError)
+        end
+
+        it "raises error if custom presence validation is not supported" do
+          expect { ValidateAfterUnrecognizablePresenceTestCoordinator.execute() }.to\
+            raise_error(ActionLogic::UnrecognizablePresenceValidatorError)
+        end
+      end
+    end
+  end
+end