template-ruby 0.2.1 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc096165f8db9f20877bbd67a8d326ecdcaa546bcf9fda19479a267d9e559504
-  data.tar.gz: ae616ed093aded9378204f0231c2b4be787c3d62d0f9859d8971ea01c4fc8a8f
+  metadata.gz: 477a0d0d70a09f5118391d5288031811436a520c8faac5794da2ff3dcee996ad
+  data.tar.gz: e3e24d79c50c1058f619b63d09154b823acc3f0cd7b3c7ac75029c86df9e1bee
 SHA512:
-  metadata.gz: 317b2f1d710abef57552f540fe756fcd7d8761d485d93332f091672b354cc9339d6f3ce1d2da009807ef0093944fa1ed41b4f4cdce3e666730d1632b88d056dc
-  data.tar.gz: ffa81e7c9700f6dd30a9d09f18cfc17769446770364ab8dddfdcc8f90fd4ffd9caf35d5c0402106d45af3e9531a0d487a8d9b35a62f3c0f5abf26f290c24df7b
+  metadata.gz: ca7d9deac26c98d399d190a11192b8448a1c2bec8119a1dbfae6cca905554fd25d9bdfd91ffdbd2ad8ac73f743c07d30d5f97fab81d5d7d508ac7c8a09832217
+  data.tar.gz: d6da812be0c57c0c943ef44a46a7e0df3dd45f687251305c9cba5ada1d1f997dd57723405b129e5e2458139c9f2ef3baec31d9b66f4a850d01b5b8b1320cca37

data/.github/workflows/rspec.yml

@@ -0,0 +1,14 @@
+name: RSpec
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    name: RSpec
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions/setup-ruby@v1
+      - run: bundle install
+      - run: bundle exec rspec

data/CHANGELOG.md

@@ -5,9 +5,22 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 0.2.4 / 2022-08-02
+
+- Add method `String#*`, e.g. `{"Dorian " \* 2}" -> "Dorian Dorian "
+- Add executable to gem, e.g. `template --help`
+
+## 0.2.3 / 2022-08-31
+
+- Add default timeout for code and template parsing and evaluation
+
+## 0.2.2 / 2022-08-31
+
+- Fix parsing error when the template is empty, e.g. ""
+
 ## 0.2.1 / 2022-08-31
 
-- Fix error on empty code like `Hello {`
+- Fix parsing error on empty code like `Hello {`
 
 ## 0.2.0 / 2022-08-30
 
@@ -16,4 +29,3 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## 0.1.0 / 2022-07-28
 
 - Initial version with interpolation
-

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    template-ruby (0.1.0)
+    template-ruby (0.2.3)
       activesupport (~> 7)
       parslet (~> 2)
       zeitwerk (~> 2.6)
@@ -21,7 +21,7 @@ GEM
       tilt
     i18n (1.12.0)
       concurrent-ruby (~> 1.0)
-    minitest (5.16.2)
+    minitest (5.16.3)
     parslet (2.0.0)
     prettier (3.2.0)
       syntax_tree (>= 2.7.1)
@@ -42,9 +42,9 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.11.0)
     rspec-support (3.11.0)
-    syntax_tree (3.2.1)
+    syntax_tree (3.5.0)
       prettier_print
-    syntax_tree-haml (1.3.0)
+    syntax_tree-haml (1.3.1)
       haml (>= 5.2)
       prettier_print
       syntax_tree (>= 2.0.1)

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2022 Dorian Marié <dorian@dorianmarie.fr>
+
+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.

data/README.md

@@ -1,10 +1,103 @@
-# `template-ruby`
+# Template
 
-A templating programming language
+[![RSpec](https://github.com/dorianmariefr/template-ruby/actions/workflows/rspec.yml/badge.svg)](https://github.com/dorianmariefr/template-ruby/actions/workflows/rspec.yml)
 
-Like `Hello {name}` with `{name: "Dorian"}` gives `Hello Dorian`.
+See [templatelang.com](https://templatelang.com) for the full documentation and
+live code editing.
+
+## The programming language
+
+Hi, I'm [Dorian Marié](https://dorianmarie.fr), I created Template to let users of my websites provide templates to customize their experience.
+
+Template is meant to be:
+
+- **Simple**: `Hello` and `Hello {name}`
+- **Safe**: Can be provided user input
+- **Powerful**: Functions, object-oriented, built-in methods
+
+Template is currently written in Ruby and embeddable as a Ruby gem.
+
+## Install
+
+### As a command line tool:
+
+```bash
+$ gem install template-ruby
+$ template --input "Hello {name}" --context '{ name: "Dorian" }'
+Hello Dorian
+$ template --input "1 + 2 = {1 + 2}"
+1 + 2 = 3
+```
+
+### As a Ruby gem:
+
+In a `Gemfile`:
 
 ```ruby
-> Template.render("Hello {name}", '{name: "Dorian"}')
-=> "Hello Dorian"
+gem "template-ruby"
 ```
+
+Then `$ bundle install`
+
+Then you can use Template like:
+
+```ruby
+Template.render("Hello {name}", '{ name: "Dorian" }')
+# => "Hello Dorian"
+Template.render("1 + 2 = {1 + 2}")
+# => "1 + 2 = 3"
+Template.render(input, context, io: StringIO.new, timeout: 10)
+```
+
+The context is a sub-language called Code, you can use it like:
+
+```ruby
+Code.evaluate("1 + 2") # => 3
+```
+
+## Future work
+
+- Extend standard library
+- Global methods from Ruby, e.g. `{markdown "**bold**"}`
+- Object methods from Ruby, e.g. `{"**bold**".markdown}`
+- Classes, e.g. `{class User end}`
+- Write JavaScript version
+- Write Crystal version
+
+## Contributing
+
+Feel free to open [issues](https://github.com/dorianmariefr/template-ruby/issues),
+and [pull requests](https://github.com/dorianmariefr/template-ruby/pulls).
+
+To develop locally:
+
+```text
+$ git clone https://github.com/dorianmariefr/template-ruby
+$ cd template-ruby
+$ bundle
+$ rspec
+$ bin/template -i docs/...
+```
+
+## Credits
+
+Thanks to [thoughtbot](https://thoughtbot.com) who let me work on this programming
+language as a Friday project.
+
+Thanks to [Kaspar Schiess](https://github.com/kschiess) who made
+[Parslet](https://kschiess.github.io/parslet/), the gem that helped me write the parser.
+
+Inspiration from [Ruby](https://www.ruby-lang.org/en/) and
+[Liquid](https://shopify.github.io/liquid/).
+
+## License
+
+MIT
+
+Copyright 2022 Dorian Marié <dorian@dorianmarie.fr>
+
+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.

data/TODO.md

@@ -0,0 +1 @@
+- Code gem

data/bin/template

@@ -6,9 +6,9 @@ require_relative "../lib/template-ruby"
 options = {}
 
 OptionParser.new do |opts|
-  opts.banner = "Usage: #{$PROGRAM_NAME} [options]"
+  opts.banner = "Usage: template [options]"
 
-  opts.on("-i INPUT", "--input=INPUT", "Input in the template language") do |input|
+  opts.on("-i INPUT", "--input=INPUT", "Input in the template language (String or File)") do |input|
     if File.exists?(input)
       input = File.read(input)
     end
@@ -16,7 +16,7 @@ OptionParser.new do |opts|
     options[:input] = input
   end
 
-  opts.on("-c CONTEXT", "--context=CONTEXT", "Context in the code language") do |context|
+  opts.on("-c CONTEXT", "--context=CONTEXT", "Context in the code language (String or File)") do |context|
     if File.exists?(context)
       context = File.read(context)
     end

data/lib/code/node/call.rb

@@ -8,9 +8,10 @@ class Code
         @arguments.map! { |argument| ::Code::Node::CallArgument.new(argument) }
 
         if call.key?(:right)
-          @right = call.fetch(:right).map do |right|
-            ::Code::Node::ChainedCall.new(right)
-          end
+          @right =
+            call
+              .fetch(:right)
+              .map { |right| ::Code::Node::ChainedCall.new(right) }
         end
 
         if call.key?(:block)

data/lib/code/object/list.rb

@@ -59,7 +59,7 @@ class Code
             else
               acc + [element]
             end
-          end
+          end,
         )
       end
 
@@ -138,7 +138,7 @@ class Code
           argument.call(
             arguments: [
               ::Code::Object::Argument.new(acc),
-              ::Code::Object::Argument.new(element)
+              ::Code::Object::Argument.new(element),
             ],
             context: context,
             io: io,
@@ -169,7 +169,7 @@ class Code
               context: context,
               io: io,
             ).truthy?
-          end
+          end,
         )
       end
 
@@ -183,7 +183,7 @@ class Code
               context: context,
               io: io,
             )
-          end
+          end,
         )
       end
 

data/lib/code/object/range.rb

@@ -54,13 +54,11 @@ class Code
         argument = arguments.first.value
         ::Code::Object::Boolean.new(
           raw.any? do |element|
-            argument
-              .call(
-                arguments: [::Code::Object::Argument.new(element)],
-                context: context,
-                io: io,
-              )
-              .truthy?
+            argument.call(
+              arguments: [::Code::Object::Argument.new(element)],
+              context: context,
+              io: io,
+            ).truthy?
           end,
         )
       end
@@ -70,13 +68,11 @@ class Code
         argument = arguments.first.value
         ::Code::Object::Boolean.new(
           raw.all? do |element|
-            argument
-              .call(
-                arguments: [::Code::Object::Argument.new(element)],
-                context: context,
-                io: io,
-              )
-              .truthy?
+            argument.call(
+              arguments: [::Code::Object::Argument.new(element)],
+              context: context,
+              io: io,
+            ).truthy?
           end,
         )
       end
@@ -104,7 +100,7 @@ class Code
               context: context,
               io: io,
             ).truthy?
-          end
+          end,
         )
       end
 
@@ -118,7 +114,7 @@ class Code
               context: context,
               io: io,
             )
-          end
+          end,
         )
       end
 
@@ -131,9 +127,13 @@ class Code
         list << element
 
         if @exlucde_end
-          list << element while (element = element + argument) < @right
+          while (element = element + argument) < @right
+            list << element
+          end
         else
-          list << element while (element = element + argument) <= @right
+          while (element = element + argument) <= @right
+            list << element
+          end
         end
 
         list

data/lib/code/object/string.rb

@@ -15,6 +15,8 @@ class Code
           to_function(arguments)
         elsif operator == "+"
           plus(arguments)
+        elsif operator == "*"
+          multiplication(arguments)
         elsif operator == "reverse"
           reverse(arguments)
         else
@@ -51,6 +53,12 @@ class Code
         ::Code::Object::String.new(raw + other.raw)
       end
 
+      def multiplication(arguments)
+        sig(arguments, ::Code::Object::Number)
+        other = arguments.first.value
+        ::Code::Object::String.new(raw * other.raw)
+      end
+
       def reverse(arguments)
         sig(arguments)
         ::Code::Object::String.new(raw.reverse)

data/lib/code/object.rb

@@ -45,11 +45,7 @@ class Code
 
     def <=>(other)
       if respond_to?(:raw)
-        if other.respond_to?(:raw)
-          raw <=> other.raw
-        else
-          raw <=> other
-        end
+        other.respond_to?(:raw) ? raw <=> other.raw : raw <=> other
       else
         other <=> self
       end
@@ -57,11 +53,7 @@ class Code
 
     def ==(other)
       if respond_to?(:raw)
-        if other.respond_to?(:raw)
-          raw == other.raw
-        else
-          raw == other
-        end
+        other.respond_to?(:raw) ? raw == other.raw : raw == other
       else
         other == self
       end

data/lib/code/parser/code.rb

@@ -9,7 +9,8 @@ class Code
       rule(:whitespace?) { whitespace.maybe }
 
       rule(:code) do
-        (whitespace?.ignore >> statement >> whitespace?.ignore).repeat(1) | whitespace?.ignore
+        (whitespace?.ignore >> statement >> whitespace?.ignore).repeat(1) |
+          whitespace?.ignore
       end
 
       root(:code)

data/lib/code.rb

@@ -1,22 +1,26 @@
 class Code
-  def initialize(input, io: $stdout)
+  def initialize(input, io: $stdout, timeout: 10)
     @input = input
-    @parsed = ::Code::Parser::Code.new.parse(@input)
+    @parsed =
+      Timeout.timeout(timeout) { ::Code::Parser::Code.new.parse(@input) }
     @io = io
+    @timeout = timeout
   end
 
-  def self.evaluate(input, context = "", io: $stdout)
-    new(input, io: io).evaluate(context)
+  def self.evaluate(input, context = "", io: $stdout, timeout: 10)
+    new(input, io: io, timeout: timeout).evaluate(context)
   end
 
   def evaluate(context = "")
-    if context.present?
-      context = ::Code.evaluate(context)
-    else
-      context = ::Code::Object::Dictionnary.new
-    end
+    Timeout.timeout(@timeout) do
+      if context.present?
+        context = ::Code.evaluate(context, timeout: @timeout)
+      else
+        context = ::Code::Object::Dictionnary.new
+      end
 
-    ::Code::Node::Code.new(parsed).evaluate(context: context, io: @io)
+      ::Code::Node::Code.new(parsed).evaluate(context: context, io: @io)
+    end
   end
 
   private

data/lib/template/parser/template.rb

@@ -15,10 +15,14 @@ class Template
       end
 
       rule(:code_part) do
-        left_curly_bracket.ignore >> code >> (right_curly_bracket.ignore | any.absent?)
+        left_curly_bracket.ignore >> code >>
+          (right_curly_bracket.ignore | any.absent?)
       end
 
-      rule(:template) { (text_part.as(:text) | code_part.as(:code)).repeat(1) }
+      rule(:template) do
+        (text_part.as(:text) | code_part.as(:code)).repeat(1) |
+          str("").as(:text).repeat(1, 1)
+      end
 
       root(:template)
     end

data/lib/template/version.rb

@@ -0,0 +1,3 @@
+require_relative "../template"
+
+Template::Version = Gem::Version.new("0.2.4")

data/lib/template-ruby.rb

@@ -4,6 +4,7 @@ require "bigdecimal"
 require "active_support"
 require "active_support/core_ext/object/blank"
 require "stringio"
+require "timeout"
 
 loader = Zeitwerk::Loader.for_gem(warn_on_extra_files: false)
 loader.ignore(__FILE__)

data/lib/template.rb

@@ -1,25 +1,34 @@
 class Template
-  VERSION = Gem::Version.new("0.2.1")
-
-  def initialize(input, io: StringIO.new)
+  def initialize(input, io: StringIO.new, timeout: 10)
     @input = input
-    @parsed = ::Template::Parser::Template.new.parse(@input)
+    @parsed =
+      Timeout.timeout(timeout) do
+        ::Template::Parser::Template.new.parse(@input)
+      end
     @io = io
+    @timeout = timeout
   end
 
-  def self.render(input, context = "", io: StringIO.new)
-    new(input, io: io).render(context)
+  def self.render(input, context = "", io: StringIO.new, timeout: 10)
+    new(input, io: io, timeout: timeout).render(context)
   end
 
   def render(context = "")
-    if context.present?
-      context = ::Code.evaluate(context)
-    else
-      context = ::Code::Object::Dictionnary.new
-    end
+    Timeout.timeout(@timeout) do
+      if context.present?
+        context = ::Code.evaluate(context, timeout: @timeout)
+      else
+        context = ::Code::Object::Dictionnary.new
+      end
 
-    ::Template::Node::Template.new(@parsed).evaluate(context: context, io: @io)
+      ::Template::Node::Template.new(@parsed).evaluate(
+        context: context,
+        io: @io,
+      )
 
-    @io.is_a?(StringIO) ? @io.string : nil
+      @io.is_a?(StringIO) ? @io.string : nil
+    end
   end
 end
+
+require_relative "template/version"

data/spec/code/parser/call_spec.rb

@@ -21,9 +21,7 @@ RSpec.describe Code::Parser::Call do
               },
             },
           },
-          right: [{
-            name: "times",
-          }],
+          right: [{ name: "times" }],
         },
       },
     ],

data/spec/code_spec.rb

@@ -95,6 +95,7 @@ RSpec.describe Code do
     ["until true end", ""],
     ["until true\nend", ""],
     %w[("Good".."Bad").first Good],
+    ['"Dorian " * 2', "Dorian Dorian "],
   ].each do |(input, expected)|
     context input.inspect do
       let(:input) { input }

data/spec/template_spec.rb

@@ -12,9 +12,8 @@ RSpec.describe Template do
       '{ user: { first_name: "Dorian" } }',
       "Hello Dorian",
     ],
-    [<<~TEMPLATE, "", "Hello "]
-      Hello {
-      TEMPLATE
+    ["Hello {", "", "Hello "],
+    ["", "", ""],
   ].each do |(input, input_context, expected)|
     context "#{input.inspect} #{input_context.inspect}" do
       let(:input) { input }

data/template-ruby.gemspec

@@ -1,8 +1,8 @@
-require_relative "lib/template-ruby"
+require_relative "lib/template/version"
 
 Gem::Specification.new do |s|
   s.name = "template-ruby"
-  s.version = ::Template::VERSION
+  s.version = ::Template::Version
   s.summary = "A templating programming language"
   s.description =
     'Like "Hello {name}" with {name: "Dorian"} gives "Hello Dorian"'
@@ -13,6 +13,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
   s.homepage = "https://github.com/dorianmariefr/template-ruby"
   s.license = "MIT"
+  s.executables = "template"
 
   s.add_dependency "activesupport", "~> 7"
   s.add_dependency "parslet", "~> 2"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: template-ruby
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.4
 platform: ruby
 authors:
 - Dorian Marié
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-31 00:00:00.000000000 Z
+date: 2022-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -82,18 +82,22 @@ dependencies:
         version: '3'
 description: 'Like "Hello {name}" with {name: "Dorian"} gives "Hello Dorian"'
 email: dorian@dorianmarie.fr
-executables: []
+executables:
+- template
 extensions: []
 extra_rdoc_files: []
 files:
 - ".editorconfig"
+- ".github/workflows/rspec.yml"
 - ".gitignore"
 - ".prettierrc"
 - ".rspec"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
+- LICENSE
 - README.md
+- TODO.md
 - bin/template
 - docs/euler/1.template
 - docs/euler/2.template
@@ -201,6 +205,7 @@ files:
 - lib/template/node/text_part.rb
 - lib/template/parser.rb
 - lib/template/parser/template.rb
+- lib/template/version.rb
 - spec/call_spec.rb
 - spec/code/error/type_error_spec.rb
 - spec/code/parser/boolean_spec.rb