ruex 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 13224922b7e3d224c8519f480b1cd5ba0b0c5838330af7f240520a703c8f149f
+  data.tar.gz: aee7340b08113ad97b628bcb056c5069428e51e982d74af4645f0849858ab7cd
+SHA512:
+  metadata.gz: 224c71be4526088840e75d8440a8ce07ca8b5e6a1a76f922f2a1700af635114b3f3f0b0603956dbd2688665796cb1c16c74fdc06e1da0aca49bae6d318f2fb92
+  data.tar.gz: c615a249f8a61ea13e6d5b50851a725c97c0c16a6b2f870e6f1befd7f3d445c8bb3e93f64dc0699aa29a8cc04a7ca8b2ad3693d75d35933a271c180b592e26f3

data/LICENSE

@@ -0,0 +1,24 @@
+BSD 2-Clause License
+
+Copyright (c) 2026, takanobu maekawa
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,205 @@
+# ruex
+
+A library and CLI tool that generates HTML using plain Ruby expressions.
+It is intended for static site or page generation, and is not suitable as a dynamic web page renderer.
+
+Technically, you only need to know HTML, CSS, and Ruby — nothing more.
+Easy to extend when needed.
+
+---
+
+## Installation
+
+```sh
+gem install ruex
+```
+
+Or add to your Gemfile:
+
+```ruby
+gem "ruex"
+```
+
+---
+
+## Quick Example
+
+```shell
+$ ruex -e 'div { p "hello" }'
+<div><p>hello</p></div>
+
+# same thing by the command pipeline
+$ echo 'div { p "hello" }' | ruex
+<div><p>hello</p></div>
+```
+
+## How it works
+
+Every standard HTML tag is available as a Ruby method.
+
+```shell
+$ ruex -e 'p "hello"'
+<p>hello</p>
+```
+
+### Attributes
+
+```shell
+$ ruex -e 'p "Hi", class: "msg"'
+<p class="msg">Hi</p>
+```
+
+### Blocks
+
+You can write child elements inside blocks:
+
+```shell
+$ ruex -e 'div { p "Hello" }'
+<div><p>Hello</p></div>
+```
+
+### Mixing Ruby code
+
+You can freely mix Ruby code.
+
+```shell
+$ cat list.html.rx
+ul{
+  %w[Foo Bar].each do |name|
+    li(name)
+  end
+}
+
+$ cat list.html.rx | ruex
+<ul><li>Foo</li><li>Bar</li></ul>
+```
+
+### Variable binding
+
+```shell
+$ cat table.html.rx
+table {
+  people.each do |person|
+    tr{ td(person[:name]) }
+  end
+}
+
+$ cat table.html.rx | ruex -b '{people: [{name: "hoge"}, {name: "bar"}]}'
+<table><tr><td>hoge</td></tr><tr><td>bar</td></tr></table>
+```
+
+### Embedding text
+
+`text` and `_` functions embed texts in HTML:
+
+```shell
+$ ruex -e 'text "Today is a good day"'
+Today is a good day
+
+$ ruex -e '_"Today is a good day"'
+Today is a good day
+
+$ ruex -e 'div{ _"Today is a good day" }'
+<div>Today is a good day</div>
+```
+
+### HTML comments
+
+ruex does not provide a comment function.
+If you want to include an HTML comment, write it directly as a string:
+
+```shell
+$ ruex -e 'div { _"<!-- note -->" }'
+<div><!-- note --></div>
+```
+
+### Custom Tags
+
+Just compose HTML using ruex expressions.
+
+```ruby
+# my_tags.rb
+
+require 'ruex'
+
+module MyTag
+  include Ruex
+
+  def card(title, &block)
+    div(class: "card"){
+      h2 title
+      block.call if block_given?
+    }
+  end
+end
+```
+
+There are a few things you should know:
+
+- you must provide your custom tag library as a module.
+- Your module name must correspond to its file name (PascalCase → snake_case).
+  ex) MyTag -> my_tag.rb
+
+
+You can use your library throuth `ruex` command, of course.
+
+```shell
+$ ruex -I /your/ruby/load/path -r my_tags.rb -e 'card("Hello") { p "world" }'
+<div class="card"><h2>Hello</h2><p>world</p></div>
+```
+
+If you make your custom tag library as Ruby gems, you don't need to specify `-I`.
+
+### CLI options
+
+```shell
+$ ruex -h
+Render ruex expressions as HTML.
+
+Usage:
+  echo 'p "hello"' | ruex
+  ruex -e 'p "hello"'
+  ruex -f template.ruex
+
+Options:
+  -I, --include-path PATH     Add PATH to $LOAD_PATH
+  -r, --require LIB           Require LIB and include its module into Ruex::Core
+  -e, --expr EXPR             Evaluate EXPR instead of reading from stdin
+  -f, --file FILE             Read Ruex DSL from FILE
+  -b, --bind KEY=VALUE        Bind a variable available inside Ruex DSL
+  -c, --context-file FILE     Load variables from YAML or JSON file
+  -v, --version               Show Ruex version
+  -h, --help                  Show this help message
+```
+
+### Using in program code
+
+1. To use ruex in Ruby code, include `Ruex`
+2. use `render` method
+
+```ruby
+require 'ruex'
+
+include Ruex
+
+render 'div { _"Hello, World!!" }'
+```
+
+All tag name methods such as `div`, `p` and so on are **not intended to use outside the string literals.**
+
+## Intended Use / Safety Notes
+ruex evaluates Ruby expressions directly.
+Use it with trusted, developer-authored templates such as static site content.
+It is not intended for rendering untrusted input in web applications.
+
+## License
+
+ruex is distributed under the BSD 2-Clause License (SPDX: BSD-2-Clause).
+See the LICENSE file for details.
+
+## Author
+
+Takanobu Maekawa
+
+https://github.com/tmkw
+

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bin/ruex

@@ -0,0 +1,82 @@
+#!/usr/bin/env ruby
+
+require "optparse"
+require "stringio"
+require "ruex/cli"
+require "ruex/version"
+require "ruex/helper/cli"
+
+include Ruex::Helper::CLI
+
+load_paths    = []
+require_files = []
+expr          = nil
+file_path     = nil
+bindings      = {}
+context_file  = nil
+
+opts = OptionParser.new do |opt|
+  opt.on("-I", "--include-path PATH") { |path| load_paths << path }
+  opt.on("-r", "--require LIB")       { |lib|  require_files << lib }
+  opt.on("-e", "--expr EXPR")         { |e| expr = e }
+  opt.on("-f", "--file FILE")         { |path| file_path = path }
+
+  opt.on("-b", "--bind RUBY_HASH") do |str|
+    begin
+      hash = ContextFile.read(StringIO.new(str))
+      bindings.merge!(hash)
+    rescue => e
+      warn e.message
+      exit(1)
+    end
+  end
+
+  opt.on("-c", "--context-file FILE") do |file|
+    context_file = file
+  end
+
+  opt.on("-h", "--help") do
+    puts load_help
+    exit(0)
+  end
+
+  opt.on("-v", "--version") do
+    puts Ruex::VERSION
+    exit(0)
+  end
+end
+
+begin
+  opts.parse!(ARGV)
+rescue OptionParser::InvalidOption => e
+  warn "Unknown option: #{e.args.join(" ")}"
+  exit(1)
+end
+
+# Load context file
+if context_file
+  begin
+    bindings.merge!(ContextFile.read(context_file))
+  rescue => e
+    warn e.message
+    exit(1)
+  end
+end
+
+# Load paths
+load_paths.each { |p| $LOAD_PATH.unshift(p) }
+
+# load custom tag libraries
+require_files.each do |lib|
+  require lib
+  mod_name = path_to_module_name(lib)
+  Ruex::Core.include(Object.const_get(mod_name))
+end
+
+# Execute
+Ruex::CLI.new.run(
+  expr: expr,
+  file: file_path,
+  ctx: bindings
+)
+

data/lib/ruex/cli.rb

@@ -0,0 +1,23 @@
+require 'ruex'
+
+module Ruex
+  class CLI
+    include Ruex
+
+    def run(expr: nil, file: nil, ctx: {})
+      input = if expr
+                expr
+              elsif file
+                File.read(file)
+              else
+                $stdin.read
+              end
+
+      input = input.to_s.strip
+      return if input.empty?
+
+      puts render(input, ctx: ctx)
+    end
+  end
+end
+

data/lib/ruex/core.rb

@@ -0,0 +1,88 @@
+module Ruex
+  class Core
+    require 'yaml'
+
+    TAGS = YAML.load_file([__dir__, "tags.yml"].join('/'))
+
+    def initialize
+      @output = ''.dup
+    end
+
+    def render_attrs(attrs, boolean_attrs)
+      return '' if attrs.empty?
+
+      parts = []
+
+      # data attributes
+      if attrs.key?(:data)
+        data_hash = attrs.delete(:data)
+        data_hash.each do |k, v|
+          html_key = "data-#{k.to_s.gsub('_', '-')}"
+          parts << %(#{html_key}="#{v}")
+        end
+      end
+
+      attrs.each do |k, v|
+        if boolean_attrs&.include?(k)
+          # boolean attributes
+          parts << k.to_s if v   # use only when the option is enabled
+        else
+          # normal attributes
+          parts << %(#{k}="#{v}")
+        end
+      end
+
+      parts.join(" ")
+    end
+
+    def render_tag(tag_def, args, attrs, block)
+      name = tag_def['name']
+      void = tag_def['void']
+      boolean_attrs = (tag_def['boolean'] || []).map(&:to_sym)
+
+      rendered_attrs = render_attrs(attrs, boolean_attrs)
+      attr_str = rendered_attrs.empty? ? '' : %( #{rendered_attrs})
+
+      if void
+        @output << "<#{name}#{attr_str}>".dup
+        return
+      end
+
+      @output << "<#{name}#{attr_str}>".dup
+
+      if block
+        block.call
+      elsif args.first
+        @output << args.first.to_s
+      end
+
+      @output << "</#{name}>".dup
+    end
+
+    TAGS.each do |tag|
+      define_method(tag['name']) do |*args, **attrs, &block|
+        render_tag(tag, args, attrs, block)
+      end
+    end
+
+    # for text node
+    def text(str)
+      @output << str.to_s
+    end
+
+    alias _ text
+
+    def render(code, ctx: {})
+      @output = "".dup
+
+      ___binding___ = binding
+      ctx.each do |k, v|
+        ___binding___.local_variable_set(k, v)
+      end
+
+      eval(code, ___binding___, __FILE__, __LINE__)
+      #instance_eval(code, __FILE__, __LINE__)
+      @output
+    end
+  end
+end

data/lib/ruex/helper/cli.rb

@@ -0,0 +1,76 @@
+module Ruex
+  module Helper
+    module CLI
+      require "json"
+      require "yaml"
+
+      def load_help
+        help_path = File.expand_path("../../../doc/help", __dir__)
+        File.read(help_path)
+      end
+
+      # Convert "foo/bar_baz" → "Foo::BarBaz"
+      def path_to_module_name(lib)
+        lib
+          .sub(/\.rb$/, "")
+          .split("/")
+          .map { |seg| seg.split("_").map(&:capitalize).join }
+          .join("::")
+      end
+
+      class ContextFile
+        def self.read(path_or_io)
+          data = if path_or_io.is_a?(StringIO)
+                   stringio_contents(path_or_io)
+                 else
+                   context_file_contents(path_or_io)
+                 end
+          deep_symbolize(data)
+        end
+
+        def self.deep_symbolize(obj)
+          case obj
+          when Hash
+            obj.each_with_object({}) do |(k, v), h|
+              h[k.to_sym] = deep_symbolize(v)
+            end
+          when Array
+            obj.map { |v| deep_symbolize(v) }
+          else
+            obj
+          end
+        end
+
+        def self.stringio_contents(sio)
+          data = Psych.safe_load(sio.read, permitted_classes: [Symbol], aliases: false)
+          raise ArgumentError, "-b expects a Hash literal" unless data.is_a?(Hash)
+          data
+        rescue Psych::DisallowedClass
+          raise ArgumentError, "-b expects a Hash literal"
+        rescue Psych::SyntaxError
+          raise ArgumentError, "Invalid -b hash"
+        end
+
+        def self.context_file_contents(path)
+          contents = File.read(path)
+          data =
+            case File.extname(path)
+            when ".yml", ".yaml"
+              Psych.safe_load(contents, permitted_classes: [Symbol], aliases: false)
+            when ".json"
+              JSON.parse(contents)
+            else
+              raise ArgumentError, "Unknown context file format: #{path}"
+            end
+
+          raise ArgumentError, "Context file must contain a top-level Hash/Map object" unless data.is_a?(Hash)
+
+          data
+        rescue Psych::DisallowedClass
+          raise ArgumentError, "disallowed class"
+        end
+      end
+    end
+  end
+end
+

data/lib/ruex/tags.yml

@@ -0,0 +1,194 @@
+- name: html
+- name: head
+- name: title
+- name: base
+  void: true
+- name: link
+  void: true
+  boolean:
+    - disabled
+- name: meta
+  void: true
+- name: style
+- name: script
+  boolean:
+    - async
+    - defer
+    - nomodule
+- name: noscript
+- name: template
+
+# Sections
+- name: body
+- name: section
+- name: nav
+- name: article
+- name: aside
+- name: h1
+- name: h2
+- name: h3
+- name: h4
+- name: h5
+- name: h6
+- name: header
+- name: footer
+- name: address
+- name: main
+
+# Grouping content
+- name: p
+- name: hr
+  void: true
+- name: pre
+- name: blockquote
+- name: ol
+- name: ul
+- name: li
+- name: dl
+- name: dt
+- name: dd
+- name: figure
+- name: figcaption
+- name: div
+
+# Text-level semantics
+- name: a
+- name: em
+- name: strong
+- name: small
+- name: s
+- name: cite
+- name: q
+- name: dfn
+- name: abbr
+- name: data
+- name: time
+- name: code
+- name: var
+- name: samp
+- name: kbd
+- name: sub
+- name: sup
+- name: i
+- name: b
+- name: u
+- name: mark
+- name: ruby
+- name: rt
+- name: rp
+- name: bdi
+- name: bdo
+- name: span
+- name: br
+  void: true
+- name: wbr
+  void: true
+
+# Edits
+- name: ins
+- name: del
+
+# Embedded content
+- name: picture
+- name: source
+  void: true
+- name: img
+  void: true
+- name: iframe
+- name: embed
+  void: true
+- name: object
+- name: param
+  void: true
+- name: video
+  boolean:
+    - autoplay
+    - controls
+    - loop
+    - muted
+- name: audio
+  boolean:
+    - autoplay
+    - controls
+    - loop
+    - muted
+- name: track
+  void: true
+- name: map
+- name: area
+  void: true
+
+# Forms
+- name: form
+  boolean:
+    - novalidate
+- name: label
+- name: input
+  void: true
+  boolean:
+    - disabled
+    - readonly
+    - required
+    - autofocus
+    - multiple
+    - hidden
+    - formnovalidate
+    - checked
+- name: button
+  boolean:
+    - disabled
+    - autofocus
+    - formnovalidate
+- name: select
+  boolean:
+    - disabled
+    - multiple
+    - required
+    - autofocus
+- name: datalist
+- name: optgroup
+  boolean:
+    - disabled
+- name: option
+  boolean:
+    - disabled
+    - selected
+- name: textarea
+  boolean:
+    - disabled
+    - readonly
+    - required
+    - autofocus
+- name: output
+- name: progress
+- name: meter
+- name: fieldset
+  boolean:
+    - disabled
+- name: legend
+
+# Interactive elements
+- name: details
+- name: summary
+- name: dialog
+- name: menu
+- name: menuitem
+
+# Table content
+- name: table
+- name: caption
+- name: colgroup
+- name: col
+  void: true
+- name: thead
+- name: tbody
+- name: tfoot
+- name: tr
+- name: td
+- name: th
+
+# Scripting
+- name: canvas
+- name: slot
+- name: portal
+

data/lib/ruex/version.rb

@@ -0,0 +1,4 @@
+module Ruex
+  VERSION = File.read(File.expand_path("../../VERSION", __dir__)).strip
+end
+

data/lib/ruex.rb

@@ -0,0 +1,7 @@
+module Ruex
+  require 'ruex/core'
+
+  def render(code, ctx: {})
+    Core.new.render(code, ctx: ctx)
+  end
+end

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: ruex
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Takanobu Maekawa
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: |-
+  A library and CLI tool that generates HTML using plain Ruby expressions.
+  It is intended for static site or page generation, and is not suitable as a dynamic web page renderer.
+executables:
+- ruex
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- VERSION
+- bin/ruex
+- lib/ruex.rb
+- lib/ruex/cli.rb
+- lib/ruex/core.rb
+- lib/ruex/helper/cli.rb
+- lib/ruex/tags.yml
+- lib/ruex/version.rb
+homepage: https://github.com/tmkw/ruex
+licenses:
+- BSD-2-Clause
+metadata:
+  homepage_uri: https://github.com/tmkw/ruex
+  source_code_uri: https://github.com/tmkw/ruex
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 4.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.3
+specification_version: 4
+summary: Static HTML generation with plain Ruby expressions
+test_files: []