Merge pull request #46 from ensan-hcl/release/1.1

ensan-hcl · web-flow · commit d060c5912be4 · 2023-02-05T21:34:32.000+09:00
Release 1.1
diff --git a/json/howToMake.md b/json/howToMake.md
@@ -67,6 +67,7 @@
 | normal   | 通常の入力キーの色です。                 |
 | special  | タブ移動キーや削除キーの色です。         |
 | selected | 選択中のタブや押されているキーの色です。 |
+| unimportant | 重要度の低いキーの色です。 |
 
 ### アクション
 
@@ -101,6 +102,7 @@ azooKeyでは`"input"`の他にいくつかの動作を行うことができま
 | toggle_tab_bar          | なし                               | タブバーの表示をtoggleします。                               |
 | toggle_caps_lock_state  | なし                               | caps lockをtoggleします。                                    |
 | dismiss_keyboard        | なし                               | キーボードを閉じます。                                       |
+| launch_application      | scheme_type: str<br />target: str | scheme_typeで指定されたアプリケーションをscheme://(target)として開きます。scheme_typeには`"azooKey"`か`"shortcuts"`のみを指定できます。 |
 
 続く`"longpress_actions"`はほぼ`"press_actions"`と同じです。
 
diff --git a/python/README.md b/python/README.md
@@ -1,3 +1,9 @@
-## 環境
+# 環境
 
 Python3.9以上。
+
+# テスト
+
+```bash
+python3 -m unittest
+```
diff --git a/python/howToMake.md b/python/howToMake.md
@@ -57,6 +57,7 @@ design = KeyDesign(
 | normal   | 通常の入力キーの色です。                 |
 | special  | タブ移動キーや削除キーの色です。         |
 | selected | 選択中のタブや押されているキーの色です。 |
+| unimportant | 重要度の低いキーの色です。 |
 
 ### アクション
 
@@ -90,6 +91,7 @@ azooKeyでは`InputAction`の他にいくつかの動作を行うことができ
 | ToggleTabBarAction          | なし                                             | タブバーの表示をtoggleします。                               |
 | ToggleCapsLockStateAction  | なし                                             | caps lockをtoggleします。                                    |
 | DismissKeyboardAction        | なし                                             | キーボードを閉じます。                                       |
+| LaunchApplicationAction      | scheme_type: Literal['azooKey', 'shortcuts']<br />target: str | scheme_typeで指定されたアプリケーションをscheme://(target)として開きます。scheme_typeには`"azooKey"`か`"shortcuts"`のみを指定できます。 |
 
 続く引数の`longpress_actions`は`LongpressAction`というオブジェクトで、ほぼ`press_actions`と同じです。
 
diff --git a/python/source/actions.py b/python/source/actions.py
@@ -1,7 +1,5 @@
-import json
-from .json import to_json
 from enum import Enum, unique
-from abc import ABCMeta, abstractmethod
+from typing import Literal
 
 
 class ActionDefaultArguments:
@@ -13,13 +11,15 @@ class ScanDirection(str, Enum):
     forward = "forward"
     backward = "backward"
 
+
 class Action:
     """
     全てのActionの継承元となるクラス。
     metaclassによって、自動的に割り当てられる。
     """
     pass
 
+
 class ActionMeta(type):
     """
     全てのActionのメタクラス。
@@ -32,8 +32,10 @@ def __new__(meta, name, bases, attributes):
             raise TypeError("Action has no type!")
         return type.__new__(meta, name, bases, attributes)
 
+
 class InputAction(metaclass=ActionMeta):
     type = "input"
+
     def __init__(self, text: str):
         """
         文字を入力するアクション
@@ -44,8 +46,10 @@ def __init__(self, text: str):
         """
         self.text = text
 
+
 class ReplaceLastCharactersAction(metaclass=ActionMeta):
     type = "replace_last_characters"
+
     def __init__(self, table: dict[str, str]):
         """
         最後の文字を置換するアクション
@@ -56,19 +60,23 @@ def __init__(self, table: dict[str, str]):
         """
         self.table = table
 
+
 class ReplaceDefaultAction(metaclass=ActionMeta):
     """
     azooKeyデフォルトの置換アクション
     """
     type = "replace_default"
 
+
 @unique
 class TabType(str, Enum):
     system = "system"
     custom = "custom"
 
+
 class MoveTabAction(metaclass=ActionMeta):
     type = "move_tab"
+
     def __init__(self, tab_type: TabType, text: str):
         """
         タブを移動するアクション
@@ -82,8 +90,10 @@ def __init__(self, tab_type: TabType, text: str):
         self.tab_type = tab_type
         self.identifier = text
 
+
 class MoveCursorAction(metaclass=ActionMeta):
     type = "move_cursor"
+
     def __init__(self, count: int):
         """
         カーソルを移動するアクション
@@ -94,8 +104,10 @@ def __init__(self, count: int):
         """
         self.count = count
 
+
 class SmartMoveCursorAction(metaclass=ActionMeta):
     type = "smart_move_cursor"
+
     def __init__(self, direction: ScanDirection, targets: list[str]):
         """
         指定した文字の隣までカーソルを移動するアクション
@@ -109,8 +121,28 @@ def __init__(self, direction: ScanDirection, targets: list[str]):
         self.direction = direction
         self.targets = targets
 
+
+class LaunchApplicationAction(metaclass=ActionMeta):
+    type = "launch_application"
+
+    def __init__(self, scheme_type: Literal['azooKey', 'shortcuts'], target: str):
+        """
+        アプリケーションを起動するアクション。
+        schemeとしてazooKeyを選んだ場合、'azooKey://' + targetを開く。
+        schemeとしてshortcutsを選んだ場合、'shortcuts://' + targetを開く。
+        target = run-shortcut?name=<ショートカット名>とすることで、任意のショートカットを開くことができる。
+        Parameters
+        ----------
+        scheme_type: Literal['azooKey', 'shortcuts']
+        target: str
+        """
+        self.scheme_type = scheme_type
+        self.target = target
+
+
 class DeleteAction(metaclass=ActionMeta):
     type = "delete"
+
     def __init__(self, count: int):
         """
         文字を削除するアクション
@@ -121,8 +153,10 @@ def __init__(self, count: int):
         """
         self.count = count
 
+
 class SmartDeleteAction(metaclass=ActionMeta):
     type = "smart_delete"
+
     def __init__(self, direction: ScanDirection, targets: list[str]):
         """
         指定した文字の隣まで文字を削除するアクション
@@ -136,42 +170,49 @@ def __init__(self, direction: ScanDirection, targets: list[str]):
         self.direction = direction
         self.targets = targets
 
+
 class SmartDeleteDefaultAction(metaclass=ActionMeta):
     """
     azooKeyデフォルトの文頭まで削除アクション
     """
     type = "smart_delete_default"
 
+
 class EnableResizingModeAction(metaclass=ActionMeta):
     """
     片手モードの調整を始めるアクション
     """
     type = "enable_resizing_mode"
 
+
 class ToggleCursorBarAction(metaclass=ActionMeta):
     """
     カーソルバーの表示状態をtoggleするアクション
     """
     type = "toggle_cursor_bar"
 
+
 class ToggleTabBarAction(metaclass=ActionMeta):
     """
     タブバーの表示状態をtoggleするアクション
     """
     type = "toggle_tab_bar"
 
+
 class ToggleCapsLockStateAction(metaclass=ActionMeta):
     """
     Caps lockの状態をtoggleするアクション
     """
     type = "toggle_caps_lock_state"
 
+
 class DismissKeyboardAction(metaclass=ActionMeta):
     """
     キーボードを閉じるアクション
     """
     type = "dismiss_keyboard"
 
+
 class LongpressAction(object):
     def __init__(self, start: list[Action] = [], repeat: list[Action] = []):
         """
diff --git a/python/source/design.py b/python/source/design.py
@@ -7,6 +7,7 @@ class KeyColor(str, Enum):
     normal = "normal"
     special = "special"
     selected = "selected"
+    unimportant = "unimportant"
 
 
 class KeyLabel(object):
diff --git a/python/test/test_actions.py b/python/test/test_actions.py
@@ -1,9 +1,10 @@
+from source.json import to_json
+from source.actions import *
 import unittest
 import sys
+import json
 from pathlib import Path
 sys.path.append(str(Path('__file__').resolve().parent))
-from source.actions import *
-from source.json import to_json
 
 
 class TestActions(unittest.TestCase):
@@ -23,7 +24,8 @@ def test_InputAction(self):
     def test_ReplaceLastCharactersAction(self):
         """test method for ReplaceLastCharactersAction
         """
-        actual = to_json(ReplaceLastCharactersAction({"あ": "ぁ", "か": "が", "😆": "😭"}))
+        actual = to_json(ReplaceLastCharactersAction(
+            {"あ": "ぁ", "か": "が", "😆": "😭"}))
         expected_json = {
             "type": "replace_last_characters",
             "table": {"あ": "ぁ", "か": "が", "😆": "😭"}
@@ -33,15 +35,17 @@ def test_ReplaceLastCharactersAction(self):
     def test_MoveTabAction(self):
         """test method for MoveTabAction
         """
-        actual = to_json(MoveTabAction(tab_type=TabType.custom, text="flick_greek"))
+        actual = to_json(MoveTabAction(
+            tab_type=TabType.custom, text="flick_greek"))
         expected_json = {
             "type": "move_tab",
             "tab_type": TabType.custom,
             "identifier": "flick_greek"
         }
         self.assertEqual(expected_json, actual)
 
-        actual = to_json(MoveTabAction(tab_type=TabType.system, text="flick_kutoten"))
+        actual = to_json(MoveTabAction(
+            tab_type=TabType.system, text="flick_kutoten"))
         expected_json = {
             "type": "move_tab",
             "tab_type": TabType.system,
@@ -66,11 +70,23 @@ def test_MoveCursorAction(self):
         }
         self.assertEqual(expected_json, actual)
 
+    def test_LaunchApplicationAction(self):
+        """test method for LaunchApplicationAction
+        """
+        actual = to_json(LaunchApplicationAction(
+            "shortcuts", "run_shortcut?name=take_picture"))
+        expected_json = {
+            "type": "launch_application",
+            "scheme_type": "shortcuts",
+            "target": "run_shortcut?name=take_picture"
+        }
+        self.assertEqual(expected_json, actual)
+
     def test_SmartMoveCursorAction(self):
         """test method for SmartMoveCursorAction
         """
         actual = to_json(SmartMoveCursorAction(ScanDirection.forward, targets=[
-                                          "!", "?", ".", ",", ":", ";"]))
+            "!", "?", ".", ",", ":", ";"]))
         expected_json = {
             "type": "smart_move_cursor",
             "direction": ScanDirection.forward,
@@ -99,7 +115,7 @@ def test_SmartDeleteAction(self):
         """test method for SmartDeleteAction
         """
         actual = to_json(SmartDeleteAction(ScanDirection.forward, targets=[
-                                     "!", "?", ".", ",", ":", ";"]))
+            "!", "?", ".", ",", ":", ";"]))
         expected_json = {
             "type": "smart_delete",
             "direction": ScanDirection.forward,
diff --git a/python/test/test_design.py b/python/test/test_design.py
@@ -1,9 +1,9 @@
+from source.json import to_json
+from source.design import *
 import unittest
 import sys
 from pathlib import Path
 sys.path.append(str(Path('__file__').resolve().parent))
-from source.design import *
-from source.json import to_json
 
 
 class TestDesign(unittest.TestCase):
@@ -22,6 +22,9 @@ def test_KeyColor(self):
         actual = json.dumps(KeyColor.selected)
         self.assertEqual("\"selected\"", actual)
 
+        actual = json.dumps(KeyColor.unimportant)
+        self.assertEqual("\"unimportant\"", actual)
+
     def test_TextLabel(self):
         """test method for TextLabel
         """
diff --git a/swift/howToMake.md b/swift/howToMake.md
@@ -49,6 +49,7 @@ design: .init(label: .text("@#/&_"), color: .normal)
 | .normal   | 通常の入力キーの色です。                 |
 | .special  | タブ移動キーや削除キーの色です。         |
 | .selected | 選択中のタブや押されているキーの色です。 |
+| .unimportant | 重要度の低いキーの色です。 |
 
 ### アクション
 
@@ -82,6 +83,7 @@ azooKeyでは`input`の他にいくつかの動作を行うことができます
 | .toggleTabBar          | なし             | タブバーの表示をtoggleします。                               |
 | .toggleCapsLockState   | なし             | caps lockをtoggleします。                                    |
 | .dismissKeyboard       | なし             | キーボードを閉じます。                                       |
+| .launchApplication     | LaunchItem       | 引数で指定されたアプリケーションを開きます。 |
 
 続く引数の`longpress_actions`は`CodableLongpressActionData`型の値です。定義は以下の通りで、`start`と`repeat`にそれぞれ行うべき動作を指定します。
 
diff --git a/swift/sources/CustardKit.swift b/swift/sources/CustardKit.swift
diff --git a/swift/tests/CustardKitTests/CustardKeyDesignTest.swift b/swift/tests/CustardKitTests/CustardKeyDesignTest.swift
