squib 0.18.0 → 0.19.0a

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (202) hide show
  1. checksums.yaml +4 -4
  2. data/.github/ISSUE_TEMPLATE/bug_report.md +39 -39
  3. data/.github/ISSUE_TEMPLATE/feature_request.md +22 -22
  4. data/.github/ISSUE_TEMPLATE/help-wanted.md +13 -13
  5. data/.github/ISSUE_TEMPLATE/release-todo.md +45 -33
  6. data/.github/PULL_REQUEST_TEMPLATE.md +13 -13
  7. data/.github/workflows/tests.yml +22 -22
  8. data/.gitignore +41 -41
  9. data/.vscode/settings.json +4 -3
  10. data/CHANGELOG.md +460 -460
  11. data/CONTRIBUTING.md +40 -40
  12. data/Dockerfile +27 -27
  13. data/Gemfile +2 -2
  14. data/Guardfile +8 -8
  15. data/LICENSE.txt +22 -22
  16. data/README.md +139 -139
  17. data/Rakefile +51 -51
  18. data/bin/squib +5 -5
  19. data/lib/squib/api/settings.rb +21 -21
  20. data/lib/squib/args/arg_loader.rb +138 -138
  21. data/lib/squib/args/box.rb +59 -59
  22. data/lib/squib/args/card_range.rb +34 -34
  23. data/lib/squib/args/color_validator.rb +7 -7
  24. data/lib/squib/args/coords.rb +49 -49
  25. data/lib/squib/args/csv_opts.rb +22 -22
  26. data/lib/squib/args/dir_validator.rb +11 -11
  27. data/lib/squib/args/draw.rb +93 -93
  28. data/lib/squib/args/drop_shadow.rb +39 -39
  29. data/lib/squib/args/embed_adjust.rb +22 -22
  30. data/lib/squib/args/embed_key.rb +12 -12
  31. data/lib/squib/args/hand_special.rb +37 -37
  32. data/lib/squib/args/import.rb +67 -67
  33. data/lib/squib/args/input_file.rb +55 -55
  34. data/lib/squib/args/paint.rb +43 -43
  35. data/lib/squib/args/paragraph.rb +118 -118
  36. data/lib/squib/args/save_batch.rb +65 -65
  37. data/lib/squib/args/scale_box.rb +57 -57
  38. data/lib/squib/args/sheet.rb +165 -165
  39. data/lib/squib/args/showcase_special.rb +41 -41
  40. data/lib/squib/args/sprue_file.rb +44 -44
  41. data/lib/squib/args/svg_special.rb +37 -37
  42. data/lib/squib/args/transform.rb +55 -55
  43. data/lib/squib/args/typographer.rb +115 -115
  44. data/lib/squib/args/unit_conversion.rb +27 -27
  45. data/lib/squib/args/xywh_shorthands.rb +50 -50
  46. data/lib/squib/builtin/layouts/economy.yml +85 -85
  47. data/lib/squib/builtin/layouts/fantasy.yml +101 -101
  48. data/lib/squib/builtin/layouts/hand.yml +62 -62
  49. data/lib/squib/builtin/layouts/party.yml +94 -94
  50. data/lib/squib/builtin/layouts/playing-card.yml +35 -35
  51. data/lib/squib/builtin/layouts/tuck_box.yml +46 -46
  52. data/lib/squib/builtin/projects/advanced/.gitignore +4 -4
  53. data/lib/squib/builtin/projects/advanced/ABOUT.md +19 -19
  54. data/lib/squib/builtin/projects/advanced/Gemfile +11 -11
  55. data/lib/squib/builtin/projects/advanced/Guardfile +21 -21
  56. data/lib/squib/builtin/projects/advanced/IDEAS.md +22 -22
  57. data/lib/squib/builtin/projects/advanced/PLAYTESTING.md +26 -26
  58. data/lib/squib/builtin/projects/advanced/Rakefile +27 -27
  59. data/lib/squib/builtin/projects/advanced/config.yml +49 -49
  60. data/lib/squib/builtin/projects/advanced/docs/PNP NOTES.md +3 -3
  61. data/lib/squib/builtin/projects/advanced/docs/RULES.md +21 -21
  62. data/lib/squib/builtin/projects/advanced/img/example.svg +60 -60
  63. data/lib/squib/builtin/projects/advanced/layouts/deck.yml +27 -27
  64. data/lib/squib/builtin/projects/advanced/src/deck.rb +34 -34
  65. data/lib/squib/builtin/projects/advanced/src/version.rb +3 -3
  66. data/lib/squib/builtin/projects/basic/.gitignore +4 -4
  67. data/lib/squib/builtin/projects/basic/ABOUT.md +19 -19
  68. data/lib/squib/builtin/projects/basic/Gemfile +3 -3
  69. data/lib/squib/builtin/projects/basic/IDEAS.md +22 -22
  70. data/lib/squib/builtin/projects/basic/PLAYTESTING.md +26 -26
  71. data/lib/squib/builtin/projects/basic/PNP NOTES.md +3 -3
  72. data/lib/squib/builtin/projects/basic/RULES.md +21 -21
  73. data/lib/squib/builtin/projects/basic/Rakefile +7 -7
  74. data/lib/squib/builtin/projects/basic/config.yml +50 -50
  75. data/lib/squib/builtin/projects/basic/deck.rb +6 -6
  76. data/lib/squib/builtin/sprues/a4_euro_card.yml +42 -42
  77. data/lib/squib/builtin/sprues/a4_poker_card_8up.yml +40 -40
  78. data/lib/squib/builtin/sprues/a4_poker_card_9up.yml +42 -42
  79. data/lib/squib/builtin/sprues/a4_usa_card.yml +42 -42
  80. data/lib/squib/builtin/sprues/drivethrucards_1up.yml +10 -10
  81. data/lib/squib/builtin/sprues/letter_poker_card_9up.yml +25 -25
  82. data/lib/squib/builtin/sprues/letter_poker_foldable_8up.yml +52 -52
  83. data/lib/squib/builtin/sprues/printplaygames_18up.yml +68 -68
  84. data/lib/squib/card.rb +75 -75
  85. data/lib/squib/commands/cli.rb +39 -39
  86. data/lib/squib/commands/data/template_option.rb +109 -109
  87. data/lib/squib/commands/make_sprue.rb +277 -277
  88. data/lib/squib/commands/new.rb +77 -77
  89. data/lib/squib/conf.rb +149 -149
  90. data/lib/squib/constants.rb +17 -17
  91. data/lib/squib/deck.rb +138 -138
  92. data/lib/squib/dsl/background.rb +35 -35
  93. data/lib/squib/dsl/circle.rb +39 -39
  94. data/lib/squib/dsl/csv.rb +42 -42
  95. data/lib/squib/dsl/curve.rb +35 -35
  96. data/lib/squib/dsl/cut_zone.rb +47 -47
  97. data/lib/squib/dsl/ellipse.rb +37 -37
  98. data/lib/squib/dsl/grid.rb +35 -35
  99. data/lib/squib/dsl/groups.rb +54 -54
  100. data/lib/squib/dsl/hand.rb +42 -42
  101. data/lib/squib/dsl/line.rb +35 -35
  102. data/lib/squib/dsl/png.rb +57 -57
  103. data/lib/squib/dsl/polygon.rb +36 -36
  104. data/lib/squib/dsl/rect.rb +37 -37
  105. data/lib/squib/dsl/safe_zone.rb +48 -48
  106. data/lib/squib/dsl/save.rb +21 -21
  107. data/lib/squib/dsl/save_pdf.rb +50 -50
  108. data/lib/squib/dsl/save_png.rb +48 -48
  109. data/lib/squib/dsl/save_sheet.rb +53 -53
  110. data/lib/squib/dsl/showcase.rb +43 -43
  111. data/lib/squib/dsl/star.rb +37 -37
  112. data/lib/squib/dsl/svg.rb +63 -63
  113. data/lib/squib/dsl/text.rb +54 -54
  114. data/lib/squib/dsl/text_embed.rb +79 -79
  115. data/lib/squib/dsl/triangle.rb +35 -35
  116. data/lib/squib/dsl/units.rb +37 -37
  117. data/lib/squib/dsl/xlsx.rb +40 -40
  118. data/lib/squib/dsl/yaml.rb +40 -40
  119. data/lib/squib/errors_warnings/warn_unexpected_params.rb +14 -14
  120. data/lib/squib/graphics/background.rb +14 -14
  121. data/lib/squib/graphics/cairo_context_wrapper.rb +115 -115
  122. data/lib/squib/graphics/embedding_utils.rb +28 -28
  123. data/lib/squib/graphics/gradient_regex.rb +47 -47
  124. data/lib/squib/graphics/hand.rb +42 -42
  125. data/lib/squib/graphics/image.rb +123 -123
  126. data/lib/squib/graphics/save_doc.rb +77 -77
  127. data/lib/squib/graphics/save_images.rb +91 -91
  128. data/lib/squib/graphics/save_pdf.rb +90 -90
  129. data/lib/squib/graphics/save_sprue.rb +231 -231
  130. data/lib/squib/graphics/shapes.rb +143 -143
  131. data/lib/squib/graphics/showcase.rb +85 -85
  132. data/lib/squib/graphics/text.rb +202 -202
  133. data/lib/squib/import/csv_importer.rb +45 -45
  134. data/lib/squib/import/data_frame.rb +108 -108
  135. data/lib/squib/import/quantity_exploder.rb +17 -17
  136. data/lib/squib/import/xlsx_importer.rb +28 -28
  137. data/lib/squib/import/yaml_importer.rb +30 -30
  138. data/lib/squib/layout_parser.rb +155 -155
  139. data/lib/squib/progress.rb +38 -38
  140. data/lib/squib/sample_helpers.rb +34 -34
  141. data/lib/squib/sprues/crop_line.rb +28 -28
  142. data/lib/squib/sprues/crop_line_dash.rb +35 -35
  143. data/lib/squib/sprues/invalid_sprue_definition.rb +9 -9
  144. data/lib/squib/sprues/sprue.rb +208 -208
  145. data/lib/squib/sprues/sprue_schema.rb +51 -51
  146. data/lib/squib/system_fonts.rb +16 -16
  147. data/lib/squib/version.rb +11 -11
  148. data/lib/squib.rb +35 -35
  149. data/samples/autoscale_font/_autoscale_font.rb +98 -98
  150. data/samples/backend/_backend.rb +26 -26
  151. data/samples/basic.rb +19 -19
  152. data/samples/build_groups/build_groups.rb +36 -36
  153. data/samples/colors/_colors.rb +44 -44
  154. data/samples/colors/_gradients.rb +34 -34
  155. data/samples/colors/_switch_color.rb +33 -33
  156. data/samples/config/config_text_markup.rb +20 -20
  157. data/samples/config/custom_config.rb +18 -18
  158. data/samples/data/_csv.rb +33 -33
  159. data/samples/data/_excel.rb +55 -55
  160. data/samples/data/_yaml.rb +12 -12
  161. data/samples/hello_world.rb +6 -6
  162. data/samples/images/_cairo_access.rb +39 -39
  163. data/samples/images/_images.rb +104 -104
  164. data/samples/images/_more_load_images.rb +102 -102
  165. data/samples/images/_placeholders.rb +48 -48
  166. data/samples/intro/01_hello.rb +8 -8
  167. data/samples/intro/02_options.rb +14 -14
  168. data/samples/intro/03_layout.rb +11 -11
  169. data/samples/intro/04_arrays.rb +15 -15
  170. data/samples/intro/05_excel.rb +14 -14
  171. data/samples/layouts/builtin_layouts.rb +97 -97
  172. data/samples/layouts/layouts.rb +71 -71
  173. data/samples/project/src/characters.rb +8 -8
  174. data/samples/project/src/skills.rb +7 -7
  175. data/samples/proofs/_tgc_proofs.rb +16 -16
  176. data/samples/ranges/_ranges.rb +64 -64
  177. data/samples/saves/_hand.rb +23 -23
  178. data/samples/saves/_portrait_landscape.rb +23 -23
  179. data/samples/saves/_save_filenames.rb +28 -28
  180. data/samples/saves/_save_pdf.rb +29 -29
  181. data/samples/saves/_saves.rb +75 -75
  182. data/samples/saves/_showcase.rb +25 -25
  183. data/samples/shadows/_shadow.rb +71 -71
  184. data/samples/shapes/_draw_shapes.rb +60 -60
  185. data/samples/shapes/_proofs.rb +22 -22
  186. data/samples/sprues/_advanced_sprues.rb +25 -25
  187. data/samples/sprues/_builtin_sprues.rb +22 -22
  188. data/samples/sprues/_fold_sheet.rb +30 -30
  189. data/samples/sprues/_hex_tiles.rb +15 -15
  190. data/samples/sprues/_mints.rb +11 -11
  191. data/samples/sprues/_negative_coords.rb +6 -6
  192. data/samples/sprues/_sprue_example.rb +11 -11
  193. data/samples/system_font_debug/_list_fonts.rb +14 -14
  194. data/samples/text/_embed_text.rb +128 -128
  195. data/samples/text/_text.rb +52 -52
  196. data/samples/text/_text_options.rb +103 -103
  197. data/samples/text/bug134.rb +14 -14
  198. data/samples/units/_cells.rb +50 -50
  199. data/samples/units/_shorthands.rb +48 -48
  200. data/samples/units/_units.rb +39 -39
  201. data/squib.gemspec +58 -58
  202. metadata +21 -21
data/CONTRIBUTING.md CHANGED
@@ -1,40 +1,40 @@
1
- # Contributing to Squib
2
-
3
- Please use GitHub issues for bugs and feature requests.
4
-
5
- ## Need Help?
6
-
7
- There are lots of people using Squib already. If you've gone through the [samples](https://github.com/andymeneely/squib/tree/master/samples) and still have questions, here are some other places to get help.
8
-
9
- * [StackOverflow](http://stackoverflow.com/questions/ask?tags=ruby squib) with the tag "ruby" and "squib" will get you answers quickly and a great way to document questions for future Squibbers.
10
- * Our [thread on BoardGameGeek](http://boardgamegeek.com/thread/1293453) is quite active and informal (if a bit unstructured).
11
-
12
- If you email me directly I'll probably ask you to post your question publicly so we can document answers for future Googling Squibbers.
13
-
14
- ## Pull Requests
15
-
16
- If you are contributing a new feature:
17
- * Keep your change small and atomic. Do significant refactoring in a separate pull request.
18
- * Please write a sample demonstrating your new feature. Place it in the samples/ directory
19
- * While your pull request is open, please keep it up to date with the `dev` branch so it can be easily integrated
20
- * We (sort of) follow [these Ruby style guidelines](https://github.com/bbatsov/ruby-style-guide)
21
-
22
- ## Get Involved in the Community
23
-
24
- Let's help each other out! Even if you're relatively new, there's probably some question out there that you can help answer. Here's how to help:
25
-
26
- * Subscribe to our thread on BoardGameGeek (see above for link)
27
- * Subscribe to alerts from Stackoverflow for the tags "squib" and "ruby"
28
- * Post snippets of your code using GitHub gists
29
- * Write a how-to tutorial and post it on [our wiki](https://github.com/andymeneely/squib/wiki)
30
-
31
- ## Testing Pre-Builds
32
-
33
- Testers needed!! If you want to test new features as I develop them, or make sure I didn't break your code, you can always point your Gemfile to the repository and follow what I'm doing there. Your Gemfile specification looks like this:
34
-
35
- ```ruby
36
- gem 'squib', git: 'git://github.com/andymeneely/squib', branch: 'dev'
37
- ```
38
- * The `dev` branch is where I am working on features in-process. I have not done much regression testing at this point, but would love testing feedback nonetheless.
39
- * The `master` branch is where I consider features and bug that are done and tested, but not released yet.
40
- * Use `bundle exec` to execute your code (e.g. `bundle exec rake` or `bundle exec ruby deck.rb`). See [Bundler](http://bundler.io) for more info.
1
+ # Contributing to Squib
2
+
3
+ Please use GitHub issues for bugs and feature requests.
4
+
5
+ ## Need Help?
6
+
7
+ There are lots of people using Squib already. If you've gone through the [samples](https://github.com/andymeneely/squib/tree/master/samples) and still have questions, here are some other places to get help.
8
+
9
+ * [StackOverflow](http://stackoverflow.com/questions/ask?tags=ruby squib) with the tag "ruby" and "squib" will get you answers quickly and a great way to document questions for future Squibbers.
10
+ * Our [thread on BoardGameGeek](http://boardgamegeek.com/thread/1293453) is quite active and informal (if a bit unstructured).
11
+
12
+ If you email me directly I'll probably ask you to post your question publicly so we can document answers for future Googling Squibbers.
13
+
14
+ ## Pull Requests
15
+
16
+ If you are contributing a new feature:
17
+ * Keep your change small and atomic. Do significant refactoring in a separate pull request.
18
+ * Please write a sample demonstrating your new feature. Place it in the samples/ directory
19
+ * While your pull request is open, please keep it up to date with the `dev` branch so it can be easily integrated
20
+ * We (sort of) follow [these Ruby style guidelines](https://github.com/bbatsov/ruby-style-guide)
21
+
22
+ ## Get Involved in the Community
23
+
24
+ Let's help each other out! Even if you're relatively new, there's probably some question out there that you can help answer. Here's how to help:
25
+
26
+ * Subscribe to our thread on BoardGameGeek (see above for link)
27
+ * Subscribe to alerts from Stackoverflow for the tags "squib" and "ruby"
28
+ * Post snippets of your code using GitHub gists
29
+ * Write a how-to tutorial and post it on [our wiki](https://github.com/andymeneely/squib/wiki)
30
+
31
+ ## Testing Pre-Builds
32
+
33
+ Testers needed!! If you want to test new features as I develop them, or make sure I didn't break your code, you can always point your Gemfile to the repository and follow what I'm doing there. Your Gemfile specification looks like this:
34
+
35
+ ```ruby
36
+ gem 'squib', git: 'git://github.com/andymeneely/squib', branch: 'dev'
37
+ ```
38
+ * The `dev` branch is where I am working on features in-process. I have not done much regression testing at this point, but would love testing feedback nonetheless.
39
+ * The `master` branch is where I consider features and bug that are done and tested, but not released yet.
40
+ * Use `bundle exec` to execute your code (e.g. `bundle exec rake` or `bundle exec ruby deck.rb`). See [Bundler](http://bundler.io) for more info.
data/Dockerfile CHANGED
@@ -1,27 +1,27 @@
1
- # This is the official Squib Docker image.
2
- #
3
- FROM ruby:2.7-slim
4
- WORKDIR /usr/src/app
5
-
6
- LABEL org.squib.url=http://squib.rocks \
7
- org.squib.github=https://github.com/andymeneely/squib
8
-
9
- RUN apt-get update && \
10
- apt-get install -y \
11
- libgirepository1.0-dev \
12
- build-essential \
13
- ruby-dev \
14
- ruby \
15
- ruby-gdk-pixbuf2 \
16
- git \
17
- fonts-open-sans
18
-
19
- # Build the current directory of Squib
20
- COPY . /usr/src/app
21
- RUN rm -f /usr/src/app/Gemfile.lock
22
- RUN gem install bundler
23
- RUN bundle install
24
- RUN bundle exec rake install
25
-
26
- # ENTRYPOINT [ "sh" ]
27
-
1
+ # This is the official Squib Docker image.
2
+ #
3
+ FROM ruby:3.0-slim
4
+ WORKDIR /usr/src/app
5
+
6
+ LABEL org.squib.url=http://squib.rocks \
7
+ org.squib.github=https://github.com/andymeneely/squib
8
+
9
+ RUN apt-get update && \
10
+ apt-get install -y \
11
+ libgirepository1.0-dev \
12
+ build-essential \
13
+ ruby-dev \
14
+ ruby \
15
+ ruby-gdk-pixbuf2 \
16
+ git \
17
+ fonts-open-sans
18
+
19
+ # Build the current directory of Squib
20
+ COPY . /usr/src/app
21
+ RUN rm -f /usr/src/app/Gemfile.lock
22
+ RUN gem install bundler
23
+ RUN bundle install
24
+ RUN bundle exec rake install
25
+
26
+ # ENTRYPOINT [ "sh" ]
27
+
data/Gemfile CHANGED
@@ -1,2 +1,2 @@
1
- source 'https://rubygems.org'
2
- gemspec
1
+ source 'https://rubygems.org'
2
+ gemspec
data/Guardfile CHANGED
@@ -1,8 +1,8 @@
1
- group :default do
2
- guard 'rake', :task => 'spec' do
3
- watch %r{.*\.xlsx$}
4
- watch %r{.*\.rb$}
5
- watch %r{.*\.yml$}
6
- watch %r{.*\.rst$}
7
- end
8
- end
1
+ group :default do
2
+ guard 'rake', :task => 'spec' do
3
+ watch %r{.*\.xlsx$}
4
+ watch %r{.*\.rb$}
5
+ watch %r{.*\.yml$}
6
+ watch %r{.*\.rst$}
7
+ end
8
+ end
data/LICENSE.txt CHANGED
@@ -1,22 +1,22 @@
1
- Copyright (c) 2014 Andy Meneely
2
-
3
- MIT License
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining
6
- a copy of this software and associated documentation files (the
7
- "Software"), to deal in the Software without restriction, including
8
- without limitation the rights to use, copy, modify, merge, publish,
9
- distribute, sublicense, and/or sell copies of the Software, and to
10
- permit persons to whom the Software is furnished to do so, subject to
11
- the following conditions:
12
-
13
- The above copyright notice and this permission notice shall be
14
- included in all copies or substantial portions of the Software.
15
-
16
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17
- EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18
- MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19
- NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
20
- LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21
- OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
22
- WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
1
+ Copyright (c) 2014 Andy Meneely
2
+
3
+ MIT License
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining
6
+ a copy of this software and associated documentation files (the
7
+ "Software"), to deal in the Software without restriction, including
8
+ without limitation the rights to use, copy, modify, merge, publish,
9
+ distribute, sublicense, and/or sell copies of the Software, and to
10
+ permit persons to whom the Software is furnished to do so, subject to
11
+ the following conditions:
12
+
13
+ The above copyright notice and this permission notice shall be
14
+ included in all copies or substantial portions of the Software.
15
+
16
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
20
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
22
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
data/README.md CHANGED
@@ -1,139 +1,139 @@
1
- # Squib [![Gem Version](https://badge.fury.io/rb/squib.svg)](https://rubygems.org/gems/squib) [![Build Status](https://secure.travis-ci.org/andymeneely/squib.svg?branch=master)](https://travis-ci.org/andymeneely/squib) [![Build status](https://ci.appveyor.com/api/projects/status/ptjw6fvjh73anlau/branch/master?svg=true)](https://ci.appveyor.com/project/andymeneely/squib/branch/master) [![Coverage Status](https://img.shields.io/coveralls/andymeneely/squib.svg)](https://coveralls.io/r/andymeneely/squib) [![ReadTheDocs](https://readthedocs.org/projects/squib/badge/?version=latest)](http://squib.readthedocs.io/en/latest/?badge=latest) [![BoardGameGeek](https://github.com/andymeneely/squib.rocks/raw/gh-pages/images/microbadge.png)](https://boardgamegeek.com/guild/2601)
2
-
3
- Squib is a Ruby [DSL](http://en.wikipedia.org/wiki/Domain-specific_language) for prototyping card and board games. Write a little bit of Ruby, define your deck's stats, then compile your game into a series of images ready for print-and-play or even print-on-demand. Squib is very data-driven and built on the principle of Don't Repeat Yourself. Think of it like [nanDeck](http://www.nand.it/nandeck/) done "the Ruby way". Squib supports:
4
-
5
- * A concise set of rules for laying out your cards
6
- * Loading PNGs and SVGs
7
- * Complex text rendering using [Pango](http://www.pango.org/)
8
- * Reading `xlsx` and `csv` files
9
- * Rendering to PNGs, PDFs, and SVGs (sheets or individual files)
10
- * Flexible, data-driven layouts in Yaml
11
- * Basic shape drawing, blending operators, gradients, etc.
12
- * Unit conversion
13
- * The full power of Ruby!
14
-
15
- Squib is based on the [Cairo](http://cairographics.org/) graphics rendering engine, the library of choice for WebKit, Gecko, Inkscape and many, many others.
16
-
17
- Check this out.
18
-
19
- ```ruby
20
- require 'squib'
21
-
22
- Squib::Deck.new(cards: 2) do
23
- text str: %w(Hello World!)
24
- save_png
25
- end
26
- ```
27
-
28
- We just created a 2-card deck with "Hello" on the first card, and "World" on the second, and saved them out to PNGs.
29
-
30
- Wanna see more? Check out the website: http://andymeneely.github.io/squib/
31
-
32
- ## Installation
33
-
34
- Squib requires Ruby 2.7 or later.
35
-
36
- Install it yourself with:
37
-
38
- $ gem install squib
39
-
40
- If you're using Bundler, add this line to your application's Gemfile:
41
-
42
- gem 'squib'
43
-
44
- And then execute:
45
-
46
- $ bundle
47
-
48
- More info: http://squib.readthedocs.org/en/latest/install.html
49
-
50
-
51
- ## Getting Started
52
-
53
- After installing Squib, you can create a project and run your first build like this:
54
-
55
- ```sh
56
- $ squib new my-cool-game
57
- $ cd my-cool-game
58
- $ ruby deck.rb
59
- ```
60
-
61
- The `squib new` command will generate files and folders like this:
62
-
63
- ```
64
- ├── .gitignore
65
- ├── ABOUT.md
66
- ├── Gemfile
67
- ├── IDEAS.md
68
- ├── PLAYTESTING.md
69
- ├── PNP NOTES.md
70
- ├── RULES.md
71
- ├── Rakefile
72
- ├── _output
73
- │   └── gitkeep.txt
74
- ├── config.yml
75
- ├── deck.rb
76
- └── layout.yml
77
-
78
- 12 files
79
- ```
80
-
81
-
82
- # Learning Squib
83
-
84
- Go [read the docs!](http://squib.readthedocs.org/)
85
-
86
- Also:
87
- * The `samples` directory in the [source repository](https://github.com/andymeneely/squib) has lots of examples.
88
- * [Masters of the Heist](http://mastersoftheheist.com) is my own creation, and it was made with Squib. Go through the repository and watch how it evolved!
89
- * [Junk Land](https://github.com/andymeneely/junk-land) is my own creation that's uses Squib for full-color rendering, and makes use of Ruby in a lot of interesting ways. The port is still in process.
90
- * [Project Spider Monkey](https://github.com/andymeneely/project-spider-monkey) is another of my own creations. This one was started from scratch with Squib, but it's still in its early stages.
91
-
92
-
93
- ## Staying DRY
94
-
95
- Squib tries to keep you DRY (Don't Repeat Yourself) with the following features:
96
-
97
- * Custom layouts allow you to specify various arguments in a separate file. This is great for x-y coordinates and alignment properties that would otherwise clutter up perfectly readable code. Squib goes even further and has a special "extends" that works especially well for grouped-together styles.
98
- * Flexible ranges and array handling: the `range` parameter in Squib is very flexible, meaning that one `text` command can specify different text in different fonts, styles, colors, etc. for each card. If you find yourself doing multiple `text` command for the same field across different ranges of cards, there's probably a better way to condense.
99
- * Custom colors keep you from hardcoding magic color strings everywhere. Custom colors go into `config.yml` file.
100
- * Plus, you know, Ruby.
101
-
102
-
103
- ## Docker
104
-
105
- Want to run in a controlled environment? We've got a [Docker image on DockerHub](https://cloud.docker.com/u/andymeneely/repository/docker/andymeneely/squib)
106
-
107
- Here's one way to run it. On the command line, go to the root of your repository. With these commands, we'll map the current directory to the `/usr/src/app` directory in the Docker image. When squib-in-docker read & writes files from there, it'll write it back out to your current directory.
108
-
109
- Assuming you have a script called hello.rb:
110
-
111
- On Windows:
112
-
113
- ```
114
- docker run --rm -v "%cd%":/usr/src/app andymeneely/squib ruby hello.rb
115
- ```
116
-
117
- On Macs:
118
-
119
- ```
120
- docker run --rm -v "$PWD":/usr/src/app andymeneely/squib ruby hello.rb
121
- ```
122
-
123
- This will create a folder called `_output` in your current directory and write the output of the script there.
124
-
125
- We're still working on ways to customize your own Docker build (e.g. document building, custom fonts, etc.) with your own Dockerfile. Pull requests and ideas welcome!
126
-
127
-
128
- # Get Help and Give Help
129
-
130
- See [this page](http://squib.readthedocs.org/en/latest/help.html)
131
-
132
-
133
- # What's up the with the name?
134
-
135
- Truthfully, I just thought it was a cool, simple word that was not used much in the Ruby community nor the board game community. But, now that I've committed to the name, I've realized that:
136
-
137
- * Squibs are small explosive devices, much like Squib "explodes" your rules into a playable game
138
- * Squibs are often used in heist movies, leading to a sudden plot twist that often resembles the twists of good tabletop game
139
- * Squibs are also part of the Harry Potter world - they are people who are non-magical but wizard-born. Squib is aware of wizarding magic and comes from that heritage, but it's not magical itself.
1
+ # Squib [![Gem Version](https://badge.fury.io/rb/squib.svg)](https://rubygems.org/gems/squib) [![Build Status](https://secure.travis-ci.org/andymeneely/squib.svg?branch=master)](https://travis-ci.org/andymeneely/squib) [![Build status](https://ci.appveyor.com/api/projects/status/ptjw6fvjh73anlau/branch/master?svg=true)](https://ci.appveyor.com/project/andymeneely/squib/branch/master) [![Coverage Status](https://img.shields.io/coveralls/andymeneely/squib.svg)](https://coveralls.io/r/andymeneely/squib) [![ReadTheDocs](https://readthedocs.org/projects/squib/badge/?version=latest)](http://squib.readthedocs.io/en/latest/?badge=latest) [![BoardGameGeek](https://github.com/andymeneely/squib.rocks/raw/gh-pages/images/microbadge.png)](https://boardgamegeek.com/guild/2601)
2
+
3
+ Squib is a Ruby [DSL](http://en.wikipedia.org/wiki/Domain-specific_language) for prototyping card and board games. Write a little bit of Ruby, define your deck's stats, then compile your game into a series of images ready for print-and-play or even print-on-demand. Squib is very data-driven and built on the principle of Don't Repeat Yourself. Think of it like [nanDeck](http://www.nand.it/nandeck/) done "the Ruby way". Squib supports:
4
+
5
+ * A concise set of rules for laying out your cards
6
+ * Loading PNGs and SVGs
7
+ * Complex text rendering using [Pango](http://www.pango.org/)
8
+ * Reading `xlsx` and `csv` files
9
+ * Rendering to PNGs, PDFs, and SVGs (sheets or individual files)
10
+ * Flexible, data-driven layouts in Yaml
11
+ * Basic shape drawing, blending operators, gradients, etc.
12
+ * Unit conversion
13
+ * The full power of Ruby!
14
+
15
+ Squib is based on the [Cairo](http://cairographics.org/) graphics rendering engine, the library of choice for WebKit, Gecko, Inkscape and many, many others.
16
+
17
+ Check this out.
18
+
19
+ ```ruby
20
+ require 'squib'
21
+
22
+ Squib::Deck.new(cards: 2) do
23
+ text str: %w(Hello World!)
24
+ save_png
25
+ end
26
+ ```
27
+
28
+ We just created a 2-card deck with "Hello" on the first card, and "World" on the second, and saved them out to PNGs.
29
+
30
+ Wanna see more? Check out the website: http://andymeneely.github.io/squib/
31
+
32
+ ## Installation
33
+
34
+ Squib requires Ruby 2.7 or later.
35
+
36
+ Install it yourself with:
37
+
38
+ $ gem install squib
39
+
40
+ If you're using Bundler, add this line to your application's Gemfile:
41
+
42
+ gem 'squib'
43
+
44
+ And then execute:
45
+
46
+ $ bundle
47
+
48
+ More info: http://squib.readthedocs.org/en/latest/install.html
49
+
50
+
51
+ ## Getting Started
52
+
53
+ After installing Squib, you can create a project and run your first build like this:
54
+
55
+ ```sh
56
+ $ squib new my-cool-game
57
+ $ cd my-cool-game
58
+ $ ruby deck.rb
59
+ ```
60
+
61
+ The `squib new` command will generate files and folders like this:
62
+
63
+ ```
64
+ ├── .gitignore
65
+ ├── ABOUT.md
66
+ ├── Gemfile
67
+ ├── IDEAS.md
68
+ ├── PLAYTESTING.md
69
+ ├── PNP NOTES.md
70
+ ├── RULES.md
71
+ ├── Rakefile
72
+ ├── _output
73
+ │   └── gitkeep.txt
74
+ ├── config.yml
75
+ ├── deck.rb
76
+ └── layout.yml
77
+
78
+ 12 files
79
+ ```
80
+
81
+
82
+ # Learning Squib
83
+
84
+ Go [read the docs!](http://squib.readthedocs.org/)
85
+
86
+ Also:
87
+ * The `samples` directory in the [source repository](https://github.com/andymeneely/squib) has lots of examples.
88
+ * [Masters of the Heist](http://mastersoftheheist.com) is my own creation, and it was made with Squib. Go through the repository and watch how it evolved!
89
+ * [Junk Land](https://github.com/andymeneely/junk-land) is my own creation that's uses Squib for full-color rendering, and makes use of Ruby in a lot of interesting ways. The port is still in process.
90
+ * [Project Spider Monkey](https://github.com/andymeneely/project-spider-monkey) is another of my own creations. This one was started from scratch with Squib, but it's still in its early stages.
91
+
92
+
93
+ ## Staying DRY
94
+
95
+ Squib tries to keep you DRY (Don't Repeat Yourself) with the following features:
96
+
97
+ * Custom layouts allow you to specify various arguments in a separate file. This is great for x-y coordinates and alignment properties that would otherwise clutter up perfectly readable code. Squib goes even further and has a special "extends" that works especially well for grouped-together styles.
98
+ * Flexible ranges and array handling: the `range` parameter in Squib is very flexible, meaning that one `text` command can specify different text in different fonts, styles, colors, etc. for each card. If you find yourself doing multiple `text` command for the same field across different ranges of cards, there's probably a better way to condense.
99
+ * Custom colors keep you from hardcoding magic color strings everywhere. Custom colors go into `config.yml` file.
100
+ * Plus, you know, Ruby.
101
+
102
+
103
+ ## Docker
104
+
105
+ Want to run in a controlled environment? We've got a [Docker image on DockerHub](https://cloud.docker.com/u/andymeneely/repository/docker/andymeneely/squib)
106
+
107
+ Here's one way to run it. On the command line, go to the root of your repository. With these commands, we'll map the current directory to the `/usr/src/app` directory in the Docker image. When squib-in-docker read & writes files from there, it'll write it back out to your current directory.
108
+
109
+ Assuming you have a script called hello.rb:
110
+
111
+ On Windows:
112
+
113
+ ```
114
+ docker run --rm -v "%cd%":/usr/src/app andymeneely/squib ruby hello.rb
115
+ ```
116
+
117
+ On Macs:
118
+
119
+ ```
120
+ docker run --rm -v "$PWD":/usr/src/app andymeneely/squib ruby hello.rb
121
+ ```
122
+
123
+ This will create a folder called `_output` in your current directory and write the output of the script there.
124
+
125
+ We're still working on ways to customize your own Docker build (e.g. document building, custom fonts, etc.) with your own Dockerfile. Pull requests and ideas welcome!
126
+
127
+
128
+ # Get Help and Give Help
129
+
130
+ See [this page](http://squib.readthedocs.org/en/latest/help.html)
131
+
132
+
133
+ # What's up the with the name?
134
+
135
+ Truthfully, I just thought it was a cool, simple word that was not used much in the Ruby community nor the board game community. But, now that I've committed to the name, I've realized that:
136
+
137
+ * Squibs are small explosive devices, much like Squib "explodes" your rules into a playable game
138
+ * Squibs are often used in heist movies, leading to a sudden plot twist that often resembles the twists of good tabletop game
139
+ * Squibs are also part of the Harry Potter world - they are people who are non-magical but wizard-born. Squib is aware of wizarding magic and comes from that heritage, but it's not magical itself.
data/Rakefile CHANGED
@@ -1,51 +1,51 @@
1
- require 'bundler/gem_tasks'
2
- require 'rspec/core/rake_task'
3
- require 'benchmark'
4
- # require 'byebug'
5
-
6
- desc 'install + spec'
7
- task default: ['install:local', :spec]
8
-
9
- desc 'test => spec'
10
- task test: [:spec]
11
-
12
- # Useful for hooking up with SublimeText.
13
- # e.g. rake sample[basic.rb]
14
- desc 'Run a specific sample'
15
- task :run, [:file] => :install do |t, args|
16
- args.with_defaults(file: 'basic.rb')
17
- Dir.chdir('samples') do
18
- args[:file] << '.rb' unless args[:file].end_with? '.rb'
19
- puts "Running samples/#{args[:file]}"
20
- load args[:file]
21
- end
22
- end
23
-
24
- RSpec::Core::RakeTask.new(:spec)
25
-
26
- RSpec::Core::RakeTask.new(:spec_fastonly) do |t|
27
- t.rspec_opts = '--tag ~slow'
28
- end
29
-
30
- desc 'Run some performance benchmarks'
31
- task benchmark: [:install] do
32
- require 'squib'
33
- Squib::logger.level = Logger::ERROR # silence warnings
34
- Dir.chdir('benchmarks') do
35
- Benchmark.bm(15) do |bm|
36
- Dir['*.rb'].each do | script |
37
- GC.start
38
- bm.report(script) { load script }
39
- end
40
- end
41
- end
42
- end
43
-
44
- desc 'Run sanity tests without a full rebuild'
45
- task :sanity_only do
46
- require_relative 'spec/sanity/sanity_test.rb'
47
- SanityTest.new.run
48
- end
49
-
50
- desc 'Run full rebuild with sanity tests'
51
- task sanity: [:install, :spec, :sanity_only]
1
+ require 'bundler/gem_tasks'
2
+ require 'rspec/core/rake_task'
3
+ require 'benchmark'
4
+ # require 'byebug'
5
+
6
+ desc 'install + spec'
7
+ task default: ['install:local', :spec]
8
+
9
+ desc 'test => spec'
10
+ task test: [:spec]
11
+
12
+ # Useful for hooking up with SublimeText.
13
+ # e.g. rake sample[basic.rb]
14
+ desc 'Run a specific sample'
15
+ task :run, [:file] => :install do |t, args|
16
+ args.with_defaults(file: 'basic.rb')
17
+ Dir.chdir('samples') do
18
+ args[:file] << '.rb' unless args[:file].end_with? '.rb'
19
+ puts "Running samples/#{args[:file]}"
20
+ load args[:file]
21
+ end
22
+ end
23
+
24
+ RSpec::Core::RakeTask.new(:spec)
25
+
26
+ RSpec::Core::RakeTask.new(:spec_fastonly) do |t|
27
+ t.rspec_opts = '--tag ~slow'
28
+ end
29
+
30
+ desc 'Run some performance benchmarks'
31
+ task benchmark: [:install] do
32
+ require 'squib'
33
+ Squib::logger.level = Logger::ERROR # silence warnings
34
+ Dir.chdir('benchmarks') do
35
+ Benchmark.bm(15) do |bm|
36
+ Dir['*.rb'].each do | script |
37
+ GC.start
38
+ bm.report(script) { load script }
39
+ end
40
+ end
41
+ end
42
+ end
43
+
44
+ desc 'Run sanity tests without a full rebuild'
45
+ task :sanity_only do
46
+ require_relative 'spec/sanity/sanity_test.rb'
47
+ SanityTest.new.run
48
+ end
49
+
50
+ desc 'Run full rebuild with sanity tests'
51
+ task sanity: [:install, :spec, :sanity_only]
data/bin/squib CHANGED
@@ -1,5 +1,5 @@
1
- #!/usr/bin/env ruby
2
- require 'squib'
3
- require 'squib/commands/cli'
4
-
5
- Squib::CLI.new.run
1
+ #!/usr/bin/env ruby
2
+ require 'squib'
3
+ require 'squib/commands/cli'
4
+
5
+ Squib::CLI.new.run
@@ -1,21 +1,21 @@
1
- module Squib
2
- class Deck
3
-
4
- # DSL method. See http://squib.readthedocs.io
5
- def hint(text: :off)
6
- conf.text_hint = text
7
- end
8
-
9
- # DSL method. See http://squib.readthedocs.io
10
- def set(opts = {})
11
- raise 'DEPRECATED: As of v0.7 img_dir is no longer supported in "set". Use config.yml instead.' if opts.key? :img_dir
12
- @font = (opts[:font] == :default) ? Squib::DEFAULT_FONT : opts[:font]
13
- end
14
-
15
- # DSL method. See http://squib.readthedocs.io
16
- def use_layout(file: 'layout.yml')
17
- @layout = LayoutParser.new(@dpi).load_layout(file, @layout)
18
- end
19
-
20
- end
21
- end
1
+ module Squib
2
+ class Deck
3
+
4
+ # DSL method. See http://squib.readthedocs.io
5
+ def hint(text: :off)
6
+ conf.text_hint = text
7
+ end
8
+
9
+ # DSL method. See http://squib.readthedocs.io
10
+ def set(opts = {})
11
+ raise 'DEPRECATED: As of v0.7 img_dir is no longer supported in "set". Use config.yml instead.' if opts.key? :img_dir
12
+ @font = (opts[:font] == :default) ? Squib::DEFAULT_FONT : opts[:font]
13
+ end
14
+
15
+ # DSL method. See http://squib.readthedocs.io
16
+ def use_layout(file: 'layout.yml')
17
+ @layout = LayoutParser.new(@dpi).load_layout(file, @layout)
18
+ end
19
+
20
+ end
21
+ end