yaml_editor 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c4d94171e199ead4f730762d78bbcb675740b5f2
+  data.tar.gz: c39259d34ac37dc36304aa0aa1a161afc6507ff3
+SHA512:
+  metadata.gz: 31a145372b9f7edb99b0a9c55a61ef989b6f87813bd36dc7d7b7e805632fb70bc84487ccd6b577b06537f35f879688833bc8659d962b61cbeec6b2a2a0fdc118
+  data.tar.gz: 1e8eb554c871218bdfa9ec4d8dbafb2ab90a3e6d4bb9a776ac7f8006f9c3feff83cdb4ac40e73ac686f06027d0ff839a90f2dd1d22d732f340dd70826057d48c

data/.gitignore

@@ -0,0 +1,3 @@
+.DS_Store
+*.gem
+coverage

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/Rakefile

@@ -0,0 +1,18 @@
+# Tests
+
+require 'rake/testtask'
+require 'rubocop/rake_task'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs |= %w[
+    test
+    lib
+  ]
+  t.test_files = FileList['test/unit/**/test_*.rb']
+end
+
+RuboCop::RakeTask.new(:rubocop) do |t|
+  t.fail_on_error = true
+end
+
+task default: %i[test rubocop]

data/examples/example1.rb

@@ -0,0 +1,8 @@
+# Example editor use
+require_relative '../lib/yaml_editor'
+
+testfile = File.expand_path('../../test/data/testdata.yml', __FILE__)
+ed = YamlEditor.new(File.read(testfile))
+ed.update('keyb', 1, 'KEY_B', val: '"This was changed"')
+ed.update('keyb', 1, 'KEY_E', val: 'appended')
+puts ed

data/lib/yaml_editor.rb

@@ -0,0 +1,205 @@
+require 'yaml'
+
+# Exception class
+class YamlEditorError < StandardError; end
+
+# Editor for YAML documents
+# rubocop:disable Metrics/ClassLength
+class YamlEditor
+  # Legal indent chars
+  INDENTS = [' ', "\t"].freeze
+  COMMENTS = ['#'].freeze
+  QUOTES = ['\'', '"'].freeze
+  MIX_ERR = [YamlEditorError, 'Mixed indents'].freeze
+  VAL_ERR = [YamlEditorError, 'Value has mismatched quotes'].freeze
+  SET_ERR = [YamlEditorError,
+             'We currently only support adding to hashes'].freeze
+  FLD_ERR = [YamlEditorError, 'Values with spaces must be quoted'].freeze
+
+  def initialize(yaml)
+    @doc = yaml.lines.map(&:chomp)
+  end
+
+  def to_yaml
+    @doc.join("\n") + "\n"
+  end
+
+  alias to_s to_yaml
+
+  # High level APIs udpate
+
+  def update(*fields, val:)
+    raise(*FLD_ERR) if bad_quoting?(val)
+    spos, _, kind, v = bracket(*fields)
+    if kind == :value
+      tag, _, comment = v
+      @doc[spos] = "#{tag}#{val}#{comment}"
+    else
+      append(fields, val)
+    end
+  end
+
+  # Mid level search API (query)
+
+  # Iterate through a set of fields to obtain the block
+  # rubocop:disable all Hookup
+  def bracket(*fields)
+    spos = 0
+    epos = @doc.size - 1
+    value = nil
+    # Top level document type
+    kind = @doc[1] =~ /\s+-/ ? :array : :hash
+    fields.each do |field|
+      if field.is_a?(Integer) && kind == :array
+        spos, epos = array(spos, epos)[field]
+      else
+        spos, epos, kind, value = inner_bracket(field, spos, epos)
+      end
+      break unless spos
+    end
+    [spos, epos, kind, value]
+  end
+  # rubocop:enable all
+
+  # Low level public APIs
+
+  # Calculate a block start and finish based upon a field
+  # rubocop:disable Metrics/MethodLength  ok
+  # rubocop:disable Metrics/AbcSize       ok
+  def inner_bracket(field, spos, epos)
+    ind = @doc[spos..epos].index { |v| v =~ /\A\s*-*\s*#{field}\:/ }
+    return unless ind
+    ind += spos
+    start_line = @doc[ind]
+    schar, snum = indented(start_line)
+    val = value(start_line)
+    return [ind, ind, :value, val] if val # Value returned if value
+    ind += 1
+    kind = array?(@doc[ind]) ? :array : :hash
+    # Loop until we encounter same indent level or end
+    @doc[ind..epos].each_with_index do |line, eind|
+      nchar, nnum = indented(line)
+      raise(*MIX_ERR) if nchar != schar
+      return [ind, ind + eind - 1, kind] if nnum <= snum
+    end
+    [ind, epos, kind]
+  end
+  # rubocop:enable all
+
+  # Produce a set of bracketed array lines betweem a line range
+  # requires that we start with a known array position containing
+  # the hyphen
+  # rubocop:disable Metrics/AbcSize ok
+  def array(spos, epos)
+    # Get initial indent level
+    ilvl = non_ws_index(@doc[spos])
+    # Produce start and end pairings
+    res = @doc[spos..epos].each_with_index.map do |line, ind|
+      nlvl = non_ws_index(line)
+      nlvl == ilvl ? spos + ind : nil
+    end
+    # Strip non boundaries, append a final marker and collect range groups
+    res.compact.push(epos + 1).each_cons(2).map do |s, f|
+      # Skip empty boundaries
+      s += 1 until hash_key?(@doc[s])
+      s >= f ? nil : [s, f.pred]
+    end
+       .compact
+  end
+  # rubocop:enable all
+
+  # Analyse the line for a value
+  def value(line)
+    res = line.match(/\A(?<tag>.+\:\s)(?<value>.+)\Z/)
+    return unless res
+    tag = res[:tag]
+    val = res[:value]
+    val, rest = value_split(val)
+    return if val.empty?
+    # Return the split line that could be reassembled
+    [tag, val, rest]
+  end
+
+  # RAW access
+  # :nocov:
+  def lines(range)
+    @doc[range]
+  end
+  # :nocov:
+
+  private
+
+  # Split the value half to capture comments etc.
+  def value_split(val)
+    # Comment only ?
+    return ['', val] if val.start_with?(*COMMENTS)
+    # No quotes ?
+    return split_noquote(val) unless val.start_with?(*QUOTES)
+    # Quotes
+    split_quoted(val)
+  end
+
+  # Simple unquoted values
+  def split_noquote(val)
+    pos = val.index(/\s/)
+    pos ? [val[0..pos.pred], val[pos..-1]] : [val, '']
+  end
+
+  # Quoted values
+  def split_quoted(val)
+    prev = quote = val[0]
+    pos = 1
+    until val[pos] == quote && prev != '\\'
+      prev = val[pos]
+      pos += 1
+      raise(*VAL_ERR) if pos > val.length
+    end
+    [val[0..pos], val[pos.succ..-1]]
+  end
+
+  # Type and count of indent char
+  def indented(line)
+    spaces = line.match(/\A\s*-*\s*/).to_s
+    ichars = INDENTS.map { |c| spaces.count(c) }
+    raise(*MIX_ERR) if ichars.count(&:nonzero?) > 1
+    # On zero indents we default to space and zero
+    iichar = ichars.index(&:nonzero?) || 0
+    # Add any hyphens for arrays detected inline
+    [INDENTS[iichar], ichars[iichar] + spaces.count('-')]
+  end
+
+  # Used by set in cases where the field does not exist
+  # rubocop:disable Metrics/AbcSize ok
+  def append(fields, val)
+    parent = fields.dup
+    node = parent.pop
+    spos, epos, = bracket(*parent)
+    # Must inspect inner element for type
+    kind = value(@doc[spos]) ? :hash : :array
+    raise(*SET_ERR) unless kind == :hash
+    ichar, inum = indented(@doc[epos])
+    pad = ichar * inum
+    @doc.insert(epos.succ, "#{pad}#{node}: #{val}")
+  end
+  # rubocop:enable all
+
+  # Are quotes missing but needed?
+  def bad_quoting?(val)
+    val.include?(' ') && !QUOTES.include?(val[0]) || false
+  end
+
+  # Simple position of first non whitespace
+  def non_ws_index(line)
+    line.index(/[^\s]/)
+  end
+
+  # Simple Hash key presence
+  def hash_key?(line)
+    line =~ /\A\s*-*\s*.+:/
+  end
+
+  # Array marker presence
+  def array?(line)
+    line =~ /\A\s*-/
+  end
+end

data/readme.md

@@ -0,0 +1,119 @@
+# YAML Editor class
+
+Do you manually edit YAML in your DevOps repos?
+
+Do you rely on commments being in place and position order for your YAML fragments?
+
+Do you wish you could occasionally update elements within those YAML files without losing comments or existing order?
+
+Is sed just a little crude for the job?
+
+If so then maybe this gem is useful to you.
+
+# About
+
+This gem provides a class that can be utilised to update or add entries into YAML and takes an approach of using ordered fields to access portions of the YAML document and locate sections with an API that will allow arbitrary values to be set on keys.
+
+The initial implementation is more about getting you to the point of being able to enter new values or update existing values and does not attempt to wrap access into a plain Ruby object as a collection.
+
+It's main API is the update API that allows one to update or append values into a YAML document with some limitations. I've taken the approach of being pragmatic and requiring the caller to be sensible about quoting values for multi word strings throwing exceptions if they are needed but not provided and chosen this initial approach to keep consistent with the simple value access APIs.
+
+Functionally this implementation is not exhaustive but meets our use cases.
+# High level API
+
+## #new(yaml)
+
+Pass a YAML document as a string.
+
+## #to_s/#to_yaml
+
+Output the YAML document following an edit session.
+
+## #update(*fields, val:)
+
+Update a field within the YAML document using val indexed by the fields list.
+
+
+# Example use (from examples folder)
+
+## example1.rb
+```
+require_relative '../lib/yaml_editor'
+
+testfile = File.expand_path('../../test/data/testdata.yml', __FILE__)
+ed = YamlEditor.new(File.read(testfile))
+ed.update('keyb', 1, 'KEY_B', val: '"This was changed"')
+ed.update('keyb', 1, 'KEY_E', val: 'appended')
+puts ed
+```
+
+As we can see the position and comment associated with KEY_B have been preserved and the new KEY_E value has been appended to the 2nd array element of the 'keyb' node.
+
+```
+[Running] ruby "/Users/andrew.smith/Ruby/yaml-formatted/examples/example1.rb"
+---
+keya:
+    second:
+      KEY_A: valuea
+      KEY_B: valueb # Comment
+      KEY_C: 'value c'
+      KEY_D: "value d" # Comment
+keyb:
+  -
+    KEY_A: valuea
+    KEY_B: valueb # Comment
+    KEY_C: 'value c'
+    KEY_D: "value d" # Comment
+  -
+    KEY_A: valuee
+    KEY_B: "This was changed" # Comment
+    KEY_C: 'value g'
+    KEY_D: "value h" # Comment
+    KEY_E: appended
+  - # Empty elements should be ignored
+  -
+    KEY_A: valuei
+    KEY_B: valuej # Comment
+    KEY_C: 'value k'
+    KEY_D: "value l" # Comment
+  - SAMELINE: "a value m"
+    ANOTHER: 'extra value'
+  - ONITSOWN: 'standalone value'
+keyc:
+  coll:
+    - name: 'index 0'
+    - name: 'index 1'
+```
+
+# Mid level API
+
+The mid level API may change over time, however it is currently public.
+
+The low level API is used to read portions of the doucment, locate entries and break lines down into component parts.
+
+## #bracket(*fields)
+
+Use fields and index numbers to determine start and end line range for a document section, the kind of element being referenced and where a value to also return an array containing the line split by tag, value and comment if present.
+
+# Low level API (semi private)
+
+As above the low level API may be used to read portions of the document in a custom manner.
+
+## #inner_bracket(field, spos, epos)
+
+Used by the bracket function this allows a single field to be searched within a hash between two line ranges.
+
+## #array(spos, epos)
+
+When used with a line range containing an array it returns an array of tuples containig the start end end position for each child section.
+
+For example use of mid and low level API please see the unit tests.
+
+## #lines(range)
+
+Provide a group of lines as an array from the internal document.
+
+## #value(line)
+
+Split the line into the tagged region (containing the leading spaces) up to the value, the actual value (including quotes as necessary, and any remaining text on the line such as commments.
+

data/test/data/testdata.yml

@@ -0,0 +1,45 @@
+---
+keya:
+    second:
+      KEY_A: valuea
+      KEY_B: valueb # Comment
+      KEY_C: 'value c'
+      KEY_D: "value d" # Comment
+keyb:
+  -
+    KEY_A: valuea
+    KEY_B: valueb # Comment
+    KEY_C: 'value c'
+    KEY_D: "value d" # Comment
+  -
+    KEY_A: valuee
+    KEY_B: valuef # Comment
+    KEY_C: 'value g'
+    KEY_D: "value h" # Comment
+  - # Empty elements should be ignored
+  -
+    KEY_A: valuei
+    KEY_B: valuej # Comment
+    KEY_C: 'value k'
+    KEY_D: "value l" # Comment
+  - SAMELINE: "a value m"
+    ANOTHER: 'extra value'
+  - ONITSOWN: 'standalone value'
+keyc:
+  coll:
+    - name: 'index 0'
+    - name: 'index 1'
+keyd:
+  -
+    nested:
+      -
+        KEY_A: 'foo'
+        KEY_B: 'bar'
+    another:
+      -
+        KEY_A: 'one'
+        KEY_B: 'two'
+  -
+    toignore:
+      -
+        ignorema: 'dummy'

data/test/test_helper.rb

@@ -0,0 +1,7 @@
+require 'simplecov'
+SimpleCov.command_name 'test:unit'
+SimpleCov.start do
+  add_group 'Libs', 'lib/'
+  track_files 'lib/*.rb'
+  add_filter '/test/'
+end

data/test/unit/test_yaml_editor.rb

@@ -0,0 +1,137 @@
+require 'test_helper'
+require 'minitest/autorun'
+require 'yaml_editor'
+require 'pp'
+
+# Unit Test
+# rubocop:disable Metrics/ClassLength
+class TestYamlEditor < Minitest::Test
+  def setup
+    testfile = File.expand_path('../../data/testdata.yml', __FILE__)
+    @ed = YamlEditor.new(File.read(testfile))
+  end
+
+  def test_bracket_value
+    _spos, _epos, kind, v = @ed.bracket('keya', 'second', 'KEY_A')
+    assert_equal(:value, kind)
+    _tag, value, comment = v
+    assert_equal('valuea', value)
+    assert_empty(comment)
+  end
+
+  def test_bracket_value_quote
+    _spos, _epos, kind, v = @ed.bracket('keya', 'second', 'KEY_C')
+    assert_equal(:value, kind)
+    _tag, value, comment = v
+    assert_equal('\'value c\'', value)
+    assert_empty(comment)
+  end
+
+  def test_get_hash
+    spos, epos, kind, = @ed.bracket('keya', 'second')
+    assert_equal(:hash, kind)
+    assert_equal(3, epos - spos) # 4 values but zero based lines
+  end
+
+  def test_get_array
+    spos, epos, kind, = @ed.bracket('keyb')
+    assert_equal(:array, kind)
+    assert_equal(18, epos - spos)
+  end
+
+  def test_bracket_value_comment
+    _spos, _epos, kind, v = @ed.bracket('keya', 'second', 'KEY_D')
+    assert_equal(:value, kind)
+    tag, value, comment = v
+    assert_includes(tag, 'KEY_D:')
+    assert_equal('"value d"', value)
+    assert_equal(' # Comment', comment)
+  end
+
+  def test_array_index
+    spos, epos, kind, = @ed.bracket('keyb')
+    assert_equal(:array, kind)
+    arr = @ed.array(spos, epos)
+    assert_kind_of(Array, arr)
+    assert(3, arr.first.last - arr.first.first)
+    # Move out to another test after embedding array indexing in bracketing.
+    assert_includes(@ed.lines(arr.last.first), 'standalone value')
+  end
+
+  def test_array_bracket
+    _spos, _epos, kind, v = @ed.bracket('keyb', 1, 'KEY_B')
+    assert_equal(:value, kind)
+    tag, value, comment = v
+    assert_includes(tag, 'KEY_B:')
+    assert_equal('valuef', value)
+    assert_equal(' # Comment', comment)
+  end
+
+  def test_collection_hashes_0
+    _spos, _epos, _kind, v = @ed.bracket('keyc', 'coll', 0, 'name')
+    _tag, value, = v
+    assert_equal('\'index 0\'', value)
+  end
+
+  def test_collection_hashes_1
+    _spos, _epos, _kind, v = @ed.bracket('keyc', 'coll', 1, 'name')
+    _tag, value, = v
+    assert_equal('\'index 1\'', value)
+  end
+
+  def test_update
+    @ed.update('keyb', 1, 'KEY_D', val: 'updated')
+    _spos, _epos, kind, v = @ed.bracket('keyb', 1, 'KEY_D')
+    assert_equal(:value, kind)
+    tag, value, comment = v
+    assert_includes(tag, 'KEY_D:')
+    assert_equal('updated', value)
+    assert_equal(' # Comment', comment)
+  end
+
+  def test_spaced_update
+    @ed.update('keyb', 1, 'KEY_D', val: '"updated with spaces"')
+    _spos, _epos, kind, v = @ed.bracket('keyb', 1, 'KEY_D')
+    assert_equal(:value, kind)
+    tag, value, comment = v
+    assert_includes(tag, 'KEY_D:')
+    assert_equal('"updated with spaces"', value)
+    assert_equal(' # Comment', comment)
+  end
+
+  def test_bad_quotes
+    assert_raises(YamlEditorError) do
+      @ed.update('keyb', 1, 'KEY_D', val: 'should not work')
+    end
+  end
+
+  def test_update_append
+    @ed.update('keyb', 1, 'KEY_E', val: 'appended')
+    spos, epos, = @ed.bracket('keyb', 1)
+    assert_equal(4, epos - spos)
+    _spos, _epos, kind, v = @ed.inner_bracket('KEY_E', spos, epos)
+    assert_equal(:value, kind)
+    _tag, value, = v
+    assert_equal('appended', value)
+  end
+
+  def test_to_yaml
+    assert_equal(45, @ed.to_yaml.lines.count)
+  end
+
+  def test_hashes_in_collections_a
+    @ed.update('keyd', 0, 'nested', 0, 'KEY_A', val: 'changed')
+    _spos, _epos, _kind, v = @ed.bracket('keyd', 0, 'nested', 0, 'KEY_A')
+    tag, value, = v
+    assert_includes(tag, 'KEY_A:')
+    assert_equal('changed', value)
+  end
+
+  def test_hashes_in_collections_b
+    @ed.update('keyd', 0, 'nested', 0, 'KEY_C', val: 'appended')
+    _spos, _epos, _kind, v = @ed.bracket('keyd', 0, 'nested', 0, 'KEY_C')
+    tag, value, = v
+    assert_includes(tag, 'KEY_C:')
+    assert_equal('appended', value)
+  end
+end

data/yaml_editor.gemspec

@@ -0,0 +1,23 @@
+class << $LOAD_PATH
+  def merge!(other)
+    replace(self | other)
+  end
+end
+
+$LOAD_PATH.merge! [File.expand_path('../lib', __FILE__)]
+
+Gem::Specification.new do |spec|
+  raise 'RubyGems 2.0 or newer is required.' unless spec.respond_to?(:metadata)
+  spec.name = 'yaml_editor'
+  spec.version = '0.0.2'
+  spec.authors = ['Andrew Smith']
+  spec.email = ['andrew.smith at moneysupermarket.com']
+
+  spec.summary = 'Update YAML documents preserving layout and comments'
+  spec.description = 'Allows update of YAML directly indexing fields within'\
+                     ' the document without deserialisation to objects so '\
+                     ' that order and comments may be preserved'
+  spec.homepage = 'https://github.com/MSMFG/rubygem_yaml_editor'
+  spec.license = 'Apache-2.0'
+  spec.files = `git ls-files -z`.split("\x0")
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: yaml_editor
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Andrew Smith
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-04-19 00:00:00.000000000 Z
+dependencies: []
+description: Allows update of YAML directly indexing fields within the document without
+  deserialisation to objects so  that order and comments may be preserved
+email:
+- andrew.smith at moneysupermarket.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- LICENSE
+- Rakefile
+- examples/example1.rb
+- lib/yaml_editor.rb
+- readme.md
+- test/data/testdata.yml
+- test/test_helper.rb
+- test/unit/test_yaml_editor.rb
+- yaml_editor.gemspec
+homepage: https://github.com/MSMFG/rubygem_yaml_editor
+licenses:
+- Apache-2.0
+metadata: {}
+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.2.5
+signing_key: 
+specification_version: 4
+summary: Update YAML documents preserving layout and comments
+test_files: []