Kirai


Source link: https://github.com/pwittchen/kirai

Kirai

Kirai means phrase in Swahili language. It's string formatting library for Java, Android, Web and Unix Terminal.

Project is inspired by phrase, TaggerString and BabushkaText. Kirai has fluent API similar to phrase with additional formatting similar to TaggerString and allows to add formatted pieces of text like BabushkaText.

JavaDoc is available at: http://pwittchen.github.io/kirai/

Library is compatible with Java 1.7 and higher. It should work with Java 1.6 and is compatible with Android applications.

Contents

Usage

Basic

CharSequence formatted = Kirai
.from("Hi {
first_name
}
, your are {
age
}
 years old.")
.put("first_name", firstName)
.put("age", age)
.format();

Android

CharSequence formatted = Kirai
.from("Hi {
first_name
}
, your are {
age
}
 years old.")
.put(HtmlPiece.put("first_name", firstName).bold().italic().big())
.put(HtmlPiece.put("age", age).underline().color("#FF0000"))
.format(new Formatter() {

  @Override public CharSequence format(String input) {

 return Html.fromHtml(input);

  
}

}
);

Code above will generate formatted text and can be used in Android TextView as follows:

textView.setText(formatted);

Web

CharSequence formatted = Kirai
.from("Hi {
first_name
}
, your are {
age
}
 years old.")
.put(HtmlPiece.put("first_name", firstName).bold().italic().big())
.put(HtmlPiece.put("age", age).underline().color("#FF0000"))
.format();

Code above will generate text formatted with HTML tags.

Terminal

CharSequence formatted = Kirai
.from("Hi {
first_name
}
, your are {
age
}
 years old.")
.put(TerminalPiece.put("first_name", firstName).background(TerminalBgColor.DARK_GRAY).bold())
.put(TerminalPiece.put("age", age).color(TerminalColor.CYAN).underline())
.format();

Code above will generate formatted text ready to display in Unix terminal as follows:

System.out.println(formatted);

instead of TerminalColor and TerminalBgColor enums we can pass color code as a string to color(string) method and it will work as well. We can use it for setting foreground and background color. For the reference of color codes take a look at http://misc.flogisoft.com/bash/tip_colors_and_formatting website.

Download

You can depend on the library through Maven:

<dependency>
  <groupId>com.github.pwittchen.kirai</groupId>
  <artifactId>library</artifactId>
  <version>1.4.1</version> </dependency>

or through Gradle:

dependencies {

compile 'com.github.pwittchen.kirai:library:1.4.1' 
}

Building project

To build project, run the following command:

./gradlew build 

Tests

Unit Tests are available in library/src/test directory. They can be run from IntelliJ IDEA or CLI with Gradle Wrapper. Tests were written according to TDD methodology. They determine library specification and check if project is fault-tolerant. Code Coverage is monitored by codecov.io integrated with Travis CI.

To execute tests, run the following command:

./gradlew test 

To generate code coverage report, run the following command:

./gradlew jacocoTestReport 

All reports are generated in build/reports/ directory.

Static Code Analysis

Project has Static Code Analysis configured in build.gradle file. It consists of CheckStyle, PMD and FindBugs.

Static Code Analysis can be executed with the following command:

./gradlew check 

Code style

Code style used in the project is called Square from Java Code Styles repository by Square available at: https://github.com/square/java-code-styles.

License

Copyright 2015 Piotr Wittchen  Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License. You may obtain a copy of the License at
  http://www.apache.org/licenses/LICENSE-2.0  Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. 

Resources

The library allows you to check if a specific application is installed or not by its package name. Also you have a helper which provides the packagenames of the most popular applications.

Periodically tracking user's location in the background.

DataFragment is a tiny tiny library that helps to prevent a little boilerplate code for retained data fragments in Android. This is really useful for holding data and long-running tasks over activity lifecycle, namely orientation changes.

Multiselect library is a powerful library to select multiple images and videos efficiently.

Common RecyclerView decorations and helpers for the Android platform.

Demo for the EventBus library of GreenRobot.

Topics


2D Engines   3D Engines   9-Patch   Action Bars   Activities   ADB   Advertisements   Analytics   Animations   ANR   AOP   API   APK   APT   Architecture   Audio   Autocomplete   Background Processing   Backward Compatibility   Badges   Bar Codes   Benchmarking   Bitmaps   Bluetooth   Blur Effects   Bread Crumbs   BRMS   Browser Extensions   Build Systems   Bundles   Buttons   Caching   Camera   Canvas   Cards   Carousels   Changelog   Checkboxes   Cloud Storages   Color Analysis   Color Pickers   Colors   Comet/Push   Compass Sensors   Conferences   Content Providers   Continuous Integration   Crash Reports   Credit Cards   Credits   CSV   Curl/Flip   Data Binding   Data Generators   Data Structures   Database   Database Browsers   Date &   Debugging   Decompilers   Deep Links   Dependency Injections   Design   Design Patterns   Dex   Dialogs   Distributed Computing   Distribution Platforms   Download Managers   Drawables   Emoji   Emulators   EPUB   Equalizers &   Event Buses   Exception Handling   Face Recognition   Feedback &   File System   File/Directory   Fingerprint   Floating Action   Fonts   Forms   Fragments   FRP   FSM   Functional Programming   Gamepads   Games   Geocaching   Gestures   GIF   Glow Pad   Gradle Plugins   Graphics   Grid Views   Highlighting   HTML   HTTP Mocking   Icons   IDE   IDE Plugins   Image Croppers   Image Loaders   Image Pickers   Image Processing   Image Views   Instrumentation   Intents   Job Schedulers   JSON   Keyboard   Kotlin   Layouts   Library Demos   List View   List Views   Localization   Location   Lock Patterns   Logcat   Logging   Mails   Maps   Markdown   Mathematics   Maven Plugins   MBaaS   Media   Menus   Messaging   MIME   Mobile Web   Native Image   Navigation   NDK   Networking   NFC   NoSQL   Number Pickers   OAuth   Object Mocking   OCR Engines   OpenGL   ORM   Other Pickers   Parallax List   Parcelables   Particle Systems   Password Inputs   PDF   Permissions   Physics Engines   Platforms   Plugin Frameworks   Preferences   Progress Indicators   ProGuard   Properties   Protocol Buffer   Pull To   Purchases   Push/Pull   QR Codes   Quick Return   Radio Buttons   Range Bars   Ratings   Recycler Views   Resources   REST   Ripple Effects   RSS   Screenshots   Scripting   Scroll Views   SDK   Search Inputs   Security   Sensors   Services   Showcase Views   Signatures   Sliding Panels   Snackbars   SOAP   Social Networks   Spannable   Spinners   Splash Screens   SSH   Static Analysis   Status Bars   Styling   SVG   System   Tags   Task Managers   TDD &   Template Engines   Testing   Testing Tools   Text Formatting   Text Views   Text Watchers   Text-to   Toasts   Toolkits For   Tools   Tooltips   Trainings   TV   Twitter   Updaters   USB   User Stories   Utils   Validation   Video   View Adapters   View Pagers   Views   Watch Face   Wearable Data   Wearables   Weather   Web Tools   Web Views   WebRTC   WebSockets   Wheel Widgets   Wi-Fi   Widgets   Windows   Wizards   XML   XMPP   YAML   ZIP Codes