dsl 0.1.0

data/.gitignore

@@ -0,0 +1 @@
+Rakefile

data/README.md

@@ -0,0 +1,49 @@
+# DSL
+
+## Description
+
+dsl.rb is a small script (26 lines) to help create domain specific languages within Ruby.
+
+## Install
+
+Until I setup the gem... just clone and play around with it.
+
+## Quick Example
+
+    require 'dsl'
+
+    class UserDSL < DSL
+      def name(n);   @name = n;   end
+      def gender(g); @gender = g; end
+      def age(a);    @age = a;    end
+    end
+
+    class User
+      attr :name, :gender, :age
+      dsl_method :edit => UserDSL
+    end
+
+    ryguy = User.new
+
+    ryguy.edit do
+      name 'Ryan Lewis'
+      gender :male
+      age 19
+    end
+
+    p ryguy
+    # => #<User:0x00000001b6dc78 @name="Ryan Lewis", @gender=:male, @age=19>
+
+As you can see, simply requiring DSL adds the Module/Class method `dsl_method`, which defines a new instance method for your class that only accepts a block.
+
+`dsl_method` only accepts a `Hash`, the key being the instance method name and the value being the DSL class the method will use.
+
+When your DSL instance method is called (with a block, of course), all of your object's instance variables are delegated into a new instance of the DSL class assigned to the called DSL instance method.  
+The block is then `instance_eval`'d within the new DSL class instance where you can use the instance variables.  
+When the block is closed, all of the instance variables are then transfered back to your object.
+
+Therefor, creating a Domain Specific Language is as easy as subclassing the `DSL` class. That's it!
+
+## Copyright
+
+Copyright (c) 2010 Ryan Lewis. See LICENSE for details.

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/dsl.rb

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+
+class DSL  
+  def self.call(parent, &blk)
+    instance = new
+    # Add all of the parents instance variables to the instance
+    parent.instance_variables.each do |instance_variable|
+      value = parent.instance_variable_get(instance_variable)
+      instance.instance_variable_set(instance_variable, value)
+    end
+    # Instance eval the block in the instance
+    instance.instance_eval(&blk)
+    # Replace all of the parents instance variables with the instance's
+    instance.instance_variables.each do |instance_variable|
+      value = instance.instance_variable_get(instance_variable)
+      parent.instance_variable_set(instance_variable, value)
+    end
+  end
+end
+
+class Module
+  def dsl_method(opts)
+    # Complain if the argument isn't a hash
+    raise(TypeError) unless opts.is_a?(Hash)
+    # For each dsl_method, define it in the class
+    # The methods do not accept arguments, only blocks
+    opts.each do |method, dsl_class|
+      define_method(method) do |&blk|
+        raise(ArgumentError, "method #{method} requires a block") unless block_given?
+        dsl_class.call(self, &blk)
+      end
+    end
+  end
+end

data/examples/database.rb

@@ -0,0 +1,77 @@
+#!/usr/bin/env ruby
+
+require File.join(File.dirname(__FILE__), '..', 'dsl')
+
+class Database
+  class Table
+    def initialize
+      @schema = {}
+      @entries = []
+    end
+    
+    def create(opts)
+      raise(TypeError) unless opts.is_a?(Hash)
+      opts.each do |name, v|
+        raise("key '#{name}' not defined in schema") unless @schema.has_key?(name)
+        if @schema[name] == :primary_key
+          raise('You cannot set primary keys')
+        else
+          raise("key '#{name}' not of type #{@schema[name]}") unless v.is_a?(@schema[name])
+        end
+      end
+      @schema.select { |name, v| v == :primary_key }.each do |name, v|
+        opts[name] = @entries.count
+      end
+      @entries << opts
+    end
+    
+    def [](id)
+      @entries.find_all do |entry|
+        entry[:id] == id
+      end
+    end
+  end
+  
+  class SchemaDSL < DSL
+    def primary_key(name); @schema[name] = :primary_key; end
+    def String(name);      @schema[name] = ::String;     end
+    def Integer(name);     @schema[name] = ::Integer;    end
+  end
+  
+  def initialize
+    @tables = {}
+  end
+  
+  def table(name, &blk)
+    if block_given?
+      raise("Table '#{name}' already exists") unless @tables[name].nil?
+      @tables[name] = Table.new
+      SchemaDSL.call(@tables[name], &blk)
+    else
+      @tables[name]
+    end
+  end
+end
+
+require 'ap'
+
+db = Database.new
+
+db.table(:users) do
+  primary_key :id
+       String :username
+      Integer :age
+end
+
+db.table(:users).create(:username => 'Foo', :age => 19)
+db.table(:users).create(:username => 'Bar', :age => 43)
+
+p db.table(:users)[0]
+# => [{:username=>"Foo", :age=>19, :id=>0}]
+
+p db.table(:users)[1]
+# => [{:username=>"Bar", :age=>43, :id=>1}]
+
+db.table(:users).create(:username => 'Baz', :age => 'One Hundred')
+# => ERROR: key 'age' not of type Integer (RuntimeError)
+

data/examples/user.rb

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+
+require File.join(File.dirname(__FILE__), '..', 'dsl')
+
+class UserDSL < DSL
+  def name(n);   @name = n;   end
+  def gender(g); @gender = g; end
+  def age(a);    @age = a;    end
+end
+
+class User
+  attr :name, :gender, :age
+  dsl_method :edit => UserDSL
+end
+
+ryguy = User.new 
+
+ryguy.edit do
+  name 'Ryan Lewis'
+  gender :male
+  age 19
+end
+
+p ryguy
+# => #<User:0x00000001b6dc78 @name="Ryan Lewis", @gender=:male, @age=19>

data/examples/webapp.rb

@@ -0,0 +1,43 @@
+#!/usr/bin/env ruby
+
+require File.join(File.dirname(__FILE__), '..', 'dsl')
+
+class ConfigDSL < DSL
+  def add_helpers(*h)
+    @helpers.concat(h)
+  end
+end
+
+class WebApp
+  attr :helpers
+  dsl_method :config => ConfigDSL
+  
+  #===--- OR:
+  # dsl_method :config => Class.new(DSL) {
+  #   def add_helpers(*h)
+  #     @helpers.concat(h)
+  #   end
+  # }
+  
+  #===--- MAYBE:
+  # define_dsl_method :config do
+  #   def add_helpers; end
+  # end
+  
+  def initialize
+    @helpers = ['helpers/foo', 'helpers/bar']
+  end
+end
+
+web_app = WebApp.new
+
+p web_app.helpers
+# => ["helpers/foo", "helpers/bar"]
+
+web_app.config do
+  add_helpers 'helpers/baz', 'helpers/qux'
+end
+
+p web_app.helpers
+# => ["helpers/foo", "helpers/bar", "helpers/baz", "helpers/qux"]
+

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: dsl
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Ryan Lewis
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-16 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: Easily create Domain Specific Languages with any block. You can also link instance methods to your DSL.
+email: c00lryguy@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- .gitignore
+- README.md
+- VERSION
+- dsl.rb
+- examples/database.rb
+- examples/user.rb
+- examples/webapp.rb
+has_rdoc: true
+homepage: http://github.com/c00lryguy/dsl
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A small library for creating Domain Specific Languages (DSLs)
+test_files: 
+- examples/webapp.rb
+- examples/database.rb
+- examples/user.rb