AXTyper 0.7.0 → 0.7.1

data/{.yardopts.typer → .yardopts_typer}

@@ -3,8 +3,8 @@
 --verbose
 --markup markdown
 --markup-provider redcarpet
---readme README.markdown.typer
+--readme README.typer.markdown
 lib/**/*.rb
-ext/**/*.m
+ext/**/*{.m,.c}
 -
 docs/KeyboardEvents.markdown

data/{README.markdown.typer → README.typer.markdown}

@@ -52,14 +52,15 @@ All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:
-    * Redistributions of source code must retain the above copyright
-      notice, this list of conditions and the following disclaimer.
-    * Redistributions in binary form must reproduce the above copyright
-      notice, this list of conditions and the following disclaimer in the
-      documentation and/or other materials provided with the distribution.
-    * Neither the name of Marketcircle Inc. nor the names of its
-      contributors may be used to endorse or promote products derived
-      from this software without specific prior written permission.
+
+* Redistributions of source code must retain the above copyright
+  notice, this list of conditions and the following disclaimer.
+* Redistributions in binary form must reproduce the above copyright
+  notice, this list of conditions and the following disclaimer in the
+  documentation and/or other materials provided with the distribution.
+* Neither the name of Marketcircle Inc. nor the names of its
+  contributors may be used to endorse or promote products derived
+  from this software without specific prior written permission.
 
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED

data/docs/KeyboardEvents.markdown

@@ -19,7 +19,7 @@ typing just make more sense when writing tests or scripts.
 
 ## Typing with the DSL
 
-The {Accessibility::DSL} mixin exposes keyboard events through the
+The {Accessibility::DSL} mix-in exposes keyboard events through the
 `type` method. A simple example would look like this:
 
     type "Hello, #{ENV['USER']}! How are you today?\n"
@@ -70,18 +70,18 @@ the string__, as in this example:
     type "\\PAGEDOWN notice the space afterwards\\PAGEUP but not before"
 
 The full list of supported custom escape sequences is listed in
-{Accessibility::StringParser::ESCAPES}. Some escapes have an alias,
+{Accessibility::StringParser::CUSTOM}. Some escapes have an alias,
 such as the right arrow key which can be escaped as `"\\RIGHT"` or as
 `"\\->"`.
 
 ### Hot Keys
 
-To support pressing multiple keys at the same time, also known as hot
-keys, you must start with the custom escape sequence for the
-combination and instead of ending with a space you should put a `+`
-character to chain the next key. The entire sequence should be ended
-with a space or nil. Some common examples are opening a file or
-quitting an application:
+To support pressing multiple keys at the same time (i.e. hot keys), you
+must start with the custom escape sequence for the combination and
+instead of ending with a space you should put a `+` character to chain
+the next key. The entire sequence should be ended with a space or
+nil. Some common examples are opening a file or quitting an
+application:
 
     type "\\COMMAND+o"
     type "\\CONTROL+a Typing at the start of the line"
@@ -93,6 +93,10 @@ You might also note that `CMD+SHIFT+s` could also be:
 
 Since a capital `S` will cause the shift key to be held down.
 
+One caveat with hot keys is that you cannot use `"\\COMMAND+ "` to
+represent command and space combination, you will need to use
+`"\\COMMAND+\s"` instead.
+
 ## Protips
 
 In order make sure that certain sequences of characters are properly
@@ -116,4 +120,3 @@ possible values. An example of using it would be:
 
     KEY_RATE=SLOW irb -rubygems -rax_elements
     KEY_RATE=0.25 rspec gui_spec.rb
-

data/ext/accessibility/key_coder/extconf.rb

@@ -6,7 +6,7 @@ $LIBS   << ' -framework Cocoa -framework Carbon -framework ApplicationServices'
 if RUBY_ENGINE == 'macruby'
   $CFLAGS << ' -fobjc-gc'
 else
-  $CFLAGS << ' -DNOT_MACRUBY -fblocks'
+  $CFLAGS << ' -DNOT_MACRUBY'
 end
 
 create_makefile('accessibility/key_coder')

data/ext/accessibility/key_coder/key_coder.c

@@ -10,10 +10,24 @@
 #import <Cocoa/Cocoa.h>
 #import <Carbon/Carbon.h>
 #import <ApplicationServices/ApplicationServices.h>
+
 #include "ruby.h"
 
+
+/*
+ *  Generate the mapping of characters to key codes for keys that can be
+ *  remapped based on keyboard layout. Changing the keyboard layout at
+ *  runtime will cause the returned hash to be different.
+ *
+ *  @example
+ *
+ *    KeyCoder.dynamic_mapping  => { "a" => 0, "b" => 24, ... }
+ *
+ *  @return [Hash{String=>Number}]
+ */
+
 static VALUE
-rb_keycoder_dynamic_mapping()
+keycoder_dynamic_mapping()
 {
 
   VALUE map = rb_hash_new();
@@ -31,8 +45,7 @@ rb_keycoder_dynamic_mapping()
     UniCharCount string_length = 0;
     UInt32       dead_key_state = 0;
     UCKeyTranslate(
-                   layout,
-		   key_code,
+		   layout,key_code,
 		   kUCKeyActionDown,
 		   0,
 		   LMGetKbdType(),  // kb type
@@ -48,7 +61,7 @@ rb_keycoder_dynamic_mapping()
   };
 
   // skip 65-92 since they are hard coded and do not change
-  for (int key_code = 0; key_code < 65; key_code++)
+  for (int key_code = 0;  key_code < 65;  key_code++)
     key_coder(key_code);
   for (int key_code = 93; key_code < 127; key_code++)
     key_coder(key_code);
@@ -64,8 +77,21 @@ rb_keycoder_dynamic_mapping()
 }
 
 
+/*
+ *  Post the given event to the system and return `true`. This method
+ *  will also add a small (9000 microsecond) delay after posting to
+ *  ensure that keyboard actions do not go too fast.
+ *
+ *  @example
+ *
+ *    KeyCoder.post_event [0, true]  -> true
+ *
+ *  @param [Array(Number, Boolean)]
+ *  @return [true]
+ */
+
 static VALUE
-rb_keycoder_post_event(VALUE self, VALUE event)
+keycoder_post_event(VALUE self, VALUE event)
 {
   VALUE code  = rb_ary_entry(event, 0);
   VALUE state = rb_ary_entry(event, 1);
@@ -81,7 +107,7 @@ rb_keycoder_post_event(VALUE self, VALUE event)
 void
 Init_key_coder()
 {
-  VALUE rb_cKeyCoder = rb_define_class("KeyCoder", rb_cObject);
-  rb_define_singleton_method(rb_cKeyCoder, "dynamic_mapping", rb_keycoder_dynamic_mapping, 0);
-  rb_define_singleton_method(rb_cKeyCoder, "post_event", rb_keycoder_post_event, 1);
+  VALUE cKeyCoder = rb_define_class("KeyCoder", rb_cObject);
+  rb_define_singleton_method(cKeyCoder, "dynamic_mapping", keycoder_dynamic_mapping, 0);
+  rb_define_singleton_method(cKeyCoder, "post_event", keycoder_post_event, 1);
 }

data/lib/accessibility/string.rb

@@ -2,7 +2,6 @@
 
 require   'accessibility/version'
 require   'accessibility/key_coder'
-framework 'ApplicationServices' if defined? MACRUBY_VERSION
 
 ##
 # Parses strings of human readable text into a series of events meant to
@@ -95,7 +94,7 @@ module Accessibility::String
       loop do
         char = @chars[@index]
         if char == PLUS
-          if @chars[@index-1] == CUSTOM_ESCAPE
+          if @chars[@index-1] == CUSTOM_ESCAPE # \\+ case
             @index += 1
             return custom_subseq start
           else
@@ -134,9 +133,6 @@ module Accessibility::String
 
 
   ##
-  # @todo Add a method to generate just keydown or just keyup events.
-  #       Requires separating code lookup from event creation.
-  #
   # Generate a sequence of keyboard events given a sequence of tokens.
   # The token format is defined by the {Lexer} class output; it is best
   # to use that class to generate the tokens.
@@ -188,27 +184,27 @@ module Accessibility::String
     #
     # @return [Hash{String=>Fixnum}]
     CUSTOM = {
-      "\\ESCAPE"        => 0x35,
-      "\\ESC"           => 0x35,
+      "\\FUNCTION"      => 0x3F,      # Standard Control Keys
+      "\\FN"            => 0x3F,
+      "\\CONTROL"       => 0x3B,
+      "\\CTRL"          => 0x3B,
+      "\\OPTION"        => 0x3A,
+      "\\OPT"           => 0x3A,
+      "\\ALT"           => 0x3A,
       "\\COMMAND"       => 0x37,
       "\\CMD"           => 0x37,
-      "\\SHIFT"         => 0x38,
       "\\LSHIFT"        => 0x38,
-      "\\CAPS"          => 0x39,
+      "\\SHIFT"         => 0x38,
       "\\CAPSLOCK"      => 0x39,
-      "\\OPTION"        => 0x3A,
-      "\\OPT"           => 0x3A,
-      "\\ALT"           => 0x3A,
-      "\\CONTROL"       => 0x3B,
-      "\\CTRL"          => 0x3B,
-      "\\RSHIFT"        => 0x3C,
+      "\\CAPS"          => 0x39,
       "\\ROPTION"       => 0x3D,
       "\\ROPT"          => 0x3D,
       "\\RALT"          => 0x3D,
       "\\RCONTROL"      => 0x3E,
       "\\RCTRL"         => 0x3E,
-      "\\FUNCTION"      => 0x3F,
-      "\\FN"            => 0x3F,
+      "\\RSHIFT"        => 0x3C,
+      "\\ESCAPE"        => 0x35,      # Top Row Keys
+      "\\ESC"           => 0x35,
       "\\VOLUMEUP"      => 0x48,
       "\\VOLUP"         => 0x48,
       "\\VOLUMEDOWN"    => 0x49,
@@ -234,19 +230,19 @@ module Accessibility::String
       "\\F18"           => 0x4F,
       "\\F19"           => 0x50,
       "\\F20"           => 0x5A,
-      "\\HELP"          => 0x72,
+      "\\HELP"          => 0x72,      # Island Keys
       "\\HOME"          => 0x73,
       "\\END"           => 0x77,
       "\\PAGEUP"        => 0x74,
       "\\PAGEDOWN"      => 0x79,
       "\\DELETE"        => 0x75,
-      "\\LEFT"          => 0x7B,
+      "\\LEFT"          => 0x7B,      # Arrow Keys
       "\\<-"            => 0x7B,
       "\\RIGHT"         => 0x7C,
       "\\->"            => 0x7C,
       "\\DOWN"          => 0x7D,
       "\\UP"            => 0x7E,
-      "\\0"             => 0x52,
+      "\\0"             => 0x52,      # Keypad Keys
       "\\1"             => 0x53,
       "\\2"             => 0x54,
       "\\3"             => 0x55,
@@ -256,20 +252,20 @@ module Accessibility::String
       "\\7"             => 0x59,
       "\\8"             => 0x5B,
       "\\9"             => 0x5C,
-      "\\Decimal"       => 0x41,
+      "\\DECIMAL"       => 0x41,
       "\\."             => 0x41,
-      "\\Plus"          => 0x45,
+      "\\PLUS"          => 0x45,
       "\\+"             => 0x45,
-      "\\Multiply"      => 0x43,
+      "\\MULTIPLY"      => 0x43,
       "\\*"             => 0x43,
-      "\\Minus"         => 0x4E,
+      "\\MINUS"         => 0x4E,
       "\\-"             => 0x4E,
-      "\\Divide"        => 0x4B,
+      "\\DIVIDE"        => 0x4B,
       "\\/"             => 0x4B,
-      "\\Equals"        => 0x51,
+      "\\EQUALS"        => 0x51,
       "\\="             => 0x51,
-      "\\Enter"         => 0x4C,
-      "\\Clear"         => 0x47,
+      "\\ENTER"         => 0x4C,
+      "\\CLEAR"         => 0x47,
     }
 
     ##
@@ -382,7 +378,7 @@ module Accessibility::String
 
 
     ##
-    # Once {generate} is called, this contains the sequence of
+    # Once {#generate} is called, this contains the sequence of
     # events.
     #
     # @return [Array<Array(Fixnum,Boolean)>]
@@ -401,7 +397,8 @@ module Accessibility::String
 
     ##
     # Generate the events for the tokens the event generator
-    # was initialized with. Returns the generated events.
+    # was initialized with. Returns the generated events, though
+    # you can also use {#events} to get the events later.
     #
     # @return [Array<Array(Fixnum,Boolean)>]
     def generate
@@ -418,6 +415,8 @@ module Accessibility::String
       @events[@index] = event
       @index += 1
     end
+    def previous_token; @events[@index-1] end
+    def rewind_index;   @index -= 1       end
 
     def gen_all tokens
       tokens.each do |token|
@@ -430,47 +429,46 @@ module Accessibility::String
     end
 
     def gen_nested head, tail
-      if code = CUSTOM[head] || SHIFTED[head] || OPTIONED[head] || MAPPING[head]
-        add [code, true]
-        gen_all tail
-        add [code, false]
-      else # handling a special case
-        gen_all head.split(EMPTY_STRING)
-      end
+      ((code =   CUSTOM[head]) &&  gen_dynamic(code, tail)) ||
+      ((code =  MAPPING[head]) &&  gen_dynamic(code, tail)) ||
+      ((code =  SHIFTED[head]) &&  gen_shifted(code, tail)) ||
+      ((code = OPTIONED[head]) && gen_optioned(code, tail)) ||
+      gen_all(head.split(EMPTY_STRING)) # handling a special case :(
     end
 
     def gen_single token
-      ((code =  MAPPING[token]) &&  gen_dynamic(code)) ||
-      ((code =  SHIFTED[token]) &&  gen_shifted(code)) ||
-      ((code = OPTIONED[token]) && gen_optioned(code)) ||
+      ((code =  MAPPING[token]) &&  gen_dynamic(code, nil)) ||
+      ((code =  SHIFTED[token]) &&  gen_shifted(code, nil)) ||
+      ((code = OPTIONED[token]) && gen_optioned(code, nil)) ||
       raise(ArgumentError, "#{token.inspect} has no mapping, bail!")
     end
 
-    def gen_shifted code
-      add SHIFT_DOWN
-      gen_dynamic MAPPING[code]
+    def gen_shifted code, tail
+      previous_token == SHIFT_UP ? rewind_index : add(SHIFT_DOWN)
+      gen_dynamic MAPPING[code], tail
       add SHIFT_UP
     end
 
-    def gen_optioned code
-      add OPTION_DOWN
-      gen_dynamic MAPPING[code]
+    def gen_optioned code, tail
+      previous_token == OPTION_UP ? rewind_index : add(OPTION_DOWN)
+      gen_dynamic MAPPING[code], tail
       add OPTION_UP
     end
 
-    def gen_dynamic code
+    def gen_dynamic code, tail
       add [code,  true]
+      gen_all tail if tail
       add [code, false]
     end
 
     # @private
-    EMPTY_STRING = ''
+    EMPTY_STRING = ""
     # @private
-    OPTION_DOWN  = [58, true]
+    OPTION_DOWN  = [58,  true]
     # @private
     OPTION_UP    = [58, false]
     # @private
-    SHIFT_DOWN   = [56, true]
+    SHIFT_DOWN   = [56,  true]
     # @private
     SHIFT_UP     = [56, false]
   end
@@ -480,7 +478,7 @@ end
 
 ##
 # @note This will only work if a run loop is running
-#
+# framework 'ApplicationServices' if defined? MACRUBY_VERSION
 # Register to be notified if the keyboard layout changes at runtime
 # NSDistributedNotificationCenter.defaultCenter.addObserver Accessibility::String::EventGenerator,
 #                                                selector: 'regenerate_dynamic_mapping',

data/lib/accessibility/version.rb

@@ -1,6 +1,6 @@
 module Accessibility
   # @return [String]
-  VERSION   = '0.7.0'
+  VERSION   = '0.7.1'
 
   # @return [String]
   CODE_NAME = 'Clefairy'

data/test/{unit → sanity}/accessibility/test_string.rb

@@ -1,5 +1,6 @@
 # -*- coding: utf-8 -*-
 
+require 'test/runner'
 require 'accessibility/string'
 
 class TestAccessibilityStringLexer < MiniTest::Unit::TestCase
@@ -131,10 +132,10 @@ class TestAccessibilityStringEventGenerator < MiniTest::Unit::TestCase
   end
 
   def test_generate_uppercase
-    assert_equal [sd,[a,t],[a,f],su],                                     gen(['A'])
-    assert_equal [sd,[c,t],[c,f],su,sd,[k,t],[k,f],su],                   gen(['C','K'])
-    assert_equal [sd,[e,t],[e,f],su,sd,[e,t],[e,f],su],                   gen(['E','E'])
-    assert_equal [sd,[c,t],[c,f],su,sd,[a,t],[a,f],su,sd,[k,t],[k,f],su], gen(['C','A','K'])
+    assert_equal [sd,[a,t],[a,f],su],                         gen(['A'])
+    assert_equal [sd,[c,t],[c,f],[k,t],[k,f],su],             gen(['C','K'])
+    assert_equal [sd,[e,t],[e,f],[e,t],[e,f],su],             gen(['E','E'])
+    assert_equal [sd,[c,t],[c,f],[a,t],[a,f],[k,t],[k,f],su], gen(['C','A','K'])
   end
 
   def test_generate_numbers
@@ -161,18 +162,19 @@ class TestAccessibilityStringEventGenerator < MiniTest::Unit::TestCase
   end
 
   def test_generate_unicode # holding option
-    assert_equal [od,[sigma,t],[sigma,f],ou], gen(["∑"])
-    assert_equal [od,[tm,t],[tm,f],ou],       gen(["™"])
-    assert_equal [od,[gbp,t],[gbp,f],ou],     gen(["£"])
-    assert_equal [od,[omega,t],[omega,f],ou], gen(["Ω"])
+    assert_equal [od,[sigma,t],[sigma,f],ou],           gen(["∑"])
+    assert_equal [od,[tm,t],[tm,f],ou],                 gen(["™"])
+    assert_equal [od,[gbp,t],[gbp,f],ou],               gen(["£"])
+    assert_equal [od,[omega,t],[omega,f],ou],           gen(["Ω"])
+    assert_equal [od,[tm,t],[tm,f],[gbp,t],[gbp,f],ou], gen(["™","£"])
   end
 
   def test_generate_backslashes
-    assert_equal [[bslash,t],[bslash,f]],                                     gen(["\\"])
-    assert_equal [[bslash,t],[bslash,f],[space,t],[space,f]],                 gen(["\\"," "])
-    assert_equal [[bslash,t],[bslash,f],[h,t],[h,f],[m,t],[m,f]],             gen(["\\",'h','m'])
+    assert_equal [[bslash,t],[bslash,f]],                               gen(["\\"])
+    assert_equal [[bslash,t],[bslash,f],[space,t],[space,f]],           gen(["\\"," "])
+    assert_equal [[bslash,t],[bslash,f],[h,t],[h,f],[m,t],[m,f]],       gen(["\\",'h','m'])
     # is this the job of the parser or the lexer?
-    assert_equal [[bslash,t],[bslash,f],sd,[h,t],[h,f],su,sd,[m,t],[m,f],su], gen([["\\HM"]])
+    assert_equal [[bslash,t],[bslash,f],sd,[h,t],[h,f],[m,t],[m,f],su], gen([["\\HM"]])
   end
 
   def test_generate_a_custom_escape
@@ -192,9 +194,8 @@ class TestAccessibilityStringEventGenerator < MiniTest::Unit::TestCase
   end
 
   def test_bails_for_unmapped_token
-    e = assert_raises ArgumentError do
-      gen(["☃"]) # cannot generate snowmen :(
-    end
+    # cannot generate snowmen :(
+    e = assert_raises(ArgumentError) { gen(["☃"]) }
     assert_match /bail/i, e.message
   end
 
@@ -202,6 +203,10 @@ class TestAccessibilityStringEventGenerator < MiniTest::Unit::TestCase
     assert_equal [[c,t],[a,t],[k,t],[e,t],[e,f],[k,f],[a,f],[c,f]], gen([["c",["a",["k",["e"]]]]])
   end
 
+  def test_generate_command_A
+    assert_equal [cd,sd,[a,t],[a,f],su,cu], gen([["\\COMMAND",["A"]]])
+  end
+
 end
 
 
@@ -218,7 +223,7 @@ class TestAccessibilityString < MiniTest::Unit::TestCase
     assert_kind_of Array, events
     refute_empty events
 
-    assert_equal true, events[0][1]
+    assert_equal true,  events[0][1]
     assert_equal false, events[1][1]
   end
 

metadata

@@ -2,14 +2,14 @@
 name: AXTyper
 version: !ruby/object:Gem::Version
   prerelease: 
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Mark Rada
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-29 00:00:00 Z
+date: 2012-04-03 00:00:00 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -69,18 +69,18 @@ executables: []
 extensions:
 - ext/accessibility/key_coder/extconf.rb
 extra_rdoc_files:
-- README.markdown.typer
-- .yardopts.typer
+- README.typer.markdown
+- .yardopts_typer
 - docs/KeyboardEvents.markdown
 files:
 - lib/accessibility/version.rb
 - lib/accessibility/string.rb
 - ext/accessibility/key_coder/key_coder.c
 - ext/accessibility/key_coder/extconf.rb
-- test/unit/accessibility/test_string.rb
+- test/sanity/accessibility/test_string.rb
 - test/runner.rb
-- README.markdown.typer
-- .yardopts.typer
+- README.typer.markdown
+- .yardopts_typer
 - docs/KeyboardEvents.markdown
 homepage: http://github.com/Marketcircle/AXElements
 licenses:
@@ -108,5 +108,5 @@ signing_key:
 specification_version: 3
 summary: Keyboard simulation via accessibility
 test_files:
-- test/unit/accessibility/test_string.rb
+- test/sanity/accessibility/test_string.rb
 - test/runner.rb