squib 0.9.0 → 0.10.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.gitignore +2 -1
- data/.gitmodules +22 -0
- data/.travis.yml +4 -5
- data/CHANGELOG.md +23 -0
- data/CONTRIBUTING.md +40 -0
- data/README.md +25 -553
- data/RELEASE TODO.md +2 -2
- data/Rakefile +6 -64
- data/appveyor.yml +0 -4
- data/benchmarks/antialias_best.rb +2 -2
- data/benchmarks/antialias_fast.rb +2 -2
- data/benchmarks/{backend-memory.rb → backend_memory.rb} +2 -2
- data/benchmarks/{backend-svg.rb → backend_svg.rb} +2 -2
- data/benchmarks/tons_of_png.rb +1 -1
- data/benchmarks/tons_of_svg.rb +1 -1
- data/benchmarks/tons_of_text.rb +1 -1
- data/docs/Makefile +216 -0
- data/docs/_static/css/squibdocs.css +18 -0
- data/docs/args/draw.rst +36 -0
- data/docs/args/expansion.rst +3 -0
- data/docs/args/layout.rst +6 -0
- data/docs/args/output_dir.rst +6 -0
- data/docs/args/range.rst +6 -0
- data/docs/args/transform.rst +51 -0
- data/docs/args/trim.rst +11 -0
- data/docs/args/wh.rst +12 -0
- data/docs/args/xy.rst +12 -0
- data/docs/arrays.rst +77 -0
- data/docs/backends.rst +20 -0
- data/docs/bleed.rst +13 -0
- data/docs/build_groups.rst +47 -0
- data/docs/colors.rst +64 -0
- data/docs/conf.py +287 -0
- data/docs/config.rst +117 -0
- data/docs/data.rst +22 -0
- data/docs/dsl/background.rst +20 -0
- data/docs/dsl/build.rst +32 -0
- data/docs/dsl/build_groups.rst +23 -0
- data/docs/dsl/circle.rst +27 -0
- data/docs/dsl/cm.rst +19 -0
- data/docs/dsl/csv.rst +62 -0
- data/docs/dsl/curve.rst +63 -0
- data/docs/dsl/deck.rst +45 -0
- data/docs/dsl/disable_build.rst +28 -0
- data/docs/dsl/ellipse.rst +17 -0
- data/docs/dsl/enable_build.rst +25 -0
- data/docs/dsl/grid.rst +31 -0
- data/docs/dsl/hand.rst +40 -0
- data/docs/dsl/hint.rst +15 -0
- data/docs/dsl/inches.rst +19 -0
- data/docs/dsl/index.rst +9 -0
- data/docs/dsl/line.rst +52 -0
- data/docs/dsl/png.rst +49 -0
- data/docs/dsl/polygon.rst +28 -0
- data/docs/dsl/rect.rst +18 -0
- data/docs/dsl/save.rst +23 -0
- data/docs/dsl/save_pdf.rst +48 -0
- data/docs/dsl/save_png.rst +46 -0
- data/docs/dsl/save_sheet.rst +55 -0
- data/docs/dsl/showcase.rst +65 -0
- data/docs/dsl/star.rst +35 -0
- data/docs/dsl/svg.rst +119 -0
- data/docs/dsl/text.rst +294 -0
- data/docs/dsl/triangle.rst +38 -0
- data/docs/dsl/use_layout.rst +16 -0
- data/docs/dsl/xlsx.rst +50 -0
- data/docs/guides/game_icons.rst +2 -0
- data/docs/guides/getting-started/index.rst +5 -0
- data/docs/guides/getting-started/part_0_learning_ruby.rst +145 -0
- data/docs/guides/getting-started/part_1_zero_to_game.rst +216 -0
- data/docs/guides/getting-started/part_2_iconography.rst +152 -0
- data/docs/guides/getting-started/part_3_workflows.rst +4 -0
- data/docs/guides/git.rst +13 -0
- data/docs/guides/hello_world.rst +6 -0
- data/docs/help.rst +157 -0
- data/docs/index.rst +35 -0
- data/docs/install.rst +66 -0
- data/docs/layouts.rst +235 -0
- data/docs/learning.rst +10 -0
- data/docs/make.bat +263 -0
- data/docs/parameters.rst +26 -0
- data/docs/server.bat +1 -0
- data/docs/text_feature.rst +86 -0
- data/docs/units.rst +6 -0
- data/lib/squib.rb +4 -4
- data/lib/squib/api/background.rb +5 -10
- data/lib/squib/api/data.rb +30 -54
- data/lib/squib/api/groups.rb +47 -0
- data/lib/squib/api/image.rb +8 -67
- data/lib/squib/api/save.rb +15 -105
- data/lib/squib/api/settings.rb +8 -22
- data/lib/squib/api/shapes.rb +15 -185
- data/lib/squib/api/text.rb +9 -49
- data/lib/squib/api/text_embed.rb +12 -12
- data/lib/squib/api/units.rb +3 -17
- data/lib/squib/args/arg_loader.rb +6 -6
- data/lib/squib/args/box.rb +2 -2
- data/lib/squib/args/card_range.rb +1 -1
- data/lib/squib/args/color_validator.rb +2 -2
- data/lib/squib/args/coords.rb +2 -2
- data/lib/squib/args/csv_opts.rb +25 -0
- data/lib/squib/args/dir_validator.rb +1 -1
- data/lib/squib/args/draw.rb +2 -2
- data/lib/squib/args/embed_adjust.rb +1 -1
- data/lib/squib/args/embed_key.rb +1 -1
- data/lib/squib/args/hand_special.rb +37 -37
- data/lib/squib/args/import.rb +2 -2
- data/lib/squib/args/input_file.rb +1 -1
- data/lib/squib/args/paint.rb +3 -3
- data/lib/squib/args/paragraph.rb +2 -2
- data/lib/squib/args/save_batch.rb +2 -2
- data/lib/squib/args/scale_box.rb +1 -1
- data/lib/squib/args/sheet.rb +3 -3
- data/lib/squib/args/showcase_special.rb +2 -2
- data/lib/squib/args/svg_special.rb +1 -1
- data/lib/squib/args/transform.rb +2 -2
- data/lib/squib/args/typographer.rb +5 -4
- data/lib/squib/args/unit_conversion.rb +4 -4
- data/lib/squib/card.rb +8 -8
- data/lib/squib/conf.rb +5 -5
- data/lib/squib/deck.rb +20 -18
- data/lib/squib/graphics/cairo_context_wrapper.rb +3 -3
- data/lib/squib/graphics/gradient_regex.rb +1 -1
- data/lib/squib/graphics/hand.rb +2 -2
- data/lib/squib/graphics/save_doc.rb +9 -8
- data/lib/squib/graphics/save_images.rb +24 -11
- data/lib/squib/graphics/shapes.rb +16 -17
- data/lib/squib/graphics/showcase.rb +9 -9
- data/lib/squib/graphics/text.rb +21 -21
- data/lib/squib/layout_parser.rb +9 -9
- data/lib/squib/layouts/economy.yml +85 -85
- data/lib/squib/layouts/fantasy.yml +101 -101
- data/lib/squib/layouts/hand.yml +62 -62
- data/lib/squib/layouts/playing-card.yml +35 -35
- data/lib/squib/layouts/tuck_box.yml +45 -45
- data/lib/squib/sample_helpers.rb +1 -1
- data/lib/squib/version.rb +1 -1
- data/samples/{backend.rb → backend/_backend.rb} +2 -2
- data/samples/basic.rb +3 -3
- data/samples/bug134.rb +14 -0
- data/samples/build_groups/build_groups.rb +36 -0
- data/samples/cairo_access.rb +12 -1
- data/samples/{colors.rb → colors/_colors.rb} +12 -12
- data/samples/{gradients.rb → colors/_gradients.rb} +1 -1
- data/samples/config_text_markup.rb +2 -2
- data/samples/custom-config.yml +5 -5
- data/samples/custom_config.rb +18 -18
- data/samples/{csv_import.rb → data/_csv.rb} +8 -1
- data/samples/{excel.rb → data/_excel.rb} +3 -3
- data/samples/embed_text.rb +21 -0
- data/samples/hello_world.rb +1 -1
- data/samples/{load_images.rb → images/_more_load_images.rb} +2 -2
- data/samples/layouts.rb +11 -1
- data/samples/layouts_builtin.rb +51 -51
- data/samples/offset.svg +71 -71
- data/samples/ranges.rb +7 -7
- data/samples/{hand.rb → saves/_hand.rb} +1 -2
- data/samples/{portrait-landscape.rb → saves/_portrait_landscape.rb} +4 -4
- data/samples/{saves.rb → saves/_saves.rb} +0 -0
- data/samples/{showcase.rb → saves/_showcase.rb} +2 -2
- data/samples/{draw_shapes.rb → shapes/_draw_shapes.rb} +1 -1
- data/samples/text/_text.rb +4 -3
- data/samples/text_options.rb +6 -6
- data/samples/unicode.rb +1 -1
- data/spec/api/api_data_spec.rb +59 -4
- data/spec/api/api_settings_spec.rb +1 -1
- data/spec/args/box_spec.rb +7 -7
- data/spec/args/draw_spec.rb +19 -19
- data/spec/args/embed_key_spec.rb +13 -13
- data/spec/args/input_file_spec.rb +2 -2
- data/spec/args/paint_spec.rb +5 -5
- data/spec/args/paragraph_spec.rb +28 -28
- data/spec/args/range_spec.rb +1 -1
- data/spec/args/save_batch_spec.rb +10 -10
- data/spec/args/scale_box_spec.rb +9 -9
- data/spec/args/sheet_spec.rb +8 -8
- data/spec/args/showcase_special_spec.rb +15 -15
- data/spec/args/transform_spec.rb +4 -4
- data/spec/args/typographer_spec.rb +11 -11
- data/spec/args/unit_conversion_spec.rb +2 -2
- data/spec/card_spec.rb +1 -1
- data/spec/commands/new_spec.rb +1 -1
- data/spec/data/csv/custom_opts.csv +2 -0
- data/spec/data/csv/newline.csv +3 -0
- data/spec/data/csv/qty.csv +2 -2
- data/spec/data/csv/qty_named.csv +2 -2
- data/spec/data/csv/with_spaces.csv +2 -2
- data/spec/data/csv/yield.csv +3 -0
- data/spec/data/samples/{autoscale_font.rb.txt → autoscale_font/_autoscale_font.rb.txt} +55 -18
- data/spec/data/samples/cairo_access.rb.txt +24 -0
- data/spec/data/samples/{gradients.rb.txt → colors/_gradients.rb.txt} +0 -0
- data/spec/data/samples/config_text_markup.rb.txt +72 -72
- data/spec/data/samples/custom_config.rb.txt +1 -0
- data/spec/data/samples/{csv_import.rb.txt → data/_csv.rb.txt} +0 -0
- data/spec/data/samples/{excel.rb.txt → data/_excel.rb.txt} +0 -0
- data/spec/data/samples/embed_text.rb.txt +79 -0
- data/spec/data/samples/hello_world.rb.txt +36 -36
- data/spec/data/samples/{load_images.rb.txt → images/_more_load_images.rb.txt} +4 -4
- data/spec/data/samples/{hand.rb.txt → saves/_hand.rb.txt} +0 -0
- data/spec/data/samples/{portrait-landscape.rb.txt → saves/_portrait_landscape.rb.txt} +11 -7
- data/spec/data/samples/{save_pdf.rb.txt → saves/_save_pdf.rb.txt} +0 -0
- data/spec/data/samples/{saves.rb.txt → saves/_saves.rb.txt} +3 -4
- data/spec/data/samples/{showcase.rb.txt → saves/_showcase.rb.txt} +0 -0
- data/spec/data/samples/{draw_shapes.rb.txt → shapes/_draw_shapes.rb.txt} +0 -0
- data/spec/data/samples/text_options.rb.txt +1125 -1125
- data/spec/graphics/cairo_context_wrapper_spec.rb +10 -10
- data/spec/graphics/graphics_save_doc_spec.rb +11 -5
- data/spec/layout_parser_spec.rb +21 -9
- data/spec/logger_spec.rb +2 -2
- data/spec/samples/run_samples_spec.rb +1 -1
- data/spec/samples/samples_regression_spec.rb +16 -18
- data/spec/samples/sanity.rb +9 -9
- data/spec/sanity/.gitignore +1 -0
- data/spec/sanity/sanity.html.erb +42 -0
- data/spec/sanity/sanity_test.rb +42 -0
- data/spec/sanity/tests.yml +12 -0
- data/spec/spec_helper.rb +22 -20
- data/squib.gemspec +3 -4
- metadata +143 -81
- data/.rspec +0 -1
- data/.yardopts +0 -10
- data/samples/autoscale_font.rb +0 -27
- data/samples/backend-config.yml +0 -5
- data/samples/color_shortcuts.rb +0 -6
- data/samples/explode_quantities.xlsx +0 -0
- data/samples/quantity_explosion.csv +0 -3
- data/samples/sample.csv +0 -3
- data/samples/sample.xlsx +0 -0
- data/squib.sublime-project +0 -42
@@ -0,0 +1,47 @@
|
|
1
|
+
require 'set'
|
2
|
+
|
3
|
+
module Squib
|
4
|
+
|
5
|
+
# An idea for later...
|
6
|
+
# def enable_group_env group
|
7
|
+
# ENV['SQUIB_BUILD'] ||= ''
|
8
|
+
# ENV['SQUIB_BUILD'] += ','
|
9
|
+
# ENV['SQUIB_BUILD'] += group
|
10
|
+
# end
|
11
|
+
# module_function :enable_group_env
|
12
|
+
|
13
|
+
class Deck
|
14
|
+
|
15
|
+
# DSL method. See http://squib.readthedocs.org
|
16
|
+
def build grp = :all, &block
|
17
|
+
raise 'Please provide a block' unless block_given?
|
18
|
+
block.yield if build_groups.include? grp
|
19
|
+
end
|
20
|
+
|
21
|
+
# DSL method. See http://squib.readthedocs.org
|
22
|
+
def enable_build grp
|
23
|
+
build_groups # make sure it's initialized
|
24
|
+
@build_groups << grp
|
25
|
+
end
|
26
|
+
|
27
|
+
# DSL method. See http://squib.readthedocs.org
|
28
|
+
def disable_build grp
|
29
|
+
build_groups # make sure it's initialized
|
30
|
+
@build_groups.delete grp
|
31
|
+
end
|
32
|
+
|
33
|
+
# DSL method. See http://squib.readthedocs.org
|
34
|
+
def build_groups
|
35
|
+
@build_groups ||= Set.new.add(:all)
|
36
|
+
end
|
37
|
+
|
38
|
+
# Not a DSL method, but initialized from Deck.new
|
39
|
+
def enable_groups_from_env!
|
40
|
+
return if ENV['SQUIB_BUILD'].nil?
|
41
|
+
ENV['SQUIB_BUILD'].split(',').each do |grp|
|
42
|
+
enable_build grp.strip.to_sym
|
43
|
+
end
|
44
|
+
end
|
45
|
+
|
46
|
+
end
|
47
|
+
end
|
data/lib/squib/api/image.rb
CHANGED
@@ -1,41 +1,14 @@
|
|
1
|
-
|
2
|
-
|
3
|
-
|
4
|
-
|
5
|
-
|
6
|
-
|
1
|
+
require_relative '../args/card_range'
|
2
|
+
require_relative '../args/paint'
|
3
|
+
require_relative '../args/scale_box'
|
4
|
+
require_relative '../args/transform'
|
5
|
+
require_relative '../args/input_file'
|
6
|
+
require_relative '../args/svg_special'
|
7
7
|
|
8
8
|
module Squib
|
9
9
|
class Deck
|
10
10
|
|
11
|
-
#
|
12
|
-
#
|
13
|
-
# See {file:samples/image.rb samples/image.rb} and {file:samples/tgc-overlay.rb samples/tgc-overlay.rb} as examples.
|
14
|
-
# @example
|
15
|
-
# png file: 'img.png', x: 50, y: 50
|
16
|
-
#
|
17
|
-
# @option opts range [Enumerable, :all] (:all) the range of cards over which this will be rendered. See {file:README.md#Specifying_Ranges Specifying Ranges}
|
18
|
-
# @option opts file [String] ((empty)) file(s) to read in. If it's a single file, then it's use for every card in range. If the parameter is an Array of files, then each file is looked up for each card. If any of them are nil or '', nothing is done. See {file:README.md#Specifying_Files Specifying Files}. Supports Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}
|
19
|
-
# @option opts x [Integer] (0) the x-coordinate to place. Supports Arrays, see {file:README#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}. Supports Unit Conversion, see {file:README.md#Units Units}.
|
20
|
-
# @option opts y [Integer] (0) the y-coordinate to place. Supports Arrays, see {file:README#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}. Supports Unit Conversion, see {file:README.md#Units Units}.
|
21
|
-
# @option opts width [Integer, :native, :scale, :deck] (:native) the pixel width that the image should scale to. :deck will scale to the deck width. :scale will use the height to scale and keep native the aspect ratio. Scaling PNGs is not recommended for professional-looking cards. When set to `:native`, uses the DPI and units of the loaded SVG document. Supports Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}. Supports Unit Conversion, see {file:README.md#Units Units}.
|
22
|
-
# @option opts height [Integer, :native, :scale, :deck] (:native) the pixel width that the image should scale to. :deck will scale to the deck height. :scale will use the width to scale and keep native the aspect ratio. Scaling PNGs is not recommended for professional-looking cards. When set to `:native`, uses the DPI and units of the loaded SVG document. Supports Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}. Supports Unit Conversion, see {file:README.md#Units Units}.
|
23
|
-
# @option opts layout [String, Symbol] (nil) entry in the layout to use as defaults for this command. See {file:README.md#Custom_Layouts Custom Layouts}. Supports Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}
|
24
|
-
# @option opts alpha [Decimal] (1.0) the alpha-transparency percentage used to blend this image. Supports Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}
|
25
|
-
# @option opts blend [:none, :multiply, :screen, :overlay, :darken, :lighten, :color_dodge, :color_burn, :hard_light, :soft_light, :difference, :exclusion, :hsl_hue, :hsl_saturation, :hsl_color, :hsl_luminosity] (:none) the composite blend operator used when applying this image. See Blend Modes at http://cairographics.org/operators. Supports Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}
|
26
|
-
# @option opts angle [FixNum] (0) Rotation of the in radians. Note that this rotates around the upper-left corner, making the placement of x-y coordinates slightly tricky. Supports Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}
|
27
|
-
# @option opts mask [String] (nil) If specified, the image will be used as a mask for the given color/gradient. Transparent pixels are ignored, opaque pixels are the given color. Note: the origin for gradient coordinates is at the given x,y, not at 0,0 as it is most other places.
|
28
|
-
# @option opts crop_x [Integer] (0) Crop the loaded image at this x coordinate. Supports Unit Conversion, see {file:README.md#Units Units}.
|
29
|
-
# @option opts crop_y [Integer] (0) Crop the loaded image at this y coordinate. Supports Unit Conversion, see {file:README.md#Units Units}.
|
30
|
-
# @option opts crop_corner_radius [Integer] (0): Radius for rounded corners, both x and y. When set, overrides crop_corner_x_radius and crop_corner_y_radius. Supports Unit Conversion, see {file:README.md#Units Units}.
|
31
|
-
# @option opts crop_corner_x_radius [Integer] (0): x radius for rounded corners of cropped image. Supports Unit Conversion, see {file:README.md#Units Units}.
|
32
|
-
# @option opts crop_corner_y_radius [Integer] (0): y radius for rounded corners of cropped image. Supports Unit Conversion, see {file:README.md#Units Units}.
|
33
|
-
# @option opts crop_width [Integer] (:native): Width of the cropped image. Supports Unit Conversion, see {file:README.md#Units Units}.
|
34
|
-
# @option opts crop_height [Integer] (:native): Height of the cropped image. Supports Unit Conversion, see {file:README.md#Units Units}.
|
35
|
-
# @option opts flip_horiztonal [Boolean] (false): Flip this image about its center horizontally (i.e. left becomes right and vice versa).
|
36
|
-
# @option opts flip_vertical [Boolean] (false): Flip this image about its center verticall (i.e. top becomes bottom and vice versa).
|
37
|
-
# @return [nil] Returns nil
|
38
|
-
# @api public
|
11
|
+
# DSL method. See http://squib.readthedocs.org
|
39
12
|
def png(opts = {})
|
40
13
|
Dir.chdir(img_dir) do
|
41
14
|
range = Args::CardRange.new(opts[:range], deck_size: size)
|
@@ -52,39 +25,7 @@ module Squib
|
|
52
25
|
end
|
53
26
|
end
|
54
27
|
|
55
|
-
#
|
56
|
-
#
|
57
|
-
# See {file:samples/load-images.rb samples/load-images.rb} and {file:samples/tgc-overlay.rb samples/tgc-overlay.rb} as examples.
|
58
|
-
#
|
59
|
-
# Note: if alpha transparency is desired, set that in the SVG.
|
60
|
-
#
|
61
|
-
# @example
|
62
|
-
# svg range: 1..2, file: 'icon.svg', id: '#stone', x: 50, y:50
|
63
|
-
#
|
64
|
-
# @option opts range [Enumerable, :all] (:all) the range of cards over which this will be rendered. See {file:README.md#Specifying_Ranges Specifying Ranges}
|
65
|
-
# @option opts file [String] ('') file(s) to read in. If it's a single file, then it's use for every card in range. If the parameter is an Array of files, then each file is looked up for each card. If any of them are nil or '', nothing is done. See {file:README.md#Specifying_Files Specifying Files}. Supports Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}
|
66
|
-
# @option opts data [String] (nil) render from an SVG XML string. Overrides file if both are specified (a warning is shown) . If it's a single file, then it's use for every card in range. If the parameter is an Array of files, then each file is looked up for each card. If any of them are nil or '', nothing is done. See {file:README.md#Specifying_Files Specifying Files}. Supports Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}.
|
67
|
-
# @option opts id [String] (nil) if set, then only render the SVG element with the given id. Prefix '#' is optional. Note: the x-y coordinates are still relative to the SVG document's page. Supports Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}
|
68
|
-
# @option opts force_id [Boolean] (false) if set, then this svg will not be rendered at all if the id is empty or nil. If not set, the entire SVG is rendered. Supports Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}
|
69
|
-
# @option opts x [Integer] (0) the x-coordinate to place. Supports Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}. Supports Unit Conversion, see {file:README.md#Units Units}.
|
70
|
-
# @option opts y [Integer] (0) the y-coordinate to place. Supports Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}. Supports Unit Conversion, see {file:README.md#Units Units}.
|
71
|
-
# @option opts width [Integer] (:native) the pixel width that the image should scale to. :deck will scale to the deck height. :scale will use the width to scale and keep native the aspect ratio. SVG scaling is done with vectors, so the scaling should be smooth. When set to `:native`, uses the DPI and units of the loaded SVG document. Supports Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}. Supports Unit Conversion, see {file:README.md#Units Units}.
|
72
|
-
# @option opts height [Integer] (:native) the pixel width that the image should scale to. :deck will scale to the deck height. :scale will use the width to scale and keep native the aspect ratio. SVG scaling is done with vectors, so the scaling should be smooth. When set to `:native`, uses the DPI and units of the loaded SVG document. Supports Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}. Supports Unit Conversion, see {file:README.md#Units Units}.
|
73
|
-
# @option opts layout [String, Symbol] (nil) entry in the layout to use as defaults for this command. See {file:README.md#Custom_Layouts Custom Layouts}. Supports Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}
|
74
|
-
# @option opts blend [:none, :multiply, :screen, :overlay, :darken, :lighten, :color_dodge, :color_burn, :hard_light, :soft_light, :difference, :exclusion, :hsl_hue, :hsl_saturation, :hsl_color, :hsl_luminosity] (:none) the composite blend operator used when applying this image. See Blend Modes at http://cairographics.org/operators. Supports Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}
|
75
|
-
# @option opts angle [FixNum] (0) Rotation of the in radians. Note that this rotates around the upper-left corner, making the placement of x-y coordinates slightly tricky. Supports Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}
|
76
|
-
# @option opts mask [String] (nil) If specified, the image will be used as a mask for the given color/gradient. Transparent pixels are ignored, opaque pixels are the given color. Note: the origin for gradient coordinates is at the given x,y, not at 0,0 as it is most other places.
|
77
|
-
# @option opts crop_x [Integer] (0) Crop the loaded image at this x coordinate. Supports Unit Conversion, see {file:README.md#Units Units}.
|
78
|
-
# @option opts crop_y [Integer] (0) Crop the loaded image at this y coordinate. Supports Unit Conversion, see {file:README.md#Units Units}.
|
79
|
-
# @option opts crop_corner_radius [Integer] (0): Radius for rounded corners, both x and y. When set, overrides crop_corner_x_radius and crop_corner_y_radius. Supports Unit Conversion, see {file:README.md#Units Units}.
|
80
|
-
# @option opts crop_corner_x_radius [Integer] (0): x radius for rounded corners of cropped image. Supports Unit Conversion, see {file:README.md#Units Units}.
|
81
|
-
# @option opts crop_corner_y_radius [Integer] (0): y radius for rounded corners of cropped image. Supports Unit Conversion, see {file:README.md#Units Units}.
|
82
|
-
# @option opts crop_width [Integer] (:native): Width of the cropped image. Supports Unit Conversion, see {file:README.md#Units Units}.
|
83
|
-
# @option opts crop_height [Integer] (:native): Height of the cropped image. Supports Unit Conversion, see {file:README.md#Units Units}.
|
84
|
-
# @option opts flip_horiztonal [Boolean] (false): Flip this image about its center horizontally (i.e. left becomes right and vice versa).
|
85
|
-
# @option opts flip_vertical [Boolean] (false): Flip this image about its center verticall (i.e. top becomes bottom and vice versa).
|
86
|
-
# @return [nil] Returns nil
|
87
|
-
# @api public
|
28
|
+
# DSL method. See http://squib.readthedocs.org
|
88
29
|
def svg(opts = {})
|
89
30
|
Dir.chdir(img_dir) do
|
90
31
|
range = Args::CardRange.new(opts[:range], deck_size: size)
|
data/lib/squib/api/save.rb
CHANGED
@@ -1,64 +1,27 @@
|
|
1
|
-
|
2
|
-
|
3
|
-
|
4
|
-
|
5
|
-
|
1
|
+
require_relative '../args/card_range'
|
2
|
+
require_relative '../args/hand_special'
|
3
|
+
require_relative '../args/save_batch'
|
4
|
+
require_relative '../args/sheet'
|
5
|
+
require_relative '../args/showcase_special'
|
6
6
|
|
7
7
|
module Squib
|
8
8
|
class Deck
|
9
9
|
|
10
|
-
#
|
11
|
-
#
|
12
|
-
#
|
13
|
-
# @option opts [Enumerable] range (:all) the range of cards over which this will be rendered. See {file:README.md#Specifying_Ranges Specifying Ranges}
|
14
|
-
# @option opts [String] dir (_output) the directory for the output to be sent to. Will be created if it doesn't exist.
|
15
|
-
# @option opts [Symbol] format (:png) the format that this will be rendered too. Options `:pdf, :png`. Array of both is allowed: `[:pdf, :png]`
|
16
|
-
# @option opts [String] prefix (card_) the prefix of the file name to be printed
|
17
|
-
# @option opts [Boolean] rotate (false) PNG saving only. If true, the saved cards will be rotated 90 degrees clockwise. Intended to rendering landscape instead of portrait.
|
18
|
-
# @return self
|
19
|
-
# @api public
|
10
|
+
# DSL method. See http://squib.readthedocs.org
|
20
11
|
def save(opts = {})
|
21
12
|
save_png(opts) if Array(opts[:format]).include? :png
|
22
13
|
save_pdf(opts) if Array(opts[:format]).include? :pdf
|
23
14
|
self
|
24
15
|
end
|
25
16
|
|
26
|
-
#
|
27
|
-
#
|
28
|
-
# @example
|
29
|
-
# save_pdf file: 'deck.pdf', margin: 75, gap: 5, trim: 37
|
30
|
-
#
|
31
|
-
# @option opts file [String] the name of the PDF file to save. See {file:README.md#Specifying_Files Specifying Files}
|
32
|
-
# @option opts dir [String] (_output) the directory to save to. Created if it doesn't exist.
|
33
|
-
# @option opts width [Integer] (3300) the height of the page in pixels. Default is 11in * 300dpi. Supports unit conversion.
|
34
|
-
# @option opts height [Integer] (2550) the height of the page in pixels. Default is 8.5in * 300dpi. Supports unit conversion.
|
35
|
-
# @option opts margin [Integer] (75) the margin around the outside of the page. Supports unit conversion.
|
36
|
-
# @option opts gap [Integer] (0) the space in pixels between the cards. Supports unit conversion.
|
37
|
-
# @option opts trim [Integer] (0) the space around the edge of each card to trim (e.g. to cut off the bleed margin for print-and-play). Supports unit conversion.
|
38
|
-
# @return [nil]
|
39
|
-
# @api public
|
17
|
+
# DSL method. See http://squib.readthedocs.org
|
40
18
|
def save_pdf(opts = {})
|
41
19
|
range = Args::CardRange.new(opts[:range], deck_size: size)
|
42
|
-
sheet = Args::Sheet.new(custom_colors, {file: 'output.pdf'}).load!(opts, expand_by: size, layout: layout, dpi: dpi)
|
20
|
+
sheet = Args::Sheet.new(custom_colors, { file: 'output.pdf' }).load!(opts, expand_by: size, layout: layout, dpi: dpi)
|
43
21
|
render_pdf(range, sheet)
|
44
22
|
end
|
45
23
|
|
46
|
-
#
|
47
|
-
#
|
48
|
-
# @example
|
49
|
-
# save range: 1..8, dir: '_pnp', prefix: 'bw_'
|
50
|
-
#
|
51
|
-
# Options support Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}
|
52
|
-
#
|
53
|
-
# @option opts [Enumerable] range (:all) the range of cards over which this will be rendered. See {file:README.md#Specifying_Ranges Specifying Ranges}
|
54
|
-
# @option opts [String] dir (_output) the directory for the output to be sent to. Will be created if it doesn't exist.
|
55
|
-
# @option opts [String] prefix (card_) the prefix of the file name to be printed.
|
56
|
-
# @option opts [String] count_format (%02d) the format string used for formatting the card count (e.g. padding zeros). Uses a Ruby format string (see the Ruby doc for Kernel::sprintf for specifics)
|
57
|
-
# @option opts [Boolean, :clockwise, :counterclockwise] rotate (false) if true, the saved cards will be rotated 90 degrees clockwise. Or, rotate by the number of radians. Intended to rendering landscape instead of portrait.
|
58
|
-
# @option opts trim [Integer] (0) the space around the edge of each card to trim (e.g. to cut off the bleed margin for print-and-play). Supports unit conversion.
|
59
|
-
# @option opts trim_radius [Integer] (38) the rounded rectangle radius around the card to trim before putting into the showcase
|
60
|
-
# @return [nil] Returns nothing
|
61
|
-
# @api public
|
24
|
+
# DSL method. See http://squib.readthedocs.org
|
62
25
|
def save_png(opts = {})
|
63
26
|
range = Args::CardRange.new(opts[:range], deck_size: size)
|
64
27
|
batch = Args::SaveBatch.new.load!(opts, expand_by: size, layout: layout, dpi: dpi)
|
@@ -70,80 +33,27 @@ module Squib
|
|
70
33
|
end
|
71
34
|
end
|
72
35
|
|
73
|
-
#
|
74
|
-
#
|
75
|
-
# @example
|
76
|
-
# save_sheet prefix: 'sheet_', margin: 75, gap: 5, trim: 37
|
77
|
-
#
|
78
|
-
# @option opts [Enumerable] range (:all) the range of cards over which this will be rendered. See {file:README.md#Specifying_Ranges Specifying Ranges}
|
79
|
-
# @option opts columns [Integer] (5) the number of columns in the grid. Must be an integer
|
80
|
-
# @option opts rows [Integer] (:infinite) the number of rows in the grid. When set to :infinite, the sheet scales to the rows needed. If there are more cards than rows*columns, new sheets are started.
|
81
|
-
# @option opts [String] prefix (card_) the prefix of the file name(s)
|
82
|
-
# @option opts [String] count_format (%02d) the format string used for formatting the card count (e.g. padding zeros). Uses a Ruby format string (see the Ruby doc for Kernel::sprintf for specifics)
|
83
|
-
# @option opts dir [String] (_output) the directory to save to. Created if it doesn't exist.
|
84
|
-
# @option opts margin [Integer] (0) the margin around the outside of the sheet.
|
85
|
-
# @option opts gap [Integer] (0) the space in pixels between the cards
|
86
|
-
# @option opts trim [Integer] (0) the space around the edge of each card to trim (e.g. to cut off the bleed margin for print-and-play)
|
87
|
-
# @return [nil]
|
88
|
-
# @api public
|
36
|
+
# DSL method. See http://squib.readthedocs.org
|
89
37
|
def save_sheet(opts = {})
|
90
38
|
range = Args::CardRange.new(opts[:range], deck_size: size)
|
91
39
|
batch = Args::SaveBatch.new.load!(opts, expand_by: size, layout: layout, dpi: dpi)
|
92
|
-
sheet = Args::Sheet.new(custom_colors, {margin: 0}, size).load!(opts, expand_by: size, layout: layout, dpi: dpi)
|
40
|
+
sheet = Args::Sheet.new(custom_colors, { margin: 0 }, size).load!(opts, expand_by: size, layout: layout, dpi: dpi)
|
93
41
|
render_sheet(range, batch, sheet)
|
94
42
|
end
|
95
43
|
|
96
|
-
#
|
97
|
-
# See {file:samples/showcase.rb} for full example
|
98
|
-
#
|
99
|
-
# @example
|
100
|
-
# showcase file: 'showcase_output.png', trim: 78, trim_radius: 32
|
101
|
-
#
|
102
|
-
# @option opts [Enumerable, :all] range (:all) the range of cards over which this will be rendered. See {file:README.md#Specifying_Ranges Specifying Ranges}
|
103
|
-
# @option opts [Fixnum] trim (0) the margin around the card to trim before putting into the showcase
|
104
|
-
# @option opts [Fixnum] trim_radius (38) the rounded rectangle radius around the card to trim before putting into the showcase
|
105
|
-
# @option opts [Fixnum] margin (75) the margin around the entire showcase
|
106
|
-
# @option opts [Fixnum] scale (0.8) percentage of original width of each (trimmed) card to scale to. Must be between 0.0 and 1.0, but starts looking bad around 0.6.
|
107
|
-
# @option opts [Fixnum] offset (1.1) percentage of the scaled width of each card to shift each offset. e.g. 1.1 is a 10% shift, and 0.95 is overlapping by 5%
|
108
|
-
# @option opts [String, Color] fill_color (:white) backdrop color. Usually black or white. Supports gradients.
|
109
|
-
# @option opts [Fixnum] reflect_offset (15) the number of pixels between the bottom of the card and the reflection. Supports Unit Conversion, see {file:README.md#Units Units}.
|
110
|
-
# @option opts [Fixnum] reflect_strength (0.2) the starting alpha transparency of the reflection (at the top of the card). Percentage between 0 and 1. Looks more realistic at low values since even shiny surfaces lose a lot of light.
|
111
|
-
# @option opts [Fixnum] reflect_percent (0.25) the length of the reflection in percentage of the card. Larger values tend to make the reflection draw just as much attention as the card, which is not good.
|
112
|
-
# @option opts [:left, :right] face (:left) which direction the cards face. Anything but `:right` will face left
|
113
|
-
# @option opts [String] dir (_output) the directory for the output to be sent to. Will be created if it doesn't exist.
|
114
|
-
# @option opts [String] file ('showcase.png') the file to save in dir. Will be overwritten.
|
115
|
-
# @return [nil] Returns nothing.
|
116
|
-
# @api public
|
44
|
+
# DSL method. See http://squib.readthedocs.org
|
117
45
|
def showcase(opts = {})
|
118
46
|
range = Args::CardRange.new(opts[:range], deck_size: size)
|
119
47
|
showcase = Args::ShowcaseSpecial.new.load!(opts, expand_by: size, layout: layout, dpi: dpi)
|
120
|
-
sheet = Args::Sheet.new(custom_colors, {file: 'showcase.png'}).load!(opts, expand_by: size, layout: layout, dpi: dpi)
|
48
|
+
sheet = Args::Sheet.new(custom_colors, { file: 'showcase.png' }).load!(opts, expand_by: size, layout: layout, dpi: dpi)
|
121
49
|
render_showcase(range, sheet, showcase)
|
122
50
|
end
|
123
51
|
|
124
|
-
#
|
125
|
-
# See {file:samples/hand.rb} for full example
|
126
|
-
#
|
127
|
-
# @example
|
128
|
-
# hand range: :all, radius: :auto, margin: 20, fill_color: :white,
|
129
|
-
# angle_range: (Math::PI / -4.0)..(Math::PI / 2),
|
130
|
-
# dir: '_output', file: 'hand1.png'
|
131
|
-
#
|
132
|
-
# @option opts [Enumerable, :all] range (:all) the range of cards over which this will be rendered. See {file:README.md#Specifying_Ranges Specifying Ranges}
|
133
|
-
# @option opts [Fixnum] radius (:auto) the distance from the bottom of each card to the center of the fan. If set to `:auto`, then it is computed as 30% of the card's height.
|
134
|
-
# @option opts [Range] angle_range: ((Math::PI / -4.0)..(Math::PI / 2)). The overall width of the fan, in radians. Angle of zero is a vertical card. Further negative angles widen the fan counter-clockwise and positive angles widen the fan clockwise.
|
135
|
-
# @option opts [Fixnum] trim (0) the margin around the card to trim before putting into the image
|
136
|
-
# @option opts [Fixnum] trim_radius (0) the rounded rectangle radius around the card to trim before putting into the showcase
|
137
|
-
# @option opts [Fixnum] margin (75) the margin around the entire image
|
138
|
-
# @option opts [String, Color] fill_color (:white) backdrop color. Usually black or white. Supports gradients.
|
139
|
-
# @option opts [String] dir (_output) the directory for the output to be sent to. Will be created if it doesn't exist.
|
140
|
-
# @option opts [String] file ('hand.png') the file to save in dir. Will be overwritten.
|
141
|
-
# @return [nil] Returns nothing.
|
142
|
-
# @api public
|
52
|
+
# DSL method. See http://squib.readthedocs.org
|
143
53
|
def hand(opts = {})
|
144
54
|
range = Args::CardRange.new(opts[:range], deck_size: size)
|
145
55
|
hand = Args::HandSpecial.new(height).load!(opts, expand_by: size, layout: layout, dpi: dpi)
|
146
|
-
sheet = Args::Sheet.new(custom_colors, {file: 'hand.png', trim_radius: 0}).load!(opts, expand_by: size, layout: layout, dpi: dpi)
|
56
|
+
sheet = Args::Sheet.new(custom_colors, { file: 'hand.png', trim_radius: 0 }).load!(opts, expand_by: size, layout: layout, dpi: dpi)
|
147
57
|
render_hand(range, sheet, hand)
|
148
58
|
end
|
149
59
|
|
data/lib/squib/api/settings.rb
CHANGED
@@ -1,34 +1,20 @@
|
|
1
1
|
module Squib
|
2
2
|
class Deck
|
3
3
|
|
4
|
-
#
|
5
|
-
#
|
6
|
-
# Text hints are rectangles around where the text will be laid out. They are intended to be temporary.
|
7
|
-
# Setting a hint to nil or to :off will disable hints. @see samples/text.rb
|
8
|
-
# @example
|
9
|
-
# hint text: :cyan
|
10
|
-
# hint text: :cyan
|
11
|
-
#
|
12
|
-
# @param [String] text the color of the text hint. To turn off use :off. @see README.md
|
13
|
-
# @return [nil] Returns nothing
|
14
|
-
# @api public
|
4
|
+
# DSL method. See http://squib.readthedocs.org
|
15
5
|
def hint(text: :off)
|
16
6
|
conf.text_hint = text
|
17
7
|
end
|
18
8
|
|
19
|
-
#
|
20
|
-
# @example
|
21
|
-
# set font: 'Arial 26'
|
22
|
-
# text 'blah' # in Arial 26
|
23
|
-
# text 'blah24', font: 'Arial 24' # in Arial 24
|
24
|
-
# set font: :default # Back to Squib-wide default
|
25
|
-
#
|
26
|
-
# @option opts font: the font string to set as default. Can also be set to `:default` to use the Squib-wide default.
|
27
|
-
# @return [nil] Returns nothing
|
28
|
-
# @api public
|
9
|
+
# DSL method. See http://squib.readthedocs.org
|
29
10
|
def set(opts = {})
|
30
11
|
raise 'DEPRECATED: As of v0.7 img_dir is no longer supported in "set". Use config.yml instead.' if opts.key? :img_dir
|
31
|
-
@font = (opts[:font] == :default) ? Squib::DEFAULT_FONT: opts[:font]
|
12
|
+
@font = (opts[:font] == :default) ? Squib::DEFAULT_FONT : opts[:font]
|
13
|
+
end
|
14
|
+
|
15
|
+
# DSL method. See http://squib.readthedocs.org
|
16
|
+
def use_layout(file: 'layout.yml')
|
17
|
+
@layout = LayoutParser.load_layout(file, @layout)
|
32
18
|
end
|
33
19
|
|
34
20
|
end
|
data/lib/squib/api/shapes.rb
CHANGED
@@ -1,36 +1,13 @@
|
|
1
|
-
|
2
|
-
|
3
|
-
|
4
|
-
|
5
|
-
|
1
|
+
require_relative '../args/box'
|
2
|
+
require_relative '../args/draw'
|
3
|
+
require_relative '../args/card_range'
|
4
|
+
require_relative '../args/transform'
|
5
|
+
require_relative '../args/coords'
|
6
6
|
|
7
7
|
module Squib
|
8
8
|
class Deck
|
9
9
|
|
10
|
-
#
|
11
|
-
#
|
12
|
-
# @example
|
13
|
-
# rect x: 0, y: 0, width: 825, height: 1125, radius: 25
|
14
|
-
#
|
15
|
-
# Options support Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}
|
16
|
-
#
|
17
|
-
# @option opts range [Enumerable, :all] (:all) the range of cards over which this will be rendered. See {file:README.md#Specifying_Ranges Specifying Ranges}
|
18
|
-
# @option opts x [Integer] (0) the x-coordinate to place. Supports Unit Conversion, see {file:README.md#Units Units}.
|
19
|
-
# @option opts y [Integer] (0) the y-coordinate to place. Supports Unit Conversion, see {file:README.md#Units Units}.
|
20
|
-
# @option opts width [Integer] the width of the rectangle. Supports Unit Conversion, see {file:README.md#Units Units}.
|
21
|
-
# @option opts height [Integer] the height of the rectangle. Supports Unit Conversion, see {file:README.md#Units Units}.
|
22
|
-
# @option opts x_radius [Integer] (0) the radius of the rounded corner horiztonally. Zero is a non-rounded corner. Supports Unit Conversion, see {file:README.md#Units Units}.
|
23
|
-
# @option opts y_radius [Integer] (0) the radius of the rounded corner vertically. Zero is a non-rounded corner. Supports Unit Conversion, see {file:README.md#Units Units}.
|
24
|
-
# @option opts radius [Integer] (nil) when set, overrides both x_radius and y_radius. Supports Unit Conversion, see {file:README.md#Units Units}.
|
25
|
-
# @option opts fill_color [String] ('#0000') the color with which to fill the rectangle. See {file:README.md#Specifying_Colors___Gradients Specifying Colors & Gradients}
|
26
|
-
# @option opts stroke_color [String] (:black) the color with which to stroke the outside of the rectangle. {file:README.md#Specifying_Colors___Gradients Specifying Colors & Gradients}
|
27
|
-
# @option opts stroke_width [Decimal] (2.0) the width of the outside stroke. Supports Unit Conversion, see {file:README.md#Units Units}.
|
28
|
-
# @option opts stroke_strategy [:fill_first, :stroke_first] (:fill_first) specify whether the stroke is done before (thinner) or after (thicker) filling the shape.
|
29
|
-
# @option opts join [String] ('miter') how corners will be drawn on stroke. Options are 'miter', 'bevel', or 'round'. Note that this is separate from the x_radius and y_radius of the rounded rectangle. Becomes more obvious with wider strokes.
|
30
|
-
# @option opts dash [String] ('') define a dash pattern for the stroke. Provide a string with space-separated numbers that define the pattern of on-and-off alternating strokes, measured in pixels by defautl. Supports Unit Conversion, see {file:README.md#Units Units} (e.g. `'0.02in 0.02in'`).
|
31
|
-
# @option opts layout [String, Symbol] (nil) entry in the layout to use as defaults for this command. See {file:README.md#Custom_Layouts Custom Layouts}
|
32
|
-
# @return [nil] intended to be void
|
33
|
-
# @api public
|
10
|
+
# DSL method. See http://squib.readthedocs.org
|
34
11
|
def rect(opts = {})
|
35
12
|
range = Args::CardRange.new(opts[:range], deck_size: size)
|
36
13
|
box = Args::Box.new(self).load!(opts, expand_by: size, layout: layout, dpi: dpi)
|
@@ -38,25 +15,7 @@ module Squib
|
|
38
15
|
range.each { |i| @cards[i].rect(box[i], draw[i]) }
|
39
16
|
end
|
40
17
|
|
41
|
-
#
|
42
|
-
#
|
43
|
-
# @example
|
44
|
-
# circle x: 0, y: 0, radius: 100
|
45
|
-
#
|
46
|
-
# Options support Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}
|
47
|
-
#
|
48
|
-
# @option opts range [Enumerable, :all] (:all) the range of cards over which this will be rendered. See {file:README.md#Specifying_Ranges Specifying Ranges}
|
49
|
-
# @option opts x [Integer] (0) the x-coordinate to place. Supports Unit Conversion, see {file:README.md#Units Units}.
|
50
|
-
# @option opts y [Integer] (0) the y-coordinate to place. Supports Unit Conversion, see {file:README.md#Units Units}.
|
51
|
-
# @option opts radius [Integer] (100) radius of the circle. Supports Unit Conversion, see {file:README.md#Units Units}.
|
52
|
-
# @option opts fill_color [String] ('#0000') the color with which to fill the rectangle. See {file:README.md#Specifying_Colors___Gradients Specifying Colors & Gradients}.
|
53
|
-
# @option opts stroke_color [String] (:black) the color with which to stroke the outside of the rectangle. See {file:README.md#Specifying_Colors___Gradients Specifying Colors & Gradients}.
|
54
|
-
# @option opts stroke_width [Decimal] (2.0) the width of the outside stroke. Supports Unit Conversion, see {file:README.md#Units Units}.
|
55
|
-
# @option opts stroke_strategy [:fill_first, :stroke_first] (:fill_first) specify whether the stroke is done before (thinner) or after (thicker) filling the shape.
|
56
|
-
# @option opts dash [String] ('') define a dash pattern for the stroke. Provide a string with space-separated numbers that define the pattern of on-and-off alternating strokes, measured in pixels by defautl. Supports Unit Conversion, see {file:README.md#Units Units} (e.g. `'0.02in 0.02in'`).
|
57
|
-
# @option opts layout [String, Symbol] (nil) entry in the layout to use as defaults for this command. See {file:README.md#Custom_Layouts Custom Layouts}
|
58
|
-
# @return [nil] intended to be void
|
59
|
-
# @api public
|
18
|
+
# DSL method. See http://squib.readthedocs.org
|
60
19
|
def circle(opts = {})
|
61
20
|
range = Args::CardRange.new(opts[:range], deck_size: size)
|
62
21
|
coords = Args::Coords.new.load!(opts, expand_by: size, layout: layout, dpi: dpi)
|
@@ -64,51 +23,15 @@ module Squib
|
|
64
23
|
range.each { |i| @cards[i].circle(coords[i], draw[i]) }
|
65
24
|
end
|
66
25
|
|
67
|
-
#
|
68
|
-
#
|
69
|
-
# @example
|
70
|
-
# ellipse x: 0, y: 0, width: 825, height: 1125
|
71
|
-
#
|
72
|
-
# Options support Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}
|
73
|
-
#
|
74
|
-
# @option opts range [Enumerable, :all] (:all) the range of cards over which this will be rendered. See {file:README.md#Specifying_Ranges Specifying Ranges}
|
75
|
-
# @option opts x [Integer] (0) the x-coordinate to place. Supports Unit Conversion, see {file:README.md#Units Units}.
|
76
|
-
# @option opts y [Integer] (0) the y-coordinate to place. Supports Unit Conversion, see {file:README.md#Units Units}.
|
77
|
-
# @option opts width [Integer] (0.25in) the width of the rectangle. Supports Unit Conversion, see {file:README.md#Units Units}.
|
78
|
-
# @option opts height [Integer] (0.25in) the height of the rectangle. Supports Unit Conversion, see {file:README.md#Units Units}.
|
79
|
-
# @option opts fill_color [String] ('#0000') the color with which to fill the rectangle. See {file:README.md#Specifying_Colors___Gradients Specifying Colors & Gradients}
|
80
|
-
# @option opts stroke_color [String] (:black) the color with which to stroke the outside of the rectangle. {file:README.md#Specifying_Colors___Gradients Specifying Colors & Gradients}
|
81
|
-
# @option opts stroke_width [Decimal] (2.0) the width of the outside stroke. Supports Unit Conversion, see {file:README.md#Units Units}.
|
82
|
-
# @option opts stroke_strategy [:fill_first, :stroke_first] (:fill_first) specify whether the stroke is done before (thinner) or after (thicker) filling the shape.
|
83
|
-
# @option opts dash [String] ('') define a dash pattern for the stroke. Provide a string with space-separated numbers that define the pattern of on-and-off alternating strokes, measured in pixels by defautl. Supports Unit Conversion, see {file:README.md#Units Units} (e.g. `'0.02in 0.02in'`).
|
84
|
-
# @option opts layout [String, Symbol] (nil) entry in the layout to use as defaults for this command. See {file:README.md#Custom_Layouts Custom Layouts}
|
85
|
-
# @return [nil] intended to be void
|
86
|
-
# @api public
|
26
|
+
# DSL method. See http://squib.readthedocs.org
|
87
27
|
def ellipse(opts = {})
|
88
28
|
range = Args::CardRange.new(opts[:range], deck_size: size)
|
89
29
|
draw = Args::Draw.new(custom_colors).load!(opts, expand_by: size, layout: layout, dpi: dpi)
|
90
|
-
box = Args::Box.new(self, {width: '0.25in', height: '0.25in'}).load!(opts, expand_by: size, layout: layout, dpi: dpi)
|
30
|
+
box = Args::Box.new(self, { width: '0.25in', height: '0.25in' }).load!(opts, expand_by: size, layout: layout, dpi: dpi)
|
91
31
|
range.each { |i| @cards[i].ellipse(box[i], draw[i]) }
|
92
32
|
end
|
93
33
|
|
94
|
-
#
|
95
|
-
#
|
96
|
-
# @example
|
97
|
-
# grid x: 0, y: 0, width: 15, height: 15
|
98
|
-
#
|
99
|
-
# Options support Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}
|
100
|
-
#
|
101
|
-
# @option opts range [Enumerable, :all] (:all) the range of cards over which this will be rendered. See {file:README.md#Specifying_Ranges Specifying Ranges}
|
102
|
-
# @option opts x [Integer] (0) the x-coordinate to place. Supports Unit Conversion, see {file:README.md#Units Units}.
|
103
|
-
# @option opts y [Integer] (0) the y-coordinate to place. Supports Unit Conversion, see {file:README.md#Units Units}.
|
104
|
-
# @option opts width [Integer] the width of the rectangle. Supports Unit Conversion, see {file:README.md#Units Units}.
|
105
|
-
# @option opts height [Integer] the height of the rectangle. Supports Unit Conversion, see {file:README.md#Units Units}.
|
106
|
-
# @option opts stroke_color [String] (:black) the color with which to stroke the outside of the rectangle. {file:README.md#Specifying_Colors___Gradients Specifying Colors & Gradients}
|
107
|
-
# @option opts stroke_width [Decimal] (2.0) the width of the outside stroke. Supports Unit Conversion, see {file:README.md#Units Units}.
|
108
|
-
# @option opts dash [String] ('') define a dash pattern for the stroke. Provide a string with space-separated numbers that define the pattern of on-and-off alternating strokes, measured in pixels by defautl. Supports Unit Conversion, see {file:README.md#Units Units} (e.g. `'0.02in 0.02in'`).
|
109
|
-
# @option opts layout [String, Symbol] (nil) entry in the layout to use as defaults for this command. See {file:README.md#Custom_Layouts Custom Layouts}
|
110
|
-
# @return [nil] intended to be void
|
111
|
-
# @api public
|
34
|
+
# DSL method. See http://squib.readthedocs.org
|
112
35
|
def grid(opts = {})
|
113
36
|
range = Args::CardRange.new(opts[:range], deck_size: size)
|
114
37
|
draw = Args::Draw.new(custom_colors).load!(opts, expand_by: size, layout: layout, dpi: dpi)
|
@@ -116,28 +39,7 @@ module Squib
|
|
116
39
|
range.each { |i| @cards[i].grid(box[i], draw[i]) }
|
117
40
|
end
|
118
41
|
|
119
|
-
#
|
120
|
-
#
|
121
|
-
# @example
|
122
|
-
# triangle :x1 => 0, :y1 => 0, :x2 => 50, :y2 => 50, :x3 => 0, :y3 => 50
|
123
|
-
#
|
124
|
-
# Options support Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}
|
125
|
-
#
|
126
|
-
# @option opts range [Enumerable, :all] (:all) the range of cards over which this will be rendered. See {file:README.md#Specifying_Ranges Specifying Ranges}
|
127
|
-
# @option opts x1 [Integer] (0) the x-coordinate to place. Supports Unit Conversion, see {file:README.md#Units Units}.
|
128
|
-
# @option opts y1 [Integer] (0) the y-coordinate to place. Supports Unit Conversion, see {file:README.md#Units Units}.
|
129
|
-
# @option opts x2 [Integer] (50) the x-coordinate to place. Supports Unit Conversion, see {file:README.md#Units Units}.
|
130
|
-
# @option opts y2 [Integer] (50) the y-coordinate to place. Supports Unit Conversion, see {file:README.md#Units Units}.
|
131
|
-
# @option opts x3 [Integer] (0) the x-coordinate to place. Supports Unit Conversion, see {file:README.md#Units Units}.
|
132
|
-
# @option opts y3 [Integer] (50) the y-coordinate to place. Supports Unit Conversion, see {file:README.md#Units Units}.
|
133
|
-
# @option opts fill_color [String] ('#0000') the color with which to fill the triangle. See {file:README.md#Specifying_Colors___Gradients Specifying Colors & Gradients}
|
134
|
-
# @option opts stroke_color [String] (:black) the color with which to stroke the outside of the triangle. See {file:README.md#Specifying_Colors___Gradients Specifying Colors & Gradients}
|
135
|
-
# @option opts stroke_width [Decimal] (2.0) the width of the outside stroke. Supports Unit Conversion, see {file:README.md#Units Units}.
|
136
|
-
# @option opts stroke_strategy [:fill_first, :stroke_first] (:fill_first) specify whether the stroke is done before (thinner) or after (thicker) filling the shape.
|
137
|
-
# @option opts dash [String] ('') define a dash pattern for the stroke. Provide a string with space-separated numbers that define the pattern of on-and-off alternating strokes, measured in pixels by defautl. Supports Unit Conversion, see {file:README.md#Units Units} (e.g. `'0.02in 0.02in'`).
|
138
|
-
# @option opts layout [String, Symbol] (nil) entry in the layout to use as defaults for this command. See {file:README.md#Custom_Layouts Custom Layouts}
|
139
|
-
# @return [nil] intended to be void
|
140
|
-
# @api public
|
42
|
+
# DSL method. See http://squib.readthedocs.org
|
141
43
|
def triangle(opts = {})
|
142
44
|
range = Args::CardRange.new(opts[:range], deck_size: size)
|
143
45
|
draw = Args::Draw.new(custom_colors).load!(opts, expand_by: size, layout: layout, dpi: dpi)
|
@@ -145,24 +47,7 @@ module Squib
|
|
145
47
|
range.each { |i| @cards[i].triangle(coords[i], draw[i]) }
|
146
48
|
end
|
147
49
|
|
148
|
-
#
|
149
|
-
#
|
150
|
-
# @example
|
151
|
-
# triangle :x1 => 0, :y1 => 0, :x2 => 50, :y2 => 50
|
152
|
-
#
|
153
|
-
# @option opts range [Enumerable, :all] (:all) the range of cards over which this will be rendered. See {file:README.md#Specifying_Ranges Specifying Ranges}
|
154
|
-
# @option opts x1 [Integer] (0) the x-coordinate to place. Supports Unit Conversion, see {file:README.md#Units Units}.
|
155
|
-
# @option opts y1 [Integer] (0) the y-coordinate to place. Supports Unit Conversion, see {file:README.md#Units Units}.
|
156
|
-
# @option opts x2 [Integer] (50) the x-coordinate to place. Supports Unit Conversion, see {file:README.md#Units Units}.
|
157
|
-
# @option opts y2 [Integer] (50) the y-coordinate to place. Supports Unit Conversion, see {file:README.md#Units Units}.
|
158
|
-
# @option opts stroke_color [String] (:black) the color with which to stroke the line. See {file:README.md#Specifying_Colors___Gradients Specifying Colors & Gradients}.
|
159
|
-
# @option opts stroke_width [Decimal] (2.0) the width of the outside stroke. Supports Unit Conversion, see {file:README.md#Units Units}.
|
160
|
-
# @option opts stroke_strategy [:fill_first, :stroke_first] (:fill_first) specify whether the stroke is done before (thinner) or after (thicker) filling the shape.
|
161
|
-
# @option opts cap [String] ('butt') how the end of the line is drawn. Options are "square", "butt", and "round"
|
162
|
-
# @option opts dash [String] ('') define a dash pattern for the stroke. Provide a string with space-separated numbers that define the pattern of on-and-off alternating strokes, measured in pixels by defautl. Supports Unit Conversion, see {file:README.md#Units Units} (e.g. `'0.02in 0.02in'`).
|
163
|
-
# @option opts layout [String, Symbol] (nil) entry in the layout to use as defaults for this command. See {file:README.md#Custom_Layouts Custom Layouts}
|
164
|
-
# @return [nil] intended to be void
|
165
|
-
# @api public
|
50
|
+
# DSL method. See http://squib.readthedocs.org
|
166
51
|
def line(opts = {})
|
167
52
|
range = Args::CardRange.new(opts[:range], deck_size: size)
|
168
53
|
draw = Args::Draw.new(custom_colors).load!(opts, expand_by: size, layout: layout, dpi: dpi)
|
@@ -170,26 +55,7 @@ module Squib
|
|
170
55
|
range.each { |i| @cards[i].line(coords[i], draw[i]) }
|
171
56
|
end
|
172
57
|
|
173
|
-
#
|
174
|
-
#
|
175
|
-
# @option opts range [Enumerable, :all] (:all) the range of cards over which this will be rendered. See {file:README.md#Specifying_Ranges Specifying Ranges}
|
176
|
-
# @option opts x1 [Integer] (0) the x-coordinate of the first endpoint. Supports Unit Conversion, see {file:README.md#Units Units}.
|
177
|
-
# @option opts y1 [Integer] (0) the y-coordinate of the first endpoint. Supports Unit Conversion, see {file:README.md#Units Units}.
|
178
|
-
# @option opts x2 [Integer] (50) the x-coordinate of the second endpoint. Supports Unit Conversion, see {file:README.md#Units Units}.
|
179
|
-
# @option opts y2 [Integer] (50) the y-coordinate of the second endpoint. Supports Unit Conversion, see {file:README.md#Units Units}.
|
180
|
-
# @option opts cx1 [Integer] (0) the x-coordinate of the first control point. Supports Unit Conversion, see {file:README.md#Units Units}.
|
181
|
-
# @option opts cy1 [Integer] (0) the y-coordinate of the first control point. Supports Unit Conversion, see {file:README.md#Units Units}.
|
182
|
-
# @option opts cx2 [Integer] (50) the x-coordinate of the second control point. Supports Unit Conversion, see {file:README.md#Units Units}.
|
183
|
-
# @option opts cy2 [Integer] (50) the y-coordinate of the second control point. Supports Unit Conversion, see {file:README.md#Units Units}.
|
184
|
-
# @option opts stroke_color [String] (:black) the color with which to stroke the line. See {file:README.md#Specifying_Colors___Gradients Specifying Colors & Gradients}.
|
185
|
-
# @option opts stroke_width [Decimal] (2.0) the width of the outside stroke. Supports Unit Conversion, see {file:README.md#Units Units}.
|
186
|
-
# @option opts stroke_strategy [:fill_first, :stroke_first] (:fill_first) specify whether the stroke is done before (thinner) or after (thicker) filling the shape.
|
187
|
-
# @option opts fill_color [String] ('#0000') the color with which to fill the triangle. See {file:README.md#Specifying_Colors___Gradients Specifying Colors & Gradients}
|
188
|
-
# @option opts cap [String] ('butt') how the end of the line is drawn. Options are "square", "butt", and "round"
|
189
|
-
# @option opts dash [String] ('') define a dash pattern for the stroke. Provide a string with space-separated numbers that define the pattern of on-and-off alternating strokes, measured in pixels by defautl. Supports Unit Conversion, see {file:README.md#Units Units} (e.g. `'0.02in 0.02in'`).
|
190
|
-
# @option opts layout [String, Symbol] (nil) entry in the layout to use as defaults for this command. See {file:README.md#Custom_Layouts Custom Layouts}
|
191
|
-
# @return [nil] intended to be void
|
192
|
-
# @api public
|
58
|
+
# DSL method. See http://squib.readthedocs.org
|
193
59
|
def curve(opts = {})
|
194
60
|
range = Args::CardRange.new(opts[:range], deck_size: size)
|
195
61
|
draw = Args::Draw.new(custom_colors).load!(opts, expand_by: size, layout: layout, dpi: dpi)
|
@@ -197,25 +63,7 @@ module Squib
|
|
197
63
|
range.each { |i| @cards[i].curve(coords[i], draw[i]) }
|
198
64
|
end
|
199
65
|
|
200
|
-
#
|
201
|
-
# @example
|
202
|
-
# star x: 10, y: 10, n: 5, angle: Math::PI / 4, inner_radius: 50, outer_radius: 100,
|
203
|
-
# fill_color: :green, stroke_color: :burgundy, :stroke_width: 3
|
204
|
-
#
|
205
|
-
# @option opts range [Enumerable, :all] (:all) the range of cards over which this will be rendered. See {file:README.md#Specifying_Ranges Specifying Ranges}
|
206
|
-
# @option opts x [Fixnum] (0) the x-coordinate of the center. Supports Unit Conversion, see {file:README.md#Units Units}.
|
207
|
-
# @option opts y [Fixnum] (0) the y-coordinate of the center. Supports Unit Conversion, see {file:README.md#Units Units}.
|
208
|
-
# @option opts n [Integer] (5) the number of points on the star
|
209
|
-
# @option opts angle [Fixnum] (0) the angle at which to rotate
|
210
|
-
# @option opts inner_radius [Fixnum] (0) the inner radius. Supports Unit conversion.
|
211
|
-
# @option opts stroke_color [String] (:black) the color with which to stroke the line. See {file:README.md#Specifying_Colors___Gradients Specifying Colors & Gradients}.
|
212
|
-
# @option opts stroke_width [Decimal] (2.0) the width of the outside stroke. Supports Unit Conversion, see {file:README.md#Units Units}.
|
213
|
-
# @option opts stroke_strategy [:fill_first, :stroke_first] (:fill_first) specify whether the stroke is done before (thinner) or after (thicker) filling the shape.
|
214
|
-
# @option opts fill_color [String] ('#0000') the color with which to fill the triangle. See {file:README.md#Specifying_Colors___Gradients Specifying Colors & Gradients}
|
215
|
-
# @option opts dash [String] ('') define a dash pattern for the stroke. Provide a string with space-separated numbers that define the pattern of on-and-off alternating strokes, measured in pixels by defautl. Supports Unit Conversion, see {file:README.md#Units Units} (e.g. `'0.02in 0.02in'`).
|
216
|
-
# @option opts layout [String, Symbol] (nil) entry in the layout to use as defaults for this command. See {file:README.md#Custom_Layouts Custom Layouts}
|
217
|
-
# @return [nil] intended to be void
|
218
|
-
# @api public
|
66
|
+
# DSL method. See http://squib.readthedocs.org
|
219
67
|
def star(opts = {})
|
220
68
|
range = Args::CardRange.new(opts[:range], deck_size: size)
|
221
69
|
draw = Args::Draw.new(custom_colors).load!(opts, expand_by: size, layout: layout, dpi: dpi)
|
@@ -224,25 +72,7 @@ module Squib
|
|
224
72
|
range.each { |i| @cards[i].star(coords[i], trans[i], draw[i]) }
|
225
73
|
end
|
226
74
|
|
227
|
-
#
|
228
|
-
# @example
|
229
|
-
# polygon x: 10, y: 10, n: 5, angle: Math::PI / 4, radius: 50,
|
230
|
-
# fill_color: :green, stroke_color: :burgundy, :stroke_width: 3
|
231
|
-
#
|
232
|
-
# @option opts range [Enumerable, :all] (:all) the range of cards over which this will be rendered. See {file:README.md#Specifying_Ranges Specifying Ranges}
|
233
|
-
# @option opts x [Fixnum] (0) the x-coordinate of the center. Supports Unit Conversion, see {file:README.md#Units Units}.
|
234
|
-
# @option opts y [Fixnum] (0) the y-coordinate of the center. Supports Unit Conversion, see {file:README.md#Units Units}.
|
235
|
-
# @option opts n [Integer] (5) the number of points on the star
|
236
|
-
# @option opts angle [Fixnum] (0) the angle at which to rotate
|
237
|
-
# @option opts radius [Fixnum] (0) the radius from center to corner. Supports Unit conversion.
|
238
|
-
# @option opts stroke_color [String] (:black) the color with which to stroke the line. See {file:README.md#Specifying_Colors___Gradients Specifying Colors & Gradients}.
|
239
|
-
# @option opts stroke_width [Decimal] (2.0) the width of the outside stroke. Supports Unit Conversion, see {file:README.md#Units Units}.
|
240
|
-
# @option opts stroke_strategy [:fill_first, :stroke_first] (:fill_first) specify whether the stroke is done before (thinner) or after (thicker) filling the shape.
|
241
|
-
# @option opts fill_color [String] ('#0000') the color with which to fill the triangle. See {file:README.md#Specifying_Colors___Gradients Specifying Colors & Gradients}
|
242
|
-
# @option opts dash [String] ('') define a dash pattern for the stroke. Provide a string with space-separated numbers that define the pattern of on-and-off alternating strokes, measured in pixels by defautl. Supports Unit Conversion, see {file:README.md#Units Units} (e.g. `'0.02in 0.02in'`).
|
243
|
-
# @option opts layout [String, Symbol] (nil) entry in the layout to use as defaults for this command. See {file:README.md#Custom_Layouts Custom Layouts}
|
244
|
-
# @return [nil] intended to be void
|
245
|
-
# @api public
|
75
|
+
# DSL method. See http://squib.readthedocs.org
|
246
76
|
def polygon(opts = {})
|
247
77
|
range = Args::CardRange.new(opts[:range], deck_size: size)
|
248
78
|
draw = Args::Draw.new(custom_colors).load!(opts, expand_by: size, layout: layout, dpi: dpi)
|