sixarm_ruby_ramp 2.1.3 → 3.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5dbd872b8c2a8f3732dad03323ac18e1e818a7a0
+  data.tar.gz: 89e1ed1eb27a9249bb1742f13b50db9e25babe0c
+SHA512:
+  metadata.gz: 9636b6fc7048ba889b1f46d5887bf07778045ebd4544ab18a20204e81095b17ea25dd51ed3e3de6b2744d11d301b4597ec91016050ffd3d6792cf46260e70170
+  data.tar.gz: 9359784e5fd0ad168d5a618334a06e18b6d4fd8d420654331ea8ff540f09fd5b85d29469665464ce901620fdb1d561d9593a628129c775e7f3f5da585e39ea3a

checksums.yaml.gz.sig

@@ -0,0 +1 @@
+����YP����F�cU3��X��}���k�ŕE�wd��5�T�U�'e�U�X_*���6���r��D
;

data.tar.gz.sig

@@ -1 +1 @@
-P�cS�zF�*�C;���?J
?�M~�^�&7o1����si$��#pB��Cz=9Bݖ'FDϰ�?c�?V|���m���7*�V��(v���^i�N<�%#��U���mR��;ڰ
+X�1��L��e��o�

data/CONTRIBUTING.md

@@ -0,0 +1,28 @@
+# Contributing
+
+Thank you for contributing!
+
+If you would like to contribute a donation, an easy way is to use PayPal to sixarm@sixarm.com.
+
+If you would like to contribute help, the next section is for you.
+
+
+## Contributing to the source
+
+We love pull requests for improvments to the source code and documentation.
+
+There are three easy steps:
+
+1. Fork the repo. 
+
+  * Before you do any work please run our existing tests to make sure the code runs cleanly.
+
+2. Work as you like. 
+
+   * Please create tests. This helps us know that all your code runs cleanly.
+
+3. Push to your fork and submit a pull request.
+
+   * We'll take a look as soon as we can; this is typically within a business day.
+
+Thank you again!

data/{README.rdoc → README.md}

@@ -1,24 +1,57 @@
-= SixArm.com » Ruby » Ramp gem is a toolkit of Ruby base class extensions
+# SixArm.com » Ruby » <br> Ramp gem is a toolkit of Ruby base class extensions
 
-Author:: Joel Parker Henderson, joel@joelparkerhenderson.com
-Copyright:: Copyright (c) 2006-2012 Joel Parker Henderson
-License:: See LICENSE.txt file
+* Doc: <http://sixarm.com/sixarm_ruby_ramp/doc>
+* Gem: <http://rubygems.org/gems/sixarm_ruby_ramp>
+* Repo: <http://github.com/sixarm/sixarm_ruby_ramp>
+* Email: Joel Parker Henderson, <joel@sixarm.com>
 
-Ramp is a library of extensions to Ruby base classes, including Array, Date, Enumerable, Hash, Kernel, Numeric, Object, Process, String, Time, and YAML. 
 
-Testing: 
+## Introduction
 
-* Each has an associated test class, e.g., ArrayTest, DateTest, etc.
-* The easy way to run the tests: gem install sixarm_ruby_ramp --test
+Ramp is a library of extensions to Ruby base classes.
 
+We extend Array, Date, Enumerable, Hash, Kernel, Numeric, Object, Process, String, Time, and YAML. 
 
-== Array
+For docs go to <http://sixarm.com/sixarm_ruby_ramp/doc>
+
+Want to help? We're happy to get pull requests.
+
+
+## Install quickstart
+
+Install:
+
+    gem install sixarm_ruby_ramp
+
+Bundler:
+
+    gem "sixarm_ruby_ramp", "~>3.0.0"
+
+Require:
+
+    require "sixarm_ruby_ramp"
+
+
+## Install with security (optional)
+
+To enable high security for all our gems:
+
+    wget http://sixarm.com/sixarm.pem
+    gem cert --add sixarm.pem
+    gem sources --add http://sixarm.com
+
+To install with high security:
+
+    gem install sixarm_ruby_ramp --test --trust-policy HighSecurity
+
+
+## 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 (deprecated - see method rdoc)
-* join: same as Array#join with some improvments
+* join, join_prefix_suffix, join_prefix_suffix_infix: like Array#join with improvements
 * 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)
@@ -31,17 +64,17 @@ 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
+## Class
 
 * publicize_methods: make all methods public for a block, e.g. to unit test private methods
 
 
-== CSV
+## CSV
 
 * http_headers: provides web file download headers for text/csv content type and disposition.
 
 
-== Date
+## Date
 
 * age_days, age_years
 * between: a random date between two specified dates
@@ -49,7 +82,7 @@ Testing:
 * weekday?, weekend?: is date a weekday or on the weekend
 
 
-== Enumerable
+## 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.
@@ -64,18 +97,18 @@ Testing:
 * power_set: return an array with all subsets of the enum's elements
 
 
-== File
+## File
 
 * File.joindir: wrapper for File.join(File.dirname(...),string,...)
 
 
-== Fixnum
+## Fixnum
 
 * even?: is the number even?
 * odd?: is the number odd?
 
 
-== Hash
+## Hash
 
 * size?: return true if hash has any keys
 * sort_by_keys: return a new Hash sorted by keys
@@ -87,48 +120,49 @@ Testing:
 * pivot: aggregates subtotals by keys and values, such as a rollup and rolldown 
 
 
-== Integer
+## Integer
 
 * maps: syntactic sugar to yield n times to a block, returning an array of any results
 * odd?: is the number odd?
 
 
-== IO
+## 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 return those rows split into fields, in an array of arrays.
 
 
-== Kernel
+## Kernel
 
 * my_method_name: return the name of the current method
 * caller_method_name: return the name of the caller method, or the Nth parent up the call stack if the optional caller_index parameter is passed.
 
 
-== Math
+## Math
 
 * ln(x): natural log of x
 * logn(x,b): log of x in base b
 
 
-== NilClass
+## NilClass
 
 * blank?: return true (same as Rails)
 
 
-== Numeric
+## Numeric
 
 * if: return 0 if the passed flag is any of: nil, false, 0, [], {} and otherwise return self
 * unless: return 0 unless the passed flag is any of: nil, false, 0, [], {} and otherwise return self
 * percent: return the number as a percentage with optional rounding to decimal points
+* floor_precision: return the number truncated to a given precision, i.e. decimal points
 
 
-== Object
+## Object
 
 * in?: return boolean indicating whether the object is a member of the specified array parameter
 
 
-== Process
+## Process
 
 Extensions that help debug Ruby programs.
 
@@ -136,22 +170,22 @@ Extensions that help debug Ruby programs.
 * (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
+## REXML::Attributes
 
 * hash: flattens the attributes hash set into a more useful ruby hash, e.g. {:height => 100, :width => 400 }
 
 
-== REXML::Document
+## REXML::Document
 
 * remove_attributes: remove all the attributes from the document's elements
 
 
-== REXML::Element
+## REXML::Element
 
 * remove_attributes: remove all the attributes from the element
 
 
-== String
+## 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.
@@ -167,30 +201,66 @@ Extensions that help debug Ruby programs.
 * words: split the string into an array of words
 
 
-== Symbol
+## Symbol
 
 * <=> and include the comparable mixin to compare symbols as strings
 
 
-== Time
+## 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
+## YAML
 
 * (class) load_dir: specify 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.
 * (class) load_dir_pairs: specify directory patterns and pass each YAML file in the matching directories to a block to process key/value pairs.
 
 
+## Changes
+
+* 2013-08-18 3.0.0 Upgrade to Ruby 2
+* 2012-09-01 2.1.7 Add Numeric#floor_precision
+* 2012-03-14 2.1.6 Update docs, tests
+* 2.1.6 Refactor XML#strip* methods to new sixarm_ruby_xml_strip gem.
+* 2.1.5 Refactor XML#load* methods to new sixarm_ruby_xml_load gem.
+* 2.1.4 Refactor REXML extensions to new sixarm_ruby_rexml gem.
+* 2.1.3 Remove dependency on sixarm_ruby_array_slice
+* 2.1.2 Refactor Array#slices and #divvy to sixarm_ruby_array_slice gem with better method names.
+* 2.1.0 Upgrades for Ruby 1.9.3; better README, new CHANGELOG, less YAML, etc.
+* 2.0.x Upgrades for Ruby 1.9.2; add methods; lift some methods to their own gems
+* 1.8.x 100% rcov coverage; add methods
+* 1.7.x Enable gemcutter; add methods; remove sqlite dependency
+* 1.6.x Upgrades for Ruby 1.9.1; improve structure; add methods
+* 1.5.0 Combined all Ruby extension files into one gem
+* 1.0.0 Original
+
+
+## License
+
+You may choose any of these open source licenses:
+
+  * Apache License
+  * BSD License
+  * CreativeCommons License, Non-commercial Share Alike
+  * GNU General Public License Version 2 (GPL 2)
+  * GNU Lesser General Public License (LGPL)
+  * MIT License
+  * Perl Artistic License
+  * Ruby License
+
+The software is provided "as is", without warranty of any kind, 
+express or implied, including but not limited to the warranties of 
+merchantability, fitness for a particular purpose and noninfringement. 
+
+In no event shall the authors or copyright holders be liable for any 
+claim, damages or other liability, whether in an action of contract, 
+tort or otherwise, arising from, out of or in connection with the 
+software or the use or other dealings in the software.
+
+This license is for the included software that is created by SixArm;
+some of the included software may have its own licenses, copyrights, 
+authors, etc. and these do take precedence over the SixArm license.
+
+Copyright (c) 2005-2012 Joel Parker Henderson

data/VERSION

@@ -1 +1 @@
-2.1.3
+3.0.0

data/lib/sixarm_ruby_ramp.rb

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 =begin rdoc
-Please see README.rdoc
+Please see README
 =end
 
 ['array','class','csv','date','enumerable','file','fixnum','hash','integer','io','kernel','math','nil','numeric','object','process','string','symbol','time','xml','yaml'].map{|x|

data/lib/sixarm_ruby_ramp/array.rb

@@ -16,39 +16,62 @@ class Array
   #
   # @return [String] concatenated string
   #
-  # @example Typical Array#join with infix
+  # @example Join with infix
   #   list=['a','b','c']
   #   list.join("*") => "a*b*c"
   #
-  # @example Improved join with infix, prefix, suffix
+  # @example Join with prefix and suffix
   #   list=['a','b','c']
-  #   list.join("*","[","]") => "[a]*[b]*[c]"
+  #   list.join("[","]") => "[a][b][c]"
   #
-  # @example Improved join with just prefix and suffix
+  # @example Join with prefix, suffix, and infix
   #   list=['a','b','c']
-  #   list.join("[","]") => "[a][b][c]"
-
+  #   list.join("*","[","]") => "[a]*[b]*[c]"
+  #
   def join(*fixes)
     if fixes.is_a?(String) then return self.ruby_join(fixes) end
-    case fixes.size
+    return case fixes.size
     when 0
-      return self.ruby_join()
+      ruby_join
     when 1
-      return self.ruby_join(fixes[0])
+      ruby_join(fixes[0].to_s)
     when 2
-      prefix=fixes[0].to_s
-      suffix=fixes[1].to_s
-      return self.map{|item| prefix + item.to_s + suffix}.ruby_join()
+      join_prefix_suffix(*fixes)
     when 3
-      infix =fixes[0].to_s
-      prefix=fixes[1].to_s
-      suffix=fixes[2].to_s
-      return self.map{|item| prefix + item.to_s + suffix}.ruby_join(infix)
+      join_prefix_suffix_infix(*fixes)
     else
       raise ArgumentError, "join() takes 0-3 arguments; you gave #{fixes.size}]"
     end
   end
 
+  # Concatenate the items by joining using a prefix string and suffix string.
+  #
+  # @return [String] concatenated string
+  #
+  # @example
+  #   list=['a','b','c']
+  #   list.join("[","]") => "[a][b][c]"
+  #
+  def join_prefix_suffix(prefix, suffix)
+    prefix = prefix.to_s
+    suffix = suffix.to_s
+    return self.map{|item| prefix + item.to_s + suffix}.ruby_join()
+  end
+
+  # Concatenate the items by joining using a prefix string, suffix string, and infix string.
+  #
+  # @return [String] concatenated string
+  #
+  # @example
+  #   list=['a','b','c']
+  #   list.join("*","[","]") => "[a]*[b]*[c]"
+  #
+  def join_prefix_suffix_infix(prefix, suffix, infix)
+    prefix = prefix.to_s
+    suffix = suffix.to_s
+    infix = infix.to_s
+    return self.map{|item| prefix + item.to_s + suffix}.ruby_join(infix)
+  end
 
   # @return [Boolean] true if size > 0
   #

data/lib/sixarm_ruby_ramp/hash.rb

@@ -169,7 +169,7 @@ class Hash
   #    "Developers"=>198
   #   }
   # 
-  #  Generic xxample:
+  #  Generic example:
   #   h={
   #    "a"=>{"x"=>1,"y"=>2,"z"=>3},
   #    "b"=>{"x"=>4,"y"=>5,"z"=>6},

data/lib/sixarm_ruby_ramp/kernel.rb

@@ -10,11 +10,13 @@ module Kernel
   # - http://www.ruby-forum.com/topic/75258
   # - In 1.9 (Ruby CVS HEAD) there is #__method__ and #__callee__
   # - http://eigenclass.org/hiki.rb?Changes+in+Ruby+1.9#l90
-  #-
+  #
+  # See http://stackoverflow.com/questions/5100299/how-to-get-the-name-of-the-calling-method
+  #
   # Make this fast because its often doing logging & reporting.
   # Inline this and use $1 because it's empirically faster than /1
   #
-  # These two methods are always equal:
+  # These two methods must always be equal:
   #   caller_method_name(0) === my_method_name
   #
   # @example
@@ -27,7 +29,9 @@ module Kernel
   # @return [String] my method name
 
   def my_method_name
-    caller[0] =~ /`([^']*)'/ and $1
+    RUBY_VERSION > '2.0' \
+    ? caller_locations(1,1).first.base_label \
+    : caller[0][/`([^']*)'/, 1]
   end
 
 
@@ -39,7 +43,7 @@ module Kernel
   # Make this fast because its often doing logging & reporting.
   # Inline this and use $1 because it's empirically faster than /1
   #
-  # These two methods are always equal:
+  # These two methods must always be equal:
   #   caller_method_name(0) === my_method_name
   #
   # @example
@@ -54,7 +58,9 @@ module Kernel
   # @return [String] the method name of the caller at the index
 
   def caller_method_name(caller_index=0)
-    caller[caller_index] =~ /`([^']*)'/ and $1
+    RUBY_VERSION > '2.0' \
+    ? caller_locations(caller_index + 1,1).first.base_label \
+    : caller[caller_index][/`([^']*)'/, 1]
   end