riker 0.1.0.pre5 → 0.1.0.pre6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd3f7e1ef08e3dd6db6362747a86a4adbff4acd42a90bd251bbde583c01d5eca
-  data.tar.gz: 57c823093ded9ae1ec66fa7dcb6741385fd450072aa59eac0cf962ed0e32b74e
+  metadata.gz: bd22e31d55bf8c4144736d6b657463e2550b8a602711adfcc4e8339a164d16c6
+  data.tar.gz: 83b5819f498d4f86f89531f81df7ca845540b108a5cac03274a0fc9d9f0b1ede
 SHA512:
-  metadata.gz: 92ae6575db90c03567fac3aa2b31d7350c1f616c011dc77c4a17c1cbb4cabc7ab2d630ac7a2311a8f6e341e08ec9fc1c26f162db047034f5122407bf0455185c
-  data.tar.gz: 90d6f23aa9224096af1b06a7aaa53a2290e4f125076fedcc58a685829b05e75b68e3d46218842e7ea1d337db01583a149d4f4363a1f7271fec115cbf5ea79f65
+  metadata.gz: 7777cf030f8bf79ceaabd4da1a826b32be8cfcc8be0f32b262d1219839dd1268d24596ad3d83320d5eb6da2f15eb9dd31a870ef3f3d12eea53eec61f8bd27982
+  data.tar.gz: 818646ea533fefd5fe79580127585ed365af10352ee0f467aa84017a967a6afcdb0ed639f3933fc6c371bd0535b57c8d156b9b6d5066f32ea168e2372ed9bfbe

data/README.md

@@ -12,7 +12,7 @@ High-Performance, Dependency-Free Command Pattern For Ruby
 ### In your gemfile:
 
 ```ruby
-gem 'riker', '0.1.0.pre5'
+gem 'riker', '0.1.0.pre6'
 ```
 
 ### In your code:
@@ -95,3 +95,39 @@ CaptainsLog.run!(message: "The Borg are attacking!")
 CaptainsLog.run(message: "We've traveled back in time!", stardate: 42.1337)
 # => "Captain's Log; Stardate: 42.1337\n\nWe've traveled back in time!"
 ```
+
+## Measurement Code
+
+Sometimes you'll want to do some logic around your commands to record
+their performance, number of calls, etc.  Rike allows for this with `around`.
+The result of your measurement code in no way effects the result from
+the command.
+
+```ruby
+module SensorArray
+  class << self
+    # the class and args of the command are provided
+    def deep_scan(klass, args)
+      # anything before code runs
+
+      # code runs here
+      yield
+
+      # anything after you want
+    end
+  end
+end
+
+class CheckWarpDrive
+  extend Riker
+
+  param :stardate
+  param :engineer
+
+  around &SensorArray.method(:deep_scan)
+
+  execute do
+    "WarpDrive checked by #{engineer} on #{stardate}"
+  end
+end
+```

data/lib/riker/command/run_bang_function.rb

@@ -14,6 +14,17 @@ module Riker
 
       # @return [Riker::Command::FunctionDetails]
       def details
+        if command.around_block
+          with_around_function_block
+        else
+          without_around_block_function
+        end
+      end
+
+      private
+
+      # @return [Riker::Command::FunctionDetails]
+      def without_around_block_function
         FunctionDetails.new(<<~RUBY, __FILE__, __LINE__ + 1)
           def self.run!(**arguments)          # def self.run!(**arguments)
             command = new(**arguments)        #   command = new(**arguments)
@@ -25,6 +36,23 @@ module Riker
           end                                 # end
         RUBY
       end
+
+      # @return [Riker::Command::FunctionDetails]
+      def with_around_function_block
+        FunctionDetails.new(<<~RUBY, __FILE__, __LINE__ + 1)
+          def self.run!(**arguments)                            # def self.run!(**arguments)
+            result = nil                                        #   result = nil
+            self.command.around_block.call(self, arguments) do  #   self.command.around_block.call(klass, arguments) do
+              command = new(**arguments)                        #     command = new(**arguments)
+              result = command.execute                          #     result = command.execute
+              if command.errored?                               #     if command.errored?
+                command.errors.raise!                           #       command.errors.raise!
+              end                                               #     end
+            end                                                 #   end
+            result                                              #   result
+          end                                                   # end
+        RUBY
+      end
     end
   end
 end

data/lib/riker/command/run_function.rb

@@ -14,6 +14,16 @@ module Riker
 
       # @return [Riker::Command::FunctionDetails]
       def details
+        if command.around_block
+          with_around_block_function
+        else
+          without_around_block_function
+        end
+      end
+
+      private
+
+      def without_around_block_function
         FunctionDetails.new(<<~RUBY, __FILE__, __LINE__ + 1)
           def self.run(**arguments)                   # def self.run!(**arguments)
             command = new(**arguments)                #   command = new(**arguments)
@@ -26,6 +36,24 @@ module Riker
           end                                         # end
         RUBY
       end
+
+      def with_around_block_function
+        FunctionDetails.new(<<~RUBY, __FILE__, __LINE__ + 1)
+          def self.run(**arguments)                             # def self.run!(**arguments)
+            outcome = nil                                       #   outcome = nil
+            self.command.around_block.call(self, arguments) do  #   self.command.around_block.call(self, arguments) do
+              command = new(**arguments)                        #     command = new(**arguments)
+              result = command.execute                          #     result = command.execute
+              outcome = if command.errored?                     #     outcome = if command.errored?
+                Riker::Outcome.invalid(command.errors)          #       Riker::Outcome.invalid(command.errors)
+              else                                              #     else
+                Riker::Outcome.valid(result)                    #       Riker::Outcome.valid(result)
+              end                                               #     end
+            end                                                 #   end
+            outcome                                             #   outcome
+          end                                                   # end
+        RUBY
+      end
     end
   end
 end

data/lib/riker/command.rb

@@ -22,6 +22,9 @@ module Riker
     # @return [Proc, nil]
     attr_accessor :execute_block
 
+    # @return [Proc, nil]
+    attr_accessor :around_block
+
     def initialize
       @parameters = Parameters.new
       @function_writer = FunctionWriter.new(self)

data/lib/riker/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Riker
-  VERSION = '0.1.0.pre5'
+  VERSION = '0.1.0.pre6'
 end

data/lib/riker.rb

@@ -31,4 +31,11 @@ module Riker
     command.execute_block = block
     command.function_writer.write!(self)
   end
+
+  # @block the logic to run around a command
+  def around(&block)
+    raise Error, "around block already called for #{self}!" if command.around_block
+
+    command.around_block = block
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: riker
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre5
+  version: 0.1.0.pre6
 platform: ruby
 authors:
 - Benjamin Falk
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-21 00:00:00.000000000 Z
+date: 2022-11-01 00:00:00.000000000 Z
 dependencies: []
 description: High-Performance, Dependency-Free Command Pattern For Ruby
 email: