gtx 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dbf48aaa95d8b915bf90f634babcbf37ef5b95527000b84677f273cde39fa8a5
+  data.tar.gz: f95cae7c6a9b04b5de554a2600040fe943a628667d0601a2e8afdbf1745b8c4c
+SHA512:
+  metadata.gz: a7929b4d3985d2a146dac93693f51a74ea78d8745505980fb717e0fbd4c32ad07b7ac5d60ea202a030ff742631666ea0a3b1cdc2c1607c6f192aeb913fa0ec4b
+  data.tar.gz: b9e3b4427d0d4f23fa6130cbf2bf73f531cf7fcc1f3465fa405852b434b7554c8d04fefda00725662e3124f2e685c543b5bed8025fa384864b11b0a63629e604

data/README.md

@@ -0,0 +1,155 @@
+# GTX - Minimal Template Engine
+
+[![Gem Version](https://badge.fury.io/rb/gtx.svg)](https://badge.fury.io/rb/gtx)
+[![Build Status](https://github.com/DannyBen/gtx/workflows/Test/badge.svg)](https://github.com/DannyBen/gtx/actions?query=workflow%3ATest)
+
+---
+
+GTX is a minimal template engine that transpiles to ERB before using it to 
+generate the output.
+
+As opposed to ERB, GTX is a code-first template engine - where Ruby code does
+not need to be enclosed in tags. Instead, the output of the template needs to
+be marked with a "Greater Than" sign (hence the name).
+
+## Install
+
+```bash
+$ gem install gtx
+```
+
+## Template Syntax
+
+### Summary
+
+GTX converts your template code to ERB before rendering its output. 
+
+<table>
+<tr><th>GTX</th><th>ERB</th></tr>
+<tr><td>
+
+```ruby
+> any text
+> inline code: {{ "hello " * 3 }}
+>          or: <%= "world " * 3 %>
+
+3.times do |i|
+  > loopy text {{ i + 1 }}
+end
+
+= user.welcome_message
+```
+      
+</td><td>
+
+```ruby
+any text
+inline code: <%= "hello " * 3 %>
+         or: <%= "world " * 3 %>
+
+<%- 3.times do |i| -%>
+loopy text <%= i + 1 %>
+<%- end -%>
+
+<%= user.welcome_message %>
+```
+
+</td></tr></table>
+
+The conversion is specifically kept at 1:1 ratio, so that the correct line number
+can be referenced in case of an error.
+
+### Explanation
+
+Lines starting with `>` are treated as output. Any number of spaces before and
+one space after the `>` are ignored:
+
+```ruby
+> this line will output as is
+```
+
+Using `{{ ... }}` in an output line executes inline ruby code, as if it is
+ERB's `<%= ... %>` syntax:
+
+```ruby
+> any ruby code: {{ "hello " * 3 }}
+```
+
+Lines starting with `=` can be used to execute ruby code that returns a string
+that is expected to be a part of the output.
+
+```ruby
+= user.welcome_message(:morning)
+# which is a shortcut to:
+> {{ user.welcome_message(:morning) }}
+```
+
+Any other line, will be treated as Ruby code and will be enclosed using ERB's 
+`<%- ... -%>` syntax.
+
+See the [example template](examples/full.rb) for additional nuances.
+
+## Usage
+
+### Using a GTX Instance
+
+```ruby
+require 'gtx'
+
+# Create an instance
+path = "path/to/template_file"
+template = File.read path
+gtx = GTX.new template, filename: path
+
+# Parse it with optional context
+gtx.parse any_object
+
+# ... or with local binding
+gtx.parse binding
+
+# Get the ERB source
+gtx.erb_source
+
+# ... or the ERB object
+gtx.erb
+
+```
+
+### Class Shortcuts
+
+```ruby
+require 'gtx'
+
+# One-liner render template from file
+GTX.render_file path
+
+# ... with a context or Binding object
+GTX.render_file path, context: any_object
+
+# Get an instance, and parse later
+gtx = GTX.load_file path
+gtx.parse optional_context_object
+
+# Render from string
+GTX.render string, context: optional_object, filename: optional_filename
+```
+
+
+## But... why?
+
+GTX was created to provide a code-first alternative to ERB, specifically for 
+the code generation templates used by [Bashly][bashly]. Enclosing Ruby code
+inside ERB tags, and ensuring there are no excess empty lines in the ERB
+template yielded some hard-to-maintain templates.
+
+
+## Contributing / Support
+
+If you experience any issue, have a question or a suggestion, or if you wish
+to contribute, feel free to [open an issue][issues].
+
+---
+
+[issues]: https://github.com/DannyBen/gtx/issues
+[bashly]: https://bashly.dannyb.co/
+

data/lib/gtx/version.rb

@@ -0,0 +1,3 @@
+class GTX
+  VERSION = "0.1.0"
+end

data/lib/gtx.rb

@@ -0,0 +1,52 @@
+require 'erb'
+
+class GTX
+  class << self
+    def render(template, context: nil, filename: nil)
+      new(template, filename: filename).parse context
+    end
+
+    def load_file(path, filename: nil)
+      new File.read(path), filename: (filename || path)
+    end
+
+    def render_file(path, context: nil, filename: nil)
+      load_file(path, filename: filename).parse context
+    end
+  end
+
+  attr_reader :template, :filename
+
+  def initialize(template, filename: nil)
+    @template, @filename = template, filename
+  end
+
+  def erb_source
+    template.each_line.map do |line|
+      case line
+      when /^\s*> ?(.*)/ then eval_vars $1
+      when /^\s*= ?(.*)/ then "<%= #{eval_vars $1.strip} %>"
+      else "<%- #{line.strip} -%>"
+      end
+    end.join "\n"
+  end
+
+  def erb
+    ERB.new(erb_source, trim_mode: '-').tap { |a| a.filename = filename }
+  end
+  
+  def parse(context = nil)
+    context ||= self
+    context = context.instance_eval { binding } unless context.is_a? Binding
+    erb.result context
+  end
+
+protected
+
+  def eval_vars(string)
+    string.gsub(/{{([^{].*?)}}/, '<%=\1%>')
+      .gsub(/\\\}\\\}/, '}}')
+      .gsub(/\\\{\\\{/, '{{')
+  end
+
+end

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: gtx
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Danny Ben Shitrit
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-06-13 00:00:00.000000000 Z
+dependencies: []
+description: Create templates that transpile to ERB
+email: db@dannyben.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/gtx.rb
+- lib/gtx/version.rb
+homepage: https://github.com/dannyben/gtx
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/DannyBen/gtx/issues
+  changelog_uri: https://github.com/DannyBen/gtx/blob/master/CHANGELOG.md
+  homepage_uri: https://github.com/dannyben/gtx
+  source_code_uri: https://github.com/dannyben/gtx
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.14
+signing_key: 
+specification_version: 4
+summary: GTX Template Engine
+test_files: []