A SassScript object representing a number. SassScript numbers can have decimal values, and can also have units. For example, `12`, `1px`, and `10.45em` are all valid values.
Numbers can also have more complex units, such as `1px*em/in`. These cannot be inputted directly in Sass code at the moment.
A two-dimensional hash from two units to the conversion ratio between them. Multiply `X` by `CONVERSION_TABLE[Y]` to convert it to `Y`.
A hash from each known unit to the set of units that it’s mutually convertible with.
Used so we don’t allocate two new arrays for each new number.
A list of units in the denominator of the number. For example, `1px*em/in*cm` would return `[“in”, “cm”]` @return [Array<String>]
A list of units in the numerator of the number. For example, `1px*em/in*cm` would return `[“px”, “em”]` @return [Array<String>]
@param value [Numeric] The value of the number @param numerator_units [::String, Array<::String>] See {#numerator_units} @param denominator_units [::String, Array<::String>] See {#denominator_units}
# File lib/sass/script/value/number.rb, line 60 def initialize(value, numerator_units = NO_UNITS, denominator_units = NO_UNITS) numerator_units = [numerator_units] if numerator_units.is_a?(::String) denominator_units = [denominator_units] if denominator_units.is_a?(::String) super(value) @numerator_units = numerator_units @denominator_units = denominator_units normalize! end
# File lib/sass/script/value/number.rb, line 36 def self.precision @precision ||= 5 end
Returns this number converted to other units. The conversion takes into account the relationship between e.g. mm and cm, as well as between e.g. in and cm.
If this number has no units, it will simply return itself with the given units.
An incompatible coercion, e.g. between px and cm, will raise an error.
@param num_units [Array<String>] The numerator units to coerce this number into.
See {\#numerator\_units}
@param den_units [Array<String>] The denominator units to coerce this number into.
See {\#denominator\_units}
@return [Number] The number with the new units @raise [Sass::UnitConversionError] if the given units are incompatible with the number’s
current units
# File lib/sass/script/value/number.rb, line 345 def coerce(num_units, den_units) Number.new(if unitless? value else value * coercion_factor(@numerator_units, num_units) / coercion_factor(@denominator_units, den_units) end, num_units, den_units) end
@param other [Number] A number to decide if it can be compared with this number. @return [Boolean] Whether or not this number can be compared with the other.
# File lib/sass/script/value/number.rb, line 356 def comparable_to?(other) operate(other, :+) true rescue Sass::UnitConversionError false end
The SassScript `/` operation. Its functionality depends on the type of its argument:
{Number} : Divides this number by the other, converting units appropriately.
{Value} : See {Value::Base#div}.
@param other [Value] The right-hand side of the operator @return [Value] The result of the operation
# File lib/sass/script/value/number.rb, line 161 def div(other) if other.is_a? Number res = operate(other, :/) if original && other.original res.original = "#{original}/#{other.original}" end res else super end end
The SassScript `==` operation.
@param other [Value] The right-hand side of the operator @return [Boolean] Whether this number is equal to the other object
# File lib/sass/script/value/number.rb, line 191 def eq(other) return Bool::FALSE unless other.is_a?(Sass::Script::Value::Number) this = self begin if unitless? this = this.coerce(other.numerator_units, other.denominator_units) else other = other.coerce(@numerator_units, @denominator_units) end rescue Sass::UnitConversionError return Bool::FALSE end Bool.new(this.value == other.value) end
Hash-equality works differently than `==` equality for numbers. Hash-equality must be transitive, so it just compares the exact value, numerator units, and denominator units.
# File lib/sass/script/value/number.rb, line 213 def eql?(other) value == other.value && numerator_units == other.numerator_units && denominator_units == other.denominator_units end
The SassScript `>` operation.
@param other [Number] The right-hand side of the operator @return [Boolean] Whether this number is greater than the other @raise [NoMethodError] if `other` is an invalid type
# File lib/sass/script/value/number.rb, line 223 def gt(other) raise NoMethodError.new(nil, :gt) unless other.is_a?(Number) operate(other, :>) end
The SassScript `>=` operation.
@param other [Number] The right-hand side of the operator @return [Boolean] Whether this number is greater than or equal to the other @raise [NoMethodError] if `other` is an invalid type
# File lib/sass/script/value/number.rb, line 233 def gte(other) raise NoMethodError.new(nil, :gte) unless other.is_a?(Number) operate(other, :>=) end
# File lib/sass/script/value/number.rb, line 206 def hash [value, numerator_units, denominator_units].hash end
Returns a readable representation of this number.
This representation is valid CSS (and valid SassScript) as long as there is only one unit.
@return [String] The representation
# File lib/sass/script/value/number.rb, line 273 def inspect(opts = {}) return original if original value = self.class.round(self.value) str = value.to_s # Ruby will occasionally print in scientific notation if the number is # small enough. That's technically valid CSS, but it's not well-supported # and confusing. str = ("%0.#{self.class.precision}f" % value).gsub(/0*$/, '') if str.include?('e') unitless? ? str : "#{str}#{unit_str}" end
@return [Boolean] Whether or not this number is an integer.
# File lib/sass/script/value/number.rb, line 296 def int? value % 1 == 0.0 end
Checks whether the number has the numerator unit specified.
@example
number = Sass::Script::Value::Number.new(10, "px") number.is_unit?("px") => true number.is_unit?(nil) => false
@param unit [::String, nil] The unit the number should have or nil if the number
should be unitless.
@see Number#unitless? The unitless? method may be more readable.
# File lib/sass/script/value/number.rb, line 315 def is_unit?(unit) if unit denominator_units.size == 0 && numerator_units.size == 1 && numerator_units.first == unit else unitless? end end
@return [Boolean] Whether or not this number has units that can be represented in CSS
(that is, zero or one \{#numerator\_units}).
# File lib/sass/script/value/number.rb, line 325 def legal_units? (@numerator_units.empty? || @numerator_units.size == 1) && @denominator_units.empty? end
The SassScript `<` operation.
@param other [Number] The right-hand side of the operator @return [Boolean] Whether this number is less than the other @raise [NoMethodError] if `other` is an invalid type
# File lib/sass/script/value/number.rb, line 243 def lt(other) raise NoMethodError.new(nil, :lt) unless other.is_a?(Number) operate(other, :<) end
The SassScript `<=` operation.
@param other [Number] The right-hand side of the operator @return [Boolean] Whether this number is less than or equal to the other @raise [NoMethodError] if `other` is an invalid type
# File lib/sass/script/value/number.rb, line 253 def lte(other) raise NoMethodError.new(nil, :lte) unless other.is_a?(Number) operate(other, :<=) end
The SassScript binary `-` operation (e.g. `$a - $b`). Its functionality depends on the type of its argument:
{Number} : Subtracts this number from the other, converting units if possible.
{Value} : See {Value::Base#minus}.
@param other [Value] The right-hand side of the operator @return [Value] The result of the operation @raise [Sass::UnitConversionError] if `other` is a number with incompatible units
# File lib/sass/script/value/number.rb, line 106 def minus(other) if other.is_a? Number operate(other, :-) else super end end
The SassScript `%` operation.
@param other [Number] The right-hand side of the operator @return [Number] This number modulo the other @raise [NoMethodError] if `other` is an invalid type @raise [Sass::UnitConversionError] if `other` has incompatible units
# File lib/sass/script/value/number.rb, line 179 def mod(other) if other.is_a?(Number) operate(other, :%) else raise NoMethodError.new(nil, :mod) end end
The SassScript `+` operation. Its functionality depends on the type of its argument:
{Number} : Adds the two numbers together, converting units if possible.
{Color} : Adds this number to each of the RGB color channels.
{Value} : See {Value::Base#plus}.
@param other [Value] The right-hand side of the operator @return [Value] The result of the operation @raise [Sass::UnitConversionError] if `other` is a number with incompatible units
# File lib/sass/script/value/number.rb, line 84 def plus(other) if other.is_a? Number operate(other, :+) elsif other.is_a?(Color) other.plus(self) else super end end
The SassScript `*` operation. Its functionality depends on the type of its argument:
{Number} : Multiplies the two numbers together, converting units appropriately.
{Color} : Multiplies each of the RGB color channels by this number.
@param other [Number, Color] The right-hand side of the operator @return [Number, Color] The result of the operation @raise [NoMethodError] if `other` is an invalid type
# File lib/sass/script/value/number.rb, line 140 def times(other) if other.is_a? Number operate(other, :*) elsif other.is_a? Color other.times(self) else raise NoMethodError.new(nil, :times) end end
@return [Fixnum] The integer value of the number @raise [Sass::SyntaxError] if the number isn’t an integer
# File lib/sass/script/value/number.rb, line 290 def to_i super unless int? value end
@return [String] The CSS representation of this number @raise [Sass::SyntaxError] if this number has units that can’t be used in CSS
(e.g. `px*in`)
# File lib/sass/script/value/number.rb, line 261 def to_s(opts = {}) return original if original raise Sass::SyntaxError.new("#{inspect} isn't a valid CSS value.") unless legal_units? inspect end
The SassScript unary `-` operation (e.g. `-$a`).
@return [Number] The negative value of this number
# File lib/sass/script/value/number.rb, line 124 def unary_minus Number.new(-value, @numerator_units, @denominator_units) end
The SassScript unary `+` operation (e.g. `+$a`).
@return [Number] The value of this number
# File lib/sass/script/value/number.rb, line 117 def unary_plus self end
Returns a human readable representation of the units in this number. For complex units this takes the form of: numerator_unit1 * numerator_unit2 / denominator_unit1 * denominator_unit2 @return [String] a string that represents the units in this number
# File lib/sass/script/value/number.rb, line 367 def unit_str rv = @numerator_units.sort.join("*") if @denominator_units.any? rv << "/" rv << @denominator_units.sort.join("*") end rv end
Generated with the Darkfish Rdoc Generator 2.