glimmer-dsl-opal 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 67893f26592de179a00e15688b7814762edd60ff1c036b1389d177437ffaae5d
-  data.tar.gz: 2a6362729a7ecbe86231f2bcab62e25a46caadee1dc82c7f8abd84180d437ea2
+  metadata.gz: 43ffbba379c5bade234cf2a2263be49565bff77120e7449e17ea7095461520c5
+  data.tar.gz: 990340e899f8bf37a98ea0ea4e78941ccb48e4e55e0faddbb2b4ea7d010c8c0c
 SHA512:
-  metadata.gz: f8ac369bb79fcd6b8b5c46ba357f807d393e99e49303f4d983efb9a1b54551a51a2b80536b2da1111097ce9ed912ae7f7ae6d7968778ade6cd0ec13f1b45e3f3
-  data.tar.gz: 517dbe5aa02c3c6027e9aca9be18c88a60c99c19c362dab098aa0ddb18c42faed884d0e6815a5cb7889fbec1f55c0e19543c843773f1e8720489baad07a7af73
+  metadata.gz: 49e2e4d81cf84643f7e645ce30c474a0262c11bebd7f708db25068fc4fd6acb53d7e98779c028b2d459165749523444ecf7a0fb4de653bc2a6c6409b05f606d9
+  data.tar.gz: 68179f29cc621c861c6243ef2dc54dff6558be4f394c0ab7bb47c0cffe683fe77cf1e3fdbc5f00b7c8646bdfb6cd7580bed4162e88353149be003bad32ce34ea

data/README.md

@@ -1,20 +1,23 @@
-# Glimmer DSL for Opal 0.0.1 Beta (Web GUI for Desktop Apps)
+
+# Glimmer DSL for Opal 0.0.2 Alpha (Web GUI for Desktop Apps)
 [![Gem Version](https://badge.fury.io/rb/glimmer-dsl-opal.svg)](http://badge.fury.io/rb/glimmer-dsl-opal)
+[![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 Opal is a web GUI adaptor for desktop apps built with [Glimmer DSL for SWT](https://github.com/AndyObtiva/glimmer-dsl-swt).
+[Glimmer](https://github.com/AndyObtiva/glimmer) DSL for Opal is a web GUI adaptor for desktop apps built with [Glimmer](https://github.com/AndyObtiva/glimmer) & [Glimmer DSL for SWT](https://github.com/AndyObtiva/glimmer-dsl-swt).
 
 It enables running [Glimmer](https://github.com/AndyObtiva/glimmer) desktop apps on the web via [Rails](https://rubyonrails.org/) 5 and [Opal](https://opalrb.com/) 1.
 
-NOTE: Version 0.0.1 only supports Hello, World! capabilities.
+NOTE: Alpha Version 0.0.2 only supports Hello, World! and Hello, Combo! capabilities.
 
-## Examples
+Other Glimmer DSL gems:
+- [glimmer-dsl-swt](https://github.com/AndyObtiva/glimmer-dsl-swt): Glimmer DSL for SWT (Desktop GUI)
+- [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)
 
-### Hello, World!
+## Hello, World!
 
-Glimmer code (from `samples/hello/hello_world.rb`):
+Glimmer code (from SWT desktop app sample [`samples/hello/hello_world.rb`](https://github.com/AndyObtiva/glimmer-dsl-swt/blob/master/samples/hello/hello_world.rb)):
 ```ruby
-require 'glimmer-dsl-opal'
-
 include Glimmer
 
 shell {
@@ -25,18 +28,23 @@ shell {
 }.open
 ```
 
-Run:
-```
-glimmer samples/hello/hello_world.rb
-```
+Glimmer app on the desktop (using [`glimmer-dsl-swt`](https://github.com/AndyObtiva/glimmer-dsl-swt) gem):
+
+![Glimmer DSL for Opal Hello World](https://github.com/AndyObtiva/glimmer/blob/master/images/glimmer-hello-world.png)
 
-Glimmer app:
+Glimmer app on the web (using `glimmer-dsl-opal` gem):
 
 ![Glimmer DSL for Opal Hello World](images/glimmer-dsl-opal-hello-world.png)
 
-## Background
+## Supported Widgets
 
-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.
+The following keywords from [glimmer-dsl-swt](https://github.com/AndyObtiva/glimmer-dsl-swt) have partial support in Opal:
+
+- `shell`
+- `label`
+- `combo`
+- `button`
+- `composite` (single-column `grid_layout` only)
 
 ## Pre-requisites
 
@@ -59,7 +67,7 @@ Add the following to `Gemfile`:
 ```
 gem 'opal-rails'
 gem 'opal-browser'
-gem 'glimmer-dsl-opal', '~> 0.0.1', require: false
+gem 'glimmer-dsl-opal', '~> 0.0.2', require: false
 ```
 
 Edit `config/initializers/assets.rb` and add:
@@ -67,6 +75,10 @@ Edit `config/initializers/assets.rb` and add:
 Opal.use_gem 'glimmer-dsl-opal'
 ```
 
+## Examples
+
+### Hello, World!
+
 Add the following Glimmer code to `app/assets/javascripts/application.js.rb`
 
 ```ruby
@@ -82,6 +94,12 @@ shell {
 }
 ```
 
+Glimmer app on the desktop (using [`glimmer-dsl-swt`](https://github.com/AndyObtiva/glimmer-dsl-swt) gem):
+
+![Glimmer DSL for Opal Hello World](https://github.com/AndyObtiva/glimmer/blob/master/images/glimmer-hello-world.png)
+
+Glimmer app on the web (using `glimmer-dsl-opal` gem):
+
 Start the Rails server:
 ```
 rails s
@@ -93,6 +111,65 @@ You should see "Hello, World!"
 
 ![Glimmer DSL for Opal Hello World](images/glimmer-dsl-opal-hello-world.png)
 
+### Hello, Combo!
+
+Add the following Glimmer code to `app/assets/javascripts/application.js.rb`
+
+```ruby
+require 'glimmer-dsl-opal' # brings opal and opal browser too
+
+class Person
+  attr_accessor :country, :country_options
+  
+  def initialize
+    self.country_options=["", "Canada", "US", "Mexico"]
+    self.country = "Canada"
+  end
+
+  def reset_country
+    self.country = "Canada"
+  end
+end
+
+class HelloCombo
+  include Glimmer
+  def launch
+    person = Person.new
+    shell {
+      composite {
+        combo(:read_only) {
+          selection bind(person, :country)
+        }
+        button {
+          text "Reset"
+          on_widget_selected do
+            person.reset_country
+          end
+        }
+      }
+    }.open
+  end
+end
+
+HelloCombo.new.launch
+```
+Glimmer app on the desktop (using [`glimmer-dsl-swt`](https://github.com/AndyObtiva/glimmer-dsl-swt) gem):
+
+![Glimmer DSL for Opal Hello Combo](https://github.com/AndyObtiva/glimmer/blob/master/images/glimmer-hello-combo.png)
+
+Glimmer app on the web (using `glimmer-dsl-opal` gem):
+
+Start the Rails server:
+```
+rails s
+```
+
+Visit `http://localhost:3000`
+
+You should see "Hello, Combo!"
+
+![Glimmer DSL for Opal Hello Combo](images/glimmer-dsl-opal-hello-combo.png)
+
 ## Help
 
 ### Issues
@@ -101,11 +178,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/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/lib/glimmer-dsl-opal.rb

@@ -1,8 +1,10 @@
-# if RUBY_ENGINE == 'opal' # or test if env is test
-  $LOAD_PATH.unshift(File.expand_path('..', __FILE__))
-  
-  require 'opal'
-  require 'glimmer'
-  
-  require 'glimmer/dsl/opal/dsl' 
-# end
+require 'opal'
+require 'opal-parser'
+require 'glimmer'
+
+GLIMMER_DSL_OPAL_ROOT = File.expand_path('../..', __FILE__)
+GLIMMER_DSL_OPAL_LIB = File.join(GLIMMER_DSL_OPAL_ROOT, 'lib')
+
+$LOAD_PATH.unshift(GLIMMER_DSL_OPAL_LIB)
+
+require 'glimmer/dsl/opal/dsl' 

data/lib/glimmer/data_binding/element_binding.rb

@@ -0,0 +1,35 @@
+require 'glimmer/data_binding/observable'
+require 'glimmer/data_binding/observer'
+
+module Glimmer
+  module DataBinding
+    class ElementBinding
+      include Glimmer
+      include Observable
+      include Observer
+
+      attr_reader :element, :property
+      def initialize(element, property, translator = nil)
+        @element = element
+        @property = property
+        @translator = translator || proc {|value| value}
+
+        # TODO see if this is needed in Opal
+#         if @element.respond_to?(:dispose)
+#           @element.on_widget_disposed do |dispose_event|
+#             unregister_all_observables
+#           end
+#         end
+      end
+      
+      def call(value)
+        converted_value = translated_value = @translator.call(value)
+        @element.send(@property + '=', converted_value) unless evaluate_property == converted_value
+      end
+      
+      def evaluate_property
+        @element.send(@property)
+      end
+    end
+  end
+end

data/lib/glimmer/data_binding/observable_element.rb

@@ -0,0 +1,14 @@
+module Glimmer
+  module DataBinding
+    module ObservableElement
+      def method_missing(method, *args, &block)
+        method_name = method.to_s
+        if method_name.start_with?('on_')
+          handle_observation_request(method_name, &block)
+        else
+          super
+        end
+      end
+    end
+  end
+end

data/lib/glimmer/dsl/opal/bind_expression.rb

@@ -0,0 +1,37 @@
+require 'glimmer/dsl/static_expression'
+require 'glimmer/data_binding/model_binding'
+
+module Glimmer
+  module DSL
+    module Opal
+      # Responsible for setting up the return value of the bind keyword (command symbol)
+      # as a ModelBinding. It is then used by another command handler like
+      # DataBindingCommandHandler for text and selection properties on Text and Spinner
+      # or TableItemsDataBindingCommandHandler for items in a Table
+      class BindExpression < StaticExpression
+        def can_interpret?(parent, keyword, *args, &block)
+          (
+            keyword == 'bind' and
+              (
+                (
+                  (args.size == 2) and
+                    textual?(args[1])
+                ) ||
+                  (
+                    (args.size == 3) and
+                      textual?(args[1]) and
+                      (args[2].is_a?(Hash))
+                  )
+              )
+          )
+        end
+  
+        def interpret(parent, keyword, *args, &block)
+          binding_options = args[2] || {}
+          binding_options[:on_read] = binding_options.delete(:on_read) || binding_options.delete('on_read') || block
+          DataBinding::ModelBinding.new(args[0], args[1].to_s, binding_options)
+        end
+      end
+    end
+  end
+end

data/lib/glimmer/dsl/opal/button_expression.rb

@@ -0,0 +1,17 @@
+require 'glimmer/dsl/static_expression'
+require 'glimmer/dsl/parent_expression'
+require 'glimmer/opal/input_proxy'
+
+module Glimmer
+  module DSL
+    module Opal
+      class ButtonExpression < StaticExpression
+        include ParentExpression
+
+        def interpret(parent, keyword, *args, &block)
+          Glimmer::Opal::InputProxy.new(parent, args)
+        end
+      end
+    end
+  end
+end

data/lib/glimmer/dsl/opal/combo_expression.rb

@@ -0,0 +1,17 @@
+require 'glimmer/dsl/static_expression'
+require 'glimmer/dsl/parent_expression'
+require 'glimmer/opal/select_proxy'
+
+module Glimmer
+  module DSL
+    module Opal
+      class ComboExpression < StaticExpression
+        include ParentExpression
+
+        def interpret(parent, keyword, *args, &block)
+          Glimmer::Opal::SelectProxy.new(parent, args)
+        end
+      end
+    end
+  end
+end

data/lib/glimmer/dsl/opal/combo_selection_data_binding_expression.rb

@@ -0,0 +1,40 @@
+require 'glimmer/dsl/expression'
+require 'glimmer/data_binding/model_binding'
+require 'glimmer/data_binding/element_binding'
+require 'glimmer/opal/select_proxy'
+
+module Glimmer
+  module DSL
+    module Opal
+      class ComboSelectionDataBindingExpression < Expression  
+        def can_interpret?(parent, keyword, *args, &block)
+          keyword == 'selection' and
+            block.nil? and
+            parent.is_a?(Glimmer::Opal::SelectProxy) and
+            args.size == 1 and
+            args[0].is_a?(DataBinding::ModelBinding) and
+            args[0].evaluate_options_property.is_a?(Array)
+        end
+  
+        def interpret(parent, keyword, *args, &block)          
+          model_binding = args[0]
+  
+          #TODO make this options observer dependent and all similar observers in element specific data binding handlers
+          # TODO consider delegating some of this work
+          element_binding = DataBinding::ElementBinding.new(parent, 'items')
+          element_binding.call(model_binding.evaluate_options_property)
+          model = model_binding.base_model
+          element_binding.observe(model, model_binding.options_property_name)
+  
+          element_binding = DataBinding::ElementBinding.new(parent, 'text')
+          element_binding.call(model_binding.evaluate_property)
+          element_binding.observe(model, model_binding.property_name_expression)
+  
+          parent.on_widget_selected do
+            model_binding.call(element_binding.evaluate_property)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/glimmer/dsl/opal/composite_expression.rb

@@ -0,0 +1,17 @@
+require 'glimmer/dsl/static_expression'
+require 'glimmer/dsl/parent_expression'
+require 'glimmer/opal/div_proxy'
+
+module Glimmer
+  module DSL
+    module Opal
+      class CompositeExpression < StaticExpression
+        include ParentExpression
+
+        def interpret(parent, keyword, *args, &block)
+          Glimmer::Opal::DivProxy.new(parent, args)
+        end
+      end
+    end
+  end
+end

data/lib/glimmer/dsl/opal/data_binding_expression.rb

@@ -0,0 +1,34 @@
+require 'glimmer/dsl/expression'
+require 'glimmer/data_binding/model_binding'
+require 'glimmer/data_binding/element_binding'
+
+module Glimmer
+  module DSL
+    module Opal
+      # Responsible for wiring two-way data-binding for text and selection properties
+      # on Text, Button, and Spinner elements.
+      # Does so by using the output of the bind(model, property) command in the form
+      # of a ModelBinding, which is then connected to an anonymous element observer
+      # (aka element_data_binder as per element_data_binders array)
+      #
+      # Depends on BindCommandHandler
+      class DataBindingExpression < Expression
+        def can_interpret?(parent, keyword, *args, &block)
+          args.size == 1 and
+            args[0].is_a?(DataBinding::ModelBinding)
+        end
+  
+        def interpret(parent, keyword, *args, &block)
+          model_binding = args[0]
+          element_binding_parameters = [parent, keyword]
+          element_binding = DataBinding::ElementBinding.new(*element_binding_parameters)
+          element_binding.call(model_binding.evaluate_property)
+          #TODO make this options observer dependent and all similar observers in element specific data binding handlers
+          element_binding.observe(model_binding)
+          # TODO simplify this logic and put it where it belongs
+          parent.add_observer(model_binding, keyword) if parent.respond_to?(:add_observer, [model_binding, keyword])
+        end
+      end
+    end
+  end
+end

data/lib/glimmer/dsl/opal/dsl.rb

@@ -6,6 +6,13 @@ require 'glimmer/dsl/engine'
 require 'glimmer/dsl/opal/shell_expression'
 require 'glimmer/dsl/opal/label_expression'
 require 'glimmer/dsl/opal/property_expression'
+require 'glimmer/dsl/opal/combo_expression'
+require 'glimmer/dsl/opal/composite_expression'
+require 'glimmer/dsl/opal/button_expression'
+require 'glimmer/dsl/opal/bind_expression'
+# require 'glimmer/dsl/opal/data_binding_expression'
+require 'glimmer/dsl/opal/combo_selection_data_binding_expression'
+require 'glimmer/dsl/opal/widget_listener_expression'
 
 module Glimmer
   module DSL
@@ -13,6 +20,8 @@ module Glimmer
       Engine.add_dynamic_expressions(
        Opal,
        %w[
+         widget_listener
+         combo_selection_data_binding
          property
        ]
       )