state_mate 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4c226a8faea22d2b1e92ba9ec2b6a7e4bd05567d
-  data.tar.gz: 5a3aa7df4eaa5174c2da39cda349871f87d45d57
+  metadata.gz: 2a4c8ab3b912af529324511e027680f26fef9266
+  data.tar.gz: 19900ae7fbd3aca5d28530833af4417b3018f5a6
 SHA512:
-  metadata.gz: 9a5cd92203f92b5fecb9aaf63198c16d64936e151bbc5f7b050161121e6a6f7700045b9cb62cbe39deac7ceb1021e3852721829a459ba66c5f6c02409dffcac8
-  data.tar.gz: 9ba7d11e17927dd298e769d29692ee9257299fdde999b849549c1e7f739672cd9f8235fc3361a0decbeae6aa4f7440d7d49605c2068f9b1984c8f4217d3f3d02
+  metadata.gz: 725018a48c59f60532de69717380def4d25a7c1d93a14a3496f539877cf52c2dc30eb4885325f2e87fc373256afbe61f224219c3221d9661d81749f8138b069b
+  data.tar.gz: 9ebc8e8dfaf989dfaf951881bfbc608b1d2a35e7451764643fa5f1d8a219f12592c27856961c434299e3f158633e71592021eebba9fcec1a2bc36001e46a63e6

data/bin/console

@@ -1,7 +1,31 @@
 #!/usr/bin/env ruby
 
+require 'pathname'
+require 'fileutils'
+
 require "bundler/setup"
 require "state_mate"
+require 'nrser'
+require 'nrser/extras'
+
+using NRSER
+
+ROOT = NRSER.git_root __FILE__
+
+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.

data/lib/state_mate/adapters/nvram.rb

@@ -1,5 +1,5 @@
+require 'cmds'
 require 'nrser'
-require 'nrser/exec'
 
 using NRSER
 

data/lib/state_mate/adapters/pmset.rb

@@ -0,0 +1,336 @@
+require 'cmds'
+require 'nrser'
+require 'pp'
+
+using NRSER
+
+module StateMate; end
+module StateMate::Adapters; end
+
+module StateMate::Adapters::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
+  #
+  MODES = {
+    'Battery Power' => 'b',
+    'AC Power' => 'c',
+  }
+  
+  # a whitelist of settings to parse, since the output of `pmset -g custom`
+  # can include lines like
+  # 
+  #     Sleep On Power Button 1
+  # 
+  # which makes it hard to parse in general (spaces in key name and between
+  # key name and value).
+  # 
+  # from
+  #
+  # -   `man pmset
+  # -   <https://developer.apple.com/library/mac/documentation/Darwin/Reference/ManPages/man1/pmset.1.html>
+  # 
+  SETTINGS = [
+    # display sleep timer; replaces 'dim' argument in 10.4 (value in minutes,
+    # or 0 to disable)
+    'displaysleep',
+    
+    # disk spindown timer; replaces 'spindown' argument in 10.4 (value in 
+    # minutes, or 0 to dis-able)
+    'disksleep',
+    
+    # system sleep timer (value in minutes, or 0 to disable)
+    'sleep',
+    
+    # wake on ethernet magic packet (value = 0/1)
+    'womp',
+    
+    # wake on modem ring (value = 0/1)
+    'ring',
+    
+    # automatic restart on power loss (value = 0/1)
+    'autorestart',
+    
+    # wake the machine when the laptop lid (or clamshell) is opened
+    # (value = 0/1)
+    'lidwake',
+    
+    # wake the machine when power source (AC/battery) is changed (value = 0/1)
+    'acwake',
+    
+    # slightly turn down display brightness when switching to this power source
+    # (value = 0/1)
+    'lessbright',
+    
+    # display sleep will use an intermediate half-brightness state between full 
+    # brightness and fully off  (value = 0/1)
+    'halfdim',
+    
+    # use Sudden Motion Sensor to park disk heads on sudden changes in G force
+    # (value = 0/1)
+    'sms',
+    
+     # change hibernation mode. Please use caution. (value = integer)
+    'hibernatemode',
+    
+    # change hibernation image file location. Image may only be located on the 
+    # root volume. Please use caution. (value = path)
+    'hibernatefile',
+    
+    # prevent idle system sleep when any tty (e.g. remote login session) is 
+    # 'active'. A tty is 'inactive' only when its idle time exceeds the system 
+    # sleep timer. (value = 0/1)
+    'ttyskeepawake',          
+    
+    # this setting affects how OS X networking presents shared network services 
+    # during system sleep. This setting is not used by all platforms; changing 
+    # its value is unsupported.
+    # 
+    # ...so we won't support it
+    # 'networkoversleep',
+    
+    # Destroy File Vault Key when going to standby mode. By default File vault
+    # keys are retained even when system goes to standby. If the keys are
+    # destroyed, user will be prompted to enter the password while coming out
+    # of standby mode.(value: 1 - Destroy, 0 - Retain)
+    'destroyfvkeyonstandby',
+    
+    # Where supported, enabled per default as an implementation of Lot 6 to the 
+    # European Energy-related Products Directive. After sleeping for 
+    # <autopoweroffdelay> minutes, the system will write a hibernation image 
+    # and go into a lower power chipset sleep. Wakeups from this state will take
+    # longer than wakeups from regular sleep. The system will not auto power
+    # off if any external devices are connected, if the system is on battery 
+    # power, or if the system is bound to a network and wake for net-work
+    # network work access is enabled.
+    'autopoweroff',
+    
+    # delay before entering autopoweroff mode. (Value = integer, in minutes)
+    'autopoweroffdelay',
+    
+    # STANDBY ARGUMENTS
+    
+    # standby causes kernel power management to automatically hibernate a
+    # machine after it has slept for a specified time period. This saves power
+    # while asleep. This setting defaults to ON for supported hardware.
+    # The setting standby will be visible in pmset -g if the feature is 
+    # supported on this machine.
+    # 
+    # only works if hibernation is turned on to hibernatemode 3 or 25.
+    'standby', 
+    
+    # specifies the delay, in seconds, before writing the hibernation image
+    # to disk and powering off memory for Standby.
+    'standbydelay',
+    
+    # UNDOCUMENTED ARGUMENTS
+    
+    # the "Power Nap" feature..?
+    # 
+    # http://apple.stackexchange.com/questions/116348/how-can-i-enable-and-or-disable-os-xs-power-nap-feature-from-within-terminal
+    # 
+    'darkwakes',
+    
+    # unknown
+    # 'gpuswitch',
+    
+    # shows up on my imac. not even sure you can set it with pmset, so ignoring
+    # for now
+    # 'Sleep On Power Button',
+  ]
+  
+  # regexp to pick the mode headers out of `pmset -g custom` output
+  MODE_RE = /^(#{ MODES.keys.map {|_| Regexp.escape _ }.join('|') })\:$/
+  
+  # regexp to pick the settings and values out of other lines of
+  # `pmset -g custom`
+  SETTING_RE = /^\s(#{ SETTINGS.map {|_| Regexp.escape _ }.join '|' })\s+(.*)$/
+  
+  # @api util
+  # *pure*
+  # 
+  # parse the output of `pmset -g custom`.
+  # 
+  # since keys can apparently have spaces in them
+  # (like "Sleep On Power Button") and are seperated by spaces, it uses
+  # the {.SETTINGS} whitelist.
+  # 
+  # settings are saved at
+  # 
+  #     /Library/Preferences/SystemConfiguration/com.apple.PowerManagement.plist
+  # 
+  # which might be a possible site for reading and writing, but seems safer
+  # to use `pmset`, and should satify needs for now.
+  # 
+  # @param input [String] output of `pmset -g custom`.
+  #     on my mbp it looks like
+  #     
+  #         Battery Power:
+  #           lidwake              1
+  #           autopoweroff         1
+  #           autopoweroffdelay    14400
+  #           standbydelay         10800
+  #           standby              1
+  #           ttyskeepawake        1
+  #           hibernatemode        3
+  #           darkwakes            0
+  #           gpuswitch            2
+  #           hibernatefile        /var/vm/sleepimage
+  #           displaysleep         5
+  #           sleep                5
+  #           acwake               0
+  #           halfdim              1
+  #           lessbright           0
+  #           disksleep            10
+  #         AC Power:
+  #           lidwake              1
+  #           autopoweroff         0
+  #           autopoweroffdelay    0
+  #           standbydelay         0
+  #           standby              0
+  #           ttyskeepawake        1
+  #           hibernatemode        3
+  #           darkwakes            1
+  #           gpuswitch            0
+  #           hibernatefile        /var/vm/sleepimage
+  #           womp                 0
+  #           displaysleep         5
+  #           networkoversleep     0
+  #           sleep                10
+  #           acwake               0
+  #           halfdim              1
+  #           disksleep            10
+  # 
+  # @return [Hash<String, Hash<String, String>>] hash of section titles 
+  #     (like "Battery Power") to hashes of string keys to *sting* values
+  #     (does not turn numeric strings into integers).
+  def self.parse input
+    sections = {}
+    section = {}
+    
+    input.lines.each do |line|
+      if m = line.match(MODE_RE)
+        section = {}
+        sections[m[1]] = section
+      else
+        if m = line.match(SETTING_RE)
+          section[m[1]] = m[2]
+        end
+      end
+    end
+    sections
+  end
+  
+  # @api adapter
+  # 
+  # reads pm settings.
+  # 
+  # @param key [Array<String>] key path to read:
+  #     -   `[]` gets everything, returning a hash
+  #         `{<mode> => {<setting> => <value>}}`.
+  #         
+  #         `PMSet.read []` looks something like:
+  #         
+  #             {"Battery Power"=>
+  #               {"lidwake"=>"1",
+  #                "autopoweroff"=>"1",
+  #                ...},
+  #              "AC Power"=>
+  #               {"lidwake"=>"1",
+  #                "autopoweroff"=>"1",
+  #                ...}}
+  #     
+  #     
+  #     -   `[<mode>]` gets a hash of `{<setting> => <value>}` for that mode.
+  #         
+  #         `PMSet.read ["AC Power"]` looks something like:
+  #         
+  #             {"lidwake"=>"1",
+  #              "autopoweroff"=>"1",
+  #              ...}
+  #         
+  #     -   `[<mode>, <setting>]` gets a string value.
+  #         
+  #         `PMSet.read ["AC Power", "lidwake"]` looks something like `"1"`
+  # 
+  #     in addition
+  #     -     `<mode>` must be in the keys of {.MODES}
+  #     -     `<setting>` must be in {.SETTINGS}
+  # 
+  # @return [Hash<String, Hash<String, String>>] hash of everything when
+  #         `key` is `[]`
+  # @return [Hash<String, String>] hash of values for mode when `key` is
+  #         `[<mode>]`
+  # @return [String] value when `key` is `[<mode>, <setting>]`
+  # 
+  # @raise [ArgumentError] if the key is not found.
+  # 
+  def self.read key, options = {}
+    # read all the settings.
+    settings = parse Cmds.out!('pmset -g custom')
+    
+    value = settings
+    key.each do |seg|
+      unless value.key? seg
+        raise ArgumentError.new binding.erb <<-END
+          bad segment #{ seg.inspect } in key #{ key }.
+          
+          pm settings:
+          
+          <%= settings.pretty_inspect %>
+        END
+      end
+      value = value[seg]
+    end
+    
+    value
+  end
+  
+  # @api adapter
+  # 
+  # writes pm settings.
+  # 
+  # @param key [Array<String>] must be a two-element array of strings where
+  #     the first element is a key of {.MODES} and the second is in {.SETTINGS}.
+  # @param value [String] value to write.
+  # 
+  # @return nil
+  #
+  # @raise [ArgumentError] if `key` is bad.
+  # 
+  def self.write key, value, options = {}
+    unless key.is_a?(Array) && key.length == 2
+      raise ArgumentError.new binding.erb <<-END
+        key must be a pair [mode, setting], not <%= key.inspect %>.
+      END
+    end
+    
+    mode, setting = key
+    
+    if MODES[mode].nil?
+      raise ArgumentError.new binding.erb <<-END
+        first key element must be one of
+        
+        <%= MODES.keys.pretty_inspect %>
+        
+        found <%= mode.inspect %>
+      END
+    end
+    
+    unless SETTINGS.include? setting
+      raise ArgumentError.new binding.erb <<-END
+        second key element must be one of
+        
+        <%= SETTINGS.pretty_inspect %>
+        
+        found <%= setting.inspect %>
+      END
+    end
+    
+    Cmds! "sudo pmset -#{ MODES[mode] } %{setting} %{value}",
+      setting: setting,
+      value: value
+    
+    nil
+  end
+end # PMSet

data/lib/state_mate/version.rb

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

data/state_mate.gemspec

@@ -26,6 +26,7 @@ END
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "yard"
   spec.add_development_dependency "redcarpet"
+  spec.add_development_dependency "nrser-extras"
 
   spec.add_dependency 'nrser', '~> 0.0', '>= 0.0.13'
   spec.add_dependency 'CFPropertyList', '~> 2.3'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: state_mate
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - nrser
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-18 00:00:00.000000000 Z
+date: 2015-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: nrser-extras
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: nrser
   requirement: !ruby/object:Gem::Requirement
@@ -158,6 +172,7 @@ files:
 - lib/state_mate/adapters/json.rb
 - lib/state_mate/adapters/launchd.rb
 - lib/state_mate/adapters/nvram.rb
+- lib/state_mate/adapters/pmset.rb
 - lib/state_mate/adapters/scutil.rb
 - lib/state_mate/adapters/time_machine.rb
 - lib/state_mate/version.rb