dsl_compose 2.15.4 → 2.15.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c630022da7a35c7bb15fcb5847b3036dc21e45b0afd950edb4fa6bb205147f4
-  data.tar.gz: ed8a49a2b1ec77a4a741a1eeaddd4fb52019ad307cf96c2d8f531f1df4d24a7f
+  metadata.gz: e0750c158e424591df6b08e2ac3786b689116b5850152b6f6fe51fc39092895a
+  data.tar.gz: 7e818d88dd0dde898b80faa4eb24f18eaa6ca8bd64a4c83fc974621ccee71e3e
 SHA512:
-  metadata.gz: 96aa671032ce71ce1d7639ab8fbf25d7e3f17d58f3b822a1601b6af99808502083d284b4f6cbea7541dc271a8d1dcf0e005f98d066852d86a9b88d3e194125cb
-  data.tar.gz: 5d17dfa43b30dae88aebdff5bc192d083fa3cf668e896a9fb71c314304b9b8320a4dfb6444b1055b8fde0d0da45d0285d38982ae7cbcf006d93f1c634d86ca38
+  metadata.gz: a374a44e85a232cc6681c98034a1196cc7ccc077689a3f9bb75354aa54e0e02be8758a527de68944af95c81f04157b07df4bcaccab20877cfee48f2164eddad2
+  data.tar.gz: 73fd1c43e1677b42c2389a4919e0ced10feda5e35ca564d1d025376fbb357282f5d8bf7411980d3d9d744c46b6d50cbc2fa370314ad0c4de58093eec569fc53d

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## [2.15.5](https://github.com/craigulliott/dsl_compose/compare/v2.15.4...v2.15.5) (2023-10-06)
+
+
+### Bug Fixes
+
+* added a first_use_only option to the parser so that only the most recent execution of a DSL will be used ([717293d](https://github.com/craigulliott/dsl_compose/commit/717293d906a183d8a13ffa1c4ae47e901de428a0))
+* specs and fixes for `first_use_only` option on parser ([a7dc087](https://github.com/craigulliott/dsl_compose/commit/a7dc0878ffef9a104c25d4f43d5796f939cb7567))
+
 ## [2.15.4](https://github.com/craigulliott/dsl_compose/compare/v2.15.3...v2.15.4) (2023-10-04)
 
 

data/lib/dsl_compose/interpreter.rb

@@ -66,8 +66,15 @@ module DSLCompose
 
     # 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, on_current_class, on_ancestor_class
-      @executions.filter { |e| e.dsl.name == dsl_name && ((on_current_class && e.klass == klass) || (on_ancestor_class && klass < e.klass)) }
+    def class_dsl_executions klass, dsl_name, on_current_class, on_ancestor_class, first_use_only
+      filtered_executions = @executions.filter { |e| e.dsl.name == dsl_name && ((on_current_class && e.klass == klass) || (on_ancestor_class && klass < e.klass)) }
+      # Because the classes were evaluated in order, we can just return the
+      # last execution
+      if first_use_only && filtered_executions.length > 0
+        [filtered_executions.last]
+      else
+        filtered_executions
+      end
     end
 
     # returns the most recent, closest single execution of a dsl with the
@@ -83,7 +90,7 @@ module DSLCompose
       # note that this method does not need to do any special sorting, the required
       # order for getting the most recent execution is already guaranteed because
       # parent classes in ruby always have to be evaluated before their descendants
-      class_dsl_executions(klass, dsl_name, true, true).last
+      class_dsl_executions(klass, dsl_name, true, true, false).last
     end
 
     # removes all executions from the interpreter, and any parser_usage_notes

data/lib/dsl_compose/parser/for_children_of_parser/for_dsl_parser.rb

@@ -20,7 +20,7 @@ module DSLCompose
         # of the provided name is used by the child class.
         #
         # base_class and child_class are set from the ForChildrenOfParser
-        def initialize base_class, child_class, dsl_names, on_current_class, on_ancestor_class, &block
+        def initialize base_class, child_class, dsl_names, on_current_class, on_ancestor_class, first_use_only, &block
           @base_class = base_class
           @child_class = child_class
           @dsl_names = dsl_names
@@ -62,7 +62,7 @@ module DSLCompose
           dsl_names.each do |dsl_name|
             # a dsl can be execued multiple times on a class, so we find all of the executions
             # here and then yield the block once for each execution
-            base_class.dsls.class_dsl_executions(child_class, dsl_name, on_current_class, on_ancestor_class).each do |dsl_execution|
+            base_class.dsls.class_dsl_executions(child_class, dsl_name, on_current_class, on_ancestor_class, first_use_only).each do |dsl_execution|
               # we only provide the requested arguments to the block, this allows
               # us to use keyword arguments to force a naming convention on these arguments
               # and to validate their use

data/lib/dsl_compose/parser/for_children_of_parser.rb

@@ -90,36 +90,42 @@ module DSLCompose
       # end
       #
       # If `on_current_class` is true, then the block will be yielded to for each DSL
-      # which was used directly on the current class. If `oncurrent_class` is false,
-      # then the block will not be yielded to for any DSL which was used directly on.
+      # which was used directly on the current class. If `on_current_class` is false,
+      # then the block will not be yielded to for any DSL which was used directly on it.
       # If `on_ancestor_class` is true, then the block will be yielded to for each DSL
       # which was used on any class in the current classes ancestry. If `on_ancestor_class`
       # is false, then the block will not be yielded to for any DSL which was used on
       # any class in the current classes ancestry.
-      def for_dsl dsl_names, on_current_class: true, on_ancestor_class: false, &block
+      #
+      # If `first_use_only` is true, then this block will only yeild once for each subject class
+      # which directly uses or inherits use of the provided DSL. The DSL execution which occurs
+      # first in the class will be selected, and if the class does not use the DSL then each of
+      # the classes ancestors will be tested until an execution is found (only the current class
+      # will be tested if skip_inherited_dsls has been set to true).
+      def for_dsl dsl_names, on_current_class: true, on_ancestor_class: false, first_use_only: false, &block
         child_class = @child_class
 
         unless child_class
           raise NoChildClassError, "No child_class was found, please call this method from within a `for_children_of` block"
         end
 
-        ForDSLParser.new(@base_class, child_class, dsl_names, on_current_class, on_ancestor_class, &block)
+        ForDSLParser.new(@base_class, child_class, dsl_names, on_current_class, on_ancestor_class, first_use_only, &block)
       end
 
       # this is a wrapper for the `for_dsl` method, but it provides a value of true
       # for the `on_ancestor_class` argument and a value of false for the `on_current_class`
       # argument. This will cause the parser to only yeild for dsls which were used on
       # a class which is in the current classes ancestry, but not on the current class
-      def for_inherited_dsl dsl_names, &block
-        for_dsl dsl_names, on_current_class: false, on_ancestor_class: true, &block
+      def for_inherited_dsl dsl_names, first_use_only: false, &block
+        for_dsl dsl_names, on_current_class: false, on_ancestor_class: true, first_use_only: first_use_only, &block
       end
 
       # this is a wrapper for the `for_dsl` method, but it provides a value of true
       # for the `on_ancestor_class` argument and a value of true for the `on_current_class`
       # argument. This will cause the parser to yeild for dsls which were used on either
       # the current class or any class in its ancestry
-      def for_dsl_or_inherited_dsl dsl_names, &block
-        for_dsl dsl_names, on_current_class: true, on_ancestor_class: true, &block
+      def for_dsl_or_inherited_dsl dsl_names, first_use_only: false, &block
+        for_dsl dsl_names, on_current_class: true, on_ancestor_class: true, first_use_only: first_use_only, &block
       end
 
       # takes a description of what this parser does and stores it against the DSL definition

data/lib/dsl_compose/reader.rb

@@ -89,7 +89,7 @@ module DSLCompose
     # Returns an array of ExecutionReaders to represent each time the DSL was used
     # on the provided class.
     def executions
-      @dsl_defining_class.dsls.class_dsl_executions(@klass, @dsl_name, true, false).map do |execution|
+      @dsl_defining_class.dsls.class_dsl_executions(@klass, @dsl_name, true, false, false).map do |execution|
         ExecutionReader.new execution
       end
     end
@@ -100,7 +100,7 @@ module DSLCompose
     # earliest ancestor first and if the DSL was used more than once on a class then
     # the order they were used.
     def ancestor_executions
-      @dsl_defining_class.dsls.class_dsl_executions(@klass, @dsl_name, false, true).map do |execution|
+      @dsl_defining_class.dsls.class_dsl_executions(@klass, @dsl_name, false, true, false).map do |execution|
         ExecutionReader.new execution
       end
     end
@@ -110,7 +110,7 @@ module DSLCompose
     # be returned in the order they were executed, which is the earliest ancestor first
     # and if the DSL was used more than once on a class then the order they were used.
     def all_executions
-      @dsl_defining_class.dsls.class_dsl_executions(@klass, @dsl_name, true, true).map do |execution|
+      @dsl_defining_class.dsls.class_dsl_executions(@klass, @dsl_name, true, true, false).map do |execution|
         ExecutionReader.new execution
       end
     end

data/lib/dsl_compose/version.rb

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

data/sig/dsl_compose/parser/for_children_of_parser/for_dsl_parser.rbs

@@ -8,7 +8,7 @@ module DSLCompose
         @dsl_names: Array[Symbol]
         @dsl_execution: Interpreter::Execution
 
-        def initialize: (singleton(Object) base_class, singleton(Object) child_class, Array[Symbol] dsl_names, bool on_current_class, bool on_ancestor_class) -> void
+        def initialize: (singleton(Object) base_class, singleton(Object) child_class, Array[Symbol] dsl_names, bool on_current_class, bool on_ancestor_class, bool first_use_only) -> void
 
         # overriding this method because steep doesn't
         # correctly infer that a block is being passed to this method

data/sig/dsl_compose/parser/for_children_of_parser.rbs

@@ -14,10 +14,12 @@ module DSLCompose
       ) -> void
 
       private
-      def for_dsl: (Array[Symbol] dsl_names, ?on_current_class: bool, ?on_ancestor_class: bool) -> untyped
+      def for_dsl: (Array[Symbol] dsl_names, ?on_current_class: bool, ?on_ancestor_class: bool, ?first_use_only: bool) -> untyped
+      def for_inherited_dsl: (Array[Symbol] dsl_names, ?first_use_only: bool) -> untyped
+      def for_dsl_or_inherited_dsl: (Array[Symbol] dsl_names, ?first_use_only: bool) -> untyped
 
       class AllBlockParametersMustBeKeywordParametersError < StandardError
-        end
+      end
 
       class ClassDoesNotUseDSLComposeError < StandardError
       end
@@ -26,7 +28,7 @@ module DSLCompose
       end
 
       class NoChildClassError < StandardError
-        end
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dsl_compose
 version: !ruby/object:Gem::Version
-  version: 2.15.4
+  version: 2.15.5
 platform: ruby
 authors:
 - Craig Ulliott
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-10-04 00:00:00.000000000 Z
+date: 2023-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: class_spec_helper