state_mate 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d0e071391d3536c0322d007eb5ada884ea4be93c
-  data.tar.gz: 265c2fd4a266933ac7b3b1625d08d354d61f5b3c
+  metadata.gz: 6355ffa118f223af88b6bef332d050d13e8c92b3
+  data.tar.gz: 9c003e9a2275ce30df419d0425740380bd698046
 SHA512:
-  metadata.gz: ae034a5e1cd34650c2b543915b9188114b40661cdd1c9e6f0ce3f3a5fced3171afcf770f032ca78f2167fa5f2318c42e5fae907c2fdca53cf1a170318d59eb84
-  data.tar.gz: 4485e1b99896113f80cd4ba65b5e3a3a4bd34ec7cf32ccd652f2f6821941b838c3d21b594ea0431d3c6fd1eff4eef1f79365afcd7465317275de7ba275ed9291
+  metadata.gz: 75855da6213f689af881a4241045fa865db8f17f8cf26a19b0fe920fee9325da0ba6e4971ad585887f04be59d369c1d57437478de3e1c03388154ac97172efdf
+  data.tar.gz: de8882e2f325ded54a07c7ec4c0d47c765bac082f740b6149a67167129e0da25c9484321d718548cf10f59daf34ce7610cd160cf1f6ede19f224d930cbfd64a7

data/.travis.yml

@@ -0,0 +1,12 @@
+before_install:
+  - gem update --system
+  - gem install bundler
+language: ruby
+os: osx
+rvm:
+  - 2.3.6
+  - 2.4.3
+  - 2.5.0
+script: bundle exec rspec
+sudo: true
+cache: bundler

data/README.md

@@ -1,5 +1,11 @@
 # StateMate
 
+[![Gem Version](http://img.shields.io/gem/v/state_mate.svg)][gem]
+[![Build Status](http://img.shields.io/travis/nrser/state_mate.svg)][travis]
+
+[gem]: https://rubygems.org/gems/state_mate
+[travis]: http://travis-ci.org/nrser/state_mate
+
 i heard it's meant to help you with your state, mate!
 
 ## Installation

data/lib/state_mate/adapters/pmset.rb

@@ -38,7 +38,7 @@ module StateMate::Adapters::PMSet
     # or 0 to disable)
     'displaysleep',
     
-    # disk spindown timer; replaces 'spindown' argument in 10.4 (value in 
+    # disk spindown timer; replaces 'spindown' argument in 10.4 (value in
     # minutes, or 0 to dis-able)
     'disksleep',
     
@@ -65,7 +65,7 @@ module StateMate::Adapters::PMSet
     # (value = 0/1)
     'lessbright',
     
-    # display sleep will use an intermediate half-brightness state between full 
+    # display sleep will use an intermediate half-brightness state between full
     # brightness and fully off  (value = 0/1)
     'halfdim',
     
@@ -76,17 +76,17 @@ module StateMate::Adapters::PMSet
      # change hibernation mode. Please use caution. (value = integer)
     'hibernatemode',
     
-    # change hibernation image file location. Image may only be located on the 
+    # 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 
+    # 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',          
+    'ttyskeepawake',
     
-    # this setting affects how OS X networking presents shared network services 
-    # during system sleep. This setting is not used by all platforms; changing 
+    # 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
@@ -98,12 +98,12 @@ module StateMate::Adapters::PMSet
     # 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 
+    # 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 
+    # 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',
@@ -116,14 +116,17 @@ module StateMate::Adapters::PMSet
     # 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 
+    # 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', 
+    'standby',
     
     # specifies the delay, in seconds, before writing the hibernation image
     # to disk and powering off memory for Standby.
+    # 
+    # NOTE  Not always present... at least not on Travis CI's OSX VMs
+    # 
     'standbydelay',
     
     # UNDOCUMENTED ARGUMENTS
@@ -149,6 +152,7 @@ module StateMate::Adapters::PMSet
   # `pmset -g custom`
   SETTING_RE = /^\s(#{ SETTINGS.map {|_| Regexp.escape _ }.join '|' })\s+(.*)$/
   
+  
   # @api util
   # *pure*
   # 
@@ -204,7 +208,7 @@ module StateMate::Adapters::PMSet
   #           halfdim              1
   #           disksleep            10
   # 
-  # @return [Hash<String, Hash<String, String>>] hash of section titles 
+  # @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
@@ -224,49 +228,60 @@ module StateMate::Adapters::PMSet
     sections
   end
   
+  
   # @api adapter
   # 
-  # reads pm settings.
+  # 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:
-  #         
+  # @param [Array<String>] key
+  #   Key path to read:
+  #   
+  #   -   `[]` gets everything, returning a hash
+  #       `{<mode> => {<setting> => <value>}}`.
+  #       
+  #       `PMSet.read []` looks something like:
+  #       
+  #           {"Battery Power"=>
   #             {"lidwake"=>"1",
   #              "autopoweroff"=>"1",
-  #              ...}
-  #         
-  #     -   `[<mode>, <setting>]` gets a string value.
-  #         
-  #         `PMSet.read ["AC Power", "lidwake"]` looks something like `"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}
+  # 
+  # @param [Hash] options
+  #   Unused (part of adapter `.read` method signature).
   # 
-  #     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, 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>]`
+  # @return [Hash<String, String>]
+  #   Hash of values for mode when `key` is `[<mode>]`.
   # 
-  # @raise [ArgumentError] if the key is not found.
+  # @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.
@@ -289,6 +304,7 @@ module StateMate::Adapters::PMSet
     value
   end
   
+  
   # @api adapter
   # 
   # writes pm settings.

data/lib/state_mate/version.rb

@@ -1,3 +1,3 @@
 module StateMate
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: state_mate
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - nrser
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-28 00:00:00.000000000 Z
+date: 2018-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -159,6 +159,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".travis.yml"
 - ".yardopts"
 - Gemfile
 - LICENSE.txt