Implement eql? and hash for UUID in Ruby so UUID can be used as a…

… key in a Ruby Hash.

.gitignore

@@ -5,6 +5,8 @@ test_gems
 test_fails.txt
 # Ignore build folders (at root level only)
 /build*/
+/debug*/
+/release*/
 
 developer/msvc/Visualizers/all_concat.natvis
 .vscode/

ruby/test/UUID_Test.rb

@@ -65,6 +65,68 @@ def test_uuid_big_set
 
     File.delete("UUIDSet.txt")
   end
+
+  def test_uuid_hash
+    model = OpenStudio::Model::Model.new
+    space1 = OpenStudio::Model::Space.new(model)
+    space1.setName("Space 1")
+    space2 = OpenStudio::Model::Space.new(model)
+    space2.setName("Space 2")
+
+    space1_handle1 = space1.handle
+    space1_handle2 = space1.handle
+    space2_handle1 = space2.handle
+    space2_handle2 = space2.handle
+
+    assert(space1_handle1 == space1_handle1)
+    assert(space1_handle1 == space1_handle2)
+    assert(space1_handle1 != space2_handle1)
+    assert(space1_handle1 != space2_handle2)
+
+    assert(space1_handle1.to_s == space1_handle1.to_s)
+    assert(space1_handle1.to_s == space1_handle2.to_s)
+    assert(space1_handle1.to_s != space2_handle1.to_s)
+    assert(space1_handle1.to_s != space2_handle2.to_s)
+
+    assert(space1_handle1.hash == space1_handle1.hash)
+    assert(space1_handle1.hash == space1_handle2.hash)
+    assert(space1_handle1.hash != space2_handle1.hash)
+    assert(space1_handle1.hash != space2_handle2.hash)
+
+    assert(space1_handle1.eql?(space1_handle1))
+    assert(space1_handle1.eql?(space1_handle2))
+    assert(!space1_handle1.eql?(space2_handle1))
+    assert(!space1_handle1.eql?(space2_handle2))
+
+    assert(space1_handle1.to_s != space1_handle1)
+    assert(space1_handle1.to_s != space1_handle2)
+    assert(space1_handle1.to_s != space2_handle1)
+    assert(space1_handle1.to_s != space2_handle2)
+
+    handle_to_space_map = {}
+    handle_to_space_map[space1_handle1] = space1
+    handle_to_space_map[space2_handle1] = space2
+    assert(handle_to_space_map[space1_handle1] == space1)
+    assert(handle_to_space_map[space1_handle2] == space1) 
+    assert(handle_to_space_map[space2_handle1] == space2)
+    assert(handle_to_space_map[space2_handle2] == space2) 
+    assert(handle_to_space_map[space1_handle1.to_s] != space1)
+    assert(handle_to_space_map[space1_handle2.to_s] != space1)
+    assert(handle_to_space_map[space2_handle1.to_s] != space2)
+    assert(handle_to_space_map[space2_handle2.to_s] != space2)
+
+    handle_str_to_space_map = {}
+    handle_str_to_space_map[space1_handle1.to_s] = space1
+    handle_str_to_space_map[space2_handle1.to_s] = space2
+    assert(handle_str_to_space_map[space1_handle1.to_s] == space1)
+    assert(handle_str_to_space_map[space1_handle2.to_s] == space1)
+    assert(handle_str_to_space_map[space2_handle1.to_s] == space2)
+    assert(handle_str_to_space_map[space2_handle2.to_s] == space2)
+    assert(handle_str_to_space_map[space1_handle1] != space1)
+    assert(handle_str_to_space_map[space1_handle2] != space1)
+    assert(handle_str_to_space_map[space2_handle1] != space2)
+    assert(handle_str_to_space_map[space2_handle2] != space2)
+  end
 
 end
 

src/utilities/core/UUID.hpp

@@ -74,6 +74,10 @@ namespace openstudio {
       return is_nil();
     }
 
+    bool isEqual(const UUID& other) const {
+      return (*this == other);
+    }
+
     using boost::uuids::uuid::iterator;
     using boost::uuids::uuid::const_iterator;
     using boost::uuids::uuid::begin;

src/utilities/core/UUID.i

@@ -7,17 +7,21 @@
 
 %{
   #include <utilities/core/UUID.hpp>
+  #include <functional>
 %}
 
 namespace openstudio{
 
   #ifdef SWIGRUBY
     %rename("nil?") isNull();
+
+    %alias UUID::isEqual "eql?";
   #endif
 
   class UUID {
   public:
     bool isNull() const;
+    bool isEqual(const UUID& other) const;
     ~UUID();
 
   protected:
@@ -40,6 +44,14 @@ namespace openstudio{
       return openstudio::toString(*self);
     }
 
+    int __hash__() const{
+      return std::hash<std::string>{}(openstudio::toString(*self));
+    }
+
+    bool __eq__ (const UUID & other) const{
+        return *self == other;
+    }
+
     bool operator!= ( const UUID & other ) const {
       return *self != other;
     }