propane 2.3.4-java → 2.4.0-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 40e07b8b28c5857b0f1738ddf80584a6c5f62764
-  data.tar.gz: 67dc8538463955bd26073f52dad1d0bb74a706c3
+  metadata.gz: 2e995a9147ca9cfe877f299d8f2433eb9cf9fd16
+  data.tar.gz: a9056a9bbfbc5d20dd55356af0c3dc7ca02633a5
 SHA512:
-  metadata.gz: 01683ec9729539dd4a279e19b8661f9b446968bcfece74c796c98d988cd177b41a03396fd11dccf8ce8c75dfced4bdc13e92f2ca7a4abf1a8b989bdb5c56e007
-  data.tar.gz: bb8318aa7cbd0d5296027230db8eebc91a9cf1c03f2cdd9cd52e5411a8ba7be274e4bbcf5e0cc9ab23853db8888729d5ab8dda05093cff2362de58635f7fb561
+  metadata.gz: 0905fd0592209ce449d1e3f8973822a426461648d84a56996289ab75e94e8d4b788dddf7dff2725ec1dec999f46fd4c3cace0e7bfc1caff6fd1d5c583c42fe2a
+  data.tar.gz: a87e497ed4e336bdd07ae29a2a118453c07c8a143ef36983e2717a3ce5aa71d5537c7ba25f1e05dc0c3f05d3625fa439561922ea2fe43273a5c709658de8e593

data/.travis.yml

@@ -1,5 +1,6 @@
 language: ruby
 sudo: false
+dist: trusty
 
 rvm:
   - jruby-9.1.12.0

data/CHANGELOG.md

@@ -1,3 +1,5 @@
+**v2.4.0** Extend LibraryProxy to include mouseEvent and keyEvent.
+
 **v2.3.4** Simplify control_panel library (replacing `c.title = 'PaneTitle'` with `c.title('PaneTitle')`) also enable use of `block` with `button's`.
 
 **v2.3.3** Update to processing-3.3.4, and upgrade jruby-9.1.12.0 last in 9.1 series?

data/lib/propane/creators/sketch_class.rb

@@ -1,4 +1,5 @@
-#frozen_string_literal: false
+# frozen_string_literal: false
+
 # the sketch class
 class SketchClass
   attr_reader :name, :width, :height, :mode
@@ -24,7 +25,7 @@ class SketchClass
   end
 
   def size
-    return format('    size %d, %d', width.to_i, height.to_i) if mode.nil?
+    return format('    size %d, %d', width.to_i, height.to_i) unless mode
     format('    size %d, %d, %s', width.to_i, height.to_i, mode.upcase)
   end
 
@@ -33,8 +34,8 @@ class SketchClass
     format("    sketch_title '%s'", human)
   end
 
-  def method_lines(name, content = '')
-    return [format('  def %s', name), content, '  end'] if content.empty?
+  def method_lines(name, content = nil)
+    return [format('  def %s', name), '', '  end'] unless content
     [format('  def %s', name), content, '  end', '']
   end
 
@@ -50,6 +51,7 @@ class SketchClass
     lines.concat method_lines('setup', sketch_title)
     lines.concat method_lines('draw')
     lines << 'end'
+    lines << ''
     lines << sketch_new
   end
 end

data/lib/propane/runner.rb

@@ -50,6 +50,11 @@ module Propane
           options[:create] = true
         end
 
+        options[:example] = false
+        opts.on('-e', '--example', 'Create new sketch outline') do
+          options[:example] = true
+        end
+
         # This displays the help screen, all programs are
         # assumed to have this option.
         opts.on('-h', '--help', 'Display this screen') do
@@ -63,6 +68,11 @@ module Propane
 
     def create
       require_relative 'creators/sketch_writer'
+      SketchFactory.new(argc).write
+    end
+
+    def examples
+      require_relative 'creators/sketch_factory'
       SketchWriter.new(File.basename(filename, '.rb'), argc).write
     end
 

data/lib/propane/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Propane
-  VERSION = '2.3.4'.freeze
+  VERSION = '2.4.0'.freeze
 end

data/library/library_proxy/README.md

@@ -1,8 +1,8 @@
 ### Using the LibraryProxy in your sketches
 LibraryProxy is a [abstract java class](https://github.com/ruby-processing/JRubyArt/blob/master/src/monkstone/core/LibraryProxy.java) so that you can acccess vanilla processing library reflection methods in your sketches using ruby.
 
-In the sketch you should `load_library :library_proxy` and your library class should inherit 
-from LibraryProxy and implement pre(), draw() and post() methods (can be empty method if not 
+In the sketch you should `load_library :library_proxy` and your library class should inherit
+from LibraryProxy and implement the draw() method (can be empty method if not 
 required). For simplicity initialize your `processing library` in the sketch `setup`.
 
 ### Example library

data/library/library_proxy/library_proxy.rb

@@ -1,12 +1,14 @@
 java_import Java::MonkstoneCore::LibraryProxy
+java_import Java::ProcessingEvent::KeyEvent
+java_import Java::ProcessingEvent::MouseEvent
 
-
-# classes that inherit from Library are expected to implement
-# the abstract methods of monkstone.core.LibraryProxy
-# def pre...
-# def draw...
-# def post...
-# def keyPressed...
-# def mousePressed...
-# NOOP is fine...
+# classes that inherit from LibraryProxy are expected to implement
+# the abstract draw method of monkstone.core.LibraryProxy the other methods are
+# registered with PApplet instance in constructor ImplementingClass.new(app)
+#
+# def pre... NOOP can be overridden
+# def draw... Abstract Method should be implemented NOOP is OK
+# def post... NOOP can be overridden
+# def keyEvent(e)... NOOP can be overridden
+# def mouseEvent(e)... NOOP can be overridden
 # `app` can be called to get PApplet instance

data/pom.rb

@@ -1,7 +1,7 @@
 require 'fileutils'
 project 'rp5extras', 'https://github.com/monkstone/propane' do
   model_version '4.0.0'
-  id 'propane:propane', '2.3.4'
+  id 'propane:propane', '2.4.0'
   packaging 'jar'
   description 'rp5extras for propane'
   organization 'ruby-processing', 'https://ruby-processing.github.io'

data/pom.xml

@@ -11,7 +11,7 @@ DO NOT MODIFIY - GENERATED CODE
   <modelVersion>4.0.0</modelVersion>
   <groupId>propane</groupId>
   <artifactId>propane</artifactId>
-  <version>2.3.4</version>
+  <version>2.4.0</version>
   <name>rp5extras</name>
   <description>rp5extras for propane</description>
   <url>https://github.com/monkstone/propane</url>

data/src/monkstone/core/LibraryProxy.java

@@ -2,106 +2,124 @@ package monkstone.core;
 
 import processing.core.PApplet;
 import static processing.core.PConstants.*;
+import processing.event.MouseEvent;
+import processing.event.KeyEvent;
 
 /**
- * The purpose of this class is to enable
- * access to processing pre, draw and post loops in
- * ruby-processing as a regular java library class.
- * Also included background, fill and stroke methods.
- * PConstants should also be available from static import
- * @author Martin Prout
- */
+* The purpose of this class is to enable
+* access to processing pre, draw and post loops in
+* ruby-processing as a regular java library class.
+* Also included background, fill and stroke methods.
+* PConstants should also be available from static import
+* @author Martin Prout
+*/
 public abstract class LibraryProxy {
 
-    private final PApplet app;
-
-    /**
-     * Useful accessors
-     */
-    public int width, height;
-
-    /**
-     *
-     * @param app PApplet
-     */
-    public LibraryProxy(PApplet app) {
-        this.app = app;
-        this.width = app.width;
-        this.height = app.height;
-        setActive(true);
-    }
+  private final PApplet app;
 
-    /**
-     * Extending classes must implement this gives access to, by reflection,
-     * processing PApplet pre loop (called before draw)
-     */
-    public abstract void pre();
-
-    /**
-     * Extending classes must implement this gives access to processing PApplet
-     * draw loop
-     */
-    public abstract void draw();
-
-    /**
-     * Extending classes must implement  this gives access to, by reflection,
-     * processing PApplet post loop (called after draw)
-     */
-    public abstract void post();
-
-    /**
-     * Register or unregister reflection methods
-     * @param active
-     */
-    final void setActive(boolean active) {
-        if (active) {
-            this.app.registerMethod("pre", this);
-            this.app.registerMethod("draw", this);
-            this.app.registerMethod("post", this);
-            this.app.registerMethod("dispose", this);
-        } else {
-            this.app.unregisterMethod("pre", this);
-            this.app.unregisterMethod("draw", this);
-            this.app.unregisterMethod("post", this);
-        }
-    }
+  /**
+  * Useful accessors
+  */
+  public int width, height;
 
-    /**
-     * Simple signature for background hides need to call app
-     * @param col int
-     */
-    public void background(int col) {
-        this.app.background(col);
-    }
+  /**
+  *
+  * @param app PApplet
+  */
+  public LibraryProxy(PApplet app) {
+    this.app = app;
+    this.width = app.width;
+    this.height = app.height;
+    setActive(true);
+  }
 
-    /**
-     * Simple signature for fill hides need to call app
-     * @param col int
-     */
-    public void fill(int col) {
-        this.app.fill(col);
-    }
+  /**
+  * Extending classes can override this, gives access to, by reflection,
+  * processing PApplet pre loop (called before draw)
+  */
+  public void pre(){}
 
-    /**
-     * Simple signature for stroke hides need to call app
-     * @param col int
-     */
-    public void stroke(int col) {
-        this.app.stroke(col);
-    }
+  /**
+  * Extending classes must implement this gives access to processing PApplet
+  * draw loop
+  */
+  public abstract void draw();
 
-    /**
-     * Access applet if we must
-     * @return applet PApplet
-     */
-    public PApplet app() {
-        return this.app;
-    }
+  /**
+  * Extending classes can override this, gives access to, by reflection,
+  * processing PApplet post loop (called after draw)
+  */
+  public void post(){}
+
+  /**
+  * Extending classes can override this, gives access to, by reflection,
+  * processing PApplet post loop (called after draw)
+  */
+  public void keyEvent(KeyEvent e){}
 
-    /**
-     * required for processing
-     */
-    public void dispose() {
-        setActive(false);
+  /**
+  * Extending classes can override this, gives access to, by reflection,
+  * processing PApplet post loop (called after draw)
+  */
+  public void mouseEvent(MouseEvent e){}
+
+  /**
+  * Register or unregister reflection methods
+  * @param active
+  */
+  final void setActive(boolean active) {
+    if (active) {
+      this.app.registerMethod("pre", this);
+      this.app.registerMethod("draw", this);
+      this.app.registerMethod("post", this);
+      this.app.registerMethod("mouseEvent", this);
+      this.app.registerMethod("keyEvent", this);
+      this.app.registerMethod("dispose", this);
+    } else {
+      this.app.unregisterMethod("pre", this);
+      this.app.unregisterMethod("draw", this);
+      this.app.unregisterMethod("post", this);
+      this.app.unregisterMethod("mouseEvent", this);
+      this.app.unregisterMethod("keyEvent", this);
     }
+  }
+
+  /**
+  * Simple signature for background hides need to call app
+  * @param col int
+  */
+  public void background(int col) {
+    this.app.background(col);
+  }
+
+  /**
+  * Simple signature for fill hides need to call app
+  * @param col int
+  */
+  public void fill(int col) {
+    this.app.fill(col);
+  }
+
+  /**
+  * Simple signature for stroke hides need to call app
+  * @param col int
+  */
+  public void stroke(int col) {
+    this.app.stroke(col);
+  }
+
+  /**
+  * Access applet if we must
+  * @return applet PApplet
+  */
+  public PApplet app() {
+    return this.app;
+  }
+
+  /**
+  * required for processing
+  */
+  public void dispose() {
+    setActive(false);
+  }
 }

data/test/sketches/key_event.rb

@@ -0,0 +1,37 @@
+#!/usr/bin/env jruby
+require 'propane'
+
+
+class CustomProxySketch < Propane::App
+
+  # A simple demonstration of vanilla processing 'reflection' methods using
+  # propane :library_proxy. See my_library.rb code for the guts.
+  load_libraries :library_proxy, :my_library
+
+  attr_reader :visible
+
+  def settings
+    size 300, 200
+    @visible = false
+  end
+
+  def setup
+    sketch_title 'Reflection Voodoo Proxy'
+    MyLibrary.new self
+  end
+
+  def hide(val)
+    @visible = !val
+  end
+
+  def draw
+    if visible
+      fill(0, 0, 200)
+      ellipse(170, 115, 70, 100)
+    else
+      background 0
+    end
+  end
+end
+
+CustomProxySketch.new

data/test/sketches/library/my_library/my_library.rb

@@ -0,0 +1,32 @@
+# This class demonstrates how by inheriting from the abstract class LibraryProxy
+# we can access 'keyEvent' and 'draw'  (Note we need a draw method even
+# though can be empty)
+class MyLibrary < LibraryProxy
+  java_import 'processing.event.KeyEvent'
+
+  attr_reader :app
+
+  def initialize(parent)
+    @app = parent
+  end
+
+  def draw # optional
+    fill app.color(200, 0, 0, 100)
+    app.rect 100, 100, 60, 90
+  end
+
+  # favor guard clause no_op unless key pressed
+  # and no_op unless ascii key
+  def keyEvent(e) # NB: need camel case for reflection to work
+    return unless e.get_action == KeyEvent::PRESS
+    return if e.get_key > 122 # else we can't use :chr
+    case e.get_key.chr.upcase
+    when 'S'
+      app.send :hide, false
+    when 'H'
+      app.send :hide, true
+    else
+      puts e.get_key.chr
+    end
+  end
+end

data/vendors/Rakefile

@@ -9,7 +9,7 @@ SOUND = 'sound.zip'.freeze
 SOUND_VERSION = 'v1.3.2' # version 1.3.2
 VIDEO = 'video-2.zip'
 VIDEO_VERSION = '2' # version 1.0.1
-EXAMPLES = '1.3'.freeze
+EXAMPLES = '1.4'.freeze
 HOME_DIR = ENV['HOME']
 MAC_OR_LINUX = /linux|mac|darwin/ =~ RbConfig::CONFIG['host_os']
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: propane
 version: !ruby/object:Gem::Version
-  version: 2.3.4
+  version: 2.4.0
 platform: java
 authors:
 - monkstone
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-19 00:00:00.000000000 Z
+date: 2017-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -141,6 +141,8 @@ files:
 - test/helper_methods_test.rb
 - test/math_tool_test.rb
 - test/respond_to_test.rb
+- test/sketches/key_event.rb
+- test/sketches/library/my_library/my_library.rb
 - test/test_helper.rb
 - test/vecmath_spec_test.rb
 - vendors/Rakefile
@@ -175,5 +177,7 @@ test_files:
 - test/helper_methods_test.rb
 - test/math_tool_test.rb
 - test/respond_to_test.rb
+- test/sketches/key_event.rb
+- test/sketches/library/my_library/my_library.rb
 - test/test_helper.rb
 - test/vecmath_spec_test.rb