webget_ruby_ramp 1.7.3 → 1.7.4

data.tar.gz.sig

@@ -1 +1 @@
-��;dU����6��J��n���\s*P�[�&�Ǎ9��˯p�d;��@���A��'ʤa�F������ ���D��yY�F�祐X����bw����y�6���7�G�j;Ǿ���T�D
+#�	��m��h�5�*�֠bx�_�a�����q����Bռ���]��0�\*�8���1���<�8����q����1_���

data/LICENSE.txt

@@ -0,0 +1,12 @@
+LICENSE
+
+You may choose any of these licenses:
+
+  - CreativeCommons License, Non-commercial Share Alike
+  - LGPL, GNU Lesser General Public License
+  - MIT License
+  - Ruby License
+
+THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.

data/README.rdoc

@@ -0,0 +1,226 @@
+
+= WebGet Ruby Gem: Ramp is a toolkit of Ruby base class extensions
+
+Author:: Joel Parker Henderson, joelparkerhenderson@gmail.com
+Copyright:: Copyright (c) 2006-2010 Joel Parker Henderson
+License:: CreativeCommons License, Non-commercial Share Alike
+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: 
+<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
+
+* car, cdr: aka first, rest (see shifted)
+* choice, choices: one or more random elements from an array
+* cross: return the cross pairings of an array with another array
+* divvy: divides an array, like a pie, into a specified number of slices
+* join: same as Array#join with some improvments
+* onto: return a hash that maps an array's keys on to another array's values
+* rotate: moves the first element of an array to the end
+* rest: return the rest of the items of the array (aka cdr, aka shifted)
+* shifted, shifted!: return an array with the first n items shifted (aka cdr, aka rest)
+* shuffle, shuffle!: randomly sort an array efficiently; each of these methods are loaded only if needed (Ruby 1.8.7+ already defines shuffle)
+* slices: divide an array into specified number of equal size sub-arrays ([1,2,3,4,5,6]slices(3) => [[1,2],[3,4],[5,6]])
+* to_csv: join a multidimensional array into a string in CSV (Comma Separated Values), with each subarray becoming one 'line' in the output; typically for viewing in a spreadsheet such as Excel.
+* to_tdf: join a multidimensional array into a string in TDF (Tab Delimited Format); this is an alias for #to_tsv
+* to_tsv: join a multidimensional array into a string in TSV (Tab Separated Values), with each subarray becoming one 'line' in the output; typically for viewing in a spreadsheet such as Excel.
+* 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])
+
+
+== CSV
+
+* http_headers: provides web file download headers for text/csv content type and disposition.
+
+
+== Date
+
+* age_days, age_years
+* between: a random date between two specified dates
+* to_sql: date as a string formatted as expected for MySQL
+* weekday?, weekend?: is date a weekday or on the weekend
+
+
+== Enumerable
+
+* cartesian_product: return an array of all possible ordered tuples from arrays.
+* hash_by: convert the array to a hash by mapping each item to a key=>value pair.
+* index_by: convert the array to a hash by mapping each ite to a key=>item pair.
+* join: forwards to self.to_a.join
+* map_id: returns the id of an Enumerable object; *requires* that the object respond to an 'id' message
+* map_to_a, map_to_f, map_to_i, map_to_s, map_to_sym: convert each object to a specific type by calling its respective method to_a, to_i, to_f, to_s, to_sym
+* map_with_index: for each item, yield to a block with the item and its incrementing index
+* nitems_until, select_until: returns the number of, or an array containing, the leading elements for which block is false or nil.
+* nitems_while, select_while: returns the number of items, or an array containing the leading elements, for which block is not false or nil.
+* nitems_with_index, select_with_index: calls block with two arguments, the item and its index, for each item in enum. Returns the number of, or an array containing, the leading elements for which block is not false or nil. 
+* power_set: return an array with all subsets of the enum's elements
+
+
+== File
+
+* File.joindir: wrapper for File.join(File.dirname(...),string,...)
+
+
+== Hash
+
+* size?: return true if hash has any keys
+* each_sort: sort the keys then call each
+* each_key!: passes each key to a specified block and updates hash in place if the key changes
+* each_pair!: passes each key value pair to a specified block and updates the hash in place if the key or value change.
+* each_value!: passes each value to a specified block and updates the hash in place if the value changes.
+* map_pair: map each key-value pair by calling a a block
+* pivot: aggregates subtotals by keys and values, such as a rollup and rolldown 
+* to_yaml_sort: returns a YAML object, sorted by field name
+
+
+== 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])
+
+
+== IO
+
+* readrow: reads a row line as with IO#readline, and return the row split it into fields 
+* IO.readrows: reads the entire file specified by name as individual row lines, and returns those rows split into fields, in an array of arrays.
+
+
+== 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.
+
+
+== Math
+
+* ln(x): natural log of x
+* logn(x,b): log of x in base b
+
+
+== NilClass
+
+* blank?: return true (same as Rails)
+
+
+== Numeric
+
+* 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
+
+* in?: returns boolean indicating whether the object is a member of the specified array parameter
+
+
+== Process
+
+Extensions that help debug Ruby programs.
+
+* (class) ps: output of the system 'ps' command, also including aliases, as raw plain text.
+* (class) pss: output of the system 'ps' command as a hash with each value set to the right type, e.g., integer, float, etc..
+
+
+== REXML::Attributes
+
+* hash: flattens the attributes hash set into a more useful ruby hash, e.g. {:height => 100, :width => 400 }
+
+
+== REXML::Document
+
+* remove_attributes: remove all the attributes from the document's elements
+
+
+== REXML::Element
+
+* remove_attributes: remove all the attributes from the element
+
+
+== String
+
+* capitalize_words (alias to titleize/titlecase): ensures the first character of each word is uppercase.
+* decrement: decrease the rightmost natural number, defaults to one value lower or by the optional step parameter value.
+* increment: increase the rightmost natural number, defaults to one value higher or by the optional step parameter value.
+* lorem: return a short random string, good for use in "lorem ipsum" sample text.
+* lowcase: translate a string to lowercase, digits and single underscores (e.g. to a method name)
+* prev/pred: previous string ("b" => "a", "bbc" => "bbb", "a" => "z", "880" => "879")
+* prev!/pred!: updates variable to the previous string in place (astring = "bbc", astring.prev!, puts astring => "bbb")
+* (class) prev_char/pred_char: returns the previous character, with a changed flag and carry flag; that is, there are three returned values, a string and two booleans.
+* split_tab: split the string into an array at each embedded tab ("Last\tFirst\tMiddle" => ["last","first","middle"])
+* split_tsv: split the string into an array at each embedded newline and embedded tab ("A\tB\t\C\nD\tE\tF" => [["A","B","C"],["D","E","F"]])
+* to_class: the global class reference of a given string
+* words: split the string into an array of words
+
+
+== Symbol
+
+* <=> and include the comparable mixin to compare symbols as strings
+
+
+== Time
+
+* (class) stamp: current time in UTC as a timestamp string ("YYYYMMDDHHMMSS")
+* to_sql: time as a string formatted as expected for MySQL
+
+
+== XML
+
+* (class) load_dir: specify a one or more directory patterns and pass each XML file in the matching directories to a block; see [Dir#glob](http://www.ruby-doc.org/core/classes/Dir.html#M002347) for pattern details.
+* (class) strip_all: delete exraneous junk from an XML text string, typically for sanitizing input
+* (class) strip_attributes: delete all attributes from an XML text string
+* (class) strip_comments: delete all comments from an XML text string
+* (class) strip_microsoft: delete all proprietary Microsoft code from an XML text string
+* (class) strip_unprintables: delete all unprintable characters from an XML text string
+
+
+== YAML
+
+* (class) load_dir: specify a one or more directory patterns and pass each YAML file in the matching directories to a block; see [Dir#glob](http://www.ruby-doc.org/core/classes/Dir.html#M002347) for pattern details.
+
+
+== Changes
+
+- 1.7.3 Refactor Rails classes to their own gem
+- 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!
+- 1.7.1.3 Add XML#strip_xxx 
+- 1.7.1.2 Update gems: Gemcutter, Ruby 1.9.1, JRuby sqlite3
+- 1.7.1.0 Add XML attributes methods #
+- 1.7.0.9 Add Enumerable #hash_by, #index_by
+- 1.7.0.7 Add Array#to_tsv, String#split_tsv, improve Array#to_csv
+- 1.7.0.6 Add Array#shuffle, Array#shuffle! 
+- 1.7.0.5 Add Array#shifted, Array#rest, Array#car, Array#cdr
+- 1.7.0.4 Upgrade IO#readrows and #readrow to use options
+- 1.7.0.2 Add Array#to_tdf
+- 1.7.0.1 Remove sqlite3 testing dependency
+- 1.6.9.6 Add Symbol with comparable and <=>
+- 1.6.9.5 Add ActiveRecord testing with sqlite3
+- 1.6.9.4 JRuby install and test successful
+- 1.6.9.3 Array#join add infix, prefix, suffix
+- 1.6.9.2 Improve ri docs
+- 1.6.9.1 Add Array#onto, Enumerable#intersect?
+- 1.6.9.0 Add IO, File, ActiveRecord#seed
+- 1.6.8.9 Add Enumerable#to_h, Array#hash, Hash#each_key!, Hash#each_pair, Hash#each_value!
+- 1.6.8.8 Add Hash#map_pair, Hash#size?, Hash#pivot
+- 1.6.8.7 Add Math
+- 1.6.8.6 Add ActiveRecord SchemaStatements
+- 1.6.8.5 Add Integer#maps, String#ACCENTS
+- 1.6.8.4 Add XML
+- 1.6.8.3 Add ActiveRecord
+- 1.6.8.2 Add String#lowcase
+- 1.6.8 Add map_to_xxx methods
+- 1.6.7 Add CSV
+- 1.6.6 Add Array#to_csv, Integer, String#lorem, etc., improve tests
+- 1.6.4 Bug fixes: String characters and YAML test files
+- 1.6.2 Improve organizaiton of class files to lib/ramp
+- 1.6.0 Upgraded to work with Ruby 1.9.1
+- 1.5.0 Combined all Ruby extension files into one gem
+- 1.0.0 Original 
+

data/lib/webget_ruby_ramp.rb

@@ -35,6 +35,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.
@@ -82,7 +87,9 @@ Testing:
 
 == Integer
 
+* even?: is the number even?
 * 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])
+* odd?: is the number odd?
 
 
 == IO
@@ -187,7 +194,8 @@ Extensions that help debug Ruby programs.
 
 == Changes
 
-- 1.7.3 Refactor Rails classes to their own gem
+- 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!
@@ -227,7 +235,7 @@ Extensions that help debug Ruby programs.
 
 =end
 
-%w{array csv date enumerable file hash integer io kernel math nil numeric object process string symbol time xml yaml}.map{|x|
+['array','class','csv','date','enumerable','file','hash','integer','io','kernel','math','nil','numeric','object','process','string','symbol','time','xml','yaml'].map{|x|
   require File.dirname(__FILE__) + "/webget_ruby_ramp/#{x}.rb"
 }
 

data/lib/webget_ruby_ramp/array.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 require 'csv'
  
 # Array extensions

data/lib/webget_ruby_ramp/class.rb

@@ -0,0 +1,36 @@
+# -*- encoding: utf-8 -*-
+
+# Class extensions
+
+
+class Class
+
+  # Make all the methods public for a block.
+  #
+  # This is especially useful for unit testing
+  # a class's private and protected methods
+  #
+  # From http://blog.jayfields.com/2007/11/ruby-testing-private-methods.html
+  #
+  # ==Example
+  #   MyClass.publicize_methods do
+  #     ...call some method that was private or protected...
+  #   end
+ 
+  def publicize_methods
+    saved_private_instance_methods = self.private_instance_methods
+    saved_protected_instance_methods = self.protected_instance_methods
+    self.class_eval {
+      public *saved_private_instance_methods 
+      public *saved_protected_instance_methods 
+    }
+    yield
+    self.class_eval {
+      private *saved_private_instance_methods 
+      protected *saved_protected_instance_methods 
+    }
+  end
+
+end
+
+

data/lib/webget_ruby_ramp/csv.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 # Comma Separated Values extensions
 
 class CSV
@@ -34,19 +36,22 @@ class CSV
       }
     end
 
+
   # Helper to try to "do the right thing" for the common case of Rails & MS IE.
   #
   # Rails automatically defines a _request_ object,
   # that has an env HTTP_USER_AGENT.
-  
+  # 
+  # @return [Hash] options
+
   def self.http_headers_adjust_for_broken_msie(options={})
     request = options[:request] || request 
     msie = (request and request.env['HTTP_USER_AGENT'] =~ /msie/i)
     if msie
-      options[:content_type]||='text/plain''})'
+      options[:content_type]||='text/plain'
       options[:cache]||=false
     end
-    options
+    return options
   end
 
 end

data/lib/webget_ruby_ramp/date.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 require 'date'
 
 # Date extensions
@@ -5,17 +7,6 @@ require 'date'
 class Date
 
 
-  # Return date in a sql format: YYYY-MM-DD
-  #
-  # ==Example
-  #   d=Date.today
-  #   d.to_sql => "2007-12-31"
-
-  def to_sql
-    return to_time.strftime("%Y-%m-%d")
-  end
-
-
   # Return true if the date is a weekday: Mon, Tue, Wed, Thu, Fri
   #
   # ==Example
@@ -52,6 +43,17 @@ class Date
   end
 
 
+  # Return date in a sql format: YYYY-MM-DD
+  #
+  # ==Example
+  #   d=Date.today
+  #   d.to_sql => "2007-12-31"
+
+  def to_sql
+    return to_time.strftime("%Y-%m-%d")
+  end
+
+
   # Return the age in years for a given date.
   #
   # ==Example
@@ -73,6 +75,7 @@ class Date
   #   birthdate.age_years(new_years_eve) => 28  # after the birthday
 
   def age_years(compare_date=Date.today)
+    (compare_date.is_a? Date) or raise ArgumentError, "compare_date must be a date"
     age=compare_date.year-year
     compare_month = compare_date.month
     age-=1 if compare_month < month or (compare_month==month and compare_date.day < day)
@@ -82,8 +85,9 @@ class Date
 
   # Return the age in days for a given date.
 
-  def age_days(compare_to_date=Date.today)
-    (compare_to_date-self).to_i
+  def age_days(compare_date=Date.today)
+    (compare_date.is_a? Date) or raise ArgumentError, "compare_date must be a date"
+    (compare_date-self).to_i
   end
 
 

data/lib/webget_ruby_ramp/enumerable.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 # Enumberable extensions
 
 module Enumerable

data/lib/webget_ruby_ramp/file.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 # File extensions
 
 class File

data/lib/webget_ruby_ramp/hash.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 require 'yaml'
 
 # Hash extensions
@@ -14,6 +16,11 @@ class Hash
   # Calls block once for each key in hsh, passing the key and value to the block as a two-element array.
   #
   # The keys are sorted.
+  #
+  # ==Example
+  #   h = { "xyz" => "123", "abc" => "789" }
+  #   h.each_sort {|key, val| ... }
+  #   => calls the block with "abc" => "789", then with "xyz" => "123"
 
   def each_sort
    keys.sort.each{|key| yield key,self[key] }
@@ -113,6 +120,11 @@ class Hash
   # Hash#to_yaml with sort 
   #
   # From http://snippets.dzone.com/tag/yaml
+  #
+  # ==Example
+  #   h = {"a"=>"b", "c"=>"d", "e"=>"f" }
+  #   h.to_yaml_sort
+  #   => "--- \na: b\nc: d\ne: f\n"
 
   def to_yaml_sort( opts = {} )
     YAML::quick_emit( object_id, opts ) do |out|
@@ -216,7 +228,7 @@ class Hash
     case direction_name
     when 'key','keys','up','left','out' then return true
     when 'val','vals','down','right','in' then return false
-    else raise 'Pivot direction must be either: up/left/out or down/right/in'
+    else raise ArgumentError, 'Pivot direction must be either: key/keys/up/left/out or val/vals/down/right/in'
     end
   end