glimmer-dsl-opal 0.16.1 → 0.16.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e2ee052273513ff79b9d9ef0f351f30bfa0c4083f589429646b894b132afa4c3
-  data.tar.gz: f2a9113b2a92168046d19c3068d9b62df1000fdc1dd6c9ea5f168ffb89123fb4
+  metadata.gz: 73ea5888d9b6351e59225c868c98bf3c5f8d7bf20e1314bf2289be1528cd5d65
+  data.tar.gz: 0d5420f934e0d29a8fcdb15e68f2e30365f2d70d9d89e2dc19bbd24d14a91626
 SHA512:
-  metadata.gz: 20edcc6d97dbee21a5b8b332bc649fb0f7d77f93e41d02095cdbbed43f0686f8c1dd5bf08972bd21511cb983f77caf247f61136ddde5de859f444ac92f31dbf2
-  data.tar.gz: ce7347775105f4b2af132cd68b4a805332b4afe910cb3ff91c0da083bd043e93cf067c693c9e4a54b506c2417d684248d23fa78aecccc264c741c38028b35b6e
+  metadata.gz: 79e7aae7f3b6e5342e2231f08330cf50e2c5574444b3f07c86b2166722e356e18ca6fb89a2ad21509951360432a42e8f6c449a19b5ff5737b08f521b8f473b79
+  data.tar.gz: 6f4be96f8c26c160b0d8d8d2dfc92d40cfa95fc79a76cfe886567cd2f55671861adf9b19cfdbc5d1f6fa78a1ce516f7ab46c330bdef2821a1a312b8b165c91cc

data/CHANGELOG.md

@@ -1,8 +1,17 @@
 # Change Log
 
+## 0.16.2
+
+- Support `grid_layout` `margin_top`, `margin_right`, `margin_bottom`, and `margin_left` attributes
+- Support `row_layout` `wrap` and `justify` attributes
+- Hello, Layout! sample
+- Partial CGI implementation to have `escapeHTML` (alias: `escape_html`) method
+- HTML Escape label text content
+- Fix issue with `row_layout` `fill` attribute not working
+
 ## 0.16.1
 
-- Support GridLayout make_columns_equal_width, horizontal_spacing, and vertical_spacing attributes
+- Support `grid_layout` `make_columns_equal_width`, `horizontal_spacing`, and `vertical_spacing` attributes
 - Hello, Composite! sample
 
 ## 0.16.0

data/README.md

@@ -1,4 +1,4 @@
-# [<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.16.0 (Pure Ruby Web 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 Opal 0.16.2 (Pure Ruby Web GUI)
 [![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)
 
@@ -143,7 +143,7 @@ Hello, Table! Game Booked
 
 NOTE: Glimmer DSL for Opal is an alpha project. Please help make better by contributing, adopting for small or low risk projects, and providing feedback. It is still an early alpha, so the more feedback and issues you report the better.
 
-**Alpha Version** 0.16.0 only supports bare-minimum capabilities for the included [samples](https://github.com/AndyObtiva/glimmer-dsl-opal#samples) (originally written for [glimmer-dsl-swt](https://github.com/AndyObtiva/glimmer-dsl-swt))
+**Alpha Version** 0.16.2 only supports bare-minimum capabilities for the included [samples](https://github.com/AndyObtiva/glimmer-dsl-opal#samples) (originally written for [glimmer-dsl-swt](https://github.com/AndyObtiva/glimmer-dsl-swt))
 
 Other [Glimmer](https://github.com/AndyObtiva/glimmer) DSL gems:
 - [glimmer-dsl-swt](https://github.com/AndyObtiva/glimmer-dsl-swt): Glimmer DSL for SWT (JRuby Desktop Development GUI Framework)
@@ -153,7 +153,7 @@ Other [Glimmer](https://github.com/AndyObtiva/glimmer) DSL gems:
 
 ## Table of Contents
 
-- [Glimmer DSL for Opal 0.16.0 (Pure Ruby Web GUI)](#-glimmer-dsl-for-opal-0160-pure-ruby-web-gui)
+- [Glimmer DSL for Opal 0.16.2 (Pure Ruby Web GUI)](#-glimmer-dsl-for-opal-0162-pure-ruby-web-gui)
   - [Principles](#principles)
   - [Background](#background)
   - [Pre-requisites](#pre-requisites)
@@ -257,7 +257,7 @@ gem 'opal', '1.0.4'
 gem 'opal-rails', '1.1.2'
 gem 'opal-async', '~> 1.2.0'
 gem 'opal-jquery', '~> 0.4.4'
-gem 'glimmer-dsl-opal', '~> 0.16.0'
+gem 'glimmer-dsl-opal', '~> 0.16.2'
 gem 'glimmer-dsl-xml', '~> 1.2.0', require: false
 gem 'glimmer-dsl-css', '~> 1.2.0', require: false
 
@@ -656,6 +656,58 @@ You should see "Hello, Computed!"
 
 ![Glimmer DSL for Opal Hello Computed](images/glimmer-dsl-opal-hello-computed.png)
 
+#### Hello, Layout!
+
+Add the following require statement to `app/assets/javascripts/application.rb`
+
+
+```ruby
+require 'glimmer-dsl-opal/samples/hello/hello_layout'
+```
+
+Glimmer app on the desktop (using [`glimmer-dsl-swt`](https://github.com/AndyObtiva/glimmer-dsl-swt) gem):
+
+![Glimmer DSL for SWT Hello Layout](https://github.com/AndyObtiva/glimmer-dsl-swt/raw/master/images/glimmer-hello-layout-tab1.png)
+
+![Glimmer DSL for SWT Hello Layout](https://github.com/AndyObtiva/glimmer-dsl-swt/raw/master/images/glimmer-hello-layout-tab2.png)
+
+![Glimmer DSL for SWT Hello Layout](https://github.com/AndyObtiva/glimmer-dsl-swt/raw/master/images/glimmer-hello-layout-tab3.png)
+
+![Glimmer DSL for SWT Hello Layout](https://github.com/AndyObtiva/glimmer-dsl-swt/raw/master/images/glimmer-hello-layout-tab4.png)
+
+![Glimmer DSL for SWT Hello Layout](https://github.com/AndyObtiva/glimmer-dsl-swt/raw/master/images/glimmer-hello-layout-tab5.png)
+
+![Glimmer DSL for SWT Hello Layout](https://github.com/AndyObtiva/glimmer-dsl-swt/raw/master/images/glimmer-hello-layout-tab6.png)
+
+![Glimmer DSL for SWT Hello Layout](https://github.com/AndyObtiva/glimmer-dsl-swt/raw/master/images/glimmer-hello-layout-tab7.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, Layout!"
+
+![Glimmer DSL for Opal Hello Layout](images/glimmer-dsl-opal-hello-layout-tab1.png)
+
+![Glimmer DSL for Opal Hello Layout](images/glimmer-dsl-opal-hello-layout-tab2.png)
+
+![Glimmer DSL for Opal Hello Layout](images/glimmer-dsl-opal-hello-layout-tab3.png)
+
+![Glimmer DSL for Opal Hello Layout](images/glimmer-dsl-opal-hello-layout-tab4.png)
+
+![Glimmer DSL for Opal Hello Layout](images/glimmer-dsl-opal-hello-layout-tab4-shrunk.png)
+
+![Glimmer DSL for Opal Hello Layout](images/glimmer-dsl-opal-hello-layout-tab5.png)
+
+![Glimmer DSL for Opal Hello Layout](images/glimmer-dsl-opal-hello-layout-tab6.png)
+
+![Glimmer DSL for Opal Hello Layout](images/glimmer-dsl-opal-hello-layout-tab7.png)
+
 #### Hello, List Single Selection!
 
 Add the following require statement to `app/assets/javascripts/application.rb`

data/VERSION

@@ -1 +1 @@
-0.16.1
+0.16.2

data/lib/cgi.rb

@@ -0,0 +1,14 @@
+class CGI
+  class << self
+    def escapeHTML(string)
+      string.
+        gsub('&', '&amp;').
+        gsub('<', '&lt;').
+        gsub('>', '&gt;').
+        gsub("'", '&apos;').
+        gsub('"', '&quot;')
+    end
+    alias escape_html escapeHTML
+    
+  end
+end

data/lib/glimmer-dsl-opal.rb

@@ -50,6 +50,7 @@ if RUBY_ENGINE == 'opal'
   require 'to_collection'
   require 'pure-struct'
   require 'os'
+  require 'cgi'
   require 'file'
   require 'display'
   require 'glimmer-dsl-opal/vendor/jquery'

data/lib/glimmer-dsl-opal/samples/hello/hello_layout.rb

@@ -0,0 +1,241 @@
+# Copyright (c) 2020-2021 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.
+
+class HelloLayout
+  include Glimmer::UI::CustomShell
+  
+  body {
+    shell {
+      # shell (which is a composite) has fill_layout(:horizontal) by default with no margins
+      text 'Hello, Layout!'
+      tab_folder {
+      
+        # every tab item has its own composite, which can set a layout
+        tab_item {
+          text 'Fill Layout (horizontal)'
+          
+          fill_layout(:horizontal) {
+            margin_width 30
+            margin_height 40
+            spacing 5
+          }
+          
+          10.times { |n|
+            label {
+              text "<label #{n+1}>"
+            }
+          
+          }
+        
+        }
+      
+        tab_item {
+          text 'Fill Layout (vertical)'
+          
+          fill_layout {
+            type :vertical # alternative way of specifying orientation
+            margin_width 40
+            margin_height 30
+            spacing 10
+          }
+          
+          10.times { |n|
+            label(:center) {
+              text "<label #{n+1}>"
+            }
+          
+          }
+        
+        }
+      
+        tab_item {
+          text 'Row Layout (horizontal)'
+          
+          row_layout(:horizontal) {
+            # row layout has margin attributes for top, left, right, and bottom
+            # in addition to width and height (and sets margin_width and margin_height to 5 by default)
+            margin_top 40
+            margin_left 30
+            spacing 5
+            wrap false
+            center true
+            justify true
+          }
+          
+          10.times { |n|
+            label {
+              text "<label #{n+1}>"
+            }
+          
+          }
+        
+        }
+      
+        tab_item {
+          text 'Row Layout (wrap on shrink)'
+          
+          row_layout { # :horizontal is the default type
+            margin_height 40
+            margin_width 30
+            spacing 35
+            # wrap true # is the default
+          }
+          
+          10.times { |n|
+            label {
+              text "<label #{n+1}>"
+            }
+          
+          }
+        
+        }
+        
+        tab_item {
+          text 'Row Layout (vertical)'
+          background :yellow
+
+          row_layout(:vertical) { |l|
+            margin_height 0
+            margin_width 0
+            spacing 10
+            fill true # fills horizontally to match the widest child (opposite to row layout orientation)
+            center false # enable and disable fill to see what this does
+          }
+
+          10.times { |n|
+            label {
+              # layout_data allows a widget to tweak its layout configuration (generating RowData object for RowLayout)
+              layout_data {
+                height 30
+#                 width unspecified yet calculated
+              }
+              text "<this is a ver#{'r'*(rand*200).to_i}y wide label #{n+1}>"
+              background :green
+            }
+
+          }
+
+        }
+            
+        tab_item {
+          text 'Grid Layout'
+          
+          grid_layout {
+            num_columns 5
+            make_columns_equal_width true
+            horizontal_spacing 15
+            vertical_spacing 10
+
+            # grid layout has margin attributes for top, left, right, and bottom
+            # in addition to width and height (and sets margin_width and margin_height to 5 by default)
+            margin_height 0
+            margin_top 20
+          }
+          
+          10.times { |n|
+            label {
+              text "<this label is wide enough to fill #{n+1}>"
+              background :white
+            }
+          }
+        
+          label {
+            # layout_data allows a widget to tweak its layout configuration (generating GridData object for GridLayout)
+            layout_data {
+              width_hint 120
+              height_hint 40
+            }
+            text "<this label is clipped>"
+            background :cyan
+          }
+        
+          label {
+            # layout_data allows a widget to tweak its layout configuration (generating GridData object for GridLayout)
+            layout_data {
+              horizontal_span 2
+            }
+            text "<this label spans two columns, so it can contain more text than normal>"
+            background :green
+          }
+        
+          label {
+            # layout_data allows a widget to tweak its layout configuration (generating GridData object for GridLayout)
+            layout_data {
+              vertical_span 2
+              vertical_alignment :fill
+            }
+            text "<this label spans two rows, \nso it can contain new lines\n1\n2\n3\n4\n5\n6\n7>"
+            background :yellow
+          }
+          
+          5.times { label } # just filler
+          
+          label {
+            
+            # layout_data allows a widget to tweak its layout configuration (generating GridData object for GridLayout)
+            layout_data {
+              horizontal_span 5
+              horizontal_alignment :fill # could be :beginning, :center or :end too
+              vertical_alignment :fill # could be :beginning, :center, or :end too
+              grab_excess_horizontal_space true
+              grab_excess_vertical_space true
+            }
+            
+            # this is a short alternative for specifying what is above
+#             layout_data(:fill, :fill, true, true) {
+#               horizontal_span 5
+#             }
+            
+            text "<this label fills all the space it can get\nhorizontally and vertically>"
+            background :magenta
+          }
+        
+        }
+        
+            
+        tab_item {
+          text 'Grid Layout (non-equal columns)'
+          
+          grid_layout(2, false) # alt syntax: (numColumns, make_columns_equal_width)
+          
+          10.times { |n|
+            label {
+              text "Field #{n+1}"
+            }
+            text {
+              layout_data {
+                width_hint 600
+              }
+              
+              text "Please enter text"
+            }
+          }
+        
+        }
+                                  
+      }
+    
+    }
+  
+  }
+end
+
+HelloLayout.launch

data/lib/glimmer/swt/fill_layout_proxy.rb

@@ -28,13 +28,11 @@ module Glimmer
     
       def initialize(parent, args)
         super(parent, args)
-        @type = @args.first || :horizontal
+        self.type = @args.first || :horizontal
         self.margin_width = 15
         self.margin_height = 15
         @parent.css_classes << 'fill-layout'
-        @parent.css_classes << (horizontal? ? 'fill-layout-horizontal' : 'fill-layout-vertical')
         @parent.dom_element.add_class('fill-layout')
-        @parent.dom_element.add_class(horizontal? ? 'fill-layout-horizontal' : 'fill-layout-vertical')
       end
       
       def horizontal?
@@ -44,6 +42,14 @@ module Glimmer
       def vertical?
         @type == :vertical
       end
+      
+      def type=(value)
+        @parent.dom_element.remove_class(horizontal? ? 'fill-layout-horizontal' : 'fill-layout-vertical')
+        @parent.css_classes.delete(horizontal? ? 'fill-layout-horizontal' : 'fill-layout-vertical')
+        @type = value
+        @parent.dom_element.add_class(horizontal? ? 'fill-layout-horizontal' : 'fill-layout-vertical')
+        @parent.css_classes << horizontal? ? 'fill-layout-horizontal' : 'fill-layout-vertical'
+      end
 
       def margin_width=(pixels)
         @margin_width = pixels

data/lib/glimmer/swt/grid_layout_proxy.rb

@@ -12,7 +12,7 @@ module Glimmer
         }
       CSS
       
-      attr_reader :num_columns, :make_columns_equal_width, :horizontal_spacing, :vertical_spacing, :margin_width, :margin_height
+      attr_reader :num_columns, :make_columns_equal_width, :horizontal_spacing, :vertical_spacing, :margin_width, :margin_height, :margin_top, :margin_right, :margin_bottom, :margin_left
     
       def num_columns=(columns)
         @num_columns = columns
@@ -55,6 +55,38 @@ module Glimmer
         @parent.dom_element.css('padding-top', effective_margin_height)
         @parent.dom_element.css('padding-bottom', effective_margin_height)
       end
+      
+      def margin_top=(pixels)
+        @margin_top = pixels
+        # Using padding for width since margin-right isn't getting respected with width 100%
+        effective_margin_top = @margin_top
+        effective_margin_top += 9 if @parent.is_a?(GroupProxy)
+        @parent.dom_element.css('padding-top', effective_margin_top)
+      end
+      
+      def margin_right=(pixels)
+        @margin_right = pixels
+        effective_margin_right = @margin_right
+        effective_margin_right += 6 if @parent.is_a?(GroupProxy)
+        @parent.dom_element.css('padding-right', effective_margin_right)
+      end
+      
+      def margin_bottom=(pixels)
+        @margin_bottom = pixels
+        # Using padding for width since margin-right isn't getting respected with width 100%
+        effective_margin_bottom = @margin_bottom
+        effective_margin_bottom += 9 if @parent.is_a?(GroupProxy)
+        @parent.dom_element.css('padding-bottom', effective_margin_bottom)
+      end
+      
+      def margin_left=(pixels)
+        @margin_left = pixels
+        effective_margin_left = @margin_left
+        effective_margin_left += 6 if @parent.is_a?(GroupProxy)
+        @parent.dom_element.css('padding-left', effective_margin_left)
+      end
+            
+      
             
       def initialize(parent, args)
         super(parent, args)

data/lib/glimmer/swt/label_proxy.rb

@@ -33,11 +33,11 @@ module Glimmer
 
       def text=(value)
         @text = value
-        dom_element.html(html_text)
+        dom_element.html(html_text) # TODO deal with issue of handling lines and escaping at the same time
       end
       
       def html_text
-        text&.gsub("\n", '<br />')
+        text && CGI.escape_html(text).gsub("\n", '<br />')
       end
       
 #       def background_image=(*image_options)

data/lib/glimmer/swt/row_layout_proxy.rb

@@ -24,6 +24,14 @@ module Glimmer
           margin-left: auto;
           margin-right: auto;
         }
+        
+        .row-layout-wrap {
+          flex-wrap: wrap;
+        }
+                
+        .row-layout-justify {
+          justify-content: space-around;
+        }
                 
         .row-layout-horizontal {
           flex-direction: row;
@@ -42,13 +50,14 @@ module Glimmer
         }
       CSS
     
-      attr_reader :type, :fill, :margin_width, :margin_height, :margin_top, :margin_right, :margin_bottom, :margin_left, :spacing, :pack, :center
+      attr_reader :type, :margin_width, :margin_height, :margin_top, :margin_right, :margin_bottom, :margin_left, :spacing, :pack, :center, :wrap, :justify
         
       def initialize(parent, args)
         super(parent, args)
         @parent.dom_element.add_class('row-layout')
         self.type = args.first || :horizontal
         self.pack = true
+        self.wrap = true
       end
       
       def type=(value)
@@ -79,9 +88,13 @@ module Glimmer
         end
       end
       
+      def fill
+        !pack
+      end
+      
       def fill=(value)
         # TODO verify this is a correct implementation and interpretation of RowLayout in SWT
-        self.pack(!value)
+        self.pack = !value
       end
       
       def center=(center_value)
@@ -94,6 +107,24 @@ module Glimmer
         end
       end
       
+      def wrap=(wrap_value)
+        @wrap = wrap_value
+        if @wrap
+          parent.dom_element.add_class("row-layout-wrap")
+        else
+          parent.dom_element.remove_class("row-layout-wrap")
+        end
+      end
+      
+      def justify=(justify_value)
+        @justify = justify_value
+        if @justify
+          parent.dom_element.add_class("row-layout-justify")
+        else
+          parent.dom_element.remove_class("row-layout-justify")
+        end
+      end
+      
       def margin_width=(pixels)
         @margin_width = pixels
         # Using padding for width since margin-right isn't getting respected with width 100%

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glimmer-dsl-opal
 version: !ruby/object:Gem::Version
-  version: 0.16.1
+  version: 0.16.2
 platform: ruby
 authors:
 - AndyMaleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-12 00:00:00.000000000 Z
+date: 2021-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: glimmer
@@ -267,6 +267,7 @@ files:
 - app/controllers/glimmer/image_paths_controller.rb
 - app/views/glimmer/image_paths/index.html.erb
 - config/routes.rb
+- lib/cgi.rb
 - lib/display.rb
 - lib/glimmer-dsl-opal.rb
 - lib/glimmer-dsl-opal/ext/class.rb
@@ -295,6 +296,7 @@ files:
 - lib/glimmer-dsl-opal/samples/hello/hello_date_time.rb
 - lib/glimmer-dsl-opal/samples/hello/hello_dialog.rb
 - lib/glimmer-dsl-opal/samples/hello/hello_group.rb
+- lib/glimmer-dsl-opal/samples/hello/hello_layout.rb
 - lib/glimmer-dsl-opal/samples/hello/hello_list_multi_selection.rb
 - lib/glimmer-dsl-opal/samples/hello/hello_list_single_selection.rb
 - lib/glimmer-dsl-opal/samples/hello/hello_menu_bar.rb