dsl_companion 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 938143a3c05df642a927d979b7f75ab214c9629c
-  data.tar.gz: 773e18265ea09fdf70b8e37a58f83cfeef093717
+  metadata.gz: 3fd835850cec2614e0af45d5ef719662d26b7939
+  data.tar.gz: a1fc45e56860006570ffce9ff1feda47ed3db132
 SHA512:
-  metadata.gz: 9c29fd79c1318fa522c42e69f9eb99c354ce0e0fb7fea803fd2dff142b9eb92d0ff237f001cb3dc210b7c12b0c3584941292ae1af27317814e575ce343a57a3f
-  data.tar.gz: 58e03724c32052ccb9b28b345f91f3aab2a76b3e62ef81e5a2336e1c80318186877b63523ca180ec1570118a52d4f390a0add2c65fa7c729e9cb8fb9ffbcca80
+  metadata.gz: f37505af4d96812117db3e69c250e0fbebbf3c8e2bcc0d5fd1d9481579e6e2bd07bf8f20cecea0f80b7225416ba8ca4db0f6829ea5df3c4fa70dc8dba6f3e682
+  data.tar.gz: 4664de8232f5e4801c1cdf792964a0ef5927fddc125c49dc47ca71f135f7573ba0cc8fda2b6dcf91c04e3d86985e4afb6ce90bd71803e380044af04f201e3bfb

data/lib/dsl_companion.rb

@@ -1,7 +1,12 @@
 require 'dsl_companion/version'
-require 'dsl_companion/meta_programming'
+require 'dsl_companion/meta_helper'
 require 'dsl_companion/helpers/context_helper'
 require 'dsl_companion/helpers/active_record'
+
+# Preloaded features
+require 'dsl_companion/features/basic'
+
+# The interpreter
 require 'dsl_companion/interpreter'
 
 module DSLCompanion

data/lib/dsl_companion/features/basic.rb

@@ -0,0 +1,43 @@
+module DSLCompanion
+  module Features
+
+    module Basic
+
+      include MetaHelper
+
+      # If any method named define_<something>(*args) is in the DSL, then it provides an alternate
+      # generic syntax of define(:something, *args)
+      # @param [Object[]] args
+      # @param [Proc] block
+      # @return [Anything returned by th emethod]
+      def define *args, &block
+        extra = args.shift
+        method_name = "define_#{extra}"
+        if respond_to? method_name.to_sym
+          block_given? ? self.send(method_name, *args, &block) : self.send(method_name, *args)
+        else
+          block_given? ? method_missing(method_name.to_sym, *args, & block) : method_missing(method_name.to_sym, *args)
+        end
+      end
+
+      def interpreter?
+        self.is_a? DSLHelper::Interpreter
+      end
+
+      def interpreter
+        self
+      end
+
+      def logger(msg, level=:info)
+        if @logger.nil?
+          STDERR.puts "#{level.to_s.upcase}: #{msg}"
+        else
+          @logger.send level, msg
+        end
+      end
+
+
+    end
+
+  end
+end

data/lib/dsl_companion/helpers/context_helper.rb

@@ -2,7 +2,7 @@ module DSLCompanion
 
   module ContextHelper
 
-    def execute_within_context context=@context, &block
+    def execute_within_context(context=@context, &block)
       # Execute the block if any
       if block_given?
         last_saved_context = @context
@@ -18,47 +18,6 @@ module DSLCompanion
       end
     end
 
-
-    # def with_dictionary &block
-    #   @within_dictionary = true
-    #
-    #   raise "'with_dictionary' cannot be processed in this context !" unless interpreter?
-    #   execute_within_context @context, &block
-    # ensure
-    #   @within_dictionary = false
-    # end
-
-    def define *args, &block
-      extra = args.shift
-      method_name = "define_#{extra}"
-      if respond_to? method_name.to_sym
-        block_given? ? self.send(method_name, *args, &block) : self.send(method_name, *args)
-      else
-        block_given? ? method_missing(method_name.to_sym, *args, & block) : method_missing(method_name.to_sym, *args)
-      end
-    end
-
-    #  def within_dictionary?
-    #    if interpreter?
-    #      @within_dictionary
-    #    else
-    #      @interpreter.within_dictionary?
-    #    end
-    # end
-
-    def interpreter?
-      self.is_a? DSLHelper::Interpreter
-    end
-
-    def interpreter_exec_mode mode=nil
-      if mode.nil?
-        @interpreter.exec_mode
-      else
-        @interpreter.exec_mode = mode
-      end
-    end
-
-
   end
 
 end

data/lib/dsl_companion/interpreter.rb

@@ -1,7 +1,10 @@
 module DSLCompanion
+
   class Interpreter
 
-    attr_accessor :logger
+    include DSLCompanion::Features::Basic
+
+    attr_writer :logger
 
     DEFAULT_EXEC_MODE=:lazy
 
@@ -59,19 +62,10 @@ module DSLCompanion
       message += ' is unknown'
       message += " within DSL file: '#{@source_code_file}'" unless @source_code_file.nil?
       message += '.'
-      report message
+      logger message, :error unless exec_strict_mode?
       raise message if exec_strict_mode?
     end
 
-    private
-
-    def report(msg)
-      if logger.nil?
-        puts msg
-      else
-        logger.error msg
-      end
-    end
-
   end
+
 end

data/lib/dsl_companion/meta_helper.rb

@@ -0,0 +1,38 @@
+module MetaHelper
+
+  def metaclass
+    class << self
+      self
+    end
+  end
+
+  def meta_eval &block
+    metaclass.instance_eval &block
+  end
+
+  # Adds method to metaclass
+  def meta_def( name, &block )
+    meta_eval { define_method name, &block }
+  end
+
+  # Defines an instance method within a class
+  def class_def( name, &block )
+    class_eval { define_method name, &block }
+  end
+
+  def inject_variable(name, value)
+    # Inject instance variable in the current context
+    injected_accessor = name.to_s.to_sym
+    injected_instance_variable = "@#{injected_accessor}"
+    already_defined = self.instance_variable_defined? injected_instance_variable
+    logger("DSL Interpreter overriding existing variable '#{injected_instance_variable}'", :warn) if already_defined
+    self.instance_variable_set injected_instance_variable, value
+
+    # Defines the method that returns the instance variable and inject into the interpreter's context
+    meta_def "#{injected_accessor}" do
+      self.instance_variable_get injected_instance_variable
+    end
+
+  end
+
+end

data/lib/dsl_companion/version.rb

@@ -1,3 +1,3 @@
 module DSLCompanion
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/spec/interpreter_spec.rb

@@ -13,22 +13,49 @@ describe DSLCompanion::Interpreter do
   end
 
   it 'should allow to add extra features through modules' do
-
-    module ExtraModule
+    module ExtraFeatureModule
       def extra_dsl_command
 
       end
     end
 
     interpreter = subject.new :strict
-    interpreter.add_feature ExtraModule
+    interpreter.add_feature ExtraFeatureModule
 
     expect(interpreter.respond_to? :extra_dsl_command).to be_truthy
     expect {interpreter.run {extra_dsl_command} }.not_to raise_error
     expect {interpreter.run {unknown_command} }.to raise_error
+  end
+
+  it 'should give access to some convenience methods' do
+    interpreter = subject.new
+    expect(interpreter.respond_to? :define).to be_truthy
+    expect(interpreter.respond_to? :interpreter).to be_truthy
+    expect(interpreter.respond_to? :interpreter?).to be_truthy
+  end
+
+  it 'should be able to inject new variables in interpreter' do
+
+    module ExtraFeatureModule
+      def define_stuff stuff_name, value
+        interpreter.inject_variable stuff_name, value
+      end
+    end
+
+    interpreter = subject.new :strict
+    interpreter.add_feature ExtraFeatureModule
+
+    interpreter.run do
+      define_stuff :pipo, 'Hello world'
+    end
+    expect {interpreter.run {typo == 'Hello world'} }.to raise_error
+    expect {interpreter.run {pipo == 'Hello world'} }.not_to raise_error
 
   end
 
+
+
+
   context 'when in lazy mode' do
 
     it 'should only report through logging errors in the DSL' do
@@ -43,7 +70,6 @@ describe DSLCompanion::Interpreter do
     it 'should raise exceptions if errors in the DSL'do
       interpreter = subject.new :strict
       expect {interpreter.run {unknown_command} }.to raise_error
-
     end
 
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dsl_companion
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Laurent B.
@@ -67,11 +67,11 @@ files:
 - Rakefile
 - dsl_companion.gemspec
 - lib/dsl_companion.rb
+- lib/dsl_companion/features/basic.rb
 - lib/dsl_companion/helpers/active_record.rb
 - lib/dsl_companion/helpers/context_helper.rb
-- lib/dsl_companion/injection.rb
 - lib/dsl_companion/interpreter.rb
-- lib/dsl_companion/meta_programming.rb
+- lib/dsl_companion/meta_helper.rb
 - lib/dsl_companion/version.rb
 - spec/interpreter_spec.rb
 - spec/spec_helper.rb

data/lib/dsl_companion/injection.rb

@@ -1,22 +0,0 @@
-module DSLCompanion
-
-  module Injection
-
-    def inject(var_name, target)
-      # Inject instance variable in the interpreter context
-      injected_accessor = name.to_s.gsub(/^\s+/, '').tr(' ', '_').underscore.to_sym
-      injected_instance_variable = "@#{injected_accessor}"
-      already_defined = self.instance_variable_defined? injected_instance_variable
-      Rails.logger.warn("DSL Interpreter: Overriding existing variable '#{injected_instance_variable}'") if already_defined
-      self.instance_variable_set injected_instance_variable, target
-
-      # Defines the method that returns the instance variable and inject into the interpreter's context
-      meta_def "#{injected_accessor}" do
-        self.instance_variable_get injected_instance_variable
-      end
-    end
-
-  end
-
-end
-

data/lib/dsl_companion/meta_programming.rb

@@ -1,22 +0,0 @@
-class Object
-
-  def metaclass
-    class << self
-      self
-    end
-  end
-
-  def meta_eval &block
-    metaclass.instance_eval &block
-  end
-
-  # Adds method to metaclass
-  def meta_def( name, &block )
-    meta_eval { define_method name, &block }
-  end
-
-  # Defines an instance method within a class
-  def class_def( name, &block )
-    class_eval { define_method name, &block }
-  end
-end