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
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
|
<?php
/*
* $Id: 53453b21a5d05a7ce53a8525a286f2f05a86548d $
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* This software consists of voluntary contributions made by many individuals
* and is licensed under the LGPL. For more information please see
* <http://phing.info>.
*/
require_once 'phing/Task.php';
/**
* VersionTask
*
* Increments a three-part version number from a given file
* and writes it back to the file.
* Incrementing is based on given releasetype, which can be one
* of Major, Minor and Bugfix.
* Resulting version number is also published under supplied property.
*
* @author Mike Wittje <mw@mike.wittje.de>
* @version $Id: 53453b21a5d05a7ce53a8525a286f2f05a86548d $ $Rev $Id: 53453b21a5d05a7ce53a8525a286f2f05a86548d $ $Author$
* @package phing.tasks.ext
*/
class VersionTask extends Task
{
/**
* Property for Releasetype
* @var string $releasetype
*/
private $releasetype;
/**
* Property for File
* @var PhingFile file
*/
private $file;
/**
* Property to be set
* @var string $property
*/
private $property;
/* Allowed Releastypes */
const RELEASETYPE_MAJOR = 'MAJOR';
const RELEASETYPE_MINOR = 'MINOR';
const RELEASETYPE_BUGFIX = 'BUGFIX';
/**
* Set Property for Releasetype (Minor, Major, Bugfix)
* @param string $releasetype
*/
public function setReleasetype($releasetype)
{
$this->releasetype = strtoupper($releasetype);
}
/**
* Set Property for File containing versioninformation
* @param PhingFile $file
*/
public function setFile($file)
{
$this->file = $file;
}
/**
* Set name of property to be set
* @param $property
* @return void
*/
public function setProperty($property)
{
$this->property = $property;
}
/**
* Main-Method for the Task
*
* @return void
* @throws BuildException
*/
public function main()
{
// check supplied attributes
$this->checkReleasetype();
$this->checkFile();
$this->checkProperty();
// read file
$filecontent = trim(file_get_contents($this->file));
// get new version
$newVersion = $this->getVersion($filecontent);
// write new Version to file
file_put_contents($this->file, $newVersion . "\n");
// publish new version number as property
$this->project->setProperty($this->property, $newVersion);
}
/**
* Returns new version number corresponding to Release type
*
* @param string $filecontent
* @return string
*/
private function getVersion($filecontent)
{
// init
$newVersion = '';
// Extract version
list($major, $minor, $bugfix) = explode(".", $filecontent);
// Return new version number
switch ($this->releasetype) {
case self::RELEASETYPE_MAJOR:
$newVersion = sprintf("%d.%d.%d", ++$major,
0,
0);
break;
case self::RELEASETYPE_MINOR:
$newVersion = sprintf("%d.%d.%d", $major,
++$minor,
0);
break;
case self::RELEASETYPE_BUGFIX:
$newVersion = sprintf("%d.%d.%d", $major,
$minor,
++$bugfix);
break;
}
return $newVersion;
}
/**
* checks releasetype attribute
* @return void
* @throws BuildException
*/
private function checkReleasetype()
{
// check Releasetype
if (is_null($this->releasetype)) {
throw new BuildException('releasetype attribute is required', $this->location);
}
// known releasetypes
$releaseTypes = array(
self::RELEASETYPE_MAJOR,
self::RELEASETYPE_MINOR,
self::RELEASETYPE_BUGFIX
);
if (!in_array($this->releasetype, $releaseTypes)) {
throw new BuildException(sprintf('Unknown Releasetype %s..Must be one of Major, Minor or Bugfix',
$this->releasetype), $this->location);
}
}
/**
* checks file attribute
* @return void
* @throws BuildException
*/
private function checkFile()
{
// check File
if ($this->file === null ||
strlen($this->file) == 0) {
throw new BuildException('You must specify a file containing the version number', $this->location);
}
$content = file_get_contents($this->file);
if (strlen($content) == 0) {
throw new BuildException(sprintf('Supplied file %s is empty', $this->file), $this->location);
}
// check for three-part number
$split = explode('.', $content);
if (count($split) !== 3) {
throw new BuildException('Unknown version number format', $this->location);
}
}
/**
* checks property attribute
* @return void
* @throws BuildException
*/
private function checkProperty()
{
if (is_null($this->property) ||
strlen($this->property) === 0) {
throw new BuildException('Property for publishing version number is not set', $this->location);
}
}
}
|
