atspi 0.9.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4b381921221f326d93dcfc8e7f5b54bf03c562fe
-  data.tar.gz: b98b064c005bac799a37b8aa0407255601ed01ba
+  metadata.gz: ead4bf4d229628674333659b98aee3247c4547bd
+  data.tar.gz: 6e89ecf3512272b48d05193e88db0ef0ff664583
 SHA512:
-  metadata.gz: ecdc4dd73b12639dcb5b7c0f144949ac92734962ab6acd80c2a2095cd47e8332aa20d1c33e7707cc4adb7824aecb0d8a3275316d5a62a890c3d8b98fa076f0c5
-  data.tar.gz: 6c3df87e1fd8b8c71dee6a8ae2c052a8614d3aeece389f9a6e52ceb8197edf1519b908b32fc3b00502290721c0566bc7bc0f757668357695ecdd85ad240ec591
+  metadata.gz: 76dfd023c4e90060c577f082046fc370e3b42815365ec7492112afd1001c90da363082d108c56c1fc341b1bafede670cf99cf76d90421c14a56ba7f55832e0ed
+  data.tar.gz: adf03361bc2c38df8d3318cc78efd7c98787bb108ac964e286d8c5f2d77f888c5ffa682923477da5b5ddbf53829f38b958f6eba77a952591cfe35e93644efaf3

data/lib/atspi/accessible.rb

@@ -149,16 +149,12 @@ module ATSPI
       Children.new(@native)
     end
 
-    # @return [Descendants, []] its descendants. It will be an empty array if it
+    # @return [Descendants] its descendants. The collection will be empty if it
     #   does not implement the {https://developer.gnome.org/libatspi/stable/AtspiAccessible.html#atspi-accessible-get-collection collection interface}
     #
     # @see https://developer.gnome.org/libatspi/stable/AtspiAccessible.html#atspi-accessible-get-collection atspi_accessible_get_collection
     def descendants
-      if @native.collection_iface
-        Descendants.new(@native)
-      else
-        []
-      end
+      Descendants.new(@native)
     end
 
     # @return [Accessible,nil] its descendant found at the given path

data/lib/atspi/accessible/children.rb

@@ -1,6 +1,9 @@
 module ATSPI
   # Wraps the children part of libatspi's AtspiAccessible[https://developer.gnome.org/libatspi/stable/AtspiAccessible.html]
   # and parts of AtspiSelection[https://developer.gnome.org/libatspi/stable/libatspi-atspi-selection.html].
+  #
+  # Instance are enumerables supporting item access and can be treated more or
+  # less like an array.
   class Accessible::Children
     include SelectableCollection
 
@@ -28,5 +31,87 @@ module ATSPI
       @native.child_count
     end
   # @!endgroup
+
+  # @!group Selection
+    # Checks if the accessible the children belong to implements the selection
+    # interface.
+    #
+    # @return [true,false]
+    #
+    # @see https://developer.gnome.org/libatspi/stable/AtspiAccessible.html#atspi-accessible-get-selection atspi_accessible_get_selection
+    def selectable?
+      not @native.selection_iface.nil?
+    end
+
+    # @return [Selected,[]] its selected subset. It will be an empty array if
+    #   children are not selectable.
+    def selected
+      if selectable?
+        Selected.new(@native)
+      else
+        []
+      end
+    end
+
+    # Tries to select all children
+    #
+    # @return [true,false] indicates success
+    #
+    # @see https://developer.gnome.org/libatspi/stable/libatspi-atspi-selection.html#atspi-selection-select-all atspi_selection_select_all
+    def select_all
+      selectable? and @native.select_all
+    end
+
+    # Tries to deselect all children
+    #
+    # @return [true,false] indicates success
+    #
+    # @see https://developer.gnome.org/libatspi/stable/libatspi-atspi-selection.html#atspi-selection-clear-selection atspi_selection_clear_selection
+    def deselect_all
+      selectable? and @native.clear_selection
+    end
+  # @!endgroup
+
+  # @!group Filter
+    # @note (see Descendants#where)
+    # @see (see Descendants#where)
+    # @return [Descendants] the children collection as filtered descendants
+    #   collection.
+    # @overload (see Descendants#where)
+    def where(*args)
+      Accessible::Descendants.new(@native).recursive(false).where(*args)
+    end
+  # @!endgroup
+
+  # @!group Options
+    # @param (see Descendants#sort_by)
+    # @return [Descendants] the children collection as sorted descendants
+    #   collection.
+    # @example (see Descendants#sort_by)
+    # @see (see Descendants#sort_by)
+    def sort_by(order)
+      Accessible::Descendants.new(@native).recursive(false).sort_by(order)
+    end
+
+    # @param (see Descendants#limit_to)
+    # @return [Descendants] the children collection as limited descendants
+    #   collection.
+    # @see (see Descendants#limit_to)
+    def limit_to(limit)
+      Accessible::Descendants.new(@native).recursive(false).limit_to(limit)
+    end
+
+    # @param (see Descendants#recursive)
+    # @return [Descendants,self] self if +recursive+ is set to +false+. A
+    #   collection of all descendants if +recursive+ is set to +true+
+    # @see (see Descendants#recursive)
+    def recursive(recursive = true)
+      if recursive
+        Accessible::Descendants.new(@native)
+      else
+        self
+      end
+    end
+  # @!endgroup
   end
 end

data/lib/atspi/accessible/children/selected.rb

@@ -0,0 +1,35 @@
+module ATSPI
+  # Wraps libatspi's AtspiSelection[https://developer.gnome.org/libatspi/stable/libatspi-atspi-selection.html]
+  # together with parts of {Selectable} and {Children}
+  #
+  # Instance are enumerables supporting item access and can be treated more or
+  # less like an array.
+  class Accessible::Children::Selected
+    include SelectableCollection::Selected
+
+  # @api private
+    def initialize(native)
+      @native = native
+    end
+
+  # @!group Enumerable interface
+    # @param idx [Integer]
+    #
+    # @return [Accessible] its child at index +idx+
+    #
+    # @see https://developer.gnome.org/libatspi/stable/libatspi-atspi-selection.html#atspi-selection-get-selected-child atspi_selection_get_selected_child
+    def at(idx)
+      super do |mapped_idx|
+        Accessible.new(@native.selected_child(mapped_idx))
+      end
+    end
+
+    # @return [Integer] its number of children
+    #
+    # @see https://developer.gnome.org/libatspi/stable/libatspi-atspi-selection.html#atspi-selection-get-n-selected-children atspi_selection_get_n_selected_children
+    def count
+      @native.n_selected_children
+    end
+  # @!endgroup
+  end
+end

data/lib/atspi/accessible/descendants.rb

@@ -22,6 +22,14 @@ module ATSPI
   # In essence, it wraps libatspi's AtspiCollection[https://developer.gnome.org/libatspi/stable/libatspi-atspi-collection.html] and
   # AtspiMatchRule[https://developer.gnome.org/libatspi/stable/AtspiMatchRule.html]
   class Accessible::Descendants
+    extend Forwardable
+    # Delegate all methods of arrays directly to the array representation so
+    # methods available otherwise (like #select through Kernel) do not
+    # interfere
+    Array.instance_methods(false).each do |method|
+      delegate method => :to_a
+    end
+
     # @api private
     def initialize(native)
       @native = native
@@ -240,8 +248,10 @@ module ATSPI
 
   # @!group Access
     # @return [Array<Accessible>] the descendants according to the configured
-    #   filters and options.
+    #   filters and options. The collection will be empty if the accessible
+    #   does not implement the {https://developer.gnome.org/libatspi/stable/AtspiAccessible.html#atspi-accessible-get-collection collection interface}
     def to_a
+      return [] unless @native.collection_iface
       match_rule = Libatspi::MatchRule.new(*@filters[:state], *@filters[:attributes],
         *@filters[:role], *@filters[:interface], @options.inverted?)
       matches = @native.matches(match_rule, *@options).to_a
@@ -256,6 +266,27 @@ module ATSPI
     end
   # @!endgroup
 
+  # @!group Selection
+    # @return [Array<Accessible>] its selected subset.
+    def selected
+      select(&:selected?)
+    end
+
+    # Tries to select all descendants in the collection
+    #
+    # @return [true,false] indicates if *all* are now selected
+    def select_all
+      map(&:select).all?
+    end
+
+    # Tries to deselect all descendants in the collection
+    #
+    # @return [true,false] indicates if *all* are now deselected
+    def deselect_all
+      map(&:deselect).all?
+    end
+  # @!endgroup
+
   # @!group Representations
     # @return [String] itself as an inspectable string
     def inspect

data/lib/atspi/accessible/selectable.rb

@@ -1,6 +1,6 @@
 class ATSPI::Accessible
   # Wraps libatspi's AtspiSelection[https://developer.gnome.org/libatspi/stable/libatspi-atspi-selection.html]
-  # together with parts of {Children}
+  # together with parts of {Children} and {Children::Selected}
   module Selectable
   # @!group Attributes & States
     # Checks if it can be selected. Accessibles which parent's native
@@ -9,7 +9,7 @@ class ATSPI::Accessible
     #
     # @return [true, false]
     def selectable?
-      not parent.__send__(:native).selection_iface.nil?
+      parent.children.selectable?
     end
   # @!endgroup
 
@@ -24,12 +24,12 @@ class ATSPI::Accessible
     end
 
     # Deselects it
-    # @return [true, false] indicating success of the operation. +true+ if its
+    # @return [true, false] indicating success of the operation. +false+ if its
     #   parent does not implement the {https://developer.gnome.org/libatspi/stable/AtspiAccessible.html#atspi-accessible-get-selection selection interface}.
     #
     # @see https://developer.gnome.org/libatspi/stable/libatspi-atspi-selection.html#atspi-selection-deselect-child atspi_selection_deselect_child
     def deselect
-      not selectable? or parent.__send__(:native).deselect_child(index_in_parent)
+      selectable? and parent.__send__(:native).deselect_child(index_in_parent)
     end
   # @!endgroup
 

data/lib/atspi/accessible/table/cell/columns.rb

@@ -1,6 +1,9 @@
 module ATSPI
   class Accessible::Table
     # Represents the columns a table {Cell} spans.
+    #
+    # Instance are enumerables supporting item access and can be treated more or
+    # less like an array.
     class Cell::Columns
       include SelectableCollection::Selected
 

data/lib/atspi/accessible/table/cell/rows.rb

@@ -1,6 +1,9 @@
 module ATSPI
   class Accessible::Table
     # Represents the rows a table {Cell} spans.
+    #
+    # Instance are enumerables supporting item access and can be treated more or
+    # less like an array.
     class Cell::Rows
       include SelectableCollection::Selected
 

data/lib/atspi/accessible/table/columns.rb

@@ -1,6 +1,9 @@
 module ATSPI
   class Accessible::Table
-    # Represents all columns in a {Table}
+    # Represents all columns in a {Table}.
+    #
+    # Instance are enumerables supporting item access and can be treated more or
+    # less like an array.
     class Columns
       include SelectableCollection
 

data/lib/atspi/accessible/table/columns/selected.rb

@@ -1,6 +1,9 @@
 module ATSPI
   class Accessible::Table
-    # Represents all selected columns of a {Table}
+    # Represents all selected columns of a {Table}.
+    #
+    # Instance are enumerables supporting item access and can be treated more or
+    # less like an array.
     class Columns::Selected
       include SelectableCollection::Selected
 

data/lib/atspi/accessible/table/rows.rb

@@ -1,6 +1,9 @@
 module ATSPI
   class Accessible::Table
-    # Represents all rows in a {Table}
+    # Represents all rows in a {Table}.
+    #
+    # Instance are enumerables supporting item access and can be treated more or
+    # less like an array.
     class Rows
       include SelectableCollection
 

data/lib/atspi/accessible/table/rows/selected.rb

@@ -1,6 +1,9 @@
 module ATSPI
   class Accessible::Table
-    # Represents all selected rows of a {Table}
+    # Represents all selected rows of a {Table}.
+    #
+    # Instance are enumerables supporting item access and can be treated more or
+    # less like an array.
     class Rows::Selected
       include SelectableCollection::Selected
 

data/lib/atspi/collection.rb

@@ -2,7 +2,7 @@ module ATSPI
   # Included in classes representing a collection that can be iterated over.
   # A Collection is an Enumerable adjusted to the what we can efficiently get
   # from libatspi. In particular, it provides access to items by index and
-  # from the end of the collection.
+  # from the end of the collection and can be treated like an array.
   module Collection
     include Enumerable
   # @!group Enumerable interface

data/lib/atspi/requires.rb

@@ -22,6 +22,7 @@ require 'atspi/accessible/action'
 
 # Children
 require 'atspi/accessible/children'
+require 'atspi/accessible/children/selected'
 
 # Descendants
 require 'atspi/accessible/descendants'

data/lib/atspi/selectable_collection.rb

@@ -1,5 +1,8 @@
 module ATSPI
-  # Included in classes representing a collection having selectable items
+  # Included in classes representing a collection having selectable items.
+  #
+  # Instance are enumerables supporting item access and can be treated more or
+  # less like an array.
   module SelectableCollection
     include Collection
 

data/lib/atspi/selectable_collection/selected.rb

@@ -1,5 +1,9 @@
 module ATSPI
-  # Included in classes representing the selected subset of a selectable collection
+  # Included in classes representing the selected subset of a selectable
+  # collection.
+  #
+  # Instance are enumerables supporting item access and can be treated more or
+  # less like an array.
   module SelectableCollection::Selected
     include Collection
 
@@ -14,7 +18,7 @@ module ATSPI
   # @!group Representation
     # @return [String] instance as inspectable string
     def inspect
-      indices = self.indices(limit: 5).inspect
+      indices = self.__send__(:indices, limit: 5).inspect
       indices[-1] = ", …]" if count > 5
       "#<#{self.class.name}:0x#{'%x14' % __id__} @count=#{count} @indices=#{indices}>"
     end

data/lib/atspi/version.rb

@@ -1,4 +1,4 @@
 module ATSPI
   # this library's version
-  VERSION = "0.9.0"
+  VERSION = "0.9.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: atspi
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Christopher Aue
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-02 00:00:00.000000000 Z
+date: 2016-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gir_ffi
@@ -86,6 +86,7 @@ files:
 - lib/atspi/accessible.rb
 - lib/atspi/accessible/action.rb
 - lib/atspi/accessible/children.rb
+- lib/atspi/accessible/children/selected.rb
 - lib/atspi/accessible/descendants.rb
 - lib/atspi/accessible/descendants/attribute_filter.rb
 - lib/atspi/accessible/descendants/interface_filter.rb