xml-write-stream 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a14bdeb8c25d97029a82e7afbe8bd8cd0247593a
-  data.tar.gz: 37b5e95c34ad08e90db5a5dd07c07be5ac2db843
+  metadata.gz: 9b8810869755e31ba4eb0c0efd716787b8eb25de
+  data.tar.gz: 6ac7aae4aee3fcb9eddbd0e7db7084e12a7f3034
 SHA512:
-  metadata.gz: f46bd1fe8b2489370cea9299e3ce94ee08069549bdb3e3a12c9db94b0d47e7222bd67b8b9daf2e4e6e8b8e897623a552defb79b7741ef25c3521095172129205
-  data.tar.gz: 5fa0ad54a777b0db21a3b1fa23887950cded7b05649812511a3c20f1e7108f2802c6d102ec4272af7ceb7775f3458bc1fefed8423a44821f6e890099603ac969
+  metadata.gz: 55ac91d6d9a2597e8025c2f29cfe120206056ccabc6e894db31fbdcc820ac1da49d34c8fb970ab74da72d156f4812432bae25c44dfe0508334dfb9c32ea0a783
+  data.tar.gz: 1f5279c539a02ad48925764de74e97876089e2948881ba4a39d52c9d60856acf8eac5b86f09ccf23ba1ff0020d2c5cf12baa90caff20d7fb747986f5ae0674de

data/History.txt

@@ -1,3 +1,7 @@
+== 1.1.0
+
+* Add ability to write tags on single lines.
+
 == 1.0.0
 
 * Birthday!

data/lib/xml-write-stream/base.rb

@@ -32,13 +32,10 @@ class XmlWriteStream
 
     def write_text(text, options = {})
       escape = options.fetch(:escape, true)
-      stream.write(indent_spaces)
 
       stream.write(
         escape ? escape_text(text) : text
       )
-
-      write_newline
     end
 
     def write_header(attributes = {})
@@ -70,7 +67,6 @@ class XmlWriteStream
     end
 
     def write_open_tag(tag_name, attributes)
-      stream.write(indent_spaces)
       stream.write("<#{tag_name}")
 
       if attributes.size > 0
@@ -82,7 +78,6 @@ class XmlWriteStream
     end
 
     def write_close_tag(tag_name)
-      stream.write(indent_spaces)
       stream.write("</#{tag_name}>")
     end
 

data/lib/xml-write-stream/stateful_writer.rb

@@ -1,6 +1,17 @@
 # encoding: UTF-8
 
 class XmlWriteStream
+  class StackItem
+    attr_reader :tag_name, :multiline
+
+    def initialize(tag_name, multiline = true)
+      @tag_name = tag_name
+      @multiline = multiline
+    end
+
+    alias_method :multiline?, :multiline
+  end
+
   class StatefulWriter < Base
     attr_reader :stream, :stack, :closed, :indent, :index
     alias :closed? :closed
@@ -14,15 +25,31 @@ class XmlWriteStream
     end
 
     def open_tag(tag_name, attributes = {})
+      open_tag_helper(tag_name, true, attributes)
+    end
+
+    def open_single_line_tag(tag_name, attributes = {})
+      open_tag_helper(tag_name, false, attributes)
+    end
+
+    def open_tag_helper(tag_name, multiline, attributes = {})
       check_eos
-      @index += 1
+
+      if index == 0
+        stack.push(StackItem.new(tag_name, multiline))
+      end
 
       check_tag_name(tag_name)
       check_attributes(attributes)
+      stream.write(indent_spaces) if index > 0 && current.multiline?
       write_open_tag(tag_name, attributes)
-      write_newline
+      write_newline if multiline
+
+      if index > 0
+        stack.push(StackItem.new(tag_name, multiline))
+      end
 
-      stack.push(tag_name)
+      @index += 1
     end
 
     def write_text(text, options = {})
@@ -32,7 +59,10 @@ class XmlWriteStream
         raise NoTopLevelTagError
       end
 
+      stream.write(indent_spaces) if current.multiline?
       super
+
+      write_newline if current.multiline?
     end
 
     def write_header(attributes = {})
@@ -46,9 +76,10 @@ class XmlWriteStream
 
     def close_tag(options = {})
       if in_tag?
-        tag_name = stack.pop
-        write_close_tag(tag_name)
-        write_newline
+        stack_item = stack.pop
+        stream.write(indent_spaces) if stack_item.multiline?
+        write_close_tag(stack_item.tag_name)
+        write_newline if current && current.multiline?
       end
     end
 
@@ -72,6 +103,10 @@ class XmlWriteStream
       (stack.size == 0 && index > 0) || closed?
     end
 
+    def current
+      stack.last
+    end
+
     protected
 
     def indent_spaces

data/lib/xml-write-stream/version.rb

@@ -1,5 +1,5 @@
 # encoding: UTF-8
 
 class XmlWriteStream
-  VERSION = "1.0.2"
+  VERSION = "1.1.0"
 end

data/lib/xml-write-stream/yielding_writer.rb

@@ -14,12 +14,14 @@ class XmlWriteStream
       check_closed
       check_tag_name(tag_name)
       check_attributes(attributes)
+      stream.write(indent_spaces)
       write_open_tag(tag_name, attributes)
       write_newline
 
       @level += 1
       yield self if block_given?
       @level -= 1
+      stream.write(indent_spaces)
       write_close_tag(tag_name)
       write_newline
     end
@@ -31,7 +33,9 @@ class XmlWriteStream
         raise NoTopLevelTagError
       end
 
+      stream.write(indent_spaces)
       super
+      write_newline
     end
 
     def write_header(attributes = {})

data/spec/stateful_spec.rb

@@ -45,13 +45,34 @@ describe XmlWriteStream::YieldingWriter do
     end
   end
 
+  describe '#open_single_line_tag' do
+    it 'writes a tag and its contents on a single line' do
+      stream_writer.open_single_line_tag('maytag')
+      stream_writer.write_text('foobar')
+      stream_writer.close_tag
+      expect(stream.string).to eq("<maytag>foobar</maytag>")
+    end
+
+    it 'works with nested tags' do
+      stream_writer.open_single_line_tag('maytag')
+      stream_writer.write_text('foobar')
+      stream_writer.open_single_line_tag('gutentag')
+      stream_writer.write_text('foobaz')
+      stream_writer.close_tag
+      stream_writer.close_tag
+      expect(stream.string).to eq(
+        "<maytag>foobar<gutentag>foobaz</gutentag></maytag>"
+      )
+    end
+  end
+
   describe '#open_tag' do
     it 'writes an opening tag' do
       stream_writer.open_tag('maytag')
       stream_writer.close
 
       expect(stream.string).to eq(
-        utf8("<maytag>\n</maytag>\n")
+        utf8("<maytag>\n</maytag>")
       )
     end
 
@@ -60,7 +81,7 @@ describe XmlWriteStream::YieldingWriter do
       stream_writer.close
 
       expect(stream.string).to eq(
-        utf8("<maytag type=\"washing_machine\">\n</maytag>\n")
+        utf8("<maytag type=\"washing_machine\">\n</maytag>")
       )
     end
 
@@ -82,7 +103,7 @@ describe XmlWriteStream::YieldingWriter do
       stream_writer.close
 
       expect(stream.string).to eq(
-        utf8("<foo9>\n    <bar:baz>\n    </bar:baz>\n</foo9>\n")
+        utf8("<foo9>\n    <bar:baz>\n    </bar:baz>\n</foo9>")
       )
     end
 
@@ -101,7 +122,7 @@ describe XmlWriteStream::YieldingWriter do
       stream_writer.close_tag
 
       expect(stream.string).to eq(
-        utf8("<maytag>\n</maytag>\n")
+        utf8("<maytag>\n</maytag>")
       )
     end
   end
@@ -113,7 +134,7 @@ describe XmlWriteStream::YieldingWriter do
       stream_writer.close
 
       expect(stream.string).to eq(
-        utf8("<places>\n    Alaska &amp; Hawai&apos;i\n</places>\n")
+        utf8("<places>\n    Alaska &amp; Hawai&apos;i\n</places>")
       )
     end
 
@@ -123,7 +144,7 @@ describe XmlWriteStream::YieldingWriter do
       stream_writer.close
 
       expect(stream.string).to eq(
-        utf8("<places>\n    Alaska & Hawai'i\n</places>\n")
+        utf8("<places>\n    Alaska & Hawai'i\n</places>")
       )
     end
 
@@ -150,7 +171,7 @@ describe XmlWriteStream::YieldingWriter do
       stream_writer.flush
 
       expect(stream.string).to eq(
-        utf8("<foo>\n    <bar>\n        <baz>\n        </baz>\n    </bar>\n</foo>\n")
+        utf8("<foo>\n    <bar>\n        <baz>\n        </baz>\n    </bar>\n</foo>")
       )
 
       expect(stream).to_not be_closed
@@ -166,7 +187,7 @@ describe XmlWriteStream::YieldingWriter do
       stream_writer.close
 
       expect(stream.string).to eq(
-        utf8("<foo>\n    <bar>\n        <baz>\n        </baz>\n    </bar>\n</foo>\n")
+        utf8("<foo>\n    <bar>\n        <baz>\n        </baz>\n    </bar>\n</foo>")
       )
 
       expect(stream).to be_closed

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xml-write-stream
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Cameron Dutro
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-26 00:00:00.000000000 Z
+date: 2015-07-10 00:00:00.000000000 Z
 dependencies: []
 description: An easy, streaming way to generate XML.
 email:
@@ -17,6 +17,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- Gemfile
+- History.txt
+- README.md
+- Rakefile
 - lib/xml-write-stream.rb
 - lib/xml-write-stream/base.rb
 - lib/xml-write-stream/stateful_writer.rb
@@ -26,32 +30,28 @@ files:
 - spec/stateful_spec.rb
 - spec/xml-write-stream_spec.rb
 - spec/yielding_spec.rb
-- Gemfile
-- History.txt
-- README.md
-- Rakefile
 - xml-write-stream.gemspec
 homepage: http://github.com/camertron
 licenses: []
 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: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.1.9
-signing_key:
+rubyforge_project: 
+rubygems_version: 2.2.3
+signing_key: 
 specification_version: 4
 summary: An easy, streaming way to generate XML.
 test_files: []