Merge pull request #9 from davidrunger/rename-shape-descriptor-to-to_s

Rename Shaped::Shape#descriptor methods to #to_s
davidrunger · Jun 16, 2020 · f3f0907 · f3f0907
2 parents fee13e9 + fe4506c
commit f3f0907
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,7 @@
+## Unreleased
+### Changed
+- Rename `Shaped::Array#descriptor` and `Shaped::Hash#descriptor` methods to `#to_s`
+
 ## 0.2.0 - 2020-06-16
 ### Added
 - Add `Shaped::Array` method and class

diff --git a/lib/shaped/array.rb b/lib/shaped/array.rb
@@ -22,7 +22,7 @@ def initialize(shape_description)
     @match_failure_reasons = {}
   end
 
-  def descriptor
+  def to_s
     "Array shaped like [#{@shape_klass}]"
   end
 

diff --git a/lib/shaped/expected_class_descriptions.rb b/lib/shaped/expected_class_descriptions.rb
@@ -5,7 +5,7 @@ module Shaped::ExpectedClassDescriptions
 
   def expected_class_descriptor(expected_klass)
     if expected_klass.is_a?(Shaped::Shape)
-      expected_klass.descriptor
+      expected_klass.to_s
     else
       expected_klass.name
     end

diff --git a/lib/shaped/hash.rb b/lib/shaped/hash.rb
@@ -15,7 +15,7 @@ def initialize(shape_description)
     @match_failure_reasons = {}
   end
 
-  def descriptor
+  def to_s
     printable_shape_description =
       @shape_description.map do |key, value|
         "#{key.inspect} => #{expected_class_descriptor(value)}"