template-ruby 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d5e2a863316056d011b034cc0c819984d710899e8b51657dd15636e45db058b0
-  data.tar.gz: 47974cad2e705fb70706b68a496523f414b3027c6f57ec6d22344c588cdce143
+  metadata.gz: 0d53d39478e69a97de7680a29e4a47634804ed0bb82badf8ec255ef70ca32968
+  data.tar.gz: 431593c814bf56bcecc3f28e6564b6e3799e674183fdf5b298b4e913b8604d43
 SHA512:
-  metadata.gz: 1ba52300910fb32458e115c200842c3a2ef18a19e8fddee92c38a961d60637d3c3c73906304184ef0ec5771ad85cc5dd19d8dbe0803a872a2c5c0dd69cc82a16
-  data.tar.gz: d526bbd95df4375aee06d4c9cc8bb8c6f2927b725514527dd9d3e29229223235bf0c8870d917eb61ae30cbce52e2c27a5f18ba31a2b1fcc94b0dfc574bf77bd1
+  metadata.gz: b11d8a9daf795dfd5c90eaed1246f85951b76c417e7b4775fe55997b88255a290bd17ed0427c7d7c4d927b20b537cc5353e8a91f76bc2d442527415b209a812b
+  data.tar.gz: 8266b19ec1b8d73a35490264ec593ef8c6609229335d99c30bc196b7719455791f240f08ea56890a40d4f0e0a6dea1973a4043ff40f3308f0b96d4ef07e61f28

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,6 +5,26 @@ 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.3.0 / ?
+
+- `bin/template` accepts `--timeout` (or `-t`) parameter
+- Adds `bin/code` with same options as `bin/template`
+- Prevent loose syntax like `{ a: }`, `[1,,,]` and `()`
+- Change precedence of defined? (to allow `defined?(name) ? name : nothing`)
+- Updates parsers to allow `while false end == nothing`
+- String interpolations like `"1 + 1 = {1 + 1}"`
+- `context(:name)` to get a function without calling it for instance
+- `.to_string` on all objects
+- `1 + "a"` and `"a" + 1.0` for instance now convert to strings
+- `Dictionnary#each` e.g. `{ a: 1 }.each { |k, v| print(k) }`
+- Fix context duplication issue that was preventing implementation of recursive
+  functions like Fibonacci
+
+## 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

data/Gemfile

@@ -1,3 +1,4 @@
 source "https://rubygems.org"
 
-gemspec
+gemspec name: "template-ruby"
+gemspec name: "code-ruby"

data/Gemfile.lock

@@ -1,7 +1,11 @@
 PATH
   remote: .
   specs:
-    template-ruby (0.2.2)
+    code-ruby (0.2.4)
+      activesupport (~> 7)
+      parslet (~> 2)
+      zeitwerk (~> 2.6)
+    template-ruby (0.2.4)
       activesupport (~> 7)
       parslet (~> 2)
       zeitwerk (~> 2.6)
@@ -62,6 +66,7 @@ PLATFORMS
   arm64-darwin-21
 
 DEPENDENCIES
+  code-ruby!
   prettier (~> 3)
   rspec (~> 3)
   template-ruby!

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/bin/code

@@ -0,0 +1,51 @@
+#!/usr/bin/env ruby
+
+require "optparse"
+require_relative "../lib/template-ruby"
+
+options = { timeout: 0 }
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: bin/code [options]"
+
+  opts.on(
+    "-i INPUT",
+    "--input=INPUT",
+    "Input in the code language (String or File)"
+  ) do |input|
+    if File.exists?(input)
+      input = File.read(input)
+    end
+
+    options[:input] = input
+  end
+
+  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
+
+    options[:context] = context
+  end
+
+  opts.on("-p", "--parse", "Get parser results for input") do |parse|
+    options[:parse] = parse
+  end
+
+  opts.on("-t TIMEOUT", "--timeout=TIMEOUT", "Set timeout in seconds") do |timeout|
+    options[:timeout] = timeout.to_f
+  end
+end.parse!
+
+input = options.fetch(:input, "")
+context = options.fetch(:context, "")
+
+if options[:parse]
+  pp ::Code::Parser::Code.new.parse(input)
+else
+  print Code.evaluate(input, context, io: $stdout, timeout: options[:timeout]).to_s
+end

data/bin/template

@@ -3,12 +3,12 @@
 require "optparse"
 require_relative "../lib/template-ruby"
 
-options = {}
+options = { timeout: 0 }
 
 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
@@ -27,6 +27,10 @@ OptionParser.new do |opts|
   opts.on("-p", "--parse", "Get parser results for input") do |parse|
     options[:parse] = parse
   end
+
+  opts.on("-t TIMEOUT", "--timeout=TIMEOUT", "Set timeout in seconds") do |timeout|
+    options[:timeout] = timeout.to_f
+  end
 end.parse!
 
 input = options.fetch(:input, "")
@@ -35,5 +39,5 @@ context = options.fetch(:context, "")
 if options[:parse]
   pp ::Template::Parser::Template.new.parse(input)
 else
-  Template.render(input, context, io: $stdout)
+  Template.render(input, context, io: $stdout, timeout: options[:timeout])
 end

data/code-ruby.gemspec

@@ -0,0 +1,22 @@
+require_relative "lib/template/version"
+
+Gem::Specification.new do |s|
+  s.name = "code-ruby"
+  s.version = ::Template::Version
+  s.summary = "A programming language"
+  s.description = 'A programming language, like Code.evaluate("1 + 1") # => 2'
+  s.authors = ["Dorian Marié"]
+  s.email = "dorian@dorianmarie.fr"
+  s.files = `git ls-files`.split($/)
+  s.test_files = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ["lib"]
+  s.homepage = "https://github.com/dorianmariefr/template-ruby"
+  s.license = "MIT"
+
+  s.add_dependency "activesupport", "~> 7"
+  s.add_dependency "parslet", "~> 2"
+  s.add_dependency "zeitwerk", "~> 2.6"
+
+  s.add_development_dependency "prettier", "~> 3"
+  s.add_development_dependency "rspec", "~> 3"
+end

data/docs/euler/4.template

@@ -3,7 +3,6 @@
   min = 1
   max = 999
 
-
   (min..max).map do |i|
     ((min..max).to_list.reverse.detect do |j|
       (i * j).to_string.reverse == (i * j).to_string

data/docs/fibonnaci.template

@@ -0,0 +1,14 @@
+{
+  fibonnaci = (n) => {
+    if n < 2
+      n
+    else
+      fibonnaci(n - 1) + fibonnaci(n - 2)
+    end
+  }
+
+  (0..20).each do |i|
+    puts("fibonnaci({i}) = {fibonnaci(i)}")
+  end
+
+  nothing

data/docs/precedence.template

@@ -2,58 +2,33 @@
   - {a = "Go" a += "od" a}
 - Statement
   - {a = "Good"}
-  - {
-     a = 0
-     while a < 10
-       a += 1
-       "Good"
-    end
-    }
+- Equality
+  - {1 == 1 ? "Good"}
 - While
-  - {
-     a = 0
-     until a > 10
-       a += 1
-       "Good"
-    end
-    }
-  - {
-    a = 0
-    while
-      if a > 10
-        false
-      else
-        true
-      end
-      a += 1
-      "Good"
-    end
-    }
+  - {a = 0
+     while a < 10 a += 1 "Good" end}
 - If
   - {if true "Good" end}
-  - {if true if false "Bad" else "Good" end}
 - IfModifier
   - {"Good" if true}
 - OrKeyword
   - {false or "Good"}
 - NotKeyword
   - {not false and "Good"}
-- Defined
-  - {a = 1 "Good" if defined?(a)}
 - Equal
   - {a = "Good"}
 - Rescue
   - {0 > "String" rescue "Good"}
 - Ternary
   - {nothing ? "Bad" : "Good"}
+- Defined
+  - {a = 1 "Good" if defined?(a)}
 - Range
   - {("Good".."Bad").first}
 - OrOperator
   - {false || "Good"}
 - AndOperator
   - {"Bad" && "Good"}
-- Equality
-  - {1 == 1 ? "Good"}
 - GreaterThan
   - {2 > 1 ? "Good"}
 - BitwiseOr

data/lib/code/node/code.rb

@@ -9,7 +9,13 @@ class Code
       end
 
       def evaluate(**args)
-        @statements.map { |statement| statement.evaluate(**args) }.last
+        last = ::Code::Object::Nothing.new
+
+        @statements.each do |statement|
+          last = statement.evaluate(**args)
+        end
+
+        last
       end
     end
   end

data/lib/code/node/list.rb

@@ -2,13 +2,13 @@ class Code
   class Node
     class List < Node
       def initialize(codes)
-        @codes =
-          codes
-            .map do |code|
-              code.fetch(:code).presence &&
-                ::Code::Node::Code.new(code.fetch(:code))
-            end
-            .compact
+        if codes.to_s.blank?
+          @codes = []
+        else
+          @codes = codes.map do |code|
+            ::Code::Node::Code.new(code.fetch(:code))
+          end
+        end
       end
 
       def evaluate(**args)

data/lib/code/node/name.rb

@@ -33,8 +33,13 @@ class Code
           end
         elsif name == "puts"
           arguments.each { |argument| io.puts argument.value }
-
           ::Code::Object::Nothing.new
+        elsif name == "print"
+          arguments.each { |argument| io.print argument.value }
+          ::Code::Object::Nothing.new
+        elsif name == "context"
+          return ::Code::Object::Nothing.new if arguments.size != 1
+          context[arguments.first&.value] || ::Code::Object::Nothing.new
         else
           raise ::Code::Error::Undefined.new("#{name} undefined")
         end

data/lib/code/node/string.rb

@@ -2,16 +2,21 @@ class Code
   class Node
     class String < Node
       def initialize(string)
-        @string = string
+        if string.to_s.blank?
+          @string = []
+        elsif string.is_a?(Array)
+          @string = string.map do |component|
+            ::Code::Node::StringComponent.new(component)
+          end
+        else
+          @string = [::Code::Node::StringCharacters.new(string)]
+        end
       end
 
       def evaluate(**args)
-        ::Code::Object::String.new(string.to_s)
+        string = @string.map { |component| component.evaluate(**args) }.map(&:to_s).join
+        ::Code::Object::String.new(string)
       end
-
-      private
-
-      attr_reader :string
     end
   end
 end

data/lib/code/node/string_characters.rb

@@ -0,0 +1,13 @@
+class Code
+  class Node
+    class StringCharacters < Node
+      def initialize(characters)
+        @characters = characters
+      end
+
+      def evaluate(**args)
+        ::Code::Object::String.new(@characters.to_s)
+      end
+    end
+  end
+end

data/lib/code/node/string_component.rb

@@ -0,0 +1,23 @@
+class Code
+  class Node
+    class StringComponent < Node
+      def initialize(component)
+        if component.key?(:characters)
+          @component = ::Code::Node::StringCharacters.new(
+            component.fetch(:characters)
+          )
+        elsif component.key?(:interpolation)
+          @component = ::Code::Node::StringInterpolation.new(
+            component.fetch(:interpolation)
+          )
+        else
+          raise NotImplementedError.new(component.inspect)
+        end
+      end
+
+      def evaluate(**args)
+        @component.evaluate(**args)
+      end
+    end
+  end
+end

data/lib/code/node/string_interpolation.rb

@@ -0,0 +1,13 @@
+class Code
+  class Node
+    class StringInterpolation < Node
+      def initialize(interpolation)
+        @interpolation = ::Code::Node::Code.new(interpolation)
+      end
+
+      def evaluate(**args)
+        @interpolation.evaluate(**args)
+      end
+    end
+  end
+end

data/lib/code/object/argument.rb

@@ -30,7 +30,7 @@ class Code
       end
 
       def to_s
-        "argument"
+        "<Argument #{value.inspect}>"
       end
 
       def inspect

data/lib/code/object/decimal.rb

@@ -19,10 +19,14 @@ class Code
         operator = args.fetch(:operator, nil)
         arguments = args.fetch(:arguments, [])
 
-        if %w[% - + / * **].detect { |o| operator == o }
+        if %w[% - / * **].detect { |o| operator == o }
           number_operation(operator.to_sym, arguments)
         elsif %w[< <= > >=].detect { |o| operator == o }
           comparaison(operator.to_sym, arguments)
+        elsif %w[<< >> & | ^].detect { |o| operator == o }
+          integer_operation(operator.to_sym, arguments)
+        elsif operator == "+"
+          plus(arguments)
         else
           super
         end
@@ -44,11 +48,28 @@ class Code
         ::Code::Object::Decimal.new(raw.public_send(operator, other.raw))
       end
 
+      def integer_operation(operator, arguments)
+        sig(arguments, ::Code::Object::Number)
+        other = arguments.first.value
+        ::Code::Object::Integer.new(raw.to_i.public_send(operator, other.raw.to_i))
+      end
+
       def comparaison(operator, arguments)
         sig(arguments, ::Code::Object::Number)
         other = arguments.first.value
         ::Code::Object::Boolean.new(raw.public_send(operator, other.raw))
       end
+
+      def plus(arguments)
+        sig(arguments, ::Code::Object)
+        other = arguments.first.value
+
+        if other.is_a?(::Code::Object::Number)
+          ::Code::Object::Decimal.new(raw + other.raw)
+        else
+          ::Code::Object::String.new(to_s + other.to_s)
+        end
+      end
     end
   end
 end

data/lib/code/object/dictionnary.rb

@@ -10,9 +10,13 @@ class Code
       def call(**args)
         operator = args.fetch(:operator, nil)
         arguments = args.fetch(:arguments, [])
+        context = args.fetch(:context)
+        io = args.fetch(:io)
 
         if operator == "values"
           values(arguments)
+        elsif operator == "each"
+          each(arguments, context: context, io: io)
         elsif key?(operator)
           fetch(operator)
         else
@@ -36,6 +40,10 @@ class Code
         raw.key?(key)
       end
 
+      def deep_dup
+        ::Code::Object::Dictionnary.new(raw.deep_dup)
+      end
+
       def to_s
         "{#{raw.map { |key, value| "#{key.inspect} => #{value.inspect}" }.join(", ")}}"
       end
@@ -50,6 +58,22 @@ class Code
         sig(arguments)
         ::Code::Object::List.new(raw.values)
       end
+
+      def each(arguments, context:, io:)
+        sig(arguments, ::Code::Object::Function)
+        argument = arguments.first.value
+        raw.each do |key, value|
+          argument.call(
+            arguments: [
+              ::Code::Object::Argument.new(key),
+              ::Code::Object::Argument.new(value)
+            ],
+            context: context,
+            io: io,
+          )
+        end
+        self
+      end
     end
   end
 end

data/lib/code/object/function.rb

@@ -32,7 +32,8 @@ class Code
       attr_reader :arguments, :body
 
       def call_function(args:, context:, io:)
-        new_context = context.dup
+        new_context = context.deep_dup
+
         arguments.each.with_index do |argument, index|
           if argument.regular?
             if argument.splat?