processing.rb 1.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eba7a6fbc01e93d9749d39744cc09d7f864e2270
+  data.tar.gz: 0ff3bd1f4773ccf00c865b5842ef63a9b2d69c9e
+SHA512:
+  metadata.gz: 47536f2d1cefad288b1970789fb962815621cf5594c622288c0c6cbd8ba40aa558f103d5f66bc34e16efe5dd4036b1526c725a6475e3daa02e4c875bc542fd29
+  data.tar.gz: 8e46387b9f2e219270ebda9e618615cfb287340a185c9a52b23f27e92c23e651e241175ad7c9827742bfed0fc80e5a0252dbfd633127211ea02102b12c3f2175

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/.rubocop.yml

@@ -0,0 +1,11 @@
+Lint/RescueException:
+  Enabled: false
+
+Metrics/AbcSize:
+  Max: 300
+
+Metrics/MethodLength:
+  Max: 100
+
+Metrics/ParameterLists:
+  Max: 10

data/CHANGELOG.md

@@ -0,0 +1,155 @@
+# Change Log
+
+## 1.1.1
+- Renamed a constant name
+- Modified a error message
+- Updated comments in code
+
+## 1.1.0
+- Splited the source code into multiple files
+- Changed to download Processing automatically
+- Changed to start automatically when the module is required
+- Renamed complete_path to sketch_path
+- Added the utility script to copy the examples
+- Adapted to both 32-bit and 64-bit architecture
+- Changed to show an error message for downloading files
+- Updated the READMEs
+
+## 1.0.0
+- Stable release
+- Modified the out messages
+
+## 0.9.9
+- Fixed a bug with downloading JRuby without proxy
+- Modified the out messages
+
+## 0.9.8
+- Updated the READMEs
+- Modified the .rubocop.yml file
+- Fixed a bug with downloading JRuby via proxy
+
+## 0.9.7
+- Changed the way to check the downloaded data
+- Modified the ouput messages
+- Updated the READMEs
+
+## 0.9.6
+- Renamed the command name to processing-rb
+- Modified the output messages
+- Updated the READMEs
+
+## 0.9.5
+- Updated the READMEs
+- Changed the directories to search for Processing
+
+## 0.9.4
+- Enabled to execute from Ruby
+- Changed to download JRuby automatically
+- Changed the way to find Processing on Windows
+
+## 0.9.3
+- Refactored a variable name
+- Renamed sketch_path to complete_path
+
+## 0.9.2
+- Updated the license text
+- Fixed the SketchBase#frame_rate method
+
+## 0.9.1
+- Changed the link to download in README
+- Renamed examples/assets to examples/data
+- Refined the READMEs
+- Removed unnecessary comments
+
+## 0.9.0
+- Added README in Japanese
+- Resized the screenshots of the examples
+- Updated README in English
+- Refined comments
+
+## 0.8.0
+- Updated the example #5
+- Refined the example #3
+- Added screenshots of the examples
+
+## 0.7.0
+- Changed to run with JRuby explicitly
+- Modified the example #3
+- Updated the examples #4
+- Refined comments in the examples
+
+## 0.6.0
+- Added an argument to the import_package method
+- Included the Handy library for the example #5
+- Added the sketch_path method
+- Added movie materials for the example #4
+
+## 0.5.0
+- Changed the directory structure of the examples
+- Renamed load_all_jars to load_jars
+- Renamed import_all_classes to import_package
+- Updated the example #3
+- Fixed the way to set the initial window status
+
+## 0.4.0
+- Refactored the example #1
+- Implemented the example #2
+- Renamed load_jar_files to loar_all_jars
+- Added the import_all_classes method
+
+## 0.3.0
+- Simplified the example #1
+- Changed to include all of the Processing classes in the module
+- Enabled to call a class methods as an instance method
+
+## 0.2.0
+- Changed the example #1
+- Added the .rubocop.yml file
+- Renamed start_sketch to start
+- Added options to the start method
+
+## 0.1.1
+- Refactored the code
+- Added a library search path for Linux
+- Started implementing the example #1
+
+## 0.1.0
+- Changed the way to undefine the Sketch class
+- Fixed the frame_rate method
+- Refactored the way to restore the environment
+- Changed to wrap the whole code in the Processing module
+- Added the descriptions to all of the methods
+
+## 0.0.7
+- Refactored the way to adapt to the virtual methods
+- Refactored the way to execute and watch the sketch
+- Wrote the README.md a little
+
+## 0.0.6
+- Wrapped the overloaded fields
+- Fixed to adapt to the virtual methods in Processing
+
+## 0.0.5
+- Added PROCESSING_ROOT check for libraries
+- Added a requirement to the gemspec file
+- Changed to call jruby when called from ruby
+- Fixed to the library load paths in Windows
+
+## 0.0.4
+- Renamed a constant variable
+- Added a shebang to the main script
+- Changed to use JRuby directly instead of Ruby
+- Changed the way to find Processing libraries
+- Added error messages
+
+## 0.0.3
+- Fixed to set __FILE__ in the sketch
+- Removed an unnecessary extension in .gitignore
+
+## 0.0.2
+- Added a command existence check
+- Adapted the load path to the directory of the sketch
+- Fixed to catch all of the errors in the sketch
+
+## 0.0.1
+- Initial release

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Takashi Kitao
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.ja.md

@@ -0,0 +1,199 @@
+# Processing.rb
+
+[ [English](https://github.com/kitao/processing.rb/blob/master/README.md) | [Japanese](https://github.com/kitao/processing.rb/blob/master/README.ja.md) ]
+
+Processing.rbはRubyで気軽にProcessingのスケッチを作成できるツールです。
+
+## 特長
+
+他の類似ツールと比べて、Processing.rbには次のような特長があります。
+
+- 設定ファイル不要で、Rubyのコードにモジュールを1つ追加するだけで使えます。
+- スケッチ更新時に自動で再起動し、requireしたモジュールも再ロードします。
+- 本家のProcessing同様、1〜2行のコード追加で簡単に拡張ライブラリが使えます。
+- ウィンドウ位置の指定や最前面表示など、ライブコーディングに便利な機能があります。
+
+## 動作画面
+
+サンプルの動作画面です。画像をクリックすると実際のコードが確認できます。
+
+<a href="https://github.com/kitao/processing.rb/blob/master/examples/01_simple_sketch.rb" target="_blank">
+<img
+src="https://raw.githubusercontent.com/kitao/processing.rb/master/examples/screenshots/01_simple_sketch.png" width="30%">
+</a>
+<a href="https://github.com/kitao/processing.rb/blob/master/examples/02_input_handling.rb" target="_blank">
+<img
+src="https://raw.githubusercontent.com/kitao/processing.rb/master/examples/screenshots/02_input_handling.png" width="30%">
+</a>
+<a href="https://github.com/kitao/processing.rb/blob/master/examples/03_multi_file.rb" target="_blank">
+<img src="https://raw.githubusercontent.com/kitao/processing.rb/master/examples/screenshots/03_multi_file.png" width="30%">
+</a>
+
+<a href="https://github.com/kitao/processing.rb/blob/master/examples/04_builtin_library.rb" target="_blank">
+<img src="https://raw.githubusercontent.com/kitao/processing.rb/master/examples/screenshots/04_builtin_library.png" width="30%">
+</a>
+<a href="https://github.com/kitao/processing.rb/blob/master/examples/05_external_library.rb" target="_blank">
+<img src="https://raw.githubusercontent.com/kitao/processing.rb/master/examples/screenshots/05_external_library.png" width="30%">
+</a>
+
+## インストール方法
+
+### 事前準備
+
+Processing.rbを使うには、RubyとJavaのインストールが必要です。各ツールは以下のサイトから入手できます。
+
+- [Ruby](https://www.ruby-lang.org/)
+- [Java](https://java.com/)
+
+### Processing.rbのインストール
+
+Processing.rbはRubyの`gem`コマンドからインストールできます。
+
+```sh
+ruby gem install processing.rb
+```
+
+インストール時にpermissionエラーが出た場合は、`sudo`コマンドを先頭に追加してください。
+
+また、オフィスなどのプロキシ環境でインストールする場合は、上記コマンドの後ろに、`-p http://proxy.hostname:port`のように[-p オプション](http://guides.rubygems.org/command-reference/#gem-install)でプロキシ設定を追加してください。
+
+インストール完了後、次のコマンドを実行すると、Processing.rbのサンプルが`~/processingrb_examples`ディレクトリにコピーされます。
+
+```sh
+setup_processingrb_examples
+```
+
+## 使い方
+
+### スケッチを作成する
+
+Processing.rbでは、`Processing::SketchBase`クラスの派生クラスとしてスケッチを作成し、`Processing.#start`関数で描画を開始します。
+
+```ruby
+require 'processing'
+
+class Sketch < Processing::SketchBase
+  def setup
+    # implement your own setup code
+  end
+
+  def draw
+    # implement your own draw code
+  end
+end
+
+Processing.start(Sketch.new)
+```
+
+`Processing::SketchBase`クラスでは、`HALF_PI`などの定数はJava版のProcessingと同様に使用できます。また、関数や変数は、`noStroke`であれば`no_stroke`のように、Java版の命令を小文字（[スネークケース](http://en.wikipedia.org/wiki/Snake_case)）にしたものが使用できます。
+
+実際のスケッチの作成例は[サンプル](https://github.com/kitao/processing.rb/tree/master/examples)をご覧ください。
+
+作成したスケッチファイルは通常のRubyコードと同じ方法で起動できます。
+
+```sh
+ruby [sketchfile]
+```
+
+なお、初回起動時のみ、`~/.processing.rb`ディレクトリにJRubyとProcessingのダウンロードが行われます。その際、ダウンロードのためのプロキシ設定を聞かれるので、必要な場合は入力を、不必要な場合は何も入力せずEnterを押してしばらくお待ちください。
+
+起動後は、同じディレクトリ以下にある`.rb`ファイルが更新されるたびに、スケッチファイルが自動で再読み込みされます。
+
+### 入力情報を取得する
+
+キーボードやマウスの入力情報は、Java版のProcessingと同様の方法で取得できます。
+
+ただし、Java版の`keyPressed`、`mousePressed`変数は、メソッド名の重複を避けるため、それぞれ`key_pressed?`、`mouse_pressed?`という名前に変更されているのでご注意ください。
+
+```ruby
+def draw
+  if mouse_pressed?
+    ellipse(mouse_x, mouse_y, 10, 10)
+  end
+end
+
+def key_pressed
+  Processing.reload if key == 'r'
+end
+```
+
+この例では、マウスボタンが押されると円を描き、キーボードの`R`が押されるとスケッチを再起動します。
+
+### 拡張ライブラリを使用する
+
+Processing向けの拡張ライブラリは、Processing.rbでもそのまま使用できます。
+
+例えば、次のようなVideoライブラリを使用するコードの場合、
+
+```java
+import processing.video.*;
+Movie movie;
+
+void setup() {
+  movie = new Movie(this, "sample.mov");
+  movie.loop();
+}
+```
+
+Processing.rbでは以下のようになります。
+
+```ruby
+Processing.load_library 'video'
+Processing.import_package 'processing.video', 'Video'
+
+class Sketch < Processing::SketchBase
+  def setup
+    @movie = Video::Movie.new(self, Processing.sketch_path('sample.mov'))
+    @movie.loop
+  end
+```
+
+Javaのライブラリへのファイルの指定は、絶対パスで行う必要があるため、この例では`Processing.#sketch_path`関数を使用して、スケッチファイルからの相対パスを絶対パスに変換しています。
+
+Processingに標準で付属しない拡張ライブラリを使用する場合は、スケッチファイルと同じディレクトリに`libraries`ディレクトリを作成して、そこに使用するライブラリを置いてください。
+
+### ライブコーディングする
+
+`Processing.#start`関数にオプションを指定すると、エディタとスケッチのウィンドウを同時に見やすく表示できます。結果を確認しながらコード編集を行う際に便利です。
+
+```ruby
+Processing.start(Sketch.new, topmost: true, pos: [300, 300])
+```
+
+`Processing.#start`関数に指定できるオプションは以下のとおりです。
+
+|オプション|説明|
+|----|----|
+|topmost:|`true`にするとウィンドウを常に最前面に表示する|
+|pos:|`[x, y]`で指定した座標にウィンドウを表示する|
+
+## APIリファレンス
+
+### Processingモジュール
+
+`Processing`モジュールはスケッチのためのクラスやメソッドを提供します。
+
+|定数|説明|
+|----|----|
+|SKETCH_FILE|起動時に指定されたスケッチファイルの絶対パス|
+|SKETCH_NAME|ディレクトリ名を除いたスケッチファイル名|
+|SKETCH_DIR|スケッチファイルの絶対パスでのディレクトリ名|
+
+|クラス|説明|
+|----|----|
+|SketchBase|スケッチの基底クラス|
+
+|特異メソッド|説明|
+|----|----|
+|load_library(name)|指定した拡張ライブラリを読み込む|
+|load_jars(dir)|指定したディレクトリのすべての`.jar`ファイルを読み込む|
+|import_package(package, module_name)|`module_name`モジュールに、指定したJavaパッケージのすべてのクラスを登録する|
+|sketch_path(path)|スケッチファイルからの相対パスを絶対パスに変換する|
+|start(sketch, topmost: false, pos: nil)|指定したスケッチインスタンスの描画を開始する|
+|reload|スケッチファイルを読み込み直し、再起動する|
+
+## ライセンス
+
+Processing.rbは[MITライセンス](http://en.wikipedia.org/wiki/MIT_License)です。無料で自由にご利用ください。
+
+Have fun!

data/README.md

@@ -0,0 +1,199 @@
+# Processing.rb
+
+[ [English](https://github.com/kitao/processing.rb/blob/master/README.md) | [Japanese](https://github.com/kitao/processing.rb/blob/master/README.ja.md) ]
+
+Processing.rb enables you to write various Processing sketches in Ruby easily.
+
+## Features
+
+Compared to similar tools, Processing.rb has the following features:
+
+- Requires no configuration file and available with just adding a module to your Ruby code
+- Reloads the sketch file and loaded modules automatically when the related files are updated
+- Available to use extension libraries for Processing with just adding a few line code in the same way as Processing
+- Provides useful functions for live coding, such as setting the window position and showing it in the topmost
+
+## Screenshots
+
+The following are screenshots of the examples of Processing.rb. Click each image to view the source code.
+
+<a href="https://github.com/kitao/processing.rb/blob/master/examples/01_simple_sketch.rb" target="_blank">
+<img
+src="https://raw.githubusercontent.com/kitao/processing.rb/master/examples/screenshots/01_simple_sketch.png" width="30%">
+</a>
+<a href="https://github.com/kitao/processing.rb/blob/master/examples/02_input_handling.rb" target="_blank">
+<img
+src="https://raw.githubusercontent.com/kitao/processing.rb/master/examples/screenshots/02_input_handling.png" width="30%">
+</a>
+<a href="https://github.com/kitao/processing.rb/blob/master/examples/03_multi_file.rb" target="_blank">
+<img src="https://raw.githubusercontent.com/kitao/processing.rb/master/examples/screenshots/03_multi_file.png" width="30%">
+</a>
+
+<a href="https://github.com/kitao/processing.rb/blob/master/examples/04_builtin_library.rb" target="_blank">
+<img src="https://raw.githubusercontent.com/kitao/processing.rb/master/examples/screenshots/04_builtin_library.png" width="30%">
+</a>
+<a href="https://github.com/kitao/processing.rb/blob/master/examples/05_external_library.rb" target="_blank">
+<img src="https://raw.githubusercontent.com/kitao/processing.rb/master/examples/screenshots/05_external_library.png" width="30%">
+</a>
+
+## How to Install
+
+### Preparations
+
+In order to use Processing.rb, installation of Ruby and Java is required. Each tool can be obtained from the following sites:
+
+- [Ruby](https://www.ruby-lang.org/)
+- [Java](https://java.com/)
+
+### Installing Processing.rb
+
+Processing.rb can be installed with the `gem` command of Ruby.
+
+```sh
+gem install processing.rb
+```
+
+If a permission error occured while installation, please add the `sudo` command at the head of the above command.
+
+In a proxy environment such as in an office, please add a proxy configuration as [-p option](http://guides.rubygems.org/command-reference/#gem-install) at the end of the above command, such as `-p http://proxy.hostname:port`.
+
+After installation, the examples of Processing.rb can be copied to the `~/processingrb_examples` directory with the following command:
+
+```sh
+setup_processingrb_examples
+```
+
+## How to Use
+
+### Creating a sketch
+
+In Processing.rb, a sketch is created as a derived class from the `Processing::SketchBase` class. And it starts rendering by calling the `Processing.#start` function.
+
+```ruby
+require 'processing'
+
+class Sketch < Processing::SketchBase
+  def setup
+    # implement your own setup code
+  end
+
+  def draw
+    # implement your own draw code
+  end
+end
+
+Processing.start(Sketch.new)
+```
+
+In the `Processing::SketchBase` class, the constants of Processing in Java such as `HALF_PI` can be used as the same name. Regarding the functions and variables of Processing, their names are [snake-cased](http://en.wikipedia.org/wiki/Snake_case). For example, `no_stroke` in the case of `noStroke` in Java.
+
+Please check the actual code in [the examples](https://github.com/kitao/processing.rb/tree/master/examples).
+
+A sketch file can be run in the same way as a usual Ruby code.
+
+```sh
+ruby [sketchfile]
+```
+
+Only for the first time, JRuby and Processing will be downloaded to the `~/.processing.rb` directory. The proxy setting to download will be asked at that moment. Please input it or just press `Enter` without any input if not necessary, and wait for a while.
+
+While the sketch file is running, it will be reloaded automatically when the `.rb` files in the same directory are updated.
+
+### Handling input data
+
+The information of the keyboard and mouse can be obtained in the same way as Processing in Java.
+
+But please note that the `keyPressed` and `mousePressed` methods in Java are renamed to `key_pressed?` and `mouse_pressed?` to avoid duplication of the method names.
+
+```ruby
+def draw
+  if mouse_pressed?
+    ellipse(mouse_x, mouse_y, 10, 10)
+  end
+end
+
+def key_pressed
+  Processing.reload if key == 'r'
+end
+```
+
+This example draws circles when the mouse button is pressed, and restarts the sketch when the `R` key is pressed.
+
+### Using an extension library
+
+An extension library for Processing can be used in Processing.rb in the same way as Processing in Java.
+
+For example, in the case of the sketch uses the video extension library like this:
+
+```java
+import processing.video.*;
+Movie movie;
+
+void setup() {
+  movie = new Movie(this, "sample.mov");
+  movie.loop();
+}
+```
+
+In Processing.rb, it goes as follow:
+
+```ruby
+Processing.load_library 'video'
+Processing.import_package 'processing.video', 'Video'
+
+class Sketch < Processing::SketchBase
+  def setup
+    @movie = Video::Movie.new(self, Processing.sketch_path('sample.mov'))
+    @movie.loop
+  end
+```
+
+When a file path for a Java library is specified in Processing.rb, it should be an absolute path. So this example uses the `Processing.#sketch_path` function to convert the relative path from the sketch directory to the absolute path.
+
+In the case of using an extension library not bundled in Processing, please make the `libraries` directory in the same directory as the sketch file and place the library in it.
+
+### Live coding
+
+With passing optional parameters to the `Processing.#start` function, the both an editor screen and a sketch window can get more visible. It helps with editing code in parallel with checking its rendering result.
+
+```ruby
+Processing.start(Sketch.new, topmost: true, pos: [300, 300])
+```
+
+The options of the `Processing.#start` function are as follows:
+
+|Option|Description|
+|----|----|
+|topmost:|When its value is `true`, the sketch window always appears in the topmost.|
+|pos:|The sketch window appears in the position `[x, y]`.|
+
+## API Reference
+
+### Processing module
+
+The `Processing` module provides the classes and methods for a Processing sketch.
+
+|Constant|Description|
+|----|----|
+|SKETCH_FILE|The path of the sketch file in the absolute path|
+|SKETCH_NAME|The name of the sketch file without the directory|
+|SKETCH_DIR|The directory of the sketch file in the absolute path|
+
+|Class|Description|
+|----|----|
+|SketchBase|The base class of a Processing sketch|
+
+|Method|Description|
+|----|----|
+|load_library(name)|Loads the specified Processing library|
+|load_jars(dir)|Loads all of the `.jar` files in the specified directory|
+|import_package(package, module_name)|Imports all of the classes in the specified Java package to the specified module|
+|sketch_path(path)|Converts the relative path from the sketch directory to the absolute path|
+|start(sketch, topmost: false, pos: nil)|Starts to render the specified sketch instance|
+|reload|Reloads the sketch file manually|
+
+## License
+
+Processing.rb is under [MIT license](http://en.wikipedia.org/wiki/MIT_License). Feel free to use it.
+
+Have fun!