flex_array 0.3.5 → 0.3.6

data/lib/flex_array/array.rb

@@ -1,33 +1,22 @@
-#Extensions to Array needed to support flex array.
+# Extensions to Array needed to support flex array.
+
 class Array
-  #Get the specifications of the array index values.
-  #<br>Returns
-  #* An array with one range in it.
+  # Get the specifications of the array index values.
   def limits
     [0...self.length]
   end
 
-  #Quick access to the limits for internal use.
-  #<br>Returns
-  #* An array with one spec component in it.
+  # Quick access to the limits for internal use.
   def array_specs
     SpecArray.new([0...self.length])
   end
 
-  #Quick access to the array data for internal use.
-  #<br>Returns
-  #* An array -- self
+  # Quick access to the array data for internal use.
   def array_data
     self
   end
 
-  #Convert this array to an range index against the spec.
-  #<br>Parameters
-  #* spec - The spec component used to validate this index.
-  #<br>Returns
-  #* A range.
-  #<br>Exceptions
-  #* IndexError if the range is not valid.
+  # Convert this array to an range index against the spec.
   def to_index_range(spec)
     spec_max = spec.max
 
@@ -43,13 +32,9 @@ class Array
     end
   end
 
-  #Return this flex array as a flex array!
-  #<br>Returns
-  #* A flex array that references this array.
-  #<br>Note
-  #* To avoid a shared reference, use my_array.dup.to_flex_array or
-  #  FlexArray.new_from_array(my_array.dup)  instead.
+  # Return this flex array as a flex array!
   def to_flex_array
     FlexArray.new_from_array(self)
   end
-end
+
+end

data/lib/flex_array/flex_array_append.rb

@@ -1,12 +1,7 @@
-#* flex_array_append.rb - The flexible array class << and related methods.
+# Append method support for the flex array.
+
 class FlexArray
-  #Append to the flex array.
-  #<br>Parameters
-  #* data - the data being appended to this array.
-  #<br>Returns
-  #* The array spec of the array being appended.
-  #<br>Exceptions
-  #* ArgumentError if the data may not be appended.
+  # Append to the flex array.
   def << (data)
     fail "Cannot append to a transposed array." if @transposed
     specs = get_append_specs(data = data.in_array)
@@ -15,22 +10,8 @@ class FlexArray
     self
   end
 
-  #Make a copy of the other's data.
-  #<br>Parameters
-  #* other - The flex array whose data is to be copied.
-  def copy_data(other)
-    fail ArgumentError, "Incompatible data copy." unless compatible?(other)
-    @array_data = other.array_data.dup
-  end
-
   private
-  #Extract and validate the append array_spec
-  #<br>Parameters
-  #* data - the data being appended to this array.
-  #<br>Returns
-  #* The array spec of the array being appended.
-  #<br>Exceptions
-  #* ArgumentError if the data may not be appended.
+  # Extract and validate the append array_spec
   def get_append_specs(data)
     spec_len = (specs = data.array_specs).length
 

data/lib/flex_array/flex_array_each.rb

@@ -1,21 +1,9 @@
-#* flex_array_each.rb - The flexible array class each and related methods.
-# :reek:RepeatedConditional - @transposed determines if short cuts are allowed.
+# Support for each and related methods for the flex array.
+
 class FlexArray
   include Enumerable
 
-  #Retrieve data from the array endlessly repeating as needed.
-  #<br>Parameters
-  #* count - The number of times to cycle through the flex array. Defaults to
-  #  cycling forever.
-  #* block - The optional block to be executed for each selected array element.
-  #  The return value is the last value returned by the block. If the block
-  #  is not present, then an enumerator object is returned.
-  #<br>Returns
-  #* nil or an enumerator if no block is provided.
-  #<br>Block Arguments
-  #* value - Each value selected by the iteration.
-  #<br>Endemic Code Smells
-  #* :reek:NestedIterators
+  # Retrieve data from the array endlessly repeating as needed.
   def cycle(count = FOREVER, &block)
     if block_given?
       if @transposed && length > 0
@@ -34,22 +22,7 @@ class FlexArray
     end
   end
 
-  #Retrieve data from a subset of the flex array endlessly repeating as needed.
-  #<br>Parameters
-  #* indexes - An array with as many entries as the flexible array has
-  #  dimensions. See [] for more details. Note that since indexes is NOT
-  #  a splat parameter, it must be passed as an array explicitly.
-  #* count - The number of times to cycle through the flex array. Defaults to
-  #  cycling forever.
-  #* block - The optional block to be executed for each selected array element.
-  #  The return value is the last value returned by the block. If the block
-  #  is not present, then an enumerator object is returned.
-  #<br>Returns
-  #* nil or an enumerator if no block is provided.
-  #<br>Block Arguments
-  #* value - Each value selected by the iteration.
-  #<br>Endemic Code Smells
-  #* :reek:NestedIterators
+  # Retrieve data from a subset of the flex array endlessly repeating as needed.
   def select_cycle(indexes, count = FOREVER, &block)
     validate_index_count(indexes)
 
@@ -68,14 +41,7 @@ class FlexArray
     end
   end
 
-  #Process the standard each operator.
-  #<br>Parameters
-  #* block - The optional block to be executed for each selected array element.
-  #<br>Returns
-  #* If the block is not present, then an enumerator object is returned.
-  #  Otherwise the flex array is returned.
-  #<br>Block Arguments
-  #* value - Each value selected by the iteration.
+  # Process the standard each operator.
   def each(&block)
     if block_given?
       if @transposed
@@ -90,17 +56,7 @@ class FlexArray
     end
   end
 
-  #Process the enhanced select_each operator.
-  #<br>Parameters
-  #* indexes - An array with as many entries as the flexible array has
-  #  dimensions. See [] for more details. Note that since indexes is NOT
-  #  a splat parameter, it must be passed as an array explicitly
-  #* block - The optional block to be executed for each selected array element.
-  #<br>Returns
-  #* If the block is not present, then an enumerator object is returned.
-  #  Otherwise the flex array is returned.
-  #<br>Block Arguments
-  #* value - Each value selected by the iteration.
+  # Process the enhanced select_each operator.
   def select_each(indexes, &block)
     validate_index_count(indexes)
 
@@ -112,15 +68,7 @@ class FlexArray
     end
   end
 
-  #Process the standard each_with_index operator.
-  #<br>Parameters
-  #* block - The optional block to be executed for each selected array element.
-  #<br>Returns
-  #* If the block is not present, then an enumerator object is returned.
-  #  Otherwise the flex array is returned.
-  #<br>Block Arguments
-  #* value - Each value selected by the iteration.
-  #* index - An array with the full index of the selected value.
+  # Process the standard each_with_index operator.
   def each_with_index(&block)
     if block_given?
       process_all {|index, posn| block.call(@array_data[posn], index)}
@@ -130,18 +78,7 @@ class FlexArray
     end
   end
 
-  #Process the enhanced select_each_with_index operator.
-  #<br>Parameters
-  #* indexes - An array with as many entries as the flexible array has
-  #  dimensions. See [] for more details. Note that since indexes is NOT
-  #  a splat parameter, it must be passed as an array explicitly.
-  #* block - The optional block to be executed for each selected array element.
-  #<br>Returns
-  #* If the block is not present, then an enumerator object is returned.
-  #  Otherwise the flex array is returned.
-  #<br>Block Arguments
-  #* value - Each value selected by the iteration.
-  #* index - An array with the full index of the selected value.
+  # Process the enhanced select_each_with_index operator.
   def select_each_with_index(indexes, &block)
     validate_index_count(indexes)
 
@@ -153,18 +90,8 @@ class FlexArray
     end
   end
 
-  #A specialized each variant that passes the low level data, the index
-  #and the position to the block.
-  #<br>Parameters
-  #* block - The optional block to be executed for each selected array element.
-  #  The return value is the last value returned by the block. If the block
-  #  is not present, then an enumerator object is returned.
-  #<br>Returns
-  #* If the block is not present, then an enumerator object is returned.
-  #  Otherwise the flex array is returned.
-  #<br>Block Arguments
-  #* index - An array with the full index of the selected value.
-  #* posn - The position of the data in the low level data store.
+  # A specialized each variant that passes the low level data, the index
+  # and the position to the block.
   def _each_raw(&block)
     if block_given?
       process_all {|index, posn| block.call(index, posn)}
@@ -174,21 +101,8 @@ class FlexArray
     end
   end
 
-  #An enhanced specialized each variant that passes the low level data,
-  #the index and the position to the block.
-  #<br>Parameters
-  #* indexes - An array with as many entries as the flexible array has
-  #  dimensions. See [] for more details. Note that since indexes is NOT
-  #  a splat parameter, it must be passed as an array explicitly.
-  #* block - The optional block to be executed for each selected array element.
-  #  The return value is the last value returned by the block. If the block
-  #  is not present, then an enumerator object is returned.
-  #<br>Returns
-  #* If the block is not present, then an enumerator object is returned.
-  #  Otherwise the flex array is returned.
-  #<br>Block Arguments
-  #* index - An array with the full index of the selected value.
-  #* posn - The position of the data in the low level data store.
+  # An enhanced specialized each variant that passes the low level data,
+  # the index and the position to the block.
   def _select_each_raw(indexes, &block)
     validate_index_count(indexes)
 
@@ -202,47 +116,21 @@ class FlexArray
 
   alias_method :flatten_collect, :collect
 
-  #The flex array version of collect that returns a flex array.
-  #<br>Parameters
-  #* block - The optional block to be executed for each selected array element.
-  #<br>Returns
-  #* An array of the computed objects retuned by the block.
-  #<br>Block Arguments
-  #* value - Each value selected by the iteration.
+  # The flex array version of collect that returns a flex array.
   def collect(&block)
     result = self.dup
     result.collect!(&block)
   end
 
-  #The flex array version of collect that accepts an optional set of indexes
-  #to select the data being collected into a flex array.
-  #<br>Parameters
-  #* indexes - An array with as many entries as the flexible array has
-  #  dimensions. See [] for more details. Note that since indexes is NOT
-  #  a splat parameter, it must be passed as an array explicitly.
-  #* block - The optional block to be executed for each selected array element.
-  #<br>Returns
-  #* An array of the computed objects retuned by the block.
-  #  If the block is not present, an enumerator object is returned.
-  #<br>Block Arguments
-  #* value - Each value selected by the iteration.
+  # The flex array version of collect that accepts an optional set of indexes
+  # to select the data being collected into a flex array.
   def select_collect(indexes, &block)
     result = self.dup
     result.select_collect!(indexes, &block)
   end
 
-  #The flex array version of collect that accepts an optional set of indexes
-  #to select the data being collected into a standard array.
-  #<br>Parameters
-  #* indexes - An array with as many entries as the flexible array has
-  #  dimensions. See [] for more details. Note that since indexes is NOT
-  #  a splat parameter, it must be passed as an array explicitly.
-  #* block - The optional block to be executed for each selected array element.
-  #<br>Returns
-  #* An array of the computed objects retuned by the block.
-  #  If the block is not present, an enumerator object is returned.
-  #<br>Block Arguments
-  #* value - Each value selected by the iteration.
+  # The flex array version of collect that accepts an optional set of indexes
+  # to select the data being collected into a standard array.
   def select_flatten_collect(indexes, &block)
     validate_index_count(indexes)
 
@@ -255,15 +143,7 @@ class FlexArray
     end
   end
 
-  #The flex array version of collect!
-  #<br>Parameters
-  #* block - The *required* block to be executed for each selected array element.
-  #  The return value is the last value returned by the block. If the block
-  #  is not present, an enumerator object is returned.
-  #<br>Returns
-  #* self
-  #<br>Block Arguments
-  #* value - Each value selected by the iteration.
+  # The flex array version of collect!
   def collect!(&block)
     fail ArgumentError, "A block is required." unless block_given?
 
@@ -277,19 +157,8 @@ class FlexArray
     self
   end
 
-  #The enhanced flex array version of collect! that accepts a set of indexes
-  #to select the data being collected.
-  #<br>Parameters
-  #* indexes - An array with as many entries as the flexible array has
-  #  dimensions. See [] for more details. Note that since indexes is NOT
-  #  a splat parameter, it must be passed as an array explicitly.
-  #* block - The *required* block to be executed for each selected array element.
-  #  The return value is the last value returned by the block. If the block
-  #  is not present, an enumerator object is returned.
-  #<br>Returns
-  #* self
-  #<br>Block Arguments
-  #* value - Each value selected by the iteration.
+  # The enhanced flex array version of collect! that accepts a set of indexes
+  # to select the data being collected.
   def select_collect!(indexes, &block)
     fail ArgumentError, "A block is required." unless block_given?
     validate_index_count(indexes)
@@ -300,17 +169,9 @@ class FlexArray
     self
   end
 
-  #The flex array version of find_index. This returns the
-  #coordinates of the first object that matches the search object or is
-  #flagged true by the search block.
-  #<br>Parameters
-  #* object - The optional value to search for.
-  #* block - The optional block to be executed for each selected array element.
-  #  If the block or object are not present, an enumerator object is returned.
-  #<br>Returns
-  #* The index of the first place that matched or nil if none matched.
-  #<br>Block Arguments
-  #* value - Each value selected by the iteration.
+  # The flex array version of find_index. This returns the coordinates of the
+  # first object that matches the search object or is flagged true by the
+  # search block.
   def find_index(value = nil, &block)
     blk = get_find_block(value, &block)
 
@@ -327,20 +188,9 @@ class FlexArray
     end
   end
 
-  #The enhanced flex array version of find_index. This returns the
-  #coordinates of the first object that matches the search object or is
-  #flagged true by the search block.
-  #<br>Parameters
-  #* indexes - An array with as many entries as the flexible array has
-  #  dimensions. See [] for more details. Note that since indexes is NOT
-  #  a splat parameter, it must be passed as an array explicitly.
-  #* object - The optional value to search for.
-  #* block - The optional block to be executed for each selected array element.
-  #  If the block or object are not present, an enumerator object is returned.
-  #<br>Returns
-  #* The index of the first place that matched or nil if none matched.
-  #<br>Block Arguments
-  #* value - Each value selected by the iteration.
+  # The enhanced flex array version of find_index. This returns the coordinates
+  # of the first object that matches the search object or is flagged true by
+  # the search block.
   def select_find_index(indexes, value = nil, &block)
     validate_index_count(indexes)
     blk = get_find_block(value, &block)
@@ -358,17 +208,9 @@ class FlexArray
     end
   end
 
-  #The improved flex array version of find_index. This returns the
-  #coordinates of objects that match the search object or are
-  #flagged true by the search block.
-  #<br>Parameters
-  #* object - The optional value to search for.
-  #* block - The optional block to be executed for each selected array element.
-  #  If the block or object are not present, an enumerator object is returned.
-  #<br>Returns
-  #* An array of the indexes of the places that matched.
-  #<br>Block Arguments
-  #* value - Each value selected by the iteration.
+  # The improved flex array version of find_index. This returns the coordinates
+  # of objects that match the search object or are flagged true by the search
+  # block.
   def find_indexes(value = nil, &block)
     blk, result = get_find_block(value, &block), []
 
@@ -385,20 +227,9 @@ class FlexArray
     end
   end
 
-  #The enhanced and improved flex array version of find_index. This returns the
-  #coordinates of objects that match the search object or are
-  #flagged true by the search block.
-  #<br>Parameters
-  #* indexes - An array with as many entries as the flexible array has
-  #  dimensions. See [] for more details. Note that since indexes is NOT
-  #  a splat parameter, it must be passed as an array explicitly.
-  #* object - The optional value to search for.
-  #* block - The optional block to be executed for each selected array element.
-  #  If the block or object are not present, an enumerator object is returned.
-  #<br>Returns
-  #* An array of the indexes of the places that matched.
-  #<br>Block Arguments
-  #* value - Each value selected by the iteration.
+  # The enhanced and improved flex array version of find_index. This returns
+  # the coordinates of objects that match the search object or are flagged true
+  # by the search block.
   def select_find_indexes(indexes, value = nil, &block)
     validate_index_count(indexes)
     blk, result = get_find_block(value, &block), []
@@ -418,16 +249,10 @@ class FlexArray
 
   private
 
-  #A helper method to determine which block to use in the find_index family.
-  #<br>Returns
-  #* The block to use or nil.
-  #<br>Endemic Code Smells
-  #* :reek:NilCheck
+  # A helper method to determine which block to use in the find_index family.
   def get_find_block(value, &block)
     if block_given?
       block
-    elsif value.nil?
-      nil
     else
       lambda {|obj| obj == value }
     end