<commit_before>Sikulio: A framework for testing with Sikuli
============================================

Sikulio provides a Page Object style framework on top of Sikuli.

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

Usage
-----

    require 'sikulio'

    Sikulio::Config.image_asdf = '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

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.<commit_msg>fixed typo<commit_after>Sikulio: A framework for testing with Sikuli
============================================

Sikulio provides a Page Object style framework on top of Sikuli.

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

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

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.
{'fraction_non_alphanumeric': 0.14169381107491857, 'fraction_numerical': 0.0024429967426710096, 'mean_word_length': 3.1294117647058823, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 9, 'https://': 4, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '7332674', 'n_tokens_mistral': 745, 'n_tokens_neox': 710, 'n_words': 252}