sikulio 0.1.beta

data/.gitignore

@@ -0,0 +1,52 @@
+# gem build
+sikulio-*.gem
+
+# rcov generated
+coverage
+coverage.data
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+
+# jeweler generated
+pkg
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+#.DS_Store
+
+# For TextMate
+#*.tmproj
+#tmtags
+
+# For emacs:
+*~
+#\#*
+#.\#*
+
+# For vim:
+*.swp
+
+# For redcar:
+#.redcar
+
+# For rubinius:
+#*.rbc

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--tty
+--format progress

data/Gemfile

@@ -0,0 +1,15 @@
+source "https://www.rubygems.org"
+
+gem "bundler"
+gem "sikuli", "~> 0.3.0"
+gem "active_support", "~> 3.0.0"
+
+group :development do
+  gem "rspec"
+  gem "i18n", "~> 0.6.0"
+end
+
+platforms :mri do
+  gem "redcarpet"
+  gem "yard"
+end

data/Gemfile.lock

@@ -0,0 +1,29 @@
+GEM
+  remote: https://www.rubygems.org/
+  specs:
+    active_support (3.0.0)
+      activesupport (= 3.0.0)
+    activesupport (3.0.0)
+    diff-lcs (1.1.3)
+    i18n (0.6.1)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.2)
+    rspec-expectations (2.12.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.2)
+    sikuli (0.3.0)
+
+PLATFORMS
+  java
+
+DEPENDENCIES
+  active_support (~> 3.0.0)
+  bundler
+  i18n (~> 0.6.0)
+  redcarpet
+  rspec
+  sikuli (~> 0.3.0)
+  yard

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Matthew Hull
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,48 @@
+Sikulio: A framework for testing with Sikuli
+============================================
+
+Sikulio provides a Page Object style framework on top of Sikuli.
+
+Still very much a work in progress.
+
+Requirements
+------------
+
+* [JRuby] (http://jruby.org/download)
+* [Sikuli Ruby] (https://github.com/chaslemley/sikuli_ruby)
+
+See the [Sikuli Ruby README] (https://github.com/chaslemley/sikuli_ruby/blob/master/README.md) for details on installing and configuring Sikuli.
+
+Installation
+------------
+
+gem install sikulio --pre
+
+Usage
+-----
+
+    require 'sikulio'
+
+    Sikulio::Config.image_root = 'images'
+
+    class MyComponent < Sikulio::Component
+      init_image_elements -- Adds a Sikulio element for each .png files found in images/my_component
+
+      relative_element :first_name_field,
+        :relative_to => :first_name_label,
+        :offset_x => 30, -- Look x pixels to the right of the relative_to element's center
+        :offset_y => 0   -- Look y pixels down from the relative_to element's center
+    end
+
+    comp = MyComponent.new
+    
+    comp.first_name_label.click
+    comp.first_name_label.type 'Joe'
+
+Running the test suite
+----------------------
+    
+    jruby -S bundle exec rspec spec
+
+Take some chill time while the tests are running - the integration tests will launch a Java Swing application
+and will fail if you take focus away.

data/Rakefile

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

data/lib/sikulio.rb

@@ -0,0 +1,13 @@
+require 'java'
+require 'sikuli'
+require 'active_support/all'
+
+require 'sikulio/version'
+
+require 'sikulio/config'
+require 'sikulio/exceptions'
+require 'sikulio/screen'
+
+require 'sikulio/element'
+require 'sikulio/relative_element'
+require 'sikulio/component'

data/lib/sikulio/component.rb

@@ -0,0 +1,76 @@
+module Sikulio
+
+  ##
+  # Represents a segment of the UI. For example: 
+  # * Web page
+  # * Modal dialog
+  # * Windows toolbar
+  # 
+  # Exposes a DSL for initializing and accessing Sikulio elements
+  # 
+  # The following example MyComponent class will include an auto-generated Sikulio element for
+  # each image file located in the my_component folder under the image_root folder. Additionally,
+  # defines a text entry field relative to the some_label element.
+  #
+  #   Sikulio::Config.image_root = 'image_root'   
+  #
+  #   class MyComponent < Component
+  #   ...
+  #     init_image_elements
+  #
+  #     relative_element :some_entry_field,
+  #       :relative_to => :some_label,
+  #       :offset_x => 30,
+  #       :offset_y => 0
+  #   ...
+  
+  class Component
+ 
+    # A Sikuli screen instance that will be shared by this component's elements 
+    attr_accessor :screen
+
+    # The root folder under which GUI images are stored
+    cattr_accessor :image_root
+
+    def component_path
+      @component_path ||= self.class.to_s.underscore
+    end
+
+    def component_path=(path)
+      @component_path = path
+    end
+    
+    # Sets the screen attribute for this component
+    # Defaults to the singleton screen provided by Sikulio::Screen
+    def initialize(screen = Sikulio::Screen.instance.screen)
+      self.screen = screen
+    end
+
+    # Initializes Sikulio image elements corresponding to 
+    # the images in the specified location
+    def self.init_image_elements(component_path=nil, image_root=Sikulio::Config.image_root)
+
+      component_path ||= self.to_s.underscore
+
+      images = Dir[File.join(image_root, component_path, "/*.png")]
+
+      images.each do |i|
+        el_name = File.basename(i, ".png")
+	define_method(el_name) { Element.new self.instance_variable_get(:@screen), i }
+      end
+
+    end
+
+    # Defines an element positioned relative to another element
+    # e.g. a text input field, relative to the field label
+    def self.relative_element(el_name, params = {})
+      
+      define_method(el_name) do
+        RelativeElement.new self.instance_variable_get(:@screen),
+	  self.send(params[:relative_to]).ident,
+	  params[:offset_x],
+	  params[:offset_y]
+      end
+    end
+  end
+end

data/lib/sikulio/config.rb

@@ -0,0 +1,12 @@
+# Global configurations for the Sikulio framework
+#
+module Sikulio
+  class Config
+    class << self
+
+      # The default location to search for images
+      attr_accessor :image_root
+
+    end
+  end
+end

data/lib/sikulio/element.rb

@@ -0,0 +1,35 @@
+module Sikulio
+  class Element
+
+    attr_accessor :screen
+
+    # The identifier (e.g. filename or OCR string) which Sikuli will use to locate the element
+    attr_accessor :ident
+
+    # Sets screen and image file path
+    def initialize(screen, ident)
+      self.screen = screen
+      self.ident = ident
+    end
+
+    def create_relative_element(offset_x, offset_y)
+      Sikulio::RelativeElement.new screen, ident, offset_x, offset_y
+    end
+
+    # Click on this element
+    def click
+      screen.click ident
+    end
+
+    # Find this element on screen
+    def find
+      screen.find ident
+    end
+
+    # Send keystrokes
+    def type(keystrokes)
+      screen.type keystrokes
+    end
+
+  end
+end

data/lib/sikulio/exceptions.rb

@@ -0,0 +1,5 @@
+module Sikulio
+  module Exceptions
+    class InvalidElementTypeError < RuntimeError; end
+  end
+end

data/lib/sikulio/relative_element.rb

@@ -0,0 +1,37 @@
+module Sikulio
+  class RelativeElement
+
+    attr_accessor :screen
+    attr_accessor :ident
+    attr_accessor :offset_x
+    attr_accessor :offset_y
+
+    # Sets screen and image file path
+    def initialize(screen, ident, offset_x, offset_y)
+      self.screen = screen
+      self.ident = ident
+      self.offset_x = offset_x
+      self.offset_y = offset_y
+    end
+
+    # Click on this element
+    def click
+      start_point = screen.find ident
+      click_x = start_point.x + offset_x
+      click_y = start_point.y + offset_y
+
+      screen.click click_x, click_y
+    end
+
+    # Find this element on screen
+    def find
+      screen.find ident
+    end
+
+    # Send keystrokes to element
+    def type(keystrokes)
+      screen.type keystrokes
+    end
+
+  end
+end

data/lib/sikulio/screen.rb

@@ -0,0 +1,20 @@
+require 'singleton'
+
+module Sikulio
+  
+  # Provides consistent access to a single Sikuli screen object
+  # 
+  # Sikuli throws intermittent errors if multiple screen objects are in use
+  # Providing singleton access to a screen prevents this from occuring
+  # Usage: Sikulio::Screen.instance 
+
+  class Screen
+    include Singleton 
+
+    attr_accessor :screen
+
+    def initialize
+      self.screen = Sikuli::Screen.new
+    end
+  end
+end

data/lib/sikulio/version.rb

@@ -0,0 +1,3 @@
+module Sikulio
+  VERSION = "0.1.beta"
+end

data/sikulio.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sikulio/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "sikulio"
+  gem.version       = Sikulio::VERSION
+  gem.authors       = ["Matthew Hull"]
+  gem.email         = ["hull.matt@gmail.com"]
+  gem.description   = %q{A Page Object style framework leveraging Sikuli}
+  gem.summary       = %q{Test automation framework for all the things}
+  gem.homepage      = "https://github.com/matthull/sikulio"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/spec/integration/hello_world_component_spec.rb

@@ -0,0 +1,61 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+
+include Java
+
+import javax.swing.JFrame
+import javax.swing.JPanel
+import javax.swing.JButton
+import javax.swing.JOptionPane
+
+class ClickingIsFunApp < JFrame
+  def initialize
+    super "Clicking Is Fun"
+
+    self.initUI
+  end
+
+  def initUI
+   
+    panel = JPanel.new
+    self.getContentPane.add panel
+    panel.setLayout nil
+
+    button = JButton.new "Click Me"
+    button.setBounds 100,60,100,30
+
+    button.addActionListener do |e|
+      JOptionPane.showMessageDialog panel, "Button Clicked", "An Informative Message", JOptionPane::INFORMATION_MESSAGE
+    end
+
+    panel.add button
+
+    self.setSize 300,200
+    self.setDefaultCloseOperation JFrame::DISPOSE_ON_CLOSE
+    self.setLocationRelativeTo nil
+    self.setVisible true
+  end
+  
+end
+
+describe Component do
+
+  Sikulio::Config.image_root = File.join(File.dirname(__FILE__), '..', 'support', 'images')
+
+  class ClickingIsFun < Component
+    init_image_elements
+  end
+  
+  it "clicks the image" do
+ 
+    app = ClickingIsFunApp.new
+
+    cif = ClickingIsFun.new
+    
+    cif.click_me_button.click
+
+    cif.button_clicked_dialog.find
+
+    app.dispose
+
+  end
+end

data/spec/integration/text_entry_component_spec.rb

@@ -0,0 +1,74 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+
+include Java
+
+import javax.swing.JFrame
+import javax.swing.JPanel
+import javax.swing.JOptionPane
+import javax.swing.JTextField
+import javax.swing.JLabel
+
+class TypingIsFunApp < JFrame
+  def initialize
+    super "Typing Is Fun"
+
+    self.initUI
+  end
+
+  def initUI
+   
+    panel = JPanel.new
+    panel.setLayout nil
+
+    wrongTextField = JTextField.new 10
+    wrongTextField.setBounds 10,20,20,30
+    panel.add wrongTextField
+
+    label = JLabel.new "Enter Text"
+    label.setBounds 10,80,60,90
+
+    panel.add label
+
+    textField = JTextField.new 30
+    textField.setBounds 78,80,180,90
+    panel.add textField
+
+    self.add panel
+    self.pack
+
+    self.setSize 300,300
+    self.setDefaultCloseOperation JFrame::DISPOSE_ON_CLOSE
+    self.setLocationRelativeTo nil
+    self.setVisible true
+    
+    wrongTextField.requestFocus
+  end
+  
+end
+
+describe Component do
+
+  Sikulio::Config.image_root = File.join(File.dirname(__FILE__), '..', 'support', 'images')
+
+  class TypingIsFun < Component
+    init_image_elements 'typing_is_fun'
+    relative_element :enter_text_field,
+    :relative_to => :enter_text_label,
+    :offset_x => 100,
+    :offset_y => 0
+  end
+  
+  it "clicks the image" do
+ 
+    app = TypingIsFunApp.new
+    tif = TypingIsFun.new
+	
+    tif.enter_text_field.click
+    tif.enter_text_field.type "blah and blah"
+
+    tif.expected_result.find
+
+    app.dispose
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+require 'rubygems'
+require 'bundler'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+end
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'sikulio'
+include Sikulio

data/spec/unit/component_spec.rb

@@ -0,0 +1,72 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+
+describe Component do
+  
+  Sikulio::Config.image_root = File.join(File.dirname(__FILE__), '..', 'support', 'images')
+
+  describe 'component_path' do
+   
+    class MyComponent < Component; end
+	 
+    subject(:comp) { MyComponent.new }	  
+
+    its(:component_path) { should == 'my_component' }
+
+    it 'can be set manually' do
+      comp.component_path = 'foo'
+      comp.component_path.should == 'foo'
+    end
+  end
+
+  describe '#init_image_elements', 'when component path and image root are manually specified' do
+
+    class ManuallyConfiguredComponent < Component
+      init_image_elements 'my_component', Sikulio::Config.image_root
+    end
+
+    subject { ManuallyConfiguredComponent.new }
+
+    its(:some_button) { should respond_to :click }
+    its(:some_label)  { should respond_to :click }
+  end
+
+  describe '#init_image_elements', 'when only component path is manually specified' do
+
+    class ConfiguredComponentPathComponent < Component
+      init_image_elements 'my_component'
+    end
+
+    subject { ConfiguredComponentPathComponent.new }
+
+    its(:some_button) { should respond_to :click }
+    its(:some_label)  { should respond_to :click }
+  end
+
+  describe '#init_image_elements', 'when no paths are specified' do
+
+    class MyComponent < Component
+      init_image_elements
+    end
+
+    subject { MyComponent.new }
+
+    its(:some_button) { should respond_to :click }
+    its(:some_label)  { should respond_to :click }
+  end
+
+  describe '#relative_element' do
+
+    class MyComponent < Component
+      init_image_elements
+
+      relative_element :some_field,
+        :relative_to => :some_label,
+        :offset_x => 20,
+        :offset_y => 0
+    end
+
+    subject { MyComponent.new }
+
+    it { should respond_to :some_field }
+  end
+end

data/spec/unit/element_spec.rb

@@ -0,0 +1,40 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+
+describe Element do
+
+  let(:file) { File.join(File.dirname(__FILE__), "images", "my_pic.png") }
+  let(:screen) { Sikuli::Screen.new }
+
+  before do
+   @el = Element.new(screen, file)
+  end	  
+
+  describe "#initialize" do
+    it "sets its screen and ident based on the provided values" do
+     @el.screen.should == screen
+     @el.ident.should == file
+    end
+  end
+
+  describe "#click" do
+    it "clicks itself" do
+     @el.screen.should_receive(:click).with(file)
+     @el.click
+    end
+  end
+
+  describe "#find" do
+    it "finds itself" do
+     @el.screen.should_receive(:find).with(file)
+     @el.find
+    end
+  end
+  
+  describe "#type" do
+    it "sends some keystrokes" do
+     @el.screen.should_receive(:type).with("blah")
+     @el.type "blah"
+    end
+  end
+
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: sikulio
+version: !ruby/object:Gem::Version
+  prerelease: 4
+  version: 0.1.beta
+platform: ruby
+authors:
+- Matthew Hull
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2013-02-20 00:00:00.000000000 Z
+dependencies: []
+description: A Page Object style framework leveraging Sikuli
+email:
+- hull.matt@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sikulio.rb
+- lib/sikulio/component.rb
+- lib/sikulio/config.rb
+- lib/sikulio/element.rb
+- lib/sikulio/exceptions.rb
+- lib/sikulio/relative_element.rb
+- lib/sikulio/screen.rb
+- lib/sikulio/version.rb
+- sikulio.gemspec
+- spec/integration/hello_world_component_spec.rb
+- spec/integration/text_entry_component_spec.rb
+- spec/spec_helper.rb
+- spec/support/images/clicking_is_fun/button_clicked_dialog.png
+- spec/support/images/clicking_is_fun/click_me_button.png
+- spec/support/images/my_component/some_button.png
+- spec/support/images/my_component/some_label.png
+- spec/support/images/typing_is_fun/enter_text_label.png
+- spec/support/images/typing_is_fun/expected_result.png
+- spec/unit/component_spec.rb
+- spec/unit/element_spec.rb
+- support/images/my_component/some_button.png
+- support/images/my_component/some_label.png
+homepage: https://github.com/matthull/sikulio
+licenses: []
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: !binary |-
+        MA==
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - !binary |-
+      Pg==
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+  none: false
+requirements: []
+rubyforge_project:
+rubygems_version: 1.8.25
+signing_key:
+specification_version: 3
+summary: Test automation framework for all the things
+test_files:
+- spec/integration/hello_world_component_spec.rb
+- spec/integration/text_entry_component_spec.rb
+- spec/spec_helper.rb
+- spec/support/images/clicking_is_fun/button_clicked_dialog.png
+- spec/support/images/clicking_is_fun/click_me_button.png
+- spec/support/images/my_component/some_button.png
+- spec/support/images/my_component/some_label.png
+- spec/support/images/typing_is_fun/enter_text_label.png
+- spec/support/images/typing_is_fun/expected_result.png
+- spec/unit/component_spec.rb
+- spec/unit/element_spec.rb
+has_rdoc: