glimmer-dsl-opal 0.4.0 → 0.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (33) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +18 -0
  3. data/README.md +530 -13
  4. data/VERSION +1 -1
  5. data/lib/glimmer-dsl-opal/samples/hello/hello_checkbox.rb +85 -0
  6. data/lib/glimmer-dsl-opal/samples/hello/hello_checkbox_group.rb +68 -0
  7. data/lib/glimmer-dsl-opal/samples/hello/hello_custom_widget.rb +3 -3
  8. data/lib/glimmer-dsl-opal/samples/hello/hello_group.rb +104 -0
  9. data/lib/glimmer-dsl-opal/samples/hello/hello_radio.rb +108 -0
  10. data/lib/glimmer-dsl-opal/samples/hello/hello_radio_group.rb +84 -0
  11. data/lib/glimmer-dsl-swt.rb +1 -0
  12. data/lib/glimmer/data_binding/element_binding.rb +2 -1
  13. data/lib/glimmer/dsl/opal/checkbox_group_selection_data_binding_expression.rb +61 -0
  14. data/lib/glimmer/dsl/opal/custom_widget_expression.rb +7 -5
  15. data/lib/glimmer/dsl/opal/dsl.rb +4 -0
  16. data/lib/glimmer/dsl/opal/property_expression.rb +4 -3
  17. data/lib/glimmer/dsl/opal/radio_group_selection_data_binding_expression.rb +61 -0
  18. data/lib/glimmer/swt/button_proxy.rb +15 -1
  19. data/lib/glimmer/swt/checkbox_proxy.rb +80 -0
  20. data/lib/glimmer/swt/combo_proxy.rb +4 -4
  21. data/lib/glimmer/swt/custom/checkbox_group.rb +142 -0
  22. data/lib/glimmer/swt/custom/radio_group.rb +143 -0
  23. data/lib/glimmer/swt/grid_layout_proxy.rb +19 -8
  24. data/lib/glimmer/swt/group_proxy.rb +38 -0
  25. data/lib/glimmer/swt/label_proxy.rb +27 -7
  26. data/lib/glimmer/swt/layout_data_proxy.rb +31 -13
  27. data/lib/glimmer/swt/list_proxy.rb +2 -2
  28. data/lib/glimmer/swt/radio_proxy.rb +81 -0
  29. data/lib/glimmer/swt/row_layout_proxy.rb +32 -9
  30. data/lib/glimmer/swt/scrolled_composite_proxy.rb +20 -0
  31. data/lib/glimmer/swt/shell_proxy.rb +21 -9
  32. data/lib/glimmer/swt/widget_proxy.rb +46 -30
  33. metadata +15 -2
@@ -17,6 +17,7 @@ end
17
17
  class File
18
18
  class << self
19
19
  def read(*args, &block)
20
+ # TODO implement via asset downloads in the future
20
21
  # No Op in Opal
21
22
  end
22
23
  end
@@ -4,6 +4,7 @@ require 'glimmer/data_binding/observer'
4
4
  module Glimmer
5
5
  module DataBinding
6
6
  class ElementBinding
7
+ # TODO consider renaming to WidgetBinding since it's no longer dealing with elements directly yet widgets instead
7
8
  include Glimmer
8
9
  include Observable
9
10
  include Observer
@@ -27,7 +28,7 @@ module Glimmer
27
28
  @element.set_attribute(@property, converted_value) unless evaluate_property == converted_value
28
29
  end
29
30
 
30
- def evaluate_property
31
+ def evaluate_property
31
32
  @element.send(@property)
32
33
  end
33
34
  end
@@ -0,0 +1,61 @@
1
+ # Copyright (c) 2020 Andy Maleh
2
+ #
3
+ # Permission is hereby granted, free of charge, to any person obtaining
4
+ # a copy of this software and associated documentation files (the
5
+ # "Software"), to deal in the Software without restriction, including
6
+ # without limitation the rights to use, copy, modify, merge, publish,
7
+ # distribute, sublicense, and/or sell copies of the Software, and to
8
+ # permit persons to whom the Software is furnished to do so, subject to
9
+ # the following conditions:
10
+ #
11
+ # The above copyright notice and this permission notice shall be
12
+ # included in all copies or substantial portions of the Software.
13
+ #
14
+ # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15
+ # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16
+ # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17
+ # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
18
+ # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
19
+ # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20
+ # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
21
+
22
+ require 'glimmer/dsl/expression'
23
+ require 'glimmer/data_binding/model_binding'
24
+ require 'glimmer/data_binding/element_binding'
25
+
26
+ module Glimmer
27
+ module DSL
28
+ module Opal
29
+ class CheckboxGroupSelectionDataBindingExpression < Expression
30
+
31
+ def can_interpret?(parent, keyword, *args, &block)
32
+ keyword == 'selection' and
33
+ block.nil? and
34
+ (parent.is_a?(Glimmer::SWT::Custom::CheckboxGroup) or (parent.is_a?(Glimmer::UI::CustomWidget) and parent.body_root.is_a?(Glimmer::SWT::Custom::CheckboxGroup)) ) and
35
+ args.size == 1 and
36
+ args[0].is_a?(DataBinding::ModelBinding) and
37
+ args[0].evaluate_options_property.is_a?(Array)
38
+ end
39
+
40
+ def interpret(parent, keyword, *args, &block)
41
+ model_binding = args[0]
42
+
43
+ #TODO make this options observer dependent and all similar observers in widget specific data binding handlers
44
+ # TODO consider delegating some of this work
45
+ widget_binding = DataBinding::ElementBinding.new(parent, 'items')
46
+ widget_binding.call(model_binding.evaluate_options_property)
47
+ model = model_binding.base_model
48
+ widget_binding.observe(model, model_binding.options_property_name)
49
+
50
+ widget_binding = DataBinding::ElementBinding.new(parent, 'selection')
51
+ widget_binding.call(model_binding.evaluate_property)
52
+ widget_binding.observe(model, model_binding.property_name_expression)
53
+
54
+ parent.on_widget_selected do
55
+ model_binding.call(widget_binding.evaluate_property)
56
+ end
57
+ end
58
+ end
59
+ end
60
+ end
61
+ end
@@ -1,5 +1,5 @@
1
1
  # Copyright (c) 2020 Andy Maleh
2
- #
2
+ #
3
3
  # Permission is hereby granted, free of charge, to any person obtaining
4
4
  # a copy of this software and associated documentation files (the
5
5
  # "Software"), to deal in the Software without restriction, including
@@ -7,10 +7,10 @@
7
7
  # distribute, sublicense, and/or sell copies of the Software, and to
8
8
  # permit persons to whom the Software is furnished to do so, subject to
9
9
  # the following conditions:
10
- #
10
+ #
11
11
  # The above copyright notice and this permission notice shall be
12
12
  # included in all copies or substantial portions of the Software.
13
- #
13
+ #
14
14
  # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15
15
  # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16
16
  # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
@@ -26,6 +26,8 @@ require 'glimmer/dsl/top_level_expression'
26
26
  require 'glimmer/ui/custom_widget'
27
27
  require 'glimmer/ui/custom_shell'
28
28
  require 'glimmer/swt/make_shift_shell_proxy'
29
+ require 'glimmer/swt/custom/radio_group'
30
+ require 'glimmer/swt/custom/checkbox_group'
29
31
 
30
32
  module Glimmer
31
33
  module DSL
@@ -52,7 +54,7 @@ module Glimmer
52
54
  'custom_shell' => keyword
53
55
  }.merge(options)
54
56
  param_string = params.to_a.map {|k, v| "#{k}=#{URI.encode_www_form_component(v)}"}.join('&')
55
- url = "#{`document.location.href`}?#{param_string}"
57
+ url = "#{`document.location.href`}?#{param_string}"
56
58
  `window.open(#{url})`
57
59
  # just a placeholder that has an open method # TODO return an actual CustomShell in the future that does the work happening above in the #open method
58
60
  Glimmer::SWT::MakeShiftShellProxy.new
@@ -64,7 +66,7 @@ module Glimmer
64
66
  custom_shell_keyword = parameters.delete('custom_shell')
65
67
  CustomWidgetExpression.new.interpret(nil, custom_shell_keyword, *[parameters])
66
68
  `history.pushState(#{parameters.reject {|k,v| k == 'custom_shell_handled'}}, document.title, #{"?#{Glimmer::UI::CustomShell.encoded_request_parameter_string.sub('&custom_shell_handled=true', '')}"})`
67
- # just a placeholder that has an open method # TODO return an actual CustomShell in the future that does the work happening above in the #open method
69
+ # just a placeholder that has an open method # TODO return an actual CustomShell in the future that does the work happening above in the #open method
68
70
  Glimmer::SWT::MakeShiftShellProxy.new
69
71
  else
70
72
  custom_widget_class&.new(parent, *args, {}, &block)
@@ -23,6 +23,8 @@ require 'glimmer/dsl/opal/rgb_expression'
23
23
  require 'glimmer/dsl/opal/rgba_expression'
24
24
  require 'glimmer/dsl/opal/custom_widget_expression'
25
25
  require 'glimmer/dsl/opal/swt_expression'
26
+ require 'glimmer/dsl/opal/radio_group_selection_data_binding_expression'
27
+ require 'glimmer/dsl/opal/checkbox_group_selection_data_binding_expression'
26
28
 
27
29
  module Glimmer
28
30
  module DSL
@@ -35,6 +37,8 @@ module Glimmer
35
37
  table_items_data_binding
36
38
  combo_selection_data_binding
37
39
  list_selection_data_binding
40
+ radio_group_selection_data_binding
41
+ checkbox_group_selection_data_binding
38
42
  data_binding
39
43
  font
40
44
  layout
@@ -7,9 +7,10 @@ module Glimmer
7
7
  include TopLevelExpression
8
8
 
9
9
  def can_interpret?(parent, keyword, *args, &block)
10
- parent and
11
- parent.respond_to?(:set_attribute) and
12
- keyword and
10
+ parent and
11
+ parent.respond_to?(:set_attribute) and
12
+ parent.respond_to?(keyword, *args) and
13
+ keyword and
13
14
  block.nil?
14
15
  end
15
16
 
@@ -0,0 +1,61 @@
1
+ # Copyright (c) 2020 Andy Maleh
2
+ #
3
+ # Permission is hereby granted, free of charge, to any person obtaining
4
+ # a copy of this software and associated documentation files (the
5
+ # "Software"), to deal in the Software without restriction, including
6
+ # without limitation the rights to use, copy, modify, merge, publish,
7
+ # distribute, sublicense, and/or sell copies of the Software, and to
8
+ # permit persons to whom the Software is furnished to do so, subject to
9
+ # the following conditions:
10
+ #
11
+ # The above copyright notice and this permission notice shall be
12
+ # included in all copies or substantial portions of the Software.
13
+ #
14
+ # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15
+ # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16
+ # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17
+ # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
18
+ # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
19
+ # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20
+ # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
21
+
22
+ require 'glimmer/dsl/expression'
23
+ require 'glimmer/data_binding/model_binding'
24
+ require 'glimmer/data_binding/element_binding'
25
+
26
+ module Glimmer
27
+ module DSL
28
+ module Opal
29
+ class RadioGroupSelectionDataBindingExpression < Expression
30
+
31
+ def can_interpret?(parent, keyword, *args, &block)
32
+ keyword == 'selection' and
33
+ block.nil? and
34
+ (parent.is_a?(Glimmer::SWT::Custom::RadioGroup) or (parent.is_a?(Glimmer::UI::CustomWidget) and parent.body_root.is_a?(Glimmer::SWT::Custom::RadioGroup)) ) and
35
+ args.size == 1 and
36
+ args[0].is_a?(DataBinding::ModelBinding) and
37
+ args[0].evaluate_options_property.is_a?(Array)
38
+ end
39
+
40
+ def interpret(parent, keyword, *args, &block)
41
+ model_binding = args[0]
42
+
43
+ #TODO make this options observer dependent and all similar observers in widget specific data binding handlers
44
+ # TODO consider delegating some of this work
45
+ widget_binding = DataBinding::ElementBinding.new(parent, 'items')
46
+ widget_binding.call(model_binding.evaluate_options_property)
47
+ model = model_binding.base_model
48
+ widget_binding.observe(model, model_binding.options_property_name)
49
+
50
+ widget_binding = DataBinding::ElementBinding.new(parent, 'selection')
51
+ widget_binding.call(model_binding.evaluate_property)
52
+ widget_binding.observe(model, model_binding.property_name_expression)
53
+
54
+ parent.on_widget_selected do
55
+ model_binding.call(widget_binding.evaluate_property)
56
+ end
57
+ end
58
+ end
59
+ end
60
+ end
61
+ end
@@ -1,8 +1,22 @@
1
1
  require 'glimmer/swt/widget_proxy'
2
+ require 'glimmer/swt/radio_proxy'
3
+ require 'glimmer/swt/checkbox_proxy'
2
4
 
3
5
  module Glimmer
4
6
  module SWT
5
7
  class ButtonProxy < WidgetProxy
8
+ class << self
9
+ def create(parent, args)
10
+ if args.to_a.include?(:radio)
11
+ RadioProxy.new(parent, args)
12
+ elsif args.to_a.include?(:check)
13
+ CheckboxProxy.new(parent, args)
14
+ else
15
+ new(parent, args)
16
+ end
17
+ end
18
+ end
19
+
6
20
  attr_reader :text
7
21
 
8
22
  def text=(value)
@@ -18,7 +32,7 @@ module Glimmer
18
32
  {
19
33
  'on_widget_selected' => {
20
34
  event: 'click'
21
- },
35
+ },
22
36
  }
23
37
  end
24
38
 
@@ -0,0 +1,80 @@
1
+ require 'glimmer/swt/widget_proxy'
2
+
3
+ module Glimmer
4
+ module SWT
5
+ class CheckboxProxy < WidgetProxy
6
+ STYLE=<<~CSS
7
+ .checkbox {
8
+ display: inline;
9
+ }
10
+ .checkbox-label {
11
+ display: inline;
12
+ }
13
+ CSS
14
+ # TODO consider reuse of logic in Radioproxy
15
+ attr_reader :text
16
+
17
+ def text=(value)
18
+ @text = value
19
+ dom_element.val(@text)
20
+ label_dom_element.html(@text)
21
+ end
22
+
23
+ def selection
24
+ dom_element.prop('checked')
25
+ end
26
+
27
+ def selection=(value)
28
+ @selection = value
29
+ dom_element.prop('checked', @selection)
30
+ end
31
+
32
+ def element
33
+ 'input'
34
+ end
35
+
36
+ def observation_request_to_event_mapping
37
+ {
38
+ 'on_widget_selected' => {
39
+ event: 'change'
40
+ },
41
+ }
42
+ end
43
+
44
+ def label_id
45
+ "#{id}-label"
46
+ end
47
+
48
+ def label_class
49
+ "#{name}-label"
50
+ end
51
+
52
+ def label_dom_element
53
+ Element.find("##{label_id}")
54
+ end
55
+
56
+ def dom
57
+ check_text = @text
58
+ check_id = id
59
+ check_style = css
60
+ check_class = name
61
+ check_selection = @selection
62
+ options = {type: 'checkbox', id: check_id, name: parent.id, style: check_style, class: check_class, value: check_text, style: 'min-width: 27px;'}
63
+ options[checked: 'checked'] if check_selection
64
+ @dom ||= html {
65
+ span {
66
+ input(options) {
67
+ }
68
+ label(id: label_id, class: label_class, for: check_id) {
69
+ check_text
70
+ }
71
+ }
72
+ }.to_s
73
+ end
74
+
75
+ end
76
+
77
+ CheckProxy = CheckboxProxy # alias
78
+ end
79
+
80
+ end
@@ -29,20 +29,20 @@ module Glimmer
29
29
  html {
30
30
  option(option_hash) {
31
31
  item
32
- }
32
+ }
33
33
  }.to_s
34
34
  end
35
35
  dom_element.html(items_dom)
36
36
  end
37
37
 
38
- def observation_request_to_event_mapping
38
+ def observation_request_to_event_mapping
39
39
  {
40
40
  'on_widget_selected' => {
41
41
  event: 'change',
42
42
  event_handler: -> (event_listener) {
43
- -> (event) {
43
+ -> (event) {
44
44
  @text = event.target.value
45
- event_listener.call(event)
45
+ event_listener.call(event)
46
46
  }
47
47
  }
48
48
  }
@@ -0,0 +1,142 @@
1
+ # Copyright (c) 2020 Andy Maleh
2
+ #
3
+ # Permission is hereby granted, free of charge, to any person obtaining
4
+ # a copy of this software and associated documentation files (the
5
+ # "Software"), to deal in the Software without restriction, including
6
+ # without limitation the rights to use, copy, modify, merge, publish,
7
+ # distribute, sublicense, and/or sell copies of the Software, and to
8
+ # permit persons to whom the Software is furnished to do so, subject to
9
+ # the following conditions:
10
+ #
11
+ # The above copyright notice and this permission notice shall be
12
+ # included in all copies or substantial portions of the Software.
13
+ #
14
+ # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15
+ # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16
+ # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17
+ # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
18
+ # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
19
+ # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20
+ # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
21
+
22
+ require 'glimmer/ui/custom_widget'
23
+
24
+ module Glimmer
25
+ module SWT
26
+ module Custom
27
+ # A custom widget rendering a group of checkboxes generated via data-binding
28
+ class CheckboxGroup
29
+ include Glimmer::UI::CustomWidget
30
+
31
+ body {
32
+ composite # just an empty composite to hold checkboxs upon data-binding `selection`
33
+ }
34
+
35
+ def items=(text_array)
36
+ selection_value = selection
37
+ @items = Array[*text_array]
38
+ build_checkboxes
39
+ end
40
+
41
+ def items
42
+ @items || []
43
+ end
44
+
45
+ def selection=(selection_texts)
46
+ items.count.times do |index|
47
+ checkbox = checkboxes[index]
48
+ item = items[index]
49
+ checkbox_text = checkbox&.text
50
+ checkbox.selection = selection_texts.to_a.include?(checkbox_text)
51
+ end
52
+ selection_texts
53
+ end
54
+
55
+ def selection
56
+ selection_indices.map do |selection_index|
57
+ checkboxes[selection_index]&.text
58
+ end
59
+ end
60
+
61
+ def selection_indices=(indices)
62
+ self.selection=(indices.to_a.map {|index| items[index]})
63
+ end
64
+ alias select selection_indices=
65
+
66
+ def selection_indices
67
+ checkboxes.each_with_index.map do |checkbox, index|
68
+ index if checkbox.selection
69
+ end.to_a.compact
70
+ end
71
+
72
+ def checkboxes
73
+ @checkboxes ||= []
74
+ end
75
+ alias checks checkboxes
76
+
77
+ def can_handle_observation_request?(observation_request)
78
+ checkboxes.first&.can_handle_observation_request?(observation_request) || super(observation_request)
79
+ end
80
+
81
+ def handle_observation_request(observation_request, &block)
82
+ observation_requests << [observation_request, block]
83
+ delegate_observation_request_to_checkboxes(observation_request, &block)
84
+ super
85
+ end
86
+
87
+ def delegate_observation_request_to_checkboxes(observation_request, &block)
88
+ if observation_request != 'on_widget_disposed'
89
+ checkboxes.count.times do |index|
90
+ checkbox = checkboxes[index]
91
+ checkbox.handle_observation_request(observation_request, &block) if checkbox.can_handle_observation_request?(observation_request)
92
+ end
93
+ end
94
+ end
95
+
96
+ def observation_requests
97
+ @observation_requests ||= Set.new
98
+ end
99
+
100
+ def has_attribute?(attribute_name, *args)
101
+ @checkboxes.to_a.map do |widget_proxy|
102
+ return true if widget_proxy.has_attribute?(attribute_name, *args)
103
+ end
104
+ super
105
+ end
106
+
107
+ def set_attribute(attribute_name, *args)
108
+ excluded_attributes = ['selection']
109
+ unless excluded_attributes.include?(attribute_name.to_s)
110
+ @checkboxes.to_a.each do |widget_proxy|
111
+ widget_proxy.set_attribute(attribute_name, *args) if widget_proxy.has_attribute?(attribute_name, *args)
112
+ end
113
+ end
114
+ super
115
+ end
116
+
117
+ private
118
+
119
+ def build_checkboxes
120
+ current_selection = selection
121
+ @checkboxes = []
122
+ items.each do |item|
123
+ body_root.content {
124
+ checkboxes << checkbox { |checkbox_proxy|
125
+ text item
126
+ on_widget_selected {
127
+ self.selection_indices = checkboxes.each_with_index.map {|cb, i| i if cb.selection}.to_a.compact
128
+ }
129
+ }
130
+ }
131
+ end
132
+ observation_requests.to_a.each do |observation_request, block|
133
+ delegate_observation_request_to_checkboxes(observation_request, &block)
134
+ end
135
+ self.selection = current_selection
136
+ end
137
+ end
138
+
139
+ CheckGroup = CheckboxGroup # alias
140
+ end
141
+ end
142
+ end