jrubyfx 0.9.1-java

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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.md

@@ -0,0 +1,97 @@
+JRubyFX
+=======
+JRubyFX is a pure ruby wrapper for JavaFX 2.x with FXML support
+
+Status
+------
+JRubyFX should be usable in its current form and able to run FXML apps if used properly (see Issues).
+The syntax of the FXML side of JRubyFX should be fairly stable, but the JavaFX DSL may change.
+At this point in time, no custom ruby controls are supported from FXML, though you
+can certainly create them in code.
+
+Install
+-----
+```text
+gem install jrubyfx
+```
+
+Manual Build and Install
+-----
+Build is done using rake/gem/bundler/rdoc. You obviously need JRuby, Java 1.7 (with JavaFX) also.
+
+```text
+rake install
+```
+Once the gem is installed, just run a ruby file that uses it normally.
+
+**NOTE:** If you don't have JRuby installed as the `ruby` command, use `jruby -S rake` instead of `rake`. If
+you are using RVM, this does not apply to you (though make sure you `rvm use jruby`).
+
+Creating a Jar
+--------------
+If you want to distribute your application, you can create a jar with embedded JRuby.
+Place all your sources in a folder, and run (replacing paths as appropriate):
+
+```text
+jrubyfx-jarify samples/fxml/ --main samples/fxml/Demo.rb Demo.jar
+```
+This jar can then run anywhere there is a JVM with JavaFX. Note than the main file is
+renamed to jar-bootstrap.rb inside the jar. If you need to detect if you are in a jar,
+use the JRubyFX::Application.in_jar? method.
+
+Sample
+-------
+
+To run sample:
+
+```text
+jruby samples/fxml/Demo.rb
+```
+
+Or, if you have not installed the gem, or are testing edits to jrubyfx.rb:
+
+```text
+rake run main_script=samples/fxml/Demo.rb
+```
+
+To run all samples (a nice quick way to make sure you didn't break anything), run:
+
+```text
+jruby samples/test_all_the_samples.rb
+```
+
+Creating Application and Controller
+-----------------------------------
+
+Require the 'jrubyfx' file/gem, and subclass JRubyFX::Application (and JRubyFX::Controller if you are using FXML).
+At the bottom of the file, call _yourFXApplicationClass_.launch().
+Override start(stage) in the application. See samples/fxml/Demo.rb for commented FXML example, 
+or the fils in samples/javafx for non-FXML (programatic JavaFX, but you should really 
+look into FXML, its better) or see the Getting Started Guide and the Notes.
+
+If you want rdoc, run `rake rdoc`.
+
+Issues
+------
+* You must NOT set fx:controller in the FXML files. At the moment, due to JRuby bugs, Java is unable
+  to initialize Ruby objects in this way. See Demo.rb for proper way to set the controller (passing it
+  in to load_fxml())
+* You must use the provided JavaFXImpl::Launcher to launch the app (aka: call _yourFXApplicationClass_.launch()). This is due to the same JRuby bugs
+  as above.
+* Errors loading jfxrt.jar are bugs. Please report if you encounter this issue, tell us your platform,
+  OS, and version of JRuby
+* Jarify command needs the `jar` executable in your path.
+* Any other difficulties are bugs. Please report them
+
+License
+-------
+Main code is Apache 2.0. See LICENSE.
+Some samples in contrib may have other licenses.
+
+Authors
+-------
+- Patrick Plenefisch
+- Thomas E Enebo
+- Hiroshi Nakamura
+- Hiro Asari
+

data/bin/jrubyfx-jarify

@@ -0,0 +1,90 @@
+#!/usr/bin/env jruby
+=begin
+JRubyFX - Write JavaFX and FXML in Ruby
+Copyright (C) 2013 The JRubyFX Team
+
+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.
+=end
+
+require 'jrubyfx_tasks'
+
+def usage
+  puts "#{$0} {options} project-folder [output.jar]"
+  puts <<THEOPTIONS
+  project-folder should contain rb files and supporting files  
+
+  -m|--main FILE     ruby script to launch when the jar is executed. 
+                     Defaults to jar-bootstrap.rb or main.rb
+  -j|--include-jars  Include jars in the jar
+THEOPTIONS
+  exit -1
+end
+
+if ARGV.length < 1
+  usage
+end
+
+main = ["jar-bootstrap.rb", "main.rb"]
+include_jars = false
+nargs = []
+default_on_next = on_next = ->(arg){true}
+
+# split the args manually
+ARGV.each do |arg|
+  # some args have multiple parts. this is a cheap way to do that (lambdas)
+  next unless on_next.call(arg)
+  case arg
+  when "-m", "--main"
+    on_next = ->(arg){
+      main = [arg]
+      on_next = default_on_next
+      false
+    }
+    next
+  when "-j", "--include-jars"
+    include_jars = true
+    next
+  when "-h", "--help"
+    usage
+  when /^-/
+    puts "ERROR! Unrecognized option '#{arg}'!"
+    exit -2
+  end
+  # no flag? must be positional arg
+  nargs << arg
+end
+# set jar default if none passed in
+if nargs.length <= 1
+  nargs << File.basename(nargs[0]) + ".jar"
+end
+# set positional args
+project_folder, output_jar = nargs
+
+# Download the current running JRuby version
+JRubyFX::Tasks::download_jruby(JRUBY_VERSION)
+
+# set the main script to the first (must be passed in), or tries to find 
+# a file that does exists. Silently fails if it fails.
+main_script = main[0]
+if main.length > 1
+  main.each do |scrpt|
+    ps = project_folder + "/" + scrpt
+    if File.exists? ps
+      main_script = ps
+      break
+    end
+  end
+end
+
+# Jarify!
+JRubyFX::Tasks::jarify_jrubyfx(project_folder + "/**/*", main_script, nil, output_jar, :file_filter => ->(filename){!filename.end_with?(".jar") or include_jars})

data/bin/rubyfx-generator

@@ -0,0 +1,81 @@
+#!/usr/bin/env jruby
+=begin
+JRubyFX - Write JavaFX and FXML in Ruby
+Copyright (C) 2013 The JRubyFX Team
+
+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.
+=end
+
+require 'date'
+require 'jrubyfx/utils'
+
+if ARGV.length < 1
+  puts "Please specify the fxml file to parse"
+  puts "#{$0} some.fxml [output.rb [AppName]]"
+  exit -1
+end
+
+fxml = ARGV[0]
+rb = File.basename(fxml.gsub(/\.fxml$/i, ".rb"))
+rb = ARGV[1] if ARGV.length > 1
+name_guess = "My" + File.basename(fxml).gsub(/\.fxml$/i, "").gsub(/[^a-zA-Z0-9_]/i, "") # better guess would be better
+name_guess = ARGV[2] if ARGV.length > 2
+
+print "Generating RubyFX template for #{fxml} into #{rb}... "
+
+File.open(rb, "w") do |output|
+  
+  output << <<END
+# This file was auto-generated by rubyfx-generator at #{DateTime.now.to_s}
+
+require 'jrubyfx'
+
+class #{name_guess}Application < JRubyFX::Application
+  def start(stage)
+    with(stage, title: "#{name_guess}", width: 600, height: 400)
+    #{name_guess}Controller.load_fxml("#{File.basename(fxml)}", stage)
+    stage.show()
+  end
+end
+
+class #{name_guess}Controller < JRubyFX::Controller
+END
+
+  File.open(fxml, "r") do |fx|
+    handlers = "\n"
+    fx.each_line do |line|
+      line.scan(/fx:id="([^ "':]+)"/) do |match| 
+        output << "  fx_id :#{match[0]}\n"
+      end
+      # TODO: may not work with funky non-latin characters
+      # Yes, I used regex, yes its xml, yes I now have two problems.
+      line.scan(/on((([A-Z]*[a-z]*)*?)[A-Z]+[a-z]+)="#([^ "':]+)"/) do |match| 
+        handlers << "  fx_#{match[1].snake_case}#{(match[1].length >0 ? "_" : "")}handler :#{match[3]} do |event|\n    # TODO: Auto-generated event handler\n"
+        handlers << "    puts \"#{match[0]} event '#{match[3]}' called\"\n  end\n\n"
+      end
+    end
+    output << handlers
+  end
+  
+  output << <<END
+end
+
+#{name_guess}Application.launch
+END
+
+end
+
+puts "Done!"
+puts "Launching 'ruby #{rb}' ..."
+
+require rb