samscript 0.1.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.tags
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in samscript.gemspec
+gemspec
+
+raise "gem must be run under jruby" unless RUBY_PLATFORM == "java"

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Sam Broughton
+
+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,43 @@
+# Samscript
+
+[![Code Climate](https://codeclimate.com/github/sambooo/Samscript.png)](https://codeclimate.com/github/sambooo/Samscript)
+
+A gem to replace AHK/Futscript for RS things
+
+## Installation
+
+This gem will only work under JRuby.
+
+Add this line to your application's Gemfile:
+
+    gem 'samscript'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install samscript
+
+## Example Usage
+
+The below script simply checks if the pixel at the mouse cursor is close to black every 100ms for 1 second, and prints true/false to console depending on the success.
+
+```ruby
+require 'samscript'
+
+Screen::wait_for_pixel(colour: java.awt.Color::BLACK,
+                       location: Mouse.position(as: :vector)
+                       tolerance: 10
+                       interval: 100
+                       timeout: 1000) { |status| puts status }
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+
+desc "Build CTags"
+task :ctags do
+  paths = Bundler.load.specs.map(&:full_gem_path)
+  system("ctags -R -f .tags #{paths.join(' ')}")
+end

data/lib/samscript.rb

@@ -0,0 +1,9 @@
+require 'samscript/version'
+require 'samscript/screen'
+require 'samscript/image'
+require 'samscript/mouse'
+require 'samscript/wait_matcher'
+require 'samscript/helpers'
+
+module Samscript
+end

data/lib/samscript/helpers.rb

@@ -0,0 +1,2 @@
+Mouse = Samscript::Mouse
+Screen = Samscript::Screen

data/lib/samscript/image.rb

@@ -0,0 +1,21 @@
+require 'matrix'
+
+module Samscript
+  class Image
+    java_import 'java.awt.Color'
+
+    def self.get_pixel image, params = {}
+      x = params[:x] || 0
+      y = params[:y] || 0
+
+      rgb = image.get_rgb(x, y)
+      Color.new rgb
+    end
+
+    def self.get_difference c1, c2
+      [c1.red - c2.red,
+       c1.green - c2.green,
+       c1.blue - c2.blue].map(&:abs).max
+    end
+  end
+end

data/lib/samscript/mouse.rb

@@ -0,0 +1,43 @@
+require 'matrix'
+
+module Samscript
+  class Mouse
+    java_import 'java.awt.MouseInfo'
+    java_import 'java.awt.Robot'
+    java_import 'java.awt.Point'
+    java_import 'java.awt.event.InputEvent'
+
+    def self.robot
+      @robot ||= Robot.new
+    end
+
+    def self.position params = {}
+      as = params[:as] || :point
+      point = MouseInfo.get_pointer_info.get_location
+      vector = Vector[point.get_x, point.get_y]
+
+      case as
+      when :point
+        return point
+      when :vector
+        return vector
+      end
+    end
+
+    def self.position= point
+      x, y = point[0], point[1] if point.is_a? Vector
+      x, y = point.get_x, point.get_y if point.is_a? Point
+
+      robot.mouse_move(x, y)
+    end
+
+    def self.click button = :left
+      masks = { left:  InputEvent::BUTTON1_MASK,
+                right: InputEvent::BUTTON2_MASK }
+      mask = masks[button]
+
+      robot.mouse_press mask
+      robot.mouse_release mask
+    end
+  end
+end

data/lib/samscript/screen.rb

@@ -0,0 +1,52 @@
+module Samscript
+  class Screen
+    java_import 'java.awt.Toolkit'
+    java_import 'java.awt.Rectangle'
+    java_import 'java.awt.Robot'
+
+    DefaultParams = { match: true,
+                      tolerance: 0,
+                      interval: 100,
+                      timeout: 1000 }
+
+    def self.resolution
+      @tk ||= Java::JavaAwt::Toolkit.get_default_toolkit
+      @tk.get_screen_size
+    end
+
+    def self.capture area = resolution
+      rect = Rectangle.new area
+      @robot ||= Robot.new
+      @robot.create_screen_capture rect
+    end
+
+    def self.wait_for_pixel params = {}
+      %w(location colour).map(&:to_sym).each do |sym|
+        raise "invalid params" if params[sym].nil?
+      end
+
+      x, y      = params[:location][0], params[:location][1]
+      colour    = params[:colour]
+      tolerance = params[:tolerance] || DefaultParams[:tolerance]
+      match     = params[:match]     || DefaultParams[:match]
+      interval  = params[:interval]  || DefaultParams[:interval]
+      timeout   = params[:timeout]   || DefaultParams[:timeout]
+      attempts  = (timeout/interval+1).floor
+
+      return if match == :any or tolerance >= 255
+
+      attempts.times do
+        screen = self.capture
+        pixel = Samscript::Image.get_pixel(screen, x: x, y: y)
+        if Samscript::Image.get_difference(pixel, colour) <= tolerance
+          yield(true) if block_given?
+          return
+        end
+
+        sleep(interval.to_f/1000)
+      end
+
+      yield(false) if block_given?
+    end
+  end
+end

data/lib/samscript/version.rb

@@ -0,0 +1,3 @@
+module Samscript
+  VERSION = "0.1.1"
+end

data/lib/samscript/wait_matcher.rb

@@ -0,0 +1,37 @@
+require 'matrix'
+
+module Samscript
+  class WaitMatcher
+    java_import 'java.awt.Color'
+
+    def self.validate_wait_params params
+      raise "no params" if params.empty?
+    end
+
+    def self.parse_location params
+      labels = [:at, :location, :coords, :point, :pixel]
+      loc = labels.reduce(nil) { |mem, sym| params[sym] || mem }
+
+      case loc
+      when Vector
+        return loc
+      when Array
+        return Vector[loc[0], loc[1]]
+      when Point
+        return Vector[loc.get_x, loc.get_y]
+      end
+    end
+
+    def self.parse_colour params
+      labels = [:colour, :color]
+      col = labels.reduce(nil) { |mem, sym| params[sym] || mem }
+
+      case col
+      when Color
+        return col
+      when Array
+        return Color.new(col[0], col[1], col[2])
+      end
+    end
+  end
+end

data/samscript.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'samscript/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "samscript"
+  spec.version       = Samscript::VERSION
+  spec.authors       = ["Sam Broughton"]
+  spec.email         = ["sam@26th-zerk.co.uk"]
+  spec.description   = %q{Samscript}
+  spec.summary       = %q{Samscript}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "shoulda"
+end

data/spec/image_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe Samscript::Image do
+  before :all do
+    java_import 'java.awt.Color'
+  end
+
+  let(:screenshot) { Samscript::Screen.capture }
+
+  it "getting pixel colour" do
+    pixel = Samscript::Image.get_pixel(screenshot, x: 200, y: 200)
+    pixel.should be_a(Color)
+  end
+end

data/spec/mouse_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+require 'matrix'
+
+describe Samscript::Mouse do
+  before :all do
+    java_import 'java.awt.Point'
+  end
+
+  context "getting position" do
+    it "getting mouse position as point" do
+      Samscript::Mouse.position.should be_a(Point)
+      Samscript::Mouse.position(as: :point).should be_a(Point)
+    end
+
+    it "getting mouse position as vector" do
+      Samscript::Mouse.position(as: :vector).should be_a(Vector)
+    end
+  end
+
+  context "setting position" do
+    let(:point_pos) { Point.new(100, 100) }
+    let(:vector_pos) { Vector[100, 100] }
+
+    it "setting mouse position with point" do
+      Samscript::Mouse.position = point_pos
+      Samscript::Mouse.position.should == point_pos
+    end
+
+    it "setting mouse position with vector" do
+      Samscript::Mouse.position = vector_pos
+      Samscript::Mouse.position.should == point_pos
+    end
+  end
+end

data/spec/screen_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe Samscript::Screen do
+  before :all do
+    java_import 'java.awt.Dimension'
+    java_import 'java.awt.image.BufferedImage'
+    java_import 'java.awt.Rectangle'
+  end
+
+  it "screen resolution return type" do
+    res = Samscript::Screen.resolution
+    res.should be_a(Dimension)
+  end
+
+  it "capture full screen" do
+    capture = Samscript::Screen.capture
+    capture.should be_a(BufferedImage)
+  end
+
+  it "capture part of screen" do
+    rect = Rectangle.new(100, 100, 100, 100)
+    capture = Samscript::Screen.capture rect
+    capture.should be_a(BufferedImage)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'samscript'
+
+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
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/wait_for_pixel_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+require 'matrix'
+
+describe Samscript::WaitMatcher do
+  before :all do
+    java_import 'java.awt.Point'
+    java_import 'java.awt.Color'
+  end
+
+  it "wait for pixel base" do
+    location  = [100, 100]
+    colour    = Color.new(100, 100, 100)
+    match     = :any
+    tolerance = 0
+    interval  = 50
+    timeout   = 3000
+
+    args = { location: location,
+             colour: colour,
+             match: match,
+             tolerance: tolerance,
+             interval: interval,
+             timeout: timeout }
+
+    lambda {
+      Samscript::Screen.wait_for_pixel args
+    }.should_not raise_error
+  end
+
+  context "validation of wait_for_pixel params" do
+    let(:random) { Random.new }
+
+    it "no params" do
+      lambda {
+        Samscript::WaitMatcher.validate_wait_params({})
+      }.should raise_error
+    end
+
+    it "locations" do
+      x = random.rand(100)
+      y = random.rand(100)
+
+      locations = [[x, y], Vector[x, y], Point.new(x, y)]
+      labels = [:at, :location, :coords, :point, :pixel]
+
+      locations.each do |location|
+        labels.each do |label|
+          result = Samscript::WaitMatcher.parse_location(label => location)
+          result.should == Vector[x, y]
+        end
+      end
+    end
+
+    it "colours" do
+      r = random.rand(255)
+      g = random.rand(255)
+      b = random.rand(255)
+
+      colours = [[r, g, b], Color.new(r, g, b)]
+      labels = [:colour, :color]
+
+      colours.each do |colour|
+        labels.each do |label|
+          result = Samscript::WaitMatcher.parse_colour(label => colour)
+          result.should == Color.new(r, g, b)
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: samscript
+version: !ruby/object:Gem::Version
+  prerelease:
+  version: 0.1.1
+platform: ruby
+authors:
+- Sam Broughton
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2013-09-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    none: false
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: rake
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: rspec
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  prerelease: false
+  type: :development
+description: Samscript
+email:
+- sam@26th-zerk.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/samscript.rb
+- lib/samscript/helpers.rb
+- lib/samscript/image.rb
+- lib/samscript/mouse.rb
+- lib/samscript/screen.rb
+- lib/samscript/version.rb
+- lib/samscript/wait_matcher.rb
+- samscript.gemspec
+- spec/image_spec.rb
+- spec/mouse_spec.rb
+- spec/screen_spec.rb
+- spec/spec_helper.rb
+- spec/wait_for_pixel_spec.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      hash: 2
+      version: '0'
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      hash: 2
+      version: '0'
+  none: false
+requirements: []
+rubyforge_project:
+rubygems_version: 1.8.24
+signing_key:
+specification_version: 3
+summary: Samscript
+test_files:
+- spec/image_spec.rb
+- spec/mouse_spec.rb
+- spec/screen_spec.rb
+- spec/spec_helper.rb
+- spec/wait_for_pixel_spec.rb