squib 0.15.1 → 0.16.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (200) hide show
  1. checksums.yaml +4 -4
  2. data/.github/workflows/tests.yml +22 -0
  3. data/.gitignore +41 -41
  4. data/CHANGELOG.md +422 -387
  5. data/CONTRIBUTING.md +40 -40
  6. data/Dockerfile +27 -25
  7. data/Gemfile +2 -2
  8. data/Guardfile +8 -0
  9. data/LICENSE.txt +22 -22
  10. data/README.md +139 -121
  11. data/RELEASE TODO.md +22 -21
  12. data/Rakefile +51 -48
  13. data/bin/squib +4 -4
  14. data/lib/squib.rb +34 -32
  15. data/lib/squib/api/settings.rb +21 -21
  16. data/lib/squib/args/arg_loader.rb +129 -126
  17. data/lib/squib/args/box.rb +59 -55
  18. data/lib/squib/args/card_range.rb +34 -32
  19. data/lib/squib/args/color_validator.rb +7 -12
  20. data/lib/squib/args/coords.rb +49 -35
  21. data/lib/squib/args/csv_opts.rb +22 -25
  22. data/lib/squib/args/dir_validator.rb +11 -16
  23. data/lib/squib/args/draw.rb +93 -92
  24. data/lib/squib/args/embed_adjust.rb +22 -25
  25. data/lib/squib/args/embed_key.rb +12 -17
  26. data/lib/squib/args/hand_special.rb +37 -37
  27. data/lib/squib/args/import.rb +67 -40
  28. data/lib/squib/args/input_file.rb +33 -37
  29. data/lib/squib/args/paint.rb +43 -44
  30. data/lib/squib/args/paragraph.rb +118 -116
  31. data/lib/squib/args/save_batch.rb +65 -63
  32. data/lib/squib/args/scale_box.rb +57 -53
  33. data/lib/squib/args/sheet.rb +170 -172
  34. data/lib/squib/args/showcase_special.rb +41 -41
  35. data/lib/squib/args/sprue_file.rb +44 -44
  36. data/lib/squib/args/svg_special.rb +37 -37
  37. data/lib/squib/args/transform.rb +55 -61
  38. data/lib/squib/args/typographer.rb +115 -119
  39. data/lib/squib/args/unit_conversion.rb +27 -29
  40. data/lib/squib/args/xywh_shorthands.rb +51 -0
  41. data/lib/squib/builtin/layouts/economy.yml +85 -85
  42. data/lib/squib/builtin/layouts/fantasy.yml +101 -101
  43. data/lib/squib/builtin/layouts/hand.yml +62 -62
  44. data/lib/squib/builtin/layouts/party.yml +94 -94
  45. data/lib/squib/builtin/layouts/playing-card.yml +35 -35
  46. data/lib/squib/builtin/layouts/tuck_box.yml +46 -46
  47. data/lib/squib/builtin/projects/advanced/.gitignore +4 -4
  48. data/lib/squib/builtin/projects/advanced/ABOUT.md +19 -19
  49. data/lib/squib/builtin/projects/advanced/Gemfile +11 -11
  50. data/lib/squib/builtin/projects/advanced/Guardfile +21 -21
  51. data/lib/squib/builtin/projects/advanced/IDEAS.md +22 -22
  52. data/lib/squib/builtin/projects/advanced/PLAYTESTING.md +26 -26
  53. data/lib/squib/builtin/projects/advanced/Rakefile +27 -27
  54. data/lib/squib/builtin/projects/advanced/config.yml +50 -49
  55. data/lib/squib/builtin/projects/advanced/docs/PNP NOTES.md +3 -3
  56. data/lib/squib/builtin/projects/advanced/docs/RULES.md +21 -21
  57. data/lib/squib/builtin/projects/advanced/img/example.svg +60 -60
  58. data/lib/squib/builtin/projects/advanced/layouts/deck.yml +27 -27
  59. data/lib/squib/builtin/projects/advanced/src/deck.rb +34 -34
  60. data/lib/squib/builtin/projects/advanced/src/version.rb +3 -3
  61. data/lib/squib/builtin/projects/basic/.gitignore +4 -4
  62. data/lib/squib/builtin/projects/basic/ABOUT.md +19 -19
  63. data/lib/squib/builtin/projects/basic/Gemfile +3 -3
  64. data/lib/squib/builtin/projects/basic/IDEAS.md +22 -22
  65. data/lib/squib/builtin/projects/basic/PLAYTESTING.md +26 -26
  66. data/lib/squib/builtin/projects/basic/PNP NOTES.md +3 -3
  67. data/lib/squib/builtin/projects/basic/RULES.md +21 -21
  68. data/lib/squib/builtin/projects/basic/Rakefile +7 -7
  69. data/lib/squib/builtin/projects/basic/config.yml +50 -49
  70. data/lib/squib/builtin/projects/basic/deck.rb +6 -6
  71. data/lib/squib/builtin/sprues/a4_euro_card.yml +42 -42
  72. data/lib/squib/builtin/sprues/a4_poker_card_8up.yml +40 -40
  73. data/lib/squib/builtin/sprues/a4_poker_card_9up.yml +42 -42
  74. data/lib/squib/builtin/sprues/a4_usa_card.yml +42 -42
  75. data/lib/squib/builtin/sprues/drivethrucards_1up.yml +10 -10
  76. data/lib/squib/builtin/sprues/letter_poker_card_9up.yml +25 -25
  77. data/lib/squib/builtin/sprues/letter_poker_foldable_8up.yml +52 -52
  78. data/lib/squib/builtin/sprues/printplaygames_18up.yml +68 -68
  79. data/lib/squib/card.rb +75 -75
  80. data/lib/squib/commands/cli.rb +39 -39
  81. data/lib/squib/commands/data/template_option.rb +109 -109
  82. data/lib/squib/commands/make_sprue.rb +277 -277
  83. data/lib/squib/commands/new.rb +77 -77
  84. data/lib/squib/conf.rb +144 -139
  85. data/lib/squib/constants.rb +17 -17
  86. data/lib/squib/deck.rb +138 -116
  87. data/lib/squib/dsl/background.rb +35 -0
  88. data/lib/squib/dsl/circle.rb +39 -0
  89. data/lib/squib/dsl/csv.rb +42 -0
  90. data/lib/squib/dsl/curve.rb +35 -0
  91. data/lib/squib/dsl/cut_zone.rb +47 -0
  92. data/lib/squib/dsl/ellipse.rb +37 -0
  93. data/lib/squib/dsl/grid.rb +35 -0
  94. data/lib/squib/{api → dsl}/groups.rb +54 -54
  95. data/lib/squib/dsl/hand.rb +42 -0
  96. data/lib/squib/dsl/line.rb +35 -0
  97. data/lib/squib/dsl/png.rb +56 -0
  98. data/lib/squib/dsl/polygon.rb +36 -0
  99. data/lib/squib/dsl/rect.rb +37 -0
  100. data/lib/squib/dsl/safe_zone.rb +48 -0
  101. data/lib/squib/dsl/save.rb +21 -0
  102. data/lib/squib/dsl/save_pdf.rb +50 -0
  103. data/lib/squib/dsl/save_png.rb +44 -0
  104. data/lib/squib/dsl/save_sheet.rb +53 -0
  105. data/lib/squib/dsl/showcase.rb +43 -0
  106. data/lib/squib/dsl/star.rb +37 -0
  107. data/lib/squib/dsl/svg.rb +62 -0
  108. data/lib/squib/dsl/text.rb +54 -0
  109. data/lib/squib/dsl/text_embed.rb +78 -0
  110. data/lib/squib/dsl/triangle.rb +35 -0
  111. data/lib/squib/{api → dsl}/units.rb +37 -27
  112. data/lib/squib/dsl/xlsx.rb +40 -0
  113. data/lib/squib/dsl/yaml.rb +40 -0
  114. data/lib/squib/errors_warnings/warn_unexpected_params.rb +14 -0
  115. data/lib/squib/graphics/background.rb +14 -14
  116. data/lib/squib/graphics/cairo_context_wrapper.rb +113 -113
  117. data/lib/squib/graphics/embedding_utils.rb +28 -28
  118. data/lib/squib/graphics/gradient_regex.rb +47 -47
  119. data/lib/squib/graphics/hand.rb +42 -42
  120. data/lib/squib/graphics/image.rb +123 -123
  121. data/lib/squib/graphics/save_doc.rb +61 -61
  122. data/lib/squib/graphics/save_images.rb +52 -52
  123. data/lib/squib/graphics/save_pdf.rb +90 -90
  124. data/lib/squib/graphics/save_sprue.rb +231 -219
  125. data/lib/squib/graphics/shapes.rb +143 -143
  126. data/lib/squib/graphics/showcase.rb +85 -85
  127. data/lib/squib/graphics/text.rb +202 -174
  128. data/lib/squib/import/csv_importer.rb +45 -0
  129. data/lib/squib/import/data_frame.rb +108 -108
  130. data/lib/squib/import/quantity_exploder.rb +18 -0
  131. data/lib/squib/import/xlsx_importer.rb +28 -0
  132. data/lib/squib/import/yaml_importer.rb +30 -0
  133. data/lib/squib/layout_parser.rb +155 -138
  134. data/lib/squib/progress.rb +38 -38
  135. data/lib/squib/sample_helpers.rb +34 -34
  136. data/lib/squib/sprues/crop_line.rb +28 -28
  137. data/lib/squib/sprues/crop_line_dash.rb +35 -35
  138. data/lib/squib/sprues/invalid_sprue_definition.rb +9 -9
  139. data/lib/squib/sprues/sprue.rb +208 -206
  140. data/lib/squib/sprues/sprue_schema.rb +50 -50
  141. data/lib/squib/version.rb +11 -10
  142. data/samples/autoscale_font/_autoscale_font.rb +98 -29
  143. data/samples/backend/_backend.rb +26 -26
  144. data/samples/basic.rb +19 -19
  145. data/samples/build_groups/build_groups.rb +36 -36
  146. data/samples/colors/_colors.rb +44 -44
  147. data/samples/colors/_gradients.rb +34 -34
  148. data/samples/colors/_switch_color.rb +33 -33
  149. data/samples/config/config_text_markup.rb +20 -20
  150. data/samples/config/custom_config.rb +18 -18
  151. data/samples/data/_csv.rb +33 -33
  152. data/samples/data/_excel.rb +55 -55
  153. data/samples/data/_yaml.rb +12 -12
  154. data/samples/hello_world.rb +6 -6
  155. data/samples/images/_cairo_access.rb +39 -39
  156. data/samples/images/_images.rb +104 -104
  157. data/samples/images/_more_load_images.rb +102 -102
  158. data/samples/intro/01_hello.rb +8 -8
  159. data/samples/intro/02_options.rb +14 -14
  160. data/samples/intro/03_layout.rb +11 -11
  161. data/samples/intro/04_arrays.rb +15 -15
  162. data/samples/intro/05_excel.rb +14 -14
  163. data/samples/layouts/builtin_layouts.rb +97 -97
  164. data/samples/layouts/layouts.rb +71 -71
  165. data/samples/project/src/characters.rb +8 -8
  166. data/samples/project/src/skills.rb +7 -7
  167. data/samples/proofs/_tgc_proofs.rb +16 -16
  168. data/samples/ranges/_ranges.rb +64 -64
  169. data/samples/saves/_hand.rb +23 -23
  170. data/samples/saves/_portrait_landscape.rb +23 -23
  171. data/samples/saves/_save_filenames.rb +28 -24
  172. data/samples/saves/_save_pdf.rb +29 -29
  173. data/samples/saves/_saves.rb +52 -51
  174. data/samples/saves/_showcase.rb +25 -25
  175. data/samples/shapes/_draw_shapes.rb +60 -60
  176. data/samples/shapes/_proofs.rb +22 -22
  177. data/samples/sprues/_advanced_sprues.rb +25 -25
  178. data/samples/sprues/_builtin_sprues.rb +22 -21
  179. data/samples/sprues/_fold_sheet.rb +30 -27
  180. data/samples/sprues/_hex_tiles.rb +15 -15
  181. data/samples/sprues/_mints.rb +11 -11
  182. data/samples/sprues/_sprue_example.rb +11 -11
  183. data/samples/text/_embed_text.rb +128 -128
  184. data/samples/text/_text.rb +52 -47
  185. data/samples/text/_text_options.rb +103 -102
  186. data/samples/text/bug134.rb +14 -14
  187. data/samples/units/_cells.rb +51 -0
  188. data/samples/units/_shorthands.rb +48 -0
  189. data/samples/units/_units.rb +39 -32
  190. data/squib.gemspec +58 -52
  191. metadata +177 -91
  192. data/.travis.yml +0 -17
  193. data/appveyor.yml +0 -25
  194. data/lib/squib/api/background.rb +0 -15
  195. data/lib/squib/api/data.rb +0 -137
  196. data/lib/squib/api/image.rb +0 -49
  197. data/lib/squib/api/save.rb +0 -83
  198. data/lib/squib/api/shapes.rb +0 -124
  199. data/lib/squib/api/text.rb +0 -25
  200. data/lib/squib/api/text_embed.rb +0 -71
@@ -1,41 +1,41 @@
1
- require 'cairo'
2
- require_relative 'arg_loader'
3
- require_relative 'dir_validator'
4
-
5
- module Squib
6
- # @api private
7
- module Args
8
-
9
- class ShowcaseSpecial
10
- include ArgLoader
11
- include DirValidator
12
-
13
- def self.parameters
14
- {
15
- scale: 0.85,
16
- trim: 0,
17
- trim_radius: 38,
18
- offset: 1.1,
19
- reflect_offset: 15,
20
- reflect_percent: 0.25,
21
- reflect_strength: 0.2,
22
- face: :left,
23
- }
24
- end
25
-
26
- def self.expanding_parameters
27
- [] # none of them
28
- end
29
-
30
- def self.params_with_units
31
- [ :reflect_offset ]
32
- end
33
-
34
- def face_right?
35
- @face.to_s.strip.downcase == 'right'
36
- end
37
-
38
- end
39
-
40
- end
41
- end
1
+ require 'cairo'
2
+ require_relative 'arg_loader'
3
+ require_relative 'dir_validator'
4
+
5
+ module Squib::Args
6
+ module_function def extract_showcase_special(opts, deck)
7
+ ShowcaseSpecial.new.extract! opts, deck
8
+ end
9
+
10
+ class ShowcaseSpecial
11
+ include ArgLoader
12
+ include DirValidator
13
+
14
+ def self.parameters
15
+ {
16
+ scale: 0.85,
17
+ trim: 0,
18
+ trim_radius: 38,
19
+ offset: 1.1,
20
+ reflect_offset: 15,
21
+ reflect_percent: 0.25,
22
+ reflect_strength: 0.2,
23
+ face: :left,
24
+ }
25
+ end
26
+
27
+ def self.expanding_parameters
28
+ [] # none of them
29
+ end
30
+
31
+ def self.params_with_units
32
+ [ :reflect_offset ]
33
+ end
34
+
35
+ def face_right?
36
+ @face.to_s.strip.downcase == 'right'
37
+ end
38
+
39
+ end
40
+
41
+ end
@@ -1,44 +1,44 @@
1
- require_relative 'arg_loader'
2
-
3
- module Squib
4
- # @api private
5
- module Args
6
- class SprueFile
7
- include ArgLoader
8
-
9
- def initialize(dsl_method_default = {})
10
- @dsl_method_default = dsl_method_default
11
- end
12
-
13
- def self.parameters
14
- {
15
- sprue: nil
16
- }
17
- end
18
-
19
- def self.expanding_parameters
20
- []
21
- end
22
-
23
- def self.params_with_units
24
- [] # none of them
25
- end
26
-
27
- def validate_template_file(arg)
28
- return nil if arg.nil?
29
-
30
- thefile = File.exist?(arg) ? arg : builtin(arg)
31
- raise "File #{File.expand_path(arg)} does not exist!" unless
32
- File.exist? thefile
33
-
34
- File.expand_path(thefile)
35
- end
36
-
37
- private
38
-
39
- def builtin(file)
40
- "#{File.dirname(__FILE__)}/../builtin/sprues/#{file}"
41
- end
42
- end
43
- end
44
- end
1
+ require_relative 'arg_loader'
2
+
3
+ module Squib::Args
4
+ module_function def extract_sprue_file(opts, deck, dsl_method_default = {})
5
+ SprueFile.new.extract! opts, deck
6
+ end
7
+ class SprueFile
8
+ include ArgLoader
9
+
10
+ def initialize(dsl_method_default = {})
11
+ @dsl_method_default = dsl_method_default
12
+ end
13
+
14
+ def self.parameters
15
+ {
16
+ sprue: nil
17
+ }
18
+ end
19
+
20
+ def self.expanding_parameters
21
+ []
22
+ end
23
+
24
+ def self.params_with_units
25
+ [] # none of them
26
+ end
27
+
28
+ def validate_template_file(arg)
29
+ return nil if arg.nil?
30
+
31
+ thefile = File.exist?(arg) ? arg : builtin(arg)
32
+ raise "File #{File.expand_path(arg)} does not exist!" unless
33
+ File.exist? thefile
34
+
35
+ File.expand_path(thefile)
36
+ end
37
+
38
+ private
39
+
40
+ def builtin(file)
41
+ "#{File.dirname(__FILE__)}/../builtin/sprues/#{file}"
42
+ end
43
+ end
44
+ end
@@ -1,37 +1,37 @@
1
- require_relative 'arg_loader'
2
-
3
- module Squib
4
- # @api private
5
- module Args
6
-
7
- class SvgSpecial
8
- include ArgLoader
9
-
10
- def self.parameters
11
- { data: nil, id: nil, force_id: false }
12
- end
13
-
14
- def self.expanding_parameters
15
- parameters.keys # all of them
16
- end
17
-
18
- def self.params_with_units
19
- []
20
- end
21
-
22
- def validate_id(arg, _i)
23
- return nil if arg.to_s.empty?
24
- arg = '#' << arg unless arg.start_with? '#'
25
- arg
26
- end
27
-
28
- # Only render if we have an ID specified, or we are forcing an ID
29
- def render?(i)
30
- return false if force_id[i] && id[i].to_s.empty?
31
- return true
32
- end
33
-
34
- end
35
-
36
- end
37
- end
1
+ require_relative 'arg_loader'
2
+
3
+ module Squib::Args
4
+ module_function def extract_svg_special(opts, deck)
5
+ SvgSpecial.new.extract! opts, deck
6
+ end
7
+
8
+ class SvgSpecial
9
+ include ArgLoader
10
+
11
+ def self.parameters
12
+ { data: nil, id: nil, force_id: false }
13
+ end
14
+
15
+ def self.expanding_parameters
16
+ parameters.keys # all of them
17
+ end
18
+
19
+ def self.params_with_units
20
+ []
21
+ end
22
+
23
+ def validate_id(arg, _i)
24
+ return nil if arg.to_s.empty?
25
+ arg = '#' << arg unless arg.start_with? '#'
26
+ arg
27
+ end
28
+
29
+ # Only render if we have an ID specified, or we are forcing an ID
30
+ def render?(i)
31
+ return false if force_id[i] && id[i].to_s.empty?
32
+ return true
33
+ end
34
+
35
+ end
36
+
37
+ end
@@ -1,61 +1,55 @@
1
- require_relative 'arg_loader'
2
-
3
- module Squib
4
- # @api private
5
- module Args
6
-
7
- class Transform
8
- include ArgLoader
9
-
10
- def initialize(deck = nil)
11
- @deck = deck
12
- end
13
-
14
- def self.parameters
15
- { angle: 0,
16
- crop_x: 0,
17
- crop_y: 0,
18
- crop_width: :native,
19
- crop_height: :native,
20
- crop_corner_radius: nil,
21
- crop_corner_x_radius: 0,
22
- crop_corner_y_radius: 0,
23
- flip_vertical: false,
24
- flip_horizontal: false,
25
- }
26
- end
27
-
28
- def self.expanding_parameters
29
- parameters.keys # all of them
30
- end
31
-
32
- def self.params_with_units
33
- parameters.keys - [:flip_vertical, :flip_horizontal]
34
- end
35
-
36
- def validate_crop_width(arg, _i)
37
- return arg if @deck.nil?
38
- return @deck.width if arg == :deck
39
- arg
40
- end
41
-
42
- def validate_crop_height(arg, _i)
43
- return arg if @deck.nil?
44
- return @deck.height if arg == :deck
45
- arg
46
- end
47
-
48
- def validate_crop_corner_x_radius(arg, i)
49
- return crop_corner_radius[i] unless crop_corner_radius[i].nil?
50
- arg
51
- end
52
-
53
- def validate_crop_corner_y_radius(arg, i)
54
- return crop_corner_radius[i] unless crop_corner_radius[i].nil?
55
- arg
56
- end
57
-
58
- end
59
-
60
- end
61
- end
1
+ require_relative 'arg_loader'
2
+
3
+ module Squib::Args
4
+ module_function def extract_transform(opts, deck)
5
+ Transform.new.extract!(opts, deck)
6
+ end
7
+
8
+ class Transform
9
+ include ArgLoader
10
+
11
+ def self.parameters
12
+ { angle: 0,
13
+ crop_x: 0,
14
+ crop_y: 0,
15
+ crop_width: :native,
16
+ crop_height: :native,
17
+ crop_corner_radius: nil,
18
+ crop_corner_x_radius: 0,
19
+ crop_corner_y_radius: 0,
20
+ flip_vertical: false,
21
+ flip_horizontal: false,
22
+ }
23
+ end
24
+
25
+ def self.expanding_parameters
26
+ parameters.keys # all of them
27
+ end
28
+
29
+ def self.params_with_units
30
+ parameters.keys - [:flip_vertical, :flip_horizontal]
31
+ end
32
+
33
+ def validate_crop_width(arg, _i)
34
+ return arg if @deck.nil?
35
+ return @deck.width if arg == :deck
36
+ arg
37
+ end
38
+
39
+ def validate_crop_height(arg, _i)
40
+ return arg if @deck.nil?
41
+ return @deck.height if arg == :deck
42
+ arg
43
+ end
44
+
45
+ def validate_crop_corner_x_radius(arg, i)
46
+ return crop_corner_radius[i] unless crop_corner_radius[i].nil?
47
+ arg
48
+ end
49
+
50
+ def validate_crop_corner_y_radius(arg, i)
51
+ return crop_corner_radius[i] unless crop_corner_radius[i].nil?
52
+ arg
53
+ end
54
+ end
55
+ end
@@ -1,119 +1,115 @@
1
- require_relative '../constants'
2
-
3
- module Squib
4
- # @api private
5
- module Args
6
- # Internal class for handling arguments
7
- # @api private
8
- class Typographer
9
-
10
- def initialize(config = Conf::DEFAULTS)
11
- %w(lsquote ldquote rsquote rdquote smart_quotes
12
- em_dash en_dash ellipsis).each do |var|
13
- instance_variable_set("@#{var}", config[var])
14
- end
15
- end
16
-
17
- def process(str)
18
- str = explicit_replacements(str.to_s)
19
- str = smart_quotes(str) if @smart_quotes
20
- str
21
- end
22
-
23
- def explicit_replacements(str)
24
- [ :left_curly, :right_curly, :apostraphize,
25
- :ellipsificate, :em_dash, :en_dash ].each do |sym|
26
- str = each_non_tag(str) do |token|
27
- self.method(sym).call(token)
28
- end
29
- end
30
- str
31
- end
32
-
33
- def smart_quotes(str)
34
- [ :single_inside_double_quote,
35
- :right_double_quote,
36
- :left_double_quote,
37
- :right_single_quote,
38
- :left_single_quote].each do |sym|
39
- str = each_non_tag(str) do |token|
40
- self.method(sym).call(token)
41
- end
42
- end
43
- str
44
- end
45
-
46
- # Iterate over each non-tag for processing
47
- # Allows us to ignore anything inside < and >
48
- def each_non_tag(str)
49
- full_str = ''
50
- tag_delimit = /(<(?:(?!<).)*>)/ # use non-capturing group w/ negative lookahead
51
- str.split(tag_delimit).each do |token|
52
- if token.start_with? '<'
53
- full_str << token # don't process tags
54
- else
55
- full_str << yield(token)
56
- end
57
- end
58
- return full_str
59
- end
60
-
61
- # Straightforward replace
62
- def left_curly(str)
63
- str.gsub('``', @ldquote)
64
- end
65
-
66
- # Straightforward replace
67
- def right_curly(str)
68
- str.gsub(%{''}, @rdquote)
69
- end
70
-
71
- # A quote between two letters is an apostraphe
72
- def apostraphize(str)
73
- str.gsub(/(\w)(\')(\w)/, '\1' + @rsquote + '\3')
74
- end
75
-
76
- # Straightforward replace
77
- def ellipsificate(str)
78
- str.gsub('...', @ellipsis)
79
- end
80
-
81
- # Straightforward replace
82
- def en_dash(str)
83
- str.gsub('--', @en_dash)
84
- end
85
-
86
- # Straightforward replace
87
- def em_dash(str)
88
- str.gsub('---', @em_dash)
89
- end
90
-
91
- # Quote next to non-whitespace curls
92
- def right_double_quote(str)
93
- str.gsub(/(\S)(\")/, '\1' + @rdquote)
94
- end
95
-
96
- # Quote next to non-whitespace curls
97
- def left_double_quote(str)
98
- str.gsub(/(\")(\S)/, @ldquote + '\2')
99
- end
100
-
101
- # Handle the cases where a double quote is next to a single quote
102
- def single_inside_double_quote(str)
103
- str.gsub(/(\")(\')(\S)/, @ldquote + @lsquote + '\3')
104
- .gsub(/(\")(\')(\S)/, '\1' + @rsquote + @rdquote)
105
- end
106
-
107
- # Quote next to non-whitespace curls
108
- def right_single_quote(str)
109
- str.gsub(/(\S)(\')/, '\1' + @rsquote)
110
- end
111
-
112
- # Quote next to non-whitespace curls
113
- def left_single_quote(str)
114
- str.gsub(/(\')(\S)/, @lsquote + '\2')
115
- end
116
-
117
- end
118
- end
119
- end
1
+ require_relative '../constants'
2
+
3
+ module Squib::Args
4
+ # Internal class for handling arguments
5
+ class Typographer
6
+
7
+ def initialize(config = Squib::Conf::DEFAULTS)
8
+ %w(lsquote ldquote rsquote rdquote smart_quotes
9
+ em_dash en_dash ellipsis).each do |var|
10
+ instance_variable_set("@#{var}", config[var])
11
+ end
12
+ end
13
+
14
+ def process(str)
15
+ str = explicit_replacements(str.to_s)
16
+ str = smart_quotes(str) if @smart_quotes
17
+ str
18
+ end
19
+
20
+ def explicit_replacements(str)
21
+ [ :left_curly, :right_curly, :apostraphize,
22
+ :ellipsificate, :em_dash, :en_dash ].each do |sym|
23
+ str = each_non_tag(str) do |token|
24
+ self.method(sym).call(token)
25
+ end
26
+ end
27
+ str
28
+ end
29
+
30
+ def smart_quotes(str)
31
+ [ :single_inside_double_quote,
32
+ :right_double_quote,
33
+ :left_double_quote,
34
+ :right_single_quote,
35
+ :left_single_quote].each do |sym|
36
+ str = each_non_tag(str) do |token|
37
+ self.method(sym).call(token)
38
+ end
39
+ end
40
+ str
41
+ end
42
+
43
+ # Iterate over each non-tag for processing
44
+ # Allows us to ignore anything inside < and >
45
+ def each_non_tag(str)
46
+ full_str = ''
47
+ tag_delimit = /(<(?:(?!<).)*>)/ # use non-capturing group w/ negative lookahead
48
+ str.split(tag_delimit).each do |token|
49
+ if token.start_with? '<'
50
+ full_str << token # don't process tags
51
+ else
52
+ full_str << yield(token)
53
+ end
54
+ end
55
+ return full_str
56
+ end
57
+
58
+ # Straightforward replace
59
+ def left_curly(str)
60
+ str.gsub('``', @ldquote)
61
+ end
62
+
63
+ # Straightforward replace
64
+ def right_curly(str)
65
+ str.gsub(%{''}, @rdquote)
66
+ end
67
+
68
+ # A quote between two letters is an apostraphe
69
+ def apostraphize(str)
70
+ str.gsub(/(\w)(\')(\w)/, '\1' + @rsquote + '\3')
71
+ end
72
+
73
+ # Straightforward replace
74
+ def ellipsificate(str)
75
+ str.gsub('...', @ellipsis)
76
+ end
77
+
78
+ # Straightforward replace
79
+ def en_dash(str)
80
+ str.gsub('--', @en_dash)
81
+ end
82
+
83
+ # Straightforward replace
84
+ def em_dash(str)
85
+ str.gsub('---', @em_dash)
86
+ end
87
+
88
+ # Quote next to non-whitespace curls
89
+ def right_double_quote(str)
90
+ str.gsub(/(\S)(\")/, '\1' + @rdquote)
91
+ end
92
+
93
+ # Quote next to non-whitespace curls
94
+ def left_double_quote(str)
95
+ str.gsub(/(\")(\S)/, @ldquote + '\2')
96
+ end
97
+
98
+ # Handle the cases where a double quote is next to a single quote
99
+ def single_inside_double_quote(str)
100
+ str.gsub(/(\")(\')(\S)/, @ldquote + @lsquote + '\3')
101
+ .gsub(/(\")(\')(\S)/, '\1' + @rsquote + @rdquote)
102
+ end
103
+
104
+ # Quote next to non-whitespace curls
105
+ def right_single_quote(str)
106
+ str.gsub(/(\S)(\')/, '\1' + @rsquote)
107
+ end
108
+
109
+ # Quote next to non-whitespace curls
110
+ def left_single_quote(str)
111
+ str.gsub(/(\')(\S)/, @lsquote + '\2')
112
+ end
113
+
114
+ end
115
+ end