lustr-xul 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,16 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/lustr-xul.rb
+lib/lustr-xul/version.rb
+lib/lustr-xul/_common.rb
+lib/lustr-xul/button.rb
+lib/lustr-xul/box.rb
+lib/lustr-xul/label.rb
+lib/lustr-xul/field.rb
+lib/lustr-xul/app.rb
+lib/lustr-xul/dividedbox.rb
+scripts/txt2html
+setup.rb
+

data/README.txt

@@ -0,0 +1,6 @@
+Lustr is a Ruby DSL for GUI development. Lustr4Wx allows Lustr UIs to be
+displayed via XUL.
+
+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-xul', 'version')
+
+AUTHOR = 'FIXME full name'  # can also be an array of Authors
+EMAIL = "FIXME email"
+DESCRIPTION = "description of gem"
+GEM_NAME = 'lustr-xul' # 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-xul"
+REV = nil # UNCOMMENT IF REQUIRED: File.read(".svn/entries")[/committed-rev="(d+)"/, 1] rescue nil
+VERS = Lustr4XUL::VERSION::STRING + (REV ? ".#{REV}" : "")
+CLEAN.include ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']
+RDOC_OPTS = ['--quiet', '--title', 'lustr-xul 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 = [['lustr-core', '>=0.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-xul.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-xul')
+Dir[path+'/*.rb'].sort.each {|f| require f}

data/lib/lustr-xul/_common.rb

@@ -0,0 +1,136 @@
+=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
+
+require 'lustr'
+require 'rubygems'
+require 'builder'
+ 
+module Lustr4XUL
+	class GenerationContext < Builder::XmlMarkup
+		attr_reader :name
+		
+		def initialize(name)
+			super()
+			@name=name
+			@namespaces={'xmlns:xul'=>"http://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul"}
+			@script_needed=true
+		end
+
+		def to_s
+			self.target!
+		end
+
+		def build_gadget_ref(gadget)
+			self.xul :box, :class=>gadget.builder.name.to_sym, :id=>gadget.name
+		end
+
+		def net_attrs(raw={})
+			result=raw.reject {|key, value| !value || (value.kind_of?(String) && value.size==0)}
+			
+			if @namespaces
+				result.merge!(@namespaces)
+			end
+			
+			@namespaces=nil
+
+			return result
+		end
+
+		def descend(widget)
+			if @script_needed
+				self.xul :script, 'src'=>'_'+@name+'.js'
+				@script_needed=false
+			end
+
+			first=true if block_given?
+
+			widget.children.each do |child|
+				child.generate(self)
+				
+				if first
+					first=false
+					yield
+				end
+			end
+		end
+	end
+
+	class XULGenerationContext < GenerationContext
+		def initialize(name)
+			super
+			@script_needed=true
+
+			self.instruct! :xml, :version=>"1.0", :encoding=>"UTF-8"
+			self.instruct! 'xml-stylesheet', :href=>"chrome://global/skin/", :type=>"text/css"
+			self.instruct! 'xml-stylesheet', :href=>"gadgets.css", :type=>"text/css"
+		end
+	end
+
+	class XBLGenerationContext < GenerationContext
+		def initialize(name)
+			super
+			@script_needed=true
+		end
+
+		def to_s
+			wrapper=Builder::XmlMarkup.new
+
+			wrapper.instruct! :xml, :version=>"1.0", :encoding=>"UTF-8"
+			wrapper.bindings 'xmlns'=>'http://www.mozilla.org/xbl' do
+				wrapper.binding 'id'=>name do
+					wrapper.content do
+						wrapper.children
+						wrapper << self.target!
+					end
+				end
+			end
+
+			return(wrapper.target!)
+		end
+	end
+
+	class Generator < Lustr::Generator
+		def create_context(name)
+			XULGenerationContext.new name
+		end
+
+		def create_gadget_context(name)
+			XBLGenerationContext.new name
+		end
+
+		def generate_extra_files(dir)
+			path=File::join(dir, 'gadgets.css')
+			
+			File.open(path, "w") do |aFile|
+				parse_context.gadget_builders.keys.each do |gadget|
+					if gadget
+						aFile.puts <<EOS
+box.#{gadget} { -moz-binding: url('gadgets/#{gadget}.xml##{gadget}'); }
+EOS
+					end
+				end
+			end
+		end
+	end
+end
+
+module Lustr
+	class XmlBasedWidget
+		def action(bus_message)
+			return "#{bus_message}(event)" if bus_message
+		end
+	end
+end
+

data/lib/lustr-xul/app.rb

@@ -0,0 +1,37 @@
+=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
+
+require 'lustr'
+ 
+module Lustr4XUL
+	class AppWidget < Lustr::XmlBasedWidget
+		def generate(xml)
+			attrs=xml.net_attrs 'onload'=>action(option(:on_init))
+
+			xml.xul :window, attrs do
+				scripts=option(:scripts) || []
+
+				scripts.each do |script|
+					xml.xul :script, 'src'=>script
+				end
+				
+				xml.descend(self)
+			end
+		end
+	end
+end
+
+Lustr.declare(Lustr::SimpleBuilder.new(:app, Lustr4XUL::AppWidget))
+

data/lib/lustr-xul/box.rb

@@ -0,0 +1,35 @@
+=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
+
+require 'lustr'
+ 
+module Lustr4XUL
+	class BoxWidget < Lustr::XmlBasedWidget
+		def generate(xml)
+			if option(:direction)==:horizontal
+				xml.xul :hbox, xml.net_attrs('id'=>option(:name), 'flex'=>option(:flex)) do
+					xml.descend(self)
+				end
+			else
+				xml.xul :vbox, xml.net_attrs('id'=>option(:name)) do
+					xml.descend(self)
+				end
+			end
+		end
+	end
+end
+
+Lustr.declare(Lustr::SimpleBuilder.new(:box, Lustr4XUL::BoxWidget))
+

data/lib/lustr-xul/button.rb

@@ -0,0 +1,31 @@
+=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
+
+require 'lustr'
+ 
+module Lustr4XUL
+	class ButtonWidget < Lustr::XmlBasedWidget
+		def generate(xml)
+			xml.xul :button, xml.net_attrs('id'=>option(:name),
+																'label'=>option(:text),
+																'oncommand'=>action(option(:on_click))) do
+				xml.descend(self)
+			end
+		end
+	end
+end
+
+Lustr.declare(Lustr::SimpleBuilder.new(:button, Lustr4XUL::ButtonWidget))
+

data/lib/lustr-xul/dividedbox.rb

@@ -0,0 +1,43 @@
+=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
+
+require 'lustr'
+ 
+module Lustr4XUL
+	class DividedBoxWidget < Lustr::XmlBasedWidget
+		def generate(xml)
+			if option(:direction)==:horizontal
+				xml.xul :hbox, xml.net_attrs('id'=>option(:name), 'flex'=>option(:flex)) do
+					xml.descend(self) {
+						xml.xul :splitter do
+							xml.xul :grippy
+						end
+					}
+				end
+			else
+				xml.xul :vbox, xml.net_attrs('id'=>option(:name)) do
+					xml.descend(self) {
+						xml.xul :splitter do
+							xml.xul :grippy
+						end
+					}
+				end
+			end
+		end
+	end
+end
+ 
+Lustr.declare(Lustr::SimpleBuilder.new(:divided_box, Lustr4XUL::DividedBoxWidget))
+

data/lib/lustr-xul/field.rb

@@ -0,0 +1,31 @@
+=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
+
+require 'lustr'
+
+module Lustr4XUL
+	class FieldWidget < Lustr::XmlBasedWidget
+		def generate(xml)
+			xml.xul :textbox, xml.net_attrs('id'=>option(:name),
+																'type'=>(option(:password) ? 'password' : nil),
+																'oninput'=>action(option(:on_change))) do
+				xml.descend(self)
+			end
+		end
+	end
+end
+
+Lustr.declare(Lustr::SimpleBuilder.new(:field, Lustr4XUL::FieldWidget))
+