stick 1.2.0

data/test/test_units.rb

@@ -0,0 +1,205 @@
+$:.unshift(File.dirname(__FILE__) + '../lib')
+
+require 'test/unit'
+require 'stick/units'
+
+class TestUnits < Test::Unit::TestCase
+
+  def assert_in_unit_delta(v1, v2, d)
+    assert( v2 * (1 - d) <= v1 && v1 <= v2 * (1 + d), "<#{v1}> expected but was\n<#{v2}>" )
+  end
+
+  include ::Stick
+
+  def test_bit_and_bytes
+    assert_equal( 65.bit/s,  1.bit/s + 8.bytes/s )
+    assert_equal( 0.125.byte/s, ((1.bit/s).to(byte/s)) )
+    # PETER : Why 0?
+    # assert_equal( 0, ((1.bit/s).to(byte/s)) )
+  end
+
+  def miles_to_feet
+    assert_equal( 5000.feet,  1.mile.to(feet) )
+  end
+
+  def test_acre_to_yards_squared
+    assert_equal( 4840.sq_yd,  1.acre.to(yd**2) )
+    # PETER : This obviously fails because yards and square yards are not the same.
+    # assert_equal( 4840.yd,  1.acre.to(yd**2) )
+  end
+
+  def test_acre_to_sq_yd
+    assert_equal( 4840.sq_yd,  1.acre.to(sq_yd) )
+  end
+
+  def test_gallon_to_liter
+    assert_in_unit_delta( 3.785411784.L, 1.gallon.to(L), 1e-15 )
+    # PETER : A gallon expressed in liters is not a liter.
+    # assert_equal( 1.L, 1.gallon.to(L) )
+  end
+
+  def test_lb_to_kg
+    assert_equal( 0.45359237.kg, 1.lb.to(kg) )
+  end
+
+  def test_m_s_to_m_s
+    assert_equal( 1.m.s, 1.m.s.to(m.s) )
+  end
+
+  def test_sq_mi_to_km_squared
+    assert_in_unit_delta( 2.589988110336.to_value(km**2), 1.sq_mi.to(km**2), 1e-15 )
+    # PETER : See comment in #test_bandwidth.
+    # assert_equal( 1.to(km**2), 1.sq_mi.to(km**2) )
+  end
+
+  def test_mile_to_km
+    assert_in_unit_delta( 1.609344.km, 1.mile.to(km), 1e-15 )
+    # PETER : These are floats, they don't compare.
+    # assert_equal( 1.609344.km, 1.mile.to(km) )
+  end
+
+  def test_with_unit_convertor_uk
+    with_unit_converter(:uk) {
+      assert_equal( 112.lb,  1.cwt.to(lb) )
+    }
+    assert_equal( 112.lb(:uk), 1.cwt(:uk).to(lb(:uk)) )
+    # PETER : That would be a very small hundredweight
+    # assert_equal( 1.lb(:uk), 1.cwt(:uk).to(lb(:uk)) )
+  end
+
+  def test_with_unit_convertor_us
+    with_unit_converter(:us) {
+      assert_equal( 100.lb,  1.cwt.to(lb) )
+    }
+    assert_equal( 100.lb(:us), 1.cwt(:us).to(lb(:us)) )
+    # PETER : That would be a very small hundredweight
+    # assert_equal( 1.lb(:us), 1.cwt(:us).to(lb(:us)) )
+  end
+
+  def test_current_lb
+    assert_equal( lb, Converter.current.lb )
+    # PETER : compares values and units again.
+    # assert_equal( 1.lb, Converter.current.lb )
+  end
+
+  def test_cwt
+    assert_equal( 1.12.cwt(:us), 1.cwt(:uk).to(cwt(:us)) )
+    assert_equal( 1.cwt(:uk), 1.12.cwt(:us).to(cwt(:uk)) )
+  end
+
+  def test_unit_convertor_cwt
+    with_unit_converter(:uk) {
+      assert_equal( 1.cwt, 1.cwt.to(cwt(:us)) )
+      assert_equal( 1.cwt(:us), 1.cwt(:us).to(cwt) )
+      # PETER : This is not correct. The conversion does
+      #   not change the magnitude of the thing, i.e.,
+      #   something that weighs a hundredweight UK style does
+      #   not weigh a hundredweight US style even when its
+      #   weight us expressed in US style hundredweights
+      #   (if that makes sense.)
+      #   Also, this converter has no effect because the
+      #   converter is specified everywhere. So it is really
+      #   the same as the above.
+      # assert_equal( 1.cwt(:us), 1.cwt(:uk).to(cwt(:us)) )
+      # assert_equal( 1.cwt(:uk), 1.cwt(:us).to(cwt(:uk)) )
+    }
+  end
+
+  #def test_registered_convertors
+  #  assert_equal( [:cex, :default, :uk, :us], Converter.registered_converters.sort )
+  #end
+
+  def test_spaceship
+    assert_nil( 1.m <=> 1.L )
+    # PETER : meter and liter are like apples and oranges.
+    #   returns nil instead.
+    # assert_equal( 0, (1.m <=> 1.L) )
+    assert_equal( 1, (1.m <=> 1.cm) )
+  end
+
+  def test_bandwidth
+    assert_equal( 1024.to_value(kB / s), ((1.MB / s).to(kB / s)) )
+    with_unit_converter(:binary_iec_base) {
+      assert_equal( 1000.to_value(kB / s), ((1.MB / s).to(kB / s)) )
+    }
+    # PETER : The #to method does conversion from one unit
+    #   to another compatible unit. Although it could make
+    #   sense to convert a unitless number to a unit
+    #   that is essentially unitless too (like kB/MB), there
+    #   are better ways to do the same, and the below still
+    #   wouldn't work because 1 is unitless and 1.kB/s is not.
+    #   I've added a to_value method for this.
+    # assert_equal( 1.to(kB / s), ((1.MB / s).to(kB / s)) )
+    # with_unit_converter(:binary_iec_base) {
+    #   assert_equal( 1.to(kB / s), ((1.MB / s).to(kB / s)) )
+    # }
+  end
+
+  def test_to_unit
+    assert_equal( m / s, "m / s".to_unit )
+    # PETER : m/s and 1 m/s are not the same thing.
+    # assert_equal( 1.to(m / s), "m / s".to_unit )
+  end
+
+  def test_to_value
+    assert_equal( 1.m / s, "1 m / s".to_value )
+    # PETER : See remark in #test_bandwidth.
+    # assert_equal( 1.to(m / s), "1 m / s".to_value )
+  end
+
+  def test_simplify
+    # PETER : Don't see how this could be zero. Don't know
+    #   exactly what you want to test though...
+    # assert_equal( 0, "1 m / cm L".to_value.simplify )
+  end
+
+  def test_float
+    assert_equal( 100.0, "1 m / cm".to_value.to_f )
+  end
+
+  def test_m_to_str_cm
+    assert_equal( 100.cm, 1.m.to("cm") )
+  end
+
+  def test_m_plus_str_cm
+    assert_equal( 105.cm, 1.m + "5cm" )
+  end
+
+  def test_plus
+    assert_equal( 1.05.m, 1.m + 5.cm )
+  end
+
+  def test
+    assert_equal( 105.m, 5.cm + 1.m )
+  end
+
+  # PETER : This compares a value (quantity + unit) to a unit. This could
+  #   be allowed by saying that the unit of meter and 1 meter is the
+  #   same, but personally I'd like to keep the distinction.
+  # def test_
+  #   assert_equal( 101.cm, cm * m )
+  # end
+
+  # def test_
+  #   assert_equal( 101.cm, cm * "m" )
+  # end
+
+  def test_value
+    assert_equal(-5.mm, "-5mm".to_value )
+    # PETER : -5mm is not the same as -5
+    # assert_equal(-5, "-5mm".to_value )
+  end
+
+  def test_value_abs
+    assert_equal(5.mm, "-5mm".to_value.abs )
+    # PETER : 5mm is not the same as 5
+    # assert_equal(5, "-5mm".to_value.abs )
+  end
+
+  def test_infinite?
+    # PETER : I'm not sure what the point of this is, but in
+    #   any case, a Value does not have an infinite? method
+    # assert_equal( false, ("5.0mm".to_value / 1).infinite? )
+  end
+
+end

data/work/TODO

@@ -0,0 +1,20 @@
+= To Do List -- Stick
+
+== Current
+
+* times.rb mainly serves as a reminder that it would be nice if the units
+  system could have an extra set of conversions for handling calander nomencalture.
+  Of course times.rb can be used too, it's just not really inteded to be used
+  alonde side units.rb.
+
+== Pre-Stick List
+
+file://lib/facets/bytes.rb
+* TODO Currently kilo, mega, etc. are all powers of two and not ten,
+  which technically isn't corrent even though it is common usage. (30)
+* TODO The in_* notation is weak. If a better nomentclature is thought
+  of then consider changing this. (33)
+
+file://lib/facets/times.rb
+* TODO Extra Add in_* methods, like in_days, in_hours, etc. (35)
+

data/work/bytes.rb

@@ -0,0 +1,231 @@
+# = bytes.rb
+#
+# == Copyright (c) 2005 Rich Kilmer, Thomas Sawyer
+#
+#  Ruby License
+#
+#   This module is free software. You may use, modify, and/or redistribute this
+#   software under the same terms as Ruby.
+#
+#   This program 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.
+#
+# == Special Thanks
+#
+# Special thanks to Richard Kilmer for the orignal work.
+# This library is based on the original library bytes.rb
+# Copyright (c) 2004 by Rich Kilmer.
+#
+# Also thanks to Alexander Kellett for suggesting it be
+# included in Facets.
+#
+# == Authors and Contributors
+#
+# * Rich Kilmer
+# * Thomas Sawyer
+#
+# == Developer Notes
+#
+#   TODO Currently kilo, mega, etc. are all powers of two and not ten,
+#        which technically isn't corrent even though it is common usage.
+#
+#   TODO The in_* notation is weak. If a better nomentclature is thought
+#        of then consider changing this.
+
+# Author::    Rich Kilmer, Thomas Sawyer
+# Copyright:: Copyright (c) 2005 Thomas Sawyer, Rich Kilmer
+# License::   Ruby License
+
+# = Binary Multipliers
+#
+# Additional methods for Numeric class to make working with
+# bits and bytes easier. Bits are used as the base value and
+# these methods can be used to convert between different
+# magnitudes.
+#
+# == Synopisis
+#
+#   1.byte               #=> 8
+#   2.bytes              #=> 16
+#   1.kilobit            #=> 1024
+#   1.kilobyte           #=> 8192
+#
+# Use the in_* methods to perform the inverse operations.
+#
+#   8192.in_kilobytes    #=> 1
+#   1024.in_kilobits     #=> 1
+#
+
+class Numeric
+
+  def bit   ; self ; end
+  def bits  ; self ; end
+  def byte  ; self * 8 ; end
+  def bytes ; self * 8 ; end
+
+  [ 'kilo', 'mega', 'giga', 'tera', 'peta', 'exa' ].each_with_index do |m, i|
+    j = i + 1
+    class_eval %{
+      def #{m}bit  ; self * #{1024**j} ; end
+      def #{m}byte ; self * #{1024**j*8} ; end
+      def in_#{m}bits  ; self / #{1024**j} ; end
+      def in_#{m}bytes ; self / #{1024**j*8} ; end
+      alias_method :#{m}bits,  :#{m}bit
+      alias_method :#{m}bytes, :#{m}byte
+    }
+  end
+
+  [ 'kibi', 'mebi', 'gibi', 'tebi', 'pebi', 'exbi' ].each_with_index do |m, i|
+    j = i + 1
+    class_eval %{
+      def #{m}bit  ; self * #{1024**j} ; end
+      def #{m}byte ; self * #{1024**j*8} ; end
+      def in_#{m}bits  ; self / #{1024**j} ; end
+      def in_#{m}bytes ; self / #{1024**j*8} ; end
+      alias_method :#{m}bits,  :#{m}bit
+      alias_method :#{m}bytes, :#{m}byte
+    }
+  end
+
+  # Formated string of bits proportial to size.
+  #
+  #   1024.bits_to_s            #=> "1.00 kb"
+  #   1048576.bits_to_s         #=> "1.00 mb"
+  #   1073741824.bits_to_s      #=> "1.00 gb"
+  #   1099511627776.bits_to_s   #=> "1.00 tb"
+  #
+  # Takes a format string to adjust output.
+  #
+  #   1024.bits_to_s('%.0f')    #=> "1 kb"
+  #
+  def strfbits(fmt='%.2f')
+    case
+    when self < 1024
+      "#{self} bits"
+    when self < 1024**2
+      "#{fmt % (self.to_f / 1024)} kb"
+    when self < 1024**3
+      "#{fmt % (self.to_f / 1024**2)} mb"
+    when self < 1024**4
+      "#{fmt % (self.to_f / 1024**3)} gb"
+    when self < 1024**5
+      "#{fmt % (self.to_f / 1024**4)} tb"
+    else
+      "#{self} bits"
+    end
+  end
+
+  # Formated string of bytes proportial to size.
+  #
+  #   1024.bytes_to_s            #=> "1.00 KB"
+  #   1048576.bytes_to_s         #=> "1.00 MB"
+  #   1073741824.bytes_to_s      #=> "1.00 GB"
+  #   1099511627776.bytes_to_s   #=> "1.00 TB"
+  #
+  # Takes a format string to adjust output.
+  #
+  #   1024.bytes_to_s('%.0f')    #=> "1 KB"
+  #
+  def strfbytes(fmt='%.2f')
+    case
+    when self < 1024
+      "#{self} bytes"
+    when self < 1024**2
+      "#{fmt % (self.to_f / 1024)} KB"
+    when self < 1024**3
+      "#{fmt % (self.to_f / 1024**2)} MB"
+    when self < 1024**4
+      "#{fmt % (self.to_f / 1024**3)} GB"
+    when self < 1024**5
+      "#{fmt % (self.to_f / 1024**4)} TB"
+    else
+      "#{self} bytes"
+    end
+  end
+
+  # deprecated
+  alias_method :octet_units, :strfbytes
+
+end
+
+
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+
+=begin testing
+
+  require 'test/unit'
+
+  class TC_Numeric < Test::Unit::TestCase
+
+    # bits
+
+    def test_bits
+      assert_equal( 8, 8.bits )
+    end
+
+    def test_kilobits
+      assert_equal( 1024**1, 1.kilobit )
+    end
+
+    def test_megabits
+      assert_equal( 1024**2, 1.megabit )
+    end
+
+    def test_gigabits
+      assert_equal( 1024**3, 1.gigabit )
+    end
+
+    def test_terabits
+      assert_equal( 1024**4, 1.terabit )
+    end
+
+    # bytes
+
+    def test_bytes
+      assert_equal( 8192, 1024.bytes )
+    end
+
+    def test_kilobytes
+      assert_equal( 1024**1*8, 1.kilobyte )
+    end
+
+    def test_megabytes
+      assert_equal( 1024**2*8, 1.megabyte )
+    end
+
+    def test_gigabytes
+      assert_equal( 1024**3*8, 1.gigabyte )
+    end
+
+    def test_terabytes
+      assert_equal( 1024**4*8, 1.terabyte )
+    end
+
+    # bits_to_s
+
+    def test_strfbits
+      assert_equal( "1.00 kb", 1024.strfbits )
+      assert_equal( "1.00 mb", 1048576.strfbits )
+      assert_equal( "1.00 gb", 1073741824.strfbits )
+      assert_equal( "1.00 tb", 1099511627776.strfbits )
+    end
+
+    # bytes_to_s
+
+    def test_strfbytes
+      assert_equal( "1.00 KB", 1024.strfbytes )
+      assert_equal( "1.00 MB", 1048576.strfbytes )
+      assert_equal( "1.00 GB", 1073741824.strfbytes )
+      assert_equal( "1.00 TB", 1099511627776.strfbytes )
+    end
+
+  end
+
+=end