gui_inspect 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d210dc0561a40901ccc1cacc1a2e0a5231db32279367ba9a06807408048b6e5c
-  data.tar.gz: a11f2537a086e83eedb739ea699454660386e909f70adeae39bd9dfd558dd34a
+  metadata.gz: d13fe746824b34ca73991a576d5e7df2b789f3b73ea74def254ef615529763da
+  data.tar.gz: ce3c26ada39119195f645c5cff6b5ccd5e0ff36d7a81bb597715af4b5e165e4e
 SHA512:
-  metadata.gz: eb40ab8bbe9e5bf4a1f2e6834e837513b4c266e7b388c834f7346bbeef03b61ff344acb1f8af61d8da37df56649d817424564001a8d9511ef5fccc5d79ec08a6
-  data.tar.gz: fa34428280a5059b3af637649ea915eea8b833a6e4b0730c5dfdb0f994955129b9d3bda7c5b1890d2f758d1d7cd813149a7bc18a360c8da09826f14d99cb5e59
+  metadata.gz: 88565fb81632f58a71fb8ec2122df174065182a892f6028404097174e94f92fcd741138195deae2fe28ca0721a93624a9c3b2da14eeb377fba4a47a99dd1af33
+  data.tar.gz: f44548dd63ded4d32a43d4962aaede4ff455d5c847fc0a7663da5b256e3e6c2e6fee970541ccfeb873f0e8bde48502cf4995a1e14ede66129c46a2f6323d28d7

data/README.md

@@ -1,4 +1,4 @@
-# Gui
+# GUI Inspect
 
 Simple methods to inspect the GUI elements of a running MacOS application.
 
@@ -7,19 +7,21 @@ Simple methods to inspect the GUI elements of a running MacOS application.
 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
+bundle gui_inspect
 ```
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
 ```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+gem install gui_inspect
 ```
 
 ## Usage
 
-> get_ui_elements '<application name>' >path/to/file # Generates a list of the GUI elements of the    
-                                                     # application in its current state
+> gui_inspect processes                                   # Generates a list of current active processes
+
+> gui_inspect elements '<application name>' >path/to/file # Generates a list of the GUI elements of
+                                                          # this application in its current state
 
 ## Development
 

data/exe/gui_inspect

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+# Main executable for gui_inspect script
+
+require 'rubygems'
+require 'bundler/setup'
+require_relative '../lib/env'
+if Environment.non_production?
+  require 'pry'
+  require 'pry-stack_explorer'
+  require 'pry-byebug'
+end
+
+require_relative '../lib/gui_inspect'
+
+if __FILE__ == $0
+  GUIInspect::CLI.go(ARGV)
+end

data/lib/env.rb

@@ -0,0 +1,41 @@
+# Determine the current environment (i.e. development, test, or production)
+
+module Environment
+  class << self
+    def current_git_branch
+      `git branch --show-current`.chomp
+    end
+
+    def current
+      current_environment = ENV['RAILS_ENV'] || ENV['RACK_ENV']
+      unless current_environment
+        current_environment = current_git_branch == 'master' ? 'production' : 'development'
+      end
+      current_environment.downcase.to_sym
+    end
+
+    def production?
+      current == :production
+    end
+
+    def non_production?
+      !production?
+    end
+
+    def test?
+      current == :test
+    end
+
+    def non_test?
+      !test?
+    end
+
+    def development?
+      non_test? && non_production?
+    end
+
+    def non_development?
+      !development?
+    end
+  end
+end 

data/lib/gui_inspect/inspector.rb

@@ -0,0 +1,73 @@
+require 'tempfile'
+
+module GUIInspect
+  class Inspector
+    attr_reader :error
+
+    def initialize
+    end
+
+    private def run_applescript(script)
+      file = Tempfile.new('gui_inspect')
+      output = begin
+        file.write(script)
+        file.close
+        `osascript #{file.path}`
+      ensure
+        file.unlink # Release the temporary script file
+      end
+      if output =~ /^Error/
+        @error = output.chomp
+        return nil
+      end
+      @error = nil
+      output.gsub(/,\s+/,"\n")
+    end
+
+    def puts_applescript_results(script)
+      output = run_applescript(script)
+      if output
+        puts output
+      else
+        warn @error
+        exit 1
+      end
+      output
+    end
+
+    def processes
+      get_processes_script = <<-END_OF_APPLESCRIPT
+        try
+          tell application "System Events"
+            set listOfProcesses to (name of every process where background only is false)
+          end tell
+          listOfProcesses
+        on error errMsg number errorNumber
+          "Error: " & errMsg & " (#" & (errorNumber as text) & ")"
+        end try
+      END_OF_APPLESCRIPT
+      puts_applescript_results(get_processes_script)
+    end
+
+    def elements(app)
+      get_elements_script = <<-END_OF_APPLESCRIPT
+        try
+          tell application "#{app}"
+            activate -- If nescessary, starts application. Gives it focus
+          end tell
+          delay 3
+          tell application "System Events"
+            set frontmostName to name of application process 1 whose frontmost is true
+            tell application process frontmostName
+              set uiElems to entire contents
+            end tell
+          end tell
+          uiElems
+        on error errMsg number errorNumber
+          "Error: " & errMsg & " (#" & (errorNumber as text) & ")"
+        end try
+      END_OF_APPLESCRIPT
+      puts_applescript_results(get_elements_script)
+    end
+  end
+end

data/lib/gui_inspect/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module GUIInspect
+  VERSION = "0.2.1"
+
+  def self.version
+    VERSION
+  end
+end

data/lib/gui_inspect.rb

@@ -0,0 +1,95 @@
+require 'thor'
+require_relative "gui_inspect/version"
+require_relative "gui_inspect/inspector"
+
+module GUIInspect
+  class Error < StandardError; end
+  class CLI < Thor
+    package_name "gui_inspect"
+
+    def self.exit_on_failure?
+      false
+    end
+
+    # Display help with additional context
+    def help(command = nil, subcommand: false)
+      say <<~END_HELP
+        gui_inspect 
+        -----------
+        Provides a set of tools for inspecting the GUI processes and elements of a MacOS GUI
+        environment. This is useful as a tool to help design scripts for GUI automation.
+
+      END_HELP
+      super command, subcommand
+    end
+
+    # desc 'help', "Get help text"
+    # def help
+    #   puts caller.first.inspect
+        
+    #   app_name = File.basename(__FILE__)
+    #   help_text = <<-END_HELP
+    #     |  #{app_name}:
+    #     |
+    #     |  Gather information about the elements of the graphical user interface of an application
+    #     |
+    #     |  Usage:
+    #     |    #{app_name} '<name of GUI app>'
+    #     |
+    #     |  #{app_name} gathers a lot of information about the named application and outputs it to
+    #     |  the standard output. (Standard output may be redirected to a file using the usual '>'
+    #     |  syntax.)
+    #     |
+    #     |  For best results, we recommend that you have the application you want to analyze already
+    #     |  running and in the state that you want it. (For instance, displaying dialogs you're interested
+    #     |  in.) Move quickly -- this script can only capture information while it is still displayed.
+    #   END_HELP
+    #   puts help_text.split("\n").map { |line| line[/^\s*\|\s\s(.*)$/, 1]}.join("\n")
+    # end
+
+    desc 'version', "Display version"
+    def version
+      puts GUIInspect.version
+    end
+    
+    desc 'processes', "Show the active processes"
+    long_desc <<-END_DESC
+      Gather information about the processes currently running in the GUI.\x5
+      \x5
+      Produces a list of running processes on $stdout (which may be redirected using the 
+      usual '>' syntax). \x5
+      \x5
+      Move quickly -- this script can only capture information about processes while they are still running.
+    END_DESC
+
+    def processes
+      inspector = GUIInspect::Inspector.new
+      inspector.processes
+    end
+        
+    desc 'elements APPLICATION', "Show the UI elements"
+    long_desc <<-END_DESC
+      Gather information about the elements of the graphical user interface of an application.\x5
+      \x5
+      Gathers a lot of information about the named application and outputs it to
+      the standard output. (Standard output may be redirected to a file using the usual '>'
+      syntax.)\x5
+      \x5
+      For best results, we recommend that you have the application you want to analyze already
+      running and in the state that you want it. (For instance, displaying dialogs you're interested
+      in.)\x5
+      \x5
+      Move quickly -- this script can only capture information while it is still displayed.
+    END_DESC
+    def elements(application)
+      inspector = GUIInspect::Inspector.new
+      inspector.elements(application)
+    end
+
+    class << self
+      def go(argv)
+        GUIInspect::CLI.start(argv)
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gui_inspect
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Richard LeBer
@@ -12,7 +12,7 @@ dependencies: []
 email:
 - richard.leber@gmail.com
 executables:
-- get_ui_elements
+- gui_inspect
 extensions: []
 extra_rdoc_files: []
 files:
@@ -22,9 +22,11 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- exe/get_ui_elements
-- lib/gui.rb
-- lib/gui/version.rb
+- exe/gui_inspect
+- lib/env.rb
+- lib/gui_inspect.rb
+- lib/gui_inspect/inspector.rb
+- lib/gui_inspect/version.rb
 - output/p_touch_editor_ui_elements.txt
 - sig/gui.rbs
 homepage: https://github.com/rleber/gui

data/exe/get_ui_elements

@@ -1,85 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'tempfile'
-
-def help
-  app_name = File.basename(__FILE__)
-  help_text = <<-END_HELP
-    |  #{app_name}:
-    |
-    |  Gather information about the elements of the graphical user interface of an application
-    |
-    |  Usage:
-    |    #{app_name} '<name of GUI app>'
-    |
-    |  #{app_name} gathers a lot of information about the named application and outputs it to
-    |  the standard output. (Standard output may be redirected to a file using the usual '>'
-    |  syntax.)
-    |
-    |  For best results, we recommend that you have the application you want to analyze already
-    |  running and in the state that you want it. (For instance, displaying dialogs you're interested
-    |  in.) Move quickly -- this script can only capture information while it is still displayed.
-  END_HELP
-  puts help_text.split("\n").map { |line| line[/^\s*\|\s\s(.*)$/, 1]}.join("\n")
-end
-
-def main(args)
-  if args.size != 1
-    help
-    exit
-  else
-    arg = args.first
-    downcase_arg = arg.downcase 
-    if downcase_arg == '--help' ||  downcase_arg == '-h' ||  downcase_arg == 'help'
-      help
-      exit
-    end
-  end
-
-  applescript = <<-END_OF_APPLESCRIPT
-    try
-      tell application "#{arg}"
-        activate -- If nescessary, starts application. Gives it focus
-      end tell
-      delay 3
-      tell application "System Events"
-        set frontmostName to name of application process 1 whose frontmost is true
-        tell application process frontmostName
-          set uiElems to entire contents
-        end tell
-      end tell
-      (* tell application "System Events"
-        -- Save exit value to a file
-        set the_file to (((path to desktop) as string) & "ui_elements.txt")
-        set nref to open for access file the_file with write permission
-        set eof of the nref to 0
-        set {TID, text item delimiters} to {text item delimiters, ","}
-        set {uiElemsText, text item delimiters} to {uiElems as text, TID}
-        write uiElemsText to nref starting at eof
-        close access nref
-      end tell
-      *)
-      uiElems
-    on error errMsg number errorNumber
-      "Error: " & errMsg & " (#" & (errorNumber as text) & ")"
-    end try
-  END_OF_APPLESCRIPT
-
-  file = Tempfile.new('get_ui_elements')
-  output = begin
-    file.write(applescript)
-    file.close
-    `osascript #{file.path}`
-  ensure
-    file.unlink # Release the temporary script file
-  end
-  if output =~ /^Error/
-    $stderr.puts output.chomp
-    exit 1
-  end
-  puts output.gsub(/,\s+/,"\n")
-end
-
-if __FILE__ == $0
-  main(ARGV)
-end

data/lib/gui/version.rb

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-
-module Gui
-  VERSION = "0.1.0"
-end

data/lib/gui.rb

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "gui/version"
-
-module Gui
-  class Error < StandardError; end
-  # Your code goes here...
-end