glib-web 0.5.5

data/app/helpers/glib/json_ui/action_builder.rb

@@ -0,0 +1,81 @@
+module Glib
+  module JsonUi
+    class ActionBuilder < AbstractBuilder
+      def method_missing m, *args
+        add_singleton_element_v1 'action', m, *args
+      end
+
+      class Action < JsonUiElement
+        def analytics(value)
+          if value.is_a?(String)
+            @analyticsEnabled = true
+            @analyticsId = value
+          else
+            @analyticsEnabled = value == true
+          end
+        end
+
+        # Override
+        def created
+          if @analyticsEnabled
+            suffix = @analyticsId
+            # TODO: recognize_path() needs `method` as a second argument for POST request
+            if suffix.nil? && @url && (route = Rails.application.routes.recognize_path(@url))
+              suffix = "#{route[:controller]}_#{route[:action]}"
+            end
+
+            if suffix
+              json.analytics do
+                json.track :event
+                json.nameSuffix suffix
+              end
+            end
+
+          end
+        end
+
+      end
+
+      ### Action definitions
+
+      module Forms
+        class Submit < Action
+        end
+
+      end
+
+      # Consider deprecating this. See Data
+      module Auth
+        class SaveCsrfToken < Action
+          string :token
+          action :onSave
+        end
+
+      end
+
+      module Timeouts
+        class Set < Action
+          int :interval  # Milliseconds
+          action :onTimeout
+        end
+
+        # FUTURE
+        class Clear < Action
+        end
+      end
+
+      # FUTURE
+      module Data
+        class SaveCsrfToken < Action
+          string :token
+          action :onSave
+        end
+
+        class Clear < Action
+        end
+      end
+
+      ###
+    end
+  end
+end

data/app/helpers/glib/json_ui/action_builder/dialogs.rb

@@ -0,0 +1,58 @@
+class Glib::JsonUi::ActionBuilder
+  module Dialogs
+    class Alert < Action
+      string :message
+      action :onLoad
+      action :onClose
+    end
+
+    class Show < Action
+      string :body
+      action :onLoad
+      action :onClose
+    end
+
+    # Deprecated in favour of `sheets/select`
+    class Options < Action
+      string :message
+
+      def buttons(block)
+        json.buttons do
+          block.call page.menu_builder
+        end
+      end
+    end
+
+    class Show < Action
+      panels_builder :content, :body
+
+      # Future plan
+      # panels_builder :content, :body, :footer
+    end
+
+    class Open < Action
+      string :url, cache: true
+    end
+
+    class Close < Action
+      action :onClose
+    end
+
+    class Oauth < Action
+      hash :provider
+      action :onSuccess
+      string :providerParamName
+      string :callbackUrlParamName
+    end
+
+    # TODO: Consider switching to `notifications/alert`
+    class Notification < Action
+      string :title
+      string :message
+      string :tag
+      int :timeout
+      action :onClick
+    end
+
+  end
+end

data/app/helpers/glib/json_ui/action_builder/http.rb

@@ -0,0 +1,19 @@
+class Glib::JsonUi::ActionBuilder
+  module Http
+    class Post < Action
+      string :url, cache: true
+      hash :formData
+    end
+
+    class Patch < Action
+      string :url, cache: true
+      hash :formData
+    end
+
+    class Delete < Action
+      string :url, cache: true
+      hash :formData
+    end
+
+  end
+end

data/app/helpers/glib/json_ui/action_builder/sheets.rb

@@ -0,0 +1,15 @@
+class Glib::JsonUi::ActionBuilder
+  module Sheets
+
+    class Select < Action
+      string :message
+
+      def buttons(block)
+        json.buttons do
+          block.call page.menu_builder
+        end
+      end
+    end
+
+  end
+end

data/app/helpers/glib/json_ui/action_builder/snackbars.rb

@@ -0,0 +1,41 @@
+class Glib::JsonUi::ActionBuilder
+
+  module Snackbars
+    class Alert < Action
+      string :message
+      # string :message_format
+      action :onClose
+
+      string :verticalPosition
+      string :horizontalPosition
+      singleton_array :styleClass, :styleClasses
+    end
+
+    # class Confirm < Action
+    #   string :message
+    #   action :onConfirm
+    #   action :onCancel
+
+    #   string :verticalPosition
+    #   string :horizontalPosition
+    #   singleton_array :styleClass, :styleClasses
+    # end
+
+    class Select < Action
+      string :message
+
+      string :verticalPosition
+      string :horizontalPosition
+      singleton_array :styleClass, :styleClasses
+
+      def buttons(block)
+        json.buttons do
+          block.call page.menu_builder
+        end
+      end
+
+    end
+
+  end
+
+end

data/app/helpers/glib/json_ui/action_builder/windows.rb

@@ -0,0 +1,25 @@
+class Glib::JsonUi::ActionBuilder
+  module Windows
+    class Close < Action
+      action :onClose
+    end
+
+    class CloseAll < Action
+      action :onClose
+    end
+
+    class Open < Action
+      string :url, cache: true
+      action :onOpen
+    end
+
+    class OpenWeb < Action
+      string :url
+    end
+
+    class Reload < Action
+      string :url, cache: true
+      action :onReload
+    end
+  end
+end

data/app/helpers/glib/json_ui/dynamic_field_builders.rb

@@ -0,0 +1,25 @@
+module Glib
+  module JsonUi
+    module DynamicFieldBuilders
+      
+      class Group < AbstractBuilder
+        def initialize json, page, template
+          super json, page
+          @template = template
+        end
+
+        # string :titlePrefix
+        def titlePrefix(string)
+          json.titlePrefix string
+        end
+
+        def template(options = {})
+          # json.template do
+            page.vertical_content(options)
+          # end
+        end
+      end
+      
+    end
+  end
+end

data/app/helpers/glib/json_ui/generic_builders.rb

@@ -0,0 +1,28 @@
+module Glib
+  module JsonUi
+    module GenericBuilders
+
+      class Content < AbstractBuilder
+        def initialize(json, page, template)
+          super json, page
+          @template = template
+        end
+
+        def definePanels(names)
+          names.each do |name|
+            define_singleton_method(name) do |options|
+              json.set!(name) { page.vertical_content(options) }
+            end
+          end
+        end
+
+        # def body(options = {})
+        #   json.body do
+        #     page.vertical_content(options)
+        #   end
+        # end
+      end
+
+    end
+  end
+end

data/app/helpers/glib/json_ui/list_builders.rb

@@ -0,0 +1,87 @@
+module Glib
+  module JsonUi
+    module ListBuilders
+      class Template < AbstractBuilder
+        def method_missing(m, *args)
+          add_element_to_array 'template', m, *args
+        end
+
+        class AbstractTemplate < JsonUiElement
+          # hash :padding
+
+          def editButtons(block)
+            json.editButtons do
+              block.call page.menu_builder
+            end
+          end
+
+          def chips(block)
+            json.chips do
+              block.call page.menu_builder
+            end
+          end
+        end
+
+        class Thumbnail < AbstractTemplate
+          string :title
+          string :subtitle
+          string :subsubtitle
+          string :imageUrl
+          action :onClick
+          icon :icon
+          bool :avatar
+
+          # # NOTE: Experimental. Still deciding whether this needs to be a full blown panel or
+          # # an array of badges (with relevant properties, e.g. text, color, etc)
+          # views :accessoryViews
+        end
+
+        class Featured < Thumbnail
+        end
+
+        class Custom < Thumbnail
+          string :template
+
+          # TODO: Experimental
+          hash :extra
+
+          # TODO: Deprecate
+          hash :data
+        end
+      end
+
+      class Section < AbstractBuilder
+        def initialize(json, page, template)
+          super json, page
+          @template = template
+        end
+
+        def header(options = {})
+          json.header do
+            page.vertical_content(options)
+          end
+        end
+
+        def rows(options = {})
+          block = options[:builder]
+          json.rows do
+            if (objects = options[:objects])
+              objects.each_with_index do |object, index|
+                block&.call @template, object, index
+              end
+            else
+              block&.call @template
+            end
+          end
+        end
+
+        def footer(options = {})
+          json.footer do
+            page.vertical_content(options)
+          end
+        end
+      end
+
+    end
+  end
+end

data/app/helpers/glib/json_ui/menu_builder.rb

@@ -0,0 +1,52 @@
+module Glib
+  module JsonUi
+    class MenuBuilder < AbstractBuilder
+      def method_missing m, *args
+        add_element_to_array_v1 nil, m, *args
+      end
+
+      class MenuItem < JsonUiElement
+      end
+
+      class Button < MenuItem
+        string :text
+        icon :icon
+        action :onClick
+        bool :disabled
+        singleton_array :styleClass, :styleClasses
+
+        def childItems(block)
+          json.childItems do
+            block.call page.menu_builder
+          end
+        end
+
+        def created
+          json.type 'button'
+        end
+      end
+
+      class Divider < MenuItem
+        # Override
+        def created
+          json.type 'divider'
+        end
+      end
+
+      class Label < MenuItem
+        string :text
+        singleton_array :styleClass, :styleClasses
+
+        # Override
+        def created
+          json.type 'label'
+        end
+      end
+
+      class MenuLeftBottom < Button
+        icon :icon
+        array :buttons
+      end
+    end
+  end
+end

data/app/helpers/glib/json_ui/page_helper.rb

@@ -0,0 +1,187 @@
+module Glib
+  module JsonUi
+    module PageHelper
+      def json_ui_garage_url(options = {})
+        Glib::Web::Engine.routes.url_helpers.json_ui_garage_url(options.merge(
+          protocol: request.protocol,
+          host: request.host,
+          port: request.port,
+          _render: params[:_render], format: params[:format])
+        )
+      end
+
+      # TODO: Remove the block
+      def json_ui_page(json, &block)
+        @__json_ui_page ||= Page.new(json, self)
+        block&.call @__json_ui_page
+        @__json_ui_page
+      end
+
+      # # Use this only if you need to generate json independently from the current `json_ui_page`
+      # def json_ui_menu(&block)
+      #   @__json_ui_menu_page ||= Page.new(Jbuilder.new, self)
+      #   json = @__json_ui_menu_page.json
+      #   json.nil!
+      #   block&.call @__json_ui_menu_page.menu_builder
+      #   json.attributes!
+      # end
+
+      # # Use this only if you need to generate json independently from the current `json_ui_page`
+      # def json_ui_panel(&block)
+      #   @__json_ui_panel_page ||= Page.new(Jbuilder.new, self)
+      #   json = @__json_ui_panel_page.json
+      #   json.nil!
+      #   block&.call @__json_ui_panel_page.view_builder
+      #   json.attributes!
+      # end
+
+      def json_ui_section(json, &block)
+        @__json_ui_section ||= Page.new(json, self)
+        @__json_ui_section.list_section_builder
+      end
+
+      class Page
+        attr_reader :json, :context, :view_builder, :action_builder, :menu_builder
+        attr_reader :list_section_builder, :table_section_builder, :drawer_content_builder, :split_content_builder
+
+        # See Panels::Form
+        attr_accessor :current_form
+
+        def initialize(json, context)
+          @json = json
+          @context = context
+
+          @view_builder = ViewBuilder.new(json, self, true)
+          @action_builder = ActionBuilder.new(json, self)
+          @menu_builder = MenuBuilder.new(json, self)
+
+          @list_section_builder = ListBuilders::Section.new(json, self, ListBuilders::Template.new(json, self))
+          @drawer_content_builder = ListBuilders::Section.new(json, self, @menu_builder)
+          @table_section_builder = TableBuilders::Section.new(json, self, TableBuilders::Template.new(json, self))
+          @split_content_builder = SplitBuilders::Content.new(json, self, @view_builder)
+
+          # TODO: Deprecate
+          # For generic `body` builder. For others, use content_builder()
+          # @generic_content_builder = GenericBuilders::Content.new(json, self, @view_builder)
+        end
+
+        def content_builder(panelNames)
+          # NOTE: Can potentially be cached
+          builder = GenericBuilders::Content.new(json, self, @view_builder)
+          builder.definePanels(panelNames)
+          builder
+        end
+
+        def rightNavButtons
+          json.rightNavButtons do
+            yield @menu_builder
+          end
+        end
+
+        def template(template)
+          json.template template
+        end
+
+        def leftDrawer(options = {})
+          json.leftDrawer do
+            [:styleClasses].each do |name|
+              if (value = options.delete(name))
+                json.set! name, value
+              end
+            end
+            options[:content]&.call drawer_content_builder
+          end
+        end
+
+        def navBar(options = {})
+          json.navBar do
+            # json.leftItems do
+            #   options[:leftItems]&.call @menu_builder
+            # end
+            # json.logoUrl "http://localhost:3000/assets/logo_dark-02d9b6a91fdbf22515da7b921d31367b70696214415f6789d2f90232e4a287b7.svg"
+            json.rightItems do
+              options[:rightItems]&.call @menu_builder
+            end
+          end
+        end
+
+        def header(options = {})
+          json.header do
+            vertical_content(options)
+          end
+        end
+
+        def footer(options = {})
+          json.footer do
+            vertical_content(options)
+          end
+        end
+
+        def body(options = {})
+          json.body do
+            vertical_content(options)
+          end
+        end
+
+        def list(options = {})
+          json.body do
+            json.childViews do
+              @view_builder.add_view('panels_list', options.reverse_merge(width: 'matchParent'))
+            end
+          end
+        end
+
+        def table(options = {})
+          json.body do
+            json.childViews do
+              @view_builder.add_view('panels_table', options.reverse_merge(width: 'matchParent'))
+            end
+          end
+        end
+
+        def scroll(options = {})
+          json.body do
+            json.childViews do
+              @view_builder.add_view('panels_scroll', options.reverse_merge(width: 'matchParent'))
+            end
+          end
+        end
+
+        def form(options = {})
+          scroll childViews: ->(scroll) do
+            @view_builder.add_view('panels_form', options.reverse_merge(width: 'matchParent'))
+          end
+        end
+
+        def data(options = {})
+          options[:content].call(ViewBuilder.new(json, self, false))
+        end
+
+        def vertical_content(options)
+          # TODO: try disabling this
+          # options = options.reverse_merge(width: 'matchParent')
+
+          [:padding, :backgroundColor, :width, :height].each do |name|
+            if (value = options.delete(name))
+              json.set! name, value
+            end
+          end
+          json.childViews do
+            if (childViews = options.delete(:childViews))
+              childViews.call @view_builder
+            end
+          end
+
+          raise "Invalid properties: #{options.keys}" if options.size > 0
+        end
+
+        def onLoad(options = {})
+          json.onLoad do
+            yield @action_builder
+          end
+        end
+
+      end
+    end
+  end
+end