feat: add IsInDebt

richardschneider · richardschneider · commit e96ae4504cc9 · 2019-06-15T20:15:01.000+12:00
diff --git a/src/CoreApi/BitswapLedger.cs b/src/CoreApi/BitswapLedger.cs
@@ -56,6 +56,8 @@ public class BitswapLedger
         /// </summary>
         /// <value>
         ///   <see cref="DataSent"/> divided by <see cref="DataReceived"/>.
+        ///   A value less than 1 indicates that we are in debt to the 
+        ///   <see cref="Peer"/>.
         /// </value>
         public float DebtRatio
         {
@@ -65,5 +67,13 @@ public float DebtRatio
             }
         }
 
+        /// <summary>
+        ///   Determines if we owe the <see cref="Peer"/> some blocks.
+        /// </summary>
+        /// <value>
+        ///   <b>true</b> if we owe data to the peer; otherwise, <b>false</b>.
+        /// </value>
+        public bool IsInDebt => DebtRatio < 1;
+
     }
 }
diff --git a/test/CoreApi/BitswapLedgerTest.cs b/test/CoreApi/BitswapLedgerTest.cs
@@ -19,20 +19,23 @@ public void Defaults()
             Assert.AreEqual(0ul, ledger.DataReceived);
             Assert.AreEqual(0ul, ledger.DataSent);
             Assert.AreEqual(0f, ledger.DebtRatio);
+            Assert.IsTrue(ledger.IsInDebt);
         }
 
         [TestMethod]
         public void DebtRatio_Positive()
         {
             var ledger = new BitswapLedger { DataSent = 1024 * 1024 };
             Assert.IsTrue(ledger.DebtRatio >= 1);
+            Assert.IsFalse(ledger.IsInDebt);
         }
 
         [TestMethod]
         public void DebtRatio_Negative()
         {
             var ledger = new BitswapLedger { DataReceived = 1024 * 1024 };
             Assert.IsTrue(ledger.DebtRatio < 1);
+            Assert.IsTrue(ledger.IsInDebt);
         }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -56,6 +56,8 @@ public class BitswapLedger`
`56`	`56`	`/// </summary>`
`57`	`57`	`/// <value>`
`58`	`58`	`/// <see cref="DataSent"/> divided by <see cref="DataReceived"/>.`
	`59`	`+ /// A value less than 1 indicates that we are in debt to the`
	`60`	`+ /// <see cref="Peer"/>.`
`59`	`61`	`/// </value>`
`60`	`62`	`public float DebtRatio`
`61`	`63`	`{`
`@@ -65,5 +67,13 @@ public float DebtRatio`
`65`	`67`	`}`
`66`	`68`	`}`
`67`	`69`
	`70`	`+ /// <summary>`
	`71`	`+ /// Determines if we owe the <see cref="Peer"/> some blocks.`
	`72`	`+ /// </summary>`
	`73`	`+ /// <value>`
	`74`	`+ /// <b>true</b> if we owe data to the peer; otherwise, <b>false</b>.`
	`75`	`+ /// </value>`
	`76`	`+ public bool IsInDebt => DebtRatio < 1;`
	`77`	`+`
`68`	`78`	`}`
`69`	`79`	`}`
Original file line number	Diff line number	Diff line change
`@@ -19,20 +19,23 @@ public void Defaults()`
`19`	`19`	`Assert.AreEqual(0ul, ledger.DataReceived);`
`20`	`20`	`Assert.AreEqual(0ul, ledger.DataSent);`
`21`	`21`	`Assert.AreEqual(0f, ledger.DebtRatio);`
	`22`	`+ Assert.IsTrue(ledger.IsInDebt);`
`22`	`23`	`}`
`23`	`24`
`24`	`25`	`[TestMethod]`
`25`	`26`	`public void DebtRatio_Positive()`
`26`	`27`	`{`
`27`	`28`	`var ledger = new BitswapLedger { DataSent = 1024 * 1024 };`
`28`	`29`	`Assert.IsTrue(ledger.DebtRatio >= 1);`
	`30`	`+ Assert.IsFalse(ledger.IsInDebt);`
`29`	`31`	`}`
`30`	`32`
`31`	`33`	`[TestMethod]`
`32`	`34`	`public void DebtRatio_Negative()`
`33`	`35`	`{`
`34`	`36`	`var ledger = new BitswapLedger { DataReceived = 1024 * 1024 };`
`35`	`37`	`Assert.IsTrue(ledger.DebtRatio < 1);`
	`38`	`+ Assert.IsTrue(ledger.IsInDebt);`
`36`	`39`	`}`
`37`	`40`	`}`
`38`	`41`	`}`