Merge pull request #1 from ihermandev/develop

add possibility to get formatted and raw text from the FormatWatcher

Author: ihermandev

CHANGELOG.md

@@ -0,0 +1,5 @@
+## v1.0.1
+- Added functionality in order to get the formatted and raw text
+
+## v1.0.0
+- The first stable release

README.md

@@ -1,5 +1,5 @@
 # FormatWatcher
-![version](https://img.shields.io/badge/format--watcher-v1.0.0-blue)
+![version](https://img.shields.io/badge/format--watcher-v1.0.1-blue)
 
 The FormatWatcher library provides a simple and easy-to-use way to apply predefined formatting to user 
 input for Android EditText. The formatter is separator sensitive, meaning if a separator is entered 
@@ -13,17 +13,25 @@ repositories {
 }
 
 dependencies {
-    implementation 'io.github.ihermandev:format-watcher:1.0.0'
+    implementation 'io.github.ihermandev:format-watcher:1.0.1'
 }
 ```
 ## Usage
-Simply create a new instance of the FormatWatcher and set it as the TextWatcher for the EditText.
+Simply create a new instance of the `FormatWatcher` and set it as the `TextWatcher` interface for 
+the `EditText`.
 ```kotlin
 val formatter = FormatWatcher("###-##-####", '#')
 editText.addTextChangedListener(formatter)
 ```
-The first argument passed to the FormatWatcher constructor is the format string to be applied to the 
+The first argument passed to the `FormatWatcher` constructor is the format string to be applied to the 
 text, the second argument is the character to be used as a placeholder in the format string.
+
+In order to obtain the formatted or raw input you can call `currentInput` and `rawInput` accordingly
+via `FormatWatcher` instance.
+```kotlin
+formatter.currentInput
+formatter.rawInput
+```
 ## Customization
 You can customize the behavior of the FormatWatcher class by changing the format string, and the 
 placeholder character to match your specific requirements.

format-watcher/build.gradle

@@ -5,7 +5,6 @@ plugins {
 
 ext {
     PUBLISH_GROUP_ID = 'io.github.ihermandev'
-    PUBLISH_VERSION = '1.0.0'
     PUBLISH_ARTIFACT_ID = 'format-watcher'
 }
 

format-watcher/src/main/java/com/github/ihermandev/formatwatcher/FormatWatcher.kt

@@ -35,6 +35,17 @@ class FormatWatcher(
         format.length
     }
 
+    // Current formatted editable input
+    var currentInput = ""
+        private set
+
+    // Raw input without format applied
+    val rawInput: String
+        get() = if (currentInput.isNotEmpty()) {
+            getRawInput(currentInput)
+        } else currentInput
+
+
     /**
      * @see [android.text.TextWatcher.onTextChanged]
      */
@@ -58,7 +69,10 @@ class FormatWatcher(
         // Check if the format is already in use
         if (isFormatApplying) return
         // Check if the editable is removing
-        if (isCharRemoving) return
+        if (isCharRemoving) {
+            currentInput = editable.toString()
+            return
+        }
 
         isFormatApplying = true
 
@@ -87,6 +101,8 @@ class FormatWatcher(
             }
 
         }
+
+        currentInput = editable.toString()
         // Reset flags
         isFormatApplying = false
         isInputCopied = false
@@ -118,6 +134,28 @@ class FormatWatcher(
         }
     }
 
+    /**
+     * Removes all non-placeholder character
+     *
+     * @param input representing text from which the formatting should be removed.
+     */
+    private fun getRawInput(input: String): String {
+        val output = StringBuilder()
+
+        for (i in input.indices) {
+            val inputChar = input[i]
+            if (i < formatLength) {
+                if (format[i] == placeholderInFormat) {
+                    output.append(inputChar)
+                }
+            } else {
+                output.append(inputChar)
+            }
+        }
+
+        return output.toString()
+    }
+
     companion object {
         const val DEFAULT_CHAR_IN_FORMAT = '*'
     }

gradle/publish-module.gradle

@@ -2,6 +2,8 @@ apply plugin: 'maven-publish'
 apply plugin: 'signing'
 apply plugin: 'org.jetbrains.dokka'
 
+apply from: "$rootProject.projectDir/gradle/version.gradle"
+
 task androidSourcesJar(type: Jar) {
     archiveClassifier.set('sources')
     if (project.plugins.findPlugin("com.android.library")) {
@@ -32,7 +34,7 @@ artifacts {
 }
 
 group = PUBLISH_GROUP_ID
-version = PUBLISH_VERSION
+version = versionName
 
 afterEvaluate {
     publishing {
@@ -41,7 +43,7 @@ afterEvaluate {
                 // The coordinates of the library
                 groupId PUBLISH_GROUP_ID
                 artifactId PUBLISH_ARTIFACT_ID
-                version PUBLISH_VERSION
+                version versionName
 
                 // Two artifacts, the `aar` (or `jar`) and the sources
                 if (project.plugins.findPlugin("com.android.library")) {

sample/src/main/java/com/github/ihermandev/sample/MainActivity.kt

@@ -4,10 +4,16 @@ import android.os.Bundle
 import android.widget.EditText
 import androidx.annotation.StringRes
 import androidx.appcompat.app.AppCompatActivity
+import androidx.constraintlayout.widget.ConstraintLayout
 import com.github.ihermandev.formatwatcher.FormatWatcher
+import com.google.android.material.snackbar.Snackbar
 
 class MainActivity : AppCompatActivity() {
 
+    private val rootContainer by lazy {
+        findViewById<ConstraintLayout>(R.id.container)
+    }
+
     private val editText1 by lazy {
         findViewById<EditText>(R.id.editText1)
     }
@@ -36,25 +42,69 @@ class MainActivity : AppCompatActivity() {
         findViewById<EditText>(R.id.editText7)
     }
 
+    private val formatWatcher1 by lazy {
+        FormatWatcher(getStringResource(R.string.format_set1),
+            placeholderInFormat = '#')
+    }
+
+    private val formatWatcher2 by lazy {
+        FormatWatcher(getStringResource(R.string.format_set2),
+            placeholderInFormat = '*')
+    }
+
+    private val formatWatcher3 by lazy {
+        FormatWatcher(getStringResource(R.string.format_set3),
+            placeholderInFormat = '#')
+    }
+
+    private val formatWatcher4 by lazy {
+        FormatWatcher(getStringResource(R.string.format_set4),
+            placeholderInFormat = '#')
+    }
+
+    private val formatWatcher5 by lazy {
+        FormatWatcher(getStringResource(R.string.format_set5),
+            placeholderInFormat = '*')
+    }
+
+    private val formatWatcher6 by lazy {
+        FormatWatcher(getStringResource(R.string.format_set6),
+            placeholderInFormat = '#')
+    }
+
+    private val formatWatcher7 by lazy {
+        FormatWatcher(getStringResource(R.string.format_set7),
+            placeholderInFormat = '#')
+    }
+
     override fun onCreate(savedInstanceState: Bundle?) {
         super.onCreate(savedInstanceState)
         setContentView(R.layout.activity_main)
 
-        editText1.addTextChangedListener(FormatWatcher(getStringResource(R.string.format_set1),
-            placeholderInFormat = '#'))
-        editText2.addTextChangedListener(FormatWatcher(getStringResource(R.string.format_set2),
-            placeholderInFormat = '*'))
-        editText3.addTextChangedListener(FormatWatcher(getStringResource(R.string.format_set3),
-            placeholderInFormat = '#'))
-        editText4.addTextChangedListener(FormatWatcher(getStringResource(R.string.format_set4),
-            placeholderInFormat = '#'))
-        editText5.addTextChangedListener(FormatWatcher(getStringResource(R.string.format_set5),
-            placeholderInFormat = '*'))
-        editText6.addTextChangedListener(FormatWatcher(getStringResource(R.string.format_set6),
-            placeholderInFormat = '#'))
-        editText7.addTextChangedListener(FormatWatcher(getStringResource(R.string.format_set7),
-            placeholderInFormat = '#'))
+        editText1.handleEditTextFormatting(formatWatcher1)
+        editText2.handleEditTextFormatting(formatWatcher2)
+        editText3.handleEditTextFormatting(formatWatcher3)
+        editText4.handleEditTextFormatting(formatWatcher4)
+        editText5.handleEditTextFormatting(formatWatcher5)
+        editText6.handleEditTextFormatting(formatWatcher6)
+        editText7.handleEditTextFormatting(formatWatcher7)
+    }
+
+    private fun EditText.handleEditTextFormatting(
+        formatWatcher: FormatWatcher,
+    ) = this.apply {
+        addTextChangedListener(formatWatcher)
+        setOnLongClickListener {
+            showSnackbarMessage(formatWatcher.rawInput, formatWatcher.currentInput)
+            true
+        }
     }
 
     private fun getStringResource(@StringRes id: Int): String = resources.getString(id)
+
+    private fun showSnackbarMessage(rawInput: String, formattedInput: String) =
+        Snackbar.make(rootContainer,
+            "Raw input is ${rawInput.ifEmpty { "empty" }}; the length is ${rawInput.length} \n" +
+                    "Formatted input is ${formattedInput.ifEmpty { "empty" }}; the length is ${formattedInput.length}",
+            Snackbar.LENGTH_SHORT).show()
 }

sample/src/main/res/layout/activity_main.xml

@@ -1,6 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
 <androidx.constraintlayout.widget.ConstraintLayout xmlns:android="http://schemas.android.com/apk/res/android"
     xmlns:tools="http://schemas.android.com/tools"
+    android:id="@+id/container"
     android:layout_width="match_parent"
     android:layout_height="match_parent"
     tools:context=".MainActivity">