From 8642f0103d4beba83f99c9017ca859c2d2a2f275 Mon Sep 17 00:00:00 2001
From: Muhammad Faisal Amir <faisalamircs@gmail.com>
Date: Fri, 19 May 2023 16:49:54 +0700
Subject: [PATCH] update: ready for publish

Co-authored-by: frogoboxbot <frogoboxmedia@gmail.com>
---
 README.md                                     | 237 +++++++++++++++++-
 buildSrc/src/main/kotlin/LibrarySetting.kt    |  29 +++
 frogo-keyboard/build.gradle.kts               |  40 +++
 .../common/core/BaseKeyboardIME.kt            |  40 +--
 .../libkeyboard/common/core/IKeyboardIME.kt   |  61 +++++
 5 files changed, 383 insertions(+), 24 deletions(-)
 create mode 100644 buildSrc/src/main/kotlin/LibrarySetting.kt
 create mode 100644 frogo-keyboard/src/main/java/com/frogobox/libkeyboard/common/core/IKeyboardIME.kt

diff --git a/README.md b/README.md
index 451a5cf..e68d0b4 100644
--- a/README.md
+++ b/README.md
@@ -20,7 +20,7 @@
 ## Version Release
 This Is Latest Release
 
-    $version_release = 1.1.0
+    $version_release = 1.1.1
 
 What's New??
 
@@ -64,17 +64,246 @@ allprojects {
 
     dependencies {
         // library frogo-keyboard
-        implementation 'com.github.amirisback:keyboard:1.1.0'
+        implementation 'com.github.amirisback:keyboard:1.1.1'
     }
 
 #### <Option 2> Kotlin DSL Gradle
 
     dependencies {
         // library frogo-keyboard
-        implementation("com.github.amirisback:keyboard:1.1.0")
+        implementation("com.github.amirisback:keyboard:1.1.1")
     }
 
-### Step 3. Coming Soon
+### Step 3. Create Service Keyboard IME
+
+#### Create Class Keyboard IME
+```kotlin
+class KeyboardIME : BaseKeyboardIME<YourIMELayoutBinding>() {
+    
+    // ovveride function from IKeyboardIME
+    
+}
+```
+
+#### Interface IKeyboardIME
+```kotlin
+interface IKeyboardIME {
+
+    fun initialSetupKeyboard()
+
+    fun setupBinding() 
+    
+    fun invalidateKeyboard()
+
+    fun initCurrentInputConnection()
+    
+    fun hideMainKeyboard()
+
+    fun showMainKeyboard()
+
+    fun showOnlyKeyboard()
+    
+    fun hideOnlyKeyboard()
+    
+    fun EditText.showKeyboardExt()
+
+    fun initBackToMainKeyboard()
+
+    fun setupFeatureKeyboard()
+
+    fun initView()
+
+    fun invalidateAllKeys()
+
+    @RequiresApi(Build.VERSION_CODES.M)
+    fun runEmojiBoard()
+
+    fun updateShiftKeyState()
+
+    @RequiresApi(Build.VERSION_CODES.M)
+    fun onKeyExt(code: Int, inputConnection: InputConnection)
+
+    fun moveCursor(moveRight: Boolean)
+
+    fun getImeOptionsActionId(): Int
+
+    fun getKeyboardLayoutXML(): Int
+    
+}
+```
+
+### Step 4. Create Layout Keyboard IME
+```xml
+<androidx.constraintlayout.widget.ConstraintLayout xmlns:android="http://schemas.android.com/apk/res/android"
+    xmlns:app="http://schemas.android.com/apk/res-auto"
+    android:id="@+id/keyboard_holder"
+    android:layout_width="match_parent"
+    android:layout_height="wrap_content"
+    android:background="@color/keyboard_bg_root">
+
+    <LinearLayout
+        android:id="@+id/container_keyboard_main"
+        android:layout_width="match_parent"
+        android:layout_height="match_parent"
+        android:orientation="vertical"
+        app:layout_constraintBottom_toBottomOf="parent">
+
+        <androidx.recyclerview.widget.RecyclerView
+            android:id="@+id/keyboard_header"
+            android:layout_width="match_parent"
+            android:layout_height="wrap_content"
+            android:background="@color/keyboard_bg_root"
+            android:minHeight="@dimen/frogo_dimen_64dp" />
+
+        <com.frogobox.libkeyboard.ui.main.MainKeyboard
+            android:id="@+id/keyboard_main"
+            style="@style/KwKeyboardView"
+            android:layout_width="match_parent"
+            android:layout_height="wrap_content"
+            android:background="@color/theme_dark_background_color" />
+
+    </LinearLayout>
+
+    <LinearLayout
+        android:id="@+id/mock_measure_height_keyboard"
+        android:layout_width="match_parent"
+        android:layout_height="match_parent"
+        android:orientation="vertical"
+        android:visibility="gone"
+        app:layout_constraintBottom_toTopOf="@id/container_keyboard_main">
+
+        <androidx.recyclerview.widget.RecyclerView
+            android:id="@+id/mock_keyboard_header"
+            android:layout_width="match_parent"
+            android:layout_height="wrap_content"
+            android:background="@color/keyboard_bg_root"
+            android:minHeight="@dimen/frogo_dimen_64dp" />
+
+        <com.frogobox.libkeyboard.ui.main.MainKeyboard
+            android:id="@+id/mock_measure_height_keyboard_main"
+            style="@style/KwKeyboardView"
+            android:layout_width="match_parent"
+            android:layout_height="wrap_content"
+            android:background="@color/theme_dark_background_color" />
+
+    </LinearLayout>
+
+    <com.frogobox.appkeyboard.ui.keyboard.autotext.AutoTextKeyboard
+        android:id="@+id/keyboard_autotext"
+        android:layout_width="match_parent"
+        android:layout_height="0dp"
+        android:clickable="true"
+        android:focusable="true"
+        android:visibility="gone"
+        app:layout_constraintBottom_toBottomOf="@id/mock_measure_height_keyboard"
+        app:layout_constraintEnd_toEndOf="parent"
+        app:layout_constraintStart_toStartOf="parent"
+        app:layout_constraintTop_toTopOf="@id/mock_measure_height_keyboard" />
+
+    <com.frogobox.appkeyboard.ui.keyboard.templatetext.TemplateTextKeyboard
+        android:id="@+id/keyboard_template_text"
+        android:layout_width="match_parent"
+        android:layout_height="0dp"
+        android:clickable="true"
+        android:focusable="true"
+        android:visibility="gone"
+        app:layout_constraintBottom_toBottomOf="@id/mock_measure_height_keyboard"
+        app:layout_constraintEnd_toEndOf="parent"
+        app:layout_constraintStart_toStartOf="parent"
+        app:layout_constraintTop_toTopOf="@id/mock_measure_height_keyboard" />
+
+    <com.frogobox.appkeyboard.ui.keyboard.news.NewsKeyboard
+        android:id="@+id/keyboard_news"
+        android:layout_width="match_parent"
+        android:layout_height="0dp"
+        android:clickable="true"
+        android:focusable="true"
+        android:visibility="gone"
+        app:layout_constraintBottom_toBottomOf="@id/mock_measure_height_keyboard"
+        app:layout_constraintEnd_toEndOf="parent"
+        app:layout_constraintStart_toStartOf="parent"
+        app:layout_constraintTop_toTopOf="@id/mock_measure_height_keyboard" />
+
+    <com.frogobox.appkeyboard.ui.keyboard.movie.MovieKeyboard
+        android:id="@+id/keyboard_moview"
+        android:layout_width="match_parent"
+        android:layout_height="0dp"
+        android:clickable="true"
+        android:focusable="true"
+        android:visibility="gone"
+        app:layout_constraintBottom_toBottomOf="@id/mock_measure_height_keyboard"
+        app:layout_constraintEnd_toEndOf="parent"
+        app:layout_constraintStart_toStartOf="parent"
+        app:layout_constraintTop_toTopOf="@id/mock_measure_height_keyboard" />
+
+    <com.frogobox.appkeyboard.ui.keyboard.webview.WebiewKeyboard
+        android:id="@+id/keyboard_webview"
+        android:layout_width="match_parent"
+        android:layout_height="0dp"
+        android:clickable="true"
+        android:focusable="true"
+        android:visibility="gone"
+        app:layout_constraintBottom_toBottomOf="@id/mock_measure_height_keyboard"
+        app:layout_constraintEnd_toEndOf="parent"
+        app:layout_constraintStart_toStartOf="parent"
+        app:layout_constraintTop_toTopOf="@id/mock_measure_height_keyboard" />
+
+    <com.frogobox.appkeyboard.ui.keyboard.form.FormKeyboard
+        android:id="@+id/keyboard_form"
+        android:layout_width="match_parent"
+        android:layout_height="0dp"
+        android:clickable="true"
+        android:focusable="true"
+        android:visibility="gone"
+        app:layout_constraintBottom_toBottomOf="@id/mock_measure_height_keyboard"
+        app:layout_constraintEnd_toEndOf="parent"
+        app:layout_constraintStart_toStartOf="parent"
+        app:layout_constraintTop_toTopOf="@id/mock_measure_height_keyboard" />
+
+    <com.frogobox.libkeyboard.ui.emoji.EmojiKeyboard
+        android:id="@+id/keyboard_emoji"
+        android:layout_width="match_parent"
+        android:layout_height="0dp"
+        android:clickable="true"
+        android:focusable="true"
+        android:visibility="gone"
+        app:layout_constraintBottom_toBottomOf="@id/mock_measure_height_keyboard"
+        app:layout_constraintEnd_toEndOf="parent"
+        app:layout_constraintStart_toStartOf="parent"
+        app:layout_constraintTop_toTopOf="@id/mock_measure_height_keyboard" />
+
+</androidx.constraintlayout.widget.ConstraintLayout>
+```
+
+### Step 5. Create KeyConfig
+```xml
+<?xml version="1.0" encoding="utf-8"?>
+<input-method xmlns:android="http://schemas.android.com/apk/res/android"
+    android:icon="@drawable/ic_frogobox"
+    android:settingsActivity="com.frogobox.appkeyboard.ui.main.MainActivity">
+
+    <subtype android:imeSubtypeMode="Keyboard" />
+
+</input-method>
+
+```
+
+### Step 6. Create Keyboard Service In Manifest
+```xml
+<service
+    android:name=".services.KeyboardIME"
+    android:exported="true"
+    android:label="@string/app_name"
+    android:permission="android.permission.BIND_INPUT_METHOD">
+    <meta-data
+        android:name="android.view.im"
+        android:resource="@xml/keys_config" />
+    <intent-filter>
+        <action android:name="android.view.InputMethod" />
+    </intent-filter>
+</service>
+```
+
 
 ## Video Play
 https://user-images.githubusercontent.com/24654871/231431022-4410933f-7199-4967-9db1-24544f5593e0.mp4
diff --git a/buildSrc/src/main/kotlin/LibrarySetting.kt b/buildSrc/src/main/kotlin/LibrarySetting.kt
new file mode 100644
index 0000000..906460e
--- /dev/null
+++ b/buildSrc/src/main/kotlin/LibrarySetting.kt
@@ -0,0 +1,29 @@
+/**
+ * Created by Faisal Amir on 24/10/22
+ * -----------------------------------------
+ * E-mail   : faisalamircs@gmail.com
+ * Github   : github.com/amirisback
+ * -----------------------------------------
+ * Copyright (C) Frogobox ID / amirisback
+ * All rights reserved
+ */
+
+
+import ProjectSetting.APP_DOMAIN
+import ProjectSetting.APP_PLAY_CONSOLE
+
+object LibrarySetting {
+
+    const val GITHUB_ACCOUNT = "amirisback"
+    const val GITHUB_REPOSITORY = "keyboard"
+
+    const val LIB_NAME = "libkeyboard"
+
+    const val ARTIFACT_ID = GITHUB_REPOSITORY
+    const val GROUP_ID = "com.github.$GITHUB_ACCOUNT"
+
+    const val NAME_SPACE = "$APP_DOMAIN.$APP_PLAY_CONSOLE.$LIB_NAME"
+
+    const val MAVEN_URI = "https://maven.pkg.github.com/$GITHUB_ACCOUNT/$GITHUB_REPOSITORY"
+
+}
\ No newline at end of file
diff --git a/frogo-keyboard/build.gradle.kts b/frogo-keyboard/build.gradle.kts
index 6216002..d70d9cd 100644
--- a/frogo-keyboard/build.gradle.kts
+++ b/frogo-keyboard/build.gradle.kts
@@ -1,6 +1,7 @@
 plugins {
     id("com.android.library")
     id("org.jetbrains.kotlin.android")
+    `maven-publish`
 }
 
 android {
@@ -51,4 +52,43 @@ dependencies {
     api(Frogo.recyclerView)
 
     api(Androidx.emoji2)
+
+}
+
+afterEvaluate {
+    publishing {
+        publications {
+
+            repositories {
+                maven {
+                    name = LibrarySetting.LIB_NAME
+                    url = uri(LibrarySetting.MAVEN_URI)
+                    credentials {
+                        username = project.findProperty("gpr.user") as String? ?: ""
+                        password = project.findProperty("gpr.key") as String? ?: ""
+                    }
+                }
+            }
+
+            // Creates a Maven publication called "release".
+            register("release", MavenPublication::class) {
+
+                // Applies the component for the release build variant.
+                // NOTE : Delete this line code if you publish Native Java / Kotlin Library
+                from(components["release"])
+
+                // Library Package Name (Example : "com.frogobox.androidfirstlib")
+                // NOTE : Different GroupId For Each Library / Module, So That Each Library Is Not Overwritten
+                groupId = LibrarySetting.GROUP_ID
+
+                // Library Name / Module Name (Example : "androidfirstlib")
+                // NOTE : Different ArtifactId For Each Library / Module, So That Each Library Is Not Overwritten
+                artifactId = LibrarySetting.ARTIFACT_ID
+
+                // Version Library Name (Example : "1.0.0")
+                version = ProjectSetting.PROJECT_VERSION_NAME
+
+            }
+        }
+    }
 }
\ No newline at end of file
diff --git a/frogo-keyboard/src/main/java/com/frogobox/libkeyboard/common/core/BaseKeyboardIME.kt b/frogo-keyboard/src/main/java/com/frogobox/libkeyboard/common/core/BaseKeyboardIME.kt
index 67d4923..53c5c94 100644
--- a/frogo-keyboard/src/main/java/com/frogobox/libkeyboard/common/core/BaseKeyboardIME.kt
+++ b/frogo-keyboard/src/main/java/com/frogobox/libkeyboard/common/core/BaseKeyboardIME.kt
@@ -27,7 +27,7 @@ import com.frogobox.libkeyboard.ui.main.ItemMainKeyboard.Companion.SHIFT_ON_PERM
 import com.frogobox.libkeyboard.ui.main.OnKeyboardActionListener
 
 // based on https://www.androidauthority.com/lets-build-custom-keyboard-android-832362/
-abstract class BaseKeyboardIME<VB : ViewBinding> : InputMethodService(), OnKeyboardActionListener {
+abstract class BaseKeyboardIME<VB : ViewBinding> : InputMethodService(), OnKeyboardActionListener, IKeyboardIME {
 
     // how quickly do we have to doubletap shift to enable permanent caps lock
     var SHIFT_PERM_TOGGLE_SPEED = 500
@@ -144,40 +144,40 @@ abstract class BaseKeyboardIME<VB : ViewBinding> : InputMethodService(), OnKeybo
         currentInputConnection?.commitText(text, 0)
     }
 
-    open fun initialSetupKeyboard() {
+    override fun initialSetupKeyboard() {
 
     }
 
-    open fun setupBinding() {
+    override fun setupBinding() {
         initialSetupKeyboard()
     }
 
-    open fun invalidateKeyboard() {
+    override fun invalidateKeyboard() {
 
         setupFeatureKeyboard()
     }
 
-    open fun initCurrentInputConnection() {
+    override fun initCurrentInputConnection() {
 
     }
 
-    open fun hideMainKeyboard() {
+    override fun hideMainKeyboard() {
 
     }
 
-    open fun showMainKeyboard() {
+    override fun showMainKeyboard() {
 
     }
 
-    open fun showOnlyKeyboard() {
+    override fun showOnlyKeyboard() {
 
     }
 
-    open fun hideOnlyKeyboard() {
+    override fun hideOnlyKeyboard() {
 
     }
 
-    open fun EditText.showKeyboardExt() {
+    override fun EditText.showKeyboardExt() {
         setOnFocusChangeListener { v, hasFocus ->
             if (hasFocus) {
                 showOnlyKeyboard()
@@ -188,28 +188,28 @@ abstract class BaseKeyboardIME<VB : ViewBinding> : InputMethodService(), OnKeybo
         }
     }
 
-    open fun initBackToMainKeyboard() {
+    override fun initBackToMainKeyboard() {
 
     }
 
-    open fun setupFeatureKeyboard() {
+    override fun setupFeatureKeyboard() {
 
     }
 
-    open fun initView() {
+    override fun initView() {
         setupFeatureKeyboard()
         initBackToMainKeyboard()
     }
 
-    open fun invalidateAllKeys() {
+    override fun invalidateAllKeys() {
 
     }
 
     @RequiresApi(Build.VERSION_CODES.M)
-    open fun runEmojiBoard() {
+    override fun runEmojiBoard() {
     }
 
-    open fun updateShiftKeyState() {
+    override fun updateShiftKeyState() {
         if (keyboardMode == KEYBOARD_LETTERS) {
             val editorInfo = currentInputEditorInfo
             if (editorInfo != null && editorInfo.inputType != InputType.TYPE_NULL && keyboard?.mShiftState != SHIFT_ON_PERMANENT) {
@@ -222,7 +222,7 @@ abstract class BaseKeyboardIME<VB : ViewBinding> : InputMethodService(), OnKeybo
     }
 
     @RequiresApi(Build.VERSION_CODES.M)
-    open fun onKeyExt(code: Int, inputConnection: InputConnection) {
+    override fun onKeyExt(code: Int, inputConnection: InputConnection) {
         if (keyboard == null || inputConnection == null) {
             return
         }
@@ -352,7 +352,7 @@ abstract class BaseKeyboardIME<VB : ViewBinding> : InputMethodService(), OnKeybo
         }
     }
 
-    open fun moveCursor(moveRight: Boolean) {
+    override fun moveCursor(moveRight: Boolean) {
         val extractedText =
             currentInputConnection?.getExtractedText(ExtractedTextRequest(), 0) ?: return
         var newCursorPosition = extractedText.selectionStart
@@ -365,7 +365,7 @@ abstract class BaseKeyboardIME<VB : ViewBinding> : InputMethodService(), OnKeybo
         currentInputConnection?.setSelection(newCursorPosition, newCursorPosition)
     }
 
-    open fun getImeOptionsActionId(): Int {
+    override fun getImeOptionsActionId(): Int {
         return if (currentInputEditorInfo.imeOptions and IME_FLAG_NO_ENTER_ACTION != 0) {
             IME_ACTION_NONE
         } else {
@@ -373,7 +373,7 @@ abstract class BaseKeyboardIME<VB : ViewBinding> : InputMethodService(), OnKeybo
         }
     }
 
-    open fun getKeyboardLayoutXML(): Int {
+    override fun getKeyboardLayoutXML(): Int {
         return R.xml.keys_letters_qwerty
     }
 
diff --git a/frogo-keyboard/src/main/java/com/frogobox/libkeyboard/common/core/IKeyboardIME.kt b/frogo-keyboard/src/main/java/com/frogobox/libkeyboard/common/core/IKeyboardIME.kt
new file mode 100644
index 0000000..123bace
--- /dev/null
+++ b/frogo-keyboard/src/main/java/com/frogobox/libkeyboard/common/core/IKeyboardIME.kt
@@ -0,0 +1,61 @@
+package com.frogobox.libkeyboard.common.core
+
+import android.os.Build
+import android.view.inputmethod.InputConnection
+import android.widget.EditText
+import androidx.annotation.RequiresApi
+
+/**
+ * Created by Faisal Amir on 24/10/22
+ * -----------------------------------------
+ * E-mail   : faisalamircs@gmail.com
+ * Github   : github.com/amirisback
+ * -----------------------------------------
+ * Copyright (C) Frogobox ID / amirisback
+ * All rights reserved
+ */
+
+
+interface IKeyboardIME {
+
+    fun initialSetupKeyboard()
+
+    fun setupBinding() 
+    
+    fun invalidateKeyboard()
+
+    fun initCurrentInputConnection()
+    
+    fun hideMainKeyboard()
+
+    fun showMainKeyboard()
+
+    fun showOnlyKeyboard()
+    
+    fun hideOnlyKeyboard()
+    
+    fun EditText.showKeyboardExt()
+
+    fun initBackToMainKeyboard()
+
+    fun setupFeatureKeyboard()
+
+    fun initView()
+
+    fun invalidateAllKeys()
+
+    @RequiresApi(Build.VERSION_CODES.M)
+    fun runEmojiBoard()
+
+    fun updateShiftKeyState()
+
+    @RequiresApi(Build.VERSION_CODES.M)
+    fun onKeyExt(code: Int, inputConnection: InputConnection)
+
+    fun moveCursor(moveRight: Boolean)
+
+    fun getImeOptionsActionId(): Int
+
+    fun getKeyboardLayoutXML(): Int
+    
+}
\ No newline at end of file