xmlbuilder 0.2.9 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 201431a2be1bd3b983848d916c346f54f7ae346e27721c0ea5cb7d18f29fef79
-  data.tar.gz: b8c7da4072e08df5200cd2f82c40ed5ebfe7019532869d429d573d5bfbaf024f
+  metadata.gz: cad808a09138b6583f6d1745180e7884f1d6a5486eaa7328cff44fc06b7e4a4d
+  data.tar.gz: c5522c2322483f81bd0b48f42f09849c59a9aea2c1348083164660ccb14a35a3
 SHA512:
-  metadata.gz: 3da9c440d70230c80dee62dcb8f8a345a3788acb147d748a4b5e10fd2478cdf6ae8d4767b361a850bde5723e9fa93af84634b902c9e9430073314fd730cb3127
-  data.tar.gz: 405d3caf5ba25426760c4b63a38c16b7f059665d33eed2a41d2466e35ce41d1baeaa5d67b2a430fff16539c2f7f62d07958a3a4ba560cd8cf12bb130ffe9fa00
+  metadata.gz: fb435fd60b53aefb8ac06e463d0768031faede54f5f297d08ed33ec5ec6722bb5a04265f390b002d2b61c16fa85dc4b24e99eaf6f7072cf5ebb9e4137a92e693
+  data.tar.gz: ac7a53d47591a95b8e540dac7ef008ac640e9d0d6ffd1b5c85e116afb15fb44502199628dec096a100d7e46be67cd3a4d9373991b9f8d5d34c38d6620d608a06

data/README.md

@@ -0,0 +1,93 @@
+## This is not the original XmlBuilder library.
+It is a separate library that uses a different interface. I did not write the original XmlBuilder gem, whose owner yanked it from rubygems.org in 2012.
+
+
+# xmlbuilder: A simple way to build XML
+This library allows you to generate XML in an idiomatic, human-readable way. It's designed to be easy to use to automatically generate XML on the fly or as needed inside your terminal.
+
+## Examples:
+A hard-coded example:
+```
+xml = XMLBuilder.new
+xml.document type: 'xml', use: 'example' do
+  xml.description "This is an example of using XMLBuilder."
+  xml.nextmeeting date: Time.now+100000 do
+    xml.agenda "Nothing of importance will be decided."
+    xml.clearance true, level: 'classified'
+    # Passing in true creates a void tag
+  end
+end
+
+p xml.str
+
+# =>
+<document type="xml" use="example">
+  <description>
+    This is an example of using XMLBuilder.
+  </description>
+  <nextmeeting date="2017-02-10 21:56:56 -0800">
+    <agenda>
+      Nothing of importance will be decided.
+    </agenda>
+    <clearance level="classified" />
+  </nextmeeting>
+</document>
+```
+
+Automatically encoding a data structure:
+```
+data = [
+  {
+    title: "Assassin's Apprentice",
+    author: "Robin Hobb",
+    published: 1995,
+    rating: 4.5
+  },
+  {
+    title: "The Fifth Season",
+    author: "N. K. Jemisin",
+    published: 2015,
+    rating: 4.6
+  },
+  ...
+].sort_by { |book| book['rating'] }
+
+output = XMLBuilder.new
+output.collection genre: 'fantasy' do
+  data.each do |book|
+    output.book do
+      book.each { |field, value| output.add_element field, value }
+    end
+  end
+end
+
+p output
+
+# =>
+<collection genre="fantasy">
+  <book>
+    <title>
+      Assassin's Apprentice
+    </title>
+    <author>
+      Robin Hobb
+    </author>
+    <published>
+      1995
+    </published>
+    <rating>
+      4.5
+    </rating>
+  </book>
+  ...
+</collection>
+```
+
+## Installation
+`gem install xmlbuilder`
+or add `gem 'xmlbuilder'` to your Gemfile
+
+[Here is the gem repo](https://rubygems.org/gems/xmlbuilder)
+
+## License
+This work is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License. To view a copy of this license, visit http://creativecommons.org/licenses/by-nc-sa/4.0/ or send a letter to Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.

data/lib/xmlbuilder.rb

@@ -1,97 +1,103 @@
 # XMLBuilder is a library that allows you to easily create XML.
-# Here's an example:
-#   xml = XMLBuilder.new
-#   xml.document :type => 'xml', :use => 'example' do
-#     xml.description "This is an example of using XMLBuilder.\n" # If you pass in a string, it will automatically input it into
-#     xml.nextmeeting :date => Time.now+100000 do       # the output string. You can't use a block with it, though.
-#       xml.agenda "Nothing of importance will be decided.\n"
-#       xml.clearance true, :level => :classified # Passing true in as the first parameter will cause it to be a standalone tag.
-#     end
-#     xml.add "I hope that this has been a good example."
-#   end
-#   p xml.str
-#   <document type="xml" use="example">
-#   <description>
-#   This is an example of using XMLBuilder.
-#   </description>
-#   <nextmeeting date="2017-02-10 21:56:56 -0800">
-#   <agenda>
-#   Nothing of importance will be decided.
-#   </agenda>
-#   <clearance level="classified" />
-#   </nextmeeting>
-#   I hope that this has been a good example.
-#   </document>
-class XMLBuilder
-	attr_reader :str
-	# #initialize simply sets the stored string to "" and the depth (used in nesting tags) to 0.
-	def initialize(separator="  ") # separator set to two spaces by default, used in nesting
+# 
+# Licensed under CC-BY-NC-SA-4.0
+# 
+# Written by Coderz
+# 
+
+
+class XMLBuilder
+  @@default_separator = "  "
+  # separator set to two spaces by default, used in nesting
+
+  attr_reader :str
+  attr_accessor :separator
+  
+	def initialize(separator=@@default_separator)
 		@str = ""
 		@depth = 0
 		@separator = separator
-	end
-	# #clear does the same thing as #initialize (by delegating to it).
+  end
+  
+	# Sets the stored string to "" and the depth to 0.
 	def clear
-		initialize # That's essentially what it does.
-	end
-	# #add adds a string (with no processing) to the object's string.
-	def add(str)
-		@str << str
-	end
-	def to_ary
-		return [@str]
-	end
-	# #method_missing is the brains of the operation. It takes the name of the tag to add,
-	# an optional string to put in the tag, an optional boolean parameter which signifies whether 
-	# to make it a single tag or not, any options to put in the tag, and a block to evaluate between
-	# the opening and closing tags. There is an alias, #add_element, which is used for already defined
-	# methods such as #send and #method_missing.
-	def method_missing(name, *args, &block)
-		internal = nil # Internal is a string that is put between the sides of the element
-		if args.length == 2
-			if args[0].is_a? String
-				one_tag, internal, hash = false, *args
-			else
-				one_tag, hash = *args
-			end
-		elsif args.length == 1
-			if args[0].is_a? Hash
-				one_tag, hash = *[false, args[0]]
-			elsif args[0].is_a? String
-				one_tag, internal, hash = false, args[0], {}
-			else
-				one_tag, hash = *[args[0], {}]
-			end
-		else
-			one_tag, hash = false, {}
-		end
-		@str << @separator.to_s * @depth
-		@str << "<#{name}"
-		if one_tag
-			hash.each do |k, v|
-				@str << " #{k}=\"#{v}\""
-			end
-			@str << " />\n"
-		else
-			hash.each do |k, v|
-				@str << " #{k}=\"#{v}\""
-			end
-			@str << ">\n"
-			if !internal.nil?
-				@str << internal.to_str + "\n"
-			elsif block
-				@depth += 1
-				block.call
-				@depth -= 1
-			end
-			@str << @separator * @depth
-			@str << "</#{name}>\n"
-		end
-		return @str
-	end
-	alias :add_element :method_missing
+    initialize(@separator)
+    self
+  end
+  
+	# Adds a string (with no preprocessing) to the object's string.
+	def add(*strs)
+		@str << strs.flatten.join('')
+  end
+  
+	# Takes the name of the tag to add, an optional string to put in the tag, an optional boolean parameter which signifies whether to make it a single tag or not, any options to put in the tag, and a block to evaluate between the opening and closing tags. Aliased to #method_missing to allow dynamic tag creation.
+  def add_element(name, *args)
+    one_tag, internal, attrs = process_args args
+    
+    # logic time
+    add indentation, ?<, name
+    attrs.each do |attr, value|
+      add " #{attr}=\"#{value}\""
+    end
+    if one_tag
+      add " />\n"
+      return self
+    else
+      add ?>
+    end
+    if internal
+      add internal
+    elsif block_given?
+      @depth += 1
+      add "\n"
+      yield
+      @depth -= 1
+    end
+    add indentation unless internal
+    add "</#{name}>\n"
+    return self
+  end
+
+  def process_args(args)
+    # Argument cheat sheet:
+    #  <name hash[0]="hash[1]">
+    #    internal
+    #  </name>
+    
+		internal = nil
+		if args.size == 2
+      if args[0] == !!args[0]
+        one_tag, hash = *args
+      else
+        one_tag, internal, hash = false, *args
+			end
+		elsif args.size == 1
+			if args[0].is_a? Hash
+				one_tag, hash = *[false, args[0]]
+			elsif args[0] == !!args[0]
+				one_tag, hash = args[0], {}
+			else
+				one_tag, internal, hash = false, args[0].to_s, {}
+			end
+		else
+			one_tag, hash = false, {}
+    end
+    return one_tag, internal, hash
+  end
+  def indentation; @separator * @depth; end
+	alias :method_missing :add_element
 	alias :to_s :str
 	alias :to_str :str
-	alias :inspect :str
+  alias :inspect :str
+  private :process_args, :indentation
 	public :add_element
 end
+
+# 
+# This work is licensed under the Creative Commons
+# Attribution-NonCommercial-ShareAlike 4.0 International License.
+# To view a copy of this license, visit 
+# http://creativecommons.org/licenses/by-nc-sa/4.0/ or
+# send a letter to
+# Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.
+# 

data/test/all.rb

@@ -0,0 +1,5 @@
+# haha testing go brrr
+
+require 'minitest/autorun'
+require_relative 'tags'
+require_relative 'examples'

data/test/examples.rb

@@ -0,0 +1,100 @@
+require_relative '../lib/xmlbuilder'
+
+# This test file contains various HTML snippets and fragments
+# in order to "stress-test" the library. Also I can't think of
+# edge cases so hopefully this will find them.
+
+$expected = [] # array of strings
+$actual = [] # array of procs
+
+$expected << <<-end
+<html>
+  <head>
+    <title>Page Title</title>
+  </head>
+  <body>
+    <h1>My First Heading</h1>
+    <p>My first paragraph.</p>
+  </body>
+</html>
+end
+
+$actual << Proc.new do |xml|
+  xml.html do
+    xml.head do
+      xml.title 'Page Title'
+    end
+    xml.body do
+      xml.h1 'My First Heading'
+      xml.p 'My first paragraph.'
+    end
+  end
+end
+
+$expected << <<-end
+<note>
+  <to>Dave</to>
+  <from>The Empress of Death</from>
+  <heading>Reminder</heading>
+  <body>Don't forget me this weekend!</body>
+</note>
+end
+
+$actual << Proc.new do |xml|
+  xml.note do
+    xml.to 'Dave'
+    xml.from 'The Empress of Death'
+    xml.heading 'Reminder'
+    xml.body 'Don\'t forget me this weekend!'
+  end
+end
+
+$expected << <<-end
+<bookstore>
+  <book category="COOKING">
+    <title lang="en">Everyday Italian</title>
+    <author>Giada De Laurentiis</author>
+    <year>2005</year>
+    <price>30.00</price>
+  </book>
+  <book category="CHILDREN">
+    <title lang="en">Harry Potter</title>
+    <author>J K. Rowling</author>
+    <year>2005</year>
+    <price>29.99</price>
+  </book>
+</bookstore>
+end
+
+$actual << Proc.new do |xml|
+  xml.bookstore do
+    xml.book category: 'COOKING' do
+      xml.title 'Everyday Italian', lang: 'en'
+      xml.author 'Giada De Laurentiis'
+      xml.year '2005'
+      xml.price '30.00'
+    end
+    xml.book category: 'CHILDREN' do
+      xml.title 'Harry Potter', lang: 'en'
+      xml.author 'J K. Rowling'
+      xml.year '2005'
+      xml.price '29.99'
+    end
+  end
+end
+
+
+
+class XMLBuilderStressTest < Minitest::Test
+  @@cases = $expected.zip($actual)
+  def setup
+    @test_obj = XMLBuilder.new
+  end
+  def test_all_cases
+    @@cases.each do |expected, actual|
+      actual = actual[@test_obj]
+      assert_equal expected.to_s, actual.to_s
+      @test_obj.clear
+    end
+  end
+end

data/test/tags.rb

@@ -0,0 +1,53 @@
+require_relative '../lib/xmlbuilder'
+
+class XMLBuilderTagTest < Minitest::Test
+  def setup
+    @test_obj = XMLBuilder.new
+  end
+
+  def test_builder_can_create_tags
+    @test_obj.add_element 'test_tag'
+    assert_equal '<test_tag></test_tag>', @test_obj.to_s.chomp
+    @test_obj.clear.add_element 'test_tag', true # Void element
+    assert_equal '<test_tag />', @test_obj.to_s.chomp
+  end
+
+  def test_builder_can_create_attributes
+    @test_obj.add_element 'test', attr: 'value'
+    assert_equal '<test attr="value"></test>', @test_obj.to_s.chomp
+  end
+
+  def test_can_handle_non_string_attrs_and_contents
+    @test_obj.add_element 'test', true, num: 37
+    assert_equal '<test num="37" />', @test_obj.to_s.chomp
+    @test_obj.clear.add_element 'test', 54
+    assert_equal "<test>54</test>", @test_obj.to_s.chomp
+  end
+
+  # May move to 'test/examples.rb'
+  def test_builder_can_nest_elements_correctly
+    expected = <<~end
+    <html>
+      <head>
+        <title>Test Title</title>
+      </head>
+      <body>
+        <p class="content">This is a piece of test content.</p>
+        <br />
+      </body>
+    </html>
+    end
+
+    xml = @test_obj
+    xml.html do
+      xml.head do
+        xml.title 'Test Title'
+      end
+      xml.body do
+        xml.p 'This is a piece of test content.', 'class': 'content'
+        xml.br true
+      end
+    end
+    assert_equal expected, xml.str
+  end
+end

metadata

@@ -1,25 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: xmlbuilder
 version: !ruby/object:Gem::Version
-  version: 0.2.9
+  version: 0.4.0
 platform: ruby
 authors:
-- Coderzthereal
+- Coderz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-04 00:00:00.000000000 Z
+date: 2020-10-20 00:00:00.000000000 Z
 dependencies: []
-description: |-
-  This gem allows you to write XML in a very Ruby-ish way. It supports
-    single tags, nesting tags, and adding strings. With a recent update, it also supports indentation.
-email: coderzthegamer@gmail.com
+description: This library allows you to generate XML in an idiomatic, human-readable
+  way. It's designed to be easy to use to automatically generate XML on the fly or
+  as needed inside your terminal.
+email: 
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/xmlbuilder.rb
-homepage: https://github.com/Coderzthereal/xmlbuilder
+- "./lib/xmlbuilder.rb"
+- "./test/all.rb"
+- "./test/examples.rb"
+- "./test/tags.rb"
+- README.md
+homepage: https://rubygems.org/gems/xmlbuilder
 licenses:
 - CC-BY-NC-SA-4.0
 metadata: {}
@@ -31,7 +35,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.2
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -42,5 +46,5 @@ rubyforge_project:
 rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: A simple gem that allows you to write XML in a very Ruby-ish way.
+summary: An idiomatic library allowing you to generate XML
 test_files: []