yaml-write-stream 1.0.4 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5150ab0601006ad44967a247d05199fd95a260fa
-  data.tar.gz: f512124a33caaf8ca2ea52920ce63879d43d1c8e
+  metadata.gz: ae8a65b60178d130ae20ab1ed7b69b7da808877b
+  data.tar.gz: 5bdaf04f74ef81c54d75f61e453a65b09059284f
 SHA512:
-  metadata.gz: 6b0ab08d6209fa31bb09a24168ee03abfc81a4eb852100a57c8e63a7e5f4ec5099f30390e30e5a4414c4a8f3677c5b8fadd3247a29c52d61f684804509d3a357
-  data.tar.gz: 198b820deec8fa0383daefa6d13f8055676860a032c7027961732f90645d707a70c45189929ebd8bb10b9fa26e8af8f7fca0c95028e6f2ec9ba1d860523d98cd
+  metadata.gz: 0a56250ac350ab119588f4a2b86560742ee9df190d0d42601d401f38621c9f9bf3bd5a3fbffdc05199e0d0d3e7e3b0a90ef8c43da6e37f8c001414daeb2e9a19
+  data.tar.gz: 439293700442a20ca04e47227e352702eb23ae3ba91edd0788f75e260b1cdf7deb459b8e0daa9adf28ab7d13ba1a077f1fcbbb2d33f96f65e226ec69e544fb85

data/Gemfile

@@ -4,7 +4,7 @@ gemspec
 
 group :development, :test do
   gem 'pry', '~> 0.9.0'
-  gem 'pry-nav'
+  gem 'pry-byebug'
   gem 'rake'
 end
 

data/History.txt

@@ -20,3 +20,11 @@
 == 1.0.4
 
 * Mapping values are now wrapped in double quotes by default
+
+== 2.0.0
+
+* Scalars are now dumped more consistently. Strings always have quotes, numbers never do.
+  This should address discrepancies that arise when dumping a string of digits. Previously,
+  the string would have been dumped either with "non-specific" tag notation (i.e. "!") or
+  without quotes. Both result in an integer when parsed. Now if you want to dump a number
+  as a string, convert it to a string before serializing.

data/lib/yaml-write-stream/stateful.rb

@@ -115,24 +115,39 @@ class YamlWriteStream
     end
 
     def write_scalar(value, quote = false)
-      style = if value == ''
+      case value
+        when Numeric
+          write_numeric_scalar(value)
+        when NilClass
+          write_nil_scalar
+        else
+          write_string_scalar(value.to_s, quote)
+      end
+    end
+
+    def write_string_scalar(value, quote = false)
+      style = if quote
         Psych::Nodes::Scalar::DOUBLE_QUOTED
       else
-        if !quote || !value
-          Psych::Nodes::Scalar::ANY
-        else
-          Psych::Nodes::Scalar::DOUBLE_QUOTED
-        end
+        Psych::Nodes::Scalar::PLAIN
       end
 
-      quoted = value == ''
-      value = value ? value : ''
+      # value, anchor, tag, plain, quoted, style
+      emitter.scalar(
+        value, nil, nil, true, true, style
+      )
+    end
 
+    def write_numeric_scalar(value)
       # value, anchor, tag, plain, quoted, style
       emitter.scalar(
-        value, nil, nil, true, quoted, style
+        value.to_s, nil, nil, true, false, Psych::Nodes::Scalar::PLAIN
       )
     end
+
+    def write_nil_scalar
+      write_string_scalar('')
+    end
   end
 
   class StatefulMappingWriter < StatefulWriter

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

@@ -1,5 +1,5 @@
 # encoding: UTF-8
 
 class YamlWriteStream
-  VERSION = "1.0.4"
+  VERSION = '2.0.0'
 end

data/lib/yaml-write-stream/yielding.rb

@@ -2,12 +2,14 @@
 
 class YamlWriteStream
   class YieldingWriter
-    attr_reader :emitter, :stream, :first
+    attr_reader :emitter, :stream, :first, :closed
+    alias_method :closed?, :closed
 
     def initialize(emitter, stream)
       @emitter = emitter
       @stream = stream
       @first = true
+      @closed = false
     end
 
     def flush
@@ -22,6 +24,7 @@ class YamlWriteStream
     def close
       flush
       stream.close
+      @closed = true
       nil
     end
 
@@ -30,7 +33,7 @@ class YamlWriteStream
 
       # anchor, tag, implicit, style
       emitter.start_sequence(
-        nil, nil, true, Psych::Nodes::Sequence::ANY
+        nil, nil, false, Psych::Nodes::Sequence::ANY
       )
 
       yield YieldingSequenceWriter.new(emitter, stream)
@@ -42,7 +45,7 @@ class YamlWriteStream
 
       # anchor, tag, implicit, style
       emitter.start_mapping(
-        nil, nil, true, Psych::Nodes::Sequence::ANY
+        nil, nil, false, Psych::Nodes::Sequence::ANY
       )
 
       yield YieldingMappingWriter.new(emitter, stream)
@@ -52,26 +55,39 @@ class YamlWriteStream
     protected
 
     def write_scalar(value, quote = false)
-      @first = false
+      case value
+        when Numeric
+          write_numeric_scalar(value)
+        when NilClass
+          write_nil_scalar
+        else
+          write_string_scalar(value.to_s, quote)
+      end
+    end
 
-      style = if value == ''
+    def write_string_scalar(value, quote = false)
+      style = if quote
         Psych::Nodes::Scalar::DOUBLE_QUOTED
       else
-        if !quote || !value
-          Psych::Nodes::Scalar::ANY
-        else
-          Psych::Nodes::Scalar::DOUBLE_QUOTED
-        end
+        Psych::Nodes::Scalar::PLAIN
       end
 
-      quoted = value == ''
-      value = value ? value : ''
+      # value, anchor, tag, plain, quoted, style
+      emitter.scalar(
+        value, nil, nil, true, true, style
+      )
+    end
 
+    def write_numeric_scalar(value)
       # value, anchor, tag, plain, quoted, style
       emitter.scalar(
-        value, nil, nil, true, quoted, style
+        value.to_s, nil, nil, true, false, Psych::Nodes::Scalar::PLAIN
       )
     end
+
+    def write_nil_scalar
+      write_string_scalar('')
+    end
   end
 
   class YieldingMappingWriter < YieldingWriter

data/spec/spec_helper.rb

@@ -3,7 +3,7 @@
 require 'rspec'
 require 'yaml-write-stream'
 require 'shared_examples'
-require 'pry-nav'
+require 'pry-byebug'
 
 RSpec.configure do |config|
   config.mock_with :rr

data/spec/stateful_spec.rb

@@ -31,7 +31,17 @@ describe YamlWriteStream::YieldingWriter do
       stream_writer.write_key_value('def', 'ghi')
       stream_writer.close
 
-      expect(stream.string).to eq(utf8("- abc\n- def: ! \"ghi\"\n"))
+      expect(stream.string).to eq(utf8("- abc\n- def: \"ghi\"\n"))
+      expect(stream_writer).to be_closed
+      expect(stream).to be_closed
+    end
+
+    it 'dumps numbers without quotes and without non-specific (implicit) tag notation' do
+      stream_writer.write_map
+      stream_writer.write_key_value('abc', 7)
+      stream_writer.close
+
+      expect(stream.string).to eq(utf8("abc: 7\n"))
       expect(stream_writer).to be_closed
       expect(stream).to be_closed
     end

data/spec/yielding_spec.rb

@@ -29,6 +29,31 @@ describe YamlWriteStream::YieldingWriter do
       expect(stream).to be_closed
     end
 
+    it 'correctly writes to and closes the stream without non-specific (implicit) tag notation' do
+      stream_writer.write_sequence do |seq_writer|
+        seq_writer.write_element('abc')
+        seq_writer.write_map do |map_writer|
+          map_writer.write_key_value('def', 'ghi')
+        end
+      end
+
+      stream_writer.close
+      expect(stream.string).to eq(utf8("- abc\n- def: \"ghi\"\n"))
+      expect(stream_writer).to be_closed
+      expect(stream).to be_closed
+    end
+
+    it 'dumps numbers without quotes and without non-specific (implicit) tag notation' do
+      stream_writer.write_map do |map_writer|
+        map_writer.write_key_value('abc', 7)
+      end
+
+      stream_writer.close
+      expect(stream.string).to eq(utf8("abc: 7\n"))
+      expect(stream_writer).to be_closed
+      expect(stream).to be_closed
+    end
+
     it 'quotes empty strings' do
       stream_writer.write_map do |map_writer|
         map_writer.write_key_value('foo', '')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yaml-write-stream
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 2.0.0
 platform: ruby
 authors:
 - Cameron Dutro
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-22 00:00:00.000000000 Z
+date: 2016-05-23 00:00:00.000000000 Z
 dependencies: []
 description: An easy, streaming way to generate YAML.
 email: