Skip to content

[Fix #310,#311] clojure-expected-ns with src/cljc #312

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Merged
merged 1 commit into from
Jul 29, 2015
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@

### Bugs fixed

* [#310](https://github.com/clojure-emacs/clojure-mode/issues/310) and [#311](https://github.com/clojure-emacs/clojure-mode/issues/311) Fix `clojure-expected-ns` in multi-source projects.
* [#307](https://github.com/clojure-emacs/clojure-mode/issues/307): Don't highlight `handle` and `handler-case` as keywords.

## 4.1.0 (20/06/2015)
Expand Down
37 changes: 25 additions & 12 deletions clojure-mode.el
Original file line number Diff line number Diff line change
Expand Up @@ -979,18 +979,31 @@ nil."



(defun clojure-expected-ns ()
"Return the namespace name that the file should have."
(let* ((project-dir (file-truename
(or (locate-dominating-file default-directory
"project.clj")
(locate-dominating-file default-directory
"build.boot"))))
(relative (substring (file-truename (buffer-file-name))
(length project-dir)
(- (length (file-name-extension (buffer-file-name) t))))))
(replace-regexp-in-string
"_" "-" (mapconcat 'identity (cdr (split-string relative "/")) "."))))
(defun clojure-project-dir ()
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Turns out this implementation is problematic. See clojure-emacs/cider#1215

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This fix solves the problematic namespaces for 99.9% of affected projects. Let's solve one problem at a time?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I mentioned this mostly because if we have the same function here, there'll be little point in fixing the problem in cider. Anyways, that's not terribly important right now.

"Return the absolute path to the project's root directory."
(file-truename
(or (locate-dominating-file default-directory
"project.clj")
(locate-dominating-file default-directory
"build.boot"))))

(defun clojure-project-relative-path (path)
"Denormalize PATH by making it relative to the project root."
(file-relative-name path (clojure-project-dir)))

(defun clojure-expected-ns (&optional path)
"Return the namespace matching PATH.

PATH is expected to be an absolute file path.

If PATH is nil, use the path to the file backing the current buffer."
(let* ((relative (clojure-project-relative-path
(or path (file-truename (buffer-file-name)))))
(sans-file-type (substring relative 0 (- (length (file-name-extension path t)))))
(sans-file-sep (mapconcat 'identity (cdr (split-string sans-file-type "/")) "."))
(sans-underscores (replace-regexp-in-string "_" "-" sans-file-sep)))
;; Drop prefix from ns for projects with structure src/{clj,cljs,cljc}
(replace-regexp-in-string "\\`clj[scx]?\\." "" sans-underscores)))

(defun clojure-insert-ns-form-at-point ()
"Insert a namespace form at point."
Expand Down
53 changes: 53 additions & 0 deletions test/clojure-mode-util-test.el
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
;;; clojure-mode-util-test.el --- Clojure Mode: util test suite -*- lexical-binding: t; -*-

;; Copyright (C) 2014-2015 Bozhidar Batsov <bozhidar@batsov.com>

;; This file is not part of GNU Emacs.

;; This program is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.

;; This program is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with this program. If not, see <http://www.gnu.org/licenses/>.

;;; Commentary:

;; The unit test suite of Clojure Mode

;;; Code:
(require 'clojure-mode)
(require 'cl-lib)
(require 'ert)

(let ((project-dir "/home/user/projects/my-project/")
(clj-file-path "/home/user/projects/my-project/src/clj/my_project/my_ns/my_file.clj")
(project-relative-clj-file-path "src/clj/my_project/my_ns/my_file.clj")
(clj-file-ns "my-project.my-ns.my-file"))

(ert-deftest project-relative-path ()
:tags '(utils)
(cl-letf (((symbol-function 'clojure-project-dir) (lambda () project-dir)))
(should (string= (clojure-project-relative-path clj-file-path)
project-relative-clj-file-path))))

(ert-deftest expected-ns ()
:tags '(utils)
(cl-letf (((symbol-function 'clojure-project-relative-path)
(lambda (&optional current-buffer-file-name)
project-relative-clj-file-path)))
(should (string= (clojure-expected-ns clj-file-path) clj-file-ns)))))

(provide 'clojure-mode-util-test)

;; Local Variables:
;; indent-tabs-mode: nil
;; End:

;;; clojure-mode-util-test.el ends here