state_mate 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6405979811d0c551cc74702afc8e4b32b17a7947
-  data.tar.gz: d5832875e024eb641f188c9d1cfc5ceb574b0261
+  metadata.gz: 5f01f81ae28c991389d0bb58e43f41fb551a690b
+  data.tar.gz: 0e888f119ce00d45046ec008aa63d43784b0ff52
 SHA512:
-  metadata.gz: f6d84cdcff0f671d9db98c1a2e27faf6bda37c181ca7ba3039c87196c0b38cf53daa59d9ad7b551a03d12b46f60d687614ca6b2b48036ac2776c8f76077fb6a8
-  data.tar.gz: e76937841bc8713c17c8390b06b35f6f2af1f62b9686499199fbb93366302530bbec05e9e73e4437404fea750c99746c35aaf3041847259d361e94736943dedf
+  metadata.gz: 3a3d7f7027493edc8aace942eb0cb15888a0145d500252f36e0d05edee3d953f4312fa009fdbb87cf9c6b86c45bee5ba177bdbb4540a3492e0284711b9979e1c
+  data.tar.gz: 1d4fbf23716276cb3688e7d73165802c20a4f4445cf688bd2ced4a3b64d2a52ec8e0ffacabcb82b9768de76846b3b7978f8b36a3dc0ebaeef59bf20e6e3481e6

data/lib/state_mate.rb

@@ -13,10 +13,48 @@ module StateMate
   @debug_mode = 'a'
 
   DIRECTIVES = Set.new [
+    # ensures that the key is set to the provided value
     :set,
+    
+    # ensures that the key is absent
     :unset,
+    
+    # ensures that the key is an array containing the provided items.
+    # 
+    # if the key is missing and `create` or `clobber` options evaluate true, it
+    # will be created to have exactly the provided items. otherwise it will
+    # fail.
+    # 
+    # if the value is not an array and `clobber` option evaluates true it will
+    # be replaced with an array of exactly the provided items. otherwise it
+    # will fail.
+    # 
     :array_contains,
+    
+    # ensures that the value is an array that is missing the provided items.
+    # 
+    # if the current value is:
+    # 
+    # -   missing/nil/null:
+    #     -   if the `unset_ok` option evaluates **true**:
+    #         -   it will validate as a correct state and no action will be 
+    #             taken.
+    #         -   **NOTE: this is the ONLY case where the action succeeds
+    #             and the value IS NOT an array afterwards**.
+    #     -   if the `unset_ok` option evaluates **false** (default):
+    #         -   if the `create` or `clobber` options evaluate **true**:
+    #             -   the value will be set to an empty array.
+    #         -   otherwise:
+    #             -   fails.
+    # -   something else that's not an array:
+    #     -   if the `clobber` option evaluates **true**:
+    #         -   value will be set to an empty array.
+    #     -   if the `clobber` option evaluates **false** (default):
+    #         -   fails.
     :array_missing,
+    
+    # initializes a value - setting it only if it is missing/nil
+    :init,
   ]
 
   class StateSet
@@ -112,7 +150,7 @@ module StateMate
               unset_when = StateMate.cast 'bool', v
             else
               # any other keys are set as options
-              # this is a little convience feature that avoids having to
+              # this is a little convenience feature that avoids having to
               # nest inside an `options` key unless your option conflicts
               # with 'key' or a directive.
               #
@@ -143,7 +181,7 @@ module StateMate
           end
           
           # handle :unset_when_false option, which changes the operation to
-          # an unset when the *directive value* is explicity false
+          # an unset when the *directive value* is explicitly false
           if  unset_when_false && 
               (value === false || ['False', 'false'].include?(value))
             directive = :unset
@@ -485,7 +523,7 @@ module StateMate
   
   # @param options [Hash]
   # @option options [Boolean] :unset_ok if true, the value being unset is
-  #     acceptible. many plist files will simply omit the key rather than
+  #     acceptable. many plist files will simply omit the key rather than
   #     store an empty array in the case that an array value is empty,
   #     and setting these to an empty array when all we want to do is make
   #     sure that *if it is there, it doesn't contain the value* seems
@@ -541,5 +579,15 @@ module StateMate
       end
     end # case current
   end # array_missing
+  
+  # the value is initialized if it's currently not nil
+  def self.init? key, current, value, adapter, options
+    return !current.nil?
+  end
+  
+  # when a value needs to be initialized it is simply set to the value.
+  def self.init key, current, value, options
+    return value
+  end
 
 end # StateMate

data/lib/state_mate/version.rb

@@ -1,3 +1,3 @@
 module StateMate
-  VERSION = "0.0.8"
+  VERSION = "0.0.9"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: state_mate
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - nrser
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-20 00:00:00.000000000 Z
+date: 2016-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler