Class: Sass::Script::Literal
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.
Instance Attribute Summary collapse
-
#value ⇒ Object
readonly
Returns the Ruby value of the literal.
Attributes inherited from Node
Instance Method Summary collapse
-
#==(other) ⇒ Boolean
Compares this object with another.
-
#_perform(environment) ⇒ Literal
protected
Evaluates the literal.
- #assert_int!
-
#children ⇒ Array<Node>
Returns an empty array.
-
#comma(other) ⇒ Script::String
The SassScript
,
operation (e.g.$a, $b
,"foo", "bar"
). - #deep_copy
-
#div(other) ⇒ Script::String
The SassScript
/
operation. -
#eq(other) ⇒ Bool
The SassScript
==
operation. -
#initialize(value = nil) ⇒ Literal
constructor
Creates a new literal.
-
#inspect ⇒ String
A readable representation of the literal.
-
#minus(other) ⇒ Script::String
The SassScript
-
operation. -
#neq(other) ⇒ Bool
The SassScript
!=
operation. -
#options ⇒ {Symbol => Object}
Returns the options hash for this node.
-
#plus(other) ⇒ Script::String
The SassScript
+
operation. -
#single_eq(other) ⇒ Script::String
The SassScript
=
operation (used for proprietary MS syntax likealpha(opacity=20)
). -
#space(other) ⇒ Script::String
The SassScript default operation (e.g.
$a $b
,"foo" "bar"
). -
#to_a ⇒ Array<Literal>
Returns the value of this literal as a list.
-
#to_bool ⇒ Boolean
true
(the Ruby boolean value). -
#to_i ⇒ Fixnum
The integer value of this literal.
-
#to_s(opts = {}) ⇒ String
(also: #to_sass)
Returns the string representation of this literal as it would be output to the CSS document.
-
#unary_div ⇒ Script::String
The SassScript unary
/
operation (e.g./$a
). -
#unary_minus ⇒ Script::String
The SassScript unary
-
operation (e.g.-$a
). -
#unary_not ⇒ Bool
The SassScript
==
operation. -
#unary_plus ⇒ Script::String
The SassScript unary
+
operation (e.g.+$a
).
Methods inherited from Node
Constructor Details
#initialize(value = nil) ⇒ Literal
Creates a new literal.
23 24 25 26 |
# File 'lib/sass/script/literal.rb', line 23
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.
18 19 20 |
# File 'lib/sass/script/literal.rb', line 18
def value
@value
end
|
Instance Method Details
#==(other) ⇒ Boolean
Compares this object with another.
190 191 192 |
# File 'lib/sass/script/literal.rb', line 190
def ==(other)
eq(other).to_bool
end
|
#_perform(environment) ⇒ Literal (protected)
Evaluates the literal.
226 227 228 |
# File 'lib/sass/script/literal.rb', line 226
def _perform(environment)
self
end
|
#assert_int!
201 |
# File 'lib/sass/script/literal.rb', line 201
def assert_int!; to_i; end
|
#children ⇒ Array<Node>
Returns an empty array.
32 33 34 |
# File 'lib/sass/script/literal.rb', line 32
def children
[]
end
|
#comma(other) ⇒ Script::String
The SassScript ,
operation (e.g. $a, $b
, "foo", "bar"
).
105 106 107 |
# File 'lib/sass/script/literal.rb', line 105
def comma(other)
Sass::Script::String.new("#{self.to_s},#{' ' unless options[:style] == :compressed}#{other.to_s}")
end
|
#deep_copy
37 38 39 |
# File 'lib/sass/script/literal.rb', line 37
def deep_copy
dup
end
|
#div(other) ⇒ Script::String
The SassScript /
operation.
145 146 147 |
# File 'lib/sass/script/literal.rb', line 145
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.
65 66 67 |
# File 'lib/sass/script/literal.rb', line 65
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.
177 178 179 |
# File 'lib/sass/script/literal.rb', line 177
def inspect
value.inspect
end
|
#minus(other) ⇒ Script::String
The SassScript -
operation.
136 137 138 |
# File 'lib/sass/script/literal.rb', line 136
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.
76 77 78 |
# File 'lib/sass/script/literal.rb', line 76
def neq(other)
Sass::Script::Bool.new(!eq(other).to_bool)
end
|
#options ⇒ {Symbol => Object}
Returns the options hash for this node.
47 48 49 50 51 52 53 54 55 56 |
# File 'lib/sass/script/literal.rb', line 47
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
|
#plus(other) ⇒ Script::String
The SassScript +
operation.
124 125 126 127 128 129 |
# File 'lib/sass/script/literal.rb', line 124
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)
).
115 116 117 |
# File 'lib/sass/script/literal.rb', line 115
def single_eq(other)
Sass::Script::String.new("#{self.to_s}=#{other.to_s}")
end
|
#space(other) ⇒ Script::String
The SassScript default operation (e.g. $a $b
, "foo" "bar"
).
96 97 98 |
# File 'lib/sass/script/literal.rb', line 96
def space(other)
Sass::Script::String.new("#{self.to_s} #{other.to_s}")
end
|
#to_a ⇒ Array<Literal>
Returns the value of this literal as a list. Single literals are considered the same as single-element lists.
207 208 209 |
# File 'lib/sass/script/literal.rb', line 207
def to_a
[self]
end
|
#to_bool ⇒ Boolean
Returns true
(the Ruby boolean value).
182 183 184 |
# File 'lib/sass/script/literal.rb', line 182
def to_bool
true
end
|
#to_i ⇒ Fixnum
Returns The integer value of this literal.
196 197 198 |
# File 'lib/sass/script/literal.rb', line 196
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.
215 216 217 |
# File 'lib/sass/script/literal.rb', line 215
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
).
172 173 174 |
# File 'lib/sass/script/literal.rb', line 172
def unary_div
Sass::Script::String.new("/#{self.to_s}")
end
|
#unary_minus ⇒ Script::String
The SassScript unary -
operation (e.g. -$a
).
163 164 165 |
# File 'lib/sass/script/literal.rb', line 163
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.
87 88 89 |
# File 'lib/sass/script/literal.rb', line 87
def unary_not
Sass::Script::Bool.new(!to_bool)
end
|
#unary_plus ⇒ Script::String
The SassScript unary +
operation (e.g. +$a
).
154 155 156 |
# File 'lib/sass/script/literal.rb', line 154
def unary_plus
Sass::Script::String.new("+#{self.to_s}")
end
|