dsl_factory 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9110073c0a21c89089537a09c4f21394b30fffa76aeaec2291c9918d58051479
-  data.tar.gz: 06d23515ae9d3a03da213d7e6642ffe19cb7deba898e05526af11131070e644b
+  metadata.gz: e9c3690034afd5fcc2eef0bb823f898bd6182effa13a49f0dd26ba0ff4dc2769
+  data.tar.gz: 468b23fb9a0987109e4cf6deb00317cd8708b2984b88750dc0e1455dfd55d697
 SHA512:
-  metadata.gz: 37b94876fd1631ab2247da8688cf5d8ded60282bcd204bec006a3017d7e843015b926aceb4a9237a0c85dc9fdfaa4641a3256709e23950dae1f4fc5103f926f3
-  data.tar.gz: 2844d3bd1abd55906099d5a309276a8dfd180e10a7bfe6b48422c1a931f26cb79cdf8ac1b593e355e4851cfe809f6288463f183da8f029cf072b8aad0f7c1c16
+  metadata.gz: 41eec163f9c946cf7ab00bd1979079fdcb8c347154976c626219cd9f9956602efa339d52e97431add2900eda2c44e727546734115a2bc6af9cd1f6826beb37e8
+  data.tar.gz: fd6a86dc150ba55196d0c0d7a5cde2148628b9a9c90527544c063126b464d4cc1bd5d305c518805139a0c27c90cf8d9f88af567f691aca84f473f5e90ae4f00b

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [0.2.0] - 2023-08-23
+
+- provide `inspect` method for better inspectability
+
 ## [0.1.0] - 2022-03-01
 
 - Initial release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dsl_factory (0.1.0)
+    dsl_factory (0.2.0)
       activesupport (>= 5.0)
 
 GEM

data/README.md

@@ -101,8 +101,8 @@ class World
   country_size 'Germany', 357_022
 end
 
-SmartyPants.capital_for_countries # => { 'Berlin' => 'Germany', 'Copenhagen' => 'Denmark'}
-SmartyPants.country_sizes # => { 'Germany' => 357022 }
+World.capital_for_countries # => { 'Berlin' => 'Germany', 'Copenhagen' => 'Denmark'}
+World.country_sizes # => { 'Germany' => 357022 }
 ```
 
 **Nested DSLs**
@@ -148,13 +148,14 @@ ButtonDsl = DslFactory.define_dsl do
   # all types outlined above support callbacks
   any :trigger, callback: ->(value) { puts "#{value} was triggered" }
   any :snicker, callback: ->(value) { arg1, arg2 = value; puts "snicker: #{arg1} & #{arg2}" } # we can pass arguments via the value
-  any :clicker, callback: ->(value) { self.do_the_click }
+  any :clicker, callback: ->(value) { self.do_the_click } # see method definition in using class
+  numeric :width, callback: ->(value) { raise DslFactory::ValidationError, 'buttons must be small' if width > 100 }
 
   # for arrays the callback always receives an array (even if it was used in singular form)
   # for hashes the callback receives two arguments: key, value
 end
 
-class Sabine
+class MonsterButton
   extend ButtonDsl
   # if we want to call a method of the class, we need to define it before the first usage of the DSL method
   def self.do_the_click
@@ -163,10 +164,19 @@ class Sabine
 
   trigger 'abc'            # -> abc was triggered
   snicker ['haha', 'hihi'] # -> snicker: haha & hihi
-  clicker nil              # make sure to alway pass a value, -> Click!
+  clicker nil              # make sure to alway pass a value; -> Click!
+  width 2000               # -> DslFactory::ValidationError: buttons must be small
 end
+
+MonsterButton.trigger # values are still set; => 'abc'
 ```
 
+**Inspection**
+
+For debugging it is useful to introspect the DSL values.
+When `inspectable` is set to `true` (`DslFactory.define_dsl(inspectable: true)`) the module will provide an `inspect` method.
+All sub-DSL modules provide an such a method by default.
+
 ## Use of the definition
 
 Usually we **extend a class** like so:
@@ -180,7 +190,7 @@ end
 LakeSuperior.lake_name # => 'Lake Superior'
 ```
 
-However we can also the **DSL in a variable**:
+However we can also use the **DSL in a variable**:
 
 ```ruby
 @config = Module.new.extend(LakeDsl)
@@ -202,6 +212,14 @@ end
 
 ```
 
+# Compatibility
+
+The gem was/is used in production with the following Ruby versions:
+
+- ✅ Ruby 2.7
+- ✅ Ruby 3.0
+- ✅ Ruby 3.1
+
 # Development
 
 ```bash
@@ -210,7 +228,7 @@ bundle install
 rake test # run the tests
 pry # require_relative 'lib/dsl_factory.rb'
 
-# to release a new version, update the version number in `version.rb`, then run
+# to release a new version, update `CHANGELOG.md` and the version number in `version.rb`, then run
 bundle exec rake release
 ```
 

data/lib/dsl_factory/generator.rb

@@ -15,6 +15,12 @@ class DslFactory::Generator
     end
   end
 
+  def define_inspect
+    @definition.define_method(:inspect) do
+      "DSL#{@dsl_values.inspect}"
+    end
+  end
+
   # for more information & examples, please see README.md
   #
   # if a `callback` is given it will be called when the extended class uses this attribute (after setting the value).
@@ -70,7 +76,7 @@ class DslFactory::Generator
 
       if block # we deal with a sub-DSL
         value_object = Class.new
-        value_object.extend(DslFactory.define_dsl(&definition_block))
+        value_object.extend(DslFactory.define_dsl(inspectable: true, &definition_block))
         value_object.instance_eval(&block)
         value = value_object
       end
@@ -97,7 +103,7 @@ class DslFactory::Generator
 
       if block # we deal with a sub-DSL
         value_object = Class.new
-        value_object.extend(DslFactory.define_dsl(&definition_block))
+        value_object.extend(DslFactory.define_dsl(inspectable: true, &definition_block))
         value_object.instance_eval(&block)
         value = value_object
       end

data/lib/dsl_factory/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DslFactory
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/dsl_factory.rb

@@ -7,8 +7,9 @@ module DslFactory
   class DefinitionError < StandardError; end
   class ValidationError < StandardError; end
 
-  def define_dsl(&block)
+  def define_dsl(inspectable: false, &block)
     generator = DslFactory::Generator.new
+    generator.define_inspect if inspectable
     generator.instance_eval(&block)
     return generator.definition
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dsl_factory
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Tom Rothe
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-01 00:00:00.000000000 Z
+date: 2023-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -50,7 +50,7 @@ metadata:
   homepage_uri: https://github.com/motine/dsl_factory
   source_code_uri: https://github.com/motine/dsl_factory
   changelog_uri: https://github.com/motine/dsl_factory/blob/master/CHANGELOG.md
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -65,8 +65,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
-signing_key:
+rubygems_version: 3.1.6
+signing_key: 
 specification_version: 4
 summary: A small DSL to generate DSLs
 test_files: []