immutable-ruby 0.0.4 → 0.1.0

data/lib/immutable/set.rb

@@ -1,9 +1,9 @@
-require "immutable/undefined"
-require "immutable/enumerable"
-require "immutable/hash"
-require "immutable/trie"
-require "immutable/sorted_set"
-require "set"
+require 'immutable/undefined'
+require 'immutable/enumerable'
+require 'immutable/hash'
+require 'immutable/trie'
+require 'immutable/sorted_set'
+require 'set'
 
 module Immutable
 
@@ -61,7 +61,7 @@ module Immutable
       #
       # @return [Set]
       def empty
-        @empty ||= self.new
+        @empty ||= new
       end
 
       # "Raw" allocation of a new `Set`. Used internally to create a new
@@ -91,7 +91,7 @@ module Immutable
     def size
       @trie.size
     end
-    alias :length :size
+    alias length size
 
     # Return a new `Set` with `item` added. If `item` is already in the set,
     # return `self`.
@@ -105,7 +105,7 @@ module Immutable
     def add(item)
       include?(item) ? self : self.class.alloc(@trie.put(item, nil))
     end
-    alias :<< :add
+    alias << add
 
     # If `item` is not a member of this `Set`, return a new `Set` with `item` added.
     # Otherwise, return `false`.
@@ -197,8 +197,8 @@ module Immutable
       trie = @trie.select { |key, _| yield(key) }
       new_trie(trie)
     end
-    alias :find_all :select
-    alias :keep_if  :select
+    alias find_all select
+    alias keep_if  select
 
     # Call the block once for each item in this `Set`. All the values returned
     # from the block will be gathered into a new `Set`. If no block is given,
@@ -215,7 +215,7 @@ module Immutable
       return self if empty?
       self.class.new(super)
     end
-    alias :collect :map
+    alias collect map
 
     # Return `true` if the given item is present in this `Set`. More precisely,
     # return `true` if an object with the same `#hash` code, and which is also `#eql?`
@@ -230,7 +230,7 @@ module Immutable
     def include?(object)
       @trie.key?(object)
     end
-    alias :member? :include?
+    alias member? include?
 
     # Return a member of this `Set`. The member chosen will be the first one which
     # would be yielded by {#each}. If the set is empty, return `nil`.
@@ -258,7 +258,7 @@ module Immutable
     #                        equal.
     # @return [SortedSet]
     def sort(&comparator)
-      SortedSet.new(self.to_a, &comparator)
+      SortedSet.new(to_a, &comparator)
     end
 
     # Return a {SortedSet} which contains the same items as this `Set`, ordered
@@ -276,7 +276,7 @@ module Immutable
     # @yieldreturn [Object] sort key for the item
     # @return [SortedSet]
     def sort_by(&mapper)
-      SortedSet.new(self.to_a, &mapper)
+      SortedSet.new(to_a, &mapper)
     end
 
     # Return a new `Set` which contains all the members of both this `Set` and `other`.
@@ -308,9 +308,9 @@ module Immutable
       trie = large_set_trie.bulk_put(small_set_pairs)
       new_trie(trie)
     end
-    alias :| :union
-    alias :+ :union
-    alias :merge :union
+    alias | union
+    alias + union
+    alias merge union
 
     # Return a new `Set` which contains all the items which are members of both
     # this `Set` and `other`. `other` can be any `Enumerable` object.
@@ -333,7 +333,7 @@ module Immutable
       end
       new_trie(trie)
     end
-    alias :& :intersection
+    alias & intersection
 
     # Return a new `Set` with all the items in `other` removed. `other` can be
     # any `Enumerable` object.
@@ -351,8 +351,8 @@ module Immutable
       end
       new_trie(trie)
     end
-    alias :subtract :difference
-    alias :- :difference
+    alias subtract difference
+    alias - difference
 
     # Return a new `Set` which contains all the items which are members of this
     # `Set` or of `other`, but not both. `other` can be any `Enumerable` object.
@@ -365,7 +365,7 @@ module Immutable
     def exclusion(other)
       ((self | other) - (self & other))
     end
-    alias :^ :exclusion
+    alias ^ exclusion
 
     # Return `true` if all items in this `Set` are also in `other`.
     #
@@ -391,7 +391,7 @@ module Immutable
       end
       all? { |item| other.include?(item) }
     end
-    alias :<= :subset?
+    alias <= subset?
 
     # Return `true` if all items in `other` are also in this `Set`.
     #
@@ -403,7 +403,7 @@ module Immutable
     def superset?(other)
       other.subset?(self)
     end
-    alias :>= :superset?
+    alias >= superset?
 
     # Returns `true` if `other` contains all the items in this `Set`, plus at least
     # one item which is not in this set.
@@ -422,7 +422,7 @@ module Immutable
       end
       all? { |item| other.include?(item) }
     end
-    alias :< :proper_subset?
+    alias < proper_subset?
 
     # Returns `true` if this `Set` contains all the items in `other`, plus at least
     # one item which is not in `other`.
@@ -436,7 +436,7 @@ module Immutable
     def proper_superset?(other)
       other.proper_subset?(self)
     end
-    alias :> :proper_superset?
+    alias > proper_superset?
 
     # Return `true` if this `Set` and `other` do not share any items.
     #
@@ -484,8 +484,8 @@ module Immutable
       end
     end
 
-    alias :group :group_by
-    alias :classify :group_by
+    alias group group_by
+    alias classify group_by
 
     # Return a randomly chosen item from this `Set`. If the set is empty, return `nil`.
     #
@@ -519,7 +519,7 @@ module Immutable
       end
       true
     end
-    alias :== :eql?
+    alias == eql?
 
     # See `Object#hash`.
     # @return [Integer]
@@ -533,7 +533,7 @@ module Immutable
     def dup
       self
     end
-    alias :clone :dup
+    alias clone dup
 
     undef :"<=>" # Sets are not ordered, so Enumerable#<=> will give a meaningless result
     undef :each_index # Set members cannot be accessed by 'index', so #each_index is not meaningful

data/lib/immutable/sorted_set.rb

@@ -1,4 +1,4 @@
-require "immutable/enumerable"
+require 'immutable/enumerable'
 
 module Immutable
 
@@ -65,7 +65,7 @@ module Immutable
       #
       # @return [SortedSet]
       def empty
-        @empty ||= self.alloc(PlainAVLNode::EmptyNode)
+        @empty ||= alloc(PlainAVLNode::EmptyNode)
       end
 
       # "Raw" allocation of a new `SortedSet`. Used internally to create a new
@@ -101,14 +101,17 @@ module Immutable
     def initialize(items=[], &block)
       items = items.to_a
       if block
-        if block.arity == 1 || block.arity == -1
+        # In Ruby 2, &:method blocks have arity -1; in Ruby 3, it's -2
+        if block.arity == 1 || block.arity == -1 || block.arity == -2
           items = items.uniq(&block)
           items.sort_by!(&block)
           comparator = lambda { |a,b| block.call(a) <=> block.call(b) }
-        else
+        elsif block.arity == 2 || block.arity == -3
           items = items.sort(&block)
           SortedSet.uniq_by_comparator!(items, block)
           comparator = block
+        else
+          raise "Comparator block for Immutable::SortedSet must accept 1 or 2 arguments"
         end
         @node = AVLNode.from_items(items, comparator)
       else
@@ -133,7 +136,7 @@ module Immutable
     def size
       @node.size
     end
-    alias :length :size
+    alias length size
 
     # Return a new `SortedSet` with `item` added. If `item` is already in the set,
     # return `self`.
@@ -151,7 +154,7 @@ module Immutable
       end
       self
     end
-    alias :<< :add
+    alias << add
 
     # If `item` is not a member of this `SortedSet`, return a new `SortedSet` with
     # `item` added. Otherwise, return `false`.
@@ -343,7 +346,7 @@ module Immutable
         subsequence(arg, length)
       end
     end
-    alias :[] :slice
+    alias [] slice
 
     # Return a new `SortedSet` with only the elements at the given `indices`.
     # If any of the `indices` do not exist, they will be skipped.
@@ -451,8 +454,8 @@ module Immutable
       each { |item| items_to_delete << item unless yield(item) }
       derive_new_sorted_set(@node.bulk_delete(items_to_delete))
     end
-    alias :find_all :select
-    alias :keep_if  :select
+    alias find_all select
+    alias keep_if  select
 
     # Invoke the given block once for each item in the set, and return a new
     # `SortedSet` containing the values returned by the block. If no block is
@@ -469,7 +472,7 @@ module Immutable
       return self if empty?
       self.class.alloc(@node.from_items(super))
     end
-    alias :collect :map
+    alias collect map
 
     # Return `true` if the given item is present in this `SortedSet`. More precisely,
     # return `true` if an object which compares as "equal" using this set's
@@ -483,7 +486,7 @@ module Immutable
     def include?(item)
       @node.include?(item)
     end
-    alias :member? :include?
+    alias member? include?
 
     # Return a new `SortedSet` with the same items, but a sort order determined
     # by the given block.
@@ -497,14 +500,14 @@ module Immutable
     # @return [SortedSet]
     def sort(&block)
       if block
-        self.class.new(self.to_a, &block)
+        self.class.new(to_a, &block)
       elsif @node.natural_order?
         self
       else
         self.class.new(self)
       end
     end
-    alias :sort_by :sort
+    alias sort_by sort
 
     # Find the index of a given object or an element that satisfies the given
     # block.
@@ -550,7 +553,7 @@ module Immutable
         super(&block)
       end
     end
-    alias :index :find_index
+    alias index find_index
 
     # Drop the first `n` elements and return the rest in a new `SortedSet`.
     #
@@ -628,9 +631,9 @@ module Immutable
     def union(other)
       self.class.alloc(@node.bulk_insert(other))
     end
-    alias :| :union
-    alias :+ :union
-    alias :merge :union
+    alias | union
+    alias + union
+    alias merge union
 
     # Return a new `SortedSet` which contains all the items which are members of both
     # this set and `other`. `other` can be any `Enumerable` object.
@@ -644,7 +647,7 @@ module Immutable
     def intersection(other)
       self.class.alloc(@node.keep_only(other))
     end
-    alias :& :intersection
+    alias & intersection
 
     # Return a new `SortedSet` with all the items in `other` removed. `other` can be
     # any `Enumerable` object.
@@ -658,8 +661,8 @@ module Immutable
     def difference(other)
       self.class.alloc(@node.bulk_delete(other))
     end
-    alias :subtract :difference
-    alias :- :difference
+    alias subtract difference
+    alias - difference
 
     # Return a new `SortedSet` with all the items which are members of this
     # set or of `other`, but not both. `other` can be any `Enumerable` object.
@@ -673,7 +676,7 @@ module Immutable
     def exclusion(other)
       ((self | other) - (self & other))
     end
-    alias :^ :exclusion
+    alias ^ exclusion
 
     # Return `true` if all items in this set are also in `other`.
     #
@@ -752,8 +755,8 @@ module Immutable
       !disjoint?(other)
     end
 
-    alias :group :group_by
-    alias :classify :group_by
+    alias group group_by
+    alias classify group_by
 
     # Select elements greater than a value.
     #
@@ -947,10 +950,11 @@ module Immutable
       return true if other.equal?(self)
       return false if not instance_of?(other.class)
       return false if size != other.size
-      a, b = self.to_enum, other.to_enum
-      while true
+      a, b = to_enum, other.to_enum
+      loop do
         return false if !a.next.eql?(b.next)
       end
+      true
     rescue StopIteration
       true
     end
@@ -967,7 +971,7 @@ module Immutable
     def dup
       self
     end
-    alias :clone :dup
+    alias clone dup
 
     # @return [::Array]
     # @private

data/lib/immutable/trie.rb

@@ -2,7 +2,7 @@ module Immutable
   # @private
   class Trie
     def self.[](pairs)
-      result = self.new(0)
+      result = new(0)
       pairs.each { |key, val| result.put!(key, val) }
       result
     end
@@ -269,7 +269,7 @@ module Immutable
       end
       true
     end
-    alias :== :eql?
+    alias == eql?
 
     protected
 

data/lib/immutable/vector.rb

@@ -1,8 +1,7 @@
-require "immutable/enumerable"
-require "immutable/hash"
+require 'immutable/enumerable'
+require 'immutable/hash'
 
 module Immutable
-
   # A `Vector` is an ordered, integer-indexed collection of objects. Like
   # Ruby's `Array`, `Vector` indexing starts at zero and negative indexes count
   # back from the end.
@@ -48,7 +47,7 @@ module Immutable
     # Return the number of items in this `Vector`
     # @return [Integer]
     attr_reader :size
-    alias :length :size
+    alias length size
 
     class << self
       # Create a new `Vector` populated with the given items.
@@ -62,7 +61,7 @@ module Immutable
       #
       # @return [Vector]
       def empty
-        @empty ||= self.new
+        @empty ||= new
       end
 
       # "Raw" allocation of a new `Vector`. Used internally to create a new
@@ -132,8 +131,8 @@ module Immutable
     def add(item)
       update_root(@size, item)
     end
-    alias :<< :add
-    alias :push :add
+    alias << add
+    alias push add
 
     # Return a new `Vector` with a new value at the given `index`. If `index`
     # is greater than the length of the vector, the returned vector will be
@@ -197,7 +196,7 @@ module Immutable
     # @return [Vector]
     def update_in(*key_path, &block)
       if key_path.empty?
-        raise ArgumentError, "must have at least one key in path"
+        raise ArgumentError, 'must have at least one key in path'
       end
       key = key_path[0]
       if key_path.size == 1
@@ -226,7 +225,7 @@ module Immutable
       return nil if index >= @size || index < 0
       leaf_node_for(@root, @levels * BITS_PER_LEVEL, index)[index & INDEX_MASK]
     end
-    alias :at :get
+    alias at get
 
     # Retrieve the value at `index` with optional default.
     #
@@ -355,7 +354,7 @@ module Immutable
         subsequence(arg, length)
       end
     end
-    alias :[] :slice
+    alias [] slice
 
     # Return a new `Vector` with the given values inserted before the element
     # at `index`. If `index` is greater than the current length, `nil` values
@@ -402,7 +401,7 @@ module Immutable
       index += @size if index < 0
 
       suffix = flatten_suffix(@root, @levels * BITS_PER_LEVEL, index, [])
-      replace_suffix(index, suffix.tap { |a| a.shift })
+      replace_suffix(index, suffix.tap(&:shift))
     end
 
     # Return a new `Vector` with the last element removed. Return `self` if
@@ -490,8 +489,8 @@ module Immutable
       return enum_for(:select) unless block_given?
       reduce(self.class.empty) { |vector, item| yield(item) ? vector.add(item) : vector }
     end
-    alias :find_all :select
-    alias :keep_if  :select
+    alias find_all select
+    alias keep_if  select
 
     # Return a new `Vector` with all items which are equal to `obj` removed.
     # `#==` is used for checking equality.
@@ -518,7 +517,7 @@ module Immutable
       return self if empty?
       self.class.new(super)
     end
-    alias :collect :map
+    alias collect map
 
     # Return a new `Vector` with the concatenated results of running the block once
     # for every element in this `Vector`.
@@ -553,7 +552,7 @@ module Immutable
     #
     # @return [Vector]
     def uniq(&block)
-      array = self.to_a
+      array = to_a
       if array.frozen?
         self.class.new(array.uniq(&block).freeze)
       elsif array.uniq!(&block) # returns nil if no changes were made
@@ -609,7 +608,7 @@ module Immutable
     # @return [Vector]
     def flatten(level = -1)
       return self if level == 0
-      array = self.to_a
+      array = to_a
       if array.frozen?
         self.class.new(array.flatten(level).freeze)
       elsif array.flatten!(level) # returns nil if no changes were made
@@ -633,7 +632,7 @@ module Immutable
       other = other.dup if other.frozen?
       replace_suffix(@size, other)
     end
-    alias :concat :+
+    alias concat +
 
     # Combine two vectors by "zipping" them together. `others` should be arrays
     # and/or vectors. The corresponding elements from this `Vector` and each of
@@ -721,7 +720,7 @@ module Immutable
     def drop(n)
       return self if n == 0
       return self.class.empty if n >= @size
-      raise ArgumentError, "attempt to drop negative size" if n < 0
+      raise ArgumentError, 'attempt to drop negative size' if n < 0
       self.class.new(flatten_suffix(@root, @levels * BITS_PER_LEVEL, n, []))
     end
 
@@ -862,7 +861,7 @@ module Immutable
       elsif n == 1
         each { |item| yield [item] }
       elsif n == @size
-        yield self.to_a
+        yield to_a
       else
         combos = lambda do |result,index,remaining|
           while @size - index > remaining
@@ -969,15 +968,14 @@ module Immutable
         used, result = [], []
         perms = lambda do |index|
           0.upto(@size-1) do |i|
-            if !used[i]
-              result[index] = get(i)
-              if index < n-1
-                used[i] = true
-                perms[index+1]
-                used[i] = false
-              else
-                yield result.dup
-              end
+            next if used[i]
+            result[index] = get(i)
+            if index < n-1
+              used[i] = true
+              perms[index+1]
+              used[i] = false
+            else
+              yield result.dup
             end
           end
         end
@@ -1085,13 +1083,13 @@ module Immutable
       end
 
       if block_given?
-        while true
+        loop do
           yield build_array[]
           return self if bump_counters[]
         end
       else
         result = []
-        while true
+        loop do
           result << build_array[]
           return result if bump_counters[]
         end
@@ -1114,7 +1112,7 @@ module Immutable
     #
     # @return [Vector]
     # @raise [IndexError] if elements are not of the same size.
-    # @raise [TypeError] if an element can not be implicitly converted to an array (using `#to_ary`)
+    # @raise [TypeError] if an element does not respond to #size and #[]
     def transpose
       return self.class.empty if empty?
       result = Array.new(first.size) { [] }
@@ -1132,6 +1130,13 @@ module Immutable
 
       result.map! { |a| self.class.new(a) }
       self.class.new(result)
+    rescue NoMethodError
+      if any? { |x| !x.respond_to?(:size) || !x.respond_to?(:[]) }
+        bad = find { |x| !x.respond_to?(:size) || !x.respond_to?(:[]) }
+        raise TypeError, "'#{bad.inspect}' must respond to #size and #[] to be transposed"
+      else
+        raise
+      end
     end
 
     # Finds a value from this `Vector` which meets the condition defined by the
@@ -1301,7 +1306,7 @@ module Immutable
         flatten_node(@root, @levels * BITS_PER_LEVEL, [])
       end
     end
-    alias :to_ary :to_a
+    alias to_ary to_a
 
     # Return true if `other` has the same type and contents as this `Vector`.
     #
@@ -1325,7 +1330,7 @@ module Immutable
     def dup
       self
     end
-    alias :clone :dup
+    alias clone dup
 
     # @return [::Array]
     # @private
@@ -1454,7 +1459,7 @@ module Immutable
           from_slot.upto(node.size-1) do |i|
             flatten_node(node[i], bitshift - BITS_PER_LEVEL, result)
           end
-        elsif child = node[from_slot]
+        elsif (child = node[from_slot])
           flatten_suffix(child, bitshift - BITS_PER_LEVEL, from, result)
           (from_slot+1).upto(node.size-1) do |i|
             flatten_node(node[i], bitshift - BITS_PER_LEVEL, result)
@@ -1524,7 +1529,7 @@ module Immutable
             end
             result.concat(remainder)
           end
-        elsif child = node[from_slot]
+        elsif (child = node[from_slot])
           result = node.take(from_slot)
           result.push(replace_node_suffix(child, bitshift - BITS_PER_LEVEL, from, suffix))
           remainder = suffix.shift((31 - from_slot) * (1 << bitshift))

data/lib/immutable/version.rb

@@ -1,5 +1,5 @@
 module Immutable
   # Current released gem version. Note that master will often have the same
   # value as a release gem but with different code.
-  VERSION = "0.0.4"
+  VERSION = '0.1.0'
 end

data/lib/immutable.rb

@@ -1,9 +1,9 @@
-require "immutable/core_ext"
-require "immutable/list"
-require "immutable/deque"
-require "immutable/hash"
-require "immutable/set"
-require "immutable/vector"
-require "immutable/sorted_set"
-require "immutable/nested"
-require "immutable/version"
+require 'immutable/core_ext'
+require 'immutable/list'
+require 'immutable/deque'
+require 'immutable/hash'
+require 'immutable/set'
+require 'immutable/vector'
+require 'immutable/sorted_set'
+require 'immutable/nested'
+require 'immutable/version'