hash-utils 2.0.2 → 2.1.0

data/.travis.yml

@@ -1,4 +1,4 @@
-script: "rake test"
+script: "rake test --trace"
 rvm:
   - 1.9.3
   - 1.9.2
@@ -10,7 +10,3 @@ rvm:
   - jruby-head
   - 1.8.7
   - ree
-jdk:
-  - openjdk7
-  - oraclejdk7
-  - openjdk6

data/CHANGES.txt

@@ -1,4 +1,14 @@
 
+2.1.0 (2012-11-24) 
+* most of missing tests
+* a lot of compatibility problems fixed
+* specs (tests) to standard file structure
+* Hash: #some?, #some_pairs? bug fix 
+* Array: #merge! optimization 
+* Array: #complete_to, #complete_to!, #cut, #cut!, #drop!, #expand_by, 
+  #expand_by!, #interlace, #interlace!, #shrink_to, #shrink_to!, #zip! 
+* Symbol: #<=>
+  
 2.0.2 (2012-10-06)
 * String: #first compatiblity problem with 1.8 fixed
 * StringIO: compatiblity problem with Rubinius 1.9 fixed
@@ -61,9 +71,9 @@
 * Object: #instance_of_any?, #kind_of_any?
 
 0.15.0 (2011-05-30)
-* Hash#keys_to_sym now converts only strings
-* Hash#to_h bug correction
-* Hash#all? removed in favour built-in one
+* Hash: #keys_to_sym now converts only strings
+* Hash: #to_h bug correction
+* Hash: #all? removed in favour built-in one
 * Hash: #get, #get_items, #get_values
 * Symbol: #split
 * Array: #first, #second, #third, #fourth, #fifth, #sixth, 

data/Gemfile.lock

@@ -9,23 +9,23 @@ GEM
       rake
       rdoc
     json (1.7.5)
-    multi_json (1.3.6)
-    rake (0.9.2.2)
+    multi_json (1.4.0)
+    rake (10.0.2)
     rdoc (3.12)
       json (~> 1.4)
-    rspec (2.11.0)
-      rspec-core (~> 2.11.0)
-      rspec-expectations (~> 2.11.0)
-      rspec-mocks (~> 2.11.0)
-    rspec-core (2.11.1)
-    rspec-expectations (2.11.3)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.1)
+    rspec-expectations (2.12.0)
       diff-lcs (~> 1.1.3)
-    rspec-mocks (2.11.3)
-    ruby-version (0.4.2)
-    simplecov (0.6.4)
+    rspec-mocks (2.12.0)
+    ruby-version (0.4.3)
+    simplecov (0.7.1)
       multi_json (~> 1.0)
-      simplecov-html (~> 0.5.3)
-    simplecov-html (0.5.3)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
 
 PLATFORMS
   ruby

data/README.md

@@ -1,13 +1,13 @@
 Hash Utils
 ==========
 
-**hash-utils** adds more than 135 useful and frequently rather 
+**hash-utils** gem adds more than 155 useful and frequently rather 
 fundamental methods which are missing in Ruby programming language, 
 to several core classes. It tries to be similar project to 
 [Ruby Facets][1] on principle, but less complex, more practical, 
 non-atomic and organized by better way.
 
-- `Array` – 15 methods,
+- `Array` – 27 methods,
 - `FalseClass` – 3 methods,
 - `File` – 2 methods,
 - `Gem` – 2 methods,
@@ -18,12 +18,13 @@ non-atomic and organized by better way.
 - `Numeric` – 5 method,
 - `Object` – 15 methods,
 - `Proc` – 1 method,
-- `TrueClass` – 3 methods,
 - `String` – 37 methods,
 - `StringIO` – 1 method,
-- `Symbol` – 8 methods.
+- `Symbol` – 9 methods,
+- `TrueClass` – 3 methods.
 
 For full reference and methods lists, see **[documentation][3]**.
+
 [![Build Status](https://secure.travis-ci.org/martinkozak/hash-utils.png)](http://travis-ci.org/martinkozak/hash-utils)
 
 ### Modularization

data/Rakefile

@@ -20,7 +20,7 @@ Jeweler::Tasks.new do |gem|
   gem.name = "hash-utils"
   gem.homepage = "http://github.com/martinkozak/hash-utils"
   gem.license = "MIT"
-  gem.summary = 'Adds more than 135 useful and frequently rather fundamental methods which are missing in Ruby programming language, to Array, File, Hash, Module, Object, String and Symbol classes. It tries to be similar project to Ruby Facets on principle, but less complex, more practical, non-atomic and organized by better way. Thanks to defensive and careful patching it should be compatible with all other libraries.'
+  gem.summary = 'Adds more than 155 useful and frequently rather fundamental methods which are missing in Ruby programming language, to Array, File, Hash, Module, Object, String and Symbol classes. It tries to be similar project to Ruby Facets on principle, but less complex, more practical, non-atomic and organized by better way. Thanks to defensive and careful patching it should be compatible with all other libraries.'
   #gem.post_install_message = "\nHASH UTILS: The 2.0 version avoids the method overwriting conflicts by not performing overwriting of already implemented methods. By this way, it can damage your existing applications based on older versions although it's very improbable. \n\n"
   gem.email = "martinkozak@martinkozak.net"
   gem.authors = ["Martin Kozák"]
@@ -37,6 +37,5 @@ Jeweler::RubygemsDotOrgTasks.new
 require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:test) do |t|
-  t.pattern = 'tests.rb'
   t.rspec_opts = '--format d -c'
 end

data/TODO.txt

@@ -1,3 +1,2 @@
 * add examples to each call
-* write remaining tests
 * integrate functions from http://rubydoc.info/gems/sane/0.25.5/frames

data/VERSION

@@ -1 +1 @@
-2.0.2
+2.1.0

data/hash-utils.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "hash-utils"
-  s.version = "2.0.2"
+  s.version = "2.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Martin Koz\u{e1}k"]
-  s.date = "2012-10-06"
+  s.date = "2012-12-04"
   s.email = "martinkozak@martinkozak.net"
   s.extra_rdoc_files = [
     "LICENSE.txt",
@@ -42,13 +42,26 @@ Gem::Specification.new do |s|
     "lib/hash-utils/string.rb",
     "lib/hash-utils/stringio.rb",
     "lib/hash-utils/symbol.rb",
-    "tests.rb"
+    "spec/modules/array_spec.rb",
+    "spec/modules/false_spec.rb",
+    "spec/modules/file_spec.rb",
+    "spec/modules/hash_spec.rb",
+    "spec/modules/io_spec.rb",
+    "spec/modules/module_spec.rb",
+    "spec/modules/nil_spec.rb",
+    "spec/modules/numeric_spec.rb",
+    "spec/modules/object_spec.rb",
+    "spec/modules/string_spec.rb",
+    "spec/modules/stringio_spec.rb",
+    "spec/modules/symbol_spec.rb",
+    "spec/modules/true_spec.rb",
+    "spec/spec_helper.rb"
   ]
   s.homepage = "http://github.com/martinkozak/hash-utils"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
   s.rubygems_version = "1.8.24"
-  s.summary = "Adds more than 135 useful and frequently rather fundamental methods which are missing in Ruby programming language, to Array, File, Hash, Module, Object, String and Symbol classes. It tries to be similar project to Ruby Facets on principle, but less complex, more practical, non-atomic and organized by better way. Thanks to defensive and careful patching it should be compatible with all other libraries."
+  s.summary = "Adds more than 155 useful and frequently rather fundamental methods which are missing in Ruby programming language, to Array, File, Hash, Module, Object, String and Symbol classes. It tries to be similar project to Ruby Facets on principle, but less complex, more practical, non-atomic and organized by better way. Thanks to defensive and careful patching it should be compatible with all other libraries."
 
   if s.respond_to? :specification_version then
     s.specification_version = 3

data/lib/hash-utils/array.rb

@@ -100,7 +100,7 @@ class Array
     if not self.__hash_utils_instance_respond_to? :merge!
         def merge!(*arrays)
             arrays.flatten! 1
-            arrays.each { |i| self << i }
+            self.push(*arrays)
             self
         end
     end
@@ -296,7 +296,7 @@ class Array
     end
     
     ##
-    # Converts array to set. Include sets before calling.
+    # Converts array to set. Includes sets before calling.
     #
     # @return [Set] new set
     # @since 2.0.0
@@ -307,5 +307,279 @@ class Array
             Set::new(self)
         end
     end
+
+    ##
+    # Performs array members interlacing in place. It means, it inserts 
+    # given item between members of the array.
+    #
+    # @example
+    #   [:a, :b, :c].interlace!("x")    # will return [:a, 'x', :b, 'x', :c] which will be in the variable
+    #
+    # @param [Object] object new member of the array
+    # @return [Array] new interlaced array
+    # @since 2.1.0
+    # 
+    
+    if not self.__hash_utils_instance_respond_to? :interlace!
+        def interlace!(*objects)
+            self.expand_by!(*objects).cut! objects.length
+        end        
+    end
+
+    ##
+    # Performs array members interlacing. It means, it inserts 
+    # given item between members of the array.
+    #
+    # @example
+    #   [:a, :b, :c].interlace("x")    # will return [:a, 'x', :b, 'x', :c]
+    #
+    # @param [Object] object new member of the array
+    # @return [Array] new interlaced array
+    # @since 2.1.0
+    # 
+    
+    if not self.__hash_utils_instance_respond_to? :interlace
+        def interlace(*objects)
+            self.dup.interlace! *objects
+        end        
+    end
+    
+    ##
+    # Performs array expanding. It means, it inserts 
+    # given items after each member of the array.
+    #
+    # @example
+    #   [:a, :b, :c].expand_by(1, 2)    # will return [:a, 1, 2, :b, 1, 2, :c, 1, 2]
+    #
+    # @param *[Object] object new member of the array
+    # @return [Array] new expanded array
+    # @since 2.1.0
+    # 
+    
+    if not self.__hash_utils_instance_respond_to? :expand_by
+        def expand_by(*objects)
+            self.dup.expand_by!(*objects)
+        end        
+    end
+    
+    ##
+    # Performs array expanding in place. It means, it inserts 
+    # given items after each member of the array.
+    #
+    # @example
+    #   [:a, :b, :c].expand_by(1, 2)    # will return [:a, 1, 2, :b, 1, 2, :c, 1, 2]
+    #
+    # @param *[Object] object new member of the array
+    # @return [Array] expanded array
+    # @since 2.1.0
+    # 
+    
+    if not self.__hash_utils_instance_respond_to? :expand_by!
+        def expand_by!(*objects)
+            if self.empty?
+                self
+            else
+                self.map! { |i| i = [i]; i += objects }.flatten! 1
+            end
+        end        
+    end
+    
+    ##
+    # Cuts out given portion of the array from the end and returns 
+    # remaining part in place.
+    #
+    # @example
+    #   [1, 2, 3, 4, 5, 6].cut! 2     # will return [1, 2, 3, 4] which also be content of a variable
+    #
+    # @param [Integer] indexes  indexes to cut out
+    # @return [Array] resultant array 
+    # @since 2.1.0
+    #
+    
+    if not self.__hash_utils_instance_respond_to? :cut!
+        def cut!(length)
+            delta = self.length - length
+            
+            if delta >= 0
+                self.slice! delta..(self.length)
+                self
+            else
+                self.clear
+            end
+        end        
+    end
+    
+    ##
+    # Cuts out given portion of the array from the end and returns 
+    # remaining.
+    #
+    # @example
+    #   [1, 2, 3, 4, 5, 6].cut! 2     # will return [1, 2, 3, 4]
+    #
+    # @param [Integer] indexes  indexes to cut out
+    # @return [Array] resultant array 
+    # @since 2.1.0
+    #
+    
+    if not self.__hash_utils_instance_respond_to? :cut
+        def cut(length)
+            self.dup.cut! length
+        end        
+    end
+    
+    ##
+    # Performs classical +#zip+ on array, but in place.
+    #
+    # @example
+    #   arr = [1, 2, 3]
+    #   arr.zip!
+    #   arr == [1, 3, 4].zip    # will be true 
+    #
+    # @param *[Array] members
+    # @return [Array]
+    # @since 2.1.0
+    #
+    
+    if not self.__hash_utils_instance_respond_to? :zip!
+        def zip!(*members)
+            self.map! { |i| [i] }
+            lengths = [ ]
+            
+            # creates zip by hand
+            members.each_index do |i|
+                item = members[i]
+                lengths << item.length
+                
+                item.each_index do |j|
+                    self[j][i + 1] = item[j]
+                end
+            end
+            
+            # padds to fixed length according to longest
+            if not lengths.empty?
+                padding = lengths.max + 1
+                self.each { |i| i.complete_to!(padding) }
+            end
+            
+            return self
+        end        
+    end
+    
+    ##
+    # Completes array to given length using given member. Shortens 
+    # longer arrays.
+    #
+    # @example
+    #   [1, 2, 3].complete_to(5, :a)    # will return [1, 2, 3, :a, :a]
+    #
+    # @param [Integer] length
+    # @param [Object] member
+    # @return [Array] resultant array
+    # @since 0.2.1
+    #
+    
+    if not self.__hash_utils_instance_respond_to? :complete_to
+        def complete_to(length, member = nil)
+            self.dup.complete_to!(length, member)
+        end
+    end
+    
+    ##
+    # Completes array to given length using given member in place. 
+    # Shortens longer arrays.
+    #
+    # @example
+    #   x = [1, 2, 3]
+    #   x = x.complete_to!(5, :a)    # will return [1, 2, 3, :a, :a]
+    #
+    # @param [Integer] length
+    # @param [Object] member
+    # @return [Array] itself
+    # @since 0.2.1
+    #
+    
+    if not self.__hash_utils_instance_respond_to? :complete_to!
+        def complete_to!(length, member = nil)
+            delta = length - self.length
+            
+            if delta > 0
+                fill = [member] * delta 
+                self.push(*fill) 
+            elsif delta == 0
+                self
+            else
+                self.shrink_to!(length)
+            end
+        end
+    end
+    
+    ##
+    # Shrinks array to given length. Ignores shorten arrays.
+    #
+    # @example
+    #   [1, 2, 3, 4, 5].shrink_to(3)    # will return [1, 2, 3]
+    #
+    # @param [Integer] length
+    # @return [Array] shorten array
+    # @since 0.2.1
+    # 
+    
+    if not self.__hash_utils_instance_respond_to? :shrink_to
+        def shrink_to(length)
+            self.dup.shrink_to! length
+        end
+    end
+    
+    ##
+    # Shrinks array to given length in place. Ignores shorten arrays.
+    #
+    # @example
+    #   x = [1, 2, 3, 4, 5]
+    #   x.shrink_to!(3)       # will return [1, 2, 3] 
+    #
+    # @param [Integer] length
+    # @return [Array] shorten array
+    # @since 0.2.1
+    # 
+    
+    if not self.__hash_utils_instance_respond_to? :shrink_to!
+        def shrink_to!(length)
+            delta = self.length - length
+            
+            if length < 0
+                raise ::ArgumentError::new("negative argument")
+            elsif delta > 0
+                self.cut! self.length - length
+            else
+                self
+            end
+        end
+    end
+    
+    ##
+    # Make +#drop+, but in-place.
+    #
+    # @example
+    #   x = [1, 2, 3, 4, 5]
+    #   x.drop! 3     # will return [4, 5] which will be in the variable
+    #
+    # @param [Integer] length
+    # @return [Array] remaining part
+    # @since 0.2.1
+    #
+    
+    if not self.__hash_utils_instance_respond_to? :drop!
+        def drop!(length)
+            if length < 0
+                raise ArgumentError::new('attempt to drop negative size')
+            elsif length == 0
+                self
+            else
+                self.slice! 0..(length - 1)
+                self
+            end
+        end
+    end
+    
 end