DEV -> MAIN

.github/workflows/ci.yml

@@ -0,0 +1,35 @@
+# Thanks to https://github.com/coil-kt/coil/blob/master/.github/workflows/ci.yml
+
+name: CI
+on:
+    push:
+        branches:
+            - master
+    pull_request:
+jobs:
+    ci:
+        name: Build + Test
+        runs-on: macOS-latest
+        steps:
+            - uses: actions/checkout@v2
+
+            # Ensure .gradle/caches is empty before writing to it.
+            # This helps us stay within Github's cache size limits.
+            - name: Clean Cache
+              run: rm -rf ~/.gradle/caches
+
+            # Restore the cache.
+            # Intentionally don't set 'restore-keys' so the cache never contains redundant dependencies.
+            - uses: actions/cache@v1
+              with:
+                  path: ~/.gradle/caches
+                  key: gradle-${{ runner.os }}-${{ hashFiles('**/build.gradle') }}-${{ hashFiles('**/gradle/wrapper/gradle-wrapper.properties') }} }}
+
+            - name: Build
+              run: ./gradlew clean build
+
+            - name: Test
+              run: ./gradlew test
+
+            - name: Detekt
+              run: ./gradlew detekt

.github/workflows/gradle-wrapper-validation.yml

@@ -0,0 +1,10 @@
+name: "Validate Gradle Wrapper"
+on: [push, pull_request]
+
+jobs:
+  validation:
+    name: "Validation"
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: gradle/wrapper-validation-action@v1

MIGRATION.md

@@ -1,5 +1,27 @@
 ### Upgrade Notes
 
+#### v5.x.y
+
+v5 brings some general API cleanup which should make the usage easier. Removed generic type to simplify code.
+
+- Usages of the `FastAdapter.with()` method have been simplified
+
+```kotlin
+// old
+FastAdapter.with<ExpandableTestItem, IAdapter<ExpandableTestItem>>(itemAdapter)
+// v5
+FastAdapter.with(itemAdapter)
+```
+
+- Correct API specification for the bind method. (The payload for bindView should be immutable)
+
+```kotlin
+// old
+override fun onBindViewHolder(holder: RecyclerView.ViewHolder, position: Int, payloads: MutableList<Any>)
+// v5
+override fun onBindViewHolder(holder: RecyclerView.ViewHolder, position: Int, payloads: List<Any>)
+```
+
 #### v4.x.y
 
 v4 is a huge release changing most of the codebase to Kotlin. This comes with many refactors, and as a result of that with many breaking API changes. 

README.md

@@ -1,12 +1,21 @@
-# FastAdapter [ ![Download](https://api.bintray.com/packages/mikepenz/maven/com.mikepenz%3Afastadapter/images/download.svg) ](https://bintray.com/mikepenz/maven/com.mikepenz%3Afastadapter/_latestVersion)
+# FastAdapter [![Status](https://travis-ci.org/mikepenz/FastAdapter.svg?branch=develop)](https://travis-ci.org/mikepenz/FastAdapter) [![Download](https://api.bintray.com/packages/mikepenz/maven/com.mikepenz%3Afastadapter/images/download.svg)](https://bintray.com/mikepenz/maven/com.mikepenz%3Afastadapter/_latestVersion)
 
-> The RecyclerView is one of the most used widgets in the Android world, and with it you have to implement an Adapter which provides the items for the view. Most use cases require the same base logic, but require you to write everything again and again.
+The FastAdapter is here to simplify creating adapters for RecyclerViews. Don't worry about the adapter anymore. Just write the logic for how your view/item should look like, and you are done.
+It's blazingly fast, minimizing the code you need to write, and is easy to extend.
 
-The FastAdapter is here to simplify this process. You don't have to worry about the adapter anymore. Just write the logic for how your view/item should look like, and you are done.
-This library has a fast and highly optimized core which provides core functionality, most apps require. It also prevents common mistakes by taking away those steps from the devs. 
-Beside being blazing fast, minimizing the code you need to write, it is also really easy to extend. Just provide another adapter implementation, hook into the adapter chain, custom select / deselection behaviors. Everything is possible.
+-------
 
-## A quick overview:
+<p align="center">
+    <a href="#whats-included-">What's included 🚀</a> &bull;
+    <a href="#setup">Setup 🛠️</a> &bull;
+    <a href="MIGRATION.md">Migration Guide 🧬</a> &bull;
+    <a href="#used-by">Used by</a> &bull;
+    <a href="https://play.google.com/store/apps/details?id=com.mikepenz.fastadapter.app">Sample App</a>
+</p>
+
+-------
+
+### What's included 🚀
 - Core module 100% in Kotlin
 - Click / Long-Click listeners
 - Selection / Multi-Selection ([MultiselectSample](https://github.com/mikepenz/FastAdapter/blob/develop/app/src/main/java/com/mikepenz/fastadapter/app/MultiselectSampleActivity.kt), [CheckBoxSample](https://github.com/mikepenz/FastAdapter/blob/develop/app/src/main/java/com/mikepenz/fastadapter/app/CheckBoxSampleActivity.kt), [RadioButtonSample](https://github.com/mikepenz/FastAdapter/blob/develop/app/src/main/java/com/mikepenz/fastadapter/app/RadioButtonSampleActivity.kt))
@@ -26,26 +35,24 @@ Beside being blazing fast, minimizing the code you need to write, it is also rea
 - Comes with useful Helpers
  - ActionModeHelper ([MultiselectSample](https://github.com/mikepenz/FastAdapter/blob/develop/app/src/main/java/com/mikepenz/fastadapter/app/MultiselectSampleActivity.kt))
  - UndoHelper ([MultiselectSample](https://github.com/mikepenz/FastAdapter/blob/develop/app/src/main/java/com/mikepenz/fastadapter/app/MultiselectSampleActivity.kt))
- - More to come...
 - FastScroller (external lib) ([SimpleItemListSample](https://github.com/mikepenz/FastAdapter/blob/develop/app/src/main/java/com/mikepenz/fastadapter/app/SimpleItemListActivity.kt))
 - Paging (via Jetpack paging lib) ([PagedActivity](https://github.com/mikepenz/FastAdapter/blob/develop/app/src/main/java/com/mikepenz/fastadapter/app/PagedActivity.kt))
+ - More to come...
 
 # Preview
-## Demo
-You can try it out here [Google Play](https://play.google.com/store/apps/details?id=com.mikepenz.fastadapter.app) (or download the latest release from GitHub)
 
-## Screenshots
+## Screenshots 🎉
 ![Image](https://raw.githubusercontent.com/mikepenz/FastAdapter/develop/DEV/github/screenshots1.jpg)
 
+# Setup
 
-# Include in your project
-## Latest releases
+## Latest releases 🛠
 
-- Kotlin | [v4.1.2](https://github.com/mikepenz/FastAdapter/tree/v4.1.2)
+- Kotlin | [v5.2.4](https://github.com/mikepenz/FastAdapter/tree/v5.2.4)
 - Java && AndroidX | [v3.3.1](https://github.com/mikepenz/FastAdapter/tree/v3.3.1)
 - Java && AppCompat | [v3.2.9](https://github.com/mikepenz/FastAdapter/tree/v3.2.9)
 
-## Using Maven
+## Provide the gradle dependency
 
 The library is split up into core, commons, and extensions. The core functions are included in the following dependency.
 ```gradle
@@ -57,31 +64,26 @@ implementation "androidx.recyclerview:recyclerview:${androidX}"
 Expandable support is included and can be added via this
 ```gradle
 implementation "com.mikepenz:fastadapter-extensions-expandable:${latestFastAdapterRelease}"
-//The tiny Materialize library used for its useful helper classes
-implementation "com.mikepenz:materialize:${latestVersion}" // at least 1.2.0
 ```
 
 Many helper classes are included in the following dependency.
 ```gradle
+implementation "com.mikepenz:fastadapter-extensions-binding:${latestFastAdapterRelease}" // view binding helpers
 implementation "com.mikepenz:fastadapter-extensions-diff:${latestFastAdapterRelease}" // diff util helpers
 implementation "com.mikepenz:fastadapter-extensions-drag:${latestFastAdapterRelease}" // drag support
 implementation "com.mikepenz:fastadapter-extensions-paged:${latestFastAdapterRelease}" // paging support
-implementation "com.mikepenz:fastadapter-extensions-scroll${latestFastAdapterRelease}" // scroll helpers
+implementation "com.mikepenz:fastadapter-extensions-scroll:${latestFastAdapterRelease}" // scroll helpers
 implementation "com.mikepenz:fastadapter-extensions-swipe:${latestFastAdapterRelease}" // swipe support
 implementation "com.mikepenz:fastadapter-extensions-ui:${latestFastAdapterRelease}" // pre-defined ui components
 implementation "com.mikepenz:fastadapter-extensions-utils:${latestFastAdapterRelease}" // needs the `expandable`, `drag` and `scroll` extension.
 
 // required for the ui components and the utils
 implementation "com.google.android.material:material:${androidX}"
-//The tiny Materialize library used for its useful helper classes
-implementation "com.mikepenz:materialize:${latestVersion}" // at least 1.2.0
 ```
 
-## v4.x.y
-> Major release, migrates fully to Kotlin. Check out the changelog or the [MIGRATION GUIDE](https://github.com/mikepenz/FastAdapter/blob/develop/MIGRATION.md for more details
-
 ## How to use
-### 1. Implement your item (the easy way)
+### 1. Implement your item
+#### 1a. Implement your item as usual (the easy way)
 Just create a class which extends the `AbstractItem` as shown below. Implement the methods, and your item is ready.
 ```kotlin
 open class SimpleItem : AbstractItem<SimpleItem.ViewHolder>() {
@@ -92,7 +94,7 @@ open class SimpleItem : AbstractItem<SimpleItem.ViewHolder>() {
     override val type: Int
         get() = R.id.fastadapter_sample_item_id
 
-    /** defines the layout which will be used for this item in the list  */
+    /** defines the layout which will be used for this item in the list */
     override val layoutRes: Int
         get() = R.layout.sample_item
 
@@ -104,7 +106,7 @@ open class SimpleItem : AbstractItem<SimpleItem.ViewHolder>() {
         var name: TextView = view.findViewById(R.id.material_drawer_name)
         var description: TextView = view.findViewById(R.id.material_drawer_description)
 
-        override fun bindView(item: SimpleItem, payloads: MutableList<Any>) {
+        override fun bindView(item: SimpleItem, payloads: List<Any>) {
             name.text = item.name
             description.text = item.name
         }
@@ -118,6 +120,26 @@ open class SimpleItem : AbstractItem<SimpleItem.ViewHolder>() {
 
 ```
 
+#### 1b. Implement item with ViewBinding (the easiest way)
+
+```kotlin
+class BindingIconItem : AbstractBindingItem<IconItemBinding>() {
+    var name: String? = null
+
+    override val type: Int
+        get() = R.id.fastadapter_icon_item_id
+
+    override fun bindView(binding: IconItemBinding, payloads: List<Any>) {
+        binding.name.text = name
+    }
+
+    override fun createBinding(inflater: LayoutInflater, parent: ViewGroup?): IconItemBinding {
+        return IconItemBinding.inflate(inflater, parent, false)
+    }
+}
+```
+Use the `binding` extension dependency in your application for this.
+
 ### 2. Set the Adapter to the RecyclerView
 ```kotlin
 //create the ItemAdapter holding your Items
@@ -226,7 +248,7 @@ override fun itemTouchOnMove(oldPosition: Int, newPosition: Int): Boolean {
 Start by initializing your adapters:
 
 ```kotlin
-// Head is a model class for your header
+// Header is a model class for your header
 val headerAdapter = ItemAdapter<Header>()
 ```
 
@@ -295,9 +317,9 @@ open class SimpleSubExpandableItem : AbstractExpandableItem<SimpleSubExpandableI
 
 
 ## Articles
-- [RecyclerView Adapter made easy](http://blog.grafixartist.com/recyclerview-adapter-android-made-fast-easy/) (FastAdapter v2.x)
+- [RecyclerView Adapter made easy](https://blog.iamsuleiman.com/recyclerview-adapter-android-made-fast-easy/) (FastAdapter v2.x)
 
-## Libs used in sample app:
+## Used by
 Mike Penz:
 - AboutLibraries https://github.com/mikepenz/AboutLibraries
 - Android-Iconics https://github.com/mikepenz/Android-Iconics
@@ -332,10 +354,11 @@ A special thanks to the very active contributors who added many improvements to
 
 * **[Allan Wang](https://github.com/AllanWang)** 
 * **[MFlisar](https://github.com/MFlisar)**
+* **[RobbWatershed](https://github.com/RobbWatershed)**
 
 # License
 
-    Copyright 2019 Mike Penz
+    Copyright 2020 Mike Penz
 
     Licensed under the Apache License, Version 2.0 (the "License");
     you may not use this file except in compliance with the License.