dsl_compose 2.3.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4fab8958e567edd7044bfef529f74c21930c7c1fba06bfd359d905249fc2d17c
-  data.tar.gz: a167ad2aaaf44b226b2884ee0f4d6447444ebe0629453ca5f288430c5198e683
+  metadata.gz: 6b29a5bddf2a3f304e22318d9ef0d2f1dc9efbb195618b1b296f33affff3d4b0
+  data.tar.gz: 06141a53c94fdfa21265df75594b627e30dd37d13d2943e83dda5cad29de9de4
 SHA512:
-  metadata.gz: fcd2f5ff1b501cffd445d937f4a96e158250e8e76e48969d54760511dc339dc90e0d7d1d3f4f2ed5a14ffc0eafe037a8833122a0f649c071a8188e1819901bb4
-  data.tar.gz: e1df9014ea4b8a20db709e44284ce320a92808085aee70004a4bac19609fad866f271426e2e86c7ec46919f21795f55c91411b1404f73cfd0349544ef71ee408
+  metadata.gz: 8f605f57dbf60fb77e7633d4631d7c5423d9614e28cce18e9e05fcca637d0b35b49b1d71c504d50289d527019c48f5a0a96588ab9cb25ba5d1c651c4ae6570f8
+  data.tar.gz: 19619027a3a21f8506cd077a927a719284b378d5d4cb2f2f11d5264a487442c2f44da2a1780684603a0154348c89c2359459b776077380da8f3a1093a15a72b6

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [2.5.0](https://github.com/craigulliott/dsl_compose/compare/v2.4.0...v2.5.0) (2023-08-01)
+
+
+### Features
+
+* you can call validators which accept arrays (such as `validate_in`) multiple times and they will be combined ([e1b4411](https://github.com/craigulliott/dsl_compose/commit/e1b441176768726cecd828e303781a57d4e36750))
+
+## [2.4.0](https://github.com/craigulliott/dsl_compose/compare/v2.3.0...v2.4.0) (2023-07-31)
+
+
+### Features
+
+* access an ExecutionReader object from within a parser ([53e9c29](https://github.com/craigulliott/dsl_compose/commit/53e9c29073389217d8526c43eec67325587c45b9))
+
 ## [2.3.0](https://github.com/craigulliott/dsl_compose/compare/v2.2.2...v2.3.0) (2023-07-28)
 
 

data/README.md

@@ -274,8 +274,13 @@ class MyParser < DSLCompose::Parser
     # then the requested dsl argument must be present on all DSLs otherwise an
     # error will be raised. The parser is aware of class inheritance, and will
     # consider a DSL to have been executed on the actual class it was used, and
-    # any classes which are descendants of that class
-    for_dsl [:dsl1, :dsl2] do |dsl_name:, a_dsl_argument:|
+    # any classes which are descendants of that class.
+    #
+    # You can also request an ExecutionReader object here by including the
+    # argument `:reader`. The resulting reader object will allow to to access the methods
+    # which were called within this use of your DSL. There is more documentation about
+    # Reader classes below.
+    for_dsl [:dsl1, :dsl2] do |dsl_name:, a_dsl_argument:, reader:|
       description <<-DESCRIPTION
         You can optionally provide a description of anything specific that your parser
         does in this block, this description will be used when generating documentation.

data/lib/dsl_compose/dsl/arguments/argument/end_with_validation.rb

@@ -12,6 +12,11 @@ module DSLCompose
           end
 
           def initialize values
+            @values = []
+            add_values values
+          end
+
+          def add_values values
             # if the provided values is a symbol, then convert it to an array
             if values.is_a? Symbol
               values = [values]
@@ -27,7 +32,7 @@ module DSLCompose
               raise ValidationFailedError, "The value `#{values}` provided to this validator must be a Symbol or an Array of Symbols"
             end
 
-            @values = values
+            @values += values
           end
 
           def validate! value

data/lib/dsl_compose/dsl/arguments/argument/in_validation.rb

@@ -12,11 +12,16 @@ module DSLCompose
           end
 
           def initialize values
+            @values = []
+            add_values values
+          end
+
+          def add_values values
             unless values.is_a?(Array)
               raise InvalidValueError, "The value `#{values}` provided to this validator must be of type Array"
             end
 
-            @values = values
+            @values += values
           end
 
           def validate! value

data/lib/dsl_compose/dsl/arguments/argument/not_end_with_validation.rb

@@ -12,6 +12,11 @@ module DSLCompose
           end
 
           def initialize values
+            @values = []
+            add_values values
+          end
+
+          def add_values values
             # if the provided values is a symbol, then convert it to an array
             if values.is_a? Symbol
               values = [values]
@@ -27,7 +32,7 @@ module DSLCompose
               raise ValidationFailedError, "The value `#{values}` provided to this validator must be a Symbol or an Array of Symbols"
             end
 
-            @values = values
+            @values += values
           end
 
           def validate! value

data/lib/dsl_compose/dsl/arguments/argument/not_in_validation.rb

@@ -12,11 +12,16 @@ module DSLCompose
           end
 
           def initialize values
+            @values = []
+            add_values values
+          end
+
+          def add_values values
             unless values.is_a?(Array)
               raise InvalidValueError, "The value `#{values}` provided to this validator must be of type Array"
             end
 
-            @values = values
+            @values += values
           end
 
           def validate! value

data/lib/dsl_compose/dsl/arguments/argument/not_start_with_validation.rb

@@ -12,6 +12,11 @@ module DSLCompose
           end
 
           def initialize values
+            @values = []
+            add_values values
+          end
+
+          def add_values values
             # if the provided values is a symbol, then convert it to an array
             if values.is_a? Symbol
               values = [values]
@@ -27,7 +32,7 @@ module DSLCompose
               raise ValidationFailedError, "The value `#{values}` provided to this validator must be a Symbol or an Array of Symbols"
             end
 
-            @values = values
+            @values += values
           end
 
           def validate! value

data/lib/dsl_compose/dsl/arguments/argument/start_with_validation.rb

@@ -12,6 +12,11 @@ module DSLCompose
           end
 
           def initialize values
+            @values = []
+            add_values values
+          end
+
+          def add_values values
             # if the provided values is a symbol, then convert it to an array
             if values.is_a? Symbol
               values = [values]
@@ -27,7 +32,7 @@ module DSLCompose
               raise ValidationFailedError, "The value `#{values}` provided to this validator must be a Symbol or an Array of Symbols"
             end
 
-            @values = values
+            @values += values
           end
 
           def validate! value

data/lib/dsl_compose/dsl/arguments/argument.rb

@@ -230,10 +230,6 @@ module DSLCompose
         end
 
         def validate_in values
-          if @in_validation
-            raise ValidationAlreadyExistsError, "The validation `in` has already been applied to this method option."
-          end
-
           unless values.is_a? Array
             raise ValidationInvalidArgumentError, values
           end
@@ -242,14 +238,15 @@ module DSLCompose
             raise ValidationIncompatibleError, "The validation type #{@type} is not compatible with this argument type"
           end
 
-          @in_validation = InValidation.new values
+          # if this validation has already been applied, then add the values to the existing validation
+          if @in_validation
+            @in_validation.add_values values
+          else
+            @in_validation = InValidation.new values
+          end
         end
 
         def validate_not_in values
-          if @not_in_validation
-            raise ValidationAlreadyExistsError, "The validation `not_in` has already been applied to this method option."
-          end
-
           unless values.is_a? Array
             raise ValidationInvalidArgumentError, values
           end
@@ -258,14 +255,15 @@ module DSLCompose
             raise ValidationIncompatibleError, "The validation type #{@type} is not compatible with this argument type"
           end
 
-          @not_in_validation = NotInValidation.new values
+          # if this validation has already been applied, then add the values to the existing validation
+          if @not_in_validation
+            @not_in_validation.add_values values
+          else
+            @not_in_validation = NotInValidation.new values
+          end
         end
 
         def validate_end_with value
-          if @end_with_validation
-            raise ValidationAlreadyExistsError, "The validation `end_with` has already been applied to this method option."
-          end
-
           unless value.is_a?(Symbol) || (value.is_a?(Array) && value.all? { |value| value.is_a? Symbol })
             raise ValidationInvalidArgumentError, "The value `#{value}` provided to this validator must be a Symbol or an Array of Symbols"
           end
@@ -274,14 +272,15 @@ module DSLCompose
             raise ValidationIncompatibleError, "The validation type #{@type} is not compatible with this argument type"
           end
 
-          @end_with_validation = EndWithValidation.new value
+          # if this validation has already been applied, then add the values to the existing validation
+          if @end_with_validation
+            @end_with_validation.add_values value
+          else
+            @end_with_validation = EndWithValidation.new value
+          end
         end
 
         def validate_not_end_with value
-          if @not_end_with_validation
-            raise ValidationAlreadyExistsError, "The validation `not_end_with` has already been applied to this method option."
-          end
-
           unless value.is_a?(Symbol) || (value.is_a?(Array) && value.all? { |value| value.is_a? Symbol })
             raise ValidationInvalidArgumentError, "The value `#{value}` provided to this validator must be a Symbol or an Array of Symbols"
           end
@@ -290,14 +289,15 @@ module DSLCompose
             raise ValidationIncompatibleError, "The validation type #{@type} is not compatible with this argument type"
           end
 
-          @not_end_with_validation = NotEndWithValidation.new value
+          # if this validation has already been applied, then add the values to the existing validation
+          if @not_end_with_validation
+            @not_end_with_validation.add_values value
+          else
+            @not_end_with_validation = NotEndWithValidation.new value
+          end
         end
 
         def validate_start_with value
-          if @start_with_validation
-            raise ValidationAlreadyExistsError, "The validation `start_with` has already been applied to this method option."
-          end
-
           unless value.is_a?(Symbol) || (value.is_a?(Array) && value.all? { |value| value.is_a? Symbol })
             raise ValidationInvalidArgumentError, "The value `#{value}` provided to this validator must be a Symbol or an Array of Symbols"
           end
@@ -306,14 +306,15 @@ module DSLCompose
             raise ValidationIncompatibleError, "The validation type #{@type} is not compatible with this argument type"
           end
 
-          @start_with_validation = StartWithValidation.new value
+          # if this validation has already been applied, then add the values to the existing validation
+          if @start_with_validation
+            @start_with_validation.add_values value
+          else
+            @start_with_validation = StartWithValidation.new value
+          end
         end
 
         def validate_not_start_with value
-          if @not_start_with_validation
-            raise ValidationAlreadyExistsError, "The validation `not_start_with` has already been applied to this method option."
-          end
-
           unless value.is_a?(Symbol) || (value.is_a?(Array) && value.all? { |value| value.is_a? Symbol })
             raise ValidationInvalidArgumentError, "The value `#{value}` provided to this validator must be a Symbol or an Array of Symbols"
           end
@@ -322,7 +323,12 @@ module DSLCompose
             raise ValidationIncompatibleError, "The validation type #{@type} is not compatible with this argument type"
           end
 
-          @not_start_with_validation = NotStartWithValidation.new value
+          # if this validation has already been applied, then add the values to the existing validation
+          if @not_start_with_validation
+            @not_start_with_validation.add_values value
+          else
+            @not_start_with_validation = NotStartWithValidation.new value
+          end
         end
 
         def validate_length maximum: nil, minimum: nil, is: nil

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

@@ -67,9 +67,14 @@ 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
+              # 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)

data/lib/dsl_compose/version.rb

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

metadata

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