v4.3.0: support for editing PKGBUILDs (--edit-pkgbuild option)

Signed-off-by: Chris Warrick <kwpolska@gmail.com>
Kwpolska · Jan 12, 2019 · a8c5daa · a8c5daa
1 parent fcb9bcf
commit a8c5daa
Show file tree

Hide file tree

Showing 69 changed files with 219 additions and 113 deletions.
diff --git a/.gitignore b/.gitignore
@@ -42,3 +42,4 @@ pbwrapperdiff
 
 # Transifex?
 .cache/
+.pytest_cache
diff --git a/.pbwrapperhelp b/.pbwrapperhelp
@@ -46,10 +46,11 @@ options:
       --sysroot        operate on a mounted guest system (root-only)
 usage: pkgbuilder [-h] [-V] [-S] [-F] [--userfetch USER] [-i] [-s] [-u] [-U]
                   [-X] [-c] [--noclean] [--colors] [-C] [--debug] [--nodebug]
-                  [--depcheck] [-d] [-D] [--novcsupgrade] [--validation] [-v]
-                  [--install] [-w] [--pgpcheck] [--skippgpcheck] [--confirm]
-                  [--noconfirm] [--shallow] [--deep] [--ignore PACKAGE] [-y]
-                  [--notmp] [--build]
+                  [--edit-pkgbuild] [--noedit-pkgbuild] [--depcheck] [-d] [-D]
+                  [--novcsupgrade] [--validation] [-v] [--install] [-w]
+                  [--pgpcheck] [--skippgpcheck] [--confirm] [--noconfirm]
+                  [--shallow] [--deep] [--ignore PACKAGE] [-y] [--notmp]
+                  [--build]
                   [PACKAGE [PACKAGE ...]]
 
 An AUR helper (and library) in Python 3.
@@ -80,6 +81,8 @@ options:
   -C, --nocolors        don't use colors in output
   --debug               display debug messages
   --nodebug             don't display debug messages (default)
+  --edit-pkgbuild       edit the PKGBUILD
+  --noedit-pkgbuild     don't edit the PKGBUILD (default)
   --depcheck            check dependencies (default)
   -d, --nodepcheck      don't check dependencies (may break makepkg)
   -D, --vcsupgrade      upgrade all the VCS/date-versioned packages

diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -5,8 +5,8 @@ Appendix C. Changelog
 :Author: Chris Warrick <chris@chriswarrick.com>
 :Copyright: © 2011-2019, Chris Warrick.
 :License: BSD (see /LICENSE or :doc:`Appendix B <LICENSE>`.)
-:Date: 2018-07-31
-:Version: 4.2.18
+:Date: 2019-01-12
+:Version: 4.3.0
 
 .. index:: CHANGELOG
 
@@ -47,6 +47,9 @@ More information can be found on GitHub in the `releases section <https://github
 Version History
 ===============
 
+4.3.0
+    * Support for editing PKGBUILDs (``--edit-pkgbuild`` option)
+
 4.2.18
     * Add a ``paccommand`` option to the INI file.
 

diff --git a/PKGBUILD b/PKGBUILD
@@ -1,7 +1,7 @@
 # Maintainer: Chris Warrick <aur@chriswarrick.com>
 pkgname=pkgbuilder
 _pyname=pkgbuilder
-pkgver=4.2.18
+pkgver=4.3.0
 pkgrel=1
 pkgdesc='A Python AUR helper/library.'
 arch=('any')
@@ -10,7 +10,7 @@ license=('BSD')
 depends=('python' 'python-setuptools' 'pyalpm>=0.5.1-1' 'python-requests' 'python-srcinfo' 'asp' 'git')
 options=(!emptydirs)
 source=("https://files.pythonhosted.org/packages/source/${_pyname:0:1}/${_pyname}/${_pyname}-${pkgver}.tar.gz")
-md5sums=('d7aa404dac208d420d338774662b4037')
+md5sums=('9c0c6d2d1253fd88fce234d50d83fa5f')
 
 package() {
   cd "${srcdir}/${_pyname}-${pkgver}"

diff --git a/PKGBUILD-git b/PKGBUILD-git
@@ -2,7 +2,7 @@
 pkgname=pkgbuilder-git
 _pyname=pkgbuilder
 _gitname=pkgbuilder
-pkgver=4.2.18
+pkgver=4.3.0
 pkgrel=1
 pkgdesc='A Python AUR helper/library. (git version)'
 arch=('any')

diff --git a/README b/README
@@ -3,8 +3,8 @@ PKGBUILDer.  An AUR helper (and library) in Python 3.
 =====================================================
 :Info: This is the README file for PKGBUILDer.
 :Author: Chris Warrick <chris@chriswarrick.com>
-:Date: 2018-07-31
-:Version: 4.2.18
+:Date: 2019-01-12
+:Version: 4.3.0
 
 .. index: README
 
@@ -44,6 +44,21 @@ the AUR.
 For more information, refer to the ``-h`` command, the ``pkgbuilder(8)`` man
 page, or the online documentation at https://pkgbuilder.readthedocs.org/.
 
+CONFIGURATION
+-------------
+
+PKGBUILDer supports per-user configuration, in the file
+~/.config/kwpolska/pkgbuilder/pkgbuilder.ini.  It can also be configured on a
+per-usage basis via command-line arguments.
+
+SECURITY AND EDITING PKGBUILDs
+------------------------------
+
+By default, PKGBUILDer strives to be the no-questions-asked package manager.
+This means that all packages are built immediately, without any confirmations.
+The behavior can be overridden with the ``--edit-pkgbuild`` command-line
+option, or with ``edit=pkgbuild=true`` in PKGBUILDer’s config file.
+
 COPYRIGHT
 ---------
 Copyright © 2011-2019, Chris Warrick.

diff --git a/README.rst b/README.rst
@@ -3,8 +3,8 @@ PKGBUILDer.  An AUR helper (and library) in Python 3.
 =====================================================
 :Info: This is the README file for PKGBUILDer.
 :Author: Chris Warrick <chris@chriswarrick.com>
-:Date: 2018-07-31
-:Version: 4.2.18
+:Date: 2019-01-12
+:Version: 4.3.0
 
 .. index: README
 
@@ -26,13 +26,6 @@ After adding the repository, you need to run::
     # pacman-key --lsign 5EAAEA16
     # pacman -Syyu
 
-My GPG key expires every year. Every year on January 1st, you’ll need to run::
-
-    # pacman-key -d 5EAAEA16
-    # pacman-key -r 5EAAEA16
-    # pacman-key --lsign 5EAAEA16
-    # pacman -Syyu
-
 BASIC USAGE
 -----------
 
@@ -51,6 +44,21 @@ the AUR.
 For more information, refer to the ``-h`` command, the ``pkgbuilder(8)`` man
 page, or the online documentation at https://pkgbuilder.readthedocs.org/.
 
+CONFIGURATION
+-------------
+
+PKGBUILDer supports per-user configuration, in the file
+~/.config/kwpolska/pkgbuilder/pkgbuilder.ini.  It can also be configured on a
+per-usage basis via command-line arguments.
+
+SECURITY AND EDITING PKGBUILDs
+------------------------------
+
+By default, PKGBUILDer strives to be the no-questions-asked package manager.
+This means that all packages are built immediately, without any confirmations.
+The behavior can be overridden with the ``--edit-pkgbuild`` command-line
+option, or with ``edit=pkgbuild=true`` in PKGBUILDer’s config file.
+
 COPYRIGHT
 ---------
 Copyright © 2011-2019, Chris Warrick.

diff --git a/docs/CHANGELOG.rst b/docs/CHANGELOG.rst
@@ -5,8 +5,8 @@ Appendix C. Changelog
 :Author: Chris Warrick <chris@chriswarrick.com>
 :Copyright: © 2011-2019, Chris Warrick.
 :License: BSD (see /LICENSE or :doc:`Appendix B <LICENSE>`.)
-:Date: 2018-07-31
-:Version: 4.2.18
+:Date: 2019-01-12
+:Version: 4.3.0
 
 .. index:: CHANGELOG
 
@@ -47,6 +47,9 @@ More information can be found on GitHub in the `releases section <https://github
 Version History
 ===============
 
+4.3.0
+    * Support for editing PKGBUILDs (``--edit-pkgbuild`` option)
+
 4.2.18
     * Add a ``paccommand`` option to the INI file.
 

diff --git a/docs/LICENSE.rst b/docs/LICENSE.rst
@@ -3,8 +3,8 @@ Appendix B. License for PKGBUILDer
 ==================================
 :Info: This is the license for PKGBUILDer.
 :Author: Chris Warrick <chris@chriswarrick.com>
-:Date: 2018-07-31
-:Version: 4.2.18
+:Date: 2019-01-12
+:Version: 4.3.0
 
 .. index:: LICENSE
 

diff --git a/docs/README.rst b/docs/README.rst
@@ -3,8 +3,8 @@ PKGBUILDer.  An AUR helper (and library) in Python 3.
 =====================================================
 :Info: This is the README file for PKGBUILDer.
 :Author: Chris Warrick <chris@chriswarrick.com>
-:Date: 2018-07-31
-:Version: 4.2.18
+:Date: 2019-01-12
+:Version: 4.3.0
 
 .. index: README
 
@@ -44,6 +44,21 @@ the AUR.
 For more information, refer to the ``-h`` command, the ``pkgbuilder(8)`` man
 page, or the online documentation at https://pkgbuilder.readthedocs.org/.
 
+CONFIGURATION
+-------------
+
+PKGBUILDer supports per-user configuration, in the file
+~/.config/kwpolska/pkgbuilder/pkgbuilder.ini.  It can also be configured on a
+per-usage basis via command-line arguments.
+
+SECURITY AND EDITING PKGBUILDs
+------------------------------
+
+By default, PKGBUILDer strives to be the no-questions-asked package manager.
+This means that all packages are built immediately, without any confirmations.
+The behavior can be overridden with the ``--edit-pkgbuild`` command-line
+option, or with ``edit=pkgbuild=true`` in PKGBUILDer’s config file.
+
 COPYRIGHT
 ---------
 Copyright © 2011-2019, Chris Warrick.

diff --git a/docs/aur.rst b/docs/aur.rst
@@ -4,8 +4,8 @@ aur module (AUR class)
 :Author: Chris Warrick <chris@chriswarrick.com>
 :Copyright: © 2011-2019, Chris Warrick.
 :License: BSD (see /LICENSE or :doc:`Appendix B <LICENSE>`.)
-:Date: 2018-07-31
-:Version: 4.2.18
+:Date: 2019-01-12
+:Version: 4.3.0
 
 .. index:: AUR; RPC
 .. index:: RPC

diff --git a/docs/build.rst b/docs/build.rst
@@ -5,8 +5,8 @@ build module
 :Author: Chris Warrick <chris@chriswarrick.com>
 :Copyright: © 2011-2019, Chris Warrick.
 :License: BSD (see /LICENSE or :doc:`Appendix B <LICENSE>`.)
-:Date: 2018-07-31
-:Version: 4.2.18
+:Date: 2019-01-12
+:Version: 4.3.0
 
 .. index:: build
 .. versionadded:: 2.1.0.0

diff --git a/docs/conf.py b/docs/conf.py
@@ -48,9 +48,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = '4.2.18'
+version = '4.3.0'
 # The full version, including alpha/beta/rc tags.
-release = '4.2.18'
+release = '4.3.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

diff --git a/docs/exceptions.rst b/docs/exceptions.rst
@@ -5,8 +5,8 @@ Exceptions in PKGBUILDer
 :Author: Chris Warrick <chris@chriswarrick.com>
 :Copyright: © 2011-2019, Chris Warrick.
 :License: BSD (see /LICENSE or :doc:`Appendix B <LICENSE>`.)
-:Date: 2018-07-31
-:Version: 4.2.18
+:Date: 2019-01-12
+:Version: 4.3.0
 
 .. index:: Exceptions
 .. versionadded:: 3.0.0

diff --git a/docs/main.rst b/docs/main.rst
@@ -4,8 +4,8 @@ __main__ module
 :Author: Chris Warrick <chris@chriswarrick.com>
 :Copyright: © 2011-2019, Chris Warrick.
 :License: BSD (see /LICENSE or :doc:`Appendix B <LICENSE>`.)
-:Date: 2018-07-31
-:Version: 4.2.18
+:Date: 2019-01-12
+:Version: 4.3.0
 
 .. index:: main
 .. versionchanged:: 4.0.0

diff --git a/docs/package.rst b/docs/package.rst
@@ -5,8 +5,8 @@ package module (Package, AURPackage, ABSPackage classes)
 :Author: Chris Warrick <chris@chriswarrick.com>
 :Copyright: © 2011-2019, Chris Warrick.
 :License: BSD (see /LICENSE or :doc:`Appendix B <LICENSE>`.)
-:Date: 2018-07-31
-:Version: 4.2.18
+:Date: 2019-01-12
+:Version: 4.3.0
 
 .. index:: Package
 .. index:: AURPackage

diff --git a/docs/pb.8.gz b/docs/pb.8.gz
diff --git a/docs/pb.rst b/docs/pb.rst
@@ -6,8 +6,8 @@ PBWrapper
 :Author: Chris Warrick <chris@chriswarrick.com>
 :Copyright: © 2011-2019, Chris Warrick.
 :License: BSD (see /LICENSE or Appendix B.)
-:Date: 2018-07-31
-:Version: 4.2.18
+:Date: 2019-01-12
+:Version: 4.3.0
 :Wrapper Version: 0.5.6
 :Manual section: 8
 :Manual group: PKGBUILDer manual

diff --git a/docs/pbds.rst b/docs/pbds.rst
@@ -5,8 +5,8 @@ pbds module (PBDS class)
 :Author: Chris Warrick <chris@chriswarrick.com>
 :Copyright: © 2011-2019, Chris Warrick.
 :License: BSD (see /LICENSE or :doc:`Appendix B <LICENSE>`.)
-:Date: 2018-07-31
-:Version: 4.2.18
+:Date: 2019-01-12
+:Version: 4.3.0
 
 .. module: pbds
 

diff --git a/docs/pkgbuilder.8.gz b/docs/pkgbuilder.8.gz
diff --git a/docs/pkgbuilder.rst b/docs/pkgbuilder.rst
@@ -6,8 +6,8 @@ PKGBUILDer
 :Author: Chris Warrick <chris@chriswarrick.com>
 :Copyright: © 2011-2019, Chris Warrick.
 :License: BSD (see /LICENSE or Appendix B.)
-:Date: 2018-07-31
-:Version: 4.2.18
+:Date: 2019-01-12
+:Version: 4.3.0
 :Manual section: 8
 :Manual group: PKGBUILDer manual
 
@@ -125,13 +125,24 @@ Only the non-default options are documented below.
 **--deep**
     Perform deep clones of git repositories.  Override with ``--shallow``.
 
+**--edit-pkgbuild**
+    Offer to edit PKGBUILDs before they are installed.
+
 **--ignore [PACKAGE PACKAGE ...]**
     Ignore a package upgrade (can be used more than once, or use commas --
     follows pacman syntax)
 
 **-y, --refresh**
     Dummy option for pacman compatibility.
 
+SECURITY AND EDITING PKGBUILDs
+==============================
+
+By default, PKGBUILDer strives to be the no-questions-asked package manager.
+This means that all packages are built immediately, without any confirmations.
+The behavior can be overridden with the ``--edit-pkgbuild`` command-line
+option, or with ``edit=pkgbuild=true`` in PKGBUILDer’s config file.
+
 EXAMPLES
 ========
 

diff --git a/docs/sample-scripts.rst b/docs/sample-scripts.rst
@@ -4,8 +4,8 @@ PKGBUILDer Sample Scripts
 :Author: Chris Warrick <chris@chriswarrick.com>
 :Copyright: © 2011-2019, Chris Warrick.
 :License: BSD (see /LICENSE or :doc:`Appendix B <LICENSE>`.)
-:Date: 2018-07-31
-:Version: 4.2.18
+:Date: 2019-01-12
+:Version: 4.3.0
 
 .. index:: sample scripts
 

diff --git a/docs/transaction.rst b/docs/transaction.rst
@@ -5,8 +5,8 @@ Transactions
 :Author: Chris Warrick <chris@chriswarrick.com>
 :Copyright: © 2011-2019, Chris Warrick.
 :License: BSD (see /LICENSE or :doc:`Appendix B <LICENSE>`.)
-:Date: 2018-07-31
-:Version: 4.2.18
+:Date: 2019-01-12
+:Version: 4.3.0
 
 .. index:: transaction
 .. versionadded:: 4.1.0

diff --git a/docs/ui.rst b/docs/ui.rst
@@ -5,8 +5,8 @@ ui module (UI class)
 :Author: Chris Warrick <chris@chriswarrick.com>
 :Copyright: © 2011-2019, Chris Warrick.
 :License: BSD (see /LICENSE or :doc:`Appendix B <LICENSE>`.)
-:Date: 2018-07-31
-:Version: 4.2.18
+:Date: 2019-01-12
+:Version: 4.3.0
 
 .. index:: UI
 .. versionadded:: 3.0.0

diff --git a/docs/upgrade.rst b/docs/upgrade.rst
@@ -5,8 +5,8 @@ upgrade module
 :Author: Chris Warrick <chris@chriswarrick.com>
 :Copyright: © 2011-2019, Chris Warrick.
 :License: BSD (see /LICENSE or :doc:`Appendix B <LICENSE>`.)
-:Date: 2018-07-31
-:Version: 4.2.18
+:Date: 2019-01-12
+:Version: 4.3.0
 
 .. index:: upgrade
 .. index:: Syu