glimmer-dsl-swt 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7caca40c9a1207a97846a5c5511fe24a07f4689979e57d54c395a33b3b341ba
-  data.tar.gz: 4b41ad30f7e63cd67bc87e88668cfb7f5b2d49b3d4cb7081bcfa04b6dcfefa90
+  metadata.gz: 0d324a6327e85a840d2a980ba78a47fa9c50e927b409f128c60d9b2ac38f2124
+  data.tar.gz: ace770a87429cbaca623310837618e14f12e8375221c433751e1feb13e768eff
 SHA512:
-  metadata.gz: 2f41fda28c273df8bb93810f68c7841f60346b3469b7afeea9992bdf34f06dae28912af64dcce1ebcc6604832383de7a3082d3f4fe7238d5fa6563476792246d
-  data.tar.gz: 92e0b7e06ebcf4e7af47bfbc22189449d5161ebda431bd4be5973c4447ba622bac139bf31d4cbaaf5e92658d6695a49e522086e54f8a4303cd394fd9bdef2e65
+  metadata.gz: 0d7e8c740b9fb6a8993e906a485cdc50241ea5a12664ff4f9ec128de2b2f77ad9718ae41fb0e9bd391546127273769769a1ac259870f2327bd29bba18d40afe3
+  data.tar.gz: 56406b25d9ab52e5af2043f33860cbd8cc0a5681b4e7eeba77325122c71cf9897c7bcd6f19ea68e3b3171f1e0dfa07c8d8dc501297fce2e8c83cc37ba3ed024b

data/README.md

@@ -1,11 +1,36 @@
-# Glimmer DSL for SWT 0.1.0 (Desktop GUI)
+# <img src="https://raw.githubusercontent.com/AndyObtiva/glimmer/master/images/glimmer-logo-hi-res.png" height=85 /> Glimmer DSL for SWT 0.2.1 (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)
+[![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 enables desktop development with 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).
 
-You may find full setup/usage instructions at the main Glimmer project page: 
-[https://github.com/AndyObtiva/glimmer](https://github.com/AndyObtiva/glimmer)
+[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.
+
+You may find full setup/usage instructions at the main [Glimmer project page](https://github.com/AndyObtiva/glimmer).
+
+Other 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)
+
+## Example
+
+```ruby
+include Glimmer
+   
+shell {
+  text 'Glimmer'
+  label {
+    text 'Hello, World!'
+  }
+}.open
+```
+
+![Glimmer DSL for SWT Hello World](https://github.com/AndyObtiva/glimmer/blob/master/images/glimmer-hello-world.png)
+
+Learn more at the main [Glimmer project page](https://github.com/AndyObtiva/glimmer).
 
 ## Help
 
@@ -15,11 +40,9 @@ You may submit [issues](https://github.com/AndyObtiva/glimmer/issues) on [GitHub
 
 [Click here to submit an issue.](https://github.com/AndyObtiva/glimmer/issues)
 
-### IRC Channel
-
-If you need live help, try the [#glimmer](http://widget.mibbit.com/?settings=7514b8a196f8f1de939a351245db7aa8&server=irc.mibbit.net&channel=%23glimmer) IRC channel on [irc.mibbit.net](http://widget.mibbit.com/?settings=7514b8a196f8f1de939a351245db7aa8&server=irc.mibbit.net&channel=%23glimmer). If no one was available, you may [leave a GitHub issue](https://github.com/AndyObtiva/glimmer/issues) to schedule a meetup on IRC. 
+### Chat
 
-[Click here to connect to #glimmer IRC channel immediately via a web interface.](http://widget.mibbit.com/?settings=7514b8a196f8f1de939a351245db7aa8&server=irc.mibbit.net&channel=%23glimmer)
+If you need live help, try to [![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)
 
 ## Feature Suggestions
 

data/RUBY_VERSION

@@ -1 +1 @@
-jruby-9.2.11.1
+jruby-9.2.12.0

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.1

data/lib/ext/glimmer.rb

@@ -3,11 +3,18 @@ require 'glimmer/swt/packages'
 module Glimmer
   class << self
     def included(klass)
+      if Object.const_defined?(:ActiveSupport) && ActiveSupport.const_defined?(:Dependencies)
+        begin
+          ActiveSupport::Dependencies.unhook!
+        rescue => e
+          # noop TODO support logging unimportant details below debug level
+        end
+      end
       if Config.import_swt_packages
         klass.include(SWT::Packages)
         klass.extend(SWT::Packages)
-        klass.extend(Glimmer)
       end
+      klass.extend(Glimmer)
     end
   end
 end

data/lib/ext/glimmer/config.rb

@@ -1,16 +1,24 @@
 module Glimmer
   module Config
+    DEFAULT_IMPORT_SWT_PACKAGES = [
+      'org.eclipse.swt',
+      'org.eclipse.swt.widgets',
+      'org.eclipse.swt.layout',
+      'org.eclipse.swt.graphics',
+      'org.eclipse.swt.browser',
+      'org.eclipse.swt.custom',
+      'org.eclipse.swt.dnd',  
+    ]
+  
     class << self
       # Tells Glimmer to import SWT packages into including class (default: true)
       def import_swt_packages=(value)
-        @@import_swt_packages = !!value
+        @@import_swt_packages = value
       end
   
       # Returns whether Glimmer will import SWT packages into including class
       def import_swt_packages
-        unless defined? @@import_swt_packages
-          @@import_swt_packages = true
-        end
+        @@import_swt_packages = DEFAULT_IMPORT_SWT_PACKAGES if !defined?(@@import_swt_packages) || (defined?(@@import_swt_packages) && @@import_swt_packages == true)
         @@import_swt_packages
       end
     end

data/lib/glimmer-dsl-swt.rb

@@ -2,9 +2,14 @@ $LOAD_PATH.unshift(File.expand_path('..', __FILE__))
 
 # External requires
 require 'java'
-require 'nested_inherited_jruby_include_package'
-require 'super_module'
-require 'glimmer'
+if ENV['BUNDLER_REQUIRE'].to_s.downcase == 'true'
+  require 'bundler'
+  Bundler.require
+else
+  require 'nested_inherited_jruby_include_package'
+  require 'super_module'
+  require 'glimmer'
+end
 
 # Internal requires
 require 'ext/glimmer/config'

data/lib/glimmer/data_binding/list_selection_binding.rb

@@ -1,4 +1,3 @@
-require 'glimmer'
 require 'glimmer/data_binding/observable'
 require 'glimmer/data_binding/observer'
 

data/lib/glimmer/data_binding/table_items_binding.rb

@@ -22,23 +22,24 @@ module Glimmer
           @table.body_root.column_properties = @column_properties
         end
         call(@model_binding.evaluate_property)
-        model = model_binding.base_model
-        observe(model, model_binding.property_name_expression)
+        observe(model_binding)
         @table.on_widget_disposed do |dispose_event|
           unregister_all_observables
         end
       end
 
       def call(new_model_collection=nil)
+        new_model_collection = @model_binding.evaluate_property # this ensures applying converters (e.g. :on_read)
         if new_model_collection and new_model_collection.is_a?(Array)
           observe(new_model_collection, @column_properties)
           @model_collection = new_model_collection
         end
-        populate_table(@model_collection, @table, @column_properties)
+        populate_table(@model_collection, @table, @column_properties)        
       end
-
+      
       def populate_table(model_collection, parent, column_properties)
         selected_table_item_models = parent.swt_widget.getSelection.map(&:getData)
+        parent.finish_edit!
         parent.swt_widget.removeAll
         model_collection.each do |model|
           table_item = TableItem.new(parent.swt_widget, SWT::SWTProxy[:none])

data/lib/glimmer/data_binding/widget_binding.rb

@@ -1,6 +1,5 @@
-require 'glimmer'
-require_relative 'observable'
-require_relative 'observer'
+require 'glimmer/data_binding/observable'
+require 'glimmer/data_binding/observer'
 
 module Glimmer
   module DataBinding
@@ -10,10 +9,10 @@ module Glimmer
       include Observer
 
       attr_reader :widget, :property
-      def initialize(model, property, translator = nil)
-        @widget = model
+      def initialize(widget, property, translator = nil)
+        @widget = widget
         @property = property
-        @translator = translator || proc {|value| value}
+        @translator = translator || proc {|value| value} #TODO check on this it doesn't seem used
 
         if @widget.respond_to?(:dispose)
           @widget.on_widget_disposed do |dispose_event|
@@ -21,10 +20,12 @@ module Glimmer
           end
         end
       end
+      
       def call(value)
         converted_value = translated_value = @translator.call(value)
         @widget.set_attribute(@property, converted_value) unless evaluate_property == converted_value
       end
+      
       def evaluate_property
         @widget.get_attribute(@property)
       end

data/lib/glimmer/dsl/swt/dnd_expression.rb

@@ -0,0 +1,25 @@
+require 'glimmer/dsl/static_expression'
+require 'glimmer/swt/dnd_proxy'
+
+# TODO consider turning static keywords like bind into methods
+
+module Glimmer
+  module DSL
+    module SWT
+      # Responsible for returning DND constant values
+      #
+      # Named DndExpression (not DNDExpression) so that the DSL engine
+      # discovers quickly by convention
+      class DndExpression < StaticExpression
+        def can_interpret?(parent, keyword, *args, &block)
+          block.nil? &&
+            args.size > 0
+        end
+  
+        def interpret(parent, keyword, *args, &block)
+          Glimmer::SWT::DNDProxy[*args]
+        end
+      end
+    end
+  end
+end

data/lib/glimmer/dsl/swt/message_box_expression.rb

@@ -14,10 +14,6 @@ module Glimmer
 
         include_package 'org.eclipse.swt.widgets'
 
-        def can_interpret?(parent, keyword, *args, &block)
-          keyword == 'message_box'
-        end
-
         def interpret(parent, keyword, *args, &block)
           potential_parent = args.first
           parent = args.shift if potential_parent.is_a?(Shell) || (potential_parent.respond_to?(:swt_widget) && potential_parent.swt_widget.is_a?(Shell))

data/lib/glimmer/launcher.rb

@@ -33,7 +33,7 @@ module Glimmer
       This runs the Glimmer application samples/hello_world.rb
     MULTI_LINE_STRING
 
-    GLIMMER_LIB_LOCAL = File.expand_path(File.join(__FILE__, '..', '..', 'glimmer-dsl-swt.rb'))
+    GLIMMER_LIB_LOCAL = File.expand_path(File.join('lib', 'glimmer-dsl-swt.rb'))
     GLIMMER_LIB_GEM = 'glimmer-dsl-swt'
     GLIMMER_OPTIONS = %w[--log-level --quiet]
     GLIMMER_OPTION_ENV_VAR_MAPPING = {

data/lib/glimmer/package.rb

@@ -1,5 +1,7 @@
 require 'os'
 
+# TODO refactor to nest under RakeTask namespace
+
 module Glimmer
   module Package
     class << self

data/lib/glimmer/rake_task.rb

@@ -59,4 +59,26 @@ namespace :glimmer do
       Scaffold.custom_widget_gem(args[:custom_widget_name], args[:namespace])
     end
   end
+  
+  namespace :list do
+    task :list_require do
+      require_relative 'rake_task/list'
+    end
+  
+    desc 'List Glimmer custom widget gems available at rubygems.org (query is optional)'
+    task :custom_widget_gems, [:query] => :list_require do |t, args|
+      Glimmer::RakeTask::List.custom_widget_gems(args[:query])
+    end
+    
+    desc 'List Glimmer custom shell gems available at rubygems.org (query is optional)'
+    task :custom_shell_gems, [:query] => :list_require do |t, args|
+      Glimmer::RakeTask::List.custom_shell_gems(args[:query])
+    end
+    
+    desc 'List Glimmer DSL gems available at rubygems.org (query is optional)'
+    task :dsl_gems, [:query] => :list_require do |t, args|
+      Glimmer::RakeTask::List.dsl_gems(args[:query])
+    end
+    
+  end
 end

data/lib/glimmer/rake_task/list.rb

@@ -0,0 +1,73 @@
+require 'facets'
+require 'text-table'
+
+module Glimmer
+  module RakeTask
+    # Lists Glimmer related gems to use in rake_task.rb
+    class List
+      class << self
+        REGEX_GEM_LINE = /^([^\(]+) \(([^\)]+)\)$/
+        
+        def custom_widget_gems(query=nil)
+          list_gems('glimmer-cw-', query) do |result|
+            puts
+            puts "  Glimmer Custom Widget Gems#{" matching [#{query}]" if query} at rubygems.org:"
+            puts result
+          end
+        end
+
+        def custom_shell_gems(query=nil)
+          list_gems('glimmer-cs-', query) do |result|
+            puts
+            puts "  Glimmer Custom Shell Gems#{" matching [#{query}]" if query} at rubygems.org:"
+            puts result
+          end
+        end
+
+        def dsl_gems(query=nil)
+          list_gems('glimmer-dsl-', query) do |result|
+            puts
+            puts "  Glimmer DSL Gems#{" matching [#{query}]" if query} at rubygems.org:"
+            puts result
+          end
+        end
+        
+        def list_gems(gem_prefix, query=nil, &printer)
+          lines = `gem search -d #{gem_prefix}`.split("\n")
+          gems = lines.slice_before {|l| l.match(REGEX_GEM_LINE) }.to_a
+          gems = gems.map do |gem|
+            {            
+              name: gem[0].match(REGEX_GEM_LINE)[1],
+              version: gem[0].match(REGEX_GEM_LINE)[2],
+              author: gem[1].strip,
+              description: gem[4..-1].map(&:strip).join(' ')
+            }
+          end.select do |gem|
+            query.nil? || "#{gem[:name]} #{gem[:author]} #{gem[:description]}".downcase.include?(query.to_s.downcase)
+          end
+          printer.call(tablify(gem_prefix, gems))
+        end
+        
+        def tablify(gem_prefix, gems)
+          array_of_arrays = gems.map do |gem|
+            [
+              gem[:name].sub(gem_prefix, '').underscore.titlecase,
+              gem[:name],
+              gem[:version],
+              gem[:author].sub('Author: ', ''),
+              gem[:description],
+            ]
+          end
+          Text::Table.new(
+            :head => %w[Name Gem Version Author Description],
+            :rows => array_of_arrays,
+            :horizontal_padding    => 1,
+            :vertical_boundary     => ' ',
+            :horizontal_boundary   => ' ',
+            :boundary_intersection => ' '
+          )
+        end
+      end
+    end
+  end
+end

data/lib/glimmer/scaffold.rb

@@ -2,6 +2,8 @@ require 'fileutils'
 require 'os'
 require 'facets'
 
+# TODO refactor to nest under RakeTask namespace
+
 class Scaffold
   class << self
     include FileUtils
@@ -155,7 +157,6 @@ class Scaffold
       end
       mkdir 'bin'
       write "bin/#{file_name(app_name)}", app_bin_file(app_name)
-      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,14 +194,14 @@ class Scaffold
       write '.ruby-gemset', gem_name
       write 'VERSION', '1.0.0'
       write 'Gemfile', GEMFILE_GEM      
-      write 'Rakefile', gem_rakefile(custom_shell_name, namespace)
+      write 'Rakefile', gem_rakefile(custom_shell_name, namespace, gem_name)
       append "lib/#{gem_name}.rb", gem_main_file(custom_shell_name, namespace)
       mkdir 'lib/views'
       custom_shell(custom_shell_name, namespace, :gem)
       mkdir 'bin'
       write "bin/#{gem_name}", gem_bin_file(gem_name, custom_shell_name, namespace)
       write "bin/#{file_name(custom_shell_name)}", gem_bin_command_file(gem_name)
-      FileUtils.chmod 0755, "bin/#{file_name(custom_shell_name)}"      
+      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"
@@ -317,8 +318,6 @@ class Scaffold
 
     def app_bin_file(app_name)
       <<~MULTI_LINE_STRING
-        #!/usr/bin/env ruby
-        
         require_relative '../app/#{file_name(app_name)}'
         
         #{class_name(app_name)}.new.open
@@ -327,8 +326,6 @@ class Scaffold
 
     def gem_bin_file(gem_name, custom_shell_name, namespace)
       <<~MULTI_LINE_STRING
-        #!/usr/bin/env ruby
-        
         require_relative '../lib/#{gem_name}'
         
         include Glimmer
@@ -349,7 +346,7 @@ class Scaffold
       MULTI_LINE_STRING
     end
 
-    def gem_rakefile(custom_shell_name = nil, namespace = nil)
+    def gem_rakefile(custom_shell_name = nil, namespace = nil, gem_name = nil)
       rakefile_content = File.read('Rakefile')
       lines = rakefile_content.split("\n")
       require_rake_line_index = lines.index(lines.detect {|l| l.include?("require 'rake'") })
@@ -357,7 +354,7 @@ class Scaffold
       gem_files_line_index = lines.index(lines.detect {|l| l.include?('# dependencies defined in Gemfile') })
       if custom_shell_name
         lines.insert(gem_files_line_index, "  gem.files = Dir['VERSION', 'LICENSE.txt', 'lib/**/*.rb', 'bin/**/*']")
-        lines.insert(gem_files_line_index+1, "  gem.executables = ['#{file_name(custom_shell_name)}']")
+        lines.insert(gem_files_line_index+1, "  gem.executables = ['#{gem_name}', '#{file_name(custom_shell_name)}']")
       else
         lines.insert(gem_files_line_index, "  gem.files = Dir['lib/**/*.rb']")
       end

data/lib/glimmer/swt/dnd_proxy.rb

@@ -0,0 +1,34 @@
+require 'glimmer/swt/style_constantizable'
+
+module Glimmer
+  module SWT
+    # Proxy for org.eclipse.swt.dnd.DND
+    #
+    # Follows the Proxy Design Pattern
+    class DNDProxy            
+      include StyleConstantizable      
+
+      class << self
+        JAVA_IMPORT = 'org.eclipse.swt.dnd.DND'
+        
+        java_import JAVA_IMPORT
+        
+        def constant_java_import 
+          JAVA_IMPORT
+        end
+
+        def constant_source_class
+          DND
+        end
+
+        def constant_value_none
+          DND::DROP_NONE
+        end
+        
+        def extra_styles
+          {}
+        end
+      end
+    end
+  end
+end