evt-record_invocation 0.0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: adfb4397c17f13ed1113c3691483dc177ab698453211159165fb18d6803dcfae
+  data.tar.gz: ed0b2e87651eb4e475ba5e40d7baa8bb7d9c77bb2f7fbaa2e465a4386fe4ff3b
+SHA512:
+  metadata.gz: 4fef722f260ad10b9538f5a7d97c218141ebd3c4cd988dfd0e409d1276e473496520936c99673757fe3b1637483a0f95cc9eac163b197de14ae41ebc35ed3466
+  data.tar.gz: 2f28cd0c551e6bc8678419d2df04198d4de01da95dab2e6d441b3ec0865ee6845c46f46382e204bbe80ec291fe1d79e8e7fd6ffecfbbba39e9f0817d0cfb9fdc

data/lib/record_invocation/controls/invocation.rb

@@ -0,0 +1,19 @@
+module RecordInvocation
+  module Controls
+    module Invocation
+      def self.example
+        parameters = {}
+        parameters[:some_parameter] = 1
+        parameters[:some_other_parameter] = 11
+
+        invocation = ::Invocation.new(method_name, parameters)
+
+        invocation
+      end
+
+      def self.method_name
+        :some_method
+      end
+    end
+  end
+end

data/lib/record_invocation/controls/recorder.rb

@@ -0,0 +1,56 @@
+module RecordInvocation
+  module Controls
+    module Recorder
+      def self.example
+        Example.new
+      end
+
+      class Example
+        include ::RecordInvocation
+
+        def some_method
+          record_invocation(binding)
+        end
+      end
+
+      module RecordMacro
+        def self.example
+          Example.new
+        end
+
+        class Example
+          include ::RecordInvocation
+
+          record def some_recorded_method(
+            some_parameter,
+            some_optional_parameter=nil,
+            *some_multiple_assignment_parameter,
+            some_keyword_parameter:,
+            some_optional_keyword_parameter: nil,
+            **some_multiple_assignment_keyword_parameter,
+            &some_block
+          )
+            :some_result
+          end
+        end
+
+        module IgnoredParameters
+          def self.example
+            Example.new
+          end
+
+          class Example
+            include ::RecordInvocation
+
+            record def some_recorded_method(
+              *,
+              **,
+              &
+            )
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/record_invocation/controls.rb

@@ -0,0 +1,2 @@
+require 'record_invocation/controls/recorder'
+require 'record_invocation/controls/invocation'

data/lib/record_invocation/record_invocation.rb

@@ -0,0 +1,153 @@
+module RecordInvocation
+  Error = ::Class.new(RuntimeError)
+
+  def self.included(cls)
+    cls.class_exec do
+      extend Record
+    end
+  end
+
+  def __records
+    @__records ||= []
+  end
+  alias :records :__records
+
+  def __record(invocation)
+    __records << invocation
+    records
+  end
+  alias :record :__record
+
+  def __record_invocation(invocation_or_binding)
+    if invocation_or_binding.is_a?(Binding)
+      invocation = Invocation.build(invocation_or_binding)
+    end
+
+    __record(invocation)
+    invocation
+  end
+  alias :record_invocation :__record_invocation
+
+  def __invocation(method_name, **parameters)
+    strict = parameters.delete(:strict)
+    strict ||= false
+
+    invocations = __invocations(method_name, **parameters)
+
+    if invocations.empty?
+      return nil
+    end
+
+    if strict && invocations.length > 1
+      raise Error, "More than one invocation record matches (Method Name: #{method_name.inspect}, Parameters: #{parameters.inspect})"
+    end
+
+    invocations.first
+  end
+  alias :invocation :__invocation
+
+  def __one_invocation(method_name, **parameters)
+    parameters[:strict] = true
+    __invocation(method_name, **parameters)
+  end
+  alias :one_invocation :__one_invocation
+
+  def __invocations(method_name=nil, **parameters)
+    if method_name.nil? && parameters.empty?
+      return __records
+    end
+
+    invocations = __records.select { |invocation| invocation.method_name == method_name }
+
+    if parameters.nil?
+      return invocations
+    end
+
+    if invocations.empty?
+      return []
+    end
+
+    invocations = invocations.select do |invocation|
+      parameters.all? do |match_parameter_name, match_parameter_value|
+        invocation_value = invocation.arguments[match_parameter_name]
+
+        invocation_value == match_parameter_value
+      end
+    end
+
+    invocations
+  end
+  alias :invocations :__invocations
+
+  def __invoked?(method_name=nil, **parameters)
+    if method_name.nil? && parameters.empty?
+      return !__records.empty?
+    end
+
+    if not parameters.key?(:strict)
+      parameters[:strict] = false
+    end
+
+    invocation = __invocation(method_name, **parameters)
+    !invocation.nil?
+  end
+  alias :invoked? :__invoked?
+
+  def __invoked_once?(method_name, **parameters)
+    parameters[:strict] = true
+    __invoked?(method_name, **parameters)
+  end
+  alias :invoked_once? :__invoked_once?
+
+  module Record
+    def record_module
+      @record_module ||= prepend_record_module
+    end
+
+    def prepend_record_module
+      mod = Module.new
+      prepend mod
+      mod
+    end
+
+    def record_macro(method_name, &blk)
+      record_module.define_method(method_name) do |*args, **kwargs, &block|
+        parameters = method(method_name).super_method.parameters
+
+        positional_arguments = args.dup
+        keyword_arguments = kwargs.dup
+
+        arguments = {}
+
+        parameters.each do |type, name|
+          case type
+          when :req, :opt
+            if positional_arguments.any?
+              arguments[name] = positional_arguments.shift
+            end
+          when :rest
+            if positional_arguments.any?
+              arguments[name] = positional_arguments
+            end
+          when :key, :keyreq
+            if keyword_arguments.key?(name)
+              arguments[name] = keyword_arguments.delete(name)
+            end
+          when :keyrest
+            arguments[name] = keyword_arguments
+          when :block
+            if not block.nil?
+              arguments[name] = block
+            end
+          end
+        end
+
+        invocation = Invocation.new(method_name, arguments)
+        __record(invocation)
+
+        super(*args, **kwargs, &block)
+      end
+    end
+    alias :record :record_macro
+  end
+end

data/lib/record_invocation.rb

@@ -0,0 +1,3 @@
+require 'invocation'
+
+require 'record_invocation/record_invocation'

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: evt-record_invocation
+version: !ruby/object:Gem::Version
+  version: 0.0.0.0
+platform: ruby
+authors:
+- The Eventide Project
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-07-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: evt-invocation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: test_bench
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: " "
+email: opensource@eventide-project.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/record_invocation.rb
+- lib/record_invocation/controls.rb
+- lib/record_invocation/controls/invocation.rb
+- lib/record_invocation/controls/recorder.rb
+- lib/record_invocation/record_invocation.rb
+homepage: https://github.com/eventide-project/record-invocation
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.6
+signing_key:
+specification_version: 4
+summary: Record method invocations, query method invocations, and use predicates to
+  verify a method's invocation
+test_files: []