action_logic 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 583858aebac317fb33f490775442ecad7a40577d
-  data.tar.gz: 839af981a8f86ad9da7de704738dddde65609007
+  metadata.gz: fb4115622aa03370f1c78ca57d8c45670d2c52bf
+  data.tar.gz: f1687c7f429d52c51369d91814cde3927a3eadd2
 SHA512:
-  metadata.gz: 4c039cabbcfac0378afb5d30e9fd942d9ae9fee064c30f6e691526f455f29617a8c24ea7e765deb2edfb2878a153347b0ba762836a40a6ed89a3eb5404b6fc75
-  data.tar.gz: a0cd7c262dc94adcd317db9d624621a3065bb0ac74c5a460a8ed331f29548f2b3aac2ad1649f1e2c6e8cbc74e67080413ae1ac244bf1c053fb99f6d4a0bd12c6
+  metadata.gz: 65e4f68bd7c54c1a838fdd81f399c9031c25a1409c423ad622d68203cbde71532f27b6df86a2c50437d6c0d23d360938df536b6593c550ce4580ea3302ac1054
+  data.tar.gz: 453fa766e4778a577fcea58ffdfc2c59b8fb256ca42322136874926f1f5bf56748aa9fc79998edbbaff6eec696c7e942e91d6b3e6034d7c13c3ca72580b5d171

data/.gitignore

@@ -1,2 +1,3 @@
 coverage/
 *.gem
+benchmark.log

data/Gemfile.lock

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

data/lib/action_logic.rb

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

data/lib/action_logic/action_benchmark.rb

@@ -1,19 +1,38 @@
+require 'benchmark'
+
 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)
+      def with_benchmark(execution_context, &block)
+        if benchmark?
+          benchmark_result, context = benchmark!(&block)
+          log!(benchmark_result, execution_context)
           context
         else
           block.call
         end
       end
-    end
 
+      private
+
+      def benchmark?
+        ActionConfiguration.benchmark?
+      end
+
+      def benchmark!(&block)
+        context = nil
+        benchmark_result  = Benchmark.measure { context = block.call }
+        [benchmark_result, context]
+      end
+
+      def log!(benchmark_result, execution_context)
+        benchmark_formatter.send(execution_context.__private__type, benchmark_result, execution_context.name)
+      end
+
+      def benchmark_formatter
+        ActionConfiguration.benchmark_formatter
+      end
+    end
   end
 end

data/lib/action_logic/action_benchmark/default_formatter.rb

@@ -0,0 +1,30 @@
+module ActionLogic
+  module ActionBenchmark
+    class DefaultFormatter
+      def initialize(benchmark_log: ActionConfiguration.benchmark_log)
+        @benchmark_log = benchmark_log
+      end
+
+      def format(benchmark_result, context_name)
+        benchmark_log.printf("%-10s %-50s %-10s %-10f %-10s %-10f %-10s %-10f %-10s %-10f\n",
+                             "context:",
+                             context_name,
+                             "user_time:",
+                             benchmark_result.utime,
+                             "system_time:",
+                             benchmark_result.stime,
+                             "total_time:",
+                             benchmark_result.total,
+                             "real_time:",
+                             benchmark_result.real)
+      end
+
+      alias_method :coordinator, :format
+      alias_method :use_case, :format
+      alias_method :task, :format
+
+      private
+      attr_reader :benchmark_log
+    end
+  end
+end

data/lib/action_logic/action_configuration.rb

@@ -18,8 +18,23 @@ module ActionLogic
       configuration_options.benchmark_log || $stdout
     end
 
+    def self.benchmark_formatter
+      custom_benchmark_formatter || default_formatter
+    end
+
     def self.reset!
       @configuration_options = OpenStruct.new
+      @custom_benchmark_formatter = nil
+      @default_formatter = nil
+    end
+
+    def self.custom_benchmark_formatter
+      @custom_benchmark_formatter ||= configuration_options.benchmark_formatter &&
+        configuration_options.benchmark_formatter.new
+    end
+
+    def self.default_formatter
+      @default_formatter ||= ::ActionLogic::ActionBenchmark::DefaultFormatter.new
     end
   end
 end

data/lib/action_logic/action_coordinator.rb

@@ -33,6 +33,10 @@ module ActionLogic
           execution_context.context
         end
       end
+
+      def __private__type
+        :coordinator
+      end
     end
   end
 end

data/lib/action_logic/action_task.rb

@@ -15,6 +15,10 @@ module ActionLogic
           execution_context.context
         end
       end
+
+      def __private__type
+        :task
+      end
     end
   end
 end

data/lib/action_logic/action_use_case.rb

@@ -21,6 +21,10 @@ module ActionLogic
           end
         end
       end
+
+      def __private__type
+        :use_case
+      end
     end
   end
 end

data/lib/action_logic/version.rb

@@ -1,3 +1,3 @@
 module ActionLogic
-  VERSION = '0.2.3'
+  VERSION = '0.2.4'
 end

data/spec/action_logic/action_benchmark/default_formatter_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+module ActionLogic::ActionBenchmark
+  describe DefaultFormatter do
+
+    let(:benchmark_log) { StringIO.new }
+    let(:benchmark_result) { double(:benchmark_result, utime: 0.00003, stime: 0.00002, total: 0.00001, real: 0.00030) }
+
+    subject { described_class.new(benchmark_log: benchmark_log) }
+
+    it "writes the benchmark result to the log for an ActionCoordinator" do
+      subject.coordinator(benchmark_result, "CoordinatorContext")
+      expect(benchmark_log.string).to\
+        eq "context:   CoordinatorContext                                 user_time: 0.000030   system_time: 0.000020   total_time: 0.000010   real_time: 0.000300  \n"
+    end
+
+    it "writes the benchmark result to the log for an ActionUseCase" do
+      subject.coordinator(benchmark_result, "UseCaseContext")
+      expect(benchmark_log.string).to\
+        eq "context:   UseCaseContext                                     user_time: 0.000030   system_time: 0.000020   total_time: 0.000010   real_time: 0.000300  \n"
+    end
+
+    it "writes the benchmark result to the log for an ActionTask" do
+      subject.coordinator(benchmark_result, "TaskContext")
+      expect(benchmark_log.string).to\
+        eq "context:   TaskContext                                        user_time: 0.000030   system_time: 0.000020   total_time: 0.000010   real_time: 0.000300  \n"
+    end
+  end
+end

data/spec/action_logic/action_configuration_spec.rb

@@ -5,6 +5,10 @@ module ActionLogic
   describe ActionConfiguration do
     subject { described_class }
 
+    before do
+      described_class.reset!
+    end
+
     after do
       described_class.reset!
     end
@@ -38,5 +42,21 @@ module ActionLogic
         expect(described_class.benchmark_log).to eq(temp_file)
       end
     end
+
+    context "benchmark_formatter" do
+      it "uses default formatter if a custom formatter is not provided" do
+        expect(described_class.benchmark_formatter).to be_a(ActionLogic::ActionBenchmark::DefaultFormatter)
+      end
+
+      it "uses a custom formatter if one is provided" do
+        class CustomFormatter; end
+
+        described_class.configure do |config|
+          config.benchmark_formatter = CustomFormatter
+        end
+
+        expect(described_class.benchmark_formatter).to be_a(CustomFormatter)
+      end
+    end
   end
 end

data/spec/action_logic/action_coordinator_spec.rb

@@ -5,6 +5,10 @@ require 'fixtures/custom_types'
 
 module ActionLogic
   describe ActionCoordinator do
+    it "knows its type" do
+      expect(TestCoordinator1.__private__type).to eq(:coordinator)
+    end
+
     context "no failures and no halts" do
       it "evaluates all use cases defined by the state transition plan" do
         result = TestCoordinator1.execute()

data/spec/action_logic/action_task_spec.rb

@@ -4,6 +4,9 @@ require 'fixtures/tasks'
 
 module ActionLogic
   describe ActionTask do
+    it "knows its type" do
+      expect(SimpleTestTask.__private__type).to eq(:task)
+    end
 
     it "returns an instance of ActionContext" do
       result = SimpleTestTask.execute()

data/spec/action_logic/active_use_case_spec.rb

@@ -5,6 +5,9 @@ require 'fixtures/custom_types'
 
 module ActionLogic
   describe ActionUseCase do
+    it "knows its type" do
+      expect(SimpleTestUseCase.__private__type).to eq(:use_case)
+    end
 
     it "returns an instance of ActionContext" do
       result = SimpleTestUseCase.execute()

data/spec/fixtures/coordinators.rb

@@ -1,6 +1,7 @@
 require 'action_logic'
 require 'fixtures/constants'
 
+# :nocov:
 class TestCoordinator1
   include ActionLogic::ActionCoordinator
 
@@ -562,3 +563,4 @@ class FailureTestTask3
     context.fail!
   end
 end
+# :nocov:

data/spec/fixtures/tasks.rb

@@ -1,7 +1,7 @@
 require 'action_logic'
 require 'fixtures/custom_types'
 require 'fixtures/constants'
-
+# :nocov:
 class SimpleTestTask
   include ActionLogic::ActionTask
 
@@ -284,3 +284,4 @@ class HaltTestTask
     context.halt!(Constants::HALT_MESSAGE)
   end
 end
+# :nocov:

data/spec/fixtures/use_cases.rb

@@ -2,6 +2,7 @@ require 'action_logic'
 require 'fixtures/tasks'
 require 'fixtures/constants'
 
+# :nocov:
 class SimpleTestUseCase
   include ActionLogic::ActionUseCase
 
@@ -416,3 +417,4 @@ class UseCaseHaltTestTask
     context.halt!(Constants::HALT_MESSAGE)
   end
 end
+# :nocov:

data/spec/spec_helper.rb

@@ -9,8 +9,15 @@ $LOAD_PATH << File.join(File.dirname(__FILE__))
 
 require 'action_logic'
 
+if ENV['BENCHMARK']
+  ActionLogic::ActionConfiguration.configure do |config|
+    config.benchmark = true
+    config.benchmark_log = File.open("benchmark.log", "w")
+  end
+end
+
 RSpec.configure do |c|
-  #c.fail_fast = true
+  c.fail_fast = true
   c.color = true
   c.formatter = 'documentation'
   c.order = 'rand'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: action_logic
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Rick Winfrey
@@ -80,6 +80,7 @@ files:
 - action_logic.gemspec
 - lib/action_logic.rb
 - lib/action_logic/action_benchmark.rb
+- lib/action_logic/action_benchmark/default_formatter.rb
 - lib/action_logic/action_configuration.rb
 - lib/action_logic/action_context.rb
 - lib/action_logic/action_coordinator.rb
@@ -99,6 +100,7 @@ files:
 - resources/action_use_case_diagram.png
 - resources/diagrams.sketch
 - resources/overview_diagram.png
+- spec/action_logic/action_benchmark/default_formatter_spec.rb
 - spec/action_logic/action_configuration_spec.rb
 - spec/action_logic/action_context_spec.rb
 - spec/action_logic/action_coordinator_spec.rb
@@ -135,6 +137,7 @@ signing_key:
 specification_version: 4
 summary: Business logic abstraction
 test_files:
+- spec/action_logic/action_benchmark/default_formatter_spec.rb
 - spec/action_logic/action_configuration_spec.rb
 - spec/action_logic/action_context_spec.rb
 - spec/action_logic/action_coordinator_spec.rb