update doc

Author: s1rius

README_CN.md

@@ -11,7 +11,7 @@
 
 - 使用状态机实现
 - 支持嵌套滑动
-- 支持Jetpack compose
+- 支持Jetpack Compose
 - 易于扩展
 
 

doc/statemachine_cn.md

@@ -1,9 +1,9 @@
-# 状态机(StateMachine)在下拉刷新控件库中的使用
-
-文中提到的状态机均为有限状态机(FSM)
+# 状态机(StateMachine)在下拉刷新控件中的使用
 
 ### 背景
 
+在维护下拉刷新控件的过程中，虽然改动的次数很少，但是每一次bug修复和新增功能都很困难，总结问题如下：
+
 - 状态转换，状态判断逻辑复杂
 
 代码中定义了4个下拉刷新的状态以及可以影响刷新状态的其他变量，在手势事件，嵌套滑动，自动刷新等事件的输入情况下，需要对几个变量进行正确判断，再做出响应。
@@ -62,7 +62,7 @@ private fun tryScrollBackToTopAbortRefresh() {
 并且让代码简洁，可维护性高？
 
 在思考这个问题的时候，我就想到游戏开发，他们如何在多个玩家进行大量的位移，技能释放等多种事件输入的场景下来保证逻辑正常运转的。如果只是靠简单的if，else判断，那对维护者来说，绝对是个灾难。
-随即，我看到了游戏开发中对状态机使用的一些文章。觉得状态机同样适用在下拉刷新库中。
+随即，我看到了游戏开发中对状态机使用的一些文章。觉得状态机同样适用在下拉刷新控件中。
 
 ### 什么是状态机
 
@@ -72,7 +72,7 @@ private fun tryScrollBackToTopAbortRefresh() {
 
 简单的理解，状态机的作用就是，给定一个当前状态和触发事件，状态机能够输出下一个状态。
 
-在软件工程中，状态机有以下几个重要的概念
+状态机的几个概念
 
 - 状态（State）：表示对象的某种形态，在当前形态下可能会拥有不同的行为和属性。
 - 转移（Transition）：表示状态变更，并且必须满足确使转移发生的条件来执行。
@@ -118,11 +118,11 @@ sealed class Event {
 ```kotlin
 sealed class SideEffect {
         // 手势取消回到顶部
-        object OnCancelToIdle : SideEffect()
+        object OnReleaseToIdle : SideEffect()
         // 刷新动作
         object OnRefreshing : SideEffect()
         // 开始拖动控件
-        object OnDragBegin : SideEffect()
+        object OnPull : SideEffect()
         // 刷新完成的动作
         object OnComplete : SideEffect()
     }
@@ -172,24 +172,24 @@ var stateMachine =
 
 1. 现在的由于状态转换的触发逻辑，都在`onTransition`的lambda中统一处理，简单易懂
 
-    ```
-        when (validTransition.sideEffect) {
-                SideEffect.OnDragBegin -> { }
-                SideEffect.OnComplete -> { 
-                    // 执行刷新完成的总做
-                }
-                SideEffect.OnRefreshing -> {
-                    // 执行刷新动作
-                }
-                SideEffect.OnCancelToIdle -> {
-                    // 执行回到顶部的动作
-                }
-            }
-    ```
+```kotlin
+    when (validTransition.sideEffect) {
+        SideEffect.OnDragBegin -> { }
+        SideEffect.OnComplete -> { 
+            // 执行刷新完成的总做
+        }
+        SideEffect.OnRefreshing -> {
+            // 执行刷新动作
+        }
+        SideEffect.OnCancelToIdle -> {
+            // 执行回到顶部的动作
+        }
+    }
+```
 
 2. 通过Event触发状态的转换，触发事件时不需要对状态进行判断，因为状态转换的判断都已经在状态机的内部完成
 
-    ```
+```kotlin
     // 触发下拉事件
     stateMachine.transition(Event.Pull)
     ...
@@ -202,18 +202,21 @@ var stateMachine =
     // 触发自动刷新的事件
     stateMachine.transition(Event.AutoRefresh)
 
-    ```
+```
 
 2. 代码逻辑更加简练了，可维护性变好
 
     状态转换的逻辑基本与手势事件，嵌套滑动等其他的逻辑解耦，debug变简单了
 
 ### 结论
 
-引入状态机后，抽象程度提高，代码逻辑变简洁。和原来相比更容易阅读和维护了。
+引入状态机后，状态的转移流程清晰易懂，代码逻辑变简洁。和原来相比更容易阅读和维护了。
 
 
 ##### 参考
-1. [有限状态机](https://zh.wikipedia.org/wiki/%E6%9C%89%E9%99%90%E7%8A%B6%E6%80%81%E6%9C%BA)
-2. [趣说游戏AI开发：对状态机的褒扬和批判](https://zhuanlan.zhihu.com/p/20476688)
-3. [Unity 教程 | 状态机 1](https://www.bilibili.com/video/BV1St4y1Y7U1)
+
+[有限状态机](https://zh.wikipedia.org/wiki/%E6%9C%89%E9%99%90%E7%8A%B6%E6%80%81%E6%9C%BA)
+
+[趣说游戏AI开发：对状态机的褒扬和批判](https://zhuanlan.zhihu.com/p/20476688)
+
+[Unity 教程 | 状态机 1](https://www.bilibili.com/video/BV1St4y1Y7U1)

ptr-demo/src/main/java/wtf/s1/android/ptr/demo/InsCompose.kt

@@ -39,7 +39,7 @@ fun Ins() {
         NSPtrState(
             coroutineScope = coroutine,
             contentInitPosition = 0.dp,
-            contentRefreshPosition = 54.dp
+            contentRefreshPosition = 60.dp
         ) {
             delay(3000)
             it.dispatchPtrEvent(Event.RefreshComplete)
@@ -51,7 +51,7 @@ fun Ins() {
     ) {
         NSPtrEZHeader(
             modifier = Modifier
-                .offset(0.dp, 12.dp),
+                .offset(0.dp, 16.dp),
             nsPtrState = nsPtrState
         )
         SimpleListCompose(Modifier.ptrContent())

ptr-demo/src/main/java/wtf/s1/android/ptr/demo/SimpleItemView.kt

@@ -2,6 +2,7 @@ package wtf.s1.android.ptr.demo
 
 import android.content.Context
 import android.content.Intent
+import android.graphics.Color
 import android.util.AttributeSet
 import android.view.ViewGroup
 import android.widget.FrameLayout
@@ -28,6 +29,7 @@ class SimpleItemView @JvmOverloads constructor(
 
             context.startActivity(intent)
         }
+        mTextView.setTextColor(Color.BLACK)
     }
 
     fun bind(post: Post) {

ptr-demo/src/main/res/layout/fragment_text.xml

@@ -12,20 +12,21 @@
             android:layout_width="match_parent"
             android:layout_height="match_parent"
             android:fillViewport="true">
+
             <TextView
                 android:id="@+id/wiki"
-                android:padding="8dp"
                 android:layout_width="match_parent"
                 android:layout_height="wrap_content"
                 android:background="@android:color/white"
                 android:gravity="center"
-                android:scrollbars = "vertical"
+                android:padding="8dp"
+                android:scrollbars="vertical"
                 android:text="@string/dotawiki"
+                android:textColor="@android:color/black"
                 android:textSize="16sp" />
 
         </androidx.core.widget.NestedScrollView>
 
 
-
     </wtf.s1.android.ptr.demo.SwipeToRefreshLayout>
 </merge>

ptr-view/src/main/java/wtf/s1/ptr/nsptr/view/NSPtrEZHeader.kt

@@ -10,7 +10,7 @@ import wtf.s1.ptr.nsptr.State
 import wtf.s1.ptr.nsptr.StateMachine
 
 /**
- * implement NSPtrHeader in easy way
+ * implement NSPtrHeader in an easy way
  */
 open class NSPtrEZHeader @JvmOverloads constructor(
         context: Context, attrs: AttributeSet? = null
@@ -43,12 +43,12 @@ open class NSPtrEZHeader @JvmOverloads constructor(
         }
     }
 
-    override fun onPositionChange(frame: NSPtrLayout, offset: Int) {
-        if (frame.currentState != State.REFRESHING) {
-            if (mIsOverToRefresh != frame.isOverToRefreshPosition) {
-                mIsOverToRefresh = frame.isOverToRefreshPosition
+    override fun onPositionChange(ptrLayout: NSPtrLayout, offset: Int) {
+        if (ptrLayout.currentState != State.REFRESHING) {
+            if (mIsOverToRefresh != ptrLayout.isOverToRefreshPosition) {
+                mIsOverToRefresh = ptrLayout.isOverToRefreshPosition
             }
-            progressBar.progress = (frame.contentTopPosition * 100f / frame.config.contentRefreshPosition()).toInt()
+            progressBar.progress = (ptrLayout.contentTopPosition * 100f / ptrLayout.config.contentRefreshPosition()).toInt()
         }
     }
 

ptr-view/src/main/java/wtf/s1/ptr/nsptr/view/NSPtrEZLayout.kt

@@ -4,7 +4,7 @@ import android.content.Context
 import android.util.AttributeSet
 
 /**
- * implement NSPtrEZLayout in easy way
+ * implement NSPtrEZLayout in an easy way
  */
 open class NSPtrEZLayout @JvmOverloads constructor(
         context: Context, attrs: AttributeSet? = null