liquid-c 4.0.1 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e8ca00871b405a80337964e8d16fbd9e2c7eebc1174e04149193ed2b6dec69e
-  data.tar.gz: 6beb1f9af62e04c208735e733536631b0bb48a734f6f25a79e69e0032a71b6df
+  metadata.gz: 8b5a8a5b1b5f7409b378626e889898eeac6996ef2127894d25d2f342183c633c
+  data.tar.gz: 165117bbbcf583f3c9c0223c3232de5e5c42b67a8ed90b3d268864e4732c685d
 SHA512:
-  metadata.gz: 9f6eb35fdd601a8ecc6d1f00beb3ef4d06ecb51c0de7fe5e9efbe9795d9ddc9828f5b0a4fe65cb719d91b322d3162a61e561c45b03f6cafebdc773a1f6bf2b7e
-  data.tar.gz: d2c21226bb648cdd9b062997fede49f6b0a2bc8896c216c5e66554b4962cd9524fe0a09b25450f8a1ac76bce2cf7f61ccdec039bc35079ce28cb0770c4a6cfbf
+  metadata.gz: a7c7ed2cd71c5470c4b53671611279e71279cba16f0a6fcd5623935b80373ed941f6b3360264399ec7f8ab1efe39728f0bba1a6fecdd3e704675e7464ab660aa
+  data.tar.gz: 006af34fd3a151cae0387a0d70f18e5f64f98dba95f1e2bf6ea36fe239db3153f301405c349ff25a852977ad38b8873a6d8b2554753f29f37665ef20f7a30fda

data/.github/workflows/cla.yml

@@ -0,0 +1,23 @@
+# .github/workflows/cla.yml
+name: Contributor License Agreement (CLA)
+
+on:
+  pull_request_target:
+    types: [opened, synchronize]
+  issue_comment:
+    types: [created]
+
+jobs:
+  cla:
+    runs-on: ubuntu-latest
+    if: |
+      (github.event.issue.pull_request
+        && !github.event.issue.pull_request.merged_at
+        && contains(github.event.comment.body, 'signed')
+      )
+      || (github.event.pull_request && !github.event.pull_request.merged)
+    steps:
+      - uses: Shopify/shopify-cla-action@v1
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          cla-token: ${{ secrets.CLA_TOKEN }}

data/.github/workflows/liquid.yml

@@ -5,19 +5,44 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        entry:
-          - { ruby: 2.7 }
-          - { ruby: 3.2 }
-    name: test (${{ matrix.entry.ruby }})
+        include:
+          - { ruby: '2.7', allowed-failure: false }
+          - { ruby: '3.0', allowed-failure: false }
+          - { ruby: '3.1', allowed-failure: false }
+          - { ruby: '3.2', allowed-failure: false }
+          - { ruby: '3.3', allowed-failure: false }
+          - { ruby: ruby-head, allowed-failure: true }
+          - { ruby: truffleruby-head, allowed-failure: true }
+    name: test (${{ matrix.ruby }})
     steps:
       - uses: actions/checkout@v2
       - uses: ruby/setup-ruby@v1
         with:
-          ruby-version: ${{ matrix.entry.ruby }}
-      - uses: actions/cache@v1
-        with:
-          path: vendor/bundle
-          key: ${{ runner.os }}-gems-${{ hashFiles('Gemfile') }}
-          restore-keys: ${{ runner.os }}-gems-
-      - run: bundle install --jobs=3 --retry=3 --path=vendor/bundle
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
       - run: bundle exec rake
+        continue-on-error: ${{ matrix.allowed-failure }}
+        env:
+          LIQUID_C_PEDANTIC: 'true'
+        if: matrix.ruby != 'truffleruby-head'
+
+      - run: bundle exec rake test:unit
+        continue-on-error: ${{ matrix.allowed-failure }}
+        env:
+          LIQUID_C_PEDANTIC: 'true'
+        if: matrix.ruby == 'truffleruby-head'
+
+      - run: bundle exec rubocop
+        if: matrix.ruby != 'truffleruby-head'
+
+  valgrind:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.3
+          bundler-cache: true
+      - run: sudo apt-get install -y valgrind
+      - run: bundle exec rake test:valgrind

data/.gitignore

@@ -7,3 +7,7 @@ tmp
 *.bundle
 ext/*/Makefile
 *.so
+instruments*.trace
+*.cpu
+*.object
+*.dSYM

data/.rubocop.yml

@@ -0,0 +1,14 @@
+inherit_gem:
+  rubocop-shopify: rubocop.yml
+
+require: rubocop-performance
+
+AllCops:
+  TargetRubyVersion: 2.5
+  Exclude:
+    - 'vendor/bundle/**/*'
+    - 'tmp/**/*'
+
+Style/GlobalVars:
+  Exclude:
+    - 'ext/liquid_c/extconf.rb'

data/Gemfile

@@ -1,14 +1,24 @@
-source 'https://rubygems.org'
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+git_source(:github) do |repo_name|
+  "https://github.com/#{repo_name}.git"
+end
 
 gemspec
 
-gem 'liquid', github: 'Shopify/liquid', branch: '4-0-stable'
+gem "liquid", github: "Shopify/liquid", ref: "master"
 
 group :test do
-  gem 'spy', '0.4.1'
-  gem 'benchmark-ips'
+  gem "base64", require: false # for older rubocop on Ruby 3.4
+  gem "rubocop", "~> 1.24.1", require: false
+  gem "rubocop-performance", "~> 1.13.2", require: false
+  gem "rubocop-shopify", "~> 2.4.0", require: false
+  gem "spy", "0.4.1"
+  gem "benchmark-ips"
+  gem "ruby_memcheck"
 end
 
 group :development do
-  gem 'byebug'
+  gem "byebug"
 end

data/README.md

@@ -1,5 +1,5 @@
 # Liquid::C
-[![Build Status](https://travis-ci.org/Shopify/liquid-c.svg?branch=master)](https://travis-ci.org/Shopify/liquid-c)
+[![Build Status](https://travis-ci.org/Shopify/liquid-c.svg?branch=main)](https://travis-ci.org/Shopify/liquid-c)
 
 Partial native implementation of the liquid ruby gem in C.
 
@@ -7,8 +7,8 @@ Partial native implementation of the liquid ruby gem in C.
 
 Add these lines to your application's Gemfile:
 
-    gem 'liquid', github: 'Shopify/liquid', branch: 'master'
-    gem 'liquid-c', github: 'Shopify/liquid-c', branch: 'master'
+    gem 'liquid', github: 'Shopify/liquid', branch: 'main'
+    gem 'liquid-c', github: 'Shopify/liquid-c', branch: 'main'
 
 And then execute:
 
@@ -31,14 +31,38 @@ then just use the documented API for the liquid Gem.
 
 To compare Liquid-C's performance with plain Liquid run
 
-    bundle exec rake compare:run
+    bundle exec rake compare:lax
 
 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%
+```
+$ bundle exec rake compare:lax
+/home/spin/.rubies/ruby-3.0.2/bin/ruby ./performance.rb bare benchmark lax
+
+Running benchmark for 10 seconds (with 5 seconds warmup).
+
+Warming up --------------------------------------
+              parse:     2.000  i/100ms
+             render:     8.000  i/100ms
+     parse & render:     2.000  i/100ms
+Calculating -------------------------------------
+              parse:     29.527  (± 3.4%) i/s -    296.000  in  10.034520s
+             render:     89.403  (± 6.7%) i/s -    896.000  in  10.072939s
+     parse & render:     20.474  (± 4.9%) i/s -    206.000  in  10.072806s
+
+/home/spin/.rubies/ruby-3.0.2/bin/ruby ./performance.rb c benchmark lax
+
+Running benchmark for 10 seconds (with 5 seconds warmup).
+
+Warming up --------------------------------------
+              parse:    10.000  i/100ms
+             render:    18.000  i/100ms
+     parse & render:     5.000  i/100ms
+Calculating -------------------------------------
+              parse:     90.672  (± 3.3%) i/s -    910.000  in  10.051124s
+             render:    163.871  (± 4.9%) i/s -      1.638k in  10.018105s
+     parse & render:     50.165  (± 4.0%) i/s -    505.000  in  10.077377s
+```
 
 ## Developing
 

data/Rakefile

@@ -1,69 +1,18 @@
-require 'rake'
-require 'rake/testtask'
-require 'bundler/gem_tasks'
-require 'rake/extensiontask'
-require 'benchmark'
+# frozen_string_literal: true
 
-ENV['DEBUG'] = 'true'
-Rake::ExtensionTask.new("liquid_c")
+require "rake"
+require "rake/testtask"
+require "bundler/gem_tasks"
+require "rake/extensiontask"
+require "benchmark"
+require "ruby_memcheck"
 
-task :default => :test
+ENV["DEBUG"] ||= "true"
 
-task :test => ['test:unit', 'test:liquid']
+task default: [:test, :rubocop]
 
-namespace :test do
-  Rake::TestTask.new(:unit => :compile) do |t|
-    t.libs << 'lib' << 'test'
-    t.test_files = FileList['test/unit/**/*_test.rb']
-  end
-
-  desc 'run test suite with default parser'
-  Rake::TestTask.new(:base_liquid => :compile) do |t|
-    t.libs << 'lib'
-    t.test_files = ['test/liquid_test.rb']
-  end
-
-  desc 'runs test suite with both strict and lax parsers'
-  task :liquid do
-    ENV['LIQUID_PARSER_MODE'] = 'lax'
-    Rake::Task['test:base_liquid'].invoke
-    ENV['LIQUID_PARSER_MODE'] = 'strict'
-    Rake::Task['test:base_liquid'].reenable
-    Rake::Task['test:base_liquid'].invoke
-  end
-end
-
-namespace :benchmark do
-  desc "Run the liquid benchmark with lax parsing"
-  task :run do
-    ruby "./performance.rb c benchmark lax"
-  end
-
-  desc "Run the liquid benchmark with strict parsing"
-  task :strict do
-    ruby "./performance.rb c benchmark strict"
-  end
-end
-
-
-namespace :profile do
-  desc "Run the liquid profile/performance coverage"
-  task :run do
-    ruby "./performance.rb c profile lax"
-  end
+task test: ["test:unit", "test:integration:all"]
 
-  desc "Run the liquid profile/performance coverage with strict parsing"
-  task :strict do
-    ruby "./performance.rb c profile strict"
-  end
-end
-
-namespace :compare do
-  %w(lax warn strict).each do |type|
-    desc "Compare Liquid to Liquid-C in #{type} mode"
-    task type.to_sym do
-      ruby "./performance.rb bare benchmark #{type}"
-      ruby "./performance.rb c benchmark #{type}"
-    end
-  end
+namespace :test do
+  task valgrind: ["test:unit:valgrind", "test:integration:valgrind:all"]
 end