glimmer-dsl-xml 1.1.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c774d77fe8923afccfdc96d47731da399f3743c5b42aeaa569288d41438e3ca
-  data.tar.gz: 31d231cbb7893502c0322df99e3c8c2b36d086ffa9357708626476119bb0a70c
+  metadata.gz: 1366050ddcebd522d82ae386b6048b5c0c8e5f32944588c71dc8020996acb595
+  data.tar.gz: 808f0b774ac0ce0860f46de890afd1e7215821a83b1008233c75f2ef260ef578
 SHA512:
-  metadata.gz: 4316b94b77344436530a5d6e6ffe3db75f2aaa8997fc9f6418c4317a327bc614fd7820bd179142f1833ba8a629e3b9f3673acd9a452de3b552b4c7a48d4b3b88
-  data.tar.gz: 81a8014a802c731077eae762263284691ed9e7f2d4d9b82ac0409333a4693778a67736919fca2a8620787e2b280badcaf43d67c8f8d5dfafa3b1141bca78b6f0
+  metadata.gz: 783c1848a2cee2b53117c4a74bc25ad3d6cb636f37ccf84525105d149c606c9f3c47ff8e1a5228e2662b439002af7195ce4f2509fa55a9672954045d98f31de7
+  data.tar.gz: a67e7ee09c14a084dce073c4da380d4f5e7283825e82a6bbf8d8a75d3ee4dd28810d321fbac0d279cc94e831ab84f6bacf449e1269c589c885bc3aa913a89715

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Change Log
 
+## 1.3.1
+
+- Support `Glimmer::Config.xml_attribute_underscore = '-'` to auto convert xml attribute underscores to dashes (or any character) only in symbols, but not strings
+
+## 1.3.0
+
+- Upgrade to Glimmer 2.4.1 (automatically gets rid of `invalid log level:` output without needing v1.2.1's fix)
+
+## 1.2.1
+
+- Get rid of `invalid log level:` output by setting `GLIMMER_LOGGER_LEVEL` env var before requiring `glimmer`
+
+## 1.2.0
+
+- Upgraded to Glimmer 2
+
 ## 1.1.0
 
 - Support `xml` keyword to produce partial xml/html without the html tag in output

data/README.md

@@ -1,17 +1,19 @@
-# [<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 1.1.0 (& HTML)
+# [<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.1
 [![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) documents.
+[Glimmer](https://github.com/AndyObtiva/glimmer) DSL for XML provides Ruby syntax for building XML (eXtensible Markup Language) and HTML documents.
 
 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/tree/master#browser-widget).
 
 Other [Glimmer](https://github.com/AndyObtiva/glimmer) DSL gems:
 - [glimmer-dsl-swt](https://github.com/AndyObtiva/glimmer-dsl-swt): Glimmer DSL for SWT (JRuby Desktop Development GUI Library)
 - [glimmer-dsl-tk](https://github.com/AndyObtiva/glimmer-dsl-tk): Glimmer DSL for Tk (Ruby Desktop Development GUI Library)
+- [glimmer-dsl-libui](https://github.com/AndyObtiva/glimmer-dsl-libui): Glimmer DSL for LibUI (Prerequisite-Free Ruby Desktop Development GUI Library)
+- [glimmer-dsl-gtk](https://github.com/AndyObtiva/glimmer-dsl-gtk): Glimmer DSL for GTK (Ruby-GNOME Desktop Development GUI Library)
 - [glimmer-dsl-opal](https://github.com/AndyObtiva/glimmer-dsl-opal): Glimmer DSL for Opal (Web GUI Adapter for Desktop Apps)
 - [glimmer-dsl-css](https://github.com/AndyObtiva/glimmer-dsl-css): Glimmer DSL for CSS (Cascading Style Sheets)
 
@@ -23,7 +25,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.1.0
+gem install glimmer-dsl-xml -v 1.3.1
 ```
 
 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 ...`
@@ -38,7 +40,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.1.0'
+gem 'glimmer-dsl-xml', '~> 1.3.1'
 ```
 
 And, then run:
@@ -67,13 +69,19 @@ Here are all the Glimmer XML DSL top-level keywords:
 
 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')` )
 
-Example (full HTML document):
+You may try the following examples in IRB after installing the [glimmer-dsl-xml](https://rubygems.org/gems/glimmer-dsl-xml) gem.
+
+Just make sure to require the library and include Glimmer first:
 
 ```ruby
 require 'glimmer-dsl-xml'
 
 include Glimmer
+```
+
+Example (full HTML document):
 
+```ruby
 @html = html {
   head {
     meta(name: "viewport", content: "width=device-width, initial-scale=2.0")
@@ -82,6 +90,7 @@ include Glimmer
     h1 { "Hello, World!" }
   }
 }
+
 puts @html
 ```
 
@@ -94,13 +103,10 @@ Output:
 Example (partial HTML fragment):
 
 ```ruby
-require 'glimmer-dsl-xml'
-
-include Glimmer
-
 @html = html {
   h1 { "Hello, World!" }
 }
+
 puts @html
 ```
 
@@ -113,35 +119,29 @@ Output:
 Example (basic XML):
 
 ```ruby
-require 'glimmer-dsl-xml'
-
-include Glimmer
-
 @xml = xml {
-  h1 { "Hello, World!" }
+  greeting { "Hello, World!" }
 }
+
 puts @xml
 ```
 
 Output:
 
 ```
-<h1>Hello, World!</h1>
+<greeting>Hello, World!</greeting>
 ```
 
 Example (XML namespaces using `name_space` keyword):
 
 ```ruby
-require 'glimmer-dsl-xml'
-
-include Glimmer
-
 @xml = name_space(:acme) {
   product(:id => "thesis", :class => "document") {
     component(:id => "main") {
     }
   }
 }
+
 puts @xml
 ```
 
@@ -154,14 +154,11 @@ Output:
 Example (XML namespaces using dot operator):
 
 ```ruby
-  require 'glimmer-dsl-xml'
-  
-  include Glimmer
-  
   @xml = xml {
     document.body(document.id => "main") {
     }
   }
+  
   puts @xml
 ```
 
@@ -173,19 +170,74 @@ Output:
 
 Example (custom tag):
 
+```ruby
+puts tag(:_name => "p") {"p is a reserved keyword in Ruby"}
+```
+
+Output:
+
+```
+<p>p is a reserved keyword in Ruby</p>
+```
+
+## Glimmer Config
+
+### `xml_attribute_underscore`
+
+(default value: `'_'`)
+
+Calling the following code enables auto-conversion of xml attribute underscores into dashes in `Symbol` attribute names (but not `String` attribute names):
+
+```ruby
+Glimmer::Config.xml_attribute_underscore = '-'
+```
+
+Example:
+
 ```ruby
 require 'glimmer-dsl-xml'
 
+Glimmer::Config.xml_attribute_underscore = '-'
+
 include Glimmer
 
-puts tag(:_name => "p") {"p is a reserved keyword in Ruby"}
+document = html {
+  body {
+    video(:data_loop, data_src: "http://videos.org/1.mp4")
+  }
+}
+
+puts document
+```
+    
+```
+<!DOCTYPE html><html><body><video data-src="http://videos.org/1.mp4" data-loop  /></body></html>
 ```
 
-Output:
+Note that strings are intentionally ignored to enable using underscores when needed.
 
+Example:
+
+```ruby
+require 'glimmer-dsl-xml'
+
+Glimmer::Config.xml_attribute_underscore = '-'
+
+include Glimmer
+
+document = html {
+  body {
+    video('data_loop', 'data_src' => "http://videos.org/1.mp4")
+  }
+}
+
+puts document
 ```
-<p>p is a reserved keyword in Ruby</p>
+    
 ```
+<!DOCTYPE html><html><body><video data_src="http://videos.org/1.mp4" data_loop  /></body></html>
+```
+
 
 ## Multi-DSL Support
 

data/VERSION

@@ -1 +1 @@
-1.1.0
+1.3.1

data/lib/ext/glimmer/config.rb

@@ -0,0 +1,41 @@
+# Copyright (c) 2007-2021 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/config'
+
+module Glimmer
+  module Config
+    class << self
+      # Tells Glimmer to automatically convert underscores in xml attribute names into dashes only when passed in as symbols (not strings)
+      def xml_attribute_underscore=(value)
+        @@xml_attribute_underscore = value
+      end
+  
+      def xml_attribute_underscore
+        if defined?(@@xml_attribute_underscore) && @@xml_attribute_underscore
+          @@xml_attribute_underscore
+        else
+          @@xml_attribute_underscore = '_'
+        end
+      end
+    end
+  end
+end

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

@@ -1,5 +1,5 @@
 # Copyright (c) 2020 - 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
@@ -7,10 +7,10 @@
 # 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
@@ -46,14 +46,14 @@ module Glimmer
           Glimmer::XML::Node.new(parent, args[0].to_s, :_name_space_context => true)
         end
         
-        def add_content(parent, &block)
+        def add_content(parent, keyword, *args, &block)
           node = block.call(parent)
           unless node.is_a?(String)
             name_space_visitor = Glimmer::XML::NameSpaceVisitor.new(parent.name)
             Glimmer::XML::DepthFirstSearchIterator.new(node, name_space_visitor).iterate
-            def node.process_block(block)
-              Glimmer::Config.logger&.debug 'block'
-            end
+#             def node.process_block(block)
+#               Glimmer::Config.logger&.debug 'block'
+#             end
           end
           parent.children << node if parent and !parent.children.include?(node)
           node

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

@@ -1,5 +1,5 @@
 # Copyright (c) 2020 - 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
@@ -7,10 +7,10 @@
 # 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
@@ -30,8 +30,8 @@ module Glimmer
         include ParentExpression
         include Glimmer
 
-        def add_content(parent, &block)
-          return_value = block.call(parent)      
+        def add_content(parent, keyword, *args, &block)
+          return_value = block.call(parent)
           if !return_value.is_a?(Glimmer::XML::Node) and !parent.children.include?(return_value)
             text = return_value.to_s
             first_match = text.match(/[#][^{]+[{][^}]+[}]/)

data/lib/glimmer/xml/node.rb

@@ -1,5 +1,5 @@
 # Copyright (c) 2020 - 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
@@ -7,10 +7,10 @@
 # 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
@@ -59,14 +59,14 @@ module Glimmer
               attribute.parent = nil #attributes do not usually have parents
             end
           end
-          Glimmer::Config.logger&.debug(attributes)
+#           Glimmer::Config.logger&.debug(attributes)
         end
       end
 
       def method_missing(symbol, *args, &block)
         @is_name_space = true
         parent.children.delete(self) if parent
-        Glimmer::DSL::Engine.add_content(self, Glimmer::DSL::XML::XmlExpression.new) {@tag = super}
+        Glimmer::DSL::Engine.add_content(self, Glimmer::DSL::XML::XmlExpression.new, name, attributes) {@tag = super}
         @tag
       end
       

data/lib/glimmer/xml/xml_visitor.rb

@@ -1,5 +1,5 @@
 # Copyright (c) 2020 - 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
@@ -7,10 +7,10 @@
 # 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
@@ -33,7 +33,7 @@ module Glimmer
       end
 
       def process_before_children(node)
-        if (!node.is_a?(Glimmer::XML::Node))          
+        if (!node.is_a?(Glimmer::XML::Node))
           @document += node.to_s
           return
         end
@@ -75,11 +75,12 @@ module Glimmer
 
       def append_attributes(node)
         return if node.name == 'xml' || node.name_space_context?
-        Glimmer::Config.logger&.debug "Take 3"
-        Glimmer::Config.logger&.debug(node.attributes)
+#         Glimmer::Config.logger&.debug "Append Attributes"
+#         Glimmer::Config.logger&.debug(node.attributes)
         node.attributes.each do |attribute, value|
           attribute_name = attribute
           attribute_name = "#{attribute.name_space.name}:#{attribute.name}" if attribute.is_a?(Node)
+          attribute_name = attribute_name.to_s.gsub('_', Glimmer::Config.xml_attribute_underscore) if attribute_name.is_a?(Symbol)
           @document += " #{attribute_name}"
           @document += "=\"#{value}\"" unless value.nil?
         end

data/lib/glimmer-dsl-xml.rb

@@ -1,5 +1,5 @@
 # Copyright (c) 2020 - 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
@@ -7,10 +7,10 @@
 # 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
@@ -19,7 +19,9 @@
 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
+
 $LOAD_PATH.unshift(File.expand_path('..', __FILE__))
 
 require 'glimmer'
+require 'ext/glimmer/config'
 require 'glimmer/dsl/xml/dsl'

metadata

@@ -1,35 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: glimmer-dsl-xml
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.3.1
 platform: ruby
 authors:
 - AndyMaleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-12 00:00:00.000000000 Z
+date: 2021-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: glimmer
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.1
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.4.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.1
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.4.1
 - !ruby/object:Gem::Dependency
   name: rspec-mocks
   requirement: !ruby/object:Gem::Requirement
@@ -188,7 +182,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Glimmer DSL for XML (& HTML)
+description: Glimmer DSL for XML & HTML
 email: andy.am@gmail.com
 executables: []
 extensions: []
@@ -202,6 +196,7 @@ files:
 - LICENSE.txt
 - README.md
 - VERSION
+- lib/ext/glimmer/config.rb
 - lib/glimmer-dsl-xml.rb
 - lib/glimmer/dsl/xml/dsl.rb
 - lib/glimmer/dsl/xml/html_expression.rb
@@ -238,7 +233,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: Glimmer DSL for XML