Merge pull request #25 from rubensousa/dev

2.0.2
rubensousa · Jun 6, 2022 · 3d4d9e3 · 3d4d9e3
2 parents c473435 + 293cbd4
commit 3d4d9e3
Show file tree

Hide file tree

Showing 12 changed files with 46 additions and 108 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,8 @@
+# 2.0.2
+
+- Moved `setDecorationLookup` to `AbstractMarginDecoration`
+- Added new `shouldApplyDecorationAt` to `AbstractMarginDecoration`
+
 # 2.0.1
 
 - Added support for `ConcatAdapter`. `DecorationLookup` now receives the absolute adapter position.

diff --git a/README.md b/README.md
@@ -9,7 +9,7 @@ Decorator is a library that helps creating composable margins and dividers in Re
 ## Install
 
 ```groovy
-implementation 'com.rubensousa:decorator:2.0.1'
+implementation 'com.rubensousa:decorator:2.0.2'
 ```
 
 ## How to use

diff --git a/decorator/gradle.properties b/decorator/gradle.properties
@@ -13,7 +13,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-LIBRARY_VERSION=2.0.1
+LIBRARY_VERSION=2.0.2
 LIBRARY_GROUP=com.rubensousa
 LIBRARY_ARTIFACT=decorator
 # POM info

diff --git a/decorator/src/main/java/com/rubensousa/decorator/AbstractMarginDecoration.kt b/decorator/src/main/java/com/rubensousa/decorator/AbstractMarginDecoration.kt
@@ -24,7 +24,7 @@ import androidx.recyclerview.widget.RecyclerView
  * A base [RecyclerView.ItemDecoration] that checks if item offsets should be applied
  * for a given position using [DecorationLookup]
  */
-abstract class AbstractMarginDecoration(private val decorationLookup: DecorationLookup?) :
+abstract class AbstractMarginDecoration(private var decorationLookup: DecorationLookup?) :
     RecyclerView.ItemDecoration() {
 
     final override fun getItemOffsets(
@@ -36,14 +36,31 @@ abstract class AbstractMarginDecoration(private val decorationLookup: Decoration
         val lm = parent.layoutManager as RecyclerView.LayoutManager
         val layoutParams = view.layoutParams as RecyclerView.LayoutParams
         val position = layoutParams.absoluteAdapterPosition
-        if (position != RecyclerView.NO_POSITION &&
-            (decorationLookup == null ||
-                    decorationLookup.shouldApplyDecoration(position, lm.itemCount))
-        ) {
+        if (shouldApplyDecorationAt(position, lm.itemCount)) {
             getItemOffsets(outRect, view, position, parent, state, lm)
         }
     }
 
+    /**
+     * @param decorationLookup an optional [DecorationLookup] to filter positions
+     * that shouldn't have this decoration applied to
+     */
+    fun setDecorationLookup(decorationLookup: DecorationLookup?) {
+        this.decorationLookup = decorationLookup
+    }
+
+    /**
+     * @return true if decoration will be applied for [position]
+     * or false if position is not valid
+     * or [decorationLookup] doesn't allow decoration for this [position]
+     */
+    fun shouldApplyDecorationAt(position: Int, itemCount: Int): Boolean {
+        if (position == RecyclerView.NO_POSITION) {
+            return false
+        }
+        return decorationLookup?.shouldApplyDecoration(position, itemCount) ?: true
+    }
+
     abstract fun getItemOffsets(
         outRect: Rect,
         view: View,

diff --git a/decorator/src/main/java/com/rubensousa/decorator/GridBoundsMarginDecoration.kt b/decorator/src/main/java/com/rubensousa/decorator/GridBoundsMarginDecoration.kt
@@ -53,7 +53,7 @@ class GridBoundsMarginDecoration(
     private var columnProvider: ColumnProvider,
     private var orientation: Int = RecyclerView.VERTICAL,
     private var inverted: Boolean = false,
-    private var decorationLookup: DecorationLookup? = null
+    decorationLookup: DecorationLookup? = null
 ) : AbstractMarginDecoration(decorationLookup) {
 
     companion object {
@@ -194,10 +194,6 @@ class GridBoundsMarginDecoration(
 
     fun isInverted() = inverted
 
-    fun setDecorationLookup(decorationLookup: DecorationLookup?) {
-        this.decorationLookup = decorationLookup
-    }
-
     override fun getItemOffsets(
         outRect: Rect,
         view: View,

diff --git a/decorator/src/main/java/com/rubensousa/decorator/GridDividerDecoration.kt b/decorator/src/main/java/com/rubensousa/decorator/GridDividerDecoration.kt
@@ -53,7 +53,7 @@ class GridDividerDecoration(
     private val columnProvider: ColumnProvider,
     private var orientation: Int = RecyclerView.VERTICAL,
     private var inverted: Boolean = false,
-    private var decorationLookup: DecorationLookup? = null
+    decorationLookup: DecorationLookup? = null
 ) : AbstractMarginDecoration(decorationLookup) {
 
     companion object {
@@ -125,14 +125,6 @@ class GridDividerDecoration(
 
     fun isInverted() = inverted
 
-    /**
-     * @param decorationLookup an optional [DecorationLookup] to filter positions
-     * that shouldn't have this decoration applied to
-     */
-    fun setDecorationLookup(decorationLookup: DecorationLookup?) {
-        this.decorationLookup = decorationLookup
-    }
-
     override fun getItemOffsets(
         outRect: Rect,
         view: View,
@@ -158,27 +150,16 @@ class GridDividerDecoration(
         for (i in 0 until parent.childCount) {
             val child = parent.getChildAt(i)
             val adapterPosition = parent.getChildAdapterPosition(child)
-            if (canApplyDecorationAt(adapterPosition, itemCount)) {
+            if (shouldApplyDecorationAt(adapterPosition, itemCount)) {
                 if (orientation == RecyclerView.VERTICAL) {
-                    drawVertical(c, child, adapterPosition, itemCount, columns, layoutManager)
+                    drawVertical(c, child, adapterPosition, itemCount, columns)
                 } else {
-                    drawHorizontal(c, child, adapterPosition, itemCount, columns, layoutManager)
+                    drawHorizontal(c, child, adapterPosition, itemCount, columns)
                 }
             }
         }
     }
 
-    private fun canApplyDecorationAt(position: Int, itemCount: Int): Boolean {
-        if (position == RecyclerView.NO_POSITION) {
-            return false
-        }
-        if (decorationLookup == null) {
-            return true
-        }
-
-        return decorationLookup!!.shouldApplyDecoration(position, itemCount)
-    }
-
     private fun applyVerticalOffsets(outRect: Rect, position: Int, columns: Int, itemCount: Int) {
         val columnIndex = position.rem(columns)
         val lines = Math.ceil(itemCount / columns.toDouble()).toInt()
@@ -297,15 +278,14 @@ class GridDividerDecoration(
         view: View,
         position: Int,
         itemCount: Int,
-        columns: Int,
-        layoutManager: RecyclerView.LayoutManager
+        columns: Int
     ) {
         val bottomPosition = if (!inverted) {
             getBottomPosition(position, columns, itemCount)
         } else {
             getTopPosition(position, columns)
         }
-        if (bottomPosition != null && canApplyDecorationAt(bottomPosition, itemCount)) {
+        if (bottomPosition != null && shouldApplyDecorationAt(bottomPosition, itemCount)) {
             canvas.drawRect(
                 view.left.toFloat() + heightMargin,
                 view.bottom.toFloat() + widthMargin,
@@ -316,7 +296,7 @@ class GridDividerDecoration(
         }
 
         val rightPosition = getRightPosition(position, columns, itemCount)
-        if (rightPosition != null && canApplyDecorationAt(rightPosition, itemCount)) {
+        if (rightPosition != null && shouldApplyDecorationAt(rightPosition, itemCount)) {
             canvas.drawRect(
                 view.right.toFloat() + widthMargin,
                 view.top.toFloat() + heightMargin,
@@ -332,15 +312,14 @@ class GridDividerDecoration(
         view: View,
         position: Int,
         itemCount: Int,
-        columns: Int,
-        layoutManager: RecyclerView.LayoutManager
+        columns: Int
     ) {
         val bottomPosition = if (!inverted) {
             getBottomPosition(position, columns, itemCount)
         } else {
             getTopPosition(position, columns)
         }
-        if (bottomPosition != null && canApplyDecorationAt(bottomPosition, itemCount)) {
+        if (bottomPosition != null && shouldApplyDecorationAt(bottomPosition, itemCount)) {
             canvas.drawRect(
                 view.right.toFloat() + widthMargin,
                 view.top.toFloat() + heightMargin,
@@ -351,7 +330,7 @@ class GridDividerDecoration(
         }
 
         val rightPosition = getRightPosition(position, columns, itemCount)
-        if (rightPosition != null && canApplyDecorationAt(rightPosition, itemCount)) {
+        if (rightPosition != null && shouldApplyDecorationAt(rightPosition, itemCount)) {
             canvas.drawRect(
                 view.left.toFloat() + heightMargin,
                 view.bottom.toFloat() + widthMargin,

diff --git a/decorator/src/main/java/com/rubensousa/decorator/GridMarginDecoration.kt b/decorator/src/main/java/com/rubensousa/decorator/GridMarginDecoration.kt
@@ -50,7 +50,7 @@ class GridMarginDecoration(
     private var columnProvider: ColumnProvider,
     private var orientation: Int = RecyclerView.VERTICAL,
     private var inverted: Boolean = false,
-    private var decorationLookup: DecorationLookup? = null
+    decorationLookup: DecorationLookup? = null
 ) : AbstractMarginDecoration(decorationLookup) {
 
     companion object {
@@ -160,14 +160,6 @@ class GridMarginDecoration(
         this.inverted = isInverted
     }
 
-    /**
-     * @param decorationLookup an optional [DecorationLookup] to filter positions
-     * that shouldn't have this decoration applied to
-     */
-    fun setDecorationLookup(decorationLookup: DecorationLookup?) {
-        this.decorationLookup = decorationLookup
-    }
-
     override fun getItemOffsets(
         outRect: Rect,
         view: View,

diff --git a/decorator/src/main/java/com/rubensousa/decorator/GridSpanBoundsMarginDecoration.kt b/decorator/src/main/java/com/rubensousa/decorator/GridSpanBoundsMarginDecoration.kt
@@ -50,7 +50,7 @@ class GridSpanBoundsMarginDecoration(
     @Px private var rightMargin: Int = 0,
     @Px private var bottomMargin: Int = 0,
     private var gridLayoutManager: GridLayoutManager,
-    private var decorationLookup: DecorationLookup? = null
+    decorationLookup: DecorationLookup? = null
 ) : AbstractMarginDecoration(decorationLookup) {
 
     fun setMargin(margin: Int) {
@@ -78,15 +78,6 @@ class GridSpanBoundsMarginDecoration(
 
     fun getBottomMargin() = bottomMargin
 
-    /**
-     * @param decorationLookup an optional [DecorationLookup] to filter positions
-     * that shouldn't have this decoration applied to
-     */
-    fun setDecorationLookup(decorationLookup: DecorationLookup?) {
-        this.decorationLookup = decorationLookup
-    }
-
-
     override fun getItemOffsets(
         outRect: Rect,
         view: View,

diff --git a/decorator/src/main/java/com/rubensousa/decorator/GridSpanMarginDecoration.kt b/decorator/src/main/java/com/rubensousa/decorator/GridSpanMarginDecoration.kt
@@ -43,7 +43,7 @@ class GridSpanMarginDecoration(
     @Px private var horizontalMargin: Int,
     @Px private var verticalMargin: Int,
     private var gridLayoutManager: GridLayoutManager,
-    private var decorationLookup: DecorationLookup? = null
+    decorationLookup: DecorationLookup? = null
 ) : AbstractMarginDecoration(decorationLookup) {
 
     companion object {
@@ -117,14 +117,6 @@ class GridSpanMarginDecoration(
         gridLayoutManager = layoutManager
     }
 
-    /**
-     * @param decorationLookup an optional [DecorationLookup] to filter positions
-     * that shouldn't have this decoration applied to
-     */
-    fun setDecorationLookup(decorationLookup: DecorationLookup?) {
-        this.decorationLookup = decorationLookup
-    }
-
     override fun getItemOffsets(
         outRect: Rect,
         view: View,

diff --git a/decorator/src/main/java/com/rubensousa/decorator/LinearBoundsMarginDecoration.kt b/decorator/src/main/java/com/rubensousa/decorator/LinearBoundsMarginDecoration.kt
@@ -49,7 +49,7 @@ class LinearBoundsMarginDecoration(
     @Px private var bottomMargin: Int = 0,
     private var orientation: Int = RecyclerView.VERTICAL,
     private var inverted: Boolean = false,
-    private var decorationLookup: DecorationLookup? = null
+    decorationLookup: DecorationLookup? = null
 ) : AbstractMarginDecoration(decorationLookup) {
 
     companion object {
@@ -155,14 +155,6 @@ class LinearBoundsMarginDecoration(
         this.inverted = inverted
     }
 
-    /**
-     * @param decorationLookup an optional [DecorationLookup] to filter positions
-     * that shouldn't have this decoration applied to
-     */
-    fun setDecorationLookup(decorationLookup: DecorationLookup?) {
-        this.decorationLookup = decorationLookup
-    }
-
     override fun getItemOffsets(
         outRect: Rect,
         view: View,

diff --git a/decorator/src/main/java/com/rubensousa/decorator/LinearDividerDecoration.kt b/decorator/src/main/java/com/rubensousa/decorator/LinearDividerDecoration.kt
@@ -66,7 +66,7 @@ class LinearDividerDecoration(
     private var inverted: Boolean = false,
     private var addBeforeFirstPosition: Boolean = false,
     private var addAfterLastPosition: Boolean = false,
-    private var decorationLookup: DecorationLookup? = null
+    decorationLookup: DecorationLookup? = null
 ) : AbstractMarginDecoration(decorationLookup) {
 
     companion object {
@@ -175,14 +175,6 @@ class LinearDividerDecoration(
 
     fun isInverted() = inverted
 
-    /**
-     * @param decorationLookup an optional [DecorationLookup] to filter positions
-     * that shouldn't have this decoration applied to
-     */
-    fun setDecorationLookup(decorationLookup: DecorationLookup?) {
-        this.decorationLookup = decorationLookup
-    }
-
     override fun getItemOffsets(
         outRect: Rect,
         view: View,
@@ -216,16 +208,6 @@ class LinearDividerDecoration(
         }
     }
 
-    private fun shouldApplyDecorationAt(position: Int, itemCount: Int): Boolean {
-        if (position == RecyclerView.NO_POSITION) {
-            return false
-        }
-        if (decorationLookup == null) {
-            return true
-        }
-        return decorationLookup!!.shouldApplyDecoration(position, itemCount)
-    }
-
     private fun applyVerticalOffsets(outRect: Rect, position: Int, itemCount: Int) {
         // Add space for the divider from the bottom if not inverted
         if (!inverted) {

diff --git a/decorator/src/main/java/com/rubensousa/decorator/LinearMarginDecoration.kt b/decorator/src/main/java/com/rubensousa/decorator/LinearMarginDecoration.kt
@@ -52,7 +52,7 @@ class LinearMarginDecoration(
     private var inverted: Boolean = false,
     private var addBeforeFirstPosition: Boolean = true,
     private var addAfterLastPosition: Boolean = true,
-    private var decorationLookup: DecorationLookup? = null
+    decorationLookup: DecorationLookup? = null
 ) : AbstractMarginDecoration(decorationLookup) {
 
     companion object {
@@ -193,14 +193,6 @@ class LinearMarginDecoration(
         this.inverted = inverted
     }
 
-    /**
-     * @param decorationLookup an optional [DecorationLookup] to filter positions
-     * that shouldn't have this decoration applied to
-     */
-    fun setDecorationLookup(decorationLookup: DecorationLookup?) {
-        this.decorationLookup = decorationLookup
-    }
-
     override fun getItemOffsets(
         outRect: Rect,
         view: View,