webget_ruby_ramp 1.8.0 → 1.8.2

data.tar.gz.sig

@@ -1,2 +1,2 @@
-0��壳>m%ka	eB��_���E���o���LjPV���n�pZae/��������������}��9G��H����AI�4(M�*ʆ�/"I��$��Y�9
-Y(��Oo!Y�&�͒Vijv�
+�]x̸4�B^���xf!�8�B��?�_��YӌJł���i�f]>$���h#mF�%��+ciW�	.�:^���6*�|��?�F{W�
=Ut����}p�J��3�\���Z����8㎫���s��YW
+G}

data/README.rdoc

@@ -9,8 +9,10 @@ License:: LGPL, GNU Lesser General Public License
 Ramp is a library of extensions to Ruby base classes, including Array, Date, Enumerable, Hash, Kernel, Numeric, Object, Process, String, Time, and YAML. 
 
 Testing: 
-* Each has an associated test class, e.g., ArrayTest, DateTest, etc.
-* The easy way to run the tests: gem install webget_ruby_ramp --test
+<ul>
+<li>Each has an associated test class, e.g., ArrayTest, DateTest, etc.
+<li>The easy way to run the tests: gem install webget_ruby_ramp --test
+</ul>
 
 
 == Array
@@ -32,6 +34,11 @@ Testing:
 * union: builds an array containing each of the unique elements of sub-arrays ([[1,2,3,4],[2,3,4,5],[3,4,5,6]].union => [1,2,3,4,5,6])
 
 
+== Class
+
+* publicize_methods: make all methods public for a block, e.g. to unit test private methods
+
+
 == CSV
 
 * http_headers: provides web file download headers for text/csv content type and disposition.
@@ -65,6 +72,12 @@ Testing:
 * File.joindir: wrapper for File.join(File.dirname(...),string,...)
 
 
+== Fixnum
+
+* even?: is the number even?
+* odd?: is the number odd?
+
+
 == Hash
 
 * size?: return true if hash has any keys
@@ -79,7 +92,8 @@ Testing:
 
 == Integer
 
-* maps: syntactic sugar to yield n times to a block, returning an array of any results (e.g. 3.maps{rand} => [0.4351325,0.7778625,0.158613534])
+* maps: syntactic sugar to yield n times to a block, returning an array of any results
+* odd?: is the number odd?
 
 
 == IO
@@ -90,8 +104,8 @@ Testing:
 
 == Kernel
 
-* method_name: 
-* method_name_of_caller: returns the name of the method which called the current method, or the Nth parent up the call stack if the optional caller_index parameter is passed.
+* my_method_name: returns the name of the current method
+* caller_method_name: returns the name of the caller method, or the Nth parent up the call stack if the optional caller_index parameter is passed.
 
 
 == Math
@@ -109,7 +123,6 @@ Testing:
 
 * if: returns 0 if the passed flag is any of: nil, false, 0, [], {} and otherwise returns self
 * unless: returns 0 unless the passed flag is any of: nil, false, 0, [], {} and otherwise returns self
-* peta, tera, giga, mega, kilo, hecto, deka, deci, centi, milli, micro, nano: multiply/divide by powers of ten
 
 
 == Object
@@ -184,7 +197,11 @@ Extensions that help debug Ruby programs.
 
 == Changes
 
-- 1.7.3 Refactor Rails classes to their own gem
+- 1.8.2 Refactored Numeric metric names into their own methods
+- 1.8.0 100% rcov coverage
+- 1.7.8 Add rcov testing
+- 1.7.4 Add Class#publicize_methods, Integer#even?, Integer#odd?
+- 1.7.3 Refactor Rails classes to their own gem, add README, LICENSE
 - 1.7.2 Gemcutter update
 - 1.7.1.8 Add Enumerable#map_with_index
 - 1.7.1.6 Add ActiveRecord::SaveExtensions#save_false_then_reload!

data/lib/webget_ruby_ramp.rb

@@ -93,7 +93,7 @@ Testing:
 
 == Integer
 
-* maps: syntactic sugar to yield n times to a block, returning an array of any results (e.g. 3.maps{rand} => [0.4351325,0.7778625,0.158613534])
+* maps: syntactic sugar to yield n times to a block, returning an array of any results
 * odd?: is the number odd?
 
 
@@ -124,7 +124,6 @@ Testing:
 
 * if: returns 0 if the passed flag is any of: nil, false, 0, [], {} and otherwise returns self
 * unless: returns 0 unless the passed flag is any of: nil, false, 0, [], {} and otherwise returns self
-* peta, tera, giga, mega, kilo, hecto, deka, deci, centi, milli, micro, nano: multiply/divide by powers of ten
 
 
 == Object
@@ -199,6 +198,7 @@ Extensions that help debug Ruby programs.
 
 == Changes
 
+- 1.8.2 Refactored Numeric metric names into their own methods
 - 1.8.0 100% rcov coverage
 - 1.7.8 Add rcov testing
 - 1.7.4 Add Class#publicize_methods, Integer#even?, Integer#odd?

data/lib/webget_ruby_ramp/array.rb

@@ -14,15 +14,17 @@ class Array
 
   # Concatenate the items into a string by join.
   #
-  # ==Typical Array#join with infix
+  # @return [String] concatenated string
+  #
+  # @example Typical Array#join with infix
   #   list=['a','b','c']
   #   list.join("*") => "a*b*c"
   #
-  # ==Improved join with infix, prefix, suffix
+  # @example Improved join with infix, prefix, suffix
   #   list=['a','b','c']
   #   list.join("*","[","]") => "[a]*[b]*[c]"
   #
-  # ==Improved join with just prefix and suffix
+  # @example Improved join with just prefix and suffix
   #   list=['a','b','c']
   #   list.join("[","]") => "[a][b][c]"
 
@@ -48,9 +50,9 @@ class Array
   end
 
 
-  # Return true if size > 0
+  # @return [Boolean] true if size > 0
   #
-  # ==Examples
+  # @example
   #   [1,2,3].size? => true
   #   [].size? => false
 
@@ -61,12 +63,12 @@ class Array
 
   # Move the first item to the last by using Array#shift and Array#push
   #
-  # ==Examples
+  # @example
   #   [1,2,3,4].rotate! => [2,3,4,1]
   #   ['a','b','c'].rotate! => ['b','c','a']
   #   [].rotate! => []
   #
-  # Return self
+  # @return [Array] self
   
   def rotate!
     if size>0
@@ -76,9 +78,9 @@ class Array
   end
 
   
-  # Return a random item from the array
+  # @return [Object] a random item from the array
   #
-  # ==Examples
+  # @example
   #   [1,2,3,4].choice => 2
   #   [1,2,3,4].choice => 4
   #   [1,2,3,4].choice => 3
@@ -90,9 +92,9 @@ class Array
   end
 
 
-  # Return a new array filled with _count_ calls to choice
+  # @return [Array] a new array filled with _count_ calls to choice
   #
-  # ==Examples
+  # @example
   #   [1,2,3,4].choices(2) => [3,1]
   #   [1,2,3,4].choices(3) => [4,2,3]
   
@@ -103,10 +105,10 @@ class Array
   end
 
 
-  # Return a hash of this array's items as keys
-  # mapped onto another array's items as values.
+  # @return [Hash] a hash of this array's items as keys,
+  #   mapped onto another array's items as values.
   #
-  # ==Example
+  # @example
   #   foo=[:a,:b,:c]
   #   goo=[:x,:y,:z]
   #   foo.onto(goo) => {:a=>:x, :b=>:y, :c=>:z}
@@ -126,15 +128,17 @@ class Array
   ##############################################################
 
 
-  # Return items in groups of _n_ items (aka slices)
+  # Slice the array.
+  #
+  # @return [Array<Array<Object>>] items in groups of _n_ items (aka slices)
   #
-  # ==Examples
+  # @example
   #   [1,2,3,4,5,6,7,8].slices(2) => [[1,2],[3,4],[5,6],[7,8]]
   #   [1,2,3,4,5,6,7,8].slices(4) => [[1,2,3,4],[5,6,7,8]]
   #
   # If the slices don't divide evenly, then the last is smaller.
   #
-  # ==Examples
+  # @example
   #   [1,2,3,4,5,6,7,8].slices(3) => [[1,2,3],[4,5,6],[7,8]] 
   #   [1,2,3,4,5,6,7,8].slices(5) => [[1,2,3,4,5],[6,7,8]] 
 
@@ -153,12 +157,14 @@ class Array
 
   # Divvy the array, like a pie, into _n_ number of slices.
   #
+  # @return [Array<Array<Object>>] items grouped into _n_ slices
+  #
   # If the array divides evenly, then each slice has size/n items.
   #
   # Otherwise, divvy makes a best attempt by rounding up to give
   # earlier slices one more item, which makes the last slice smaller:
   #
-  # ==Examples
+  # @example
   #   [1,2,3,4,5].divvy(2) => [[1,2,3],[4,5]]
   #   [1,2,3,4,5,6,7].divvy(3) => [[1,2,3],[4,5,6],[7]]
   #
@@ -166,7 +172,7 @@ class Array
   # no mathematical way to _n_ slices, then divvy will return
   # as many slices as it can.
   #
-  # ==Examples
+  # @example
   #   [1,2,3,4,5,6].divvy(4) => [[1,2],[3,4],[5,6]]
 
   def divvy(number_of_slices)
@@ -183,18 +189,19 @@ class Array
   ##############################################################
 
   
-  # Return the union of the array's items.
+  # @return [Array] the union of the array's items.
+  #
   # In typical use, each item is an array.
   #
-  # ==Example using Ruby Array pipe
+  # @example using Ruby Array pipe
   #   arr=[[1,2,3,4],[3,4,5,6]]
   #   arr.union => [1,2,3,4,5,6]
   #
-  # ==Examples with proc
+  # @example with proc
   #   arr.map(&:foo).union
   #   => foos that are in any of the array items
   #
-  # ==Example with nil
+  # @example with nil
   #   [].union => []
 
   def union
@@ -202,19 +209,20 @@ class Array
   end
 
 
-  # Return the intersection of the array's items.
+  # @return [Array] the intersection of the array's items.
+  #
   # In typical usage, each item is an array.
   #
-  # ==Examples
+  # @example
   #   arr=[[1,2,3,4],[3,4,5,6]]
   #   arr.intersect
   #   => [3,4]
   #
-  # ==Examples with proc
+  # @example with proc
   #   arr.map(&:foo).intersect
   #   => foos that are in all of the array items
   #
-  # ==Example with nil
+  # @example with nil
   #   [].intersect => []
 
   def intersect
@@ -229,14 +237,14 @@ class Array
   #
   ##############################################################
 
-  # Returns the rest of the items of self, after a shift.
+  # @return [Array] the rest of the items of self, after a shift.
   #
-  # ==Example
+  # @example
   #   list=['a','b','c']
   #   list.shift => 'a'
   #   list.shifted => ['b','c']
   #
-  # ==Example with length
+  # @example with length
   #   list.shifted(0) => ['a','b','c']
   #   list.shifted(1) => ['b','c']
   #   list.shifted(2) => ['c']
@@ -262,14 +270,16 @@ class Array
   alias :rest :shifted
 
 
-  # Delete the first _number_of_items_ items. Returns the array, not the deleted items.
+  # Delete the first _number_of_items_ items.
+  #
+  # @return [Array] the array, minus the deleted items.
   # 
-  # ==Example
+  # @example
   #   list=['a','b','c']
   #   list.shifted!
   #   list => ['b','c']
   #
-  # ==Example with length:
+  # @example with length:
   #   list=['a','b','c']
   #   list.shifted!(2)
   #   list => ['c']
@@ -289,10 +299,12 @@ class Array
 
   # Randomly arrange the array items.
   #
+  # @return [Array] the array, with its items shuffled.
+  #
   # This implementation is optimized for speed, not for memory use.
   # See http://codeidol.com/other/rubyckbk/Arrays/Shuffling-an-Array/
   #
-  # ==Example
+  # @example
   #   list=
   #   list=['a','b','c']
   #   list.shuffle!
@@ -305,12 +317,13 @@ class Array
     end
   end
 
-  # Return the array items in random order.
+
+  # @return [Array] a new array with the items shuffled.
   #
   # This implementation is optimized for speed, not for memory use.
   # See http://codeidol.com/other/rubyckbk/Arrays/Shuffling-an-Array/
   #
-  # ==Example
+  # @example
   #   list=
   #   list=['a','b','c']
   #   list.shuffle!
@@ -327,17 +340,17 @@ class Array
   #
   ##############################################################
 
-  # Returns a CSV (Comma Separated Value) string of this array.
+  # @return [String] a CSV (Comma Separated Value) string of this array.
   #
-  # ==Example of a one-dimensional array
+  # @example of a one-dimensional array
   #
   #   [1,2,3].to_csv => "1,2,3\n"
   #
-  # ==Example of a multi-dimensional array
+  # @example of a multi-dimensional array
   #
   #   [[1,2,3],[4,5,6]] => "1,2,3\n4,5,6\n"
   #
-  # ==Example of a blank array
+  # @example of a blank array
   #   
   #   [].to_csv => ""
   #
@@ -366,12 +379,12 @@ class Array
   end
 
 
-  # Returns a TSV (Tab Separated Value) string
-  # representation of a multi-dimensional array.
+  # @return [String] a TSV (Tab Separated Value) string
+  #   representation of a multi-dimensional array.
   #
   # Each subarray becomes one 'line' in the output.
   #
-  # ==Example of a blank array
+  # @example of a blank array
   #   
   #   [].to_csv => ""
 

data/lib/webget_ruby_ramp/class.rb

@@ -12,10 +12,12 @@ class Class
   #
   # From http://blog.jayfields.com/2007/11/ruby-testing-private-methods.html
   #
-  # ==Example
+  # @example
   #   MyClass.publicize_methods do
   #     ...call some method that was private or protected...
   #   end
+  #
+  # @return void
  
   def publicize_methods
     saved_private_instance_methods = self.private_instance_methods

data/lib/webget_ruby_ramp/csv.rb

@@ -4,16 +4,16 @@
 
 class CSV
 
-  # Return HTTP headers for a typical CSV file download without caching.
+  # @return [Hash<String,String>] HTTP headers for a typical CSV file download without caching.
   #
   # ==Options
   #   - filename: defaults to "data.csv"
   #   - request: the incoming http request, which is used to return MSIE-specific headers
   #
-  # ==Example
+  # @example
   #   headers = CSV.http_headers("myfile.csv")
   #
-  # ==Example for Rails
+  # @example for Rails
   #   response.headers.merge CSV.http_headers("myfile.csv")
   # 
   # Ideas from http://stackoverflow.com/questions/94502/in-rails-how-to-return-records-as-a-csv-file/94520
@@ -42,7 +42,7 @@ class CSV
   # Rails automatically defines a _request_ object,
   # that has an env HTTP_USER_AGENT.
   # 
-  # @return [Hash] options
+  # @return [Hash<String,String>] HTTP headers
 
   def self.http_headers_adjust_for_broken_msie(options={})
     request = options[:request] || request 

data/lib/webget_ruby_ramp/date.rb

@@ -6,9 +6,9 @@ require 'date'
 
 class Date
 
-  # Return true if the date is a weekday: Mon, Tue, Wed, Thu, Fri
+  # @return [Boolean] true if the date is a weekday: Mon, Tue, Wed, Thu, Fri
   #
-  # ==Example
+  # @example
   #   d = Date.parse('2008-01-01')
   #   d.wday => 2
   #   d.weekday? => true
@@ -18,9 +18,9 @@ class Date
   end
 
 
-  # Return true if the date is a weekend: Sat, Sun
+  # @return [Boolean] true if the date is a weekend: Sat, Sun
   #
-  # ==Example
+  # @example
   #   d = Date.parse('2008-01-05')
   #   d.wday => 6
   #   d.weekend? => true
@@ -30,9 +30,9 @@ class Date
   end
 
 
-  # Return a random date between min & max
+  # @return [Date] a random date between min & max
   #
-  # ==Example
+  # @example
   #   d1= Date.parse('2008-01-01')
   #   d2= Date.parse('2009-01-01')
   #   Date.between(d1,d3) => Date 2008-11-22
@@ -42,9 +42,9 @@ class Date
   end
 
 
-  # Return date in a sql format: YYYY-MM-DD
+  # @return [String] date in a sql format: YYYY-MM-DD
   #
-  # ==Example
+  # @example
   #   d=Date.today
   #   d.to_sql => "2007-12-31"
 
@@ -53,14 +53,14 @@ class Date
   end
 
 
-  # Return the age in years for a given date.
+  # @return [Integer] the age in years for a given date.
   #
-  # ==Example
+  # @example
   #
   #   birthdate=Date.new(1980,10,31)
   #   birthdate.age_years => 28 (where 28 is the correct age for today)
   #
-  # ==Example of custom dates
+  # @example of custom dates
   #
   #   birthdate=Date.new(1980,10,31)
   #
@@ -82,7 +82,7 @@ class Date
   end
 
 
-  # Return the age in days for a given date.
+  # @return [Integer] the age in days for a given date.
 
   def age_days(compare_date=Date.today)
     (compare_date.is_a? Date) or raise ArgumentError, "compare_date must be a date"