motion-accessibility 1.1.1 → 2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a5468abd3418ca116e6c77c58f430f557944426c
-  data.tar.gz: 2d1807d3bad63b1908071dc77ea6cca9ebfa42d6
+  metadata.gz: 5a8b8a68fde38c107500ee9ba7391df3cf22d7a6
+  data.tar.gz: e979abc551392f9dede8c3dbf88199f70b1c34ff
 SHA512:
-  metadata.gz: c386cc1b2e01afddf5b57a9fc22101f992615804f0d828f6e66e096815b03efb86e71b9203889dce6b6682c664da7be13c800a2fa79c31763e3db3faa26dea64
-  data.tar.gz: 2661bbe13ac9c29a0379ba2249fbda14cd202f3bbae8661475de89cdc67bb88b0cc2779cdc9e2640934556376da452ab413370c377f47fce48acdfeeecbfb0d1
+  metadata.gz: b97f12b278ea3522bd242c8ee9c94bcae1f67cbf5e17ba4ff87839ccd2997bc73164f3524e879b574ef6e770b42e849524276efd0399d1a85334a9104e960479
+  data.tar.gz: 356842305034eb08ce3a4f49aebd4166e7c9156069295d636c9371f43c237143d6a148016e2bf2579dc2fb356bb93ffdf2f31ad370d3fbdc2f16b81b14ff0e26

data/README.md

@@ -23,6 +23,82 @@ Or install it yourself as:
     $ gem install motion-accessibility
 
 ## Usage
+### The Motion-Accessibility Console
+
+The motion-accessibility console gives you a way to interact with a running application through a purely textual interface. This works well for blind developers and command line users.
+
+#### Enabling the Console
+
+To enable the console, you can do one of two things. If you would just like to try it, type `include Accessibility::Console` at a REPL prompt. If you would like to use it in your application, add `require motion-accessibility-console` to your Rakefile. You have to do this even if you use bundler.
+
+#### `browse` or `b`
+
+The `browse` or `b` command lets you examine the view hierarchy in a speech-friendly way. This lets you see all the relevant views displayed in your running application. It will detect if the screen has changed and refresh itself automatically.
+
+The following examples come from the sample app included with motion-accessibility.
+
+```
+(main)>	browse                                                                  
+Browsing  UIWindow                                                              
+1 UILabel Hello!                                                                
+2 Touchable UITextField                                                         
+3 Touchable UIRoundedRectButton Update                                          
+4 UINavigationBar                                                               
+5 UITabBar with 2 subviews                                                      
+=> nil
+```
+
+If a view has subviews, you can browse that view.
+
+```
+(main)>	b 5                                                                     
+Browsing  UITabBar                                                              
+0 Superview UIWindow                                                            
+1 Touchable UITabBarButton Test App                                             
+2 Touchable UITabBarButton Table                                                
+=> nil
+```
+
+You can  refresh the browser by passing the `:refresh` or `:top` keyword. 
+
+You may pass the `:scroll` keyword to scroll a UIScrollView or descendants, such as a UITableView. This still has some minor issues .
+
+#### `view` or `v`
+
+The `view` or `v` command simply returns the current view. If you have just browsed a view, it will return that. Otherwise, you may specify the view you wish to browse. Note that for all the commands, you may either use its number or accessibility label.
+
+```
+(main)>	v 1                                                                     
+=> #<UITabBarButton:0x9380560>
+```
+
+#### `touch`
+The `touch` command lets you interact with the various controls. It works on all standard UIControls. `touch` can accept an argument depending on the type of control. For example, you can pass a UITextField a string to set its value.
+
+```
+(main)>	touch 2,"motion-accessibility rocks!"                                   
+Browsing  UIWindow                                                              
+1 UILabel Hello!                                                                
+2 Touchable UITextField motion-accessibility rocks!                             
+3 Touchable UIRoundedRectButton Update                                          
+4 UINavigationBar                                                               
+5 UITabBar with 2 subviews                                                      
+=> nil
+```
+
+UIButtons can take a UIControlEvent, but default to `UIControlEventTouchUpInside`. Note here the use of an accessibility label to reference the view.
+
+```
+(main)>	touch "update"                                                          
+Browsing  UIWindow                                                              
+1 UILabel motion-accessibility rocks!                                           
+2 Touchable UITextField motion-accessibility rocks!                             
+3 Touchable UIRoundedRectButton Update                                          
+4 UINavigationBar                                                               
+5 UITabBar with 2 subviews                                                      
+=> nil
+```
+
 ### The Accessibility Inspector
 
 You can easily see the state of any of the following attributes and methods by using the accessibility inspector. Just call the `inspect_accessibility` method on any object.

data/lib/motion-accessibility-console/object.rb

@@ -0,0 +1,16 @@
+class NSObject
+
+def browse(*args)
+A11y::Console.browse(*args)
+end
+def view(*args)
+A11y::Console.view(*args)
+end
+def touch(*args)
+A11y::Console.touch(*args)
+end
+
+alias :b :browse
+alias :v :view
+
+end

data/lib/motion-accessibility-console.rb

@@ -0,0 +1,8 @@
+unless defined?(Motion::Project::Config)
+  raise "The motion-accessibility browser must be required within a RubyMotion project Rakefile."
+end
+
+lib_dir_path = File.dirname(File.expand_path(__FILE__))
+Motion::Project::App.setup do |app|
+  app.files.unshift(Dir.glob(File.join(lib_dir_path, "motion-accessibility-console/**/*.rb")))
+end

data/lib/project/constants.rb

@@ -187,7 +187,16 @@ attributes.member?(attribute)
 end
 
 Touchable_Types = ["UITextField", "UIButton", "UIPickerView", "UIDatePicker",
-"UISegmentedControl", "UISlider", "UIStepper", "UISwitch"]
+"UISegmentedControl", "UISlider", "UIStepper", "UISwitch",
+"UITableViewCell", "UITabBarButton","UINavigationItemButtonView"]
+
+Ignored_Views = ["UIView", "UILayoutContainerView", "UITransitionView", "UINavigationTransitionView", "UIViewControllerWrapperView", "UITableViewCellContentView", "UINavigationItemView", "UITableViewWrapperView"]
+
+Ignored_ImageViews = ["UINavigationBar", "UITabBar", "UITableView"]
+
+Reverse_Views = ["UITableView", "UINavigationBar", "UITabBar"]
+
+View_Names = {"UINavigationItemButtonView" => "Back Button"}
 
 private
 def compile_attributes

data/lib/project/motion-accessibility-console/browser.rb

@@ -0,0 +1,111 @@
+module Accessibility
+module Console
+
+$browser_path=[]
+Update_Delay=1.0
+
+def self.touchable_type(view)
+control=view.class
+until A11y::Touchable_Types.member?(control.to_s)||control.nil?
+control=control.superclass
+end
+control
+end
+
+def self.scrollable_view?(view)
+control=view.class
+until control==UIScrollView||control.nil?
+control=control.superclass
+end
+control==UIScrollView
+end
+
+def self.init(view=nil)
+view=UIApplication.sharedApplication.keyWindow if view.nil?
+$browser_tree=A11y::Console::Tree.build(view)
+$browser_path<<$browser_tree if $browser_path.empty?
+nil
+end
+
+def self.display_views
+$browser_current=$browser_tree unless $browser_current
+puts "Browsing "+$browser_current.display_view
+$browser_current.browsable_nodes.each_with_index do |node, index|
+next if node.nil?
+output=node.display_view( index)
+puts output unless output.nil?
+end
+end
+
+def self.start_refreshing
+if !A11y::Data[:refresh]&&RUBYMOTION_ENV!='test'
+NSTimer.scheduledTimerWithTimeInterval(Update_Delay, target: self, selector: 'refresh', userInfo: nil, repeats: true)
+A11y::Data[:refresh]=true
+self.init
+end
+end
+
+def self.browse(request=nil)
+self.init unless $browser_current
+self.start_refreshing
+request=0 if request==:back
+if request.nil?
+elsif request==:top||request==:refresh
+self.init
+$browser_current=$browser_tree
+$browser_path.clear
+elsif request==0
+raise "You cannot go back any further" if $browser_path.length<2
+$browser_path.pop
+$browser_current=$browser_path.last
+self.init unless A11y::Data[:refresh]
+elsif request==:scroll
+raise "This view cannot scroll" unless A11y::Console.scrollable_view?($browser_current.view)
+below=CGRect.new([0, $browser_current.view.size.height], $browser_current.view.size)
+$browser_current.view.scrollRectToVisible(below, animated: false)
+else
+self.init unless $browser_tree
+$browser_current=$browser_tree unless $browser_current
+found=$browser_current.find(request)
+if found
+if found.subviews.empty?
+$browser_cursor=found
+return found.view.inspect_a11y
+end
+self.init unless A11y::Data[:refresh]
+$browser_current=found
+$browser_path<<found
+end
+end
+$browser_cursor=$browser_current
+self.display_views
+nil
+end
+
+def self.refresh
+self.init
+$before=$browser_tree.copy unless $before
+unless $browser_tree==$before
+puts "The screen has changed."
+self.browse :top
+puts "(Main)> "
+end
+$before=$browser_tree.copy
+end
+
+def self.view(request=nil)
+self.init unless A11y::Data[:refresh]
+$browser_current=$browser_tree unless $browser_current
+$browser_cursor=$browser_tree unless $browser_cursor
+return $browser_cursor.view unless request
+result=$browser_current.find(request)
+raise "Unknown view" unless result
+$browser_cursor=result
+result.view
+end
+
+alias :b :browse
+alias :v :view
+
+end
+end

data/lib/project/motion-accessibility-console/touch.rb

@@ -0,0 +1,104 @@
+module Accessibility
+module Console
+
+def self.touch(view, arg=nil, options={})
+self.start_refreshing
+$browser_current=$browser_tree unless $browser_current
+unless RUBYMOTION_ENV=='test'
+found=$browser_current.find(view)
+raise "Could not find the view" unless found
+      view=found.view
+end
+control=A11y::Console.touchable_type(view)
+raise "I don't know how to touch a #{view.class}"  if control.nil?
+if found
+sv=options[:superview]||found.superview.view
+else
+sv=options[:superview]
+end
+case control.to_s
+when "UIButton"
+arg||=UIControlEventTouchUpInside
+view.sendActionsForControlEvents(arg)
+when "UITabBarButton"
+arg||=UIControlEventTouchUpInside
+view.sendActionsForControlEvents(arg)
+when "UITextField"
+view.text=arg
+when "UIPickerView"
+self.touch_pickerview(view, arg)
+when "UIDatePicker"
+view.date=arg
+when "UISegmentedControl"
+self.touch_segmented(view, arg)
+when "UISlider"
+view.value=arg
+when "UIStepper"
+view.value=arg
+when "UISwitch"
+arg||=!view.arg
+view.on=arg
+when "UITableViewCell"
+raise "Could not get the UITableView" unless sv.kind_of?(UITableView)
+index=options[:index]||sv.indexPathForCell(view)
+raise "Could not get the index" unless index
+sv.delegate.tableView(self, didSelectRowAtIndexPath: index)
+when "UINavigationItemButtonView"
+view.superview.delegate.popViewControllerAnimated(true)
+else
+raise "I don't know what to do with a #{control}"
+end
+self.browse unless RUBYMOTION_ENV=='test'
+end
+
+def self.touch_pickerview(view, arg)
+raise "You must pass a hash with the row and component keywords" unless arg.kind_of?(Hash)&&arg[:row]&&arg[:component]
+arg[:animated]||=false
+if arg[:row].kind_of?(String)
+results=[]
+view.numberOfRowsInComponent(arg[:component]).times do |row_index|
+title=view.delegate.pickerView(view, titleForRow: row_index, forComponent: arg[:component])
+if title.casecmp(arg[:row])==0
+results=[row_index]
+break
+end
+if title=~Regexp.new(arg[:row],true)
+results<<row_index
+end
+end
+raise "Unknown value" if results.empty?
+raise "That could refer to more than one value." if results.length>1
+view.selectRow(results.first, inComponent: arg[:component], animated: false)
+elsif arg[:row].kind_of?(Fixnum)
+view.selectRow(arg[:row], inComponent: arg[:component], animated: arg[:animated])
+else
+raise "Unknown row #{arg[:row]}"
+end
+end
+
+def self.touch_segmented(view, arg)
+if arg.kind_of?(Fixnum)
+view.selectedSegmentIndex=arg
+elsif arg.kind_of?(String)
+results=[]
+view.numberOfSegments.times do |index|
+title=view.titleForSegmentAtIndex(index)
+if title.casecmp(arg)==0
+results=[index]
+break
+end
+if title=~Regexp.new(arg,true)
+results<<index
+end
+end
+raise "Unknown segment" if results.empty?
+raise "That could refer to more than one segment" if results.length>1
+view.selectedSegmentIndex=results.first
+else
+raise "Invalid segment"
+end
+end
+
+
+end
+end

data/lib/project/motion-accessibility-console/tree.rb

@@ -0,0 +1,149 @@
+module Accessibility
+module Console
+class Tree
+
+attr_accessor :view, :subviews, :superview
+
+def initialize(options={})
+@view=options[:view]
+@subviews=options[:subviews]||[]
+@superview=options[:superview]
+end
+
+def copy
+other=A11y::Console::Tree.new
+other.superview=self.superview if superview
+other.view=self.view if view
+self.subviews.each {|subview| other.subviews<<subview.clone}
+other
+end
+
+def ==(other)
+return false unless self.superview.view==other.superview.view
+return false unless self.view==other.view
+return false unless self.subviews.size==other.subviews.size
+self.subviews.each_index {|index| return false unless self.subviews[index]==other.subviews[index]}
+return true
+end
+
+def browsable_nodes
+nodes=[@superview]
+if @subviews
+if A11y::Reverse_Views.member?(@view.class.to_s)
+nodes+=@subviews.reverse
+else
+nodes+=@subviews
+end
+end
+nodes
+end
+
+def inspect
+nodes=@subviews.collect {|tree| tree.inspect}
+return @view.class.to_s if @subviews.empty?
+result="[#{@view.class}"
+result+=" #{nodes.join(" ")}" unless nodes.empty?
+result+="]"
+result
+end
+
+def display_view(index=nil)
+display=Array.new
+control=@view.class.to_s
+control=nil if A11y::View_Names[control]
+control="Superview #{control}" if index==0
+if @view.class==UITableViewCell
+label=@view.subviews.first
+while label&&!label.kind_of?(UILabel)
+label=label.subviews.first
+end
+raise "Could not find the UITableViewCell's label" unless label.kind_of?(UILabel)
+name=label.text
+elsif @view.class==UITextField
+name=@view.text
+else
+name=A11y::View_Names[@view.class.to_s]||@view.accessibility_value||@view.accessibility_label if @view.accessibility_element?||view.superclass==UIControl
+end
+display<<index.to_s
+display<<"Touchable" if A11y::Console.touchable_type(@view)
+display<<control if control
+display<<name if name
+if index
+if index>0 and  not(@subviews.empty?)
+indicator="with #{@subviews.length} subview"
+indicator+="s" if @subviews.length>1
+end
+   display<<indicator
+end
+display.join(" ")
+end
+
+def self.accessible_view?(view)
+return view.accessibility_element?||view.accessibility_label||view.accessibility_value||view.accessibility_traits
+end
+
+def self.ignore_view?(view)
+return true if view.subviews.empty?&&!self.accessible_view?(view)
+if view.superview
+sv=view.superview
+while sv&&self.ignore_view?(sv)
+sv=sv.superview
+end
+return true if A11y::Console.touchable_type(sv)
+return true if view.class==UIImageView&&A11y::Ignored_ImageViews.member?(sv.class.to_s)
+end
+class_name=view.class.to_s
+return true if class_name=~/^_/
+A11y::Ignored_Views.member?(class_name)
+end
+
+def self.build(view=nil, superview=nil)
+tree=self.new
+view=UIApplication.sharedApplication.keyWindow if view.nil?
+subviews=[]
+view.subviews.each do |subview|
+subview_tree=self.build(subview, tree)
+if self.ignore_view?(subview)
+subview_tree.subviews.each {|v| v.superview=tree}
+subviews=subviews+subview_tree.subviews
+else
+subviews<<subview_tree
+end
+end
+tree.view=view
+tree.subviews=subviews
+tree.superview=superview
+tree
+end
+
+def find(request)
+found=nil
+if request.kind_of?(Fixnum)
+raise "Invalid number" unless request>=0&&request<browsable_nodes.length
+found=browsable_nodes[request]
+elsif request.kind_of?(String)
+results=[]
+browsable_nodes.each do |node|
+next if node.nil?
+next unless node.view.accessibility_label
+pattern=Regexp.new(request,true)
+compare=node.view.accessibility_label=~pattern
+next if compare.nil?
+if node.view.accessibility_label.downcase==request.downcase
+return node
+else
+results<<node
+end
+end
+raise "\"#{request}\" could refer to more than one view." if results.length>1
+found=results.first
+else
+raise "Unknown request: #{request}: #{request.class}" unless request.respond_to?(:superview)
+found=request
+end
+found
+end
+
+end
+end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: motion-accessibility
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: '2.0'
 platform: ruby
 authors:
 - Austin Seraphin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-09 00:00:00.000000000 Z
+date: 2013-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -32,10 +32,15 @@ extensions: []
 extra_rdoc_files: []
 files:
 - README.md
+- lib/motion-accessibility-console/object.rb
+- lib/motion-accessibility-console.rb
 - lib/motion-accessibility.rb
 - lib/project/constants.rb
 - lib/project/element.rb
 - lib/project/inspector.rb
+- lib/project/motion-accessibility-console/browser.rb
+- lib/project/motion-accessibility-console/touch.rb
+- lib/project/motion-accessibility-console/tree.rb
 - lib/project/object.rb
 - lib/project/picker.rb
 - lib/project/status.rb
@@ -59,7 +64,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.0.6
 signing_key: 
 specification_version: 4
 summary: This gem provides easy ruby-like wrappers around the protocols which interact