Merge pull request #8 from DevAhamed/develop

1.1.0 release

Author: DevAhamed

README.md

@@ -19,7 +19,7 @@ The minimum API level supported by this library is API 9.
 ```gradle
 dependencies {
 	// ... other dependencies here
-    compile 'com.github.devahamed:multi-view-adapter:1.0.1'
+    compile 'com.github.devahamed:multi-view-adapter:1.1.0'
 }
 ```
 
@@ -61,164 +61,7 @@ You can read more about this library here in this [Medium article](https://mediu
 
 ## Usage
 To get some idea about the MultiViewAdapter features kindly look at sample app code.
-
-### Simple adapters
-Let us display list of cars. No fuss. Here is the entire code.
-
-<b>CarBinder</b>
- 
-```java
-class CarBinder extends ItemBinder<CarModel, CarBinder.CarViewHolder> {
-
-  @Override public CarViewHolder create(LayoutInflater inflater, ViewGroup parent) {
-    return new CarViewHolder(inflater.inflate(R.layout.item_car, parent, false));
-  }
-
-  @Override public boolean canBindData(Object item) {
-    return item instanceof CarModel;
-  }
-
-  @Override public void bind(CarViewHolder holder, CarModel item) {
-    // Bind the data here
-  }
-
-  static class CarViewHolder extends BaseViewHolder<CarModel> {
-    // Normal ViewHolder code
-  }
-}
-```
-
-<b>CarAdapter</b>
-
-```java
-class CarAdapter extends RecyclerAdapter {
-
-  private DataListManager<CarModel> dataManager;
-
-  public SimpleAdapter() {
-    this.dataManager = new DataListManager<>(this);
-    addDataManager(dataManager);
-
-    registerBinder(new CarBinder());
-  }
-
-  public void addData(List<CarModel> dataList) {
-    dataManager.addAll(dataList);
-  }
-}
-```
-
-Now you are good to go. Just create the CarAdapter object and set it to your recyclerview. When addData() method is called it will show the items in recyclerview.
-<br/>
-If you want to show multiple viewtypes just create multiple ItemBinders and register inside the adapter.
- 
-### For different span count in GridLayoutManager
-If the GridLayoutManager has different span count for different view types, then override the getSpanSize() method inside ItemBinder.
-
-```
-
-  @Override public int getSpanSize(int maxSpanCount) {
-    return 1; // Return any number which is less than maxSpanCount 
-  }
-
-```
-
-Also don't forget to set span size lookup in GridLayoutManager. Adapter has default span size lookup object. Use that object.
-
-```
-layoutManager.setSpanSizeLookup(adapter.getSpanSizeLookup());
-```
-
-### ItemDecoration support
-Create your own item decoration class implementing ItemDecorator. It goes like this,
-
-
-```java
-
-public class MyItemDecorator implements ItemDecorator {
-
-  public MyItemDecorator() {
-    // Any initialization code
-  }
-
-  @Override public void getItemOffsets(Rect outRect, int position, int positionType) {
-    // Set item offset for each item
-    // outRect.set(0, 0, 0, 0);
-  }
-
-  @Override public void onDraw(Canvas canvas, RecyclerView parent, View child, int position,
-      int positionType) {
-    // Canvas drawing code implementation
-    // Unlike default ItemDecoration, this method will be called for individual items. Do not create objects here.
-  }
-}
-
-```
-
-The methods, getItemOffsets and onDraw will be called for each item. So avoid creating objects there.
-<br/> 
-MyItemDecorator will be used with the ItemBinder as follows.
-
-
-```java
-
-public class CustomItemBinder implements ItemBinder {
-
-  public CustomItemBinder(MyItemDecorator myItemDecorator) {
-    super(myItemDecorator);
-  }
-}
-
-```
-
-### Making RecyclerView selectable
-Just extend your adapter from SelectableAdapter instead of RecyclerAdapter. Now the adapter is selectable. 
-To make an ItemBinder as selectable, extend it from SelectableBinder and also extend ViewHolder from SelectableViewHolder. 
-By default, on long press ViewHolder will be selectable if it extends from SelectableViewHolder. 
-You can also call `itemSelectionToggled()` to make it selected by yourself. Kindly go through the sample repo implementation.
-<br/>
-Finally, you can call `DataListManager`'s `getSelectedItems()` and `setSelectedItems(List<E> selectedItems)` to get and set selected items respectively.
-
-### Using DiffUtil and Payload
-DataListManager and DataItemManager will take care of diffutil. There is no special code needed. But to enable the payloads, you have to pass PayloadProvider to DataListManager's constructor.
-
-
-```java
-class CarAdapter extends RecyclerAdapter {
-
-  private DataListManager<CarModel> dataManager;
-  private PayloadProvider<M> payloadProvider = new PayloadProvider<CarModel>() {
-      @Override public boolean areContentsTheSame(CarModel oldItem, CarModel newItem) {
-        // Your logic here
-        return oldItem.equals(newItem);
-      }
-
-      @Override public Object getChangePayload(CarModel oldItem, CarModel newItem) {
-        // Your logic here
-        return null;
-      }
-  };
-
-  public CarAdapter() {
-    this.dataManager = new DataListManager<>(this, payloadProvider);
-    addDataManager(dataManager);
-
-    registerBinder(new CarBinder());
-  }
-
-  public void addData(List<CarModel> dataList) {
-    dataManager.addAll(dataList);
-  }
-}
-```
-
-## Roadmap
-I am actively working on expanding the feature set of this library. While i don't have a exact timeline, but here are the future plans. All these will be taken up once 1.0 is released.
-1. Add support for StaggeredGrid layout manager
-2. Move diffutil calculation to background thread
-3. Adding support for swipe listeners with composability as priority
-4. Improve the sample app code and api documentation
-5. Expandable item / group
+Also we have comprehensive wiki pages as well. Take a look at [JCenter](https://github.com/DevAhamed/MultiViewAdapter/wiki).
 
 
 ## Changelog
@@ -236,7 +79,7 @@ Kindly make sure your code is formatted with this codestyle - [Square Java code
 
 
 ## Alternatives
-This library may not suit your needs or imposes too many restrictions. In that case create an issue/feature request. In the mean time check these awesome alternatives as well.
+This library may not suit your needs or imposes too many restrictions. In that case create an issue/feature request. Mean time check these awesome alternatives as well.
 1. [MultipleViewTypesAdapter](https://github.com/yqritc/RecyclerView-MultipleViewTypesAdapter) - Original inspiration for this library.<br/>
 2. [AdapterDelegates](https://github.com/sockeqwe/AdapterDelegates)
 3. [Groupie](https://github.com/lisawray/groupie)

images/File-Template-Cover.png

@@ -0,0 +1 @@
+/build

images/File-Template-Menu.png

@@ -0,0 +1,79 @@
+/*
+ * Copyright 2017 Riyaz Ahamed
+ *
+ * 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.
+ */
+
+apply plugin: 'com.android.library'
+
+def devPropertiesFile = rootProject.file("developer.properties");
+def devProperties = new Properties()
+devProperties.load(new FileInputStream(devPropertiesFile))
+
+android {
+  compileSdkVersion 25
+  buildToolsVersion "25.0.3"
+
+  defaultConfig {
+    minSdkVersion 9
+    targetSdkVersion 25
+    versionCode 1
+    versionName "1.0"
+
+    testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"
+  }
+  buildTypes {
+    release {
+      minifyEnabled false
+      proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
+    }
+  }
+}
+
+dependencies {
+  compile project(':multi-view-adapter')
+  provided('com.android.databinding:library:1.3.1') {
+    transitive = false
+  }
+  provided('com.android.databinding:baseLibrary:2.3.2') {
+    transitive = false
+  }
+}
+
+ext {
+
+  bintrayRepo = devProperties['repoName']
+  bintrayName = devProperties['artifactId']
+
+  publishedGroupId = devProperties['groupId']
+  libraryName = devProperties['repoName']
+  artifact = devProperties['artifactIdDataBinding']
+
+  libraryDescription = 'Additional DataBinding support for MultiViewAdapter'
+
+  siteUrl = 'https://github.com/DevAhamed/MultiViewAdapter'
+  gitUrl = 'https://github.com/DevAhamed/MultiViewAdapter.git'
+
+  libraryVersion = '1.1.0'
+
+  developerId = devProperties['devId']
+  developerName = devProperties['devName']
+  developerEmail = devProperties['devEmail']
+
+  licenseName = 'The Apache Software License, Version 2.0'
+  licenseUrl = 'http://www.apache.org/licenses/LICENSE-2.0.txt'
+  allLicenses = ["Apache-2.0"]
+}
+
+apply from: '../install.gradle'
+apply from: '../bintray.gradle'

images/contexual-action-mode.gif

@@ -0,0 +1,25 @@
+# Add project specific ProGuard rules here.
+# By default, the flags in this file are appended to flags specified
+# in /Users/Ahamed/Library/Android/sdk/tools/proguard/proguard-android.txt
+# You can edit the include path and order by changing the proguardFiles
+# directive in build.gradle.
+#
+# For more details, see
+#   http://developer.android.com/guide/developing/tools/proguard.html
+
+# Add any project specific keep options here:
+
+# If your project uses WebView with JS, uncomment the following
+# and specify the fully qualified class name to the JavaScript interface
+# class:
+#-keepclassmembers class fqcn.of.javascript.interface.for.webview {
+#   public *;
+#}
+
+# Uncomment this to preserve the line number information for
+# debugging stack traces.
+#-keepattributes SourceFile,LineNumberTable
+
+# If you keep the line number information, uncomment this to
+# hide the original source file name.
+#-renamesourcefileattribute SourceFile

images/drag-and-drop.gif

@@ -1,4 +1,3 @@
-<?xml version="1.0" encoding="utf-8"?>
 <!--
   ~ Copyright 2017 Riyaz Ahamed
   ~
@@ -15,11 +14,4 @@
   ~ limitations under the License.
   -->
 
-<LinearLayout
-    xmlns:android="http://schemas.android.com/apk/res/android"
-    android:layout_width="wrap_content"
-    android:layout_height="wrap_content"
-    android:orientation="horizontal"
-    >
-
-</LinearLayout>
+<manifest package="com.ahamed.multiviewadapter.databinding" />

images/expandable-group.gif

@@ -24,11 +24,11 @@
  * @param <M> Refers to the model class
  * @param <VDB> Refers to the DataBinding class of the model
  */
-public abstract class BindingViewHolder<M, VDB extends ViewDataBinding> extends BaseViewHolder<M> {
+abstract class BindingViewHolder<M, VDB extends ViewDataBinding> extends BaseViewHolder<M> {
 
   private final VDB binding;
 
-  public BindingViewHolder(VDB binding) {
+  BindingViewHolder(VDB binding) {
     super(binding.getRoot());
     this.binding = binding;
   }

images/multi-list.gif

@@ -21,7 +21,7 @@
 import android.view.ViewGroup;
 
 /**
- * {@link ItemBinder} which supports the DataBinding
+ * ItemBinder which supports the DataBinding
  *
  * @param <M> Refers to the model class
  * @param <VDB> Refers to the view binding of the model class

images/swipe-to-dismiss.gif

@@ -32,7 +32,7 @@ android {
     minSdkVersion 9
     targetSdkVersion 25
     versionCode 1
-    versionName "1.0.1"
+    versionName "1.1.0"
 
     testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"
   }
@@ -62,7 +62,7 @@ ext {
   siteUrl = 'https://github.com/DevAhamed/MultiViewAdapter'
   gitUrl = 'https://github.com/DevAhamed/MultiViewAdapter.git'
 
-  libraryVersion = '1.0.1'
+  libraryVersion = '1.1.0'
 
   developerId = devProperties['devId']
   developerName = devProperties['devName']

multi-view-adapter-databinding/.gitignore

@@ -14,6 +14,4 @@
   ~ limitations under the License.
   -->
 
-<manifest
-    package="com.ahamed.multiviewadapter"
-    />
+<manifest package="com.ahamed.multiviewadapter"/>