squib 0.13.4 → 0.14.beta1

data/lib/squib/commands/make_sprue.rb

@@ -0,0 +1,275 @@
+require 'fileutils'
+require 'pathname'
+require 'highline'
+require 'bigdecimal'
+require 'yaml'
+require_relative 'data/template_option'
+
+module Squib
+  # Squib's command-line option
+  module Commands
+    # Generate a template definition file that can be used for
+    # +save_templated_sheet+
+    #
+    # @api public
+    class MakeSprue
+      # :nodoc:
+      # @api private
+      def process(args, input = $stdin, output = $stdout)
+        # Get definitions from the user
+        @option = prompt(input, output)
+
+        @printable_edge_right = (
+          @option.sheet_width - @option.sheet_margin.right)
+        @printable_edge_bottom = (
+          @option.sheet_height - @option.sheet_margin.bottom)
+        @card_iter_x = @option.card_width + @option.card_gap.horizontal
+        @card_iter_y = @option.card_height + @option.card_gap.vertical
+
+        # Recalculate the sheet margin if the sheet alignment is in the center
+        if @option.sheet_align == :center
+          @option.sheet_margin = recalculate_center_align_sheet
+        end
+
+        # We would now have to output the file
+        YAML.dump generate_template, File.new(@option.output_file, 'w')
+      end
+
+      private
+
+      # Accept user input that defines the template.
+      def prompt(input, output)
+        option = TemplateOption.new
+        cli = HighLine.new(input, output)
+
+        option.unit = cli.choose do |menu|
+          menu.prompt = 'What measure unit should we use? '
+          menu.choice(:in)
+          menu.choice(:cm)
+          menu.choice(:mm)
+        end
+
+        cli.choose do |menu|
+          menu.prompt = 'What paper size you are using? '
+          menu.choice('A4, portrait') do
+            option.sheet_width = convert_measurement_value(
+              210, :mm, option.unit
+            )
+            option.sheet_height = convert_measurement_value(
+              297, :mm, option.unit
+            )
+          end
+          menu.choice('A4, landscape') do
+            option.sheet_width = convert_measurement_value(
+              297, :mm, option.unit
+            )
+            option.sheet_height = convert_measurement_value(
+              210, :mm, option.unit
+            )
+          end
+          menu.choice('US letter, portrait') do
+            option.sheet_width = convert_measurement_value(
+              8.5, :in, option.unit
+            )
+            option.sheet_height = convert_measurement_value(
+              11, :in, option.unit
+            )
+          end
+          menu.choice('US letter, landscape') do
+            option.sheet_width = convert_measurement_value(
+              11, :in, option.unit
+            )
+            option.sheet_height = convert_measurement_value(
+              8.5, :in, option.unit
+            )
+          end
+          menu.choice('Custom size') do
+            option.sheet_width = cli.ask(
+              "Custom paper width? (#{option.unit}) ", Float
+            )
+            option.sheet_height = cli.ask(
+              "Custom paper height? (#{option.unit}) ", Float
+            )
+          end
+        end
+
+        option.sheet_margin = cli.ask(
+          "Sheet margins? (#{option.unit}) "
+        ) do |q|
+          q.validate = /^((\d+\.\d+|\d+) ){0,3}(\d+\.\d+|\d+)/
+        end
+        option.sheet_align = cli.choose do |menu|
+          menu.prompt = 'How to align cards on sheet? [left] '
+          menu.choice(:left)
+          menu.choice(:right)
+          menu.choice(:center)
+          menu.default = :left
+        end
+
+        option.card_width = cli.ask(
+          "Card width? (#{option.unit}) ", Float
+        ) { |q| q.above = 0 }
+        option.card_height = cli.ask(
+          "Card height? (#{option.unit}) ", Float
+        ) { |q| q.above = 0 }
+        option.card_gap = cli.ask(
+          "Gap between cards? (#{option.unit}) "
+        ) { |q| q.validate = /^((\d+\.\d+|\d+))(\s+(\d+\.\d+|\d+))?/ }
+
+        option.card_ordering = cli.choose do |menu|
+          menu.prompt = 'How to layout your cards? [rows]'
+          menu.choice(:rows, text: 'In rows')
+          menu.choice(:columns, text: 'In columns')
+          menu.default = :rows
+        end
+
+        option.crop_lines = cli.choose do |menu|
+          menu.prompt = 'Generate crop lines? [true]'
+          menu.choice(:true)
+          menu.choice(:false)
+          menu.default = :true
+        end
+
+        option.output_file = cli.ask('Output to? ') do |q|
+          q.validate = lambda do |path_str|
+            path = Pathname.new path_str
+            if path.exist?
+              path.writable? && !path.directory?
+            else
+              path.dirname.writable?
+            end
+          end
+
+          q.responses[:not_valid] = (
+            'The filename specified is not a writable file or is a directory.'
+          )
+          q.default = 'template.yml'
+        end
+
+        option
+      end
+
+      def convert_measurement_value(val, from_unit, to_unit)
+        return val if from_unit == to_unit
+
+        if from_unit == :in
+          val_mm = val * 25.4
+        elsif from_unit == :cm
+          val_mm = val * 10.0
+        end
+
+        if to_unit == :in
+          val_mm / 25.4
+        elsif to_unit == :cm
+          val_mm / 10.0
+        else
+          val_mm
+        end
+      end
+
+      def generate_template
+        x = @option.sheet_margin.left
+        y = @option.sheet_margin.top
+        cards = []
+        horizontal_crop_lines = Set.new
+        vertical_crop_lines = Set.new
+
+        while (
+            x + @card_iter_x < @printable_edge_right &&
+            y + @card_iter_y < @printable_edge_bottom)
+          xpos = x + @option.card_gap.horizontal
+          ypos = y + @option.card_gap.vertical
+          cards.push(
+            'x' => "#{xpos}#{@option.unit}",
+            'y' => "#{ypos}#{@option.unit}"
+          )
+
+          # Append the crop lines
+          vertical_crop_lines.add xpos
+          vertical_crop_lines.add xpos + @option.card_width
+          horizontal_crop_lines.add ypos
+          horizontal_crop_lines.add ypos + @option.card_height
+
+          # Calculate the next iterator
+          if @option.card_ordering == :rows
+            x, y = next_card_pos_row(x, y)
+          elsif @option.card_ordering == :columns
+            x, y = next_card_pos_col(x, y)
+          else
+            raise RunTimeException, 'Invalid card ordering value received'
+          end
+        end
+
+        output = {
+          'sheet_width' => "#{@option.sheet_width}#{@option.unit}",
+          'sheet_height' => "#{@option.sheet_height}#{@option.unit}",
+          'card_width' => "#{@option.card_width}#{@option.unit}",
+          'card_height' => "#{@option.card_height}#{@option.unit}",
+          'cards' => cards
+        }
+
+        if @option.crop_lines == :true
+          lines = []
+          vertical_crop_lines.each do |val|
+            lines.push(
+              'type' => :vertical, 'position' => "#{val}#{@option.unit}"
+            )
+          end
+          horizontal_crop_lines.each do |val|
+            lines.push(
+              'type' => :horizontal, 'position' => "#{val}#{@option.unit}"
+            )
+          end
+          output['crop_line'] = { 'lines' => lines }
+        end
+
+        # Return the output data
+        output
+      end
+
+      def recalculate_center_align_sheet
+        # We will still respect the user specified margins
+        printable_width = (
+          @option.sheet_width - @option.sheet_margin.left -
+          @option.sheet_margin.right)
+        num_of_cols, remainder = printable_width.divmod(@card_iter_x)
+        if (
+            @option.card_gap.horizontal > 0 &&
+            remainder < @option.card_gap.horizontal)
+          num_of_cols -= 1
+        end
+
+        new_hor_margin = (
+          (@option.sheet_width - num_of_cols * @card_iter_x -
+           @option.card_gap.horizontal) / 2)
+        Margin.new [
+          @option.sheet_margin.top,
+          new_hor_margin,
+          @option.sheet_margin.bottom
+        ]
+      end
+
+      def next_card_pos_row(x, y)
+        x += @card_iter_x
+
+        if (x + @card_iter_x) > @printable_edge_right
+          x = @option.sheet_margin.left
+          y += @card_iter_y
+        end
+
+        [x, y]
+      end
+
+      def next_card_pos_col(x, y)
+        y += @card_iter_y
+
+        if (y + @card_iter_y) > @printable_edge_bottom
+          x += @card_iter_x
+          y = @option.sheet_margin.top
+        end
+
+        [x, y]
+      end
+    end
+  end
+end

data/lib/squib/commands/new.rb

@@ -23,20 +23,53 @@ module Squib
 
       # :nodoc:
       # @api private
-      def process(args)
-        raise ArgumentError.new('Please specify a path.') if args.empty?
+      def process(args, advanced)
+        raise empty_path_error if args.empty?
 
         new_project_path = File.expand_path(args.join(' '), Dir.pwd)
-        template_path = File.expand_path('../project_template', File.dirname(__FILE__))
 
         FileUtils.mkdir_p new_project_path
         if !Dir["#{new_project_path}/**/*"].empty?
           $stderr.puts "#{new_project_path} exists and is not empty. Doing nothing and quitting."
         else
           Dir.chdir(new_project_path) do
-            FileUtils.cp_r template_path + '/.', new_project_path
+            FileUtils.cp_r template_path(advanced) + '/.', new_project_path
           end
         end
+        puts "Created basic Squib project in #{new_project_path}."
+        puts advanced_message if advanced
+      end
+
+      def empty_path_error
+        ArgumentError.new('Please specify a path.')
+      end
+
+      def template_path(advanced)
+        path = case advanced
+               when true
+                 '../builtin/projects/advanced'
+               else
+                 '../builtin/projects/basic'
+               end
+        File.expand_path(path, File.dirname(__FILE__))
+      end
+
+      def advanced_message
+        <<-EOS
+
+This is the advanced layout designed for larger games. Everything is
+organized into separate directories and the workflow is all based on
+the Rakefile.
+
+From within this directory, run `bundle install` to install extra
+gems.
+
+After that,  run `rake` to build. Check out the Rakefile for more.
+
+Happy Squibbing! And best of luck with your game.
+  -Andy (@andymeneely)
+
+        EOS
       end
 
     end

data/lib/squib/constants.rb

@@ -3,10 +3,15 @@ module Squib
     # System-wide default font
     # :nodoc:
     # @api public
-    DEFAULT_FONT = 'Arial 36'
+    DEFAULT_FONT = 'Arial 12'
 
     # Used for inch-cm conversion
     # :nodoc:
     # @api private
     INCHES_IN_CM = 0.393700787
+
+    # Used for points-inch conversion
+    # :nodoc:
+    # @api private
+    POINTS_PER_IN = 72.0
 end

data/lib/squib/graphics/cairo_context_wrapper.rb

@@ -25,7 +25,7 @@ module Squib
         :operator=, :show_page, :clip, :transform, :mask, :create_pango_layout,
         :antialias=, :curve_to, :matrix, :matrix=, :identity_matrix, :pango_layout_path,
         :stroke_preserve, :target, :new_path, :fill_preserve, :close_path,
-        :set_line_join, :set_line_cap, :set_dash
+        :set_line_join, :set_line_cap, :set_dash, :arc, :arc_negative
 
       # :nodoc:
       # @api private

data/lib/squib/graphics/image.rb

@@ -67,7 +67,12 @@ module Squib
       Squib.logger.warn 'Both an SVG file and SVG data were specified' unless file.to_s.empty? || svg_args.data.to_s.empty?
       return if (file.nil? or file.eql? '') and svg_args.data.nil? # nothing specified TODO Move this out to arg validator
       svg_args.data = File.read(file) if svg_args.data.to_s.empty?
-      svg          = Rsvg::Handle.new_from_data(svg_args.data)
+      begin
+        svg = Rsvg::Handle.new_from_data(svg_args.data)
+      rescue Rsvg::Error::Failed
+        Squib.logger.error "Invalid SVG data. Is '#{file}' a valid svg file?"
+        return
+      end
       box.width    = svg.width  if box.width == :native
       box.height   = svg.height if box.height == :native
       box.width  = svg.width.to_f * box.height.to_f / svg.height.to_f if box.width == :scale

data/lib/squib/graphics/save_doc.rb

@@ -9,7 +9,8 @@ module Squib
       cc = Cairo::Context.new(Cairo::ImageSurface.new(sheet_width, sheet_height))
       num_this_sheet = 0
       sheet_num = 0
-      x, y = sheet.margin, sheet.margin
+      y = sheet.margin
+      x = sheet.rtl ? (sheet_width - sheet.margin - sheet.gap - @width) : 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
@@ -18,16 +19,17 @@ module Squib
             new_sheet = false
             num_this_sheet = 0
             sheet_num += 1
-            x, y = sheet.margin, sheet.margin
+            y = sheet.margin
+            x = sheet.rtl ? (sheet_width - sheet.margin - sheet.gap - @width) : 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
+          x += (surface.width + sheet.gap) * (sheet.rtl ? -1 : 1)
           if num_this_sheet % sheet.columns == 0 # new row
-            x = sheet.margin
+            x = sheet.rtl ? (sheet_width - sheet.margin - sheet.gap - @width) : sheet.margin
             y += surface.height + sheet.gap
           end
           bar.increment

data/lib/squib/graphics/save_pdf.rb

@@ -12,10 +12,13 @@ module Squib
       # @api private
       def render_pdf(range, sheet)
         cc = init_cc(sheet)
-        cc.scale(72.0 / @deck.dpi, 72.0 / @deck.dpi) # for bug #62
-        x, y         = sheet.margin, sheet.margin
+        cc.scale(POINTS_PER_IN / @deck.dpi, POINTS_PER_IN / @deck.dpi) # for bug #62
         card_width   = @deck.width  - 2 * sheet.trim
         card_height  = @deck.height - 2 * sheet.trim
+        start_x_pos = sheet.rtl ? sheet.width - sheet.margin - card_width - 2 * sheet.trim : sheet.margin
+        x_increment = (card_width + sheet.gap) * (sheet.rtl ? -1 : 1)
+        y = sheet.margin
+        x = start_x_pos
         track_progress(range, sheet) do |bar|
           range.each do |i|
             card = @deck.cards[i]
@@ -38,14 +41,16 @@ module Squib
             bar.increment
             cc.reset_clip
             cc.translate(-x, -y)
+
             draw_crop_marks(cc, x, y, sheet)
-            x += card.width + sheet.gap - 2 * sheet.trim
-            if x > (sheet.width - card_width - sheet.margin)
-              x = sheet.margin
+            x += x_increment
+            if (x > (sheet.width - card_width - sheet.margin)) or (x < sheet.margin)
+              x = start_x_pos
               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
+                y = sheet.margin
+                x = start_x_pos
               end
             end
           end
@@ -59,8 +64,8 @@ module Squib
       def init_cc(sheet)
         Cairo::Context.new(Cairo::PDFSurface.new(
           "#{sheet.dir}/#{sheet.file}",
-          sheet.width * 72.0 / @deck.dpi,  #PDF thinks in 72 DPI "points"
-          sheet.height * 72.0 / @deck.dpi)
+          sheet.width * POINTS_PER_IN / @deck.dpi,  #PDF thinks in 72 DPI "points"
+          sheet.height * POINTS_PER_IN / @deck.dpi)
         )
       end