dsl_compose 2.5.2 → 2.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9530f024d2b46df98c44f9a5835a9a2492d8ed61af9542e36482323295aed93a
-  data.tar.gz: 241b93305870e0a6e205f3535df506b89b4a548c5d202e94b6242c6e5952a937
+  metadata.gz: 5ab97e49cd1581273bc3555e75d7610cab0764024f5c87445cf7da2f48af97d4
+  data.tar.gz: bc8e659445fad939868276749ae23c8e5cd3a44d7afb45989d4cd5dac4b487a2
 SHA512:
-  metadata.gz: d025d6a6245c6e9e93f9727b7dde6cc7fd5ac66684bd3d17ba6c952b876aa3a6f41deb9d383324f7a5f7f3f32685be5b0f034fd6351e5852ea4064f0a8912019
-  data.tar.gz: 79c467dde765e402b90439d003ef00c5509d0b50658d41ada8c6c344ee4fb986e68c679b7cfb643d0bf90255f41a505a1e65706f1adec7fe7aa38d74b6295818
+  metadata.gz: 3e7e18eec99d3b458d1a03e5a9feff3aad70696318d706bf17064646ceeb152d45f4b0b954aef83cb5edcf501502d76821a44c2da58f88d60a91cba31ae18c70
+  data.tar.gz: 8412d42847af88966b8e523ccda0c37f2724d71c319b244cb1a1f206694899b0cad65e5aaf48d9252e597dd9c1afc8ae50f3bc13e6d4b0459669340f7d242dbb

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [2.6.1](https://github.com/craigulliott/dsl_compose/compare/v2.6.0...v2.6.1) (2023-08-29)
+
+
+### Bug Fixes
+
+* renaming `description` to `add_documentation` for dynamically creating documentation from within parsers ([3e24194](https://github.com/craigulliott/dsl_compose/commit/3e2419492e61d94ea7d3c1f34ef4990fc0f6682a))
+
+## [2.6.0](https://github.com/craigulliott/dsl_compose/compare/v2.5.2...v2.6.0) (2023-08-23)
+
+
+### Features
+
+* optionally request an object containing all the dsl and dsl method args from within the parser ([8abfd64](https://github.com/craigulliott/dsl_compose/commit/8abfd64131e37f620a9443466028c5a81b6f5377))
+
 ## [2.5.2](https://github.com/craigulliott/dsl_compose/compare/v2.5.1...v2.5.2) (2023-08-17)
 
 

data/lib/dsl_compose/interpreter/execution/arguments.rb

@@ -148,7 +148,6 @@ module DSLCompose
               else
                 optional_arg_value
               end
-
             rescue => e
               raise e, "Error processing optional argument #{optional_argument_name}: #{e.message}", e.backtrace
             end
@@ -239,7 +238,6 @@ module DSLCompose
             else
               required_arg_value
             end
-
           rescue => e
             raise e, "Error processing required argument #{argument_name}: #{e.message}", e.backtrace
           end

data/lib/dsl_compose/interpreter/execution/method_calls.rb

@@ -14,12 +14,12 @@ module DSLCompose
           @method_calls.filter { |mc| mc.method_name == method_name }.any?
         end
 
-        def add_method_call dsl_method, *args, &block
+        def add_method_call(dsl_method, ...)
           # make sure we always have a variable which can be used in the exception message
           dsl_method_name = nil
           dsl_method_name = dsl_method.name
 
-          method_call = MethodCall.new(dsl_method, *args, &block)
+          method_call = MethodCall.new(dsl_method, ...)
           @method_calls << method_call
           method_call
         rescue => e

data/lib/dsl_compose/interpreter/execution.rb

@@ -59,7 +59,7 @@ module DSLCompose
       private
 
       # catch and process any method calls within the DSL block
-      def method_missing method_name, *args, &block
+      def method_missing(method_name, ...)
         # if the method does not exist, then this will raise a MethodDoesNotExistError
         dsl_method = @dsl.dsl_method method_name
 
@@ -68,7 +68,7 @@ module DSLCompose
           raise MethodIsUniqueError, "This method `#{method_name}` is unique and can only be called once within this DSL"
         end
 
-        @method_calls.add_method_call dsl_method, *args, &block
+        @method_calls.add_method_call(dsl_method, ...)
       end
 
       def respond_to_missing?(method_name, *args)

data/lib/dsl_compose/interpreter.rb

@@ -40,14 +40,14 @@ module DSLCompose
     # 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
+    def execute_dsl(klass, dsl, ...)
       # make sure we have these variables for the exception message below
       class_name = nil
       class_name = klass.name
       dsl_name = nil
       dsl_name = dsl.name
 
-      execution = Execution.new(klass, dsl, *args, &block)
+      execution = Execution.new(klass, dsl, ...)
       @executions << execution
       execution
     rescue => e

data/lib/dsl_compose/parser/for_children_of_parser/for_dsl_parser/for_method_parser.rb

@@ -83,6 +83,17 @@ module DSLCompose
                   end
                 end
 
+                # a hash representation of all the method arguments, if requested
+                if BlockArguments.accepts_argument?(:method_arguments, &block)
+                  args[:method_arguments] = {}
+                  # process each argument, because we might need to coerce it
+                  method_call.arguments.arguments.each do |name, value|
+                    # if this value is a ClassCoerce object, then convert it from its original
+                    # string value to a class
+                    args[:method_arguments][name] = value.is_a?(ClassCoerce) ? value.to_class : value
+                  end
+                end
+
                 # set the method_call in an instance variable so that method calls to `description`
                 # from within the block will have access to it
                 @method_call = method_call
@@ -96,8 +107,8 @@ module DSLCompose
           # takes a description of what this parser does and stores it against the DSL definition
           # of the current @child_class, this is used to generate documentation for what the parser
           # has done with the DSL
-          def description description
-            @method_call.add_parser_usage_note description
+          def add_documentation documentation
+            @method_call.add_parser_usage_note documentation
           end
         end
       end

data/lib/dsl_compose/parser/for_children_of_parser/for_dsl_parser.rb

@@ -67,14 +67,28 @@ module DSLCompose
               # us to use keyword arguments to force a naming convention on these arguments
               # and to validate their use
               args = {}
+
               # the dsl name (if it's requested)
               if BlockArguments.accepts_argument?(:dsl_name, &block)
                 args[:dsl_name] = dsl_execution.dsl.name
               end
+
+              # a hash representation of all the dsl arguments, if requested
+              if BlockArguments.accepts_argument?(:dsl_arguments, &block)
+                args[:dsl_arguments] = {}
+                # process each argument, because we might need to coerce it
+                dsl_execution.arguments.arguments.each do |name, value|
+                  # if this value is a ClassCoerce object, then convert it from its original
+                  # string value to a class
+                  args[:dsl_arguments][name] = value.is_a?(ClassCoerce) ? value.to_class : value
+                end
+              end
+
               # an ExecutionReader object to access the exections methods (if it's requested)
               if BlockArguments.accepts_argument?(:reader, &block)
                 args[:reader] = Reader::ExecutionReader.new(dsl_execution)
               end
+
               # add any arguments that were provided to the DSL
               dsl_execution.arguments.arguments.each do |name, value|
                 if BlockArguments.accepts_argument?(name, &block)
@@ -83,6 +97,7 @@ module DSLCompose
                   args[name] = value.is_a?(ClassCoerce) ? value.to_class : value
                 end
               end
+
               # set the dsl_execution in an instance variable so that method calls to `for_method`
               # from within the block will have access to it
               @dsl_execution = dsl_execution
@@ -127,8 +142,8 @@ module DSLCompose
         # takes a description of what this parser does and stores it against the DSL definition
         # of the current @child_class, this is used to generate documentation for what the parser
         # has done with the DSL
-        def description description
-          @dsl_execution.add_parser_usage_note description
+        def add_documentation documentation
+          @dsl_execution.add_parser_usage_note documentation
         end
       end
     end

data/lib/dsl_compose/parser/for_children_of_parser.rb

@@ -125,8 +125,8 @@ module DSLCompose
       # takes a description of what this parser does and stores it against the DSL definition
       # of the current @child_class, this is used to generate documentation for what the parser
       # has done with the DSL
-      def description description
-        @base_class.dsls.add_parser_usage_note @child_class, description
+      def add_documentation documentation
+        @base_class.dsls.add_parser_usage_note @child_class, documentation
       end
     end
   end

data/lib/dsl_compose/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DSLCompose
-  VERSION = "2.5.2"
+  VERSION = "2.6.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dsl_compose
 version: !ruby/object:Gem::Version
-  version: 2.5.2
+  version: 2.6.1
 platform: ruby
 authors:
 - Craig Ulliott
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-17 00:00:00.000000000 Z
+date: 2023-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: class_spec_helper