facets 0.9.0 → 1.0.0

data/lib/facets/english/bytes.rb

@@ -0,0 +1,212 @@
+#--
+# Binary Multipliers
+#
+# Copyright (c) 2005 Thomas Sawyer
+# Copyright (c) 2004 Rich Kilmer
+#
+# 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.
+#
+# ==========================================================================
+# Revision History ::
+# --------------------------------------------------------------------------
+#  2005.08.10  trans   * Made a module. Added in_* methods.
+#  2005.07.28  trans   * Rewrote lib to work in bits instead of bytes.
+#  2005.04.28  trans   * Ported from Rich Kilmer's lib.
+# ==========================================================================
+#
+# :CREDIT: Credit goes to Richard Kilmer for the orignal work and
+#          Alexander Kellett for suggesting it be included here.
+#
+#++
+
+#:title: Binary Multipliers
+#
+# Mixin for Numeric to make working with bits and bytes easier.
+# These are numerous and therefore provided via a mega-module
+# called BinaryMultiplers, rather then individual nano-methods.
+#
+#   1.byte               #=> 8
+#   2.bytes              #=> 16
+#   1.kilobit            #=> 1024
+#   1.kilobyte           #=> 8192
+#
+
+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

data/lib/facets/english/multipliers.rb

@@ -0,0 +1,192 @@
+#--
+# multipliers.rb
+#
+# Copyright (c) 2005 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.
+#
+# ==========================================================================
+# Revision History ::
+# --------------------------------------------------------------------------
+#  2005.08.10  trans   * Created, inspired by Rich Kilmer's bytes.rb.
+# ==========================================================================
+#++
+
+#:title: Multipliers
+#
+# Adds methods to Numeric to make working with
+# magnitudes (kilo, mega, giga, milli, micro, etc.)
+# as well as bits and bytes easier.
+#
+#   1.kilo               #=> 1000
+#   1.milli              #=> 0.001
+#   1.kibi               #=> 1024
+#
+# To display a value in a certain denomination, simply 
+# perform the inverse operation by placing the 
+# multiplier called on unit (1) in the denominator.
+#
+#   1000 / 1.kilo        #=> 1
+#   1024 / 1.kibi        #=> 1
+#
+
+class Numeric
+
+  # SI Multipliers
+
+  def deka  ; self * 10 ; end
+  def hecto ; self * 100 ; end
+  def kilo  ; self * 1000 ; end
+  def mega  ; self * 1000000 ; end
+  def giga  ; self * 1000000000 ; end
+  def tera  ; self * 1000000000000 ; end
+  def peta  ; self * 1000000000000000 ; end
+  def exa   ; self * 1000000000000000000 ; end
+
+  # SI Fractional
+
+  def deci  ; self.to_f / 10 ; end
+  def centi ; self.to_f / 100 ; end
+  def milli ; self.to_f / 1000 ; end
+  def micro ; self.to_f / 1000000 ; end
+  def nano  ; self.to_f / 1000000000 ; end
+  def pico  ; self.to_f / 1000000000000 ; end
+  def femto ; self.to_f / 1000000000000000 ; end
+  def atto  ; self.to_f / 1000000000000000000 ; end
+
+  # SI Binary
+
+  def kibi ; self * 1024 ; end
+  def mebi ; self * 1024**2 ; end
+  def gibi ; self * 1024**3 ; end
+  def tebi ; self * 1024**4 ; end
+  def pebi ; self * 1024**5 ; end
+  def exbi ; self * 1024**6 ; end
+
+  # Bits and Bytes
+ 
+  def bit   ; self ; end
+  def bits  ; self ; end
+  def byte  ; self * 8 ; end
+  def bytes ; self * 8 ; end
+
+end
+
+
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+
+=begin testing
+
+  require 'test/unit'
+
+  class TC_Multipliers < Test::Unit::TestCase
+
+    def test_deka
+      assert_equal( 10, 1.deka )
+    end
+
+    def test_hecto
+      assert_equal( 100, 1.hecto )
+    end
+
+    def test_kilo
+      assert_equal( 1000, 1.kilo )
+    end
+
+    def test_mega
+      assert_equal( 1000000, 1.mega )
+    end
+
+    def test_giga
+      assert_equal( 1000000000, 1.giga )
+    end
+
+    def test_tera
+      assert_equal( 1000000000000, 1.tera )
+    end
+
+    def test_peta
+      assert_equal( 1000000000000000, 1.peta )
+    end
+
+    def test_exa
+      assert_equal( 1000000000000000000, 1.exa )
+    end
+
+    # Fractional
+
+    def test_deci
+      assert_equal( 0.1, 1.deci )
+    end
+
+    def test_centi
+      assert_equal( 0.01, 1.centi )
+    end
+
+    def test_milli
+      assert_equal( 0.001, 1.milli )
+    end
+
+    def test_milli
+      assert_equal( 0.000001, 1.micro )
+    end
+
+    def test_nano
+      assert_equal( 0.000000001, 1.nano )
+    end
+
+    def test_pico
+      assert_equal( 0.000000000001, 1.pico )
+    end
+
+    def test_femto
+      assert_equal( 0.000000000000001, 1.femto )
+    end
+
+    def test_atto
+      assert_equal( 0.000000000000000001, 1.atto )
+    end
+
+    # SI Binary
+
+    def test_kibi
+      assert_equal( 1024, 1.kibi )
+    end
+
+    def test_mebi
+      assert_equal( 1024**2, 1.mebi )
+    end
+
+    def test_gibi
+      assert_equal( 1024**3, 1.gibi )
+    end
+
+    def test_tebi
+      assert_equal( 1024**4, 1.tebi )
+    end
+
+    def test_pebi
+      assert_equal( 1024**5, 1.pebi )
+    end
+
+    def test_exbi
+      assert_equal( 1024**6, 1.exbi )
+    end
+
+  end
+
+=end
+

data/lib/facets/english/ormsupport.rb

@@ -0,0 +1,233 @@
+#--
+# ORMSupport
+#
+# Copyright (c) 2004,2005 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.
+#
+# ==========================================================================
+#  Revision History
+# ==========================================================================
+#
+#  5.8.25 Trans
+#    - Created based on a set of methods from Rails. Spruced up to support
+#      Multiple frameworks, mainly Nitro.
+#
+# ==========================================================================
+#++
+
+#:title: ORMSupport
+#
+# Provides a number of basc convenience methods for working with Object
+# Relational Mappings.
+#
+# == Usage
+#
+#  TODO
+#
+# == Author(s)
+#
+# * D.H.H.
+# * George Moschovitis
+# * Thomas Sawyer
+#
+
+require 'facet/module/attr_setter'
+require 'facet/module/basename'
+require 'facet/string/to_const'
+require 'facet/inflect'
+
+module ORMSupport
+
+  #++
+  # class level
+  #--
+
+  def self.default_system(s=:"~")
+    unless s == :"~"
+      @default_system = x.to_sym
+    else
+      @default_system ||= :og
+    end
+  end
+
+  def self.default_key(k=:"~")
+    unless k == :"~"
+      @default_key = k.to_s
+    else
+      @default_key ||= '_id'
+    end
+  end
+
+  #++
+  # instance level
+  #--
+
+  # Converts a class-esque name into a table name.
+  def tablename( sys=:og )
+    sys ||= ORMSupport.default_system
+    case sys.to_sym
+    when :rails, :ar, :activerecord
+      to_s.underscore.plural
+    when :nitro, :og
+      to_s.gsub(/::/, '_').downcase
+    else
+      to_s.gsub(/::/, '_').downcase
+    end
+  end
+  alias_method :table_name, :tablename  # a la Rails
+  alias_method :tableize,   :tablename    # a la Rails
+
+  # Converts a table name into a class name.
+  #--
+  # Should this return the calculated name even if the class isn't found?
+  #++
+  def classname( sys=nil )
+    sys ||= ORMSupport.default_system
+    case sys.to_sym
+    when :rails, :ar, :activerecord
+      cn = to_s.singular.camelize
+    when :nitro, :og
+      cn = to_s.gsub(/_/, '::').camelize
+    else
+      cn = to_s.gsub(/_/, '::').camelize
+    end
+    k = findclass( cn )
+    return k.name if k
+    return cn
+  end
+  alias_method :class_name, :classname  # a la Rails
+
+  # Like classname, but returns the actual class.
+  #--
+  # TODO Error if not found?
+  #++
+  def classify( sys=:og )
+    findclass( classname( sys ) )
+  end
+
+  def findclass( str )
+    str = str.gsub(/^::/,'')
+    k = nil
+    ObjectSpace.each_object(Class) { |c| (k = c;  break) if c.name.downcase == str.downcase }
+    return k
+  end
+  private :findclass
+
+
+  # This is good for generating database key/id field names from class names.
+  # In essense, it demodulizes, underscores and appends 'id'.
+  def keyname( key=nil )
+    key ||= ORMSupport.default_key
+    case key.to_sym
+    when :_id
+      self.basename.underscore + "_id"
+    when :id
+      self.basename.underscore + "id"
+    when :_key
+      self.basename.underscore + "_key"
+    when :key
+      self.basename.underscore + "key"
+    else
+      self.basename.underscore + ORMSupport.default_key
+    end
+  end
+  alias_method :key_name, :keyname     # to be consistant
+  alias_method :foreign_key, :keyname  # a la Rails
+
+end
+
+#--
+
+class String
+  include ORMSupport
+end
+
+class Class
+  include ORMSupport
+  alias_method :demodulize, :basename  # a la Rails
+end
+
+#++
+
+
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+
+=begin #testing
+
+  require 'test/unit'
+
+  # fixtures
+
+  class Vendor
+  end
+
+  module MockMod
+    class Customer
+    end
+  end
+
+  # test
+
+  class TC_ORMSupport < Test::Unit::TestCase
+
+    # tablename
+
+    def test_tablename
+      assert_equal( 'vendor', "Vendor".tablename )
+      assert_equal( 'mockmod_customer', "MockMod::Customer".tablename )
+    end
+
+    # tableize
+
+    def test_tableize
+      assert_equal( 'vendor', "Vendor".tableize )
+      assert_equal( 'mockmod_customer', "MockMod::Customer".tableize )
+    end
+
+    # classname
+
+    def test_classname
+      assert_equal( 'Vendor', "vendor".classname )
+      assert_equal( 'MockMod::Customer', "mockmod_customer".classname, :none )
+    end
+
+    # classify
+
+    def test_classify
+      assert_equal( Vendor, "vendor".classify )
+      assert_equal( MockMod::Customer, "mockmod_customer".classify )
+    end
+
+    # keyname
+
+    def test_keyname
+      assert_equal( 'vendor_id', "Vendor".keyname )
+      assert_equal( 'customer_id', "MockMod::Customer".keyname )
+      assert_equal( 'customerid', "MockMod::Customer".keyname( :id ) )
+    end
+
+    # foriegn_key (same as keyname)
+
+    def test_foriegn_key
+      assert_equal( 'vendor_id', "Vendor".foreign_key )
+      assert_equal( 'customer_id', "MockMod::Customer".foreign_key )
+      assert_equal( 'customerid', "MockMod::Customer".foreign_key( :id ) )
+    end
+
+  end
+
+=end