Liquid performance extension in C.
C Ruby
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
ext/liquid_c
lib/liquid
test
.gitignore
.travis.yml
Gemfile
LICENSE.txt
README.md
Rakefile
liquid-c.gemspec
performance.rb

README.md

Liquid::C

Build Status

Partial native implementation of the liquid ruby gem in C.

Installation

Add these lines to your application's Gemfile:

gem 'liquid', github: 'Shopify/liquid', branch: 'master'
gem 'liquid-c', github: 'Shopify/liquid-c', branch: 'master'

And then execute:

$ bundle

Usage

require 'liquid/c'

then just use the documented API for the liquid Gem.

Restrictions

  • Input strings are assumed to be UTF-8 encoded strings
  • Tag#parse(tokens) is given a Liquid::Tokenizer object, instead of an array of strings, which only implements the shift method to get the next token.

Performance

To compare Liquid-C's performance with plain Liquid run

bundle exec rake compare:run

The latest benchmark results are shown below:

                 user     system      total        real
Liquid:      0.000000   0.000000 246.950000 (247.499526)
Liquid-C:    0.000000   0.010000 224.270000 (224.794395)
Ratio: 90.82619215891624%

Developing

bundle install
# run tests
bundle exec rake

Contributing

  1. Fork it ( http://github.com/Shopify/liquid-c/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request