├── .github └── workflows │ └── ci.yml ├── .gitignore ├── .rubocop.yml ├── COPYING ├── GPLv2 ├── GPLv3 ├── Gemfile ├── LICENSE ├── README.md ├── Rakefile ├── VERSION ├── data ├── fonts │ └── DejaVuSans.ttf ├── images │ └── dice.png └── pdfs │ ├── arch_e1.pdf │ ├── complex_template.pdf │ ├── contains_ttf_font.pdf │ ├── corrupt_identifier_for_nil.pdf │ ├── curves.pdf │ ├── encrypted.pdf │ ├── form.pdf │ ├── hexagon.pdf │ ├── indirect_reference.pdf │ ├── multipage_template.pdf │ ├── nested_pages.pdf │ ├── page_with_mediabox_reference.pdf │ ├── page_without_mediabox.pdf │ ├── resources_as_indirect_object.pdf │ ├── two_hexagons.pdf │ └── version_1_6.pdf ├── lib ├── pdf │ └── core │ │ ├── document_state.rb │ │ ├── errors.rb │ │ ├── object_store.rb │ │ └── page.rb └── prawn │ ├── document │ └── internals.rb │ ├── templates.rb │ └── text.rb ├── prawn-templates.gemspec └── spec ├── prawn └── templates_spec.rb └── spec_helper.rb /.github/workflows/ci.yml: -------------------------------------------------------------------------------- 1 | name: CI 2 | 3 | on: 4 | push: 5 | pull_request: 6 | schedule: 7 | - cron: "6 20 * * 6" 8 | 9 | jobs: 10 | code-style: 11 | runs-on: ubuntu-latest 12 | steps: 13 | - uses: actions/checkout@v1 14 | - name: Set up Ruby 15 | uses: ruby/setup-ruby@v1 16 | with: 17 | ruby-version: 3.1.0 18 | - name: Gems cache 19 | uses: actions/cache@v2 20 | with: 21 | path: ~/gems 22 | key: gems-3.1.0-${{ hashFiles('*.gemspec', 'Gemfile') }}-${{ github.sha }} 23 | restore-keys: | 24 | gems-3.1.0-${{ hashFiles('*.gemspec', 'Gemfile') }}- 25 | gems-3.1.0- 26 | - name: Install dependencies 27 | run: | 28 | gem install bundler 29 | bundle config path ~/gems 30 | bundle install --jobs 4 --retry 3 31 | - name: Check code style 32 | run: bundle exec rake rubocop 33 | test: 34 | runs-on: ubuntu-latest 35 | strategy: 36 | fail-fast: false 37 | matrix: 38 | ruby: 39 | - "2.6.0" 40 | - "2.6" 41 | - "2.7.0" 42 | - "2.7" 43 | - "3.0.0" 44 | - "3.0" 45 | - jruby-9.3 46 | steps: 47 | - uses: actions/checkout@v1 48 | - name: Set up Ruby 49 | uses: ruby/setup-ruby@v1 50 | with: 51 | ruby-version: ${{ matrix.ruby }} 52 | - name: Gems cache 53 | uses: actions/cache@v2 54 | with: 55 | path: ~/gems 56 | key: gems-${{ matrix.ruby }}-${{ hashFiles('*.gemspec', 'Gemfile') }}-${{ github.sha }} 57 | restore-keys: | 58 | gems-${{ matrix.ruby }}-${{ hashFiles('*.gemspec', 'Gemfile') }}- 59 | gems-${{ matrix.ruby }}- 60 | - name: Install dependencies 61 | run: | 62 | gem install bundler 63 | bundle config path ~/gems 64 | bundle install --jobs 4 --retry 3 65 | - name: Run tests 66 | run: bundle exec rake spec 67 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | Gemfile.lock 2 | *.gem 3 | .idea/ 4 | .project 5 | -------------------------------------------------------------------------------- /.rubocop.yml: -------------------------------------------------------------------------------- 1 | inherit_gem: 2 | prawn-dev: rubocop.yml 3 | 4 | RSpec/ExampleLength: 5 | Enabled: false 6 | 7 | RSpec/MultipleExpectations: 8 | Enabled: false 9 | 10 | RSpec/NestedGroups: 11 | Max: 5 12 | 13 | RSpec/NotToNot: 14 | EnforcedStyle: to_not 15 | 16 | Metrics/AbcSize: 17 | Enabled: false 18 | Metrics/BlockLength: 19 | Exclude: 20 | - prawn-templates.gemspec 21 | - spec/**/*.rb 22 | Metrics/ClassLength: 23 | Enabled: false 24 | Metrics/CyclomaticComplexity: 25 | Enabled: false 26 | Metrics/MethodLength: 27 | Enabled: false 28 | Metrics/ModuleLength: 29 | Enabled: false 30 | Metrics/PerceivedComplexity: 31 | Enabled: false 32 | 33 | Layout/ParameterAlignment: 34 | EnforcedStyle: with_fixed_indentation 35 | 36 | # We need to reference non-ascii characters when testing and explaining 37 | # behavior related to win-1252, UTF-8 and UTF-16 encodings for example. 38 | Style/AsciiComments: 39 | Enabled: false 40 | 41 | Style/Documentation: 42 | Enabled: false 43 | 44 | Layout/FirstArrayElementLineBreak: 45 | Enabled: true 46 | 47 | Layout/FirstHashElementLineBreak: 48 | Enabled: true 49 | 50 | Layout/FirstMethodArgumentLineBreak: 51 | Enabled: true 52 | 53 | Layout/FirstParameterIndentation: 54 | EnforcedStyle: consistent 55 | 56 | Style/GuardClause: 57 | Enabled: false 58 | 59 | # We don't always prefer modified if statements even if they do fit on 60 | # a line. 61 | Style/IfUnlessModifier: 62 | Enabled: false 63 | 64 | Layout/FirstArrayElementIndentation: 65 | EnforcedStyle: consistent 66 | 67 | Layout/FirstHashElementIndentation: 68 | EnforcedStyle: consistent 69 | 70 | Layout/MultilineMethodCallIndentation: 71 | EnforcedStyle: indented 72 | 73 | Layout/MultilineOperationIndentation: 74 | EnforcedStyle: indented 75 | Exclude: 76 | - prawn-templates.gemspec 77 | 78 | Style/PercentLiteralDelimiters: 79 | PreferredDelimiters: 80 | '%': '()' 81 | '%i': '[]' 82 | '%I': '[]' 83 | '%q': '()' 84 | '%Q': '()' 85 | '%r': '{}' 86 | '%s': '()' 87 | '%w': '[]' 88 | '%W': '[]' 89 | '%x': '()' 90 | 91 | Layout/SpaceAroundOperators: 92 | AllowForAlignment: false 93 | 94 | Style/WhileUntilModifier: 95 | Enabled: false 96 | -------------------------------------------------------------------------------- /COPYING: -------------------------------------------------------------------------------- 1 | Prawn may be used under Matz's original licensing terms for Ruby, or GPLv2 or GPLv3. 2 | See LICENSE for Matz's terms, or GPLv2 and GPLv3 files. 3 | -------------------------------------------------------------------------------- /GPLv2: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 2, June 1991 3 | 4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc., 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | Preamble 10 | 11 | The licenses for most software are designed to take away your 12 | freedom to share and change it. By contrast, the GNU General Public 13 | License is intended to guarantee your freedom to share and change free 14 | software--to make sure the software is free for all its users. This 15 | General Public License applies to most of the Free Software 16 | Foundation's software and to any other program whose authors commit to 17 | using it. (Some other Free Software Foundation software is covered by 18 | the GNU Library General Public License instead.) You can apply it to 19 | your programs, too. 20 | 21 | When we speak of free software, we are referring to freedom, not 22 | price. Our General Public Licenses are designed to make sure that you 23 | have the freedom to distribute copies of free software (and charge for 24 | this service if you wish), that you receive source code or can get it 25 | if you want it, that you can change the software or use pieces of it 26 | in new free programs; and that you know you can do these things. 27 | 28 | To protect your rights, we need to make restrictions that forbid 29 | anyone to deny you these rights or to ask you to surrender the rights. 30 | These restrictions translate to certain responsibilities for you if you 31 | distribute copies of the software, or if you modify it. 32 | 33 | For example, if you distribute copies of such a program, whether 34 | gratis or for a fee, you must give the recipients all the rights that 35 | you have. You must make sure that they, too, receive or can get the 36 | source code. And you must show them these terms so they know their 37 | rights. 38 | 39 | We protect your rights with two steps: (1) copyright the software, and 40 | (2) offer you this license which gives you legal permission to copy, 41 | distribute and/or modify the software. 42 | 43 | Also, for each author's protection and ours, we want to make certain 44 | that everyone understands that there is no warranty for this free 45 | software. If the software is modified by someone else and passed on, we 46 | want its recipients to know that what they have is not the original, so 47 | that any problems introduced by others will not reflect on the original 48 | authors' reputations. 49 | 50 | Finally, any free program is threatened constantly by software 51 | patents. We wish to avoid the danger that redistributors of a free 52 | program will individually obtain patent licenses, in effect making the 53 | program proprietary. To prevent this, we have made it clear that any 54 | patent must be licensed for everyone's free use or not licensed at all. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | GNU GENERAL PUBLIC LICENSE 60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 61 | 62 | 0. This License applies to any program or other work which contains 63 | a notice placed by the copyright holder saying it may be distributed 64 | under the terms of this General Public License. The "Program", below, 65 | refers to any such program or work, and a "work based on the Program" 66 | means either the Program or any derivative work under copyright law: 67 | that is to say, a work containing the Program or a portion of it, 68 | either verbatim or with modifications and/or translated into another 69 | language. (Hereinafter, translation is included without limitation in 70 | the term "modification".) Each licensee is addressed as "you". 71 | 72 | Activities other than copying, distribution and modification are not 73 | covered by this License; they are outside its scope. The act of 74 | running the Program is not restricted, and the output from the Program 75 | is covered only if its contents constitute a work based on the 76 | Program (independent of having been made by running the Program). 77 | Whether that is true depends on what the Program does. 78 | 79 | 1. You may copy and distribute verbatim copies of the Program's 80 | source code as you receive it, in any medium, provided that you 81 | conspicuously and appropriately publish on each copy an appropriate 82 | copyright notice and disclaimer of warranty; keep intact all the 83 | notices that refer to this License and to the absence of any warranty; 84 | and give any other recipients of the Program a copy of this License 85 | along with the Program. 86 | 87 | You may charge a fee for the physical act of transferring a copy, and 88 | you may at your option offer warranty protection in exchange for a fee. 89 | 90 | 2. You may modify your copy or copies of the Program or any portion 91 | of it, thus forming a work based on the Program, and copy and 92 | distribute such modifications or work under the terms of Section 1 93 | above, provided that you also meet all of these conditions: 94 | 95 | a) You must cause the modified files to carry prominent notices 96 | stating that you changed the files and the date of any change. 97 | 98 | b) You must cause any work that you distribute or publish, that in 99 | whole or in part contains or is derived from the Program or any 100 | part thereof, to be licensed as a whole at no charge to all third 101 | parties under the terms of this License. 102 | 103 | c) If the modified program normally reads commands interactively 104 | when run, you must cause it, when started running for such 105 | interactive use in the most ordinary way, to print or display an 106 | announcement including an appropriate copyright notice and a 107 | notice that there is no warranty (or else, saying that you provide 108 | a warranty) and that users may redistribute the program under 109 | these conditions, and telling the user how to view a copy of this 110 | License. (Exception: if the Program itself is interactive but 111 | does not normally print such an announcement, your work based on 112 | the Program is not required to print an announcement.) 113 | 114 | These requirements apply to the modified work as a whole. If 115 | identifiable sections of that work are not derived from the Program, 116 | and can be reasonably considered independent and separate works in 117 | themselves, then this License, and its terms, do not apply to those 118 | sections when you distribute them as separate works. But when you 119 | distribute the same sections as part of a whole which is a work based 120 | on the Program, the distribution of the whole must be on the terms of 121 | this License, whose permissions for other licensees extend to the 122 | entire whole, and thus to each and every part regardless of who wrote it. 123 | 124 | Thus, it is not the intent of this section to claim rights or contest 125 | your rights to work written entirely by you; rather, the intent is to 126 | exercise the right to control the distribution of derivative or 127 | collective works based on the Program. 128 | 129 | In addition, mere aggregation of another work not based on the Program 130 | with the Program (or with a work based on the Program) on a volume of 131 | a storage or distribution medium does not bring the other work under 132 | the scope of this License. 133 | 134 | 3. You may copy and distribute the Program (or a work based on it, 135 | under Section 2) in object code or executable form under the terms of 136 | Sections 1 and 2 above provided that you also do one of the following: 137 | 138 | a) Accompany it with the complete corresponding machine-readable 139 | source code, which must be distributed under the terms of Sections 140 | 1 and 2 above on a medium customarily used for software interchange; or, 141 | 142 | b) Accompany it with a written offer, valid for at least three 143 | years, to give any third party, for a charge no more than your 144 | cost of physically performing source distribution, a complete 145 | machine-readable copy of the corresponding source code, to be 146 | distributed under the terms of Sections 1 and 2 above on a medium 147 | customarily used for software interchange; or, 148 | 149 | c) Accompany it with the information you received as to the offer 150 | to distribute corresponding source code. (This alternative is 151 | allowed only for noncommercial distribution and only if you 152 | received the program in object code or executable form with such 153 | an offer, in accord with Subsection b above.) 154 | 155 | The source code for a work means the preferred form of the work for 156 | making modifications to it. For an executable work, complete source 157 | code means all the source code for all modules it contains, plus any 158 | associated interface definition files, plus the scripts used to 159 | control compilation and installation of the executable. However, as a 160 | special exception, the source code distributed need not include 161 | anything that is normally distributed (in either source or binary 162 | form) with the major components (compiler, kernel, and so on) of the 163 | operating system on which the executable runs, unless that component 164 | itself accompanies the executable. 165 | 166 | If distribution of executable or object code is made by offering 167 | access to copy from a designated place, then offering equivalent 168 | access to copy the source code from the same place counts as 169 | distribution of the source code, even though third parties are not 170 | compelled to copy the source along with the object code. 171 | 172 | 4. You may not copy, modify, sublicense, or distribute the Program 173 | except as expressly provided under this License. Any attempt 174 | otherwise to copy, modify, sublicense or distribute the Program is 175 | void, and will automatically terminate your rights under this License. 176 | However, parties who have received copies, or rights, from you under 177 | this License will not have their licenses terminated so long as such 178 | parties remain in full compliance. 179 | 180 | 5. You are not required to accept this License, since you have not 181 | signed it. However, nothing else grants you permission to modify or 182 | distribute the Program or its derivative works. These actions are 183 | prohibited by law if you do not accept this License. Therefore, by 184 | modifying or distributing the Program (or any work based on the 185 | Program), you indicate your acceptance of this License to do so, and 186 | all its terms and conditions for copying, distributing or modifying 187 | the Program or works based on it. 188 | 189 | 6. Each time you redistribute the Program (or any work based on the 190 | Program), the recipient automatically receives a license from the 191 | original licensor to copy, distribute or modify the Program subject to 192 | these terms and conditions. You may not impose any further 193 | restrictions on the recipients' exercise of the rights granted herein. 194 | You are not responsible for enforcing compliance by third parties to 195 | this License. 196 | 197 | 7. If, as a consequence of a court judgment or allegation of patent 198 | infringement or for any other reason (not limited to patent issues), 199 | conditions are imposed on you (whether by court order, agreement or 200 | otherwise) that contradict the conditions of this License, they do not 201 | excuse you from the conditions of this License. If you cannot 202 | distribute so as to satisfy simultaneously your obligations under this 203 | License and any other pertinent obligations, then as a consequence you 204 | may not distribute the Program at all. For example, if a patent 205 | license would not permit royalty-free redistribution of the Program by 206 | all those who receive copies directly or indirectly through you, then 207 | the only way you could satisfy both it and this License would be to 208 | refrain entirely from distribution of the Program. 209 | 210 | If any portion of this section is held invalid or unenforceable under 211 | any particular circumstance, the balance of the section is intended to 212 | apply and the section as a whole is intended to apply in other 213 | circumstances. 214 | 215 | It is not the purpose of this section to induce you to infringe any 216 | patents or other property right claims or to contest validity of any 217 | such claims; this section has the sole purpose of protecting the 218 | integrity of the free software distribution system, which is 219 | implemented by public license practices. Many people have made 220 | generous contributions to the wide range of software distributed 221 | through that system in reliance on consistent application of that 222 | system; it is up to the author/donor to decide if he or she is willing 223 | to distribute software through any other system and a licensee cannot 224 | impose that choice. 225 | 226 | This section is intended to make thoroughly clear what is believed to 227 | be a consequence of the rest of this License. 228 | 229 | 8. If the distribution and/or use of the Program is restricted in 230 | certain countries either by patents or by copyrighted interfaces, the 231 | original copyright holder who places the Program under this License 232 | may add an explicit geographical distribution limitation excluding 233 | those countries, so that distribution is permitted only in or among 234 | countries not thus excluded. In such case, this License incorporates 235 | the limitation as if written in the body of this License. 236 | 237 | 9. The Free Software Foundation may publish revised and/or new versions 238 | of the General Public License from time to time. Such new versions will 239 | be similar in spirit to the present version, but may differ in detail to 240 | address new problems or concerns. 241 | 242 | Each version is given a distinguishing version number. If the Program 243 | specifies a version number of this License which applies to it and "any 244 | later version", you have the option of following the terms and conditions 245 | either of that version or of any later version published by the Free 246 | Software Foundation. If the Program does not specify a version number of 247 | this License, you may choose any version ever published by the Free Software 248 | Foundation. 249 | 250 | 10. If you wish to incorporate parts of the Program into other free 251 | programs whose distribution conditions are different, write to the author 252 | to ask for permission. For software which is copyrighted by the Free 253 | Software Foundation, write to the Free Software Foundation; we sometimes 254 | make exceptions for this. Our decision will be guided by the two goals 255 | of preserving the free status of all derivatives of our free software and 256 | of promoting the sharing and reuse of software generally. 257 | 258 | NO WARRANTY 259 | 260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY 261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN 262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED 264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS 266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE 267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, 268 | REPAIR OR CORRECTION. 269 | 270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR 272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING 274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED 275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY 276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER 277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 278 | POSSIBILITY OF SUCH DAMAGES. 279 | 280 | END OF TERMS AND CONDITIONS 281 | 282 | How to Apply These Terms to Your New Programs 283 | 284 | If you develop a new program, and you want it to be of the greatest 285 | possible use to the public, the best way to achieve this is to make it 286 | free software which everyone can redistribute and change under these terms. 287 | 288 | To do so, attach the following notices to the program. It is safest 289 | to attach them to the start of each source file to most effectively 290 | convey the exclusion of warranty; and each file should have at least 291 | the "copyright" line and a pointer to where the full notice is found. 292 | 293 | 294 | Copyright (C) 295 | 296 | This program is free software; you can redistribute it and/or modify 297 | it under the terms of the GNU General Public License as published by 298 | the Free Software Foundation; either version 2 of the License, or 299 | (at your option) any later version. 300 | 301 | This program is distributed in the hope that it will be useful, 302 | but WITHOUT ANY WARRANTY; without even the implied warranty of 303 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 304 | GNU General Public License for more details. 305 | 306 | You should have received a copy of the GNU General Public License 307 | along with this program; if not, write to the Free Software 308 | Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 309 | 310 | 311 | Also add information on how to contact you by electronic and paper mail. 312 | 313 | If the program is interactive, make it output a short notice like this 314 | when it starts in an interactive mode: 315 | 316 | Gnomovision version 69, Copyright (C) year name of author 317 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 318 | This is free software, and you are welcome to redistribute it 319 | under certain conditions; type `show c' for details. 320 | 321 | The hypothetical commands `show w' and `show c' should show the appropriate 322 | parts of the General Public License. Of course, the commands you use may 323 | be called something other than `show w' and `show c'; they could even be 324 | mouse-clicks or menu items--whatever suits your program. 325 | 326 | You should also get your employer (if you work as a programmer) or your 327 | school, if any, to sign a "copyright disclaimer" for the program, if 328 | necessary. Here is a sample; alter the names: 329 | 330 | Yoyodyne, Inc., hereby disclaims all copyright interest in the program 331 | `Gnomovision' (which makes passes at compilers) written by James Hacker. 332 | 333 | , 1 April 1989 334 | Ty Coon, President of Vice 335 | 336 | This General Public License does not permit incorporating your program into 337 | proprietary programs. If your program is a subroutine library, you may 338 | consider it more useful to permit linking proprietary applications with the 339 | library. If this is what you want to do, use the GNU Library General 340 | Public License instead of this License. 341 | -------------------------------------------------------------------------------- /GPLv3: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /Gemfile: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | source 'https://rubygems.org' 4 | 5 | gemspec 6 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Prawn::Templates is copyrighted free software produced by James Healy 2 | along with community contributions. 3 | 4 | Licensing terms follow: 5 | 6 | You can redistribute Prawn::Templates and/or modify it under either the terms of the GPLv2 7 | or GPLv3 (see GPLv2 and GPLv3 files), or the conditions below: 8 | 9 | 1. You may make and give away verbatim copies of the source form of the 10 | software without restriction, provided that you duplicate all of the 11 | original copyright notices and associated disclaimers. 12 | 13 | 2. You may modify your copy of the software in any way, provided that 14 | you do at least ONE of the following: 15 | 16 | a) place your modifications in the Public Domain or otherwise 17 | make them Freely Available, such as by posting said 18 | modifications to Usenet or an equivalent medium, or by allowing 19 | the author to include your modifications in the software. 20 | 21 | b) use the modified software only within your corporation or 22 | organization. 23 | 24 | c) rename any non-standard executables so the names do not conflict 25 | with standard executables, which must also be provided. 26 | 27 | d) make other distribution arrangements with the author. 28 | 29 | 3. You may distribute the software in object code or executable 30 | form, provided that you do at least ONE of the following: 31 | 32 | a) distribute the executables and library files of the software, 33 | together with instructions (in the manual page or equivalent) 34 | on where to get the original distribution. 35 | 36 | b) accompany the distribution with the machine-readable source of 37 | the software. 38 | 39 | c) give non-standard executables non-standard names, with 40 | instructions on where to get the original software distribution. 41 | 42 | d) make other distribution arrangements with the author. 43 | 44 | 4. You may modify and include the part of the software into any other 45 | software (possibly commercial). 46 | 47 | 5. The scripts and library files supplied as input to or produced as 48 | output from the software do not automatically fall under the 49 | copyright of the software, but belong to whomever generated them, 50 | and may be sold commercially, and may be aggregated with this 51 | software. 52 | 53 | 6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR 54 | IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED 55 | WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 56 | PURPOSE. 57 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Prawn Templates 2 | 3 | [![Gem Version](https://badge.fury.io/rb/prawn-templates.svg)](http://badge.fury.io/rb/prawn-templates) 4 | ![Build Status](https://github.com/prawnpdf/prawn-templates/actions/workflows/ci.yml/badge.svg) 5 | [![Code Climate](https://codeclimate.com/github/prawnpdf/prawn-templates/badges/gpa.svg)](https://codeclimate.com/github/prawnpdf/prawn-templates) 6 | ![Maintained: PRs accepted](https://img.shields.io/badge/maintained-PRs_accepted-orange.svg) 7 | 8 | Support for templates was dropped in Prawn 0.13.0, 9 | disabled by default in 0.14.0, and extracted in 0.15.0. 10 | 11 | This gem includes the extracted templates code, which is mainly 12 | unsupported, but provides the old functionality that was in 13 | Prawn 0.12.0 for years. 14 | 15 | Templates were originally written by James Healy, but are no 16 | longer actively maintained by anyone. Burkhard Vogel created 17 | a port to make the old code work again with the current state 18 | of prawn. Use at your own risk, or volunteer to help maintain 19 | the code through issues and pull requests or on the Prawn 20 | Mailing list: 21 | 22 | https://groups.google.com/forum/#!forum/prawn-ruby 23 | 24 | Keep in mind the reason that this gem was extracted is because the 25 | code is very buggy! For a list of old issues that were affecting 26 | it, see Prawn's tracker: 27 | 28 | https://github.com/prawnpdf/prawn/issues?direction=desc&labels=templates&page=1&sort=updated&state=closed 29 | 30 | Issues that affect releases after 0.0.3 should be filed here. 31 | 32 | For Prawn 2.1.0 use v0.0.4, Prawn 2.2.1 works with 0.0.5, if you rely on 33 | pdf-reader 2.0 you should opt for 0.1.0. Although the gem requires ruby 34 | versions after 1.9.3 only the ones mentioned in `.travis.yml` are 35 | supported. 36 | -------------------------------------------------------------------------------- /Rakefile: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | GEMSPEC = File.expand_path('prawn-templates.gemspec', __dir__) 4 | require 'prawn/dev/tasks' 5 | 6 | task default: %i[spec rubocop] 7 | 8 | desc 'Run all rspec files' 9 | RSpec::Core::RakeTask.new('spec') do |c| 10 | c.rspec_opts = '-t ~unresolved' 11 | end 12 | 13 | RuboCop::RakeTask.new 14 | -------------------------------------------------------------------------------- /VERSION: -------------------------------------------------------------------------------- 1 | 0.1.3 2 | -------------------------------------------------------------------------------- /data/fonts/DejaVuSans.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/prawnpdf/prawn-templates/6452b4ea9c80ef4cc7e29cd58e39e2a2ca30492d/data/fonts/DejaVuSans.ttf -------------------------------------------------------------------------------- /data/images/dice.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/prawnpdf/prawn-templates/6452b4ea9c80ef4cc7e29cd58e39e2a2ca30492d/data/images/dice.png -------------------------------------------------------------------------------- /data/pdfs/arch_e1.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/prawnpdf/prawn-templates/6452b4ea9c80ef4cc7e29cd58e39e2a2ca30492d/data/pdfs/arch_e1.pdf -------------------------------------------------------------------------------- /data/pdfs/complex_template.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/prawnpdf/prawn-templates/6452b4ea9c80ef4cc7e29cd58e39e2a2ca30492d/data/pdfs/complex_template.pdf -------------------------------------------------------------------------------- /data/pdfs/contains_ttf_font.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/prawnpdf/prawn-templates/6452b4ea9c80ef4cc7e29cd58e39e2a2ca30492d/data/pdfs/contains_ttf_font.pdf -------------------------------------------------------------------------------- /data/pdfs/corrupt_identifier_for_nil.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/prawnpdf/prawn-templates/6452b4ea9c80ef4cc7e29cd58e39e2a2ca30492d/data/pdfs/corrupt_identifier_for_nil.pdf -------------------------------------------------------------------------------- /data/pdfs/curves.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/prawnpdf/prawn-templates/6452b4ea9c80ef4cc7e29cd58e39e2a2ca30492d/data/pdfs/curves.pdf -------------------------------------------------------------------------------- /data/pdfs/encrypted.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/prawnpdf/prawn-templates/6452b4ea9c80ef4cc7e29cd58e39e2a2ca30492d/data/pdfs/encrypted.pdf -------------------------------------------------------------------------------- /data/pdfs/form.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/prawnpdf/prawn-templates/6452b4ea9c80ef4cc7e29cd58e39e2a2ca30492d/data/pdfs/form.pdf -------------------------------------------------------------------------------- /data/pdfs/hexagon.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/prawnpdf/prawn-templates/6452b4ea9c80ef4cc7e29cd58e39e2a2ca30492d/data/pdfs/hexagon.pdf -------------------------------------------------------------------------------- /data/pdfs/indirect_reference.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/prawnpdf/prawn-templates/6452b4ea9c80ef4cc7e29cd58e39e2a2ca30492d/data/pdfs/indirect_reference.pdf -------------------------------------------------------------------------------- /data/pdfs/multipage_template.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/prawnpdf/prawn-templates/6452b4ea9c80ef4cc7e29cd58e39e2a2ca30492d/data/pdfs/multipage_template.pdf -------------------------------------------------------------------------------- /data/pdfs/nested_pages.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/prawnpdf/prawn-templates/6452b4ea9c80ef4cc7e29cd58e39e2a2ca30492d/data/pdfs/nested_pages.pdf -------------------------------------------------------------------------------- /data/pdfs/page_with_mediabox_reference.pdf: -------------------------------------------------------------------------------- 1 | %PDF-1.4 2 | 1 0 obj 3 | << /Type /Catalog 4 | /Pages 2 0 R 5 | >> 6 | endobj 7 | 3 0 obj 8 | << /Type /Page 9 | /Parent 2 0 R 10 | /Resources 4 0 R 11 | /MediaBox [0 0 612 792] 12 | /Contents 5 0 R 13 | >> 14 | endobj 15 | 4 0 obj 16 | << /ProcSet [/PDF /ImageB] 17 | /XObject << /Im1 6 0 R >> 18 | >> 19 | endobj 20 | 5 0 obj 21 | << /Length 107 >> 22 | stream 23 | q 24 | 0.480000 0 0 0.480000 0 0 cm 25 | 1 0 0 1 0 0 cm 26 | 1275 0 0 1650 0 0 cm 27 | /Im1 Do 28 | Q 29 | 30 | endstream 31 | endobj 32 | 6 0 obj 33 | << /Length 195 34 | >> 35 | stream 36 | 0.000 0.000 0.000 rg 37 | 0.000 0.000 0.000 RG 38 | q 39 | 1.000 0.000 0.000 rg 40 | 136.000 286.000 m 41 | 236.000 336.000 l 42 | 336.000 286.000 l 43 | 336.000 186.000 l 44 | 236.000 136.000 l 45 | 136.000 186.000 l 46 | 136.000 286.000 l 47 | f 48 | Q 49 | 50 | endstream 51 | endobj 52 | 53 | 7 0 obj 54 | 55597 55 | endobj 56 | 2 0 obj 57 | << /Type /Pages 58 | /Kids [3 0 R ] 59 | /Count 1 60 | >> 61 | endobj 62 | xref 63 | 0 8 64 | 0000000000 65535 f 65 | 0000000009 00000 n 66 | 0000000659 00000 n 67 | 0000000058 00000 n 68 | 0000000162 00000 n 69 | 0000000233 00000 n 70 | 0000000391 00000 n 71 | 0000000638 00000 n 72 | trailer 73 | << /Size 8 74 | /Root 1 0 R 75 | >> 76 | startxref 77 | 717 78 | %%EOF3 0 obj 79 | << 80 | /Type /Page 81 | /Parent 2 0 R 82 | /Resources 4 0 R 83 | /MediaBox 9 0 R 84 | /Contents 5 0 R 85 | /Rotate 90 86 | 87 | >> 88 | 89 | endobj 90 | 9 0 obj 91 | [ 0 0 612 792 ] 92 | endobj 93 | xref 94 | 3 1 95 | 0000000931 00000 n 96 | 9 1 97 | 0000001040 00000 n 98 | trailer 99 | << 100 | /Size 9 101 | /Root 1 0 R 102 | /Prev 717 103 | 104 | >> 105 | 106 | startxref 107 | 1075 108 | %%EOF 109 | -------------------------------------------------------------------------------- /data/pdfs/page_without_mediabox.pdf: -------------------------------------------------------------------------------- 1 | %PDF-1.2 2 | 3 | 1 0 obj % page object - page 1 4 | << 5 | /Type /Page 6 | /Parent 7 0 R % back pointer 7 | /Resources 3 0 R % font to use 8 | /Contents 2 0 R % page image 9 | >> 10 | endobj 11 | 12 | 2 0 obj % contents object 13 | << 14 | /Length 1335 % # of bytes between stream and endstream 15 | >> 16 | stream 17 | % draw three lines of text 18 | 19 | BT 20 | /F1 24 Tf % setfont 21 | 1 0 0 1 72 648 Tm % moveto 22 | (Hello World) Tj % show 23 | 1 0 0 1 72 612 Tm 24 | <4D53835383568362834E3234837C834383938367> Tj % shift-jis string 25 | 1 0 0 1 72 576 Tm 26 | 0.5 g % setgray 27 | <82BB82EA82F08A44904682C982B582BD82E082CC> Tj 28 | ET 29 | 30 | % draw filled, dark blue, shougi koma 31 | 32 | q % gsave 33 | 12 0 0 12 72 360 cm % concat - translate and scale 34 | 0 0 0.5 rg % setcolor for fill 35 | 0 0 m % moveto 36 | 12 0 l % lineto 37 | 10 11 l 38 | 6 12 l 39 | 2 11 l 40 | f % close path and fill 41 | Q % grestore 42 | 43 | % draw stroked brown egg upright 44 | 45 | q 46 | .5 w % setlinewidth 47 | 12 0 0 12 360 360 cm 48 | 0.5 0 0 RG % setcolor for stroking 49 | 0 0 m 50 | 8 0 4 12 0 12 c % curveto 51 | -4 12 -8 0 0 0 c 52 | S % stroke 53 | Q 54 | 55 | % draw bitmap - dark green steps 56 | 57 | 0 0.5 0 rg % fill color 58 | 144 0 0 144 72 144 cm % scale 16x16 bits to two-inch square 59 | BI 60 | /W 16 % pixcel width 61 | /H 16 % height 62 | /BPC 1 % bits per component 63 | /F /AHx % filter = ASCII Hex 64 | /IM true % imagemask (0 - paint, 1 - transparent) 65 | ID 66 | 0FFF 67 | 0FFF 68 | 0FFF 69 | 0FFF 70 | 00FF 71 | 00FF 72 | 00FF 73 | 00FF 74 | 000F 75 | 000F 76 | 000F 77 | 000F 78 | 0000 79 | 0000 80 | 0000 81 | 0000> 82 | EI 83 | endstream 84 | endobj % end of page stream 85 | 86 | 3 0 obj % resource object 87 | << 88 | /ProcSet [ /PDF /Text ] % operators to use 89 | /Font << /F1 4 0 R >> % name the font /F1 90 | >> 91 | endobj 92 | 93 | % Font definition taken from Acrobat 4 PDFWriter (some comments added) 94 | 95 | 4 0 obj % base font 96 | << 97 | /Type /Font 98 | /Subtype /Type0 % Adobe composite font 99 | /BaseFont /#82l#82r#83S#83V#83b#83N % MS-Gothic 100 | /DescendantFonts [ 5 0 R ] % points to actual font 101 | /Encoding /90ms-RKSJ-H % Shift-JIS encoding 102 | >> 103 | endobj 104 | 105 | 5 0 obj % descendent font 106 | << 107 | /Type /Font 108 | /Subtype /CIDFontType2 % TrueType 109 | /BaseFont /#82l#82r#83S#83V#83b#83N % MS-Gothic 110 | /WinCharSet 128 111 | /FontDescriptor 6 0 R % points to metric info 112 | /CIDSystemInfo 113 | << 114 | /Registry(Adobe) 115 | /Ordering(Japan1) 116 | /Supplement 2 117 | >> 118 | /DW 1000 119 | /W [ 120 | 231 389 500 121 | 631 631 500 122 | ] 123 | >> 124 | endobj 125 | 126 | 6 0 obj % font metric information 127 | << 128 | /Type /FontDescriptor 129 | /FontName /#82l#82r#83S#83V#83b#83N 130 | /Flags 39 131 | /FontBBox [ -150 -147 1100 853 ] 132 | /MissingWidth 507 133 | /StemV 92 134 | /StemH 92 135 | /ItalicAngle 0 136 | /CapHeight 853 137 | /XHeight 597 138 | /Ascent 853 139 | /Descent -147 140 | /Leading 0 141 | /MaxWidth 1000 142 | /AvgWidth 507 143 | /Style << /Panose <0805020B0609000000000000> >> 144 | >> 145 | endobj 146 | 147 | % End of font defintion from PDFWriter 148 | 149 | 7 0 obj % pages object 150 | << 151 | /Type /Pages 152 | /Kids [ 1 0 R ] % list of pages (only one in this case) 153 | /Count 1 % # of pages - one 154 | /MediaBox [ 0 0 595 842 ] % A4 portrait 155 | >> 156 | endobj 157 | 158 | 8 0 obj % catalog object 159 | << 160 | /Type /Catalog 161 | /Pages 7 0 R % points to pages object 162 | >> 163 | endobj 164 | 165 | 9 0 obj % info object 166 | << 167 | /CreationDate (D:19991115) 168 | /Title (Hand-written sample PDF) 169 | /Author (ARAI Bunkichi, Yokohama Koubunsha) 170 | >> 171 | endobj 172 | 173 | xref 174 | 0 10 175 | 0000000000 65535 f 176 | 0000000012 00000 n 177 | 0000000184 00000 n 178 | 0000001672 00000 n 179 | 0000001888 00000 n 180 | 0000002185 00000 n 181 | 0000002569 00000 n 182 | 0000002992 00000 n 183 | 0000003218 00000 n 184 | 0000003324 00000 n 185 | trailer 186 | << 187 | /Root 8 0 R % points to catalog object 188 | /Info 9 0 R % info object 189 | /Size 10 % # of entries in xref 190 | >> 191 | startxref 192 | 3475 193 | %%EOF 194 | -------------------------------------------------------------------------------- /data/pdfs/resources_as_indirect_object.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/prawnpdf/prawn-templates/6452b4ea9c80ef4cc7e29cd58e39e2a2ca30492d/data/pdfs/resources_as_indirect_object.pdf -------------------------------------------------------------------------------- /data/pdfs/two_hexagons.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/prawnpdf/prawn-templates/6452b4ea9c80ef4cc7e29cd58e39e2a2ca30492d/data/pdfs/two_hexagons.pdf -------------------------------------------------------------------------------- /data/pdfs/version_1_6.pdf: -------------------------------------------------------------------------------- 1 | %PDF-1.6 2 | %???? 3 | 1 0 obj 4 | << /Creator (Prawn) 5 | /Producer (Prawn) 6 | >> 7 | endobj 8 | 2 0 obj 9 | << /Kids [5 0 R] 10 | /Type /Pages 11 | /Count 1 12 | >> 13 | endobj 14 | 3 0 obj 15 | << /Type /Catalog 16 | /Pages 2 0 R 17 | >> 18 | endobj 19 | 4 0 obj 20 | << /Length 195 21 | >> 22 | stream 23 | 0.000 0.000 0.000 rg 24 | 0.000 0.000 0.000 RG 25 | q 26 | 1.000 0.000 0.000 rg 27 | 136.000 286.000 m 28 | 236.000 336.000 l 29 | 336.000 286.000 l 30 | 336.000 186.000 l 31 | 236.000 136.000 l 32 | 136.000 186.000 l 33 | 136.000 286.000 l 34 | f 35 | Q 36 | 37 | endstream 38 | endobj 39 | 5 0 obj 40 | << /Contents 4 0 R 41 | /Type /Page 42 | /MediaBox [0 0 612.0 792.0] 43 | /Parent 2 0 R 44 | >> 45 | endobj 46 | xref 47 | 0 6 48 | 0000000000 65535 f 49 | 0000000015 00000 n 50 | 0000000071 00000 n 51 | 0000000128 00000 n 52 | 0000000177 00000 n 53 | 0000000423 00000 n 54 | trailer 55 | << /Info 1 0 R 56 | /Size 6 57 | /Root 3 0 R 58 | >> 59 | startxref 60 | 514 61 | %%EOF 62 | -------------------------------------------------------------------------------- /lib/pdf/core/document_state.rb: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | module PDF 4 | module Core 5 | class DocumentState # :nodoc: 6 | alias __initialize initialize 7 | def initialize(options) 8 | normalize_metadata(options) 9 | 10 | if options[:template] 11 | @store = 12 | if options[:print_scaling] 13 | PDF::Core::ObjectStore.new( 14 | template: options[:template], 15 | print_scaling: options[:print_scaling] 16 | ) 17 | else 18 | PDF::Core::ObjectStore.new(template: options[:template]) 19 | end 20 | @store.info.data.merge!(options[:info]) if options[:info] 21 | else 22 | @store = 23 | if options[:print_scaling] 24 | PDF::Core::ObjectStore.new( 25 | info: options[:info], 26 | print_scaling: options[:print_scaling] 27 | ) 28 | else 29 | PDF::Core::ObjectStore.new(info: options[:info]) 30 | end 31 | end 32 | 33 | @version = 1.3 34 | @pages = [] 35 | @page = nil 36 | @trailer = options.fetch(:trailer, {}) 37 | @compress = options.fetch(:compress, false) 38 | @encrypt = options.fetch(:encrypt, false) 39 | @encryption_key = options[:encryption_key] 40 | @skip_encoding = options.fetch(:skip_encoding, false) 41 | @before_render_callbacks = [] 42 | @on_page_create_callback = nil 43 | end 44 | end 45 | end 46 | end 47 | -------------------------------------------------------------------------------- /lib/pdf/core/errors.rb: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | module PDF 4 | module Core 5 | module Errors 6 | # This error is raised when object store fails to load a template file 7 | TemplateError = Class.new(StandardError) 8 | end 9 | end 10 | end 11 | -------------------------------------------------------------------------------- /lib/pdf/core/object_store.rb: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | module PDF 4 | module Core 5 | class ObjectStore # :nodoc: 6 | alias __initialize initialize 7 | def initialize(opts = {}) 8 | @objects = {} 9 | @identifiers = [] 10 | 11 | load_file(opts[:template]) if opts[:template] 12 | 13 | @info ||= ref(opts[:info] || {}).identifier 14 | @root ||= ref(Type: :Catalog).identifier 15 | if opts[:print_scaling] == :none 16 | root.data[:ViewerPreferences] = { PrintScaling: :None } 17 | end 18 | if pages.nil? 19 | root.data[:Pages] = ref(Type: :Pages, Count: 0, Kids: []) 20 | end 21 | end 22 | 23 | alias __utf8? utf8? if method_defined? :utf8? 24 | def utf8?(str) 25 | str.force_encoding(::Encoding::UTF_8) 26 | str.valid_encoding? 27 | end 28 | end 29 | end 30 | end 31 | -------------------------------------------------------------------------------- /lib/pdf/core/page.rb: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | module PDF 4 | module Core 5 | class Page # :nodoc: 6 | alias __initialize initialize 7 | def initialize(document, options = {}) 8 | @document = document 9 | @margins = options[:margins] || { 10 | left: 36, 11 | right: 36, 12 | top: 36, 13 | bottom: 36 14 | } 15 | @crops = options[:crops] || ZERO_INDENTS 16 | @bleeds = options[:bleeds] || ZERO_INDENTS 17 | @trims = options[:trims] || ZERO_INDENTS 18 | @art_indents = options[:art_indents] || ZERO_INDENTS 19 | @stack = GraphicStateStack.new(options[:graphic_state]) 20 | if options[:object_id] 21 | init_from_object(options) 22 | else 23 | init_new_page(options) 24 | end 25 | end 26 | 27 | # Prepend a content stream containing 'q', 28 | # and append a content stream containing 'Q'. 29 | # This ensures that prawn has a pristine graphics state 30 | # before it starts adding content. 31 | def wrap_graphics_state 32 | dictionary.data[:Contents] = Array(dictionary.data[:Contents]) 33 | 34 | # Save graphics context 35 | @content = document.ref({}) 36 | dictionary.data[:Contents].unshift(document.state.store[@content]) 37 | document.add_content 'q' 38 | 39 | # Restore graphics context 40 | @content = document.ref({}) 41 | dictionary.data[:Contents] << document.state.store[@content] 42 | document.add_content 'Q' 43 | end 44 | 45 | # As per the PDF spec, each page can have multiple content streams. This 46 | # will add a fresh, empty content stream this the page, mainly for use in 47 | # loading template files. 48 | # 49 | def new_content_stream 50 | return if in_stamp_stream? 51 | 52 | dictionary.data[:Contents] = Array(dictionary.data[:Contents]) 53 | @content = document.ref({}) 54 | dictionary.data[:Contents] << document.state.store[@content] 55 | document.open_graphics_state 56 | end 57 | 58 | unless method_defined? :imported_page? 59 | def imported_page? 60 | @imported_page 61 | end 62 | end 63 | 64 | alias __dimensions dimensions if method_defined? :dimensions 65 | def dimensions 66 | if imported_page? 67 | media_box = inherited_dictionary_value(:MediaBox) 68 | return media_box.data if media_box.is_a?(PDF::Core::Reference) 69 | 70 | return media_box 71 | end 72 | 73 | coords = PDF::Core::PageGeometry::SIZES[size] || size 74 | [0, 0] + 75 | case layout 76 | when :portrait 77 | coords 78 | when :landscape 79 | coords.reverse 80 | else 81 | raise PDF::Core::Errors::InvalidPageLayout, 82 | 'Layout must be either :portrait or :landscape' 83 | end 84 | end 85 | 86 | if method_defined? :init_from_object 87 | alias __init_from_object init_from_object 88 | end 89 | def init_from_object(options) 90 | @dictionary = options[:object_id].to_i 91 | if options[:page_template] 92 | dictionary.data[:Parent] = document.state.store.pages 93 | end 94 | 95 | if !dictionary.data[:Contents] 96 | # :Contents can sometimes be nil for blank pages. 97 | # (This is technically a malformed PDF, but we can fix it here.) 98 | @content = document.ref({}) 99 | elsif !dictionary.data[:Contents].is_a?(Array) 100 | # content only on leafs 101 | @content = dictionary.data[:Contents].identifier 102 | end 103 | 104 | @stamp_stream = nil 105 | @stamp_dictionary = nil 106 | @imported_page = true 107 | end 108 | 109 | alias __init_new_page init_new_page if method_defined? :init_new_page 110 | def init_new_page(options) 111 | @size = options[:size] || 'LETTER' 112 | @layout = options[:layout] || :portrait 113 | 114 | @stamp_stream = nil 115 | @stamp_dictionary = nil 116 | @imported_page = false 117 | 118 | @content = document.ref({}) 119 | content << 'q' << "\n" 120 | @dictionary = document.ref( 121 | Type: :Page, 122 | Parent: document.state.store.pages, 123 | MediaBox: dimensions, 124 | CropBox: crop_box, 125 | BleedBox: bleed_box, 126 | TrimBox: trim_box, 127 | ArtBox: art_box, 128 | Contents: content 129 | ) 130 | 131 | resources[:ProcSet] = %i[PDF Text ImageB ImageC ImageI] 132 | end 133 | end 134 | end 135 | end 136 | -------------------------------------------------------------------------------- /lib/prawn/document/internals.rb: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | module Prawn 4 | class Document 5 | module Internals 6 | delegate [:open_graphics_state] => :renderer 7 | 8 | # wraps existing content streams with two new streams 9 | # containing just 'q' and 'Q'. This ensures that prawn 10 | # has a pristine graphics context before it starts adding content. 11 | # 12 | # adds a new, empty content stream to each page. Used in templating so 13 | # that imported content streams can be left pristine 14 | # 15 | def fresh_content_streams(options = {}) 16 | (1..page_count).each do |i| 17 | go_to_page i 18 | 19 | state.page.wrap_graphics_state 20 | state.page.new_content_stream 21 | apply_margin_options(options) 22 | generate_margin_box 23 | use_graphic_settings(options[:template]) 24 | forget_text_rendering_mode! 25 | end 26 | end 27 | end 28 | end 29 | end 30 | -------------------------------------------------------------------------------- /lib/prawn/templates.rb: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | # This is free software. See LICENSE and COPYING files for details. 4 | require 'pdf/reader' 5 | require 'pdf/core' 6 | require 'prawn/text' 7 | 8 | require_relative '../pdf/core/document_state' 9 | require_relative '../pdf/core/errors' 10 | require_relative '../pdf/core/object_store' 11 | require_relative '../pdf/core/page' 12 | require_relative 'text' 13 | require_relative 'document/internals' 14 | 15 | module Prawn 16 | # @private 17 | module Templates 18 | def initialize_first_page(options) 19 | return super unless options[:template] 20 | 21 | fresh_content_streams(options) 22 | go_to_page(1) 23 | end 24 | 25 | ## FIXME: This is going to be terribly brittle because 26 | # it copy-pastes the start_new_page method. But at least 27 | # it should only run when templates are used. 28 | def start_new_page(options = {}) 29 | return super unless options[:template] 30 | 31 | last_page = state.page 32 | if last_page 33 | last_page_size = last_page.size 34 | last_page_layout = last_page.layout 35 | last_page_margins = last_page.margins.dup 36 | end 37 | 38 | page_options = { 39 | size: options[:size] || last_page_size, 40 | layout: options[:layout] || last_page_layout, 41 | margins: last_page_margins 42 | } 43 | if last_page 44 | if last_page.graphic_state 45 | new_graphic_state = last_page.graphic_state.dup 46 | end 47 | 48 | # erase the color space so that it gets reset on new page for fussy 49 | # pdf-readers 50 | new_graphic_state.color_space = {} if new_graphic_state 51 | 52 | page_options[:graphic_state] = new_graphic_state 53 | end 54 | 55 | merge_template_options(page_options, options) 56 | 57 | state.page = PDF::Core::Page.new(self, page_options) 58 | 59 | apply_margin_options(options) 60 | generate_margin_box 61 | 62 | # Reset the bounding box if the new page has different size or layout 63 | if last_page && (last_page.size != state.page.size || 64 | last_page.layout != state.page.layout) 65 | @bounding_box = @margin_box 66 | end 67 | 68 | state.page.new_content_stream 69 | use_graphic_settings(true) 70 | forget_text_rendering_mode! 71 | 72 | unless options[:orphan] 73 | state.insert_page(state.page, @page_number) 74 | @page_number += 1 75 | 76 | if @background 77 | canvas do 78 | image(@background, scale: @background_scale, at: bounds.top_left) 79 | end 80 | end 81 | @y = @bounding_box.absolute_top 82 | 83 | float do 84 | state.on_page_create_action(self) 85 | end 86 | end 87 | end 88 | 89 | def merge_template_options(page_options, options) 90 | object_id = state.store.import_page( 91 | options[:template], 92 | options[:template_page] || 1 93 | ) 94 | page_options.merge!(object_id: object_id, page_template: true) 95 | end 96 | 97 | module ObjectStoreExtensions 98 | # imports all objects required to render a page from another PDF. The 99 | # objects are added to the current object store, but NOT linked 100 | # anywhere. 101 | # 102 | # The object ID of the root Page object is returned, it's up to the 103 | # calling code to link that into the document structure somewhere. If 104 | # this isn't done the imported objects will just be removed when the 105 | # store is compacted. 106 | # 107 | # Imports nothing and returns nil if the requested page number doesn't 108 | # exist. page_num is 1 indexed, so 1 indicates the first page. 109 | # 110 | def import_page(input, page_num) 111 | @loaded_objects = {} 112 | template_id = indexed_template(input, page_num) 113 | return template_id if template_id 114 | 115 | io = 116 | if input.respond_to?(:seek) && input.respond_to?(:read) 117 | input 118 | elsif File.file?(input.to_s) 119 | StringIO.new(File.binread(input.to_s)) 120 | else 121 | raise ArgumentError, 122 | 'input must be an IO-like object or a ' \ 123 | 'filename' 124 | end 125 | 126 | hash = indexed_hash(input, io) 127 | ref = hash.page_references[page_num - 1] 128 | 129 | if ref.nil? 130 | nil 131 | else 132 | index_template( 133 | input, 134 | page_num, 135 | load_object_graph(hash, ref).identifier 136 | ) 137 | end 138 | rescue PDF::Reader::MalformedPDFError, 139 | PDF::Reader::InvalidObjectError => e 140 | msg = 'Error reading template file. If you are sure it\'s a valid PDF,'\ 141 | " it may be a bug.\n#{e.message}" 142 | raise PDF::Core::Errors::TemplateError, msg 143 | rescue PDF::Reader::UnsupportedFeatureError 144 | msg = 'Template file contains unsupported PDF features' 145 | raise PDF::Core::Errors::TemplateError, msg 146 | end 147 | 148 | private 149 | 150 | # An index for page templates so that their loaded object graph 151 | # can be reused without multiple loading 152 | def template_index 153 | @template_index ||= {} 154 | end 155 | 156 | # returns the indexed object graph identifier for a template page if 157 | # it exists 158 | def indexed_template(input, page_number) 159 | key = indexing_key(input) 160 | template_index[key] && template_index[key][page_number] 161 | end 162 | 163 | # indexes the identifier for a page from a template 164 | def index_template(input, page_number, id) 165 | (template_index[indexing_key(input)] ||= {})[page_number] ||= id 166 | end 167 | 168 | # An index for the read object hash of a pdf template so that the 169 | # object hash does not need to be parsed multiple times when using 170 | # different pages of the pdf as page templates 171 | def hash_index 172 | @hash_index ||= {} 173 | end 174 | 175 | # reads and indexes a new IO for a template 176 | # if the IO has been indexed already then the parsed object hash 177 | # is returned directly 178 | def indexed_hash(input, io) 179 | hash_index[indexing_key(input)] ||= PDF::Reader::ObjectHash.new(io) 180 | end 181 | 182 | # the index key for the input. 183 | # uses object_id so that both a string filename or an IO stream can be 184 | # indexed and reused provided the same object gets used in multiple page 185 | # template calls. 186 | def indexing_key(input) 187 | input.object_id 188 | end 189 | 190 | # returns a nested array of object IDs for all pages in this object store. 191 | # 192 | def get_page_objects(obj) 193 | case obj.data[:Type] 194 | when :Page 195 | obj.identifier 196 | when :Pages 197 | obj.data[:Kids].map { |kid| get_page_objects(kid) } 198 | end 199 | end 200 | 201 | # takes a source PDF and uses it as a template for this document. 202 | # 203 | def load_file(template) 204 | unless (template.respond_to?(:seek) && template.respond_to?(:read)) || 205 | File.file?(template) 206 | raise ArgumentError, "#{template} does not exist" 207 | end 208 | 209 | hash = PDF::Reader::ObjectHash.new(template) 210 | src_info = hash.trailer[:Info] 211 | src_root = hash.trailer[:Root] 212 | @min_version = hash.pdf_version.to_f 213 | 214 | if hash.trailer[:Encrypt] 215 | msg = 'Template file is an encrypted PDF, it can\'t be used as a '\ 216 | 'template' 217 | raise PDF::Core::Errors::TemplateError, msg 218 | end 219 | 220 | if src_info 221 | @info = load_object_graph(hash, src_info).identifier 222 | end 223 | 224 | if src_root 225 | @root = load_object_graph(hash, src_root).identifier 226 | end 227 | rescue PDF::Reader::MalformedPDFError, 228 | PDF::Reader::InvalidObjectError => e 229 | msg = 'Error reading template file. If you are sure it\'s a valid PDF,'\ 230 | " it may be a bug.\n#{e.message}" 231 | raise PDF::Core::Errors::TemplateError, msg 232 | rescue PDF::Reader::UnsupportedFeatureError 233 | msg = 'Template file contains unsupported PDF features' 234 | raise PDF::Core::Errors::TemplateError, msg 235 | end 236 | 237 | # recurse down an object graph from a source PDF, importing all the 238 | # indirect objects we find. 239 | # 240 | # hash is the PDF::Reader::ObjectHash to extract objects from, object is 241 | # the object to extract. 242 | # 243 | def load_object_graph(hash, object) 244 | @loaded_objects ||= {} 245 | case object 246 | when ::Hash 247 | object.each do |key, value| 248 | object[key] = load_object_graph(hash, value) 249 | end 250 | object 251 | when Array 252 | object.map { |item| load_object_graph(hash, item) } 253 | when PDF::Reader::Reference 254 | unless @loaded_objects.key?(object.id) 255 | @loaded_objects[object.id] = ref(nil) 256 | new_obj = load_object_graph(hash, hash[object]) 257 | if new_obj.is_a?(PDF::Reader::Stream) 258 | stream_dict = load_object_graph(hash, new_obj.hash) 259 | @loaded_objects[object.id].data = stream_dict 260 | @loaded_objects[object.id] << new_obj.data 261 | else 262 | @loaded_objects[object.id].data = new_obj 263 | end 264 | end 265 | @loaded_objects[object.id] 266 | when PDF::Reader::Stream 267 | # Stream is a subclass of string, so this is here to prevent the 268 | # stream being wrapped in a LiteralString 269 | object 270 | when String 271 | utf8?(object) ? object : PDF::Core::ByteString.new(object) 272 | else # rubocop:disable Lint/DuplicateBranch 273 | object 274 | end 275 | end 276 | end 277 | end 278 | end 279 | 280 | if Prawn::Document::VALID_OPTIONS.frozen? 281 | # rubocop:disable Style/Send 282 | Prawn::Document.const_set( 283 | :VALID_OPTIONS, 284 | (Prawn::Document.send( 285 | :remove_const, 286 | :VALID_OPTIONS 287 | ).dup << :template).freeze 288 | ) 289 | # rubocop:enable Style/Send 290 | else 291 | Prawn::Document::VALID_OPTIONS << :template 292 | end 293 | Prawn::Document.extensions << Prawn::Templates 294 | 295 | PDF::Core::ObjectStore.include Prawn::Templates::ObjectStoreExtensions 296 | -------------------------------------------------------------------------------- /lib/prawn/text.rb: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | module Prawn 4 | module Text # :nodoc: 5 | def text_rendering_mode(mode = nil) 6 | if mode.nil? 7 | return defined?(@text_rendering_mode) && @text_rendering_mode || :fill 8 | end 9 | 10 | unless MODES.key?(mode) 11 | raise ArgumentError, 12 | "mode must be between one of #{MODES.keys.join(', ')} (#{mode})" 13 | end 14 | original_mode = text_rendering_mode 15 | 16 | if original_mode == :unknown 17 | original_mode = :fill 18 | add_content "\n#{MODES[:fill]} Tr" 19 | end 20 | 21 | if original_mode == mode 22 | yield 23 | else 24 | @text_rendering_mode = mode 25 | add_content "\n#{MODES[mode]} Tr" 26 | yield 27 | add_content "\n#{MODES[original_mode]} Tr" 28 | @text_rendering_mode = original_mode 29 | end 30 | end 31 | end 32 | end 33 | -------------------------------------------------------------------------------- /prawn-templates.gemspec: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | Gem::Specification.new do |spec| 4 | spec.name = 'prawn-templates' 5 | spec.version = File.read(File.expand_path('VERSION', File.dirname(__FILE__))) 6 | .strip 7 | spec.platform = Gem::Platform::RUBY 8 | spec.summary = 'Prawn::Templates allows using PDFs as templates in Prawn' 9 | spec.files = Dir.glob('{lib}/**/**/*') + [ 10 | 'prawn-templates.gemspec', 'COPYING', 'LICENSE', 'GPLv2', 'GPLv3' 11 | ] 12 | spec.require_path = 'lib' 13 | spec.required_ruby_version = '>= 2.6' 14 | spec.required_rubygems_version = '>= 2.0.0' 15 | spec.licenses = %w[Nonstandard GPL-2.0 GPL-3.0] 16 | 17 | spec.authors = [ 18 | 'Gregory Brown', 'Brad Ediger', 'Daniel Nelson', 'Jonathan Greenberg', 19 | 'James Healy', 'Burkhard Vogel-Kreykenbohm' 20 | ] 21 | spec.email = [ 22 | 'gregory.t.brown@gmail.com', 'brad@bradediger.com', 'dnelson@bluejade.com', 23 | 'greenberg@entryway.net', 'jimmy@deefa.com', 'b.vogel@buddyandselly.com' 24 | ] 25 | spec.add_dependency('pdf-reader', '~> 2.0', '!= 2.9.0', '!= 2.9.1') 26 | spec.add_dependency('prawn', '~> 2.2') 27 | spec.add_development_dependency('pdf-inspector', '~> 1.3') 28 | spec.add_development_dependency('prawn-dev', '~> 0.3.0') 29 | spec.homepage = 'https://github.com/prawnpdf/prawn-templates' 30 | spec.description = 'A extension to prawn that allows to include other pdfs '\ 31 | 'either as background to write upon or to combine several pdf documents '\ 32 | 'into one.' 33 | end 34 | -------------------------------------------------------------------------------- /spec/prawn/templates_spec.rb: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | require_relative '../spec_helper' 4 | require_relative '../../lib/prawn/templates' 5 | 6 | DATADIR = "#{File.dirname(__FILE__)}/../../data" 7 | 8 | describe Prawn::Templates do 9 | describe 'Document built from a template' do 10 | it 'has the same page count as the source document' do 11 | filename = "#{DATADIR}/pdfs/curves.pdf" 12 | pdf = Prawn::Document.new(template: filename) 13 | page_counter = PDF::Inspector::Page.analyze(pdf.render) 14 | 15 | expect(page_counter.pages.size).to eq 1 16 | 17 | filename = "#{DATADIR}/pdfs/multipage_template.pdf" 18 | pdf = Prawn::Document.new(template: filename) 19 | page_counter = PDF::Inspector::Page.analyze(pdf.render) 20 | 21 | expect(page_counter.pages.size).to eq 3 22 | end 23 | 24 | it 'recognizes a large page format' do 25 | # try with default margin of 72pt 26 | filename = "#{DATADIR}/pdfs/arch_e1.pdf" 27 | pdf = Prawn::Document.new(template: filename) 28 | expect(pdf.bounds.top_left).to eq [0, 2088] 29 | expect(pdf.bounds.width).to eq 72 * (42 - 1) 30 | expect(pdf.bounds.height).to eq 72 * (30 - 1) 31 | 32 | # set margin to 0 to confirm full-page bounds 33 | filename = "#{DATADIR}/pdfs/arch_e1.pdf" 34 | pdf = Prawn::Document.new(template: filename, margin: 0) 35 | expect(pdf.bounds.top_left).to eq [0, 2160] 36 | expect(pdf.bounds.width).to eq 72 * 42 37 | expect(pdf.bounds.height).to eq 72 * 30 38 | end 39 | 40 | it 'handles a document with a nil Contents entry' do 41 | filename = "#{DATADIR}/pdfs/corrupt_identifier_for_nil.pdf" 42 | expect do 43 | Prawn::Document.new(template: filename) 44 | end.to_not raise_error 45 | end 46 | 47 | it 'does not set the template page\'s parent to the document pages catalog'\ 48 | ' (especially with nested pages)' do 49 | filename = "#{DATADIR}/pdfs/nested_pages.pdf" 50 | pdf = Prawn::Document.new(template: filename, skip_page_creation: true) 51 | expect(pdf.state.page.dictionary.data[:Parent]).to_not eq( 52 | pdf.state.store.pages 53 | ) 54 | end 55 | 56 | it 'does start with the Y cursor at the top of the document' do 57 | filename = "#{DATADIR}/pdfs/curves.pdf" 58 | 59 | pdf = Prawn::Document.new(template: filename) 60 | expect(pdf.y).to_not be_nil 61 | end 62 | 63 | it 'respects margins set by Prawn' do 64 | filename = "#{DATADIR}/pdfs/curves.pdf" 65 | 66 | pdf = Prawn::Document.new(template: filename, margin: 0) 67 | expect(pdf.page.margins).to eq( 68 | left: 0, 69 | right: 0, 70 | top: 0, 71 | bottom: 0 72 | ) 73 | 74 | pdf = Prawn::Document.new(template: filename, left_margin: 0) 75 | expect(pdf.page.margins).to eq( 76 | left: 0, 77 | right: 36, 78 | top: 36, 79 | bottom: 36 80 | ) 81 | 82 | pdf.start_new_page(right_margin: 0) 83 | expect(pdf.page.margins).to eq( 84 | left: 0, 85 | right: 0, 86 | top: 36, 87 | bottom: 36 88 | ) 89 | end 90 | 91 | it 'does not add an extra restore_graphics_state operator to the end of '\ 92 | 'any content stream' do 93 | filename = "#{DATADIR}/pdfs/curves.pdf" 94 | 95 | pdf = Prawn::Document.new(template: filename) 96 | output = StringIO.new(pdf.render) 97 | hash = PDF::Reader::ObjectHash.new(output) 98 | 99 | hash.each_value do |obj| 100 | next unless obj.is_a?(PDF::Reader::Stream) 101 | 102 | data = obj.data.tr(" \n\r", '') 103 | expect(data).to_not include 'QQ' 104 | end 105 | end 106 | 107 | it 'has a single page object if importing a single page template' do 108 | filename = "#{DATADIR}/pdfs/hexagon.pdf" 109 | 110 | pdf = Prawn::Document.new(template: filename) 111 | output = StringIO.new(pdf.render) 112 | hash = PDF::Reader::ObjectHash.new(output) 113 | 114 | pages = 115 | hash.values.select do |obj| 116 | obj.is_a?(Hash) && obj[:Type] == :Page 117 | end 118 | 119 | expect(pages.size).to eq 1 120 | end 121 | 122 | it 'has four content streams if importing a single page template' do 123 | filename = "#{DATADIR}/pdfs/hexagon.pdf" 124 | 125 | pdf = Prawn::Document.new(template: filename) 126 | output = StringIO.new(pdf.render) 127 | hash = PDF::Reader::ObjectHash.new(output) 128 | 129 | streams = hash.values.select { |obj| obj.is_a?(PDF::Reader::Stream) } 130 | 131 | expect(streams.size).to eq 4 132 | end 133 | 134 | it 'does not die if using this PDF as a template' do 135 | filename = "#{DATADIR}/pdfs/complex_template.pdf" 136 | 137 | expect do 138 | Prawn::Document.new(template: filename) 139 | end.to_not raise_error 140 | end 141 | 142 | it 'wraps and balances q/Q streams' do 143 | filename = "#{DATADIR}/pdfs/hexagon.pdf" 144 | 145 | pdf = Prawn::Document.new(template: filename) 146 | output = StringIO.new(pdf.render) 147 | hash = PDF::Reader::ObjectHash.new(output) 148 | 149 | page = hash.values.find { |obj| obj[:Type] == :Page } 150 | 151 | page[:Contents].each_with_index do |ref, i| 152 | stream_ref = hash.keys.find { |key| key.id == ref.id } 153 | stream = hash[stream_ref] 154 | data = stream.unfiltered_data 155 | 156 | case i 157 | when 0 158 | expect(data).to eq("q\n") 159 | when page[:Contents].length - 2 160 | expect(data).to eq("Q\n") 161 | else 162 | expect(data.scan('q').size).to eq(1) 163 | expect(data.scan('Q').size).to eq(1) 164 | end 165 | end 166 | end 167 | 168 | it 'allows text to be added to a single page template' do 169 | filename = "#{DATADIR}/pdfs/hexagon.pdf" 170 | 171 | pdf = Prawn::Document.new(template: filename) 172 | 173 | pdf.text 'Adding some text' 174 | 175 | text = PDF::Inspector::Text.analyze(pdf.render) 176 | expect(text.strings.first).to eq 'Adding some text' 177 | end 178 | 179 | it 'allows PDFs with page resources behind an indirect object to be used '\ 180 | 'as templates' do 181 | filename = "#{DATADIR}/pdfs/resources_as_indirect_object.pdf" 182 | 183 | pdf = Prawn::Document.new(template: filename) 184 | 185 | pdf.text 'Adding some text' 186 | 187 | text = PDF::Inspector::Text.analyze(pdf.render) 188 | all_text = text.strings.join 189 | expect(all_text).to include 'Adding some text' 190 | end 191 | 192 | it 'copies the PDF version from the template file' do 193 | filename = "#{DATADIR}/pdfs/version_1_6.pdf" 194 | 195 | pdf = Prawn::Document.new(template: filename) 196 | str = pdf.render 197 | expect(str[0, 8]).to eq '%PDF-1.6' 198 | end 199 | 200 | it 'correctly adds a TTF font to a template that has existing fonts' do 201 | filename = "#{DATADIR}/pdfs/contains_ttf_font.pdf" 202 | pdf = Prawn::Document.new(template: filename) 203 | pdf.font "#{DATADIR}/fonts/DejaVuSans.ttf" 204 | pdf.move_down(40) 205 | pdf.text 'Hi There' 206 | 207 | output = StringIO.new(pdf.render) 208 | hash = PDF::Reader::ObjectHash.new(output) 209 | 210 | page_dict = 211 | hash.values.find do |obj| 212 | obj.is_a?(Hash) && obj[:Type] == :Page 213 | end 214 | resources = page_dict[:Resources] 215 | fonts = resources[:Font] 216 | expect(fonts.size).to eq 2 217 | end 218 | 219 | it 'correctly imports a template file that is missing a MediaBox entry' do 220 | filename = "#{DATADIR}/pdfs/page_without_mediabox.pdf" 221 | 222 | pdf = Prawn::Document.new(template: filename) 223 | str = pdf.render 224 | expect(str[0, 4]).to eq '%PDF' 225 | end 226 | 227 | context 'with the template as a stream' do 228 | it 'correctly imports a template file from a stream' do 229 | filename = "#{DATADIR}/pdfs/hexagon.pdf" 230 | io = StringIO.new(File.binread(filename)) 231 | pdf = Prawn::Document.new(template: io) 232 | str = pdf.render 233 | expect(str[0, 4]).to eq '%PDF' 234 | end 235 | end 236 | 237 | it 'merges metadata info' do 238 | filename = "#{DATADIR}/pdfs/hexagon.pdf" 239 | info = { 240 | Title: 'Sample METADATA', 241 | Author: 'Me', 242 | Subject: 'Not Working', 243 | CreationDate: Time.now 244 | } 245 | 246 | pdf = Prawn::Document.new(template: filename, info: info) 247 | output = StringIO.new(pdf.render) 248 | hash = PDF::Reader::ObjectHash.new(output) 249 | info.each_key do |k| 250 | expect(hash[hash.trailer[:Info]].key?(k)).to eq true 251 | end 252 | end 253 | 254 | it 'returns correct dimensions when :MediaBox is a reference' do 255 | filename = "#{DATADIR}/pdfs/page_with_mediabox_reference.pdf" 256 | pdf = Prawn::Document.new(template: filename) 257 | 258 | # expect the inherited value to be a reference 259 | # rubocop:disable Style/Send 260 | expect(pdf.state.page.send(:inherited_dictionary_value, :MediaBox)).to be_a PDF::Core::Reference 261 | # rubocop:enable Style/Send 262 | 263 | # expect dimensions to come back as an array 264 | expect(pdf.state.page.dimensions).to be_a Array 265 | end 266 | end 267 | 268 | describe 'Document#start_new_page with :template option' do 269 | filename = "#{DATADIR}/pdfs/curves.pdf" 270 | 271 | it "sets the imported page's parent to the document pages catalog" do 272 | pdf = Prawn::Document.new 273 | pdf.start_new_page(template: filename) 274 | expect(pdf.state.page.dictionary.data[:Parent]).to eq( 275 | pdf.state.store.pages 276 | ) 277 | end 278 | 279 | it 'sets start the Y cursor at the top of the page' do 280 | pdf = Prawn::Document.new 281 | pdf.start_new_page(template: filename) 282 | expect(pdf.y).to_not be_nil 283 | end 284 | 285 | it 'respects margins set by Prawn' do 286 | pdf = Prawn::Document.new(margin: 0) 287 | pdf.start_new_page(template: filename) 288 | expect(pdf.page.margins).to eq( 289 | left: 0, 290 | right: 0, 291 | top: 0, 292 | bottom: 0 293 | ) 294 | 295 | pdf = Prawn::Document.new(left_margin: 0) 296 | pdf.start_new_page(template: filename) 297 | expect(pdf.page.margins).to eq( 298 | left: 0, 299 | right: 36, 300 | top: 36, 301 | bottom: 36 302 | ) 303 | pdf.start_new_page(template: filename, right_margin: 0) 304 | expect(pdf.page.margins).to eq( 305 | left: 0, 306 | right: 0, 307 | top: 36, 308 | bottom: 36 309 | ) 310 | end 311 | 312 | it 'does not add an extra restore_graphics_state operator to the end of '\ 313 | 'any content stream' do 314 | pdf = Prawn::Document.new 315 | pdf.start_new_page(template: filename) 316 | output = StringIO.new(pdf.render) 317 | hash = PDF::Reader::ObjectHash.new(output) 318 | 319 | hash.each_value do |obj| 320 | next unless obj.is_a?(PDF::Reader::Stream) 321 | 322 | data = obj.data.tr(" \n\r", '') 323 | expect(data).to_not include 'QQ' 324 | end 325 | end 326 | 327 | it 'has two content streams if importing a single page template' do 328 | filename = "#{DATADIR}/pdfs/hexagon.pdf" 329 | pdf = Prawn::Document.new 330 | pdf.start_new_page(template: filename) 331 | output = StringIO.new(pdf.render) 332 | hash = PDF::Reader::ObjectHash.new(output) 333 | pages = hash.values.find do |obj| 334 | obj.is_a?(Hash) && obj[:Type] == :Pages 335 | end[:Kids] 336 | template_page = hash[pages[1]] 337 | expect(template_page[:Contents].size).to eq 2 338 | end 339 | 340 | it 'has balanced q/Q operators on all content streams' do 341 | filename = "#{DATADIR}/pdfs/hexagon.pdf" 342 | 343 | pdf = Prawn::Document.new 344 | pdf.start_new_page(template: filename) 345 | output = StringIO.new(pdf.render) 346 | hash = PDF::Reader::ObjectHash.new(output) 347 | 348 | streams = hash.values.select { |obj| obj.is_a?(PDF::Reader::Stream) } 349 | 350 | streams.each do |stream| 351 | data = stream.unfiltered_data 352 | expect(data.scan('q').size).to eq(1) 353 | expect(data.scan('Q').size).to eq(1) 354 | end 355 | end 356 | 357 | it 'allows text to be added to a single page template' do 358 | pdf = Prawn::Document.new 359 | pdf.start_new_page(template: filename) 360 | 361 | pdf.text 'Adding some text' 362 | 363 | text = PDF::Inspector::Text.analyze(pdf.render) 364 | expect(text.strings.first).to eq 'Adding some text' 365 | end 366 | 367 | it 'allows PDFs with page resources behind an indirect object to be used '\ 368 | 'as templates' do 369 | filename = "#{DATADIR}/pdfs/resources_as_indirect_object.pdf" 370 | 371 | pdf = Prawn::Document.new 372 | pdf.start_new_page(template: filename) 373 | 374 | pdf.text 'Adding some text' 375 | 376 | text = PDF::Inspector::Text.analyze(pdf.render) 377 | all_text = text.strings.join 378 | expect(all_text).to include 'Adding some text' 379 | end 380 | 381 | it 'correctly adds a TTF font to a template that has existing fonts' do 382 | filename = "#{DATADIR}/pdfs/contains_ttf_font.pdf" 383 | pdf = Prawn::Document.new 384 | pdf.start_new_page(template: filename) 385 | pdf.font "#{DATADIR}/fonts/DejaVuSans.ttf" 386 | pdf.move_down(40) 387 | pdf.text 'Hi There' 388 | 389 | output = StringIO.new(pdf.render) 390 | hash = PDF::Reader::ObjectHash.new(output) 391 | pages = hash.values.find do |obj| 392 | obj.is_a?(Hash) && obj[:Type] == :Pages 393 | end[:Kids] 394 | template_page = hash[pages[1]] 395 | resources = template_page[:Resources] 396 | fonts = resources[:Font] 397 | expect(fonts.size).to eq 2 398 | end 399 | 400 | it 'indexes template pages when used multiple times' do 401 | filename = "#{DATADIR}/pdfs/multipage_template.pdf" 402 | repeated_pdf = Prawn::Document.new 403 | 3.times { repeated_pdf.start_new_page(template: filename) } 404 | repeated_hash = PDF::Reader::ObjectHash.new( 405 | StringIO.new( 406 | repeated_pdf.render 407 | ) 408 | ) 409 | sequential_pdf = Prawn::Document.new 410 | (1..3).each do |p| 411 | sequential_pdf.start_new_page( 412 | template: filename, 413 | template_page: p 414 | ) 415 | end 416 | sequential_hash = PDF::Reader::ObjectHash.new( 417 | StringIO.new( 418 | sequential_pdf.render 419 | ) 420 | ) 421 | expect(repeated_hash.size < sequential_hash.size).to be_truthy 422 | end 423 | 424 | context 'with the template as a stream' do 425 | it 'correctly imports a template file from a stream' do 426 | filename = "#{DATADIR}/pdfs/hexagon.pdf" 427 | io = StringIO.new(File.binread(filename)) 428 | 429 | pdf = Prawn::Document.new 430 | pdf.start_new_page(template: io) 431 | 432 | str = pdf.render 433 | expect(str[0, 4]).to eq '%PDF' 434 | end 435 | end 436 | 437 | context 'when using template_page option' do 438 | it 'uses the specified page option' do 439 | filename = "#{DATADIR}/pdfs/multipage_template.pdf" 440 | pdf = Prawn::Document.new 441 | pdf.start_new_page(template: filename, template_page: 2) 442 | text = PDF::Inspector::Text.analyze(pdf.render) 443 | expect(text.strings.first).to eq 'This is template page 2' 444 | end 445 | end 446 | end 447 | 448 | describe 'ObjectStore extensions' do 449 | before do 450 | @store = PDF::Core::ObjectStore.new 451 | end 452 | 453 | it 'imports objects from an existing PDF' do 454 | filename = "#{DATADIR}/pdfs/curves.pdf" 455 | store = PDF::Core::ObjectStore.new(template: filename) 456 | expect(store.size).to eq 5 457 | end 458 | 459 | it 'points to existing roots when importing objects from an existing PDF' do 460 | filename = "#{Prawn::BASEDIR}/spec/data/curves.pdf" 461 | store = PDF::Core::ObjectStore.new(template: filename) 462 | expect(store.info.class).to eq(PDF::Core::Reference) 463 | expect(store.root.class).to eq(PDF::Core::Reference) 464 | end 465 | 466 | it 'initializes with pages when importing objects from an existing PDF' do 467 | filename = "#{DATADIR}/pdfs/curves.pdf" 468 | store = PDF::Core::ObjectStore.new(template: filename) 469 | expect(store.pages.data[:Count]).to eq 1 470 | end 471 | 472 | it 'imports all objects from a PDF that has an indirect reference in a '\ 473 | 'stream dict' do 474 | filename = "#{DATADIR}/pdfs/indirect_reference.pdf" 475 | store = PDF::Core::ObjectStore.new(template: filename) 476 | expect(store.size).to eq 8 477 | end 478 | 479 | it 'raises error ArgumentError when given a file that doesn exist as a '\ 480 | 'template' do 481 | filename = 'not_really_there.pdf' 482 | 483 | expect { PDF::Core::ObjectStore.new(template: filename) }.to raise_error( 484 | ArgumentError 485 | ) 486 | end 487 | 488 | it 'raises error PDF::Core::Errors::TemplateError when given a non PDF as '\ 489 | 'a template' do 490 | filename = "#{DATADIR}/images/dice.png" 491 | 492 | expect { PDF::Core::ObjectStore.new(template: filename) }.to raise_error( 493 | PDF::Core::Errors::TemplateError 494 | ) 495 | end 496 | 497 | it 'raises error PDF::Core::Errors::TemplateError when given an encrypted '\ 498 | 'PDF as a template' do 499 | filename = "#{DATADIR}/pdfs/encrypted.pdf" 500 | 501 | expect { PDF::Core::ObjectStore.new(template: filename) }.to raise_error( 502 | PDF::Core::Errors::TemplateError 503 | ) 504 | end 505 | end 506 | 507 | describe 'ObjectStore#object_id_for_page' do 508 | it 'returns the object ID of an imported template page' do 509 | filename = "#{DATADIR}/pdfs/hexagon.pdf" 510 | store = PDF::Core::ObjectStore.new(template: filename) 511 | expect(store.object_id_for_page(0)).to eq 4 512 | end 513 | 514 | it 'returns the object ID of the first imported template page' do 515 | filename = "#{DATADIR}/pdfs/two_hexagons.pdf" 516 | store = PDF::Core::ObjectStore.new(template: filename) 517 | expect(store.object_id_for_page(1)).to eq 4 518 | end 519 | 520 | it 'returns the object ID of the last imported template page' do 521 | filename = "#{DATADIR}/pdfs/two_hexagons.pdf" 522 | store = PDF::Core::ObjectStore.new(template: filename) 523 | expect(store.object_id_for_page(-1)).to eq 6 524 | end 525 | 526 | it 'returns the object ID of the first page of a template that uses nested'\ 527 | ' Pages' do 528 | filename = "#{DATADIR}/pdfs/nested_pages.pdf" 529 | store = PDF::Core::ObjectStore.new(template: filename) 530 | expect(store.object_id_for_page(1)).to eq 5 531 | end 532 | 533 | it 'returns the object ID of the last page of a template that uses nested '\ 534 | 'Pages' do 535 | filename = "#{DATADIR}/pdfs/nested_pages.pdf" 536 | store = PDF::Core::ObjectStore.new(template: filename) 537 | expect(store.object_id_for_page(-1)).to eq 8 538 | end 539 | 540 | describe 'returns nil if given an invalid page number' do 541 | it 'with a template' do 542 | filename = "#{DATADIR}/pdfs/hexagon.pdf" 543 | store = PDF::Core::ObjectStore.new(template: filename) 544 | expect(store.object_id_for_page(10)).to eq nil 545 | end 546 | 547 | it 'without a template' do 548 | store = PDF::Core::ObjectStore.new 549 | expect(store.object_id_for_page(10)).to eq nil 550 | end 551 | end 552 | 553 | it 'accepts a stream instead of a filename' do 554 | example = Prawn::Document.new 555 | example.text 'An example doc, created in memory' 556 | example.start_new_page 557 | pdf = nil 558 | StringIO.open(example.render) do |stream| 559 | pdf = PDF::Core::ObjectStore.new(template: stream) 560 | end 561 | expect(pdf.page_count).to eq 2 562 | end 563 | end 564 | end 565 | -------------------------------------------------------------------------------- /spec/spec_helper.rb: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | puts "PDF::Core specs: Running on Ruby Version: #{RUBY_VERSION}" 4 | 5 | require 'bundler' 6 | Bundler.setup 7 | 8 | if ENV['COVERAGE'] 9 | require 'simplecov' 10 | SimpleCov.start 11 | end 12 | 13 | require 'prawn' 14 | require_relative '../lib/prawn/templates' 15 | 16 | require 'rspec' 17 | require 'pdf/reader' 18 | require 'pdf/inspector' 19 | 20 | RSpec::Matchers.define :have_parseable_xobjects do 21 | match do |actual| 22 | expect { PDF::Inspector::XObject.analyze(actual.render) }.to_not raise_error 23 | true 24 | end 25 | failure_message_for_should do |actual| 26 | "expected that #{actual}'s XObjects could be successfully parsed" 27 | end 28 | end 29 | --------------------------------------------------------------------------------