renaming of ob-sh to ob-shell

renaming of ob-sh to ob-shell

[Nicolas Richard]

[-- Attachment #1: Type: text/plain, Size: 374 bytes --]

Hello,

The commit 80754a8 says "updated names in test-ob-shell" but it
reintroduced the file test-ob-sh.el which was renamed in the parent of
that commit.

I attach a patch which changs that and various other things related to
the renaming, namely : the customize interface, the README, and a change
in org-test (the one mentionned in <87a9et6mzz.fsf@gmail.com> I guess).


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: patch --]
[-- Type: text/x-diff, Size: 5962 bytes --]

From 8351ad5f1b94ba0ca7768a1d765df1248645fbf4 Mon Sep 17 00:00:00 2001
From: Nicolas Richard <theonewiththeevillook@yahoo.fr>
Date: Fri, 31 Jan 2014 17:02:03 +0100
Subject: [PATCH] Renaming of ob-sh to ob-shell: various fixes

* lisp/org.el (org-babel-load-languages):
* testing/org-test.el:
* testing/README: change 'sh' to 'shell'

* testing/lisp/test-ob-sh.el: re-rename test file (fixes 80754a8)
---
 lisp/org.el                   |  2 +-
 testing/README                |  2 +-
 testing/lisp/test-ob-sh.el    | 52 -------------------------------------------
 testing/lisp/test-ob-shell.el | 15 +++++++------
 testing/org-test.el           |  2 +-
 5 files changed, 11 insertions(+), 62 deletions(-)
 delete mode 100644 testing/lisp/test-ob-sh.el

diff --git a/lisp/org.el b/lisp/org.el
index 20dcb92..5158678 100644
--- a/lisp/org.el
+++ b/lisp/org.el
@@ -275,7 +275,7 @@ requirements) is loaded."
 		 (const :tag "Scala" scala)
 		 (const :tag "Scheme" scheme)
 		 (const :tag "Screen" screen)
-		 (const :tag "Shell Script" sh)
+		 (const :tag "Shell Script" shell)
 		 (const :tag "Shen" shen)
 		 (const :tag "Sql" sql)
 		 (const :tag "Sqlite" sqlite)
diff --git a/testing/README b/testing/README
index e25a109..c7e352b 100644
--- a/testing/README
+++ b/testing/README
@@ -24,7 +24,7 @@ Also note that many of the current tests uses babel evaluation...
         -l lisp/org-id.el -l testing/org-test.el \
         --eval "(progn (org-reload) (setq org-confirm-babel-evaluate nil) \
         (org-babel-do-load-languages 'org-babel-load-languages \
-        '((emacs-lisp . t) (sh . t) (org . t))))" \
+        '((emacs-lisp . t) (shell . t) (org . t))))" \
         -f org-test-run-batch-tests
 #+END_SRC
 
diff --git a/testing/lisp/test-ob-sh.el b/testing/lisp/test-ob-sh.el
deleted file mode 100644
index 09278e7..0000000
--- a/testing/lisp/test-ob-sh.el
+++ /dev/null
@@ -1,52 +0,0 @@
-;;; test-ob-shell.el
-
-;; Copyright (c) 2010-2014 Eric Schulte
-;; Authors: Eric Schulte
-
-;; 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/>.
-
-;;; Comment:
-
-;; Template test file for Org-mode tests
-
-;;; Code:
-(org-test-for-executable "sh")
-(unless (featurep 'ob-shell)
-  (signal 'missing-test-dependency "Support for Shell code blocks"))
-
-(ert-deftest test-ob-shell/dont-insert-spaces-on-expanded-bodies ()
-  "Expanded shell bodies should not start with a blank line
-unless the body of the tangled block does."
-  (should-not (string-match "^[\n\r][\t ]*[\n\r]"
-			    (org-babel-expand-body:generic "echo 2" '())))
-  (should (string-match "^[\n\r][\t ]*[\n\r]"
-			(org-babel-expand-body:generic "\n\necho 2" '()))))
-
-(ert-deftest test-ob-shell/dont-error-on-empty-results ()
-  "Was throwing an elisp error when shell blocks threw errors and
-returned empty results."
-  (should (null (org-babel-execute:sh "ls NoSuchFileOrDirectory.txt" nil))))
-
-(ert-deftest test-ob-shell/session ()
-  "This also tests `org-babel-comint-with-output' in
-ob-comint.el, which was not previously tested."
-  (let ((res (org-babel-execute:sh "echo 1; echo 2" '((:session . "yes")))))
-    (should res)
-    (should (listp res))))
-
-(provide 'test-ob-shell)
-
-;;; test-ob-shell.el ends here
diff --git a/testing/lisp/test-ob-shell.el b/testing/lisp/test-ob-shell.el
index 87e2a95..2b3e48f 100644
--- a/testing/lisp/test-ob-shell.el
+++ b/testing/lisp/test-ob-shell.el
@@ -1,4 +1,4 @@
-;;; test-ob-sh.el
+;;; test-ob-shell.el
 
 ;; Copyright (c) 2010-2014 Eric Schulte
 ;; Authors: Eric Schulte
@@ -25,9 +25,9 @@
 ;;; Code:
 (org-test-for-executable "sh")
 (unless (featurep 'ob-shell)
-  (signal 'missing-test-dependency "Support for Sh code blocks"))
+  (signal 'missing-test-dependency "Support for Shell code blocks"))
 
-(ert-deftest test-ob-sh/dont-insert-spaces-on-expanded-bodies ()
+(ert-deftest test-ob-shell/dont-insert-spaces-on-expanded-bodies ()
   "Expanded shell bodies should not start with a blank line
 unless the body of the tangled block does."
   (should-not (string-match "^[\n\r][\t ]*[\n\r]"
@@ -35,18 +35,19 @@ unless the body of the tangled block does."
   (should (string-match "^[\n\r][\t ]*[\n\r]"
 			(org-babel-expand-body:generic "\n\necho 2" '()))))
 
-(ert-deftest test-ob-sh/dont-error-on-empty-results ()
+(ert-deftest test-ob-shell/dont-error-on-empty-results ()
   "Was throwing an elisp error when shell blocks threw errors and
 returned empty results."
   (should (null (org-babel-execute:sh "ls NoSuchFileOrDirectory.txt" nil))))
 
-(ert-deftest test-ob-sh/session ()
+(ert-deftest test-ob-shell/session ()
   "This also tests `org-babel-comint-with-output' in
 ob-comint.el, which was not previously tested."
   (let ((res (org-babel-execute:sh "echo 1; echo 2" '((:session . "yes")))))
     (should res)
     (should (listp res))))
 
-(provide 'test-ob-sh)
 
-;;; test-ob-sh.el ends here
+(provide 'test-ob-shell)
+
+;;; test-ob-shell.el ends here
diff --git a/testing/org-test.el b/testing/org-test.el
index c2a9fd4..879d45e 100644
--- a/testing/org-test.el
+++ b/testing/org-test.el
@@ -52,7 +52,7 @@
       (require 'org-id)
       (require 'ox)
       (org-babel-do-load-languages
-       'org-babel-load-languages '((sh . t) (org . t))))
+       'org-babel-load-languages '((shell . t) (org . t))))
 
     (let* ((load-path (cons
 		       org-test-dir
-- 
1.8.3.2


[-- Attachment #3: Type: text/plain, Size: 11 bytes --]


-- 
Nico.

Re: renaming of ob-sh to ob-shell

[Thorsten Jolitz]

Nicolas Richard <theonewiththeevillook@yahoo.fr> writes:

Hello,

> I attach a patch which changs that and various other things related to
> the renaming, namely : the customize interface, the README, and a change
> in org-test (the one mentionned in <87a9et6mzz.fsf@gmail.com> I guess).

Good job. 

I wonder if a library can have two (provide ...) statements, in that
case ob-shell.el could have simply used both of these:

,-----------------
| (provide 'sh)
| (provide 'shell)
`-----------------

-- 
cheers,
Thorsten

Re: renaming of ob-sh to ob-shell

[Thorsten Jolitz]

Thorsten Jolitz <tjolitz@gmail.com> writes:

> Nicolas Richard <theonewiththeevillook@yahoo.fr> writes:
>
> Hello,
>
>> I attach a patch which changs that and various other things related to
>> the renaming, namely : the customize interface, the README, and a change
>> in org-test (the one mentionned in <87a9et6mzz.fsf@gmail.com> I guess).
>
> Good job. 
>
> I wonder if a library can have two (provide ...) statements, in that
> case ob-shell.el could have simply used both of these:
>
> ,-----------------
> | (provide 'sh)
> | (provide 'shell)
> `-----------------

I meant 

,-----------------
| (provide 'ob-sh)
| (provide 'ob-shell)
`-----------------

of course ...

-- 
cheers,
Thorsten

Re: renaming of ob-sh to ob-shell

[Nicolas Richard]

Thorsten Jolitz <tjolitz@gmail.com> writes:
> I meant 
>
> ,-----------------
> | (provide 'ob-sh)
> | (provide 'ob-shell)
> `-----------------
>
> of course ...

I guess that that would indeed avoid loading an older ob-sh.el. Perhaps
together with something like
(mapc
 (lambda (x)
   (when (member '(require . ob-sh) x)
     (warn "`ob-sh' was required by %s and is deprecated, please check"
           (car x))))
  load-history)

Result is a warning like this:
Warning (emacs): `ob-sh' was required by /path/to/file.el and is deprecated, please check

-- 
Nico.

Re: renaming of ob-sh to ob-shell

[Eric Schulte]

Applied.  Thanks for catching this error and taking the time to provide
this thorough fix!

Nicolas Richard <theonewiththeevillook@yahoo.fr> writes:

> Hello,
>
> The commit 80754a8 says "updated names in test-ob-shell" but it
> reintroduced the file test-ob-sh.el which was renamed in the parent of
> that commit.
>
> I attach a patch which changs that and various other things related to
> the renaming, namely : the customize interface, the README, and a change
> in org-test (the one mentionned in <87a9et6mzz.fsf@gmail.com> I guess).
>
>
> From 8351ad5f1b94ba0ca7768a1d765df1248645fbf4 Mon Sep 17 00:00:00 2001
> From: Nicolas Richard <theonewiththeevillook@yahoo.fr>
> Date: Fri, 31 Jan 2014 17:02:03 +0100
> Subject: [PATCH] Renaming of ob-sh to ob-shell: various fixes
>
> * lisp/org.el (org-babel-load-languages):
> * testing/org-test.el:
> * testing/README: change 'sh' to 'shell'
>
> * testing/lisp/test-ob-sh.el: re-rename test file (fixes 80754a8)
> ---
>  lisp/org.el                   |  2 +-
>  testing/README                |  2 +-
>  testing/lisp/test-ob-sh.el    | 52 -------------------------------------------
>  testing/lisp/test-ob-shell.el | 15 +++++++------
>  testing/org-test.el           |  2 +-
>  5 files changed, 11 insertions(+), 62 deletions(-)
>  delete mode 100644 testing/lisp/test-ob-sh.el
>
> diff --git a/lisp/org.el b/lisp/org.el
> index 20dcb92..5158678 100644
> --- a/lisp/org.el
> +++ b/lisp/org.el
> @@ -275,7 +275,7 @@ requirements) is loaded."
>  		 (const :tag "Scala" scala)
>  		 (const :tag "Scheme" scheme)
>  		 (const :tag "Screen" screen)
> -		 (const :tag "Shell Script" sh)
> +		 (const :tag "Shell Script" shell)
>  		 (const :tag "Shen" shen)
>  		 (const :tag "Sql" sql)
>  		 (const :tag "Sqlite" sqlite)
> diff --git a/testing/README b/testing/README
> index e25a109..c7e352b 100644
> --- a/testing/README
> +++ b/testing/README
> @@ -24,7 +24,7 @@ Also note that many of the current tests uses babel evaluation...
>          -l lisp/org-id.el -l testing/org-test.el \
>          --eval "(progn (org-reload) (setq org-confirm-babel-evaluate nil) \
>          (org-babel-do-load-languages 'org-babel-load-languages \
> -        '((emacs-lisp . t) (sh . t) (org . t))))" \
> +        '((emacs-lisp . t) (shell . t) (org . t))))" \
>          -f org-test-run-batch-tests
>  #+END_SRC
>  
> diff --git a/testing/lisp/test-ob-sh.el b/testing/lisp/test-ob-sh.el
> deleted file mode 100644
> index 09278e7..0000000
> --- a/testing/lisp/test-ob-sh.el
> +++ /dev/null
> @@ -1,52 +0,0 @@
> -;;; test-ob-shell.el
> -
> -;; Copyright (c) 2010-2014 Eric Schulte
> -;; Authors: Eric Schulte
> -
> -;; 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/>.
> -
> -;;; Comment:
> -
> -;; Template test file for Org-mode tests
> -
> -;;; Code:
> -(org-test-for-executable "sh")
> -(unless (featurep 'ob-shell)
> -  (signal 'missing-test-dependency "Support for Shell code blocks"))
> -
> -(ert-deftest test-ob-shell/dont-insert-spaces-on-expanded-bodies ()
> -  "Expanded shell bodies should not start with a blank line
> -unless the body of the tangled block does."
> -  (should-not (string-match "^[\n\r][\t ]*[\n\r]"
> -			    (org-babel-expand-body:generic "echo 2" '())))
> -  (should (string-match "^[\n\r][\t ]*[\n\r]"
> -			(org-babel-expand-body:generic "\n\necho 2" '()))))
> -
> -(ert-deftest test-ob-shell/dont-error-on-empty-results ()
> -  "Was throwing an elisp error when shell blocks threw errors and
> -returned empty results."
> -  (should (null (org-babel-execute:sh "ls NoSuchFileOrDirectory.txt" nil))))
> -
> -(ert-deftest test-ob-shell/session ()
> -  "This also tests `org-babel-comint-with-output' in
> -ob-comint.el, which was not previously tested."
> -  (let ((res (org-babel-execute:sh "echo 1; echo 2" '((:session . "yes")))))
> -    (should res)
> -    (should (listp res))))
> -
> -(provide 'test-ob-shell)
> -
> -;;; test-ob-shell.el ends here
> diff --git a/testing/lisp/test-ob-shell.el b/testing/lisp/test-ob-shell.el
> index 87e2a95..2b3e48f 100644
> --- a/testing/lisp/test-ob-shell.el
> +++ b/testing/lisp/test-ob-shell.el
> @@ -1,4 +1,4 @@
> -;;; test-ob-sh.el
> +;;; test-ob-shell.el
>  
>  ;; Copyright (c) 2010-2014 Eric Schulte
>  ;; Authors: Eric Schulte
> @@ -25,9 +25,9 @@
>  ;;; Code:
>  (org-test-for-executable "sh")
>  (unless (featurep 'ob-shell)
> -  (signal 'missing-test-dependency "Support for Sh code blocks"))
> +  (signal 'missing-test-dependency "Support for Shell code blocks"))
>  
> -(ert-deftest test-ob-sh/dont-insert-spaces-on-expanded-bodies ()
> +(ert-deftest test-ob-shell/dont-insert-spaces-on-expanded-bodies ()
>    "Expanded shell bodies should not start with a blank line
>  unless the body of the tangled block does."
>    (should-not (string-match "^[\n\r][\t ]*[\n\r]"
> @@ -35,18 +35,19 @@ unless the body of the tangled block does."
>    (should (string-match "^[\n\r][\t ]*[\n\r]"
>  			(org-babel-expand-body:generic "\n\necho 2" '()))))
>  
> -(ert-deftest test-ob-sh/dont-error-on-empty-results ()
> +(ert-deftest test-ob-shell/dont-error-on-empty-results ()
>    "Was throwing an elisp error when shell blocks threw errors and
>  returned empty results."
>    (should (null (org-babel-execute:sh "ls NoSuchFileOrDirectory.txt" nil))))
>  
> -(ert-deftest test-ob-sh/session ()
> +(ert-deftest test-ob-shell/session ()
>    "This also tests `org-babel-comint-with-output' in
>  ob-comint.el, which was not previously tested."
>    (let ((res (org-babel-execute:sh "echo 1; echo 2" '((:session . "yes")))))
>      (should res)
>      (should (listp res))))
>  
> -(provide 'test-ob-sh)
>  
> -;;; test-ob-sh.el ends here
> +(provide 'test-ob-shell)
> +
> +;;; test-ob-shell.el ends here
> diff --git a/testing/org-test.el b/testing/org-test.el
> index c2a9fd4..879d45e 100644
> --- a/testing/org-test.el
> +++ b/testing/org-test.el
> @@ -52,7 +52,7 @@
>        (require 'org-id)
>        (require 'ox)
>        (org-babel-do-load-languages
> -       'org-babel-load-languages '((sh . t) (org . t))))
> +       'org-babel-load-languages '((shell . t) (org . t))))
>  
>      (let* ((load-path (cons
>  		       org-test-dir
> -- 
> 1.8.3.2

-- 
Eric Schulte
https://cs.unm.edu/~eschulte
PGP: 0x614CA05D