alki-dsl 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4d2cf31784168eb5de6e6fd04ac4d6d7763aa16a
-  data.tar.gz: '0299ce32b0c21d2567c6a201696262a0442af954'
+  metadata.gz: 4450c3089f0ffa33bd64349a3f6a06e3e2c93192
+  data.tar.gz: 81c39bf6c311568c9b1ab3e633209622bc8c2798
 SHA512:
-  metadata.gz: b306403e0261d49b4d4f5f16203d7599cc8468d5b1cb9cfa57e546dbc7be2f872590c4bc0d444037370d6a863b47358e1dda0027aecf7b3f532aeeb892a41feb
-  data.tar.gz: 525dfdbe6892594eda9330edfde6c7b77bf63ccfec42915f20fd7495d89f22dc459a5140ccc20a9566975616a75feb9a7b5bc08d49de7966ba75ebfd7d37a82a
+  metadata.gz: 56fe3c9044b3e0f416b363615269344ec5150292a422964fed7c05002e614b4cd7feb7a6137738287d443cfc2f8d3ef8aae3c061f776b7019573131e5cbf5124
+  data.tar.gz: a5d8ce35078e0cf74a313dbfbb7da8ce5312955dac27b06ba3c92582b06dee58d917cc1e055ca64f5ad4c390bde769b01ccd2214291f71974afeee05af9856de

data/README.adoc

@@ -57,7 +57,7 @@ Or install it yourself as:
 
 All DSLs created with Alki::Dsl are Class objects with `::build` methods. These build methods take an optional
 hash of parameters, along with a ruby block to be evaluated. DSLs created with Alki::Dsl cannot directly
-strings.
+evaluate strings, just ruby blocks.
 
 While DSLs can be created with Alki::Dsl manually, the easiest way is to use the provided "dsl" DSL. Each
 DSL defines any number of "dsl methods", which are methods that will be exposed to the user of the DSL.
@@ -124,10 +124,57 @@ puts result
 
 ```
 
+#### Helpers ####
+
+In addition to defining dsl methods, the 'dsl' DSL also allows defining helper methods,
+which can be called within other dsls that require it.
+
+```ruby
+require 'alki/dsl'
+
+strings_dsl = Alki::Dsl.build 'alki/dsls/dsl' do
+  init do
+    ctx[:strings] = []
+  end
+
+  helper :set_separator do |sep|
+    ctx[:separator] = sep
+  end
+
+  dsl_method :add do |val|
+    ctx[:strings] << val
+  end
+
+  finish do
+    sep = ctx[:separator] || "\n"
+    ctx[:result] = ctx[:strings].join(sep)
+  end
+end
+
+my_dsl = Alki::Dsl.build 'alki/dsls/dsl' do
+  require_dsl strings_dsl
+
+  dsl_method :separator do |sep|
+    set_separator sep # Call helper from strings_dsl
+  end
+end
+
+result = my_dsl.build do
+  separator ' '
+
+  add "hello"
+  add "world"
+end
+
+puts result
+
+# output: hello world
+```
+
 ### Using with Alki::Loader
 
-https://github.com/alki-project/alki-loader[Alki::Loader] is library that provides extra functionality
-over base Ruby around loading source files. One of its features is to associate "builder" objects with files
+https://github.com/alki-project/alki-loader[Alki::Loader] is a library that extends Ruby's `require` method.
+It can be used to associate "builder" objects with files
 or directories so that the code within them is processed by the builder object when they are loaded. More
 documentation can be found at the Alki::Loader https://github.com/alki-project/alki-loader[github page].
 
@@ -142,6 +189,7 @@ To register it create a `lib/alki_loader.rb` file:
 
 .lib/alki_loader.rb
 ```ruby
+# Treat all ruby source files in lib/my_project/dsls as DSL definition files
 Alki::Loader.register 'my_project/dsls', builder: 'alki/dsls/dsl'
 ```
 
@@ -155,7 +203,8 @@ The DSL class can be passed directly instead of the load string.
 ****
 
 Now a DSL definition file can be created in `lib/my_project/dsls`. Revisiting the previous example, a "strings"
-can be created.
+dsl file can be created. Because the file has been registered with the 'alki/dsls/dsl' builder,
+it will be automatically processed as a DSL definition when loaded.
 
 .lib/my_project/dsls/strings.rb
 ```ruby
@@ -217,16 +266,17 @@ Alki do
 end
 ```
 
-So what if we want to use our DSL with Alki::Loader as well? First, Alki::Loader requires builders to
-define a constant with the correct name, so we need code to do that. Alki::Dsl comes with a "class" DSL
-that makes this easy. First lets create a new DSL that adapts our transformable_strings DSL into a module
-builder.
+So what if we want to use our DSL with Alki::Loader as well? First, our DSL right now produces
+a string, but Alki::Loader requires builders to define a constant with the correct name. Alki::Dsl comes with a
+"class" DSL that makes this easy. First lets create a new DSL that adapts our transformable_strings DSL into a one
+that defines a module.
 
 .lib/my_project/dsls/strings_class.rb
 ```ruby
 Alki do
   require_dsl 'alki/dsls/class'
-  require_dsl 'my_project/dsls/transformable_strings', :after # This makes it's finish runs before ours
+  require_dsl 'my_project/dsls/transformable_strings', :after # This makes it's finish hook
+                                                              # run before ours
 
   finish do
     # Helpers provided by alki/dsls/class

data/alki-dsl.gemspec

@@ -19,5 +19,5 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'alki-support', '~> 0.7'
   spec.add_dependency 'alki-loader', '~> 0.2'
-  spec.add_development_dependency 'minitest', '~> 5.9', '>= 5.9.1'
+  spec.add_development_dependency 'alki-testing', '~> 0.1'
 end

data/lib/alki/dsl/base.rb

@@ -6,8 +6,8 @@ module Alki
     class Base
       extend Alki::Dsl::Builder
 
-      def self.generate(ctx)
-        obj = new(ctx)
+      def self.generate(evaluator,ctx)
+        obj = new(ctx,evaluator)
         result = {methods: {}}
         info = self.dsl_info
 
@@ -25,7 +25,18 @@ module Alki
             result[:methods][name] = obj.method method
           end
         end
-        result
+
+        if info[:helpers]
+          info[:helpers].each do |method|
+            if method.is_a?(Array)
+              name, method = method
+            else
+              name = method
+            end
+            result[:helpers][name] = obj.method method
+          end
+        end
+        evaluator.update result
       end
 
       def self.dsl_info
@@ -33,15 +44,12 @@ module Alki
       end
 
       def self.helpers
-        if defined? self::Helpers
-          [self::Helpers]
-        else
-          []
-        end
+        []
       end
 
-      def initialize(ctx)
+      def initialize(ctx,evaluator)
         @ctx = ctx
+        @evaluator = evaluator
       end
 
       attr_reader :ctx

data/lib/alki/dsl/class_helpers.rb

@@ -47,16 +47,6 @@ module Alki
         }
       end
 
-      def add_helper(name,&blk)
-        add_method name, &blk
-        add_method name, subclass: 'Helpers', &blk
-      end
-
-      def add_helper_module(mod)
-        add_module mod
-        add_module mod, subclass: 'Helpers'
-      end
-
       def add_initialize_param(name,opts={},&default)
         name = name.to_sym
         param = default ? [name,default] : name

data/lib/alki/dsl/evaluator.rb

@@ -1,54 +1,71 @@
 require 'set'
 require 'alki/support'
+require 'alki/dsl/evaluator_instance'
 
 module Alki
   module Dsl
     class Evaluator
-      def initialize
+      def self.evaluate(dsl, data={}, &blk)
+        evaluator = new(dsl,data)
+        evaluator.evaluate &blk
+        evaluator.finish
+      end
+
+      def initialize(dsl,data)
         @inits = []
         @finishers = []
         @processors = []
         @dsls_seen = Set.new
+        @data = data
+        @mod = (data[:module] ||= Module.new)
+        @dsl = dsl
+        evaluator = self
+        define_dsl_method :method_missing do |meth,*args,&b|
+          evaluator.context.send meth, *args, &b
+        end
+        process_dsl @dsl
       end
 
-      def evaluate(dsl,data={},&blk)
-        mod = (data[:module] ||= Module.new)
-        process_dsl dsl, data
+      def build(data={},&blk)
+        self.class.evaluate(@dsl,data,&blk)
+      end
 
-        @inits.each(&:call)
-        define_dsl_method mod, :method_missing do |meth,*args,&b|
-          blk.binding.receiver.send meth, *args, &b
-        end
-        dsl_exec mod, &blk
-        @finishers.reverse_each(&:call)
-        clear_dsl_methods mod
+      def process_dsl(dsl)
+        return unless @dsls_seen.add? dsl
+        dsl.generate(self,@data)
+      end
 
-        if data.key? :result
-          data[:result]
-        else
-          data
-        end
+      def context
+        Thread.current[:__alki_dsl_context]
       end
 
-      def process_dsl(dsl,data)
-        return unless @dsls_seen.add? dsl
-        cbs = dsl.generate(data)
+      def evaluate(&blk)
+        Thread.current[:__alki_dsl_context] = @data[:context] || blk.binding.receiver
+        @mod.class_exec &blk
+      end
+
+      def require_dsl(source,dsl)
+        dsl_class = Alki.load(dsl)
+        dsl_class.new(EvaluatorInstance.new(self,@data))
+      end
+
+      def update(cbs)
         after_requires = []
         if cbs[:requires]
           cbs[:requires].each do |(required_dsl,order)|
             case order
               when :before
-                process_dsl Alki.load(required_dsl), data
+                process_dsl Alki.load(required_dsl)
               when :after
-                after_requires << [Alki.load(required_dsl), data]
+                after_requires << [Alki.load(required_dsl)]
             end
           end
         end
-        @inits << cbs[:init] if cbs[:init]
+        cbs[:init].call if cbs[:init]
         @finishers << cbs[:finish] if cbs[:finish]
         if cbs[:methods]
           cbs[:methods].each do |name, proc|
-            define_dsl_method data[:module], name, &proc
+            define_dsl_method name, &proc
           end
         end
         after_requires.each do |process_args|
@@ -56,22 +73,27 @@ module Alki
         end
       end
 
-      def define_dsl_method(mod,name,&blk)
-        mod.define_singleton_method name, &blk
+      def define_dsl_method(name,&blk)
+        @mod.define_singleton_method name, &blk
       end
 
-      def clear_dsl_methods(mod)
-        mod.singleton_methods do |m|
-          mod.singleton_class.send :remove_method, m
+      def finish
+        @finishers.reverse_each(&:call)
+        clear_dsl_methods
+
+        if @data.key? :result
+          @data[:result]
+        else
+          @data
         end
       end
 
-      def dsl_exec(mod,&blk)
-        mod.class_exec &blk
-      end
+      private
 
-      def self.evaluate(dsl, data={}, &blk)
-        new.evaluate dsl, data, &blk
+      def clear_dsl_methods
+        @mod.singleton_methods do |m|
+          @mod.singleton_class.send :remove_method, m
+        end
       end
     end
   end

data/lib/alki/dsl/evaluator_instance.rb

@@ -0,0 +1,17 @@
+module Alki
+  module Dsl
+    class EvaluatorInstance
+      attr_reader :data
+
+      def initialize(evaluator,data,dsl)
+        @evaluator = evaluator
+        @data = data
+        @dsl = dsl
+      end
+
+      def require_dsl(dsl)
+        @evaluator.require_dsl(self,dsl)
+      end
+    end
+  end
+end

data/lib/alki/dsl/merge.rb

@@ -10,10 +10,8 @@ module Alki
         @requires = dsls.map{|dsl| [dsl,:before]}.freeze
       end
 
-      def generate(_ctx)
-        {
-          requires: @requires
-        }
+      def generate(evaluator,_ctx)
+        evaluator.update requires: @requires
       end
 
       def helpers

data/lib/alki/dsl/version.rb

@@ -1,5 +1,5 @@
 module Alki
   module Dsl
-    VERSION = '0.4.2'
+    VERSION = '0.5.0'
   end
 end

data/lib/alki/dsls/class.rb

@@ -7,7 +7,9 @@ module Alki
     class Class < Alki::Dsl::Base
       include Alki::Dsl::ClassHelpers
 
-      self::Helpers = Alki::Dsl::ClassHelpers
+      def self.helpers
+        [Alki::Dsl::ClassHelpers]
+      end
 
       def self.dsl_info
         {

data/lib/alki/dsls/dsl.rb

@@ -5,8 +5,25 @@ require 'alki/dsl/class_helpers'
 module Alki
   module Dsls
     class Dsl < Alki::Dsl::Base
-      include Alki::Dsl::ClassHelpers
-      Helpers = Alki::Dsl::ClassHelpers
+      module Helpers
+        include Alki::Dsl::ClassHelpers
+
+        def add_helper(name,&blk)
+          add_method name, &blk
+          add_method name, subclass: 'Helpers', &blk
+        end
+
+        def add_helper_module(mod)
+          add_module mod
+          add_module mod, subclass: 'Helpers'
+        end
+      end
+
+      include Helpers
+
+      def self.helpers
+        [Helpers]
+      end
 
       def self.dsl_info
         {
@@ -68,7 +85,8 @@ module Alki
 
       def finish
         set_super_class 'alki/dsl/base'
-        class_builder('Helpers')[:type] = :module
+        create_as_module(subclass: 'Helpers')
+
         add_class_method :helpers do
           [self::Helpers]
         end
@@ -76,6 +94,14 @@ module Alki
         add_class_method :dsl_info do
           info
         end
+
+        add_method(:require_dsl,private: true) do |dsl,order=:before|
+          dsl_class = Alki.load dsl
+          dsl_class.helpers.each do |helper|
+            self.singleton_class.send :include, helper
+          end
+          @evaluator.update requires: [[dsl,order]]
+        end
       end
     end
   end

data/test/feature/config_test.rb

@@ -1,11 +1,7 @@
-require_relative '../test_helper'
+require 'alki/feature_test'
 require 'alki/dsl'
 
 describe 'dsl configuration' do
-  before do
-    $LOAD_PATH.unshift fixture_path('example','lib')
-  end
-
   it 'should be automatically loaded when requiring a dsl' do
     require 'alki_test/dsls/number'
     AlkiTest::Dsls::Number.must_be_instance_of Class
@@ -16,9 +12,4 @@ describe 'dsl configuration' do
     require 'alki_test/numbers/three'
     AlkiTest::Numbers::Three.new.must_equal 3
   end
-
-  it 'should allow using Alki::Dsl.merge to merge dsls together' do
-    require 'alki_test/numbers/three'
-    AlkiTest::Numbers::Three.simple.must_equal true
-  end
 end

data/test/feature/merge_test.rb

@@ -0,0 +1,65 @@
+require 'alki/feature_test'
+
+describe 'Merging Dsls' do
+  before do
+    @dsl1 = build_dsl do
+      init do
+        ctx[:result] << :init1
+      end
+      helper :do_one do
+        ctx[:result] << :one
+      end
+      dsl_method :one do
+        do_one
+      end
+      finish do
+        ctx[:result] << :finish1
+      end
+    end
+    @dsl2 = build_dsl do
+      init do
+        ctx[:result] << :init2
+      end
+      helper :do_two do
+        ctx[:result] << :two
+      end
+      dsl_method :two do
+        do_two
+      end
+      finish do
+        ctx[:result] << :finish2
+      end
+    end
+    @merged = Alki::Dsl.merge(@dsl1,@dsl2)
+  end
+
+  def build(dsl = @merged,&blk)
+    dsl.build result: [], &(blk || ->{})
+  end
+
+  it 'should run init and finish blocks of both dsls in order' do
+    build.must_equal %i(init1 init2 finish2 finish1)
+  end
+
+  it 'should expose dsl methods of both dsls' do
+    result = build { one; two }
+    result.must_include :one
+    result.must_include :two
+  end
+
+  it 'should provide helpers from both dsls when required by another dsl' do
+    merged = @merged
+    dsl = build_dsl do
+      require_dsl merged
+
+      finish do
+        do_one
+        do_two
+      end
+    end
+    result = build(dsl)
+
+    result.must_include :one
+    result.must_include :two
+  end
+end

data/test/feature/runtime_requires.rb

@@ -0,0 +1,5 @@
+require 'alki/feature_test'
+
+describe 'Runtime requires' do
+  it 'should be allowed at '
+end

data/test/feature_test_helper.rb

@@ -0,0 +1,8 @@
+require 'alki/dsl'
+$LOAD_PATH.unshift Alki::Test.fixture_path('example','lib')
+
+class Minitest::Spec
+  def build_dsl(&blk)
+    Alki::Dsl.build 'alki/dsls/dsl', &blk
+  end
+end

data/test/fixtures/example/lib/alki_test/dsls/simple.rb

@@ -1,7 +1,7 @@
 Alki do
-  require_dsl 'alki/dsls/class'
 
   finish do
+    require_dsl 'alki/dsls/class'
     add_class_method :simple do
       true
     end

data/test/fixtures/example/merged.rb

@@ -0,0 +1,3 @@
+Alki do
+
+end

data/test/integration/class_builder_test.rb

@@ -1,4 +1,4 @@
-require_relative '../test_helper'
+require 'alki/test'
 require 'alki/class_builder'
 
 describe Alki::ClassBuilder do

data/test/unit/evaluator_test.rb

@@ -1,6 +1,6 @@
-require_relative '../test_helper'
+require 'alki/test'
 require 'alki/dsl/evaluator'
 
 describe Alki::Dsl::Evaluator do
 
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alki-dsl
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Matt Edlefsen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-05 00:00:00.000000000 Z
+date: 2017-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: alki-support
@@ -39,25 +39,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.2'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: alki-testing
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.9'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 5.9.1
+        version: '0.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.9'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 5.9.1
+        version: '0.1'
 description: Library for defining and using DSLs
 email:
 - matt.edlefsen@gmail.com
@@ -75,15 +69,20 @@ files:
 - lib/alki/dsl/builder.rb
 - lib/alki/dsl/class_helpers.rb
 - lib/alki/dsl/evaluator.rb
+- lib/alki/dsl/evaluator_instance.rb
 - lib/alki/dsl/merge.rb
 - lib/alki/dsl/version.rb
 - lib/alki/dsls/class.rb
 - lib/alki/dsls/dsl.rb
 - test/feature/config_test.rb
+- test/feature/merge_test.rb
+- test/feature/runtime_requires.rb
+- test/feature_test_helper.rb
 - test/fixtures/example/lib/alki_loader.rb
 - test/fixtures/example/lib/alki_test/dsls/number.rb
 - test/fixtures/example/lib/alki_test/dsls/simple.rb
 - test/fixtures/example/lib/alki_test/dsls/value.rb
+- test/fixtures/example/merged.rb
 - test/fixtures/example/numbers/three.rb
 - test/integration/class_builder_test.rb
 - test/test_helper.rb
@@ -114,10 +113,14 @@ specification_version: 4
 summary: Alki dsl library
 test_files:
 - test/feature/config_test.rb
+- test/feature/merge_test.rb
+- test/feature/runtime_requires.rb
+- test/feature_test_helper.rb
 - test/fixtures/example/lib/alki_loader.rb
 - test/fixtures/example/lib/alki_test/dsls/number.rb
 - test/fixtures/example/lib/alki_test/dsls/simple.rb
 - test/fixtures/example/lib/alki_test/dsls/value.rb
+- test/fixtures/example/merged.rb
 - test/fixtures/example/numbers/three.rb
 - test/integration/class_builder_test.rb
 - test/test_helper.rb