Refactor/deprecate ipc msgs (#63)

* Config: deprecate ipc message handling (#53)

* Readme: Change ipc message example to `hs` cli

* Config: fix typo in return value of config:validate() method, guard against toggling non-boolean setting, simplify conditional logic, cleanup formatting, fix typo in return variable name

Author: AdamWagner

README.md

@@ -170,7 +170,7 @@ Did the terminal window expand to cover the area previously occupied by Safari?
 If the icons are a bit too heavy for you, you can toggle minimalist mode by turning the icons off:
 
 ```sh
- echo ":toggle_appearance.show_icons:" | hs -m stackline-config
+hs -c 'stackline.config:toggle("appearance.showIcons")'
 ```
 
 

stackline/configmanager.lua

@@ -1,7 +1,7 @@
 -- https://github.com/erento/lua-schema-validation
 local log = hs.logger.new('sline.conf')
 log.setLogLevel('info')
-log.i("Loading module")
+log.i('Loading module')
 
 local M = {}
 
@@ -15,8 +15,8 @@ local is_color = v.is_table { -- {{{
     blue  = o(v.is_number()),
     alpha = o(v.is_number()),
 } -- }}}
-local function unknownTypeValidator(v) -- {{{
-    log.i("Not validating: ", schemaType)
+local function unknownTypeValidator(val) -- {{{
+    log.i('Not validating: ', val)
     return true
 end -- }}}
 
@@ -51,7 +51,7 @@ M.types = { -- {{{
     },
 } -- }}}
 
-local defaultOnChangeEvt = {    -- {{{
+local defaultOnChangeEvt = {   -- {{{
     __index = function() stackline.queryWindowState:start() end
 }  -- }}}
 
@@ -67,7 +67,7 @@ M.events = setmetatable({ -- {{{
         dynamicLuminosity = nil,
     },
     advanced = {
-        maxRefreshRate    = function() print('Needs implemented') end,
+        maxRefreshRate = function() print('Needs implemented') end,
     },
 }, defaultOnChangeEvt) -- }}}
 
@@ -108,39 +108,30 @@ M.schema = { -- {{{
 
 function M:getPathSchema(path) -- {{{
     local _type = u.getfield(path, self.schema) -- lookup type in schema
-    if not _type then
-        return false
-    end
+    if not _type then return false end
     local validator = self.types[_type].validator()
+
     return _type, validator
 end -- }}}
 
 function M.generateValidator(schemaType) -- {{{
-    if type(schemaType) == 'table' then
+    if type(schemaType)=='table' then -- recursively build validator
         local children = u.map(schemaType, M.generateValidator)
         log.d('validator children:\n', hs.inspect(children))
         return v.is_table(children)
-    else
-        log.i('schemaType:', schemaType)
-        return
-            M.types[schemaType] and M.types[schemaType].validator() -- returns a fn to be called with value to validate
-            or unknownTypeValidator -- unknown types are assumed-valid
     end
+
+    -- otherwise, return validation fn forgiven type
+    log.i('schemaType:', schemaType)
+    return M.types[schemaType]                  -- if schemaType is a known config type..
+            and M.types[schemaType].validator() -- then return validation fn
+            or unknownTypeValidator             -- otherwise, unknown types are assumed valid
 end -- }}}
 
 -- Config manager
 function M:init(conf) -- {{{
     log.i('Initializing configmanager…')
     self:validate(conf)
-    ipcConfigPort = hs.ipc.localPort('stackline-config',
-        function(_, msgID, msg)
-            if msgID == 900 then
-                return "version:2.0a" -- if this is not returned, *ipc msgs will NOT work*
-            elseif msgID == 500 then
-                self:handleMsg(msg)
-            end
-        end)
-
     self.__index = self
     return self
 end -- }}}
@@ -155,18 +146,17 @@ function M:validate(conf) -- {{{
         self.conf = conf
         self.autosuggestions = u.keys(u.flatten(self.conf))
     else
-        local invalidKeys = table.concat(u.keys(u.flatten(err)), ", ")
+        local invalidKeys = table.concat(u.keys(u.flatten(err)), ', ')
+        log.e('Invalid stackline config:\n', hs.inspect(err))
         hs.notify.new(nil, {
             title           = 'Invalid stackline config!',
-            subTitle        =  'invalid keys:' .. invalidKeys,
+            subTitle        = 'invalid keys:' .. invalidKeys,
             informativeText = 'Please refer to the default conf file.',
             withdrawAfter   = 10
         }):send()
-
-        log.e('Invalid stackline config:\n', hs.inspect(err))
     end
 
-    return valid, err
+    return isValid, err
 end -- }}}
 
 function M:autosuggest(path) -- {{{
@@ -178,7 +168,9 @@ function M:autosuggest(path) -- {{{
     local function asc(a, b)
         return a[1] < b[1]
     end
+
     table.sort(scores, asc)
+
     log.d(hs.inspect(scores))
 
     local result1, result2 = scores[1][2], scores[2][2] -- return the best 2 matches
@@ -189,15 +181,14 @@ function M:autosuggest(path) -- {{{
         informativeText = string.format('"%s" is not a default stackline config path', path),
         withdrawAfter = 10
     }):send()
-
 end -- }}}
 
 function M:getOrSet(path, val) -- {{{
-    if path == nil or val == nil then
-        return self:get(path)
-    else
+    if path and val then
         return self:set(path, val)
     end
+
+    return self:get(path)
 end -- }}}
 
 function M:get(path) -- {{{
@@ -221,93 +212,36 @@ function M:set(path, val) -- {{{
 
     if _type == nil then
         self:autosuggest(path)
-    else
-        local typedVal = self.types[_type].coerce(val)
-        local isValid, err = validator(typedVal)           -- validate val is appropriate type
-        log.d('\nval:', typedVal)
-        log.d('val type:', type(typedVal))
-        if isValid then
-            log.d('Setting', path, 'to', typedVal)
-            u.setfield(path, typedVal, self.conf)
-
-            local onChange = u.getfield(path, self.events, true)
-            if type(onChange) == 'function' then onChange() end
-        else
-            log.e(hs.inspect(err))
-        end
-        return self, val
+        return self
     end
 
-end -- }}}
+    local typedVal = self.types[_type].coerce(val)
+    local isValid, err = validator(typedVal)           -- validate val is appropriate type
 
-function M:toggle(key) -- {{{
-    local toggledVal = not self:get(key)
-    log.d('Toggling', key, 'from ', self:get(key), 'to ', toggledVal)
-    self:set(key, toggledVal)
-    return self
-end -- }}}
-
--- TODO: Add m:Increment(delta)
--- TODO: Add m:Decrement(delta)
+    log.d('\nval:', typedVal, '\nval type:', type(typedVal))
 
-function M:parseMsg(msg) -- {{{
-    local _, path, val = table.unpack(msg:split(':'))
-    path = path:gsub("_(.)", string.upper) -- convert snake_case to camelCase
-    log.d('path parsed from ipc port', path)
-
-    if type(val) == 'string' then
-        val = val:gsub("%W", "") -- remove all whitespace
+    if not isValid then
+        log.e(hs.inspect(err))
+        return self
     end
 
-    -- TODO: resolve 'chicken & egg' problem: need type to fully parse, need to fully parse to get type w/o error
-    -- local _type, validator = self:getPathSchema(path)
-
-    local parsedMsg = {
-        path      = path,
-        val       = val,
-        _type     = _type,
-        validator = validator,
-        isGet     = (path ~= nil) and (val == nil),
-        isSet     = (path ~= nil) and (val ~= nil),
-        isToggle  = path:match("toggle") ~= nil, -- TODO: add and _type == 'boolean' when todo above is complete
-    }
-
-    log.d('Parsed msg:\n', hs.inspect(parsedMsg))
+    log.d('Setting', path, 'to', typedVal)
 
-    return parsedMsg
-end -- }}}
+    u.setfield(path, typedVal, self.conf)
 
-function M:handleMsg(msg) -- {{{
-    log.d('msg', msg)
-    local m = self:parseMsg(msg)
-    log.d(m)
-
-    if m.isToggle then
-        log.d('isToggle')
-        local key = m.path
-            :gsub('toggle', '')        -- strip leading 'toggle'
-            :gsub("^%L", string.lower) -- lowercase 1st character
-        self:toggle(key)
-        return self:get(key)
-
-    elseif m.isSet then
-        log.d('isSet')
-        local _, setVal = self:set(m.path, m.val)
-        return setVal
-
-    elseif m.isGet then
-        log.d('isGet')
-        local val = self:get(m.path)
-        return val
+    local onChange = u.getfield(path, self.events, true)
+    if type(onChange) == 'function' then onChange() end
+    return self, val
 
-    else
-        log.e('Unparsable IPC message. Try:')
-        log.i( '    `echo ":toggle_appearance.show_icons:" | hs -m stackline-config"`')
-        log.i( '    `echo ":get_appearance.show_icons:" | hs -m stackline-config"`')
-    end
-
-    return "ok"
 end -- }}}
 
+function M:toggle(key) -- {{{
+    local val = self:get(key)
+    if type(val)~='boolean' then log.w(key, 'cannot be toggled because it is not boolean') end
+    local toggledVal = not val
+    log.d('Toggling', key, 'from ', val, 'to ', toggledVal)
+    self:set(key, toggledVal)
+    return self
+end -- }}}
 
 return M