mac-robot 0.2.3 → 0.5.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 002b8be116c9feea37ae23ac55cc05911189dc7998108c2751a10bddb0c038bf
+  data.tar.gz: 4354f97d4b55d61741b99de682d1708a6aafdb737d1affaf24c92134c9334eb7
+SHA512:
+  metadata.gz: 064d07a920fddc44e55647155c1cb26c9987878967688a233eed0036035afa702a6fa84a612216e97fced7cd940570d864196b5270aa32af50332d0eb80ae8cc
+  data.tar.gz: 4dc039577b578b06f705648690661931cc4c391765f76bb3b36104381244f72767302dfa229a47946f47fad4366382c33712f5395e923b5da05123942a1cd681

data/Gemfile

@@ -6,7 +6,9 @@ source "http://rubygems.org"
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
 group :development do
+  gem "rake", "< 11.0"
+  gem "json", "~> 2.5.1"
   gem "rspec", "~> 2.8.0"
   gem "bundler"
-  gem "jeweler", "~> 1.8.3"
+  gem "jeweler", "~> 2.3.9"
 end

data/Gemfile.lock

@@ -1,17 +1,57 @@
 GEM
   remote: http://rubygems.org/
   specs:
+    addressable (2.4.0)
+    builder (3.2.4)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
     diff-lcs (1.1.3)
-    git (1.2.5)
-    jeweler (1.8.3)
-      bundler (~> 1.0)
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    git (1.8.1)
+      rchardet (~> 1.8)
+    github_api (0.16.0)
+      addressable (~> 2.4.0)
+      descendants_tracker (~> 0.0.4)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 3.4)
+      mime-types (>= 1.16, < 3.0)
+      oauth2 (~> 1.0)
+    hashie (4.1.0)
+    highline (2.0.3)
+    jeweler (2.3.9)
+      builder
+      bundler
       git (>= 1.2.5)
+      github_api (~> 0.16.0)
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      psych
       rake
       rdoc
-    json (1.6.5)
-    rake (0.9.2.2)
-    rdoc (3.12)
-      json (~> 1.4)
+      semver2
+    json (2.5.1)
+    jwt (2.2.2)
+    mime-types (2.99.3)
+    mini_portile2 (2.5.0)
+    multi_json (1.15.0)
+    multi_xml (0.6.0)
+    multipart-post (2.1.1)
+    nokogiri (1.11.3)
+      mini_portile2 (~> 2.5.0)
+      racc (~> 1.4)
+    oauth2 (1.4.7)
+      faraday (>= 0.8, < 2.0)
+      jwt (>= 1.0, < 3.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 3)
+    psych (3.3.1)
+    racc (1.5.2)
+    rack (2.2.3)
+    rake (10.5.0)
+    rchardet (1.8.0)
+    rdoc (6.3.0)
     rspec (2.8.0)
       rspec-core (~> 2.8.0)
       rspec-expectations (~> 2.8.0)
@@ -20,11 +60,18 @@ GEM
     rspec-expectations (2.8.0)
       diff-lcs (~> 1.1.2)
     rspec-mocks (2.8.0)
+    semver2 (3.4.2)
+    thread_safe (0.3.6)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler
-  jeweler (~> 1.8.3)
+  jeweler (~> 2.3.9)
+  json (~> 2.5.1)
+  rake (< 11.0)
   rspec (~> 2.8.0)
+
+BUNDLED WITH
+   2.1.4

data/README.rdoc

@@ -12,8 +12,13 @@ A Library to Automate User Interactions
 
  robot.mouse_press
  robot.mouse_move(250, 250)
+ robot.mouse_drag(100, 200)
  robot.mouse_release
 
+ robot.mouse_current_location # => 100, 200
+
+ robot.scroll_wheel(:x => 10, :y => -20, :z => 5)
+
 === Automate keyboard
 
  [0x04, 0x0e, 0x25, 0x25, 0x1f].each do |keycode|

data/Rakefile

@@ -32,10 +32,10 @@ ext_names = %w/event_dispatcher util/
 ext_names.each do |ext_name|
   CLEAN.include Dir.glob("ext/#{ext_name}/*{.o,.log}")
   CLEAN.include "ext/#{ext_name}/Makefile"
-  CLOBBER.include "ext/#{ext_name}/#{ext_name}.bundle"
-  CLOBBER.include "lib/#{ext_name}.bundle"
+  CLOBBER.include "ext/#{ext_name}/#{ext_name}.h.bundle"
+  CLOBBER.include "lib/#{ext_name}.h.bundle"
 
-  file "lib/#{ext_name}.bundle" =>
+  file "lib/#{ext_name}.h.bundle" =>
     Dir.glob("ext/#{ext_name}/*{.rb,.m}") do
     Dir.chdir("ext/#{ext_name}") do
       # this does essentially the same thing
@@ -43,10 +43,10 @@ ext_names.each do |ext_name|
       ruby "extconf.rb"
       sh "make"
     end
-    cp "ext/#{ext_name}/#{ext_name}.bundle", "lib/"
+    cp "ext/#{ext_name}/#{ext_name}.h.bundle", "lib/"
   end
 
-  task :spec => "lib/#{ext_name}.bundle"
+  task :spec => "lib/#{ext_name}.h.bundle"
 end
 
 require 'rspec/core'

data/VERSION

@@ -1 +1 @@
-0.2.3
+0.5.1

data/ext/event_dispatcher/event_dispatcher.m

@@ -16,6 +16,8 @@ VALUE createInstance() {
   return Data_Wrap_Struct(rb_cEventDispatcher, 0, cEventDispatcher_free, obj);
 }
 
+// https://developer.apple.com/library/mac/documentation/Carbon/Reference/QuartzEventServicesRef/Reference/reference.html#//apple_ref/doc/uid/TP40003550-CH3g-C016985
+// XXX: support right button and center button
 CGEventType getEventTypeFromValue(VALUE value)
 {
   const char *typeStr;
@@ -29,6 +31,8 @@ CGEventType getEventTypeFromValue(VALUE value)
     type = kCGEventLeftMouseUp;
   } else if(strcmp(typeStr, "mouse_move") == 0) {
     type = kCGEventMouseMoved;
+  } else if(strcmp(typeStr, "mouse_drag") == 0) {
+    type = kCGEventLeftMouseDragged;
   } else {
     type = kCGEventNull;
   }
@@ -36,6 +40,27 @@ CGEventType getEventTypeFromValue(VALUE value)
   return type;
 }
 
+CGScrollEventUnit getScrollEventUnitFromValue(VALUE value)
+{
+  const char *unitStr;
+  CGScrollEventUnit unit;
+
+  unitStr = StringValuePtr(value);
+
+  if(strncmp(unitStr, "pix", 3) == 0) {
+    // accepts pixel, pixels, pix
+    unit = kCGScrollEventUnitPixel;
+  } else if(strncmp(unitStr, "line", 4) == 0) {
+    // accepts line, lines
+    unit = kCGScrollEventUnitLine;
+  } else {
+    rb_warn("Given unit `%s' is invalid. pixel or line is allowed.", unitStr);
+    unit = kCGScrollEventUnitPixel;
+  }
+
+  return unit;
+}
+
 CGMouseButton getMouseButtonFromValue(VALUE value)
 {
   // http://developer.apple.com/library/mac/#documentation/Carbon/Reference/QuartzEventServicesRef/Reference/reference.html
@@ -78,6 +103,29 @@ static VALUE cEventDispatcher_dispatchMouseEvent(int argc, VALUE *argv, VALUE se
   return Qnil;
 }
 
+// http://stackoverflow.com/questions/6126226/how-to-create-an-nsevent-of-type-nsscrollwheel
+// wheel_cnt: 1 - Y, 2 - Y-X, 3 - Y-X-Z
+static VALUE cEventDispatcher_dispatchScrollWheelEvent(int argc, VALUE *argv, VALUE self)
+{
+  VALUE unit, wheel_cnt, scroll_y, scroll_x, scroll_z;
+  CGEventRef event;
+
+  rb_scan_args(argc, argv, "5", &unit, &wheel_cnt, &scroll_y, &scroll_x, &scroll_z);
+
+  event = CGEventCreateScrollWheelEvent(
+                                  NULL,
+                                  getScrollEventUnitFromValue(rb_funcall(unit, rb_intern("to_s"), 0)),
+                                  NUM2INT(wheel_cnt),
+                                  NUM2INT(scroll_y),
+                                  NUM2INT(scroll_x),
+                                  NUM2INT(scroll_z));
+
+  CGEventPost(kCGHIDEventTap, event);
+  CFRelease(event);
+
+  return Qnil;
+}
+
 // http://forums.macrumors.com/showthread.php?t=780577
 static VALUE cEventDispatcher_dispatchKeyboardEvent(int argc, VALUE *argv, VALUE self)
 {
@@ -105,5 +153,6 @@ void Init_event_dispatcher(void){
   rb_cEventDispatcher = rb_define_class_under(rb_cRobot, "EventDispatcher", rb_cObject);
   rb_define_singleton_method(rb_cEventDispatcher, "new", cEventDispatcher_new, -1);
   rb_define_method(rb_cEventDispatcher, "dispatchMouseEvent", cEventDispatcher_dispatchMouseEvent, -1);
+  rb_define_method(rb_cEventDispatcher, "dispatchScrollWheelEvent", cEventDispatcher_dispatchScrollWheelEvent, -1);
   rb_define_method(rb_cEventDispatcher, "dispatchKeyboardEvent", cEventDispatcher_dispatchKeyboardEvent, -1);
 }

data/ext/event_dispatcher/extconf.rb

@@ -5,7 +5,7 @@ end
 require "mkmf"
 
 # Name your extension
-extension_name = 'event_dispatcher'
+extension_name = 'event_dispatcher.h'
 
 # Set your target name
 dir_config(extension_name)

data/ext/util/extconf.rb

@@ -5,7 +5,7 @@ end
 require "mkmf"
 
 # Name your extension
-extension_name = 'util'
+extension_name = 'util.h'
 
 # Set your target name
 dir_config(extension_name)

data/ext/util/util.m

@@ -47,6 +47,21 @@ static VALUE mUtil_get_display_pixel_size(int argc, VALUE *argv, VALUE self)
   return result;
 }
 
+static VALUE mUtil_get_mouse_current_location(int argc, VALUE *argv, VALUE self)
+{
+  VALUE result;
+  CGEventRef event;
+
+  event = CGEventCreate(NULL);
+  CGPoint loc = CGEventGetLocation(event);
+
+  result = rb_ary_new();
+  rb_ary_push(result, INT2NUM(loc.x));
+  rb_ary_push(result, INT2NUM(loc.y));
+
+  return result;
+}
+
 void Init_util(void){
   VALUE rb_mMac, rb_cRobot, rb_mUtil;
 
@@ -55,4 +70,5 @@ void Init_util(void){
   rb_mUtil = rb_define_module_under(rb_cRobot, "Util");
   rb_define_singleton_method(rb_mUtil, "get_pixel_color", mUtil_get_pixel_color, -1);
   rb_define_singleton_method(rb_mUtil, "get_display_pixel_size", mUtil_get_display_pixel_size, -1);
+  rb_define_singleton_method(rb_mUtil, "get_mouse_current_location", mUtil_get_mouse_current_location, -1);
 }

data/lib/mac-robot.rb

@@ -1,5 +1,5 @@
-require 'event_dispatcher'
-require 'util'
+require 'event_dispatcher.h'
+require 'util.h'
 
 module Mac
   class Robot
@@ -17,6 +17,7 @@ module Mac
     def initialize
       @x = 0
       @y = 0
+
       @state = :mouse_up
       @dispatcher = EventDispatcher.new
     end
@@ -38,6 +39,18 @@ module Mac
       mouse_event(:left, :mouse_move)
     end
 
+    def mouse_drag(x, y)
+      @x = x
+      @y = y
+
+      mouse_event(:left, :mouse_drag)
+    end
+
+    def mouse_current_location
+      loc = Util.get_mouse_current_location
+      Struct.new(:x, :y).new(*loc)
+    end
+
     def key_press(keycode)
       keyboard_event(keycode, 1)
     end
@@ -46,10 +59,28 @@ module Mac
       keyboard_event(keycode, 0)
     end
 
+    def scroll_wheel_line(args = {})
+      scroll_wheel_event(:line, *scroll_count_extract(args))
+    end
+    alias scroll_wheel scroll_wheel_line
+
+    def scroll_wheel_pixel(args = {})
+      scroll_wheel_event(:pixel, *scroll_count_extract(args))
+    end
+
     def get_pixel_color(x, y)
       raise OutOfResolution if x < 0 || y < 0
       raise OutOfResolution if display_pixel_size.width < x || display_pixel_size.height < y
 
+      # workarownd for exeption occurs when x == display_pixel_size.width
+      #
+      # *** Assertion failure in -[NSBitmapImageRep initWithCGImage:], /SourceCache/AppKit/AppKit-1265/AppKit.subproj/NSBitmapImageRep.m:1286
+      # An uncaught exception was raised
+      # Invalid parameter not satisfying: cgImage != NULL
+      if display_pixel_size.width == x
+        x = x - 0.1
+      end
+
       color = Util.get_pixel_color(x, y)
       Struct.new(:red, :green, :blue, :alpha).new(*color)
     end
@@ -64,6 +95,32 @@ module Mac
       @dispatcher.dispatchMouseEvent(@x, @y, BUTTONS[button], type)
     end
 
+    def scroll_wheel_event(unit, scroll_y, scroll_x = 0, scroll_z = 0)
+      wheel_count = 3
+      @dispatcher.dispatchScrollWheelEvent(unit, wheel_count, scroll_y, scroll_x, scroll_z)
+    end
+
+    def scroll_count_extract(args = {})
+      # java.awt.Robot
+      # http://docs.oracle.com/javase/1.4.2/docs/api/java/awt/Robot.html#mouseWheel%28int%29
+      scroll_x = 0 # x > 0 => right
+      scroll_y = 0 # y > 0 => down
+      scroll_z = 0 # z > 0 => towards
+
+      args.each do |key, value|
+        case key
+        when :x
+          scroll_x -= value
+        when :y
+          scroll_y -= value
+        when :z
+          scroll_z -= value
+        end
+      end
+
+      return [scroll_y, scroll_x, scroll_z]
+    end
+
     def keyboard_event(keycode, keydown)
       @dispatcher.dispatchKeyboardEvent(keycode, keydown)
     end

data/spec/mac-robot_spec.rb

@@ -9,12 +9,24 @@ describe Mac::Robot do
   describe 'mouse event' do
     it 'should simulate mouse event' do
       subject.mouse_move(20, 0)
+      sleep 0.2
       subject.mouse_press(:left)
-      subject.mouse_move(20, 250)
+      sleep 0.2
+      subject.mouse_move(20, 200)
+      sleep 0.2
       subject.mouse_release(:left)
     end
   end
 
+  describe 'scroll wheel event' do
+    it 'should simulate scroll wheel event' do
+      subject.scroll_wheel_line(:y => 10)  # down 10 lines
+      subject.scroll_wheel(:y => -10)      # up 10 lines
+      subject.scroll_wheel_pixel(:x => 10, :y => -20, :z => 5)
+      subject.scroll_wheel_pixel(:y => 20, :x => -10, :z => -5)
+    end
+  end
+
   describe 'keyboard event' do
     it 'should simulate keyboard event' do
       [0x04, 0x0e, 0x25, 0x25, 0x1f].each do |keycode|
@@ -44,5 +56,23 @@ describe Mac::Robot do
         }.should raise_error(Mac::Robot::OutOfResolution)
       end
     end
+
+    it 'should get color from rightmost pixel' do
+      display_pixel_size = subject.display_pixel_size
+
+      color = subject.get_pixel_color(display_pixel_size.width, 0)
+      color.red.should be_a_kind_of(Float)
+      color.green.should be_a_kind_of(Float)
+      color.blue.should be_a_kind_of(Float)
+      color.alpha.should be_a_kind_of(Float)
+    end
+  end
+
+  describe 'current mouse location' do
+    it 'should have current mouse location' do
+      subject.mouse_move(20, 0)
+      subject.mouse_current_location.x.should eql(20)
+      subject.mouse_current_location.y.should eql(0)
+    end
   end
 end

metadata

@@ -1,64 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: mac-robot
 version: !ruby/object:Gem::Version
-  version: 0.2.3
-  prerelease: 
+  version: 0.5.1
 platform: ruby
 authors:
 - youpy
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2012-06-17 00:00:00.000000000 Z
+date: 2021-04-15 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.5.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.8.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: jeweler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.3
+        version: 2.3.9
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.3
+        version: 2.3.9
 description: A Library to Automate User Interactions
 email: youpy@buycheapviagraonlinenow.com
 executables: []
@@ -69,8 +90,8 @@ extra_rdoc_files:
 - LICENSE.txt
 - README.rdoc
 files:
-- .document
-- .rspec
+- ".document"
+- ".rspec"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -91,29 +112,24 @@ files:
 homepage: http://github.com/youpy/mac-robot
 licenses:
 - MIT
-post_install_message: 
+metadata: {}
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 3702793379613243156
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.24
-signing_key: 
-specification_version: 3
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
 summary: A Library to Automate User Interactions
 test_files: []