dsl_compose 2.13.1 → 2.14.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 117789e8395652f4823ad048b258d2a683b65328d5817788b9d3d3d7bc377c8b
-  data.tar.gz: d4ad4b7a66de0cfd143006e4c9984bef0ce1c29e6e18b86a0621810cb2d11edb
+  metadata.gz: 7dae8c4f74589b916fbfc6f67f181d58b6e2044aa9eed65a4e26e2e2d05b1fbc
+  data.tar.gz: c9663b356014625a531f22fc093b3f0c0117be81b49a6157b9068b196c4db2dc
 SHA512:
-  metadata.gz: dbcf361a908dcd619664f12e50299f80092d5e2f4e8efb4f53320b2d13c3ca30ef334e429fe1a977fb899c0878f2dd26a30d9b067b74da22198eb2372984d2ad
-  data.tar.gz: 9e932a4d10693634bc25532d9d625ad1939f58c975bf90a0f4a0f1714586bdce5dc1650cf48cbfaa0655c56fbaa341fd27731953e4e3fe74fbefd63619fac6ad
+  metadata.gz: 7e6ccea99702dc7e02344b4dfe169433b61a363e6ea0d3c3bf4abae0c531c240e4a37a68e384e5d9b7b96a63438e768b3b8beb2ae37fc657ffd141ff80e707b1
+  data.tar.gz: 2eec3427dc377746dce4e708a6c2c1d12bcb6ec94637ae9f425810d7b5665b90e51178b62ff0ce6d0f22409697c7611e3c363bb636d4f8f9a88ae990c39ddfcb

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [2.14.1](https://github.com/craigulliott/dsl_compose/compare/v2.14.0...v2.14.1) (2023-09-11)
+
+
+### Bug Fixes
+
+* freezing dsl arguments so that other parts of the code can't change the underlying dsl configuration ([d3373d4](https://github.com/craigulliott/dsl_compose/commit/d3373d494b292241bc17f38e565a2434e5e0d187))
+
+## [2.14.0](https://github.com/craigulliott/dsl_compose/compare/v2.13.1...v2.14.0) (2023-09-06)
+
+
+### Features
+
+* adding start_with/end_with and format validators to classes ([d390d15](https://github.com/craigulliott/dsl_compose/commit/d390d15bf2ebec2340815ff0a372a938072efd0e))
+
 ## [2.13.1](https://github.com/craigulliott/dsl_compose/compare/v2.13.0...v2.13.1) (2023-09-05)
 
 

data/README.md

@@ -597,16 +597,16 @@ The following validations can be added to the arguments of your DSL methods. Val
         validate_in ["cat", "dog"]
 
         # The argument must start with the following string.
-        validate_start_with [:foo_]
+        validate_start_with ["foo_"]
 
         # The argument must not start with the following string.
-        validate_not_start_with [:foo_]
+        validate_not_start_with ["foo_"]
 
         # The argument must end with the following string.
-        validate_end_with [:_foo]
+        validate_end_with ["_foo"]
 
         # The argument must not end with the following string.
-        validate_not_end_with [:_foo]
+        validate_not_end_with ["_foo"]
 
         # The argument must match the provided regex.
         validate_format /\A[A-Z][a-z]+\Z/
@@ -692,7 +692,20 @@ The following validations can be added to the arguments of your DSL methods. Val
 
       requires :my_first_argument, :class do
 
-        # There are no validations for :class types
+        # The class name must start with the following string.
+        validate_start_with ["foo_"]
+
+        # The class name must not start with the following string.
+        validate_not_start_with ["foo_"]
+
+        # The class name must end with the following string.
+        validate_end_with ["_foo"]
+
+        # The class name must not end with the following string.
+        validate_not_end_with ["_foo"]
+
+        # The class name must match the provided regex.
+        validate_format /\A[A-Z][a-z]+\Z/
 
       end
 

data/lib/dsl_compose/class_coerce.rb

@@ -5,6 +5,8 @@ module DSLCompose
     class UnexpectedClassNameError < StandardError
     end
 
+    attr_reader :class_name
+
     def initialize class_name
       unless class_name.is_a? String
         raise UnexpectedClassNameError, "expected `#{class_name}` to be a String"

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

@@ -17,19 +17,19 @@ module DSLCompose
           end
 
           def add_values values
-            # if the provided values is a symbol, then convert it to an array
-            if values.is_a? Symbol
+            # if the provided values is a single item then convert it to an array
+            if values.is_a?(Symbol) || values.is_a?(String)
               values = [values]
             end
 
             # assert that the provided values is an array
             unless values.is_a? Array
-              raise ValidationFailedError, "The value `#{values}` provided to this validator must be a Symbol or an Array of Symbols"
+              raise ValidationFailedError, "The value `#{values}` provided to this validator must be a Symbol/String or an Array of Symbols/Strings"
             end
 
-            # assert that the provided values is an array of symbols
-            unless values.all? { |value| value.is_a? Symbol }
-              raise ValidationFailedError, "The value `#{values}` provided to this validator must be a Symbol or an Array of Symbols"
+            # assert that the provided values is an array of symbols/strings
+            unless values.all? { |value| value.is_a? Symbol } || values.all? { |value| value.is_a? String }
+              raise ValidationFailedError, "The value `#{values}` provided to this validator must be a Symbol/String or an Array of Symbols/Strings"
             end
 
             @values += values

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

@@ -17,19 +17,19 @@ module DSLCompose
           end
 
           def add_values values
-            # if the provided values is a symbol, then convert it to an array
-            if values.is_a? Symbol
+            # if the provided values is a single item then convert it to an array
+            if values.is_a?(Symbol) || values.is_a?(String)
               values = [values]
             end
 
             # assert that the provided values is an array
             unless values.is_a? Array
-              raise ValidationFailedError, "The value `#{values}` provided to this validator must be a Symbol or an Array of Symbols"
+              raise ValidationFailedError, "The value `#{values}` provided to this validator must be a Symbol/String or an Array of Symbols/Strings"
             end
 
-            # assert that the provided values is an array of symbols
-            unless values.all? { |value| value.is_a? Symbol }
-              raise ValidationFailedError, "The value `#{values}` provided to this validator must be a Symbol or an Array of Symbols"
+            # assert that the provided values is an array of symbols/strings
+            unless values.all? { |value| value.is_a? Symbol } || values.all? { |value| value.is_a? String }
+              raise ValidationFailedError, "The value `#{values}` provided to this validator must be a Symbol/String or an Array of Symbols/Strings"
             end
 
             @values += values

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

@@ -17,19 +17,19 @@ module DSLCompose
           end
 
           def add_values values
-            # if the provided values is a symbol, then convert it to an array
-            if values.is_a? Symbol
+            # if the provided values is a single item then convert it to an array
+            if values.is_a?(Symbol) || values.is_a?(String)
               values = [values]
             end
 
             # assert that the provided values is an array
             unless values.is_a? Array
-              raise ValidationFailedError, "The value `#{values}` provided to this validator must be a Symbol or an Array of Symbols"
+              raise ValidationFailedError, "The value `#{values}` provided to this validator must be a Symbol/String or an Array of Symbols/Strings"
             end
 
-            # assert that the provided values is an array of symbols
-            unless values.all? { |value| value.is_a? Symbol }
-              raise ValidationFailedError, "The value `#{values}` provided to this validator must be a Symbol or an Array of Symbols"
+            # assert that the provided values is an array of symbols/strings
+            unless values.all? { |value| value.is_a? Symbol } || values.all? { |value| value.is_a? String }
+              raise ValidationFailedError, "The value `#{values}` provided to this validator must be a Symbol/String or an Array of Symbols/Strings"
             end
 
             @values += values

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

@@ -17,19 +17,19 @@ module DSLCompose
           end
 
           def add_values values
-            # if the provided values is a symbol, then convert it to an array
-            if values.is_a? Symbol
+            # if the provided values is a single item then convert it to an array
+            if values.is_a?(Symbol) || values.is_a?(String)
               values = [values]
             end
 
             # assert that the provided values is an array
             unless values.is_a? Array
-              raise ValidationFailedError, "The value `#{values}` provided to this validator must be a Symbol or an Array of Symbols"
+              raise ValidationFailedError, "The value `#{values}` provided to this validator must be a Symbol/String or an Array of Symbols/Strings"
             end
 
-            # assert that the provided values is an array of symbols
-            unless values.all? { |value| value.is_a? Symbol }
-              raise ValidationFailedError, "The value `#{values}` provided to this validator must be a Symbol or an Array of Symbols"
+            # assert that the provided values is an array of symbols/strings
+            unless values.all? { |value| value.is_a? Symbol } || values.all? { |value| value.is_a? String }
+              raise ValidationFailedError, "The value `#{values}` provided to this validator must be a Symbol/String or an Array of Symbols/Strings"
             end
 
             @values += values

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

@@ -225,7 +225,7 @@ module DSLCompose
             raise ValidationInvalidArgumentError, regexp
           end
 
-          unless @type == :string || @type == :symbol
+          unless @type == :string || @type == :symbol || @type == :class
             raise ValidationIncompatibleError, "The validation type #{@type} is not compatible with this argument type"
           end
           @format_validation = FormatValidation.new regexp
@@ -278,11 +278,14 @@ module DSLCompose
         end
 
         def validate_end_with value
-          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"
+          valid_type = value.is_a?(Symbol) || value.is_a?(String)
+          valid_array_of_symbols = (value.is_a?(Array) && value.all? { |value| value.is_a? Symbol })
+          valid_array_of_strings = (value.is_a?(Array) && value.all? { |value| value.is_a? String })
+          unless valid_type || valid_array_of_symbols || valid_array_of_strings
+            raise ValidationInvalidArgumentError, "The value `#{value}` provided to this validator must be a Symbol/String or an Array of Symbols/Strings"
           end
 
-          unless @type == :string || @type == :symbol
+          unless @type == :string || @type == :symbol || @type == :class
             raise ValidationIncompatibleError, "The validation type #{@type} is not compatible with this argument type"
           end
 
@@ -295,11 +298,14 @@ module DSLCompose
         end
 
         def validate_not_end_with value
-          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"
+          valid_type = value.is_a?(Symbol) || value.is_a?(String)
+          valid_array_of_symbols = (value.is_a?(Array) && value.all? { |value| value.is_a? Symbol })
+          valid_array_of_strings = (value.is_a?(Array) && value.all? { |value| value.is_a? String })
+          unless valid_type || valid_array_of_symbols || valid_array_of_strings
+            raise ValidationInvalidArgumentError, "The value `#{value}` provided to this validator must be a Symbol/String or an Array of Symbols/Strings"
           end
 
-          unless @type == :string || @type == :symbol
+          unless @type == :string || @type == :symbol || @type == :class
             raise ValidationIncompatibleError, "The validation type #{@type} is not compatible with this argument type"
           end
 
@@ -312,11 +318,14 @@ module DSLCompose
         end
 
         def validate_start_with value
-          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"
+          valid_type = value.is_a?(Symbol) || value.is_a?(String)
+          valid_array_of_symbols = (value.is_a?(Array) && value.all? { |value| value.is_a? Symbol })
+          valid_array_of_strings = (value.is_a?(Array) && value.all? { |value| value.is_a? String })
+          unless valid_type || valid_array_of_symbols || valid_array_of_strings
+            raise ValidationInvalidArgumentError, "The value `#{value}` provided to this validator must be a Symbol/String or an Array of Symbols/Strings"
           end
 
-          unless @type == :string || @type == :symbol
+          unless @type == :string || @type == :symbol || @type == :class
             raise ValidationIncompatibleError, "The validation type #{@type} is not compatible with this argument type"
           end
 
@@ -329,11 +338,14 @@ module DSLCompose
         end
 
         def validate_not_start_with value
-          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"
+          valid_type = value.is_a?(Symbol) || value.is_a?(String)
+          valid_array_of_symbols = (value.is_a?(Array) && value.all? { |value| value.is_a? Symbol })
+          valid_array_of_strings = (value.is_a?(Array) && value.all? { |value| value.is_a? String })
+          unless valid_type || valid_array_of_symbols || valid_array_of_strings
+            raise ValidationInvalidArgumentError, "The value `#{value}` provided to this validator must be a Symbol/String or an Array of Symbols/Strings"
           end
 
-          unless @type == :string || @type == :symbol
+          unless @type == :string || @type == :symbol || @type == :class
             raise ValidationIncompatibleError, "The validation type #{@type} is not compatible with this argument type"
           end
 
@@ -421,8 +433,11 @@ module DSLCompose
 
         # returns true if every provided class validation also returns true
         def validate_class! value
-          # there are no class validations
-          true
+          (format_validation.nil? || format_validation.validate!(value.class_name)) &&
+            (end_with_validation.nil? || end_with_validation.validate!(value.class_name)) &&
+            (not_end_with_validation.nil? || not_end_with_validation.validate!(value.class_name)) &&
+            (start_with_validation.nil? || start_with_validation.validate!(value.class_name)) &&
+            (not_start_with_validation.nil? || not_start_with_validation.validate!(value.class_name))
         end
 
         # returns true if every provided object validation also returns true

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

@@ -101,7 +101,7 @@ module DSLCompose
                   ClassCoerce.new optional_arg[optional_argument_name]
                 end
               else
-                optional_arg[optional_argument_name]
+                optional_arg[optional_argument_name].freeze
               end
 
               if optional_arg_value.is_a?(Array) && !optional_argument.array
@@ -191,7 +191,7 @@ module DSLCompose
                 ClassCoerce.new required_args[i]
               end
             else
-              required_args[i]
+              required_args[i].freeze
             end
 
             if required_arg_value.is_a?(Array) && !required_argument.array

data/lib/dsl_compose/version.rb

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

data/sig/dsl_compose/dsl/arguments/argument/end_with_validation.rbs

@@ -6,7 +6,7 @@ module DSLCompose
         class EndWithValidation
           @values: Array[Symbol]
 
-          def initialize: (Symbol | Array[Symbol]) -> void
+          def initialize: (Symbol | Array[Symbol] | String | Array[String]) -> void
           def validate!: (Symbol | String value) -> true
 
           class InvalidValueError < StandardError

data/sig/dsl_compose/dsl/arguments/argument/interpreter.rbs

@@ -19,10 +19,10 @@ module DSLCompose
           def validate_length: (?minimum: Numeric?, ?maximum: Numeric?, ?is: Numeric?) -> void
           def validate_not_in: ([Numeric | Symbol | String] values) -> void
           def validate_in: ([Numeric | Symbol | String] values) -> void
-          def validate_end_with: (Symbol | Array[Symbol] value) -> void
-          def validate_not_end_with: (Symbol | Array[Symbol] value) -> void
-          def validate_start_with: (Symbol | Array[Symbol] value) -> void
-          def validate_not_start_with: (Symbol | Array[Symbol] value) -> void
+          def validate_end_with: (Symbol | Array[Symbol] | String | Array[String] value) -> void
+          def validate_not_end_with: (Symbol | Array[Symbol] | String | Array[String] value) -> void
+          def validate_start_with: (Symbol | Array[Symbol] | String | Array[String] value) -> void
+          def validate_not_start_with: (Symbol | Array[Symbol] | String | Array[String] value) -> void
           def validate_format: (Regexp regex) -> void
           def validate_is_a: (String class_name) -> void
         end

data/sig/dsl_compose/dsl/arguments/argument/not_end_with_validation.rbs

@@ -6,7 +6,7 @@ module DSLCompose
         class NotEndWithValidation
           @values: Array[Symbol]
 
-          def initialize: (Symbol | Array[Symbol]) -> void
+          def initialize: (Symbol | Array[Symbol] | String | Array[String]) -> void
           def validate!: (Symbol | String value) -> true
 
           class InvalidValueError < StandardError

data/sig/dsl_compose/dsl/arguments/argument/not_start_with_validation.rbs

@@ -6,7 +6,7 @@ module DSLCompose
         class NotStartWithValidation
           @values: Array[Symbol]
 
-          def initialize: (Symbol | Array[Symbol]) -> void
+          def initialize: (Symbol | Array[Symbol] | String | Array[String]) -> void
           def validate!: (Symbol | String value) -> true
 
           class InvalidValueError < StandardError

data/sig/dsl_compose/dsl/arguments/argument/start_with_validation.rbs

@@ -6,7 +6,7 @@ module DSLCompose
         class StartWithValidation
           @values: Array[Symbol]
 
-          def initialize: (Symbol | Array[Symbol]) -> void
+          def initialize: (Symbol | Array[Symbol] | String | Array[String]) -> void
           def validate!: (Symbol | String value) -> true
 
           class InvalidValueError < StandardError

data/sig/dsl_compose/dsl/arguments/argument.rbs

@@ -42,10 +42,10 @@ module DSLCompose
         def validate_equal_to: (Numeric | Symbol | String value) -> void
         def validate_in: (Array[Numeric | Symbol | String] values) -> void
         def validate_not_in: (Array[Numeric | Symbol | String] values) -> void
-        def validate_end_with: (Symbol | Array[Symbol] value) -> void
-        def validate_not_end_with: (Symbol | Array[Symbol] value) -> void
-        def validate_start_with: (Symbol | Array[Symbol] value) -> void
-        def validate_not_start_with: (Symbol | Array[Symbol] value) -> void
+        def validate_end_with: (Symbol | Array[Symbol] | String | Array[String] value) -> void
+        def validate_not_end_with: (Symbol | Array[Symbol] | String | Array[String] value) -> void
+        def validate_start_with: (Symbol | Array[Symbol] | String | Array[String] value) -> void
+        def validate_not_start_with: (Symbol | Array[Symbol] | String | Array[String] value) -> void
         def validate_length: (?maximum: nil | Numeric, ?minimum: nil | Numeric, ?is: nil | Numeric) -> void
         def validate_is_a: (String class_name) -> void
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dsl_compose
 version: !ruby/object:Gem::Version
-  version: 2.13.1
+  version: 2.14.1
 platform: ruby
 authors:
 - Craig Ulliott
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-09-05 00:00:00.000000000 Z
+date: 2023-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: class_spec_helper