macos 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e57ccde4764a60cb95d02db81cb77b9020fc9a49485ceb9cd072372b83a49771
-  data.tar.gz: 35fa614ea29cbd22514e399421e020bd31b53684ff873557b2c473997f138622
+  metadata.gz: 423a1401afca3af5d7e80af2653462f51c8a94b2b38e2b886eecf7d958e33f59
+  data.tar.gz: b5a9a30edef68dccea9f734befd4638b3c1ca0c176360f250a322a4f0ea00e50
 SHA512:
-  metadata.gz: bd6b361dc972f420b4dddd63e26a6526c613c958e2e4d7468968ad1aeb14f9040582b60e8d63ddf7b0b8b4d26f785279882b0df7dfbe472ceeb95fbd152c6f00
-  data.tar.gz: 95cb05ce401e150b188bbd5fa5dc1201b298d27fbeaa3d10b0ae3de4d46bbc8072f6cd4412f2f1ffe2303a47918b302207d407287047e0ba4ba4d74ddc283239
+  metadata.gz: 39d70e2ef94ebf0af0aab4a33c2d68f3daa49de8faa38a9fc7e3fde2deac2face88a7cd9a45e2e7fa5f772976a6ead402671d29269b5140e5f8d492ccbc0fb45
+  data.tar.gz: 31219d6687186afda87061b43274bb75c85ef2b4b8589625d0bce96e1522782efc6461a3d45aaec749c1f547cb0a7b38dd17f8edc195db12761d354104124ce2

data/Gemfile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+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,39 +1,48 @@
-# Macos
+# MacOS
 
-TODO: Delete this and the text below, and describe your gem
+[![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)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/macos`. To experiment with that code, run `bin/console` for an interactive prompt.
+A library for interacting with your Mac through ruby.
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
-Install the gem and add to the application's Gemfile by executing:
-
-```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```ruby
+gem install macos
 ```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+## Usage
 
-```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
-```
+### Mouse
 
-## Usage
+```ruby
+require 'macos'
 
-TODO: Write usage instructions here
+mouse = MacOS.mouse
 
-## Development
+mouse.move(x: 0, y: 0)
+position = mouse.position
+puts "#{position.x},#{position.y}"
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+mouse.move(x: 2, y: 3)
+position = mouse.position
+puts "#{position.x},#{position.y}"
+```
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+### Display
 
-## Contributing
+```ruby
+require 'macos'
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/macos.
+display = MacOS.display
+bounds = display.bounds
 
-## License
+puts "#{bounds.width}×#{bounds.height}"
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+display.capture do |tempfile|
+  # ...
+end
+```

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "macos"
+
+require "irb"
+IRB.start(__FILE__)

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/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

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_mouse_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_mouse_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_mouse_click(x:, y:)
+      left_mouse_down(x:, y:)
+      left_mouse_up(x:, y:)
+    end
+
+    # @param x [Float]
+    # @param y [Float]
+    def right_mouse_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_mouse_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_mouse_click(x:, y:)
+      right_mouse_down(x:, y:)
+      right_mouse_up(x:, y:)
+    end
+
+    # @param x [Float]
+    # @param y [Float]
+    def middle_mouse_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_mouse_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_mouse_click(x:, y:)
+      middle_mouse_down(x:, y:)
+      middle_mouse_up(x:, y:)
+    end
+  end
+end

data/lib/macos/version.rb

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

data/lib/macos.rb

@@ -1,8 +1,41 @@
 # frozen_string_literal: true
 
-require_relative "macos/version"
+require "fiddle"
+require "zeitwerk"
 
-module Macos
+loader = Zeitwerk::Loader.for_gem
+loader.inflector.inflect "cg" => "CG"
+loader.inflector.inflect "macos" => "MacOS"
+loader.setup
+
+# Interacts with macOS.
+module MacOS
   class Error < StandardError; end
-  # Your code goes here...
+
+  # @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_mouse_click(x: position.x, y: position.y)
+  #   mouse.right_mouse_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,56 @@
 --- !ruby/object:Gem::Specification
 name: macos
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Kevin Sylvestre
-autorequire:
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2024-11-18 00:00:00.000000000 Z
-dependencies: []
+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
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: An interface (designed for LLMs) to macOS.
 email:
 - kevin@ksylvest.com
@@ -17,22 +58,31 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".rspec"
-- ".rubocop.yml"
-- LICENSE.txt
+- Gemfile
 - README.md
-- Rakefile
+- bin/console
+- bin/demo
+- bin/setup
 - lib/macos.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
-- sig/macos.rbs
 homepage: https://github.com/ksylvest/macos
 licenses:
 - MIT
 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
@@ -40,15 +90,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !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/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/.rubocop.yml

@@ -1,8 +0,0 @@
-AllCops:
-  TargetRubyVersion: 3.0
-
-Style/StringLiterals:
-  EnforcedStyle: double_quotes
-
-Style/StringLiteralsInInterpolation:
-  EnforcedStyle: double_quotes

data/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2024 Kevin Sylvestre
-
-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/Rakefile

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-require "rubocop/rake_task"
-
-RuboCop::RakeTask.new
-
-task default: %i[spec rubocop]

data/sig/macos.rbs

@@ -1,4 +0,0 @@
-module Macos
-  VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
-end