Module: Haml::Util
- Extended by:
- Util
- Included in:
- Buffer, Compiler, Parser, Plugin, Util, Version
- Defined in:
- /build/buildd/ruby-haml-3.1.4/lib/haml/util.rb
Overview
A module containing various useful functions.
Defined Under Namespace
Classes: StaticConditionalContext
Constant Summary
- RUBY_VERSION =
An array of ints representing the Ruby version number.
::RUBY_VERSION.split(".").map {
- RUBY_ENGINE =
The Ruby engine we’re running under. Defaults to
"ruby"
if the top-level constant is undefined. defined?(::RUBY_ENGINE) ? ::RUBY_ENGINE : "ruby"
Instance Method Summary (collapse)
-
- abstract(obj)
Throws a NotImplementedError for an abstract method.
-
- (Boolean) ap_geq?(version)
Returns whether this environment is using ActionPack of a version greater than or equal to that specified.
-
- (Boolean) ap_geq_3?
Returns whether this environment is using ActionPack version 3.0.0 or greater.
-
- assert_html_safe!(text)
Assert that a given object (usually a String) is HTML safe according to Rails’ XSS handling, if it’s loaded.
-
- av_template_class(name)
Returns an ActionView::Template* class.
-
- ([String, Fixnum, (String, nil)]) caller_info(entry = caller[1])
Returns information about the caller of the previous method.
-
- (String) check_encoding(str) {|msg| ... }
Checks that the encoding of a string is valid in Ruby 1.9 and cleans up potential encoding gotchas like the UTF-8 BOM.
-
- (String) check_haml_encoding(str) {|msg| ... }
Like #check_encoding, but also checks for a Ruby-style
-# coding:
comment at the beginning of the template and uses that encoding if it exists. -
- def_static_method(klass, name, args, *vars, erb)
This is used for methods in Buffer that need to be very fast, and take a lot of boolean parameters that are known at compile-time.
-
- (String) dump(obj)
A wrapper for
Marshal.dump
that calls#_before_dump
on the object before dumping it,#_after_dump
afterwards. -
- (Enumerator) enum_cons(enum, n)
A version of
Enumerable#enum_cons
that works in Ruby 1.8 and 1.9. -
- (Enumerator) enum_slice(enum, n)
A version of
Enumerable#enum_slice
that works in Ruby 1.8 and 1.9. -
- (Enumerator) enum_with_index(enum)
A version of
Enumerable#enum_with_index
that works in Ruby 1.8 and 1.9. -
- (Array) flatten(arr, n)
Flattens the first
n
nested arrays in a cross-version manner. -
- haml_warn(msg)
The same as
Kernel#warn
, but is silenced by #silence_haml_warnings. -
- (Boolean) has?(attr, klass, method)
Checks to see if a class has a given method.
-
- (String?) html_safe(text)
Returns the given text, marked as being HTML-safe.
-
- (String) inspect_obj(obj)
Like
Object#inspect
, but preserves non-ASCII characters rather than escaping them under Ruby 1.9.2. -
- (Array) intersperse(enum, val)
Intersperses a value in an enumerable, as would be done with
Array#join
but without concatenating the array together afterwards. -
- (Boolean) ironruby?
Whether or not this is running on IronRuby.
-
- (Array) lcs(x, y) {|a, b| ... }
Computes a single longest common subsequence for
x
andy
. -
- (Object) load(data)
A wrapper for
Marshal.load
that calls#_after_load
on the object after loading it, if it’s defined. -
- (Hash) map_hash(hash) {|key, value| ... }
Maps the key-value pairs of a hash according to a block.
-
- (Hash) map_keys(hash) {|key| ... }
Maps the keys in a hash according to a block.
-
- (Hash) map_vals(hash) {|value| ... }
Maps the values in a hash according to a block.
-
- (Array) merge_adjacent_strings(arr)
Concatenates all strings that are adjacent in an array, while leaving other elements as they are.
-
- (Fixnum) ord(c)
Returns the ASCII code of the given character.
-
- (Array<Arrays>) paths(arrs)
Return an array of all possible paths through the given arrays.
-
- (Set<Set>) powerset(arr)
Computes the powerset of the given array.
-
- (String?) rails_env
Returns the environment of the Rails application, if this is running in a Rails context.
-
- (String?) rails_root
Returns the root of the Rails application, if this is running in a Rails context.
-
- (Class) rails_safe_buffer_class
The class for the Rails SafeBuffer XSS protection class.
-
- (Boolean) rails_xss_safe?
Whether or not ActionView’s XSS protection is available and enabled, as is the default for Rails 3.0+, and optional for version 2.3.5+.
-
- (Numeric) restrict(value, range)
Restricts a number to falling within a given range.
-
- (Boolean) ruby1_8?
Whether or not this is running under Ruby 1.8 or lower.
-
- (Boolean) ruby1_8_6?
Whether or not this is running under Ruby 1.8.6 or lower.
-
- (String) scope(file)
Returns the path of a file relative to the Haml root directory.
-
- (Boolean) set_eql?(set1, set2)
Tests the hash-equality of two sets in a cross-version manner.
-
- (Fixnum) set_hash(set)
Returns the hash code for a set in a cross-version manner.
-
- silence_haml_warnings { ... }
Silences all Haml warnings within a block.
-
- silence_warnings { ... }
Silence all output to STDERR within a block.
-
- (String) static_method_name(name, *vars)
Computes the name for a method defined via #def_static_method.
-
- (Array) strip_string_array(arr)
Destructively strips whitespace from the beginning and end of the first and last elements, respectively, in the array (if those elements are strings).
-
- substitute(ary, from, to)
Substitutes a sub-array of one array with another sub-array.
-
- (Hash) to_hash(arr)
Converts an array of
[key, value]
pairs to a hash. -
- (Boolean) try_sass
Try loading Sass.
-
- (Boolean) version_geq(v1, v2)
Returns whether one version string represents the same or a more recent version than another.
-
- (Boolean) version_gt(v1, v2)
Returns whether one version string represents a more recent version than another.
-
- (Boolean) windows?
Whether or not this is running on Windows.
Instance Method Details
- abstract(obj)
Throws a NotImplementedError for an abstract method.
305 306 307 |
# File '/build/buildd/ruby-haml-3.1.4/lib/haml/util.rb', line 305
def abstract(obj)
raise NotImplementedError.new("#{obj.class} must implement ##{caller_info[2]}")
end
|
- (Boolean) ap_geq?(version)
Returns whether this environment is using ActionPack of a version greater than or equal to that specified.
411 412 413 414 415 416 417 |
# File '/build/buildd/ruby-haml-3.1.4/lib/haml/util.rb', line 411
def ap_geq?(version)
# The ActionPack module is always loaded automatically in Rails >= 3
return false unless defined?(ActionPack) && defined?(ActionPack::VERSION) &&
defined?(ActionPack::VERSION::STRING)
version_geq(ActionPack::VERSION::STRING, version)
end
|
- (Boolean) ap_geq_3?
Returns whether this environment is using ActionPack version 3.0.0 or greater.
400 401 402 |
# File '/build/buildd/ruby-haml-3.1.4/lib/haml/util.rb', line 400
def ap_geq_3?
ap_geq?("3.0.0.beta1")
end
|
- assert_html_safe!(text)
Assert that a given object (usually a String) is HTML safe according to Rails’ XSS handling, if it’s loaded.
459 460 461 462 |
# File '/build/buildd/ruby-haml-3.1.4/lib/haml/util.rb', line 459
def assert_html_safe!(text)
return unless rails_xss_safe? && text && !text.to_s.html_safe?
raise Haml::Error.new("Expected #{text.inspect} to be HTML-safe.")
end
|
- av_template_class(name)
Returns an ActionView::Template* class. In pre-3.0 versions of Rails, most of these classes were of the form ActionView::TemplateFoo
, while afterwards they were of the form ActionView;:Template::Foo
.
427 428 429 430 |
# File '/build/buildd/ruby-haml-3.1.4/lib/haml/util.rb', line 427
def av_template_class(name)
return ActionView.const_get("Template#{name}") if ActionView.const_defined?("Template#{name}")
return ActionView::Template.const_get(name.to_s)
end
|
- ([String, Fixnum, (String, nil)]) caller_info(entry = caller[1])
Returns information about the caller of the previous method.
226 227 228 229 230 231 232 |
# File '/build/buildd/ruby-haml-3.1.4/lib/haml/util.rb', line 226
def caller_info(entry = caller[1])
info = entry.scan(/^(.*?):(-?.*?)(?::.*`(.+)')?$/).first
info[1] = info[1].to_i
# This is added by Rubinius to designate a block, but we don't care about it.
info[2].sub!(/ \{\}\Z/, '') if info[2]
info
end
|
- (String) check_encoding(str) {|msg| ... }
Checks that the encoding of a string is valid in Ruby 1.9 and cleans up potential encoding gotchas like the UTF-8 BOM. If it’s not, yields an error string describing the invalid character and the line on which it occurrs.
524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 |
# File '/build/buildd/ruby-haml-3.1.4/lib/haml/util.rb', line 524
def check_encoding(str)
if ruby1_8?
return str.gsub(/\A\xEF\xBB\xBF/, '') # Get rid of the UTF-8 BOM
elsif str.valid_encoding?
# Get rid of the Unicode BOM if possible
if str.encoding.name =~ /^UTF-(8|16|32)(BE|LE)?$/
return str.gsub(Regexp.new("\\A\uFEFF".encode(str.encoding.name)), '')
else
return str
end
end
encoding = str.encoding
newlines = Regexp.new("\r\n|\r|\n".encode(encoding).force_encoding("binary"))
str.force_encoding("binary").split(newlines).each_with_index do |line, i|
begin
line.encode(encoding)
rescue Encoding::UndefinedConversionError => e
yield <<MSG.rstrip, i + 1
Invalid #{encoding.name} character #{e.error_char.dump}
MSG
end
end
return str
end
|
- (String) check_haml_encoding(str) {|msg| ... }
Like #check_encoding, but also checks for a Ruby-style -# coding:
comment at the beginning of the template and uses that encoding if it exists.
The Haml encoding rules are simple. If a -# coding:
comment exists, we assume that that’s the original encoding of the document. Otherwise, we use whatever encoding Ruby has.
Haml uses the same rules for parsing coding comments as Ruby. This means that it can understand Emacs-style comments (e.g. -*- encoding: "utf-8" -*-
), and also that it cannot understand non-ASCII-compatible encodings such as UTF-16
and UTF-32
.
570 571 572 573 574 575 576 577 578 579 580 |
# File '/build/buildd/ruby-haml-3.1.4/lib/haml/util.rb', line 570
def check_haml_encoding(str, &block)
return check_encoding(str, &block) if ruby1_8?
str = str.dup if str.frozen?
bom, encoding = parse_haml_magic_comment(str)
if encoding; str.force_encoding(encoding)
elsif bom; str.force_encoding("UTF-8")
end
return check_encoding(str, &block)
end
|
- def_static_method(klass, name, args, *vars, erb)
This is used for methods in Buffer that need to be very fast, and take a lot of boolean parameters that are known at compile-time. Instead of passing the parameters in normally, a separate method is defined for every possible combination of those parameters; these are then called using #static_method_name.
To define a static method, an ERB template for the method is provided. All conditionals based on the static parameters are done as embedded Ruby within this template. For example:
def_static_method(Foo, :my_static_method, [:foo, :bar], :baz, :bang, <<RUBY) <% if baz && bang %> return foo + bar <% elsif baz || bang %> return foo - bar <% else %> return 17 <% end %> RUBY
#static_method_name can be used to call static methods.
757 758 759 760 761 762 763 764 |
# File '/build/buildd/ruby-haml-3.1.4/lib/haml/util.rb', line 757
def def_static_method(klass, name, args, *vars)
erb = vars.pop
info = caller_info
powerset(vars).each do |set|
context = StaticConditionalContext.new(set).instance_eval {binding}
klass.class_eval("def \#{static_method_name(name, *vars.map {|v| set.include?(v)})}(\#{args.join(', ')})\n \#{ERB.new(erb).result(context)}\nend\n", info[0], info[1])
end
end
|
- (String) dump(obj)
A wrapper for Marshal.dump
that calls #_before_dump
on the object before dumping it, #_after_dump
afterwards. It also calls #_around_dump
and passes it a block in which the object is dumped.
If any of these methods are undefined, they are not called.
280 281 282 283 284 285 286 287 288 |
# File '/build/buildd/ruby-haml-3.1.4/lib/haml/util.rb', line 280
def dump(obj)
obj._before_dump if obj.respond_to?(:_before_dump)
return Marshal.dump(obj) unless obj.respond_to?(:_around_dump)
res = nil
obj._around_dump {res = Marshal.dump(obj)}
res
ensure
obj._after_dump if obj.respond_to?(:_after_dump)
end
|
- (Enumerator) enum_cons(enum, n)
A version of Enumerable#enum_cons
that works in Ruby 1.8 and 1.9.
640 641 642 |
# File '/build/buildd/ruby-haml-3.1.4/lib/haml/util.rb', line 640
def enum_cons(enum, n)
ruby1_8? ? enum.enum_cons(n) : enum.each_cons(n)
end
|
- (Enumerator) enum_slice(enum, n)
A version of Enumerable#enum_slice
that works in Ruby 1.8 and 1.9.
649 650 651 |
# File '/build/buildd/ruby-haml-3.1.4/lib/haml/util.rb', line 649
def enum_slice(enum, n)
ruby1_8? ? enum.enum_slice(n) : enum.each_slice(n)
end
|
- (Enumerator) enum_with_index(enum)
A version of Enumerable#enum_with_index
that works in Ruby 1.8 and 1.9.
631 632 633 |
# File '/build/buildd/ruby-haml-3.1.4/lib/haml/util.rb', line 631
def enum_with_index(enum)
ruby1_8? ? enum.enum_with_index : enum.each_with_index
end
|
- (Array) flatten(arr, n)
Flattens the first n
nested arrays in a cross-version manner.
666 667 668 669 670 |
# File '/build/buildd/ruby-haml-3.1.4/lib/haml/util.rb', line 666
def flatten(arr, n)
return arr.flatten(n) unless ruby1_8_6?
return arr if n == 0
arr.inject([]) {|res, e| e.is_a?(Array) ? res.concat(flatten(e, n - 1)) : res << e}
end
|
- haml_warn(msg)
The same as Kernel#warn
, but is silenced by #silence_haml_warnings.
334 335 336 337 |
# File '/build/buildd/ruby-haml-3.1.4/lib/haml/util.rb', line 334
def haml_warn(msg)
return if @@silence_warnings
warn(msg)
end
|
- (Boolean) has?(attr, klass, method)
Checks to see if a class has a given method. For example:
Haml::Util.has?(:public_instance_method, String, :gsub) #=> true
Method collections like Class#instance_methods
return strings in Ruby 1.8 and symbols in Ruby 1.9 and on, so this handles checking for them in a compatible way.
623 624 625 |
# File '/build/buildd/ruby-haml-3.1.4/lib/haml/util.rb', line 623
def has?(attr, klass, method)
klass.send("#{attr}s").include?(ruby1_8? ? method.to_s : method.to_sym)
end
|
- (String?) html_safe(text)
Returns the given text, marked as being HTML-safe. With older versions of the Rails XSS-safety mechanism, this destructively modifies the HTML-safety of text
.
449 450 451 452 453 |
# File '/build/buildd/ruby-haml-3.1.4/lib/haml/util.rb', line 449
def html_safe(text)
return unless text
return text.html_safe if defined?(ActiveSupport::SafeBuffer)
text.html_safe!
end
|
- (String) inspect_obj(obj)
Like Object#inspect
, but preserves non-ASCII characters rather than escaping them under Ruby 1.9.2. This is necessary so that the precompiled Haml template can be #encode
d into @options[:encoding]
before being evaluated.
699 700 701 702 703 704 |
# File '/build/buildd/ruby-haml-3.1.4/lib/haml/util.rb', line 699
def inspect_obj(obj)
return obj.inspect unless version_geq(::RUBY_VERSION, "1.9.2")
return ':' + inspect_obj(obj.to_s) if obj.is_a?(Symbol)
return obj.inspect unless obj.is_a?(String)
'"' + obj.gsub(/[\x00-\x7F]+/) {|s| s.inspect[1...-1]} + '"'
end
|
- (Array) intersperse(enum, val)
Intersperses a value in an enumerable, as would be done with Array#join
but without concatenating the array together afterwards.
153 154 155 |
# File '/build/buildd/ruby-haml-3.1.4/lib/haml/util.rb', line 153
def intersperse(enum, val)
enum.inject([]) {|a, e| a << e << val}[0...-1]
end
|
- (Boolean) ironruby?
Whether or not this is running on IronRuby.
488 489 490 |
# File '/build/buildd/ruby-haml-3.1.4/lib/haml/util.rb', line 488
def ironruby?
RUBY_ENGINE == "ironruby"
end
|
- (Array) lcs(x, y) {|a, b| ... }
Computes a single longest common subsequence for x
and y
. If there are more than one longest common subsequences, the one returned is that which starts first in x
.
214 215 216 217 218 219 |
# File '/build/buildd/ruby-haml-3.1.4/lib/haml/util.rb', line 214
def lcs(x, y, &block)
x = [nil, *x]
y = [nil, *y]
block ||= proc {|a, b| a == b && a}
lcs_backtrace(lcs_table(x, y, &block), x, y, x.size-1, y.size-1, &block)
end
|
- (Object) load(data)
A wrapper for Marshal.load
that calls #_after_load
on the object after loading it, if it’s defined.
295 296 297 298 299 |
# File '/build/buildd/ruby-haml-3.1.4/lib/haml/util.rb', line 295
def load(data)
obj = Marshal.load(data)
obj._after_load if obj.respond_to?(:_after_load)
obj
end
|
- (Hash) map_hash(hash) {|key, value| ... }
Maps the key-value pairs of a hash according to a block.
88 89 90 |
# File '/build/buildd/ruby-haml-3.1.4/lib/haml/util.rb', line 88
def map_hash(hash, &block)
to_hash(hash.map(&block))
end
|
- (Hash) map_keys(hash) {|key| ... }
Maps the keys in a hash according to a block.
55 56 57 |
# File '/build/buildd/ruby-haml-3.1.4/lib/haml/util.rb', line 55
def map_keys(hash)
to_hash(hash.map {|k, v| [yield(k), v]})
end
|
- (Hash) map_vals(hash) {|value| ... }
Maps the values in a hash according to a block.
71 72 73 |
# File '/build/buildd/ruby-haml-3.1.4/lib/haml/util.rb', line 71
def map_vals(hash)
to_hash(hash.map {|k, v| [k, yield(v)]})
end
|
- (Array) merge_adjacent_strings(arr)
Concatenates all strings that are adjacent in an array, while leaving other elements as they are.
130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 |
# File '/build/buildd/ruby-haml-3.1.4/lib/haml/util.rb', line 130
def merge_adjacent_strings(arr)
# Optimize for the common case of one element
return arr if arr.size < 2
arr.inject([]) do |a, e|
if e.is_a?(String)
if a.last.is_a?(String)
a.last << e
else
a << e.dup
end
else
a << e
end
a
end
end
|
- (Fixnum) ord(c)
Returns the ASCII code of the given character.
657 658 659 |
# File '/build/buildd/ruby-haml-3.1.4/lib/haml/util.rb', line 657
def ord(c)
ruby1_8? ? c[0] : c.ord
end
|
- (Array<Arrays>) paths(arrs)
Return an array of all possible paths through the given arrays.
197 198 199 200 201 |
# File '/build/buildd/ruby-haml-3.1.4/lib/haml/util.rb', line 197
def paths(arrs)
arrs.inject([[]]) do |paths, arr|
flatten(arr.map {|e| paths.map {|path| path + [e]}}, 1)
end
end
|
- (Set<Set>) powerset(arr)
Computes the powerset of the given array. This is the set of all subsets of the array.
100 101 102 103 104 105 106 107 108 109 |
# File '/build/buildd/ruby-haml-3.1.4/lib/haml/util.rb', line 100
def powerset(arr)
arr.inject([Set.new].to_set) do |powerset, el|
new_powerset = Set.new
powerset.each do |subset|
new_powerset << subset
new_powerset << subset + [el]
end
new_powerset
end
end
|
- (String?) rails_env
Returns the environment of the Rails application, if this is running in a Rails context. Returns nil
if no such environment is defined.
390 391 392 393 394 |
# File '/build/buildd/ruby-haml-3.1.4/lib/haml/util.rb', line 390
def rails_env
return ::Rails.env.to_s if defined?(::Rails.env)
return RAILS_ENV.to_s if defined?(RAILS_ENV)
return nil
end
|
- (String?) rails_root
Returns the root of the Rails application, if this is running in a Rails context. Returns nil
if no such root is defined.
376 377 378 379 380 381 382 383 |
# File '/build/buildd/ruby-haml-3.1.4/lib/haml/util.rb', line 376
def rails_root
if defined?(::Rails.root)
return ::Rails.root.to_s if ::Rails.root
raise "ERROR: Rails.root is nil!"
end
return RAILS_ROOT.to_s if defined?(RAILS_ROOT)
return nil
end
|
- (Class) rails_safe_buffer_class
The class for the Rails SafeBuffer XSS protection class. This varies depending on Rails version.
468 469 470 471 472 473 474 |
# File '/build/buildd/ruby-haml-3.1.4/lib/haml/util.rb', line 468
def rails_safe_buffer_class
# It's important that we check ActiveSupport first,
# because in Rails 2.3.6 ActionView::SafeBuffer exists
# but is a deprecated proxy object.
return ActiveSupport::SafeBuffer if defined?(ActiveSupport::SafeBuffer)
return ActionView::SafeBuffer
end
|
- (Boolean) rails_xss_safe?
Whether or not ActionView’s XSS protection is available and enabled, as is the default for Rails 3.0+, and optional for version 2.3.5+. Overridden in haml/template.rb if this is the case.
439 440 441 |
# File '/build/buildd/ruby-haml-3.1.4/lib/haml/util.rb', line 439
def rails_xss_safe?
false
end
|
- (Numeric) restrict(value, range)
Restricts a number to falling within a given range. Returns the number if it falls within the range, or the closest value in the range if it doesn’t.
118 119 120 |
# File '/build/buildd/ruby-haml-3.1.4/lib/haml/util.rb', line 118
def restrict(value, range)
[[value, range.first].max, range.last].min
end
|
- (Boolean) ruby1_8?
Whether or not this is running under Ruby 1.8 or lower.
Note that IronRuby counts as Ruby 1.8, because it doesn’t support the Ruby 1.9 encoding API.
500 501 502 503 504 |
# File '/build/buildd/ruby-haml-3.1.4/lib/haml/util.rb', line 500
def ruby1_8?
# IronRuby says its version is 1.9, but doesn't support any of the encoding APIs.
# We have to fall back to 1.8 behavior.
ironruby? || (Haml::Util::RUBY_VERSION[0] == 1 && Haml::Util::RUBY_VERSION[1] < 9)
end
|
- (Boolean) ruby1_8_6?
Whether or not this is running under Ruby 1.8.6 or lower. Note that lower versions are not officially supported.
510 511 512 |
# File '/build/buildd/ruby-haml-3.1.4/lib/haml/util.rb', line 510
def ruby1_8_6?
ruby1_8? && Haml::Util::RUBY_VERSION[2] < 7
end
|
- (String) scope(file)
Returns the path of a file relative to the Haml root directory.
28 29 30 |
# File '/build/buildd/ruby-haml-3.1.4/lib/haml/util.rb', line 28
def scope(file)
File.join(Haml::ROOT_DIR, file)
end
|
- (Boolean) set_eql?(set1, set2)
Tests the hash-equality of two sets in a cross-version manner. Aggravatingly, this is order-dependent in Ruby 1.8.6.
688 689 690 691 |
# File '/build/buildd/ruby-haml-3.1.4/lib/haml/util.rb', line 688
def set_eql?(set1, set2)
return set1.eql?(set2) unless ruby1_8_6?
set1.to_a.uniq.sort_by {|e| e.hash}.eql?(set2.to_a.uniq.sort_by {|e| e.hash})
end
|
- (Fixnum) set_hash(set)
Returns the hash code for a set in a cross-version manner. Aggravatingly, this is order-dependent in Ruby 1.8.6.
677 678 679 680 |
# File '/build/buildd/ruby-haml-3.1.4/lib/haml/util.rb', line 677
def set_hash(set)
return set.hash unless ruby1_8_6?
set.map {|e| e.hash}.uniq.sort.hash
end
|
- silence_haml_warnings { ... }
Silences all Haml warnings within a block.
323 324 325 326 327 328 329 |
# File '/build/buildd/ruby-haml-3.1.4/lib/haml/util.rb', line 323
def silence_haml_warnings
old_silence_warnings = @@silence_warnings
@@silence_warnings = true
yield
ensure
@@silence_warnings = old_silence_warnings
end
|
- silence_warnings { ... }
Silence all output to STDERR within a block.
312 313 314 315 316 317 |
# File '/build/buildd/ruby-haml-3.1.4/lib/haml/util.rb', line 312
def silence_warnings
the_real_stderr, $stderr = $stderr, StringIO.new
yield
ensure
$stderr = the_real_stderr
end
|
- (String) static_method_name(name, *vars)
Computes the name for a method defined via #def_static_method.
776 777 778 |
# File '/build/buildd/ruby-haml-3.1.4/lib/haml/util.rb', line 776
def static_method_name(name, *vars)
"#{name}_#{vars.map {|v| !!v}.join('_')}"
end
|
- (Array) strip_string_array(arr)
Destructively strips whitespace from the beginning and end of the first and last elements, respectively, in the array (if those elements are strings).
180 181 182 183 184 |
# File '/build/buildd/ruby-haml-3.1.4/lib/haml/util.rb', line 180
def strip_string_array(arr)
arr.first.lstrip! if arr.first.is_a?(String)
arr.last.rstrip! if arr.last.is_a?(String)
arr
end
|
- substitute(ary, from, to)
Substitutes a sub-array of one array with another sub-array.
162 163 164 165 166 167 168 169 170 171 172 |
# File '/build/buildd/ruby-haml-3.1.4/lib/haml/util.rb', line 162
def substitute(ary, from, to)
res = ary.dup
i = 0
while i < res.size
if res[i...i+from.size] == from
res[i...i+from.size] = to
end
i += 1
end
res
end
|
- (Hash) to_hash(arr)
Converts an array of [key, value]
pairs to a hash.
39 40 41 |
# File '/build/buildd/ruby-haml-3.1.4/lib/haml/util.rb', line 39
def to_hash(arr)
Hash[arr.compact]
end
|
- (Boolean) try_sass
Try loading Sass. If the sass
gem isn’t installed, print a warning and load from the vendored gem.
344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 |
# File '/build/buildd/ruby-haml-3.1.4/lib/haml/util.rb', line 344
def try_sass
return true if defined?(::SASS_BEGUN_TO_LOAD)
begin
require 'sass/version'
loaded = Sass.respond_to?(:version) && Sass.version[:major] &&
Sass.version[:minor] && ((Sass.version[:major] > 3 && Sass.version[:minor] > 1) ||
((Sass.version[:major] == 3 && Sass.version[:minor] == 1) &&
(Sass.version[:prerelease] || Sass.version[:name] != "Bleeding Edge")))
rescue LoadError => e
loaded = false
end
unless loaded
haml_warn("Sass is in the process of being separated from Haml,\nand will no longer be bundled at all in Haml 3.2.0.\nPlease install the 'sass' gem if you want to use Sass.\n")
$".delete('sass/version')
$LOAD_PATH.unshift(scope("vendor/sass/lib"))
end
loaded
end
|
- (Boolean) version_geq(v1, v2)
Returns whether one version string represents the same or a more recent version than another.
268 269 270 |
# File '/build/buildd/ruby-haml-3.1.4/lib/haml/util.rb', line 268
def version_geq(v1, v2)
version_gt(v1, v2) || !version_gt(v2, v1)
end
|
- (Boolean) version_gt(v1, v2)
Returns whether one version string represents a more recent version than another.
239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 |
# File '/build/buildd/ruby-haml-3.1.4/lib/haml/util.rb', line 239
def version_gt(v1, v2)
# Construct an array to make sure the shorter version is padded with nil
Array.new([v1.length, v2.length].max).zip(v1.split("."), v2.split(".")) do |_, p1, p2|
p1 ||= "0"
p2 ||= "0"
release1 = p1 =~ /^[0-9]+$/
release2 = p2 =~ /^[0-9]+$/
if release1 && release2
# Integer comparison if both are full releases
p1, p2 = p1.to_i, p2.to_i
next if p1 == p2
return p1 > p2
elsif !release1 && !release2
# String comparison if both are prereleases
next if p1 == p2
return p1 > p2
else
# If only one is a release, that one is newer
return release1
end
end
end
|
- (Boolean) windows?
Whether or not this is running on Windows.
481 482 483 |
# File '/build/buildd/ruby-haml-3.1.4/lib/haml/util.rb', line 481
def windows?
RbConfig::CONFIG['host_os'] =~ /mswin|windows|mingw/i
end
|