lib/squib/graphics/save_doc.rb in squib-0.6.0 vs lib/squib/graphics/save_doc.rb in squib-0.7.0

- old
+ new

@@ -1,137 +1,103 @@ -module Squib - class Deck - - # Lays out the cards in range and renders a PDF - # - # @example - # save_pdf file: 'deck.pdf', margin: 75, gap: 5, trim: 37 - # - # @option opts file [String] the name of the PDF file to save. See {file:README.md#Specifying_Files Specifying Files} - # @option opts dir [String] (_output) the directory to save to. Created if it doesn't exist. - # @option opts width [Integer] (3300) the height of the page in pixels. Default is 11in * 300dpi. Supports unit conversion. - # @option opts height [Integer] (2550) the height of the page in pixels. Default is 8.5in * 300dpi. Supports unit conversion. - # @option opts margin [Integer] (75) the margin around the outside of the page. Supports unit conversion. - # @option opts gap [Integer] (0) the space in pixels between the cards. Supports unit conversion. - # @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. - # @return [nil] - # @api public - def save_pdf(opts = {}) - opts = {width: 3300, height: 2550}.merge(opts) - p = needs(opts, [:range, :paper_width, :paper_height, :file_to_save, - :creatable_dir, :margin, :gap, :trim]) - paper_width = p[:width] - paper_height = p[:height] - file = "#{p[:dir]}/#{p[:file]}" - cc = Cairo::Context.new(Cairo::PDFSurface.new(file, paper_width * 72.0 / @dpi, paper_height * 72.0 / @dpi)) - cc.scale(72.0 / @dpi, 72.0 / @dpi) # for bug #62 - x, y = p[:margin], p[:margin] - card_width = @width - 2 * p[:trim] - card_height = @height - 2 * p[:trim] - @progress_bar.start("Saving PDF to #{file}", p[:range].size) do |bar| - p[:range].each do |i| - card = @cards[i] - cc.translate(x,y) - cc.rectangle(p[:trim], p[:trim], card_width, card_height) - cc.clip - case card.backend.downcase.to_sym - when :memory - cc.set_source(card.cairo_surface, 0, 0) - cc.paint - when :svg - card.cairo_surface.finish - cc.save - cc.scale(0.8,0.8) # I really don't know why I needed to do this at all. But 0.8 is the magic number to get this to scale right - cc.render_rsvg_handle(RSVG::Handle.new_from_file(card.svgfile), nil) - cc.restore - else - abort "No such back end supported for save_pdf: #{backend}" - end - bar.increment - cc.reset_clip - cc.translate(-x,-y) - x += card.width + p[:gap] - 2*p[:trim] - if x > (paper_width - card_width - p[:margin]) - x = p[:margin] - y += card.height + p[:gap] - 2*p[:trim] - if y > (paper_height - card_height - p[:margin]) - cc.show_page # next page - x,y = p[:margin],p[:margin] - end - end - end - end - end - - # Lays out the cards in range and renders a stitched PNG sheet - # - # @example - # save_sheet prefix: 'sheet_', margin: 75, gap: 5, trim: 37 - # - # @option opts [Enumerable] range (:all) the range of cards over which this will be rendered. See {file:README.md#Specifying_Ranges Specifying Ranges} - # @option opts colulmns [Integer] (5) the number of columns in the grid - # @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. - # @option opts [String] prefix (card_) the prefix of the file name(s) - # @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) - # @option opts dir [String] (_output) the directory to save to. Created if it doesn't exist. - # @option opts margin [Integer] (0) the margin around the outside of the page. - # @option opts gap [Integer] (0) the space in pixels between the cards - # @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) - # @return [nil] - # @api public - def save_sheet(opts = {}) - opts = {margin: 0}.merge(opts) # overriding the non-system default - p = needs(opts, [:range, :prefix, :count_format, :creatable_dir, :margin, :gap, :trim, :rows, :columns]) - # EXTRACT METHOD HERE - sheet_width = (p[:columns] * (@width + 2 * p[:gap] - 2 * p[:trim])) + (2 * p[:margin]) - sheet_height = (p[:rows] * (@height + 2 * p[:gap] - 2 * p[:trim])) + (2 * p[:margin]) - cc = Cairo::Context.new(Cairo::ImageSurface.new(sheet_width, sheet_height)) - num_this_sheet = 0 - sheet_num = 0 - x, y = p[:margin], p[:margin] - @progress_bar.start("Saving PNG sheet to #{p[:dir]}/#{p[:prefix]}_*", @cards.size + 1) do |bar| - p[:range].each do |i| - if num_this_sheet >= (p[:columns] * p[:rows]) # new sheet - filename = "#{p[:dir]}/#{p[:prefix]}#{p[:count_format] % sheet_num}.png" - cc.target.write_to_png(filename) - new_sheet = false - num_this_sheet = 0 - sheet_num += 1 - x, y = p[:margin], p[:margin] - cc = Cairo::Context.new(Cairo::ImageSurface.new(sheet_width, sheet_height)) - end - surface = trim(@cards[i].cairo_surface, p[:trim], @width, @height) - cc.set_source(surface, x, y) - cc.paint - num_this_sheet += 1 - x += surface.width + p[:gap] - if num_this_sheet % p[:columns] == 0 # new row - x = p[:margin] - y += surface.height + p[:gap] - end - bar.increment - end - cc.target.write_to_png("#{p[:dir]}/#{p[:prefix]}#{p[:count_format] % sheet_num}.png") - end - end - - # Return a new Cairo::ImageSurface that is trimmed from the original - # - # @param surface The surface to trim - # @param trim The number of pixels around the edge to trim - # @param width The width of the surface prior to the trim - # @param height The height of the surface prior to the trim - # :nodoc: - # @api private - def trim(surface, trim, width, height) - if trim > 0 - tmp = Cairo::ImageSurface.new(width-2*trim, height-2*trim) - cc = Cairo::Context.new(tmp) - cc.set_source(surface,-1*trim, -1*trim) - cc.paint - surface = tmp - end - surface - end - - end -end +module Squib + class Deck + + # :nodoc: + # @api private + def render_pdf(range, sheet) + file = "#{sheet.dir}/#{sheet.file}" + cc = Cairo::Context.new(Cairo::PDFSurface.new(file, sheet.width * 72.0 / @dpi, sheet.height * 72.0 / @dpi)) + cc.scale(72.0 / @dpi, 72.0 / @dpi) # for bug #62 + x, y = sheet.margin, sheet.margin + card_width = @width - 2 * sheet.trim + card_height = @height - 2 * sheet.trim + @progress_bar.start("Saving PDF to #{file}", range.size) do |bar| + range.each do |i| + card = @cards[i] + cc.translate(x,y) + cc.rectangle(sheet.trim, sheet.trim, card_width, card_height) + cc.clip + case card.backend.downcase.to_sym + when :memory + cc.set_source(card.cairo_surface, 0, 0) + cc.paint + when :svg + card.cairo_surface.finish + cc.save + cc.scale(0.8,0.8) # I really don't know why I needed to do this at all. But 0.8 is the magic number to get this to scale right + cc.render_rsvg_handle(RSVG::Handle.new_from_file(card.svgfile), nil) + cc.restore + else + abort "No such back end supported for save_pdf: #{backend}" + end + bar.increment + cc.reset_clip + cc.translate(-x,-y) + x += card.width + sheet.gap - 2*sheet.trim + if x > (sheet.width - card_width - sheet.margin) + x = sheet.margin + y += card.height + sheet.gap - 2*sheet.trim + if y > (sheet.height - card_height - sheet.margin) + cc.show_page # next page + x,y = sheet.margin,sheet.margin + end + end + end + end + end + + # :nodoc: + # @api private + def render_sheet(range, batch, sheet) + sheet_width = (sheet.columns * (@width + 2 * sheet.gap - 2 * sheet.trim)) + (2 * sheet.margin) + sheet_height = (sheet.rows * (@height + 2 * sheet.gap - 2 * sheet.trim)) + (2 * sheet.margin) + cc = Cairo::Context.new(Cairo::ImageSurface.new(sheet_width, sheet_height)) + num_this_sheet = 0 + sheet_num = 0 + x, y = sheet.margin, sheet.margin + @progress_bar.start("Saving PNG sheet to #{batch.summary}", @cards.size + 1) do |bar| + range.each do |i| + if num_this_sheet >= (sheet.columns * sheet.rows) # new sheet + filename = batch.full_filename(sheet_num) + cc.target.write_to_png(filename) + new_sheet = false + num_this_sheet = 0 + sheet_num += 1 + x, y = sheet.margin, sheet.margin + cc = Cairo::Context.new(Cairo::ImageSurface.new(sheet_width, sheet_height)) + end + surface = trim(@cards[i].cairo_surface, sheet.trim, @width, @height) + cc.set_source(surface, x, y) + cc.paint + num_this_sheet += 1 + x += surface.width + sheet.gap + if num_this_sheet % sheet.columns == 0 # new row + x = sheet.margin + y += surface.height + sheet.gap + end + bar.increment + end + cc.target.write_to_png(batch.full_filename(sheet_num)) + end + end + + # Return a new Cairo::ImageSurface that is trimmed from the original + # + # @param surface The surface to trim + # @param trim The number of pixels around the edge to trim + # @param width The width of the surface prior to the trim + # @param height The height of the surface prior to the trim + # :nodoc: + # @api private + def trim(surface, trim, width, height) + if trim > 0 + tmp = Cairo::ImageSurface.new(width-2*trim, height-2*trim) + cc = Cairo::Context.new(tmp) + cc.set_source(surface,-1*trim, -1*trim) + cc.paint + surface = tmp + end + surface + end + + end +end