brianmario/fast_xs

excessively fast escaping

fast_xs, excessively fast escaping¶ ↑

• rubyforge.org/projects/fast-xs

• fast-xs.rubyforge.org/

• [email protected]

• git://rubyforge.org/fast-xs.git

• fast-xs.rubyforge.org/git?p=fast-xs.git

DESCRIPTION:¶ ↑

fast_xs provides C extensions for escaping text.

The original String#fast_xs method is based on the xchar code by Sam Ruby:

• intertwingly.net/stories/2005/09/28/xchar.rb

• intertwingly.net/blog/2005/09/28/XML-Cleansing

_why also packages an older version with Hpricot (patches submitted). The version here should be compatible with the latest version of Hpricot code.

Ruby on Rails will automatically use String#fast_xs from either Hpricot or this gem version with the bundled Builder package.

String#fast_xs is an almost exact translation of Sam Ruby’s original implementation (String#to_xs), but it does escape “"” (which is optional, but all parsers are able to handle it). XML::Builder as packaged in Rails 2.0 will be automatically use String#fast_xs instead of String#to_xs available.

EXTRA:¶ ↑

‘fast_xs_extra’ is an experimental extension that can be used with ‘fast_xs_monkey_patcher’ to monkey patch methods in common libraries:

CGI, ERB::Util, Rack::Utils, Mongrel

However, ‘fast_xs_extra’ does not provide a significant performance boost like ‘fast_xs’ does under Ruby 1.8.

COMPATIBILITY:¶ ↑

This package aims to be compatible with Ruby 1.8 and 1.9. It is however not as helpful in Ruby 1.9 which already provides encoding-aware string functions. Rubinius compatibility may happen in the future if deemed necessary, but this extension seems to be against the spirit of the Rubinius project.

LICENSE:¶ ↑

(The MIT License)

Copyright © all contributors (see logs in git)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

fast_xs's Issues

to_xs has changed in builder 3 fast_xs should deal with it

class String
  # XML escaped version of to_s. When <tt>escape</tt> is set to false
  # the CP1252 fix is still applied but utf-8 characters are not
  # converted to character entities.
  def to_xs(escape=true)
    unpack('U*').map {|n| n.xchr(escape)}.join # ASCII, UTF-8
  rescue
    unpack('C*').map {|n| n.xchr}.join # ISO-8859-1, WIN-1252
  end
end

fast_xs fails to install

I’m having some issues with setting up discourse, which depends on fast_xs, for development on my M1 Mac.

fast_xs gem fails to install. I’ve pasted the fast_xs error message below. Any insight?

Building native extensions. This could take a while...
ERROR:  Error installing fast_xs:
	ERROR: Failed to build gem native extension.

    current directory: /Users/sisirkoppaka/.gem/ruby/3.2.0/gems/fast_xs-0.8.0/ext/fast_xs
/Users/sisirkoppaka/.rubies/ruby-3.2.0/bin/ruby -I /Users/sisirkoppaka/.rubies/ruby-3.2.0/lib/ruby/site_ruby/3.2.0 extconf.rb
checking for assert.h... yes
creating Makefile

current directory: /Users/sisirkoppaka/.gem/ruby/3.2.0/gems/fast_xs-0.8.0/ext/fast_xs
make DESTDIR\= sitearchdir\=./.gem.20240203-10621-j9d0j7 sitelibdir\=./.gem.20240203-10621-j9d0j7 clean

current directory: /Users/sisirkoppaka/.gem/ruby/3.2.0/gems/fast_xs-0.8.0/ext/fast_xs
make DESTDIR\= sitearchdir\=./.gem.20240203-10621-j9d0j7 sitelibdir\=./.gem.20240203-10621-j9d0j7
compiling fast_xs.c
fast_xs.c:144:39: error: incompatible function pointer types passing 'VALUE (VALUE)' (aka 'unsigned long (unsigned long)') to parameter of type 'VALUE (*)(VALUE, VALUE)' (aka 'unsigned long (*)(unsigned long, unsigned long)') [-Wincompatible-function-pointer-types]
  144 |         array = rb_rescue(unpack_utf8, self, unpack_uchar, self);
      |                                              ^~~~~~~~~~~~
/Users/sisirkoppaka/.rubies/ruby-3.2.0/include/ruby-3.2.0/ruby/internal/iterator.h:364:62: note: passing argument to parameter 'r_proc' here
  364 | VALUE rb_rescue(VALUE (*b_proc)(VALUE), VALUE data1, VALUE (*r_proc)(VALUE, VALUE), VALUE data2);
      |                                                              ^
1 error generated.
make: *** [fast_xs.o] Error 1

make failed, exit code 2

Gem files will remain installed in /Users/sisirkoppaka/.gem/ruby/3.2.0/gems/fast_xs-0.8.0 for inspection.
Results logged to /Users/sisirkoppaka/.gem/ruby/3.2.0/extensions/arm64-darwin-22/3.2.0-static/fast_xs-0.8.0/gem_make.out```

JRuby support

This doesn't seem like it would be too hard to port, and the JRuby version would be line-for-line almost exactly the same as the CRuby version.

I can help with the port or try to do it myself. The former would be best since I'm not familiar with the library.

This is a direct dependency of Discourse, which I'm trying to get working on JRuby.