libyui_client 0.4.0

data/lib/libyui_client/widgets/textbox.rb

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

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

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

data/libyui_client.gemspec

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'libyui_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'libyui_client'
+  spec.version       = LibyuiClient::VERSION
+  spec.required_ruby_version = '>= 2.5.0'
+  spec.authors       = ['Joaquin Rivera', 'Ioannis Bonatakis', 'Oleksandr Orlov', 'Rodion Iafarov', 'Sofia Syrianidou']
+  spec.email         = ['qa-sle-yast@suse.de']
+
+  spec.summary       = 'Client for libyui applications.'
+  spec.description   = 'Client to operate controls for libyui applications.'
+  spec.homepage      = "https://github.com/qa-sle-yast/libyui_client"
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+  #    spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  #
+  #    spec.metadata["homepage_uri"] = spec.homepage
+  #    spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+  #    spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 2.1.4'
+  spec.add_development_dependency 'rake', '~> 13.0.1'
+  spec.add_development_dependency 'rspec', '~> 3.9.0'
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: libyui_client
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- Joaquin Rivera
+- Ioannis Bonatakis
+- Oleksandr Orlov
+- Rodion Iafarov
+- Sofia Syrianidou
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-09-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.4
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+description: Client to operate controls for libyui applications.
+email:
+- qa-sle-yast@suse.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/libyui_client.rb
+- lib/libyui_client/actions.rb
+- lib/libyui_client/app.rb
+- lib/libyui_client/error.rb
+- lib/libyui_client/filter_extractor.rb
+- lib/libyui_client/http/http_client.rb
+- lib/libyui_client/http/response.rb
+- lib/libyui_client/http/version_controller.rb
+- lib/libyui_client/http/widget_controller.rb
+- lib/libyui_client/local_process.rb
+- lib/libyui_client/logger.rb
+- lib/libyui_client/timer.rb
+- lib/libyui_client/version.rb
+- lib/libyui_client/wait.rb
+- lib/libyui_client/waitable.rb
+- lib/libyui_client/widgets.rb
+- lib/libyui_client/widgets/bargraph.rb
+- lib/libyui_client/widgets/base.rb
+- lib/libyui_client/widgets/button.rb
+- lib/libyui_client/widgets/checkbox.rb
+- lib/libyui_client/widgets/combobox.rb
+- lib/libyui_client/widgets/datefield.rb
+- lib/libyui_client/widgets/label.rb
+- lib/libyui_client/widgets/menubutton.rb
+- lib/libyui_client/widgets/multilinebox.rb
+- lib/libyui_client/widgets/numberbox.rb
+- lib/libyui_client/widgets/progressbar.rb
+- lib/libyui_client/widgets/radiobutton.rb
+- lib/libyui_client/widgets/richtext.rb
+- lib/libyui_client/widgets/selectionbox.rb
+- lib/libyui_client/widgets/tab.rb
+- lib/libyui_client/widgets/table.rb
+- lib/libyui_client/widgets/textbox.rb
+- lib/libyui_client/widgets/timefield.rb
+- lib/libyui_client/widgets/tree.rb
+- libyui_client.gemspec
+homepage: https://github.com/qa-sle-yast/libyui_client
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Client for libyui applications.
+test_files: []