dsl_compose 1.4.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1a173b5c152d3e0e4ac3867b9f55989593a82f724ad27c26aa0445500c81295
-  data.tar.gz: 391d451dcef58cf46915b0b54249b527097210d916aa041e1d49de4c576845d8
+  metadata.gz: 51a691703918ebafb30bb7c158e627e6a02597e9171e38d1b87cd4cd066d825d
+  data.tar.gz: 4e750c6839f7946299f13e81b8af0a7ca94e8d852d7a418f8be97658a0ba67a8
 SHA512:
-  metadata.gz: 9d049bc5ed8c830468376cefcb198fc2671c7eff26b9a0a3fff33377d0ac2c27c03f2b2c2fa1527ef648a847667d5fe58b814c355f058e5cb3bceb80439e0ac7
-  data.tar.gz: 7af648a16098f0ce9b6a0c20936b0b87195cf0e2c8e7869769b5ff293d059b6ca39a0da30b15fb1605d558faeaf5965e616c3cb253bc34daec6e683879ee4da9
+  metadata.gz: aa82b56b1c7b6cfcbf4b0116c34b4084f5873cd5d957ceb615b16ab4b36f44a6d3da1ffea8a8ef779b837322d0622254e8688fa4fecffdcb6a011a531aa31106
+  data.tar.gz: b1d02bc6e922d35aeee52095bfd3847d5ae347ef56e6278a4f90bb4c76666e0829dad6638956f96a555400a129160f5431d197b264dc1103532c2a1b6df14de2

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [1.6.0](https://github.com/craigulliott/dsl_compose/compare/v1.5.0...v1.6.0) (2023-07-07)
+
+
+### Features
+
+* added an interpreter clear method to erase state between tests ([#17](https://github.com/craigulliott/dsl_compose/issues/17)) ([9d0a0c9](https://github.com/craigulliott/dsl_compose/commit/9d0a0c9c521bed61f08fecaa388d1410f513498b))
+
+## [1.5.0](https://github.com/craigulliott/dsl_compose/compare/v1.4.0...v1.5.0) (2023-07-07)
+
+
+### Features
+
+* adding a parser method to rerun the parser, this is most useful from within a test suite when you are testing the parser itself ([#15](https://github.com/craigulliott/dsl_compose/issues/15)) ([fe4de0e](https://github.com/craigulliott/dsl_compose/commit/fe4de0e53f78aff34de4ba1c432b10022d2b6ab4))
+
 ## [1.4.0](https://github.com/craigulliott/dsl_compose/compare/v1.3.0...v1.4.0) (2023-06-26)
 
 

data/README.md

@@ -11,9 +11,9 @@ Ruby gem to add dynamic DSLs to classes
 
 * Contains a simple internal DSL which is used to declare dynamic DSLs on your classes
 * Takes special care not to pollute the namespace of classes where it is used
-* Use of your declared DSLs is validated at run time
-* Automatically generate documentation and instructions for your DSLs
-* Complete test coverage
+* Use of your declared DSLs is strictly validated at run time
+* Automatically generate documentation for your DSLs
+* Extensive test coverage
 * Very lightweight and no external dependencies
 
 ## Installation
@@ -28,7 +28,7 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ## Usage
 
-DSLs are added to classes by including the DSLCompose::Composer module, and then calling the define_dsl singleton method within the class or a child class.
+DSLs are defined and added to classes by including the `DSLCompose::Composer` module, and then calling the `define_dsl` singleton method on that class. Those DSLs can then be used on child classes (classes which extend the original class).
 
 ### Defining your DSL
 
@@ -36,11 +36,11 @@ DSLs are added to classes by including the DSLCompose::Composer module, and then
 class Foo
   include DSLCompose::Composer
 
-  # Define and name the DSL. Your DSL will available on this
+  # Define and name your DSL. Your DSL will be available on this
   # class and any children of this class.
-  define_dsl :my_dsl do
+  define_dsl :your_dsl do
 
-    # A description of your DSL.
+    # A description of your DSL
     description <<-DESCRIPTION
       Add a description of your DSL here, this description will be
       used when generating the documentation for your DSL.
@@ -49,8 +49,8 @@ class Foo
     DESCRIPTION
 
     # You can add required or optional arguments to the initial method which is used
-    # to enter your dynamic DSL (for optional arguments, use `optional` instead of
-    # `required`).
+    # to call your dynamic DSL (for optional arguments, use `optional` instead of
+    # `required`)
     #
     # Arguments are validated, and their expected type must be defined. Supported
     # argument types are :integer, :boolean, :float, :string or :symbol
@@ -66,29 +66,29 @@ class Foo
       # You should provide descriptions for your methods. These descriptions will
       # be used when generating your documentation. Both of these descriptions
       # accept markdown
-      description "A description of my awesome method"
+      description "A description of your method"
 
-      # add your method argument definition here
+      # Add your method argument definition here
     end
 
-    # Define a required within your DSL. If a class uses your DSL but
-    # does not execute this method then an error will be raised.
+    # Define a required method within your DSL. An error will be raised if a class
+    # uses your DSL but does not execute this method
     add_method :a_required_method, required: true do
-      # add your description and method argument definition here (see below)
+      # Add your description here
+      # Add any method arguments here (more info below about method arguments)
     end
 
     # Define a method which can only be called once within your DSL. These
-    # methods will raise an error of they are called multiple times.
+    # "unique" methods will raise an error of they are called multiple times.
     #
-    # There "unique" methods can be optionally marked as required.
+    # unique methods can be optionally marked as required.
     add_unique_method :an_optional_method do
-      # add your description and method argument definition here (see below)
+      # Add your description and any method arguments here (more info below about method arguments)
     end
 
     # Define a method in your DSL which takes arguments
-    add_method :my_method do
-      # A description of my DSL method
-      description "A description of my DSL method"
+    add_method :your_method do
+      description "A description of your DSL method"
 
       # You can add required arguments to your methods. The order in which you
       # define these arguments determines the order of the arguments in your final DSL.
@@ -96,7 +96,7 @@ class Foo
       # Arguments are validated, and their expected type must be defined. Supported
       # argument types are :integer, :boolean, :float, :string or :symbol
       requires :first_method_argument, :string do
-        # You should provide descriptions for your arguments. These descriptions will
+        # You should provide descriptions for your arguments too. These descriptions will
         # be used when generating your documentation. This description supports markdown
         description "A description of the first argument for this method"
       end
@@ -124,8 +124,8 @@ Child classes can then use your new DSL
 ```ruby
 class Bar << Foo
 
-  my_dsl :first_dsl_argument, do
-    my_method "first_method_argument", optional_argument: 123
+  your_dsl :first_dsl_argument, do
+    your_method "first_method_argument", optional_argument: 123
   end
 
 end

data/lib/dsl_compose/interpreter.rb

@@ -37,6 +37,13 @@ module DSLCompose
       @executions.filter { |e| e.klass == klass && e.dsl.name == dsl_name }
     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.
+    def clear
+      @executions = []
+    end
+
     def to_h dsl_name
       h = {}
       dsl_executions(dsl_name).each do |execution|

data/lib/dsl_compose/parser.rb

@@ -27,10 +27,28 @@ module DSLCompose
     # the first step in defining a parser is to set the base_class, this method
     # will yield to the provided block for each child class of the provided base_class
     # provided that the child_class uses at least one of the base_classes defined DSLs
-    def self.for_children_of base_class, &block
+    def self.for_children_of base_class, rerun = false, &block
+      unless rerun
+        @runs ||= []
+        @runs << {
+          base_class: base_class,
+          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, &block)
     end
+
+    # this method is used to rerun the parser, this is most useful from within a test suite
+    # when you are testing the parser itself
+    def self.rerun
+      @runs&.each do |run|
+        base_class = run[:base_class]
+        block = run[:block]
+        for_children_of base_class, true, &block
+      end
+    end
   end
 end

data/lib/dsl_compose/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dsl_compose
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Craig Ulliott
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-26 00:00:00.000000000 Z
+date: 2023-07-07 00:00:00.000000000 Z
 dependencies: []
 description: Ruby gem to add dynamic DSLs to classes. DSLs are added to classes by
   including the DSLCompose module, and then calling the add_dsl singleton method within