Class: Sass::Script::Literal

Inherits:
Node
  • Object
show all
Defined in:
lib/sass/script/literal.rb

Overview

The abstract superclass for SassScript objects.

Many of these methods, especially the ones that correspond to SassScript operations, are designed to be overridden by subclasses which may change the semantics somewhat. The operations listed here are just the defaults.

Direct Known Subclasses

Bool, Color, Number, String

Instance Attribute Summary collapse

Attributes inherited from Node

#context, #line

Instance Method Summary collapse

Methods inherited from Node

#dasherize, #perform

Constructor Details

#initialize(value = nil) ⇒ Literal

Creates a new literal.

Parameters:

  • value (Object) (defaults to: nil) —

    The object for #value



22
23
24
25
 
# File 'lib/sass/script/literal.rb', line 22

def initialize(value = nil)
  @value = value
  super()
end

Instance Attribute Details

#value ⇒ Object (readonly)

Returns the Ruby value of the literal. The type of this value varies based on the subclass.

Returns:

  • (Object) 


17
18
19
 
# File 'lib/sass/script/literal.rb', line 17

def value
  @value
end

Instance Method Details

#==(other) ⇒ Boolean

Compares this object with another.

Parameters:

  • other (Object) —

    The object to compare with

Returns:

  • (Boolean) —

    Whether or not this literal is equivalent to other



204
205
206
 
# File 'lib/sass/script/literal.rb', line 204

def ==(other)
  eq(other).to_bool
end

#_perform(environment) ⇒ Literal (protected)

Evaluates the literal.

Parameters:

  • environment (Sass::Environment) —

    The environment in which to evaluate the SassScript

Returns:



232
233
234
 
# File 'lib/sass/script/literal.rb', line 232

def _perform(environment)
  self
end

#and(other) ⇒ Literal

The SassScript and operation.

Parameters:

  • other (Literal) —

    The right-hand side of the operator

Returns:

  • (Literal) —

    The result of a logical and: other if this literal isn't a false Bool, and this literal otherwise



58
59
60
 
# File 'lib/sass/script/literal.rb', line 58

def and(other)
  to_bool ? other : self
end

#assert_int!

Raises:



215
 
# File 'lib/sass/script/literal.rb', line 215

def assert_int!; to_i; end

#children ⇒ Array<Node>

Returns an empty array.

Returns:

  • (Array<Node>) —

    empty

See Also:



31
32
33
 
# File 'lib/sass/script/literal.rb', line 31

def children
  []
end

#comma(other) ⇒ Script::String

The SassScript , operation (e.g. $a, $b, "foo", "bar").

Parameters:

  • other (Literal) —

    The right-hand side of the operator

Returns:

  • (Script::String) —

    A string containing both literals separated by ", "



119
120
121
 
# File 'lib/sass/script/literal.rb', line 119

def comma(other)
  Sass::Script::String.new("#{self.to_s}, #{other.to_s}")
end

#concat(other) ⇒ Script::String

The SassScript default operation (e.g. $a $b, "foo" "bar").

Parameters:

  • other (Literal) —

    The right-hand side of the operator

Returns:

  • (Script::String) —

    A string containing both literals separated by a space



110
111
112
 
# File 'lib/sass/script/literal.rb', line 110

def concat(other)
  Sass::Script::String.new("#{self.to_s} #{other.to_s}")
end

#div(other) ⇒ Script::String

The SassScript / operation.

Parameters:

  • other (Literal) —

    The right-hand side of the operator

Returns:

  • (Script::String) —

    A string containing both literals separated by "/"



159
160
161
 
# File 'lib/sass/script/literal.rb', line 159

def div(other)
  Sass::Script::String.new("#{self.to_s}/#{other.to_s}")
end

#eq(other) ⇒ Bool

The SassScript == operation. Note that this returns a Bool object, not a Ruby boolean.

Parameters:

  • other (Literal) —

    The right-hand side of the operator

Returns:

  • (Bool) —

    True if this literal is the same as the other, false otherwise



79
80
81
 
# File 'lib/sass/script/literal.rb', line 79

def eq(other)
  Sass::Script::Bool.new(self.class == other.class && self.value == other.value)
end

#inspect ⇒ String

Returns A readable representation of the literal.

Returns:

  • (String) —

    A readable representation of the literal



191
192
193
 
# File 'lib/sass/script/literal.rb', line 191

def inspect
  value.inspect
end

#minus(other) ⇒ Script::String

The SassScript - operation.

Parameters:

  • other (Literal) —

    The right-hand side of the operator

Returns:

  • (Script::String) —

    A string containing both literals separated by "-"



150
151
152
 
# File 'lib/sass/script/literal.rb', line 150

def minus(other)
  Sass::Script::String.new("#{self.to_s}-#{other.to_s}")
end

#neq(other) ⇒ Bool

The SassScript != operation. Note that this returns a Bool object, not a Ruby boolean.

Parameters:

  • other (Literal) —

    The right-hand side of the operator

Returns:

  • (Bool) —

    False if this literal is the same as the other, true otherwise



90
91
92
 
# File 'lib/sass/script/literal.rb', line 90

def neq(other)
  Sass::Script::Bool.new(!eq(other).to_bool)
end

#options ⇒ {Symbol => Object}

Returns the options hash for this node.

Returns:

  • ({Symbol => Object})

Raises:

  • (Sass::SyntaxError) —

    if the options hash hasn't been set. This should only happen when the literal was created outside of the parser and #to_s was called on it



41
42
43
44
45
46
47
48
49
50
 
# File 'lib/sass/script/literal.rb', line 41

def options
  opts = super
  return opts if opts
  raise Sass::SyntaxError.new(<<MSG)
The #options attribute is not set on this #{self.class}.
  This error is probably occurring because #to_s was called
  on this literal within a custom Sass function without first
  setting the #option attribute.
MSG
end

#or(other) ⇒ Literal

The SassScript or operation.

Parameters:

  • other (Literal) —

    The right-hand side of the operator

Returns:

  • (Literal) —

    The result of the logical or: this literal if it isn't a false Bool, and other otherwise



68
69
70
 
# File 'lib/sass/script/literal.rb', line 68

def or(other)
  to_bool ? self : other
end

#plus(other) ⇒ Script::String

The SassScript + operation.

Parameters:

  • other (Literal) —

    The right-hand side of the operator

Returns:

  • (Script::String) —

    A string containing both literals without any separation



138
139
140
141
142
143
 
# File 'lib/sass/script/literal.rb', line 138

def plus(other)
  if other.is_a?(Sass::Script::String)
    return Sass::Script::String.new(self.to_s + other.value, other.type)
  end
  Sass::Script::String.new(self.to_s + other.to_s)
end

#single_eq(other) ⇒ Script::String

The SassScript = operation (used for proprietary MS syntax like alpha(opacity=20)).

Parameters:

  • other (Literal) —

    The right-hand side of the operator

Returns:

  • (Script::String) —

    A string containing both literals separated by "="



129
130
131
 
# File 'lib/sass/script/literal.rb', line 129

def single_eq(other)
  Sass::Script::String.new("#{self.to_s}=#{other.to_s}")
end

#to_bool ⇒ Boolean

Returns true (the Ruby boolean value).

Returns:

  • (Boolean) —

    true (the Ruby boolean value)



196
197
198
 
# File 'lib/sass/script/literal.rb', line 196

def to_bool
  true
end

#to_i ⇒ Fixnum

Returns The integer value of this literal.

Returns:

  • (Fixnum) —

    The integer value of this literal

Raises:



210
211
212
 
# File 'lib/sass/script/literal.rb', line 210

def to_i
  raise Sass::SyntaxError.new("#{self.inspect} is not an integer.")
end

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

Returns the string representation of this literal as it would be output to the CSS document.

Returns:

Raises:



221
222
223
 
# File 'lib/sass/script/literal.rb', line 221

def to_s(opts = {})
  raise Sass::SyntaxError.new("[BUG] All subclasses of Sass::Literal must implement #to_s.")
end

#unary_div ⇒ Script::String

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

Parameters:

  • other (Literal) —

    The right-hand side of the operator

Returns:

  • (Script::String) —

    A string containing the literal preceded by "/"



186
187
188
 
# File 'lib/sass/script/literal.rb', line 186

def unary_div
  Sass::Script::String.new("/#{self.to_s}")
end

#unary_minus ⇒ Script::String

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

Parameters:

  • other (Literal) —

    The right-hand side of the operator

Returns:

  • (Script::String) —

    A string containing the literal preceded by "-"



177
178
179
 
# File 'lib/sass/script/literal.rb', line 177

def unary_minus
  Sass::Script::String.new("-#{self.to_s}")
end

#unary_not ⇒ Bool

The SassScript == operation. Note that this returns a Bool object, not a Ruby boolean.

Parameters:

  • other (Literal) —

    The right-hand side of the operator

Returns:

  • (Bool) —

    True if this literal is the same as the other, false otherwise



101
102
103
 
# File 'lib/sass/script/literal.rb', line 101

def unary_not
  Sass::Script::Bool.new(!to_bool)
end

#unary_plus ⇒ Script::String

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

Parameters:

  • other (Literal) —

    The right-hand side of the operator

Returns:

  • (Script::String) —

    A string containing the literal preceded by "+"



168
169
170
 
# File 'lib/sass/script/literal.rb', line 168

def unary_plus
  Sass::Script::String.new("+#{self.to_s}")
end