dsl_compose 2.6.0 → 2.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '048f2e5d2e94df09db474b6134cacb580dde9a88a751e2e0697d72234be0132e'
-  data.tar.gz: b336eb45f722b2fbafb0f12f43d760ad1de2287eb9beffc27227d020daf5cc43
+  metadata.gz: 5ab97e49cd1581273bc3555e75d7610cab0764024f5c87445cf7da2f48af97d4
+  data.tar.gz: bc8e659445fad939868276749ae23c8e5cd3a44d7afb45989d4cd5dac4b487a2
 SHA512:
-  metadata.gz: 412d7f101db06e26ad871a359d7d063a0086b0b2b3e8be2e96cd3b87e69ec1eb7f813c770326779e9b16c166433700b6751ecf9e8b35e568313f8350ed31fd30
-  data.tar.gz: 551f08b45107d633abbcdc008fd13e971c41c317e17ce07e86f0035b2d1ee1ef9ddb6e23b2c1505239279d7f90c1940f22b1d111542ecc51a253b588bb101823
+  metadata.gz: 3e7e18eec99d3b458d1a03e5a9feff3aad70696318d706bf17064646ceeb152d45f4b0b954aef83cb5edcf501502d76821a44c2da58f88d60a91cba31ae18c70
+  data.tar.gz: 8412d42847af88966b8e523ccda0c37f2724d71c319b244cb1a1f206694899b0cad65e5aaf48d9252e597dd9c1afc8ae50f3bc13e6d4b0459669340f7d242dbb

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # 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)
 
 

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

@@ -107,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

@@ -142,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.6.0"
+  VERSION = "2.6.1"
 end

metadata

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