Order of company candidates is lost

[ag91]

Hey, thanks for maintaining this repo.

I wonder how this wasn't raised before, but helm-company stores company-candidates strings in a hash-table.
Elisp hash tables are unordered, so (hash-table-keys helm-company-display-candidates-hash) applies a random order to the list of completions.

I finally managed to find the issue today and this is my fix:

    (defvar my/sorted-candidates-display-str nil)

    (defun helm-company--make-display-candidate-hash (candidates)
      (let ((hash (make-hash-table :test 'equal :size 1000)))
        (setq my/sorted-candidates-display-str nil)
        (cl-loop for candidate in candidates
                 for annot = (helm-company--get-annotations candidate)
                 for display-str = (helm-company--make-display-string candidate annot)
                 for key = (substring-no-properties display-str)
                 do (progn
                      (add-to-list 'my/sorted-candidates-display-str display-str 'append)
                      (puthash key (cons display-str candidate) hash)))
        hash))

    (defun helm-company-get-display-strings ()
      (let ((sort (null helm--in-fuzzy))
            (display-strs my/sorted-candidates-display-str))
        (if sort
            (sort display-strs #'helm-generic-sort-fn)
          display-strs)))
    )

Hope this helps