diff --git a/CHANGELOG.md b/CHANGELOG.md index 58975fa..6cfca2e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,11 @@ # Squib CHANGELOG Squib follows [semantic versioning](http://semver.org). +## v0.10.0 / Unreleased + +Chores: +* Switched to `require_relative` internally throughout the codebase to be more pry-friendly (#130) + ## v0.9.0 / 2016-01-10 Features: diff --git a/lib/squib.rb b/lib/squib.rb index 7b285bf..73dc7d4 100644 --- a/lib/squib.rb +++ b/lib/squib.rb @@ -2,10 +2,10 @@ require 'logger' require 'cairo' require 'pango' require 'rsvg2' -require 'squib/version' -require 'squib/commands/new' -require 'squib/deck' -require 'squib/card' +require_relative 'squib/version' +require_relative 'squib/commands/new' +require_relative 'squib/deck' +require_relative 'squib/card' module Squib diff --git a/lib/squib/api/background.rb b/lib/squib/api/background.rb index b356706..872d70b 100644 --- a/lib/squib/api/background.rb +++ b/lib/squib/api/background.rb @@ -1,3 +1,6 @@ +require_relative '../args/card_range' +require_relative '../args/draw' + module Squib class Deck # Fills the background with the given color diff --git a/lib/squib/api/data.rb b/lib/squib/api/data.rb index 90c40bd..28464f6 100644 --- a/lib/squib/api/data.rb +++ b/lib/squib/api/data.rb @@ -1,7 +1,7 @@ require 'roo' require 'csv' -require 'squib/args/input_file' -require 'squib/args/import' +require_relative '../args/input_file' +require_relative '../args/import' module Squib diff --git a/lib/squib/api/image.rb b/lib/squib/api/image.rb index 018c2ca..2dc4454 100644 --- a/lib/squib/api/image.rb +++ b/lib/squib/api/image.rb @@ -1,9 +1,9 @@ -require 'squib/args/card_range' -require 'squib/args/paint' -require 'squib/args/scale_box' -require 'squib/args/transform' -require 'squib/args/input_file' -require 'squib/args/svg_special' +require_relative '../args/card_range' +require_relative '../args/paint' +require_relative '../args/scale_box' +require_relative '../args/transform' +require_relative '../args/input_file' +require_relative '../args/svg_special' module Squib class Deck diff --git a/lib/squib/api/save.rb b/lib/squib/api/save.rb index fbe14f6..1c3bd4e 100644 --- a/lib/squib/api/save.rb +++ b/lib/squib/api/save.rb @@ -1,8 +1,8 @@ -require 'squib/args/card_range' -require 'squib/args/hand_special' -require 'squib/args/save_batch' -require 'squib/args/sheet' -require 'squib/args/showcase_special' +require_relative '../args/card_range' +require_relative '../args/hand_special' +require_relative '../args/save_batch' +require_relative '../args/sheet' +require_relative '../args/showcase_special' module Squib class Deck diff --git a/lib/squib/api/shapes.rb b/lib/squib/api/shapes.rb index 28125e0..8e6719f 100644 --- a/lib/squib/api/shapes.rb +++ b/lib/squib/api/shapes.rb @@ -1,8 +1,8 @@ -require 'squib/args/box' -require 'squib/args/draw' -require 'squib/args/card_range' -require 'squib/args/transform' -require 'squib/args/coords' +require_relative '../args/box' +require_relative '../args/draw' +require_relative '../args/card_range' +require_relative '../args/transform' +require_relative '../args/coords' module Squib class Deck diff --git a/lib/squib/api/text.rb b/lib/squib/api/text.rb index 7ccba39..31f814b 100644 --- a/lib/squib/api/text.rb +++ b/lib/squib/api/text.rb @@ -1,8 +1,8 @@ -require 'squib/api/text_embed' -require 'squib/args/box' -require 'squib/args/card_range' -require 'squib/args/draw' -require 'squib/args/paragraph' +require_relative 'text_embed' +require_relative '../args/box' +require_relative '../args/card_range' +require_relative '../args/draw' +require_relative '../args/paragraph' module Squib class Deck @@ -43,7 +43,7 @@ module Squib # @option opts angle [FixNum] (0) Rotation of the text in radians. Note that this rotates around the upper-left corner of the text box, making the placement of x-y coordinates slightly tricky. # @option opts stroke_width [Decimal] (0.0) the width of the outside stroke. Supports Unit Conversion, see {file:README.md#Units Units}. # @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} - # @option opts stroke_strategy [:fill_first, :stroke_first] (:fill_first) specify whether the stroke is done before (thinner) or after (thicker) filling the shape. + # @option opts stroke_strategy [:fill_first, :stroke_first] (:fill_first) specify whether the stroke is done before (thinner) or after (thicker) filling the shape. # @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'`). # @option opts hint [String] (:nil) draw a rectangle around the text with the given color. Overrides global hints (see {Deck#hint}). # @return [Array] Returns an Array of hashes keyed by :width and :height that mark the ink extents of the text rendered. diff --git a/lib/squib/api/text_embed.rb b/lib/squib/api/text_embed.rb index bffb2ac..2cc14b2 100644 --- a/lib/squib/api/text_embed.rb +++ b/lib/squib/api/text_embed.rb @@ -1,10 +1,10 @@ -require 'squib/args/box' -require 'squib/args/card_range' -require 'squib/args/embed_adjust' -require 'squib/args/embed_key' -require 'squib/args/input_file' -require 'squib/args/paint' -require 'squib/args/transform' +require_relative '../args/box' +require_relative '../args/card_range' +require_relative '../args/embed_adjust' +require_relative '../args/embed_key' +require_relative '../args/input_file' +require_relative '../args/paint' +require_relative '../args/transform' module Squib class TextEmbed diff --git a/lib/squib/api/units.rb b/lib/squib/api/units.rb index 7e17ae8..8e14a7d 100644 --- a/lib/squib/api/units.rb +++ b/lib/squib/api/units.rb @@ -1,4 +1,4 @@ -require 'squib/constants' +require_relative '../constants' module Squib class Deck diff --git a/lib/squib/args/arg_loader.rb b/lib/squib/args/arg_loader.rb index 480b1d1..f941c82 100644 --- a/lib/squib/args/arg_loader.rb +++ b/lib/squib/args/arg_loader.rb @@ -1,5 +1,5 @@ -require 'squib/constants' -require 'squib/conf' +require_relative '../constants' +require_relative '../conf' require 'ostruct' module Squib diff --git a/lib/squib/args/box.rb b/lib/squib/args/box.rb index e6da0ab..63bb7d2 100644 --- a/lib/squib/args/box.rb +++ b/lib/squib/args/box.rb @@ -1,4 +1,4 @@ -require 'squib/args/arg_loader' +require_relative 'arg_loader' module Squib # @api private @@ -52,4 +52,4 @@ module Squib end end -end \ No newline at end of file +end diff --git a/lib/squib/args/coords.rb b/lib/squib/args/coords.rb index 710af09..001a8c1 100644 --- a/lib/squib/args/coords.rb +++ b/lib/squib/args/coords.rb @@ -1,4 +1,4 @@ -require 'squib/args/arg_loader' +require_relative 'arg_loader' module Squib # @api private @@ -30,4 +30,4 @@ module Squib end end -end \ No newline at end of file +end diff --git a/lib/squib/args/draw.rb b/lib/squib/args/draw.rb index c4dcd49..3e9ae60 100644 --- a/lib/squib/args/draw.rb +++ b/lib/squib/args/draw.rb @@ -1,6 +1,6 @@ require 'cairo' -require 'squib/args/arg_loader' -require 'squib/args/color_validator' +require_relative 'arg_loader' +require_relative 'color_validator' module Squib # @api private diff --git a/lib/squib/args/embed_adjust.rb b/lib/squib/args/embed_adjust.rb index e97ac69..0d1e2c7 100644 --- a/lib/squib/args/embed_adjust.rb +++ b/lib/squib/args/embed_adjust.rb @@ -1,4 +1,4 @@ -require 'squib/args/arg_loader' +require_relative 'arg_loader' module Squib # @api private diff --git a/lib/squib/args/embed_key.rb b/lib/squib/args/embed_key.rb index 347b246..73c052d 100644 --- a/lib/squib/args/embed_key.rb +++ b/lib/squib/args/embed_key.rb @@ -1,4 +1,4 @@ -require 'squib/args/arg_loader' +require_relative 'arg_loader' module Squib # @api private diff --git a/lib/squib/args/import.rb b/lib/squib/args/import.rb index 4a0194d..82e064d 100644 --- a/lib/squib/args/import.rb +++ b/lib/squib/args/import.rb @@ -1,4 +1,4 @@ -require 'squib/args/arg_loader' +require_relative 'arg_loader' module Squib # @api private @@ -37,4 +37,4 @@ module Squib end end -end \ No newline at end of file +end diff --git a/lib/squib/args/input_file.rb b/lib/squib/args/input_file.rb index 9b520aa..eb0d94f 100644 --- a/lib/squib/args/input_file.rb +++ b/lib/squib/args/input_file.rb @@ -1,4 +1,4 @@ -require 'squib/args/arg_loader' +require_relative 'arg_loader' module Squib # @api private diff --git a/lib/squib/args/paint.rb b/lib/squib/args/paint.rb index ce4b26b..c44aa1f 100644 --- a/lib/squib/args/paint.rb +++ b/lib/squib/args/paint.rb @@ -1,6 +1,6 @@ require 'cairo' -require 'squib/args/arg_loader' -require 'squib/args/color_validator' +require_relative 'arg_loader' +require_relative 'color_validator' module Squib # @api private @@ -41,4 +41,4 @@ module Squib end end -end \ No newline at end of file +end diff --git a/lib/squib/args/paragraph.rb b/lib/squib/args/paragraph.rb index 74368e8..2d08142 100644 --- a/lib/squib/args/paragraph.rb +++ b/lib/squib/args/paragraph.rb @@ -1,5 +1,5 @@ -require 'squib/args/arg_loader' -require 'squib/constants' +require_relative '../constants' +require_relative 'arg_loader' module Squib # @api private diff --git a/lib/squib/args/save_batch.rb b/lib/squib/args/save_batch.rb index d0364f6..a4bea2a 100644 --- a/lib/squib/args/save_batch.rb +++ b/lib/squib/args/save_batch.rb @@ -1,5 +1,5 @@ -require 'squib/args/arg_loader' -require 'squib/args/dir_validator' +require_relative 'arg_loader' +require_relative 'dir_validator' module Squib # @api private diff --git a/lib/squib/args/scale_box.rb b/lib/squib/args/scale_box.rb index 0211a2f..46c7d84 100644 --- a/lib/squib/args/scale_box.rb +++ b/lib/squib/args/scale_box.rb @@ -1,4 +1,4 @@ -require 'squib/args/arg_loader' +require_relative 'arg_loader' module Squib # @api private diff --git a/lib/squib/args/sheet.rb b/lib/squib/args/sheet.rb index dc90efc..8dea09f 100644 --- a/lib/squib/args/sheet.rb +++ b/lib/squib/args/sheet.rb @@ -1,7 +1,7 @@ require 'cairo' -require 'squib/args/arg_loader' -require 'squib/args/color_validator' -require 'squib/args/dir_validator' +require_relative 'arg_loader' +require_relative 'color_validator' +require_relative 'dir_validator' module Squib # @api private diff --git a/lib/squib/args/showcase_special.rb b/lib/squib/args/showcase_special.rb index c393758..087f326 100644 --- a/lib/squib/args/showcase_special.rb +++ b/lib/squib/args/showcase_special.rb @@ -1,6 +1,6 @@ require 'cairo' -require 'squib/args/arg_loader' -require 'squib/args/dir_validator' +require_relative 'arg_loader' +require_relative 'dir_validator' module Squib # @api private diff --git a/lib/squib/args/svg_special.rb b/lib/squib/args/svg_special.rb index af33c9b..11801d6 100644 --- a/lib/squib/args/svg_special.rb +++ b/lib/squib/args/svg_special.rb @@ -1,4 +1,4 @@ -require 'squib/args/arg_loader' +require_relative 'arg_loader' module Squib # @api private diff --git a/lib/squib/args/transform.rb b/lib/squib/args/transform.rb index 5d4a069..bb0ca42 100644 --- a/lib/squib/args/transform.rb +++ b/lib/squib/args/transform.rb @@ -1,4 +1,4 @@ -require 'squib/args/arg_loader' +require_relative 'arg_loader' module Squib # @api private @@ -58,4 +58,4 @@ module Squib end end -end \ No newline at end of file +end diff --git a/lib/squib/args/typographer.rb b/lib/squib/args/typographer.rb index 79de92c..c618e26 100644 --- a/lib/squib/args/typographer.rb +++ b/lib/squib/args/typographer.rb @@ -1,4 +1,5 @@ -require 'squib/constants' +require_relative '../constants' + module Squib #@api private module Args @@ -115,4 +116,4 @@ module Squib end end -end \ No newline at end of file +end diff --git a/lib/squib/args/unit_conversion.rb b/lib/squib/args/unit_conversion.rb index db4c3d7..cee5af8 100644 --- a/lib/squib/args/unit_conversion.rb +++ b/lib/squib/args/unit_conversion.rb @@ -1,4 +1,4 @@ -require 'squib/constants' +require_relative '../constants' module Squib module Args @@ -22,4 +22,4 @@ module Squib end end -end \ No newline at end of file +end diff --git a/lib/squib/card.rb b/lib/squib/card.rb index 1f37206..5fa112b 100644 --- a/lib/squib/card.rb +++ b/lib/squib/card.rb @@ -1,5 +1,5 @@ require 'cairo' -require 'squib/graphics/cairo_context_wrapper' +require_relative 'graphics/cairo_context_wrapper' module Squib # Back end graphics. Private. @@ -54,13 +54,13 @@ module Squib ######################## ### BACKEND GRAPHICS ### ######################## - require 'squib/graphics/background' - require 'squib/graphics/image' - require 'squib/graphics/save_doc' - require 'squib/graphics/save_images' - require 'squib/graphics/shapes' - require 'squib/graphics/showcase' - require 'squib/graphics/text' + require_relative 'graphics/background' + require_relative 'graphics/image' + require_relative 'graphics/save_doc' + require_relative 'graphics/save_images' + require_relative 'graphics/shapes' + require_relative 'graphics/showcase' + require_relative 'graphics/text' end end diff --git a/lib/squib/conf.rb b/lib/squib/conf.rb index c6a80b1..f7c2eb1 100644 --- a/lib/squib/conf.rb +++ b/lib/squib/conf.rb @@ -1,7 +1,6 @@ require 'forwardable' -require 'squib' -require 'squib/args/typographer' require 'yaml' +require_relative 'args/typographer' module Squib # @api private diff --git a/lib/squib/deck.rb b/lib/squib/deck.rb index c88908c..2f83528 100644 --- a/lib/squib/deck.rb +++ b/lib/squib/deck.rb @@ -1,14 +1,14 @@ require 'forwardable' require 'pp' -require 'squib' -require 'squib/args/unit_conversion' -require 'squib/card' -require 'squib/conf' -require 'squib/constants' -require 'squib/graphics/hand' -require 'squib/graphics/showcase' -require 'squib/layout_parser' -require 'squib/progress' +require_relative '../squib' +require_relative 'args/unit_conversion' +require_relative 'card' +require_relative 'conf' +require_relative 'constants' +require_relative 'graphics/hand' +require_relative 'graphics/showcase' +require_relative 'layout_parser' +require_relative 'progress' # The project module @@ -100,14 +100,14 @@ module Squib ################## ### PUBLIC API ### ################## - require 'squib/api/background' - require 'squib/api/data' - require 'squib/api/image' - require 'squib/api/save' - require 'squib/api/settings' - require 'squib/api/shapes' - require 'squib/api/text' - require 'squib/api/units' + require_relative 'api/background' + require_relative 'api/data' + require_relative 'api/image' + require_relative 'api/save' + require_relative 'api/settings' + require_relative 'api/shapes' + require_relative 'api/text' + require_relative 'api/units' end end diff --git a/lib/squib/graphics/cairo_context_wrapper.rb b/lib/squib/graphics/cairo_context_wrapper.rb index 590a3f1..47c91c1 100644 --- a/lib/squib/graphics/cairo_context_wrapper.rb +++ b/lib/squib/graphics/cairo_context_wrapper.rb @@ -1,5 +1,5 @@ require 'forwardable' -require 'squib/graphics/gradient_regex' +require_relative 'gradient_regex' module Squib module Graphics diff --git a/lib/squib/graphics/hand.rb b/lib/squib/graphics/hand.rb index 3fe9ca2..9dda24e 100644 --- a/lib/squib/graphics/hand.rb +++ b/lib/squib/graphics/hand.rb @@ -1,4 +1,4 @@ -require 'squib/graphics/cairo_context_wrapper' +require_relative 'cairo_context_wrapper' module Squib class Deck diff --git a/lib/squib/graphics/showcase.rb b/lib/squib/graphics/showcase.rb index c7b04b6..facc5d1 100644 --- a/lib/squib/graphics/showcase.rb +++ b/lib/squib/graphics/showcase.rb @@ -1,4 +1,4 @@ -require 'squib/graphics/cairo_context_wrapper' +require_relative 'cairo_context_wrapper' module Squib class Deck diff --git a/lib/squib/graphics/text.rb b/lib/squib/graphics/text.rb index 639b1a8..b2fa614 100644 --- a/lib/squib/graphics/text.rb +++ b/lib/squib/graphics/text.rb @@ -1,5 +1,5 @@ require 'pango' -require 'squib/args/typographer' +require_relative '../args/typographer' module Squib class Card