parsley/app/models/unit_conversion.rb

module UnitConversion

  INTEGER_REGEX = /-?[0-9]+/
  DECIMAL_REGEX = /(?:-?[0-9]+)?\.[0-9]+/
  RATIONAL_REGEX = /-?(?:[0-9]+ )?[0-9]+\/[0-9]+/
  UNIT_REGEX = /[\[\]a-zA-Z][\[\]a-zA-Z\/.\-()0-9]*/
  UNIT_PARSING_REGEX = /^(?<value>#{INTEGER_REGEX}|#{DECIMAL_REGEX}|#{RATIONAL_REGEX})\s+(?<unit>#{UNIT_REGEX})$/

  UNIT_ALIASES = {
      cup: %w(cups c),
      tablespoon: %w(tbsp tbs tablespoons),
      teaspoon: %w(tsp teaspoons),
      ounce: %w(oz ounces),
      pound: %w(pounds lb lbs),
      pint: %w(pints),
      quart: %w(quarts qt),
      gallon: %w(gallons ga),

      gram: %w(grams g),
      kilogram: %w(kilograms kg),
      milliliter: %w(ml milliliters),
      liter: %w(l liters)
  }

  UNIT_ALIAS_MAP = Hash[UNIT_ALIASES.map { |unit, values| values.map { |v| [v, unit] } }.flatten(1)]

  # map that gives comfortable ranges for a given set of units
  UNIT_RANGES = {
      teaspoon: (0.125...3.0),
      tablespoon: (0.5...4.0),
      cup: (0.25...4.0),
      quart: (1.0...4.0),
      gallon: (0.5..9999),

      ounce: (0..16),
      pound: (0.5..9999),

      gram: (1.0..750),
      kilogram: (0.5..9999),

      milliliter: (1.0..750),
      liter: (0.5..9999)
  }

  UNIT_ORDERS = {
      standard_volume: [
          :teaspoon,
          :tablespoon,
          :cup,
          :quart,
          :gallon
      ],

      metric_volume: [
          :milliliter,
          :liter
      ],

      standard_mass: [
          :ounce,
          :pound
      ],

      metric_mass: [
          :gram,
          :kilogram
      ]
  }

  class UnparseableUnitError < StandardError
  end

  class UnknownUnitError < UnparseableUnitError
  end

  class << self

    def parse(unit_string)
      match = UNIT_PARSING_REGEX.match(unit_string.to_s.strip)

      if match && match[:value].present? && match[:unit].present?
        begin
          value = get_value(match[:value])
          Unitwise(value, normalize_unit_names(match[:unit]))
        rescue Unitwise::ExpressionError => err
          raise UnknownUnitError, err.message
        end
      else
        raise UnparseableUnitError, "'#{unit_string}' does not appear to be a valid measurement of the form <value> <units> (ie '5 cup' or '223 gram/cup')"
      end
    end

    def density?(unit)
      unit.compatible_with? Unitwise(1, 'g/ml')
    end

    def volume?(unit)
      unit.compatible_with? Unitwise(1, 'ml')
    end

    def mass?(unit)
      unit.compatible_with? Unitwise(1, 'g')
    end

    # Returns a Unitwise representation of the density.  Raises an exception if the value is anything other than a
    # valid density
    def get_density(str)
      raise UnknownUnitError, 'No density provided' if str.blank?
      begin
        unit = parse(str)
      rescue UnparseableUnitError => err
        raise UnknownUnitError "Invalid density: #{err.message}"
      end

      raise UnknownUnitError, "Invalid density: #{str} is not a density" unless density?(unit)
      unit
    end

    def normalize_unit_names(unit_description)
      unit_description.downcase.gsub(/[a-z]+/) do |match|
        UNIT_ALIAS_MAP[match] || match
      end
    end

    def get_value(str)
      if str =~ /^#{INTEGER_REGEX}$/
        str.to_i
      elsif str =~ /^#{RATIONAL_REGEX}$/
        parts = str.split(' ')
        if parts.length == 2
          whole = parts.first.to_r
          fractional = parts.last.to_r
          (whole.abs + fractional) * (whole < 0 ? -1.to_r : 1.to_r)
        else
          str.to_r
        end
      elsif str =~ /^#{DECIMAL_REGEX}$/
        str.to_d
      else
        raise UnparseableUnitError, "str (#{str}) is not a valid number"
      end
    end

    def convert(quantity, factor, input_unit, output_unit, density = nil)

      value = get_value(quantity)
      factor = get_value(factor)

      if value.is_a?(BigDecimal) && factor.is_a?(Rational)
        factor = factor.to_d(10)
      end

      converted = value * factor

      input_unit = normalize_unit_names(input_unit) unless input_unit.nil?
      output_unit = normalize_unit_names(output_unit) unless output_unit.nil?

      if input_unit.present? && output_unit.present? && input_unit != output_unit
        in_unit = Unitwise(1, input_unit)
        out_unit = Unitwise(1, output_unit)
        unit = Unitwise(converted, input_unit)

        if volume?(in_unit) && mass?(out_unit)
          unit_density = get_density(density)
          unit = unit * unit_density
        elsif mass?(in_unit) && volume?(out_unit)
          unit_density = get_density(density)
          unit = unit / unit_density
        end

        converted = unit.convert_to(output_unit).value
      end

      quantity_format(converted, value)
    end

    def quantity_format(quantity, original_quantity)
      if original_quantity.is_a?(Rational) || original_quantity.is_a?(Integer)
        rational_val = rationalize(quantity)
        if rational_val.denominator == 1
          rational_val.to_i.to_s
        elsif rational_val.denominator < rational_val.numerator.abs
          whole = rational_val.floor
          fraction = rational_val - whole
          "#{whole} #{fraction}"
        else
          rational_val.to_s
        end
      else
        "%g" % ("%.3f" % quantity)
      end
    end

    def rationalize(value)

      if value.is_a? Integer
        return value
      end

      if value.floor == value
        return value
      end

      useful_denominators = [2, 3, 4, 8, 16]

      whole = value.floor
      fraction = value - whole

      approximations = useful_denominators.map do |d|
        best_n = (1...d).each.map { |n| {delta: (fraction - Rational(n, d)).abs, numerator: n} }.sort { |a, b| a[:delta] <=> b[:delta] }.first
        {denominator: d, numerator: best_n[:numerator], delta: best_n[:delta]}
      end

      # Add 0 and 1
      approximations << { denominator: 1, numerator: 0, delta: (fraction - Rational(0,1)).abs }
      approximations << { denominator: 1, numerator: 1, delta: (fraction - Rational(1,1)).abs }

      best = approximations.sort { |a, b| [a[:delta], a[:denominator]] <=> [b[:delta], b[:denominator]] }.first

      Rational((whole * best[:denominator]) + best[:numerator], best[:denominator])
    end

    # Given an awkward measurement such as '18 9/10 oz' or '5/24 cup' or '0.09434 cup',
    # it will round the rational and scale the unit to give a more reasonable, useful measurement, ie
    # 19 oz, 3 Tbsp, 1 1/2 Tbsp
    def auto_unit(quantity, units)
      # First scale the unit if it seems to use the wrong unit
      normalized_unit = normalize_unit_names(units)
      value = initial_value = get_value(quantity)
      type_key, unit_orders = UNIT_ORDERS.detect { |key, orders| orders.include(normalized_unit.to_sym) }
      new_unit = normalized_unit

      if unit_orders && (unit_range = UNIT_RANGE[normalized_unit.to_sym])

        if value < unit_range.first
          unit_orders = unit_orders.reverse
        end

        idx = unit_orders.index(new_unit.to_sym)

        while !unit_range.include?(value) && idx < (unit_orders.length - 1)
          idx += 1
          next_unit = unit_orders[idx]
          value = Unitwise(value, new_unit).convert_to(next_unit).value
          new_unit = next_unit
          unit_range = UNIT_RANGE[new_unit.to_sym]
        end
      end

      quantity_format(value, initial_value)
    end

  end
end