Command line tool to duplicate/modify version number strings across source code and distribution files according to syntax context.

⌈⌋ branch:  version numbers get/write


Check-in [434454639c]

Many hyperlinks are disabled.
Use anonymous login to enable hyperlinks.

Overview
Comment:3.2.1
Timelines: family | ancestors | descendants | both | trunk
Files: files | file ages | folders
SHA1:434454639c2b1164e0f97445c1aa4068af5889e3
User & Date: mario 2014-02-07 19:42:25
Context
2014-02-07
19:42
manpage and build script (for local deb/ template) check-in: 4191d9fe50 user: mario tags: trunk
19:42
3.2.1 check-in: 434454639c user: mario tags: trunk
19:42
3.1.5 check-in: e22dc562c1 user: mario tags: trunk
Changes

Changes to version.php.

1
2
3
4
5
6
7

8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57


58
59








60

61
62
63
64
65
66
67
68
69
70
71
72

73
74
75
76
77
78
79

80
81
82
83
84
85
















86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
...
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159







160
161

162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182

183
184
185
186

187
188
189
190
191


192
193
194
195
196
197
198

199
200
201
202
203
204
205

206
207
208

209

210
211
212
213
214
215

216
217
218
219

220
221
222
223

224
225
226
227

228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
...
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
...
349
350
351
352
353
354
355















356
357
358
359
360
361
362
...
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
...
498
499
500
501
502
503
504






























505
#!/usr/bin/php
<?php
/**
 * type: cli
 * title: Version Get/Write
 * description: Commandline tool to read and update source code version numbers
 * version: 3.1.5-3

 * 
 *
 * This tool reads various formats of "Version: x.y*" from and to source code
 * or distribution files. It's useful for keeping them synced or prepared without
 * further packaging tool scripting.
 *
 * It's indifferent to versioning schemes, understands following source and target
 * text variations:
 *
 *   PHP plugins   # version: 1.2.3       RPM/EPM spec    %version 7.1
 *   PHP docblock  * @version: 0.0        Debian control  Version: 2.0-3
 *   Python src    version = 
 *   Script vars   $version = "1.0";
 *
 * Multiple commands are supported and can be chained often quite readibly to
 * move version numbers across files:
 *
 *   version  get file.php
 *
 *   version  read file.c  bump  show
 *
 *   version  --get file.php   --incr  --write package.list
 *
 *   version  read script.py  incr  bump   write DEBIAN/control
 *
 *   version  read:php file.php  bump  write:spec package.spec
 *
 *   version  1.2.3-dev  write  source.php
 *
 *   version  get  phar://project.phar/.phar/stub.php   write project.phar
 *
 *
 * Everything that's not a valid filename is presumed to be an action command,
 * and can also be prefixed with --, as in --get. The order of filenames and
 * actions is often irrelevant.
 *
 *   --get    Loads and shows version.
 *   --read   Just loads version from file, does not display it.
 *   --show   Just prints out current or increased/bumped version number.
 *
 *   --write  Update version field in target file. Here it's often sensible to
 *            specify the target filename beforehand.
 *
 *   --incr   Increment patch ver number (last colon-separated 0.0.x decimal)
 *   --bump   Add/incr packaging/suffix (first num after dash 0.0.0-x)
 *            You can also bump in bigger spans using --bumb::2 or --incr::3
 *
 *   --format:ini     Explicit file format
 *   --format:php:2   Also specify how many occurences to replace.
 *


 * Some aliases exist for actions, for example ++ for --increment.
 * ...








 * There's no commandline option for custom regexen, to eschew code duplication.

 *
 *@version 3.1.5-3
 */


 
#-- regular expressions
$rx_ver        = "(  (?<epoch>\d+:)? (?<major>\d+) \.(?<minor>\d+) (?:\.(?<patch>\d+))? (?<suffix>[\d\w-+.~_]*)  )";
$rx_ws  =  $s  = "[^\S\R]";    // whitespace without linebreaks
$rx_end        = " $s* $";   // default regex end match (everything after the $rx_ver match)
$rx_format = array(
    "debian"   =>       "^ Version: $s+ ",

    "plugin"   =>       "^ $s* (?:\*|\#|\/\/) $s* (?i) version: $s* ",   // generic meta data comment block
    "docblock" =>       "^ $s* [*]@version $s+",
    "const"    => array("^ $s* const $s+ \w*VERSION $s+ = $s+ [\'\"]",  $rx_ver,   "[\'\"]; $rx_end"),
    "define"   => array("^ $s* define \( [\'\"] \w*VERSION [\'\"], $s* [\'\"]",  $rx_ver,  "[\'\"]\); $rx_end"),
    "var"      => array("^ $s* (?:var|public|private|protected|static|global)? $s* \$\w*version $s* = $s* [\'\"]",  $rx_ver,  "[\'\"]; $rx_end"),
    "wordpress"=>       "^ $s* Version: $s* ",
    "ini"      => array("^ $s* version $s* = $s* [\'\"]",  $rx_ver,  "[\'\"] $rx_end"),

    "composer" => array("$s* \"version\" $s* : $s* \" ",  $rx_ver,  " \"  $s* [,}] "),
    "xmltag"   => array("<version>$s*", $rx_ver, "$s*<\/version>"),
    "_raw_"    => array("", $rx_ver, "")  // would match anything in a text file that looks like a version number
);

#-- config
















$action_aliases = aliases_flip(array(
    "write" => array("save", "write", "update"),
    "get" => array("get"),
    "read" => array("read"),
    "show" => array("show"),
    "increment" => array("++", "add", "inc", "incr", "increment"),
    "bump" => array("bump", "suffix", "release",),
    "format" => array("fmt", "format", "and", "then", "set"),
    "last" => array("last"),
    "help" => array("help"),
    "dry" => array("dry", "nowrite", "dryrun"),
));
$ext_to_rxformat = array(
    "php" => array("plugin", "docblock", "define", "const", "var", "wordpress"),
    "control" => array("debian"),
    "py" => array("plugin", "ini"),
    "cpp" => array("plugin", "const"),
    "c" => array("plugin", "ini"),
    "json" => array("composer"),
    "xml" => array("xmltag"),
    "any" => array_keys(array_filter($rx_format)),
);
$bin_handlers = array(
    "phar" => "bin_phar",
);



#-- most actions require a pair of $action and $file to be set
$version = "";
class command {
    var $action = "";
    var $file = "";
    var $ext = "";
    var $format = "";
    var $count = 1;
................................................................................



#-- init argv
$argv = array_slice($_SERVER["argv"], 1);
// no args = help
if (empty($argv)) {
    $argv = array("help");
}
// just one filename arg = default action to 'get'
elseif (count($argv) == 1) {
    $cmd->action = "get";
}



#-- go over args list
foreach ($argv as $arg) {


    #-- categorize current argument
    
    // it's a filename
    if (file_exists($arg)) {
        $cmd->file = $arg;
        $cmd->ext = trim(substr($arg, strrpos($arg, ".")), ".");   // extension or basename (e.g. for DEBIAN/control file)
    }

    // special filename
    elseif ($arg == "-") {
        $cmd->file = "php://stdin";
    }
    







    // input version number
    elseif (preg_match("/^$rx_ver$/x", $arg)) {

        $cmd->version = $arg;
    }

    // action/command name
    else {
    
        // extra flags
        if (strpos($arg, ":")) {
            list($arg, $cmd->format, $cmd->count) = explode(":", "$arg:1");
        }
        
        // normalize
        $cmd->action = $action_aliases[ltrim($arg, "-")]
        or exit("version: Unknown action command or non-existant file '$arg'\n");
    }



    #-- processing/behaviour
    switch ($cmd->action) {


        case "show":
            print $version;
            break;


        case "get":
            if ($cmd->file) {
                action::read($cmd);
                if (strlen($cmd->version) < 3) {
                    // return 0.0-0error on failure


                    // (while --read should not not)
                }
                print $cmd->version;
                $last=$cmd and $cmd=new command();
            }
            break;


        case "read":
            if ($cmd->file) {
                action::read($cmd);
                $last=$cmd and $cmd=new command();
            }
            break;


        case "write":
            if ($cmd->file) {
                if (strlen($cmd->version) < 3) {

                    // error

                }
                action::write($cmd);
                $last=$cmd and $cmd=new command();
            }
            break;


        case "increment":
            action::increment($cmd);
            break;


        case "bump":
            action::bump($cmd);
            break;


        case "dry":
            $cmd->dry = 1;
            break;


        case "":
        case "nop":
        case "format":
            // do nothing (--format:TYPE:N params can be attached to any other command, --format itself incurs no action)
            break;
            
        case "help":
            die(file_get_contents(__FILE__, NULL, NULL, 20, 2100));
            
        default:
            exit("version: Unimplemented action '$cmd->action'\n");
    }
}



/**
 * Action implementation
................................................................................
        $limit = $cmd->count ? (int)$cmd->count : 1;
        //@bug: PHP applies the limit to each regex in the list, not as overall

        // replace
        $src = preg_replace_callback
            (
                rx::get($cmd),
                function($m) use ($cmd, $limit) {
                
                    // apply application stop here, because preg_replace() only does for *each* rx[] list entry
                    if ($limit-- <= 0) {
                        return $m[0];
                    }
                    
                    // replace 
................................................................................
        else {
            $cmd->version .= "-0";
        }
    }




















    #-- binary handlers


    
    // read "version" meta field via binary helpers
................................................................................
            }
            elseif (isset($ext_to_rxformat[$s])) {
                foreach ($ext_to_rxformat[$s] as $s2) {
                    $rx[] = $rx_format[$s2];
                }
            }
            else {
                die("version: Unkown file extension or rx_format '$s' name\n");
            }
        }
        return $rx;
    }
    
    /**
     * Combine a list of regex parts with $rx_ver, $rx_end
................................................................................
        foreach ($values as $v) {
            $r[$v] = $key;
        }
    }
    return $r;
}































?>






|
>












|










|









|
|

|
|


|
<


|
|




>
>
|
<
>
>
>
>
>
>
>
>
|
>

|
|









>

|





>






>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>


|
|
|







<
<
<
<
<
<
<
<
<
<
<
<
<



|







 







|



|










|


|


|



|
>
>
>
>
>
>
>
|

>



|









|




|


>




>



|

>
>







>







>


<
>
|
>






>




>



|
>




>

<



|
|
<
<

|







 







|







 







>
>
>
>
>
>
>
>
>
>
>
>
>
>
>







 







|







 







>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49

50
51
52
53
54
55
56
57
58
59
60

61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125













126
127
128
129
130
131
132
133
134
135
136
...
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236

237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262

263
264
265
266
267


268
269
270
271
272
273
274
275
276
...
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
...
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
...
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
...
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
#!/usr/bin/php
<?php
/**
 * type: cli
 * title: Version Get/Write
 * description: Commandline tool to read and update source code version numbers
 * version: 3.2.1-0
 * category: tools
 * 
 *
 * This tool reads various formats of "Version: x.y*" from and to source code
 * or distribution files. It's useful for keeping them synced or prepared without
 * further packaging tool scripting.
 *
 * It's indifferent to versioning schemes, understands following source and target
 * text variations:
 *
 *   PHP plugins   # version: 1.2.3       RPM/EPM spec    %version 7.1
 *   PHP docblock  * @version: 0.0        Debian control  Version: 2.0-3
 *   Python src    version = 
 *   Script vars   $version = "1.0";      JSON    { "version": "0.2.2" }
 *
 * Multiple commands are supported and can be chained often quite readibly to
 * move version numbers across files:
 *
 *   version  get file.php
 *
 *   version  read file.c  bump  show
 *
 *   version  --get file.php   --incr  --write package.list
 *
 *   version  read script.py  incr and bump then  write DEBIAN/control
 *
 *   version  read:php file.php  bump  write:spec package.spec
 *
 *   version  1.2.3-dev  write  source.php
 *
 *   version  get  phar://project.phar/.phar/stub.php   write project.phar
 *
 *
 * Everything that's not a valid filename is presumed to be an action command,
 * and can also be prefixed with a - single or -- double dash, as in --get.
 * The order of filenames and actions is often irrelevant.
 *
 *   --get    Loads and shows version from file.
 *   --read   Just loads version, does not display it.
 *   --show   Just prints out current or increased/bumped version number.
 *
 *   --write  Update version field in the destination source code file.

 *
 *   --incr   Increment patch ver number (last colon-separated 0.0.x decimal)
 *   --bump   Add/count up packaging/suffix (first num after dash 0.0.0-x)
 *            You can also bump in bigger spans using --bump::2 or --incr::3
 *
 *   --format:ini     Explicit file format
 *   --format:php:2   Also specify how many occurences to replace.
 *
 * You can add the :format:count extras to any command actually, so `-fmt:py:2`
 * and is used in `-write:py:2` implicitly
 * More aliases exist for actions, for example ++ for -increment.

 * For format types you can specify both file extension and internal rx format
 * monikers (ini, var, docblock, ..., `_raw_` for any versiony-looking string).
 *
 * Often you may wish to split up invocations from the shell, as in:
 *
 *    VERSION=$(version get orig.c ++)
 *    version write $VERSION dest.cpp
 *
 * There's no commandline option for custom regexen, to eschew code duplication
 * in said shell scripts.
 *
 *@version 3.2.1-0
 */   


 
#-- regular expressions
$rx_ver        = "(  (?<epoch>\d+:)? (?<major>\d+) \.(?<minor>\d+) (?:\.(?<patch>\d+))? (?<suffix>[\d\w-+.~_]*)  )";
$rx_ws  =  $s  = "[^\S\R]";    // whitespace without linebreaks
$rx_end        = " $s* $";   // default regex end match (everything after the $rx_ver match)
$rx_format = array(
    "debian"   =>       "^ Version: $s+ ",
    "rpmspec"  =>       "^ % version $s+",
    "plugin"   =>       "^ $s* (?:\*|\#|\/\/) $s* (?i) version: $s* ",   // generic meta data comment block
    "docblock" =>       "^ $s* [*] $s? @version $s+",
    "const"    => array("^ $s* const $s+ \w*VERSION $s+ = $s+ [\'\"]",  $rx_ver,   "[\'\"]; $rx_end"),
    "define"   => array("^ $s* define \( [\'\"] \w*VERSION [\'\"], $s* [\'\"]",  $rx_ver,  "[\'\"]\); $rx_end"),
    "var"      => array("^ $s* (?:var|public|private|protected|static|global)? $s* \$\w*version $s* = $s* [\'\"]",  $rx_ver,  "[\'\"]; $rx_end"),
    "wordpress"=>       "^ $s* Version: $s* ",
    "ini"      => array("^ $s* version $s* = $s* [\'\"]",  $rx_ver,  "[\'\"] $rx_end"),
    "python"   => array("^ $s* __version__ $s* = $s* [\'\"]",  $rx_ver,  "[\'\"] $rx_end"),
    "composer" => array("$s* \"version\" $s* : $s* \" ",  $rx_ver,  " \"  $s* [,}] "),
    "xmltag"   => array("<version>$s*", $rx_ver, "$s*<\/version>"),
    "_raw_"    => array("", $rx_ver, "")  // would match anything in a text file that looks like a version number
);

#-- config
$ext_to_rxformat = array(
    "php" => array("plugin", "docblock", "define", "const", "var", "wordpress"),
    "control" => array("debian"),
    "py" => array("python", "plugin", "ini"),
    "cpp" => array("plugin", "const"),
    "c" => array("plugin", "ini"),
    "json" => array("composer"),
    "sh" => array("plugin", "ini"),
    "xml" => array("xmltag"),
    "spec" => array("rpmspec"),
   #"txt" => array("_raw_"),  // e.g. distutils2 version.txt
    "any" => array_keys(array_diff_key($rx_format, array("_raw_"=>FALSE))),
);
$bin_handlers = array(
    "phar" => "bin_phar",
);
$action_aliases = aliases_flip(array(
    "write" => array("save", "write", "update"),
    "get" => array("get", "from"),
    "read" => array("read", "fetch"),
    "show" => array("show", "echo", "print"),
    "increment" => array("++", "add", "inc", "incr", "increment"),
    "bump" => array("bump", "suffix", "release",),
    "format" => array("fmt", "format", "and", "then", "set"),
    "last" => array("last"),
    "help" => array("help"),
    "dry" => array("dry", "nowrite", "dryrun"),
));
















#-- most commands require a pair of $action + $file to be run
$version = "";
class command {
    var $action = "";
    var $file = "";
    var $ext = "";
    var $format = "";
    var $count = 1;
................................................................................



#-- init argv
$argv = array_slice($_SERVER["argv"], 1);
// no args = help
if (empty($argv)) {
    action::help();
}
// just one filename arg = default action to 'get'
elseif (count($argv) == 1) {
    $cmd->action = "get";  //@todo: get_ or set_ from argv[0] basename?
}



#-- go over args list
foreach ($argv as $arg) {


    #-- categorize current argument
    
    // It's a filename
    if (file_exists($arg)) {
        $cmd->file = $arg;
        $cmd->ext = basename(trim(substr($arg, strrpos($arg, ".")), "."));   // extension or basename (e.g. for DEBIAN/control file)
    }

    // STDIN
    elseif ($arg == "-") {
        $cmd->file = "php://stdin";
    }

    // Reuse previous filename and options (but retain current action)
    elseif ($arg == "last") {
        $last->action = $cmd->action;
        $cmd = $last;
        #continue;   // oh no, such a great opportunity missed for using `goto`
    }
    
    // Input version number
    elseif (preg_match("/^$rx_ver$/x", $arg)) {
        if (!is_valid_ver($arg)) { error("Invalid version string supplied '$arg'", 33 /*EDOM*/); }
        $cmd->version = $arg;
    }

    // Action/command name
    else {
    
        // extra flags
        if (strpos($arg, ":")) {
            list($arg, $cmd->format, $cmd->count) = explode(":", "$arg:1");
        }
        
        // normalize
        $cmd->action = $action_aliases[ltrim($arg, "-")]
        or error("Unknown action command or non-existant file '$arg'\n", 2 /*ENOENT*/);
    }



    #-- Processing/behaviour
    switch ($cmd->action) {

        // Output current $cmd->version
        case "show":
            print $version;
            break;

        // Read and print from file
        case "get":
            if ($cmd->file) {
                action::read($cmd);
                if (!is_valid_ver($cmd->version)) {
                    // return 0.0-0error on failure
                    fwrite(STDOUT, "0.0-0error");
                    error("No version number found in file '$this->file'", 61/*ENODATA*/);
                    // (while --read should not not)
                }
                print $cmd->version;
                $last=$cmd and $cmd=new command();
            }
            break;

        // Silent reading from file
        case "read":
            if ($cmd->file) {
                action::read($cmd);
                $last=$cmd and $cmd=new command();
            }
            break;

        // Update current $version string into target source code
        case "write":
            if ($cmd->file) {

                if (!is_valid_ver($version)) {
                    // fail
                    error("No valid version number to write. Aborting.", 33 /*EDOM*/);
                }
                action::write($cmd);
                $last=$cmd and $cmd=new command();
            }
            break;

        // Increment patch version number 0.0.x or 0.0.0.x
        case "increment":
            action::increment($cmd);
            break;

        // Increment or add release suffix 0.0-1
        case "bump":
            action::bump($cmd);
            break;
            
        // Make 'write' command non-writey
        case "dry":
            $cmd->dry = 1;
            break;

        // NOP
        case "":

        case "format":
            // do nothing (--format:TYPE:N params can be attached to any other command, --format itself incurs no action)
            break;

        // Should've been catched earlier (= an assert() would do here)            


        default:
            error("Unimplemented action '$cmd->action'\n", 24 /*EINVAL*/);
    }
}



/**
 * Action implementation
................................................................................
        $limit = $cmd->count ? (int)$cmd->count : 1;
        //@bug: PHP applies the limit to each regex in the list, not as overall

        // replace
        $src = preg_replace_callback
            (
                rx::get($cmd),
                function($m) use ($cmd, &$limit) {
                
                    // apply application stop here, because preg_replace() only does for *each* rx[] list entry
                    if ($limit-- <= 0) {
                        return $m[0];
                    }
                    
                    // replace 
................................................................................
        else {
            $cmd->version .= "-0";
        }
    }



    /**
     * Print out file comment as --help
     *
     */
    function help() {
        $src = file_get_contents(__FILE__) and preg_match("#/\*\*.+?\*/#s", $src, $m) and $src = $m[0];
        $src = preg_replace("#^/\*+\s*$|^\s*\*/$|^ \*(@version.+)? ?#m", "", $src);
        $src = preg_replace(
            array("/^\w+:|--/m",       "/version/",       "/get|show|read|write|incr|bump|format/", "/[a-z]\w+\.\w+/", "/:/"),
            array("\33[30;1m$0\33[0m", "\33[32m$0\33[0m", "\33[31m$0\33[0m",                        "\33[36m$0\33[0m", "\33[33;1m$0\33[0m"),
            $src
        );
        die($src);
    }            



    #-- binary handlers


    
    // read "version" meta field via binary helpers
................................................................................
            }
            elseif (isset($ext_to_rxformat[$s])) {
                foreach ($ext_to_rxformat[$s] as $s2) {
                    $rx[] = $rx_format[$s2];
                }
            }
            else {
                error("Unkown file extension or rx_format '$s' name", 65 /*ENOPKG*/);
            }
        }
        return $rx;
    }
    
    /**
     * Combine a list of regex parts with $rx_ver, $rx_end
................................................................................
        foreach ($values as $v) {
            $r[$v] = $key;
        }
    }
    return $r;
}



/**
 * Abort.
 *
 *
 */
function error($msg="aborted", $errno=-1) {
    fwrite(STDERR, basename($_SERVER['argv'][0]) . ": " . $msg . "\n");
    if ($errno > 0) {
        exit($errno   );
    }
}




/**
 * Version string conformance testing.
 *
 *  Applies $rx_ver obviously,
 *  but also checks for `0.0-0error` specials (which --get may have returned on previous runs).
 *
 */
function is_valid_ver($version) {
    global $rx_ver;
    return preg_match("/^($rx_ver)$/x", $version)
       and !preg_match("/^0\.0([0.-]*|[12]?error)+$/", $version);
}

?>