cfa 0.7.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0256a5d406e5ed0a4bbedd2c59fe6ed3947b35286697301543285c8e588e1753
-  data.tar.gz: 0361b40d6ee2a3fc94a0f2218a2cec6c4c6c2c833942d62fe67513b65d776450
+  metadata.gz: 4a1b7d04b80d8f3847c52a299c581eb93ce99504aa21df9ff777766fbdd9a693
+  data.tar.gz: eb11d86a2949be4b60227c4e6a2d834ad8c8fa9f142db99bbd4b011827cc27aa
 SHA512:
-  metadata.gz: d0b02d8195de9b6f72e347924253ad534b76de671f44f8c598f324ab1059473aa7f5039c0f1b16e5a2eb85651ed0fc51d162dd5c49cd4b0ff0efc3be6c5b66d3
-  data.tar.gz: d576b43dab99a7711f6012a4c270d53a409e5b7f2b9c7868dd9e31a87de6d616a0c4565e22970a1e481801b0572c8bbe1229b5f56d6f677d66419fa651da91df
+  metadata.gz: 0f6e65715be7e500b23ab82c025082c97c035af9ca878f76543fa571b3a22ea3feda7dc535fd974704d5e6b2a13465723068fa066dcd7eef75a1e28b9023d4bf
+  data.tar.gz: c4e7641eb00264924223db6491e09a80f4acb1c987074c579e63e78b22eae6caa94fe57319ba28d9fe4b4fea5a703f097579ce9a413641fc29c52decc364f09e

data/lib/cfa/augeas_parser.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "set"
 require "augeas"
 require "forwardable"
@@ -323,6 +325,7 @@ module CFA
       @data.insert(index, new_entry)
       # the entry is not yet in the tree
       if old_entry[:operation] == :add
+        key = old_entry[:key]
         @data.delete_if { |d| d[:key] == key }
       else
         old_entry[:operation] = :remove

data/lib/cfa/augeas_parser/keys_cache.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module CFA
   # A cache that holds all avaiable keys in an Augeas tree. It is used to
   # prevent too many `aug.match` calls which are expensive.

data/lib/cfa/augeas_parser/reader.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "cfa/augeas_parser/keys_cache"
 require "cfa/augeas_parser"
 

data/lib/cfa/augeas_parser/writer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module CFA
   # The goal of this class is to write the data stored in {AugeasTree}
   # back to Augeas.

data/lib/cfa/base_model.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "cfa/matcher"
 require "cfa/placer"
 # FIXME: tree should be generic and not augeas specific,
@@ -37,8 +39,7 @@ module CFA
     #   then *parser* may raise an error.
     #   A properly written BaseModel subclass should prevent that by preventing
     #   insertion of such values in the first place.
-    def save(changes_only: false)
-      merge_changes if changes_only
+    def save
       @parser.file_name = @file_path if @parser.respond_to?(:file_name=)
       @file_handler.write(@file_path, @parser.serialize(data))
     end
@@ -131,13 +132,6 @@ module CFA
 
     attr_accessor :data
 
-    def merge_changes
-      new_data = data.dup
-      read
-      # TODO: recursive merge
-      data.merge(new_data)
-    end
-
     # Modify an **existing** entry and return `true`,
     # or do nothing and return `false`.
     # @return [Boolean]
@@ -172,10 +166,16 @@ module CFA
     end
   end
 
-  # Representing boolean value switcher in default grub configuration file.
+  # Represents a boolean value switcher in default grub configuration file.
   # Allows easy switching and questioning for boolean value, even if
-  # represented by text in config file
+  # represented by text in config file.
+  # It's tristate: if unset, {#enabled?} and {#disabled?} return `nil`
+  # (but once set, we cannot return to an unset state).
   class BooleanValue
+    # @param name [String]
+    # @param model [BaseModel]
+    # @param true_value [String]
+    # @param false_value [String]
     def initialize(name, model, true_value: "true", false_value: "false")
       @name = name
       @model = model
@@ -183,32 +183,42 @@ module CFA
       @false_value = false_value
     end
 
+    # Set to *true*
     def enable
       @model.generic_set(@name, @true_value)
     end
 
+    # Set to *false*
     def disable
       @model.generic_set(@name, @false_value)
     end
 
+    # @return [Boolean,nil] true, false, (nil if undefined)
     def enabled?
-      return nil unless data
+      d = data
+      return nil unless d
 
-      data == @true_value
+      d == @true_value
     end
 
+    # @return [Boolean,nil] true, false, (nil if undefined)
     def disabled?
-      return nil unless data
+      d = data
+      return nil unless d
 
-      data != @true_value
+      d != @true_value
     end
 
+    # @return [Boolean]
+    #   true if the key has a value;
+    #   false if {#enabled?} and {#disabled?} return `nil`.
     def defined?
       !data.nil?
     end
 
     # sets boolean value, recommend to use for generic boolean setter.
     # for constants prefer to use enable/disable
+    # @param value [Boolean]
     def value=(value)
       @model.generic_set(@name, value ? @true_value : @false_value)
     end

data/lib/cfa/matcher.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module CFA
   # The Matcher is used as a predicate on {AugeasElement}.
   #

data/lib/cfa/memory_file.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module CFA
   # memory file is used when string is stored only in memory.
   # Useful for testing. For remote read or socket read, own File class

data/lib/cfa/placer.rb

@@ -1,15 +1,18 @@
+# frozen_string_literal: true
+
 module CFA
   # Places a new {AugeasElement} into an {AugeasTree}.
   # @abstract Subclasses implement different ways **where**
   #   to place the entry by overriding {#new_element}.
   class Placer
-    # @param  [AugeasTree] tree
-    # @return [AugeasElement,Hash] the new element; it is empty!
-    #   Note that the return value is actually a Hash; {AugeasElement}
-    #   documents its structure.
+    # @overload new_element(tree)
+    #   @param  [AugeasTree] tree
+    #   @return [AugeasElement,Hash] the new element; it is empty!
+    #     Note that the return value is actually a Hash; {AugeasElement}
+    #     documents its structure.
     def new_element(_tree)
       raise NotImplementedError,
-        "Subclasses of #{Module.nesting.first} must override #{__method__}"
+            "Subclasses of #{Module.nesting.first} must override #{__method__}"
     end
 
   protected

metadata

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