dsl_compose 2.2.2 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b5f53afb63b68aac27995b0fee8dceb7c0f5649a171f187bf95c85ebe29215e
-  data.tar.gz: 9ee378a6a342684339a0ff2472ed0aa37fb4d3a5e3e3f71f9eb9b87d5f013b37
+  metadata.gz: 43cfe766f3e464ba7f5a22128e7f5155806f92686555aef5f2f06af2b58916af
+  data.tar.gz: 999dc31a662af4684b2956a50c226aa596b345ece609d2b9ace058eea211f924
 SHA512:
-  metadata.gz: 6f9494f1e9054d83bff8601aa6bf2c7e6fc887af2a7c3f762649d32d71116fa0c9856f1d94811df32246f7cf345eafdb06987946da9524832d2a8c9e366f4284
-  data.tar.gz: 42f04fe0ee1e3341716a446fd3747ba7bce072d921dcb2cf62ebe3a8d4e7112336ec3b5d42cd87c56076cbbaf36f29ccfe3925f1e1f13776d4d5a38f244f1b9f
+  metadata.gz: 78b2add3e95f52ae184abb3d2a30f9218d966a8d44e378b72ea37c5ad2dfd6c3409f7a9cf08e4762d17cf717c2ff35c2f7da4ce5a28d8959eacbcf92c484c0db
+  data.tar.gz: 7d4e1550f001a40d0665c6258eff2cd16d0052f209b1c6741a3252b0623f698345d8344014555153649dd705077dda8cc39d08531bb95bd5df4611cde257c156

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [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)
+
+
+### Features
+
+* added a method_called? helper method to the DSL parser ([48e68a8](https://github.com/craigulliott/dsl_compose/commit/48e68a8d799e297d3433f3d2a6bccb7a077dd9af))
+
 ## [2.2.2](https://github.com/craigulliott/dsl_compose/compare/v2.2.1...v2.2.2) (2023-07-27)
 
 

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.
@@ -286,6 +291,12 @@ class MyParser < DSLCompose::Parser
         other than making calls to `for_method`
       DESCRIPTION
 
+      # Within a `for_dsl` block you can determine if a specific DSL method was used
+      # with the `method_called?` method. This method will return true if the method was
+      # used, otherwise it will return false. If a method with the provided name does not
+      # exist for the DSL, then an error will be raised.
+      was_some_method_name_used = method_called? :some_method_name
+
       # `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.

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)
@@ -109,6 +114,16 @@ module DSLCompose
           ForMethodParser.new(@base_class, @child_class, @dsl_execution, method_names, &block)
         end
 
+        # Given a method name, will return true if the method was called within the current DSL
+        # execution, otherwise it will return false
+        def method_called? method_name
+          # get the dsl method from the current dsl execution, this
+          # will raise an error if the method does not exist
+          dsl_method = @dsl_execution.dsl.dsl_method(method_name)
+          # was this method called within the current DSL execution?
+          @dsl_execution.method_calls.method_called? dsl_method.name
+        end
+
         # takes a description of what this parser does and stores it against the DSL definition
         # of the current @child_class, this is used to generate documentation for what the parser
         # has done with the DSL

data/lib/dsl_compose/version.rb

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

metadata

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