dsl_companion 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 938143a3c05df642a927d979b7f75ab214c9629c
+  data.tar.gz: 773e18265ea09fdf70b8e37a58f83cfeef093717
+SHA512:
+  metadata.gz: 9c29fd79c1318fa522c42e69f9eb99c354ce0e0fb7fea803fd2dff142b9eb92d0ff237f001cb3dc210b7c12b0c3584941292ae1af27317814e575ce343a57a3f
+  data.tar.gz: 58e03724c32052ccb9b28b345f91f3aab2a76b3e62ef81e5a2336e1c80318186877b63523ca180ec1570118a52d4f390a0add2c65fa7c729e9cb8fb9ffbcca80

data/.gitignore

@@ -0,0 +1,48 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+/pkg/
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+# Standard
+*~
+# Standard Rails project
+/tmp/
+/log/
+/db/*.sqlite3
+# SASS CSS generation
+/public/stylesheets/.sass-cache/
+# Netbeans
+/nbproject/
+# Sublime Text 2 project
+*.sublime-project
+*.sublime-workspace
+*(copie)*
+# RVM
+.rvmrc
+# VisualRuby
+.vr_settings.yaml
+# Emacs
+*# 
+*\# 
+\#*
+.#*
+\#*\#
+# Geany
+*.geany
+# RubyMine
+.idea
+#RedCar
+.redcar

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.0.0
+script:
+  - bundle exec rake spec

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dsl_companion.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Laurent B.
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,33 @@
+# DslHelper
+# EasyAppHelper
+
+ [![Build Status](https://travis-ci.org/lbriais/dsl_companion.png?branch=master)](https://travis-ci.org/lbriais/dsl_companion)
+ [![Gem Version](https://badge.fury.io/rb/dsl_companion.png)](http://badge.fury.io/rb/dsl_companion)
+ 
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'dsl_helper'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dsl_helper
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/dsl_helper/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/dsl_companion.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dsl_companion/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dsl_companion"
+  spec.version       = DSLCompanion::VERSION
+  spec.authors       = ["Laurent B."]
+  spec.email         = ["lbnetid+gh@gmail.com"]
+  spec.summary       = %q{Provides a customizable interpreter to run your own internal DSLs.}
+  spec.description   = %q{The goal of this gem is to provide a versatile DSL interpreter.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'rspec'
+end

data/lib/dsl_companion.rb

@@ -0,0 +1,8 @@
+require 'dsl_companion/version'
+require 'dsl_companion/meta_programming'
+require 'dsl_companion/helpers/context_helper'
+require 'dsl_companion/helpers/active_record'
+require 'dsl_companion/interpreter'
+
+module DSLCompanion
+end

data/lib/dsl_companion/helpers/active_record.rb

@@ -0,0 +1,30 @@
+module DSLCompanion
+
+  module ActiveRecordAttributesExposer
+    def add_dsl_attributes(record)
+      extra_module = nil
+      record.class.columns.each do |col|
+        # Remove the columns we don't want to give direct access to.
+        next if col.primary
+        next if col.name =~ /_id$/i
+        next if col.name =~ /^(created|updated)_at$/i
+
+        # Creating a module to ease the DSL, exposing AR attributes as methods.
+        # When in a do block attributes can be directly modified without specifying "self".
+        extra_module ||= Module.new
+        extra_module.module_eval do
+          define_method(col.name.to_sym) do |arg=nil|
+            if arg.nil?
+              self[col.name]
+            else
+              self[col.name] = arg
+            end
+          end
+        end
+      end
+
+      # And then include the module into the instance if needed
+      record.extend extra_module unless extra_module.nil?
+    end
+  end
+end

data/lib/dsl_companion/helpers/context_helper.rb

@@ -0,0 +1,64 @@
+module DSLCompanion
+
+  module ContextHelper
+
+    def execute_within_context context=@context, &block
+      # Execute the block if any
+      if block_given?
+        last_saved_context = @context
+        @context = context
+        begin
+          # puts ">>>> Switching to context: #{@context} (from #{last_saved_context})"
+          @context.send :instance_variable_set, '@interpreter', @interpreter
+          @context.instance_eval(&block)
+        ensure
+          @context = last_saved_context
+          # puts "<<<< Back to context: #{@context}"
+        end
+      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/injection.rb

@@ -0,0 +1,22 @@
+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/interpreter.rb

@@ -0,0 +1,77 @@
+module DSLCompanion
+  class Interpreter
+
+    attr_accessor :logger
+
+    DEFAULT_EXEC_MODE=:lazy
+
+    def initialize(exec_mode=DEFAULT_EXEC_MODE)
+      @interpreter = self
+      self.exec_mode = exec_mode
+    end
+
+
+    def run file=nil, &block
+      @context = self
+      if file.nil?
+        self.instance_eval &block
+      else
+        @source_code_file = file
+        code = File.read file
+        self.instance_eval code
+      end
+    ensure
+      @last_source_code_file = @source_code_file
+      @source_code_file = nil
+    end
+
+    def self.run file=nil, exec_mode=DEFAULT_EXEC_MODE, &block
+      new(exec_mode).run file, &block
+    end
+
+
+    def exec_mode=(mode)
+      if [:strict, true].include? mode
+        @exec_mode = :strict
+        return @exec_mode
+      end
+      if [:lazy, false].include? mode
+        @exec_mode = :lazy
+        return @exec_mode
+      end
+      raise "DSL Interpreter: Invalid execution mode !"
+    end
+    attr_reader :exec_mode
+
+
+    def exec_strict_mode?
+      @exec_mode == :strict
+    end
+
+    def add_feature(mod)
+      self.extend(mod)
+    end
+
+    def method_missing(symbolic_name, *args)
+      method_name ||= symbolic_name.to_s
+      message = "DSL Interpreter: method '#{method_name}'"
+      message += block_given? ? ' (with a code block passed).' : ' (with no code block passed)'
+      message += ' is unknown'
+      message += " within DSL file: '#{@source_code_file}'" unless @source_code_file.nil?
+      message += '.'
+      report message
+      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_programming.rb

@@ -0,0 +1,22 @@
+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

data/lib/dsl_companion/version.rb

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

data/spec/interpreter_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe DSLCompanion::Interpreter do
+
+  subject{DSLCompanion::Interpreter}
+
+  it 'should be used with a block of commands' do
+    the_class=nil
+    subject.run do
+      the_class = self.class
+    end
+    expect(the_class == DSLCompanion::Interpreter).to be_truthy
+  end
+
+  it 'should allow to add extra features through modules' do
+
+    module ExtraModule
+      def extra_dsl_command
+
+      end
+    end
+
+    interpreter = subject.new :strict
+    interpreter.add_feature ExtraModule
+
+    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
+
+  context 'when in lazy mode' do
+
+    it 'should only report through logging errors in the DSL' do
+      interpreter = subject.new
+      expect {interpreter.run {unknown_command} }.not_to raise_error
+    end
+
+  end
+
+  context 'when in strict mode' 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
+
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,31 @@
+#-------------------------------------------------------------------------------
+#
+#
+# Copyright (c) 2014 L.Briais under MIT license
+# http://opensource.org/licenses/MIT
+#-------------------------------------------------------------------------------
+
+require 'dsl_companion'
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir[File.expand_path("../../spec/support/**/*.rb", __FILE__)].each { |f| require f }
+
+RSpec.configure do |config|
+  # ## Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+  config.mock_with :rspec
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = "random"
+
+  config.color = true
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: dsl_companion
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Laurent B.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: The goal of this gem is to provide a versatile DSL interpreter.
+email:
+- lbnetid+gh@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- dsl_companion.gemspec
+- lib/dsl_companion.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/version.rb
+- spec/interpreter_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.0
+signing_key: 
+specification_version: 4
+summary: Provides a customizable interpreter to run your own internal DSLs.
+test_files:
+- spec/interpreter_spec.rb
+- spec/spec_helper.rb