jzimmek-easy_dsl 0.1.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Jan Zimmek
+
+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.rdoc

@@ -0,0 +1,7 @@
+= easy_dsl
+
+EasyDSL provides common functionality to build a ruby based internal DSL
+
+== Copyright
+
+Copyright (c) 2009 Jan Zimmek. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "easy_dsl"
+    gem.summary = %Q{EasyDSL provides common functionality to build a ruby based internal DSL}
+    gem.email = "jan.zimmek@web.de"
+    gem.homepage = "http://github.com/jzimmek/easy_dsl"
+    gem.authors = ["Jan Zimmek"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "easy_dsl #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/easy_dsl.gemspec

@@ -0,0 +1,54 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{easy_dsl}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jan Zimmek"]
+  s.date = %q{2009-08-12}
+  s.email = %q{jan.zimmek@web.de}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "easy_dsl.gemspec",
+     "lib/easy_dsl.rb",
+     "lib/easy_dsl/attribute.rb",
+     "lib/easy_dsl/container.rb",
+     "test/easy_dsl/test/apache.rb",
+     "test/easy_dsl/test/rewrite.rb",
+     "test/easy_dsl/test/virtual_host.rb",
+     "test/easy_dsl_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/jzimmek/easy_dsl}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.4}
+  s.summary = %q{EasyDSL provides common functionality to build a ruby based internal DSL}
+  s.test_files = [
+    "test/easy_dsl/test/apache.rb",
+     "test/easy_dsl/test/rewrite.rb",
+     "test/easy_dsl/test/virtual_host.rb",
+     "test/easy_dsl_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/lib/easy_dsl/attribute.rb

@@ -0,0 +1,24 @@
+module EasyDsl
+  class Attribute
+    
+    attr_reader :required
+    attr_reader :inheritable
+    attr_reader :filter
+    
+    def self.create(opts)
+      opts = {
+        :required => false,
+        :inheritable => true,
+        :filter => nil
+      }.merge(opts)
+
+      new(opts[:required], opts[:inheritable], opts[:filter])
+    end
+    
+    def initialize(required, inheritable, filter)
+      @required = required
+      @inheritable = inheritable
+      @filter = filter
+    end
+  end
+end

data/lib/easy_dsl/container.rb

@@ -0,0 +1,162 @@
+require 'active_support'
+require 'base64'
+require 'easy_dsl/attribute'
+
+module EasyDsl
+  class Container
+    
+    attr_accessor :name
+    attr_accessor :container
+    attr_reader   :attributes
+    attr_reader   :children
+
+    def initialize(name, container)
+      @name = name
+      @container = container
+      @attributes = {}
+      @children = []
+      @nested = {}
+    end
+    
+    def self.create(opts={}, &block)
+      root = self.new("default")
+      root.instance_eval(&block) if block_given?
+      root.freeze_attributes
+      root.validate unless opts[:validate] == false
+      root
+    end
+    
+    def validate
+      @attributes.each_pair do |name, attribute|
+        if attribute.required
+          raise "attribute #{name} in #{self.class.name} (#{self.name}) is required" unless send(name)
+        end
+      end
+      
+      @children.each do |child|
+        child.validate
+      end
+    end
+    
+    def attribute(name, opts={})
+      
+      name = name.to_sym
+      
+      @attributes[name] = Attribute.create(opts)
+      
+      self.class.send(:define_method, name) do |value|
+        
+        raise "attribute #{name} of #{self.class.name}.#{self.name} is already frozen" if frozen?
+        
+        value = opts[:filter].call(value) if opts[:filter]
+        
+        instance_variable_set("@#{name}", value)
+      end
+
+      __define_getter(name, "#{name}_value".to_sym)
+
+    end
+    
+    def __define_getter(name, getter_name)
+      self.class.send(:define_method, getter_name) do
+        value = instance_variable_get("@#{name}")
+  
+        if !value && @container && @container.is_attribute_inheritable?(name)
+          if @container.respond_to?(getter_name)
+            # while in initialization phase
+            value = @container.send(getter_name)
+          else
+            # when initialization phase is over
+            value = @container.send(name)
+          end
+        end
+  
+        value          
+      end        
+    end
+    
+    def is_attribute_inheritable?(name)
+      @attributes[name].try(:inheritable) == true
+    end
+    
+    def freeze_attributes
+      @attributes.keys.each do |name|
+        getter = self.method("#{name}_value".to_sym)
+
+        next unless getter
+        
+        self.class.send(:remove_method, name)
+        self.class.send(:remove_method, "#{name}_value")
+
+        __define_getter(name, name)
+      end
+    end
+    
+    def selfrdoc
+      
+      selfdoc.each_pair do |clazz, doc|
+        
+        puts "**** #{clazz.name}"
+
+        puts "** attributes"
+
+        doc[:attributes].each_pair do |name, attribute|
+          puts "- #{name} (required: #{attribute.required}, :inheritable => #{attribute.inheritable})"
+        end
+          
+        puts "** nested elements"
+        
+        doc[:nested].each_pair do |name, nested|
+          puts "- #{name} (#{nested})"
+        end
+        
+      end
+      
+    end
+    
+    def selfdoc(doc={})
+      
+      unless doc.key?(self.class)
+        
+        doc[self.class] = {
+          :element => self.class,
+          :attributes => @attributes,
+          :nested => @nested
+        }
+        
+        @nested.values.each do |nested_clazz|
+          nested = nested_clazz.new("default", self)
+          nested.selfdoc(doc)
+        end
+        
+      end
+      
+      doc
+    end
+    
+    def nested(nested_name, clazz)
+      nested_name = nested_name.to_sym
+      
+      @nested[nested_name] = clazz unless @nested.key?(nested_name)
+      
+      instance_variable_set("@all_#{nested_name}", {})
+      
+      self.class.send(:define_method, "all_#{nested_name}") do
+        instance_variable_get("@all_#{nested_name}")
+      end
+      
+      self.class.send(:define_method, nested_name) do |obj_name, &block|
+        obj = clazz.new(obj_name, self)
+        instance_variable_get("@all_#{nested_name}")[obj_name] = obj
+
+        @children << obj
+
+        obj.instance_eval(&block) if block
+        
+        obj.freeze_attributes
+
+      end
+    end
+    
+  end
+end

data/lib/easy_dsl.rb

@@ -0,0 +1 @@
+require 'easy_dsl/container'

data/test/easy_dsl/test/apache.rb

@@ -0,0 +1,17 @@
+require 'easy_dsl/container'
+require 'easy_dsl/test/virtual_host'
+
+module EasyDsl
+  module Test
+    class Apache < EasyDsl::Container
+      def initialize(name)
+        super(name, nil)
+
+        attribute :webmaster_email,   :inheritable => true,   :required => true, :filter => Proc.new{|value|value.strip}
+        attribute :port,              :inheritable => true,   :required => true
+
+        nested    :virtual_host, VirtualHost
+      end
+    end
+  end
+end

data/test/easy_dsl/test/rewrite.rb

@@ -0,0 +1,12 @@
+require 'easy_dsl/container'
+
+module EasyDsl
+  module Test
+    class Rewrite < EasyDsl::Container
+      def initialize(name, container)
+        super
+        attribute :target,  :required => true
+      end
+    end
+  end
+end

data/test/easy_dsl/test/virtual_host.rb

@@ -0,0 +1,16 @@
+require 'easy_dsl/container'
+require 'easy_dsl/test/rewrite'
+
+module EasyDsl
+  module Test
+    class VirtualHost < EasyDsl::Container
+      def initialize(name, container)
+        super
+        attribute :document_root, :inheritable => false, :required => true
+        attribute :webmaster_email
+        attribute :port
+        nested    :rewrite, Rewrite
+      end
+    end
+  end
+end

data/test/easy_dsl_test.rb

@@ -0,0 +1,116 @@
+require 'test_helper'
+require 'easy_dsl/test/apache'
+
+class EasyDslTest < Test::Unit::TestCase
+
+  def test_attribute_filter
+    a = EasyDsl::Test::Apache.create do
+      port 8080
+      webmaster_email "  webmaster@domain "
+    end
+    
+    assert_equal "webmaster@domain", a.webmaster_email
+  end
+
+  def test_selfdoc
+    
+    a = EasyDsl::Test::Apache.create(:validate => false)
+    doc = a.selfdoc
+    
+    # apache
+    
+    assert_equal  EasyDsl::Test::Apache, doc[EasyDsl::Test::Apache][:element]
+    assert        doc[EasyDsl::Test::Apache][:attributes].length == 2
+
+    assert        doc[EasyDsl::Test::Apache][:attributes].include?(:webmaster_email)
+    assert        doc[EasyDsl::Test::Apache][:attributes][:webmaster_email].inheritable
+    assert        doc[EasyDsl::Test::Apache][:attributes][:webmaster_email].required
+
+    assert        doc[EasyDsl::Test::Apache][:attributes].include?(:port)
+    assert        doc[EasyDsl::Test::Apache][:attributes][:port].inheritable
+    assert        doc[EasyDsl::Test::Apache][:attributes][:port].required
+
+    assert        doc[EasyDsl::Test::Apache][:nested].length == 1
+    assert_equal  EasyDsl::Test::VirtualHost, doc[EasyDsl::Test::Apache][:nested][:virtual_host]
+
+    # virtualhost
+
+    assert_equal  EasyDsl::Test::VirtualHost, doc[EasyDsl::Test::VirtualHost][:element]
+    assert        doc[EasyDsl::Test::VirtualHost][:attributes].length == 3
+    
+    assert        doc[EasyDsl::Test::VirtualHost][:attributes].include?(:document_root)
+    assert        !doc[EasyDsl::Test::VirtualHost][:attributes][:document_root].inheritable
+    assert        doc[EasyDsl::Test::VirtualHost][:attributes][:document_root].required
+    
+    assert        doc[EasyDsl::Test::VirtualHost][:attributes].include?(:port)
+    assert        doc[EasyDsl::Test::VirtualHost][:attributes][:port].inheritable
+    assert        !doc[EasyDsl::Test::VirtualHost][:attributes][:port].required
+
+    assert        doc[EasyDsl::Test::VirtualHost][:attributes].include?(:webmaster_email)
+    assert        doc[EasyDsl::Test::VirtualHost][:attributes][:webmaster_email].inheritable
+    assert        !doc[EasyDsl::Test::VirtualHost][:attributes][:webmaster_email].required
+    
+    assert        doc[EasyDsl::Test::VirtualHost][:nested].length == 1
+    assert_equal  EasyDsl::Test::Rewrite, doc[EasyDsl::Test::VirtualHost][:nested][:rewrite]
+    
+    # rewrite
+
+    assert_equal  EasyDsl::Test::Rewrite, doc[EasyDsl::Test::Rewrite][:element]
+    assert        doc[EasyDsl::Test::Rewrite][:attributes].length == 1
+
+    assert        doc[EasyDsl::Test::Rewrite][:attributes].include?(:target)
+    assert        doc[EasyDsl::Test::Rewrite][:attributes][:target].inheritable
+    assert        doc[EasyDsl::Test::Rewrite][:attributes][:target].required
+    assert        doc[EasyDsl::Test::Rewrite][:nested].blank?
+    
+  end
+
+  def test_default
+    a = EasyDsl::Test::Apache.create do
+      
+      webmaster_email "webmaster@yourdomain"
+      port            80
+      
+      virtual_host "virtualhost01.yourdomain.com" do
+        document_root "/var/www/virtualhost01/htdocs"
+        rewrite "^/some_path/(.*)$" do
+          target "/some_other_path/$1"
+        end
+      end
+
+      virtual_host "virtualhost02.yourdomain.com" do
+        document_root "/var/www/virtualhost02/htdocs"
+        port 81
+        webmaster_email "jan@zimmek"
+      end
+    end
+    
+    assert_equal nil, a.container
+    assert_equal 2, a.all_virtual_host.length
+    assert_equal "webmaster@yourdomain", a.webmaster_email
+
+    
+    virtualhost01 = a.all_virtual_host["virtualhost01.yourdomain.com"]
+    assert_equal  a, virtualhost01.container
+    
+    virtualhost02 = a.all_virtual_host["virtualhost02.yourdomain.com"]
+    assert_equal  a, virtualhost02.container
+
+    assert_equal "virtualhost01.yourdomain.com", virtualhost01.name
+    assert_equal "webmaster@yourdomain", virtualhost01.webmaster_email
+    assert_equal 80, virtualhost01.port
+
+    assert_equal "virtualhost02.yourdomain.com", virtualhost02.name
+    assert_equal "jan@zimmek", virtualhost02.webmaster_email
+    assert_equal 81, virtualhost02.port
+    
+    assert_equal 1,                       virtualhost01.all_rewrite.length
+    
+    rewrite = virtualhost01.all_rewrite["^/some_path/(.*)$"]
+    assert_equal virtualhost01, rewrite.container
+    
+    assert_equal "^/some_path/(.*)$",     rewrite.name
+    assert_equal "/some_other_path/$1",   rewrite.target
+  end
+  
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'easy_dsl'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: jzimmek-easy_dsl
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Jan Zimmek
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-12 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: jan.zimmek@web.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- easy_dsl.gemspec
+- lib/easy_dsl.rb
+- lib/easy_dsl/attribute.rb
+- lib/easy_dsl/container.rb
+- test/easy_dsl/test/apache.rb
+- test/easy_dsl/test/rewrite.rb
+- test/easy_dsl/test/virtual_host.rb
+- test/easy_dsl_test.rb
+- test/test_helper.rb
+has_rdoc: false
+homepage: http://github.com/jzimmek/easy_dsl
+licenses: 
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: EasyDSL provides common functionality to build a ruby based internal DSL
+test_files: 
+- test/easy_dsl/test/apache.rb
+- test/easy_dsl/test/rewrite.rb
+- test/easy_dsl/test/virtual_host.rb
+- test/easy_dsl_test.rb
+- test/test_helper.rb