summaryrefslogtreecommitdiffstats
path: root/php-victorjonsson-markdowndocs.spec
blob: 03bc6cd5412f4e225b2d63c3fab23b854ead7bf6 (plain)
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
# remirepo spec file for php-victorjonsson-markdowndocs, from:
#
# Fedora spec file for php-victorjonsson-markdowndocs
#
# Copyright (c) 2016-2021 Shawn Iwinski <shawn@iwin.ski>
#
# License: MIT
# http://opensource.org/licenses/MIT
#
# Please preserve changelog entries
#

%global github_owner     victorjonsson
%global github_name      PHP-Markdown-Documentation-Generator
%global github_version   1.3.8
%global github_commit    c5eb16ff5bd15ee60223883ddacba0ab8797268d

%global composer_vendor  victorjonsson
%global composer_project markdowndocs

# "php" : ">=5.5.0"
%global php_min_ver 5.5.0
# "symfony/console": ">=2.6"
%global symfony_min_ver 2.6
%global symfony_max_ver 3

# Build using "--without tests" to disable tests
%global with_tests 0%{!?_without_tests:1}

%{!?phpdir:  %global phpdir  %{_datadir}/php}

Name:          php-%{composer_vendor}-%{composer_project}
Version:       %{github_version}
Release:       1%{?github_release}%{?dist}
Summary:       Command line tool for generating markdown-formatted class documentation

License:       MIT
URL:           https://github.com/%{github_owner}/%{github_name}
Source0:       %{url}/archive/%{github_commit}/%{name}-%{github_version}-%{github_commit}.tar.gz

# Add LICENSE file
# https://patch-diff.githubusercontent.com/raw/victorjonsson/PHP-Markdown-Documentation-Generator/pull/10
Patch0:        %{name}-pull-request-10.patch
# Set CLI version (instead of reading composer.json)
Patch1:        %{name}-cli-version.patch
# Modify bin autoloader
Patch2:        %{name}-bin.patch
# For PHP 8
Patch3:        %{name}-php8.patch


BuildArch:     noarch
# Tests
%if %{with_tests}
## composer.json
BuildRequires: php(language) >= %{php_min_ver}
BuildRequires: php-composer(phpunit/phpunit)
BuildRequires: php-composer(symfony/console) <  %{symfony_max_ver}
BuildRequires: php-composer(symfony/console) >= %{symfony_min_ver}
## phpcompatinfo (computed from version 1.3.7)
BuildRequires: php-json
BuildRequires: php-pcre
BuildRequires: php-reflection
BuildRequires: php-spl
## Autoloader
BuildRequires: php-composer(fedora/autoloader)
%endif

Requires:      php-cli
# composer.json
Requires:      php(language) >= %{php_min_ver}
Requires:      php-composer(symfony/console) <  %{symfony_max_ver}
Requires:      php-composer(symfony/console) >= %{symfony_min_ver}
# phpcompatinfo (computed from version 1.3.7)
Requires:      php-json
Requires:      php-pcre
Requires:      php-reflection
Requires:      php-spl
# Autoloader
Requires:      php-composer(fedora/autoloader)

# Composer
Provides:      php-composer(%{composer_vendor}/%{composer_project}) = %{version}

%description
Documentation is just as important as the code it's referring to. With this
command line tool you will be able to write your documentation once, and only
once!

This project will write a single-page markdown-formatted API document based on
the DocBlock comments in your source code. The phpdoc standard is used.

Autoloader: %{phpdir}/PHPDocsMD/autoload.php


%prep
%setup -qn %{github_name}-%{github_commit}

: Add LICENSE file
%patch0 -p1

: Set CLI version -- instead of reading composer.json
%patch1 -p1
sed -i 's#__VERSION__#%{version}#' src/PHPDocsMD/Console/CLI.php

: Modify bin autoloader
%patch2 -p1
sed -i 's#__PHPDIR__#%{phpdir}#' bin/phpdoc-md

: PHP 8
%patch3 -p1

: Fix rpmlint "wrong-file-end-of-line-encoding" warning
sed -i 's/\r$//' README.md


%build
: Create autoloader
cat <<'AUTOLOAD' | tee src/PHPDocsMD/autoload.php
<?php
/**
 * Autoloader for %{name} and its' dependencies
 * (created by %{name}-%{version}-%{release}).
 */
require_once '%{phpdir}/Fedora/Autoloader/autoload.php';

\Fedora\Autoloader\Autoload::addPsr4('PHPDocsMD\\', __DIR__);

\Fedora\Autoloader\Dependencies::required(array(
    '%{phpdir}/Symfony/Component/Console/autoload.php',
));
AUTOLOAD


%install
: Library
mkdir -p %{buildroot}%{phpdir}
cp -rp src/PHPDocsMD %{buildroot}%{phpdir}/

: Bin
mkdir -p %{buildroot}%{_bindir}
install -pm 0755 bin/phpdoc-md %{buildroot}%{_bindir}/phpdoc-md


%check
%if %{with_tests}
BOOTSTRAP=%{buildroot}%{phpdir}/PHPDocsMD/autoload.php

: Upstream tests
SCL_RETURN_CODE=0
for SCL in php php73 php74 php80; do
    if which $SCL; then
       $SCL %{_bindir}/phpunit --bootstrap $BOOTSTRAP || SCL_RETURN_CODE=1
    fi
done
exit $SCL_RETURN_CODE
%else
: Tests skipped
%endif



%files
# remirepo:1
%{!?_licensedir:%global license %%doc}
%license LICENSE
%doc *.md
%doc composer.json
%{phpdir}/PHPDocsMD
%{_bindir}/phpdoc-md


%changelog
* Fri Apr  9 2021 Remi Collet <remi@remirepo.net> - 1.3.8-1
- update to 1.3.8
- add patch for PHP 8 from
  https://github.com/victorjonsson/PHP-Markdown-Documentation-Generator/pull/25

* Mon Jan  9 2017 Remi Collet <remi@remirepo.net> - 1.3.7-1
- add backport stuff

* Mon Dec 26 2016 Shawn Iwinski <shawn@iwin.ski> - 1.3.7-1
- Initial package