lustr-core 0.1.0

data/History.txt

@@ -0,0 +1,4 @@
++++ 0.1.0 2007-05-23
+
++ 1 major enhancement:
+  + Initial release

data/Manifest.txt

@@ -0,0 +1,20 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/lustr/blank_slate.rb
+lib/lustr/builder.rb
+lib/lustr/controller.rb
+lib/lustr/defaults.rb
+lib/lustr/dsl.rb
+lib/lustr/engine.rb
+lib/lustr/eval_context.rb
+lib/lustr/gadget.rb
+lib/lustr/generator.rb
+lib/lustr/parse_context.rb
+lib/lustr.rb
+lib/lustr/runtime.rb
+lib/lustr/version.rb
+lib/lustr/widget.rb
+scripts/txt2html
+setup.rb

data/README.txt

@@ -0,0 +1,8 @@
+Lustr is a Ruby DSL for GUI development. Write a Lustr GUI once, and you can:
+
+- Run it with Ruby controllers on the desktop, using wxRuby, on all major operating systems, including Linux, OS X, and many versions of Windows
+- Use the same Ruby controllers and run it in a JVM using JRuby and Swing
+- Run a code generator to convert the UI to Flex/MXML or XUL, to tie into your ActionScript or Javascript controllers
+
+More details on Lustr can be found at {Lustr's home page}[http://www.codecorps.org/moinmoin/index.cgi/Lustr]
+or on the {RubyForge}[http://rubyforge.org/projects/lustr] site.

data/Rakefile

@@ -0,0 +1,93 @@
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rake/contrib/rubyforgepublisher'
+require 'fileutils'
+require 'hoe'
+include FileUtils
+require File.join(File.dirname(__FILE__), 'lib', 'lustr', 'version')
+
+AUTHOR = 'Mark Murphy'  # can also be an array of Authors
+EMAIL = "mmurphy@municorps.org"
+DESCRIPTION = "Lustr core engine for Ruby GUI/RIA development"
+GEM_NAME = 'lustr-core' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'lustr' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+NAME = "lustr-core"
+REV = nil # UNCOMMENT IF REQUIRED: File.read(".svn/entries")[/committed-rev="(d+)"/, 1] rescue nil
+VERS = Lustr::VERSION::STRING + (REV ? ".#{REV}" : "")
+CLEAN.include ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']
+RDOC_OPTS = ['--quiet', '--title', 'lustr-core documentation',
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject { |x| Array(x).first == 'hoe' } 
+  end 
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.author = AUTHOR 
+  p.description = DESCRIPTION
+  p.email = EMAIL
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs = CLEAN  #An array of file patterns to delete on clean.
+  
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.extra_deps = [['builder', '>=2.1.1']]     # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
+  #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+end
+
+
+desc 'Generate website files'
+task :website_generate do
+  Dir['website/**/*.txt'].each do |txt|
+    sh %{ ruby scripts/txt2html #{txt} > #{txt.gsub(/txt$/,'html')} }
+  end
+end
+
+desc 'Upload website files to rubyforge'
+task :website_upload do
+  config = YAML.load(File.read(File.expand_path("~/.rubyforge/user-config.yml")))
+  host = "#{config["username"]}@rubyforge.org"
+  remote_dir = "/var/www/gforge-projects/#{RUBYFORGE_PROJECT}/"
+  # remote_dir = "/var/www/gforge-projects/#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+  local_dir = 'website'
+  sh %{rsync -av #{local_dir}/ #{host}:#{remote_dir}}
+end
+
+desc 'Generate and upload website files'
+task :website => [:website_generate, :website_upload]
+
+desc 'Release the website and new gem version'
+task :deploy => [:check_version, :website, :release]
+
+desc 'Runs tasks website_generate and install_gem as a local deployment of the gem'
+task :local_deploy => [:website_generate, :install_gem]
+
+task :check_version do
+  unless ENV['VERSION']
+    puts 'Must pass a VERSION=x.y.z release version'
+    exit
+  end
+  unless ENV['VERSION'] == VERS
+    puts "Please update your version.rb to match the release version, currently #{VERS}"
+    exit
+  end
+end
+

data/lib/lustr.rb

@@ -0,0 +1,17 @@
+=begin
+This file is part of Lustr (http://rubyforge.org/projects/lustr).
+
+Copyright (c) 2007 Mark L. Murphy.
+
+Lustr is free software; you can redistribute it and/or modify it under the
+terms of the GNU General Public License as published by the Free Software
+Foundation; either version 2 of the License.
+
+Lustr is distributed in the hope that it will be useful, but WITHOUT ANY
+WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
+details. This file is included in the Ruby gem as License.txt.
+=end
+
+path=File::join(File::dirname(__FILE__), 'lustr')
+Dir[path+'/*.rb'].sort.each {|f| require f if !File.directory?(f)}

data/lib/lustr/blank_slate.rb

@@ -0,0 +1,33 @@
+=begin
+This file is part of Lustr (http://rubyforge.org/projects/lustr).
+
+Copyright (c) 2007 Mark L. Murphy.
+
+Lustr is free software; you can redistribute it and/or modify it under the
+terms of the GNU General Public License as published by the Free Software
+Foundation; either version 2 of the License.
+
+Lustr is distributed in the hope that it will be useful, but WITHOUT ANY
+WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
+details. This file is included in the Ruby gem as License.txt.
+=end
+
+module Lustr
+
+=begin rdoc
+This is a "blank slate" class, styled after the BlankSlate documented at
+http://onestepback.org/index.cgi/Tech/Ruby/BlankSlate.rdoc. It is used as the
+superclass for the DSL and eliminates as many of the intrinsic Object methods
+as possible to minimize collision with possible widget and gadget names.
+=end
+
+	class BlankSlate
+		instance_methods.each { |m| undef_method(m) unless %w(
+				 __send__ __id__ send class require
+				 inspect instance_eval instance_variables respond_to? kind_of?
+				 ).include?(m)
+		}
+	end
+end
+

data/lib/lustr/builder.rb

@@ -0,0 +1,117 @@
+=begin
+This file is part of Lustr (http://rubyforge.org/projects/lustr).
+
+Copyright (c) 2007 Mark L. Murphy.
+
+Lustr is free software; you can redistribute it and/or modify it under the
+terms of the GNU General Public License as published by the Free Software
+Foundation; either version 2 of the License.
+
+Lustr is distributed in the hope that it will be useful, but WITHOUT ANY
+WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
+details. This file is included in the Ruby gem as License.txt.
+=end
+
+module Lustr
+
+=begin rdoc
+BuilderBase is the base class of all builders used in toolkits. A "builder"
+takes the definition from the DSL and creates a widget instance (runtime) or
+generates the appropriate UI source code (generative). The norm is for builders
+to be subclasses of BuilderBase and declared through <tt>Lustr.declare()</tt>.
+=end
+	
+	class BuilderBase
+		attr_reader :children, :event_handlers, :name, :widget_type
+		attr_accessor :options
+		
+		def initialize(widget_type, options={})
+			@widget_type=widget_type
+			@children=[]
+			@event_handlers={}
+
+			if widget_type
+				@options=Lustr.defaults(widget_type).merge(options)
+			else
+				@options=options
+			end
+
+			@name=self.options[:name]
+		end
+
+		def all_event_handlers
+			result=event_handlers
+
+			children.each do |child|
+				result.merge!(child.all_event_handlers)
+			end
+
+			return result
+		end
+
+		def <<(child)
+			children << child if child
+		end
+		
+		def build_all(eval_context, parent_widget=nil)
+			widget=nil
+			
+			if parent_widget
+				widget=build(parent_widget.resolve_parent)
+			else
+				widget=build(nil)
+			end
+
+			widget.init_options(options)
+			widget.name=options[:name]
+			widget.eval_context=eval_context
+			widget.gadget=eval_context.current_gadget
+			eval_context.current_gadget.widgets[widget.name]=widget if eval_context.current_gadget && widget.name
+				
+			proc=lambda {
+				children.each do |child|
+					tree=child.build_all(eval_context, widget.resolve)
+					widget << tree
+				end
+			}
+
+			if widget.respond_to?(:init_block=)
+				widget.init_block=proc
+			elsif widget.kind_of?(Gadget)
+				eval_context.for_gadget(widget, proc)
+			else
+				proc.call
+			end
+
+			return widget
+		end
+
+		def dup_from(options)
+			self.class.new(widget_type, options)
+		end
+	end
+
+=begin rdoc
+SimpleBuilder handles the really simple case where a builder simply instantiates
+some widget class. Then, rather than having to create custom builder subclasses
+for each widget class, you can simply <tt>Lustr.declare()</tt> an instance of SimpleBuilder
+with the appropriate widget class as a parameter.
+=end
+	
+	class SimpleBuilder < BuilderBase
+		def initialize(widget_type, klass, options={})
+			super(widget_type, options)
+			@widget_class=klass
+    end
+
+		def dup_from(options)
+			self.class.new(widget_type, @widget_class, options)
+		end
+		
+		def build(parent_widget)
+			@widget_class.new
+		end
+	end
+end
+

data/lib/lustr/controller.rb

@@ -0,0 +1,29 @@
+=begin
+This file is part of Lustr (http://rubyforge.org/projects/lustr).
+
+Copyright (c) 2007 Mark L. Murphy.
+
+Lustr is free software; you can redistribute it and/or modify it under the
+terms of the GNU General Public License as published by the Free Software
+Foundation; either version 2 of the License.
+
+Lustr is distributed in the hope that it will be useful, but WITHOUT ANY
+WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
+details. This file is included in the Ruby gem as License.txt.
+=end
+
+module Lustr
+	module ControllerBase
+		attr_accessor :gadget
+	end
+
+	class NullController
+		include ControllerBase
+
+		def instance_eval(str)
+			eval(str)
+		end
+	end
+end
+

data/lib/lustr/defaults.rb

@@ -0,0 +1,67 @@
+=begin
+This file is part of Lustr (http://rubyforge.org/projects/lustr).
+
+Copyright (c) 2007 Mark L. Murphy.
+
+Lustr is free software; you can redistribute it and/or modify it under the
+terms of the GNU General Public License as published by the Free Software
+Foundation; either version 2 of the License.
+
+Lustr is distributed in the hope that it will be useful, but WITHOUT ANY
+WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
+details. This file is included in the Ruby gem as License.txt.
+=end
+
+module Lustr
+	module Defaults
+		def self.app
+			{:title=>'', :width=>640, :height=>480}
+		end
+
+		def self.box
+			{:direction=>:vertical}
+		end
+
+		def self.button
+			{:text=>'Click me!'}
+		end
+
+		def self.divided_box
+			box
+		end
+
+		def self.field
+			{:text=>''}
+		end
+
+		def self.html_area
+			{:wordWrap=>false}
+		end
+
+		def self.label
+			{:text=>''}
+		end
+
+		def self.list
+			{:editable=>false}
+		end
+
+		def self.tab_panel
+			{:label=>''}
+		end
+
+		def self.text_area
+			{:editable=>true, :wordWrap=>false}
+		end
+
+		def self.tree
+			{}
+		end
+
+		def self.method_missing(sym, *parms)
+			{}
+		end
+	end
+end
+

data/lib/lustr/dsl.rb

@@ -0,0 +1,52 @@
+=begin
+This file is part of Lustr (http://rubyforge.org/projects/lustr).
+
+Copyright (c) 2007 Mark L. Murphy.
+
+Lustr is free software; you can redistribute it and/or modify it under the
+terms of the GNU General Public License as published by the Free Software
+Foundation; either version 2 of the License.
+
+Lustr is distributed in the hope that it will be useful, but WITHOUT ANY
+WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
+details. This file is included in the Ruby gem as License.txt.
+=end
+
+module Lustr
+	class DSL < BlankSlate
+		def self.add_dsl_method(*symbols)
+			symbols.each do |sym|
+				class_eval <<EOF
+					def #{sym}(options={})
+						@parse_context.add_builder(:#{sym}, options) { yield if block_given? }
+					end
+EOF
+			end
+		end
+
+		def initialize(parse_context, eval_context)
+			@parse_context=parse_context
+			@eval_context=eval_context
+			@involved=[]
+		end
+
+		def involve(path)
+			if !@involved.include?(path)
+				@involved << path
+				self.instance_eval(File.new(path).read, path) 
+			end
+		end
+
+		def gadget(options)
+			builder=GadgetBuilder.new(options)
+			@parse_context.attach_builder(builder, options[:name]) { yield if block_given? }
+			Lustr.add_dsl_handler(options[:name].to_sym, builder)
+		end
+
+		def is_runtime?
+			@eval_context.is_runtime?
+		end
+	end
+end
+