Added function sly-import-symbol-at-point to add import-from into thecurrent defpackage form #147

svetlyak40wt · 2018-02-14T06:28:50Z

This function is bound to C-c i by default, and using it, you can easily simplify
your code by moving package prefixes into the defpackage form.

Here is a demo:

https://youtu.be/pZ72_hI4Tcw

… current defpackage form. This function is bound to C-c i by default, and using it, you can easily simplify your code by moving package prefixes into the defpackage form.

joaotavora · 2018-02-14T08:52:52Z

Demo looks good, code also looks good from glancing. I'll try to review it thoroughly tonight or over the weekend at the most

svetlyak40wt · 2018-02-14T11:55:35Z

Thank you.

joaotavora

Great functionality but code must be cleaned up before merging. After the cleanup a NEWS entry should be added (I can do that).

joaotavora · 2018-02-14T12:30:54Z

contrib/sly-package-fu.el

+  "This function is applied to a package name before
+   it is inserted into the defpackage form.
+
+   By default, it is an 'identity, but you may wish


I don't follow completely here. This is used in the import-from form right? If so, then changing the package name from one convention to another would actually create an error in the code, unless the original package:symbol designation on which I pressed C-x i was already erroneous.

So unless, I'm missing something, I think this functionality is orthogonal to this PR and should be discussed separately.

I've used this feature to replace dots with slashes during refactoring of a large system to package-inferred-system. It was very convenient to automatically replace dots with slashes when creating import-from form.

Here how I've setup this variable in my config:

(setq sly-import-symbol-package-transform-function (lambda (package) (replace-regexp-in-string "\\." "/" package)))

joaotavora · 2018-02-14T12:34:36Z

contrib/sly-package-fu.el

@@ -144,9 +155,12 @@ places the cursor at the start of the DEFPACKAGE form."
                                 (1+ (point))
                               (point))))))))))))

-(defun sly-export-symbols ()
+(defun sly-read-symbols ()


Please rename this to sly-package-fu--read-symbols and tweak the docstring to state that it reads a list of symbols following point and is intended to be used inside defpackage forms that list symbols.

joaotavora · 2018-02-14T12:34:48Z

contrib/sly-package-fu.el

@@ -144,9 +155,12 @@ places the cursor at the start of the DEFPACKAGE form."
                                 (1+ (point))
                               (point))))))))))))

-(defun sly-export-symbols ()
+(defun sly-read-symbols ()
  "Return a list of symbols inside :export clause of a defpackage."
  ;; Assumes we're at the beginning of :export


Is this assumption still valid?

No, this function is generic and can be used inside of any s-exp. So, I've removed the comment.

joaotavora · 2018-02-14T12:36:40Z

contrib/sly-package-fu.el

@@ -155,20 +169,21 @@ places the cursor at the start of the DEFPACKAGE form."
    (save-excursion
      (cl-loop for sexp = (read-sexp) while sexp collect sexp))))

+(defun sly-package-normalize-name (name)


It's a good idea to reuse this code in a function, but please rename it sly-package-fu--normalize-name to comply with emacs lisp coding practices.

joaotavora · 2018-02-14T12:37:23Z

contrib/sly-package-fu.el

+;; Dealing with import-from
+;;
+;; MELPA version: (buffer-substring-no-properties point1 pount2)
+;; ~/.emacs.d/elpa/sly-20171111.1604/contrib/sly-package-fu.el


I can't understand these two lines of comments

Sorry, I've removed this junk :)

joaotavora · 2018-02-14T12:51:37Z

contrib/sly-package-fu.el

+
+
+(defun sly-import-symbol-from (symbol)
+  "Accepts "


This docstring could see some work. :-) Explain in one sentence less than 70chars what the function does. Like "Inserts SYMBOL at the correct :import-from sexp".

joaotavora · 2018-02-14T12:55:19Z

contrib/sly-package-fu.el

+
+     ;; We only process symbols in fully qualified form like
+     ;; weblocks/request:get-parameter
+     (when package


Perhaps its useful, instead of when package to issue an error or an user-error. Like

(unless package (user-error "Can't guess the package designator of %s" symbol))

joaotavora · 2018-02-14T12:56:06Z

contrib/sly-package-fu.el

+               ;; If symbol is not imported yet, then just
+               ;; add it to the end
+               ;; TODO: rename function
+               (sly-insert-export simple-symbol)))


Yes, rename the function to sly-package-fu--insert-symbol and update all its users.

joaotavora · 2018-02-14T12:57:54Z

contrib/sly-package-fu.el

+           ;; Now, remove symbol at the point from the buffer
+           (delete-region (point)
+                          (+ (point)
+                             (length symbol-name)))


I think its clearer and more readable to use the left-bound and right-bound variables established earlier.

Oh, no, this does not work, because when we insert :import-from form, left-bound and right-bound become obsolete.

So, I've returned back (point) usage.

Then use markers instead.

joaotavora · 2018-02-14T13:00:03Z

sly.el

@@ -7077,10 +7077,10 @@ The result is unspecified if there isn't a symbol under the point."
  "Return the bounds of the symbol around point.
 The returned bounds are either nil or non-empty."
  (let ((bounds (bounds-of-thing-at-point 'sly-symbol)))
-    (if (and bounds


This change is merely cosmetic if I understand correctly. Leave it out of this PR (if you want, submit it in another one)...

Returned if.

joaotavora · 2018-03-09T13:02:37Z

Hi @svetlyak40wt, It's been a while since you proposed this. Do you agree with the proposed changes?

I like this feature and think it would be quite useful, but I need to maintain some coding standards for maintainability.

svetlyak40wt · 2018-03-10T22:06:33Z

@joaotavora I'm agree and will make all fixes soon. Just too busy.

joaotavora · 2018-04-05T13:34:50Z

@svetlyak40wt ping? If you prefer, I can make the fixes myself (but I'll basically be rewriting your contribution)

svetlyak40wt · 2018-04-05T16:23:50Z

@joaotavora will try to fix everything within few days.

… and given detailed docstring.

…-import-from.

…ces.

…e-fu--create-new-import-from.

…-update-import-from-form and given proper docstring.

…ackage designator.

svetlyak40wt · 2018-04-09T06:59:27Z

@joaotavora please, take a look. I've made the requested changes.

joaotavora · 2018-04-09T07:27:18Z

Looks much better, just a couple of nitpicks left, which I can fix if you can't find the time.

Regarding the transformation function, I'll try to understand what package-inferred-system is and get back to you. If there variable makes sense, then it probably should get a new name, too.

svetlyak40wt · 2018-04-09T12:59:12Z

Package inferred system, is a system where you may to not include all source files into the my-system.asd file. ASDF will infer all components and their dependencies from defpackage's use and import-from forms.

Also, when using package inferred system definition, you use "one package per file", having defpackage at the beginning of each file. And for big projects, package names should repeat a filestructure, like "app/db/models/user". This way, when you are referring to a symbols imported from :app/db/models/user, asdf will know where to find a source for this package.

I've created this pull, when working on large refactoring of the Weblocks. Before refactoring I also have had on package per file, but used dots as delimiters. That is why I decided to add a sly-import-symbol-package-transform-function to replace dots with slashes.

May be it is good idea to rename this variable into the sly-import-symbol-package-transform-function to sly-import-from-package-symbol-representation-function to make it more similar to sly-export-symbol-representation-function.

svetlyak40wt · 2018-04-09T15:36:23Z

Interesting, after I've removed comment, Travis build failed for two configurations.

* contrib/sly-package-fu.el (sly-import-symbol-package-transform-function) (sly-package-fu--read-symbols): Tweak docstring. (sly-package-fu--normalize-name): Rename from sly-package-normalize-name. Fix indentation. (sly-package-fu--read-symbols): Fix indentation. (sly-defpackage-exports): Use sly-package-fu--normalize-name. Fix indentation. (sly-package-fu--search-import-from): Use sly-package-fu--normalize-name (sly-package-fu--add-or-update-import-from-form): Tweak docstring. (sly-import-symbol-at-point): Tweak docstring. Simplify.

This makes it more on par with sly-export-symbol at point. Also saves the file if sly-package-fu-save-file is non nil. Also mention this feature in NEWS.md. * NEWS.md: Mention sly-import-symbol-at-point * contrib/sly-package-fu.el (sly-package-fu--add-or-update-import-from-form): Actually import the symbol and save the file according to sly-package-fu-save-file. (sly-package-fu-save-file): New variable. (sly-export-save-file): Obsolete alias for sly-package-fu-save-file. * contrib/slynk-package-fu.lisp (import-symbol-for-emacs): New slyfun.

joaotavora · 2018-04-11T23:29:25Z

So I merged this and added a few tweaks and improvements. Most notably, the symbol is now actually imported by CL just as in C-c e. Please try it out and tell me what you think.

And finally a big thank you!

Added function sly-import-symbol-at-point to add import-from into the…

f9d492e

… current defpackage form. This function is bound to C-c i by default, and using it, you can easily simplify your code by moving package prefixes into the defpackage form.

joaotavora requested changes Feb 14, 2018

View reviewed changes

svetlyak40wt added 10 commits April 9, 2018 08:25

Function sly-read-symbols was renamed to sly-package-fu--read-symbols…

28cbb41

… and given detailed docstring.

Removed junk comment.

4db0058

Function sly-search-import-from was renamed to sly-package-fu--search…

33bf5c2

…-import-from.

Removed unused definitions for sly-package-write-imported and get-pie…

e85ae69

…ces.

Function sly-package-create-new-import-from was renamed to sly-packag…

e012b5a

…e-fu--create-new-import-from.

Function sly-import-symbol-from was renamed to sly-package-fu--add-or…

7c2d179

…-update-import-from-form and given proper docstring.

Now we raise user-error when function is called on a symbol without p…

c002a07

…ackage designator.

Function sly-insert-export was renamed to sly-package-fu--insert-symbol.

16d7d34

Returned back if instead of when.

28b567d

Fixed formatting in sly.el.

efcbe24

Removed TODO comment.

cbea653

joaotavora merged commit c53e699 into joaotavora:master Apr 11, 2018

joaotavora mentioned this pull request Jul 6, 2020

Add import-symbol-at-point to package-fu slime/slime#573

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added function sly-import-symbol-at-point to add import-from into thecurrent defpackage form #147

Added function sly-import-symbol-at-point to add import-from into thecurrent defpackage form #147

svetlyak40wt commented Feb 14, 2018 •

edited

Loading

joaotavora commented Feb 14, 2018

svetlyak40wt commented Feb 14, 2018

joaotavora left a comment

joaotavora Feb 14, 2018

svetlyak40wt Apr 9, 2018

joaotavora Feb 14, 2018

svetlyak40wt Apr 9, 2018

joaotavora Feb 14, 2018

svetlyak40wt Apr 9, 2018

joaotavora Feb 14, 2018

joaotavora Feb 14, 2018

svetlyak40wt Apr 9, 2018

joaotavora Feb 14, 2018

joaotavora Feb 14, 2018

svetlyak40wt Apr 9, 2018

joaotavora Feb 14, 2018

svetlyak40wt Apr 9, 2018

joaotavora Feb 14, 2018

svetlyak40wt Apr 9, 2018

svetlyak40wt Apr 9, 2018

joaotavora Apr 9, 2018

joaotavora Feb 14, 2018

svetlyak40wt Apr 9, 2018

joaotavora commented Mar 9, 2018

svetlyak40wt commented Mar 10, 2018

joaotavora commented Apr 5, 2018

svetlyak40wt commented Apr 5, 2018

svetlyak40wt commented Apr 9, 2018

joaotavora commented Apr 9, 2018

svetlyak40wt commented Apr 9, 2018

svetlyak40wt commented Apr 9, 2018

joaotavora commented Apr 11, 2018

Added function sly-import-symbol-at-point to add import-from into thecurrent defpackage form #147

Added function sly-import-symbol-at-point to add import-from into thecurrent defpackage form #147

Conversation

svetlyak40wt commented Feb 14, 2018 • edited Loading

joaotavora commented Feb 14, 2018

svetlyak40wt commented Feb 14, 2018

joaotavora left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

joaotavora commented Mar 9, 2018

svetlyak40wt commented Mar 10, 2018

joaotavora commented Apr 5, 2018

svetlyak40wt commented Apr 5, 2018

svetlyak40wt commented Apr 9, 2018

joaotavora commented Apr 9, 2018

svetlyak40wt commented Apr 9, 2018

svetlyak40wt commented Apr 9, 2018

joaotavora commented Apr 11, 2018

svetlyak40wt commented Feb 14, 2018 •

edited

Loading