glimmer-dsl-swt 0.6.3 → 0.6.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c4290c2587a5d74bdbd39df1e1459219628abd0f867df9c972ec766d1581e786
-  data.tar.gz: a422f8c8f1cad97b8c59f72eefdbdac2bfab5076e45b4d99bacbea063f683897
+  metadata.gz: 8f75e570d4a595c012b464d8dffa7149200385d8053dc39640d5be59d8f4980c
+  data.tar.gz: 1fbd61272f851ffa8aa1f6dbcf0afa57e898147c3982f69a180018a2d5d0e6c3
 SHA512:
-  metadata.gz: cfe72e5b9043ca482199ebcdb21ce5dfb3bcf5106b4adf2d1f5928d195b9ae99fbd1cd10b120ec14901052121a3cb82e5e45a203e235daaf2bd29addc6e29f60
-  data.tar.gz: 9f1d1bd197e61a8a462f5afc8d84466b0a595f0ab225999571d9fb22c8f00e078928a675a4474fde34c1274aaac252c4d23f7c7fcd38fea155a0cac8e6769767
+  metadata.gz: 3c78fc793f87813acaf59b2732a362fc37da683c79b2610dc7d9d74c37ddd56ee1ac5d33209ee509d2cc1a3c62a0fb5db56b8275d88a93b6c4d7e8c5906511b0
+  data.tar.gz: 90941e2906ecc6c87e6685f8c8ff62fda790a43c3af519761011cefa56466336e5705e8deb49e25eeef60020a7cf6ab65c19c7c3f1c1a0f325158053bcf778c4

data/README.md

@@ -1,11 +1,11 @@
-# [<img src="https://raw.githubusercontent.com/AndyObtiva/glimmer/master/images/glimmer-logo-hi-res.png" height=85 />](https://github.com/AndyObtiva/glimmer) Glimmer DSL for SWT 0.6.3 (Desktop GUI)
+# [<img src="https://raw.githubusercontent.com/AndyObtiva/glimmer/master/images/glimmer-logo-hi-res.png" height=85 />](https://github.com/AndyObtiva/glimmer) Glimmer DSL for SWT 0.6.8 (JRuby Desktop GUI)
 [![Gem Version](https://badge.fury.io/rb/glimmer-dsl-swt.svg)](http://badge.fury.io/rb/glimmer-dsl-swt)
 [![Travis CI](https://travis-ci.com/AndyObtiva/glimmer-dsl-swt.svg?branch=master)](https://travis-ci.com/github/AndyObtiva/glimmer-dsl-swt)
 [![Coverage Status](https://coveralls.io/repos/github/AndyObtiva/glimmer-dsl-swt/badge.svg?branch=master)](https://coveralls.io/github/AndyObtiva/glimmer-dsl-swt?branch=master)
 [![Maintainability](https://api.codeclimate.com/v1/badges/aaf1cba142dd351f84bd/maintainability)](https://codeclimate.com/github/AndyObtiva/glimmer-dsl-swt/maintainability)
 [![Join the chat at https://gitter.im/AndyObtiva/glimmer](https://badges.gitter.im/AndyObtiva/glimmer.svg)](https://gitter.im/AndyObtiva/glimmer?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
-[Glimmer](https://github.com/AndyObtiva/glimmer) DSL for [SWT](https://www.eclipse.org/swt/) enables desktop development with [Glimmer](https://github.com/AndyObtiva/glimmer).
+[Glimmer](https://github.com/AndyObtiva/glimmer) DSL for [SWT](https://www.eclipse.org/swt/) enables desktop development with [Glimmer](https://github.com/AndyObtiva/glimmer) in [JRuby](https://www.jruby.org/).
 
 [Glimmer](https://github.com/AndyObtiva/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.
 
@@ -15,6 +15,7 @@ Other [Glimmer](https://github.com/AndyObtiva/glimmer) DSL gems:
 - [glimmer-dsl-opal](https://github.com/AndyObtiva/glimmer-dsl-opal): Glimmer DSL for Opal (Web GUI Adapter for Desktop Apps)
 - [glimmer-dsl-xml](https://github.com/AndyObtiva/glimmer-dsl-xml): Glimmer DSL for XML (& HTML)
 - [glimmer-dsl-css](https://github.com/AndyObtiva/glimmer-dsl-css): Glimmer DSL for CSS (Cascading Style Sheets)
+- [glimmer-dsl-tk](https://github.com/AndyObtiva/glimmer-dsl-tk): Glimmer DSL for Tk (MRI Ruby Desktop GUI)
 
 ## Example
 

data/VERSION

@@ -1 +1 @@
-0.6.3
+0.6.8

data/lib/ext/glimmer/config.rb

@@ -1,3 +1,5 @@
+require 'glimmer/config'
+
 module Glimmer
   module Config
     DEFAULT_IMPORT_SWT_PACKAGES = [
@@ -9,6 +11,11 @@ module Glimmer
       'org.eclipse.swt.custom',
       'org.eclipse.swt.dnd',  
     ]
+    
+    # This may be configured with extra sample directories from custom widget/shell gems
+    # following the convention of a `samples/subdirectory` where subdirectory is the 
+    # custom widget/shell name or something representative of a group of samples (e.g. c_date_time).
+    SAMPLE_DIRECTORIES = []
   
     class << self
       # Tells Glimmer to import SWT packages into including class (default: true)
@@ -48,6 +55,10 @@ module Glimmer
       
       def logging_appender_options
         @@logging_appender_options = {async: true, auto_flushing: 500, write_size: 500, flush_period: 60, immediate_at: [:error, :fatal], layout: logging_layout} unless defined? @@logging_appender_options
+        # TODO make this a glimmer command option
+        if ENV['GLIMMER_LOGGER_ASYNC'].to_s.downcase == 'false'
+          @@logging_appender_options.merge!(async: false, auto_flushing: 1, immediate_at: [:debug, :info, :warn, :error, :fatal])
+        end
         @@logging_appender_options
       end
       
@@ -90,18 +101,27 @@ module Glimmer
           end
           logger.appenders = appenders
         end
+        
       end
+      
     end
+    
   end
+  
 end
 
-Glimmer::Config.reset_logger!
+Glimmer::Config.reset_logger! unless ENV['GLIMMER_LOGGER_ENABLED'].to_s.downcase == 'false'
 if ENV['GLIMMER_LOGGER_LEVEL']
   # if glimmer log level is being overridden for debugging purposes, then disable async logging making logging immediate
   Glimmer::Config.logging_appender_options = Glimmer::Config.logging_appender_options.merge(async: false, auto_flushing: 1)
   Glimmer::Config.logging_devices = [:stdout]
-  Glimmer::Config.logger.level = ENV['GLIMMER_LOGGER_LEVEL']
+  begin
+    Glimmer::Config.logger.level = ENV['GLIMMER_LOGGER_LEVEL'].strip
+  rescue => e
+    puts e.message
+  end
 end
+
 Glimmer::Config.excluded_keyword_checkers << lambda do |method_symbol, *args|
   method = method_symbol.to_s
   result = false

data/lib/glimmer-dsl-swt.rb

@@ -2,15 +2,11 @@ $LOAD_PATH.unshift(File.expand_path('..', __FILE__))
 
 # External requires
 require 'java'
-if ENV['BUNDLER_REQUIRE'].to_s.downcase == 'true'
-  require 'bundler'
-  Bundler.require
-else
-  require 'glimmer'
-  require 'logging'
-  require 'nested_inherited_jruby_include_package'
-  require 'super_module'
-end
+require 'puts_debuggerer' if ("#{ENV['pd']}#{ENV['PD']}").to_s.downcase.include?('true')
+require 'glimmer'
+require 'logging'
+require 'nested_inherited_jruby_include_package'
+require 'super_module'
 
 # Internal requires
 require 'ext/glimmer/config'

data/lib/glimmer/Rakefile

@@ -0,0 +1,5 @@
+# This Rakefile gets used from Glimmer::Launcher when the current directory for running the `glimmer` command 
+# does not have a Rakefile (e.g. during scaffolding). 
+# It is not needed when running from inside a scaffolded app or gem, or an app with a Rakefile that has
+# `require 'glimmer/rake_task'`
+require 'glimmer/rake_task'

data/lib/glimmer/data_binding/table_items_binding.rb

@@ -30,7 +30,10 @@ module Glimmer
       end
 
       def call(new_model_collection=nil)
-        new_model_collection = @model_binding.evaluate_property # this ensures applying converters (e.g. :on_read)        
+        new_model_collection = @model_binding.evaluate_property # this ensures applying converters (e.g. :on_read)
+        table_cells = @table.swt_widget.items.map {|item| @table.column_properties.size.times.map {|i| item.get_text(i)} }
+        model_cells = new_model_collection.to_a.map {|m| @table.cells_for(m)}
+        return if table_cells == model_cells
         if new_model_collection and new_model_collection.is_a?(Array)
           @table_items_observer_registration&.unobserve
           @table_items_observer_registration = observe(new_model_collection, @column_properties)

data/lib/glimmer/launcher.rb

@@ -1,36 +1,30 @@
-require_relative 'rake_task'
+require 'fileutils'
+require 'os'
 
 module Glimmer
   class Launcher
     OPERATING_SYSTEMS_SUPPORTED = ["mac", "windows", "linux"]
     
-    TEXT_USAGE_PREFIX = <<~MULTI_LINE_STRING
+    TEXT_USAGE = <<~MULTI_LINE_STRING
+      Glimmer (Ruby Desktop Development GUI Library) - JRuby Gem: glimmer-dsl-swt v#{File.read(File.expand_path('../../../VERSION', __FILE__))}      
       Usage: glimmer [--quiet] [--debug] [--log-level=VALUE] [[ENV_VAR=VALUE]...] [[-jruby-option]...] (application.rb or task[task_args]) [[application2.rb]...]
     
-      Runs Glimmer applications/tasks.
-    
-      Either a single task or one or more applications may be specified.
-    
-      When a task is specified, it runs via rake. Some tasks take arguments in square brackets.
-    
-      Available tasks are below (if you do not see any, please add `require 'glimmer/rake_task'` to Rakefile and rerun or run rake -T):
-    MULTI_LINE_STRING
-
-    TEXT_USAGE_SUFFIX = <<~MULTI_LINE_STRING
+      Runs Glimmer applications and tasks.    
     
       When applications are specified, they are run using JRuby, 
       automatically preloading the glimmer Ruby gem and SWT jar dependency.
     
-      Optionally, extra Glimmer options, JRuby options and environment variables may be passed in.
+      Optionally, extra Glimmer options, JRuby options, and/or environment variables may be passed in.
     
       Glimmer options:
       - "--quiet"           : Does not announce file path of Glimmer application being launched
       - "--debug"           : Displays extra debugging information, passes "--debug" to JRuby, and enables debug logging
       - "--log-level=VALUE" : Sets Glimmer's Ruby logger level ("ERROR" / "WARN" / "INFO" / "DEBUG"; default is none)
     
-      Example: glimmer samples/hello_world.rb
+      Tasks are run via rake. Some tasks take arguments in square brackets.
     
-      This runs the Glimmer application samples/hello_world.rb
+      Available tasks are below (if you do not see any, please add `require 'glimmer/rake_task'` to Rakefile and rerun or run rake -T):
+      
     MULTI_LINE_STRING
 
     GLIMMER_LIB_LOCAL = File.expand_path(File.join('lib', 'glimmer-dsl-swt.rb'))
@@ -73,6 +67,10 @@ module Glimmer
         end
         @glimmer_lib
       end
+      
+      def dev_mode?
+        glimmer_lib == GLIMMER_LIB_LOCAL
+      end
 
       def glimmer_option_env_vars(glimmer_options)
         GLIMMER_OPTION_ENV_VAR_MAPPING.reduce({}) do |hash, pair|
@@ -89,12 +87,19 @@ module Glimmer
       def launch(application, jruby_options: [], env_vars: {}, glimmer_options: {})
         jruby_options_string = jruby_options.join(' ') + ' ' if jruby_options.any?
         env_vars = env_vars.merge(glimmer_option_env_vars(glimmer_options))
-        env_vars_string = env_vars.map {|k,v| "#{k}=#{v}"}.join(' ')
+        env_vars_string = env_vars.map do |k,v| 
+          if OS.windows? && ENV['PROMPT'] # detect command prompt (or powershell)
+            "set #{k}=#{v} && "
+          else
+            "export #{k}=#{v} && "
+          end
+        end.join
         the_glimmer_lib = glimmer_lib
         devmode_require = nil
         if the_glimmer_lib == GLIMMER_LIB_LOCAL
           devmode_require = '-r puts_debuggerer '
         end
+        require_relative 'rake_task'
         rake_tasks = Rake.application.tasks.map(&:to_s).map {|t| t.sub('glimmer:', '')}
          
         # handle a bash quirk with calling package[msi] while there is a "packages" directory locally (it passes package[msi] as packages)
@@ -113,8 +118,16 @@ module Glimmer
             puts "Launching Glimmer Application: #{application}" if jruby_options_string.to_s.include?('--debug') || glimmer_options['--quiet'].to_s.downcase != 'true'
           end
           command = "#{env_vars_string} jruby #{jruby_options_string}#{jruby_os_specific_options} #{devmode_require}-r #{the_glimmer_lib} -S #{application}"
+          if !env_vars_string.empty? && OS.windows?
+            command = "bash -c \"#{command}\"" if ENV['SHELL'] # do in Windows Git Bash only
+            command = "cmd /C \"#{command}\"" if ENV['PROMPT'] # do in Windows Command Prompt only (or Powershell)
+          end
           puts command if jruby_options_string.to_s.include?('--debug')
-          exec command
+          if command.include?(' irb ')
+            exec command
+          else
+            system command
+          end
         end
       end
     end
@@ -159,10 +172,35 @@ module Glimmer
     end
 
     def display_usage
-      rake_tasks = `rake -T`.gsub('rake glimmer:', 'glimmer ').split("\n").select {|l| l.start_with?('glimmer ')}
-      puts TEXT_USAGE_PREFIX
-      puts rake_tasks.join("\n")
-      puts TEXT_USAGE_SUFFIX
+      puts TEXT_USAGE
+      display_tasks
+    end
+    
+    def display_tasks
+      if OS.windows?
+        tasks = Rake.application.tasks
+        task_lines = tasks.reject do |task|
+          task.comment.nil?
+        end.map do |task|
+          max_task_size = tasks.map(&:name_with_args).map(&:size).max + 1
+          task_name = task.name_with_args.sub('glimmer:', '')
+          line = "glimmer #{task_name.ljust(max_task_size)} # #{task.comment}"
+          bound = TTY::Screen.width - 6
+          line.size <= bound ? line : "#{line[0..(bound - 3)]}..."          
+        end
+        puts task_lines.to_a
+      else
+        require 'rake-tui'
+        require 'tty-screen'
+        require_relative 'rake_task'
+        Rake::TUI.run(branding_header: nil, prompt_question: 'Select a Glimmer task to run:') do |task, tasks|
+          max_task_size = tasks.map(&:name_with_args).map(&:size).max + 1
+          task_name = task.name_with_args.sub('glimmer:', '')
+          line = "glimmer #{task_name.ljust(max_task_size)} # #{task.comment}"
+          bound = TTY::Screen.width - 6
+          line.size <= bound ? line : "#{line[0..(bound - 3)]}..."          
+        end    
+      end
     end
 
     def extract_application_paths(options)

data/lib/glimmer/rake_task.rb

@@ -2,7 +2,95 @@ require 'rake'
 
 require_relative 'package'
 
+ENV['GLIMMER_LOGGER_ENABLED'] = 'false'
+require_relative '../ext/glimmer/config.rb'
+
+Glimmer::Config::SAMPLE_DIRECTORIES << File.expand_path('../../../samples/hello', __FILE__)
+Glimmer::Config::SAMPLE_DIRECTORIES << File.expand_path('../../../samples/elaborate', __FILE__)
+
 namespace :glimmer do
+  namespace :sample do
+    task :requires do
+      require 'text-table'
+      require 'facets/string/titlecase'
+      require 'facets/string/underscore'
+      
+      require_relative 'launcher'        
+    end
+    
+    task :glimmer_gems do
+      glimmer_gem_lib_files = Dir.glob(File.join(Gem.dir, 'gems', '*')).to_a.select do |gem_path| 
+        !!File.basename(gem_path).match(/glimmer-cw|glimmer-cs|glimmer-dsl/)
+      end.map do |gem_path|
+        Dir.glob(File.join(gem_path, 'lib/*.rb')).detect {|lib| gem_path.include?(File.basename(lib, '.rb')) }
+      end.uniq do |gem_lib_file|
+        File.basename(gem_lib_file)
+      end
+      glimmer_gem_lib_files.each {|file| require file.sub(/\.rb$/, '')}    
+    end
+  
+    desc 'Runs a Glimmer internal sample [included in gem]. If no name is supplied, it runs all samples.'
+    task :run, [:name] => [:requires, :glimmer_gems] do |t, args|
+      name = args[:name]
+      name = name.underscore.downcase unless name.nil?
+      samples = Glimmer::Config::SAMPLE_DIRECTORIES.map {|dir| Dir.glob(File.join(dir, '*.rb'))}.reduce(:+).sort
+      samples = samples.select {|path| path.include?("#{name}.rb")} unless name.nil?      
+      Rake::Task['glimmer:sample:code'].invoke(name) if samples.size == 1
+      Glimmer::Launcher.new(samples << '--quiet=false').launch
+    end
+    
+    desc 'Lists Glimmer internal samples [included in gem]. Filters by query if specified (query is optional)'
+    task :list, [:query] => [:requires, :glimmer_gems] do |t, args|
+      Glimmer::Config::SAMPLE_DIRECTORIES.each do |dir|
+        sample_group_name = File.basename(dir)
+        human_sample_group_name = sample_group_name.underscore.titlecase
+        array_of_arrays = Dir.glob(File.join(dir, '*.rb')).map do |path| 
+          File.basename(path, '.rb')
+        end.select do |path| 
+          args[:query].nil? || path.include?(args[:query])
+        end.map do |path| 
+          [path, path.underscore.titlecase, "#{'bin/' if Glimmer::Launcher.dev_mode?}glimmer sample:run[#{path}]"]
+        end.sort
+        if array_of_arrays.empty?
+          puts "No Glimmer #{human_sample_group_name} Samples match the query."
+        else
+          puts 
+          puts "  Glimmer #{human_sample_group_name} Samples:"
+          puts Text::Table.new(
+            :head => %w[Name Description Run],
+            :rows => array_of_arrays,
+            :horizontal_padding    => 1,
+            :vertical_boundary     => ' ',
+            :horizontal_boundary   => ' ',
+            :boundary_intersection => ' '
+          )        
+        end
+      end
+    end
+    
+    desc 'Outputs code for a Glimmer internal sample [included in gem] (name is required)'
+    task :code, [:name] => [:requires, :glimmer_gems] do |t, args|
+      require 'tty-markdown' unless OS.windows?
+      samples = Glimmer::Config::SAMPLE_DIRECTORIES.map {|dir| Dir.glob(File.join(dir, '*.rb'))}.reduce(:+).sort
+      sample = samples.detect {|path| path.include?("#{args[:name].to_s.underscore.downcase}.rb")}
+      sample_additional_files = Dir.glob(File.join(sample.sub('.rb', ''), '**', '*.rb'))
+      code = ([sample] + sample_additional_files).map do |file|
+        <<~RUBY
+        
+        # #{file}
+        
+        #{File.read(file)}
+        
+        # # #
+        
+        RUBY
+      end.join("\n")
+      code = TTY::Markdown.parse("```ruby\n#{code}\n```") unless OS.windows?
+      puts code
+    end
+    
+  end
+
   namespace :package do
     desc 'Clean by removing "dist" and "packages" directories'
     task :clean do
@@ -40,7 +128,6 @@ namespace :glimmer do
     Rake::Task['glimmer:package:native'].execute(args)
   end
 
-
   desc 'Scaffold Glimmer application directory structure to build a new app'
   task :scaffold, [:app_name] do |t, args|
     require_relative 'scaffold'

data/lib/glimmer/scaffold.rb

@@ -4,6 +4,8 @@ require 'facets'
 
 # TODO refactor to nest under RakeTask namespace
 
+MAIN_OBJECT = self
+
 class Scaffold
   class << self
     include FileUtils
@@ -179,6 +181,13 @@ class Scaffold
     def custom_shell_gem(custom_shell_name, namespace)
       gem_name = "glimmer-cs-#{compact_name(custom_shell_name)}"
       gem_summary = "#{human_name(custom_shell_name)} - Glimmer Custom Shell"
+      begin
+        custom_shell_keyword = dsl_widget_name(custom_shell_name)
+        MAIN_OBJECT.method(custom_shell_keyword)
+        return puts("CustomShell keyword `#{custom_shell_keyword}` is unavailable (occupied by a built-in Ruby method)! Please pick a different name.")
+      rescue NameError
+        # No Op (keyword is not taken by a built in Ruby method)
+      end
       if namespace
         gem_name += "-#{compact_name(namespace)}"
         gem_summary += " (#{human_name(namespace)})"
@@ -350,12 +359,19 @@ class Scaffold
     end
 
     def gem_bin_file(gem_name, custom_shell_name, namespace)
+      # TODO change this so that it does not mix Glimmer unto the main object
       <<~MULTI_LINE_STRING
         require_relative '../lib/#{gem_name}'
         
-        include Glimmer
+        class #{class_name(custom_shell_name)}App
+          include Glimmer
+        
+          def open
+            #{dsl_widget_name(custom_shell_name)}.open
+          end
+        end
         
-        #{dsl_widget_name(custom_shell_name)}.open
+        #{class_name(custom_shell_name)}App.new.open
       MULTI_LINE_STRING
     end
 
@@ -394,7 +410,7 @@ class Scaffold
             " -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)}'" 
+            " -Bmac.CFBundleIdentifier='org.#{namespace ? compact_name(namespace) : compact_name(custom_shell_name)}.application.#{compact_name(custom_shell_name).capitalize}'" 
             # " -BlicenseType=" +
             # " -Bmac.category=" +
             # " -Bmac.signing-key-developer-id-app="

data/lib/glimmer/swt/shell_proxy.rb

@@ -1,7 +1,6 @@
 require 'glimmer/swt/swt_proxy'
 require 'glimmer/swt/widget_proxy'
 require 'glimmer/swt/display_proxy'
-require 'glimmer/swt/swt_proxy'
 
 module Glimmer
   module SWT

data/lib/glimmer/swt/style_constantizable.rb

@@ -18,6 +18,7 @@ module Glimmer
         end
  
         def constant_value_none
+          # TODO instead of raising error try a convention instead like CLASSNAME::NONE by default
           raise 'Not implemented! Mixer must implement!'
         end
         

data/lib/glimmer/swt/table_proxy.rb

@@ -209,9 +209,19 @@ module Glimmer
         @editor = args
       end 
       
+      def cells_for(model)
+        column_properties.map {|property| model.send(property)}
+      end
+      
+      def cells
+        column_count = @table.column_properties.size
+        swt_widget.items.map {|item| column_count.times.map {|i| item.get_text(i)} }
+      end
+      
       def sort
         return unless sort_property && (sort_type || sort_block || sort_by_block)
         array = model_binding.evaluate_property
+        array = array.sort_by(&:hash) # this ensures consistent subsequent sorting in case there are equivalent sorts to avoid an infinite loop
         # Converting value to_s first to handle nil cases. Should work with numeric, boolean, and date fields
         if sort_block
           sorted_array = array.sort(&sort_block)