philiprehberger-xml_builder 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 82e57a50119722850b37aea9fb4dc8d4ed53774c8377750baee25faf0b118b76
-  data.tar.gz: 41d22968c8eff5a8e31c1223f6169d40aa65ac5b2c9eb07034495681a0dcd94f
+  metadata.gz: 3fb9d2343ef89b02de12422a8ca7632e3d16634876c8d602f93966f35f4f8287
+  data.tar.gz: 7a21d2d73ddfe6d7d2305527fc1305425965197eb5950809d3168308ed4a7d4e
 SHA512:
-  metadata.gz: 7923d521f4ad86f86d608541cb482b4cadc1a41a378d4a228a4e9e48dc9068047dadfb4670d3e3a2060bac706f2df02f1c426ea48a1421bb4570eb3c52524c05
-  data.tar.gz: 53aa3ea970baf6adf08387b2a9900f61390ea8ec316d9de912205bab2095f2d3c90a3fb6ffa0affb847e5598ff2d60ce73dcb998a99cb2a4dd1da17763f69fac
+  metadata.gz: 7c0d1c868566984cc1656049d2705a2b7af30293e567b0d66ff065edeeea004d257e5d3164b2e288949dfcc0654f0dddc3dea2d81a0c64ccebd1cd05c14afbb8
+  data.tar.gz: 8094d77d65803ac2ad438e1eee6c9c32218e60e6548a09d18874796bad2a17ba891178aa6f0198b6d756ea4d067abcca2a8492a391b7e8d8409d381fcf652df2

data/CHANGELOG.md

@@ -7,6 +7,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.3.0] - 2026-04-10
+
+### Added
+- Add `declaration:` option to `build`, `build_soap`, and `Document.new` to omit the XML declaration when building fragments
+- Add CDATA content validation — raises `Error` if content contains `]]>`
+- Add comment text validation — raises `Error` if text contains `--`
+- Add Ruby 3.4 to CI test matrix
+
+## [0.2.2] - 2026-03-31
+
+### Added
+- Add GitHub issue templates, dependabot config, and PR template
+
 ## [0.2.1] - 2026-03-31
 
 ### Changed

data/README.md

@@ -98,6 +98,19 @@ xml = Philiprehberger::XmlBuilder.build do |doc|
 end
 ```
 
+### Without XML Declaration
+
+Omit the `<?xml ... ?>` declaration when building fragments:
+
+```ruby
+xml = Philiprehberger::XmlBuilder.build(declaration: false) do |doc|
+  doc.tag(:item, id: "1") { doc.text("fragment") }
+end
+
+puts xml
+# <item id="1">fragment</item>
+```
+
 ### XML Namespaces
 
 Register namespace prefixes and create namespace-aware elements:
@@ -184,8 +197,8 @@ end
 
 | Method | Description |
 |--------|-------------|
-| `.build(encoding: "UTF-8", version: "1.0") { \|doc\| ... }` | Build an XML document and return the string |
-| `.build_soap(soap_version: "1.1", encoding: "UTF-8", version: "1.0") { \|header, body\| ... }` | Build a SOAP envelope document |
+| `.build(encoding: "UTF-8", version: "1.0", declaration: true) { \|doc\| ... }` | Build an XML document and return the string |
+| `.build_soap(soap_version: "1.1", encoding: "UTF-8", version: "1.0", declaration: true) { \|header, body\| ... }` | Build a SOAP envelope document |
 
 ### `Document`
 

data/lib/philiprehberger/xml_builder/document.rb

@@ -10,9 +10,10 @@ module Philiprehberger
 
       # @param version [String] XML version for the declaration
       # @param encoding [String] XML encoding for the declaration
-      def initialize(version: '1.0', encoding: 'UTF-8')
+      def initialize(version: '1.0', encoding: 'UTF-8', declaration: true)
         @version = version
         @encoding = encoding
+        @declaration = declaration
         @children = []
         @node_stack = []
         @namespaces = {}
@@ -50,6 +51,8 @@ module Philiprehberger
       # @param content [String] the CDATA content (must not contain "]]>")
       # @return [void]
       def cdata(content)
+        raise Error, 'CDATA content must not contain "]]>"' if content.to_s.include?(']]>')
+
         current_parent.push("<![CDATA[#{content}]]>")
       end
 
@@ -58,6 +61,8 @@ module Philiprehberger
       # @param text [String] the comment text
       # @return [void]
       def comment(text)
+        raise Error, 'Comment text must not contain "--"' if text.to_s.include?('--')
+
         current_parent.push("<!-- #{text} -->")
       end
 
@@ -90,8 +95,12 @@ module Philiprehberger
       # @param indent [Integer, nil] number of spaces per indentation level, or nil for compact output
       # @return [String] the rendered XML document
       def to_xml(indent: nil)
-        parts = ["<?xml version=\"#{@version}\" encoding=\"#{@encoding}\"?>"]
-        parts << (indent ? "\n" : '')
+        parts = []
+
+        if @declaration
+          parts << "<?xml version=\"#{@version}\" encoding=\"#{@encoding}\"?>"
+          parts << (indent ? "\n" : '')
+        end
 
         @children.each do |child|
           parts << render_child(child, indent: indent, level: 0)

data/lib/philiprehberger/xml_builder/version.rb

@@ -2,6 +2,6 @@
 
 module Philiprehberger
   module XmlBuilder
-    VERSION = '0.2.1'
+    VERSION = '0.3.0'
   end
 end

data/lib/philiprehberger/xml_builder.rb

@@ -15,8 +15,8 @@ module Philiprehberger
     # @param version [String] XML version declaration (default: "1.0")
     # @yield [Document] the document builder
     # @return [String] the rendered XML string
-    def self.build(encoding: 'UTF-8', version: '1.0', &block)
-      doc = Document.new(version: version, encoding: encoding)
+    def self.build(encoding: 'UTF-8', version: '1.0', declaration: true, &block)
+      doc = Document.new(version: version, encoding: encoding, declaration: declaration)
       block.call(doc)
       doc.to_s
     end
@@ -31,8 +31,8 @@ module Philiprehberger
     # @param version [String] XML version declaration (default: "1.0")
     # @yield [header, body] yields two arrays; push lambdas that accept a doc
     # @return [String] the rendered SOAP XML string
-    def self.build_soap(soap_version: '1.1', encoding: 'UTF-8', version: '1.0', &block)
-      doc = Document.new(version: version, encoding: encoding)
+    def self.build_soap(soap_version: '1.1', encoding: 'UTF-8', version: '1.0', declaration: true, &block)
+      doc = Document.new(version: version, encoding: encoding, declaration: declaration)
       doc.soap_envelope(version: soap_version, &block)
       doc.to_s
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: philiprehberger-xml_builder
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Philip Rehberger
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-03-31 00:00:00.000000000 Z
+date: 2026-04-11 00:00:00.000000000 Z
 dependencies: []
 description: Programmatic XML construction with a clean DSL, auto-escaping, CDATA,
   comments, processing instructions, and pretty printing. Zero dependencies.
@@ -26,11 +26,11 @@ files:
 - lib/philiprehberger/xml_builder/escaper.rb
 - lib/philiprehberger/xml_builder/node.rb
 - lib/philiprehberger/xml_builder/version.rb
-homepage: https://github.com/philiprehberger/rb-xml-builder
+homepage: https://philiprehberger.com/open-source-packages/ruby/philiprehberger-xml_builder
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/philiprehberger/rb-xml-builder
+  homepage_uri: https://philiprehberger.com/open-source-packages/ruby/philiprehberger-xml_builder
   source_code_uri: https://github.com/philiprehberger/rb-xml-builder
   changelog_uri: https://github.com/philiprehberger/rb-xml-builder/blob/main/CHANGELOG.md
   bug_tracker_uri: https://github.com/philiprehberger/rb-xml-builder/issues