xml-mixup 0.1.12 → 0.1.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce4b5cbf2235ee24e96cec12c0d65dbd7b40b9263ad0bddf5c3424f5ba6ce510
-  data.tar.gz: 2cfaa1771ddbc17085b7f6544b3c8d6e8078861337fabfbf3c2dd678220d8cf1
+  metadata.gz: f2987df3a876da2b544c023d70a16dc8a44eb8bf391af07436263004b180f095
+  data.tar.gz: d04b0ad24255030ae51d50c7d198d95baf08570ec6a3e411b61119ef329a1542
 SHA512:
-  metadata.gz: f7c179cbabe818107285b4ccf74be253cca2b6a4c887b0ecc29167f07ee8db48450ae1bf3a6cb560c653c59c9dc05b6a1b80aab45354c9fd055ce75199c40891
-  data.tar.gz: d3013275de68a4e5a83df7afe9f4200808f8b9ccc09356d935d27807e2806ad2b5f61fedc0b9523ce1c610f69f9631343e9d2ec0e69b0cf794449e7ee26e034d
+  metadata.gz: 6537916b1380983c64e39aaf54048a0a08e6df07662c7319c07df566dee3320dd850b1153cfa705a7f18bacad12a26949d13b968f59c21a76270007889a2a3c2
+  data.tar.gz: 85d6a953e37ec44ca90f6b28dcb39483de885b094b17fa70caabf9ad18f52d6e723345391c264033df094f82f0db79e892231152615f9e305161badeca80dd8c

data/lib/xml/mixup/version.rb

@@ -1,5 +1,5 @@
 module XML
   module Mixup
-    VERSION = "0.1.12"
+    VERSION = "0.1.16"
   end
 end

data/lib/xml/mixup.rb

@@ -3,12 +3,9 @@ require 'nokogiri'
 require 'set'
 
 module XML::Mixup
-
-  # 
-
   # these are node attachment protocols
   private
-  
+
   ADJACENT = {
     parent:  lambda do |node, parent|
       if parent.node_type == 9 and node.node_type == 1
@@ -31,8 +28,65 @@ module XML::Mixup
   RESERVED = Set.new(%w{comment cdata doctype dtd elem element
     pi processing-instruction tag}.map {|x| "##{x}"}).freeze
 
+  ATOMS = [String, Symbol, Numeric, FalseClass, TrueClass].freeze
+
+  def element tag, doc: nil, ns: {}, attr: {}, args: []
+    raise 'Document node must be present' unless doc
+    pfx = nil
+    if tag.respond_to? :to_a
+      pfx = tag[0]
+      tag = tag.to_a[0..1].join ':'
+    elsif m = tag.match(/([^:]+):/)
+      pfx = m[1]
+    end
+
+    elem = doc.create_element tag.to_s
+    elem.default_namespace = ns[pfx] if ns[pfx]
+
+    ns.keys.sort { |a, b| a.to_s <=> b.to_s }.each do |p|
+      elem.add_namespace((p.nil? ? p : p.to_s), ns[p].to_s)
+    end
+    attr.sort.each do |k, v|
+      v = flatten_attr(v, args) or next
+      elem[k.to_s] = v
+    end
+
+    elem
+  end
+
   public
 
+  # Returns a string suitable for an XML attribute.
+  #
+  # @param obj [Object] the object to be flattened
+  # @param args [Array, nil] callback arguments
+  #
+  # @return [String] the attribute in question.
+  #
+  def flatten_attr obj, args = []
+    return if obj.nil?
+    args ||= []
+    # early bailout for most likely condition
+    if ATOMS.any? { |x| obj.is_a? x }
+      obj.to_s
+    elsif obj.is_a? Hash
+      tmp = obj.sort.map do |kv|
+        v = flatten_attr kv[1], args
+        v.nil? ? nil : "#{kv[0].to_s}: #{v}"
+      end.compact
+      tmp.empty? ? nil : tmp.join(' ')
+    elsif obj.respond_to? :call
+      flatten_attr obj.call(*args), args
+    elsif obj.respond_to? :map
+      tmp = obj.map { |x| flatten_attr x, args }.reject do |x|
+        x.nil? || x == ''
+      end
+      tmp.empty? ? nil : tmp.join(' ')
+    else
+      obj.to_s
+    end
+  end
+
   # Generate a handy blank document.
   #
   # @param version [Numeric, nil]
@@ -51,6 +105,8 @@ module XML::Mixup
   #    include XML::Mixup
   #  end
   #
+  #  # note you can now also just call XML::Mixup.markup
+  #
   #  something = Anything.new
   #
   #  # generate a structure
@@ -73,18 +129,18 @@ module XML::Mixup
   #  # case, it will be a text node containing 'lolwut'.
   #
   #  doc = node.document
-  #  puts doc.to_xml  
+  #  puts doc.to_xml
   #
   # @param spec [Hash, Array, Nokogiri::XML::Node, Proc, #to_s] An XML
   #  tree specification. May be composed of multiple hashes and
   #  arrays. See the spec spec.
-  # 
+  #
   # @param doc [Nokogiri::XML::Document, nil] an optional XML document
-  #  instance; will be supplied if none given.
+  #  instance; will be created if none given.
   #
   # @param args [#to_a] Any arguments to be passed to any callbacks
   #  anywhere in the spec. Assumed to be an array.
-  # 
+  #
   # @param parent [Nokogiri::XML::Node] The node under which the
   #  evaluation result of the spec is to be attached. This is the
   #  default adjacent node, which in turn defaults to the document if
@@ -171,7 +227,7 @@ module XML::Mixup
             x = x.to_a
             name = x.shift
             children = x
-          else 
+          else
             name = x
           end
         elsif (compact = spec.select { |k, _| k.respond_to?(:to_a) or
@@ -180,10 +236,10 @@ module XML::Mixup
           raise %q{Spec can't have duplicate compact keys} if compact.count > 1
           children, name = compact.first
           children = children.is_a?(Hash) ||
-            children.is_a?(Nokogiri::XML::Node) ? [children] : children.to_a 
+            children.is_a?(Nokogiri::XML::Node) ? [children] : children.to_a
         elsif (special = spec.select { |k, _| k.respond_to? :to_s and
                    k.to_s.start_with? ?# }) and !special.empty?
-          # these are special keys 
+          # these are special keys
           raise %q{Spec can't have multiple special keys} if special.count > 1
           name, children = special.first
 
@@ -203,7 +259,7 @@ module XML::Mixup
 
           # don't forget to reset the child nodes
           children = children.is_a?(Hash) || !children.respond_to?(:to_a) ?
-            [children] : children.to_a 
+            [children] : children.to_a
         end
 
         # note the name can be nil because it can be inferred
@@ -217,7 +273,7 @@ module XML::Mixup
         # now we dispatch based on the name
         if name == '#comment'
           # first up, comments
-          node = doc.create_comment flatten(children, args).to_s
+          node = doc.create_comment flatten_attr(children, args).to_s
 
           # attach it
           ADJACENT[adj].call node, nodes[adj]
@@ -231,14 +287,14 @@ module XML::Mixup
           content = ''
           if (c = children[1..children.length]) and c.length > 0
             #warn c.inspect
-            content = flatten(c, args).to_s
+            content = flatten_attr(c, args).to_s
           else
             content = attr.sort.map { |pair|
-              v = flatten(pair[1], args) or next
+              v = flatten_attr(pair[1], args) or next
               "#{pair[0].to_s}=\"#{v}\""
             }.compact.join(' ')
           end
-              
+
           node = Nokogiri::XML::ProcessingInstruction.new(doc, target, content)
 
           #warn node.inspect, content
@@ -274,14 +330,14 @@ module XML::Mixup
           #ADJACENT[adj].call node, nodes[adj]
         elsif name == '#cdata'
           # let's not forget cdata sections
-          node = doc.create_cdata flatten(children, args)
+          node = doc.create_cdata flatten_attr(children, args)
           # attach it
           ADJACENT[adj].call node, nodes[adj]
 
         else
           # finally, an element
 
-          raise 'Element name inference NOT IMPLEMENTED' unless name
+          raise "Element name inference NOT IMPLEMENTED: #{spec}" unless name
 
           # first check the name
           prefix = local = nil
@@ -295,7 +351,7 @@ module XML::Mixup
           at = {}
           attr.each do |k, v|
             k = k.to_s
-            v = flatten(v, args) or next
+            v = flatten_attr(v, args) or next
             if (md = /^xmlns(?::(.*))?$/i.match(k))
               ns[md[1]] = v
             else
@@ -338,7 +394,7 @@ module XML::Mixup
           # generate the node
           node = element name, doc: doc, ns: ns, attr: at, args: args
 
-          # attach it 
+          # attach it
           ADJACENT[adj].call node, nodes[adj]
 
           # don't forget the children!
@@ -368,9 +424,9 @@ module XML::Mixup
   # Generates an XHTML stub, with optional RDFa attributes. All
   # parameters are optional.
   #
-  # *This method is still under development.* I am still trying to
-  # figure out how I want it to behave. Some parts may not work as
-  # advertised.
+  # @note *This method is still under development.* I am still trying
+  #  to figure out how I want it to behave. Some parts may not work as
+  #  advertised.
   #
   # @param doc [Nokogiri::XML::Document, nil] an optional document.
   #
@@ -378,7 +434,7 @@ module XML::Mixup
   #
   # @param prefix [Hash] the contents of the root node's +prefix=+
   #  and +xmlns:*+ attributes.
-  # 
+  #
   # @param vocab [#to_s] the contents of the root node's +vocab=+.
   #
   # @param lang [#to_s] the contents of +lang=+ and when applicable,
@@ -428,7 +484,7 @@ module XML::Mixup
   #  namespaces. Defaults to +true+.
   #
   # @param args [#to_a] Arguments for any callbacks in the spec.
-  # 
+  #
   # @return [Nokogiri::XML::Node] the last node generated, in document order.
 
   def xhtml_stub doc: nil, base: nil, ns: {}, prefix: {}, vocab: nil,
@@ -458,7 +514,7 @@ module XML::Mixup
     elsif title.is_a? Hash
       # nothing
     elsif title.respond_to? :to_a
-      title = title.to_a
+      title = title.to_a.dup
       text  = title.shift
       props = title
       title = { '#title' => text }
@@ -478,7 +534,7 @@ module XML::Mixup
     # construct document tree
 
     head ||= {}
-    if head.is_a? Hash and head.empty? 
+    if head.is_a? Hash and head.empty?
       head[nil] = [:head, title, base, link, meta, style, script, extra]
     elsif head.is_a? Array
       # children of unmarked head element
@@ -530,55 +586,7 @@ module XML::Mixup
     markup spec: spec, doc: doc, args: args
   end
 
-  private
-
-  def element tag, doc: nil, ns: {}, attr: {}, args: []
-    raise 'Document node must be present' unless doc
-    pfx = nil
-    if tag.respond_to? :to_a
-      pfx = tag[0]
-      tag = tag.to_a[0..1].join ':'
-    elsif m = tag.match(/([^:]+):/)
-      pfx = m[1]
-    end
-
-    elem = doc.create_element tag.to_s
-    elem.default_namespace = ns[pfx] if ns[pfx]
-
-    ns.keys.sort { |a, b| a.to_s <=> b.to_s }.each do |p|
-      elem.add_namespace((p.nil? ? p : p.to_s), ns[p].to_s)
-    end
-    attr.sort.each do |k, v|
-      v = flatten(v, args) or next
-      elem[k.to_s] = v
-    end
-
-    elem
-  end
-
-  ATOMS = [String, Symbol, Numeric, FalseClass, TrueClass].freeze
-
-  # yo dawg
-
-  def flatten obj, args
-    return if obj.nil?
-    # early bailout for most likely condition
-    if ATOMS.any? { |x| obj.is_a? x }
-      obj.to_s
-    elsif obj.is_a? Hash
-      tmp = obj.sort.map do |kv|
-        v = flatten(kv[1], args)
-        v.nil? ? nil : "#{kv[0].to_s}: #{v}"
-      end.compact
-      tmp.empty? ? nil : tmp.join(' ')
-    elsif obj.respond_to? :call
-      flatten(obj.call(*args), args)
-    elsif obj.respond_to? :map
-      tmp = obj.map { |x| flatten(x, args) }.reject { |x| x.nil? || x == '' }
-      tmp.empty? ? nil : tmp.join(' ')
-    else
-      obj.to_s
-    end
-  end
 
+  # add class methods too
+  extend self
 end

data/xml-mixup.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.summary       = %q{A mixin for (XML) markup}
   spec.description   = %q{XML::Mixup uses declarative data structures to incrementally generate XML.}
   spec.homepage      = "https://github.com/doriantaylor/rb-xml-mixup"
-  spec.required_ruby_version = "~> 2.0"
+  spec.required_ruby_version = ">= 2.0"
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
@@ -21,9 +21,9 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "bundler", "~> 2.1"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.9"
 
-  spec.add_dependency "nokogiri", ">= 1.10.4"
+  spec.add_dependency "nokogiri", ">= 1.13.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xml-mixup
 version: !ruby/object:Gem::Version
-  version: 0.1.12
+  version: 0.1.16
 platform: ruby
 authors:
 - Dorian Taylor
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-12-12 00:00:00.000000000 Z
+date: 2022-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,56 +16,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.10.4
+        version: 1.13.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.10.4
+        version: 1.13.6
 description: XML::Mixup uses declarative data structures to incrementally generate
   XML.
 email:
@@ -89,13 +89,13 @@ homepage: https://github.com/doriantaylor/rb-xml-mixup
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
       version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
@@ -104,9 +104,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
-signing_key: 
+rubygems_version: 3.3.11
+signing_key:
 specification_version: 4
 summary: A mixin for (XML) markup
 test_files: []