dsl_compose 2.14.2 → 2.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f89114eef0fe1f670d05bfe9cb2b8fe7964285f8dfbc60638f979ec125ad5e88
-  data.tar.gz: 0ab64341226e7069d50016415a786b8525b93006d84378911d215b911f8526a1
+  metadata.gz: af6d832ff6a9dbe899f76297a60555caf170045743dd6cf83cbabb6b26e87892
+  data.tar.gz: a9628422e02b4cac58263ad72938c0297f42c75d81dd3337e43d227ec71ba664
 SHA512:
-  metadata.gz: 97f0cbe329fb957589f395cfdc7ee75c1b195ac897e01a494578efc45409375d5435ff17507b241d8d1f0b65bc014b1a50d2d9b2ec673c1b039cc937052d87a5
-  data.tar.gz: 235bf2593f1ef5e0309973eb45189dc7c634e8b959dde94c8a52673b933d0ddb996a2065d29707901ccc94466754d3c2f6d29cf4f0ad237d305d1d21c050aeea
+  metadata.gz: 82ee9d6210446826e52dec60de79f414d9769e4e571e2d95ccf41c66da3231728ad6ffecb9f55beedeceecbf651c286fc0499b076301d3c7f858fa84bd0d5106
+  data.tar.gz: d30c48922a712e86138867c4b4de9daee988bf99b3af052a407a8b8bc739f292c974a143ea6b93c0de35b84a981d763c08e3da799114a17ca68f1ff4e6b086f4

data/CHANGELOG.md

@@ -1,5 +1,25 @@
 # Changelog
 
+## [2.15.0](https://github.com/craigulliott/dsl_compose/compare/v2.14.3...v2.15.0) (2023-10-03)
+
+
+### Features
+
+* added option to skip certain provided classes within dsl parsers ([c2be111](https://github.com/craigulliott/dsl_compose/commit/c2be111289f4ca0b84b95e641c18bdbd784b5b6f))
+* adding default values for dsl arguments ([b89bd69](https://github.com/craigulliott/dsl_compose/commit/b89bd697eb6598f5f723a28533bd3e67e4ab9207))
+
+
+### Bug Fixes
+
+* passing classes to skip to the parser as class names (strings) instead of the actual classes. This prevents this library holding a reference to those classes and preventing garbage collection of the classes when they are dynamically created/destroyed within a test suite. ([74b332a](https://github.com/craigulliott/dsl_compose/commit/74b332ab99b7cf96bb8468a06634ee217cd5c58b))
+
+## [2.14.3](https://github.com/craigulliott/dsl_compose/compare/v2.14.2...v2.14.3) (2023-09-27)
+
+
+### Bug Fixes
+
+* better error if passing a scalar arg instead of kwargs ([7a47775](https://github.com/craigulliott/dsl_compose/commit/7a47775e7b13329c82c2497a017d2d67c5c56d75))
+
 ## [2.14.2](https://github.com/craigulliott/dsl_compose/compare/v2.14.1...v2.14.2) (2023-09-11)
 
 

data/README.md

@@ -106,8 +106,9 @@ class Foo
 
       # You can also add optional arguments to your DSL methods. All optional
       # arguments must be added after required ones. An error will be raised if
-      # you define a required argument after an optional one.
-      optional :optional_argument, :integer do
+      # you define a required argument after an optional one. Optional arguments can
+      # have an default value, if a default is not provided then nil will be assumed.
+      optional :optional_argument, :integer, default: 123 do
         description "A description of an optional argument"
 
         # You can add validation to your arguments. A full list is provided later in this document
@@ -281,6 +282,9 @@ class MyParser < DSLCompose::Parser
   # If you only want to process classes at the end of the class hierarchy (classes
   # which extend the provided base class, but do not have their own children) then
   # use `for_final_children_of` instead of `for_children_of`
+  #
+  # Both `for_children_of` and `for_final_children_of` accept an optional parameter
+  # named skip_classes which accepts an array of class names which should be skipped.
   for_children_of SomeBaseClass do |child_class:|
     add_documentation <<~DESCRIPTION
       You can optionally provide a description of anything specific that your parser

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

@@ -52,6 +52,8 @@ module DSLCompose
         # If true, then this argument accepts an array of values. It will also accept a single value,
         # but that single value will be automatically converted to an array
         attr_reader :array
+        # The default value for optional arguments, if one is not provided then nil will be assumed.
+        attr_reader :default
         # An otional description of this Attribute, if provided then it must be a string.
         # The description accepts markdown and is used when generating documentation.
         attr_reader :description
@@ -81,7 +83,7 @@ module DSLCompose
         # `kwarg` is a boolean which determines if a required Attribute must be provided as a keyword argument.
         # `type` can be either :integer, :boolean, :float, :string or :symbol
         # `block` contains the instructions to further configure this Attribute
-        def initialize name, required, kwarg, type, array: false, &block
+        def initialize name, required, kwarg, type, array: false, default: nil, &block
           if name.is_a? Symbol
 
             if RESERVED_ARGUMENT_NAMES.include? name
@@ -109,6 +111,13 @@ module DSLCompose
 
           @array = array ? true : false
 
+          unless default.nil?
+            if @required
+              raise ImpossibleKwargError, "The argument `#{name}` is required, so can not be given a default value."
+            end
+            @default = default
+          end
+
           # If a block was provided, then we evaluate it using a seperate
           # interpreter class. We do this because the interpreter class contains
           # no other methods or variables, if it was evaluated in the context of

data/lib/dsl_compose/dsl/arguments.rb

@@ -85,9 +85,11 @@ module DSLCompose
       #
       # Argument `name` must be unique within the DSLMethod.
       # `required` must be a boolean, and determines if this argument will be required
+      # `array` is a boolean which determines if this argument will accept an array of the given type or a single item
+      # `default` contains the default value, if one is not provided then nil will be assumed (it is only available for optional arguments)
       # `kwarg` is a boolean which determines if a required Attribute must be provided as a keyword argument.
       # or optional on the method which is exposed in our DSL.
-      def add_argument name, required, kwarg, type, array: false, &block
+      def add_argument name, required, kwarg, type, array: false, default: nil, &block
         if @arguments.key? name
           raise ArgumentAlreadyExistsError, "An argument with the name `#{name}` already exists for this DSL method"
         end
@@ -97,7 +99,7 @@ module DSLCompose
           raise ArgumentOrderingError, "Required arguments can not be added after optional ones"
         end
 
-        @arguments[name] = Argument.new(name, required, kwarg, type, array: array, &block)
+        @arguments[name] = Argument.new(name, required, kwarg, type, array: array, default: default, &block)
       end
     end
   end

data/lib/dsl_compose/dsl/interpreter.rb

@@ -63,10 +63,12 @@ module DSLCompose
       #
       # name must be a symbol
       # `type` can be either :integer, :boolean, :float, :string, :symbol, :class or :object
+      # `array` is a boolean which determines if this argument will accept an array of the given type or a single item
+      # `default` contains the default value, if one is not provided then nil will be assumed
       # `block` contains the argument definition and will be evaluated seperately
       # by the Argument::Interpreter
-      def optional name, type, array: false, &block
-        @dsl.arguments.add_argument name, false, false, type, array: array, &block
+      def optional name, type, array: false, default: nil, &block
+        @dsl.arguments.add_argument name, false, false, type, array: array, default: default, &block
       end
 
       # adds a new required argument to the DSLMethod

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

@@ -38,6 +38,11 @@ module DSLCompose
 
           # process all the required arguments which are kwargs
           required_kwargs = arguments.required_arguments.filter { |a| a.kwarg }
+
+          if required_kwargs.any? && !all_kwargs.is_a?(Hash)
+            raise MissingRequiredArgumentsError, "This has required keyword arguments, but no keyword arguments were provided"
+          end
+
           required_kwargs.each do |required_kwarg|
             if all_kwargs.key? required_kwarg.name
               # add the keyword argument to the required args
@@ -64,17 +69,17 @@ module DSLCompose
             raise TooManyArgumentsError, "Too many arguments provided"
           end
 
-          # Assume all optonal arguments are nil (except booleans, which default to false).
+          # Assume all optonal arguments are their defaults (except booleans, which default to false).
           # If actual values were provided, then they will be set further below.
           if arguments.optional_arguments.any?
             arguments.optional_arguments.each do |optional_argument|
               # assume it is nil
-              @arguments[optional_argument.name] = nil
+              @arguments[optional_argument.name] = optional_argument.default
               # unless the argument is an array or a boolean, in which case it defaults
               # to an empty array or false
               if optional_argument.array
                 @arguments[optional_argument.name] = [].freeze
-              elsif optional_argument.type == :boolean
+              elsif optional_argument.type == :boolean && optional_argument.default.nil?
                 @arguments[optional_argument.name] = false
               end
             end

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

@@ -4,9 +4,10 @@ module DSLCompose
   class Parser
     class ForChildrenOfParser
       class Descendents
-        def initialize base_class, final_children_only
+        def initialize base_class, final_children_only, skip_classes = []
           @base_class = base_class
           @final_children_only = final_children_only
+          @skip_classes = skip_classes
         end
 
         def classes
@@ -19,6 +20,11 @@ module DSLCompose
             "#{child_class.name.split("::").count}_#{has_descendents(child_class) ? 0 : 1}_#{child_class.name}"
           end
 
+          # reject any classes which we are skipping
+          extending_classes.reject! do |child_class|
+            @skip_classes.include? child_class.name
+          end
+
           # if this is not a final child, but we are processing final children only, then skip it
           if @final_children_only
             # reject any classes which have descendents

data/lib/dsl_compose/parser/for_children_of_parser.rb

@@ -35,7 +35,7 @@ module DSLCompose
       # parser.for_children_of BaseClass do |child_class:|
       #    # this will yield for ChildClass and GrandchildClass
       # and
-      def initialize base_class, final_children_only, &block
+      def initialize base_class, final_children_only, skip_classes = [], &block
         # assert the provided class has the DSLCompose::Composer module installed
         unless base_class.respond_to? :dsls
           raise ClassDoesNotUseDSLComposeError, base_class
@@ -57,7 +57,7 @@ module DSLCompose
         end
 
         # yeild the block for all descendents of the provided base_class
-        Descendents.new(base_class, final_children_only).classes.each do |child_class|
+        Descendents.new(base_class, final_children_only, skip_classes).classes.each do |child_class|
           # determine which arguments to send to the block
           args = {}
           if BlockArguments.accepts_argument?(:child_class, &block)

data/lib/dsl_compose/parser.rb

@@ -30,27 +30,28 @@ module DSLCompose
     # If `final_children_only` is true, then this will cause the parser to only return
     # classes which are at the end of their class hierachy (meaning they dont have any
     # children of their own)
-    def self.for_children_of base_class, final_children_only: false, rerun: false, &block
+    def self.for_children_of base_class, final_children_only: false, skip_classes: [], rerun: false, &block
       unless rerun
         @runs ||= []
         @runs << {
           base_class: base_class,
           final_children_only: final_children_only,
+          skip_classes: skip_classes,
           block: block
         }
       end
 
       # we parse the provided block in the context of the ForChildrenOfParser class
       # to help make this code more readable, and to limit polluting the current namespace
-      ForChildrenOfParser.new(base_class, final_children_only, &block)
+      ForChildrenOfParser.new(base_class, final_children_only, skip_classes, &block)
     end
 
     # this is a wrapper for the `for_children_of` method, but it provides a value
     # of true for the `final_children_only` argument. This will cause the parser to only
     # return classes which are at the end of the class hierachy (meaning they dont have
     # any children of their own)
-    def self.for_final_children_of base_class, &block
-      for_children_of base_class, final_children_only: true, &block
+    def self.for_final_children_of base_class, skip_classes: [], &block
+      for_children_of base_class, final_children_only: true, skip_classes: skip_classes, &block
     end
 
     # this method is used to rerun the parser, this is most useful from within a test suite
@@ -61,7 +62,8 @@ module DSLCompose
         base_class = run[:base_class]
         block = run[:block]
         final_children_only = run[:final_children_only]
-        for_children_of base_class, rerun: true, final_children_only: final_children_only, &block
+        skip_classes = run[:skip_classes]
+        for_children_of base_class, rerun: true, final_children_only: final_children_only, skip_classes: skip_classes, &block
       end
     end
 

data/lib/dsl_compose/version.rb

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

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

@@ -11,6 +11,7 @@ module DSLCompose
         attr_reader required: bool
         attr_reader kwarg: bool
         attr_reader array: bool
+        attr_reader default: untyped
         attr_reader description: String
 
         attr_reader greater_than_validation: GreaterThanValidation
@@ -28,7 +29,7 @@ module DSLCompose
         attr_reader length_validation: LengthValidation
         attr_reader is_a_validation: IsAValidation
 
-        def initialize: (Symbol name, bool required, bool kwarg, argument_type `type`, ?array: bool) -> void
+        def initialize: (Symbol name, bool required, bool kwarg, argument_type `type`, ?array: bool, ?default: untyped) -> void
         def set_description: (String description) -> void
         def has_description?: () -> bool
         def required?: -> bool

data/sig/dsl_compose/dsl/arguments.rbs

@@ -12,7 +12,7 @@ module DSLCompose
       def optional_argument: (Symbol name) -> Argument
       def required_argument: (Symbol name) -> Argument
       def has_argument?: (Symbol name) -> bool
-      def add_argument: (Symbol name, bool required, bool kwarg, argument_type `type`, ?array: bool) -> Argument
+      def add_argument: (Symbol name, bool required, bool kwarg, argument_type `type`, ?array: bool, ?default: untyped) -> Argument
 
       class ArgumentDoesNotExistError < StandardError
         end

data/sig/dsl_compose/dsl/interpreter.rbs

@@ -13,7 +13,7 @@ module DSLCompose
       def title: (String title) -> void
       def add_method: (Symbol name, ?required: nil) -> void
       def add_unique_method: (Symbol name, ?required: nil) -> void
-      def optional: (Symbol name, argument_type `type`, ?array: bool) -> void
+      def optional: (Symbol name, argument_type `type`, ?array: bool, ?default: untyped) -> void
       def requires: (Symbol name, argument_type `type`, ?kwarg: bool, ?array: bool) -> void
     end
   end

data/sig/dsl_compose/parser/for_children_of_parser/descendents.rbs

@@ -4,9 +4,10 @@ module DSLCompose
     class ForChildrenOfParser
       class Descendents
         @base_class: singleton(Object)
+        @skip_classes: Array[String]
         @final_children_only: bool
 
-        def initialize: (singleton(Object) base_class, bool final_children_only) -> void
+        def initialize: (singleton(Object) base_class, bool final_children_only, ?Array[String] skip_classes) -> void
         def classes: -> Array[singleton(Object)]
 
         private

data/sig/dsl_compose/parser/for_children_of_parser.rbs

@@ -5,7 +5,7 @@ module DSLCompose
       @base_class: singleton(Object)
       @child_class: singleton(Object)
 
-      def initialize: (singleton(Object) base_class, bool final_children_only) -> void
+      def initialize: (singleton(Object) base_class, bool final_children_only, ?Array[String] skip_classes) -> void
 
       # overriding this method because steep doesn't
       # correctly infer that a block is being passed to this method

data/sig/dsl_compose/parser.rbs

@@ -4,7 +4,8 @@ module DSLCompose
     self.@runs: untyped
 
     def initialize: -> void
-    def self.for_children_of: (singleton(Object) base_class, ?final_children_only: bool, ?rerun: bool) -> void
+    def self.for_children_of: (singleton(Object) base_class, ?final_children_only: bool, ?skip_classes: Array[String], ?rerun: bool) -> void
+    def self.for_final_children_of: (singleton(Object) base_class, ?skip_classes: Array[String]) -> void
 
     class NotInitializable < StandardError
     end

metadata

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