| Path: | lib/haml/util.rb |
| Last Update: | Thu Dec 16 14:23:23 +0000 2010 |
This is used for methods in {Haml::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.
@overload def_static_method(klass, name, args, *vars, erb) @param klass [Module] The class on which to define the static method @param name [to_s] The (base) name of the static method @param args [Array<Symbol>] The names of the arguments to the defined methods
(**not** to the ERB template)
@param vars [Array<Symbol>] The names of the static boolean variables
to be made available to the ERB template
@param erb [String] The template for the method code
# File lib/haml/util.rb, line 740
740: def def_static_method(klass, name, args, *vars)
741: erb = vars.pop
742: info = caller_info
743: powerset(vars).each do |set|
744: context = StaticConditionalContext.new(set).instance_eval {binding}
745: 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])
746: end
747: end
A version of `Enumerable#enum_cons` that works in Ruby 1.8 and 1.9.
@param enum [Enumerable] The enumerable to get the enumerator for @param n [Fixnum] The size of each cons @return [Enumerator] The consed enumerator
# File lib/haml/util.rb, line 623
623: def enum_cons(enum, n)
624: ruby1_8? ? enum.enum_cons(n) : enum.each_cons(n)
625: end
A version of `Enumerable#enum_slice` that works in Ruby 1.8 and 1.9.
@param enum [Enumerable] The enumerable to get the enumerator for @param n [Fixnum] The size of each slice @return [Enumerator] The consed enumerator
# File lib/haml/util.rb, line 632
632: def enum_slice(enum, n)
633: ruby1_8? ? enum.enum_slice(n) : enum.each_slice(n)
634: end
A version of `Enumerable#enum_with_index` that works in Ruby 1.8 and 1.9.
@param enum [Enumerable] The enumerable to get the enumerator for @return [Enumerator] The with-index enumerator
# File lib/haml/util.rb, line 614
614: def enum_with_index(enum)
615: ruby1_8? ? enum.enum_with_index : enum.each_with_index
616: end
Flattens the first `n` nested arrays in a cross-version manner.
@param arr [Array] The array to flatten @param n [Fixnum] The number of levels to flatten @return [Array] The flattened array
# File lib/haml/util.rb, line 649
649: def flatten(arr, n)
650: return arr.flatten(n) unless ruby1_8_6?
651: return arr if n == 0
652: arr.inject([]) {|res, e| e.is_a?(Array) ? res.concat(flatten(e, n - 1)) : res << e}
653: end
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.
@param attr [to_s] The (singular) name of the method-collection method
(e.g. `:instance_methods`, `:private_methods`)
@param klass [Module] The class to check the methods of which to check @param method [String, Symbol] The name of the method do check for @return [Boolean] Whether or not the given collection has the given method
# File lib/haml/util.rb, line 606
606: def has?(attr, klass, method)
607: klass.send("#{attr}s").include?(ruby1_8? ? method.to_s : method.to_sym)
608: end
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.
@param obj {Object} @return {String}
# File lib/haml/util.rb, line 682
682: def inspect_obj(obj)
683: return obj.inspect unless version_geq(::RUBY_VERSION, "1.9.2")
684: return ':' + inspect_obj(obj.to_s) if obj.is_a?(Symbol)
685: return obj.inspect unless obj.is_a?(String)
686: '"' + obj.gsub(/[\x00-\x7F]+/) {|s| s.inspect[1...-1]} + '"'
687: end
Returns the ASCII code of the given character.
@param c [String] All characters but the first are ignored. @return [Fixnum] The ASCII code of `c`.
# File lib/haml/util.rb, line 640
640: def ord(c)
641: ruby1_8? ? c[0] : c.ord
642: end
Tests the hash-equality of two sets in a cross-version manner. Aggravatingly, this is order-dependent in Ruby 1.8.6.
@param set1 [Set] @param set2 [Set] @return [Boolean] Whether or not the sets are hashcode equal
# File lib/haml/util.rb, line 671
671: def set_eql?(set1, set2)
672: return set1.eql?(set2) unless ruby1_8_6?
673: set1.to_a.uniq.sort_by {|e| e.hash}.eql?(set2.to_a.uniq.sort_by {|e| e.hash})
674: end
Returns the hash code for a set in a cross-version manner. Aggravatingly, this is order-dependent in Ruby 1.8.6.
@param set [Set] @return [Fixnum] The order-independent hashcode of `set`
# File lib/haml/util.rb, line 660
660: def set_hash(set)
661: return set.hash unless ruby1_8_6?
662: set.map {|e| e.hash}.uniq.sort.hash
663: end
Computes the name for a method defined via \{def_static_method}.
@param name [String] The base name of the static method @param vars [Array<Boolean>] The static variable assignment @return [String] The real name of the static method
# File lib/haml/util.rb, line 759
759: def static_method_name(name, *vars)
760: "#{name}_#{vars.map {|v| !!v}.join('_')}"
761: end
Computes a single longest common subsequence for arrays x and y. Algorithm from [Wikipedia](en.wikipedia.org/wiki/Longest_common_subsequence_problem#Reading_out_an_LCS)
# File lib/haml/util.rb, line 786
786: def lcs_backtrace(c, x, y, i, j, &block)
787: return [] if i == 0 || j == 0
788: if v = yield(x[i], y[j])
789: return lcs_backtrace(c, x, y, i-1, j-1, &block) << v
790: end
791:
792: return lcs_backtrace(c, x, y, i, j-1, &block) if c[i][j-1] > c[i-1][j]
793: return lcs_backtrace(c, x, y, i-1, j, &block)
794: end
Calculates the memoization table for the Least Common Subsequence algorithm. Algorithm from [Wikipedia](en.wikipedia.org/wiki/Longest_common_subsequence_problem#Computing_the_length_of_the_LCS)
# File lib/haml/util.rb, line 767
767: def lcs_table(x, y)
768: c = Array.new(x.size) {[]}
769: x.size.times {|i| c[i][0] = 0}
770: y.size.times {|j| c[0][j] = 0}
771: (1...x.size).each do |i|
772: (1...y.size).each do |j|
773: c[i][j] =
774: if yield x[i], y[j]
775: c[i-1][j-1] + 1
776: else
777: [c[i][j-1], c[i-1][j]].max
778: end
779: end
780: end
781: return c
782: end
Parses a magic comment at the beginning of a Haml file. The parsing rules are basically the same as Ruby‘s.
@return [(Boolean, String or nil)]
Whether the document begins with a UTF-8 BOM, and the declared encoding of the document (or nil if none is declared)
# File lib/haml/util.rb, line 802
802: def parse_haml_magic_comment(str)
803: scanner = StringScanner.new(str.dup.force_encoding("BINARY"))
804: bom = scanner.scan(/\xEF\xBB\xBF/n)
805: return bom unless scanner.scan(/-\s*#\s*/n)
806: if coding = try_parse_haml_emacs_magic_comment(scanner)
807: return bom, coding
808: end
809:
810: return bom unless scanner.scan(/.*?coding[=:]\s*([\w-]+)/in)
811: return bom, scanner[1]
812: end
# File lib/haml/util.rb, line 814
814: def try_parse_haml_emacs_magic_comment(scanner)
815: pos = scanner.pos
816: return unless scanner.scan(/.*?-\*-\s*/n)
817: # From Ruby's parse.y
818: return unless scanner.scan(/([^\s'":;]+)\s*:\s*("(?:\\.|[^"])*"|[^"\s;]+?)[\s;]*-\*-/n)
819: name, val = scanner[1], scanner[2]
820: return unless name =~ /(en)?coding/in
821: val = $1 if val =~ /^"(.*)"$/n
822: return val
823: ensure
824: scanner.pos = pos
825: end