Make a few handy additions to Props

Author: loverdos

README.md

@@ -3,4 +3,4 @@ streamresource
 
 Convenient abstractions related to the getResource() pattern. Introduces the idea of resource contexts, which are responsible for resource resolving.
 
-Latest release is `"com.ckkloverdos" % "streamresource_2.9.1" % "0.1.1"` from [scala-tools.org](http://scala-tools.org/repo-releases).
+Latest release is `"com.ckkloverdos" % "streamresource_2.9.1" % "0.2.0"` from [scala-tools.org](http://scala-tools.org/repo-releases).

project/build.properties

@@ -19,7 +19,7 @@
 project.organization=com.ckkloverdos
 project.name=streamresource
 sbt.version=0.7.7
-project.version=0.1.1
+project.version=0.2.0
 publish.remote=false
 build.scala.versions=2.9.1
 project.initialize=false

src/main/scala/com/ckkloverdos/props/Props.scala

@@ -31,8 +31,44 @@ import com.ckkloverdos.maybe.{NoVal, Maybe}
  */
 class Props(val map: Map[String, String]) {
 
+  private def _toBoolean(value: String, falseStrings: Set[String]): Boolean = {
+    if(null eq value) {
+      throw new NullPointerException("Cannot get a Boolean from null")
+    } else {
+      !(falseStrings contains value.toLowerCase)
+    }
+  }
+
+  def contains(key: String) = map contains key
+  
+  def filterKeys(f: String => Boolean) = new Props(map filterKeys f)
+  
+  def filterValues(f: String => Boolean) = new Props(map filter {case (k, v) => f(v)})
+
+  /**
+   * Get a value or throw an exception if it doesnot exist.
+   */
+  def getEx(key: String): String = map apply key
+
   def get(key: String): Maybe[String] = map.get(key): Maybe[String]
 
+  def getOr(key: String, default: String = null): String = map.getOrElse(key, default)
+
+  def getBoolean(key: String, falseStrings: Set[String] = Props.DefaultFalseStrings): Maybe[Boolean] = map.get(key) match {
+    case Some(value) => Maybe(_toBoolean(value, falseStrings))
+    case None => NoVal
+  }
+
+  def getByte(key: String): Maybe[Byte] = map.get(key) match {
+      case Some(value) => Maybe(value.toByte)
+      case None => NoVal
+    }
+
+  def getShort(key: String): Maybe[Short] = map.get(key) match {
+    case Some(value) => Maybe(value.toShort)
+    case None => NoVal
+  }
+
   def getInt(key: String): Maybe[Int] = map.get(key) match {
     case Some(value) => Maybe(value.toInt)
     case None => NoVal
@@ -47,7 +83,12 @@ class Props(val map: Map[String, String]) {
     case Some(value) => Maybe(value.toDouble)
     case None => NoVal
   }
-  
+
+  def getFloat(key: String): Maybe[Float] = map.get(key) match {
+    case Some(value) => Maybe(value.toFloat)
+    case None => NoVal
+  }
+
   def getProps(key: String): Maybe[Props] = map.get(key) match {
     case Some(value) => Props(value)
     case None => NoVal
@@ -60,9 +101,30 @@ class Props(val map: Map[String, String]) {
 
   def getTrimmedList(key: String, separatorRegex: String = "\\s*,\\s*"): List[String] =
     getList(key, separatorRegex).map(_.trim).filter(_.length > 0)
+
+  override def equals(any: Any) = any match {
+    case props: Props if(props.getClass == this.getClass) => props.map == this.map
+    case _ => false
+  }
+
+  def equalsProps(other: Props): Boolean = other match {
+    case null => false
+    case _    => equalsMap(other.map)
+  }
+
+  def equalsMap(other: Map[String, String]): Boolean = other match {
+    case null => false
+    case _ => other == this.map
+  }
+
+  override def hashCode() = map.##
+
+  override def toString = "Props(%s)".format(map.mkString(", "))
 }
 
 object Props {
+  lazy val DefaultFalseStrings = Set("false", "off", "0")
+
   lazy val DummyWrappedURL = new URL("streamresource://wrapped")
   lazy val DummyWrappedPath = "wrapped"
 
@@ -88,4 +150,6 @@ object Props {
   def apply(path: String, rc: StreamResourceContext = DefaultResourceContext): Maybe[Props] = {
     rc.getResource(path).flatMap(this(_))
   }
+
+  def apply(keyvals: (String, String)*): Props = new Props(Map(keyvals: _*))
 }

src/test/scala/com/ckkloverdos/resource/ResourceTest.scala

@@ -20,6 +20,7 @@ import org.junit.Assert
 import org.junit.Test
 import com.ckkloverdos.runmode.{StageMode, RunMode, TestMode, StandardRunModeContext}
 import com.ckkloverdos.props.Props
+import com.ckkloverdos.maybe.Just
 
 /**
  *
@@ -201,4 +202,56 @@ class ResourceTest {
     val listColon = props.getTrimmedList(rcKeyListColon, "\\s*:\\s*")
     Assert.assertEquals(List("one", "two", "three"), listColon)
   }
+  
+  @Test
+  def testPropsBoolean {
+    val key1val = ("key1", "on", true)
+    val key2val = ("key2",  "off", false)
+    val key3val = ("key3", "0", false)
+    val all = Seq(key1val, key2val, key3val)
+    val keyvals = all map { case (k, v, _) => (k, v) }
+    val props = Props(keyvals: _*)
+
+    all foreach  { case (k, _, b) =>
+      Assert.assertEquals("Testing boolean property: %s".format(k), Just(b), props.getBoolean(k))
+    }
+  }
+  
+  @Test
+  def testPropsEqual1 {
+    val props1 = Props("1" -> "one", "2" -> "two")
+    val props2 = Props("2" -> "two", "1" -> "one")
+    Assert.assertEquals(props1, props2)
+    Assert.assertEquals(props2, props1)
+  }
+
+  @Test
+  def testPropsEqual2 {
+    class SuperProps(map: Map[String, String]) extends Props(map)
+    val props1 = new SuperProps(Map("1" -> "one", "2" -> "two"))
+    val props2 = Props("2" -> "two", "1" -> "one")
+    Assert.assertTrue(props1.equalsProps(props2))
+    Assert.assertTrue(props2.equalsProps(props1))
+  }
+
+  @Test
+  def testPropsNotEqual1 {
+    val props1 = Props("1" -> "one", "2" -> "two")
+    val props2 = Props("2" -> "two", "1" -> "one1")
+    Assert.assertFalse(props1 == props2)
+  }
+
+  @Test
+  def testPropsNotEqual2 {
+    val props1 = Props("1" -> "one", "2" -> "two")
+    Assert.assertFalse(props1 == null)
+  }
+  
+  @Test
+  def testPropsNotEqual3 {
+    class SuperProps(map: Map[String, String]) extends Props(map)
+    val props1 = new SuperProps(Map("1" -> "one", "2" -> "two"))
+    val props2 = Props("2" -> "two", "1" -> "one")
+    Assert.assertFalse(props1 == props2)
+  }
 }