immutable-ruby 0.0.1 → 0.1.0

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.
     #
@@ -279,6 +278,24 @@ module Immutable
       end
     end
 
+    # Return the value of successively indexing into a nested collection.
+    # If any of the keys is not present, return `nil`.
+    #
+    # @example
+    #   v = Immutable::Vector[9, Immutable::Hash[c: 'a', d: 4]]
+    #   v.dig(1, :c) # => "a"
+    #   v.dig(1, :f) # => nil
+    #
+    # @return [Object]
+    def dig(key, *rest)
+      value = self[key]
+      if rest.empty? || value.nil?
+        value
+      else
+        value.dig(*rest)
+      end
+    end
+
     # Return specific objects from the `Vector`. All overloads return `nil` if
     # the starting index is out of range.
     #
@@ -337,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
@@ -384,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
@@ -472,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.
@@ -500,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`.
@@ -535,18 +552,10 @@ module Immutable
     #
     # @return [Vector]
     def uniq(&block)
-      array = self.to_a
-      if block_given?
-        if array.frozen?
-          self.class.new(array.uniq(&block).freeze)
-        elsif array.uniq!(&block) # returns nil if no changes were made
-          self.class.new(array.freeze)
-        else
-          self
-        end
-      elsif array.frozen?
-        self.class.new(array.uniq.freeze)
-      elsif array.uniq! # returns nil if no changes were made
+      array = to_a
+      if array.frozen?
+        self.class.new(array.uniq(&block).freeze)
+      elsif array.uniq!(&block) # returns nil if no changes were made
         self.class.new(array.freeze)
       else
         self
@@ -599,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
@@ -623,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
@@ -711,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
 
@@ -852,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
@@ -959,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
@@ -1075,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
@@ -1104,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) { [] }
@@ -1122,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
@@ -1291,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`.
     #
@@ -1315,7 +1330,7 @@ module Immutable
     def dup
       self
     end
-    alias :clone :dup
+    alias clone dup
 
     # @return [::Array]
     # @private
@@ -1444,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)
@@ -1514,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.1"
+  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'