dotremap 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b583b2e6288717148abe4fdaf0a0005ee4e44d7b
-  data.tar.gz: 56162121e591fce2c2df10404fa8f058204f261e
+  metadata.gz: f7239e13995fda02fc4fa7d3aadb9b7a23ab7efa
+  data.tar.gz: beea8d31a99eddca3b13e18a28a68a3103493ea2
 SHA512:
-  metadata.gz: 6152e932f2ce3581d3bec446abb8697f9607a381e03c3b321e7ed1ef10091ed191ae693e85411c40c927cad8e34be869dbad70dd28d2c0bacf8218b7fbd0b407
-  data.tar.gz: de087ee48dac92eb7f479830e196e3b6fe63dc828d7784f1531fcd6489a086dd423b1907b23f6574b0cc1a77487fa2b38d075a64a96c970446fc17f80870289f
+  metadata.gz: 0611d804ba6284b53ae62a75db22159a054f964be1ba9be6d12af307b9605bedcd84bade9a75fdd7ceedef77339a5d167f21a0af270bf09938929285f6a6590e
+  data.tar.gz: e9a66f62416f43b44675ff615ae02d395bb8bd00abd43b41561330f46c1fb8a5e8822749659110299e8307188e2b3d801f77d49700ce3f951607277012ebf506

data/.rspec

@@ -0,0 +1 @@
+-c

data/.travis.yml

@@ -0,0 +1,7 @@
+rvm:
+- 2.1.2
+branches:
+  only:
+    - master
+script:
+  - 'bundle exec rspec .'

data/README.md

@@ -1,10 +1,22 @@
-# Dotremap
+# Dotremap [![Build Status](https://travis-ci.org/k0kubun/dotremap.png?branch=master)](https://travis-ci.org/k0kubun/dotremap)
 
-Lightweight configuration DSL for [KeyRemap4MacBook](https://pqrs.org/osx/karabiner/index.html)
+Lightweight keyremap configuration DSL for [Karabiner](https://pqrs.org/osx/karabiner/index.html.en)
+
+## Why dotremap?
+
+Original [Karabiner's configuration](https://pqrs.org/osx/karabiner/xml.html.ja) is very hard to write.  
+Dotremap's DSL is its wrapper, which is easy-to-write and readable.  
+  
+If you write Karabiner's config by dotremap, you can update your keyremap configuration quickly.
 
 ## Installation
 
-````bash
+First of all, you have to install [Karabiner](https://pqrs.org/osx/karabiner/index.html.en).
+Karabiner is a keyboard remap utility for Mac OSX.  
+  
+Then execute:
+
+```bash
 $ gem install dotremap
 ```
 
@@ -12,12 +24,8 @@ $ gem install dotremap
 ### 1. Create ~/.remap
 
 ```rb
-# ~/.remap
-item "Control+PNBF to Up/Down/Left/Right", not: "TERMINAL" do
-  remap "C-p", to: "Up"
-  remap "C-n", to: "Down"
-  remap "C-b", to: "Left"
-  remap "C-f", to: "Right"
+item "Command+G to open Google Chrome" do
+  remap "Cmd-g", to: invoke("Google Chrome")
 end
 ```
 
@@ -27,30 +35,89 @@ end
 $ dotremap
 ```
 
-It will replace KeyRemap4MacBook's private.xml with compiled ~/.remap:
-
-```xml
-<?xml version="1.0"?>
-<root>
-  <item>
-    <name>Control+PNBF to Up/Down/Left/Right</name>
-    <identifier>remap.control_pnbf_to_up_down_left_right</identifier>
-    <not>TERMINAL</not>
-    <autogen>__KeyToKey__ KeyCode::P, VK_CONTROL, KeyCode::CURSOR_UP</autogen>
-    <autogen>__KeyToKey__ KeyCode::N, VK_CONTROL, KeyCode::CURSOR_DOWN</autogen>
-    <autogen>__KeyToKey__ KeyCode::B, VK_CONTROL, KeyCode::CURSOR_LEFT</autogen>
-    <autogen>__KeyToKey__ KeyCode::F, VK_CONTROL, KeyCode::CURSOR_RIGHT</autogen>
-  </item>
-</root>
+Then dotremap will update Karabiner's config as you expected.
+
+![](https://raw.githubusercontent.com/k0kubun/dotremap/master/img/disabled.png)
+
+### 3. Enable your favorite configurations
+
+![](https://raw.githubusercontent.com/k0kubun/dotremap/master/img/enabled.png)
+
+Enjoy!
+
+## How to write ~/.remap
+### Basics
+
+Dotremap's DSL is a superset of Ruby.  
+So you can use any Ruby methods in ~/.remap.
+
+#### item
+
+```rb
+item "configuration unit" do
+  ...
+end
 ```
 
-dotremap will automatically execute "ReloadXML".  
-Then activate your favorite configurations.
+In dotremap, any Karabiner's configuration unit is expressed in `item` and its `do ~ end` block.  
+You can group some remap configurations in one item and enable them in one click.
+
+#### remap
+
+```rb
+item "remap example" do
+  remap "Cmd-a", to: "C-a"
+end
+```
+
+If you want to add remap configuration, you have to call `remap` method.  
+In this example, Command+A will be remapped to Control+A.  
+  
+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
+
+#### available single keys
+
+```
+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
+
+Ctrl_R Ctrl_L
+Opt_R  Opt_L
+Cmd_R  Cmd_L
+```
+
+### Advanced usage
+
+I'm sorry but currently some features are not documented here.  
+You can see [my ~/.remap](https://github.com/k0kubun/dotfiles/blob/master/.remap.rb) or
+[dotremap's spec files](https://github.com/k0kubun/dotremap/tree/master/spec/lib).
 
-## Example
+## TODO
 
-I'm sorry but currently this software is not well documented.  
-Please see [example.rb](https://github.com/k0kubun/dotremap/blob/master/example.rb) to learn how to use.
+- Document all features in this README
 
 ## Contributing
 

data/dotremap.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = Dotremap::VERSION
   spec.authors       = ["Takashi Kokubun"]
   spec.email         = ["takashikkbn@gmail.com"]
-  spec.summary       = %q{Configuration DSL for KeyRemap4MacBook}
-  spec.description   = %q{Configuration DSL for KeyRemap4MacBook}
+  spec.summary       = %q{Lightweight keyremap configuration DSL}
+  spec.description   = %q{Lightweight keyremap configuration DSL for Karabiner}
   spec.homepage      = "https://github.com/k0kubun/dotremap"
   spec.license       = "MIT"
 
@@ -19,6 +19,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler"
-  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rake", "~> 10.3.2"
+  spec.add_development_dependency "rspec", "~> 3.0.0"
+  spec.add_development_dependency "pry"
   spec.add_dependency 'unindent', '~> 1.0'
 end

data/lib/dotremap.rb

@@ -1,3 +1,4 @@
+require "dotremap/karabiner"
 require "dotremap/version"
 require "dotremap/root"
 require "unindent"
@@ -5,11 +6,7 @@ require "fileutils"
 
 class Dotremap
   XML_FILE_NAME = "private.xml"
-  OLD_XML_DIR = File.expand_path("~/Library/Application Support/KeyRemap4MacBook")
-  NEW_XML_DIR = File.expand_path("~/Library/Application Support/Karabiner")
-  OLD_APP_PATH = "/Applications/KeyRemap4MacBook.app"
-  NEW_APP_PATH = "/Applications/Karabiner.app"
-  RELOAD_XML_PATH = "Contents/Applications/Utilities/ReloadXML.app"
+  XML_DIR = File.expand_path("~/Library/Application Support/Karabiner")
 
   def initialize(config_path)
     @config_path = config_path
@@ -18,38 +15,18 @@ class Dotremap
 
   def apply_configuration
     replace_private_xml
-    reload_xml
+    Karabiner.reload_xml
+
     puts "Successfully updated Karabiner configuration"
   end
 
   private
 
   def replace_private_xml
-    ensure_xml_dir_existence
-    remove_current_xml
-    write_new_xml
-  end
-
-  def reload_xml
-    app_path = File.exists?(OLD_APP_PATH) ? OLD_APP_PATH : NEW_APP_PATH
-    reload_xml_path = File.join(app_path, RELOAD_XML_PATH)
-
-    system("open #{reload_xml_path}")
-  end
-
-  def ensure_xml_dir_existence
-    FileUtils.mkdir_p(OLD_XML_DIR)
-    FileUtils.mkdir_p(NEW_XML_DIR)
-  end
-
-  def remove_current_xml
-    FileUtils.rm_f(File.join(OLD_XML_DIR, XML_FILE_NAME))
-    FileUtils.rm_f(File.join(NEW_XML_DIR, XML_FILE_NAME))
-  end
+    FileUtils.mkdir_p(XML_DIR)
 
-  def write_new_xml
-    File.write(File.join(OLD_XML_DIR, XML_FILE_NAME), new_xml)
-    File.write(File.join(NEW_XML_DIR, XML_FILE_NAME), new_xml)
+    xml_path = File.join(XML_DIR, XML_FILE_NAME)
+    File.write(xml_path, new_xml)
   end
 
   def new_xml
@@ -59,7 +36,7 @@ class Dotremap
     root = Root.new
     config = File.read(config_path)
     root.instance_eval(config)
-    @new_xml = root.to_xml.gsub(/ *$/, "")
+    @new_xml = root.to_xml.gsub(/ *$/, "").concat("\n")
   end
 
   def validate_config_existence

data/lib/dotremap/appdef.rb

@@ -18,8 +18,10 @@ class Dotremap::Appdef
   def to_xml
     [
       "<appdef>",
-      "  <appname>#{@appname}</appname>",
-      @childs.map(&:to_xml).join("\n").gsub(/^/, "  "),
+      [
+        "<appname>#{@appname}</appname>",
+        *@childs.map(&:to_xml),
+      ].join("\n").gsub(/^/, "  "),
       "</appdef>",
     ].join("\n")
   end

data/lib/dotremap/karabiner.rb

@@ -0,0 +1,7 @@
+module Dotremap::Karabiner
+  CLI_PATH = "/Applications/Karabiner.app/Contents/Library/bin/karabiner"
+
+  def self.reload_xml
+    system("#{CLI_PATH} reloadxml")
+  end
+end

data/lib/dotremap/key.rb

@@ -0,0 +1,85 @@
+class Dotremap::Key
+  KEYCODE_MAP = {
+    "0"      => "KEY_0",
+    "1"      => "KEY_1",
+    "2"      => "KEY_2",
+    "3"      => "KEY_3",
+    "4"      => "KEY_4",
+    "5"      => "KEY_5",
+    "6"      => "KEY_6",
+    "7"      => "KEY_7",
+    "8"      => "KEY_8",
+    "9"      => "KEY_9",
+    "Up"     => "CURSOR_UP",
+    "Down"   => "CURSOR_DOWN",
+    "Right"  => "CURSOR_RIGHT",
+    "Left"   => "CURSOR_LEFT",
+    "]"      => "BRACKET_RIGHT",
+    "["      => "BRACKET_LEFT",
+    ";"      => "SEMICOLON",
+    "-"      => "MINUS",
+    ","      => "COMMA",
+    "."      => "DOT",
+    "\\"     => "BACKSLASH",
+    "/"      => "SLASH",
+    "="      => "EQUAL",
+    "'"      => "QUOTE",
+    "Ctrl_R" => "CONTROL_R",
+    "Ctrl_L" => "CONTROL_L",
+    "Opt_R"  => "OPTION_R",
+    "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
+  PREFIX_EXPRESSION = "(#{PREFIX_MAP.keys.map { |k| k + '-' }.join('|')})"
+
+  def initialize(expression)
+    @expression = expression
+  end
+
+  def to_s
+    key_combination(@expression)
+  end
+
+  private
+
+  def key_combination(raw_combination)
+    raw_prefixes, raw_key = split_key_combination(raw_combination)
+    return key_expression(raw_key) if raw_prefixes.empty?
+
+    prefixes = raw_prefixes.map { |raw_prefix| PREFIX_MAP[raw_prefix] }
+    "#{key_expression(raw_key)}, #{prefixes.join(' | ')}"
+  end
+
+  def key_expression(raw_key)
+    case raw_key
+    when /^(#{KEYCODE_MAP.keys.map { |k| Regexp.escape(k) }.join('|')})$/
+      "KeyCode::#{KEYCODE_MAP[raw_key]}"
+    else
+      raw_key = raw_key.upcase unless raw_key.match(/^VK_/)
+      "KeyCode::#{raw_key}"
+    end
+  end
+
+  def split_key_combination(raw_combination)
+    prefixes = []
+    key = raw_combination.dup
+
+    while key.match(/^#{PREFIX_EXPRESSION}/)
+      key.gsub!(/^#{PREFIX_EXPRESSION}/) do
+        prefixes << $1.gsub(/-$/, "")
+        ""
+      end
+    end
+
+    [prefixes, key]
+  end
+end

data/lib/dotremap/remap.rb

@@ -1,46 +1,6 @@
-class Dotremap::Remap
-  KEYCODE_MAP = {
-    "0"      => "KEY_0",
-    "1"      => "KEY_1",
-    "2"      => "KEY_2",
-    "3"      => "KEY_3",
-    "4"      => "KEY_4",
-    "5"      => "KEY_5",
-    "6"      => "KEY_6",
-    "7"      => "KEY_7",
-    "8"      => "KEY_8",
-    "9"      => "KEY_9",
-    "Up"     => "CURSOR_UP",
-    "Down"   => "CURSOR_DOWN",
-    "Right"  => "CURSOR_RIGHT",
-    "Left"   => "CURSOR_LEFT",
-    "]"      => "BRACKET_RIGHT",
-    "["      => "BRACKET_LEFT",
-    ";"      => "SEMICOLON",
-    "-"      => "MINUS",
-    ","      => "COMMA",
-    "."      => "DOT",
-    "\\"     => "BACKSLASH",
-    "/"      => "SLASH",
-    "="      => "EQUAL",
-    "'"      => "QUOTE",
-    "Ctrl_R" => "CONTROL_R",
-    "Ctrl_L" => "CONTROL_L",
-    "Opt_R"  => "OPTION_R",
-    "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
-  PREFIX_EXPRESSION = "(#{PREFIX_MAP.keys.map { |k| k + '-' }.join('|')})"
+require "dotremap/key"
 
+class Dotremap::Remap
   def initialize(from, to)
     @from = from
     @to = to
@@ -53,42 +13,10 @@ class Dotremap::Remap
   private
 
   def from
-    key_combination(@from)
+    Dotremap::Key.new(@from)
   end
 
   def to
-    [@to].flatten.map { |to| key_combination(to) }.join(", ")
-  end
-
-  def key_combination(raw_combination)
-    raw_prefixes, raw_key = split_key_combination(raw_combination)
-    return key_expression(raw_key) if raw_prefixes.empty?
-
-    prefixes = raw_prefixes.map { |raw_prefix| PREFIX_MAP[raw_prefix] }
-    "#{key_expression(raw_key)}, #{prefixes.join(' | ')}"
-  end
-
-  def key_expression(raw_key)
-    case raw_key
-    when /^(#{KEYCODE_MAP.keys.map { |k| Regexp.escape(k) }.join('|')})$/
-      "KeyCode::#{KEYCODE_MAP[raw_key]}"
-    else
-      raw_key = raw_key.upcase unless raw_key.match(/^VK_/)
-      "KeyCode::#{raw_key}"
-    end
-  end
-
-  def split_key_combination(raw_combination)
-    prefixes = []
-    key = raw_combination.dup
-
-    while key.match(/^#{PREFIX_EXPRESSION}/)
-      key.gsub!(/^#{PREFIX_EXPRESSION}/) do
-        prefixes << $1.gsub(/-$/, "")
-        ""
-      end
-    end
-
-    [prefixes, key]
+    [@to].flatten.map { |to| Dotremap::Key.new(to) }.join(", ")
   end
 end

data/lib/dotremap/root.rb

@@ -13,9 +13,11 @@ class Dotremap::Root
     [
       "<?xml version=\"1.0\"?>",
       "<root>",
-      childs.map(&:to_xml).join("\n\n").gsub(/^/, "  "),
-      Dotremap::Openurl.registered_xml.gsub(/^/, "  "),
+      [
+        childs.map(&:to_xml).join("\n\n"),
+        Dotremap::Openurl.registered_xml,
+      ].compact.join("\n").gsub(/^/, "  "),
       "</root>",
-    ].compact.join("\n")
+    ].join("\n")
   end
 end

data/lib/dotremap/version.rb

@@ -1,3 +1,3 @@
 class Dotremap
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/lib/dotremap/appdef_spec.rb

@@ -0,0 +1,35 @@
+require "spec_helper"
+
+describe Dotremap::Appdef do
+  describe "#to_xml" do
+    it "returns valid xml from appdef with equal" do
+      appdef = Dotremap::Appdef.new("CHROME", equal: "com.google.Chrome")
+      expect(appdef.to_xml).to eq(<<-EOS.unindent.strip)
+        <appdef>
+          <appname>CHROME</appname>
+          <equal>com.google.Chrome</equal>
+        </appdef>
+      EOS
+    end
+
+    it "returns valid xml from appdef with prefix" do
+      appdef = Dotremap::Appdef.new("CHROME", prefix: "com")
+      expect(appdef.to_xml).to eq(<<-EOS.unindent.strip)
+        <appdef>
+          <appname>CHROME</appname>
+          <prefix>com</prefix>
+        </appdef>
+      EOS
+    end
+
+    it "returns valid xml from appdef with suffix" do
+      appdef = Dotremap::Appdef.new("CHROME", suffix: "Chrome")
+      expect(appdef.to_xml).to eq(<<-EOS.unindent.strip)
+        <appdef>
+          <appname>CHROME</appname>
+          <suffix>Chrome</suffix>
+        </appdef>
+      EOS
+    end
+  end
+end

data/spec/lib/dotremap/key_spec.rb

@@ -0,0 +1,111 @@
+require "spec_helper"
+
+describe Dotremap::Key do
+  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",
+      "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",
+      "0"      => "KeyCode::KEY_0",
+      "1"      => "KeyCode::KEY_1",
+      "2"      => "KeyCode::KEY_2",
+      "3"      => "KeyCode::KEY_3",
+      "4"      => "KeyCode::KEY_4",
+      "5"      => "KeyCode::KEY_5",
+      "6"      => "KeyCode::KEY_6",
+      "7"      => "KeyCode::KEY_7",
+      "8"      => "KeyCode::KEY_8",
+      "9"      => "KeyCode::KEY_9",
+      "Up"     => "KeyCode::CURSOR_UP",
+      "Down"   => "KeyCode::CURSOR_DOWN",
+      "Right"  => "KeyCode::CURSOR_RIGHT",
+      "Left"   => "KeyCode::CURSOR_LEFT",
+      "]"      => "KeyCode::BRACKET_RIGHT",
+      "["      => "KeyCode::BRACKET_LEFT",
+      ";"      => "KeyCode::SEMICOLON",
+      "-"      => "KeyCode::MINUS",
+      ","      => "KeyCode::COMMA",
+      "."      => "KeyCode::DOT",
+      "\\"     => "KeyCode::BACKSLASH",
+      "/"      => "KeyCode::SLASH",
+      "="      => "KeyCode::EQUAL",
+      "'"      => "KeyCode::QUOTE",
+      "Ctrl_R" => "KeyCode::CONTROL_R",
+      "Ctrl_L" => "KeyCode::CONTROL_L",
+      "Opt_R"  => "KeyCode::OPTION_R",
+      "Opt_L"  => "KeyCode::OPTION_L",
+      "Cmd_R"  => "KeyCode::COMMAND_R",
+      "Cmd_L"  => "KeyCode::COMMAND_L",
+    }.freeze
+
+    it "converts single key expression as expected" do
+      EXPECTED_RESULTS.each do |expression, result|
+        expect(described_class.new(expression).to_s).to eq(result)
+      end
+    end
+
+    it "converts double key combination as expected" do
+      Dotremap::Key::PREFIX_MAP.each do |prefix, vk|
+        key, keycode = EXPECTED_RESULTS.to_a.sample
+        expect(described_class.new("#{prefix}-#{key}").to_s).to eq("#{keycode}, #{vk}")
+      end
+    end
+
+    it "converts triple key combination as expected" do
+      key, keycode = EXPECTED_RESULTS.to_a.sample
+      unique_maps = Dotremap::Key::PREFIX_MAP.to_a.sort_by { rand }.uniq { |a| a[1] }
+      unique_maps.combination(2) do |(prefix1, vk1), (prefix2, vk2)|
+        expect(described_class.new("#{prefix1}-#{prefix2}-#{key}").to_s).to eq("#{keycode}, #{vk1} | #{vk2}")
+      end
+    end
+  end
+end

data/spec/lib/dotremap/remap_spec.rb

@@ -0,0 +1,10 @@
+require "spec_helper"
+
+describe Dotremap::Remap do
+  describe "#to_xml" do
+    it "converts key remap to autogen tag" do
+      expect(Dotremap::Remap.new("Cmd-Shift-]", "Opt-Ctrl-Up").to_xml).
+        to eq("<autogen>__KeyToKey__ KeyCode::BRACKET_RIGHT, VK_COMMAND | VK_SHIFT, KeyCode::CURSOR_UP, VK_OPTION | VK_CONTROL</autogen>")
+    end
+  end
+end

data/spec/lib/dotremap_spec.rb

@@ -0,0 +1,248 @@
+require "spec_helper"
+require "tempfile"
+
+describe Dotremap do
+  let!(:config) { Tempfile.new(".remap") }
+  let(:xml_dir) { "/tmp" }
+  let(:xml_path) { File.join(xml_dir, Dotremap::XML_FILE_NAME) }
+  let(:result) { File.read(xml_path) }
+
+  before do
+    stub_const("Dotremap::XML_DIR", xml_dir)
+    allow(Dotremap::Karabiner).to receive(:reload_xml)
+
+    # Silence stdout
+    allow_any_instance_of(Kernel).to receive(:puts)
+  end
+
+  after do
+    config.close!
+  end
+
+  def prepare_dotremap(dotremap)
+    config.write(dotremap)
+    config.rewind
+  end
+
+  def expect_result(expected_result)
+    dotremap = Dotremap.new(config.path)
+    dotremap.apply_configuration
+    expect(result).to eq(expected_result)
+  end
+
+  it "accepts blank config" do
+    prepare_dotremap("")
+
+    expect_result(<<-EOS.unindent)
+      <?xml version="1.0"?>
+      <root>
+
+      </root>
+    EOS
+  end
+
+  it "accepts cmd combination" do
+    prepare_dotremap(<<-EOS)
+      item "Command+A to Command+B" do
+        remap "Cmd-A", to: "Cmd-B"
+      end
+    EOS
+
+    expect_result(<<-EOS.unindent)
+      <?xml version="1.0"?>
+      <root>
+        <item>
+          <name>Command+A to Command+B</name>
+          <identifier>remap.command_a_to_command_b</identifier>
+          <autogen>__KeyToKey__ KeyCode::A, VK_COMMAND, KeyCode::B, VK_COMMAND</autogen>
+        </item>
+      </root>
+    EOS
+  end
+
+  it "accepts multiple remaps" do
+    prepare_dotremap(<<-EOS)
+      item "multiple remaps" do
+        remap "Cmd-A", to: "Cmd-B"
+        remap "Shift-A", to: "Shift-B"
+      end
+    EOS
+
+    expect_result(<<-EOS.unindent)
+      <?xml version="1.0"?>
+      <root>
+        <item>
+          <name>multiple remaps</name>
+          <identifier>remap.multiple_remaps</identifier>
+          <autogen>__KeyToKey__ KeyCode::A, VK_COMMAND, KeyCode::B, VK_COMMAND</autogen>
+          <autogen>__KeyToKey__ KeyCode::A, VK_SHIFT, KeyCode::B, VK_SHIFT</autogen>
+        </item>
+      </root>
+    EOS
+  end
+
+  it "accepts multiple items" do
+    prepare_dotremap(<<-EOS)
+      item "first item" do
+        remap "Cmd-C-A", to: "Cmd-M-B"
+      end
+
+      item "second item" do
+        remap "Shift-Opt-A", to: "Shift-Cmd-B"
+      end
+    EOS
+
+    expect_result(<<-EOS.unindent)
+      <?xml version="1.0"?>
+      <root>
+        <item>
+          <name>first item</name>
+          <identifier>remap.first_item</identifier>
+          <autogen>__KeyToKey__ KeyCode::A, VK_COMMAND | VK_CONTROL, KeyCode::B, VK_COMMAND | VK_OPTION</autogen>
+        </item>
+
+        <item>
+          <name>second item</name>
+          <identifier>remap.second_item</identifier>
+          <autogen>__KeyToKey__ KeyCode::A, VK_SHIFT | VK_OPTION, KeyCode::B, VK_SHIFT | VK_COMMAND</autogen>
+        </item>
+      </root>
+    EOS
+  end
+
+  it "accepts appdef and app option" do
+    prepare_dotremap(<<-EOS)
+      appdef "CHROME", equal: "com.google.Chrome"
+
+      item "Command+K to Command+L", only: "CHROME" do
+        remap "Cmd-K", to: "Cmd-L"
+      end
+    EOS
+
+    expect_result(<<-EOS.unindent)
+      <?xml version="1.0"?>
+      <root>
+        <appdef>
+          <appname>CHROME</appname>
+          <equal>com.google.Chrome</equal>
+        </appdef>
+
+        <item>
+          <name>Command+K to Command+L</name>
+          <identifier>remap.command_k_to_command_l</identifier>
+          <only>CHROME</only>
+          <autogen>__KeyToKey__ KeyCode::K, VK_COMMAND, KeyCode::L, VK_COMMAND</autogen>
+        </item>
+      </root>
+    EOS
+  end
+
+  it "accepts config and show_message" do
+    prepare_dotremap(<<-EOS)
+      item "CapsLock ON", config_not: "notsave.private_capslock_on" do
+        remap "Cmd-L", to: ["capslock", "VK_CONFIG_FORCE_ON_notsave_private_capslock_on"]
+      end
+
+      item "CapsLock OFF", config_only: "notsave.private_capslock_on" do
+        remap "Cmd-L", to: ["capslock", "VK_CONFIG_FORCE_OFF_notsave_private_capslock_on"]
+      end
+
+      item "CapsLock Mode" do
+        identifier "notsave.private_capslock_on", vk_config: "true"
+        show_message "CapsLock"
+      end
+    EOS
+
+    expect_result(<<-EOS.unindent)
+      <?xml version="1.0"?>
+      <root>
+        <item>
+          <name>CapsLock ON</name>
+          <identifier>remap.capslock_on</identifier>
+          <config_not>notsave.private_capslock_on</config_not>
+          <autogen>__KeyToKey__ KeyCode::L, VK_COMMAND, KeyCode::CAPSLOCK, KeyCode::VK_CONFIG_FORCE_ON_notsave_private_capslock_on</autogen>
+        </item>
+
+        <item>
+          <name>CapsLock OFF</name>
+          <identifier>remap.capslock_off</identifier>
+          <config_only>notsave.private_capslock_on</config_only>
+          <autogen>__KeyToKey__ KeyCode::L, VK_COMMAND, KeyCode::CAPSLOCK, KeyCode::VK_CONFIG_FORCE_OFF_notsave_private_capslock_on</autogen>
+        </item>
+
+        <item>
+          <name>CapsLock Mode</name>
+          <identifier vk_config="true">notsave.private_capslock_on</identifier>
+          <autogen>__ShowStatusMessage__ CapsLock</autogen>
+        </item>
+      </root>
+    EOS
+  end
+
+  it "accepts implicit autogen selection" do
+    prepare_dotremap(<<-EOS)
+      item "Control+LeftClick to Command+LeftClick" do
+        autogen "__PointingButtonToPointingButton__ PointingButton::LEFT, MODIFIERFLAG_EITHER_LEFT_OR_RIGHT_CONTROL, PointingButton::LEFT, MODIFIERFLAG_EITHER_LEFT_OR_RIGHT_COMMAND"
+      end
+    EOS
+
+    expect_result(<<-EOS.unindent)
+      <?xml version="1.0"?>
+      <root>
+        <item>
+          <name>Control+LeftClick to Command+LeftClick</name>
+          <identifier>remap.control_leftclick_to_command_leftclick</identifier>
+          <autogen>__PointingButtonToPointingButton__ PointingButton::LEFT, MODIFIERFLAG_EITHER_LEFT_OR_RIGHT_CONTROL, PointingButton::LEFT, MODIFIERFLAG_EITHER_LEFT_OR_RIGHT_COMMAND</autogen>
+        </item>
+      </root>
+    EOS
+  end
+
+  it "application invoking" do
+    prepare_dotremap(<<-EOS)
+      item "Application shortcuts" do
+        remap "C-o", to: invoke("YoruFukurou")
+        remap "C-u", to: invoke("Google Chrome")
+        remap "C-h", to: invoke("iTerm")
+      end
+
+      item "duplicate app" do
+        remap "C-a", to: invoke("YoruFukurou")
+      end
+    EOS
+
+    expect_result(<<-EOS.unindent)
+      <?xml version="1.0"?>
+      <root>
+        <item>
+          <name>Application shortcuts</name>
+          <identifier>remap.application_shortcuts</identifier>
+          <autogen>__KeyToKey__ KeyCode::O, VK_CONTROL, KeyCode::VK_OPEN_URL_APP_YoruFukurou</autogen>
+          <autogen>__KeyToKey__ KeyCode::U, VK_CONTROL, KeyCode::VK_OPEN_URL_APP_Google_Chrome</autogen>
+          <autogen>__KeyToKey__ KeyCode::H, VK_CONTROL, KeyCode::VK_OPEN_URL_APP_iTerm</autogen>
+        </item>
+
+        <item>
+          <name>duplicate app</name>
+          <identifier>remap.duplicate_app</identifier>
+          <autogen>__KeyToKey__ KeyCode::A, VK_CONTROL, KeyCode::VK_OPEN_URL_APP_YoruFukurou</autogen>
+        </item>
+
+        <vkopenurldef>
+          <name>KeyCode::VK_OPEN_URL_APP_YoruFukurou</name>
+          <url type="file">/Applications/YoruFukurou.app</url>
+        </vkopenurldef>
+
+        <vkopenurldef>
+          <name>KeyCode::VK_OPEN_URL_APP_Google_Chrome</name>
+          <url type="file">/Applications/Google Chrome.app</url>
+        </vkopenurldef>
+
+        <vkopenurldef>
+          <name>KeyCode::VK_OPEN_URL_APP_iTerm</name>
+          <url type="file">/Applications/iTerm.app</url>
+        </vkopenurldef>
+      </root>
+    EOS
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require "dotremap"
+require "pry"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dotremap
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Takashi Kokubun
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-25 00:00:00.000000000 Z
+date: 2014-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -26,6 +26,34 @@ dependencies:
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.3.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -52,7 +80,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-description: Configuration DSL for KeyRemap4MacBook
+description: Lightweight keyremap configuration DSL for Karabiner
 email:
 - takashikkbn@gmail.com
 executables:
@@ -61,24 +89,34 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/dotremap
 - dotremap.gemspec
-- example.rb
+- img/disabled.png
+- img/enabled.png
 - lib/dotremap.rb
 - lib/dotremap/appdef.rb
 - lib/dotremap/dsl.rb
 - lib/dotremap/dsl/item.rb
 - lib/dotremap/dsl/root.rb
 - lib/dotremap/item.rb
+- lib/dotremap/karabiner.rb
+- lib/dotremap/key.rb
 - lib/dotremap/openurl.rb
 - lib/dotremap/property.rb
 - lib/dotremap/remap.rb
 - lib/dotremap/root.rb
 - lib/dotremap/version.rb
+- spec/lib/dotremap/appdef_spec.rb
+- spec/lib/dotremap/key_spec.rb
+- spec/lib/dotremap/remap_spec.rb
+- spec/lib/dotremap_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/k0kubun/dotremap
 licenses:
 - MIT
@@ -102,5 +140,10 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Configuration DSL for KeyRemap4MacBook
-test_files: []
+summary: Lightweight keyremap configuration DSL
+test_files:
+- spec/lib/dotremap/appdef_spec.rb
+- spec/lib/dotremap/key_spec.rb
+- spec/lib/dotremap/remap_spec.rb
+- spec/lib/dotremap_spec.rb
+- spec/spec_helper.rb

data/example.rb

@@ -1,135 +0,0 @@
-item "[Not Terminal] Command+O|P to Command+{|} (US)", not: "TERMINAL" do
-  remap "Cmd-P", to: "Cmd-Shift-]"
-  remap "Cmd-O", to: "Cmd-Shift-["
-end
-
-item "[Only Terminal] Command+O|P to Option+{|} (US)", only: "TERMINAL" do
-  remap "Cmd-P", to: "Opt-Shift-]"
-  remap "Cmd-O", to: "Opt-Shift-["
-end
-
-item "[Not Terminal] Command+E to Command+W", not: "TERMINAL" do
-  remap "Cmd-E", to: "Cmd-W"
-end
-
-item "[Only Terminal] Command+T to Option+T, Command+E to Option+E", only: "TERMINAL" do
-  remap "Cmd-T", to: "Opt-T"
-  remap "Cmd-E", to: "Opt-E"
-end
-
-# For tmux copy mode
-item "[Only Terminal] Command+I to Option+I", only: "TERMINAL" do
-  remap "Cmd-I", to: "Opt-I"
-end
-
-item "Command_L to Control_R" do
-  remap "Cmd_L", to: "Ctrl_R"
-end
-
-# Change japanese input mode by Cmd_L + Space
-item "Exchange Control + Space and Command + Space" do
-  remap "C-Space", to: "Cmd-Space"
-  remap "Cmd-Space", to: "C-Space"
-end
-
-item "CapsLock ON", config_not: "notsave.private_capslock_on" do
-  remap "Cmd-L", to: ["capslock", "VK_CONFIG_FORCE_ON_notsave_private_capslock_on"]
-end
-
-item "CapsLock OFF", config_only: "notsave.private_capslock_on" do
-  remap "Cmd-L", to: ["capslock", "VK_CONFIG_FORCE_OFF_notsave_private_capslock_on"]
-end
-
-item "CapsLock Mode" do
-  identifier "notsave.private_capslock_on", vk_config: "true"
-  show_message "CapsLock"
-end
-
-item "[Not Terminal] Control+PNBF to Up/Down/Left/Right", not: "TERMINAL" do
-  remap "C-p", to: "Up"
-  remap "C-n", to: "Down"
-  remap "C-b", to: "Left"
-  remap "C-f", to: "Right"
-end
-
-# Use Cmd_R+D as M-d
-item "[Not Terminal] Command+D to Option+Forward Delete", not: "TERMINAL" do
-  remap "Cmd-D", to: "Opt-forward_delete"
-end
-
-item "[Only Terminal] Command+D to Option+D, Command+BF to Option+BF", only: "TERMINAL" do
-  remap "Cmd-D", to: "M-d"
-  remap "Cmd-B", to: "M-b"
-  remap "Cmd-F", to: "M-f"
-end
-
-# Use Cmd_R+B/F as M-b/f, and Cmd_R+S as Cmd+F to avoid conflict with M-f
-item "[Not Terminal] Command+B/F to Option+Left/Right, Command+S to Command+F", not: "TERMINAL" do
-  remap "Cmd-B", to: "Opt-Left"
-  remap "Cmd-F", to: "Opt-Right"
-  remap "Cmd-S", to: "Cmd-F"
-end
-
-item "[Not Terminal] Control+W to Option+Delete", not: "TERMINAL" do
-  remap "C-w", to: "Opt-delete"
-end
-
-item "Control+LeftClick to Command+LeftClick" do
-  autogen "__PointingButtonToPointingButton__ PointingButton::LEFT, MODIFIERFLAG_EITHER_LEFT_OR_RIGHT_CONTROL, PointingButton::LEFT, MODIFIERFLAG_EITHER_LEFT_OR_RIGHT_COMMAND"
-end
-
-item "[Not Terminal] Chrome inspector Command+Control+I", not: "TERMINAL" do
-  remap "Cmd-Ctrl-I", to: "Cmd-Opt-i"
-end
-
-# browser reload
-item "[Not Terminal] Control-R -> Command-R", not: "TERMINAL" do
-  remap "C-r", to: "Cmd-R"
-end
-
-# tmux prefix
-item "[Only Terminal] Command-R -> Option-R", only: "TERMINAL" do
-  remap "Cmd-R", to: "M-r"
-end
-
-# I don't want to press shift key
-item "Command semicolon to colon" do
-  remap "Cmd-;", to: "Shift-;"
-end
-
-item "Shift by control" do
-  remap "C--", to: "Shift--"
-  remap "C-0", to: "Shift-0"
-  remap "C-9", to: "Shift-9"
-  remap "C-8", to: "Shift-8"
-  remap "C-7", to: "Shift-7"
-  remap "C-6", to: "Shift-6"
-  remap "C-[", to: "Shift-["
-  remap "C-]", to: "Shift-]"
-  remap "C-;", to: "Shift-;"
-  remap "C-,", to: "Shift-,"
-  remap "C-.", to: "Shift-."
-  remap "C-/", to: "Shift-/"
-  remap "C-=", to: "Shift-="
-  remap "C-\\", to: "Shift-\\"
-end
-
-item "Exchange single quote and double quote" do
-  remap "Shift-'", to: "'"
-  remap "'", to: "Shift-'"
-end
-
-item "[Only Terminal] Command+A to Option+A", only: "TERMINAL" do
-  remap "Cmd-A", to: "M-a"
-end
-
-item "Disable Command-W" do
-  remap "Cmd-W", to: "w"
-end
-
-appdef "YORUFUKUROU", equal: "com.YoruFukurouProject.YoruFukurou"
-
-item "YoruFukurou Account Change", only: "YORUFUKUROU" do
-  remap "Cmd-K", to: "Cmd-Opt-Up"
-  remap "Cmd-J", to: "Cmd-Opt-Down"
-end