mxrb 0.1.2 → 0.1.4

data/lib/mxrb/compiler/generic_widget_bundle_compiler.rb

@@ -25,7 +25,9 @@ module Mxrb
         @index = source.document_index
         @widget_type = find_widget_type
         @values = property_values(widget['Object'])
-        @list_data_source = @values.values.find { _1.first == 'DataSource' }&.last
+        @list_data_source = @values.values.find do |type, value, _metadata|
+          type == 'DataSource' && database_list_property(value)
+        end&.last
         @component_name = widget_id.to_s.split('.').last
         @module_path = widget_id.to_s.tr('.', '/')
       end
@@ -60,60 +62,105 @@ module Mxrb
           type = @index[IO::BsonCodec.extract_id(property['TypePointer'])]
           next unless type
 
-          [type.fetch('PropertyKey'), [type.dig('ValueType', 'Type'), property['Value']]]
+          value_type = type.fetch('ValueType', {})
+          [type.fetch('PropertyKey'), [value_type['Type'], property['Value'], value_type]]
         end.to_h
       end
 
       def supported_property?(pair)
-        type, value = pair
+        type, value, metadata = pair
         return true if %w[Boolean Integer Decimal Enumeration String System].include?(type)
         return value['DataSource'].nil? || !database_list_property(value).nil? if type == 'DataSource'
         return true if type == 'Association'
         return true if type == 'Attribute' && value['AttributeRef'].nil?
-        return true if %w[Expression TextTemplate].include?(type) && expression_property(type, value)
-        return true if type == 'Attribute' && attribute_property(value)
+        return true if type == 'Selection'
+        return value['Icon'].nil? if type == 'Icon'
+        return value['Image'].to_s.empty? if type == 'Image'
+        return true if %w[Expression TextTemplate].include?(type) && expression_property(type, value, metadata)
+        return true if type == 'Attribute' && attribute_property(value, metadata)
         return no_action?(value) || !compiled_action(value).nil? if type == 'Action'
         return array(value['Widgets']).empty? || @render_widgets if type == 'Widgets'
-        return array(value['Objects']).empty? if type == 'Object'
+        return supported_objects?(value) if type == 'Object'
 
         false
       end
 
       def compile_property(pair)
-        type, value = pair
+        type, value, metadata = pair
         case type
         when 'Boolean' then value['PrimitiveValue'] == 'true'
         when 'Integer' then value['PrimitiveValue'].to_i
         when 'Decimal' then value['PrimitiveValue'].to_f
         when 'Enumeration', 'String' then value['PrimitiveValue'].to_s
-        when 'Expression', 'TextTemplate' then raw(expression_property(type, value))
+        when 'Expression', 'TextTemplate' then raw(expression_property(type, value, metadata))
         when 'DataSource' then database_list_property(value)&.then { raw(_1) } || :undefined
         when 'Action' then compiled_action(value)&.then { raw(_1) } || :undefined
         when 'Association' then :undefined
-        when 'Attribute' then attribute_property(value)&.then { raw(_1) } || :undefined
-        when 'Widgets' then compile_widgets(value)
-        when 'Object' then []
+        when 'Attribute' then attribute_property(value, metadata)&.then { raw(_1) } || :undefined
+        when 'Selection' then raw(selection_property(value))
+        when 'Icon', 'Image' then :undefined
+        when 'Widgets' then compile_widgets(value, metadata)
+        when 'Object' then compile_objects(value)
         else :undefined
         end
       end
 
-      def compile_widgets(value)
+      def compile_widgets(value, metadata = nil)
         widgets = array(value['Widgets'])
         return [] if widgets.empty?
 
-        @render_widgets.call(widgets)
+        rendered = @render_widgets.call(widgets)
+        return rendered unless data_source_bound?(metadata)
+
+        raw("TemplatedWidgetProperty(#{javascript(
+          children: raw("() => #{javascript(rendered)}"), dataSourceId: widget_key, editable: false
+        )})")
+      end
+
+      def supported_objects?(value)
+        array(value['Objects']).all? do |object|
+          values = property_values(object)
+          !values.empty? && values.values.all? { supported_property?(_1) }
+        end
       end
 
-      def expression_property(type, value)
+      def compile_objects(value)
+        array(value['Objects']).map do |object|
+          values = property_values(object)
+          with_list_data_source(values) do
+            values.each_with_object({}) do |(key, pair), result|
+              compiled = compile_property(pair)
+              result[key.to_sym] = compiled unless compiled.equal?(:undefined)
+            end
+          end
+        end
+      end
+
+      def with_list_data_source(values)
+        previous = @list_data_source
+        @list_data_source = values.values.find do |type, value, _metadata|
+          type == 'DataSource' && database_list_property(value)
+        end&.last
+        yield
+      ensure
+        @list_data_source = previous
+      end
+
+      def selection_property(value)
+        "SelectionProperty(#{javascript(selectionType: value.fetch('Selection', 'None'), dataSourceId: widget_key)})"
+      end
+
+      def expression_property(type, value, metadata = nil)
         expression = type == 'Expression' ? compile_expression(value['Expression']) : compile_template(value)
         return unless expression
 
+        list_bound = data_source_bound?(metadata) && @list_data_source
         args = expression_variables(expression).to_h do |variable|
-          [variable.to_sym, { widget: @scope, source: 'object' }]
+          [variable.to_sym, { widget: list_bound ? widget_key : @scope, source: 'object' }]
         end
-        property = @list_data_source ? 'ListExpressionProperty' : 'ExpressionProperty'
+        property = list_bound ? 'ListExpressionProperty' : 'ExpressionProperty'
         config = { expression: { expr: expression, args: } }
-        config[:dataSourceId] = widget_key if @list_data_source
+        config[:dataSourceId] = widget_key if list_bound
         "#{property}(#{javascript(config)})"
       end
 
@@ -200,11 +247,17 @@ module Mxrb
         pieces.compact.reduce { |left, right| { type: 'function', name: '+', parameters: [left, right] } }
       end
 
-      def attribute_property(value)
+      def attribute_property(value, metadata = nil)
         attribute = value.dig('AttributeRef', 'Attribute').to_s
-        return unless @scope && attribute.include?('.')
+        return unless (@scope || @list_data_source) && attribute.include?('.')
 
         entity, _, name = attribute.rpartition('.')
+        if data_source_bound?(metadata) && @list_data_source
+          return "ListAttributeProperty(#{javascript(
+            path: '', entity:, attribute: name, dataSourceId: widget_key, isList: false
+          )})"
+        end
+
         "AttributeProperty(#{javascript(
           scope: @scope, path: '', entity:, attribute: name,
           onChange: { type: 'doNothing', argMap: {}, config: {}, disabledDuringExecution: true },
@@ -212,6 +265,10 @@ module Mxrb
         )})"
       end
 
+      def data_source_bound?(metadata)
+        !metadata.to_h.fetch('DataSourceProperty', '').to_s.empty?
+      end
+
       def expression_variables(expression)
         case expression
         when Hash

data/lib/mxrb/compiler/legacy_custom_widget_compiler.rb

@@ -0,0 +1,159 @@
+# frozen_string_literal: true
+
+require 'zip'
+
+module Mxrb
+  module Compiler
+    # Serializes schema-described Mendix 6/7 custom widgets to their Dojo client contract.
+    # rubocop:disable Metrics
+    class LegacyCustomWidgetCompiler
+      include ModelValues
+
+      SUPPORTED_TYPES = %w[
+        Attribute Boolean Decimal Entity EntityConstraint Enumeration Form Image Integer
+        Microflow String System TranslatableString Object
+      ].freeze
+
+      attr_reader :widget_id
+
+      def initialize(source, widget, language:)
+        @source = source
+        @widget = widget
+        @language = language
+        @widget_type = widget['Type'] || {}
+        @widget_id = @widget_type['WidgetId'].to_s
+        @schema_index = schema_index(@widget_type)
+      end
+
+      def supported?
+        !widget_id.empty? && package_module? && properties(@widget['Object']).all? do |property|
+          type = property_type(property)
+          SUPPORTED_TYPES.include?(type) && supported_value?(type, property['Value'])
+        end
+      end
+
+      def properties_hash
+        properties(@widget['Object']).to_h do |property|
+          schema = property_schema(property)
+          [schema['PropertyKey'].to_s, compile_value(schema.dig('ValueType', 'Type'), property['Value'])]
+        end
+      end
+
+      private
+
+      def properties(object) = array(object&.fetch('Properties', nil))
+
+      def property_schema(property)
+        @schema_index[IO::BsonCodec.extract_id(property['TypePointer'])] || {}
+      end
+
+      def property_type(property) = property_schema(property).dig('ValueType', 'Type').to_s
+
+      def supported_value?(type, value)
+        value ||= {}
+        return objects(value).all? { supported_object?(_1) } if type == 'Object'
+        return !image_uri(value['Image']).nil? if type == 'Image' && !value['Image'].to_s.empty?
+
+        true
+      end
+
+      def supported_object?(object)
+        properties(object).all? do |property|
+          type = property_type(property)
+          SUPPORTED_TYPES.include?(type) && supported_value?(type, property['Value'])
+        end
+      end
+
+      def compile_value(type, value)
+        value ||= {}
+        case type
+        when 'Boolean' then value['PrimitiveValue'] == 'true'
+        when 'Integer' then value['PrimitiveValue'].to_i
+        when 'Decimal' then value['PrimitiveValue'].to_f
+        when 'Enumeration', 'String', 'System' then value['PrimitiveValue'].to_s
+        when 'TranslatableString' then translated(value['TranslatableValue'])
+        when 'Entity' then value['EntityPath'].to_s
+        when 'EntityConstraint' then value['XPathConstraint'].to_s
+        when 'Attribute' then relative_attribute(value['AttributePath'])
+        when 'Microflow' then value['Microflow'].to_s
+        when 'Form' then value['Form'].to_s
+        when 'Image' then value['Image'].to_s.empty? ? '' : image_uri(value['Image'])
+        when 'Object' then objects(value).map { compile_object(_1) }
+        end
+      end
+
+      def compile_object(object)
+        properties(object).to_h do |property|
+          schema = property_schema(property)
+          [schema['PropertyKey'].to_s, compile_value(schema.dig('ValueType', 'Type'), property['Value'])]
+        end
+      end
+
+      def objects(value) = array(value&.fetch('Objects', nil))
+
+      def relative_attribute(path)
+        value = path.to_s
+        value.split('.').last.to_s
+      end
+
+      def translated(text)
+        items = array(text&.fetch('Items', nil))
+        items.find { _1['LanguageCode'] == @language }&.fetch('Text', '') ||
+          items.find { _1['LanguageCode'] == 'en_US' }&.fetch('Text', '') ||
+          items.first&.fetch('Text', '') || ''
+      end
+
+      def image_uri(reference)
+        module_name, collection_name, image_name = reference.to_s.split('.', 3)
+        unit = @source.units_of('Images$ImageCollection').find do |candidate|
+          candidate.module_name == module_name && candidate.document['Name'] == collection_name
+        end
+        image = array(unit&.document&.fetch('Images', nil)).find { _1['Name'] == image_name }
+        unless image
+          return system_image_uri(collection_name, image_name) if module_name == 'System'
+
+          return
+        end
+
+        "img/#{module_name}$#{image_name}.#{image_format(image)}"
+      end
+
+      def system_image_uri(collection_name, image_name)
+        return if collection_name != 'Images' || image_name.to_s.empty?
+
+        extension = %w[Error Running Completed Module].include?(image_name) ? 'gif' : 'png'
+        "img/System$#{image_name}.#{extension}"
+      end
+
+      def schema_index(root)
+        index = {}
+        visit = lambda do |value|
+          case value
+          when Hash
+            id = IO::BsonCodec.extract_id(value['$ID'])
+            index[id] = value if id
+            value.each_value { visit.call(_1) }
+          when Array then value.each { visit.call(_1) }
+          end
+        end
+        visit.call(root)
+        index
+      end
+
+      def package_module?
+        return true unless @source.is_a?(SourceModel)
+
+        entry = "#{widget_id.tr('.', '/')}.js"
+        root = File.join(File.dirname(@source.path), 'widgets')
+        return true if File.file?(File.join(root, entry))
+
+        Dir.glob(File.join(root, '*.mpk')).any? do |path|
+          Zip::File.open(path) { _1.find_entry(entry) }
+        rescue Zip::Error
+          false
+        end
+      end
+    end
+    # rubocop:enable Metrics
+  end
+end

data/lib/mxrb/compiler/legacy_data_grid_compiler.rb

@@ -21,7 +21,9 @@ module Mxrb
         'Forms$GridNewButton' => 'InsertNew',
         'Forms$GridEditButton' => 'EditSelection',
         'Forms$GridDeleteButton' => 'DeleteSelection',
-        'Forms$GridActionButton' => 'InvokeAction'
+        'Forms$GridActionButton' => 'InvokeAction',
+        'Forms$DataGridAddButton' => 'AddRef',
+        'Forms$DataGridRemoveButton' => 'DeleteRef'
       }.freeze
 
       attr_reader :unsupported
@@ -38,16 +40,18 @@ module Mxrb
       def html
         props = JSON.generate(properties)[1..-2]
         attributes = {
-          'data-mendix-id' => widget_id, 'data-mendix-type' => 'mxui.widget.DataGrid',
+          'data-mendix-id' => widget_id, 'data-mendix-type' => client_widget_type,
           'data-mendix-props' => props, 'class' => css_class, 'tabindex' => @widget['TabIndex'].to_i
         }
         "<div #{attributes.map { |key, value| "#{key}='#{escape(value)}'" }.join(' ')}></div>"
       end
 
+      def id = widget_id
+
       private
 
       def properties
-        {
+        result = {
           'friendlyId' => friendly_id, 'entity' => entity, 'schema' => entity_schema,
           'config' => {
             'locale' => @language, 'gridType' => 'Standalone',
@@ -57,11 +61,14 @@ module Mxrb
             'griddata' => columns.map { compile_column(_1) }, 'plugins' => {}
           }
         }
+        result['xpathConstraint'] = @widget['SelectableXPathConstraint'].to_s if reference_set?
+        result
       end
 
       def presentation
         {
-          'rows' => @widget['NumberOfRows'].to_i, 'columns' => 1,
+          'rows' => @widget['NumberOfRows'].to_i,
+          'columns' => template_grid? ? [@widget['NumberOfColumns'].to_i, 1].max : 1,
           'controlbar' => @widget['IsControlBarVisible'] == true,
           'pagingbar' => @widget['IsPagingEnabled'] == true,
           'sortparams' => sort_items, 'searchbar' => !search_elements.empty?,
@@ -74,6 +81,8 @@ module Mxrb
       end
 
       def datasource
+        return reference_set_datasource if reference_set?
+
         type = SOURCE_TYPES[data_source['$Type']]
         @unsupported << data_source['$Type'].to_s unless type
         result = { 'friendlyId' => friendly_id, 'type' => type || 'unsupported', 'path' => entity }
@@ -136,7 +145,7 @@ module Mxrb
 
       def button_params(button)
         case button['$Type']
-        when 'Forms$GridNewButton', 'Forms$GridEditButton'
+        when 'Forms$GridNewButton', 'Forms$GridEditButton', 'Forms$DataGridAddButton'
           { entity => { 'pageSettings' => page_settings(button['FormSettings']) } }
         when 'Forms$GridActionButton'
           { entity => { 'action' => client_action(button['Action']),
@@ -200,7 +209,17 @@ module Mxrb
 
       def entity
         direct = data_source['EntityPath'] || data_source.dig('EntityRef', 'Entity')
-        direct.to_s.empty? ? attribute_path(columns.first).to_s.rpartition('.').first : direct.to_s
+        value = direct.to_s.empty? ? attribute_path(columns.first).to_s.rpartition('.').first : direct.to_s
+        reference_set? ? value.split('/').last.to_s : value
+      end
+
+      def reference_set_datasource
+        {
+          'friendlyId' => friendly_id, 'path' => entity, 'entity' => entity,
+          'reference' => data_source['EntityPath'].to_s.split('/').first.to_s,
+          'sort' => sort_items, 'attributes' => columns.map { relative_attribute(attribute_path(_1)) },
+          'distinct' => false
+        }
       end
 
       def entity_schema
@@ -233,10 +252,27 @@ module Mxrb
       def widget_id = "#{@sequence}_#{buttons.length}"
 
       def css_class
-        ['mx-datagrid', "mx-name-#{@widget['Name']}", @widget['Class']]
+        [widget_css_class, "mx-name-#{@widget['Name']}", @widget['Class']]
           .map(&:to_s).reject(&:empty?).uniq.join(' ')
       end
 
+      def client_widget_type
+        return 'mxui.widget.TemplateGrid' if template_grid?
+        return 'mxui.widget.ReferenceSetSelector' if reference_set?
+
+        'mxui.widget.DataGrid'
+      end
+
+      def widget_css_class
+        return 'mx-templategrid' if template_grid?
+        return 'mx-referencesetselector' if reference_set?
+
+        'mx-datagrid'
+      end
+
+      def template_grid? = @widget['$Type'] == 'Forms$TemplateGrid'
+      def reference_set? = @widget['$Type'] == 'Forms$ReferenceSetSelector'
+
       def translated(text)
         items = array(text&.fetch('Items', nil))
         items.find { _1['LanguageCode'] == @language }&.fetch('Text', '') ||