glimmer-dsl-xml 1.3.2 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f7120ebc13114f4347589e7e082e14de894c522786a8de3d99707d342a269ba7
-  data.tar.gz: d278c65435fc6cb806c4e72703cbd0e2927b0d1cb2f9db23ef613f5b9c8b0464
+  metadata.gz: 299589b2fe8ece942e67b330eaf32929870da8faa32b2ecf3dab2c92c3d28b13
+  data.tar.gz: dd4742f77cfe0e81299a80539069989e7315b04c276e07266403eac3d8758f91
 SHA512:
-  metadata.gz: e762085105a741a28a7e5a33a3e9dfbcecc2e399fad2d731b716ab563978bdb7b0c3547b8d711345798bf78dedb11c684dfcc9f4b6b4b65922fa89835a1a5338
-  data.tar.gz: 6d04566d9b594028e4cb07f7902b26dd9fd3517ceeeb883508512c494d6beed7c333f64d48ab366949f4b9c3c58183da641239bdf11aed9ce33822b7a1404235
+  metadata.gz: 96b1e96fed543c46ee0c04a4e3b0d2ffcc25d7b7691df64f7335eb12b80d770f5254e47ce711961e593a9ba21bb976197b0253912c38340e6bf324a126c072bc
+  data.tar.gz: 70af6db063691aeaa12342a4a4ada5eab28e016718cccdc41ab3b1cbb4916db83066c25353a01d9c6ff45eaa85a83387a1419aa61b7cbacee7a5247a66d16d13

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change Log
 
+## 1.4.0
+
+- `html_to_glimmer` converter command for automatically converting HTML to Glimmer DSL Ruby code
+- Support `p` keyword directly (without having to use the custom `tag` keyword like `tag(:_name => "p")`)
+
 ## 1.3.2
 
 - Relaxed glimmer dependency to between 2.4.1 and 3.0.0

data/README.md

@@ -1,29 +1,17 @@
-# [<img src="https://raw.githubusercontent.com/AndyObtiva/glimmer/master/images/glimmer-logo-hi-res.png" height=85 />](https://github.com/AndyObtiva/glimmer) Glimmer DSL for XML & HTML 1.3.2
+# [<img src="https://raw.githubusercontent.com/AndyObtiva/glimmer/master/images/glimmer-logo-hi-res.png" height=85 />](https://github.com/AndyObtiva/glimmer) Glimmer DSL for XML & HTML 1.4.0
 [![Gem Version](https://badge.fury.io/rb/glimmer-dsl-xml.svg)](http://badge.fury.io/rb/glimmer-dsl-xml)
 [![Travis CI](https://travis-ci.com/AndyObtiva/glimmer-dsl-xml.svg?branch=master)](https://travis-ci.com/github/AndyObtiva/glimmer-dsl-xml)
 [![Coverage Status](https://coveralls.io/repos/github/AndyObtiva/glimmer-dsl-xml/badge.svg?branch=master)](https://coveralls.io/github/AndyObtiva/glimmer-dsl-xml?branch=master)
 [![Maintainability](https://api.codeclimate.com/v1/badges/65f487b8807f7126b803/maintainability)](https://codeclimate.com/github/AndyObtiva/glimmer-dsl-xml/maintainability)
 [![Join the chat at https://gitter.im/AndyObtiva/glimmer](https://badges.gitter.im/AndyObtiva/glimmer.svg)](https://gitter.im/AndyObtiva/glimmer?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
-[Glimmer](https://github.com/AndyObtiva/glimmer) DSL for XML provides Ruby syntax for building XML (eXtensible Markup Language) and HTML documents. It used to be part of the [Glimmer](https://github.com/AndyObtiva/glimmer) library (created in 2007), but eventually got extracted into its own project.
+[Glimmer](https://github.com/AndyObtiva/glimmer) DSL for XML provides Ruby syntax for building XML (eXtensible Markup Language) and HTML documents, included in [Glimmer DSL for Web](https://github.com/AndyObtiva/glimmer-dsl-web) (Ruby in the Browser Web Frontend Framework) to use in Rails Frontend Development. It used to be part of the [Glimmer](https://github.com/AndyObtiva/glimmer) library (created in 2007), but eventually got extracted into its own project. The Ruby gem also includes an [HTML to Glimmer Converter](#html-to-glimmer-converter) (`html_to_glimmer`) to automatically convert legacy HTML code into Glimmer DSL syntax.
 
 Within the context of desktop development, Glimmer DSL for XML is useful in providing XML data for the [SWT Browser widget](https://github.com/AndyObtiva/glimmer-dsl-swt/blob/master/docs/reference/GLIMMER_GUI_DSL_SYNTAX.md#browser-widget).
 
 Otherwise, it is also used in the development of [Glimmer DSL for Opal](https://github.com/AndyObtiva/glimmer-dsl-opal).
 
-**[Glimmer](https://github.com/AndyObtiva/glimmer) DSL Comparison Table:**
-DSL | Platforms | Native? | Vector Graphics? | Pros | Cons | Prereqs
-----|-----------|---------|------------------|------|------|--------
-[Glimmer DSL for SWT (JRuby Desktop Development GUI Framework)](https://github.com/AndyObtiva/glimmer-dsl-swt) | Mac / Windows / Linux | Yes | Yes (Canvas Shape DSL) | Very Mature / Scaffolding / Native Executable Packaging / Custom Widgets | Slow JRuby Startup Time / Heavy Memory Footprint | Java / JRuby
-[Glimmer DSL for Opal (Pure Ruby Web GUI and Auto-Webifier of Desktop Apps)](https://github.com/AndyObtiva/glimmer-dsl-opal) | All Web Browsers | No | Yes (Canvas Shape DSL) | Simpler than All JavaScript Technologies / Auto-Webify Desktop Apps | Setup Process / Only Rails 5 Support for Now | Rails
-[Glimmer DSL for LibUI (Prerequisite-Free Ruby Desktop Development GUI Library)](https://github.com/AndyObtiva/glimmer-dsl-libui) | Mac / Windows / Linux | Yes | Yes (Area API) | Fast Startup Time / Light Memory Footprint | LibUI is an Incomplete Mid-Alpha Only | None Other Than MRI Ruby
-[Glimmer DSL for Tk (MRI Ruby Desktop Development GUI Library)](https://github.com/AndyObtiva/glimmer-dsl-tk) | Mac / Windows / Linux | Some Native-Themed Widgets (Not Truly Native) | Yes (Canvas) | Fast Startup Time / Light Memory Footprint | Widgets Do Not Look Truly Native, Espcially on Linux | ActiveTcl / MRI Ruby
-[Glimmer DSL for GTK (Ruby-GNOME Desktop Development GUI Library)](https://github.com/AndyObtiva/glimmer-dsl-gtk) | Mac / Windows / Linux | Only on Linux | Yes (Cairo) | Complete Access to GNOME Features on Linux (Forte) | Not Native on Mac and Windows | None Other Than MRI Ruby on Linux / Brew Packages on Mac / MSYS & MING Toolchains on Windows / MRI Ruby
-[Glimmer DSL for FX (FOX Toolkit Ruby Desktop Development GUI Library)](https://github.com/AndyObtiva/glimmer-dsl-fx) | Mac (requires XQuartz) / Windows / Linux | No | Yes (Canvas) | No Prerequisites on Windows (Forte Since Binaries Are Included Out of The Box) | Widgets Do Not Look Native / Mac Usage Obtrusively Starts XQuartz | None Other Than MRI Ruby on Windows / XQuarts on Mac / MRI Ruby
-[Glimmer DSL for JFX (JRuby JavaFX Desktop Development GUI Library)](https://github.com/AndyObtiva/glimmer-dsl-jfx) | Mac / Windows / Linux | No | Yes (javafx.scene.shape and javafx.scene.canvas) | Rich in Custom Widgets | Slow JRuby Startup Time / Heavy Memory Footprint / Widgets Do Not Look Native | Java / JRuby / JavaFX SDK
-[Glimmer DSL for Swing (JRuby Swing Desktop Development GUI Library)](https://github.com/AndyObtiva/glimmer-dsl-swing) | Mac / Windows / Linux | No | Yes (Java2D) | Very Mature | Slow JRuby Startup Time / Heavy Memory Footprint / Widgets Do Not Look Native | Java / JRuby
-[Glimmer DSL for XML (& HTML)](https://github.com/AndyObtiva/glimmer-dsl-xml) | All Web Browsers | No | Yes (SVG) | Programmable / Lighter-weight Than Actual XML | XML Elements Are Sometimes Not Well-Named (Many Types of Input) | None
-[Glimmer DSL for CSS](https://github.com/AndyObtiva/glimmer-dsl-css) | All Web Browsers | No | Yes | Programmable | CSS Is Over-Engineered / Too Many Features To Learn | None
+Learn more about the differences between various [Glimmer](https://github.com/AndyObtiva/glimmer) DSLs by looking at the **[Glimmer DSL Comparison Table](https://github.com/AndyObtiva/glimmer#glimmer-dsl-comparison-table)**.
 
 ## Setup
 
@@ -33,7 +21,7 @@ Please follow these instructions to make the `glimmer` command available on your
 
 Run this command to install directly:
 ```
-gem install glimmer-dsl-xml -v 1.3.2
+gem install glimmer-dsl-xml -v 1.4.0
 ```
 
 Note: When using JRuby, `jgem` is JRuby's version of `gem` command. RVM allows running `gem` as an alias in JRuby. Otherwise, you may also run `jruby -S gem install ...`
@@ -48,7 +36,7 @@ That's it! Requiring the gem activates the Glimmer XML DSL automatically.
 
 Add the following to `Gemfile` (after `glimmer-dsl-swt` and/or `glimmer-dsl-opal` if included too):
 ```
-gem 'glimmer-dsl-xml', '~> 1.3.2'
+gem 'glimmer-dsl-xml', '~> 1.4.0'
 ```
 
 And, then run:
@@ -73,7 +61,7 @@ Here are all the Glimmer XML DSL top-level keywords:
 - `html`: renders partial HTML just like `xml` (not having body/head) or full HTML document (having body/head), automatically including doctype (`<!DOCTYPE html>`) and surrounding content by the `<html></html>` tag
 - `xml`: renders XML/XHTML content (e.g. `xml {span {'Hello'}; br}.to_s` renders `<span>Hello</span><br />`)
 - `name_space`: enables namespacing html tags
-- `tag`: enables custom tag creation for exceptional cases (e.g. `p` as reserved Ruby keyword) by passing tag name as '_name' attribute
+- `tag`: enables custom tag creation for exceptional cases (e.g. `acme:window` as reserved Ruby keyword) by passing tag name as '_name' attribute
 
 Element properties are typically passed as a key/value hash (e.g. `section(id: 'main', class: 'accordion')`) . However, for properties like "selected" or "checked", you must leave value `nil` or otherwise pass in front of the hash (e.g. `input(:checked, type: 'checkbox')` )
 
@@ -179,13 +167,100 @@ Output:
 Example (custom tag):
 
 ```ruby
-puts tag(:_name => "p") {"p is a reserved keyword in Ruby"}
+puts tag(:_name => "acme:window") {"This is a window under acme inc."}
 ```
 
 Output:
 
 ```
-<p>p is a reserved keyword in Ruby</p>
+<acme:window>This is a window under acme inc.</acme:window>
+```
+
+### HTML to Glimmer Converter
+
+The Ruby gem includes a HTML to Glimmer converter (`html_to_glimmer`) to automatically convert legacy HTML code into Glimmer DSL syntax.
+
+Prerequisite: the `nokogiri` Ruby gem. If not already installed, run `gem install nokogiri` before using `html_to_glimmer`.
+
+Script:
+
+[bin/html_to_glimmer](/bin/html_to_glimmer)
+
+Usage:
+
+```
+html_to_glimmer path_to_html_file
+```
+
+Example:
+
+Suppose we have an HTML file called `input.html`:
+
+```html
+<html style='max-height: 100%'>
+  <body style="max-height: 100%; font: 'Times New Roman', Arial;">
+    <h1 id="top-header" class="header" data-owner='John "Bonham" Doe'>Welcome</h1>
+    <p>It is good to have <strong>you</strong> in our <strong><em>platform</em></strong>!</p>
+    <form action="/owner" method="post">
+      <input type="text" value="you" />
+    </form>
+  </body>
+</html>
+```
+
+We can run this command:
+
+```
+html_to_glimmer input.html
+```
+
+Printout:
+
+```
+Converting from HTML syntax to Glimmer DSL Ruby syntax for input file: input.html
+Converted output file: input.html.glimmer.rb
+```
+
+Output file (`input.html.glimmer.rb`) is a runnable Ruby file containing Glimmer DSL for XML & HTML syntax:
+
+```rb
+require 'glimmer-dsl-xml'
+
+include Glimmer
+
+html_document = xml {
+  html(style: 'max-height: 100%') {
+    body(style: "max-height: 100%; font: 'Times New Roman', Arial;") {
+      h1(id: 'top-header', class: 'header', 'data-owner': 'John "Bonham" Doe') {
+        "Welcome"
+      }
+      p {
+        span {
+          "It is good to have "
+        }
+        strong {
+          "you"
+        }
+        span {
+          " in our "
+        }
+        strong {
+          em {
+            "platform"
+          }
+        }
+        span {
+          "!"
+        }
+      }
+      form(action: '/owner', method: 'post') {
+        input(type: 'text', value: 'you')
+      }
+    }
+  }
+}
+
+puts html_document.to_s
 ```
 
 ## Glimmer Config

data/VERSION

@@ -1 +1 @@
-1.3.2
+1.4.0

data/bin/html_to_glimmer

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/glimmer/xml/html_to_glimmer_converter'
+
+usage = "***Glimmer DSL for XML & HTML - HTML to Glimmer Converter***\nPrerequisite: `nokogiri` gem (install by running: gem install nokogiri)\nUsage: html_to_glimmer path_to_html_file"
+
+if ARGV.empty?
+  puts usage
+else
+  html_file_path = ARGV.last
+  puts "Converting from HTML syntax to Glimmer DSL Ruby syntax for input file: #{html_file_path}"
+  html = File.read(html_file_path)
+  converter = Glimmer::XML::HTMLToGlimmerConverter.new
+  glimmer = converter.convert(html)
+  glimmer_file_path = "#{html_file_path}.glimmer.rb"
+  File.write(glimmer_file_path, glimmer)
+  puts "Converted output file: #{glimmer_file_path}"
+end

data/lib/glimmer/dsl/xml/dsl.rb

@@ -27,6 +27,7 @@ require 'glimmer/dsl/xml/xml_node_expression'
 require 'glimmer/dsl/xml/html_expression'
 require 'glimmer/dsl/xml/meta_expression'
 require 'glimmer/dsl/xml/name_space_expression'
+require 'glimmer/dsl/xml/p_expression'
 
 module Glimmer
   module DSL

data/lib/glimmer/dsl/xml/p_expression.rb

@@ -0,0 +1,46 @@
+# Copyright (c) 2020-2023 - Andy Maleh
+#
+# 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.
+
+require 'glimmer/dsl/xml/node_parent_expression'
+require 'glimmer/dsl/static_expression'
+require 'glimmer/xml/node'
+
+module Kernel
+  alias pi p
+end
+
+module Glimmer
+  module DSL
+    module XML
+      class PExpression < StaticExpression
+        include NodeParentExpression
+
+        def can_interpret?(parent, keyword, *args, &block)
+          keyword == 'p' && parent.is_a?(Glimmer::XML::Node)
+        end
+
+        def interpret(parent, keyword, *args, &block)
+          Glimmer::XML::Node.new(parent, keyword.to_s, args, &block)
+        end
+      end
+    end
+  end
+end

data/lib/glimmer/xml/html_to_glimmer_converter.rb

@@ -0,0 +1,127 @@
+# Copyright (c) 2020-2024 - Andy Maleh
+#
+# 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.
+
+begin
+  require 'nokogiri'
+rescue LoadError
+  puts 'Please install the `nokogiri` gem by running: gem install nokogiri'
+  raise 'The `nokogiri` gem is not installed!'
+end
+
+module Glimmer
+  module XML
+    class HTMLToGlimmerConverter
+      def convert(html)
+        glimmer = ''
+        glimmer += "require 'glimmer-dsl-xml'\n\n"
+        glimmer += "include Glimmer\n\n"
+        glimmer += "html_document = xml {\n"
+        glimmer += indent_lines(convert_html(html))
+        glimmer += "}\n\n"
+        glimmer += "puts html_document.to_s\n"
+      end
+      
+      private
+      
+      def convert_html(html)
+        html_doc = Nokogiri::HTML(html)
+        glimmer = ''
+        html_doc.children.select(&:element?).each do |element|
+          glimmer += convert_element(element)
+        end
+        glimmer
+      end
+      
+      def convert_element(element)
+        children_count = element.children.size
+        glimmer = ''
+        glimmer += "#{element.node_name}#{convert_attributes(element)}" if element.element?
+        glimmer += " {\n" if element.element? && children_count > 0
+        if element.children.size == 1 && element.children.first.text?
+          glimmer += indent_lines(convert_text(element.children.first))
+        else
+          element.children.each do |child|
+            if child.element?
+              glimmer += indent_lines(convert_element(child))
+            elsif child.text?
+              glimmer += indent_lines(convert_span(child))
+            end
+          end
+        end
+        glimmer += "}\n" if element.element? && children_count > 0
+        glimmer += "\n" if element.element? && children_count == 0
+        glimmer
+      end
+      
+      def convert_span(text_element)
+        text_content = indent_lines(convert_text(text_element))
+        return '' if text_content.strip.empty?
+        glimmer = ''
+        glimmer += "span {\n"
+        glimmer += text_content
+        glimmer += "}\n"
+        glimmer
+      end
+      
+      def convert_text(text_element)
+        text_content = text_element.to_s
+        if text_content.strip.empty?
+          ''
+        else
+          "#{text_element.to_s.dump}\n"
+        end
+      end
+      
+      def convert_attributes(element)
+        attributes_string = element.attributes.to_a.map do |attribute, value|
+          "#{normalize_attribute(attribute)}: #{normalize_value(value)}"
+        end.join(', ')
+        return '' if attributes_string.strip.empty?
+        glimmer = ''
+        glimmer += '('
+        glimmer += attributes_string
+        glimmer += ')'
+        glimmer
+      end
+      
+      def normalize_attribute(attribute)
+        if attribute.include?('-')
+          "'#{attribute}'"
+        else
+          attribute
+        end
+      end
+      
+      def normalize_value(value)
+        value = value.to_s
+        if value.include?("'")
+          "\"#{value}\""
+        else
+          "'#{value}'"
+        end
+      end
+      
+      def indent_lines(multi_line_string)
+        multi_line_string.lines.map { |line| "  #{line}" }.join
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glimmer-dsl-xml
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.4.0
 platform: ruby
 authors:
 - AndyMaleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-15 00:00:00.000000000 Z
+date: 2024-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: glimmer
@@ -190,7 +190,8 @@ dependencies:
         version: '0'
 description: Glimmer DSL for XML & HTML
 email: andy.am@gmail.com
-executables: []
+executables:
+- html_to_glimmer
 extensions: []
 extra_rdoc_files:
 - CHANGELOG.md
@@ -202,6 +203,7 @@ files:
 - LICENSE.txt
 - README.md
 - VERSION
+- bin/html_to_glimmer
 - lib/glimmer-dsl-xml-ext/glimmer/config.rb
 - lib/glimmer-dsl-xml.rb
 - lib/glimmer/dsl/xml/dsl.rb
@@ -209,12 +211,14 @@ files:
 - lib/glimmer/dsl/xml/meta_expression.rb
 - lib/glimmer/dsl/xml/name_space_expression.rb
 - lib/glimmer/dsl/xml/node_parent_expression.rb
+- lib/glimmer/dsl/xml/p_expression.rb
 - lib/glimmer/dsl/xml/tag_expression.rb
 - lib/glimmer/dsl/xml/text_expression.rb
 - lib/glimmer/dsl/xml/xml_expression.rb
 - lib/glimmer/dsl/xml/xml_node_expression.rb
 - lib/glimmer/xml/depth_first_search_iterator.rb
 - lib/glimmer/xml/html_node.rb
+- lib/glimmer/xml/html_to_glimmer_converter.rb
 - lib/glimmer/xml/html_visitor.rb
 - lib/glimmer/xml/name_space_visitor.rb
 - lib/glimmer/xml/node.rb
@@ -239,7 +243,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: Glimmer DSL for XML