dsl_compose 1.11.0 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6a23cf9faddf37ebe1fdec13fe554e8e7601e01f5c53495d8d3d37f28a63faf
-  data.tar.gz: 7254f3f5c46716e462189c72d2bd02b0131cdca1fb39387a8b86fd79cb2e9c6c
+  metadata.gz: a22a3595bbf6990c27628cf872f751939156cc9cda865d6ae05ca9cd6e6ba544
+  data.tar.gz: 79fcd4ddb46ecc10cc1dd84f50515c4bb85067a0b26482d7a6250112b4d44fc8
 SHA512:
-  metadata.gz: c71462286d85bdc0b4f2d3879b08bf04a142b4f10bb9554c230fa263d80e69d08fe73bd3cc198d516d8950df1a8b39863823cf0993b3a80af2110b80de69f2a6
-  data.tar.gz: 5b03471c8e676610297c16312b517bd62692fa5d85e5a610aed709684058032764668550622c84089d4cc6b7240d76c2d6a9d21487a4abf074eecaf93b6c19bd
+  metadata.gz: 4cc5bf277a33d63d0dba6aa3053bfec1b5154d7f337c7e0e6fd0db2e5f429718e12097b640069904e44d95d02d2d576604d571cc45c96687ab8316064b4de3a7
+  data.tar.gz: 52a29affc55dd62fe4abbc965dc22973c1a01ba7acc170e33e8f7191ddf1ab19e4456f288cf69864282bea49afa8ac445ce1c1316053c07a6b4f2ef0ef1ba10a

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [1.12.0](https://github.com/craigulliott/dsl_compose/compare/v1.11.0...v1.12.0) (2023-07-13)
+
+
+### Features
+
+* parsers are now aware of class inheritance, and all classes now assume the DSL configurations of all their ancestors ([#33](https://github.com/craigulliott/dsl_compose/issues/33)) ([6a6cfb1](https://github.com/craigulliott/dsl_compose/commit/6a6cfb1fd9bb44c2ea949888c7b7be14ddc0cef8))
+
 ## [1.11.0](https://github.com/craigulliott/dsl_compose/compare/v1.10.0...v1.11.0) (2023-07-12)
 
 

data/README.md

@@ -241,8 +241,7 @@ A parser class can be used to process complicated DSLs. In the example below, a
 # create your own parser by creating a new class which extends DSLCompose::Parser
 MyParser < DSLCompose::Parser
   # `for_children_of` will process SomeBaseClass and yield the provided
-  # block once for every class which extends SomeBaseClass and uses at
-  # least one of the DSLs that have been defined on it.
+  # block once for every class which extends SomeBaseClass
   for_children_of SomeBaseClass do |child_class:|
     # `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
@@ -253,7 +252,9 @@ MyParser < DSLCompose::Parser
     # You can optionally provide keyword arguments which correspond to any
     # arguments that were defined for the DSL, if multiple dsl names are provided
     # then the requested dsl argument must be present on all DSLs otherwise an
-    # error will be raised.
+    # 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:|
       # `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

data/lib/dsl_compose/interpreter.rb

@@ -40,9 +40,10 @@ module DSLCompose
       @executions.filter { |e| e.dsl.name == dsl_name }
     end
 
-    # Returns an array of all executions for a given name and class.
+    # Returns an array of all executions for a given name and class. This includes
+    # any ancestors of the provided class
     def class_dsl_executions klass, dsl_name
-      @executions.filter { |e| e.klass == klass && e.dsl.name == dsl_name }
+      @executions.filter { |e| e.dsl.name == dsl_name && (e.klass == klass || klass < e.klass) }
     end
 
     # removes all executions from the interpreter, this is primarily used from

data/lib/dsl_compose/parser/for_children_of_parser.rb

@@ -15,8 +15,26 @@ module DSLCompose
       class NoChildClassError < StandardError
       end
 
-      # This class will yield to the provided block for each class which extends the base_class, provided
-      # that the child also uses at least one of the DSLs which have been defined on the base_class
+      # This class will yield to the provided block for each descendant
+      # class of the provided base_class
+      #
+      # For example:
+      #
+      # class BaseClass
+      #   include DSLCompose::Composer
+      #   define_dsl :my_foo_dsl
+      # end
+      #
+      # class ChildClass < BaseClass
+      #   my_foo_dsl
+      # end
+      #
+      # class GrandchildClass < ChildClass
+      # end
+      #
+      # parser.for_children_of BaseClass do |child_class:|
+      #    # this will yield for ChildClass and GrandchildClass
+      # and
       def initialize base_class, &block
         # assert the provided class has the DSLCompose::Composer module installed
         unless base_class.respond_to? :dsls
@@ -38,9 +56,8 @@ module DSLCompose
           end
         end
 
-        # yield the provided block for each child class of the provided base_class
-        # which uses a defined DSL
-        base_class.dsls.executions_by_class.each do |child_class, dsl|
+        # yeild the block for all descendents of the provided base_class
+        ObjectSpace.each_object(Class).select { |klass| klass < base_class }.each do |child_class|
           args = {}
           if BlockArguments.accepts_argument?(:child_class, &block)
             args[:child_class] = child_class
@@ -57,7 +74,7 @@ module DSLCompose
 
       # Given a dsl name, or array of dsl names, this method will yield to the
       # provided block once for each time a dsl with one of the provided names
-      # was used on the correspondng child_class
+      # was used on the correspondng child_class or any of its ancestors.
       #
       # The value of child_class and base_class are set from the yield of this
       # classes initializer, meaning that the use of this method should look

data/lib/dsl_compose/version.rb

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

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: dsl_compose
 version: !ruby/object:Gem::Version
-  version: 1.11.0
+  version: 1.12.0
 platform: ruby
 authors:
 - Craig Ulliott
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-07-12 00:00:00.000000000 Z
-dependencies: []
+date: 2023-07-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: class_spec_helper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 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
   the class or a child class.