exec_env 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e5b8c15180ac50f0722afdd0987350185e01cd58
+  data.tar.gz: 8eecab2c95e0911dcbfac7ab45cb42bbfc71bb8f
+SHA512:
+  metadata.gz: cd306141d63b7bdb8cbc8a209a08048a3054d931652298c6904866a92d4dedf5ae779a58dd3c9ca3be2bfff6bf7b41ecc755300a447374aa92ac4a117478a54a
+  data.tar.gz: b29a6a804a923f7ef7d238d077ccc38633486767e1b5e4dc14227a226d48e3d9a35badc4cb11b114ec6d33c833a9e81dcb5c92c326098e20daa4db78bfb1063d

data/.gitignore

@@ -0,0 +1,5 @@
+# Build artifacts
+/pkg
+
+# Bundle config
+/.bundle

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,27 @@
+PATH
+  remote: .
+  specs:
+    exec_env (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.4)
+    rake (10.1.0)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.4)
+    rspec-expectations (2.14.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.4)
+  exec_env!
+  rake (~> 10.1)
+  rspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Marten Lienen
+
+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,61 @@
+# ExecEnv
+
+Execute blocks in a manipulatable environment and capture messages
+that did not get a response and would normally produce a `NameError`
+or `NoMethodError`. For example use cases of this have a look at
+[anaphoric](https://github.com/CQQL/anaphoric) or
+[hash_builder](https://github.com/CQQL/hash_builder).
+
+If you have another use case for this, please send me an email. I am
+really interested if there are other use cases for this quite exotic
+library.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'exec_env'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install exec_env
+
+## Usage
+
+```ruby
+scope = [1, 2, 3, 4]
+
+env = ExecEnv::Env.new(locals: { foo: 2 })
+env.locals[:bar] = 3
+env.scope = scope
+
+result = env.exec do
+  exotic :dragon, :banana
+  action do
+    :nested
+  end
+
+  size * foo * bar
+end
+
+# Because the block was executed in the scope of the array.
+result # => 24 == 2 * 3 * 4
+
+env.messages
+# => [
+# =>  [:exotic, [:dragon, :banana], nil],
+# =>  [:action, [], <Proc ...>]
+# => ]
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/CQQL/exec_env/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/exec_env.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'exec_env/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "exec_env"
+  spec.version       = ExecEnv::VERSION
+  spec.authors       = ["Marten Lienen"]
+  spec.email         = ["marten.lienen@gmail.com"]
+  spec.summary       = %q{Execute blocks in a manipulatable environment}
+  spec.description   = %q{See README.md}
+  spec.homepage      = "https://github.com/CQQL/exec_env"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.4"
+  spec.add_development_dependency "rake", "~> 10.1"
+  spec.add_development_dependency "rspec"
+end

data/lib/exec_env.rb

@@ -0,0 +1,6 @@
+require "exec_env/version"
+require "exec_env/env"
+
+module ExecEnv
+  
+end

data/lib/exec_env/env.rb

@@ -0,0 +1,89 @@
+module ExecEnv
+  # A manipulatable execution environment, that let's you inject local and
+  # instance variables into a block and capture messages sent during it's
+  # execution.
+  class Env
+    # A hash of local variables, that will be injected into the block
+    #
+    # Examples
+    #
+    #   env.locals = { foo: 3, bar: :symbol }
+    attr_accessor :locals
+
+    # A hash of instance variables, that will be injected into the block
+    #
+    # Examples
+    #
+    #   env.ivars = { :@foo => 3, :@bar => :symbol }
+    attr_accessor :ivars
+
+    # An object, that will serve as the scope of execution of the block
+    #
+    # Examples
+    #
+    #   # Unresolved method calls in the block will be forwarded to
+    #   # the String object "An object"
+    #   env.scope = "An object"
+    attr_accessor :scope
+
+    # An array of all messages that were not captured by locals or
+    # the scope object.
+    #
+    # Examples
+    #
+    #   env.exec do
+    #     test :foo, "bar"
+    #     each do
+    #       # ...
+    #     end
+    #   end
+    #
+    #   env.messages
+    #   # => [[:test, [:foo, "bar], nil], [:each, [], <the block>]]
+    attr_reader :messages
+    
+    def initialize (locals: {}, ivars: {}, scope: nil)
+      @messages = []
+      @locals = locals
+      @ivars = ivars
+      @scope = scope
+    end
+
+    # Execute a block in the manipulated environment.
+    #
+    # Additional arguments will be passed to the block.
+    #
+    # Returns the return value of the block
+    def exec (*args, &block)
+      if @scope
+        @scope.instance_variables.each do |name|
+          instance_variable_set(name, @scope.instance_variable_get(name))
+        end
+      end
+
+      @ivars.each do |name, value|
+        instance_variable_set(name, value)
+      end
+      
+      instance_exec(*args, &block)
+    end
+
+    # Send a message, that completely bypasses the locals
+    # and the scope and is added directly to #messages.
+    def xsend (name, *args, &block)
+      @messages << [name, args, block]
+    end
+
+    def method_missing (name, *args, &block)
+      if @locals.key?(name) && args.size == 0 && !block
+        @locals[name]
+      elsif @scope && @scope.respond_to?(name)
+        @scope.send(name, *args, &block)
+      else
+        @messages << [name, args, block]
+
+        nil
+      end
+    end
+  end
+end

data/lib/exec_env/version.rb

@@ -0,0 +1,3 @@
+module ExecEnv
+  VERSION = "0.1.0"
+end

data/spec/exec_env/env_spec.rb

@@ -0,0 +1,152 @@
+describe ExecEnv::Env do
+  let(:env) { ExecEnv::Env.new }
+
+  it "should allow injecting locals" do
+    value = nil
+
+    env.locals = { it: 5 }
+    env.exec do
+      value = it
+    end
+
+    expect(value).to eq 5
+  end
+
+  it "should allow injecting instance variables" do
+    value = nil
+
+    env.ivars = { :@bind => :test }
+    env.exec do
+      value = @bind
+    end
+
+    expect(value).to eq :test
+  end
+
+  it "should dispatch method calls to the scope object" do
+    value = nil
+    scope = Object.new
+    def scope.it
+      "value"
+    end
+
+    env.scope = scope
+    env.exec do
+      value = it
+    end
+
+    expect(value).to eq "value"
+  end
+
+  it "should inject instance variables from the scope object" do
+    value = nil
+    scope = Object.new
+    scope.instance_variable_set(:@symbol, :value)
+
+    env.scope = scope
+    env.exec do
+      value = @symbol
+    end
+
+    expect(value).to eq :value
+  end
+
+  it "should dispatch method calls to the scope" do
+    value = nil
+    scope = Object.new
+    def scope.it (value)
+      value
+    end
+
+    env.scope = scope
+    env.locals = { it: :binding }
+    env.exec do
+      value = it(:scope)
+    end
+
+    expect(value).to eq :scope
+  end
+
+  it "should evaluate locals before scope methods" do
+    value = nil
+    scope = Object.new
+    def scope.it
+      :scope
+    end
+
+    env.scope = scope
+    env.locals = { it: :binding }
+    env.exec do
+      value = it
+    end
+
+    expect(value).to eq :binding
+  end
+
+  it "should overshadow scope ivars with explicit ones" do
+    value = nil
+    scope = Object.new
+    scope.instance_variable_set(:@it, :scope)
+
+    env.scope = scope
+    env.ivars = { :@it => :binding }
+    env.exec do
+      value = @it
+    end
+
+    expect(value).to eq :binding
+  end
+
+  it "should track unresolved messages" do
+    block = -> { :block }
+    scope = Object.new
+    def scope.number
+      10
+    end
+
+    env.locals = { foo: 5 }
+    env.scope = scope
+    env.exec do
+      var = foo
+      var += number
+
+      foo 15
+      name(:var, 33, &block)
+    end
+
+    expect(env.messages).to eq [[:foo, [15], nil], [:name, [:var, 33], block]]
+  end
+
+  it "should allow bypassing locals and the scope with xsend" do
+    scope = Object.new
+    def scope.foo (arg)
+      :in_scope
+    end
+
+    env.scope = scope
+    env.locals = { foo: 12 }
+    env.exec do
+      xsend :foo, 37
+    end
+
+    expect(env.messages).to eq [[:foo, [37], nil]]
+  end
+
+  it "should pass arguments to the block" do
+    value = nil
+
+    env.exec -10, 3 do |num, factor|
+      value = num * factor
+    end
+
+    expect(value).to eq -30
+  end
+
+  it "should return the return value of the block" do
+    value = env.exec do
+      1337
+    end
+
+    expect(value).to eq 1337
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require "exec_env"

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: exec_env
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Marten Lienen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !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: See README.md
+email:
+- marten.lienen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- exec_env.gemspec
+- lib/exec_env.rb
+- lib/exec_env/env.rb
+- lib/exec_env/version.rb
+- spec/exec_env/env_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/CQQL/exec_env
+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.1.5
+signing_key: 
+specification_version: 4
+summary: Execute blocks in a manipulatable environment
+test_files:
+- spec/exec_env/env_spec.rb
+- spec/spec_helper.rb