cfa 0.6.3 → 0.6.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b935ded0de71ea141ce56290ee7e46c62d3b5c4f3719d392a2f3d2607fb6e50
-  data.tar.gz: 6d8ec5f5cc7fd9490a1bad3a2f19466873f5a906c15a3351fe6de507fbdfcefe
+  metadata.gz: b16f5b90e04efbadc819f5a47ef4855118d4ea2b286cfa790edd64ee333ce129
+  data.tar.gz: 8ec15e83b710cbc323077b16309d4f2b58584890dd40e8d7bf21ee4019bcc82d
 SHA512:
-  metadata.gz: 04f2051c36312ebbc098eb1e4c26f5f6ad0339d89e34c57a4395286862ef302858306242ef951810c69452298cf0ad1f043e1f8e355518ffb4c29d678bf4e234
-  data.tar.gz: 1935ed5dff889f4a223363aa4b50892f88abf525a29a93c750a4add401d802aab8cc14fe1d461adab44d0cbc1fe16f1ce5217f2d1fb8df7825713730e464501f
+  metadata.gz: f2ef2156c4810935459f0dbed8c15e365b61ec82b80652efb65d056df6262d4151f824ea5887972abe3dd9650b92f96977ca0e9df7437ee783d04c7e8ed81e2d
+  data.tar.gz: 375e2b81646579375e7824b2852960223414c146cdf342129d95b3cbec66e5fa6951e3db4726e79fa650b41e9f0800d257b5fe3e5c176e85259a4697d56aa26b

data/lib/cfa/augeas_parser.rb

@@ -298,15 +298,20 @@ module CFA
   #    require "cfa/augeas_parser"
   #
   #    parser = CFA::AugeasParser.new("Sysconfig.lns")
+  #    parser.file_name = "/etc/default/grub" # for error reporting
   #    data = parser.parse(File.read("/etc/default/grub"))
   #
   #    puts data["GRUB_DISABLE_OS_PROBER"]
   #    data["GRUB_DISABLE_OS_PROBER"] = "true"
   #    puts parser.serialize(data)
   class AugeasParser
+    # @return [String] optional, used for error reporting
+    attr_accessor :file_name
+
     # @param lens [String] a lens name, like "Sysconfig.lns"
     def initialize(lens)
       @lens = lens
+      @file_name = nil
     end
 
     # @param raw_string [String] a string to be parsed
@@ -324,7 +329,8 @@ module CFA
       root = load_path = nil
       Augeas.open(root, load_path, Augeas::NO_MODL_AUTOLOAD) do |aug|
         aug.set("/input", raw_string)
-        report_error(aug) unless aug.text_store(@lens, "/input", "/store")
+        report_error(aug, "parsing", file_name) \
+          unless aug.text_store(@lens, "/input", "/store")
 
         return AugeasReader.read(aug, "/store")
       end
@@ -343,7 +349,7 @@ module CFA
         AugeasWriter.new(aug).write("/store", data)
 
         res = aug.text_retrieve(@lens, "/input", "/store", "/output")
-        report_error(aug) unless res
+        report_error(aug, "serializing", file_name) unless res
 
         return aug.get("/output")
       end
@@ -358,16 +364,30 @@ module CFA
   private
 
     # @param aug [::Augeas]
-    def report_error(aug)
+    # @param activity ["parsing", "serializing"] for better error messages
+    # @param file_name [String,nil] a file name
+    def report_error(aug, activity, file_name)
       error = aug.error
       # zero is no error, so problem in lense
-      if aug.error[:code].nonzero?
-        raise "Augeas error #{error[:message]}. Details: #{error[:details]}."
+      if error[:code].nonzero?
+        raise "Augeas error: #{error[:message]}. Details: #{error[:details]}."
       end
 
-      msg = aug.get("/augeas/text/store/error/message")
-      location = aug.get("/augeas/text/store/error/lens")
-      raise "Augeas parsing/serializing error: #{msg} at #{location}"
+      file_name ||= "(unknown file)"
+      raise format("Augeas #{activity} error: %<message>s" \
+                   " at #{file_name}:%<line>s:%<char>s, lens %<lens>s",
+        aug_get_error(aug))
+    end
+
+    def aug_get_error(aug)
+      {
+        message: aug.get("/augeas/text/store/error/message"),
+        line:    aug.get("/augeas/text/store/error/line"),
+        char:    aug.get("/augeas/text/store/error/char"), # column
+        # file, line+column range, like
+        # "/usr/share/augeas/lenses/dist/hosts.aug:23.12-.42:"
+        lens:    aug.get("/augeas/text/store/error/lens")
+      }
     end
   end
 end

data/lib/cfa/base_model.rb

@@ -39,6 +39,7 @@ module CFA
     #   insertion of such values in the first place.
     def save(changes_only: false)
       merge_changes if changes_only
+      @parser.file_name = @file_path if @parser.respond_to?(:file_name=)
       @file_handler.write(@file_path, @parser.serialize(data))
     end
 
@@ -51,6 +52,7 @@ module CFA
     # @raise a *parser* specific error. If the parsed String is malformed, then
     #   depending on the used parser it may raise an error.
     def load
+      @parser.file_name = @file_path if @parser.respond_to?(:file_name=)
       self.data = @parser.parse(@file_handler.read(@file_path))
       @loaded = true
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cfa
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.6.4
 platform: ruby
 authors:
 - Josef Reidinger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-09 00:00:00.000000000 Z
+date: 2018-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-augeas