yui_rest_client 0.5.0

data/lib/yui_rest_client/widgets/datefield.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module YuiRestClient
+  module Widgets
+    # Class representing a date field in the UI, namely YDateField.
+    class Datefield < Widgets::Base
+      # Sends action to set the value of date field. Accepts Date, Time or DateTime
+      # object and sets value in ISO 8601 format YYYY-MM-DD.
+      # @param date [Date] date to be set in date field
+      # @return [Datefield] in case action is successful
+      # @raise YuiRestClientError if parameter is not Date, DateTime or Time
+      # @example Set date in date field with id 'test' to current date
+      #   app.datefield(id: 'date').set(Time.now)
+      # @example Set date in date field with id 'test' to 2002-12-29
+      #   app.datefield(id: 'date').set(DateTime.new(2002,12,29))
+      # @example Set date in date field with id 'test' to 2021-02-03
+      #   app.datefield(id: 'date').set(Date.new(2001,2,3))
+      def set(date)
+        unless  [Date, DateTime, Time].any? { |c| date.is_a? c }
+          raise Error::YuiRestClientError, 'Parameter is not Date, Time or DateTime'
+        end
+
+        action(action: Actions::ENTER_TEXT, value: date.strftime('%F'))
+        self
+      end
+
+      # Returns text that is currently set for datefield.
+      # Gets value from 'value' parameter in JSON representation of YDateField.
+      # @return [String] value
+      # @example Get value from datefield with id "date"
+      #   {
+      #       "class" : "YDateField",
+      #       "debug_label" : "Date:",
+      #       "hstretch" : true,
+      #       "id" : "date",
+      #       "label" : "&Date:",
+      #       "notify" : true,
+      #       "value" : "1989-11-09"
+      #   }
+      # @example
+      #   app.datefield(id: 'date').value # '1989-11-09'
+      def value
+        property(:value)
+      end
+    end
+  end
+end

data/lib/yui_rest_client/widgets/label.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module YuiRestClient
+  module Widgets
+    # Class representing a Label UI. It can be YLabel, YLabel_Heading
+    class Label < Widgets::Base
+      # Returns if label is a heading being represented in bold in the UI
+      # Gets value from 'is_heading' parameter in JSON representation of YLabel_Heading.
+      # @return [Boolean] true if it is a heading, false otherwise.
+      # @example Check label with 'label' "Product name"
+      #   {
+      #     "class": "YLabel_Heading",
+      #     "debug_label": "Product name ...",
+      #     "is_heading": true,
+      #     "label": "Product name",
+      #     "text": "Product name"
+      #   }
+      # @example
+      #   app.label(label: 'Product name').heading? # true
+      def heading?
+        heading_prop = property(:is_heading)
+        !heading_prop.nil? && heading_prop == true
+      end
+
+      # Returns text value for the label.
+      # @return [String] value
+      # @example Get text value for YLabel, YLabelHeading
+      #   {
+      #     "class": "YLabel",
+      #     "debug_label": "short message",
+      #     "label": "test label",
+      #     "text": "text label"
+      #   }
+      # @example
+      #   text = app.label(label: 'test label').text # "text label"
+      def text
+        property(:text)
+      end
+    end
+  end
+end

data/lib/yui_rest_client/widgets/menubutton.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module YuiRestClient
+  module Widgets
+    # Class representing a menubutton in UI. It can be YMenuButton.
+    class Menubutton < Widgets::Base
+      # Sends action to click on one of the items of the menubutton in UI.
+      # @param item [String] value to select from items.
+      # @example Click button with label 'test_button' for menubutton with id 'test_id'.
+      # @example
+      #   app.menubutton(id: 'test_id').click('test_button')
+      def click(item)
+        action(action: Actions::PRESS, value: item)
+      end
+
+      # Returns the list of items available to select from widget.
+      # @return [Array<String>] array of strings.
+      # @example Get items from widget with id "test_id"
+      #   {
+      #     "class": "YMenuButton",
+      #     "debug_label": "test",
+      #     "icon_base_path": "",
+      #     "id": "test_id",
+      #     "items": [
+      #       {
+      #         "label": "button1"
+      #       },
+      #       {
+      #         "label": "button2"
+      #       },
+      #       {
+      #         "label": "button3"
+      #       }
+      #     ],
+      #     "items_count": 3,
+      #     "label": "button group"
+      #   }
+      # @example
+      #   app.menubutton(id: 'test').items
+      #   # button1
+      #   # button2
+      #   # button3
+      def items
+        property(:items).map { |x| x[:label] }
+      end
+    end
+  end
+end

data/lib/yui_rest_client/widgets/multilinebox.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module YuiRestClient
+  module Widgets
+    # Class representing a multilinebox in the UI. It can be YMultiLineEdit.
+    class Multilinebox < Widgets::Base
+      # Returns maximum string length to set in the multilinebox
+      # @return [Integer] maximum number of character to set in the multilinebox
+      # @example Check maximum string length in multilinebox with id 'TEST_ID'
+      #   }
+      #      "class" : "YMultiLineEdit",
+      #      "debug_label" : "test_label",
+      #      "default_visible_lines" : 3,
+      #      "hstretch" : true,
+      #      "hweight" : 1,
+      #      "id" : "\"TEST_ID\"",
+      #      "input_max_length" : -1,
+      #      "label" : "test_label",
+      #      "value" : "",
+      #      "vstretch" : true
+      #   }
+      # @example
+      #   app.multilinebox(id: '"TEST_ID"').max_length
+      #     # -1
+      def max_length
+        property(:input_max_length)
+      end
+
+      # Returns the default visible number of lines for the multilinebox
+      # @return [Integer] default number of visible lines for the multilinebox
+      # @example Check the default visible number of line for  multilinebox with id 'TEST_ID'
+      #   }
+      #      "class" : "YMultiLineEdit",
+      #      "debug_label" : "test_label",
+      #      "default_visible_lines" : 3,
+      #      "hstretch" : true,
+      #      "hweight" : 1,
+      #      "id" : "\"TEST_ID\"",
+      #      "input_max_length" : -1,
+      #      "label" : "test_label",
+      #      "value" : "",
+      #      "vstretch" : true
+      #   }
+      # @example
+      #   app.multilinebox(id: '"TEST_ID"').visible_lines
+      #     # 3
+      def visible_lines
+        property(:default_visible_lines)
+      end
+
+      # Sends action to set the value of multilinebox.
+      # @param value [String] text to be set in multilinebox
+      # @return [Multilinebox] in case action is successful
+      # @example Set text in multilinebox with id 'TEST_ID' to 'text'
+      #   app.multilinebox(id: '"TEST_ID"').set("text\ntext in new line")
+      def set(value)
+        action(action: Actions::ENTER_TEXT, value: value)
+        self
+      end
+
+      # Returns text that is currently set for multilinebox.
+      # Gets value from 'value' parameter in JSON representation of YMultiLineEdit.
+      # @return [String] text set as value in the multilinebox.
+      # @example Get value from multilinebox with id "address"
+      #   }
+      #      "class" : "YMultiLineEdit",
+      #      "debug_label" : "test_label",
+      #      "default_visible_lines" : 3,
+      #      "hstretch" : true,
+      #      "hweight" : 1,
+      #      "id" : "\"TEST_ID\"",
+      #      "input_max_length" : -1,
+      #      "label" : "test_label",
+      #      "value" : "This is a \nmultiline\ntext",
+      #      "vstretch" : true
+      #   }
+      # @example
+      #   app.multilinebox(id: '"TEST_ID"').value # This is a \nmultiline\ntext
+      def value
+        property(:value)
+      end
+    end
+  end
+end

data/lib/yui_rest_client/widgets/numberbox.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module YuiRestClient
+  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/yui_rest_client/widgets/progressbar.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module YuiRestClient
+  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/yui_rest_client/widgets/radiobutton.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module YuiRestClient
+  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/yui_rest_client/widgets/richtext.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module YuiRestClient
+  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/yui_rest_client/widgets/selectionbox.rb

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