rb_lovely 0.7.2 → 0.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 67d03675c3c6b63a3ebfd789c053a98df9b4a55c
-  data.tar.gz: c77b233b9b82b11f00f1d0fb37ed1ac7be8d8c17
+  metadata.gz: a3f7d4f5fc6ca3c627d4ad35b98c0f935d98a118
+  data.tar.gz: c3ea2e3558250ccc28c80ba638b511338ee2815f
 SHA512:
-  metadata.gz: 8605022a32d4df8a51bfd6460774f64ea8fef9983f028f4eab839f663c6d5ec671b3d450c91525b84ff8f980e4e670f632f136cf9b022584749addb48512fe70
-  data.tar.gz: 256fbbace880eca76a8a3373e1622c57a9ac34324580f9904311770abd3b10579dfbb9ff719cfbcd7357dfdfd499440846594225b31bfda3b640f1cfc0afe55b
+  metadata.gz: cdea171a98d780d43ff3d91b9375c646c997a1a12d0e2eb851974e731538637f82260c4d5b12b0d79d264fa37a4d60301b11b80ee6dffd829a2117e47d0a87e8
+  data.tar.gz: 145a2c7665ed69d6dcdeff8b82bb4d6972aa59456d0698fdf1e31e2b956286e8ec25f089bda951c564bac5ed16eca410f9f391d18030fa33ed35cee1e9f177da

data/ext/rb_lovely/sorted_hash.cpp

@@ -309,6 +309,7 @@ extern "C" {
     rb_define_method(rbHash, "[]", RUBY_METHOD_FUNC(hashGet), 1);
     rb_define_method(rbHash, "each", RUBY_METHOD_FUNC(hashEach), 0);
     rb_define_method(rbHash, "to_s", RUBY_METHOD_FUNC(hashToString), 0);
+    rb_define_method(rbHash, "inspect", RUBY_METHOD_FUNC(hashToString), 0);
     rb_define_method(rbHash, "first", RUBY_METHOD_FUNC(hashFirst<ValueOrKey::BOTH>), 0);
     rb_define_method(rbHash, "first_value", RUBY_METHOD_FUNC(hashFirst<ValueOrKey::VALUE>), 0);
     rb_define_method(rbHash, "first_key", RUBY_METHOD_FUNC(hashFirst<ValueOrKey::KEY>), 0);

data/ext/rb_lovely/sorted_set.cpp

@@ -231,6 +231,7 @@ extern "C" {
     rb_define_method(rbSet, "<<", RUBY_METHOD_FUNC(setAdd), 1);
     rb_define_method(rbSet, "each", RUBY_METHOD_FUNC(setEach), 0);
     rb_define_method(rbSet, "to_s", RUBY_METHOD_FUNC(setToString), 0);
+    rb_define_method(rbSet, "inspect", RUBY_METHOD_FUNC(setToString), 0);
     rb_define_method(rbSet, "first", RUBY_METHOD_FUNC(setFirst), 0);
     rb_define_method(rbSet, "last", RUBY_METHOD_FUNC(setLast), 0);
     rb_define_method(rbSet, "delete", RUBY_METHOD_FUNC(setMutatingDelete), 1);

data/yard.rb

@@ -161,10 +161,14 @@ module RbLovely
   #   expect(hash[:y]).to equal 4
   #   expect(hash.length).to equal 3
   #   expect(hash.to_a).to eql [[:i, 1], [:y, 4], [:b, 16]]
+  #
+  #   # reverse order by overriding key comparison function.
+  #   rhash = RbLovely::SortedHash(compare: proc { |a, b| b <=> a })
   class SortedHash
     include Enumerable
 
     # @complexity O(n).
+    # @see .[]
     # @param content [Array] An array containing key, value, key, value ...
     # @param compare [Proc] Comparison function used to order values (rather than default
     #                       of using <=> method).
@@ -189,15 +193,18 @@ module RbLovely
     #   expect(hash.to_a).to eql [[:b, 1], [:a, 3]]
     def self.[](*content) ; end
 
-    # Set the value associated with a key. If the key already then it and its value are removed.
+    # Set the value associated with a key, replacing the existing key's value.
     # @complexity O(c).
+    # @see #replace
     # @return The value that was passed.
     # @example
     #   hash = RbLovely::SortedHash.new
     #   hash[:a] = 'yo'
     def []=(key, value) ; end
 
-    # Set the value associated with a key. If the key already then it and its value are removed.
+    # Set the value associated with a key, differs to #[]= in return value.
+    # @complexity O(c).
+    # @see #[]=
     # @return The value that was previously associated with the key or nil if the key was not present in the hash.
     # @example
     #   hash = RbLovely::SortedHash[:a, 'yi']
@@ -222,7 +229,7 @@ module RbLovely
     #   hash.each { |key, value| puts "#{key} => #{value}" }
     def each(&block) ; end
 
-    # Remove all values from the hash.
+    # Remove all key-value pairs from the hash.
     # @complexity O(n)
     # @example
     #   hash = RbLovely::SortedHash [:a, 10]
@@ -230,7 +237,8 @@ module RbLovely
     #   expect(hash.empty?).to equal true
     def clear ; end
 
-    # Retrieve value associated with the corresponding key or nil if the key doesn't exist.
+    # Retrieve value from hash using key.
+    # @return Value associated with the corresponding key or nil if the key doesn't exist.
     # @complexity O(c)
     # @example
     #   hash = RbLovely::SortedHash [:a, 2]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rb_lovely
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.7.3
 platform: ruby
 authors:
 - James Pike