dsl_compose 1.9.1 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7fc1bd78d6f3926b9ee718a6e2191cefd5aecd40fcfbb5de9a8cfbd8c602e65c
-  data.tar.gz: 7b9fd87ecf61b71831f56ab9120562cb3fbb3d49424dc7862c31014e6dc96d45
+  metadata.gz: d4269fe819882b592d12b6cce51673a6ef4d87116521ff267c76a7a23aab0382
+  data.tar.gz: 9f13611b9417a7e34f0f81d4ccfda152eb5593168a483a011ccf2949a5624937
 SHA512:
-  metadata.gz: d3f750f7d8d5d1d7b2014cd84ad10d656d005e2738b18c8ed89f108656b5f9037a428f6ec1094af5382d9788985f3c205c68f06198c8a18e2dfc01f518203cb6
-  data.tar.gz: 12a823a699962ee5426a53ab66517f5acb23bd1fbc6834b219d6209d09ba78a9a9b249a1169497a0a2773287f24abf2d7c065c3f126f702bf4927c13180a15aa
+  metadata.gz: 8923178c3d5ce6ab78229eb22a86412f2b4e7c9da41528b0b752965438dde12c6e8bfb1930880433ab4db2490efd36e15243e907f402544e4c2281a0b81f42e4
+  data.tar.gz: e5a0d13825e052290e865365a933b36f6dedcc668f5642283e7f6cbe227617697e83898dec9224179f9f569aa7727a1a6b796201441377431d19ba2235d69fd3

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [1.10.0](https://github.com/craigulliott/dsl_compose/compare/v1.9.1...v1.10.0) (2023-07-11)
+
+
+### Features
+
+* ability to easily share configuration between multiple DSLs ([#27](https://github.com/craigulliott/dsl_compose/issues/27)) ([38ff61b](https://github.com/craigulliott/dsl_compose/commit/38ff61bed7c9d4357a0019c40fc20bc54d62bebb))
+
 ## [1.9.1](https://github.com/craigulliott/dsl_compose/compare/v1.9.0...v1.9.1) (2023-07-11)
 
 

data/README.md

@@ -15,6 +15,7 @@ Ruby gem to add dynamic DSLs to classes
 * Automatically generate documentation for your DSLs
 * Extensive test coverage
 * Very lightweight and no external dependencies
+* Share common DSL configuration between DSLs
 
 ## Installation
 
@@ -117,6 +118,39 @@ end
 
 ```
 
+### Shared Configuration
+
+If you are composing many DSLs across one or many classes and these DSLs share common configuration, then you can share configuration between them.
+
+Define your shared configuration
+
+```ruby
+DSLCompose::SharedConfiguration.add :my_common_validators do
+  validate_not_end_with [:_id, :_at, :_count, :_type]
+  validate_not_in [:type, :stage]
+  validate_length minimum: 0, maximum: 10
+  validate_format /\A[a-z]+(_[a-z]+)*\Z/
+end
+```
+
+Use your shared DSL from within any of your DSL compositions
+
+```ruby
+class Foo
+  include DSLCompose::Composer
+
+  define_dsl :your_dsl do
+    optional :optional_argument, :integer do
+      # this will import and apply your shared configuration
+      import_shared :my_common_validators
+    end
+
+  end
+end
+```
+
+You can use `import_shared` anywhere within your DSL definition, you can even use `import_shared` within other shared configuration
+
 ### Using your DSL
 
 Child classes can then use your new DSL

data/lib/dsl_compose/dsl/arguments/argument/interpreter.rb

@@ -99,6 +99,14 @@ module DSLCompose
           def validate_format regexp
             @argument.validate_format regexp
           end
+
+          # executes the shared configuration block with the given name within the
+          # context of this part of the DSL, this is a mechanism to share configuration
+          # between DSLs
+          def import_shared shared_configuration_name
+            block = SharedConfiguration.get shared_configuration_name
+            instance_eval(&block)
+          end
         end
       end
     end

data/lib/dsl_compose/dsl/dsl_method/interpreter.rb

@@ -51,6 +51,14 @@ module DSLCompose
         def requires name, type, &block
           @dsl_method.arguments.add_argument name, true, type, &block
         end
+
+        # executes the shared configuration block with the given name within the
+        # context of this part of the DSL, this is a mechanism to share configuration
+        # between DSLs
+        def import_shared shared_configuration_name
+          block = SharedConfiguration.get shared_configuration_name
+          instance_eval(&block)
+        end
       end
     end
   end

data/lib/dsl_compose/dsl/interpreter.rb

@@ -67,6 +67,14 @@ module DSLCompose
       def requires name, type, &block
         @dsl.arguments.add_argument name, true, type, &block
       end
+
+      # executes the shared configuration block with the given name within the
+      # context of this part of the DSL, this is a mechanism to share configuration
+      # between DSLs
+      def import_shared shared_configuration_name
+        block = SharedConfiguration.get shared_configuration_name
+        instance_eval(&block)
+      end
     end
   end
 end

data/lib/dsl_compose/shared_configuration.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module DSLCompose
+  # This module is used to store shared configuration blocks which can be imported and
+  # used within your base or method dsl configuration blocks.
+  module SharedConfiguration
+    class SharedConfigurationAlreadyExistsError < StandardError
+    end
+
+    class SharedConfigurationDoesNotExistError < StandardError
+    end
+
+    class InvalidSharedConfigurationNameError < StandardError
+    end
+
+    class NoBlockProvidedError < StandardError
+    end
+
+    # takes a name and a block and stores it in the shared_configuration hash
+    # if a block with this name already exists, it raises an error
+    def self.add name, &block
+      raise InvalidSharedConfigurationNameError unless name.is_a?(Symbol)
+      raise SharedConfigurationAlreadyExistsError if @shared_configuration&.key?(name)
+      raise NoBlockProvidedError if block.nil?
+
+      @shared_configuration ||= {}
+      @shared_configuration[name] = block
+    end
+
+    # takes a name and returns the block stored in the shared_configuration hash
+    # if a block with this name does not exist, it raises an error
+    def self.get name
+      raise InvalidSharedConfigurationNameError unless name.is_a?(Symbol)
+      raise SharedConfigurationDoesNotExistError unless @shared_configuration&.key?(name)
+
+      @shared_configuration[name]
+    end
+
+    # clears the shared_configuration hash, this is typically used from the test suite
+    def self.clear
+      @shared_configuration = {}
+    end
+  end
+end

data/lib/dsl_compose/version.rb

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

data/lib/dsl_compose.rb

@@ -41,6 +41,8 @@ require "dsl_compose/parser"
 
 require "dsl_compose/composer"
 
+require "dsl_compose/shared_configuration"
+
 require "dsl_compose/dsls"
 
 module DSLCompose

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dsl_compose
 version: !ruby/object:Gem::Version
-  version: 1.9.1
+  version: 1.10.0
 platform: ruby
 authors:
 - Craig Ulliott
@@ -56,6 +56,7 @@ files:
 - lib/dsl_compose/parser/for_children_of_parser.rb
 - lib/dsl_compose/parser/for_children_of_parser/for_dsl_parser.rb
 - lib/dsl_compose/parser/for_children_of_parser/for_dsl_parser/for_method_parser.rb
+- lib/dsl_compose/shared_configuration.rb
 - lib/dsl_compose/version.rb
 homepage: 
 licenses: