dsl_compose 2.5.0 → 2.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b29a5bddf2a3f304e22318d9ef0d2f1dc9efbb195618b1b296f33affff3d4b0
-  data.tar.gz: 06141a53c94fdfa21265df75594b627e30dd37d13d2943e83dda5cad29de9de4
+  metadata.gz: d558cb69dae4f6a6ea4e6a2fe996a88ea0a94545e94f68c22c0800732d0745da
+  data.tar.gz: 9527152eda7312f711c9881fffb26cc2feae295d67be646ace5ce9a20f6dc88b
 SHA512:
-  metadata.gz: 8f605f57dbf60fb77e7633d4631d7c5423d9614e28cce18e9e05fcca637d0b35b49b1d71c504d50289d527019c48f5a0a96588ab9cb25ba5d1c651c4ae6570f8
-  data.tar.gz: 19619027a3a21f8506cd077a927a719284b378d5d4cb2f2f11d5264a487442c2f44da2a1780684603a0154348c89c2359459b776077380da8f3a1093a15a72b6
+  metadata.gz: 5c60f96f11f85c753138ea3a1f4fefe227fdb7ce48191e6dc204380e603916204e62e398ca0813487ed92f15dea9f38596050e5f91484a9ceab604ef11ff828e
+  data.tar.gz: 7eae02a8c4d6fa2e43ab4789ae1399c74e744bbccdfb46e60804f41d7982e11e9187b2f332fe6db53f858b867584f4317b981ca360f982d78fe05346db576f94

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## [2.5.1](https://github.com/craigulliott/dsl_compose/compare/v2.5.0...v2.5.1) (2023-08-17)
+
+
+### Bug Fixes
+
+* defaulting optional boolean values to false instead of nil in the parser ([3a4b4d7](https://github.com/craigulliott/dsl_compose/commit/3a4b4d7df315e60dca0e66af37d77b800dc6be2c))
+* stripping white space off descriptions ([93ba9d2](https://github.com/craigulliott/dsl_compose/commit/93ba9d21f57a4f58f70f24a44cd58121741da8d0))
+
 ## [2.5.0](https://github.com/craigulliott/dsl_compose/compare/v2.4.0...v2.5.0) (2023-08-01)
 
 

data/README.md

@@ -42,7 +42,7 @@ class Foo
   define_dsl :your_dsl do
 
     # A description of your DSL
-    description <<-DESCRIPTION
+    description <<~DESCRIPTION
       Add a description of your DSL here, this description will be
       used when generating the documentation for your DSL.
 
@@ -191,7 +191,7 @@ class MyClientLibrary
     description "Configure the settings for MyClientLibrary"
 
     add_unique_method :api_key, required: true do
-      description <<-DESCRIPTION
+      description <<~DESCRIPTION
         Your API key.
 
         API keys can be generated from your developer
@@ -247,7 +247,7 @@ class MyParser < DSLCompose::Parser
   # which extend the provided base class, but do not have their own children) then
   # use `for_final_children_of` instead of `for_children_of`
   for_children_of SomeBaseClass do |child_class:|
-    description <<-DESCRIPTION
+    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
 
@@ -281,7 +281,7 @@ class MyParser < DSLCompose::Parser
     # 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
+      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.
 
@@ -308,7 +308,7 @@ class MyParser < DSLCompose::Parser
       # are provided then the requested dsl argument must be present on all DSLs
       # otherwise an error will be raised.
       for_method :some_method_name do |method_name:, a_method_argument:|
-        description <<-DESCRIPTION
+        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.rb

@@ -112,7 +112,7 @@ module DSLCompose
         # `description` must be a string with a length greater than 0.
         # The `description` can only be set once per Argument
         def set_description description
-          unless description.is_a?(String) && description.length > 0
+          unless description.is_a?(String) && description.strip.length > 0
             raise InvalidDescriptionError, "The option description `#{description}` is invalid, it must be of type string and have length greater than 0."
           end
 
@@ -120,7 +120,7 @@ module DSLCompose
             raise DescriptionAlreadyExistsError, "The description has already been set"
           end
 
-          @description = FixHeredocIndentation.fix_heredoc_indentation description
+          @description = description.strip
         end
 
         # Returns `true` if this DSL has a description, else false.

data/lib/dsl_compose/dsl/dsl_method.rb

@@ -68,7 +68,7 @@ module DSLCompose
       # `description` must be a string with a length greater than 0.
       # The `description` can only be set once per DSLMethod
       def set_description description
-        unless description.is_a?(String) && description.length > 0
+        unless description.is_a?(String) && description.strip.length > 0
           raise InvalidDescriptionError, "The DSL method description `#{description}` is invalid, it must be of type string and have length greater than 0"
         end
 
@@ -76,7 +76,7 @@ module DSLCompose
           raise DescriptionAlreadyExistsError, "The description has already been set"
         end
 
-        @description = FixHeredocIndentation.fix_heredoc_indentation description
+        @description = description.strip
       end
 
       # Returns `true` if this DSL has a description, else false.

data/lib/dsl_compose/dsl.rb

@@ -74,7 +74,7 @@ module DSLCompose
     # `description` must be a string with a length greater than 0.
     # The `description` can only be set once per DSL
     def set_description description
-      unless description.is_a?(String) && description.length > 0
+      unless description.is_a?(String) && description.strip.length > 0
         raise InvalidDescriptionError, "The DSL description `#{description}` is invalid, it must be of type string and have length greater than 0"
       end
 
@@ -82,7 +82,7 @@ module DSLCompose
         raise DescriptionAlreadyExistsError, "The DSL description has already been set"
       end
 
-      @description = FixHeredocIndentation.fix_heredoc_indentation description
+      @description = description.strip
     end
 
     # Returns `true` if this DSL has a description, else false.

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

@@ -44,10 +44,11 @@ module DSLCompose
             raise TooManyArgumentsError, "Too many arguments provided"
           end
 
-          # assume all optonal arguments are nil. If actual values were provided, then they will be set below
+          # Assume all optonal arguments are nil (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|
-              @arguments[optional_argument.name] = nil
+              @arguments[optional_argument.name] = (optional_argument.type == :boolean) ? false : nil
             end
           end
 

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

@@ -5,6 +5,9 @@ module DSLCompose
     class Execution
       class MethodCalls
         class MethodCall
+          class InvalidDescriptionError < StandardError
+          end
+
           attr_reader :dsl_method
           attr_reader :arguments
 
@@ -26,8 +29,12 @@ module DSLCompose
           # the parser can provide usage notes for how this dsl is being used, these are used to
           # generate documentation
           def add_parser_usage_note note
+            unless note.is_a?(String) && note.strip.length > 0
+              raise InvalidDescriptionError, "The parser usage description `#{note}` is invalid, it must be of type string and have length greater than 0"
+            end
+
             @parser_usage_notes ||= []
-            @parser_usage_notes << DSLCompose::FixHeredocIndentation.fix_heredoc_indentation(note)
+            @parser_usage_notes << note.strip
           end
 
           # return the list of notes which describe how the parsers are using this DSL

data/lib/dsl_compose/interpreter/execution.rb

@@ -9,6 +9,9 @@ module DSLCompose
       class RequiredMethodNotCalledError < StandardError
       end
 
+      class InvalidDescriptionError < StandardError
+      end
+
       attr_reader :dsl
       attr_reader :klass
       attr_reader :method_calls
@@ -39,8 +42,12 @@ module DSLCompose
       # the parser can provide usage notes for how this dsl is being used, these are used to
       # generate documentation
       def add_parser_usage_note note
+        unless note.is_a?(String) && note.strip.length > 0
+          raise InvalidDescriptionError, "The parser usage description `#{note}` is invalid, it must be of type string and have length greater than 0"
+        end
+
         @parser_usage_notes ||= []
-        @parser_usage_notes << DSLCompose::FixHeredocIndentation.fix_heredoc_indentation(note)
+        @parser_usage_notes << note.strip
       end
 
       # return the list of notes which describe how the parsers are using this DSL

data/lib/dsl_compose/interpreter.rb

@@ -7,6 +7,9 @@ module DSLCompose
     class DSLExecutionNotFoundError < StandardError
     end
 
+    class InvalidDescriptionError < StandardError
+    end
+
     # A dynamic DSL can be used multiple times on the same class, each time the DSL is used
     # a corresponding execution will be created. The execution contains the resulting configuration
     # from that particular use of the DSL.
@@ -19,9 +22,12 @@ module DSLCompose
     # the parser can provide usage notes for how this dsl is being used, these are used to
     # generate documentation
     def add_parser_usage_note child_class, note
+      unless note.is_a?(String) && note.strip.length > 0
+        raise InvalidDescriptionError, "The parser usage description `#{note}` is invalid, it must be of type string and have length greater than 0"
+      end
       @parser_usage_notes ||= {}
       @parser_usage_notes[child_class] ||= []
-      @parser_usage_notes[child_class] << DSLCompose::FixHeredocIndentation.fix_heredoc_indentation(note)
+      @parser_usage_notes[child_class] << note.strip
     end
 
     # return the list of notes which describe how the parsers are using this DSL

data/lib/dsl_compose/version.rb

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

data/lib/dsl_compose.rb

@@ -51,8 +51,6 @@ require "dsl_compose/composer"
 
 require "dsl_compose/class_coerce"
 
-require "dsl_compose/fix_heredoc_indentation"
-
 require "dsl_compose/shared_configuration"
 
 require "dsl_compose/dsls"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dsl_compose
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.5.1
 platform: ruby
 authors:
 - Craig Ulliott
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-01 00:00:00.000000000 Z
+date: 2023-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: class_spec_helper
@@ -62,7 +62,6 @@ files:
 - lib/dsl_compose/dsl/dsl_method/interpreter.rb
 - lib/dsl_compose/dsl/interpreter.rb
 - lib/dsl_compose/dsls.rb
-- lib/dsl_compose/fix_heredoc_indentation.rb
 - lib/dsl_compose/interpreter.rb
 - lib/dsl_compose/interpreter/execution.rb
 - lib/dsl_compose/interpreter/execution/arguments.rb

data/lib/dsl_compose/fix_heredoc_indentation.rb

@@ -1,21 +0,0 @@
-module DSLCompose
-  # A small helper to fix indentation and clean up whitespace in
-  # strings which were created with rubys heredoc syntax.
-  module FixHeredocIndentation
-    # This method is used to trim empty lines from the start and end of
-    # a block of markdown, it will also fix the indentation of heredoc
-    # strings by removing the leading whitespace from the first line, and
-    # that same amount of white space from every other line
-    def self.fix_heredoc_indentation string
-      # replace all tabs with spaces
-      string = string.gsub(/\t/, "  ")
-      # remove empty lines from the start of the string
-      string = string.gsub(/\A( *\n)+/, "")
-      # remove empty lines from the end of the string
-      string = string.gsub(/( *\n)+\Z/, "")
-      # removes the number of leading spaces on the first line, from
-      # all the other lines
-      string.gsub(/^#{string[/\A */]}/, "")
-    end
-  end
-end