sikuli 0.1.0 → 0.1.1

data/README.md

@@ -21,12 +21,15 @@ Usage
     require 'java'
     require 'sikuli'
     
+    Sikuli.addImagePath("#{Dir.pwd}/images/")
+    
     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')
+    app.window.click('ui_element.png') if app.window.exists?('ui_element.png')
     
-    if !app.window.exists?('other_ui_element.png')
-      raise "Error!"
-    end
+Examples
+--------
+
+* [Cucumber Suite](https://github.com/chaslemley/cucumber_sikuli)

data/lib/sikuli.rb

@@ -4,8 +4,11 @@ require "sikuli/version"
 require "sikuli/app"
 require "sikuli/region"
 require "sikuli/screen"
+require "sikuli/key_code"
 
 module Sikuli
+  include KeyCode
+  
   def self.getImagePath
     paths = java.lang.System.getProperty("SIKULI_IMAGE_PATH") || ""
     paths.split(":")

data/lib/sikuli/key_code.rb

@@ -0,0 +1,14 @@
+module KeyCode
+  KEY_CMD   = java.awt.event.InputEvent::META_MASK
+  KEY_SHIFT = java.awt.event.InputEvent::SHIFT_MASK
+  KEY_CTRL  = java.awt.event.InputEvent::CTRL_MASK
+  KEY_ALT   = java.awt.event.InputEvent::ALT_MASK
+  
+  KEY_BACKSPACE = "\u0008"
+  KEY_RETURN    = "\n"
+  
+  UP_ARROW      = nil
+  LEFT_ARROW    = "\ue003"
+  DOWN_ARROW    = nil
+  RIGHT_ARROW   = nil
+end

data/lib/sikuli/typeable.rb

@@ -1,7 +1,7 @@
 module Sikuli
   module Typeable
-    def type(text)
-      @java_obj.type(nil, text, 0)
+    def type(text, modifier = 0)
+      @java_obj.type(nil, text, modifier)
     end
   end
 end

data/lib/sikuli/version.rb

@@ -1,3 +1,3 @@
 module Sikuli
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/spec/sikuli/clickable_spec.rb

@@ -0,0 +1,32 @@
+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 
+    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
+
+  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

data/spec/sikuli/region_spec.rb

@@ -14,62 +14,4 @@ describe Sikuli::Region, 'when initialzed with a sikuli region' do
   its(:y) { should == 16 }
   its(:width) { should == 251 }
   its(:height) { should == 401 }
-end
-
-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 
-    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
-
-  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
-
-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 return false if the image is not found" do
-    @region.exists?("apple.png").should be_false
-  end
 end

data/spec/sikuli/searchable_spec.rb

@@ -0,0 +1,28 @@
+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 return false if the image is not found" do
+    @region.exists?("apple.png").should be_false
+  end
+end

data/spec/sikuli/typeable_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe Sikuli::Region, "#Typeable" do
+  before(:all) do
+    app = Sikuli::App.new("TextMate")
+    app.focus
+    @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) }
+    it("left arrow")  { @region.type(Sikuli::LEFT_ARROW) }
+    it("down arrow")  { @region.type(Sikuli::DOWN_ARROW) }
+    it("right arrow") { @region.type(Sikuli::RIGHT_ARROW) }
+  end
+end

data/spec/sikuli_spec.rb

@@ -10,14 +10,6 @@ describe Sikuli, "image path" do
     Sikuli.getImagePath().should == ['/Users/images/']
   end
   
-  it "should allow logging to be turned off" do
-    Sikuli.logging = false
-    
-    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
-  
   it "should allow logging to be turned on" do
     Sikuli.logging = true
     
@@ -25,4 +17,12 @@ describe Sikuli, "image path" do
     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.logging = false
+    
+    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

metadata

@@ -2,7 +2,7 @@
 name: sikuli
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
   - Chas Lemley
@@ -41,6 +41,7 @@ files:
   - lib/sikuli.rb
   - lib/sikuli/app.rb
   - lib/sikuli/clickable.rb
+  - lib/sikuli/key_code.rb
   - lib/sikuli/region.rb
   - lib/sikuli/screen.rb
   - lib/sikuli/searchable.rb
@@ -49,8 +50,11 @@ files:
   - lib/sikuli/version.rb
   - sikuli.gemspec
   - spec/sikuli/app_spec.rb
+  - spec/sikuli/clickable_spec.rb
   - spec/sikuli/region_spec.rb
   - spec/sikuli/screen_spec.rb
+  - spec/sikuli/searchable_spec.rb
+  - spec/sikuli/typeable_spec.rb
   - spec/sikuli_spec.rb
   - spec/spec_helper.rb
   - spec/support/images/.DS_Store
@@ -87,8 +91,11 @@ specification_version: 3
 summary: Ruby wrapper for Sikuli GUI automation library
 test_files: 
   - spec/sikuli/app_spec.rb
+  - spec/sikuli/clickable_spec.rb
   - spec/sikuli/region_spec.rb
   - spec/sikuli/screen_spec.rb
+  - spec/sikuli/searchable_spec.rb
+  - spec/sikuli/typeable_spec.rb
   - spec/sikuli_spec.rb
   - spec/spec_helper.rb
   - spec/support/images/.DS_Store