dsl_compose 1.14.0 → 1.14.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8fe38926f435f6f7978468bb08e0b91ebbd6962d5863032a7cb49095856c3c50
-  data.tar.gz: c4523746ddbef25e5c64e8b47ea624393d6efa25f0c6b795a0d69ea7910d2683
+  metadata.gz: 623399acb76c51f12e07ed2ac76358334298cd9714a222ad271a3c90b1cc2aa2
+  data.tar.gz: 42069e337ec7435aea513ffd42f7303d62d62900f84de3e9822129e895fb3e92
 SHA512:
-  metadata.gz: ef54cc72949be0609a9bd1feacad07b202c90b183f6be89c6494c19a95944639ccc0cba3986375a16234803aa96f4e90721abc2308fa75e20ace407504bfedce
-  data.tar.gz: 4143b1a1d0d84597da9fa29ef745a9ca0002fc4bc6107a9206b700453f511cdc1e7a0bc6eea16af69e169cc3c220ff43bbbdd5b8603df58704bcc9d51fa5d58b
+  metadata.gz: a68c4971e5ac2057e31df63d28ec097c9f5a0ceaca2dc80d9a5997e50373218831c5aeb3733d9b005b9cb2a849d30065e28b5844e376e2fc8093667cf12cf887
+  data.tar.gz: '097c77a640d68e46057911d0b75067fd215d251e6fc218982ee8f4d37ff315cb87e3e6f1db1079806d881018ef84a900f1cd17178b04f20616127bb56545750a'

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [1.14.2](https://github.com/craigulliott/dsl_compose/compare/v1.14.1...v1.14.2) (2023-07-19)
+
+
+### Bug Fixes
+
+* fixed parser usage notes not being cleared as expected ([#43](https://github.com/craigulliott/dsl_compose/issues/43)) ([3d31ab1](https://github.com/craigulliott/dsl_compose/commit/3d31ab1a8dc238144749c18847d5e655461fca06))
+
+## [1.14.1](https://github.com/craigulliott/dsl_compose/compare/v1.14.0...v1.14.1) (2023-07-19)
+
+
+### Bug Fixes
+
+* Clearing the parser_usage_notes when also clearing the DSLs. ([#41](https://github.com/craigulliott/dsl_compose/issues/41)) ([bbdb445](https://github.com/craigulliott/dsl_compose/commit/bbdb445ed9fa4b495f8aa5bf0b889707680858d0))
+
 ## [1.14.0](https://github.com/craigulliott/dsl_compose/compare/v1.13.1...v1.14.0) (2023-07-19)
 
 

data/README.md

@@ -247,6 +247,16 @@ 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
+      You can optionally provide a description of anything specific that your parser
+      does in this block, this description will be used when generating documentation
+
+      This description accepts markdown.
+
+      Do not add a description here if the parser does not have any business logic here
+      other than making calls to `for_dsl`, `for_dsl_or_inherited_dsl` or `for_inherited_dsl`
+    DESCRIPTION
+
     # `for_dsl` accepts a DSL name or an array of DSL names and will yield it's
     # provided block once for each time a DSL of that name has been used
     # directly on the child_class.
@@ -266,6 +276,16 @@ MyParser < DSLCompose::Parser
     # 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:|
+      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.
+
+        This description accepts markdown.
+
+        Do not add a description here if the parser does not have any business logic here
+        other than making calls to `for_method`
+      DESCRIPTION
+
       # `for_method` accepts a method name or an array of method names and will
       # yield it's provided block once for each time a method with this name is
       # executed within the DSL.
@@ -277,6 +297,13 @@ 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
+          You can optionally provide a description of anything specific that your parser
+          does in this block, this description will be used when generating documentation.
+
+          This description accepts markdown.
+        DESCRIPTION
+
         # your business logic goes here
         ...
       end

data/lib/dsl_compose/interpreter.rb

@@ -61,11 +61,13 @@ module DSLCompose
       @executions.filter { |e| e.dsl.name == dsl_name && ((on_current_class && e.klass == klass) || (on_ancestor_class && klass < e.klass)) }
     end
 
-    # removes all executions from the interpreter, this is primarily used from
-    # within a test suite when dynamically creating classes for tests and then
-    # wanting to clear the interpreter before the next test.
+    # removes all executions from the interpreter, and any parser_usage_notes
+    # this is primarily used from within a test suite when dynamically creating
+    # classes for tests and then wanting to clear the interpreter before the
+    # next test.
     def clear
       @executions = []
+      @parser_usage_notes = {}
     end
 
     def to_h dsl_name

data/lib/dsl_compose/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dsl_compose
 version: !ruby/object:Gem::Version
-  version: 1.14.0
+  version: 1.14.2
 platform: ruby
 authors:
 - Craig Ulliott