dsl_compose 1.0.0 → 1.2.0

data/lib/dsl_compose/interpreter/execution.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module DSLCompose
+  class Interpreter
+    class Execution
+      class MethodIsUniqueError < StandardError
+        def message
+          "This method is unique and can only be called once within this DSL"
+        end
+      end
+
+      class RequiredMethodNotCalledError < StandardError
+        def message
+          "This method is required, but was not called within this DSL"
+        end
+      end
+
+      attr_reader :dsl
+      attr_reader :klass
+      attr_reader :method_calls
+      attr_reader :arguments
+
+      # execute/process a dynamically defined DSL
+      def initialize klass, dsl, *args, &block
+        @klass = klass
+        @dsl = dsl
+        @method_calls = MethodCalls.new
+        @arguments = Arguments.new(dsl.arguments, *args)
+
+        # dynamically process the DSL by calling the provided block
+        # all methods executions will be caught and processed by the method_missing method below
+        if block
+          instance_eval(&block)
+        end
+
+        # assert that all required methods have been called at least once
+        dsl.required_dsl_methods.each do |dsl_method|
+          unless @method_calls.method_called? dsl_method.name
+            raise RequiredMethodNotCalledError
+          end
+        end
+      end
+
+      private
+
+      # catch and process any method calls within the DSL block
+      def method_missing method_name, *args, &block
+        # if the method does not exist, then this will raise a MethodDoesNotExistError
+        dsl_method = @dsl.dsl_method method_name
+
+        # if the method is unique, then it can only be called once per DSL
+        if dsl_method.unique? && @method_calls.method_called?(method_name)
+          raise MethodIsUniqueError
+        end
+
+        @method_calls.add_method_call dsl_method, *args, &block
+      end
+
+      def respond_to_missing?(method_name, *args)
+        @dsl.has_dsl_method? method_name
+      end
+    end
+  end
+end

data/lib/dsl_compose/interpreter.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module DSLCompose
+  # The class is reponsible for parsing and executing a dynamic DSL (dynamic DSLs are
+  # created using the DSLCompose::DSL class).
+  class Interpreter
+    # A dynamic DSL can be used multiple times on the same class, each time the DSL is used
+    # a corresponding execution will be created. The execution contains the resulting configuration
+    # from that particular use of the DSL.
+    attr_reader :executions
+
+    def initialize
+      @executions = []
+    end
+
+    # Execute/process a dynamically defined DSL on a class.
+    # `klass` is the class in which the DSL is being used, not
+    # the class in which the DSL was defined.
+    def execute_dsl klass, dsl, *args, &block
+      execution = Execution.new(klass, dsl, *args, &block)
+      @executions << execution
+      execution
+    end
+
+    # Returns an array of all executions for a given class.
+    def class_executions klass
+      @executions.filter { |e| e.klass == klass }
+    end
+
+    # Returns an array of all executions for a given class.
+    def dsl_executions dsl_name
+      @executions.filter { |e| e.dsl.name == dsl_name }
+    end
+
+    def to_h dsl_name
+      h = {}
+      dsl_executions(dsl_name).each do |execution|
+        h[execution.klass] ||= {
+          arguments: execution.arguments.to_h,
+          method_calls: {}
+        }
+        execution.method_calls.method_calls.each do |method_call|
+          h[execution.klass][:method_calls][method_call.method_name] ||= []
+          h[execution.klass][:method_calls][method_call.method_name] << method_call.to_h
+        end
+      end
+      h
+    end
+  end
+end

data/lib/dsl_compose/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
-module DslCompose
-  VERSION = "1.0.0"
+module DSLCompose
+  VERSION = "1.2.0"
 end

data/lib/dsl_compose.rb

@@ -1,8 +1,39 @@
 # frozen_string_literal: true
 
-require_relative "dsl_compose/version"
+require "dsl_compose/version"
 
-module DslCompose
-  class Error < StandardError; end
-  # Your code goes here...
+require "dsl_compose/dsl/arguments/argument/equal_to_validation"
+require "dsl_compose/dsl/arguments/argument/format_validation"
+require "dsl_compose/dsl/arguments/argument/greater_than_or_equal_to_validation"
+require "dsl_compose/dsl/arguments/argument/greater_than_validation"
+require "dsl_compose/dsl/arguments/argument/in_validation"
+require "dsl_compose/dsl/arguments/argument/length_validation"
+require "dsl_compose/dsl/arguments/argument/less_than_or_equal_to_validation"
+require "dsl_compose/dsl/arguments/argument/less_than_validation"
+require "dsl_compose/dsl/arguments/argument/not_in_validation"
+
+require "dsl_compose/dsl/arguments/argument/interpreter"
+require "dsl_compose/dsl/arguments/argument"
+require "dsl_compose/dsl/arguments"
+
+require "dsl_compose/dsl/dsl_method/interpreter"
+require "dsl_compose/dsl/dsl_method"
+
+require "dsl_compose/dsl/interpreter"
+
+require "dsl_compose/dsl"
+
+require "dsl_compose/interpreter/execution/method_calls/method_call"
+require "dsl_compose/interpreter/execution/method_calls"
+require "dsl_compose/interpreter/execution/arguments"
+require "dsl_compose/interpreter/execution"
+require "dsl_compose/interpreter"
+
+require "dsl_compose/composer"
+
+require "dsl_compose/dsls"
+
+module DSLCompose
+  class Error < StandardError
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dsl_compose
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Craig Ulliott
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-09 00:00:00.000000000 Z
+date: 2023-06-22 00:00:00.000000000 Z
 dependencies: []
 description: Ruby gem to add dynamic DSLs to classes. DSLs are added to classes by
   including the DSLCompose module, and then calling the add_dsl singleton method within
@@ -24,6 +24,29 @@ files:
 - LICENSE.txt
 - README.md
 - lib/dsl_compose.rb
+- lib/dsl_compose/composer.rb
+- lib/dsl_compose/dsl.rb
+- lib/dsl_compose/dsl/arguments.rb
+- lib/dsl_compose/dsl/arguments/argument.rb
+- lib/dsl_compose/dsl/arguments/argument/equal_to_validation.rb
+- lib/dsl_compose/dsl/arguments/argument/format_validation.rb
+- lib/dsl_compose/dsl/arguments/argument/greater_than_or_equal_to_validation.rb
+- lib/dsl_compose/dsl/arguments/argument/greater_than_validation.rb
+- lib/dsl_compose/dsl/arguments/argument/in_validation.rb
+- lib/dsl_compose/dsl/arguments/argument/interpreter.rb
+- lib/dsl_compose/dsl/arguments/argument/length_validation.rb
+- lib/dsl_compose/dsl/arguments/argument/less_than_or_equal_to_validation.rb
+- lib/dsl_compose/dsl/arguments/argument/less_than_validation.rb
+- lib/dsl_compose/dsl/arguments/argument/not_in_validation.rb
+- lib/dsl_compose/dsl/dsl_method.rb
+- lib/dsl_compose/dsl/dsl_method/interpreter.rb
+- lib/dsl_compose/dsl/interpreter.rb
+- lib/dsl_compose/dsls.rb
+- lib/dsl_compose/interpreter.rb
+- lib/dsl_compose/interpreter/execution.rb
+- lib/dsl_compose/interpreter/execution/arguments.rb
+- lib/dsl_compose/interpreter/execution/method_calls.rb
+- lib/dsl_compose/interpreter/execution/method_calls/method_call.rb
 - lib/dsl_compose/version.rb
 homepage: 
 licenses:
@@ -39,7 +62,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="