libyui_client 0.4.0

data/lib/libyui_client/widgets/numberbox.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module LibyuiClient
+  module Widgets
+    # Class representing a numberbox in the UI. It can be YIntField.
+    class Numberbox < Widgets::Base
+      # Returns minimum value to set in the numberbox
+      # @return [Integer] with minimum value
+      # @example Get minimum value to set numberbox with id 'test'
+      #   {
+      #      "class": "YIntField",
+      #      "debug_label": "label_test",
+      #      "hstretch": true,
+      #      "id": "test",
+      #      "label": "label_test",
+      #      "max_value": 65535,
+      #      "min_value": 0,
+      #      "value": 3260
+      #   }
+      # @example
+      #   app.numberbox(id: 'test').min_value
+      def min_value
+        property(:min_value)
+      end
+
+      # Returns maximum value to set in the numberbox
+      # @return [Integer] with maximum value
+      # @example Get maximum value to set numberbox with id 'test'
+      #   {
+      #      "class": "YIntField",
+      #      "debug_label": "label_test",
+      #      "hstretch": true,
+      #      "id": "test",
+      #      "label": "label_test",
+      #      "max_value": 65535,
+      #      "min_value": 0,
+      #      "value": 3260
+      #   }
+      # @example
+      #   app.numberbox(id: 'test').max_value
+      def max_value
+        property(:max_value)
+      end
+
+      # Sends action to set the value of numberbox.
+      # @param value [Integer] to be set in numberbox
+      # @return [Numberbox] in case action is successful
+      # @example Set text in numberbox with id 'test' to 123
+      #   app.numberbox(id: 'test').set(123)
+      def set(value)
+        action(action: Actions::ENTER_TEXT, value: value)
+        self
+      end
+
+      # Returns number that is currently set for numberbox.
+      # Gets value from 'value' parameter in JSON representation of YIntField.
+      # @return [Integer] value
+      # @example Get value from numberbox with id "test"
+      #   {
+      #      "class": "YIntField",
+      #      "debug_label": "label_test",
+      #      "hstretch": true,
+      #      "id": "test",
+      #      "label": "label_test",
+      #      "max_value": 65535,
+      #      "min_value": 0,
+      #      "value": 3260
+      #   }
+      # @example
+      #   app.numberbox(id: 'address').value # 3260
+      def value
+        property(:value)
+      end
+    end
+  end
+end

data/lib/libyui_client/widgets/progressbar.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module LibyuiClient
+  module Widgets
+    # Class representing a Progressbar in UI. It can be YProgressBar.
+    class Progressbar < Widgets::Base
+      # Returns the current value of progressbar.
+      # Gets value from 'value' parameter in JSON representation of YProgressBar.
+      # @return [Integer] current value of progressbar.
+      # @example Get progressbar value, with id 'initProg'
+      #   {
+      #     "class" : "YProgressBar",
+      #     "hstretch" : true,
+      #     "id" : "initProg",
+      #     "label" : "Disk",
+      #     "max_value" : 1000,
+      #     "value" : 666
+      #   }
+      #   app.progressbar(id: 'initProg').value
+      #	    # 663
+      def value
+        property(:value)
+      end
+
+      # Returns the max value of progressbar.
+      # Gets value from 'max_value' parameter in JSON representation of YProgressBar.
+      # @return [Integer] max value of the progressbar.
+      # @example Get progressbar max_value, with id 'initProg'
+      #   {
+      #     "class" : "YProgressBar",
+      #     "hstretch" : true,
+      #     "id" : "initProg",
+      #     "label" : "Disk",
+      #     "max_value" : 1000,
+      #     "value" : 666
+      #   }
+      # @example
+      #   app.progressbar(id: 'initProg').max_value
+      #     # 1000
+      def max_value
+        property(:max_value)
+      end
+    end
+  end
+end

data/lib/libyui_client/widgets/radiobutton.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module LibyuiClient
+  module Widgets
+    # Class representing a RadioButton in the UI. It can be YRadioButton.
+    class Radiobutton < Widgets::Base
+      # Sends action to select the radiobutton in UI.
+      # @return [Radiobutton] in case action is successful
+      # @example Select radiobutton with id 'test'
+      #   app.radiobutton(id: 'test').select
+      def select
+        action(action: Actions::SELECT)
+        self
+      end
+
+      # Returns the state of radiobutton (selected or not).
+      # Gets value from 'value' parameter in JSON representation of YRadioButton.
+      # @return [Boolean] true if the radiobutton is selected, false otherwise.
+      # @example Get state for radiobutton with id "manual"
+      #   {
+      #     "class": "YRadioButton",
+      #     "debug_label": "Manually",
+      #     "id": "manual",
+      #     "label": "&Manually",
+      #     "notify": true,
+      #     "value": false
+      #   }
+      # @example
+      #   app.radiobutton(id: 'manual').selected? # false
+      def selected?
+        property(:value)
+      end
+    end
+  end
+end

data/lib/libyui_client/widgets/richtext.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module LibyuiClient
+  module Widgets
+    # Class representing a richtext in the UI. It can be YRichText.
+    class Richtext < Widgets::Base
+      # Sends action to click a link inside a richtext control in the UI.
+      # @param value [String] href
+      # @return [Richtext] in case action is successful
+      # @example Click link with value 'test'
+      #   items.click_link('test')
+      def click_link(value)
+        action(action: Actions::PRESS, value: value)
+        self
+      end
+
+      # Returns text value for the richtext.
+      # @return [String] value
+      # @example Get text value for YRichText
+      #   {
+      #     "class": "YRichText",
+      #     "enabled": false,
+      #     "hstretch": true,
+      #     "id": "test",
+      #     "text": "<small>Select something here</small>",
+      #     "vstretch": true,
+      #     "vweight": 25
+      #   }
+      # @example
+      #   text = app.richtext(id: 'test').text # "<small>Select something here</small>"
+      def text
+        property(:text)
+      end
+    end
+  end
+end

data/lib/libyui_client/widgets/selectionbox.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module LibyuiClient
+  module Widgets
+    # Class representing a selectionbox in the UI. It can be YSelectionBox.
+    class Selectionbox < Widgets::Base
+      # Returns the list of items available to select from selection box.
+      # @return [Array] array of String objects.
+      # @example Get items from selection box with id "test_id"
+      #   {
+      #     "class" : "YSelectionBox",
+      #     "debug_label" : "selection box title",
+      #     "hstretch" : true,
+      #     "icon_base_path" : "",
+      #     "id" : "test_id",
+      #     "items" :
+      #     [
+      #       {
+      #         "label" : "selection 1",
+      #         "selected" : true
+      #       },
+      #       {
+      #         "label" : "selection 2"
+      #       },
+      #       {
+      #         "label" : "selection 3"
+      #       }
+      #     ],
+      #     "items_count" : 3,
+      #     "label" : "&selection box title",
+      #     "vstretch" : true
+      #   }
+      #
+      # @example
+      #   app.selectionbox(id: 'test_id').items
+      #   # selection 1
+      #   # selection 2
+      #   # selection 3
+      def items
+        property(:items).map { |x| x[:label] }
+      end
+
+      # Sends action to click the selection in UI.
+      # @param item [String] value to select from items.
+      # @return [Selectionbox] in case action is successful
+      # @example Click selection with id 'test_id'
+      #   app.selectionbox(id: 'test_id').select('item_id')
+      def select(item)
+        action(action: Actions::SELECT, value: item)
+        self
+      end
+
+      # Returns selected item in selection box.
+      # @example Get selected item in selection box with id "test_id"
+      #   {
+      #     "class" : "YSelectionBox",
+      #     "debug_label" : "selection box title",
+      #     "hstretch" : true,
+      #     "icon_base_path" : "",
+      #     "id" : "test_id",
+      #     "items" :
+      #     [
+      #       {
+      #         "label" : "selection 1",
+      #         "selected" : true
+      #       },
+      #       {
+      #         "label" : "selection 2"
+      #       },
+      #       {
+      #         "label" : "selection 3"
+      #       }
+      #     ],
+      #     "items_count" : 3,
+      #     "label" : "&selection box title",
+      #     "vstretch" : true
+      #   }
+      #
+      # @example
+      #   app.selectionbox(id: 'test_id').selected_item
+      #   # selection 1
+      def selected_item
+        property(:items).select { |x| x[:selected] }.first[:label]
+      end
+    end
+  end
+end

data/lib/libyui_client/widgets/tab.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module LibyuiClient
+  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/libyui_client/widgets/table.rb

@@ -0,0 +1,154 @@
+# frozen_string_literal: true
+
+module LibyuiClient
+  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