state_mate 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8a688ee124e85b425b1448494e3a59bb5244097d
-  data.tar.gz: e3f8f643717a325cf6743c4f690cbf4f2bc45fef
+  metadata.gz: 7e41284705be1f86eac6d6e3d67e0867fae16c30
+  data.tar.gz: b89e28497de8c95c21226c873bcb0bc84d453139
 SHA512:
-  metadata.gz: 55925c3df961ce4eef5df8d88e5f4e48a53173bce138321df7f1ac9dabe54a04cefc3143821c5c7ee683806cbe388fdc4fc3bcf19b73d98b8c4c5da6a410b0c2
-  data.tar.gz: aec931eefee2567705e5a604bdde89be85967bf8c3c0d6f0bf7910275ebce938298ce005ab5b4e30e49ba7759783dc405698805abe1a3ce4c3119d4c9087df84
+  metadata.gz: fcf1b94b353247bad4191400d91ad633b32c1197e7b46a12c1d8ed2a81a5349d9fd3af3a72748a64d85c6b9fe22cc8465e2f8c8e2253abab523b6e18e3204f71
+  data.tar.gz: b766eeee693b372c6abf79a91d0e8eeb6a2d0913334196219982ac6030626e2f2ae7a9420fbfbf843760b9cd46fc47ce288f8377e26caa032ea7bdde4e23a889

data/lib/state_mate/adapters/yaml.rb

@@ -0,0 +1,85 @@
+require 'yaml'
+require 'diffable_yaml'
+
+require 'state_mate'
+require 'state_mate/adapters/defaults'
+
+module StateMate::Adapters::YAML
+  include StateMate::Adapters
+  register 'yaml'
+  
+  @preorder = []
+  
+  def self.preorder= keys
+    @preorder = keys
+  end
+  
+  def self.parse_key key
+    # use the same key seperation as Defaults
+    StateMate::Adapters::Defaults.parse_key key
+  end
+  
+  def self.cast_seg key_seg
+    if key_seg =~ /\A[0-9]+\z/
+      key_seg.to_i
+    else
+      key_seg
+    end
+  end
+
+  def self.read key, options = {}
+    filepath, key_segs = parse_key key
+
+    contents = File.read(File.expand_path(filepath))
+
+    value = ::YAML.load contents
+
+    key_segs.each do |seg|
+      seg = cast_seg seg
+      
+      value = case value
+      when Hash, Array
+        value = value[seg]
+      else
+        nil
+      end
+    end
+
+    value
+  end
+  
+  def self.write key, value, options = {}
+    StateMate.debug key: key, value: value, options: options
+    
+    filepath, key_segs = parse_key key
+
+    new_root = if key_segs.length > 1
+      root = read filepath
+
+      deep_write! root, key_segs, value
+
+      root
+    else
+      value
+    end
+
+    content = DiffableYAML.dump new_root, preorder: @preorder
+
+    File.open(filepath, 'w') do |f|
+      f.write content
+    end
+  end
+  
+  def self.deep_write! obj, key_segs, value
+    seg = cast_seg key_segs.first
+    rest = key_segs[1..-1]
+    
+    if rest.empty?
+      obj[seg] = value
+      
+    else
+      deep_write! obj[seg], rest, value
+      
+    end
+  end
+end # YAML

data/lib/state_mate/adapters.rb

@@ -33,6 +33,7 @@ module StateMate::Adapters
     begin
       require "state_mate/adapters/#{ name }"
     rescue LoadError => e
+      StateMate.debug "failed to require adapter #{ name }", e
     end
     
     unless @@index.key? name

data/lib/state_mate/version.rb

@@ -1,3 +1,3 @@
 module StateMate
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

data/lib/state_mate.rb

@@ -9,6 +9,8 @@ require "state_mate/error"
 require "state_mate/adapters"
 
 module StateMate
+  @debug = false
+  @debug_mode = 'a'
 
   DIRECTIVES = Set.new [
     :set,
@@ -67,6 +69,16 @@ module StateMate
           key = nil
           directives = []
           type_name = nil
+          unset_when_false = false
+          
+          # the :unset_when option can be provided to change the directive to
+          # :unset when the option's value is true.
+          # 
+          # this is useful for things that should simply unset the key when
+          # turned off instead of setting it to false or something.
+          # 
+          unset_when = nil
+          
           options = state['options'] || {}
           
           unless options.is_a? Hash
@@ -94,6 +106,10 @@ module StateMate
               directives << [k, v]
             elsif k == :type
               type_name = v
+            elsif k == :unset_when_false
+              unset_when_false = v
+            elsif k == :unset_when
+              unset_when = StateMate.cast 'bool', v
             else
               # any other keys are set as options
               # this is a little convience feature that avoids having to
@@ -126,7 +142,20 @@ module StateMate
             raise "multiple directives found in #{ state.inspect }"
           end
           
-          unless type_name.nil?
+          # handle :unset_when_false option, which changes the operation to
+          # an unset when the *directive value* is explicity false
+          if  unset_when_false && 
+              (value === false || ['False', 'false'].include?(value))
+            directive = :unset
+            value = nil
+          
+          # handle :unset_when, which also changes the operation to :unset
+          # when the option's value is true.
+          elsif unset_when
+            directive = :unset
+            value = nil
+            
+          elsif type_name
             value = StateMate.cast type_name, value
           end
 
@@ -277,6 +306,40 @@ module StateMate
     end # rollback
   end # StateSet
   
+  # @api dev
+  # 
+  # turns debug on or off
+  # 
+  # @param mode [Boolean|String]
+  #   if a string, enables and sets the debug file mode (use 'a' or 'w').
+  #   if a boolean, sets enabled.
+  # 
+  def self.debug= mode
+    if mode.is_a? String
+      @debug_mode = mode
+    end
+    @debug = !!mode
+  end
+  
+  def self.debug *messages
+    return unless @debug
+    
+    @debug_file ||= File.open('./state_mate.debug.log', @debug_mode)
+    
+    messages.each_with_index do |message, index|
+      if index == 0
+        @debug_file.write 'DEBUG '
+      end
+      
+      if message.is_a? String
+        @debug_file.puts message
+      else
+        @debug_file.puts
+        PP.pp(message, @debug_file)
+      end
+    end
+  end
+  
   # @api util
   # *pure*
   # 

data/state_mate.gemspec

@@ -31,4 +31,5 @@ END
   spec.add_dependency 'nrser', '~> 0.0', '>= 0.0.13'
   spec.add_dependency 'CFPropertyList', '~> 2.3'
   spec.add_dependency 'cmds', '~> 0.0', '>= 0.0.9'
+  spec.add_dependency 'diffable_yaml', '~> 0.0', '>= 0.0.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: state_mate
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - nrser
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-22 00:00:00.000000000 Z
+date: 2016-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -148,6 +148,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.0.9
+- !ruby/object:Gem::Dependency
+  name: diffable_yaml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.2
 description: |
   helps manage state on OSX by wrapping system commands like `defaults`, `nvram`,
   `lanuchctl`, `scutil` and more.
@@ -164,7 +184,6 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- ansible/library/state
 - bin/console
 - lib/state_mate.rb
 - lib/state_mate/adapters.rb
@@ -176,6 +195,7 @@ files:
 - lib/state_mate/adapters/pmset.rb
 - lib/state_mate/adapters/scutil.rb
 - lib/state_mate/adapters/time_machine.rb
+- lib/state_mate/adapters/yaml.rb
 - lib/state_mate/error.rb
 - lib/state_mate/version.rb
 - notes/state-set-steps.md
@@ -200,9 +220,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.6.4
 signing_key: 
 specification_version: 4
 summary: i heard it's meant to help you with your state, mate!
 test_files: []
-has_rdoc: 

data/ansible/library/state

@@ -1,59 +0,0 @@
-#!/usr/bin/env ruby
-# WANT JSON
-
-require 'json'
-require 'shellwords'
-require 'pp'
-
-require 'bundler/setup'
-
-require 'nrser'
-require 'state_mate'
-
-using NRSER
-
-MODULE_COMPLEX_ARGS = "<<INCLUDE_ANSIBLE_MODULE_COMPLEX_ARGS>>"
-
-def parse input
-  # require 'shellwords'
-  parsed = {}
-  Shellwords.split(input).each do |word|
-    (key, value) = word.split('=', 2)
-    parsed[key] = value
-  end
-  unless MODULE_COMPLEX_ARGS.empty?
-    parsed.update JSON.load(MODULE_COMPLEX_ARGS)
-  end
-  parsed
-end
-
-def main
-  input = nil
-  args = nil
-  changed = false
-
-  begin
-    input = File.read ARGV[0]
-    args = parse input
-
-    spec = args
-
-    changes = StateMate.execute spec
-
-    print JSON.dump({
-      'changed' => !changes.empty?,
-      'changes' => changes,
-    })
-  rescue Exception => e
-    print JSON.dump({
-      'failed' => true,
-      'msg' => e.format,
-      # 'input' => input,
-      'args' => args,
-      # 'ARGV' => ARGV,
-      # 'ruby' => RUBY_VERSION,
-    })
-  end
-end
-
-main if __FILE__ == $0