state_mate 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2a4c8ab3b912af529324511e027680f26fef9266
-  data.tar.gz: 19900ae7fbd3aca5d28530833af4417b3018f5a6
+  metadata.gz: 8a688ee124e85b425b1448494e3a59bb5244097d
+  data.tar.gz: e3f8f643717a325cf6743c4f690cbf4f2bc45fef
 SHA512:
-  metadata.gz: 725018a48c59f60532de69717380def4d25a7c1d93a14a3496f539877cf52c2dc30eb4885325f2e87fc373256afbe61f224219c3221d9661d81749f8138b069b
-  data.tar.gz: 9ebc8e8dfaf989dfaf951881bfbc608b1d2a35e7451764643fa5f1d8a219f12592c27856961c434299e3f158633e71592021eebba9fcec1a2bc36001e46a63e6
+  metadata.gz: 55925c3df961ce4eef5df8d88e5f4e48a53173bce138321df7f1ac9dabe54a04cefc3143821c5c7ee683806cbe388fdc4fc3bcf19b73d98b8c4c5da6a410b0c2
+  data.tar.gz: aec931eefee2567705e5a604bdde89be85967bf8c3c0d6f0bf7910275ebce938298ce005ab5b4e30e49ba7759783dc405698805abe1a3ce4c3119d4c9087df84

data/lib/state_mate/adapters/defaults.rb

@@ -9,10 +9,12 @@ require 'CFPropertyList'
 
 require 'cmds'
 
-module StateMate; end
-module StateMate::Adapters; end
+require 'state_mate'
 
 module StateMate::Adapters::Defaults
+  include StateMate::Adapters
+  register 'defaults'
+  
   # constants
   # ========
   
@@ -43,28 +45,20 @@ module StateMate::Adapters::Defaults
   #     `nil`.
   # 
   # @param options [Hash]
-  # @option options [Boolean] 'current_host' if true, the read will be done
+  # @option options [Boolean] :current_host if true, the read will be done
   #     for the domain's "current host" plist file (using the `-currentHost`
   #     option when calling the system's `defaults` command).
-  #     
-  #     note that the key is a {String} and not a {Symbol}.
   # 
   # @return our Ruby representation of the value, or `nil` if it's not found.
   # 
   def self.read key, options = {}
-    if options.key? :current_host
-      raise ArgumentError.new NRSER.squish <<-END
-        current_host option key must be a string, not a symbol.
-      END
-    end
-    
     options = {
-      'current_host' => false,
+      current_host: false,
     }.merge options
 
     domain, key_segs = parse_key key
 
-    value = read_defaults domain, options['current_host']
+    value = read_defaults domain, options[:current_host]
 
     key_segs.each do |seg|
       value = if (value.is_a?(Hash) && value.key?(seg))
@@ -93,23 +87,15 @@ module StateMate::Adapters::Defaults
   #     key.
   # 
   # @param options [Hash]
-  # @option options [Boolean] 'current_host' if true, the read will be done
+  # @option options [Boolean] :current_host if true, the read will be done
   #     for the domain's "current host" plist file (using the `-currentHost`
   #     option when calling the system's `defaults` command).
-  #     
-  #     note that the key is a {String} and not a {Symbol}.
   # 
   # @return nil
   # 
   def self.write key, value, options = {}
-    if options.key? :current_host
-      raise ArgumentError.new NRSER.squish <<-END
-        current_host option key must be a string, not a symbol.
-      END
-    end
-    
     options = {
-      'current_host' => false,
+      current_host: false,
     }.merge options
 
     domain, key_segs = parse_key key
@@ -119,12 +105,12 @@ module StateMate::Adapters::Defaults
                   key_segs[0],
                   key_segs.drop(1),
                   value,
-                  options['current_host']
+                  options[:current_host]
     else
       basic_write domain,
                   key_segs[0],
                   value,
-                  options['current_host']
+                  options[:current_host]
     end
     
     nil
@@ -588,7 +574,7 @@ module StateMate::Adapters::Defaults
   # @return nil
   # 
   def self.deep_write domain, key, deep_segs, value, current_host
-    root = read [domain, key], 'current_host' => current_host
+    root = read [domain, key], current_host: current_host
     # handle the root not being there
     root = {} unless root.is_a? Hash
     hash_deep_write! root, deep_segs, value

data/lib/state_mate/adapters/git_config.rb

@@ -1,10 +1,11 @@
 require 'cmds'
 
-module StateMate; end
-module StateMate::Adapters; end
+require 'state_mate'
 
 # adapter to set global git config options
 module StateMate::Adapters::GitConfig
+  include StateMate::Adapters
+  register 'git_config'
   
   # @api adapter
   # 

data/lib/state_mate/adapters/json.rb

@@ -4,6 +4,9 @@ require 'state_mate'
 require 'state_mate/adapters/defaults'
 
 module StateMate::Adapters::JSON
+  include StateMate::Adapters
+  register 'json'
+  
   def self.parse_key key
     # use the same key seperation as Defaults
     StateMate::Adapters::Defaults.parse_key key
@@ -14,7 +17,7 @@ module StateMate::Adapters::JSON
 
     contents = File.read(File.expand_path(filepath))
 
-    value = JSON.load contents
+    value = ::JSON.load contents
 
     key_segs.each do |seg|
       value = if (value.is_a?(Hash) && value.key?(seg))
@@ -49,9 +52,9 @@ module StateMate::Adapters::JSON
     end
 
     content = if options['pretty']
-      JSON.pretty_generate new_root
+      ::JSON.pretty_generate new_root
     else
-      JSON.dump new_root
+      ::JSON.dump new_root
     end
 
     File.open(filepath, 'w') do |f|

data/lib/state_mate/adapters/launchd.rb

@@ -15,6 +15,8 @@ using NRSER
 # 46
 
 module StateMate::Adapters::LaunchD
+  include StateMate::Adapters
+  register 'launchd'
 
   EXE = '/bin/launchctl'
 

data/lib/state_mate/adapters/nvram.rb

@@ -1,12 +1,14 @@
 require 'cmds'
 require 'nrser'
 
-using NRSER
+require 'state_mate'
 
-module StateMate; end
-module StateMate::Adapters; end
+using NRSER
 
 module StateMate::Adapters::NVRAM
+  include StateMate::Adapters
+  register 'nvram'
+  
   def self.read key, options = {}
     result = Cmds "nvram %{key}", key: key
 

data/lib/state_mate/adapters/pmset.rb

@@ -1,13 +1,16 @@
+require 'pp'
+
 require 'cmds'
 require 'nrser'
-require 'pp'
 
-using NRSER
+require 'state_mate'
 
-module StateMate; end
-module StateMate::Adapters; end
+using NRSER
 
 module StateMate::Adapters::PMSet
+  include StateMate::Adapters
+  register 'pmset'
+  
   # whitelist of modes we handle mapped to their `pmset` flag
   #
   # there is also a UPS mode, but i don't know what it looks like

data/lib/state_mate/adapters/scutil.rb

@@ -1,10 +1,11 @@
 require 'cmds'
 
-module StateMate; end
-module StateMate::Adapters; end
+require 'state_mate'
 
 # adapter to set global git config options
 module StateMate::Adapters::SCUtil
+  include StateMate::Adapters
+  register 'scutil'
 
   # @api adapter
   #

data/lib/state_mate/adapters/time_machine.rb

@@ -5,12 +5,14 @@ require 'CFPropertyList'
 require 'nrser'
 require 'nrser/exec'
 
-using NRSER
+require 'state_mate'
 
-module StateMate; end;
-module StateMate::Adapters; end
+using NRSER
 
 module StateMate::Adapters::TimeMachine
+  include StateMate::Adapters
+  register 'time_machine'
+  
   EXE = '/usr/bin/tmutil'
   PLIST_PATH = '/Library/Preferences/com.apple.TimeMachine.plist'
 

data/lib/state_mate/adapters.rb

@@ -0,0 +1,52 @@
+require 'pp'
+
+module StateMate; end
+
+module StateMate::Adapters
+  API_METHOD_NAMES = [:read, :write]
+  
+  @@index = {}
+  
+  module IncludeClassMethods
+    def register name
+      StateMate::Adapters.register name, self
+    end
+  end
+  
+  def self.included base
+    base.extend IncludeClassMethods
+  end
+  
+  def self.register name, obj
+    unless name.is_a? String
+      raise StateMate::Error::TypeError.new name, "name must be a String"
+    end
+    
+    @@index[name] = obj
+  end
+  
+  def self.get name
+    # return it if it's already loaded
+    return @@index[name] if @@index.key? name
+    
+    # try to require it
+    begin
+      require "state_mate/adapters/#{ name }"
+    rescue LoadError => e
+    end
+    
+    unless @@index.key? name
+      raise StateMate::Error::AdapterNotFoundError.new NRSER.dedent <<-END
+        adapter #{ name.inspect } was not found.
+        
+        registered adapters:
+        
+        #{ @@index.pretty_inspect }
+        
+      END
+    end
+    
+    @@index[name]
+  end
+  
+end # Adapters

data/lib/state_mate/error.rb

@@ -0,0 +1,28 @@
+module StateMate
+  module Error
+    class StateMateError < StandardError; end
+    
+    class ExecutionError < StateMateError; end
+
+    class WriteError < ExecutionError; end
+    
+    # raised when an erros is encountered running a sync method on an adapter
+    #(set, unset, array_contains, array_missing)
+    class ValueSyncError < ExecutionError; end
+
+    class TypeError < ::TypeError
+      attr_accessor :value
+
+      def initialize value, msg
+        @value = value
+        super "#{ msg }, found #{ value.inspect }"
+      end
+    end
+    
+    class AdapterNotFoundError < StateMateError; end
+    
+    # raised when the current structre of a value prevents the desired sync
+    # operation with the given options.
+    class StructureConflictError < StateMateError; end
+  end # Error
+end # StateMate

data/lib/state_mate/version.rb

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

data/lib/state_mate.rb

@@ -5,33 +5,18 @@ require 'nrser/refinements'
 using NRSER
 
 require "state_mate/version"
+require "state_mate/error"
+require "state_mate/adapters"
 
 module StateMate
 
   DIRECTIVES = Set.new [
-    'set',
-    'unset',
-    'array_contains',
-    'array_missing',
+    :set,
+    :unset,
+    :array_contains,
+    :array_missing,
   ]
 
-  module Error
-    class ExecutionError < StandardError; end
-
-    class WriteError < ExecutionError; end
-
-    class ValueChangeError < ExecutionError; end
-
-    class TypeError < ::TypeError
-      attr_accessor :value
-
-      def initialize value, msg
-        @value = value
-        super "#{ msg }, found #{ value.inspect }"
-      end
-    end
-  end # Error
-
   class StateSet
     attr_accessor :spec
     attr_reader :states,
@@ -60,7 +45,7 @@ module StateMate
       end
 
       spec.each do |adapter_name, states|
-        adapter = StateMate.get_adapter adapter_name
+        adapter = StateMate::Adapters.get adapter_name
 
         states = case states
         when Hash
@@ -98,13 +83,16 @@ module StateMate
           end
           
           state.each do |k, v|
-            if k == 'key'
+            # normalize to symbols
+            k = k.to_sym if k.is_a? String
+            
+            if k == :key
               key = v
-            elsif k == 'options'
+            elsif k == :options
               # pass, dealt with above
             elsif DIRECTIVES.include? k
               directives << [k, v]
-            elsif k == 'type'
+            elsif k == :type
               type_name = v
             else
               # any other keys are set as options
@@ -181,7 +169,11 @@ module StateMate
         test_method = StateMate.method "#{ state.directive }?"
 
         # find out if the state is in sync
-        in_sync = test_method.call state.key, read_value, state.value, state.adapter
+        in_sync = test_method.call  state.key,
+                                    read_value,
+                                    state.value,
+                                    state.adapter,
+                                    state.options
 
         # add to the list of changes to be made for states that are
         # out of sync
@@ -205,13 +197,13 @@ module StateMate
                                         state.options
         rescue Exception => e
           @new_value_error = e
-          raise Error::ValueChangeError.new binding.erb <<-BLOCK
+          raise Error::ValueSyncError.new binding.erb <<-BLOCK
             an error occured when changing a values:
 
             <%= @new_value_error.format %>
 
             no changes were attempted to the system, so there is no rollback
-            neessicary.
+            necessary.
           BLOCK
         end
         # change successful, store the new value along-side the state
@@ -293,39 +285,64 @@ module StateMate
   # as strings.
   # 
   # @param type_name [String] the 'name' of the type to cast to.
-  
+  # @param value the value to cast.
+  # 
   def self.cast type_name, value
     case type_name
     when 'string', 'str'
       value.to_s
     when 'integer', 'int'
-      value.to_i
+      case value
+      when Fixnum
+        value
+      when true
+        1
+      when false
+        0
+      when String
+        if value =~ /\A[-+]?[0-9]*\Z/
+          value.to_i
+        elsif value.downcase == 'true'
+          1
+        elsif value.downcase == 'false'
+          0
+        else
+          raise ArgumentError.new "can't cast to integer: #{ value.inspect }"
+        end
+      else
+        raise TypeError.new "can't cast type to integer: #{ value.inspect }"
+      end
     when 'float'
-      value.to_f
+      case value
+      when Float
+        value
+      when Fixnum
+        value.to_f
+      when String
+        if value =~ /\A[-+]?[0-9]*\.?[0-9]+\Z/
+          value.to_f
+        else
+          raise ArgumentError.new "can't cast to float: #{ value.inspect }"
+        end
+      else
+        raise TypeError.new "can't cast type to float: #{ value.inspect }"
+      end
     when 'boolean', 'bool'
-      if value.to_s.downcase == 'true'
-        true
-      elsif value.to_s.downcase == 'false'
+      case value
+      when true, false
+        value
+      when 0, '0', 'False', 'false', 'FALSE'
         false
-      else
-        raise ArgumentError.new "can't cast to boolean: #{ value.inspect }"
+      when 1, '1', 'True', 'true', 'TRUE'
+        true
+      else 
+        raise ArgumentError.new "can't cast type to boolean: #{ value.inspect }"
       end
     else 
       raise ArgumentError.new "bad type name: #{ type_name.inspect }"
     end
   end
 
-  def self.get_adapter adapter_name
-    begin
-      require "state_mate/adapters/#{ adapter_name }"
-      StateMate::Adapters.constants.find {|sym|
-        sym.to_s.downcase == adapter_name.gsub('_', '')
-      }.pipe {|sym| StateMate::Adapters.const_get sym}
-    rescue Exception => e
-      raise "can't find adapter #{ adapter_name.inspect }: #{ e }"
-    end
-  end
-
   def self.execute spec
     StateSet.from_spec(spec).execute
   end
@@ -338,7 +355,7 @@ module StateMate
     end
   end
 
-  def self.set? key, current, value, adapter
+  def self.set? key, current, value, adapter, options
     values_equal? current, value, adapter
   end
 
@@ -347,7 +364,7 @@ module StateMate
     value
   end
 
-  def self.unset? key, current, value, adapter
+  def self.unset? key, current, value, adapter, options
     current.nil?
   end
 
@@ -357,7 +374,7 @@ module StateMate
     nil
   end
 
-  def self.array_contains? key, current, value, adapter
+  def self.array_contains? key, current, value, adapter, options
     current.is_a?(Array) && current.any? {|v|
       values_equal? v, value, adapter
     }
@@ -366,14 +383,22 @@ module StateMate
   def self.array_contains key, current, value, options
     case current
     when Array
-      current + [value]
+      # this is just to make the function consistent, so it doesn't add another
+      # copy of value if it's there... in practice StateMate should not
+      # call {.array_contains} if the value is alreay in the array
+      # (that's what {.array_contains?} tests for)
+      if current.include? value
+        current
+      else
+        current + [value]
+      end
 
     when nil
       # it needs to be created
-      if options[:create]
+      if options[:create] || options[:clobber]
         [value]
       else
-        raise <<-BLOCK.unblock
+        raise Error::StructureConflictError.new <<-BLOCK.unblock
           can not ensure #{ key.inspect } contains #{ value.inspect } because
           the key does not exist and options[:create] is not true.
         BLOCK
@@ -387,18 +412,34 @@ module StateMate
       if options[:clobber]
         [value]
       else
-        raise <<-BLOCK.unblock
+        raise Error::StructureConflictError.new <<-BLOCK.unblock
           can not ensure #{ key.inspect } contains #{ value.inspect } because
           the value is #{ current.inspect } and options[:clobber] is not true.
         BLOCK
       end
     end # case current
   end # array_contians
-
-  def self.array_missing? key, current, value, adapter
-    current.is_a?(Array) && !current.any? {|v|
-      values_equal? v, value, adapter
-    }
+  
+  # @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
+  #     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
+  #     pointless.
+  def self.array_missing? key, current, value, adapter, options
+    case current
+    when nil
+      if options[:unset_ok]
+        true
+      else
+        false
+      end
+    when Array
+      !current.any? {|v| values_equal? v, value, adapter}
+    else
+      false
+    end
   end
 
   def self.array_missing key, current, value, options
@@ -407,14 +448,20 @@ module StateMate
       current - [value]
 
     when nil
-      # there is no value, only option is to create a new empty array there
-      if options[:create]
-        []
+      # if we're ok with the value being unset (`nil` to us here), then
+      # we're done
+      if options[:unset_ok]
+        nil
       else
-        raise <<-BLOCK.unblock
-          can not ensure #{ key.inspect } missing #{ value.inspect } because
-          the key does not exist and options[:create] is not true.
-        BLOCK
+        # there is no value, only option is to create a new empty array there
+        if options[:create] || options[:clobber]
+          []
+        else
+          raise Error::StructureConflictError.new <<-BLOCK.unblock
+            can not ensure #{ key.inspect } missing #{ value.inspect } because
+            the key does not exist and options[:create] is not true.
+          BLOCK
+        end
       end
 
     else
@@ -424,7 +471,7 @@ module StateMate
       if options[:clobber]
         []
       else
-        raise <<-BLOCK.unblock
+        raise Error::StructureConflictError.new <<-BLOCK.unblock
           can not ensure #{ key.inspect } missing #{ value.inspect } because
           the value is #{ current.inspect } and options[:clobber] is not true.
         BLOCK

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: state_mate
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - nrser
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-19 00:00:00.000000000 Z
+date: 2015-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -167,6 +167,7 @@ files:
 - ansible/library/state
 - bin/console
 - lib/state_mate.rb
+- lib/state_mate/adapters.rb
 - lib/state_mate/adapters/defaults.rb
 - lib/state_mate/adapters/git_config.rb
 - lib/state_mate/adapters/json.rb
@@ -175,6 +176,7 @@ files:
 - lib/state_mate/adapters/pmset.rb
 - lib/state_mate/adapters/scutil.rb
 - lib/state_mate/adapters/time_machine.rb
+- lib/state_mate/error.rb
 - lib/state_mate/version.rb
 - notes/state-set-steps.md
 - state_mate.gemspec