glimmer 0.5.6 → 0.5.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51b44dbf8715a8b5137fc9d25920195cfbc3371c64bc4f9f08382b58b90f9f05
-  data.tar.gz: e4cf7037a049c640bd073df65e6053f82cabba4afbdb74a2ea4d7ac040ff62a5
+  metadata.gz: 34181d1d8318f14c036ebfdd848818600e16db5cc38ffcab6d5bb4be066d71af
+  data.tar.gz: 280f6bb988e28a5c22a691df979616b20036e6d918a68595c1a7e5236ff8e7ac
 SHA512:
-  metadata.gz: 64cb07faee671c1497ed8ce958f79bcf790740263e8d6a317df0295da98d2c99062134f47bc8ebbb8496828aa68db4795b8bad3f2ed01bd08bce7b9a40eb5513
-  data.tar.gz: 84d6fe12fceadf0904421caba2e20e840aa67b7cdfd7820da8f3a0373643a086fc2b82f5ba7bf719ff4fc3cde5298b8de64f64a11ad90451f3e3458f88aae830
+  metadata.gz: 5c65e1dcdd54e3c9a98b5cc16bc422c5a1ee38f4b0f85a9f9c761dce93ab3b0682b4ee708b7e5212dc24e875a1b7bcf37578f75cd975f5a6093312e0caf2c8f7
+  data.tar.gz: e7ea759b31719d58f05bef4ef0b1fd4a5301fa9240412c3eac75c98d961a0515b02703a84e86f0f06e32effffea168e7f7c9e38ed00b116b69bcb61dfa90d69e

data/README.markdown

@@ -1,4 +1,4 @@
-# Glimmer 0.5.6 Beta (JRuby Desktop UI DSL + Data-Binding)
+# Glimmer 0.5.7 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.6
+jgem install glimmer -v 0.5.7
 ```
 
 ### Option 2: Bundler
 
 Add the following to `Gemfile`:
 ```
-gem 'glimmer', '~> 0.5.6'
+gem 'glimmer', '~> 0.5.7'
 ```
 
 And, then run:
@@ -1117,37 +1117,26 @@ The alternative syntax can be helpful if you prefer to separate Glimmer observer
 
 #### Observing Models
 
-The class that needs to observe a model object must include (mix in) the `Observer` module and implement the `#call(new_value)` method. The class to be observed doesn't need to do anything. It will automatically be enhanced by Glimmer for observation.
-
-To register observer, one has to call the `#observe` method and pass in the observable and the property(ies) to observe.
+Glimmer DSL includes an `observe` keyword used to register an observer by passing in the observable and the property(ies) to observe, and then specifying in a block what happens on notification.
 
 ```ruby
 class TicTacToe
   include Glimmer
-  include Observer
 
   def initialize
     # ...
-    observe(@tic_tac_toe_board, :game_status)
-  end
-
-  def call(game_status)
-    display_win_message if game_status == TicTacToeBoard::WIN
-    display_draw_message if game_status == TicTacToeBoard::DRAW
+    observe(@tic_tac_toe_board, :game_status) { |game_status|
+      display_win_message if game_status == TicTacToeBoard::WIN
+      display_draw_message if game_status == TicTacToeBoard::DRAW
+    }
   end
   # ...
 end
 ```
 
-Alternatively, one can use a default Observer.proc implementation via Observer.proc method:
-```ruby
-observer = Observer.proc { |new_value| puts new_value }
-observer.observe(@tic_tac_toe_board, :game_status)
-```
+Observers can be a good mechanism for displaying dialog messages in Glimmer (using SWT's `MessageBox`).
 
-Observers can be a good mechanism for displaying dialog messages with Glimmer (using SWT's `MessageBox`).
-
-Look at `samples/tictactoe/tic_tac_toe.rb` for an `Observer` dialog message example (sample below).
+Look at [`samples/tictactoe/tic_tac_toe.rb`](samples/tictactoe/tic_tac_toe.rb) for more details starting with the code included below.
 
 ```ruby
 class TicTacToe
@@ -1156,12 +1145,10 @@ class TicTacToe
 
   def initialize
     # ...
-    observe(@tic_tac_toe_board, :game_status)
-  end
-
-  def call(game_status)
-    display_win_message if game_status == TicTacToeBoard::WIN
-    display_draw_message if game_status == TicTacToeBoard::DRAW
+    observe(@tic_tac_toe_board, :game_status) { |game_status|
+      display_win_message if game_status == TicTacToeBoard::WIN
+      display_draw_message if game_status == TicTacToeBoard::DRAW
+    }
   end
 
   def display_win_message
@@ -1685,6 +1672,7 @@ To use:
 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/)
+- (Optional) You may optionally add the following to `Rakefile` to configure extra arguments for javapackager: `Glimmer::Packager.javapackager_extra_args = "..."` (Useful to avoid re-entering extra arguments on every run of rake task.)
 
 Now, you can run the following rake command to package your app into a Mac DMG file (using both Warbler and javapackager):
 ```
@@ -1703,20 +1691,69 @@ 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.
+In any case, in order to pass extra options to configure Mac package and sign your Mac app to distribute on the App Store, you can read more advanced instructions for `javapackager` here:
+- https://docs.oracle.com/javase/9/tools/javapackager.htm#JSWOR719
+- 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
+- https://docs.oracle.com/javase/8/docs/technotes/guides/deploy/self-contained-packaging.html
+
+Glimmer rake task allows passing extra options to javapackager via `Glimmer::Packager.javapackager_extra_args` in your application Rakefile or environment variable `JAVAPACKAGER_EXTRA_ARGS`
 
-Glimmer allows passing extra options to the rake task via environment variable `JAVAPACKAGER_EXTRA_ARGS`
+Example (Rakefile):
 
+```ruby
+Glimmer::Package.javapackager_extra_args = '-srcfiles "LICENSE.txt" -BlicenseFile="LICENSE.txt" -BlicenseType="MIT" -Bmac.CFBundleVersion="1.0.0" -Bmac.category="arithmetic" -Bmac.signing-key-developer-id-app="Andy Maleh"'
 ```
-JAVAPACKAGER_EXTRA_ARGS='-Bicon="package/macosx/MathBowling.icns"' rake glimmer:package
+
+Example (env var):
+
+```
+JAVAPACKAGER_EXTRA_ARGS='-Bmac.CFBundleName="Math Bowling Game"' rake glimmer:package
 ```
 
-### Gotcha
+That overrides the default application display name.
+
+### Mac Application Distribution
+
+Recent macOS versions (starting with Catalina) have very stringent security requirements requiring all applications to be signed before running (unless the user goes to System Preferences -> Privacy -> General tab and clicks "Open Anyway" after failing to open application the first time they run it). So, to release a desktop application on the Mac, it is recommended to enroll in the [Apple Developer Program](https://developer.apple.com/programs/) to distribute on the [Mac App Store](https://developer.apple.com/distribute/) or otherwise request [app notarization from Apple](https://developer.apple.com/documentation/xcode/notarizing_macos_software_before_distribution) to distribute independently.
+
+### Self Signed Certificate
+
+You may still release a signed DMG file without enrolling into the Apple Developer Program with the caveat that users will always fail in opening the app the first time, and have to go to System Preferences -> Privacy -> General tab to "Open Anyway".
+
+To do so, you may follow these steps (abbreviated version from https://developer.apple.com/library/archive/documentation/Security/Conceptual/CodeSigningGuide/Procedures/Procedures.html#//apple_ref/doc/uid/TP40005929-CH4-SW2):
+- Open Keychain Access
+- Choose Keychain Access > Certificate Assistant > Create Certificate ...
+- Enter Name (referred to below as "CertificateName")
+- Set 'Certificate Type' to 'Code Signing'
+- Create (if you alternatively override defaults, make sure to enable all capabilities)
+- Add the following option to javapackager: `-Bmac.signing-key-developer-id-app="CertificateName"` via `Glimmer::Package.javapackager_extra_args` or `JAVAPACKAGER_EXTRA_ARGS`
+
+Example:
+
+```ruby
+Glimmer::Package.javapackager_extra_args = '-Bmac.signing-key-developer-id-app="Andy Maleh"'
+```
+
+Now, when you run `rake glimmer:package`, it builds a self-signed DMG file. When you make available online, and users download, upon launching application, they are presented with your certificate, which they have to sign if they trust you in order to use the application.
+
+### Gotchas
+
+1. Specifying License File
+
+The javapackager documentation states that a license file may be specified with "-BlicenseFile" javapackager option. However, in order for that to work, one must specify as a source file via "-srcfiles" javapackager option.
+
+Example:
+
+```ruby
+Glimmer::Package.javapackager_extra_args = '-srcfiles "LICENSE.txt" -BlicenseFile="LICENSE.txt" -BlicenseType="MIT"'
+```
 
-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."
+2. Mounted DMG Residue
 
-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"
+If you run `rake glimmer:package` 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."
 
+By the way, keep in mind that during normal operation, it does also indicate a false-negative while completing successfully (please ignore): "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"
 
 ## Resources
 

data/lib/glimmer.rb

@@ -24,6 +24,8 @@ module Glimmer
     def included(klass)
       if import_swt_packages
         klass.include(SWT::Packages)
+        klass.extend(SWT::Packages)
+        klass.extend(Glimmer)
       end
     end
 

data/lib/glimmer/package.rb

@@ -0,0 +1,7 @@
+module Glimmer
+  module Package
+    class << self
+      attr_accessor :javapackager_extra_args
+    end
+  end
+end

data/lib/glimmer/rake_task.rb

@@ -1,9 +1,12 @@
+require 'glimmer/package'
+
 namespace :glimmer do
   namespace :package do
     desc 'Generate JAR config file'
     task :config do
       project_name = File.basename(File.expand_path('.'))
       if !File.exists?('config/warble.rb')
+        puts 'Generating JAR configuration (config/warble.rb) to use with Warbler...'
         system('mkdir -p config')
         system('warble config')
         new_config = File.read('config/warble.rb').split("\n").inject('') do |output, line|
@@ -22,11 +25,18 @@ namespace :glimmer do
 
   desc 'Package app for distribution'
   task :package => 'package:config' do
+    require 'facets/string/titlecase'
+    require 'facets/string/underscore'
     project_name = File.basename(File.expand_path('.'))
+    human_name = project_name.underscore.titlecase
     system('mkdir -p dist')
+    puts "Generating JAR with Warbler..."
     system('warble')
-    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 = "javapackager -deploy -native -outdir packages -outfile #{project_name} -srcfiles \"dist/#{project_name}.jar\" -appclass JarMain -name \"#{project_name}\" -title \"#{human_name}\" -BjvmOptions=-XstartOnFirstThread"
+    command += " -Bmac.CFBundleName=\"#{human_name}\""
+    command += " #{Glimmer::Package.javapackager_extra_args}" if Glimmer::Package.javapackager_extra_args
     command += " #{ENV['JAVAPACKAGER_EXTRA_ARGS']}" if ENV['JAVAPACKAGER_EXTRA_ARGS']
+    puts "Generating DMG/PKG/APP/JNLP with javapackager..."
     puts command
     system command
   end

data/lib/glimmer/swt/shell_proxy.rb

@@ -14,18 +14,12 @@ module Glimmer
 
       WIDTH_MIN = 130
       HEIGHT_MIN = 0
-      CUSTOM_ATTRIBUTES = %w[app_name app_version]
 
       attr_reader :opened_before
       alias opened_before? opened_before
 
       # Instantiates ShellProxy with same arguments expected by SWT Shell
       def initialize(*args)
-        if args.last.is_a?(Hash)
-          app_attributes = args.delete(args.last)
-          Display.setAppName(app_attributes[:app_name])
-          Display.setAppVersion(app_attributes[:app_version])
-        end
         if args.first.is_a?(ShellProxy)
           args[0] = args[0].swt_widget
         end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: glimmer
 version: !ruby/object:Gem::Version
-  version: 0.5.6
+  version: 0.5.7
 platform: ruby
 authors:
 - AndyMaleh
@@ -255,6 +255,7 @@ files:
 - lib/glimmer/error.rb
 - lib/glimmer/invalid_keyword_error.rb
 - lib/glimmer/launcher.rb
+- lib/glimmer/package.rb
 - lib/glimmer/rake_task.rb
 - lib/glimmer/swt/color_proxy.rb
 - lib/glimmer/swt/display_proxy.rb