simple-liquid 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '093b30f70350434d5c195d1c510534c87c628a821580284f6cb56ce69715ba0c'
+  data.tar.gz: 0ee9883ced270bfff45af039211deda7137c38a7d8b92a50b105ade29ffa70ef
+SHA512:
+  metadata.gz: 3e34a9aac5c46bd613761e86adbae4942c48693ddbb9fad3c4bd67e41e9fb7f1ad25f0dbc90cd9abc9567190ca76bf86ad6eb385a8331b65d344bfcb113563f8
+  data.tar.gz: ba03e07892d6f7b783834b674d3678717642b4cc9519b437d51f9294f9696857cb56befbf7fc60c9b5865ac4b461cffaf6e4b79912c6f91c333331204d35b15f

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+pkg/

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/LICENSE

@@ -0,0 +1,2 @@
+this work is licensed under the terms of the MIT license,
+see https://opensource.org/licenses/MIT

data/README.md

@@ -0,0 +1,31 @@
+# Simple::Hash
+
+safe simple way to render a liquid template
+
+## installation
+
+    $ gem install simple-liquid
+
+**or**
+
+```ruby
+gem 'simple-liquid'
+```
+
+    $ bundle
+
+## usage
+
+```ruby
+Simple::Liquid.render('hello {{ name | default: "?" }}', { name: nil })
+# => hello ?
+
+Simple::Liquid.render('hello {{ location }}', { name: "0xfabe" })
+# => Simple::Liquid::Error (undefined variable location)
+
+Simple::Liquid.render('hello {{ location }} {{ something }}', { name: "0xfabe" })
+# => Simple::Liquid::Error (undefined variable location, undefined variable something)
+
+Simple::Liquid.render("{{ a | oops }}", { a: 1 })
+# => Simple::Liquid::Error (undefined filter oops)
+```

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "simple/liquid"
+
+require "irb"
+
+IRB.start(__FILE__)

data/lib/simple/liquid.rb

@@ -0,0 +1,55 @@
+require 'liquid'
+
+module Simple
+end
+
+class Simple::Liquid
+  class Error < RuntimeError
+  end
+
+  VERSION = '1.0.0'
+
+  attr_reader :template, :object
+
+  def initialize(template, object = {})
+    @template = template
+    @object = deep_stringify_keys(object.to_h)
+  end
+
+  def self.render(template, object = {})
+    new(template, object).render
+  end
+
+  def liquid_template
+    @liquid_template ||= ::Liquid::Template.parse(template, error_mode: :strict)
+  end
+
+  def render
+    liquid_template.render(
+      object,
+      strict_variables: true,
+      strict_filters: true
+    ).tap { raise_if_errors! }
+  end
+
+  def raise_if_errors!
+    errors = liquid_template.errors
+    return if errors.empty?
+    messages = errors.map { |error| error.message.gsub('Liquid error:', '').strip }
+    raise Simple::Liquid::Error.new(messages.join(', '))
+  end
+
+  private
+
+  def deep_stringify_keys(object)
+    if object.is_a?(Array)
+      object.map { |value| deep_stringify_keys(value) }
+    elsif object.is_a?(Hash)
+      object.transform_keys(&:to_s).transform_values do |value|
+        deep_stringify_keys(value)
+      end
+    else
+      object
+    end
+  end
+end

data/simple-liquid.gemspec

@@ -0,0 +1,14 @@
+require_relative "lib/simple/liquid"
+
+Gem::Specification.new do |spec|
+  spec.name = "simple-liquid"
+  spec.version = Simple::Liquid::VERSION
+  spec.authors = ["localhostdotdev"]
+  spec.email = ["localhostdotdev@protonmail.com"]
+  spec.summary = "safe simple way to render a liquid template"
+  spec.homepage = "https://github.com/simple-updates/simple-liquid"
+  spec.license = "MIT"
+  spec.files = `git ls-files`.split("\n")
+  spec.require_paths = ["lib"]
+  spec.add_dependency "liquid", "~> 4.0"
+end

data/test/simple/liquid_test.rb

@@ -0,0 +1,52 @@
+require "minitest/autorun"
+require_relative '../../lib/simple/liquid'
+
+class TestSimpleLiquid < Minitest::Test
+  extend MiniTest::Spec::DSL
+
+  @@counter = 0
+
+  def self.it(&block)
+    @@counter += 1
+
+    define_method("test_#{@@counter}", &block)
+  end
+
+  def assert_raises_message(message, &block)
+    error = nil
+
+    begin
+      block.call
+    rescue => e
+      error = e
+    end
+
+    assert_includes(error&.message.to_s, message)
+  end
+
+  before do
+    @template = '{{ a }} {{ b }} {{ c }}'
+    @object = { a: 1, b: 2, c: 3 }
+  end
+
+  it { assert_equal("1 2 3", Simple::Liquid.render(@template, @object)) }
+  it { assert_equal("a", Simple::Liquid.render("a", @object)) }
+
+  it do
+    assert_raises_message("undefined variable d") do
+      Simple::Liquid.render("{{ d }}", @object)
+    end
+  end
+
+  it do
+    assert_raises_message("undefined variable d, undefined variable e") do
+      Simple::Liquid.render("{{ d }} {{ e }}", @object)
+    end
+  end
+
+  it do
+    assert_raises(Simple::Liquid::Error) do
+      Simple::Liquid.render("{{ d | oops }}", @object)
+    end
+  end
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: simple-liquid
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- localhostdotdev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-04-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: liquid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: 
+email:
+- localhostdotdev@protonmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- lib/simple/liquid.rb
+- simple-liquid.gemspec
+- test/simple/liquid_test.rb
+homepage: https://github.com/simple-updates/simple-liquid
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: safe simple way to render a liquid template
+test_files: []