propane 3.1.0.pre-java → 3.2.0-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d30b5c711105c3e4795739b48211591d221039464e60a9e1f545c7d43bcd0294
-  data.tar.gz: 7cced24e7cc4e1dc831837f8d263c8211f09dd2e265bf7d46a8362704d577ce8
+  metadata.gz: 27e0f6d8547d0ab680c183052c93de07386e196ef645111564ad033172ccccbe
+  data.tar.gz: cc8cf473457ddfbe7e423e202276d209d629942b2d04bedfd07c577ca1fefb43
 SHA512:
-  metadata.gz: e3e297a0d7a8ce24c5543bb83eb69146be511d808fd6e6a2e2bbaf0dc84ed60cbde754b6b40c09c5354210d88a999da386f61165bdbeb91554817546b6516af6
-  data.tar.gz: 895be9e7ce50d9bba9d2433cc457265faaa3690199ea88815c52cb87c09fc7f1a17f86661defff1a1a41d3f76e81c01f7c9daead46dcdc8dac1a47943ea6a1a1
+  metadata.gz: 501f170bf9899573c5085c292a0fe8796df82588dd74b2b07b80c8dda96498a7cbd26352fce2a8623a69b1ff0d4703bb265dcf55b81292efdbe3c52322100fc1
+  data.tar.gz: 4b8a78d2f4b924111b16a8269d922107f84f186465e5568972237944886bfcb2c23fa5178e5c2b8046aa559b74ea167932795c25a97849322ec9c991ab274a24

data/.mvn/wrapper/maven-wrapper.properties

@@ -0,0 +1 @@
+distributionUrl=https://repo1.maven.org/maven2/org/apache/maven/apache-maven/3.6.0/apache-maven-3.6.0-bin.zip

data/CHANGELOG.md

@@ -1,8 +1,4 @@
-**v3.1.0.pre** Now is the time for some serious refactoring for jdk11. Hell we might even get in working on MacOS and Windows, ahead of vanilla processing. For MacOS this means ditching apple.jar dependency.
-
-**v3.0.1.pre** Bump jruby version
-
-**v3.0.0.pre** Compiled for java 11, works on linux, requires testing on MacOS and Windows
+**v3.2** Now is the time for some serious refactoring for jdk11. Might even work on MacOS and Windows, ahead of vanilla processing.
 
 **v2.9.1** Attempt to bring 64 bit Windows users to party. Use non versioned jogl/opengl jars from processing distro, including processing.org apple.jar in case it's needed, MacOS users are being very opaque on this.
 

data/README.md

@@ -1,16 +1,15 @@
 # Propane
 
-Here is my attempt to get a version of ruby-processing working with openjdk11, it imore than a proof of concept, as it already works very succesfully under linux the question is will it work under Windows and MacOS. To do this I have created a custom maven build of processing core, to which I add vanilla processing jogl jars (these are not the same as jogl jars form maven).
-I am watching with interest progress made by @sampottinger on [vanilla processing][vanilla]. I have implemented a different solution for think different than @ssilverman in my jdk11 branch (but I don't know whether it works).
+This version is intended to work with openjdk11+, @sampottinger is currently working on [vanilla processing][vanilla] which will enable JRubyArt to catch up.
 
-A slim layer to communicate with Processing from JRuby, features a polyglot maven build. We have created a configuration free version of ruby processing, for processing-3.4, where we include a modified processing core (`public runPropane()` to replace `protected runSketch()`. These jars are small enough to include in a gem distribution, and hence we do not require configuration. This has created a scriptable version, ie files get run direct from jruby, but you could use jruby-complete if you used the propane script (avoids need to give the absolute data path for the data folder, but would also be needed for a watch mode). See guide to [building ruby-processing projects][building]. NB: this is a far from perfect solution and javafx sketches and possibly a few others will not run with jdk11, but a least I get to diagnose those errors too.
+A slim layer to communicate with Processing from JRuby, features maven build. We have created a configuration free version of ruby processing, for processing-3.5+, where we include a modified processing core (`public runPropane()` to replace `protected runSketch()`. These jars are small enough to include in a gem distribution, and hence we do not require configuration. This has created a scriptable version, ie files get run direct from jruby. Currently JavaFX is unsupported again @sampottinger is currently working on [vanilla processing][vanilla] to use OpenJFX.
 
 adjust above for your OS/distro setup.
 
 ## Requirements
 
-- `jdk-11.0.1`
-- `jruby-9.2.5.0`
+- `jdk-11.0.2+`
+- `jruby-9.2.7.0`
 - `mvn-3.5.4+`
 
 ## Building and testing
@@ -22,16 +21,26 @@ rake javadoc
 ```
 
 ## Installation
+
 ```bash
-jgem install --pre propane # from rubygems
-jgem install propane-3.1.0.pre-java.gem # local install requires a custom processing-core
+jgem install propane # from rubygems
+jgem install propane-3.2.0-java.gem # local install
 # Alternative
-jruby -S gem install --pre propane # from rubygems
-jruby -S gem install propane-3.1.0.pre-java.gem # local install requires a custom processing-core
+jruby -S gem install propane # from rubygems
+jruby -S gem install propane-3.2.0-java.gem # local install
+```
+
+## Check Install
+To check version and confirm gem bin files are on your path (also checks JDK version)
+
+```bash
+propane --version
 ```
 
 ## Usage
 
+A propane sketch:-
+
 ``` ruby
 require 'propane'
 
@@ -53,8 +62,8 @@ end
 FlashingLightsSketch.new
 ```
 
+Create template sketches with the sketch creator tool
 
-There is a handy sketch creator tool
 ```bash
 propane -c my_sketch 200 200 # for default renderer
 propane -c my_sketch 200 200 p2d # for opengl 2D renderer
@@ -66,18 +75,21 @@ To run sketches
 ```bash
 jruby my_sketch.rb # or use script to run sketches from atom
 ```
+
 To install the sound and video libraries `~/.propane/libraries`. Depends on wget.
 ```bash
 propane --install sound
 propane --install video
 ```
+
 Other java libraries can be manually installed to the same folder (no need for processing ide)
 
 See [gh-pages][gh-pages] for more detailed instructions and much more.
 
 ## Examples
 
-[Worked Examples](https://github.com/ruby-processing/propane-examples) more to follow, feel free to add your own, especially ruby-2.2+ syntax now we can. To install the samples.  The samples get copied to `~/propane_samples`. Depends on wget.
+[Worked Examples](https://github.com/ruby-processing/propane-examples) more to follow, feel free to add your own, especially ruby-2.4
++ syntax now we can. To install the samples.  The samples get copied to `~/propane_samples`. Depends on wget.
 ```bash
 propane --install samples
 ```
@@ -86,4 +98,3 @@ propane --install samples
 [building]:http://ruby-processing.github.io/building/building/
 [gh-pages]:https://ruby-processing.github.io/propane/
 [vanilla]:https://github.com/processing/processing/pull/5753
-https://github.com/processing/processing/pull/5747

data/Rakefile

@@ -1,26 +1,37 @@
 # frozen_string_literal: false
 require_relative 'lib/propane/version'
+require 'erb'
 
-def create_manifest
-  title = 'Implementation-Title: rpextras (java extension for propane)'
-  version = format('Implementation-Version: %s', Propane::VERSION)
+desc 'Create jar Manifest'
+task :create_manifest do
+  manifest = ERB.new <<~MANIFEST
+    Implementation-Title: rpextras (java extension for propane)
+    Implementation-Version: <%= Propane::VERSION %>
+    Class-Path: gluegen-rt.jar jog-all.jar
+  MANIFEST
   File.open('MANIFEST.MF', 'w') do |f|
-    f.puts(title)
-    f.puts(version)
-    f.puts('Class-Path: apple.jar gluegen-rt.jar jog-all.jar')
+    f.puts(manifest.result(binding))
   end
 end
 
 task default: [:init, :compile, :install, :test, :gem]
 
-desc 'Create Manifest'
-task :init do
-  create_manifest
+# depends on installed processing, with processing on path
+desc 'Create Manifest and Copy Jars'
+task init: :create_manifest do
+  processing_root = File.dirname(`readlink -f $(which processing)`) # for Archlinux etc
+  # processing_root = File.join(ENV['HOME'], 'processing-3.5.3') # alternative for debian linux etc
+  jar_dir = File.join(processing_root, 'core', 'library')
+  opengl = Dir.entries(jar_dir).grep(/amd64|macosx-universal/)
+  opengl.concat %w[jogl-all.jar gluegen-rt.jar]
+  opengl.each do |gl|
+    FileUtils.cp(File.join(jar_dir, gl), File.join('.', 'lib'))
+  end
 end
 
 desc 'Install'
 task :install do
-  sh 'mv target/propane-3.0.1.jar lib'
+  sh "mv target/propane-#{Propane::VERSION}.jar lib"
 end
 
 desc 'Gem'
@@ -55,8 +66,8 @@ end
 
 desc 'clean'
 task :clean do
-  Dir['./**/*.%w{jar gem}'].each do |path|
-    puts 'Deleting #{path} ...'
+  Dir["./**/*.{jar,gem}"].each do |path|
+    puts "Deleting #{path} ..."
     File.delete(path)
   end
   FileUtils.rm_rf('./target')

data/lib/propane/helpers/version_error.rb

@@ -0,0 +1,6 @@
+
+class JDKVersionError < StandardError
+  def message
+    'This version of propane requires at least JDK11 to work'
+  end
+end

data/lib/propane/runner.rb

@@ -67,10 +67,22 @@ module Propane
     end
 
     def show_version
+
       v_format = "Propane version %s\nJRuby version %s"
       puts format(v_format, Propane::VERSION, JRUBY_VERSION)
     end
 
+    def show_version
+      require 'erb'
+      require_relative 'helpers/version_error'
+      raise JDKVersionError.new if ENV_JAVA['java.specification.version'] < '11'
+      template = ERB.new <<-EOF
+        propane version <%= Propane::VERSION %>
+        JRuby version <%= JRUBY_VERSION %>
+      EOF
+      puts template.result(binding)
+    end
+
     def install(library)
       choice = library.downcase
       valid = Regexp.union('samples', 'sound', 'video', 'glvideo')

data/lib/propane/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Propane
-  VERSION = '3.1.0.pre'.freeze
+  VERSION = '3.2.0'.freeze
 end

data/library/slider/slider.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 # Here's a little library for quickly hooking up in sketch sliders.
-# Copyright (c) 2016-18 Martin Prout.
+# Copyright (c) 2016-19 Martin Prout.
 
 java_import 'monkstone.slider.CustomHorizontalSlider'
 java_import 'monkstone.slider.CustomVerticalSlider'

data/mvnw

@@ -0,0 +1,234 @@
+#!/bin/sh
+# ----------------------------------------------------------------------------
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you 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.
+# ----------------------------------------------------------------------------
+
+# ----------------------------------------------------------------------------
+# Maven2 Start Up Batch script
+#
+# Required ENV vars:
+# ------------------
+#   JAVA_HOME - location of a JDK home dir
+#
+# Optional ENV vars
+# -----------------
+#   M2_HOME - location of maven2's installed home dir
+#   MAVEN_OPTS - parameters passed to the Java VM when running Maven
+#     e.g. to debug Maven itself, use
+#       set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000
+#   MAVEN_SKIP_RC - flag to disable loading of mavenrc files
+# ----------------------------------------------------------------------------
+
+if [ -z "$MAVEN_SKIP_RC" ] ; then
+
+  if [ -f /etc/mavenrc ] ; then
+    . /etc/mavenrc
+  fi
+
+  if [ -f "$HOME/.mavenrc" ] ; then
+    . "$HOME/.mavenrc"
+  fi
+
+fi
+
+# OS specific support.  $var _must_ be set to either true or false.
+cygwin=false;
+darwin=false;
+mingw=false
+case "`uname`" in
+  CYGWIN*) cygwin=true ;;
+  MINGW*) mingw=true;;
+  Darwin*) darwin=true
+           #
+           # Look for the Apple JDKs first to preserve the existing behaviour, and then look
+           # for the new JDKs provided by Oracle.
+           # 
+           if [ -z "$JAVA_HOME" ] && [ -L /System/Library/Frameworks/JavaVM.framework/Versions/CurrentJDK ] ; then
+             #
+             # Apple JDKs
+             #
+             export JAVA_HOME=/System/Library/Frameworks/JavaVM.framework/Versions/CurrentJDK/Home
+           fi
+           
+           if [ -z "$JAVA_HOME" ] && [ -L /System/Library/Java/JavaVirtualMachines/CurrentJDK ] ; then
+             #
+             # Apple JDKs
+             #
+             export JAVA_HOME=/System/Library/Java/JavaVirtualMachines/CurrentJDK/Contents/Home
+           fi
+             
+           if [ -z "$JAVA_HOME" ] && [ -L "/Library/Java/JavaVirtualMachines/CurrentJDK" ] ; then
+             #
+             # Oracle JDKs
+             #
+             export JAVA_HOME=/Library/Java/JavaVirtualMachines/CurrentJDK/Contents/Home
+           fi           
+
+           if [ -z "$JAVA_HOME" ] && [ -x "/usr/libexec/java_home" ]; then
+             #
+             # Apple JDKs
+             #
+             export JAVA_HOME=`/usr/libexec/java_home`
+           fi
+           ;;
+esac
+
+if [ -z "$JAVA_HOME" ] ; then
+  if [ -r /etc/gentoo-release ] ; then
+    JAVA_HOME=`java-config --jre-home`
+  fi
+fi
+
+if [ -z "$M2_HOME" ] ; then
+  ## resolve links - $0 may be a link to maven's home
+  PRG="$0"
+
+  # need this for relative symlinks
+  while [ -h "$PRG" ] ; do
+    ls=`ls -ld "$PRG"`
+    link=`expr "$ls" : '.*-> \(.*\)$'`
+    if expr "$link" : '/.*' > /dev/null; then
+      PRG="$link"
+    else
+      PRG="`dirname "$PRG"`/$link"
+    fi
+  done
+
+  saveddir=`pwd`
+
+  M2_HOME=`dirname "$PRG"`/..
+
+  # make it fully qualified
+  M2_HOME=`cd "$M2_HOME" && pwd`
+
+  cd "$saveddir"
+  # echo Using m2 at $M2_HOME
+fi
+
+# For Cygwin, ensure paths are in UNIX format before anything is touched
+if $cygwin ; then
+  [ -n "$M2_HOME" ] &&
+    M2_HOME=`cygpath --unix "$M2_HOME"`
+  [ -n "$JAVA_HOME" ] &&
+    JAVA_HOME=`cygpath --unix "$JAVA_HOME"`
+  [ -n "$CLASSPATH" ] &&
+    CLASSPATH=`cygpath --path --unix "$CLASSPATH"`
+fi
+
+# For Migwn, ensure paths are in UNIX format before anything is touched
+if $mingw ; then
+  [ -n "$M2_HOME" ] &&
+    M2_HOME="`(cd "$M2_HOME"; pwd)`"
+  [ -n "$JAVA_HOME" ] &&
+    JAVA_HOME="`(cd "$JAVA_HOME"; pwd)`"
+  # TODO classpath?
+fi
+
+if [ -z "$JAVA_HOME" ]; then
+  javaExecutable="`which javac`"
+  if [ -n "$javaExecutable" ] && ! [ "`expr \"$javaExecutable\" : '\([^ ]*\)'`" = "no" ]; then
+    # readlink(1) is not available as standard on Solaris 10.
+    readLink=`which readlink`
+    if [ ! `expr "$readLink" : '\([^ ]*\)'` = "no" ]; then
+      if $darwin ; then
+        javaHome="`dirname \"$javaExecutable\"`"
+        javaExecutable="`cd \"$javaHome\" && pwd -P`/javac"
+      else
+        javaExecutable="`readlink -f \"$javaExecutable\"`"
+      fi
+      javaHome="`dirname \"$javaExecutable\"`"
+      javaHome=`expr "$javaHome" : '\(.*\)/bin'`
+      JAVA_HOME="$javaHome"
+      export JAVA_HOME
+    fi
+  fi
+fi
+
+if [ -z "$JAVACMD" ] ; then
+  if [ -n "$JAVA_HOME"  ] ; then
+    if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
+      # IBM's JDK on AIX uses strange locations for the executables
+      JAVACMD="$JAVA_HOME/jre/sh/java"
+    else
+      JAVACMD="$JAVA_HOME/bin/java"
+    fi
+  else
+    JAVACMD="`which java`"
+  fi
+fi
+
+if [ ! -x "$JAVACMD" ] ; then
+  echo "Error: JAVA_HOME is not defined correctly." >&2
+  echo "  We cannot execute $JAVACMD" >&2
+  exit 1
+fi
+
+if [ -z "$JAVA_HOME" ] ; then
+  echo "Warning: JAVA_HOME environment variable is not set."
+fi
+
+CLASSWORLDS_LAUNCHER=org.codehaus.plexus.classworlds.launcher.Launcher
+
+# For Cygwin, switch paths to Windows format before running java
+if $cygwin; then
+  [ -n "$M2_HOME" ] &&
+    M2_HOME=`cygpath --path --windows "$M2_HOME"`
+  [ -n "$JAVA_HOME" ] &&
+    JAVA_HOME=`cygpath --path --windows "$JAVA_HOME"`
+  [ -n "$CLASSPATH" ] &&
+    CLASSPATH=`cygpath --path --windows "$CLASSPATH"`
+fi
+
+# traverses directory structure from process work directory to filesystem root
+# first directory with .mvn subdirectory is considered project base directory
+find_maven_basedir() {
+  local basedir=$(pwd)
+  local wdir=$(pwd)
+  while [ "$wdir" != '/' ] ; do
+    if [ -d "$wdir"/.mvn ] ; then
+      basedir=$wdir
+      break
+    fi
+    wdir=$(cd "$wdir/.."; pwd)
+  done
+  echo "${basedir}"
+}
+
+# concatenates all lines of a file
+concat_lines() {
+  if [ -f "$1" ]; then
+    echo "$(tr -s '\n' ' ' < "$1")"
+  fi
+}
+
+export MAVEN_PROJECTBASEDIR=${MAVEN_BASEDIR:-$(find_maven_basedir)}
+MAVEN_OPTS="$(concat_lines "$MAVEN_PROJECTBASEDIR/.mvn/jvm.config") $MAVEN_OPTS"
+
+# Provide a "standardized" way to retrieve the CLI args that will 
+# work with both Windows and non-Windows executions.
+MAVEN_CMD_LINE_ARGS="$MAVEN_CONFIG $@"
+export MAVEN_CMD_LINE_ARGS
+
+WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain
+
+exec "$JAVACMD" \
+  $MAVEN_OPTS \
+  -classpath "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" \
+  "-Dmaven.home=${M2_HOME}" "-Dmaven.multiModuleProjectDirectory=${MAVEN_PROJECTBASEDIR}" \
+  ${WRAPPER_LAUNCHER} $MAVEN_CMD_LINE_ARGS
+