sikuli 0.1.3 → 0.1.4

data/.gitignore

@@ -1,3 +1,4 @@
+.DS_Store
 *.gem
 .bundle
 Gemfile.lock

data/README.md

@@ -10,28 +10,44 @@ Requirements
 * [Sikuli X 1.0rc2](http://sikuli.org/)
 * OSX
 
+Compatibility
+-------------
+It's recommended to use JRuby ~> 1.6.0 and run it in 1.9 mode to get unicode characters working
+as expected.
+
+```
+export JRUBY_OPTS=--1.9
+```
+
 Installation
 ------------
 
     gem install sikuli
-    
+
 Usage
 -----
-    
+
     require 'java'
     require 'sikuli'
-    
-    Sikuli::Config.run do |config| 
+
+    Sikuli::Config.run do |config|
       config.image_path = "#{Dir.pwd}/images/"
       config.logging = false
     end
-    
+
     screen = Sikuli::Screen.new
     screen.click(10, 10) # should open your apple menu
-    
+
     app = Sikuli::App.new("iPhone Simulator")
     app.window.click('ui_element.png') if app.window.exists?('ui_element.png')
     
+Running the test suite
+----------------------
+
+1. You need to open `test_area.jpg` in **Preview** from `spec/support/images/` directory
+before running tests.
+2. You also need to open the **TextEdit** app
+
 Examples
 --------
 

data/lib/sikuli/app.rb

@@ -3,13 +3,13 @@ module Sikuli
     def initialize(app_name)
       @java_obj = org.sikuli.script::App.new(app_name)
     end
-  
+
     def focus
       @java_obj.focus()
     end
-  
+
     def window
       Region.new(@java_obj.window())
     end
   end
-end
+end

data/lib/sikuli/clickable.rb

@@ -15,7 +15,7 @@ module Sikuli
         else raise ArgumentError
       end
     end
-  
+
     def dragDrop(start_x, start_y, end_x, end_y)
       @java_obj.dragDrop(
         org.sikuli.script::Location.new(start_x, start_y).offset(x(), y()),
@@ -23,10 +23,10 @@ module Sikuli
         0
       )
     end
-    
+
     private
-    
-    def click_image(filename, opts = {})      
+
+    def click_image(filename, opts = {})
       begin
         if opts[:double]
           @java_obj.doubleClick(filename, 0)
@@ -37,7 +37,7 @@ module Sikuli
         raise "File Not Found: #{filename}"
       end
     end
-    
+
     def click_point(x, y, opts = {})
       if opts[:double]
         @java_obj.doubleClick(org.sikuli.script::Location.new(x, y).offset(x(), y()), 0)
@@ -46,4 +46,4 @@ module Sikuli
       end
     end
   end
-end
+end

data/lib/sikuli/config.rb

@@ -1,24 +1,29 @@
 module Sikuli
   class Config
-    def self.image_path
-      java.lang.System.getProperty("SIKULI_IMAGE_PATH")
-    end
-    
-    def self.image_path=(path)
-      java.lang.System.setProperty("SIKULI_IMAGE_PATH", path)
-    end
-    
-    def self.logging=(boolean)
-      return unless [TrueClass, FalseClass].include? boolean.class
-      org.sikuli.script::Settings.InfoLogs = boolean
-      org.sikuli.script::Settings.ActionLogs = boolean
-      org.sikuli.script::Settings.DebugLogs = boolean
-    end
-    
-    def self.run(*args)
-      if block_given?
-        yield self
+    class << self
+      attr_accessor :highlight_on_find
+
+      def image_path
+        java.lang.System.getProperty("SIKULI_IMAGE_PATH")
+      end
+
+      def image_path=(path)
+        java.lang.System.setProperty("SIKULI_IMAGE_PATH", path)
+      end
+
+      def logging=(boolean)
+        return unless [TrueClass, FalseClass].include? boolean.class
+        org.sikuli.script::Settings.InfoLogs = boolean
+        org.sikuli.script::Settings.ActionLogs = boolean
+        org.sikuli.script::Settings.DebugLogs = boolean
+      end
+
+      def run(*args)
+        if block_given?
+          yield self
+        end
       end
+
     end
   end
-end
+end

data/lib/sikuli/region.rb

@@ -7,29 +7,29 @@ module Sikuli
     include Clickable
     include Typeable
     include Searchable
-      
+
     def initialize(*args)
       @java_obj = org.sikuli.script::Region.new(*args)
     end
-  
+
     def highlight(seconds = 1)
       @java_obj.highlight(seconds)
     end
-  
+
     def x
       @java_obj.x()
     end
-  
+
     def y
       @java_obj.y()
     end
-  
+
     def width
       @java_obj.w()
     end
-  
+
     def height
       @java_obj.h()
     end
   end
-end
+end

data/lib/sikuli/searchable.rb

@@ -1,18 +1,20 @@
 module Sikuli
-  module Searchable  
+  module Searchable
     def find(filename, similarity = 0.9)
       begin
         pattern = org.sikuli.script::Pattern.new(filename).similar(similarity)
-        Region.new(@java_obj.find(pattern))
+        region = Region.new(@java_obj.find(pattern))
+        region.highlight if Sikuli::Config.highlight_on_find
+        return region
       rescue
         raise "File Not Found: #{filename}"
       end
     end
-    
+
     def exists?(filename, similarity = 0.9, time = 0.5)
       pattern = org.sikuli.script::Pattern.new(filename).similar(similarity)
       @java_obj.exists(pattern, time)
     end
     alias_method :contains?, :exists?
   end
-end
+end

data/lib/sikuli/version.rb

@@ -1,3 +1,3 @@
 module Sikuli
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

data/spec/sikuli/app_spec.rb

@@ -2,6 +2,6 @@ require 'spec_helper'
 
 describe Sikuli::App do
   subject { Sikuli::App.new('Finder') }
-  
+
   its(:window) { should be_an_instance_of Sikuli::Region }
-end
+end

data/spec/sikuli/clickable_spec.rb

@@ -2,22 +2,21 @@ require 'spec_helper'
 
 describe Sikuli::Region, "#Clickable" do
   before(:all) do
-    #open the file 'test_area.jpg' in Preview at zoom level 0
     @region = setup_test_area
   end
-  
+
   it "should perform a click at 10, 10" do
     lambda { @region.click(12, 12) }.should_not raise_error
   end
-  
-  it "should perform a double click 10, 1040" do 
+
+  it "should perform a double click 10, 1040" do
     lambda { @region.doubleClick(12, 491) }.should_not raise_error
   end
-  
+
   it "should perform a double click on an image" do
     lambda { @region.doubleClick("smiley_face.png") }.should_not raise_error
   end
-  
+
   it "should perform a drag and drop" do
     lambda { @region.dragDrop(12, 12, 491, 491) }.should_not raise_error
   end
@@ -25,8 +24,8 @@ describe Sikuli::Region, "#Clickable" do
   it "should perform a click on an image" do
     lambda { @region.click("smiley_face.png") }.should_not raise_error
   end
-  
+
   it "should not perform a click on an image that is outside of the region" do
     lambda { @region.click("apple.png")}.should raise_error
   end
-end
+end

data/spec/sikuli/config_spec.rb

@@ -5,33 +5,43 @@ describe Sikuli::Config do
     Sikuli::Config.image_path = ""
     java.lang.System.getProperty("SIKULI_IMAGE_PATH").should == ""
   end
-  
+
   it "should allow a path to be added" do
     Sikuli::Config.run do |config|
       config.image_path = '/Users/images/'
     end
-    
+
     java.lang.System.getProperty("SIKULI_IMAGE_PATH").should == '/Users/images/'
     Sikuli::Config.image_path.should == '/Users/images/'
   end
-  
+
   it "should allow logging to be turned on" do
     Sikuli::Config.run do |config|
       config.logging = true
     end
-    
+
     org.sikuli.script::Settings.InfoLogs.should be_true
     org.sikuli.script::Settings.ActionLogs.should be_true
     org.sikuli.script::Settings.DebugLogs.should be_true
   end
-  
+
   it "should allow logging to be turned off" do
     Sikuli::Config.run do |config|
       config.logging = false
     end
-    
+
     org.sikuli.script::Settings.InfoLogs.should be_false
     org.sikuli.script::Settings.ActionLogs.should be_false
     org.sikuli.script::Settings.DebugLogs.should be_false
   end
-end
+
+  it "should allow us to turn off highlighting on find" do
+    Sikuli::Config.highlight_on_find = false
+    Sikuli::Config.highlight_on_find.should be_false
+  end
+
+  it "should allow us to turn on highlighting on find" do
+    Sikuli::Config.highlight_on_find = true
+    Sikuli::Config.highlight_on_find.should be_true
+  end
+end

data/spec/sikuli/screen_spec.rb

@@ -2,9 +2,11 @@ require 'spec_helper'
 
 describe Sikuli::Screen, 'when initialized' do
   subject { Sikuli::Screen.new }
-  
+
   its(:x) { should == 0 }
   its(:y) { should == 0 }
-  its(:width) { should == 1680 } # screen's resolution
-  its(:height) { should == 1050 } # screen's resolution
-end
+  its(:width) { should > 0 } # screen's resolution
+  its(:width) { should be_instance_of Fixnum }
+  its(:height) { should > 0 } # screen's resolution
+  its(:height) { should be_instance_of Fixnum }
+end

data/spec/sikuli/searchable_spec.rb

@@ -2,31 +2,30 @@ require 'spec_helper'
 
 describe Sikuli::Region, "#Searchable" do
   before(:all) do
-    #open the file 'test_area.jpg' in Preview at zoom level 0
     @region = setup_test_area
   end
-  
+
   it "should find an image within the region" do
     @region.find("smiley_face.png").should_not be_nil
   end
-  
+
   it "should return a region containing the found image" do
     @region.find("smiley_face.png").should be_an_instance_of Sikuli::Region
   end
-  
+
   it "should not find an image that is not in the region" do
     lambda { @region.find("apple.png") }.should raise_error
   end
-  
+
   it "should return true if the image is found" do
     @region.exists?("smiley_face.png").should be_true
   end
-  
+
   it "should allow you to call contains?" do
     @region.contains?("smiley_face.png").should be_true
   end
-  
+
   it "should return false if the image is not found" do
     @region.exists?("apple.png").should be_false
   end
-end
+end

data/spec/sikuli/typeable_spec.rb

@@ -2,25 +2,23 @@ require 'spec_helper'
 
 describe Sikuli::Region, "#Typeable" do
   before(:all) do
-    app = Sikuli::App.new("TextMate")
+    app = Sikuli::App.new("TextEdit")
     app.focus
-    @region = app.window 
+    @region = app.window
   end
-  
+
   context "modifying text input with" do
     it "apple key" do
       @region.type("n", Sikuli::KEY_CMD)
     end
-    
+
     it "shift key" do
       @region.type("this should be lower case")
       @region.type("this should be upper case", Sikuli::KEY_SHIFT)
     end
   end
-  
+
   context "unicode characters" do
-    # tell JRuby to run in 1.9 mode
-    # http://stackoverflow.com/questions/4755900/how-to-make-jruby-1-6-default-to-ruby-1-9
     it("backspace")   { @region.type(Sikuli::KEY_BACKSPACE * 50) }
     it("return")      { @region.type(Sikuli::KEY_RETURN) }
     xit("up arrow")   { @region.type(Sikuli::UP_ARROW) }
@@ -28,4 +26,4 @@ describe Sikuli::Region, "#Typeable" do
     it("down arrow")  { @region.type(Sikuli::DOWN_ARROW) }
     it("right arrow") { @region.type(Sikuli::RIGHT_ARROW) }
   end
-end
+end

data/spec/spec_helper.rb

@@ -11,9 +11,9 @@ def setup_test_area
   app = Sikuli::App.new('Preview')
   app.focus()
   center = screen.find("#{Dir.pwd}/spec/support/images/smiley_face.png")
-  
+
   test_area = Sikuli::Region.new(center.x - 212, center.y - 212, 503, 503)
   test_area.highlight
- 
+
   test_area
-end
+end

metadata

@@ -2,7 +2,7 @@
 name: sikuli
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors: 
   - Chas Lemley
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-25 00:00:00 -04:00
+date: 2011-07-28 00:00:00 -04:00
 default_executable: 
 dependencies: 
   - !ruby/object:Gem::Dependency 
@@ -58,7 +58,6 @@ files:
   - spec/sikuli/searchable_spec.rb
   - spec/sikuli/typeable_spec.rb
   - spec/spec_helper.rb
-  - spec/support/images/.DS_Store
   - spec/support/images/apple.png
   - spec/support/images/smiley_face.png
   - spec/support/images/test_area.jpg
@@ -99,7 +98,6 @@ test_files:
   - spec/sikuli/searchable_spec.rb
   - spec/sikuli/typeable_spec.rb
   - spec/spec_helper.rb
-  - spec/support/images/.DS_Store
   - spec/support/images/apple.png
   - spec/support/images/smiley_face.png
   - spec/support/images/test_area.jpg