action_logic 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ec1c25ca6b1d98aead3c8da72aaa11ae58c1b9fe
-  data.tar.gz: c27b50ad7c730bcf5b370b3016b8dc8fabca1cc9
+  metadata.gz: cb908cdf21b4822673902f5b19eed95206101d34
+  data.tar.gz: 88acebe974c5bdfc84a0f063b3de6167aaf8d089
 SHA512:
-  metadata.gz: 8340bda2fb890fdea4c2cf4177763c347dfdcbc247ab4a49b1def06851cd99cfc633c3c9c671272a16ce7dd960fee432d9e4abc5af341a499d33a83202c5b61f
-  data.tar.gz: c9f53e0e7f74cb63618e1b064a940027166ba8f9165c9dbdf0ac4cd289a25e19ce90d0fbfaa34433a13d82a65c654c6cc8144ddd8d27b78158a4c58253b900b9
+  metadata.gz: 91b207eff368d0401c5b3110bd62de42929198aae35993fd80f72746e8628e6d8dffd0283aa04bd26d103445ac0c091c843915ac83e8f3e0c2285dc1fd99c40f
+  data.tar.gz: 061f6bc8f7ae853638320cf79d0c6a2e154d110c322482887e9e74719978d5e4dd71e1c9f8b17342a4901bbef6d055cf047cd7cb2ccacab56410128b6f7ba894

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    action_logic (0.2.0)
+    action_logic (0.2.1)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -589,7 +589,7 @@ class ActionTaskExample
   end
 end
 
-ActionTaskExample.execute # ~> [:required_attribute1] (ActionLogic::MissingAttributeError)
+ActionTaskExample.execute # ~> context: ActionTaskExample message: [:required_attribute1] (ActionLogic::MissingAttributeError)
 ```
 
 Attribute validations are defined in the same way regardless of the timing of the validation ([before](#before-validations), [after](#after-validations) or
@@ -657,7 +657,7 @@ class ActionTaskExample
   end
 end
 
-ActionTaskExample.execute # ~> ["Attribute: integer_test with value: 1.0 was expected to be of type Fixnum but is Float"] (ActionLogic::AttributeTypeError)
+ActionTaskExample.execute # ~> context: ActionTaskExample message: Attribute: integer_test with value: 1.0 was expected to be of type Fixnum but is Float (ActionLogic::AttributeTypeError)
 ```
 
 In addition to the above default types it is possible to also validate against user defined types.
@@ -709,7 +709,7 @@ class ActionTaskExample
   end
 end
 
-ActionTaskExample.execute # ~> ["Attribute: example_attribute with value: #<OtherClass:0x007fb5ca04edb8> was expected to be of type ExampleClass but is OtherClass"] (ActionLogic::AttributeTypeError)
+ActionTaskExample.execute # ~> context: ActionTaskExample message: Attribute: example_attribute with value: #<OtherClass:0x007fb5ca04edb8> was expected to be of type ExampleClass but is OtherClass (ActionLogic::AttributeTypeError)
 ```
 
 Attribute and type validations are very helpful, but in some situations this is not enough. Additionally, `ActionLogic` provides presence validation so you can also verify that
@@ -751,7 +751,7 @@ class ActionTaskExample
   end
 end
 
-ActionTaskExample.execute(:example_attribute => nil) # ~> ["Attribute: example_attribute is missing value in context but presence validation was specified"] (ActionLogic::PresenceError)
+ActionTaskExample.execute(:example_attribute => nil) # ~> context: ActionTaskExample message: Attribute: example_attribute is missing value in context but presence validation was specified (ActionLogic::PresenceError)
 ```
 
 ### Custom Presence Validations
@@ -792,7 +792,7 @@ class ActionTaskExample
   end
 end
 
-ActionTaskExample.execute(:example_attribute => []) # ~> ["Attribute: example_attribute is missing value in context but custom presence validation was specified"] (ActionLogic::PresenceError)
+ActionTaskExample.execute(:example_attribute => []) # ~> context: ActionTaskExample message: Attribute: example_attribute is missing value in context but custom presence validation was specified (ActionLogic::PresenceError)
 ```
 
 In the above example, we have failed to pass the presence validation for `example_attribute` because the value of `example_attribute` is an empty array. When

data/lib/action_logic.rb

@@ -1,4 +1,5 @@
 require 'action_logic/version'
+require 'action_logic/action_configuration'
 require 'action_logic/action_context'
 require 'action_logic/action_coordinator'
 require 'action_logic/action_core'
@@ -6,3 +7,4 @@ require 'action_logic/action_task'
 require 'action_logic/action_use_case'
 require 'action_logic/action_validation'
 require 'action_logic/errors'
+require 'benchmark'

data/lib/action_logic/action_benchmark.rb

@@ -0,0 +1,19 @@
+module ActionLogic
+  module ActionBenchmark
+
+    module ClassMethods
+      def with_benchmark(class_context, &block)
+        if ActionConfiguration.benchmark?
+          context = nil
+          benchmark_result = Benchmark.measure { context = block.call }
+          ActionConfiguration.benchmark_log.printf("%60s: %15s %15s %15s %15s\n", "Context", "User Time", "System Time", "Total Time", "Real Time")
+          ActionConfiguration.benchmark_log.printf("%60s: %15f %15f %15f %15f\n\n", class_context, benchmark_result.utime, benchmark_result.stime, benchmark_result.total, benchmark_result.real)
+          context
+        else
+          block.call
+        end
+      end
+    end
+
+  end
+end

data/lib/action_logic/action_configuration.rb

@@ -0,0 +1,25 @@
+require 'ostruct'
+
+module ActionLogic
+  class ActionConfiguration
+    def self.configure(&block)
+      block.call(configuration_options)
+    end
+
+    def self.configuration_options
+      @configuration_options ||= OpenStruct.new
+    end
+
+    def self.benchmark?
+      configuration_options.benchmark || false
+    end
+
+    def self.benchmark_log
+      configuration_options.benchmark_log || $stdout
+    end
+
+    def self.reset!
+      @configuration_options = OpenStruct.new
+    end
+  end
+end

data/lib/action_logic/action_coordinator.rb

@@ -1,5 +1,6 @@
 require 'action_logic/action_core'
 require 'action_logic/action_validation'
+require 'action_logic/action_benchmark'
 
 module ActionLogic
   module ActionCoordinator
@@ -10,6 +11,7 @@ module ActionLogic
       klass.extend ClassMethods
       klass.extend ActionLogic::ActionCore::ClassMethods
       klass.extend ActionLogic::ActionValidation::ClassMethods
+      klass.extend ActionLogic::ActionBenchmark::ClassMethods
     end
 
     module ClassMethods

data/lib/action_logic/action_core.rb

@@ -17,6 +17,12 @@ module ActionLogic
 
     module ClassMethods
       def around(params, &block)
+        with_benchmark(self) do
+          execute!(params, &block)
+        end
+      end
+
+      def execute!(params, &block)
         execution_context = self.new(params)
 
         return execution_context.context if execution_context.break?

data/lib/action_logic/action_task.rb

@@ -1,5 +1,6 @@
 require 'action_logic/action_core'
 require 'action_logic/action_validation'
+require 'action_logic/action_benchmark'
 
 module ActionLogic
   module ActionTask
@@ -10,6 +11,7 @@ module ActionLogic
       klass.extend ClassMethods
       klass.extend ActionLogic::ActionCore::ClassMethods
       klass.extend ActionLogic::ActionValidation::ClassMethods
+      klass.extend ActionLogic::ActionBenchmark::ClassMethods
     end
 
     module ClassMethods

data/lib/action_logic/action_use_case.rb

@@ -1,5 +1,6 @@
 require 'action_logic/action_core'
 require 'action_logic/action_validation'
+require 'action_logic/action_benchmark'
 
 module ActionLogic
   module ActionUseCase
@@ -10,6 +11,7 @@ module ActionLogic
       klass.extend ClassMethods
       klass.extend ActionLogic::ActionCore::ClassMethods
       klass.extend ActionLogic::ActionValidation::ClassMethods
+      klass.extend ActionLogic::ActionBenchmark::ClassMethods
     end
 
     module ClassMethods

data/lib/action_logic/version.rb

@@ -1,3 +1,3 @@
 module ActionLogic
-  VERSION = '0.2.1'
+  VERSION = '0.2.2'
 end

data/spec/action_logic/action_configuration_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+require 'action_logic'
+
+module ActionLogic
+  describe ActionConfiguration do
+    subject { described_class }
+
+    before do
+      described_class.reset!
+    end
+
+    context "benchmark" do
+      it "defaults the benchmark configuration option to false" do
+        expect(described_class.benchmark?).to be_falsey
+      end
+
+      it "returns true when the benchmark configuration option is set to true" do
+        described_class.configure do |config|
+          config.benchmark = true
+        end
+
+        expect(described_class.benchmark?).to be_truthy
+      end
+    end
+
+    context "benchmark_log" do
+      it "defaults benchmark log file to stdout" do
+        expect(described_class.benchmark_log).to eq($stdout)
+      end
+
+      it "returns the log file when the benchmark log configuration option is set" do
+        temp_file = Object.new
+
+        described_class.configure do |config|
+          config.benchmark_log = temp_file
+        end
+
+        expect(described_class.benchmark_log).to eq(temp_file)
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: action_logic
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Rick Winfrey
@@ -79,6 +79,8 @@ files:
 - README.md
 - action_logic.gemspec
 - lib/action_logic.rb
+- lib/action_logic/action_benchmark.rb
+- lib/action_logic/action_configuration.rb
 - lib/action_logic/action_context.rb
 - lib/action_logic/action_coordinator.rb
 - lib/action_logic/action_core.rb
@@ -92,6 +94,7 @@ files:
 - resources/action_use_case_diagram.png
 - resources/diagrams.sketch
 - resources/overview_diagram.png
+- spec/action_logic/action_configuration_spec.rb
 - spec/action_logic/action_context_spec.rb
 - spec/action_logic/action_coordinator_spec.rb
 - spec/action_logic/action_task_spec.rb
@@ -127,6 +130,7 @@ signing_key:
 specification_version: 4
 summary: Business logic abstraction
 test_files:
+- spec/action_logic/action_configuration_spec.rb
 - spec/action_logic/action_context_spec.rb
 - spec/action_logic/action_coordinator_spec.rb
 - spec/action_logic/action_task_spec.rb