xmlbuilder 0.2.6 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 42a7c1b629722216b6d80b67c770a9ddc6b28cd9
-  data.tar.gz: 395ad471f2713ed4b11b2c07e1d3860ab8adbdf4
+  metadata.gz: 3bd4c789992a5269f5279e618fe048e090f03184
+  data.tar.gz: 6a68d9ed39a906f87c7c19839f22bc59568dd900
 SHA512:
-  metadata.gz: 462b61b94852841639c8892176a1b4ca8cef1f4c8385bfbf27bb3a21a8bbf7fa3b82f265a174b4c6b86946e09d388172ced39509565358f342513b10c2b7fd11
-  data.tar.gz: dccf8a82a9405e3d72a87809244868ed6d1886ead40e9e38402f3e717ca999c2c94f7d22dfdd9ad6907e866f6be4c77bc7dccdca3d225dfb6e7aceabc88819ed
+  metadata.gz: 2c101946113eea1ca8b65f554e028cd2284400419762a2d0368f90fdc1ebfd0ac6466ca913a11c1699e50936476bed206ec371a52b287a9d8fdb2a8fcce83803
+  data.tar.gz: 46fca03eceb72c57ad051af2ee3ab494d9a5654b9d2822a1574b2535267721a60768e7204b4588b93553c2581af2eb2c9203570b3dbeef38d9206d71285ef764

data/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright 2020 Coderzthereal
+
+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.

data/README.md

@@ -0,0 +1,81 @@
+## 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
+Available for use under the [MIT license](https://opensource.org/licenses/MIT)

data/lib/xmlbuilder.rb

@@ -1,78 +1,95 @@
-# XMLBuilder is a class that allows you to easily create XML.
-# Here's an example:
-#   xml = XMLBuilder.new
-#   xml.document :type => 'xml', :use => 'example' do |document|
-#     document.description { |desc| desc.add "This is an example of using XMLBuilder.\n" }
-#     document.nextmeeting :date => Time.now+100000 do |meeting|
-#       meeting.agenda { |agenda| agenda.add "Nothing of importance will be decided.\n" }
-#       meeting.clearance true, :level => :classified # Passing true in as the first parameter will cause it to be a tag with no closing 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>
+# XMLBuilder is a library that allows you to easily create XML.
+#
+# Licensed under MIT
+#
+# Written by Coderz
+#
+
 class XMLBuilder
-	attr_reader :str
-	# XMLBuilder#initialize simply sets the stored string to "".
-	def initialize
-		@str = ""
-	end
-	# XMLBuilder#clear does the same thing as #initialize (by delegating to it).
-	def clear
-		initialize # That's essentially what it does.
-	end
-	# XMLBuilder#add adds a string (with no processing) to the object's string.
-	def add(str)
-		@str << str
-	end
-	# XMLBuilder#method_missing is the brains of the operation. It takes the name of the tag to add,
-	# 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, XMLBuilder#add_element, which is used for already defined methods such as XMLBuilder#send and 
-	# XMLBuilder#method_missing.
-	def method_missing(name, *args, &block)
-		if args.length == 2
-			one_tag, hash = *args
-		elsif args.length == 1
-			if args[0].is_a? Hash
-				one_tag, hash = *[false, args[0]]
-			else
-				one_tag, hash = *[args[0], {}]
-			end
-		else
-			one_tag, hash = false, {}
-		end
-		@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 block
-				block.call(self)
-			end
-			@str << "</#{name}>\n"
-		end
-		return @str
-	end
-	alias :add_element :method_missing
-	alias :to_s :str
-	alias :to_str :str
-	alias :inspect :str
-end
+  @@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
+
+  # Sets the stored string to "" and the depth to 0.
+  def clear
+    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
+  private :process_args, :indentation
+  public :add_element
+end

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,26 +1,32 @@
 --- !ruby/object:Gem::Specification
 name: xmlbuilder
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.4.2
 platform: ruby
 authors:
 - Coderz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-24 00:00:00.000000000 Z
+date: 2020-11-08 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.
-email: asdfsocool@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"
+- LICENSE
+- README.md
+homepage: https://github.com/Coderzthereal/xmlbuilder
 licenses:
-- CC-BY-NC-SA-4.0
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -30,7 +36,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -38,8 +44,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.7
+rubygems_version: 2.5.2
 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: []