tkxml 0.3.0

data/.ruby

@@ -0,0 +1,34 @@
+--- 
+name: tkxml
+organizaton: RubyWorks
+title: TkXML
+contact: trans <transfire+tkxml AT gmail.com>
+requires: 
+- group: 
+  - build
+  name: syckle
+  version: 0+
+- group: 
+  - test
+  name: qed
+  version: 0+
+pom_verison: 1.0.0
+manifest: 
+- .ruby
+- lib/tkxml/nokogiri.rb
+- lib/tkxml/rexml.rb
+- lib/tkxml.rb
+- lib/tkxml.yml
+- test/test_tkxml.rb
+- test/ui.xml
+- HISTORY.rdoc
+- LICENSE
+- README.rdoc
+- VERSION
+version: 0.2.4
+copyright: (c) 2008 Trans
+licenses: 
+- Apache 2.0
+description: TkXML translates XML markup into Ruby Tk interface code
+summary: XML markup for building Tk User interfaces
+created: 2008-02-21

data/HISTORY.rdoc

@@ -0,0 +1,20 @@
+= RELEASE HISTORY
+
+== 0.3.0 / 2011-03-05
+
+The REXML listener was causing an known error, and without word on
+a fix yet, we added a Nokogiri SAX parser that can take it's place.
+
+Changes:
+
+* Add Nokogiri SAX parser.
+* Make back-end selectable.
+
+== 0.2.0 / 2002-04-19
+
+Yes, TkXML was create just that long ago.
+
+Changes:
+
+* Happy birthday.
+

data/LICENSE

@@ -0,0 +1,205 @@
+.
+
+                             Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+.

data/README.rdoc

@@ -0,0 +1,54 @@
+= TkXML
+
+An XML markup lanaguage for generating Tk user-interfaces. It was inspired
+by GTK's glade format. The TkXML format defines a very simple one-to-one
+correlatation to the Ruby Tk API.
+
+== Usage
+
+Here's an +example.xml+ TkXML file:
+
+  <Tk:Root name="test" title="Test">
+    <Tk:Frame name="menuframe">
+      <Tk:Menubutton name="filebutton" text="File" underline="0">
+        <Tk:Menu name="filemenu" tearoff="false">
+          <Tk:_add _1="command" label="Open" underline="0" accel="Ctrl+O" command="openDocument" />
+          <Tk:_add _1="command" label="Exit" underline="0" accel="Ctrl+Q" command="exitApplication" />
+        </Tk:Menu>
+        <Tk:_pack side="left" />
+      </Tk:Menubutton>
+      <Tk:_pack side="left" />
+    </Tk:Frame>
+    <Tk:_bind _1="Control-o" _2="openDocument" />
+    <Tk:_bind _1="Control-q" _2="exitApplication" />
+  </Tk:Root>
+
+To use the library:
+
+  require 'tkxml'
+
+  tkxml = TkXML.new(File.read('example.xml'))
+  tkxml.build
+
+== STATUS
+
+At ths point, TkXML is little more than an interesting expirement in encoding 
+GUIs via markup. But it certainly has the potential of becoming a productive
+tool if someone were inclined to further it's development.
+
+== COPYING
+
+Copyright (c) 2002 Thomas Sawyer
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+

data/VERSION

@@ -0,0 +1 @@
+0.3.0

data/lib/tkxml/nokogiri.rb

@@ -0,0 +1,58 @@
+require 'nokogiri'
+
+class TkXML
+
+  def parse(source)
+    listener = Nokogiri_Listener.new(self)
+    parser   = Nokogiri::XML::SAX::Parser.new(listener)
+    parser.parse(source)
+  end
+
+  #
+  class Nokogiri_Listener < Nokogiri::XML::SAX::Document
+
+    #
+    attr :tk
+
+    #
+    def initialize(tk)
+      super()
+      @tk = tk
+    end
+
+    #
+    def start_element(name, attrs=[])
+      tk.start
+
+      ## pull off the tag name if prefixed with the Tk namespace
+      name  = name.sub(/^Tk:/, '')
+
+      attrs = Hash[*attrs]
+
+      ## is it a method call or a new widget?
+      if name[0..0] == '_'
+        name = name[1..-1]
+        tk.start_method(name, attrs)
+      else
+        tk.start_widget(name, attrs)
+      end
+    end
+
+    #
+    def end_element(name)
+      ## pull off the tag name if prefixed with the Tk namespace
+      name = name.sub(/^Tk:/, '')
+
+      # if method then we're finish
+      # else if widget then finish creation and pop off the widget stack
+      if name[0..0] == "_"
+        name = name[1..-1]
+        tk.end_method(name)
+      else
+        tk.end_widget(name)
+      end
+    end
+
+  end
+
+end

data/lib/tkxml/rexml.rb

@@ -0,0 +1,71 @@
+require 'rexml/document'
+
+class TkXML
+
+  #
+  def parse(source)
+    listener = REXML_Listener.new(self)
+    REXML::Document.parse_stream(source, listener)
+  end
+
+  # REXML Listener
+  class REXML_Listener
+
+    #
+    attr :tk
+
+    #
+    def initialize(tk)
+      super()
+      @tk = tk
+    end
+
+    #
+    def tag_start(name, attributes)
+      tk.start
+
+      ## pull off the tag name if prefixed with the Tk namespace
+      if name[0..2] == "Tk:"
+        tag_name = name[3..name.length]
+      else
+        tag_name = name
+      end
+
+      ## is it a method call or a new widget?
+      if tag_name[0..0] == '_'
+        name = tag_name[1..tag_name.length]
+        tk.start_method(name, attributes)
+      else
+        tk.start_widget(name, attributes)
+      end
+    end
+
+    #
+    def tag_end(name)
+      # pull off the tag name if prefixed with the Tk namespace
+      if name[0..2] == "Tk:"
+        tag_name = name[3..name.length]
+      else
+        tag_name = name
+      end
+
+      # if method then we're finish
+      # else if widget then finish creation and pop off the widget stack
+      if tag_name[0..0] == "_"
+        name = tag_name[1..tag_name.length]
+        tk.end_method(name)
+      else
+        tk.end_widget(name)
+      end
+    end
+
+    #
+    def text(free_radical)
+      if not free_radical.strip == ""
+        puts "Error: TkXML does not use XML text entries: #{free_radical}"
+      end
+    end
+
+  end
+
+end

data/lib/tkxml.rb

@@ -0,0 +1,165 @@
+# TkXML (2.04a)
+# Copyright 2002 Thomas Sawyer (transami@runbox.com)
+# April 2002 Alpha
+
+require 'tk'
+
+# A combination of Ruby/Tk + REXML to allow for fast and easy creation of Tk
+# interfaces using standard XML
+#
+#   xml_file = File.open("ui.xml")
+#   tkxml_instance = TkXML.new(xml_file)
+#   tkxml_instance.build
+#
+class TkXML
+
+  # Access to project metadata.
+  def self.metadata
+    @metadata ||= (
+      require 'yaml'
+      YAML.load(File.new(File.dirname(__FILE__) + '/tkxml.yml'))
+    )
+  end
+
+  # Access metadata as constants.
+  def self.const_missing(name)
+    key = name.to_s.downcase
+    metadata[key] || super(name)
+  end
+
+  # TODO: here only b/c Ruby 1.8.x is broke
+  VERSION = metadata['version']
+
+  #
+  def initialize(source, type=:nokogiri)
+    @widget = {}
+    @widget_stack = []
+    @parent = nil
+
+    case type
+    when :nokogiri
+      require 'tkxml/nokogiri'
+    else
+      require 'tkxml/rexml'
+    end
+
+    parse(source)
+  end
+
+  #
+  def build
+    Tk.mainloop
+  end
+
+  def start
+    ## get parent, the widget on the bottom of the stack
+    @parent = @widget_stack.last
+  end
+
+  #
+  def start_widget(name, attrs)
+    ## create widget
+    puts "Creating Widget: #{name} of #{@parent}"
+
+    ##
+    attrs = assoc_to_hash(attrs)
+
+    widget_class = "Tk" + name.capitalize
+    widget_name = attrs['name']
+
+    if @parent == nil
+      @widget[widget_name] = Tk.const_get(widget_class).new
+    else
+      @widget[widget_name] = Tk.const_get(widget_class).new(@parent)
+    end
+
+    ## assign the widget properties
+    attrs.each do |n, v|
+      if not n == 'name'
+        puts "   #{n} => #{v}"
+        @widget[widget_name].send(n, v)
+      end
+    end
+
+    ## push widget on to the stack
+    @widget_stack.push(@widget[widget_name])
+  end
+
+  #
+  def end_widget(name)
+    @parent = @widget_stack[-2]
+    current = @widget_stack.last
+
+    case name.downcase
+    when "menu"
+      @parent.menu(current)
+    end
+
+    # pop current widget off of stack
+    @widget_stack.pop
+
+    puts "End Widget: #{name}"
+  end
+
+  #
+  def start_method(name, attrs)
+    ## apply method
+    puts "Applying Method: #{name} to #{@parent}"
+
+    ##
+    attrs = assoc_to_hash(attrs)
+
+    ## assign the method's parameters
+    p_arr  = []  # array for parameters to be passed
+    p_init = {}  # for the ordered arguments _1 _2 etc.
+    p_hash = {}  # for all other named parameters
+
+    ## weed out the ordered parameters from the hash parameters
+    attrs.each do |n, v|
+      puts "   #{n} => #{v}"
+      if n[0..0] == "_"
+        p_init[n] = v
+      else
+        p_hash[n] = v
+      end
+    end
+
+    ## sort the ordered parameters based on the hash key
+    ## note: this converts p_init into an associative array
+    ## then place each one in the parameter array
+    if not p_init.empty?
+      p_init.sort
+      p_init.each do |a|
+        p_arr.push a[1]
+      end
+    end
+
+    ## now add the hash to the array if there is one
+    if not p_hash.empty?
+      p_arr.push p_hash
+    end
+
+    ## call the method
+    @parent.send(name, *p_arr)
+  end
+
+  #
+  def end_method(name)
+    puts "End Method: #{name}"
+  end
+
+  private
+
+  # Looks like the attributes object given is nothing more then
+  # a array in an array. how lame! This wll turn it into a hash.
+  def assoc_to_hash(array)
+    return array if Hash === array
+    hash = {}
+    array.each do |a|
+      hash[a[0]] = a[1]
+    end
+    hash
+  end
+
+end
+

data/lib/tkxml.yml

@@ -0,0 +1,34 @@
+--- 
+name: tkxml
+organizaton: RubyWorks
+title: TkXML
+contact: trans <transfire+tkxml AT gmail.com>
+requires: 
+- group: 
+  - build
+  name: syckle
+  version: 0+
+- group: 
+  - test
+  name: qed
+  version: 0+
+pom_verison: 1.0.0
+manifest: 
+- .ruby
+- lib/tkxml/nokogiri.rb
+- lib/tkxml/rexml.rb
+- lib/tkxml.rb
+- lib/tkxml.yml
+- test/test_tkxml.rb
+- test/ui.xml
+- HISTORY.rdoc
+- LICENSE
+- README.rdoc
+- VERSION
+version: 0.2.4
+copyright: (c) 2008 Trans
+licenses: 
+- Apache 2.0
+description: TkXML translates XML markup into Ruby Tk interface code
+summary: XML markup for building Tk User interfaces
+created: 2008-02-21

data/test/test_tkxml.rb

@@ -0,0 +1,6 @@
+require 'tkxml'
+
+file  = File.open("demo/ui.xml")
+tkxml = TkXML.new(file)
+tkxml.build
+

data/test/ui.xml

@@ -0,0 +1,32 @@
+<Tk:Root name="test" title="Test">
+
+	<Tk:Frame name="menuframe">
+		<Tk:Menubutton name="filebutton" text="File" underline="0">
+			<Tk:Menu name="filemenu" tearoff="false">
+				<Tk:_add
+					_1="command"
+					label="Open"
+					command="openDocument"
+					underline="0"
+					accel="Ctrl+O" />
+				<Tk:_add
+					_1="command"
+					label="Exit"
+					command="exitApplication"
+					underline="0"
+					accel="Ctrl+Q" />
+			</Tk:Menu>
+			<Tk:_pack side="left" />
+		</Tk:Menubutton>
+		<Tk:_pack side="left" />
+	</Tk:Frame>
+
+	<Tk:_bind
+		_1="Control-o"
+		_2="openDocument" />
+
+	<Tk:_bind
+		_1="Control-q"
+		_2="exitApplication" />
+	
+</Tk:Root>

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification 
+name: tkxml
+version: !ruby/object:Gem::Version 
+  hash: 19
+  prerelease: false
+  segments: 
+  - 0
+  - 3
+  - 0
+  version: 0.3.0
+platform: ruby
+authors: []
+
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-05 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: syckle
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: qed
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: TkXML translates XML markup into Ruby Tk interface code
+email: ""
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- .ruby
+- lib/tkxml/nokogiri.rb
+- lib/tkxml/rexml.rb
+- lib/tkxml.rb
+- lib/tkxml.yml
+- test/test_tkxml.rb
+- test/ui.xml
+- HISTORY.rdoc
+- LICENSE
+- README.rdoc
+- VERSION
+has_rdoc: true
+homepage: ""
+licenses: 
+- Apache 2.0
+post_install_message: 
+rdoc_options: 
+- --title
+- TkXML API
+- --main
+- README.rdoc
+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: tkxml
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: XML markup for building Tk User interfaces
+test_files: 
+- test/test_tkxml.rb