glib-web 0.5.77 → 0.5.78

data/app/helpers/glib/json_ui/view_builder/fields.rb

@@ -1,291 +1,291 @@
-class Glib::JsonUi::ViewBuilder
-  module Fields
-
-    class AbstractField < View
-      bool :readOnly
-      hash :validation
-      # string :label
-
-      def label(label)
-        @label = label
-      end
-
-      def label_args(label_args)
-        @label_args = label_args
-      end
-
-      def hint(hint)
-        @hint = hint
-      end
-
-      def hint_args(hint_args)
-        @hint_args = hint_args
-      end
-
-      def placeholder(placeholder)
-        @placeholder = placeholder
-      end
-
-      def placeholder_args(placeholder_args)
-        @placeholder_args = placeholder_args
-      end
-
-      def name(name)
-        @name = name if name != Glib::Value::DEFAULT
-      end
-
-      def value(value)
-        @value = value if value != Glib::Value::DEFAULT
-      end
-
-      def prop(prop)
-        @prop = prop
-      end
-
-      # Override
-      def created
-        if @prop && (form = page.current_form)
-          form.field_assert_respond_to(@prop)
-
-          @name ||= form.field_name(@prop, @multiple || false)
-          @value ||= form.field_value(@prop)
-          @label ||= form.field_label(@prop, @label_args || {})
-          @hint ||= form.hint_label(@prop, @hint_args || {})
-          @placeholder ||= form.placeholder_label(@prop, @placeholder_args || {})
-
-          @validation ||= form.field_validation(@prop)
-        end
-        json.name @name
-        json.value @value if @value
-        json.label @label if @label
-        json.hint @hint if @hint
-
-        # In general, use hint over placeholder for the following reasons:
-        # - Placeholder gets hidden when there is input which may be confusing
-        # - Placeholder competes with label for space
-        json.placeholder @placeholder if @placeholder
-
-        # TODO: Add a flag so the framework's user can turn it on and off.
-        # json.validation @validation if @validation
-      end
-
-    end
-
-    class Text < AbstractField
-      int :maxLength
-      icon :leftIcon
-      string :leftText
-      string :rightText
-      action :onTypeStart
-      action :onTypeEnd
-    end
-
-    class Number < Text
-      int :min
-      int :max
-    end
-
-    class Email < Text
-    end
-
-    class Url < Text
-    end
-
-    class Password < Text
-    end
-
-    class Hidden < Text
-    end
-
-    class Timer < Text
-      hash :actionCable
-      int :min
-      int :max
-      bool :forward
-    end
-
-    # Benefits of using `fields/submit` over `button`
-    # - On the web, it translates to input[type=submit] which provides builtin functionality such as
-    #   submitting upon pressing enter on a field and remembering values for autofill.
-    # - We can attach name-value param to it. See https://www.w3schools.com/tags/att_button_value.asp
-    # - It has a default onClick so no need to specify `onClick: ->(action) { action.forms_submit }`
-    class Submit < AbstractField
-      string :text
-      color :color
-    end
-
-    class CheckGroup < AbstractField
-      views :childViews
-      string :uncheckValue
-    end
-
-    class Check < Text
-      any :uncheckValue
-      any :checkValue
-
-
-      def value(value)
-        @value = value if value != Glib::Value::DEFAULT
-      end
-
-      # TODO: Remove (deprecated). Where possible, use value instead of this
-      bool :checked
-    end
-
-    # This doesn't use camel case because some terms have become single words (e.g. snackbar)
-    class Textarea < Text
-    end
-
-    class RichText < Text
-      array :images
-    end
-
-    class Country < AbstractField
-      hash :region
-    end
-
-    class Select < AbstractField
-      array :options
-      # bool :readOnly
-      bool :multiple, cache: true
-      # bool :manualEntry
-      hash :append
-    end
-
-    class TimeZone < AbstractField
-      include Glib::EnumHelper
-
-      # Override
-      def created
-        super
-
-        json.options glib_time_zone_options
-      end
-    end
-
-    # TODO: Remove (deprecated)
-    class Autocomplete < AbstractField
-      array :options
-      # bool :readOnly
-      bool :multiple, cache: true
-      # bool :manualEntry
-      hash :append
-    end
-
-    class DynamicSelect < AbstractField
-      array :selectedOptions
-      string :url
-      bool :multiple, cache: true
-
-      # Override
-      def value(value)
-        raise 'Use selectedOptions instead (for clarity)'
-      end
-    end
-
-    class DynamicGroup < AbstractField
-      string :titlePrefix
-      panels_builder :content, :template
-      hash :groupFieldProperties
-
-      # NOTE: Consider using sub-panel instead (e.g. groupTemplate)
-      # views :groupTemplateViews
-    end
-
-    class RadioGroup < AbstractField
-      # string :name
-      # string :value
-      views :childViews
-
-      # Override
-      def value(value)
-        # Convert to string to make sure the value matches with Radio#value
-        @value = value.to_s if value != Glib::Value::DEFAULT
-      end
-
-      string :iconOfBeforeSelected
-      string :iconOfSelected
-      string :iconOfAfterSelected
-    end
-
-    class Radio < View
-      string :label
-      string :value
-    end
-
-    class File < Text
-      # file_rules = { fileType: 'image/*', maxFileSize: 5000 }
-      # file_rules = { fileType: 'video/*', maxFileSize: 50000 }
-      # file_rules = { fileType: 'application/pdf', maxFileSize: 5000 }
-      hash :accepts
-
-      string :directUploadUrl
-      string :fileUrl
-      string :fileTitle
-      hash :placeholderView
-    end
-
-    # TODO
-    # class MultiImage < Text
-    #   # file_rules = { fileType: 'image/*', maxFileSize: 5000 }
-    #   # file_rules = { fileType: 'video/*', maxFileSize: 50000 }
-    #   # file_rules = { fileType: 'application/pdf', maxFileSize: 5000 }
-    #   # hash :accepts
-
-    #   string :directUploadUrl
-    #   # string :fileUrl
-    #   # string :fileTitle
-    #   hash :placeholderView
-    # end
-
-    class Date < AbstractField
-      date :min
-      date :max
-
-      # Override
-      def value(value)
-        super(value&.to_date)
-      end
-    end
-
-    # This doesn't use camel case to be consistent with the html input equivalent
-    class Datetime < AbstractField
-      date_time :min
-      date_time :max
-    end
-
-    class Location < AbstractField
-      hash :latitudeField
-      hash :longitudeField
-      hash :zoomField
-      hash :autocompleteOptions
-    end
-
-    class StripeToken < AbstractField
-      string :publicKey
-    end
-
-    class StripeExternalAccount < AbstractField
-      string :publicKey
-      string :accountHolderName
-      string :accountHolderType
-      string :country
-      string :currency
-    end
-
-    class Phone < AbstractField
-      string :defaultCountry
-      bool :disableAutoDetect
-    end
-
-    class CreditCard < AbstractField
-      string :publicKey
-    end
-
-    class Rating < AbstractField
-      bool    :halfIncrements
-      string  :color
-      int     :size
-    end
-  end
-end
+class Glib::JsonUi::ViewBuilder
+  module Fields
+
+    class AbstractField < View
+      bool :readOnly
+      hash :validation
+      # string :label
+
+      def label(label)
+        @label = label
+      end
+
+      def label_args(label_args)
+        @label_args = label_args
+      end
+
+      def hint(hint)
+        @hint = hint
+      end
+
+      def hint_args(hint_args)
+        @hint_args = hint_args
+      end
+
+      def placeholder(placeholder)
+        @placeholder = placeholder
+      end
+
+      def placeholder_args(placeholder_args)
+        @placeholder_args = placeholder_args
+      end
+
+      def name(name)
+        @name = name if name != Glib::Value::DEFAULT
+      end
+
+      def value(value)
+        @value = value if value != Glib::Value::DEFAULT
+      end
+
+      def prop(prop)
+        @prop = prop
+      end
+
+      # Override
+      def created
+        if @prop && (form = page.current_form)
+          form.field_assert_respond_to(@prop)
+
+          @name ||= form.field_name(@prop, @multiple || false)
+          @value ||= form.field_value(@prop)
+          @label ||= form.field_label(@prop, @label_args || {})
+          @hint ||= form.hint_label(@prop, @hint_args || {})
+          @placeholder ||= form.placeholder_label(@prop, @placeholder_args || {})
+
+          @validation ||= form.field_validation(@prop)
+        end
+        json.name @name
+        json.value @value if @value
+        json.label @label if @label
+        json.hint @hint if @hint
+
+        # In general, use hint over placeholder for the following reasons:
+        # - Placeholder gets hidden when there is input which may be confusing
+        # - Placeholder competes with label for space
+        json.placeholder @placeholder if @placeholder
+
+        # TODO: Add a flag so the framework's user can turn it on and off.
+        # json.validation @validation if @validation
+      end
+
+    end
+
+    class Text < AbstractField
+      int :maxLength
+      icon :leftIcon
+      string :leftText
+      string :rightText
+      action :onTypeStart
+      action :onTypeEnd
+    end
+
+    class Number < Text
+      int :min
+      int :max
+    end
+
+    class Email < Text
+    end
+
+    class Url < Text
+    end
+
+    class Password < Text
+    end
+
+    class Hidden < Text
+    end
+
+    class Timer < Text
+      hash :actionCable
+      int :min
+      int :max
+      bool :forward
+    end
+
+    # Benefits of using `fields/submit` over `button`
+    # - On the web, it translates to input[type=submit] which provides builtin functionality such as
+    #   submitting upon pressing enter on a field and remembering values for autofill.
+    # - We can attach name-value param to it. See https://www.w3schools.com/tags/att_button_value.asp
+    # - It has a default onClick so no need to specify `onClick: ->(action) { action.forms_submit }`
+    class Submit < AbstractField
+      string :text
+      color :color
+    end
+
+    class CheckGroup < AbstractField
+      views :childViews
+      string :uncheckValue
+    end
+
+    class Check < Text
+      any :uncheckValue
+      any :checkValue
+
+
+      def value(value)
+        @value = value if value != Glib::Value::DEFAULT
+      end
+
+      # TODO: Remove (deprecated). Where possible, use value instead of this
+      bool :checked
+    end
+
+    # This doesn't use camel case because some terms have become single words (e.g. snackbar)
+    class Textarea < Text
+    end
+
+    class RichText < Text
+      array :images
+    end
+
+    class Country < AbstractField
+      hash :region
+    end
+
+    class Select < AbstractField
+      array :options
+      # bool :readOnly
+      bool :multiple, cache: true
+      # bool :manualEntry
+      hash :append
+    end
+
+    class TimeZone < AbstractField
+      include Glib::EnumHelper
+
+      # Override
+      def created
+        super
+
+        json.options glib_time_zone_options
+      end
+    end
+
+    # TODO: Remove (deprecated)
+    class Autocomplete < AbstractField
+      array :options
+      # bool :readOnly
+      bool :multiple, cache: true
+      # bool :manualEntry
+      hash :append
+    end
+
+    class DynamicSelect < AbstractField
+      array :selectedOptions
+      string :url
+      bool :multiple, cache: true
+
+      # Override
+      def value(value)
+        raise 'Use selectedOptions instead (for clarity)'
+      end
+    end
+
+    class DynamicGroup < AbstractField
+      string :titlePrefix
+      panels_builder :content, :template
+      hash :groupFieldProperties
+
+      # NOTE: Consider using sub-panel instead (e.g. groupTemplate)
+      # views :groupTemplateViews
+    end
+
+    class RadioGroup < AbstractField
+      # string :name
+      # string :value
+      views :childViews
+
+      # Override
+      def value(value)
+        # Convert to string to make sure the value matches with Radio#value
+        @value = value.to_s if value != Glib::Value::DEFAULT
+      end
+
+      string :iconOfBeforeSelected
+      string :iconOfSelected
+      string :iconOfAfterSelected
+    end
+
+    class Radio < View
+      string :label
+      string :value
+    end
+
+    class File < Text
+      # file_rules = { fileType: 'image/*', maxFileSize: 5000 }
+      # file_rules = { fileType: 'video/*', maxFileSize: 50000 }
+      # file_rules = { fileType: 'application/pdf', maxFileSize: 5000 }
+      hash :accepts
+
+      string :directUploadUrl
+      string :fileUrl
+      string :fileTitle
+      hash :placeholderView
+    end
+
+    # TODO
+    # class MultiImage < Text
+    #   # file_rules = { fileType: 'image/*', maxFileSize: 5000 }
+    #   # file_rules = { fileType: 'video/*', maxFileSize: 50000 }
+    #   # file_rules = { fileType: 'application/pdf', maxFileSize: 5000 }
+    #   # hash :accepts
+
+    #   string :directUploadUrl
+    #   # string :fileUrl
+    #   # string :fileTitle
+    #   hash :placeholderView
+    # end
+
+    class Date < AbstractField
+      date :min
+      date :max
+
+      # Override
+      def value(value)
+        super(value&.to_date)
+      end
+    end
+
+    # This doesn't use camel case to be consistent with the html input equivalent
+    class Datetime < AbstractField
+      date_time :min
+      date_time :max
+    end
+
+    class Location < AbstractField
+      hash :latitudeField
+      hash :longitudeField
+      hash :zoomField
+      hash :autocompleteOptions
+    end
+
+    class StripeToken < AbstractField
+      string :publicKey
+    end
+
+    class StripeExternalAccount < AbstractField
+      string :publicKey
+      string :accountHolderName
+      string :accountHolderType
+      string :country
+      string :currency
+    end
+
+    class Phone < AbstractField
+      string :defaultCountry
+      bool :disableAutoDetect
+    end
+
+    class CreditCard < AbstractField
+      string :publicKey
+    end
+
+    class Rating < AbstractField
+      bool    :halfIncrements
+      string  :color
+      int     :size
+    end
+  end
+end

data/app/helpers/glib/json_ui/view_builder/iap.rb

@@ -0,0 +1,11 @@
+class Glib::JsonUi::ViewBuilder
+  module Iap
+
+    class ProductButton < View
+      string :text
+      string :productId
+      action :onClick
+    end
+
+  end
+end