blackwinter-ruby-nuggets 0.4.0

data/lib/nuggets/numeric/duration.rb

@@ -0,0 +1,109 @@
+#--
+###############################################################################
+#                                                                             #
+# A component of ruby-nuggets, some extensions to the Ruby programming        #
+# language.                                                                   #
+#                                                                             #
+# Copyright (C) 2007-2008 Jens Wille                                          #
+#                                                                             #
+# Authors:                                                                    #
+#     Jens Wille <jens.wille@uni-koeln.de>                                    #
+#                                                                             #
+# ruby-nuggets is free software; you can redistribute it and/or modify it     #
+# under the terms of the GNU General Public License as published by the Free  #
+# Software Foundation; either version 3 of the License, or (at your option)   #
+# any later version.                                                          #
+#                                                                             #
+# ruby-nuggets is distributed in the hope that it will be useful, but WITHOUT #
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or       #
+# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for    #
+# more details.                                                               #
+#                                                                             #
+# You should have received a copy of the GNU General Public License along     #
+# with ruby-nuggets. If not, see <http://www.gnu.org/licenses/>.              #
+#                                                                             #
+###############################################################################
+#++
+
+class Numeric
+
+  # call-seq:
+  #   num.hms => anArray
+  #
+  # Converts _num_ into hour, minute, and second portions.
+  def hms
+    raise ArgumentError, "negative duration #{self}" if self < 0
+
+    one_minute = 60
+    one_hour   = 60 * one_minute
+
+    [((h,) = divmod(one_hour)).last.divmod(one_minute), h].reverse.flatten  # *SCNR* ;-)
+  end
+
+  # call-seq:
+  #   num.ymd => anArray
+  #
+  # Converts _num_ into year, month, and day portions.
+  def ymd
+    raise ArgumentError, "negative duration #{self}" if self < 0
+
+    one_day   = 24 * 60 * 60
+    one_month = 30 * one_day
+    one_year  = 365.25 * one_day
+
+    y, m = divmod(one_year)
+    m, d = m.divmod(one_month)
+
+    [y, m, d / one_day]
+  end
+
+  # call-seq:
+  #   num.to_hms(precision = 0, labels = %w[h m s]) => aString
+  #
+  # Produces a stringified version of _num_'s time portions (cf. #hms),
+  # with the specified +precision+ for the seconds (treated as floating
+  # point). The individual parts are labelled as specified in the +labels+
+  # parameter (hours, minutes, seconds in that order). Leading parts with
+  # a value of zero are omitted.
+  #
+  # Examples:
+  #   180.to_hms               #=> "3m0s"
+  #   180.75.to_hms            #=> "3m1s"
+  #   180.75.to_hms(2)         #=> "3m0.75s"
+  #   8180.to_hms              #=> "2h16m20s"
+  #   8180.to_hms(0, %w[: :])  #=> "2:16:20"
+  def to_hms(precision = 0, labels = %w[h m s], time = hms)
+    h, m, s = time
+
+    h.zero? ? m.zero? ?
+      "%0.#{precision}f#{labels[2]}" % [s] :
+      "%d#{labels[1]}%0.#{precision}f#{labels[2]}" % [m, s] :
+      "%d#{labels[0]}%d#{labels[1]}%0.#{precision}f#{labels[2]}" % [h, m, s]
+  end
+
+  # call-seq:
+  #   num.to_ymd(include_hms = false, labels = %w[y m d]) => aString
+  #
+  # Produces a stringified version of _num_'s date portions (cf. #ymd),
+  # analogous to #to_hms. Includes time portions (cf. #hms) if +include_hms+
+  # is true.
+  def to_ymd(include_hms = false, labels = %w[y m d])
+    unless include_hms
+      to_hms(0, labels, ymd)
+    else
+      y, m, d = ymd
+      e = d.truncate
+
+      "#{to_hms(0, labels, [y, m, e])} #{((d - e) * 24 * 60 * 60).to_hms}"
+    end
+  end
+
+end
+
+if $0 == __FILE__
+  [123, 123456789, 0, 0.001, 1.23, 1234.56789].each { |n|
+    p n
+    p [n.hms, n.to_hms, n.to_hms(2)]
+    p [n.ymd, n.to_ymd, n.to_ymd(true)]
+  }
+end

data/lib/nuggets/numeric/limit.rb

@@ -0,0 +1,70 @@
+#--
+###############################################################################
+#                                                                             #
+# A component of ruby-nuggets, some extensions to the Ruby programming        #
+# language.                                                                   #
+#                                                                             #
+# Copyright (C) 2007-2008 Jens Wille                                          #
+#                                                                             #
+# Authors:                                                                    #
+#     Jens Wille <jens.wille@uni-koeln.de>                                    #
+#                                                                             #
+# ruby-nuggets is free software; you can redistribute it and/or modify it     #
+# under the terms of the GNU General Public License as published by the Free  #
+# Software Foundation; either version 3 of the License, or (at your option)   #
+# any later version.                                                          #
+#                                                                             #
+# ruby-nuggets is distributed in the hope that it will be useful, but WITHOUT #
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or       #
+# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for    #
+# more details.                                                               #
+#                                                                             #
+# You should have received a copy of the GNU General Public License along     #
+# with ruby-nuggets. If not, see <http://www.gnu.org/licenses/>.              #
+#                                                                             #
+###############################################################################
+#++
+
+class Numeric
+
+  # call-seq:
+  #   num.limit(min, max) => aNumeric
+  #
+  # Returns +min+ if that's larger than _num_, or +max+ if that's smaller than
+  # _num_. Otherwise returns _num_.
+  def limit(min, max)
+    min, max = max, min if max < min
+
+    self.min(min).max(max)
+  end
+
+  alias_method :between, :limit
+
+  # call-seq:
+  #   num.min(min) => aNumeric
+  #
+  # Returns _num_ or +min+, whatever is larger.
+  def min(min)
+    self < min ? min : self
+  end
+
+  alias_method :at_least, :min
+
+  # call-seq:
+  #   num.max(max) => aNumeric
+  #
+  # Returns _num_ or +max+, whatever is smaller.
+  def max(max)
+    self > max ? max : self
+  end
+
+  alias_method :at_most, :max
+
+end
+
+if $0 == __FILE__
+  [123, -123, 0, 0.001, 1.23, -12.3].each { |n|
+    p n
+    p n.between(0, 10)
+  }
+end

data/lib/nuggets/numeric/signum.rb

@@ -0,0 +1,60 @@
+#--
+###############################################################################
+#                                                                             #
+# A component of ruby-nuggets, some extensions to the Ruby programming        #
+# language.                                                                   #
+#                                                                             #
+# Copyright (C) 2007-2008 Jens Wille                                          #
+#                                                                             #
+# Authors:                                                                    #
+#     Jens Wille <jens.wille@uni-koeln.de>                                    #
+#                                                                             #
+# ruby-nuggets is free software; you can redistribute it and/or modify it     #
+# under the terms of the GNU General Public License as published by the Free  #
+# Software Foundation; either version 3 of the License, or (at your option)   #
+# any later version.                                                          #
+#                                                                             #
+# ruby-nuggets is distributed in the hope that it will be useful, but WITHOUT #
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or       #
+# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for    #
+# more details.                                                               #
+#                                                                             #
+# You should have received a copy of the GNU General Public License along     #
+# with ruby-nuggets. If not, see <http://www.gnu.org/licenses/>.              #
+#                                                                             #
+###############################################################################
+#++
+
+class Numeric
+
+  def positive?
+    self > 0
+  end
+
+  def negative?
+    self < 0
+  end
+
+  def non_negative?
+    !negative?
+  end
+
+  # call-seq:
+  #   num.signum => -1, 0, 1
+  #
+  # Returns the sign of _num_.
+  def signum
+    positive? ? 1 : negative? ? -1 : 0
+  end
+
+  alias_method :sign, :signum
+  alias_method :sgn,  :signum
+
+end
+
+if $0 == __FILE__
+  [123, -123, 0, 0.001, 1.23, -12.3].each { |n|
+    p n
+    p n.sgn
+  }
+end

data/lib/nuggets/numeric/to_multiple.rb

@@ -0,0 +1,68 @@
+#--
+###############################################################################
+#                                                                             #
+# A component of ruby-nuggets, some extensions to the Ruby programming        #
+# language.                                                                   #
+#                                                                             #
+# Copyright (C) 2007-2008 Jens Wille                                          #
+#                                                                             #
+# Authors:                                                                    #
+#     Jens Wille <jens.wille@uni-koeln.de>                                    #
+#                                                                             #
+# ruby-nuggets is free software; you can redistribute it and/or modify it     #
+# under the terms of the GNU General Public License as published by the Free  #
+# Software Foundation; either version 3 of the License, or (at your option)   #
+# any later version.                                                          #
+#                                                                             #
+# ruby-nuggets is distributed in the hope that it will be useful, but WITHOUT #
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or       #
+# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for    #
+# more details.                                                               #
+#                                                                             #
+# You should have received a copy of the GNU General Public License along     #
+# with ruby-nuggets. If not, see <http://www.gnu.org/licenses/>.              #
+#                                                                             #
+###############################################################################
+#++
+
+class Numeric
+
+  # call-seq:
+  #   num.to_multiple_of(target, what) => aNumeric
+  #
+  # Returns the nearest multiple of +target+ according to +what+.
+  def to_multiple_of(target, what = :round)
+    target.zero? ? self : (to_f / target).send(what) * target
+  end
+
+  # call-seq:
+  #   num.round_to(target) => aNumeric
+  #
+  # Rounds _num_ to the nearest multiple of +target+.
+  def round_to(target)
+     to_multiple_of(target, :round)
+  end
+
+  # call-seq:
+  #   num.floor_to(target) => aNumeric
+  #
+  # Returns the largest multiple of +target+ less than or equal to _num_.
+  def floor_to(target)
+     to_multiple_of(target, :floor)
+  end
+
+  # call-seq:
+  #   num.ceil_to(target) => aNumeric
+  #
+  # Returns the smallest multiple of +target+ greater than or equal to _num_.
+  def ceil_to(target)
+    to_multiple_of(target, :ceil)
+  end
+
+end
+
+if $0 == __FILE__
+  [123, -123, 0, 0.001, 5.67, -12.3].each { |n|
+    p [n, n.round_to(10), n.floor_to(10), n.ceil_to(10)]
+  }
+end

data/lib/nuggets/object/blank.rb

@@ -0,0 +1,119 @@
+#--
+###############################################################################
+#                                                                             #
+# A component of ruby-nuggets, some extensions to the Ruby programming        #
+# language.                                                                   #
+#                                                                             #
+# Copyright (C) 2007 Jens Wille                                               #
+#                                                                             #
+# Authors:                                                                    #
+#     Jens Wille <jens.wille@uni-koeln.de>                                    #
+#                                                                             #
+# ruby-nuggets is free software; you can redistribute it and/or modify it     #
+# under the terms of the GNU General Public License as published by the Free  #
+# Software Foundation; either version 3 of the License, or (at your option)   #
+# any later version.                                                          #
+#                                                                             #
+# ruby-nuggets is distributed in the hope that it will be useful, but WITHOUT #
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or       #
+# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for    #
+# more details.                                                               #
+#                                                                             #
+# You should have received a copy of the GNU General Public License along     #
+# with ruby-nuggets. If not, see <http://www.gnu.org/licenses/>.              #
+#                                                                             #
+###############################################################################
+#++
+
+class Object
+
+  # call-seq:
+  #   object.blank? => true or false
+  #
+  # Basically a short-cut to <tt>object.nil? || object.empty?</tt>.
+  def blank?(*modifiers)
+    if block_given?
+      return true if yield(dup).blank?
+    end
+
+    if modifiers.empty?
+      respond_to?(:empty?) ? empty? : !self
+    else
+      return true if blank?
+
+      modifiers.each { |modifier|
+        if respond_to?(modifier)
+          if modifier.to_s =~ /\?\z/
+            return true if send(modifier)
+          else
+            return true if send(modifier).blank?
+          end
+        end
+      }
+
+      false
+    end
+  end
+
+  # call-seq:
+  #   object.void? => true or false
+  #
+  # Adds white-space strings, 0 and arrays of +nil+ objects to the list of
+  # blank objects.
+  def void?
+    blank?(:zero?, :strip, :compact)
+  end
+  alias_method :vain?, :void?
+
+end
+
+class Array
+
+  # call-seq:
+  #   array.vain? => true or false
+  #
+  # Returns true if all of _array_'s elements are themselves vain.
+  def vain?
+    blank? { |a| a.delete_if { |i| i.vain? } }
+  end
+
+end
+
+class Hash
+
+  # call-seq:
+  #   hash.vain? => true or false
+  #
+  # Returns true if all of _hash_'s values are themselves vain.
+  def vain?
+    blank? { |h| h.delete_if { |_, v| v.vain? } }
+  end
+
+end
+
+class String
+  if public_instance_methods(false).include?(method = 'blank?')
+    # remove incompatible implementation added by utility_belt/language_greps.rb
+    remove_method method
+  end
+end
+
+if $0 == __FILE__
+  ['', ' ', 's', 0, 1, nil, true, false, [], [nil], {}].each { |o|
+    p o
+    p o.blank?
+    p o.void?
+  }
+
+  o = ['', [], [nil], {}]
+  p o
+  p o.blank?
+  p o.void?
+  p o.vain?
+
+  o = { :x => nil, :y => [], :z => { :zz => nil } }
+  p o
+  p o.blank?
+  p o.void?
+  p o.vain?
+end

data/lib/nuggets/object/boolean.rb

@@ -0,0 +1,69 @@
+#--
+###############################################################################
+#                                                                             #
+# A component of ruby-nuggets, some extensions to the Ruby programming        #
+# language.                                                                   #
+#                                                                             #
+# Copyright (C) 2007-2008 Jens Wille                                          #
+#                                                                             #
+# Authors:                                                                    #
+#     Jens Wille <jens.wille@uni-koeln.de>                                    #
+#                                                                             #
+# ruby-nuggets is free software; you can redistribute it and/or modify it     #
+# under the terms of the GNU General Public License as published by the Free  #
+# Software Foundation; either version 3 of the License, or (at your option)   #
+# any later version.                                                          #
+#                                                                             #
+# ruby-nuggets is distributed in the hope that it will be useful, but WITHOUT #
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or       #
+# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for    #
+# more details.                                                               #
+#                                                                             #
+# You should have received a copy of the GNU General Public License along     #
+# with ruby-nuggets. If not, see <http://www.gnu.org/licenses/>.              #
+#                                                                             #
+###############################################################################
+#++
+
+class Object
+
+  # call-seq:
+  #   object.boolean? => true or false
+  #
+  # 
+  def boolean?
+    is_a?(TrueClass) || is_a?(FalseClass)
+  end
+
+  # call-seq:
+  #   object.negate => true or false
+  #
+  #
+  def negate
+    !self
+  end
+
+  alias_method :false?, :negate
+
+  # call-seq:
+  #   object.to_bool => true or false
+  #
+  #
+  def to_bool
+    !!self
+  end
+
+  alias_method :true?, :to_bool
+
+end
+
+if $0 == __FILE__
+  [0, 1, nil, '', 'abc', true, false, Class, Object.new].each { |o|
+    p o
+    p o.boolean?
+    p o.negate
+    p o.to_bool
+    p o.true?
+    p o.false?
+  }
+end

data/lib/nuggets/object/eigenclass.rb

@@ -0,0 +1,2 @@
+# whatever you prefer to call it...
+require 'nuggets/singleton_class'

data/lib/nuggets/object/ghost_class.rb

@@ -0,0 +1,2 @@
+# whatever you prefer to call it...
+require 'nuggets/singleton_class'

data/lib/nuggets/object/metaclass.rb

@@ -0,0 +1,2 @@
+# whatever you prefer to call it...
+require 'nuggets/singleton_class'

data/lib/nuggets/object/msend.rb

@@ -0,0 +1,55 @@
+#--
+###############################################################################
+#                                                                             #
+# A component of ruby-nuggets, some extensions to the Ruby programming        #
+# language.                                                                   #
+#                                                                             #
+# Copyright (C) 2007-2008 Jens Wille                                          #
+#                                                                             #
+# Authors:                                                                    #
+#     Jens Wille <jens.wille@uni-koeln.de>                                    #
+#                                                                             #
+# ruby-nuggets is free software; you can redistribute it and/or modify it     #
+# under the terms of the GNU General Public License as published by the Free  #
+# Software Foundation; either version 3 of the License, or (at your option)   #
+# any later version.                                                          #
+#                                                                             #
+# ruby-nuggets is distributed in the hope that it will be useful, but WITHOUT #
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or       #
+# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for    #
+# more details.                                                               #
+#                                                                             #
+# You should have received a copy of the GNU General Public License along     #
+# with ruby-nuggets. If not, see <http://www.gnu.org/licenses/>.              #
+#                                                                             #
+###############################################################################
+#++
+
+class Object
+
+  # call-seq:
+  #   object.msend(*messages) => anArray
+  #
+  # Sends _object_ multiple +messages+ and returns an array of the individual
+  # return values.
+  def msend(*messages)
+    hash = messages.last.is_a?(Hash) ? messages.pop : {}
+    (messages + hash.to_a).map { |msg| send *msg.is_a?(Array) ? msg : [msg] }
+  end
+
+end
+
+if $0 == __FILE__
+  o = 'foo bar'
+  p o
+  p o.msend(:length, :reverse)
+
+  o = 42
+  p o
+  p o.msend(:to_s, :* => 2)
+  p o.msend([:to_s, 2], '-@')
+
+  o = Time.now
+  p o
+  p o.msend(:year, :month, :day)
+end