karabiner 0.1.0

data/lib/karabiner/xml_tree.rb

@@ -0,0 +1,42 @@
+module Karabiner::XmlTree
+  attr_reader :parent
+
+  def add_child(*objects)
+    objects.each do |object|
+      childs << object
+    end
+
+    childs.each do |child|
+      child.parent = self
+    end
+  end
+
+  def search_childs(klass)
+    childs.select { |c| c.is_a?(klass) }
+  end
+
+  def to_xml(distance_between_childs = 0)
+    tag_name = self.class.to_s.split("::").last.downcase
+    newline_count = distance_between_childs + 1
+
+    [
+      "<#{tag_name}>",
+      childs.map(&:to_xml).join("\n" * newline_count).gsub(/^/, "  "),
+      "</#{tag_name}>",
+    ].join("\n")
+  end
+
+  protected
+
+  attr_writer :parent
+
+  private
+
+  def childs
+    @childs ||= []
+  end
+
+  def parent
+    @parent
+  end
+end

data/lib/karabiner.rb

@@ -0,0 +1,56 @@
+require "karabiner/cli"
+require "karabiner/version"
+require "karabiner/root"
+require "unindent"
+require "fileutils"
+
+class Karabiner
+  XML_FILE_NAME = "private.xml"
+  XML_DIR = File.expand_path("~/Library/Application Support/Karabiner")
+
+  def initialize(config_path)
+    @config_path = config_path
+    Karabiner::InvokeHistory.clear_histroy
+  end
+  attr_reader :config_path
+
+  def apply_configuration
+    replace_private_xml
+    CLI.reload_xml
+
+    puts "Successfully updated Karabiner configuration"
+  end
+
+  private
+
+  def replace_private_xml
+    FileUtils.mkdir_p(XML_DIR)
+
+    xml_path = File.join(XML_DIR, XML_FILE_NAME)
+    File.write(xml_path, new_xml)
+  end
+
+  def new_xml
+    return @new_xml if defined?(@new_xml)
+    validate_config_existence
+
+    root = Root.new
+    config = File.read(config_path)
+    root.instance_eval(config)
+    @new_xml = root.to_xml.gsub(/ *$/, "").concat("\n")
+  end
+
+  def validate_config_existence
+    return if File.exists?(config_path)
+
+    File.write(config_path, <<-EOS.unindent)
+      #!/usr/bin/env ruby
+
+      # # Example
+      # item "Command+E to Command+W", not: "TERMINAL" do
+      #   identifier "option.not_terminal_opt_e"
+      #   autogen "__KeyToKey__ KeyCode::E, VK_COMMAND, KeyCode::W, ModifierFlag::COMMAND_L"
+      # end
+    EOS
+  end
+end

data/spec/lib/dotremap/appdef_spec.rb

@@ -0,0 +1,35 @@
+require "spec_helper"
+
+describe Karabiner::Appdef do
+  describe "#to_xml" do
+    it "returns valid xml from appdef with equal" do
+      appdef = Karabiner::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 = Karabiner::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 = Karabiner::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/karabiner_spec.rb

@@ -0,0 +1,29 @@
+require "spec_helper"
+
+describe Karabiner::CLI do
+  describe ".current_config" do
+    subject { described_class.current_config }
+
+    let(:cli_path) { Karabiner::CLI::CLI_PATH }
+
+    before do
+      allow_any_instance_of(Kernel).to receive(:'`').with("#{cli_path} changed").and_return(<<-EOS.unindent)
+        remap.command_k_to_command_l=1
+        repeat.initial_wait=100
+        repeat.wait=20
+        option.terminal_command_option=1
+        notsave.automatically_enable_keyboard_device=1
+      EOS
+    end
+
+    it "returns config hash" do
+      expect(subject).to eq({
+        "option.terminal_command_option"               => "1",
+        "remap.command_k_to_command_l"                 => "1",
+        "repeat.initial_wait"                          => "100",
+        "repeat.wait"                                  => "20",
+        "notsave.automatically_enable_keyboard_device" => "1",
+      })
+    end
+  end
+end

data/spec/lib/dotremap/key_spec.rb

@@ -0,0 +1,113 @@
+require "spec_helper"
+
+describe Karabiner::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",
+      "Shift_R" => "KeyCode::SHIFT_R",
+      "Shift_L" => "KeyCode::SHIFT_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
+      Karabiner::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 = Karabiner::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 Karabiner::Remap do
+  describe "#to_xml" do
+    it "converts key remap to autogen tag" do
+      expect(Karabiner::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,335 @@
+require "spec_helper"
+require "tempfile"
+
+describe Karabiner do
+  let!(:config) { Tempfile.new(".karabiner") }
+  let(:xml_dir) { "/tmp" }
+  let(:xml_path) { File.join(xml_dir, Karabiner::XML_FILE_NAME) }
+  let(:result) { File.read(xml_path) }
+
+  before do
+    stub_const("Karabiner::XML_DIR", xml_dir)
+    allow(Karabiner::CLI).to receive(:reload_xml)
+
+    # Silence stdout
+    allow_any_instance_of(Kernel).to receive(:puts)
+  end
+
+  after do
+    config.close!
+  end
+
+  def prepare_karabiner(karabiner)
+    config.write(karabiner)
+    config.rewind
+  end
+
+  def expect_result(expected_result)
+    karabiner = Karabiner.new(config.path)
+    karabiner.apply_configuration
+    expect(result).to eq(expected_result)
+  end
+
+  it "accepts blank config" do
+    prepare_karabiner("")
+
+    expect_result(<<-EOS.unindent)
+      <?xml version="1.0"?>
+      <root>
+
+      </root>
+    EOS
+  end
+
+  it "accepts cmd combination" do
+    prepare_karabiner(<<-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_karabiner(<<-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_karabiner(<<-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_karabiner(<<-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_karabiner(<<-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_karabiner(<<-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_karabiner(<<-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
+
+  it "accepts group items" do
+    prepare_karabiner(<<-EOS)
+      group "Option" do
+        item "First" do
+          identifier "option.option_first"
+        end
+
+        item "Second" do
+          identifier "option.option_second"
+        end
+      end
+    EOS
+
+    expect_result(<<-EOS.unindent)
+      <?xml version="1.0"?>
+      <root>
+        <item>
+          <name>Option</name>
+          <item>
+            <name>First</name>
+            <identifier>option.option_first</identifier>
+          </item>
+          <item>
+            <name>Second</name>
+            <identifier>option.option_second</identifier>
+          </item>
+        </item>
+      </root>
+    EOS
+  end
+
+  context "when items are surrounded by config" do
+    it "accepts cmd combination" do
+      prepare_karabiner(<<-EOS)
+        config "Default" do
+          item "Command+A to Command+B" do
+            remap "Cmd-A", to: "Cmd-B"
+          end
+        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 group items" do
+      prepare_karabiner(<<-EOS)
+        config "Original" do
+          group "Option" do
+            item "First" do
+              identifier "option.option_first"
+            end
+
+            item "Second" do
+              identifier "option.option_second"
+            end
+          end
+        end
+      EOS
+
+      expect_result(<<-EOS.unindent)
+        <?xml version="1.0"?>
+        <root>
+          <item>
+            <name>Option</name>
+            <item>
+              <name>First</name>
+              <identifier>option.option_first</identifier>
+            </item>
+            <item>
+              <name>Second</name>
+              <identifier>option.option_second</identifier>
+            </item>
+          </item>
+        </root>
+      EOS
+    end
+  end
+end

data/spec/spec_helper.rb

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