glimmer 0.7.6 → 0.7.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94497522f529a193db5b827f739dcf4eab4a23c0c0ac583d7352cd7bd8270a83
-  data.tar.gz: a7a6a6ff9816f5be2422b5bd53c020f8152b47a436cd2cc805690e3af3cb5612
+  metadata.gz: 76d86f5e3e322edba85aee815e28a0bb19b6ed56694ff44b1311a759b249b189
+  data.tar.gz: ad84ddf98c7a9da150f1dd4897e7a7df0e7d8cf06d317a1a748929c1446895ce
 SHA512:
-  metadata.gz: '095cae0665dbdb73713608a2b2ba9029e0693a33796e4e61ee8463f7f4dcdb385ef04f6fa5f1b3ef2cc48db11492b6bb1c6adff6eeb9de89639a7a1993c3ae1a'
-  data.tar.gz: 5513aac74d33b07ee14dbc430938e1f059a5a76a842d6dbbfef2b29c5fede52f2c57a3aea2053835b411da346bd3c7dca9bdddea385742363a6bf6ed8dbb7d40
+  metadata.gz: dbbd46186a07700fed156566a5a0de4fb5ad90720ae2e24eb0662bc1ef3a64850f29d4f91fa577f388136511e3ec20689a97e1686e25f34112fabf35c05c2981
+  data.tar.gz: f484803847e17525090f815ea117d429f10abc87f12a5c38343c9d6e2f56ff6bf055b153f5fa3f250ae60adde2b5ff4cba7b209b0b1693bc98d0f619cc1d15db

data/README.md

@@ -1,9 +1,10 @@
-# Glimmer 0.7.6 Beta (Desktop Development Library for Ruby)
+# Glimmer 0.7.7 Beta (Desktop Development Library for Ruby)
 [![Gem Version](https://badge.fury.io/rb/glimmer.svg)](http://badge.fury.io/rb/glimmer)
 [![Travis CI](https://travis-ci.com/AndyObtiva/glimmer.svg?branch=master)](https://travis-ci.com/github/AndyObtiva/glimmer)
-<!-- [![Coverage Status](https://coveralls.io/repos/github/AndyObtiva/glimmer/badge.svg?branch=master)](https://coveralls.io/github/AndyObtiva/glimmer?branch=master) -->
+[![Test Coverage](https://api.codeclimate.com/v1/badges/38fbc278022862794414/test_coverage)](https://codeclimate.com/github/AndyObtiva/glimmer/test_coverage)
+[![Maintainability](https://api.codeclimate.com/v1/badges/38fbc278022862794414/maintainability)](https://codeclimate.com/github/AndyObtiva/glimmer/maintainability)
 
-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 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 models test-first afterwards.
+Glimmer is a native-GUI 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 Eclipse SWT library. Glimmer additionally innovates by having built-in data-binding support to greatly facilitate synchronizing the GUI with domain models. As a result, that achieves true decoupling of object oriented components, enabling developers to solve business problems without worrying about GUI concerns, or alternatively drive development GUI-first, and then write clean business models test-first afterwards.
 
 [<img src="https://covers.oreillystatic.com/images/9780596519650/lrg.jpg" width=105 /><br /> 
 Featured in<br />JRuby Cookbook](http://shop.oreilly.com/product/9780596519650.do)
@@ -74,7 +75,7 @@ NOTE: Glimmer is in beta mode. Please help make better by adopting for small or
 
 ## Table of Contents
 
-- [Glimmer 0.7.6 Beta (Desktop Development Library for Ruby)](#glimmer-075-beta-desktop-development-library-for-ruby)
+- [Glimmer 0.7.7 Beta (Desktop Development Library for Ruby)](#glimmer-075-beta-desktop-development-library-for-ruby)
   - [Examples](#examples)
     - [Hello, World!](#hello-world)
     - [Tic Tac Toe](#tic-tac-toe)
@@ -125,6 +126,7 @@ NOTE: Glimmer is in beta mode. Please help make better by adopting for small or
   - [Contributing](#contributing)
   - [Contributors](#contributors)
   - [License](#license)
+
 ## Background
 
 Ruby is a dynamically-typed object-oriented language, which provides great productivity gains due to its powerful expressive syntax and dynamic nature. While it is proven by the Ruby on Rails framework for web development, it currently lacks a robust platform-independent framework for building desktop applications. Given that Java libraries can now be utilized in Ruby code through JRuby, Eclipse technologies, such as SWT, JFace, and RCP can help fill the gap of desktop application development with Ruby.
@@ -136,12 +138,12 @@ Glimmer runs on the following platforms:
 - Windows
 - Linux
 
-Glimmer's UI has the native look and feel of each operating system it runs on since it uses SWT behind the scenes, which leverages the following native libraries:
+Glimmer's GUI has the native look and feel of each operating system it runs on since it uses SWT behind the scenes, which leverages the following native libraries:
 - Win32 on Windows
 - Cocoa on Mac
 - GTK on Linux
 
-More info about the SWT UI on various platforms can be found on the Eclipse WIKI and SWT FAQ:
+More info about the SWT GUI on various platforms can be found on the Eclipse WIKI and SWT FAQ:
 
 https://wiki.eclipse.org/SWT/Devel/Gtk/Dev_guide#Win32.2FCocoa.2FGTK
 https://www.eclipse.org/swt/faq.php
@@ -169,7 +171,7 @@ Please follow these instructions to make the `glimmer` command available on your
 
 Run this command to install directly:
 ```
-jgem install glimmer -v 0.7.6
+jgem install glimmer -v 0.7.7
 ```
 
 `jgem` is JRuby's version of `gem` command. 
@@ -180,7 +182,7 @@ Otherwise, you may also run `jruby -S gem install ...`
 
 Add the following to `Gemfile`:
 ```
-gem 'glimmer', '~> 0.7.6'
+gem 'glimmer', '~> 0.7.7'
 ```
 
 And, then run:
@@ -341,9 +343,11 @@ glimmer scaffold:custom_widget[custom_widget_name]
 
 #### Custom Shell Gem
 
-Custom shell gems are self-contained Glimmer apps as well as reusable custom shells.
+Custom shell gems are self-contained Glimmer apps as well as reusable custom shells. 
+As such, they are packaged as both a native executable (e.g. Mac DMG/PKG/APP) and a Ruby gem.
+Of course, you can build a Ruby gem and disregard its native executable packaging if you do not need it.
 
-To scaffold a Glimmer custom shell gem (full window view externalized into a gem) for an existing Glimmer app, run the following command:
+To scaffold a Glimmer custom shell gem (full window view distributed as a Ruby gem), run the following command:
 
 ```
 glimmer scaffold:custom_shell_gem[custom_shell_name, namespace]
@@ -351,7 +355,7 @@ glimmer scaffold:custom_shell_gem[custom_shell_name, namespace]
 
 It is important to specify a namespace to avoid having your gem clash with existing gems.
 
-The Ruby gem name will follow the convention "glimmer-cs-customwidgetname-namespace" (the 'cs' is for Custom Shell)
+The Ruby gem name will follow the convention "glimmer-cs-customwidgetname-namespace" (the 'cs' is for Custom Shell).
 
 Only official Glimmer gems created by the Glimmer project committers will have no namespace (e.g. [glimmer-cs-gladiator](https://rubygems.org/gems/glimmer-cs-gladiator) Ruby gem)
 
@@ -359,7 +363,7 @@ Example: [https://github.com/AndyObtiva/glimmer-cs-gladiator](https://github.com
 
 #### Custom Widget Gem
 
-To scaffold a Glimmer custom widget gem (part of a view externalized into a gem) for an existing Glimmer app, run the following command:
+To scaffold a Glimmer custom widget gem (part of a view distributed as a Ruby gem), run the following command:
 
 ```
 glimmer scaffold:custom_widget_gem[custom_widget_name, namespace]
@@ -409,7 +413,7 @@ You will learn more about widgets next.
 
 ### Widgets
 
-Glimmer UIs (user interfaces) are modeled with widgets, which are wrappers around the SWT library widgets found here:
+Glimmer GUIs (user interfaces) are modeled with widgets, which are wrappers around the SWT library widgets found here:
 
 https://www.eclipse.org/swt/widgets/
 
@@ -518,7 +522,7 @@ shell {
 
 #### Display
 
-SWT Display is a singleton in Glimmer. It is used in SWT to represent your display device, allowing you to manage UI globally 
+SWT Display is a singleton in Glimmer. It is used in SWT to represent your display device, allowing you to manage GUI globally 
 and access available monitors. 
 It is automatically instantiated upon first instantiation of a `shell` widget. 
 Alternatively, for advanced use cases, it can be created explicitly with Glimmer `display` keyword. When a `shell` is later declared, it
@@ -546,7 +550,7 @@ Glimmer follows Proxy Design Pattern by having Ruby proxy wrappers for all SWT o
 - `Glimmer::SWT:TabItemProxy` wraps `org.eclipse.swt.widget.TabItem` (also adds a composite to enable adding content under tab items directly in Glimmer)
 - `Glimmer::SWT:LayoutProxy` wraps all descendants of `org.eclipse.swt.widget.Layout`
 - `Glimmer::SWT:LayoutDataProxy` wraps all layout data objects
-- `Glimmer::SWT:DisplayProxy` wraps `org.eclipse.swt.widget.Display` (manages displaying UI)
+- `Glimmer::SWT:DisplayProxy` wraps `org.eclipse.swt.widget.Display` (manages displaying GUI)
 - `Glimmer::SWT:ColorProxy` wraps `org.eclipse.swt.graphics.Color`
 - `Glimmer::SWT:FontProxy` wraps `org.eclipse.swt.graphics.Font`
 - `Glimmer::SWT::WidgetListenerProxy` wraps all widget listeners
@@ -1405,7 +1409,7 @@ Example (you may copy/paste in [`girb`](#girb-glimmer-irb-command)):
 
 The shell declared above has been modified so that the minimize button works just like the close button. Once you minimize the shell (iconify it), it closes.
 
-The alternative syntax can be helpful if you prefer to separate Glimmer observer declarations from Glimmer UI declarations, or would like to add observers dynamically based on some logic later on.
+The alternative syntax can be helpful if you prefer to separate Glimmer observer declarations from Glimmer GUI declarations, or would like to add observers dynamically based on some logic later on.
 
 #### Observing Models
 
@@ -1939,7 +1943,7 @@ This relies on Glimmer's [Multi-DSL Support](https://github.com/AndyObtiva/glimm
 - Widget property declarations always have arguments and never take a block
 - Widget property arguments are never wrapped inside parentheses
 - Widget listeners are always declared starting with `on_` prefix and affixing listener event method name afterwards in underscored lowercase form
-- Widget listeners are always followed by a block using curly braces (Only when declared in DSL. When invoked on widget object directly outside of UI declarations, standard Ruby conventions apply)
+- Widget listeners are always followed by a block using curly braces (Only when declared in DSL. When invoked on widget object directly outside of GUI declarations, standard Ruby conventions apply)
 - Data-binding is done via `bind` keyword, which always takes arguments wrapped in parentheses
 - Custom widget body, before_body, and after_body blocks open their blocks and close them with curly braces.
 - Custom widgets receive additional arguments to SWT style called options. These are passed as the last argument inside the parentheses, a hash of option names pointing to values.
@@ -2283,8 +2287,10 @@ These features have been suggested. You might see them in a future version of Gl
 
 ## Contributors
 
-* Andy Maleh (Founder)
-* Dennis Theisen
+* [Andy Maleh](https://github.com/AndyObtiva) (Founder)
+* [Dennis Theisen](https://github.com/Soleone) (Contributor)
+
+[Click here to view contributor commits.](https://github.com/AndyObtiva/glimmer/graphs/contributors)
 
 ## License
 

data/VERSION

@@ -1 +1 @@
-0.7.6
+0.7.7

data/lib/glimmer/scaffold.rb

@@ -77,7 +77,7 @@ class Scaffold
     GEMFILE_APP = <<~MULTI_LINE_STRING
       # frozen_string_literal: true
       
-      source "https://rubygems.org"
+      source 'https://rubygems.org'
       
       git_source(:github) {|repo_name| "https://github.com/\#{repo_name}" }
       
@@ -91,16 +91,16 @@ class Scaffold
     GEMFILE_GEM = <<~MULTI_LINE_STRING
       # frozen_string_literal: true
       
-      source "https://rubygems.org"
+      source 'https://rubygems.org'
       
       git_source(:github) {|repo_name| "https://github.com/\#{repo_name}" }
       
       gem 'glimmer', '~> #{VERSION}'
       
       group :development do
-        gem "rspec", "~> 3.5.0"
-        gem "jeweler", "2.3.9"
-        gem "simplecov", ">= 0"
+        gem 'rspec', '~> 3.5.0'
+        gem 'jeweler', '2.3.9'
+        gem 'simplecov', '>= 0'
       end
     MULTI_LINE_STRING
 
@@ -155,7 +155,7 @@ class Scaffold
       end
       mkdir 'bin'
       write "bin/#{file_name(app_name)}", app_bin_file(app_name)
-      FileUtils.chmod 0755, "bin/#{app_name.underscore}"
+      FileUtils.chmod 0755, "bin/#{file_name(app_name)}"
       system "bash -c '#{RVM_FUNCTION}\n cd .\n bundle\n glimmer package\n'"
       system "open packages/bundles/#{human_name(app_name).gsub(' ', '\ ')}.app"
       # TODO generate rspec test suite
@@ -193,11 +193,21 @@ class Scaffold
       write '.ruby-gemset', gem_name
       write 'VERSION', '1.0.0'
       write 'Gemfile', GEMFILE_GEM      
-      write 'Rakefile', gem_rakefile
+      write 'Rakefile', gem_rakefile(custom_shell_name, namespace)
       append "lib/#{gem_name}.rb", gem_main_file(custom_shell_name, namespace)
       mkdir 'lib/views'
       custom_shell(custom_shell_name, namespace)
-      system "bash -c '#{RVM_FUNCTION}\n cd .\n bundle\n'"
+      mkdir 'bin'
+      write "bin/#{file_name(custom_shell_name)}", gem_bin_file(gem_name, custom_shell_name, namespace)
+      FileUtils.chmod 0755, "bin/#{file_name(custom_shell_name)}"      
+      if OS.mac?
+        mkdir_p 'package/macosx'
+        icon_file = "package/macosx/#{human_name(custom_shell_name)}.icns"
+        cp File.expand_path('../../../icons/scaffold_app.icns', __FILE__), icon_file
+        puts "Created #{current_dir_name}/#{icon_file}"
+      end
+      system "bash -c '#{RVM_FUNCTION}\n cd .\n bundle\n glimmer package\n'"
+      system "open packages/bundles/#{human_name(custom_shell_name).gsub(' ', '\ ')}.app"
       puts "Finished creating #{gem_name} Ruby gem."
       puts 'Edit Rakefile to configure gem details.'
       puts 'Run `rake` to execute specs.'
@@ -253,19 +263,20 @@ class Scaffold
     end
 
     def class_name(app_name)
-      app_name.camelcase(:upper)
+      app_name.underscore.camelcase(:upper)
     end
 
     def file_name(app_name)
       app_name.underscore
     end
+    alias dsl_widget_name file_name
 
     def human_name(app_name)
       app_name.underscore.titlecase
     end
 
     def compact_name(gem_name)
-      gem_name.camelcase.downcase
+      gem_name.underscore.camelcase.downcase
     end
 
     def app_main_file(app_name)
@@ -312,7 +323,19 @@ class Scaffold
       MULTI_LINE_STRING
     end
 
-    def gem_rakefile
+    def gem_bin_file(gem_name, custom_shell_name, namespace)
+      <<~MULTI_LINE_STRING
+        #!/usr/bin/env ruby
+        
+        require_relative '../lib/#{gem_name}'
+        
+        include Glimmer
+        
+        #{dsl_widget_name(custom_shell_name)}.open
+      MULTI_LINE_STRING
+    end
+
+    def gem_rakefile(custom_shell_name = nil, namespace = nil)
       rakefile_content = File.read('Rakefile')
       lines = rakefile_content.split("\n")
       require_rake_line_index = lines.index(lines.detect {|l| l.include?("require 'rake'") })
@@ -321,8 +344,21 @@ class Scaffold
       lines.insert(gem_files_line_index, "  gem.files = Dir['lib/**/*.rb']")
       spec_pattern_line_index = lines.index(lines.detect {|l| l.include?('spec.pattern =') })
       lines.insert(spec_pattern_line_index+1, "  spec.ruby_opts = [Glimmer::Launcher.jruby_swt_options]")
-      lines << "\nrequire 'glimmer/rake_task'\n"
-      lines.join("\n")
+      lines << "\nrequire 'glimmer/rake_task'\n"       
+      file_content = lines.join("\n")
+      if custom_shell_name
+        file_content << <<~MULTI_LINE_STRING  
+          Glimmer::Package.javapackager_extra_args =
+            " -name '#{human_name(custom_shell_name)}'" +
+            " -title '#{human_name(custom_shell_name)}'" +
+            " -Bmac.CFBundleName='#{human_name(custom_shell_name)}'" +
+            " -Bmac.CFBundleIdentifier='org.#{namespace ? compact_name(namespace) : compact_name(custom_shell_name)}.application.#{compact_name(custom_shell_name)}'" 
+            # " -BlicenseType=" +
+            # " -Bmac.category=" +
+            # " -Bmac.signing-key-developer-id-app="
+        MULTI_LINE_STRING
+      end
+      file_content
     end
 
     def spec_helper_file

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glimmer
 version: !ruby/object:Gem::Version
-  version: 0.7.6
+  version: 0.7.7
 platform: ruby
 authors:
 - AndyMaleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-26 00:00:00.000000000 Z
+date: 2020-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -150,34 +150,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.5.0
-- !ruby/object:Gem::Dependency
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.8.5
-  name: coveralls
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.8.5
-- !ruby/object:Gem::Dependency
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.10.0
-  name: simplecov
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.10.0
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements: