glimmer 0.5.5 → 0.5.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f7348e7c25e89b1300de7540833ad43ac060ecf94b8b97b897d8e946390851a5
-  data.tar.gz: a4e964bacc785ed789fe25c97c3811b39952d315428ec38e43082d5ba2bd1967
+  metadata.gz: 51b44dbf8715a8b5137fc9d25920195cfbc3371c64bc4f9f08382b58b90f9f05
+  data.tar.gz: e4cf7037a049c640bd073df65e6053f82cabba4afbdb74a2ea4d7ac040ff62a5
 SHA512:
-  metadata.gz: 5348edf829a109f758e8a098d19b33dbdb6ddd27add80a5ab37afed35e426d1805742ce065ffb09f9451202ea3974312222bdd16390a47014a97dfc3cf92d399
-  data.tar.gz: dc24d11c4522f9c96d8d2fae5178a7053d9599fe5e3e0054db34e047dc519fdb1cbbb928eb8a5b16527db1ac2973224dc802802c9654096fd609e20533eba94d
+  metadata.gz: 64cb07faee671c1497ed8ce958f79bcf790740263e8d6a317df0295da98d2c99062134f47bc8ebbb8496828aa68db4795b8bad3f2ed01bd08bce7b9a40eb5513
+  data.tar.gz: 84d6fe12fceadf0904421caba2e20e840aa67b7cdfd7820da8f3a0373643a086fc2b82f5ba7bf719ff4fc3cde5298b8de64f64a11ad90451f3e3458f88aae830

data/README.markdown

@@ -1,4 +1,4 @@
-# Glimmer 0.5.5 Beta (JRuby Desktop UI DSL + Data-Binding)
+# Glimmer 0.5.6 Beta (JRuby Desktop UI DSL + Data-Binding)
 [![Coverage Status](https://coveralls.io/repos/github/AndyObtiva/glimmer/badge.svg?branch=master)](https://coveralls.io/github/AndyObtiva/glimmer?branch=master)
 
 Glimmer is a native-UI cross-platform desktop development library written in Ruby. Glimmer's main innovation is a JRuby DSL that enables productive and efficient authoring of desktop application user-interfaces while relying on the robust platform-native Eclipse SWT library. Glimmer additionally innovates by having built-in data-binding support to greatly facilitate synchronizing the UI with domain models. As a result, that achieves true decoupling of object oriented components, enabling developers to solve business problems without worrying about UI concerns, or alternatively drive development UI-first, and then write clean business components test-first afterwards.
@@ -111,14 +111,14 @@ Please follow these instructions to make the `glimmer` command available on your
 
 Run this command to install directly:
 ```
-jgem install glimmer -v 0.5.5
+jgem install glimmer -v 0.5.6
 ```
 
 ### Option 2: Bundler
 
 Add the following to `Gemfile`:
 ```
-gem 'glimmer', '~> 0.5.5'
+gem 'glimmer', '~> 0.5.6'
 ```
 
 And, then run:
@@ -1675,29 +1675,48 @@ Glimmer apps may be packaged and distributed on the Mac, Windows, and Linux via
 - Warbler (https://github.com/jruby/warbler): Enables bundling a Glimmer app into a JAR file
 - javapackager (https://docs.oracle.com/javase/8/docs/technotes/tools/unix/javapackager.html): Enables packaging a JAR file as a DMG file on Mac, EXE on Windows, and multiple Linux supported formats on Linux.
 
-Glimmer simplifies the process for general packaging on the Mac by providing a rake task.
+Glimmer simplifies the process for Mac packaging by providing a rake task.
 
+To use:
 - Create `Rakefile` in your app root directory
 - Add the following line to it: `require 'glimmer/rake_task'`
 - Create a Ruby script under bin (e.g. `bin/math_bowling`) to require the application file that uses Glimmer (e.g. `'../app/my_application.rb'`):
 ```ruby
 require_relative '../app/my_application.rb'
 ```
+- (Optional) If you'd like to include an icon for your app (.icns format on the Mac), place it under `package/macosx` matching your application local directory name (e.g. 'MathBowling.icns' for MathBowling). You may generate your Mac icon easily using tools like Image2Icon (http://www.img2icnsapp.com/) or manually using the Mac terminal command `iconutil` (iconutil guide: https://applehelpwriter.com/tag/iconutil/)
 
-Now, you can run the following command to package your app into a Mac DMG file (using both Warbler and javapackager):
+Now, you can run the following rake command to package your app into a Mac DMG file (using both Warbler and javapackager):
 ```
 rake glimmer:package
 ```
 
-This will generate a JAR file under `./dist` directory and DMG file under `./packages/bundles`. Both will match your application local directory name (e.g. `MathBowling.jar` and `MathBowling-1.0.dmg` for `~/code/MathBowling`)
+This will generate a JAR file under `./dist` directory, which is then used to generate a DMG file (and pkg/app) under `./packages/bundles`. Both will match your application local directory name (e.g. `MathBowling.jar` and `MathBowling-1.0.dmg` for `~/code/MathBowling`)
 
 By default, the package only includes these directories: app, config, db, lib, script, bin, images, sounds, videos
 
-After running once, you will find a `config/warble.rb` file. It has the JAR packaging configuration. You may adjust included directories in it if needed, and then rerun `rake glimmer:package` and it will pick up your custom configuration.
+After running once, you will find a `config/warble.rb` file. It has the JAR packaging configuration. You may adjust included directories in it if needed, and then rerun `rake glimmer:package` and it will pick up your custom configuration. Alternatively, if you'd like to customize the included directories to begin with, don't run `rake glimmer:package` right away. Run this command first:
 
-Otherwise, you may find more advanced instructions for javapackager (https://docs.oracle.com/javase/8/docs/technotes/guides/deploy/self-contained-packaging.html#BCGICFDB) and (https://docs.oracle.com/javase/8/docs/technotes/guides/deploy/self-contained-packaging.html) in order to sign your Mac app and distribute on the App Store.
+```
+rake glimmer:package:config
+```
+
+This will generate `config/warble.rb`, which you may configure and then run `rake glimmer:package` afterwards.
+
+In any case, you may find more advanced instructions for `javapackager` (https://docs.oracle.com/javase/8/docs/technotes/tools/unix/javapackager.html), (https://docs.oracle.com/javase/8/docs/technotes/guides/deploy/self-contained-packaging.html#BCGICFDB) and (https://docs.oracle.com/javase/8/docs/technotes/guides/deploy/self-contained-packaging.html) in order to pass extra options and sign your Mac app to distribute on the App Store.
+
+Glimmer allows passing extra options to the rake task via environment variable `JAVAPACKAGER_EXTRA_ARGS`
+
+```
+JAVAPACKAGER_EXTRA_ARGS='-Bicon="package/macosx/MathBowling.icns"' rake glimmer:package
+```
+
+### Gotcha
+
+If you run `rake glimmer:config` multiple times, sometimes it leaves a mounted DMG project in your finder. Unmount before you run the command again or it might fail with an error saying: "Error: Bundler "DMG Installer" (dmg) failed to produce a bundle."
+
+BTW, keep in mind that during normal operation, it does indicate a false-negative failure while completing successfully regardless: "Exec failed with code 2 command [[/usr/bin/SetFile, -c, icnC, /var/folders/4_/g1sw__tx6mjdgyh3mky7vydc0000gp/T/fxbundler4076750801763032201/images/MathBowling/.VolumeIcon.icns] in unspecified directory"
 
-Additionally, read their documentation on how to set an icon/assets for the application: https://docs.oracle.com/javase/8/docs/technotes/tools/unix/javapackager.html
 
 ## Resources
 

data/lib/glimmer/rake_task.rb

@@ -1,23 +1,33 @@
 namespace :glimmer do
-  desc 'Package app for distribution'
-  task :package do
-    project_name = File.basename(File.expand_path('.'))
-    if !File.exists?('config/warble.rb')
-      system('mkdir -p config')
-      system('warble config')
-      new_config = File.read('config/warble.rb').split("\n").inject('') do |output, line|
-        if line.include?('config.dirs =')
-          line = line.sub('# ', '').sub(/=[^=\n]+$/, '= %w(app config db lib script bin images sounds videos)')
-        end
-        if line.include?('config.autodeploy_dir =')
-          line = line.sub('# ', '')
+  namespace :package do
+    desc 'Generate JAR config file'
+    task :config do
+      project_name = File.basename(File.expand_path('.'))
+      if !File.exists?('config/warble.rb')
+        system('mkdir -p config')
+        system('warble config')
+        new_config = File.read('config/warble.rb').split("\n").inject('') do |output, line|
+          if line.include?('config.dirs =')
+            line = line.sub('# ', '').sub(/=[^=\n]+$/, '= %w(app config db lib script bin images sounds videos)')
+          end
+          if line.include?('config.autodeploy_dir =')
+            line = line.sub('# ', '')
+          end
+          output + "\n" + line
         end
-        output + "\n" + line
+        File.write('config/warble.rb', new_config)
       end
-      File.write('config/warble.rb', new_config)
     end
+  end
+
+  desc 'Package app for distribution'
+  task :package => 'package:config' do
+    project_name = File.basename(File.expand_path('.'))
     system('mkdir -p dist')
     system('warble')
-    system("javapackager -deploy -native -outdir packages -outfile #{project_name} -srcdir dist -srcfiles #{project_name}.jar -appclass JarMain -name \"#{project_name}\" -title \"#{project_name}\" -BjvmOptions=-XstartOnFirstThread")
+    command = "javapackager -deploy -native -outdir packages -outfile #{project_name} -srcdir dist -srcfiles #{project_name}.jar -appclass JarMain -name \"#{project_name}\" -title \"#{project_name}\" -BjvmOptions=-XstartOnFirstThread"
+    command += " #{ENV['JAVAPACKAGER_EXTRA_ARGS']}" if ENV['JAVAPACKAGER_EXTRA_ARGS']
+    puts command
+    system command
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glimmer
 version: !ruby/object:Gem::Version
-  version: 0.5.5
+  version: 0.5.6
 platform: ruby
 authors:
 - AndyMaleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-04-17 00:00:00.000000000 Z
+date: 2020-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement