state_mate 0.0.9 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5f01f81ae28c991389d0bb58e43f41fb551a690b
-  data.tar.gz: 0e888f119ce00d45046ec008aa63d43784b0ff52
+  metadata.gz: 2a117a449ec19a632442d42240486e118f2fa0af
+  data.tar.gz: 2a300da504220c97e5b6eae01162604cf9cd1e29
 SHA512:
-  metadata.gz: 3a3d7f7027493edc8aace942eb0cb15888a0145d500252f36e0d05edee3d953f4312fa009fdbb87cf9c6b86c45bee5ba177bdbb4540a3492e0284711b9979e1c
-  data.tar.gz: 1d4fbf23716276cb3688e7d73165802c20a4f4445cf688bd2ced4a3b64d2a52ec8e0ffacabcb82b9768de76846b3b7978f8b36a3dc0ebaeef59bf20e6e3481e6
+  metadata.gz: 4421432fc0952a59e2b59c53940b2a46d9623a172fb01402be037c55ad935dcd2ea3c22625e9251cd048df6e8fe053a24d8f5e6012cf2ab1dcfae9cbc520387d
+  data.tar.gz: 40e024603a6b86775bbda6653bb40134b7edcd77b7a0ed1881c38acf3fc3404f83b638fa93b528f2cb085df55270b2705aeff19e201ebcb0a2a247b8dd4b777b

data/.gitignore

@@ -20,3 +20,4 @@ tmp
 *.o
 *.a
 mkmf.log
+.qb-playbook.yml

data/bin/console

@@ -1,38 +1,25 @@
 #!/usr/bin/env ruby
 
-require 'pathname'
-require 'fileutils'
-
 require "bundler/setup"
-require "state_mate"
 require 'nrser'
-require 'nrser/extras'
+require 'state_mate'
 
-using NRSER
 
-ROOT = NRSER.git_root __FILE__
+require 'nrser/refinements'
+using NRSER
 
-Pathname.glob(ROOT + 'lib' + 'state_mate' + 'adapters' + '*.rb').each do |pn|
-  name = "state_mate/adapters/#{ pn.basename '.rb' }"
-  begin
-    require name
-  rescue Exception => e
-    puts NRSER.dedent <<-END
-      failed to load adapter '#{ name }':
-      
-      #{ e.format }
-      
-    END
-  end
-    
-end
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
 
 # (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start
+begin
+  require "pry"
+rescue LoadError => error
+  puts "Failed to load `pry` gem - add it to your Gemfile or edit this file"
+  
+  require "irb"
+  IRB.start
+else
+  Pry.start
+end

data/bin/rake

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+bundle exec rake "$@"

data/bin/rspec

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+bundle exec rspec "$@"

data/lib/state_mate.rb

@@ -1,12 +1,30 @@
+# Requirements
+# =======================================================================
+
+# Stdlib
+# -----------------------------------------------------------------------
 require 'set'
-require 'nrser'
-require 'nrser/refinements'
 
-using NRSER
+# Deps
+# -----------------------------------------------------------------------
 
+# Project / Package
+# -----------------------------------------------------------------------
 require "state_mate/version"
 require "state_mate/error"
 require "state_mate/adapters"
+require "state_mate/state_set"
+
+
+# Refinements
+# =======================================================================
+
+require 'nrser/refinements'
+using NRSER
+
+
+# Definitions
+# =======================================================================
 
 module StateMate
   @debug = false
@@ -37,7 +55,7 @@ module StateMate
     # 
     # -   missing/nil/null:
     #     -   if the `unset_ok` option evaluates **true**:
-    #         -   it will validate as a correct state and no action will be 
+    #         -   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**.
@@ -56,293 +74,7 @@ module StateMate
     # initializes a value - setting it only if it is missing/nil
     :init,
   ]
-
-  class StateSet
-    attr_accessor :spec
-    attr_reader :states,
-                :read_values,
-                :states_to_change,
-                :new_values,
-                :written_states,
-                :write_error,
-                :rollback_errors,
-                :changes
-
-
-    State = Struct.new  :adapter,
-                        :key,
-                        :directive,
-                        :value,
-                        :options
-
-    def self.from_spec spec
-      state_set = self.new
-      state_set.spec = spec
-
-      unless spec.is_a? Hash
-        raise Error::TypeError.new spec, 
-          "spec must be a Hash of adapter names to states"
-      end
-
-      spec.each do |adapter_name, states|
-        adapter = StateMate::Adapters.get adapter_name
-
-        states = case states
-        when Hash
-          [states]
-        when Array
-          states
-        else
-          raise Error::TypeError.new states, <<-BLOCK.unblock
-            each value of the spec needs to be a single state hash or an
-            array or state
-          BLOCK
-        end
-
-        states.each do |state|
-          unless spec.is_a? Hash
-            raise Error::TypeError.new state, "each state needs to be a Hash"
-          end
-
-          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
-            raise TypeError.new binding.erb <<-END
-              options must be a hash, found <%= options.class %>:
-              
-              <%= options.inspect %>
-              
-              state:
-              
-              <%= state.inspect %>
-              
-            END
-          end
-          
-          state.each do |k, v|
-            # normalize to symbols
-            k = k.to_sym if k.is_a? String
-            
-            if k == :key
-              key = v
-            elsif k == :options
-              # pass, dealt with above
-            elsif DIRECTIVES.include? k
-              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 convenience feature that avoids having to
-              # nest inside an `options` key unless your option conflicts
-              # with 'key' or a directive.
-              #
-              # check for conflicts
-              if options.key? k
-                raise ArgumentError.new binding.erb <<-END
-                  top-level state key #{ k.inspect } was also provided in the
-                  options.
-                  
-                  state:
-                  
-                  <%= state.inspect %>
-                  
-                END
-              end
-              
-              options[k] = v
-            end
-          end
-
-          directive, value = case directives.length
-          when 0
-            raise "no directive found in #{ state.inspect }"
-          when 1
-            directives.first
-          else
-            raise "multiple directives found in #{ state.inspect }"
-          end
-          
-          # handle :unset_when_false option, which changes the operation to
-          # an unset when the *directive value* is explicitly 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
-
-          state_set.add adapter, key, directive, value, options
-        end # state.each
-      end # states.each
-
-      state_set
-    end # from_spec
-
-    def initialize
-      @spec = nil
-      @states = []
-      @read_values = {}
-      @states_to_change = []
-      @new_values = []
-      @written_states = []
-      @write_error = nil
-      # map of states to errors raised when trying to rollback
-      @rollback_errors = {}
-      # report of changes made
-      @changes = {}
-    end
-
-    def add adapter, key, directive, value, options = {}
-      @states << State.new(adapter, key, directive, value, options)
-    end
-
-    def execute
-      # find out what needs to be changed
-      @states.each do |state|
-        # read the current value
-        read_value = state.adapter.read state.key, state.options
-
-        # store it for use in the actual change
-        @read_values[state] = read_value
-
-        # the test method is the directive with a '?' appended,
-        # like `set?` or `array_contains?`
-        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,
-                                    state.options
-
-        # add to the list of changes to be made for states that are
-        # out of sync
-        @states_to_change << state unless in_sync
-      end
-
-      # if everything is in sync, no changes need to be attempted
-      # reutrn the empty hash of changes
-      return @changes if @states_to_change.empty?
-
-      # do the change to each in-memory value
-      # this will raise an excption if the operation can't be done for
-      # some reason
-      states_to_change.each do |state|
-        sync_method = StateMate.method state.directive
-        # we want to catch any error and report it
-        begin
-          new_value = sync_method.call  state.key,
-                                        @read_values[state],
-                                        state.value,
-                                        state.options
-        rescue Exception => e
-          @new_value_error = e
-          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
-            necessary.
-          BLOCK
-        end
-        # change successful, store the new value along-side the state
-        # for use in the next block
-        @new_values << [state, new_value]
-      end
-
-      new_values.each do |state, new_value|
-        begin
-          state.adapter.write state.key, new_value, state.options
-        rescue Exception => e
-          @write_error = e
-          rollback
-          raise Error::WriteError.new binding.erb <<-BLOCK
-            an error occured when writing new state values:
-
-            <%= @write_error.format %>
-
-            <% if @written_states.empty? %>
-              the error occured on the first write, so no values were rolled
-              back.
-
-            <% else %>
-              <% if @rollback_errors.empty? %>
-                all values were sucessfully rolled back:
-
-              <% else %>
-                some values failed to rollback:
-
-              <% end %>
-
-              <% @written_states.each do |state| %>
-                <% if @rollback_errors[state] %>
-                  <% state.key %>: <% @rollback_errors[state].format.indent(8) %>
-                <% else %> 
-                  <%= state.key %>: rolled back.
-                <% end %>
-              <% end %>
-            <% end %>
-            BLOCK
-        else
-          @written_states << state
-        end # begin / rescue / else
-      end # new_values.each
-
-      # ok, we made it. report the changes
-      new_values_hash = Hash[@new_values]
-      @written_states.each do |state|
-        @changes[[state.adapter.name, state.key]] = [@read_values[state], new_values_hash[state]]
-      end
-      
-      @changes
-    end # execute
-
-    private
-
-    def rollback
-      # go through the writes that were sucessfully made and try to
-      # reverse them
-      @written_states.reverse.each do |state|
-        # wrap in rescue so that we can record that the rollback failed
-        # for a value and continue
-        begin
-          state.adapter.write state.key, state.value, state.options
-        rescue Exception => e
-          # record when and why a rollback fails to include it in the
-          # exiting exception
-          @rollback_errors[state] = e
-        end
-      end
-    end # rollback
-  end # StateSet
+  
   
   # @api dev
   # 
@@ -382,7 +114,7 @@ module StateMate
   # *pure*
   # 
   # casts a value to a type, or raises an error if not possible.
-  # this is useful because ansible in particular likes to pass things
+  # this is useful because Ansible in particular likes to pass things
   # as strings.
   # 
   # @param type_name [String] the 'name' of the type to cast to.
@@ -436,10 +168,10 @@ module StateMate
         false
       when 1, '1', 'True', 'true', 'TRUE'
         true
-      else 
+      else
         raise ArgumentError.new "can't cast type to boolean: #{ value.inspect }"
       end
-    else 
+    else
       raise ArgumentError.new "bad type name: #{ type_name.inspect }"
     end
   end
@@ -486,7 +218,7 @@ module StateMate
     when Array
       # 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
+      # call {.array_contains} if the value is already in the array
       # (that's what {.array_contains?} tests for)
       if current.include? value
         current

data/lib/state_mate/adapters.rb

@@ -5,6 +5,12 @@ module StateMate; end
 module StateMate::Adapters
   API_METHOD_NAMES = [:read, :write]
   
+  # Default character to split string keys on.
+  # 
+  # @return [String]
+  # 
+  DEFAULT_KEY_SEP = ':'
+  
   @@index = {}
   
   module IncludeClassMethods

data/lib/state_mate/adapters/file.rb

@@ -0,0 +1,145 @@
+# Requirements
+# =======================================================================
+
+# Stdlib
+# -----------------------------------------------------------------------
+
+# Deps
+# -----------------------------------------------------------------------
+
+# Project / Package
+# -----------------------------------------------------------------------
+
+
+# Refinements
+# =======================================================================
+
+
+# Declarations
+# =======================================================================
+
+
+# Definitions
+# =======================================================================
+
+
+# Abstract base class for adapters whose data is stored in a single file.
+# 
+class StateMate::Adapters::File
+  
+  # Constants
+  # ======================================================================
+  
+  
+  # Class Methods
+  # ======================================================================
+  
+  # *pure*
+  # 
+  # Parses a key into path segments, the first of which should be the file
+  # path.
+  # 
+  # Checks that there is at least one resulting segment and that none of the
+  # segments are empty.
+  # 
+  # If `key` is an array, assumes it's already split, and just checks that 
+  # the segments meet the above criteria, allowing key segments that contain
+  # the key separator (which defaults to the
+  # {StateMate::Adapters::DEFAULT_KEY_SEP} `:`).
+  # 
+  # @example `:`-separated string key
+  #   parse_key '/Users/nrser/what/ever.json:x:y:z'
+  #   # => ['/Users/nrser/what/ever.json', 'x', 'y', 'z']
+  # 
+  # @example Array key with segments containing `:`
+  #   parse_key ['/Users/nrser/filename:with:colons.json', 'x', 'y']
+  #   # => ['/Users/nrser/filename:with:colons.json', 'x', 'y']
+  #
+  # @param key [Array<String>, String] an Array of non-empty Strings or a
+  #     a String that splits by `:` into an non-empty Array of non-empty
+  #     Strings.
+  # 
+  # @return [Array<String, Array<String>>] the String domain followed by an
+  #     array of key segments.
+  # 
+  # @raise [ArgumentError] if the key does not parse into a non-empty list
+  #     of non-empty strings.
+  #
+  def self.parse_key key, key_sep = StateMate::Adapters::DEFAULT_KEY_SEP
+    strings = case key
+    when Array
+      key
+    when String
+      key.split key_sep
+    else
+      raise TypeError,
+        "key must be string or array, not #{ key.inspect }"
+    end # case
+    
+    # make sure there is at least one element
+    if strings.empty?
+      raise ArgumentError,
+        "key parsed into empty list: #{ key.inspect }"
+    end
+    
+    # check for non-strings, empty domain or key segments
+    strings.each do |string|
+      if !string.is_a?(String) || string.empty?
+        raise ArgumentError.new NRSER.squish <<-END
+          all key segments must be non-empty,
+          found #{ string.inspect } in key #{ key.inspect }.
+        END
+      end
+    end
+
+    strings
+  end # ::parse_key
+  
+  
+  # Attributes
+  # ======================================================================
+  
+  
+  # Constructor
+  # ======================================================================
+  
+  # Instantiate a new `StateMate::Adapters::File`.
+  def initialize
+    
+  end # #initialize
+  
+  
+  # Instance Methods
+  # ======================================================================
+  
+  
+  # Parse file contents into state structure.
+  # 
+  # @abstract
+  # 
+  # @param [String] file_contents
+  #   File contents to parse.
+  # 
+  # @return [Hash]
+  #   @todo Document return value.
+  # 
+  def parse file_contents
+    raise NRSER::AbstractMethodError.new self, __method__ 
+  end # #parse
+  
+  
+  
+  # @todo Document read method.
+  # 
+  # @param [type] arg_name
+  #   @todo Add name param description.
+  # 
+  # @return [return_type]
+  #   @todo Document return value.
+  # 
+  def read key, **options
+    
+  end # #read
+  
+  
+end # class StateMate::Adapters::File

data/lib/state_mate/adapters/git/ignore.rb

@@ -0,0 +1,85 @@
+# Requirements
+# =======================================================================
+
+# Stdlib
+# -----------------------------------------------------------------------
+
+# Deps
+# -----------------------------------------------------------------------
+
+# Project / Package
+# -----------------------------------------------------------------------
+
+require 'cmds'
+
+require 'state_mate/adapters'
+
+
+# Declarations
+# =======================================================================
+
+module StateMate::Adapters::Git; end
+
+
+# Definitions
+# =======================================================================
+
+# Adapter for working with `.gitingore` files.
+# 
+module StateMate::Adapters::Git::Ignore
+  include StateMate::Adapters
+  
+  register 'gitignore'
+  
+   
+  # adapter API call that reads a value from the git global config.
+  # 
+  # @api adapter
+  # 
+  # @param key [String] the key to read
+  # @param options [Hash] unused options to conform to adapter API
+  # 
+  # @return [String, nil] the git config value, or nil if it's missing.
+  # 
+  # @raise [SystemCallError] if the key is bad or something else caused the
+  #     command to fail.
+  def self.read key, options = {}
+    result = Cmds "git config --global --get %{key}", key: key
+    
+    # if the command succeeded the result is the output
+    # (minus trailing newline)
+    if result.ok?
+      result.out.chomp
+    
+    # if it errored with no output then the key is missing
+    elsif result.err == ''
+      nil
+    
+    # otherwise, raise an error
+    else
+      result.assert
+    end
+  end # ::read
+  
+  
+  # @api adapter
+  # 
+  # adapter API call that writes a value to the git global config.
+  # 
+  # @param key [String] the key to write
+  # @param value [String] the value to write
+  # @param options [Hash] unused options to conform to adapter API
+  # 
+  # @return nil
+  # 
+  def self.write key, value, options = {}
+    # decide to add or replace based on if the key has a value
+    action = read(key, options).nil? ? '--add' : '--replace'
+
+    result = Cmds!  "git config --global #{ action } %{key} %{value}",
+                    key: key,
+                    value: value
+    
+    nil
+  end # ::write
+end # GitConfig

data/lib/state_mate/adapters/json.rb

@@ -8,7 +8,7 @@ module StateMate::Adapters::JSON
   register 'json'
   
   def self.parse_key key
-    # use the same key seperation as Defaults
+    # use the same key separation as Defaults
     StateMate::Adapters::Defaults.parse_key key
   end
 

data/lib/state_mate/state_set.rb

@@ -0,0 +1,316 @@
+# Requirements
+# =======================================================================
+
+# Stdlib
+# -----------------------------------------------------------------------
+
+# Deps
+# -----------------------------------------------------------------------
+
+# Project / Package
+# -----------------------------------------------------------------------
+
+
+# Refinements
+# =======================================================================
+
+require 'nrser/refinements'
+using NRSER
+
+
+# Declarations
+# =======================================================================
+
+module StateMate; end
+
+
+# Definitions
+# =======================================================================
+
+class StateMate::StateSet
+  attr_accessor :spec
+  attr_reader :states,
+              :read_values,
+              :states_to_change,
+              :new_values,
+              :written_states,
+              :write_error,
+              :rollback_errors,
+              :changes
+
+
+  State = Struct.new  :adapter,
+                      :key,
+                      :directive,
+                      :value,
+                      :options
+
+  def self.from_spec spec
+    state_set = self.new
+    state_set.spec = spec
+
+    unless spec.is_a? Hash
+      raise StateMate::Error::TypeError.new spec,
+        "spec must be a Hash of adapter names to states"
+    end
+
+    spec.each do |adapter_name, states|
+      adapter = StateMate::Adapters.get adapter_name
+
+      states = case states
+      when Hash
+        [states]
+      when Array
+        states
+      else
+        raise StateMate::Error::TypeError.new states, <<-BLOCK.unblock
+          each value of the spec needs to be a single state hash or an
+          array or state
+        BLOCK
+      end
+
+      states.each do |state|
+        unless spec.is_a? Hash
+          raise StateMate::Error::TypeError.new state,
+            "each state needs to be a Hash"
+        end
+
+        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
+          raise TypeError.new binding.erb <<-END
+            options must be a hash, found <%= options.class %>:
+            
+            <%= options.inspect %>
+            
+            state:
+            
+            <%= state.inspect %>
+            
+          END
+        end
+        
+        state.each do |k, v|
+          # normalize to symbols
+          k = k.to_sym if k.is_a? String
+          
+          if k == :key
+            key = v
+          elsif k == :options
+            # pass, dealt with above
+          elsif StateMate::DIRECTIVES.include? k
+            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 convenience feature that avoids having to
+            # nest inside an `options` key unless your option conflicts
+            # with 'key' or a directive.
+            #
+            # check for conflicts
+            if options.key? k
+              raise ArgumentError.new binding.erb <<-END
+                top-level state key #{ k.inspect } was also provided in the
+                options.
+                
+                state:
+                
+                <%= state.inspect %>
+                
+              END
+            end
+            
+            options[k] = v
+          end
+        end
+
+        directive, value = case directives.length
+        when 0
+          raise "no directive found in #{ state.inspect }"
+        when 1
+          directives.first
+        else
+          raise "multiple directives found in #{ state.inspect }"
+        end
+        
+        # handle :unset_when_false option, which changes the operation to
+        # an unset when the *directive value* is explicitly 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
+
+        state_set.add adapter, key, directive, value, options
+      end # state.each
+    end # states.each
+
+    state_set
+  end # from_spec
+
+  def initialize
+    @spec = nil
+    @states = []
+    @read_values = {}
+    @states_to_change = []
+    @new_values = []
+    @written_states = []
+    @write_error = nil
+    # map of states to errors raised when trying to rollback
+    @rollback_errors = {}
+    # report of changes made
+    @changes = {}
+  end
+
+  def add adapter, key, directive, value, options = {}
+    @states << State.new(adapter, key, directive, value, options)
+  end
+
+  def execute
+    # find out what needs to be changed
+    @states.each do |state|
+      # read the current value
+      read_value = state.adapter.read state.key, state.options
+
+      # store it for use in the actual change
+      @read_values[state] = read_value
+
+      # the test method is the directive with a '?' appended,
+      # like `set?` or `array_contains?`
+      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,
+                                  state.options
+
+      # add to the list of changes to be made for states that are
+      # out of sync
+      @states_to_change << state unless in_sync
+    end
+
+    # if everything is in sync, no changes need to be attempted
+    # reutrn the empty hash of changes
+    return @changes if @states_to_change.empty?
+
+    # do the change to each in-memory value
+    # this will raise an excption if the operation can't be done for
+    # some reason
+    states_to_change.each do |state|
+      sync_method = StateMate.method state.directive
+      # we want to catch any error and report it
+      begin
+        new_value = sync_method.call  state.key,
+                                      @read_values[state],
+                                      state.value,
+                                      state.options
+      rescue Exception => e
+        @new_value_error = e
+        raise StateMate::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
+          necessary.
+        BLOCK
+      end
+      # change successful, store the new value along-side the state
+      # for use in the next block
+      @new_values << [state, new_value]
+    end
+
+    new_values.each do |state, new_value|
+      begin
+        state.adapter.write state.key, new_value, state.options
+      rescue Exception => e
+        @write_error = e
+        rollback
+        raise StateMate::Error::WriteError.new binding.erb <<-BLOCK
+          an error occured when writing new state values:
+
+          <%= @write_error.format %>
+
+          <% if @written_states.empty? %>
+            the error occured on the first write, so no values were rolled
+            back.
+
+          <% else %>
+            <% if @rollback_errors.empty? %>
+              all values were sucessfully rolled back:
+
+            <% else %>
+              some values failed to rollback:
+
+            <% end %>
+
+            <% @written_states.each do |state| %>
+              <% if @rollback_errors[state] %>
+                <% state.key %>: <% @rollback_errors[state].format.indent(8) %>
+              <% else %>
+                <%= state.key %>: rolled back.
+              <% end %>
+            <% end %>
+          <% end %>
+          BLOCK
+      else
+        @written_states << state
+      end # begin / rescue / else
+    end # new_values.each
+
+    # ok, we made it. report the changes
+    new_values_hash = Hash[@new_values]
+    @written_states.each do |state|
+      @changes[[state.adapter.name, state.key]] = [@read_values[state], new_values_hash[state]]
+    end
+    
+    @changes
+  end # execute
+
+  private
+
+  def rollback
+    # go through the writes that were successfully made and try to
+    # reverse them
+    @written_states.reverse.each do |state|
+      # wrap in rescue so that we can record that the rollback failed
+      # for a value and continue
+      begin
+        state.adapter.write state.key, state.value, state.options
+      rescue Exception => e
+        # record when and why a rollback fails to include it in the
+        # exiting exception
+        @rollback_errors[state] = e
+      end
+    end
+  end # rollback
+end # class StateMate::StateSet

data/lib/state_mate/version.rb

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

data/state_mate.gemspec

@@ -28,8 +28,8 @@ END
   spec.add_development_dependency "redcarpet"
   spec.add_development_dependency "nrser-extras"
 
-  spec.add_dependency 'nrser', '~> 0.0', '>= 0.0.13'
+  spec.add_dependency 'nrser', '~> 0.0', '>= 0.0.29'
   spec.add_dependency 'CFPropertyList', '~> 2.3'
-  spec.add_dependency 'cmds', '~> 0.0', '>= 0.0.9'
+  spec.add_dependency 'cmds', '~> 0.0', '>= 0.2.4'
   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.9
+  version: 0.1.0
 platform: ruby
 authors:
 - nrser
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-27 00:00:00.000000000 Z
+date: 2018-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -103,7 +103,7 @@ dependencies:
         version: '0.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.13
+        version: 0.0.29
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -113,7 +113,7 @@ dependencies:
         version: '0.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.13
+        version: 0.0.29
 - !ruby/object:Gem::Dependency
   name: CFPropertyList
   requirement: !ruby/object:Gem::Requirement
@@ -137,7 +137,7 @@ dependencies:
         version: '0.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.9
+        version: 0.2.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -147,7 +147,7 @@ dependencies:
         version: '0.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.9
+        version: 0.2.4
 - !ruby/object:Gem::Dependency
   name: diffable_yaml
   requirement: !ruby/object:Gem::Requirement
@@ -185,9 +185,13 @@ files:
 - README.md
 - Rakefile
 - bin/console
+- bin/rake
+- bin/rspec
 - lib/state_mate.rb
 - lib/state_mate/adapters.rb
 - lib/state_mate/adapters/defaults.rb
+- lib/state_mate/adapters/file.rb
+- lib/state_mate/adapters/git/ignore.rb
 - lib/state_mate/adapters/git_config.rb
 - lib/state_mate/adapters/json.rb
 - lib/state_mate/adapters/launchd.rb
@@ -197,6 +201,7 @@ files:
 - lib/state_mate/adapters/time_machine.rb
 - lib/state_mate/adapters/yaml.rb
 - lib/state_mate/error.rb
+- lib/state_mate/state_set.rb
 - lib/state_mate/version.rb
 - notes/state-set-steps.md
 - state_mate.gemspec
@@ -220,7 +225,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.4
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: i heard it's meant to help you with your state, mate!