yui_rest_client 0.5.0

data/lib/yui_rest_client/widgets/tab.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module YuiRestClient
+  module Widgets
+    # Class representing a tab in the UI. It can be YDumbTab.
+    class Tab < Widgets::Base
+      # Returns the list of items available to select from tab.
+      # @return [Array] array of String objects.
+      # @example Get items from tab with id "test_id"
+      #   {
+      #     "class": "YDumbTab",
+      #     "debug_label": "YDumbTab [tab1] [tab2] [tab3]",
+      #     "hstretch": true,
+      #     "icon_base_path": "",
+      #     "id": "test_id",
+      #     "items": [
+      #       {
+      #         "label": "tab1"
+      #       },
+      #       {
+      #         "label": "tab2",
+      #         "selected": true
+      #       },
+      #       {
+      #         "label": "tab3"
+      #       }
+      #     ],
+      #     "items_count": 3,
+      #     "vstretch": true
+      #   }
+      # @example
+      #   app.tab(id: 'test').items
+      #   # tab1
+      #   # tab2
+      #   # tab3
+      def items
+        property(:items).map { |x| x[:label] }
+      end
+
+      # Sends action to click the tab in UI.
+      # @param item [String] value to select from items.
+      # @return [Tab] in case action is successful
+      # @example Click tab with id 'test'
+      #   app.button(id: 'test', value: test_item).select
+      def select(item)
+        action(action: Actions::SELECT, value: item)
+        self
+      end
+
+      # Returns the label of the selected tab.
+      # @return [String] label of the tab selected
+      # @example Get items from tab with id "test_id"
+      #   {
+      #     "class": "YDumbTab",
+      #     "debug_label": "YDumbTab [tab1] [tab2] [tab3]",
+      #     "hstretch": true,
+      #     "icon_base_path": "",
+      #     "id": "test_id",
+      #     "items": [
+      #       {
+      #         "label": "tab1"
+      #       },
+      #       {
+      #         "label": "tab2",
+      #         "selected": true
+      #       },
+      #       {
+      #         "label": "tab3"
+      #       }
+      #     ],
+      #     "items_count": 3,
+      #     "vstretch": true
+      #   }
+      # @example
+      #   app.tab(id: 'test').selected_item  # tab2
+      def selected_item
+        property(:items).select { |x| x[:selected] }.first[:label]
+      end
+    end
+  end
+end

data/lib/yui_rest_client/widgets/table.rb

@@ -0,0 +1,154 @@
+# frozen_string_literal: true
+
+module YuiRestClient
+  module Widgets
+    # Class representing a table in the UI. It can be YTable
+    class Table < Widgets::Base
+      # Returns whether the table contains any row or not
+      # @return [Boolean] true if table is empty, otherwise false
+      # @example Check if table with id "test_id" is empty
+      #     {
+      #       "class": "YTable",
+      #       "columns": 4,
+      #       "header": [
+      #         "header1",
+      #         "header2",
+      #         "header3",
+      #         "header4"
+      #       ],
+      #       "id": "test_id",
+      #       "items": null,
+      #       "items_count": 0
+      #     }
+      # @example
+      #   app.table(id: 'test_id').empty?
+      def empty?
+        property(:items).nil?
+      end
+
+      # Returns the list of items available to select from the table.
+      # @return [Array] array of [Array] objects containing values for each column
+      # @example Get items from the table with id "test_id"
+      #     {
+      #       "class": "YTable",
+      #       "columns": 4,
+      #       "header": [
+      #         "header1",
+      #         "header2",
+      #         "header3",
+      #         "header4"
+      #       ],
+      #       "id": "test_id",
+      #       "items": [
+      #           {
+      #               "labels": [
+      #                   "test.item.1",
+      #                   "",
+      #                   "",
+      #                   ""
+      #               ],
+      #               "selected": true
+      #           },
+      #           {
+      #               "labels": [
+      #                   "test.item.2",
+      #                   "",
+      #                   "",
+      #                   ""
+      #               ]
+      #           }
+      #       ],
+      #       "items_count": 2
+      #     }
+      # @example
+      #   app.table(id: 'test_id').items
+      #   # [test.item.1, "", "", ""]
+      #   # [test.item.2, "", "", ""]
+      def items
+        property(:items).map { |x| x[:labels] }
+      end
+
+      # Returns the list of column names.
+      # @return [Array] array of [String] objects containing names of the columns
+      # @example Get header column names from the table with id "test_id"
+      #   app.table(id: 'test_id').header
+      def header
+        property(:header)
+      end
+
+      # Sends action to select a row in a table. Row can be selected either by
+      # cell value in the column (first column will be used by default), or by
+      # row number directly. If both are provided, value will be used.
+      # NOTE: row number corresponds to the position of the
+      # item in the list of column values which might differ to the display order.
+      # @param value [String] value to select in the table.
+      # @param column [String] column name where value is present
+      # @param row [Numeric] row number to select in the table.
+      # @return [Table] in case action is successful
+      # @example Select row with value "test.item.2" for column "header1" in table with id 'test_id'
+      #   app.table(id: 'test_id').select(value: 'test.item.2', column: 'header1')
+      # @example Select row number 3 in table with id 'test_id'
+      #   app.table(id: 'test_id').select(row: 3)
+      def select(value: nil, column: nil, row: nil)
+        params = { action: Actions::SELECT }
+        if !value.nil?
+          params.merge!(value: value)
+          params.merge!(column: get_index(column)) unless column.nil?
+        elsif !row.nil?
+          params.merge!(row: row)
+        end
+        action(params)
+        self
+      end
+
+      # Returns the list of items currently selected from the table.
+      # @return [Array] array of [Array] objects containing values for each column
+      # @example Get items from the table with id "test_id"
+      #     {
+      #       "class": "YTable",
+      #       "columns": 4,
+      #       "header": [
+      #         "header1",
+      #         "header2",
+      #         "header3",
+      #         "header4"
+      #       ],
+      #       "id": "test_id",
+      #       "items": [
+      #           {
+      #               "labels": [
+      #                   "test.item.1",
+      #                   "",
+      #                   "",
+      #                   ""
+      #               ],
+      #               "selected": true
+      #           },
+      #           {
+      #               "labels": [
+      #                   "test.item.2",
+      #                   "",
+      #                   "",
+      #                   ""
+      #               ],
+      #               "selected": true
+      #           }
+      #       ],
+      #       "items_count": 2
+      #     }
+      # @example
+      #   app.table(id: 'test_id').selected_items
+      #   # [test.item.1, "", "", ""]
+      #   # [test.item.2, "", "", ""]
+      def selected_items
+        property(:items).map { |x| x[:labels] if x[:selected] }.compact
+      end
+
+      private
+
+      def get_index(column)
+        header.index(column)
+      end
+    end
+  end
+end

data/lib/yui_rest_client/widgets/textbox.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module YuiRestClient
+  module Widgets
+    # Class representing a textbox in the UI. It can be YInputField.
+    class Textbox < Widgets::Base
+      # Returns maximum string length to set in the textbox
+      # @return [Integer] maximum number of character to set in the textbox
+      # @example Check maximum string length in textbox with id 'test'
+      #   {
+      #      "class": "YInputField",
+      #      "debug_label": "label_test",
+      #      "hstretch": true,
+      #      "id": "test",
+      #      "input_max_length": 256,
+      #      "label": "label_test",
+      #      "password_mode": false,
+      #      "valid_chars": "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-_.",
+      #      "value": ""
+      #   }
+      # @example
+      #   app.textbox(id: 'test').max_length
+      def max_length
+        property(:input_max_length)
+      end
+
+      # Sends action to set the value of textbox.
+      # @param value [String] text to be set in textbox
+      # @return [Textbox] in case action is successful
+      # @example Set text in textbox with id 'test' to 'my value'
+      #   app.textbox(id: 'test').set('my value')
+      def set(value)
+        action(action: Actions::ENTER_TEXT, value: value)
+        self
+      end
+
+      # Check if textbox has password mode
+      # @return [Boolean] true if has password mode, otherwise false
+      # @example Check password mode in textbox with id 'test'
+      #   {
+      #      "class": "YInputField",
+      #      "debug_label": "label_test",
+      #      "hstretch": true,
+      #      "id": "test",
+      #      "label": "label_test",
+      #      "password_mode": false,
+      #      "value": ""
+      #   }
+      # @example
+      #   app.textbox(id: 'test').password?
+      def password?
+        property(:password_mode)
+      end
+
+      # Returns valid chars to set in the textbox
+      # @return [String] containing all valid chars
+      # @example Check password mode in textbox with id 'test'
+      #   {
+      #      "class": "YInputField",
+      #      "debug_label": "label_test",
+      #      "hstretch": true,
+      #      "id": "test",
+      #      "label": "label_test",
+      #      "password_mode": false,
+      #      "valid_chars": "0123456789",
+      #      "value": ""
+      #   }
+      # @example
+      #   app.textbox(id: 'test').valid_chars
+      def valid_chars
+        property(:valid_chars)
+      end
+
+      # Returns text that is currently set for textbox.
+      # Gets value from 'value' parameter in JSON representation of YInputField.
+      # @return [String] value
+      # @example Get value from textbox with id "address"
+      #   {
+      #       "class": "YInputField",
+      #       "debug_label": "Address",
+      #       "hstretch": true,
+      #       "id": "address",
+      #       "label": "A&ddress",
+      #       "password_mode": false,
+      #       "value": "Test Address"
+      #   }
+      # @example
+      #   app.textbox(id: 'address').value # Test Address
+      def value
+        property(:value)
+      end
+    end
+  end
+end

data/lib/yui_rest_client/widgets/timefield.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module YuiRestClient
+  module Widgets
+    # Class representing a DateField in the UI, namely YTimeField.
+    class Timefield < Widgets::Base
+      # Sends action to set the value of time field. Accepts Time or DateTime
+      # object and sets value in ISO 8601 format HH:MM:SS.
+      # @param time [Time] time to be set in the time field
+      # @return [Timefield] in case action is successful
+      # @raise YuiRestClientError if parameter is not DateTime or Time
+      # @example Set current time in the time field with id 'test' using Time
+      #   app.timefield(id: 'time').set(Time.now)
+      # @example Set custom time in the field with id 'test' to 04:05:06
+      #   app.timefield(id: 'time').set(DateTime.new(2001,2,3,4,5,6))
+      def set(time)
+        unless  [DateTime, Time].any? { |c| time.is_a? c }
+          raise Error::YuiRestClientError, 'Parameter is not Date, Time or DateTime'
+        end
+
+        action(action: Actions::ENTER_TEXT, value: time.strftime('%T'))
+        self
+      end
+
+      # Returns text that is currently set for timefield.
+      # Gets value from 'value' parameter in JSON representation of YTimeField.
+      # @return [String] value
+      # @example Get value from timefield with id "time"
+      #   {
+      #       "class" : "YTimeField",
+      #       "debug_label" : "Time:",
+      #       "hstretch" : true,
+      #       "id" : "time",
+      #       "label" : "&Time:",
+      #       "notify" : true,
+      #       "value" : "20:15:00"
+      #   }
+      # @example
+      #   app.timefield(id: 'time').value # '20:15:00'
+      def value
+        property(:value)
+      end
+    end
+  end
+end

data/lib/yui_rest_client/widgets/tree.rb

@@ -0,0 +1,149 @@
+# frozen_string_literal: true
+
+module YuiRestClient
+  module Widgets
+    # Class representing a tree in UI. It can be YTree.
+    class Tree < Widgets::Base
+      # Returns the list of items available to select from tree. Each item
+      # is represented by its path from root node to leaf in the tree,
+      # in other words, a list of nodes separated by special simbol '|'
+      # @return [Array<String>] array of strings
+      # @example Get items from tree with id "test_id"
+      #  {
+      #    "class": "YTree",
+      #    "debug_label": "node_0",
+      #    "hstretch": true,
+      #    "hweight": 30,
+      #    "icon_base_path": "",
+      #    "id": "test_id",
+      #    "items": [
+      #      {
+      #        "children": [
+      #          {
+      #            "icon_name": "icon",
+      #            "label": "node1_1"
+      #          },
+      #          {
+      #            "children": [
+      #              {
+      #                "label": "node1_2_1"
+      #              },
+      #              {
+      #                "label": "node1_2_2",
+      #                "selected": true
+      #              }
+      #            ],
+      #            "icon_name": "icon",
+      #            "label": "node1_2"
+      #          }
+      #        ],
+      #        "icon_name": "icon",
+      #        "label": "node1",
+      #      },
+      #      {
+      #        "icon_name": "icon",
+      #        "label": "node2"
+      #      }
+      #    ],
+      #    "items_count": 2,
+      #    "label": "node_0",
+      #    "notify": true,
+      #    "vstretch": true
+      #  }
+      # @example
+      #   app.tree(id: 'test_id').items
+      #   # node1
+      #   # node1|node1_1
+      #   # node1|node1_2
+      #   # node1|node1_2|node1_2_1
+      #   # node1|node1_2|node1_2_2
+      #   # node2
+      def items
+        get_nodes(property(:items))
+      end
+
+      # Sends action to select an item from the tree in UI.
+      # @param item [String] value to select from items.
+      # @example Select tree node 'test_node' from tree with id 'test_id'
+      #   app.tree(id: 'test_id').select('test_node')
+      def select(item)
+        action(action: Actions::SELECT, value: item)
+        self
+      end
+
+      # Returns the item currently selected/highlighted in the tree. Item
+      # is represented by its path from root node to leaf in the tree,
+      # in other words, a list of nodes separated by special simbol '|'
+      # @return [String] item selected/highlighted in the tree
+      # @example Get selected item from tree with id "test_id"
+      #  {
+      #    "class": "YTree",
+      #    "debug_label": "node_0",
+      #    "hstretch": true,
+      #    "hweight": 30,
+      #    "icon_base_path": "",
+      #    "id": "test_id",
+      #    "items": [
+      #      {
+      #        "children": [
+      #          {
+      #            "icon_name": "icon",
+      #            "label": "node1_1"
+      #          },
+      #          {
+      #            "children": [
+      #              {
+      #                "label": "node_1_2_1"
+      #              },
+      #              {
+      #                "label": "node_1_2_2",
+      #                "selected": true
+      #              }
+      #            ],
+      #            "icon_name": "icon",
+      #            "label": "node1_2"
+      #          }
+      #        ],
+      #        "icon_name": "icon",
+      #        "label": "node1",
+      #      },
+      #      {
+      #        "icon_name": "icon",
+      #        "label": "node2"
+      #      }
+      #    ],
+      #    "items_count": 2,
+      #    "label": "node_0",
+      #    "notify": true,
+      #    "vstretch": true
+      #  }
+      # @example
+      #   app.tree(id: 'test_id').selected_item
+      #   # node1|node1_2|node1_2_2
+      def selected_item
+        get_selected_node(property(:items))
+      end
+
+      private
+
+      def get_nodes(items, root = '')
+        items.map do |x|
+          current = root.empty? ? x[:label] : root + '|' + x[:label]
+          x.key?(:children) ? [current, get_nodes(x[:children], current)] : current
+        end.flatten
+      end
+
+      def get_selected_node(items, root = '')
+        selected = ''
+        items.each do |x|
+          current = root.empty? ? x[:label] : root + '|' + x[:label]
+          return current if x[:selected]
+
+          selected = get_selected_node(x[:children], current) if x.key?(:children)
+          break unless selected.empty?
+        end
+        selected
+      end
+    end
+  end
+end