text: # -*- coding: utf-8 -*-
  '''
  Homebrew for Mac OS X
  '''
  
  # Import python libs
  import copy
  import logging
  
  # Import salt libs
  import salt.utils
  from salt.exceptions import CommandExecutionError, MinionError
  
  log = logging.getLogger(__name__)
  
  # Define the module's virtual name
  __virtualname__ = 'pkg'
  
  
  def __virtual__():
      '''
      Confine this module to Mac OS with Homebrew.
      '''
  
      if salt.utils.which('brew') and __grains__['os'] == 'MacOS':
          return __virtualname__
      return False
  
  
  def _list_taps():
      '''
      List currently installed brew taps
      '''
      cmd = 'brew tap'
      return __salt__['cmd.run'](cmd, output_loglevel='trace').splitlines()
  
  
  def _tap(tap, runas=None):
      '''
      Add unofficial Github repos to the list of formulas that brew tracks,
      updates, and installs from.
      '''
      if tap in _list_taps():
          return True
  
      cmd = 'brew tap {0}'.format(tap)
      if __salt__['cmd.retcode'](cmd, runas=runas):
          log.error('Failed to tap "{0}"'.format(tap))
          return False
  
      return True
  
  
  def _homebrew_bin():
      '''
      Returns the full path to the homebrew binary in the PATH
      '''
      ret = __salt__['cmd.run']('brew --prefix', output_loglevel='trace')
      ret += '/bin/brew'
      return ret
  
  
  def list_pkgs(versions_as_list=False, **kwargs):
      '''
      List the packages currently installed in a dict::
  
          {'<package_name>': '<version>'}
  
      CLI Example:
  
      .. code-block:: bash
  
          salt '*' pkg.list_pkgs
      '''
      versions_as_list = salt.utils.is_true(versions_as_list)
      # not yet implemented or not applicable
      if any([salt.utils.is_true(kwargs.get(x))
              for x in ('removed', 'purge_desired')]):
          return {}
  
      if 'pkg.list_pkgs' in __context__:
          if versions_as_list:
              return __context__['pkg.list_pkgs']
          else:
              ret = copy.deepcopy(__context__['pkg.list_pkgs'])
              __salt__['pkg_resource.stringify'](ret)
              return ret
  
      cmd = 'brew list --versions'
      ret = {}
      out = __salt__['cmd.run'](cmd, output_loglevel='trace')
      for line in out.splitlines():
          try:
              name_and_versions = line.split(' ')
              name = name_and_versions[0]
              installed_versions = name_and_versions[1:]
              newest_version = sorted(installed_versions, cmp=salt.utils.version_cmp).pop()
          except ValueError:
              continue
          __salt__['pkg_resource.add_pkg'](ret, name, newest_version)
  
      __salt__['pkg_resource.sort_pkglist'](ret)
      __context__['pkg.list_pkgs'] = copy.deepcopy(ret)
      if not versions_as_list:
          __salt__['pkg_resource.stringify'](ret)
      return ret
  
  
  def version(*names, **kwargs):
      '''
      Returns a string representing the package version or an empty string if not
      installed. If more than one package name is specified, a dict of
      name/version pairs is returned.
  
      CLI Example:
  
      .. code-block:: bash
  
          salt '*' pkg.version <package name>
          salt '*' pkg.version <package1> <package2> <package3>
      '''
      return __salt__['pkg_resource.version'](*names, **kwargs)
  
  
  def latest_version(*names, **kwargs):
      '''
      Return the latest version of the named package available for upgrade or
      installation
  
      Note that this currently not fully implemented but needs to return
      something to avoid a traceback when calling pkg.latest.
  
      CLI Example:
  
      .. code-block:: bash
  
          salt '*' pkg.latest_version <package name>
          salt '*' pkg.latest_version <package1> <package2> <package3>
      '''
      refresh = salt.utils.is_true(kwargs.pop('refresh', True))
  
      if refresh:
          refresh_db()
  
      if len(names) <= 1:
          return ''
      else:
          ret = {}
          for name in names:
              ret[name] = ''
          return ret
  
  # available_version is being deprecated
  available_version = latest_version
  
  
  def remove(name=None, pkgs=None, **kwargs):
      '''
      Removes packages with ``brew uninstall``.
  
      name
          The name of the package to be deleted.
  
  
      Multiple Package Options:
  
      pkgs
          A list of packages to delete. Must be passed as a python list. The
          ``name`` parameter will be ignored if this option is passed.
  
      .. versionadded:: 0.16.0
  
  
      Returns a dict containing the changes.
  
      CLI Example:
  
      .. code-block:: bash
  
          salt '*' pkg.remove <package name>
          salt '*' pkg.remove <package1>,<package2>,<package3>
          salt '*' pkg.remove pkgs='["foo", "bar"]'
      '''
      try:
          pkg_params = __salt__['pkg_resource.parse_targets'](
              name, pkgs, **kwargs
          )[0]
      except MinionError as exc:
          raise CommandExecutionError(exc)
  
      old = list_pkgs()
      targets = [x for x in pkg_params if x in old]
      if not targets:
          return {}
      cmd = 'brew uninstall {0}'.format(' '.join(targets))
      __salt__['cmd.run'](cmd, output_loglevel='trace')
      __context__.pop('pkg.list_pkgs', None)
      new = list_pkgs()
      return salt.utils.compare_dicts(old, new)
  
  
  def refresh_db():
      '''
      Update the homebrew package repository.
  
      CLI Example:
  
      .. code-block:: bash
  
          salt '*' pkg.refresh_db
      '''
      cmd = 'brew update'
      user = __salt__['file.get_user'](_homebrew_bin())
  
      if __salt__['cmd.retcode'](cmd, runas=user):
          log.error('Failed to update')
          return False
  
      return True
  
  
  def install(name=None, pkgs=None, taps=None, options=None, **kwargs):
      '''
      Install the passed package(s) with ``brew install``
  
      name
          The name of the formula to be installed. Note that this parameter is
          ignored if "pkgs" is passed.
  
          CLI Example:
  
          .. code-block:: bash
  
              salt '*' pkg.install <package name>
  
      taps
          Unofficial Github repos to use when updating and installing formulas.
  
          CLI Example:
  
          .. code-block:: bash
  
              salt '*' pkg.install <package name> tap='<tap>'
              salt '*' pkg.install zlib taps='homebrew/dupes'
              salt '*' pkg.install php54 taps='["josegonzalez/php", "homebrew/dupes"]'
  
      options
          Options to pass to brew. Only applies to initial install. Due to how brew
          works, modifying chosen options requires a full uninstall followed by a
          fresh install. Note that if "pkgs" is used, all options will be passed
          to all packages. Unrecognized options for a package will be silently
          ignored by brew.
  
          CLI Example:
  
          .. code-block:: bash
  
              salt '*' pkg.install <package name> tap='<tap>'
              salt '*' pkg.install php54 taps='["josegonzalez/php", "homebrew/dupes"]' options='["--with-fpm"]'
  
      Multiple Package Installation Options:
  
      pkgs
          A list of formulas to install. Must be passed as a python list.
  
          CLI Example:
  
          .. code-block:: bash
  
              salt '*' pkg.install pkgs='["foo","bar"]'
  
  
      Returns a dict containing the new package names and versions::
  
          {'<package>': {'old': '<old-version>',
                         'new': '<new-version>'}}
  
      CLI Example:
  
      .. code-block:: bash
  
          salt '*' pkg.install 'package package package'
      '''
      try:
          pkg_params, pkg_type = __salt__['pkg_resource.parse_targets'](
              name, pkgs, kwargs.get('sources', {})
          )
      except MinionError as exc:
          raise CommandExecutionError(exc)
  
      if pkg_params is None or len(pkg_params) == 0:
          return {}
  
      formulas = ' '.join(pkg_params)
      old = list_pkgs()
      user = __salt__['file.get_user'](_homebrew_bin())
  
      # Ensure we've tapped the repo if necessary
      if taps:
          if not isinstance(taps, list):
              # Feels like there is a better way to allow for tap being
              # specified as both a string and a list
              taps = [taps]
  
          for tap in taps:
              if user != __opts__['user']:
                  _tap(tap, runas=user)
              else:
                  _tap(tap)
  
      if options:
          cmd = 'brew install {0} {1}'.format(formulas, ' '.join(options))
      else:
          cmd = 'brew install {0}'.format(formulas)
  
      __salt__['cmd.run'](
          cmd,
          runas=user if user != __opts__['user'] else None,
          output_loglevel='trace'
      )
      __context__.pop('pkg.list_pkgs', None)
      new = list_pkgs()
      return salt.utils.compare_dicts(old, new)
  
  
  def list_upgrades():
      '''
      Check whether or not an upgrade is available for all packages
  
      CLI Example:
  
      .. code-block:: bash
  
          salt '*' pkg.list_upgrades
      '''
      cmd = 'brew outdated'
  
      return __salt__['cmd.run'](cmd, output_loglevel='trace').splitlines()
  
  
  def upgrade_available(pkg):
      '''
      Check whether or not an upgrade is available for a given package
  
      CLI Example:
  
      .. code-block:: bash
  
          salt '*' pkg.upgrade_available <package name>
      '''
      return pkg in list_upgrades()
  
  
  def upgrade(refresh=True):
      '''
      Upgrade outdated, unpinned brews.
  
      refresh
          Fetch the newest version of Homebrew and all formulae from GitHub before installing.
  
      Return a dict containing the new package names and versions::
  
          {'<package>': {'old': '<old-version>',
                         'new': '<new-version>'}}
  
      CLI Example:
  
      .. code-block:: bash
  
          salt '*' pkg.upgrade
      '''
      old = list_pkgs()
  
      if salt.utils.is_true(refresh):
          refresh_db()
  
      cmd = 'brew upgrade'
      user = __salt__['file.get_user'](_homebrew_bin())
      __salt__['cmd.run'](
          cmd,
          runas=user if user != __opts__['user'] else __opts__['user'],
          output_loglevel='trace'
      )
  
      __context__.pop('pkg.list_pkgs', None)
      new = list_pkgs()
      return salt.utils.compare_dicts(old, new)
  