glimmer-dsl-opal 0.0.9 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b56026edb0b7ab096e2b972afcc99f2914db153e52fa52616859b44e86d0ad8c
-  data.tar.gz: aa94ad9ded4e7cac3ec706db46a012861e9c1e3a0d0026cdcc7833f43733eba0
+  metadata.gz: b86a4ab59fb47c8fd2e21c3f88d790942b19461e159b613edab602c250c0d9e7
+  data.tar.gz: 121b3220b1bdb4848ce065564f108bc03f0d8145a2e35d07936ed69f66d52e8a
 SHA512:
-  metadata.gz: 66e958ca4e486e0a33908fb21d72322c375da35774a86e0514898a50b214bff0ecd7e7f4f5ce930983394cf49d9386ddce45f9ddcc0eb5e0074c455e8ebb87c9
-  data.tar.gz: 9e57c5f9a2bb433f182e7f7ce392f19985796cd56f8f40bed01bfed2e7385a25b4bf3fb7b06c541dae0b77cda2a981ac71d2a094d21f0beede0f8867b3fd1333
+  metadata.gz: e5a6fd8bb27c826ffbfa8baf5a0ab006f5756125eae25cea4fd08911c65736899520c8bbe1fafa6e1e9941ad1902dc90a62630170a2c0afec9f0420e4ec3911c
+  data.tar.gz: dfb9b7195d02486125efff51d9abb1c3c14ba62e9450f597d1508418155962eef0e00a7e2149f501de0f5fdf589fc4c71038392b743c42a43b9c83e914264462

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change Log
 
+## 0.1.0
+
+- Code redesign to better match the glimmer-dsl-swt APIs
+- opal-jquery refactoring
+- opal-rspec test coverage
+
 ## 0.0.9
 
 - Upgraded to glimmer gem v0.9.3

data/README.md

@@ -1,10 +1,18 @@
-# <img src="https://raw.githubusercontent.com/AndyObtiva/glimmer/master/images/glimmer-logo-hi-res.png" height=65 /> Glimmer DSL for Opal 0.0.9 (Webify Desktop Apps)
+# [<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 Opal 0.0.9 (Webify 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 DSL for Opal is an experimental web GUI adaptor for [Glimmer](https://github.com/AndyObtiva/glimmer) desktop apps (i.e. apps built with [Glimmer](https://github.com/AndyObtiva/glimmer) [DSL for SWT](https://github.com/AndyObtiva/glimmer-dsl-swt)). It webifies them via [Rails](https://rubyonrails.org/) and [Opal](https://opalrb.com/), allowing Ruby desktop apps to run on the web without changing a line of code. Apps may then be custom-styled for the web via standard CSS.
+[Glimmer](https://github.com/AndyObtiva/glimmer) DSL for [Opal](https://opalrb.com/) is an experimental proof-of-concept web GUI adaptor for [Glimmer](https://github.com/AndyObtiva/glimmer) desktop apps (i.e. apps built with [Glimmer DSL for SWT](https://github.com/AndyObtiva/glimmer-dsl-swt)). It webifies them via [Rails](https://rubyonrails.org/) and [Opal](https://opalrb.com/), allowing Ruby desktop apps to run on the web without changing a line of code. Apps may then be custom-styled for the web via standard CSS. 
 
-NOTE: Alpha Version 0.0.9 only supports bare-minimum capabilities for the following [glimmer-dsl-swt](https://github.com/AndyObtiva/glimmer-dsl-swt) [samples](https://github.com/AndyObtiva/glimmer#samples):
+Glimmer DSL for Opal successfully reuses the entire [Glimmer](https://github.com/AndyObtiva/glimmer) core DSL engine in [Opal](https://opalrb.com/) Ruby, and as such inherits the full range of powerful Glimmer DSL [data-binding](https://github.com/AndyObtiva/glimmer#data-binding) capabilities, such as: 
+- `bind(model, property)` basic data-binding
+- `bind(model, property, computed_by: procs)` computed data-binding
+- `bind(model, property, on_read:, on_write:)` data-binding converters
+- `bind(model, property), column_properties(columns)` `table` data-binding
+- Automatically inferred `property_options` for `list` and `combo` data-binding
+- `observe(model, property)` free-form observing
+
+NOTE: Alpha Version 0.1.0 only supports bare-minimum capabilities for the following [glimmer-dsl-swt](https://github.com/AndyObtiva/glimmer-dsl-swt) [samples](https://github.com/AndyObtiva/glimmer#samples):
 - [Hello, World!](#hello-world)
 - [Hello, Combo!](#hello-combo)
 - [Hello, Computed!](#hello-computed)
@@ -16,7 +24,7 @@ NOTE: Alpha Version 0.0.9 only supports bare-minimum capabilities for the follow
 - [Tic Tac Toe](#tic-tac-toe)
 - [Contact Manager](#contact-manager)
 
-Other Glimmer DSL gems:
+Other [Glimmer](https://github.com/AndyObtiva/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)
@@ -49,10 +57,11 @@ The following keywords from [glimmer-dsl-swt](https://github.com/AndyObtiva/glim
 
 - Rails 5: [https://github.com/rails/rails/tree/5-2-stable](https://github.com/rails/rails/tree/5-2-stable)
 - Opal 1: [https://github.com/opal/opal-rails](https://github.com/opal/opal-rails)
+- jQuery 3: [https://code.jquery.com/](https://code.jquery.com/) (jQuery 3.5.1 is included in the glimmer-dsl-opal rubygem)
 
 ## Setup
 
-(NOTE: if you run into issues, they are probably fixed in master or development/wip branch, you may check out instead)
+(NOTE: if you run into issues, keep in mind this is a very early experimental and incomplete alpha. Also, there is a slight chance issues you encounter are fixed in master or some other branch that you could check out instead)
 
 Please install a Rails 5 gem (e.g. `gem install rails -v5.2.4.3` )
 
@@ -67,8 +76,10 @@ Add the following to `Gemfile`:
 ```
 gem 'opal-rails', '~> 1.1.2'
 gem 'opal-async', '~> 1.1.0'
-gem 'opal-browser', '~> 0.2.0'
-gem 'glimmer-dsl-opal', '~> 0.0.9', require: false
+gem 'opal-jquery', '~> 0.4.4'
+gem 'glimmer-dsl-opal', '~> 0.1.0', require: false
+gem 'glimmer-dsl-xml', '~> 0.1.0', require: false
+
 ```
 
 Follow (opal-rails)[https://github.com/opal/opal-rails] instructions, basically the configuration of: config/initializers/assets.rb
@@ -84,10 +95,18 @@ Add the following line to the top of an empty `app/assets/javascripts/applicatio
 require 'glimmer-dsl-opal' # brings opal and opal browser too
 ```
 
-Add more code to `app/assets/javascripts/application.rb` from one of the samples below or require a [Glimmer](https://github.com/AndyObtiva/glimmer) app/[custom-shell](https://github.com/AndyObtiva/glimmer#custom-shell-gem) gem.
+Add more code to `app/assets/javascripts/application.rb` inside `Document.ready? do; end` block from one of the samples below or require a [Glimmer](https://github.com/AndyObtiva/glimmer) app/[custom-shell](https://github.com/AndyObtiva/glimmer#custom-shell-gem) gem.
 
 ## Samples
 
+Make sure to add any `require` statements or code below inside:
+
+```ruby
+Document.ready? do
+# Code goes here.
+end
+```
+
 ### Hello Samples
 
 #### Hello, World!
@@ -230,15 +249,15 @@ class HelloComputed
 
   def initialize
     @contact = Contact.new(
-      first_name: "Barry",
-      last_name: "McKibbin",
+      first_name: 'Barry',
+      last_name: 'McKibbin',
       year_of_birth: 1985
     )
   end
 
   def launch
     shell {
-      text "Hello Computed"
+      text 'Hello, Computed!'
       composite {
         grid_layout {
           num_columns 2
@@ -246,44 +265,44 @@ class HelloComputed
           horizontal_spacing 20
           vertical_spacing 10
         }
-        label {text "First &Name: "}
+        label {text 'First &Name: '}
         text {
           text bind(@contact, :first_name)
           layout_data {
-            horizontalAlignment :fill
-            grabExcessHorizontalSpace true
+            horizontal_alignment :fill
+            grab_excess_horizontal_space true
           }
         }
-        label {text "&Last Name: "}
+        label {text '&Last Name: '}
         text {
           text bind(@contact, :last_name)
           layout_data {
-            horizontalAlignment :fill
-            grabExcessHorizontalSpace true
+            horizontal_alignment :fill
+            grab_excess_horizontal_space true
           }
         }
-        label {text "&Year of Birth: "}
+        label {text '&Year of Birth: '}
         text {
           text bind(@contact, :year_of_birth)
           layout_data {
-            horizontalAlignment :fill
-            grabExcessHorizontalSpace true
+            horizontal_alignment :fill
+            grab_excess_horizontal_space true
           }
         }
-        label {text "Name: "}
+        label {text 'Name: '}
         label {
           text bind(@contact, :name, computed_by: [:first_name, :last_name])
           layout_data {
-            horizontalAlignment :fill
-            grabExcessHorizontalSpace true
+            horizontal_alignment :fill
+            grab_excess_horizontal_space true
           }
         }
-        label {text "Age: "}
+        label {text 'Age: '}
         label {
           text bind(@contact, :age, on_write: :to_i, computed_by: [:year_of_birth])
           layout_data {
-            horizontalAlignment :fill
-            grabExcessHorizontalSpace true
+            horizontal_alignment :fill
+            grab_excess_horizontal_space true
           }
         }
       }
@@ -1344,6 +1363,10 @@ Glimmer DSL for Opal Contact Manager Edit Done
 
 ![Glimmer DSL for Opal Contact Manager Edit Done](images/glimmer-dsl-opal-contact-manager-edit-done.png)
 
+## Sample App
+
+[https://github.com/AndyObtiva/sample-glimmer-dsl-opal-rails5-app](https://github.com/AndyObtiva/sample-glimmer-dsl-opal-rails5-app)
+
 ## Help
 
 ### Issues
@@ -1378,5 +1401,11 @@ These features have been suggested. You might see them in a future version of Gl
 
 ## License
 
-Copyright (c) 2020 Andy Maleh.
-See LICENSE.txt for further details.
+[MIT](https://opensource.org/licenses/MIT)
+
+Copyright (c) 2020 - Andy Maleh. 
+See [LICENSE.txt](LICENSE.txt) for further details.
+
+--
+
+[<img src="https://raw.githubusercontent.com/AndyObtiva/glimmer/master/images/glimmer-logo-hi-res.png" height=40 />](https://github.com/AndyObtiva/glimmer) Built for [Glimmer](https://github.com/AndyObtiva/glimmer) (Ruby Desktop Development GUI Library).

data/VERSION

@@ -1 +1 @@
-0.0.9
+0.1.0

data/lib/glimmer-dsl-opal.rb

@@ -1,13 +1,28 @@
 require 'opal'
-require 'opal-async'
-require 'browser'
-require 'browser/effects'
-require 'glimmer'
+if RUBY_PLATFORM == 'opal'
+  require 'opal-async'
+  require 'jquery' # included in glimmer-dsl-opal
+  require 'opal-jquery'
+  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'
-require 'glimmer/data_binding/ext/observable_model'
+  # Spiking async logging
+#   logger = Glimmer::Config.logger
+#   original_add_method = logger.class.instance_method(:add)
+#   logger.define_singleton_method("__original_add", original_add_method)
+#   logger.singleton_class.send(:define_method, :add) do |*args|
+#     Async::Timeout.new 10000 do
+#       __original_add(*args)
+#     end
+#   end  
+   
+  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'
+  require 'glimmer/data_binding/ext/observable_model'
+   
+  require 'glimmer-dsl-xml'
+  Element.alias_native :replace_with, :replaceWith
+end

data/lib/glimmer/data_binding/element_binding.rb

@@ -27,7 +27,7 @@ module Glimmer
         @element.set_attribute(@property, converted_value) unless evaluate_property == converted_value
       end
       
-      def evaluate_property
+      def evaluate_property        
         @element.send(@property)
       end
     end

data/lib/glimmer/data_binding/ext/observable_model.rb

@@ -24,10 +24,10 @@ module Glimmer
             old_value = self.send(property_name)
             unregister_dependent_observers(property_name, old_value)
             self.send("__original_#{property_writer_name}", value)
-            Glimmer::Opal::DisplayProxy.instance.async_exec do
-              notify_observers(property_name)
-              ensure_array_object_observer(property_name, value, old_value)
-            end
+#             Glimmer::Opal::DisplayProxy.instance.async_exec do
+            notify_observers(property_name)
+            ensure_array_object_observer(property_name, value, old_value)
+#             end
           end
         end
       rescue => e

data/lib/glimmer/data_binding/list_selection_binding.rb

@@ -39,7 +39,7 @@ module Glimmer
       end
 
       def call(value)
-        PROPERTY_TYPE_UPDATERS[@property_type].call(@element_proxy, value) unless evaluate_property == value
+        PROPERTY_TYPE_UPDATERS[@property_type].call(@element_proxy, value) unless !evaluate_property.is_a?(Array) && evaluate_property == value
       end
 
       def evaluate_property

data/lib/glimmer/data_binding/table_items_binding.rb

@@ -2,8 +2,8 @@ require 'glimmer/data_binding/observable_array'
 require 'glimmer/data_binding/observable_model'
 require 'glimmer/data_binding/observable'
 require 'glimmer/data_binding/observer'
-require 'glimmer/opal/table_proxy'
-require 'glimmer/opal/table_item'
+require 'glimmer/swt/table_proxy'
+require 'glimmer/swt/table_item_proxy'
 
 module Glimmer
   module DataBinding
@@ -47,7 +47,7 @@ module Glimmer
         old_item_ids_per_model = old_items.reduce({}) {|hash, item| hash.merge(item.get_data.hash => item.id) }
         parent.remove_all
         model_collection.each do |model|
-          table_item = Glimmer::Opal::TableItem.new(parent)
+          table_item = Glimmer::SWT::TableItemProxy.new(parent)
           for index in 0..(column_properties.size-1)
             table_item.set_text(index, model.send(column_properties[index]).to_s)
           end

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

@@ -1,5 +1,5 @@
 require 'glimmer/dsl/static_expression'
-require 'glimmer/opal/table_proxy'
+require 'glimmer/swt/table_proxy'
 
 module Glimmer
   module DSL
@@ -10,7 +10,7 @@ module Glimmer
         def can_interpret?(parent, keyword, *args, &block)
           keyword == 'column_properties' and
             block.nil? and
-            parent.is_a?(Glimmer::Opal::TableProxy)
+            parent.is_a?(Glimmer::SWT::TableProxy)
         end
   
         def interpret(parent, keyword, *args, &block)

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

@@ -1,7 +1,7 @@
 require 'glimmer/dsl/expression'
 require 'glimmer/data_binding/model_binding'
 require 'glimmer/data_binding/element_binding'
-require 'glimmer/opal/select_proxy'
+require 'glimmer/swt/combo_proxy'
 
 module Glimmer
   module DSL
@@ -10,7 +10,7 @@ module Glimmer
         def can_interpret?(parent, keyword, *args, &block)
           keyword == 'selection' and
             block.nil? and
-            parent.is_a?(Glimmer::Opal::SelectProxy) and
+            parent.is_a?(Glimmer::SWT::ComboProxy) and
             args.size == 1 and
             args[0].is_a?(DataBinding::ModelBinding) and
             args[0].evaluate_options_property.is_a?(Array)

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

@@ -1,31 +1,18 @@
-require 'opal'
-require 'browser'
-
 require 'glimmer/dsl/engine'
 # Dir[File.expand_path('../*_expression.rb', __FILE__)].each {|f| require f}
 require 'glimmer/dsl/opal/shell_expression'
-require 'glimmer/dsl/opal/label_expression'
+require 'glimmer/dsl/opal/widget_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'
-require 'glimmer/dsl/opal/grid_layout_expression'
-require 'glimmer/dsl/opal/text_expression'
-require 'glimmer/dsl/opal/list_expression'
-require 'glimmer/dsl/opal/browser_expression'
-require 'glimmer/dsl/opal/tab_folder_expression'
-require 'glimmer/dsl/opal/tab_item_expression'
 require 'glimmer/dsl/opal/message_box_expression'
 require 'glimmer/dsl/opal/async_exec_expression'
 require 'glimmer/dsl/opal/observe_expression'
+require 'glimmer/dsl/opal/layout_expression'
 require 'glimmer/dsl/opal/layout_data_expression'
 require 'glimmer/dsl/opal/list_selection_data_binding_expression'
-require 'glimmer/dsl/opal/table_expression'
-require 'glimmer/dsl/opal/table_column_expression'
 require 'glimmer/dsl/opal/table_items_data_binding_expression'
 require 'glimmer/dsl/opal/column_properties_expression'
 
@@ -40,8 +27,9 @@ module Glimmer
          combo_selection_data_binding
          list_selection_data_binding
          data_binding
-         text
+         layout
          property
+         widget
        ]
       )
     end

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

@@ -1,6 +1,6 @@
 require 'glimmer/dsl/static_expression'
 require 'glimmer/dsl/parent_expression'
-require 'glimmer/opal/layout_data_proxy'
+require 'glimmer/swt/layout_data_proxy'
 
 module Glimmer
   module DSL
@@ -9,7 +9,7 @@ module Glimmer
         include ParentExpression
 
         def interpret(parent, keyword, *args, &block)
-          Glimmer::Opal::LayoutDataProxy.new(parent, args)
+          Glimmer::SWT::LayoutDataProxy.new(parent, args)
         end
       end
     end

data/lib/glimmer/dsl/opal/{text_expression.rb → layout_expression.rb}

@@ -1,20 +1,20 @@
 require 'glimmer/dsl/expression'
 require 'glimmer/dsl/parent_expression'
-require 'glimmer/opal/input_proxy'
+require 'glimmer/swt/layout_proxy'
 
 module Glimmer
   module DSL
     module Opal
-      class TextExpression < Expression
+      class LayoutExpression < Expression
         include ParentExpression
 
         def can_interpret?(parent, keyword, *args, &block)
-          keyword == 'text' and parent and block_given?
+          parent.is_a?(Glimmer::SWT::CompositeProxy) &&
+            Glimmer::SWT::LayoutProxy.layout_exists?(keyword)
         end
 
         def interpret(parent, keyword, *args, &block)
-          args << {type: 'text'}
-          Glimmer::Opal::InputProxy.new(parent, args)
+          Glimmer::SWT::LayoutProxy.for(keyword, parent, args)
         end
       end
     end

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

@@ -2,7 +2,7 @@ require 'glimmer/dsl/expression'
 require 'glimmer/data_binding/model_binding'
 require 'glimmer/data_binding/element_binding'
 require 'glimmer/data_binding/list_selection_binding'
-require 'glimmer/opal/list_proxy'
+require 'glimmer/swt/list_proxy'
 
 module Glimmer
   module DSL
@@ -11,7 +11,7 @@ module Glimmer
         def can_interpret?(parent, keyword, *args, &block)
           keyword == 'selection' and
             block.nil? and
-            parent.is_a?(Glimmer::Opal::ListProxy) and
+            parent.is_a?(Glimmer::SWT::ListProxy) and
             args.size == 1 and
             args[0].is_a?(DataBinding::ModelBinding) and
             args[0].evaluate_options_property.is_a?(Array)
@@ -31,7 +31,6 @@ module Glimmer
           list_selection_binding.call(model_binding.evaluate_property)
           #TODO check if nested data binding works for list widget and other widgets that need custom data binding
           list_selection_binding.observe(model, model_binding.property_name_expression)
-  
           parent.on_widget_selected do
             model_binding.call(list_selection_binding.evaluate_property)
           end