sikuli 0.1.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in sikuli_ruby.gemspec
+gemspec

data/README.md

@@ -0,0 +1,32 @@
+Sikuli Ruby
+===========
+
+[Sikuli](http://sikuli.org/) allows you to interact with your application's user interface using image based search to automate user actions.
+
+Requirements
+------------
+
+* JRuby (rvm install jruby)
+* [Sikuli X 1.0rc2](http://sikuli.org/)
+* OSX
+
+Installation
+------------
+
+    gem install sikuli
+    
+Usage
+-----
+    
+    require 'java'
+    require 'sikuli'
+    
+    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?('other_ui_element.png')
+      raise "Error!"
+    end

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/lib/sikuli.rb

@@ -0,0 +1,27 @@
+require "sikuli/sikuli-script.jar"
+require "sikuli/version"
+
+require "sikuli/app"
+require "sikuli/region"
+require "sikuli/screen"
+
+module Sikuli
+  def self.getImagePath
+    paths = java.lang.System.getProperty("SIKULI_IMAGE_PATH") || ""
+    paths.split(":")
+  end
+  
+  def self.addImagePath(path)
+    paths = self.getImagePath
+    paths << path
+    
+    java.lang.System.setProperty("SIKULI_IMAGE_PATH", paths.join(':'))
+  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
+end

data/lib/sikuli/app.rb

@@ -0,0 +1,15 @@
+module Sikuli
+  class App
+    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

data/lib/sikuli/clickable.rb

@@ -0,0 +1,49 @@
+module Sikuli
+  module Clickable
+    def click(*args)
+      case args.length
+        when 1 then click_image(args[0])
+        when 2 then click_point(args[0], args[1])
+        else raise ArgumentError
+      end
+    end
+
+    def doubleClick(*args)
+      case args.length
+        when 1 then click_image(args[0], { :double => true })
+        when 2 then click_point(args[0], args[1], {:double => true })
+        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()),
+        org.sikuli.script::Location.new(end_x, end_y).offset(x(), y()),
+        0
+      )
+    end
+    
+    private
+    
+    def click_image(filename, opts = {})      
+      begin
+        if opts[:double]
+          @java_obj.doubleClick(filename, 0)
+        else
+          @java_obj.click(filename, 0)
+        end
+      rescue
+        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)
+      else
+        @java_obj.click(org.sikuli.script::Location.new(x, y).offset(x(), y()), 0)
+      end
+    end
+  end
+end

data/lib/sikuli/region.rb

@@ -0,0 +1,35 @@
+require "sikuli/clickable"
+require "sikuli/typeable"
+require "sikuli/searchable"
+
+module Sikuli
+  class Region
+    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

data/lib/sikuli/screen.rb

@@ -0,0 +1,7 @@
+module Sikuli
+  class Screen < Region
+    def initialize
+      @java_obj = org.sikuli.script::Screen.new()
+    end
+  end
+end

data/lib/sikuli/searchable.rb

@@ -0,0 +1,17 @@
+module Sikuli
+  module Searchable  
+    def find(filename, similarity = 0.9)
+      begin
+        pattern = org.sikuli.script::Pattern.new(filename).similar(similarity)
+        Region.new(@java_obj.find(pattern))
+      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
+  end
+end

data/lib/sikuli/typeable.rb

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

data/lib/sikuli/version.rb

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

data/sikuli.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "sikuli/version"
+
+Gem::Specification.new do |s|
+  s.add_development_dependency "rspec"
+  s.name        = "sikuli"
+  s.version     = Sikuli::VERSION
+  s.authors     = ["Chas Lemley"]
+  s.email       = ["chas.lemley@gmail.com"]
+  s.homepage    = "https://github.com/chaslemley/sikuli_ruby"
+  s.summary     = %q{Ruby wrapper for Sikuli GUI automation library}
+  s.description = %q{Sikuli allows you to interact with your application's user interface using image based search to automate user actions.}
+
+  s.rubyforge_project = "sikuli"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/spec/sikuli/app_spec.rb

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

data/spec/sikuli/region_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+
+describe Sikuli::Region, 'when initialized with a rectangle' do
+  subject { Sikuli::Region.new(10, 15, 250, 400) }
+  its(:x) { should == 10 }
+  its(:y) { should == 15 }
+  its(:width) { should == 250 }
+  its(:height) { should == 400 }
+end
+
+describe Sikuli::Region, 'when initialzed with a sikuli region' do
+  subject { Sikuli::Region.new org.sikuli.script::Region.new(11, 16, 251, 401) }
+  its(:x) { should == 11 }
+  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/screen_spec.rb

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

data/spec/sikuli_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe Sikuli, "image path" do
+  it "should retain a list of directories to search in for images" do
+    Sikuli.getImagePath().should == []
+  end
+  
+  it "should allow a path to be added" do
+    Sikuli.addImagePath('/Users/images/')
+    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
+    
+    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
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+require 'java'
+
+require 'rspec'
+require 'sikuli'
+
+Sikuli.logging = false
+
+def setup_test_area
+  Sikuli.addImagePath("#{Dir.pwd}/spec/support/images/")
+  screen = Sikuli::Screen.new
+  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

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification 
+name: sikuli
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+  - Chas Lemley
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-24 00:00:00 -04:00
+default_executable: 
+dependencies: 
+  - !ruby/object:Gem::Dependency 
+    name: rspec
+    prerelease: false
+    requirement: &id001 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: "0"
+    type: :development
+    version_requirements: *id001
+description: Sikuli allows you to interact with your application's user interface using image based search to automate user actions.
+email: 
+  - chas.lemley@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+  - .gitignore
+  - Gemfile
+  - README.md
+  - Rakefile
+  - lib/sikuli.rb
+  - lib/sikuli/app.rb
+  - lib/sikuli/clickable.rb
+  - lib/sikuli/region.rb
+  - lib/sikuli/screen.rb
+  - lib/sikuli/searchable.rb
+  - lib/sikuli/sikuli-script.jar
+  - lib/sikuli/typeable.rb
+  - lib/sikuli/version.rb
+  - sikuli.gemspec
+  - spec/sikuli/app_spec.rb
+  - spec/sikuli/region_spec.rb
+  - spec/sikuli/screen_spec.rb
+  - spec/sikuli_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
+has_rdoc: true
+homepage: https://github.com/chaslemley/sikuli_ruby
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+  - lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+requirements: []
+
+rubyforge_project: sikuli
+rubygems_version: 1.5.1
+signing_key: 
+specification_version: 3
+summary: Ruby wrapper for Sikuli GUI automation library
+test_files: 
+  - spec/sikuli/app_spec.rb
+  - spec/sikuli/region_spec.rb
+  - spec/sikuli/screen_spec.rb
+  - spec/sikuli_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