keyremac 0.0.1 → 0.0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 56a85964a7ed2a53cffef78bb058925b6af0cd59
-  data.tar.gz: cb87ed2b0ef6002a218c859f04f502c671260bb9
+  metadata.gz: e396e7b7adb1000fc741d5c0e9523d4f85c2770c
+  data.tar.gz: 8a6a3dbc853f7e6e6610dd5aa83845f0b24d25a8
 SHA512:
-  metadata.gz: e8ff12e76d5080364666e61023c6269e0f91198aafce3f602fe50766201f2e48a1989440e45d1b622f5c0aa1587f7dad17f7a0c77970555dc775757a6da2f560
-  data.tar.gz: f952a9b53d7d7a49e79e213e694b8ba5c20bfdba34e04cadc3fa662d7a5bab44daa6c11ea552fe4f2aa595b9557a7a61117d34433e184edb4c586e4877606cab
+  metadata.gz: 34b2966dc0dc2d735ff6dbeb17870c24464503493872d02a09278b15ada32812fa8703df1c2239f3d0d6c3f678ce330e1add475fb64bdce5a5aaedd57e892255
+  data.tar.gz: c08e1f5d867974e8f11cdea777aad2b7051884da4b3b999c1258f1f7d5029f6bf717b8a0c2eb2f6769add8f4f3718852f0e5530424f9cd44642b11a5f52da700

data/README.ja.md

@@ -0,0 +1,100 @@
+# Keyremac
+
+[![Build Status](https://travis-ci.org/keqh/keyremac.png?branch=master)](https://travis-ci.org/keqh/keyremac)
+
+*Keyremac*はRubyでKeyRemap4MacBookの設定を行うgemです。
+- 大量のcheckboxを扱うのが苦手な方や
+- XMLを手で編集するのが好きではない方向けに
+KeyRemap4MacBookの設定を行うDSLを提供します。
+
+## dependency
+
+- KeyRemap4MacBook v7.0.0+
+    - https://pqrs.org/macosx/keyremap4macbook/
+- ruby v2.0.0+
+
+## Installation
+
+    $ gem install keyremac --source http://github.com/keqh/keyremac/raw/master
+
+## Getting Started
+
+```bash
+$ cat > private.rb
+require 'keyremac'
+:SPACE .to :TAB
+
+$ ruby private.rb --dump
+<?xml version="1.0" encoding="UTF-8"?>
+<root>
+  <item>
+    <name>root_item</name>
+    <identifier>private.root_item</identifier>
+    <autogen>__KeyToKey__ KeyCode::SPACE, KeyCode::TAB</autogen>
+    <autogen>__KeyToKey__ KeyCode::TAB, KeyCode::SPACE</autogen>
+    <autogen>__KeyToKey__ KeyCode::COMMAND_R, KeyCode::ESCAPE</autogen>
+  </item>
+</root>
+
+$ ruby private.rb --reload
+```
+
+## Examples
+
+### simple KeyToKey
+
+```rb
+:SPACE .to :TAB
+```
+
+### mods (cmd, ctrl, opt, shift, none)
+
+```rb
+:m.cmd .to :VK_NONE
+:j.ctrl .to :JIS_KANA
+```
+
+### key to keys
+
+```rb
+:n.ctrl.cmd .to :JIS_EISUU, '['.cmd.shift
+:p.ctrl.cmd .to :JIS_EISUU, ']'.cmd.shift
+```
+
+### app_only
+
+```rb
+app "CHROME" do
+  :m.cmd.none .to :VK_NONE
+end
+
+# or
+
+item app: "CHORME" do
+  ...
+end
+```
+
+### inputsource_only
+
+```
+item inputsource: "JAPANESE" do
+  :l .to :JIS_EISUU
+end
+```
+
+### raw
+
+```
+item_ do
+  name_ 'jis_to_us'
+  identifier_ 'private.jis_to_us'
+  autogen_ "__SetKeyboardType__ KeyboardType::MACBOOK"
+  :JIS_YEN .to :BACKQUOTE
+  :JIS_UNDERSCORE .to :BACKQUOTE
+end
+```
+
+- more examples: https://github.com/keqh/keyremac/tree/master/samples
+- and specs: https://github.com/keqh/keyremac/tree/master/spec
+

data/README.md

@@ -1,29 +1,97 @@
 # Keyremac
 
-TODO: Write a gem description
+[![Build Status](https://travis-ci.org/keqh/keyremac.png?branch=master)](https://travis-ci.org/keqh/keyremac)
+
+Keyremac is KeyRemap4MacBook settings generator.
+
+## dependency
+
+- KeyRemap4MacBook v7.0.0+
+    - https://pqrs.org/macosx/keyremap4macbook/
+- ruby v2.0.0+
 
 ## Installation
 
-Add this line to your application's Gemfile:
+    $ gem install keyremac
 
-    gem 'keyremac'
+## Getting Started
 
-And then execute:
+```bash
+$ cat > private.rb
+require 'keyremac'
+:SPACE .to :TAB
 
-    $ bundle
+$ ruby private.rb --dump
+<?xml version="1.0" encoding="UTF-8"?>
+<root>
+  <item>
+    <name>root_item</name>
+    <identifier>private.root_item</identifier>
+    <autogen>__KeyToKey__ KeyCode::SPACE, KeyCode::TAB</autogen>
+    <autogen>__KeyToKey__ KeyCode::TAB, KeyCode::SPACE</autogen>
+    <autogen>__KeyToKey__ KeyCode::COMMAND_R, KeyCode::ESCAPE</autogen>
+  </item>
+</root>
 
-Or install it yourself as:
+$ ruby private.rb --reload
+```
 
-    $ gem install keyremac
+## Examples
+
+### simple KeyToKey
+
+```rb
+:SPACE .to :TAB
+```
+
+### mods (cmd, ctrl, opt, shift, none)
+
+```rb
+:m.cmd .to :VK_NONE
+:j.ctrl .to :JIS_KANA
+```
+
+### key to keys
+
+```rb
+:n.ctrl.cmd .to :JIS_EISUU, '['.cmd.shift
+:p.ctrl.cmd .to :JIS_EISUU, ']'.cmd.shift
+```
+
+### app_only
+
+```rb
+app "CHROME" do
+  :m.cmd.none .to :VK_NONE
+end
+
+# or
+
+item app: "CHORME" do
+  ...
+end
+```
+
+### inputsource_only
+
+```
+item inputsource: "JAPANESE" do
+  :l .to :JIS_EISUU
+end
+```
 
-## Usage
+### raw
 
-TODO: Write usage instructions here
+```
+item_ do
+  name_ 'jis_to_us'
+  identifier_ 'private.jis_to_us'
+  autogen_ "__SetKeyboardType__ KeyboardType::MACBOOK"
+  :JIS_YEN .to :BACKQUOTE
+  :JIS_UNDERSCORE .to :BACKQUOTE
+end
+```
 
-## Contributing
+- more examples: https://github.com/keqh/keyremac/tree/master/samples
+- and specs: https://github.com/keqh/keyremac/tree/master/spec
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request

data/keyremac.gemspec

@@ -20,7 +20,6 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "awesome_print"
 
   spec.add_dependency "builder"
 end

data/lib/keyremac.rb

@@ -37,6 +37,7 @@ module Keyremac
       op.on('--dump', 'dump private.xml') { Keyremac::dump }
       op.on('--reload', 'reload private.xml') { Keyremac::reload }
       op.on('--ids', 'collect identifiers') { puts Keyremac::collect_identifiers }
+      op.on('--test', 'test') { `touch ~/test.txt` }
       }.parse!(ARGV.dup)
   end
 end

data/lib/keyremac/base.rb

@@ -1,47 +1,45 @@
-require 'awesome_print'
 require 'builder'
 
 require 'keyremac/key'
 
 module Keyremac
-  # focus
-  # ====================================
+  module Focus
+    @@focus = []
 
-  @@focus = []
+    def self.add(rule)
+      @@focus.last.add rule
+    end
 
-  def self.focus
-    @@focus
-  end
+    def self.focus
+      @@focus
+    end
 
-  def self.get_focus
-    @@focus.last
-  end
-  def self.set_focus(container, &block)
-    @@focus.push container
-    yield
-    @@focus.pop
+    def self.set_focus(container, &block)
+      @@focus.push container
+      yield
+      @@focus.pop
+    end
   end
 
-  # autogen
-  # ====================================
-
-  class KeyToKey < Struct.new(:from, :to); end
-  class KeyToConsumer < Struct.new(:from, :to); end
-  class KeyOverlaidModifier # < Struct.new(:key, :mod, :keys)
-    attr_reader :key, :mod, :keys, :repeat
-    def initialize(key, mod, keys: [], repeat: false)
-      @key = key
-      @mod = mod
-      @keys = keys == [] ? [key] : keys
-      @repeat = repeat
-    end
+  module Autogen
+    class KeyToKey < Struct.new(:from, :to); end
+    class KeyToConsumer < Struct.new(:from, :to); end
+    class KeyOverlaidModifier
+      attr_reader :key, :mod, :keys, :repeat
+      def initialize(key, mod, keys: [], repeat: false)
+        @key = key
+        @mod = mod
+        @keys = keys == [] ? [key] : keys
+        @repeat = repeat
+      end
 
-    def repeat?
-      @repeat
+      def repeat?
+        @repeat
+      end
     end
   end
 
-  # container
+  # @group container
   # ====================================
 
   module Container
@@ -56,7 +54,7 @@ module Keyremac
       if method_name[-1] == '_'
         raw = Raw.new method_name.chomp('_')
         if block
-          Keyremac.set_focus raw do
+          Keyremac::Focus.set_focus raw do
             raw.instance_eval(&block)
           end
         else
@@ -103,22 +101,29 @@ module Keyremac
 
     def initialize
       @root_item = Item.new 'root_item'
-      Keyremac.focus.clear
-      Keyremac.focus << @root_item
+      Keyremac::Focus.focus.clear
+      Keyremac::Focus.focus << @root_item
       @children = []
     end
 
+    # @param [String] app only tag
+    # @param [String] inputsource inputsource_only tag
+    # yield [] children
+    # @return [Item]
     def item(app: nil, inputsource: nil, &block)
       Item.new.tap { |item|
         item.only_ app if app
         item.inputsource_only_ inputsource if inputsource
         @children << item
-        Keyremac.set_focus item do
+        Keyremac::Focus.set_focus item do
           item.instance_eval(&block)
         end
       }
     end
 
+    # @param [String] only
+    # @option options same as item method
+    # @return [Item]
     def app(only, **options, &block)
       options[:app] = only
       item(**options, &block)
@@ -135,8 +140,8 @@ module Keyremac
       @@root
     end
 
-    def method_missing(method_name, *args, &block)
-      @@root.send(method_name, *args, &block)
+    def method_missing(*args, &block)
+      @@root.send(*args, &block)
     end
   end
 end

data/lib/keyremac/constants.rb

@@ -0,0 +1,49 @@
+module Keyremac
+  CONSUMER_KEYS = [
+    'BRIGHTNESS_DOWN',
+    'BRIGHTNESS_UP',
+    'KEYBOARDLIGHT_OFF',
+    'KEYBOARDLIGHT_LOW',
+    'KEYBOARDLIGHT_HIGH',
+    'MUSIC_PREV',
+    'MUSIC_PLAY',
+    'MUSIC_NEXT',
+    'MUSIC_PREV_18',
+    'MUSIC_NEXT_17',
+    'VOLUME_MUTE',
+    'VOLUME_DOWN',
+    'VOLUME_UP',
+    'EJECT',
+    'POWER',
+    'NUMLOCK',
+    'VIDEO_MIRROR',
+  ]
+
+  SYMBOL_TABLE = {
+    '`'  => 'BACKQUOTE',
+    '\\' => 'BACKSLASH',
+    '['  => 'BRACKET_LEFT',
+    ']'  => 'BRACKET_RIGHT',
+    ','  => 'COMMA',
+    '.'  => 'DOT',
+    '='  => 'EQUAL',
+    '-'  => 'MINUS',
+    '\'' => 'QUOTE',
+    ';'  => 'SEMICOLON',
+    '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',
+  }
+
+  SHIFT_TABLE = Hash[
+    %q[!@#$%^&*()_+~QWERTYUIOP{}ASDFGHJKL:"|ZXCVBNM<>?~].each_char.to_a.zip(
+    %q(1234567890-=`qwertyuiop[]asdfghjkl;'\zxcvbnm,./`).each_char.to_a
+  )]
+end

data/lib/keyremac/dump.rb

@@ -1,5 +1,7 @@
-module Keyremac
 
+require 'keyremac/base'
+
+module Keyremac
   # key
   # ===========================
 
@@ -32,24 +34,26 @@ module Keyremac
   # autogen
   # ===========================
 
-  class KeyToKey
-    def dump(xml)
-      seqs = [from, *to].map{ |k| k.dump(xml) }.join(', ')
-      xml.autogen "__KeyToKey__ #{seqs}"
+  module Autogen
+    class KeyToKey
+      def dump(xml)
+        seqs = [from, *to].map{ |k| k.dump(xml) }.join(', ')
+        xml.autogen "__KeyToKey__ #{seqs}"
+      end
     end
-  end
 
-  class KeyToConsumer
-    def dump(xml)
-      xml.autogen "__KeyToConsumer__ #{from.dump(xml)}, #{to.dump(xml)}"
+    class KeyToConsumer
+      def dump(xml)
+        xml.autogen "__KeyToConsumer__ #{from.dump(xml)}, #{to.dump(xml)}"
+      end
     end
-  end
 
-  class KeyOverlaidModifier
-    def dump(xml)
-      seqs = [key, mod, *keys].map { |k| k.dump(xml) }.join(', ')
-      autogen = repeat ? '__KeyOverlaidModifierWithRepeat__' : '__KeyOverlaidModifier__'
-      xml.autogen "#{autogen} #{seqs}"
+    class KeyOverlaidModifier
+      def dump(xml)
+        seqs = [key, mod, *keys].map { |k| k.dump(xml) }.join(', ')
+        autogen = repeat ? '__KeyOverlaidModifierWithRepeat__' : '__KeyOverlaidModifier__'
+        xml.autogen "#{autogen} #{seqs}"
+      end
     end
   end
 

data/lib/keyremac/key.rb

@@ -1,58 +1,10 @@
 
 require 'keyremac/base'
+require 'keyremac/constants'
 
 require 'set'
 
 module Keyremac
-
-  CONSUMER_KEYS = [
-    'BRIGHTNESS_DOWN',
-    'BRIGHTNESS_UP',
-    'KEYBOARDLIGHT_OFF',
-    'KEYBOARDLIGHT_LOW',
-    'KEYBOARDLIGHT_HIGH',
-    'MUSIC_PREV',
-    'MUSIC_PLAY',
-    'MUSIC_NEXT',
-    'MUSIC_PREV_18',
-    'MUSIC_NEXT_17',
-    'VOLUME_MUTE',
-    'VOLUME_DOWN',
-    'VOLUME_UP',
-    'EJECT',
-    'POWER',
-    'NUMLOCK',
-    'VIDEO_MIRROR',
-  ]
-
-  SYMBOL_TABLE = {
-    '`'  => 'BACKQUOTE',
-    '\\' => 'BACKSLASH',
-    '['  => 'BRACKET_LEFT',
-    ']'  => 'BRACKET_RIGHT',
-    ','  => 'COMMA',
-    '.'  => 'DOT',
-    '='  => 'EQUAL',
-    '-'  => 'MINUS',
-    '\'' => 'QUOTE',
-    ';'  => 'SEMICOLON',
-    '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',
-  }
-
-  SHIFT_TABLE = Hash[
-    %q[!@#$%^&*()_+~QWERTYUIOP{}ASDFGHJKL:"|ZXCVBNM<>?~].each_char.to_a.zip(
-    %q(1234567890-=`qwertyuiop[]asdfghjkl;'\zxcvbnm,./`).each_char.to_a
-  )]
-
   module Keyable
     {
       ctrl:   :VK_CONTROL,
@@ -66,21 +18,28 @@ module Keyremac
       define_method("#{k}?", -> { self.to_key.mods.include? v })
     }
 
+    def add_rule(autogen)
+      Keyremac::Focus.add autogen
+      autogen
+    end
+
+    # @param [Array<Keyable>] keys
+    # @return [KeyToKey]
+    # @return [KeyToConsumer]
     def to(*keys)
       key = keys.first.to_key
-      autogen = if key.consumer_key?
-        Keyremac::KeyToConsumer.new self.to_key, key
+      if key.consumer_key?
+        add_rule Autogen::KeyToConsumer.new(self.to_key, key)
       else
-        Keyremac::KeyToKey.new self.to_key, keys.map(&:to_key)
+        add_rule Autogen::KeyToKey.new(self.to_key, keys.map(&:to_key))
       end
-      Keyremac.get_focus.add autogen
-      autogen
     end
 
+    # @param [Keyable] mod
+    # @options [Keyable] mod
+    # @return [KeyToOverlaidModifier]
     def overlaid(mod, keys: [], repeat: false)
-      autogen = Keyremac::KeyOverlaidModifier.new self.to_key, mod.to_key, keys: keys.map(&:to_key), repeat: repeat
-      Keyremac.get_focus.add autogen
-      autogen
+      add_rule Autogen::KeyOverlaidModifier.new(self.to_key, mod.to_key, keys: keys.map(&:to_key), repeat: repeat)
     end
 
     def consumer_key?

data/lib/keyremac/version.rb

@@ -1,3 +1,3 @@
 module Keyremac
-  VERSION = "0.0.1"
+  VERSION = "0.0.2.1"
 end

data/samples/sample.rb

@@ -1,4 +1,4 @@
-
+#!/usr/bin/env ruby -I ../lib -I lib
 require 'keyremac'
 
 item_ do
@@ -65,3 +65,13 @@ end
 app 'SUBLIME', inputsource: 'JAPANESE' do
   :TAB .to :i.ctrl
 end
+
+# item do
+#   autogen_ "__KeyToKey__ KeyCode::Q, KeyCode::VK_OPEN_URL_SCRIPT_test"
+# end
+
+# vkopenurldef_ do
+#   name_ "KeyCode::VK_OPEN_URL_SCRIPT_test"
+#   url_ "file:///Users/keqh/Dropbox/personal/projects/KEYnoe/keyremac/samples/sample.rb --test"
+# end
+

data/spec/dump_spec.rb

@@ -1,6 +1,5 @@
 
 require 'minitest/autorun'
-require 'keyremac/base'
 require 'keyremac/dump'
 
 module MiniTest::Assertions
@@ -9,17 +8,42 @@ module MiniTest::Assertions
     actual = rule.dump(xml)
     assert actual == expected, message { diff expected, actual }
   end
+
+  def assert_item(expected, rule)
+    expected = <<-EOI
+<item>
+  <name>a</name>
+  <identifier>private.a</identifier>
+  #{expected}
+</item>
+    EOI
+    xml = Builder::XmlMarkup.new(indent: 2)
+    actual = rule.dump(xml)
+    assert actual == expected, message { diff expected, actual }
+  end
+
+  def assert_autogen(expected, rule)
+    xml = Builder::XmlMarkup.new(indent: 2)
+    actual = rule.dump(xml)
+    assert_match("autogen", actual)
+    assert_match(expected, actual)
+  end
+
+  def assert_tag(expected, rule)
+    xml = Builder::XmlMarkup.new(indent: 2)
+    actual = rule.dump(xml)
+    assert_match(expected, actual)
+  end
 end
 Object.infect_an_assertion :assert_xml, :must_be_xml
+Object.infect_an_assertion :assert_item, :must_be_item
+Object.infect_an_assertion :assert_autogen, :must_be_autogen
+Object.infect_an_assertion :assert_tag, :must_contain_tag
 
-describe 'dump' do
-  before do
-    @root = Keyremac::Root.new
-    @xml = Builder::XmlMarkup.new(indent: 2)
-    Keyremac::Item.reset_identifier
-  end
+describe 'root' do
+  let(:root) { Keyremac::Root.new }
 
-  it 'rootが出力される' do
+  it 'generates root tag' do
     expected = <<-EOR
 <?xml version="1.0" encoding="UTF-8"?>
 <root>
@@ -29,68 +53,30 @@ describe 'dump' do
   </item>
 </root>
     EOR
-    @root.must_be_xml expected
-  end
-
-  it '任意のtagを書くことができる' do
-    expected = "<hoge>\n</hoge>\n"
-    @root.hoge_ {}.must_be_xml expected
+    root.must_be_xml expected
   end
+end
 
-  describe 'item' do
-    ITEM = <<-EOI
-<item>
-  <name>a</name>
-  <identifier>private.a</identifier>
-  %s
-</item>
-    EOI
-
-    it 'blank' do
-      expected = <<-EOI
-<item>
-  <name>a</name>
-  <identifier>private.a</identifier>
-</item>
-      EOI
-      @root.item {}.must_be_xml expected
-    end
-
-    it 'raw' do
-      expected = ITEM % "<autogen>__KeyToKey__ KeyCode::J, KeyCode::K</autogen>"
-      @root.item {
-        autogen_ '__KeyToKey__ KeyCode::J, KeyCode::K'
-      }.must_be_xml expected
-    end
-
-    it 'app' do
-      expected = ITEM % "<only>TERMINAL</only>"
-      @root.item(app: 'TERMINAL') {}.must_be_xml expected
-    end
+describe 'raw' do
+  let(:root) { Keyremac::Root.new }
 
-    it 'inputsource' do
-      expected = ITEM % "<inputsource_only>JAPANESE</inputsource_only>"
-      @root.item(inputsource: 'JAPANESE') {}.must_be_xml expected
-    end
+  it 'can write any tags' do
+    root.hoge_ {}.must_contain_tag "hoge"
+    root.fuga_("").must_contain_tag "fuga"
   end
+end
 
-  describe 'app' do
-    it 'raw' do
-      expected = ITEM % "<only>TERMINAL</only>"
-      @root.app('TERMINAL') {}.must_be_xml expected
-    end
+describe Keyremac::Key do
+  describe '#to' do
+    it { (:j .to :k).must_be_autogen "KeyToKey" }
+    it { (:j .to :k, :l).must_be_autogen "KeyToKey" }
+    it { (:F7.to:MUSIC_PREV).must_be_autogen "KeyToConsumer" }
   end
+end
 
-  describe 'to' do
-    it 'basic' do
-      expected = "<autogen>__KeyToKey__ KeyCode::J, KeyCode::K</autogen>\n"
-      (:j .to :k).must_be_xml expected
-    end
-
-    it '複数' do
-      expected = "<autogen>__KeyToKey__ KeyCode::J, KeyCode::K, KeyCode::L</autogen>\n"
-      (:j .to :k, :l).must_be_xml expected
-    end
+describe 'root' do
+  before do
+    @root = Keyremac::Root.new
   end
 
   ROOT2 = <<-EOR
@@ -104,57 +90,68 @@ describe 'dump' do
 </root>
   EOR
 
-  describe 'root直下' do
-    it 'root直下にautogenを書くとroot_itemに追加される' do
-      :j .to :k
-      expected = ROOT2 % "<autogen>__KeyToKey__ KeyCode::J, KeyCode::K</autogen>"
-      @root.dump.must_equal expected
-    end
+  it 'can write toplevel key definition' do
+    :j .to :k
+    expected = ROOT2 % "<autogen>__KeyToKey__ KeyCode::J, KeyCode::K</autogen>"
+    @root.must_be_xml expected
   end
+end
 
-  describe 'mods' do
-    it 'ctrl' do
-      expected = "KeyCode::J, VK_CONTROL"
-      :j.ctrl.must_be_xml expected
+describe 'dump' do
+  before do
+    @root = Keyremac::Root.new
+    Keyremac::Item.reset_identifier
+  end
+
+  describe 'item' do
+    it 'generates item tag' do
+      contents = '__KeyToKey__ KeyCode::J, KeyCode::K'
+      @root.item { autogen_ contents }.must_be_item "<autogen>#{contents}</autogen>"
+    end
+
+    it 'generates item tag with only tag' do
+      @root.item(app: 'TERMINAL') {}.must_be_item "<only>TERMINAL</only>"
     end
 
-    it 'none' do
-      expected = "KeyCode::J, ModifierFlag::NONE"
-      :j.none.must_be_xml expected
+    it 'generates item tag with inputsource_only tag' do
+      @root.item(inputsource: 'JAPANESE') {}.must_be_item "<inputsource_only>JAPANESE</inputsource_only>"
     end
 
-    it '複数' do
-      expected = "KeyCode::J, VK_CONTROL | VK_COMMAND"
-      :j.ctrl.cmd.must_be_xml expected
+    it 'generates item tag with only tag' do
+      @root.app('TERMINAL') {}.must_be_item "<only>TERMINAL</only>"
     end
   end
 
-  describe 'consumer' do
-    it 'consumer_key' do
-      expected = "ConsumerKeyCode::MUSIC_PREV"
-      :MUSIC_PREV.to_key.must_be_xml expected
+  describe 'mods' do
+    it 'trails mod key' do
+      :j.ctrl.must_be_xml "KeyCode::J, VK_CONTROL"
+    end
+
+    it 'trails none flag' do
+      :j.none.must_be_xml "KeyCode::J, ModifierFlag::NONE"
     end
-    it 'key_to_consumer' do
-      expected = "<autogen>__KeyToConsumer__ KeyCode::F7, ConsumerKeyCode::MUSIC_PREV</autogen>\n"
-      (:F7.to:MUSIC_PREV).must_be_xml expected
+
+    it 'trails mod keys' do
+      :j.ctrl.cmd.must_be_xml "KeyCode::J, VK_CONTROL | VK_COMMAND"
     end
   end
 
   describe 'key_overlaid_modifier' do
-    it 'basic' do
-      expected = "<autogen>__KeyOverlaidModifier__ KeyCode::JIS_EISUU, KeyCode::COMMAND_L, KeyCode::JIS_EISUU</autogen>\n"
-      (:JIS_EISUU.overlaid:COMMAND_L).must_be_xml expected
+    it 'generates KeyOverlaidModifier' do
+      expected = "__KeyOverlaidModifier__ KeyCode::JIS_EISUU, KeyCode::COMMAND_L, KeyCode::JIS_EISUU"
+      (:JIS_EISUU.overlaid:COMMAND_L).must_be_autogen expected
     end
-    it 'keys' do
-      expected = "<autogen>__KeyOverlaidModifier__ KeyCode::CONTROL_L, KeyCode::CONTROL_L, KeyCode::JIS_EISUU, KeyCode::ESCAPE</autogen>\n"
+
+    it 'generates KeyOverlaidModifier with keys' do
+      expected = "__KeyOverlaidModifier__ KeyCode::CONTROL_L, KeyCode::CONTROL_L, KeyCode::JIS_EISUU, KeyCode::ESCAPE"
       autogen = :CONTROL_L .overlaid :CONTROL_L, keys: [:JIS_EISUU, :ESCAPE]
-      autogen.must_be_xml expected
+      autogen.must_be_autogen expected
     end
 
-    it 'repeat' do
-      expected = "<autogen>__KeyOverlaidModifierWithRepeat__ KeyCode::SPACE, KeyCode::SHIFT_L, KeyCode::SPACE</autogen>\n"
+    it 'generates KeyOverlaidModifierWithRepeat' do
+      expected = "__KeyOverlaidModifierWithRepeat__ KeyCode::SPACE, KeyCode::SHIFT_L, KeyCode::SPACE"
       autogen = :SPACE .overlaid :SHIFT_L, repeat: true
-      autogen.must_be_xml expected
+      autogen.must_be_autogen expected
     end
   end
 end

data/spec/keyremac_spec.rb

@@ -2,138 +2,136 @@
 require 'minitest/autorun'
 require 'keyremac/base'
 
-describe 'root' do
-  before do
-    @root = Keyremac::Root.new
+module MiniTest::Assertions
+  def assert_add_child(rule)
+    expected = 1
+    actual = rule.children.length
+    assert expected == actual, message { diff expected, actual }
   end
+end
+Object.infect_an_assertion :assert_add_child, :must_add_child, :unary
 
-  it '末尾に_で任意のtagを書くことができる' do
-    @root.item_ 'hoge'
-    @root.children.length.must_equal 1
-  end
+module Keyremac
+  describe Root do
+    let(:root) { Root.new }
 
-  it '任意のtagはblockで入れ子にできる' do
-    @root.item_ {
-      name_ 'hoge'
-    }
-    @root.children.length.must_equal 1
-  end
-
-  describe 'item' do
-    it '' do
-      @root.item {}
-      @root.children.length.must_equal 1
+    it 'includes any tags' do
+      root.item_('hoge')
+      root.must_add_child
     end
 
-    it 'raw' do
-      @root.item {
-        autogen_ '__KeyToKey__ KeyCode::J, KeyCode::K'
-      }
-      @root.children.length.must_equal 1
+    it 'includes any tags' do
+      root.item_ { name_ 'hoge' }
+      root.must_add_child
     end
 
-    it 'app' do
-      @root.item(app: 'TERMINAL') { }
-      @root.children.length.must_equal 1
+    it 'includes item' do
+      root.item {}
+      root.must_add_child
     end
 
-    it 'inputsource' do
-      @root.item(inputsource: 'JAPANESE') { }
-      @root.children.length.must_equal 1
+    it 'includes app' do
+      root.app('dummy') { }
+      root.must_add_child
     end
   end
 
-  describe 'app' do
-    it 'raw' do
-      container = @root.app('dummy') { }
-      container.class.must_equal Keyremac::Item
-      container.children.length.must_equal 1
-    end
-  end
+  describe 'container' do
+    let(:root) { Root.new }
 
-  describe 'to' do
-    it 'basic' do
-      item = @root.item {
-        :j .to :k
-      }
-      item.children.length.must_equal 1
-    end
+    describe 'item' do
+      it 'can use item container' do
+        root.item { autogen_ '__KeyToKey__ KeyCode::J, KeyCode::K' }
+        root.must_add_child
+      end
 
-    it 'root直下' do
-      :j .to :k
-      @root.root_item.children.length.must_equal 1
-    end
+      it 'can use item container with app_only' do
+        root.item(app: 'TERMINAL') { }
+        root.must_add_child
+      end
 
-    it '複数のkeyを渡せる' do
-      :a .to :b, :c
-      @root.root_item.children.length.must_equal 1
+      it 'can use item container with inputsource_only' do
+        root.item(inputsource: 'JAPANESE') { }
+        root.must_add_child
+      end
     end
-  end
 
-  describe 'overlaid' do
-    it 'basic' do
-      item = @root.item {
-        :JIS_EISUU .overlaid :COMMAND_L
-      }
-      item.children.length.must_equal 1
+    describe 'app' do
+      it 'is the same as item container with app_only' do
+        container = root.app('dummy') { }
+        container.must_be_instance_of Item
+      end
     end
+  end
 
-    it 'basic' do
-      (:JIS_EISUU .overlaid :COMMAND_L).class.must_equal Keyremac::KeyOverlaidModifier
-    end
+  describe 'autogen' do
+    let(:root) { Root.new }
 
-    it 'keys' do
-      autogen = :CONTROL_L .overlaid :CONTROL_L, keys: [:JIS_EISUU, :ESCAPE]
-      autogen.class.must_equal Keyremac::KeyOverlaidModifier
+    describe 'to' do
+      it { root.item { :j .to :k }.must_add_child }
+      it { (:j .to :k).must_be_instance_of Autogen::KeyToKey }
+      it { (:a .to :b, :c).must_be_instance_of Autogen::KeyToKey }
     end
 
-    it 'repeat: false' do
-      autogen = :CONTROL_L .overlaid :CONTROL_L
-      autogen.repeat?.must_equal false
-    end
+    describe 'overlaid' do
+      it 'generates KeyOverlaidModifier' do
+        (:JIS_EISUU .overlaid :COMMAND_L).must_be_instance_of Autogen::KeyOverlaidModifier
+      end
 
-    it 'repeat: true' do
-      autogen = :CONTROL_L .overlaid :CONTROL_L, repeat: true
-      autogen.repeat?.must_equal true
-    end
-  end
+      it 'generates KeyOverlaidModifier with keys' do
+        autogen = :CONTROL_L .overlaid :CONTROL_L, keys: [:JIS_EISUU, :ESCAPE]
+        autogen.class.must_equal Autogen::KeyOverlaidModifier
+      end
 
-  describe 'mods' do
-    [:ctrl, :shift, :opt, :cmd, :extra1].each { |mod|
-      it mod do
-        :j.send(mod).send("#{mod}?").must_equal true
+      it 'has repeat: false by default' do
+        autogen = :CONTROL_L .overlaid :CONTROL_L
+        autogen.wont_be :repeat?
       end
-    }
-  end
 
-  describe 'key' do
-    it '記号を入れると対応するKeyCodeに変換する' do
-      ';'.to_key.code.must_equal 'SEMICOLON'
+      it 'enables repeat flag' do
+        autogen = :CONTROL_L .overlaid :CONTROL_L, repeat: true
+        autogen.must_be :repeat?
+      end
     end
 
-    it 'shiftが必要なkeyは内部で分解する' do
-      key = :J.to_key
-      key.code.must_equal 'j'
-      key.shift?.must_equal true
+    describe 'autogen' do
+      it { (:j .to :k).must_be_instance_of Autogen::KeyToKey }
+      it { (:F7 .to :MUSIC_PREV).must_be_instance_of Autogen::KeyToConsumer }
     end
 
-    it '数値を適切にKeyCodeに変換する' do
-      '1'.to_key.code.must_equal 'KEY_1'
+    describe 'overlaid' do
+      it 'can contain KeyOverlaidModifier' do
+        root.item { :JIS_EISUU .overlaid :COMMAND_L }.must_add_child
+      end
     end
   end
 
-  describe 'consumer_key' do
-    it 'basic' do
-      :MUSIC_PREV.to_key.class.must_equal Keyremac::ConsumerKey
+  describe 'primitive' do
+    describe 'key' do
+      it { :a.to_key.must_be_kind_of Keyable }
+      it { 'a'.to_key.must_be_kind_of Keyable }
+
+      it 'decodes key + shift' do
+        key = :J.to_key
+        key.code.must_equal 'j'
+        key.must_be :shift?
+      end
+
+      it 'converts KEY_*' do
+        '1'.to_key.code.must_equal 'KEY_1'
+      end
     end
-  end
 
-  describe 'autogen' do
-    it 'KeyToKey' do
-      (:j .to :k).class.must_equal Keyremac::KeyToKey
+    describe 'consumer_key' do
+      it { :MUSIC_PREV.to_key.must_be_instance_of ConsumerKey }
     end
-    it 'KeyToConsumer' do
-      (:F7 .to :MUSIC_PREV).class.must_equal Keyremac::KeyToConsumer
+
+    describe 'mods' do
+      [:ctrl, :shift, :opt, :cmd, :extra1, :none].each { |mod|
+        it "adds #{mod} flag" do
+          :j.send(mod).must_be :"#{mod}?"
+        end
+      }
     end
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: keyremac
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2.1
 platform: ruby
 authors:
 - keqh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-21 00:00:00.000000000 Z
+date: 2013-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,20 +38,6 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: awesome_print
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: builder
   requirement: !ruby/object:Gem::Requirement
@@ -77,11 +63,13 @@ files:
 - .travis.yml
 - Gemfile
 - LICENSE.txt
+- README.ja.md
 - README.md
 - Rakefile
 - keyremac.gemspec
 - lib/keyremac.rb
 - lib/keyremac/base.rb
+- lib/keyremac/constants.rb
 - lib/keyremac/dump.rb
 - lib/keyremac/key.rb
 - lib/keyremac/version.rb
@@ -115,3 +103,4 @@ summary: KeyRemap4MacBook private.xml generator
 test_files:
 - spec/dump_spec.rb
 - spec/keyremac_spec.rb
+has_rdoc: