macos 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd5cbbc912f0fab0192641cb14735ebbd151c1db00381dc1f837174a2dc2bff2
-  data.tar.gz: 30c5de93807739ead6fc84a5fdc899bf6041b5c9946f6b4f21961704d808ecda
+  metadata.gz: f5f7eea4e2dd2200b9cf31edba5eeafb649c61f04c3ce97977e3b2b9eb7ac9ab
+  data.tar.gz: 3a57005b465e9751bf0390fc077a916be95665b8e9b67dc3d2e550063bbd3d57
 SHA512:
-  metadata.gz: 974a5ed9a34e8a890179836a5ad80d2fe584b5218d948d390d586fd8fd7df04d9bd303e248e30020f893675236b4f94ab53697f3faebd0a8ca64a6c02dbd0621
-  data.tar.gz: 766c1ea410a4f9e7ca8e7d05b2e5eddb115932c41356c8dfce44020558a68d3ede27cd9237449173b2a1e87656e8d3f12d18100f57d5c90e6a4c69a604b52b7e
+  metadata.gz: f5bbc37912e6e9e726c4d0f8e0b5315d2a5b1a79ad3d68e4399d575127e88b20b8adb4a1c7081ebf124a0fdb5cab274138882cfdcc6e0b49fa2dc87589dd8663
+  data.tar.gz: 2324a3f60635e949c2d90ab30705a91047edbf78b4dbe7b12c8684783d54a8282c74e33fcae98f37be8cbe825b7fcd15b85046872239dbc3005dee8d9c3b1cdc

data/Gemfile

@@ -2,11 +2,14 @@
 
 source "https://rubygems.org"
 
-# Specify your gem's dependencies in macos.gemspec
 gemspec
 
-gem "rake", "~> 13.0"
-
-gem "rspec", "~> 3.0"
-
-gem "rubocop", "~> 1.21"
+gem "rake"
+gem "rspec"
+gem "rspec_junit_formatter"
+gem "rubocop"
+gem "rubocop-basic"
+gem "rubocop-rake"
+gem "rubocop-rspec"
+gem "simplecov"
+gem "yard"

data/README.md

@@ -1,4 +1,10 @@
-# MacOS.rb
+# MacOS
+
+[![LICENSE](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/ksylvest/macos/blob/main/LICENSE)
+[![RubyGems](https://img.shields.io/gem/v/macos)](https://rubygems.org/gems/macos)
+[![GitHub](https://img.shields.io/badge/github-repo-blue.svg)](https://github.com/ksylvest/macos)
+[![Yard](https://img.shields.io/badge/docs-site-blue.svg)](https://macos.ksylvest.com)
+[![CircleCI](https://img.shields.io/circleci/build/github/ksylvest/macos)](https://circleci.com/gh/ksylvest/macos)
 
 A library for interacting with your Mac through ruby.
 
@@ -10,13 +16,33 @@ gem install macos
 
 ## Usage
 
-### Screen
+### Mouse
 
 ```ruby
 require 'macos'
 
-screen = MacOS::screen
-screen.capture do |tempfile|
+mouse = MacOS.mouse
+
+mouse.move(x: 0, y: 0)
+position = mouse.position
+puts "#{position.x},#{position.y}"
+
+mouse.move(x: 2, y: 3)
+position = mouse.position
+puts "#{position.x},#{position.y}"
+```
+
+### Display
+
+```ruby
+require 'macos'
+
+display = MacOS.display
+bounds = display.bounds
+
+puts "#{bounds.width}×#{bounds.height}"
+
+display.capture do |tempfile|
   # ...
 end
 ```

data/bin/demo

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "macos"
+
+mouse = MacOS.mouse
+
+loop do
+  puts mouse.position
+
+  mouse.move(x: 20.0, y: 20.0)
+  sleep 5
+end

data/lib/macos/cg/event_tap_location.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module MacOS
+  module CG
+    # https://developer.apple.com/documentation/coregraphics/cgeventtaplocation
+    module EventTapLocation
+      HID_EVENT_TAP = 0 # https://developer.apple.com/documentation/coregraphics/cgeventtaplocation/cghideventtap
+      SESSSION_EVENT_TAP = 1 # https://developer.apple.com/documentation/coregraphics/cgeventtaplocation/sessioneventtap
+      ANNOTATED_SESSION_EVENT_TAP = 2 # https://developer.apple.com/documentation/coregraphics/cgeventtaplocation/annotatedsessioneventtap
+    end
+  end
+end

data/lib/macos/cg/event_type.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module MacOS
+  module CG
+    # https://developer.apple.com/documentation/coregraphics/cgeventtype
+    module EventType
+      NULL = 0 # https://developer.apple.com/documentation/coregraphics/cgeventtype/null
+      LEFT_MOUSE_DOWN = 1 # https://developer.apple.com/documentation/coregraphics/cgeventtype/leftmousedown
+      LEFT_MOUSE_UP = 2 # https://developer.apple.com/documentation/coregraphics/cgeventtype/leftmouseup
+      RIGHT_MOUSE_DOWN = 3 # https://developer.apple.com/documentation/coregraphics/cgeventtype/rightmousedown
+      RIGHT_MOUSE_UP = 4 # https://developer.apple.com/documentation/coregraphics/cgeventtype/rightmouseup
+      MOUSE_MOVED = 5 # https://developer.apple.com/documentation/coregraphics/cgeventtype/mousemoved
+      LEFT_MOUSE_DRAGGED = 6 # https://developer.apple.com/documentation/coregraphics/cgeventtype/leftmousedragged
+      RIGHT_MOUSE_DRAGGED = 7 # https://developer.apple.com/documentation/coregraphics/cgeventtype/rightmousedragged
+      KEY_DOWN = 10 # https://developer.apple.com/documentation/coregraphics/cgeventtype/keydown
+      KEY_UP = 11 # https://developer.apple.com/documentation/coregraphics/cgeventtype/keyup
+      OTHER_MOUSE_DOWN = 25 # https://developer.apple.com/documentation/coregraphics/cgeventtype/othermousedown
+      OTHER_MOUSE_UP = 26 # https://developer.apple.com/documentation/coregraphics/cgeventtype/othermouseup
+      OTHER_MOUSE_DRAGGED = 27 # https://developer.apple.com/documentation/coregraphics/cgeventtype/othermousedragged
+    end
+  end
+end

data/lib/macos/cg/mouse_button.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module MacOS
+  module CG
+    # https://developer.apple.com/documentation/coregraphics/cgmousebutton
+    module MouseButton
+      LEFT = 0 # https://developer.apple.com/documentation/coregraphics/cgmousebutton/left
+      RIGHT = 1 # https://developer.apple.com/documentation/coregraphics/cgmousebutton/right
+      CENTER = 2 # https://developer.apple.com/documentation/coregraphics/cgmousebutton/center
+    end
+  end
+end

data/lib/macos/cg/point.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "ffi"
+
+module MacOS
+  module CG
+    # https://developer.apple.com/documentation/corefoundation/cgpoint
+    class Point < FFI::Struct
+      layout :x, :double, :y, :double
+    end
+  end
+end

data/lib/macos/cg/rect.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "ffi"
+
+module MacOS
+  module CG
+    # https://developer.apple.com/documentation/corefoundation/cgrect
+    class Rect < FFI::Struct
+      layout :origin, MacOS::CG::Point, :size, MacOS::CG::Size
+    end
+  end
+end

data/lib/macos/cg/size.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "ffi"
+
+module MacOS
+  module CG
+    # https://developer.apple.com/documentation/corefoundation/cgsize
+    class Size < FFI::Struct
+      layout :width, :double, :height, :double
+    end
+  end
+end

data/lib/macos/display.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module MacOS
+  # Simulates a macOS display.
+  class Display
+    Size = Struct.new(:width, :height)
+
+    def self.main
+      id = Library.CGMainDisplayID
+      new(id:)
+    end
+
+    # @param id [Integer
+    def initialize(id:)
+      @id = id
+    end
+
+    # @return [Size]
+    def bounds
+      bounds = Library.CGDisplayBounds(@id)
+
+      width = Integer(bounds[:size][:width])
+      height = Integer(bounds[:size][:height])
+
+      Size.new(width, height)
+    end
+
+    # @yield [tempfile]
+    # @yieldparam tempfile [Tempfile]
+    def capture
+      tempfile = Tempfile.new(["screenshot", ".png"])
+      system("screencapture -o -x #{tempfile.path}")
+      yield tempfile
+    ensure
+      tempfile.close
+      tempfile.unlink
+    end
+  end
+end

data/lib/macos/keyboard.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module MacOS
+  # Simulates a macOS keyboard.
+  class Keyboard
+    def type(text)
+      text.chars.each do |character|
+        key_down(character)
+        key_up(character)
+      end
+    end
+  end
+end

data/lib/macos/library.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "ffi"
+
+module MacOS
+  # https://developer.apple.com/documentation/coregraphics
+  module Library
+    extend ::FFI::Library
+    ffi_lib "/System/Library/Frameworks/CoreGraphics.framework/CoreGraphics"
+
+    attach_function :CGEventCreate, %i[pointer], :pointer
+    attach_function :CGEventGetLocation, %i[pointer], CG::Point.by_value
+    attach_function :CFRelease, %i[pointer], :void
+    attach_function :CGEventCreateMouseEvent, [:pointer, :uint32, CG::Point.by_value, :uint32], :pointer
+    attach_function :CGEventPost, %i[uint32 pointer], :void
+    attach_function :CGWarpMouseCursorPosition, [CG::Point.by_value], :pointer
+    attach_function :CGEventCreateKeyboardEvent, %i[pointer uint16 bool bool], :pointer
+    attach_function :CGMainDisplayID, [], :uint32
+    attach_function :CGDisplayBounds, [:uint32], CG::Rect.by_value
+  end
+end

data/lib/macos/mouse.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module MacOS
+  # Simulates a macOS mouse.
+  class Mouse
+    Position = Data.define(:x, :y)
+
+    # @return [Position]
+    def position
+      event = Library.CGEventCreate(nil)
+      position = Library.CGEventGetLocation(event)
+      Library.CFRelease(event)
+
+      x = position[:x]
+      y = position[:y]
+
+      Position.new(x, y)
+    end
+
+    # @param type [Integer] e.g. `MacOS::CG::EventType::MOUSE_MOVED`
+    # @param x [Float]
+    # @param y [Float]
+    # @param button [Integer] e.g. `MacOS::CG::MouseButton::LEFT` / `MacOS::CG::MouseButton::RIGHT` / etc.
+    def trigger(type:, x:, y:, button: 0)
+      position = CG::Point.new
+      position[:x] = x
+      position[:y] = y
+      event = Library.CGEventCreateMouseEvent(nil, type, position, button)
+      Library.CGEventPost(CG::EventTapLocation::HID_EVENT_TAP, event)
+      Library.CFRelease(event)
+    end
+
+    # @param x [Float]
+    # @param y [Float]
+    def move(x:, y:)
+      position = CG::Point.new
+      position[:x] = x
+      position[:y] = y
+      Library.CGWarpMouseCursorPosition(position)
+    end
+
+    # @param x [Float]
+    # @param y [Float]
+    def left_down(x:, y:)
+      trigger(type: CG::EventType::LEFT_MOUSE_DOWN, x:, y:, button: CG::MouseButton::LEFT)
+    end
+
+    # @param x [Float]
+    # @param y [Float]
+    def left_up(x:, y:)
+      trigger(type: CG::EventType::LEFT_MOUSE_UP, x:, y:, button: CG::MouseButton::LEFT)
+    end
+
+    # @param x [Float]
+    # @param y [Float]
+    def left_click(x:, y:)
+      left_down(x:, y:)
+      left_up(x:, y:)
+    end
+
+    # @param x [Float]
+    # @param y [Float]
+    def right_down(x:, y:)
+      trigger(type: CG::EventType::RIGHT_MOUSE_DOWN, x:, y:, button: CG::MouseButton::RIGHT)
+    end
+
+    # @param x [Float]
+    # @param y [Float]
+    def right_up(x:, y:)
+      trigger(type: CG::EventType::RIGHT_MOUSE_UP, x:, y:, button: CG::MouseButton::RIGHT)
+    end
+
+    # @param x [Float]
+    # @param y [Float]
+    def right_click(x:, y:)
+      right_down(x:, y:)
+      right_up(x:, y:)
+    end
+
+    # @param x [Float]
+    # @param y [Float]
+    def middle_down(x:, y:)
+      trigger(type: CG::EventType::OTHER_MOUSE_DOWN, x:, y:, button: CG::MouseButton::CENTER)
+    end
+
+    # @param x [Float]
+    # @param y [Float]
+    def middle_up(x:, y:)
+      trigger(type: CG::EventType::OTHER_MOUSE_UP, x:, y:, button: CG::MouseButton::CENTER)
+    end
+
+    # @param x [Float]
+    # @param y [Float]
+    def middle_click(x:, y:)
+      middle_down(x:, y:)
+      middle_up(x:, y:)
+    end
+  end
+end

data/lib/macos/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
-module Macos
-  VERSION = "0.1.1"
+module MacOS
+  VERSION = "0.1.3"
 end

data/lib/macos.rb

@@ -1,16 +1,41 @@
 # frozen_string_literal: true
 
-require 'zeitwerk'
+require "fiddle"
+require "zeitwerk"
 
 loader = Zeitwerk::Loader.for_gem
-loader.inflector.inflect 'macos' => 'MacOS'
+loader.inflector.inflect "cg" => "CG"
+loader.inflector.inflect "macos" => "MacOS"
 loader.setup
 
+# Interacts with macOS.
 module MacOS
   class Error < StandardError; end
 
-  # @return [MacOS::Screen]
-  def screen
-    Screen.new
+  # @example
+  #   MacOS.keyboard.type('Hello, World!')
+  #   MacOS.keyboard.key_down('a')
+  #   MacOS.keyboard.key_up('a')
+  #
+  # @return [MacOS::Keyboard]
+  def self.keyboard
+    Keyboard.new
+  end
+
+  # @example
+  #   mouse = MacOS.mouse
+  #   mouse.move(x: 4, y: 8)
+  #   position = mouse.position
+  #   mouse.left_click(x: position.x, y: position.y)
+  #   mouse.right_click(x: position.x, y: position.y)
+  #
+  # @return [MacOS::Mouse]
+  def self.mouse
+    Mouse.new
+  end
+
+  # @return [MacOS::Display]
+  def self.display
+    Display.main
   end
 end

metadata

@@ -1,15 +1,42 @@
 --- !ruby/object:Gem::Specification
 name: macos
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Kevin Sylvestre
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-18 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fiddle
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
@@ -34,9 +61,19 @@ files:
 - Gemfile
 - README.md
 - bin/console
+- bin/demo
 - bin/setup
 - lib/macos.rb
-- lib/macos/screen.rb
+- lib/macos/cg/event_tap_location.rb
+- lib/macos/cg/event_type.rb
+- lib/macos/cg/mouse_button.rb
+- lib/macos/cg/point.rb
+- lib/macos/cg/rect.rb
+- lib/macos/cg/size.rb
+- lib/macos/display.rb
+- lib/macos/keyboard.rb
+- lib/macos/library.rb
+- lib/macos/mouse.rb
 - lib/macos/version.rb
 homepage: https://github.com/ksylvest/macos
 licenses:
@@ -44,8 +81,8 @@ licenses:
 metadata:
   homepage_uri: https://github.com/ksylvest/macos
   source_code_uri: https://github.com/ksylvest/macos
-  changelog_uri: https://github.com/ksylvest/macos
-post_install_message:
+  changelog_uri: https://github.com/ksylvest/macos/releases
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -60,8 +97,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 3.6.7
 specification_version: 4
 summary: An interface with macOS.
 test_files: []

data/lib/macos/screen.rb

@@ -1,14 +0,0 @@
-module MacOS
-  module Screen
-    # @yield [tempfile]
-    # @yieldparam tempfile [Tempfile]
-    def capture
-      tempfile = Tempfile.new(['screenshot', '.png'])
-      system("screencapture -o -x #{tempfile.path}")
-      yield tempfile
-    ensure
-      tempfile.close
-      tempfile.unlink
-    end
-  end
-end