glimmer-dsl-web 0.0.4 → 0.0.6

data/VERSION

@@ -1 +1 @@
-0.0.4
+0.0.6

data/glimmer-dsl-web.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: glimmer-dsl-web 0.0.4 ruby lib
+# stub: glimmer-dsl-web 0.0.6 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "glimmer-dsl-web".freeze
-  s.version = "0.0.4".freeze
+  s.version = "0.0.6".freeze
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Andy Maleh".freeze]
-  s.date = "2023-12-30"
+  s.date = "2024-01-01"
   s.description = "Glimmer DSL for Web (Ruby in the Browser Web GUI Frontend Library) - Enables frontend GUI development with Ruby by adopting a DSL that follows web-like HTML syntax, enabling the transfer of HTML/CSS/JS skills to Ruby frontend development. This library relies on Opal Ruby.".freeze
   s.email = "andy.am@gmail.com".freeze
   s.extra_rdoc_files = [
@@ -31,18 +31,26 @@ Gem::Specification.new do |s|
     "lib/glimmer-dsl-web/ext/date.rb",
     "lib/glimmer-dsl-web/ext/exception.rb",
     "lib/glimmer-dsl-web/samples/hello/hello_button.rb",
+    "lib/glimmer-dsl-web/samples/hello/hello_data_binding.rb",
+    "lib/glimmer-dsl-web/samples/hello/hello_form.rb",
     "lib/glimmer-dsl-web/samples/hello/hello_world.rb",
     "lib/glimmer-dsl-web/vendor/jquery.js",
     "lib/glimmer/config/opal_logger.rb",
     "lib/glimmer/data_binding/element_binding.rb",
-    "lib/glimmer/data_binding/observable_element.rb",
+    "lib/glimmer/dsl/web/bind_expression.rb",
+    "lib/glimmer/dsl/web/data_binding_expression.rb",
     "lib/glimmer/dsl/web/dsl.rb",
     "lib/glimmer/dsl/web/element_expression.rb",
+    "lib/glimmer/dsl/web/general_element_expression.rb",
     "lib/glimmer/dsl/web/listener_expression.rb",
+    "lib/glimmer/dsl/web/p_expression.rb",
     "lib/glimmer/dsl/web/property_expression.rb",
+    "lib/glimmer/dsl/web/select_expression.rb",
+    "lib/glimmer/dsl/web/shine_data_binding_expression.rb",
     "lib/glimmer/util/proc_tracker.rb",
     "lib/glimmer/web.rb",
     "lib/glimmer/web/element_proxy.rb",
+    "lib/glimmer/web/event_proxy.rb",
     "lib/glimmer/web/listener_proxy.rb",
     "lib/glimmer/web/property_owner.rb"
   ]
@@ -58,7 +66,6 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency(%q<glimmer-dsl-css>.freeze, ["~> 1.2.2".freeze])
   s.add_runtime_dependency(%q<opal-async>.freeze, ["~> 1.4.0".freeze])
   s.add_runtime_dependency(%q<to_collection>.freeze, [">= 2.0.1".freeze, "< 3.0.0".freeze])
-  s.add_runtime_dependency(%q<pure-struct>.freeze, [">= 1.0.2".freeze, "< 2.0.0".freeze])
   s.add_development_dependency(%q<puts_debuggerer>.freeze, [">= 0".freeze])
   s.add_development_dependency(%q<rake>.freeze, [">= 10.1.0".freeze, "< 14.0.0".freeze])
   s.add_development_dependency(%q<rake-tui>.freeze, [">= 0".freeze])

data/lib/glimmer/data_binding/element_binding.rb

@@ -4,7 +4,6 @@ require 'glimmer/data_binding/observer'
 module Glimmer
   module DataBinding
     class ElementBinding
-      # TODO consider renaming to WidgetBinding since it's no longer dealing with elements directly yet widgets instead
       include Glimmer
       include Observable
       include Observer
@@ -15,7 +14,8 @@ module Glimmer
         @property = property
         @translator = translator || proc {|value| value}
 
-        # TODO see if this is needed in Opal
+        # TODO implement automatic cleanup upon calling element.remove
+        # Alternatively, have this be built into ElementProxy and remove this code
 #         if @element.respond_to?(:dispose)
 #           @element.on_widget_disposed do |dispose_event|
 #             unregister_all_observables
@@ -25,7 +25,7 @@ module Glimmer
       
       def call(value)
         converted_value = translated_value = @translator.call(value)
-        @element.set_attribute(@property, converted_value) unless evaluate_property == converted_value
+        @element.send("#{@property}=", converted_value) unless evaluate_property == converted_value
       end
       
       def evaluate_property

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

@@ -0,0 +1,36 @@
+# Copyright (c) 2023 Andy Maleh
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+require 'glimmer/dsl/static_expression'
+require 'glimmer/dsl/bind_expression'
+require 'glimmer/data_binding/model_binding'
+
+module Glimmer
+  module DSL
+    module Web
+      # Responsible for setting up the return value of the bind keyword (command symbol)
+      # as a ModelBinding. It is then used by other data-binding expressions
+      class BindExpression < StaticExpression
+        include Glimmer::DSL::BindExpression
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+require 'glimmer/dsl/expression'
+require 'glimmer/data_binding/model_binding'
+require 'glimmer/data_binding/element_binding'
+
+module Glimmer
+  module DSL
+    module Web
+      # 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) and
+            parent.respond_to?(:data_bind)
+        end
+  
+        def interpret(parent, keyword, *args, &block)
+          model_binding = args[0]
+          property = keyword
+          parent.data_bind(property, model_binding)
+        end
+      end
+    end
+  end
+end

data/lib/glimmer/dsl/web/dsl.rb

@@ -3,6 +3,11 @@ require 'glimmer/dsl/engine'
 require 'glimmer/dsl/web/element_expression'
 require 'glimmer/dsl/web/listener_expression'
 require 'glimmer/dsl/web/property_expression'
+require 'glimmer/dsl/web/p_expression'
+require 'glimmer/dsl/web/select_expression'
+require 'glimmer/dsl/web/bind_expression'
+require 'glimmer/dsl/web/data_binding_expression'
+require 'glimmer/dsl/web/shine_data_binding_expression'
 
 module Glimmer
   module DSL
@@ -19,7 +24,9 @@ module Glimmer
        Web,
        %w[
          listener
+         data_binding
          property
+         shine_data_binding
          element
        ]
       )

data/lib/glimmer/dsl/web/element_expression.rb

@@ -1,34 +1,16 @@
 require 'glimmer/dsl/expression'
-require 'glimmer/dsl/parent_expression'
-require 'glimmer/web/element_proxy'
+require 'glimmer/dsl/web/general_element_expression'
 
 module Glimmer
   module DSL
     module Web
       class ElementExpression < Expression
-        include ParentExpression
+        include GeneralElementExpression
         
         def can_interpret?(parent, keyword, *args, &block)
           # TODO automatically pass parent option as element if not passed instead of rejecting elements without a paraent nor root
           # TODO raise a proper error if root is an element that is not found (maybe do this in model)
-          !keyword.to_s.start_with?('on_')
-        end
-
-        def interpret(parent, keyword, *args, &block)
-          Glimmer::Web::ElementProxy.for(keyword, parent, args, block)
-        end
-        
-        def add_content(parent, keyword, *args, &block)
-          if parent.rendered? || parent.skip_content_on_render_blocks?
-            return_value = super(parent, keyword, *args, &block)
-            if return_value.is_a?(String) && parent.dom_element.text.to_s.empty?
-              parent.add_text_content(return_value)
-            end
-            parent.post_add_content
-            return_value
-          else
-            parent.add_content_on_render(&block)
-          end
+          !keyword.to_s.start_with?('on')
         end
       end
     end

data/lib/glimmer/dsl/web/general_element_expression.rb

@@ -0,0 +1,29 @@
+require 'glimmer/dsl/parent_expression'
+require 'glimmer/web/element_proxy'
+
+module Glimmer
+  module DSL
+    module Web
+      module GeneralElementExpression
+        include ParentExpression
+
+        def interpret(parent, keyword, *args, &block)
+          Glimmer::Web::ElementProxy.for(keyword, parent, args, block)
+        end
+        
+        def add_content(parent, keyword, *args, &block)
+          if parent.rendered? || parent.skip_content_on_render_blocks?
+            return_value = super(parent, keyword, *args, &block)
+            if return_value.is_a?(String) && parent.dom_element.text.to_s.empty?
+              parent.add_text_content(return_value)
+            end
+            parent.post_add_content
+            return_value
+          else
+            parent.add_content_on_render(&block)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/glimmer/dsl/web/p_expression.rb

@@ -0,0 +1,12 @@
+require 'glimmer/dsl/static_expression'
+require 'glimmer/dsl/web/general_element_expression'
+
+module Glimmer
+  module DSL
+    module Web
+      class PExpression < StaticExpression
+        include GeneralElementExpression
+      end
+    end
+  end
+end

data/lib/glimmer/dsl/web/select_expression.rb

@@ -0,0 +1,12 @@
+require 'glimmer/dsl/static_expression'
+require 'glimmer/dsl/web/general_element_expression'
+
+module Glimmer
+  module DSL
+    module Web
+      class SelectExpression < StaticExpression
+        include GeneralElementExpression
+      end
+    end
+  end
+end

data/lib/glimmer/dsl/web/shine_data_binding_expression.rb

@@ -0,0 +1,42 @@
+# Copyright (c) 2020-2022 Andy Maleh
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+require 'glimmer/dsl/expression'
+require 'glimmer/data_binding/model_binding'
+require 'glimmer/data_binding/shine'
+
+module Glimmer
+  module DSL
+    module Web
+      class ShineDataBindingExpression < Expression
+        def can_interpret?(parent, keyword, *args, &block)
+          args.size == 0 and
+            block.nil? and
+            (parent.respond_to?("#{keyword}=") and parent.respond_to?(keyword))
+        end
+  
+        def interpret(parent, keyword, *args, &block)
+          Glimmer::DataBinding::Shine.new(parent, keyword)
+        end
+      end
+    end
+  end
+end

data/lib/glimmer/web/element_proxy.rb

@@ -74,7 +74,7 @@ module Glimmer
       
       GLIMMER_ATTRIBUTES = [:parent]
       
-      attr_reader :keyword, :parent, :args, :options, :children, :enabled, :foreground, :background, :focus, :removed?, :rendered
+      attr_reader :keyword, :parent, :args, :options, :children, :enabled, :foreground, :background, :removed?, :rendered
       alias rendered? rendered
       
       def initialize(keyword, parent, args, block)
@@ -176,16 +176,6 @@ module Glimmer
         dom_element.css('background-color', background.to_css) unless background.nil?
       end
       
-      def focus=(value)
-        @focus = value
-        dom_element.focus # TODO consider if a delay or async_exec is needed here
-      end
-      
-      def set_focus
-        self.focus = true
-      end
-      alias setFocus set_focus
-      
       def parent_selector
         @parent&.selector
       end
@@ -196,7 +186,9 @@ module Glimmer
         else
           # TODO consider moving this to initializer
           options[:parent] ||= 'body'
-          Document.find(options[:parent])
+          the_element = Document.find(options[:parent])
+          the_element = Document.find('body') if the_element.length == 0
+          the_element
         end
       end
       
@@ -226,7 +218,7 @@ module Glimmer
           end
         end
       end
-      alias redraw render
+      alias rerender render
         
       def attach(the_parent_dom_element)
         the_parent_dom_element.append(@dom)
@@ -743,7 +735,7 @@ module Glimmer
       def can_handle_observation_request?(keyword)
         # TODO sort this out for Opal
         keyword = keyword.to_s
-        keyword.start_with?('on_')
+        keyword.start_with?('on')
 #         if keyword.start_with?('on_swt_')
 #           constant_name = keyword.sub(/^on_swt_/, '')
 #           SWTProxy.has_constant?(constant_name)
@@ -765,10 +757,10 @@ module Glimmer
       
       def handle_javascript_observation_request(keyword, original_event_listener)
         listener = ListenerProxy.new(
-          element_proxy: self,
+          element: self,
           selector: selector,
           dom_element: dom_element,
-          event: keyword.sub(/^on_/, ''),
+          event_attribute: keyword,
           listener: original_event_listener,
           original_event_listener: original_event_listener
         )
@@ -813,11 +805,19 @@ module Glimmer
         event_listener_proxies.clear
       end
       
-      def add_observer(observer, property_name)
-        property_listener_installers = self.class&.ancestors&.to_a.map {|ancestor| widget_property_listener_installers[ancestor]}.compact
-        widget_listener_installers = property_listener_installers.map{|installer| installer[property_name.to_s.to_sym]}.compact if !property_listener_installers.empty?
-        widget_listener_installers.to_a.each do |widget_listener_installer|
-          widget_listener_installer.call(observer)
+      def data_bind(property, model_binding)
+        element_binding_parameters = [self, property]
+        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)
+        unless model_binding.binding_options[:read_only]
+          # TODO add guards against nil cases for hash below
+          listener_keyword = data_binding_element_keyword_to_property_listener_map[keyword][property]
+          data_binding_read_listener = lambda do |event|
+            model_binding.call(send(property))
+          end
+          handle_observation_request(listener_keyword, data_binding_read_listener)
         end
       end
       
@@ -827,6 +827,7 @@ module Glimmer
       end
       
       def respond_to_missing?(method_name, include_private = false)
+        # TODO consider doing more correct checking of availability of properties/methods using native `` ticks
         property_name = property_name_for(method_name)
         super(method_name, include_private) ||
           (dom_element && dom_element.length > 0 && Native.call(dom_element, '0').respond_to?(method_name.to_s.camelcase, include_private)) ||
@@ -836,6 +837,7 @@ module Glimmer
       end
       
       def method_missing(method_name, *args, &block)
+        # TODO consider doing more correct checking of availability of properties/methods using native `` ticks
         property_name = property_name_for(method_name)
         if method_name.to_s.start_with?('on_')
           handle_observation_request(method_name, block)
@@ -931,144 +933,17 @@ module Glimmer
         }
       end
       
-      def widget_property_listener_installers
-        @swt_widget_property_listener_installers ||= {
-#           WidgetProxy => {
-#             :focus => proc do |observer|
-#               on_focus_gained { |focus_event|
-#                 observer.call(true)
-#               }
-#               on_focus_lost { |focus_event|
-#                 observer.call(false)
-#               }
-#             end,
-#           },
-          MenuItemProxy => {
-            :selection => proc do |observer|
-              on_widget_selected { |selection_event|
-                # TODO look into validity of this and perhaps move toggle logic to MenuItemProxy
-                if check?
-                  observer.call(!selection)
-                else
-                  observer.call(selection)
-                end
-              }
-            end
-          },
-          ScaleProxy => {
-            :selection => proc do |observer|
-              on_widget_selected { |selection_event|
-                observer.call(selection)
-              }
-            end
-          },
-          SliderProxy => {
-            :selection => proc do |observer|
-              on_widget_selected { |selection_event|
-                observer.call(selection)
-              }
-            end
+      def data_binding_element_keyword_to_property_listener_map
+        @data_binding_element_keyword_to_property_listener_map ||= {
+          'input' => {
+            'value' => 'oninput',
           },
-          SpinnerProxy => {
-            :selection => proc do |observer|
-              on_widget_selected { |selection_event|
-                observer.call(selection)
-              }
-            end
+          'select' => {
+            'value' => 'onchange',
           },
-          TextProxy => {
-            :text => proc do |observer|
-              on_modify_text { |modify_event|
-                observer.call(text)
-              }
-            end,
-#             :caret_position => proc do |observer|
-#               on_event_keydown { |event|
-#                 observer.call(getCaretPosition)
-#               }
-#               on_event_keyup { |event|
-#                 observer.call(getCaretPosition)
-#               }
-#               on_event_mousedown { |event|
-#                 observer.call(getCaretPosition)
-#               }
-#               on_event_mouseup { |event|
-#                 observer.call(getCaretPosition)
-#               }
-#             end,
-#             :selection => proc do |observer|
-#               on_event_keydown { |event|
-#                 observer.call(getSelection)
-#               }
-#               on_event_keyup { |event|
-#                 observer.call(getSelection)
-#               }
-#               on_event_mousedown { |event|
-#                 observer.call(getSelection)
-#               }
-#               on_event_mouseup { |event|
-#                 observer.call(getSelection)
-#               }
-#             end,
-#             :selection_count => proc do |observer|
-#               on_event_keydown { |event|
-#                 observer.call(getSelectionCount)
-#               }
-#               on_event_keyup { |event|
-#                 observer.call(getSelectionCount)
-#               }
-#               on_event_mousedown { |event|
-#                 observer.call(getSelectionCount)
-#               }
-#               on_event_mouseup { |event|
-#                 observer.call(getSelectionCount)
-#               }
-#             end,
-#             :top_index => proc do |observer|
-#               @last_top_index = getTopIndex
-#               on_paint_control { |event|
-#                 if getTopIndex != @last_top_index
-#                   @last_top_index = getTopIndex
-#                   observer.call(@last_top_index)
-#                 end
-#               }
-#             end,
-          },
-#           Java::OrgEclipseSwtCustom::StyledText => {
-#             :text => proc do |observer|
-#               on_modify_text { |modify_event|
-#                 observer.call(getText)
-#               }
-#             end,
-#           },
-          DateTimeProxy => {
-            :date_time => proc do |observer|
-              on_widget_selected { |selection_event|
-                observer.call(date_time)
-              }
-            end
+          'textarea' => {
+            'value' => 'oninput',
           },
-          RadioProxy => { #radio?
-            :selection => proc do |observer|
-              on_widget_selected { |selection_event|
-                observer.call(selection)
-              }
-            end
-          },
-          TableProxy => {
-            :selection => proc do |observer|
-              on_widget_selected { |selection_event|
-                observer.call(selection_event.table_item.get_data)  # TODO ensure selection doesn't conflict with editing
-              }
-            end,
-          },
-#           Java::OrgEclipseSwtWidgets::MenuItem => {
-#             :selection => proc do |observer|
-#               on_widget_selected { |selection_event|
-#                 observer.call(getSelection)
-#               }
-#             end
-#           },
         }
       end
       

data/lib/glimmer/web/event_proxy.rb

@@ -0,0 +1,59 @@
+# Copyright (c) 2023 Andy Maleh
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+module Glimmer
+  module Web
+    class EventProxy
+      attr_reader :js_event, :listener
+
+      def initialize(js_event:, listener:)
+        @js_event = js_event
+        @listener = listener
+      end
+      
+      def element = listener.element
+      def event_name = listener.event_name
+      def event_attribute = listener.event_attribute
+      
+      def original_event
+        Native(`#{js_event.to_n}.originalEvent`)
+      end
+      
+      def respond_to_missing?(method_name, include_private = false)
+        property_name = method_name.to_s.camelcase
+        super(method_name, include_private) ||
+          js_event.respond_to?(method_name, include_private) ||
+          `#{property_name} in #{original_event.to_n}`
+      end
+      
+      def method_missing(method_name, *args, &block)
+        property_name = method_name.to_s.camelcase
+        if js_event.respond_to?(method_name, true)
+          js_event.send(method_name, *args, &block)
+        elsif `#{property_name} in #{original_event.to_n}`
+          original_event[property_name]
+        else
+          super(method_name, *args, &block)
+        end
+      end
+    end
+  end
+end