mzl 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format progress
+--drb

data/.rvmrc

@@ -0,0 +1 @@
+rvm 1.9.3@mzl --create

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gem 'rake'
+gem 'rspec'
+gem 'pry'
+gem 'spork'
+gem 'autotest-standalone'
+
+# Specify your gem's dependencies in mzl.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Kyle Brett
+
+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,29 @@
+# Mzl
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mzl'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mzl
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,13 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+require 'bundler/setup'
+require 'rspec/core/rake_task'
+require 'pry'
+
+desc 'run console'
+task :console do
+  exec('bundle exec pry -I lib -r mzl')
+end
+
+desc 'run specs'
+RSpec::Core::RakeTask.new

data/lib/examples/calculate.rb

@@ -0,0 +1,23 @@
+module Examples
+  class Calculate
+    def initialize
+      @total = 0
+    end
+
+    mzl.def :total, persist: true do
+      @total
+    end
+
+    mzl.def :add do |*numbers|
+      @total += numbers.inject(:+)
+    end
+
+    mzl.def :sub do |*numbers|
+      @total -= numbers.inject(:+)
+    end
+
+    mzl.def :exp do |exp|
+      @total = total ** exp
+    end
+  end
+end

data/lib/examples/scopes.rb

@@ -0,0 +1,9 @@
+require 'examples/calculate'
+
+module Examples
+  class Scopes
+    mzl.child :calculate, Calculate
+  end
+end
+
+

data/lib/mzl.rb

@@ -0,0 +1,16 @@
+require 'mzl/version'
+
+module Mzl
+  autoload :Thing, 'mzl/thing'
+  autoload :DSLProxy, 'mzl/dsl_proxy'
+
+  module Class
+    def mzl(&block)
+      @mzl ||= Mzl::Thing.for(self)
+
+      block_given? ? @mzl.new(&block) : @mzl
+    end
+  end
+end
+
+Class.send(:include, Mzl::Class)

data/lib/mzl/dsl_proxy.rb

@@ -0,0 +1,56 @@
+ module Mzl
+  class DSLProxy
+    def initialize
+      @defs = {}
+    end
+
+    # define a method that will be available on objects created with
+    # the mzl object that created this object
+    def def(m, opts, &block)
+      raise ArgumentError if defs.include?(m)
+      @defs[m] = [block, opts]
+    end
+
+    # a list of our methods
+    def defs
+      @defs.keys
+    end
+
+    # leave this def on the instance? (so it is accessible without mzl)
+    def persist?(m)
+      @defs[m][1][:persist]
+    end
+
+    # the proc for a def is the first element of the array in @defs[m]
+    def proc_for(m)
+      @defs[m][0]
+    end
+
+    # define our DSL methods on the instance's metaclass
+    def insert_mzl(instance, filter = {})
+      @defs.each do |m, ary|
+        blk, opts = ary
+        next unless filter.empty? || opts == filter
+        instance.singleton_class.send(:define_method, m, &blk)
+      end
+    end
+
+    # remove all our methods
+    def extract_mzl(instance)
+      defs.each do |m|
+        instance.singleton_class.send(:remove_method, m) unless persist?(m)
+      end
+    end
+
+    # execute the block against the instance with our methods
+    # available.  afterwards, remove the :persist => false ones
+    def exec_for(instance, &block)
+      insert_mzl(instance)
+      instance.instance_exec(&block)
+      extract_mzl(instance)
+
+      # return the instance
+      instance
+    end
+  end
+end

data/lib/mzl/thing.rb

@@ -0,0 +1,110 @@
+module Mzl
+  class Thing
+    attr_reader :subject, :defaults, :options
+
+    def self.for(klass)
+      @things_by_class ||= {}
+      @things_by_class[klass] ||= new(klass)
+    end
+
+    def initialize(subject)
+      raise ArgumentError unless subject.is_a?(Class)
+
+      # the class we will be instantiating
+      @subject = subject
+
+      # this object will hold our DSL methods so we don't make a mess
+      @dsl_proxy = DSLProxy.new
+
+      # default parameters for things
+      @defaults = Hash.new({})
+    end
+
+    # this is stupid and probably only here for that test I wrote earlier
+    def dsl_methods
+      @dsl_proxy.defs
+    end
+
+    def override_new(bool = true)
+      if bool
+        @subject.singleton_class.class_exec do
+          alias_method(:mzl_orig_new, :new) if method_defined?(:new)
+          def new(*args, &block)
+            mzl.new(*args, &block)
+          end
+          @__mzl_new_overridden = true
+        end
+      elsif @subject.singleton_class.instance_variable_get(:@__mzl_new_overridden)
+        @subject.singleton_class.class_exec do
+          @__mzl_new_overridden = false
+          remove_method(:new) # this is the shim new we defined above
+
+          if respond_to?(:mzl_orig_new)
+            alias_method :mzl_orig_new, :new
+            remove_method(:mzl_orig_new)
+          end
+        end
+      end
+    end
+
+    # define a DSL method
+    def def(sym, opts = {}, &block)
+      raise ArgumentError unless block_given?
+      raise ArgumentError if @dsl_proxy.defs.include?(sym)
+      @dsl_proxy.def(sym, @defaults[:def].merge(opts), &block)
+    end
+
+    def child(sym, klass, opts = {persist: true})
+      self.def(sym) do |&block|
+        # be a attr_reader for a new instance of the child class
+        child = instance_variable_get(:"@#{sym}")
+        child = instance_variable_set(:"@#{sym}", klass.mzl.new) unless child
+
+        # mzl an optional block in the child
+        child.mzl(&block) if block.is_a?(Proc)
+
+        # and return it, of course
+        child
+      end
+
+      if opts[:persist]
+        @subject.send(:define_method, sym) do
+          if val = instance_variable_get(:"@#{sym}")
+            val
+          else
+            val = instance_variable_set(:"@#{sym}", klass.mzl.new)
+          end
+        end
+      end
+    end
+
+    # instance method not class method!
+    def new(&block)
+      # we will need ourselves later
+      _self = self
+
+      # create an instance of subject
+      instance = subject.respond_to?(:mzl_orig_new) ? subject.mzl_orig_new : subject.new
+      instance = block_given? ? exec(instance, &block) : instance
+
+      # Give the instance a mzl thing (_self)
+      instance.singleton_class.send(:define_method, :mzl) do |&blk|
+        _self.exec(self, &blk) if blk.is_a?(Proc)
+        _self
+      end
+
+      # put the permanent methods on (in case they never call mzl with a block)
+      @dsl_proxy.insert_mzl(instance, persist: true)
+
+      # and return it
+      instance
+    end
+
+    def exec(instance, &block)
+      return instance unless block_given?
+
+      # have the dsl proxy execute the block on behalf of that instance
+      @dsl_proxy.exec_for(instance, &block)
+    end
+  end
+end

data/lib/mzl/version.rb

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

data/mzl.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/mzl/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Kyle Brett"]
+  gem.email         = ["kyle@kylebrett.com"]
+  gem.description   = %q{Ridiculous metaprogramming for almost no reason.}
+  gem.summary       = %q{Metaprogramming library for DSLs}
+  gem.homepage      = "http://github.com/dashkb/mzl"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "mzl"
+  gem.require_paths = ["lib"]
+  gem.version       = Mzl::VERSION
+end

data/spec/mzl_spec.rb

@@ -0,0 +1,157 @@
+require 'spec_helper'
+require 'examples/calculate'
+
+describe 'Class' do
+  let(:klass) do
+    klass = Class.new
+    klass.mzl.def :call_block do |*args, &block|
+      block.call
+    end
+
+    klass.mzl.def :properties, persist: true do
+      @properties ||= {}
+    end
+
+    klass.mzl.def :throw_the_instance do
+      throw :the_instance, self
+    end
+
+    klass
+  end
+
+  describe '.mzl' do
+    it 'responds with a Mzl::Thing' do
+      Class.mzl.should be_a(Mzl::Thing)
+    end
+
+    specify 'subject is the calling class' do
+      Class.mzl.subject.should == Class
+      klass.mzl.subject.should == klass
+      klass.mzl.new.mzl.subject.should == klass
+    end
+
+    specify 'with a block is the same as .mzl.new' do
+      instance = klass.mzl do
+        properties[:foo] = :bar
+      end
+
+      instance.instance_variable_get(:@properties)[:foo].should == :bar
+    end
+
+    describe '.def' do
+      it 'defines a DSL method for the subject' do
+        klass.mzl.dsl_methods.should == [:call_block, :properties, :throw_the_instance]
+      end
+
+      it 'can define methods which take blocks' do
+        catch(:block) do
+          klass.mzl.new do
+            call_block do
+              throw :block, self
+            end
+          end
+        end.should be_a(klass)
+      end
+
+      it 'executes the methods in the correct context' do
+        catch(:the_instance) do
+          klass.mzl.new do
+            throw_the_instance
+          end
+        end.should be_a(klass)
+      end
+
+      it 'takes option :persist => true to permanently define the method on the instance' do
+        klass.mzl do
+          properties[:foo] = 'whatever'
+        end.properties[:foo].should == 'whatever'
+      end
+
+      it 'by default defines methods only available during mzl' do
+        expect {
+          klass.mzl.new
+        }
+      end
+    end
+
+    describe '.new' do
+      it 'returns an instance of of the subject class' do
+        klass.mzl.new.should be_a(klass)
+      end
+
+      it 'sets self to the instance' do
+        catch(:instance) do
+          klass.mzl.new do
+            throw :instance, self
+          end.should be_a(klass)
+        end
+      end
+
+      it 'instance_execs a block against the instance with mzl methods available' do
+        instance_a = klass.mzl.new do
+          properties[:foo] = :bar
+        end
+
+        instance_b = klass.mzl.new do
+          properties[:foo] = :baz
+        end
+
+        [[instance_a, :bar], [instance_b, :baz]].each do |pair|
+          instance, val = pair
+          props = instance.instance_variable_get(:@properties)
+          props.should be_a(Hash)
+          props[:foo].should == val
+        end
+      end
+
+      it 'can override klass.new' do
+        klass.mzl.new.should respond_to(:properties)
+        klass.new.should_not respond_to(:properties)
+
+        klass.mzl.override_new
+        klass.new.should respond_to(:properties)
+        klass.mzl.override_new(false)
+        klass.new.should_not respond_to(:properties)
+      end
+    end
+  end
+end
+
+describe 'Mzl instances' do
+  let(:klass) { Examples::Calculate }
+
+  it 'should not respond to DSL methods' do
+    klass.mzl.new.should_not respond_to(:add)
+  end
+
+  it 'should respond to normal instance methods' do
+    klass.mzl.new.total.should == 0
+
+    catch(:total) do
+      klass.mzl.new do
+        throw(:total, total)
+      end
+    end.should == 0
+  end
+
+  it 'should put two and two together' do
+    klass.mzl.new do
+      add 2, 2
+    end.total.should == 4
+  end
+
+  it 'should have a mzl thing' do
+    instance = klass.mzl.new
+    instance.should respond_to(:mzl)
+    instance.mzl.should be_a(Mzl::Thing)
+  end
+
+  it 'can use the mzl thing to call dsl methods later' do
+    instance = klass.mzl.new
+    expect {
+      instance.mzl do
+        add 1, 1, 1, 1
+      end
+    }.to change { instance.total }.by(4)
+  end
+end

data/spec/scopes_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+require 'examples/scopes'
+
+describe Examples::Scopes do
+  subject { Examples::Scopes }
+  let(:instance) { subject.mzl.new }
+
+  it 'has a calculator child' do
+    instance.should respond_to(:calculate)
+    instance.calculate.should be_a(Examples::Calculate)
+
+    catch(:calculate) do
+      instance.mzl do
+        throw :calculate, calculate
+      end
+    end.should be_a(Examples::Calculate)
+  end
+
+  it 'can do math with the calculator child' do
+    expect {
+      instance.mzl do
+        calculate.mzl { add 1, 1 }
+      end
+    }.to change { instance.calculate.total }.by(2)
+  end
+
+  it 'can do math with the calculator child without calling mzl explicitly' do
+    expect {
+      instance.mzl { calculate { add 1, 4 } }
+    }.to change { instance.calculate.total }.by(5)
+
+    expect {
+      instance.calculate { add 1, 1 }
+    }.to_not raise_exception
+
+    expect {
+      instance.calculate.mzl { calculate { add 2, 3 } }
+    }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+require 'rubygems'
+require 'spork'
+
+#uncomment the following line to use spork with the debugger
+#require 'spork/ext/ruby-debug'
+
+Spork.prefork do
+  require 'pry'
+
+  RSpec.configure do |config|
+    config.treat_symbols_as_metadata_keys_with_true_values = true
+    config.run_all_when_everything_filtered = true
+    config.filter_run :focus
+
+    # 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'
+  end
+end
+
+Spork.each_run do
+  require 'mzl'
+end
+

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: mzl
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Kyle Brett
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-17 00:00:00.000000000 Z
+dependencies: []
+description: Ridiculous metaprogramming for almost no reason.
+email:
+- kyle@kylebrett.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/examples/calculate.rb
+- lib/examples/scopes.rb
+- lib/mzl.rb
+- lib/mzl/dsl_proxy.rb
+- lib/mzl/thing.rb
+- lib/mzl/version.rb
+- mzl.gemspec
+- spec/mzl_spec.rb
+- spec/scopes_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/dashkb/mzl
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1818933194322953242
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1818933194322953242
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Metaprogramming library for DSLs
+test_files:
+- spec/mzl_spec.rb
+- spec/scopes_spec.rb
+- spec/spec_helper.rb