uom 1.2.1

data/lib/uom/unit_factory.rb

@@ -0,0 +1,145 @@
+require 'set'
+require 'active_support/inflector'
+require 'uom/error'
+require 'uom/units'
+
+module UOM
+  # A UnitFactory creates Unit instances.
+  class UnitFactory
+    LABEL_EXPONENT_HASH = {:square=>2, :sq=>2, :cubic=>3, :cu=>3}
+
+    # Returns the unit with the given label. Creates a new unit if necessary.
+    #
+    # Raises MeasurementError if the unit could not be created.
+    def create(label)
+      create_atomic(label.to_s) or create_composite(label.to_s) or raise MeasurementError.new("Unit '#{label}' not found")
+    end
+
+    private
+
+    def unit_for(label)
+      # the label => Unit hash of known units
+      @label_unit_hash ||= Unit.extent.association
+      # test whether there is an association before accessing it by label, since the extent hash
+      # has a hash factory that creates a Unit on demand, which is not desirable here
+      @label_unit_hash[label.to_sym] if @label_unit_hash.has_key?(label.to_sym)
+    end
+
+    def create_atomic(label)
+      scalar, axis = partition_atomic_label(label)
+      return if axis.nil?
+      label = "#{scalar}#{axis}".to_sym
+      unit_for(label) or Unit.new(label, scalar, axis)
+    end
+
+    def create_composite(label)
+      create_division(label) or create_product(label)
+    end
+
+    def create_division(str)
+      labels = str.split('_per_')
+      return if labels.size < 2
+      units = labels.map { |label| create(label) or raise MeasurementError.new("Unit '#{label}' not found in #{str}") }
+      std_label = units.join('_per_')
+      unit_for(std_label) or units.inject { |quotient, divisor| quotient / divisor }
+    end
+
+    def create_product(str)
+      std_label, units = collect_product_units(str)
+      unit_for(std_label) or units.inject { |product, multiplier| product * multiplier } unless units.size < 2
+    end
+
+    def collect_product_units(str)
+      return nil, [] if str.nil? or str.empty?
+      prefix = str[/[[:alnum:]]+/]
+      exponent = LABEL_EXPONENT_HASH[prefix.to_sym]
+      if exponent.nil? then
+        label, unit = slice_atomic_unit(str)
+        rest_label, rest_units = collect_product_units(str[label.length + 1..-1])
+        return "#{unit.label}_#{rest_label}".to_sym, [unit].concat(rest_units)
+      else
+        label, unit = slice_atomic_unit(str[prefix.length + 1..-1])
+        return "#{prefix}_#{unit.label}".to_sym, Array.new(exponent, unit)
+      end
+    end
+
+    # Returns the Unit which matches the str prefix.
+    #
+    # Raises MeasurementError if the unit could not be determined.
+    def slice_atomic_unit(str)
+      label = ''
+      str.scan(/_?[^_]+/) do |chunk|
+        label << chunk
+        unit = create_atomic(label)
+        return label, unit if unit
+      end
+      raise MeasurementError.new("Unit '#{str}' not found")
+    end
+
+    # Returns the +[scale, axis]+ pair parsed from the label.
+    def partition_atomic_label(label)
+      # singularize the label if it contains more than two letters and ends in s but not ss. this condition
+      # avoids incorrect singularization of, e.g., ms (millisecond) and gauss.
+      label = label.singularize if label =~ /[[:alnum:]][^s]s$/
+      scalar, axis = parse_atomic_label(label) { |label| match_axis_label_suffix(label) }
+      return scalar, axis unless scalar.nil? and axis.nil?
+      parse_atomic_label(label) { |label| match_axis_abbreviation_suffix(label) }
+    end
+
+    def parse_atomic_label(label)
+      # match the axis from the label suffix
+      suffix, axis = yield label
+      return nil, axis if axis.nil? or suffix == label
+      prefix = suffix.nil? ? label : label[0...-suffix.to_s.length]
+      # remove trailing separator from prefix if necessary,
+      # e.g. the "milli_meter" prefix "milli_" becomes "milli"
+      prefix = prefix[0, prefix.length - 1] if prefix[prefix.length - 1] == '_'
+      # match the remaining prefix part of the label to a scalar
+      scalar = match_scalar(prefix)
+      return nil, nil if scalar.nil?
+      return scalar, axis
+    end
+
+    # Returns the axis label and Unit which match on the label suffix substring, or nil
+    # if no match. For example,
+    #   match_axis_label_suffix(:millimeter)
+    # returns "meter" and the meter Unit.
+    def match_axis_label_suffix(str)
+      best = [nil, nil]
+      Unit.each do |unit|
+        label_s = unit.label.to_s
+        best = [label_s, unit] if suffix?(label_s, str) and (best.first.nil? or label_s.length > best.first.length)
+      end
+      best
+    end
+
+    # Returns the axis abbreviation and Unit which match on the label suffix substring, or nil
+    # if no match. For example,
+    #   match_axis_abbreviation_suffix(:mm)
+    # returns "meter" and the meter Unit.
+    def match_axis_abbreviation_suffix(str)
+      best = [nil, nil]
+      Unit.each do |unit|
+        unit.abbreviations.each do |abbrev|
+          abbrev_s = abbrev.to_s
+          best = abbrev_s, unit if suffix?(abbrev_s, str) and (best.first.nil? or abbrev_s.length > best.first.length)
+        end
+      end
+      best
+    end
+
+    # Returns the Factor which matches the label, or nil if no match.
+    def match_scalar(label)
+      label = label.to_sym
+      Factor.detect do |factor|
+        return factor if factor.label == label or factor.abbreviation == label
+      end
+    end
+
+    # Returns whether text ends in suffix.
+    def suffix?(suffix, text)
+      len = suffix.length
+      len <= text.length and suffix == text[-len, len]
+    end
+  end
+end

data/lib/uom/units.rb

@@ -0,0 +1,115 @@
+require 'uom/dimensions'
+require 'uom/factors'
+require 'uom/unit'
+require 'uom/composite_unit'
+
+module UOM
+  ## STANDARD UNITS ##
+
+  # the standard units for each dimension
+  METER = Unit.new(:meter, :m, LENGTH, *METRIC_FACTORS)
+  GRAM = Unit.new(:gram, :gm, :g, MASS, *METRIC_FACTORS)
+  SECOND = Unit.new(:second, :sec, :s, TIME, MILLI, MICRO, NANO, PICO, FEMTO)
+  KELVIN = Unit.new(:kelvin, :K, TEMPERATURE)
+  CANDELA = Unit.new(:candela, :cd, INTENSITY)
+  AMPERE = Unit.new(:ampere, :A, CURRENT, *ELECTRONIC_FACTORS)
+  MOLE = Unit.new(:mole, :mol, MASS)
+  BYTE = Unit.new(:byte, :Byte, :B, :b, INFORMATION) # Scaled byte units, e.g KByte, are defined below
+
+  ## SCALED UNITS ##
+  # Just a few common metric units; units are typically referred to by label rather than a constant,
+  # e.g. <tt>Unit.for(:millimeter)</tt>
+  MILLIMETER = Unit.for(:millimeter)
+  CENTIMETER = Unit.for(:centimeter)
+  DECIMETER = Unit.for(:decimeter)
+  MICROGRAM = Unit.for(:microgram)
+  MILLIGRAM = Unit.for(:milligram)
+  KILOGRAM = Unit.for(:kilogram)
+
+  # The BYTE scale is a base two axis multiplier rather than a metric scalar multipler.
+  # TODO - express these with base-2 factors?
+  KILOBYTE = Unit.new(:kilobyte, :KByte, :KB, BYTE, 1024)
+  MEGABYTE = Unit.new(:megabyte, :MByte, :MB, KILOBYTE, 1024)
+  GIGABYTE = Unit.new(:gigabyte, :GByte, :GB, MEGABYTE, 1024)
+  TERABYTE = Unit.new(:terabyte, :TByte, :TB, GIGABYTE, 1024)
+  PETABYTE = Unit.new(:petabyte, :PByte, :PB, TERABYTE, 1024)
+
+  ## DERIVED UNITS ##
+
+  # astronomical distances
+  ANGSTROM = Unit.new(:angstrom, :a, METER, 10000000000)
+  AU = Unit.new(:astronomical_unit, :AU, METER, 149597870691)
+  LIGHT_YEAR = Unit.new(:light_year, :ly, METER, 9460730472580800)
+
+  # temperature with inverse converters
+  CELSIUS = Unit.new(:celsius, :C, KELVIN) { |celsius| celsius - 273.15 }
+  KELVIN.add_converter(CELSIUS) { |kelvin| kelvin + 273.15 }
+  FARENHEIT = Unit.new(:farenheit, :F, CELSIUS) { |farenheit| (farenheit - 32) * (5 / 9) }
+  CELSIUS.add_converter(FARENHEIT) { |celsius| (celsius + 32) * (9 / 5) }
+  # mark temperatures as uncountable for the parser
+  ActiveSupport::Inflector.inflections { |inflect| inflect.uncountable('celsius', 'kelvin', 'farenheit') }
+
+  # time
+  MINUTE = Unit.new(:minute, :min, SECOND, 60)
+  HOUR = Unit.new(:hour, :hr, MINUTE, 60)
+  DAY = Unit.new(:day, HOUR, 24)
+
+  # information
+  BIT = Unit.new(:bit, BYTE, 1.0 / 8)
+
+  # US Customary length units
+  INCH = Unit.new(:inch, :in, METER, 0.0254)
+  FOOT = Unit.new(:foot, :ft, INCH, 12)
+  YARD = Unit.new(:yard, :yd, FOOT, 3)
+  MILE = Unit.new(:mile, :mi, FOOT, 5280)
+
+  # US Customary weight units
+  OUNCE = Unit.new(:ounce, :oz, GRAM, 28.34952)
+  POUND = Unit.new(:pound, :lb, OUNCE, 16)
+  TON = Unit.new(:ton, POUND, 2000)
+  GRAIN = Unit.new(:grain, :gr, POUND, 1.0 / 7000)
+  DRAM = Unit.new(:dram, :dr, OUNCE, 1.0 / 16)
+
+  # Metric composite units
+  LITER = Unit.new(:liter, :l, :L, DECIMETER * DECIMETER * DECIMETER, *METRIC_FACTORS)
+  MILLILITER = Unit.for(:milliliter)
+  JOULE = Unit.new(:joule, :J, (KILOGRAM * (METER * METER)) / (SECOND * SECOND), *ELECTRONIC_FACTORS)
+  ERG = Unit.new(:erg, (GRAM * (CENTIMETER * CENTIMETER)) / (SECOND * SECOND), *ELECTRONIC_FACTORS)
+  DYNE = Unit.new(:dyne, :dyn, (GRAM * CENTIMETER) / (SECOND * SECOND), *ELECTRONIC_FACTORS)
+  BARYE = Unit.new(:barye, :Ba, GRAM / (CENTIMETER * (SECOND * SECOND)), *ELECTRONIC_FACTORS)
+  POISE = Unit.new(:poise, :P, GRAM / (CENTIMETER * SECOND), KILO, MILLI, MICRO, NANO, PICO)
+  COULOMB = Unit.new(:coulomb, AMPERE / SECOND, *ELECTRONIC_FACTORS) # C abbreviation is taken by CENTIGRADE
+  VOLT = Unit.new(:volt, :V, JOULE / COULOMB, *ELECTRONIC_FACTORS)
+  FARAD = Unit.new(:farad, COULOMB / VOLT, *ELECTRONIC_FACTORS) # F abbreviation is taken by FARENHEIT
+  WEBER = Unit.new(:weber, :Wb, VOLT * SECOND, *ELECTRONIC_FACTORS)
+  HENRY = Unit.new(:henry, :H, WEBER / AMPERE, METRIC_FACTORS)
+  MAXWELL = Unit.new(:maxwell, :Mx, WEBER, 1.0 / 10 ** 8, METRIC_FACTORS)
+  GAUSS = Unit.new(:gauss, :G, MAXWELL / (CENTIMETER * CENTIMETER), METRIC_FACTORS)
+  # mark gauss as irregular for the parser
+  ActiveSupport::Inflector.inflections { |inflect| inflect.irregular('gauss', 'gausses') }
+  TESLA = Unit.new(:tesla, :T, WEBER / (METER * METER), DECI, CENTI, MILLI, MICRO, NANO, PICO)
+
+  # The speed of light in a vacuum in cm/sec.
+  C = 29979245800
+
+  OHM = Unit.new(:ohm, SECOND / CENTIMETER, 10 ** 9 / C)
+
+  # US Customary liquid volume units
+  FLUID_OUNCE = Unit.new(:fluid_ounce, :fl_oz, MILLILITER, 29.57353)
+  TBSP = Unit.new(:tablespoon, :tbsp, FLUID_OUNCE, 2)
+  TSP = Unit.new(:teaspoon, :tsp, TBSP, 1.0 / 3)
+  CUP = Unit.new(:cup, :cp, FLUID_OUNCE, 8)
+  PINT = Unit.new(:pint, :pt, CUP, 2)
+  QUART = Unit.new(:quart, :qt, PINT, 2)
+  GALLON = Unit.new(:gallon, :gal, QUART, 4)
+
+  # US Customary dry volume units
+  DRY_PINT = Unit.new(:dry_pint, :dry_pt, LITER) { |liter| liter / 0.5506105 }
+  DRY_QUART = Unit.new(:dry_quart, :dry_qt, DRY_PINT, 2)
+  DRY_GALLON = Unit.new(:dry_gallon, :dry_gal, DRY_QUART, 4)
+  PECK = Unit.new(:peck, :pk, DRY_GALLON, 2)
+  BUSHEL = Unit.new(:bushel, :bu, PECK, 4)
+
+  # Pressure
+  PSI = Unit.for(:pounds_per_square_inch).add_abbreviation(:psi)
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification 
+name: uom
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 1
+  - 2
+  - 1
+  version: 1.2.1
+platform: ruby
+authors: 
+- OHSU
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-04 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: extensional
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: "    UOM implements Units of Measurement based on the International System of Units (SI).\n    The base SI units, metric scalar factors and all possible combinations of these units\n    are supported out of the box.\n"
+email: caruby.org@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- doc/units.txt
+- lib/active_support/core_ext/string/inflections.rb
+- lib/active_support/core_ext/string.rb
+- lib/active_support/inflections.rb
+- lib/active_support/inflector.rb
+- lib/active_support/README.txt
+- lib/uom/composite_unit.rb
+- lib/uom/composite_unit_key_canonicalizer.rb
+- lib/uom/dimension.rb
+- lib/uom/dimensions.rb
+- lib/uom/error.rb
+- lib/uom/factor.rb
+- lib/uom/factors.rb
+- lib/uom/measurement.rb
+- lib/uom/unit.rb
+- lib/uom/unit_factory.rb
+- lib/uom/units.rb
+- lib/uom.rb
+- History.txt
+- LEGAL
+- LICENSE
+- README.md
+has_rdoc: uom
+homepage: http://github.com/caruby/uom/
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: caruby
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Ruby Unit of Measurement library.
+test_files: []
+