Class: Sass::Script::Value::Number

Inherits:
Base
  • Object
show all
Defined in:
lib/sass/script/value/number.rb

Overview

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.

Constant Summary collapse

NO_UNITS =

Used so we don't allocate two new arrays for each new number.

[]

Instance Attribute Summary collapse

Attributes inherited from Base

#options, #source_range

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Base

#==, #_perform, #assert_int!, #neq, #null?, #separator, #single_eq, #to_a, #to_bool, #to_h, #unary_div, #unary_not

Constructor Details

#initialize(value, numerator_units = NO_UNITS, denominator_units = NO_UNITS) ⇒ Number

Returns a new instance of Number

Parameters:

  • value (Numeric)

    The value of the number

  • numerator_units (::String, Array<::String>) (defaults to: NO_UNITS)
  • denominator_units (::String, Array<::String>) (defaults to: NO_UNITS)

60
61
62
63
64
65
66
67
# 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

Instance Attribute Details

#denominator_unitsArray<String> (readonly)

A list of units in the denominator of the number. For example, 1px*em/in*cm would return ["in", "cm"]

Returns:


24
25
26
# File 'lib/sass/script/value/number.rb', line 24

def denominator_units
  @denominator_units
end

#numerator_unitsArray<String> (readonly)

A list of units in the numerator of the number. For example, 1px*em/in*cm would return ["px", "em"]

Returns:


19
20
21
# File 'lib/sass/script/value/number.rb', line 19

def numerator_units
  @numerator_units
end

#originalBoolean?

The original representation of this number. For example, although the result of 1px/2px is 0.5, the value of #original is "1px/2px".

This is only non-nil when the original value should be used as the CSS value, as in font: 1px/2px.

Returns:

  • (Boolean, nil)

34
35
36
# File 'lib/sass/script/value/number.rb', line 34

def original
  @original
end

#valueNumeric (readonly)

The Ruby value of the number.

Returns:

  • (Numeric)

14
15
16
# File 'lib/sass/script/value/number.rb', line 14

def value
  @value
end

Class Method Details

.precision


36
37
38
# File 'lib/sass/script/value/number.rb', line 36

def self.precision
  @precision ||= 5
end

.precision=(digits)

Sets the number of digits of precision For example, if this is 3, 3.1415926 will be printed as 3.142.


43
44
45
46
# File 'lib/sass/script/value/number.rb', line 43

def self.precision=(digits)
  @precision = digits.round
  @precision_factor = 10.0**@precision
end

.precision_factor

the precision factor used in numeric output it is derived from the precision method.


50
51
52
# File 'lib/sass/script/value/number.rb', line 50

def self.precision_factor
  @precision_factor ||= 10.0**precision
end

Instance Method Details

#coerce(num_units, den_units) ⇒ Number

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.

Parameters:

Returns:

  • (Number)

    The number with the new units

Raises:


345
346
347
348
349
350
351
352
# 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

#comparable_to?(other) ⇒ Boolean

Returns Whether or not this number can be compared with the other.

Parameters:

  • other (Number)

    A number to decide if it can be compared with this number.

Returns:

  • (Boolean)

    Whether or not this number can be compared with the other.


356
357
358
359
360
361
# File 'lib/sass/script/value/number.rb', line 356

def comparable_to?(other)
  operate(other, :+)
  true
rescue Sass::UnitConversionError
  false
end

#div(other) ⇒ Value

The SassScript / operation. Its functionality depends on the type of its argument:

Sass::Script::Value::Number : Divides this number by the other, converting units appropriately.

Sass::Script::Value : See Base#div.

Parameters:

  • other (Value)

    The right-hand side of the operator

Returns:

  • (Value)

    The result of the operation


161
162
163
164
165
166
167
168
169
170
171
# 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

#eq(other) ⇒ Boolean

The SassScript == operation.

Parameters:

  • other (Value)

    The right-hand side of the operator

Returns:

  • (Boolean)

    Whether this number is equal to the other object


191
192
193
194
195
196
197
198
199
200
201
202
203
204
# 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

#eql?(other) ⇒ Boolean

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.

Returns:

  • (Boolean)

213
214
215
216
# 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

#gt(other) ⇒ Boolean

The SassScript > operation.

Parameters:

  • other (Number)

    The right-hand side of the operator

Returns:

  • (Boolean)

    Whether this number is greater than the other

Raises:

  • (NoMethodError)

    if other is an invalid type


223
224
225
226
# 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

#gte(other) ⇒ Boolean

The SassScript >= operation.

Parameters:

  • other (Number)

    The right-hand side of the operator

Returns:

  • (Boolean)

    Whether this number is greater than or equal to the other

Raises:

  • (NoMethodError)

    if other is an invalid type


233
234
235
236
# 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

#hash


206
207
208
# File 'lib/sass/script/value/number.rb', line 206

def hash
  [value, numerator_units, denominator_units].hash
end

#inspect(opts = {}) ⇒ String Also known as: to_sass

Returns a readable representation of this number.

This representation is valid CSS (and valid SassScript) as long as there is only one unit.

Returns:

  • (String)

    The representation


273
274
275
276
277
278
279
280
281
282
283
284
285
# 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

#int?Boolean

Returns Whether or not this number is an integer.

Returns:

  • (Boolean)

    Whether or not this number is an integer.


296
297
298
# File 'lib/sass/script/value/number.rb', line 296

def int?
  value % 1 == 0.0
end

#is_unit?(unit) ⇒ Boolean

Checks whether the number has the numerator unit specified.

Examples:

number = Sass::Script::Value::Number.new(10, "px")
number.is_unit?("px") => true
number.is_unit?(nil) => false

Parameters:

  • unit (::String, nil)

    The unit the number should have or nil if the number should be unitless.

Returns:

  • (Boolean)

See Also:


315
316
317
318
319
320
321
# 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

Returns Whether or not this number has units that can be represented in CSS (that is, zero or one #numerator_units).

Returns:

  • (Boolean)

    Whether or not this number has units that can be represented in CSS (that is, zero or one #numerator_units).


325
326
327
# File 'lib/sass/script/value/number.rb', line 325

def legal_units?
  (@numerator_units.empty? || @numerator_units.size == 1) && @denominator_units.empty?
end

#lt(other) ⇒ Boolean

The SassScript < operation.

Parameters:

  • other (Number)

    The right-hand side of the operator

Returns:

  • (Boolean)

    Whether this number is less than the other

Raises:

  • (NoMethodError)

    if other is an invalid type


243
244
245
246
# 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

#lte(other) ⇒ Boolean

The SassScript <= operation.

Parameters:

  • other (Number)

    The right-hand side of the operator

Returns:

  • (Boolean)

    Whether this number is less than or equal to the other

Raises:

  • (NoMethodError)

    if other is an invalid type


253
254
255
256
# 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

#minus(other) ⇒ Value

The SassScript binary - operation (e.g. $a - $b). Its functionality depends on the type of its argument:

Sass::Script::Value::Number : Subtracts this number from the other, converting units if possible.

Sass::Script::Value : See Base#minus.

Parameters:

  • other (Value)

    The right-hand side of the operator

Returns:

  • (Value)

    The result of the operation

Raises:


106
107
108
109
110
111
112
# File 'lib/sass/script/value/number.rb', line 106

def minus(other)
  if other.is_a? Number
    operate(other, :-)
  else
    super
  end
end

#mod(other) ⇒ Number

The SassScript % operation.

Parameters:

  • other (Number)

    The right-hand side of the operator

Returns:

  • (Number)

    This number modulo the other

Raises:


179
180
181
182
183
184
185
# 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

#plus(other) ⇒ Value

The SassScript + operation. Its functionality depends on the type of its argument:

Sass::Script::Value::Number : Adds the two numbers together, converting units if possible.

Color : Adds this number to each of the RGB color channels.

Sass::Script::Value : See Base#plus.

Parameters:

  • other (Value)

    The right-hand side of the operator

Returns:

  • (Value)

    The result of the operation

Raises:


84
85
86
87
88
89
90
91
92
# 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

#times(other) ⇒ Number, Color

The SassScript * operation. Its functionality depends on the type of its argument:

Sass::Script::Value::Number : Multiplies the two numbers together, converting units appropriately.

Color : Multiplies each of the RGB color channels by this number.

Parameters:

  • other (Number, Color)

    The right-hand side of the operator

Returns:

Raises:

  • (NoMethodError)

    if other is an invalid type


140
141
142
143
144
145
146
147
148
# 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

#to_iFixnum

Returns The integer value of the number

Returns:

  • (Fixnum)

    The integer value of the number

Raises:


290
291
292
293
# File 'lib/sass/script/value/number.rb', line 290

def to_i
  super unless int?
  value.to_i
end

#to_s(opts = {}) ⇒ String

Returns The CSS representation of this number

Returns:

  • (String)

    The CSS representation of this number

Raises:

  • (Sass::SyntaxError)

    if this number has units that can't be used in CSS (e.g. px*in)


261
262
263
264
265
# 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

#unary_minusNumber

The SassScript unary - operation (e.g. -$a).

Returns:

  • (Number)

    The negative value of this number


124
125
126
# File 'lib/sass/script/value/number.rb', line 124

def unary_minus
  Number.new(-value, @numerator_units, @denominator_units)
end

#unary_plusNumber

The SassScript unary + operation (e.g. +$a).

Returns:

  • (Number)

    The value of this number


117
118
119
# File 'lib/sass/script/value/number.rb', line 117

def unary_plus
  self
end

#unit_strString

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

Returns:

  • (String)

    a string that represents the units in this number


367
368
369
370
371
372
373
374
# 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

#unitless?Boolean

Returns Whether or not this number has no units.

Returns:

  • (Boolean)

    Whether or not this number has no units.


301
302
303
# File 'lib/sass/script/value/number.rb', line 301

def unitless?
  @numerator_units.empty? && @denominator_units.empty?
end