palletjack 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aa38de4b29c6cceadd2fecc3e88e74f041eccfef
-  data.tar.gz: 1532f5e70753e10d7cd08497426ca23d5384de21
+  metadata.gz: f14f5c45a068c34bf0fc6444ec9b05ce81f26397
+  data.tar.gz: 3eadcf8f4243fca26d2f7bac66eb0822c8b7543f
 SHA512:
-  metadata.gz: c3b79c7b5762b97e7ab13c1149f087e7e0267fa5af90fcd19a6511948cafa2651f237989da3c9f1a16c50a32d78c5b91c564239bb94e7c26f5981ad66fd1ddc5
-  data.tar.gz: 0d74674d2e2394365658cb8ac8a005ab52e877c651cf6ed5f34b38d8f5db5c989ce1c3f6a73088a1e397177131a5f146ac76f1d027bb95c432509179d4b68562
+  metadata.gz: a9c5a9585753b2bc53a007063ac4e9562419fb44d060220ba5a7e3e557391ad99600e4d0738402c8f3fa32311e6ea60402e29cb7636185ce40ea8bfca7af6940
+  data.tar.gz: 3b7044a659bd1cd171095d9a2faf5041c56c70f0026ec219b7b374bb18dd66c9c42180aacab3c4cd4c69d8065de5837d000c0647bbfc7ee3680d35ee128894f5

data/lib/palletjack/keytransformer.rb

@@ -1,3 +1,5 @@
+require 'traceable'
+
 class PalletJack
   class KeyTransformer
     class Reader < KeyTransformer
@@ -251,6 +253,11 @@ class PalletJack
             if self.respond_to?(transform.to_sym) then
               if new_value = self.send(transform.to_sym, param, context)
               then
+                new_value = TraceableString.new(new_value)
+                new_value.file = transform.file
+                new_value.line = transform.line
+                new_value.column = transform.column
+                new_value.byte = transform.byte
                 pallet[key] = new_value
                 break
               end

data/lib/palletjack/pallet.rb

@@ -1,4 +1,5 @@
 require 'palletjack/pallet/identity'
+require 'traceable'
 
 class PalletJack < KVDAG
   # PalletJack managed pallet of key boxes inside a warehouse.
@@ -38,7 +39,8 @@ class PalletJack < KVDAG
         filestat = File.lstat(filepath)
         case
         when (filestat.file? and file =~ /\.yaml$/)
-          merge!(YAML::load_file(filepath))
+          merge!(TraceableYAML::load_file(filepath,
+                   filepath.sub(@identity.warehouse, '')[1..-1]))
           boxes << file
         when filestat.symlink?
           link = File.readlink(filepath)

data/lib/palletjack/version.rb

@@ -1,5 +1,5 @@
 require 'kvdag'
 
 class PalletJack < KVDAG
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/lib/palletjack.rb

@@ -4,6 +4,7 @@ require 'kvdag'
 require 'palletjack/version'
 require 'palletjack/keytransformer'
 require 'palletjack/pallet'
+require 'traceable'
 
 class PalletJack < KVDAG
   attr_reader :warehouse
@@ -23,7 +24,7 @@ class PalletJack < KVDAG
 
   def load(warehouse)
     @warehouse = File.expand_path(warehouse)
-    key_transforms = YAML::load_file(File.join(@warehouse, "transforms.yaml"))
+    key_transforms = TraceableYAML::load_file(File.join(@warehouse, 'transforms.yaml'), 'transforms.yaml')
     @keytrans_reader = KeyTransformer::Reader.new(key_transforms)
     @keytrans_writer = KeyTransformer::Writer.new(key_transforms)
 

data/lib/traceable.rb

@@ -0,0 +1,217 @@
+require 'psych'
+
+# Read YAML files and remember where each value came from.
+#
+# Objects behave like normal in most respects. Objects that implement
+# Traceable can be asked for their position by calling file(), line(),
+# column() and byte().
+#
+# If the class attribute TraceableString.debug is set, +inspect+ and
+# +to_yaml+ output position information for each atom, in the case of
+# +to_yaml+ separated from its value by the string " =^.^= ".
+#
+# Example:
+#
+#   yaml = "---
+#   foo:
+#     bar: 1
+#     baz:
+#       - gazonk
+#       - foobar"
+#   handler = PositionHandler.new("<STDIN>")
+#   parser = Psych::Parser.new(handler)
+#   handler.parser = parser
+#   parser.parse(yaml)
+#   visitor = PositionVisitor.new
+#   tree = visitor.accept(handler.root)
+#
+#   tree[0]['foo']['bar']
+#   => "1"
+#   tree[0]['foo']['bar'].file
+#   => "<STDIN>"
+#   tree[0]['foo']['bar'].line
+#   => 3
+#   tree[0]['foo']['bar'].column
+#   => 2
+#
+#   puts tree[0].to_yaml
+#   ---
+#   foo:
+#     bar: 1
+#     baz:
+#     - gazonk
+#     - foobar
+#
+#   TraceableString.debug = true
+#   puts tree[0].to_yaml.gsub(' =^.^= ', '  # ')
+#   ---
+#   foo  # <STDIN> (line 1, column 4):
+#     bar  # <STDIN> (line 2, column 6): 1  # <STDIN> (line 3, column 2)
+#     baz  # <STDIN> (line 3, column 6):
+#     - gazonk  # <STDIN> (line 5, column 4)
+#     - foobar  # <STDIN> (line 6, column 0)
+
+# Attributes required to trace the origin of a value.
+module Traceable
+  attr_accessor :file
+  attr_accessor :byte
+  attr_accessor :line
+  attr_accessor :column
+end
+
+# A string that remembers the source of its value, and can output it
+# again when serialised to YAML.
+class TraceableString < String
+  include Traceable
+
+  def encode_with(coder)
+    coder.tag = nil
+    coder.scalar = self.to_str
+    if debug?
+      # LibYAML, the C YAML library which underlies Ruby's Psych
+      # library, does not handle comments at all. The parser ignores
+      # them and the emitter cannot write them. Thus, to output the
+      # sourcing information in a manner that is at least semi-sane,
+      # we need to put it in the actual value, behind some sort of
+      # separator.
+      #
+      # The separator needs to be representable in Latin-1, otherwise
+      # LibYAML quotes it. It needs to be non-breaking, otherwise
+      # LibYAML will break here to wrap at 80 characters. It cannot
+      # have any special meaning in YAML (including the quote
+      # character), otherwise LibYAML quotes it. It shouldn't appear
+      # in real data, sine we'll need to substitute all instances of
+      # it.
+      #
+      # Also, I like cats, even ASCII ones.
+      coder.scalar += " =^.^= #{@file} (line #{@line}, column #{@column})"
+    end
+  end
+
+  def inspect
+    if debug?
+      "\"%s\" (%s, line: %i, col: %i, byte: %i)" %
+        [self.to_str, @file, @line, @column, @byte]
+    else
+      super
+    end
+  end
+
+  def self.debug=(maybe)
+    @@debug = maybe
+  end
+
+  def self.debug
+    @@debug ||= false
+  end
+
+  private
+
+  def debug?
+    self.class.debug
+  end
+end
+
+# Make the nodes in Psych's YAML parse tree track their positions.
+class Psych::Nodes::Node
+  include Traceable
+end
+
+# Extend the parser to remember the position of each object.
+class PositionHandler < Psych::TreeBuilder
+
+  # The handler needs access to the parser in order to call mark
+  attr_accessor :parser
+
+  # +filename+ is the name of the source file the YAML structure will
+  # be parsed from. It is only copied into parsed objects, not
+  # interpreted.
+  def initialize(filename)
+    super()
+    @file = filename
+  end
+
+  # Copy a parser position from a +Psych::Parser::Mark+ to a parse
+  # tree node.
+  def record_position(node, mark)
+    node.extend Traceable
+    node.file = @file
+    node.byte = mark.index
+    node.line = mark.line
+    node.column = mark.column
+    node
+  end
+
+  def start_mapping(anchor, tag, implicit, style)
+    record_position(super, parser.mark)
+  end
+
+  def start_sequence(anchor, tag, implicit, style)
+    record_position(super, parser.mark)
+  end
+
+  def scalar(value, anchor, tag, plain, quoted, style)
+    record_position(super, parser.mark)
+  end
+end
+
+# Extend the Ruby structure builder to remeber each object's position.
+class PositionVisitor < Psych::Visitors::ToRuby
+
+  # Copy a parser position from a parse tree node to a primitive
+  # object.
+  def record_position(s, o)
+    s.extend Traceable
+    s.file = o.file
+    s.byte = o.byte
+    s.line = o.line
+    s.column = o.column
+    s
+  end
+
+  def visit_Psych_Nodes_Scalar o
+    # Primitive YAML values can be either strings or integers. Ruby
+    # integers cannot be extended, so convert everything to strings
+    # before inserting position information.
+    record_position(TraceableString.new(String(super)), o)
+  end
+
+  def visit_Psych_Nodes_Sequence o
+    record_position(super, o)
+  end
+
+  def visit_Psych_Nodes_Mapping o
+    record_position(super, o)
+  end
+end
+
+module TraceableYAML
+
+  # Parse a YAML document from the string +doc+, tagging each value
+  # with the source +tag+, and return a Ruby object tree representing
+  # the result.
+  def self.parse(doc, tag)
+    handler = PositionHandler.new(tag)
+    parser = Psych::Parser.new(handler)
+    handler.parser = parser
+    parser.parse doc
+    if PositionVisitor.respond_to?(:create)
+      # Ruby 2.1 and above
+      visitor = PositionVisitor.create
+    else
+      # Ruby 2.0
+      visitor = PositionVisitor.new
+    end
+    tree = visitor.accept(handler.root)
+    tree[0]
+  end
+
+  # Load a YAML document from the file +path+, tagging each value with
+  # the source +tag+, and return a Ruby object tree representing the
+  # result.
+  def self.load_file(path, tag)
+    File.open(path) do |f|
+      parse(f.read, tag)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: palletjack
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Calle Englund
@@ -31,7 +31,7 @@ cert_chain:
   f8wtQllq82VF0AXUYeLtTh1f+DW3WW5BO1e2OCu5eOV7dbyaVPaNK/+rHjCN8kM/
   DGZSwUoNADmVkQ==
   -----END CERTIFICATE-----
-date: 2016-11-18 00:00:00.000000000 Z
+date: 2016-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -165,6 +165,7 @@ files:
 - lib/palletjack/pallet/identity.rb
 - lib/palletjack/tool.rb
 - lib/palletjack/version.rb
+- lib/traceable.rb
 - palletjack.gemspec
 homepage: https://github.com/saab-simc-admin/palletjack
 licenses: