cfa 0.6.4 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b16f5b90e04efbadc819f5a47ef4855118d4ea2b286cfa790edd64ee333ce129
-  data.tar.gz: 8ec15e83b710cbc323077b16309d4f2b58584890dd40e8d7bf21ee4019bcc82d
+  metadata.gz: 0256a5d406e5ed0a4bbedd2c59fe6ed3947b35286697301543285c8e588e1753
+  data.tar.gz: 0361b40d6ee2a3fc94a0f2218a2cec6c4c6c2c833942d62fe67513b65d776450
 SHA512:
-  metadata.gz: f2ef2156c4810935459f0dbed8c15e365b61ec82b80652efb65d056df6262d4151f824ea5887972abe3dd9650b92f96977ca0e9df7437ee783d04c7e8ed81e2d
-  data.tar.gz: 375e2b81646579375e7824b2852960223414c146cdf342129d95b3cbec66e5fa6951e3db4726e79fa650b41e9f0800d257b5fe3e5c176e85259a4697d56aa26b
+  metadata.gz: d0b02d8195de9b6f72e347924253ad534b76de671f44f8c598f324ab1059473aa7f5039c0f1b16e5a2eb85651ed0fc51d162dd5c49cd4b0ff0efc3be6c5b66d3
+  data.tar.gz: d576b43dab99a7711f6012a4c270d53a409e5b7f2b9c7868dd9e31a87de6d616a0c4565e22970a1e481801b0572c8bbe1229b5f56d6f677d66419fa651da91df

data/lib/cfa/augeas_parser.rb

@@ -35,6 +35,66 @@ module CFA
   class AugeasElement < Hash
   end
 
+  # Error that is raised when augeas fail for some reason.
+  # Base class for more specialized exceptions.
+  class AugeasError < RuntimeError
+  end
+
+  # Error in augeas itself like broken lens
+  class AugeasInternalError < AugeasError
+    attr_reader :details
+    attr_reader :aug_message
+
+    def initialize(message, details)
+      @aug_message = message
+      @details = details
+
+      super("Augeas error: #{message}. Details: #{details}.")
+    end
+  end
+
+  # Parsing error
+  class AugeasParsingError < AugeasError
+    attr_reader :aug_message
+    attr_reader :file
+    attr_reader :line
+    attr_reader :character
+    attr_reader :lens
+    attr_reader :file_content
+
+    def initialize(params)
+      @aug_message = params[:message]
+      @file = params[:file]
+      @line = params[:line]
+      @char = params[:char]
+      @lens = params[:lens]
+      @file_content = params[:file_content]
+
+      super("Augeas parsing error: #{@aug_message}" \
+        " at #{@file}:#{@line}:#{@char}, lens #{@lens}"
+      )
+    end
+  end
+
+  # Serializing error
+  class AugeasSerializingError < AugeasError
+    attr_reader :aug_message
+    attr_reader :file
+    attr_reader :lens
+    attr_reader :aug_tree
+
+    def initialize(params)
+      @aug_message = params[:message]
+      @file = params[:file]
+      @lens = params[:lens]
+      @aug_tree = params[:aug_tree]
+
+      super("Augeas serializing error: #{@aug_message}" \
+        " for #{@file} with lens #{@lens}"
+      )
+    end
+  end
+
   # Represents list of same config options in augeas.
   # For example comments are often stored in collections.
   class AugeasCollection
@@ -168,6 +228,7 @@ module CFA
       id = 1
       loop do
         return id.to_s unless ids.include?(id.to_s)
+
         id += 1
       end
     end
@@ -180,6 +241,7 @@ module CFA
     # @param [String, Matcher] matcher
     def delete(matcher)
       return if matcher.nil?
+
       unless matcher.is_a?(CFA::Matcher)
         matcher = CFA::Matcher.new(key: matcher)
       end
@@ -236,6 +298,7 @@ module CFA
 
     def ==(other)
       return false if self.class != other.class
+
       other_data = other.data # do not compute again
       data.each_with_index do |entry, index|
         other_entry = other_data[index]
@@ -329,7 +392,7 @@ 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, "parsing", file_name) \
+        report_error(aug, :parsing, file_name, raw_string) \
           unless aug.text_store(@lens, "/input", "/store")
 
         return AugeasReader.read(aug, "/store")
@@ -349,7 +412,7 @@ module CFA
         AugeasWriter.new(aug).write("/store", data)
 
         res = aug.text_retrieve(@lens, "/input", "/store", "/output")
-        report_error(aug, "serializing", file_name) unless res
+        report_error(aug, :serializing, file_name, data) unless res
 
         return aug.get("/output")
       end
@@ -364,19 +427,38 @@ module CFA
   private
 
     # @param aug [::Augeas]
-    # @param activity ["parsing", "serializing"] for better error messages
+    # @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 error[:code].nonzero?
-        raise "Augeas error: #{error[:message]}. Details: #{error[:details]}."
-      end
+    # @param data [AugeasTree, String] used data so augeas tree for
+    #   serializing or file content for parsing
+    def report_error(aug, activity, file_name, data = nil)
+      report_internal_error!(aug)
 
       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))
+      args = aug_get_error(aug)
+      args[:file] = file_name
+      report_activity_error!(args, activity, data)
+    end
+
+    def report_internal_error!(aug)
+      error = aug.error
+      # zero is no error, so there's a problem in the lens
+      return if error[:code].zero?
+
+      raise AugeasInternalError.new(error[:message], error[:details])
+    end
+
+    def report_activity_error!(args, activity, data)
+      case activity
+      when :parsing
+        args[:file_content] = data
+        raise AugeasParsingError, args
+      when :serializing
+        args[:aug_tree] = data
+        raise AugeasSerializingError, args
+      else
+        raise ArgumentError, "invalid activity #{activity.inspect}"
+      end
     end
 
     def aug_get_error(aug)

data/lib/cfa/augeas_parser/keys_cache.rb

@@ -22,6 +22,7 @@ module CFA
       loop do
         matches = aug.match(search_path)
         break if matches.empty?
+
         assign_matches(matches, @cache)
 
         search_path += "/*"

data/lib/cfa/augeas_parser/writer.rb

@@ -139,6 +139,7 @@ module CFA
       # the entries preceding this entry
       def preceding_entries
         return [] if index.zero? # first entry
+
         tree.all_data[0..(index - 1)]
       end
 

data/lib/cfa/matcher.rb

@@ -43,6 +43,7 @@ module CFA
         return false unless collection_match?(element, collection)
         return false unless value_match?(element, value_matcher)
         return false unless !block || yield(element[:key], element[:value])
+
         return true
       end
     end
@@ -71,6 +72,7 @@ module CFA
       when nil then true
       when Regexp
         return false unless element[:value].is_a?(String)
+
         matcher =~ element[:value]
       else
         matcher == element[:value]

metadata

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