xrb 0.1 → 0.3.0

data/lib/xrb/uri.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2017-2024, by Samuel Williams.
+
+module XRB
+	# This class is superceeded by `XRB::Reference`.
+	class URI
+		def initialize(path, query_string, fragment, parameters)
+			@path = path
+			@query_string = query_string
+			@fragment = fragment
+			@parameters = parameters
+		end
+		
+		# The path component of the URI, e.g. /foo/bar/index.html
+		attr :path
+		
+		# The un-parsed query string of the URI, e.g. 'x=10&y=20'
+		attr :query_string
+		
+		# A fragment identifier, the part after the '#'
+		attr :fragment
+		
+		# User supplied parameters that will be appended to the query part.
+		attr :parameters
+		
+		def append(buffer)
+			if @query_string
+				buffer << escape_path(@path) << '?' << query_string
+				buffer << '&' << query_parameters if @parameters
+			else
+				buffer << escape_path(@path)
+				buffer << '?' << query_parameters if @parameters
+			end
+			
+			if @fragment
+				buffer << '#' << escape(@fragment)
+			end
+			
+			return buffer
+		end
+		
+		def to_str
+			append(String.new)
+		end
+		
+		alias to_s to_str
+		
+		private
+		
+		# According to https://tools.ietf.org/html/rfc3986#section-3.3, we escape non-pchar.
+		NON_PCHAR = /([^a-zA-Z0-9_\-\.~!$&'()*+,;=:@\/]+)/.freeze
+		
+		def escape_path(path)
+			encoding = path.encoding
+			path.b.gsub(NON_PCHAR) do |m|
+				'%' + m.unpack('H2' * m.bytesize).join('%').upcase
+			end.force_encoding(encoding)
+		end
+		
+		# Escapes a generic string, using percent encoding.
+		def escape(string)
+			encoding = string.encoding
+			string.b.gsub(/([^a-zA-Z0-9_.\-]+)/) do |m|
+				'%' + m.unpack('H2' * m.bytesize).join('%').upcase
+			end.force_encoding(encoding)
+		end
+		
+		def query_parameters
+			build_nested_query(@parameters)
+		end
+		
+		def build_nested_query(value, prefix = nil)
+			case value
+			when Array
+				value.map { |v|
+					build_nested_query(v, "#{prefix}[]")
+				}.join("&")
+			when Hash
+				value.map { |k, v|
+					build_nested_query(v, prefix ? "#{prefix}[#{escape(k.to_s)}]" : escape(k.to_s))
+				}.reject(&:empty?).join('&')
+			when nil
+				prefix
+			else
+				raise ArgumentError, "value must be a Hash" if prefix.nil?
+				"#{prefix}=#{escape(value.to_s)}"
+			end
+		end
+	end
+	
+	# Generate a URI from a path and user parameters. The path may contain a `#fragment` or `?query=parameters`.
+	def self.URI(path = '', parameters = nil)
+		base, fragment = path.split('#', 2)
+		path, query_string = base.split('?', 2)
+		
+		URI.new(path, query_string, fragment, parameters)
+	end
+end

data/lib/xrb/version.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2012-2024, by Samuel Williams.
+
+module XRB
+	VERSION = "0.3.0"
+end

data/lib/xrb.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2012-2024, by Samuel Williams.
+
+require_relative 'xrb/version'
+require_relative 'xrb/native'
+require_relative 'xrb/builder'
+require_relative 'xrb/template'
+
+require_relative 'xrb/reference'

data/license.md

@@ -0,0 +1,23 @@
+# MIT License
+
+Copyright, 2012-2024, by Samuel Williams.  
+Copyright, 2020, by Cyril Roelandt.  
+Copyright, 2022, by Adam Daniels.  
+
+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

@@ -0,0 +1,34 @@
+# XRB
+
+XRB is a templating system built loosely on top of XHTML markup. It uses efficient native parsers where possible and compiles templates into efficient Ruby. It also includes a markup builder to assist with the generation of pleasantly formatted markup which is compatible with the included parsers.
+
+[![Development Status](https://github.com/socketry/xrb/workflows/Test/badge.svg)](https://github.com/socketry/xrb/actions?workflow=Test)
+
+## Usage
+
+Please see the [project documentation](https://socketry.github.io/xrb/) for more details.
+
+  - [Usage](https://socketry.github.io/xrb/guides/getting-started/index) - This guide gives a brief overview of the XRB templating system and how to use it.
+
+## See Also
+
+  - [xrb-vscode](https://github.com/socketry/xrb-vscode) - A syntax highlighting package for Visual Studio Code.
+  - [trenni](https://github.com/ioquatix/trenni) - The original templating system which XRB is based on.
+
+## Contributing
+
+We welcome contributions to this project.
+
+1.  Fork it.
+2.  Create your feature branch (`git checkout -b my-new-feature`).
+3.  Commit your changes (`git commit -am 'Add some feature'`).
+4.  Push to the branch (`git push origin my-new-feature`).
+5.  Create new Pull Request.
+
+### Developer Certificate of Origin
+
+This project uses the [Developer Certificate of Origin](https://developercertificate.org/). All contributors to this project must agree to this document to have their contributions accepted.
+
+### Contributor Covenant
+
+This project is governed by the [Contributor Covenant](https://www.contributor-covenant.org/). All contributors and participants agree to abide by its terms.

metadata

@@ -1,69 +1,129 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: xrb
-version: !ruby/object:Gem::Version 
-  hash: 9
-  prerelease: 
-  segments: 
-  - 0
-  - 1
-  version: "0.1"
+version: !ruby/object:Gem::Version
+  version: 0.3.0
 platform: ruby
-authors: 
-- Aizat Faiz
-autorequire: 
+authors:
+- Samuel Williams
+- Adam Daniels
+- Cyril Roelandt
+autorequire:
 bindir: bin
-cert_chain: []
-
-date: 2011-06-05 00:00:00 Z
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIE2DCCA0CgAwIBAgIBATANBgkqhkiG9w0BAQsFADBhMRgwFgYDVQQDDA9zYW11
+  ZWwud2lsbGlhbXMxHTAbBgoJkiaJk/IsZAEZFg1vcmlvbnRyYW5zZmVyMRIwEAYK
+  CZImiZPyLGQBGRYCY28xEjAQBgoJkiaJk/IsZAEZFgJuejAeFw0yMjA4MDYwNDUz
+  MjRaFw0zMjA4MDMwNDUzMjRaMGExGDAWBgNVBAMMD3NhbXVlbC53aWxsaWFtczEd
+  MBsGCgmSJomT8ixkARkWDW9yaW9udHJhbnNmZXIxEjAQBgoJkiaJk/IsZAEZFgJj
+  bzESMBAGCgmSJomT8ixkARkWAm56MIIBojANBgkqhkiG9w0BAQEFAAOCAY8AMIIB
+  igKCAYEAomvSopQXQ24+9DBB6I6jxRI2auu3VVb4nOjmmHq7XWM4u3HL+pni63X2
+  9qZdoq9xt7H+RPbwL28LDpDNflYQXoOhoVhQ37Pjn9YDjl8/4/9xa9+NUpl9XDIW
+  sGkaOY0eqsQm1pEWkHJr3zn/fxoKPZPfaJOglovdxf7dgsHz67Xgd/ka+Wo1YqoE
+  e5AUKRwUuvaUaumAKgPH+4E4oiLXI4T1Ff5Q7xxv6yXvHuYtlMHhYfgNn8iiW8WN
+  XibYXPNP7NtieSQqwR/xM6IRSoyXKuS+ZNGDPUUGk8RoiV/xvVN4LrVm9upSc0ss
+  RZ6qwOQmXCo/lLcDUxJAgG95cPw//sI00tZan75VgsGzSWAOdjQpFM0l4dxvKwHn
+  tUeT3ZsAgt0JnGqNm2Bkz81kG4A2hSyFZTFA8vZGhp+hz+8Q573tAR89y9YJBdYM
+  zp0FM4zwMNEUwgfRzv1tEVVUEXmoFCyhzonUUw4nE4CFu/sE3ffhjKcXcY//qiSW
+  xm4erY3XAgMBAAGjgZowgZcwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0O
+  BBYEFO9t7XWuFf2SKLmuijgqR4sGDlRsMC4GA1UdEQQnMCWBI3NhbXVlbC53aWxs
+  aWFtc0BvcmlvbnRyYW5zZmVyLmNvLm56MC4GA1UdEgQnMCWBI3NhbXVlbC53aWxs
+  aWFtc0BvcmlvbnRyYW5zZmVyLmNvLm56MA0GCSqGSIb3DQEBCwUAA4IBgQB5sxkE
+  cBsSYwK6fYpM+hA5B5yZY2+L0Z+27jF1pWGgbhPH8/FjjBLVn+VFok3CDpRqwXCl
+  xCO40JEkKdznNy2avOMra6PFiQyOE74kCtv7P+Fdc+FhgqI5lMon6tt9rNeXmnW/
+  c1NaMRdxy999hmRGzUSFjozcCwxpy/LwabxtdXwXgSay4mQ32EDjqR1TixS1+smp
+  8C/NCWgpIfzpHGJsjvmH2wAfKtTTqB9CVKLCWEnCHyCaRVuKkrKjqhYCdmMBqCws
+  JkxfQWC+jBVeG9ZtPhQgZpfhvh+6hMhraUYRQ6XGyvBqEUe+yo6DKIT3MtGE2+CP
+  eX9i9ZWBydWb8/rvmwmX2kkcBbX0hZS1rcR593hGc61JR6lvkGYQ2MYskBveyaxt
+  Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
+  voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
+  -----END CERTIFICATE-----
+date: 2024-04-27 00:00:00.000000000 Z
 dependencies: []
-
-description: 
-email: aizat.faiz@gmail.com
+description:
+email:
 executables: []
-
-extensions: []
-
+extensions:
+- ext/extconf.rb
 extra_rdoc_files: []
-
-files: 
-- README
-- app/helpers/ui_helper.rb
-- app/models/xrb/element.rb
-- lib/xrb/engine.rb
-- rails/init.rb
-- xrb.gemspec
-homepage: http://github.com/aizatto/xrb
-licenses: []
-
-post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
-require_paths: 
+files:
+- bake/xrb/entities.rb
+- bake/xrb/parsers.rb
+- ext/Makefile
+- ext/XRB_Extension.bundle
+- ext/escape.o
+- ext/extconf.h
+- ext/extconf.rb
+- ext/markup.o
+- ext/mkmf.log
+- ext/query.o
+- ext/tag.o
+- ext/template.o
+- ext/xrb.o
+- ext/xrb/escape.c
+- ext/xrb/escape.h
+- ext/xrb/markup.c
+- ext/xrb/markup.h
+- ext/xrb/markup.rl
+- ext/xrb/query.c
+- ext/xrb/query.h
+- ext/xrb/query.rl
+- ext/xrb/tag.c
+- ext/xrb/tag.h
+- ext/xrb/template.c
+- ext/xrb/template.h
+- ext/xrb/template.rl
+- ext/xrb/xrb.c
+- ext/xrb/xrb.h
+- lib/xrb.rb
+- lib/xrb/buffer.rb
+- lib/xrb/builder.rb
+- lib/xrb/entities.rb
+- lib/xrb/entities.xrb
+- lib/xrb/error.rb
+- lib/xrb/fallback/markup.rb
+- lib/xrb/fallback/markup.rl
+- lib/xrb/fallback/query.rb
+- lib/xrb/fallback/query.rl
+- lib/xrb/fallback/template.rb
+- lib/xrb/fallback/template.rl
+- lib/xrb/markup.rb
+- lib/xrb/native.rb
+- lib/xrb/parsers.rb
+- lib/xrb/query.rb
+- lib/xrb/reference.rb
+- lib/xrb/strings.rb
+- lib/xrb/tag.rb
+- lib/xrb/template.rb
+- lib/xrb/uri.rb
+- lib/xrb/version.rb
+- license.md
+- readme.md
+homepage: https://github.com/ioquatix/xrb
+licenses:
+- MIT
+metadata:
+  documentation_uri: https://socketry.github.io/xrb/
+  funding_uri: https://github.com/sponsors/ioquatix
+  source_code_uri: https://github.com/ioquatix/xrb.git
+post_install_message:
+rdoc_options: []
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: 
-rubygems_version: 1.7.2
-signing_key: 
-specification_version: 3
-summary: XRB summary
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: A fast native templating system that compiles directly to Ruby code.
 test_files: []
-

metadata.gz.sig

@@ -0,0 +1,2 @@
+c��lv�G�I��<�ث��
+;f�l;�Q��ª_o�]+�2�/��'~���(G8���Ϡ�,s䀤���:���𼵞��׆��X�;���=�‡��x$.6=��8��s+'�\��Woʡ(Wl�:��B�2���S�n���I)��Vf�X����>/gb�1G��?[�t��^h��/�j�3�,x�;s��,�K'���@�Ŋ@���(�̡K�G��k�r

data/README

@@ -1,60 +0,0 @@
-XRB was inspired by XHP ( http://github.com/facebook/xhp/ ).
-XRB is a Rails Engine to be used.
-
-Having used XHP intensively, I saw the benefits of XML literals as first class
-elements in a programming language.  The biggest benefit was that you could
-easily build large libraries of components to reuse on many sites.
-
-As I was unable to figure out how to add XML literals into the Ruby parser.
-I thought I would start with a more Ruby approach.
-
-Installation
-============
-
-Edit Your Application's Gemfile
--------------------------------
-
-Add to your Gemfile
-
-    gem 'xrb', :require => 'xrb/engine'
-
-In your ApplicationHelper add
-
-    require UiHelper
-
-Usage
-=====
-
-Inside your template files you can now use XRB.
-
-    <%= ui :image, :block do %>
-      <% ui :link => user_path(user) %>
-        <%= image_tag(user.photo.url(:thumbnail), :title => user %>
-      <% end %>
-      <% ui :group do %>
-        <% ui :link => user_path(user) %>
-          <%= user %>
-        <% end %>
-        <% ui :group do %>
-          <%= user.description %>
-        <% end %>
-      <% end %>
-    <% end %>
-
-
-Defining your own XRB Element
------------------------------
-
-Say you want to define an element `user`.
-Inside a helper file we need to add a function:
-
-    def ui_user(xrb)
-      user = xrb.attributes.delete(:user)
-
-      xrb.content = ui_output do
-        content_tag :div, user, xrb.attributes
-      end
-    end
-
-Change the code inside `ui_output` to let design how your component will look
-like.

data/app/helpers/ui_helper.rb

@@ -1,80 +0,0 @@
-module UiHelper
-
-  def ui(*args, &block)
-    component = []
-    if args.length == 1 && args.first.is_a?(Hash) && args.first.length == 1
-      component << args.first.keys.first
-    else 
-      while args.first.is_a? Symbol
-        component << args.shift
-      end
-    end
-    component = "ui_#{component.join '_'}"
-    xrb = ui_capture(*args, &block)
-    @components << xrb if @components
-
-    self.send(component, xrb)
-  end
-
-  def ui_image_block(xrb)
-    image = xrb.components.shift
-    group = xrb.components.shift
-
-    title = group.components.shift
-    contents = group.components.shift
-    
-    ui_output do <<-HTML
-      <div class="image-block">
-        <div class="image">#{image}</div>
-        <div class="content">
-          <div class="title">#{title}</div>
-          #{contents}
-        </div>
-      </div>
-      <div class="clear"></div>
-    HTML
-    end
-  end
-
-  def ui_link(xrb)
-    xrb.attributes[:href] = xrb.attributes[:link] if xrb.attributes[:link]
-
-    xrb.content = ui_output do
-      content_tag(:a, xrb.inner_content, xrb.attributes)
-    end
-  end
-
-  def ui_group(xrb)
-    xrb.content = ui_output do
-      xrb.inner_content
-    end
-  end
-
-  # helper
-  def ui_output
-    value = yield
-
-    value.html_safe
-  end
-
-  def ui_capture(*args, &block)
-    xrb = ::XRB::Element.new
-    xrb.attributes = args.extract_options!
-
-    if block
-      @components, old_components = [], @components
-      xrb.inner_content = capture(&block)
-      xrb.components = @components
-      @components = old_components
-    else
-      xrb.inner_content = args.first || ''
-    end
-
-    if xrb.inner_content.is_a?(String) && ! xrb.inner_content.html_safe?
-      xrb.inner_content = xrb.inner_content.html_safe
-    end
-
-    xrb
-  end
-
-end

data/app/models/xrb/element.rb

@@ -1,9 +0,0 @@
-module XRB
-  class Element
-    attr_accessor :content, :inner_content, :attributes, :components
-
-    def to_s
-      content
-    end
-  end
-end

data/lib/xrb/engine.rb

@@ -1,4 +0,0 @@
-module XRB
-  class Engine < Rails::Engine
-  end
-end

data/rails/init.rb

@@ -1 +0,0 @@
-require 'xrb/engine'

data/xrb.gemspec

@@ -1,12 +0,0 @@
-Gem::Specification.new do |s|
-  s.name = %q{xrb}
-  s.version = "0.1"
-  s.authors = ["Aizat Faiz"]
-  s.email = %q{aizat.faiz@gmail.com}
-  s.date = Time.now.utc.strftime("%Y-%m-%d")
-  s.files = `git ls-files`.split("\n")
-  s.homepage = %q{http://github.com/aizatto/xrb}
-  s.rdoc_options = ["--charset=UTF-8"]
-  s.rubygems_version = %q{1.7.2}
-  s.summary = %q{XRB summary}
-end