scribble 1.0.0

data/test/template_test.rb

@@ -0,0 +1,51 @@
+require_relative 'test_helper'
+
+describe Scribble::Template do
+
+  # Rendering
+
+  it 'can be rendered multiple times' do
+    template = Scribble::Template.new('Hello World')
+    assert_equal 'Hello World', template.render
+    assert_equal 'Hello World', template.render
+    assert_equal 'Hello World', template.render
+  end
+
+  # Partial loading
+
+  it "can't load partials without a loader" do
+    assert_raises_message 'Cannot load partial' do
+      Scribble::Template.new('Hello World').load 'some_partial', nil
+    end
+  end
+
+  it "loads partials when it has a loader" do
+    loader = MockLoader.new some_partial: ''
+    assert_instance_of Scribble::Partial::Context, Scribble::Template.new('Hello World', loader: loader).load('some_partial', nil)
+  end
+
+  # Formats
+
+  it "can't render in format without template format" do
+    assert_raises_message 'Cannot convert to' do
+      Scribble::Template.new('Hello World').render format: :render_format
+    end
+  end
+
+  it "can't render in format without suitable converter" do
+    assert_raises_message 'No suitable converter' do
+      Scribble::Template.new('Hello World', format: :template_format).render format: :render_format
+    end
+  end
+
+  it "won't need converter to render in template format" do
+    assert_scribble_render 'Hello World', 'Hello World',
+      format: :template_format, template: {format: :template_format}
+  end
+
+  it "renders in format when it has a template format and a suitable converter" do
+    converter = MockConverter.new :template_format, :render_format
+    assert_scribble_render 'Hello World', 'template_format > render_format(Hello World)',
+      format: :render_format, template: {format: :template_format, converters: [converter]}
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,65 @@
+require 'pry'
+require 'minitest/autorun'
+
+require_relative '../lib/scribble'
+
+module MiniTest::Assertions
+  def assert_scribble_parse source, serialized_transform
+    assert_equal serialized_transform, serialize_transform(Scribble::Template.new(source).nodes)
+  end
+
+  def assert_scribble_render source, render_result, template: {}, **options
+    assert_equal render_result, Scribble::Template.new(source, **template).render(options)
+  end
+
+  def assert_scribble_raises source, exception_class = Scribble::Errors::Undefined, message = nil
+    e = assert_raises exception_class do
+      Scribble::Template.new(source).render
+    end
+    assert_equal message, e.message unless message.nil?
+  end
+
+  def assert_raises_message regex, exception_class = RuntimeError, &block
+    assert_match regex, assert_raises(exception_class, &block).message
+  end
+
+  def serialize_transform node = transform
+    case node
+    when Array                then node.map { |node| serialize_transform node }.join(', ')
+    when Scribble::Nodes::Value  then node.value.is_a?(String) ? "'#{node.value}'" : node.value.inspect
+    when Scribble::Nodes::Call
+      call = node.name.to_s
+      call = "#{serialize_transform(node.receiver)}.#{call}" if node.receiver
+      call = "#{call}(#{serialize_transform node.args})"     unless node.allow_variable
+      call = "#{call} { #{serialize_transform node.nodes} }" if node.nodes
+      call
+    else raise "Unable to serialize transform: #{node.inspect}"
+    end
+  end
+end
+
+class MockLoader
+  def initialize partials
+    @partials = partials
+  end
+
+  def load name
+    source, format = @partials[name.to_sym]
+    Scribble::Partial.new source, format: format
+  end
+end
+
+MockConverter = Struct.new :from, :to do
+  def convert source
+    "#{from} > #{to}(#{source})"
+  end
+end
+
+class Scribble::Registry
+  def reset
+    class_names, methods = @class_names.dup, @methods.dup
+    yield
+  ensure
+    @class_names, @methods = class_names, methods
+  end
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: scribble
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Stefan Kroes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: parslet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+description: Scribble is a client facing template language similar to Liquid. Scribble
+  was written in Ruby and can be used in any Ruby or Ruby on Rails project. It takes
+  a template file, consisting of text and Scribble tags and transforms it into text.
+  Scribble can be used to transform any plain text format like HTML, Markdown, JSON,
+  XML, etc. Client facing means that it is safe to use Scribble to run/evaluate user
+  provided templates.
+email:
+- stefan.kroes@lab01.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/scribble.rb
+- lib/scribble/block.rb
+- lib/scribble/converter.rb
+- lib/scribble/errors.rb
+- lib/scribble/method.rb
+- lib/scribble/methods/if.rb
+- lib/scribble/methods/layout.rb
+- lib/scribble/methods/partial.rb
+- lib/scribble/methods/times.rb
+- lib/scribble/nodes/call.rb
+- lib/scribble/nodes/ending.rb
+- lib/scribble/nodes/node.rb
+- lib/scribble/nodes/value.rb
+- lib/scribble/objects/boolean.rb
+- lib/scribble/objects/fixnum.rb
+- lib/scribble/objects/nil.rb
+- lib/scribble/objects/string.rb
+- lib/scribble/parsing/nester.rb
+- lib/scribble/parsing/parser.rb
+- lib/scribble/parsing/reporter.rb
+- lib/scribble/parsing/transform.rb
+- lib/scribble/partial.rb
+- lib/scribble/registry.rb
+- lib/scribble/support/context.rb
+- lib/scribble/support/matcher.rb
+- lib/scribble/support/unmatched.rb
+- lib/scribble/support/utilities.rb
+- lib/scribble/template.rb
+- lib/scribble/version.rb
+- scribble.gemspec
+- test/all.rb
+- test/errors_test.rb
+- test/methods/if_test.rb
+- test/methods/layout_test.rb
+- test/methods/partial_test.rb
+- test/methods/times_test.rb
+- test/objects/boolean_test.rb
+- test/objects/fixnum_test.rb
+- test/objects/nil_test.rb
+- test/objects/string_test.rb
+- test/parsing/parsing_test.rb
+- test/registry_test.rb
+- test/template_test.rb
+- test/test_helper.rb
+homepage: https://github.com/stefankroes/scribble
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.2
+signing_key: 
+specification_version: 4
+summary: Scribble is a client facing template language similar to Liquid build in
+  Ruby
+test_files:
+- test/all.rb
+- test/errors_test.rb
+- test/methods/if_test.rb
+- test/methods/layout_test.rb
+- test/methods/partial_test.rb
+- test/methods/times_test.rb
+- test/objects/boolean_test.rb
+- test/objects/fixnum_test.rb
+- test/objects/nil_test.rb
+- test/objects/string_test.rb
+- test/parsing/parsing_test.rb
+- test/registry_test.rb
+- test/template_test.rb
+- test/test_helper.rb