karabiner 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d0c5b3a09ef8ab46b1340851ef24f67a776a800e
-  data.tar.gz: 73675efb64d75733c720393755b7f4996e46888f
+  metadata.gz: 5f432819fc1b42ec63bc0505b92644bffa27edcb
+  data.tar.gz: e68ef48995d6def0b813c4c389183f89f002cc30
 SHA512:
-  metadata.gz: a93b691b3c929332a64ff7d7a93654bf742895049dfe3022a073a0c4d8a8a02e4e80705c0926ddf64e8526d031423127e4a6d53406f9ea3d23b5d8ba0ba5e398
-  data.tar.gz: 377b271a2aee5a4b0e655c90b0a2316a4607f5184786f4522d6004caf3362b54e1c3e9561297c6ffaea92fb539be3298c4e93054b10c2ded135b621f9b9929b6
+  metadata.gz: 5e966346719f6afcbdfbdfd606b6b9d807dfa9ace01e5e340c8fc5d962bfebc60461d16c20e0854ac294e635e82f46020621c56f582b8a9024f170321409e6cb
+  data.tar.gz: fb23950b2c04ff2cd35dd0b9d8a5bbf6bb17dcf9aade7e6fe97e93525a86101081d14482470e1101f1fdd66b76fe6a3bad166a25caa92a660044953cededac36

data/CHANGELOG.md

@@ -0,0 +1,35 @@
+# Change Log
+
+## [v0.3.1](https://github.com/k0kubun/karabiner-dsl/tree/v0.3.1) (2016-05-17)
+[Full Changelog](https://github.com/k0kubun/karabiner-dsl/compare/v0.3.0...v0.3.1)
+
+## [v0.3.0](https://github.com/k0kubun/karabiner-dsl/tree/v0.3.0) (2015-12-31)
+[Full Changelog](https://github.com/k0kubun/karabiner-dsl/compare/v0.2.1...v0.3.0)
+
+**Merged pull requests:**
+
+- Can invoke the application of any place [\#5](https://github.com/k0kubun/karabiner-dsl/pull/5) ([elim](https://github.com/elim))
+
+## [v0.2.1](https://github.com/k0kubun/karabiner-dsl/tree/v0.2.1) (2015-08-30)
+[Full Changelog](https://github.com/k0kubun/karabiner-dsl/compare/v0.2.0...v0.2.1)
+
+## [v0.2.0](https://github.com/k0kubun/karabiner-dsl/tree/v0.2.0) (2015-07-08)
+[Full Changelog](https://github.com/k0kubun/karabiner-dsl/compare/v0.1.2...v0.2.0)
+
+## [v0.1.2](https://github.com/k0kubun/karabiner-dsl/tree/v0.1.2) (2015-05-21)
+[Full Changelog](https://github.com/k0kubun/karabiner-dsl/compare/v0.1.1...v0.1.2)
+
+**Merged pull requests:**
+
+- Add supporting BACKQUOTE [\#4](https://github.com/k0kubun/karabiner-dsl/pull/4) ([cnosuke](https://github.com/cnosuke))
+
+## [v0.1.1](https://github.com/k0kubun/karabiner-dsl/tree/v0.1.1) (2014-11-16)
+[Full Changelog](https://github.com/k0kubun/karabiner-dsl/compare/v0.0.8...v0.1.1)
+
+## [v0.0.8](https://github.com/k0kubun/karabiner-dsl/tree/v0.0.8) (2014-11-16)
+[Full Changelog](https://github.com/k0kubun/karabiner-dsl/compare/v0.1.0...v0.0.8)
+
+## [v0.1.0](https://github.com/k0kubun/karabiner-dsl/tree/v0.1.0) (2014-11-16)
+
+
+\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*

data/README.md

@@ -81,34 +81,44 @@ You have to write "key expression" to specify keys to remap.
 #### key expression
 
 - `a`, `A`, `1`, `;`, `tab`, `Tab`, `space`, `up`, `down`
-  - any string without `-` will be regarded as single key
-  - ignore upcase or downcase
-- `C-a`, `Ctrl-a`
-  - regarded as Control + A
-  - `C-` is a short expression of `Ctrl-`
-- `M-a`, `Opt-a`
-  - regarded as Option + A
-- `Shift-a`
-  - regarded as large A
-  - if you write just `A`, it will be regarded as small a
-- `Cmd-a`
-  - regarded as Command + A
-- `Cmd-Shift-a`
-  - regarded as Command + Shift + A
-  - you can use any combination of Ctrl, Opt, Shift, Cmd
+  - any string without `-` or `+` will be regarded as a single key
+  - strings are case insensitive
+- `Volume Mute`, `Mute`, `Brightness Down`, `Brightness_Down`
+  - support system (consumer) keys
+  - words could be separated by space ` ` or underscore `_`
+- nil, `nil`, `none`
+  - you can drop any key by using nil or the corresponding aliases
+
+#### key combination
+
+| Key combination                                            | Regarded as           | Notes  |
+| ---------------------------------------------------------- | --------------------- | ------ |
+| `C-a`, `Ctrl-a`, `C+a`, `Ctrl+a`                           | Control + A           | `C-` is a short alias for `Ctrl-` |
+| `M-a`, `Opt-a`, `Alt-a`, `M+a`, `Opt+a`, `Alt+a`           | Option + A            | `M-` and `Alt-` are aliases for `Opt-` |
+| `Shift-a`, `Shift+a`                                       | Shift + A (capital A) | if you write just `A`, it will be regarded as small a |
+| `Cmd-a`, `Cmd+a`                                           | Command + A           |        |
+| `Cmd-Shift-a`, `Cmd+Shift-a`, `Cmd-Shift+a`, `Cmd+Shift+a` | Command + Shift + A   | you can use any combination of Ctrl, Opt, Shift, Cmd |
 
 #### available single keys
 
+[Karabiner DSL keycode and alias reference](https://github.com/k0kubun/karabiner-dsl/blob/master/lib/karabiner/key.rb)
+
+[Karabiner full keycode reference](https://pqrs.org/osx/karabiner/xml.html#keycode-list)
+
 ```
 a b c ... x y z
 0 1 2 ... 7 8 9
+
 F1 F2 ... F11 F12
 \ [ ] ; ' ` , . / - =
 Up Down Right Left
-space tab delete forward_delete capslock
+Space Tab Delete ... Forward_Delete Esc Capslock
+Mute Volume_Down Volume_Up ... Prev Play Next
+
+nil none
 
 Ctrl_R  Ctrl_L
-Opt_R   Opt_L
+Opt_R   Opt_L   Alt_R   Alt_L
 Cmd_R   Cmd_L
 Shift_R Shift_L
 ```

data/lib/karabiner/key.rb

@@ -1,5 +1,24 @@
 class Karabiner::Key
-  KEYCODE_MAP = {
+  def self.normalize_input(raw_input)
+    if raw_input.match(/^VK_/)
+      raw_input
+    else
+      raw_input = raw_input.tr(' ', '_').tr('+', '-').upcase
+    end
+  end
+
+  def self.normalize_and_freeze!(map)
+    map.tap do |h|
+      h.keys.each { |k| h[normalize_input(k)] = h.delete(k) }
+    end
+    map.freeze
+  end
+
+  # Karabiner full keycode reference:
+  # https://pqrs.org/osx/karabiner/xml.html#keycode-list
+  KEYCODE_MAP = normalize_and_freeze!({
+    "nil"    => "VK_NONE",
+    "none"   => "VK_NONE",
     "0"      => "KEY_0",
     "1"      => "KEY_1",
     "2"      => "KEY_2",
@@ -33,15 +52,42 @@ class Karabiner::Key
     "Opt_L"  => "OPTION_L",
     "Cmd_R"  => "COMMAND_R",
     "Cmd_L"  => "COMMAND_L",
-  }.freeze
-  PREFIX_MAP = {
-    "C"     => "VK_CONTROL",
-    "Ctrl"  => "VK_CONTROL",
-    "Cmd"   => "VK_COMMAND",
-    "Shift" => "VK_SHIFT",
-    "M"     => "VK_OPTION",
-    "Opt"   => "VK_OPTION",
-  }.freeze
+    "Esc"    => "ESCAPE",
+  })
+  CONSUMER_MAP = normalize_and_freeze!({
+    "Brightness Down"     => "BRIGHTNESS_DOWN",
+    "Brightness Up"       => "BRIGHTNESS_UP",
+    "Keyboardlight Off"   => "KEYBOARDLIGHT_OFF",
+    "Keyboardlight Low"   => "KEYBOARDLIGHT_LOW",
+    "Keyboardlight High"  => "KEYBOARDLIGHT_HIGH",
+    "Keyboard Light Off"  => "KEYBOARDLIGHT_OFF",
+    "Keyboard Light Low"  => "KEYBOARDLIGHT_LOW",
+    "Keyboard Light High" => "KEYBOARDLIGHT_HIGH",
+    "Music Prev"          => "MUSIC_PREV",
+    "Music Play"          => "MUSIC_PLAY",
+    "Music Next"          => "MUSIC_NEXT",
+    "Prev"                => "MUSIC_PREV",
+    "Play"                => "MUSIC_PLAY",
+    "Next"                => "MUSIC_NEXT",
+    "Volume Mute"         => "VOLUME_MUTE",
+    "Volume Down"         => "VOLUME_DOWN",
+    "Volume Up"           => "VOLUME_UP",
+    "Mute"                => "VOLUME_MUTE",
+    "Eject"               => "EJECT",
+    "Power"               => "POWER",
+    "Numlock"             => "NUMLOCK",
+    "Num Lock"            => "NUMLOCK",
+    "Video Mirror"        => "VIDEO_MIRROR",
+  })
+  PREFIX_MAP = normalize_and_freeze!({
+    "C"        => "VK_CONTROL",
+    "Ctrl"     => "VK_CONTROL",
+    "Cmd"      => "VK_COMMAND",
+    "Shift"    => "VK_SHIFT",
+    "M"        => "VK_OPTION",
+    "Opt"      => "VK_OPTION",
+    "Alt"      => "VK_OPTION",
+  })
   PREFIX_EXPRESSION = "(#{PREFIX_MAP.keys.map { |k| k + '-' }.join('|')})"
 
   def initialize(expression)
@@ -55,6 +101,8 @@ class Karabiner::Key
   private
 
   def key_combination(raw_combination)
+    return "KeyCode::VK_NONE" if raw_combination.nil?
+    raw_combination = normalize_key_combination(raw_combination)
     raw_prefixes, raw_key = split_key_combination(raw_combination)
     return key_expression(raw_key) if raw_prefixes.empty?
 
@@ -64,14 +112,19 @@ class Karabiner::Key
 
   def key_expression(raw_key)
     case raw_key
-    when /^(#{KEYCODE_MAP.keys.map { |k| Regexp.escape(k) }.join('|')})$/
+    when /^#{Regexp.union(KEYCODE_MAP.keys)}$/
       "KeyCode::#{KEYCODE_MAP[raw_key]}"
+    when /^#{Regexp.union(CONSUMER_MAP.keys)}$/
+      "ConsumerKeyCode::#{CONSUMER_MAP[raw_key]}"
     else
-      raw_key = raw_key.upcase unless raw_key.match(/^VK_/)
       "KeyCode::#{raw_key}"
     end
   end
 
+  def normalize_key_combination(raw_combination)
+    self.class.normalize_input(raw_combination)
+  end
+
   def split_key_combination(raw_combination)
     prefixes = []
     key = raw_combination.dup

data/lib/karabiner/version.rb

@@ -1,3 +1,3 @@
 class Karabiner
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

data/spec/lib/karabiner/key_spec.rb

@@ -1,34 +1,14 @@
 require "spec_helper"
 
 describe Karabiner::Key do
+  describe ".normalize_input" do
+    it { expect(described_class.normalize_input('Cmd+Volume Up')).to eq('CMD-VOLUME_UP') }
+  end
+
   describe "#to_s" do
     EXPECTED_RESULTS = {
-      "a"       => "KeyCode::A",
-      "b"       => "KeyCode::B",
-      "c"       => "KeyCode::C",
-      "d"       => "KeyCode::D",
-      "e"       => "KeyCode::E",
-      "f"       => "KeyCode::F",
-      "g"       => "KeyCode::G",
-      "h"       => "KeyCode::H",
-      "i"       => "KeyCode::I",
-      "j"       => "KeyCode::J",
-      "k"       => "KeyCode::K",
-      "l"       => "KeyCode::L",
-      "m"       => "KeyCode::M",
-      "n"       => "KeyCode::N",
-      "o"       => "KeyCode::O",
-      "p"       => "KeyCode::P",
-      "q"       => "KeyCode::Q",
-      "r"       => "KeyCode::R",
-      "s"       => "KeyCode::S",
-      "t"       => "KeyCode::T",
-      "u"       => "KeyCode::U",
-      "v"       => "KeyCode::V",
-      "w"       => "KeyCode::W",
-      "x"       => "KeyCode::X",
-      "y"       => "KeyCode::Y",
-      "z"       => "KeyCode::Z",
+      "nil"     => "KeyCode::VK_NONE",
+      "none"    => "KeyCode::VK_NONE",
       "A"       => "KeyCode::A",
       "B"       => "KeyCode::B",
       "C"       => "KeyCode::C",
@@ -90,6 +70,31 @@ describe Karabiner::Key do
       "Cmd_L"   => "KeyCode::COMMAND_L",
       "Shift_R" => "KeyCode::SHIFT_R",
       "Shift_L" => "KeyCode::SHIFT_L",
+      "Esc"     => "KeyCode::ESCAPE",
+
+      "Brightness Down"     => "ConsumerKeyCode::BRIGHTNESS_DOWN",
+      "Brightness Up"       => "ConsumerKeyCode::BRIGHTNESS_UP",
+      "Keyboardlight Off"   => "ConsumerKeyCode::KEYBOARDLIGHT_OFF",
+      "Keyboardlight Low"   => "ConsumerKeyCode::KEYBOARDLIGHT_LOW",
+      "Keyboardlight High"  => "ConsumerKeyCode::KEYBOARDLIGHT_HIGH",
+      "Keyboard Light Off"  => "ConsumerKeyCode::KEYBOARDLIGHT_OFF",
+      "Keyboard Light Low"  => "ConsumerKeyCode::KEYBOARDLIGHT_LOW",
+      "Keyboard Light High" => "ConsumerKeyCode::KEYBOARDLIGHT_HIGH",
+      "Music Prev"          => "ConsumerKeyCode::MUSIC_PREV",
+      "Music Play"          => "ConsumerKeyCode::MUSIC_PLAY",
+      "Music Next"          => "ConsumerKeyCode::MUSIC_NEXT",
+      "Prev"                => "ConsumerKeyCode::MUSIC_PREV",
+      "Play"                => "ConsumerKeyCode::MUSIC_PLAY",
+      "Next"                => "ConsumerKeyCode::MUSIC_NEXT",
+      "Volume Mute"         => "ConsumerKeyCode::VOLUME_MUTE",
+      "Volume Down"         => "ConsumerKeyCode::VOLUME_DOWN",
+      "Volume Up"           => "ConsumerKeyCode::VOLUME_UP",
+      "Mute"                => "ConsumerKeyCode::VOLUME_MUTE",
+      "Eject"               => "ConsumerKeyCode::EJECT",
+      "Power"               => "ConsumerKeyCode::POWER",
+      "Numlock"             => "ConsumerKeyCode::NUMLOCK",
+      "Num Lock"            => "ConsumerKeyCode::NUMLOCK",
+      "Video Mirror"        => "ConsumerKeyCode::VIDEO_MIRROR",
     }.freeze
 
     it "converts single key expression as expected" do
@@ -112,5 +117,15 @@ describe Karabiner::Key do
         expect(described_class.new("#{prefix1}-#{prefix2}-#{key}").to_s).to eq("#{keycode}, #{vk1} | #{vk2}")
       end
     end
+
+    it "converts key expression in case-insensitive manner" do
+      EXPECTED_RESULTS.each do |expression, result|
+        expect(described_class.new(expression.swapcase).to_s).to eq(result)
+      end
+    end
+
+    it "accepts nil class as key expression" do
+      expect(described_class.new(nil).to_s).to eq("KeyCode::VK_NONE")
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: karabiner
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Takashi Kokubun
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-17 00:00:00.000000000 Z
+date: 2016-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -92,6 +92,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md