squib_plus 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 19f2f11b51db065d28f3be11cbc30293202dac9c1e9bee8b77408ab9b07d255b
+  data.tar.gz: 6ee1c5d23a051ff4341ddd6957e4e80f000c1ac94909e7beb3a1cfba3babce9f
+SHA512:
+  metadata.gz: ff9ebe8819ff49e08f99dd6d6054e86f62297748341280c4ca291f84fde4a772cff2bd42f222f8fd0513d0c9b337c86740e6f8cb5624466c44a296292d54302f
+  data.tar.gz: 4b2d3ab40628d117c1c138f04d5170efb5d82fa32e43ca1479d8da48672a7018629aa64ecfc7df7ce91dd2f6973969f6afc18c6a619f2531bec01fb35743db7e

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+_output

data/Gemfile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+gemspec

data/lib/squib_plus/card_size.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Squib
+  # Default card sizes for use like
+  #   Squib::Deck.new(**Squib.card_size(:bridge))
+  #
+  # Note that each of these has 0.25in extra compared
+  # to the real-world dimensions of the card in order
+  # to account for bleed.
+  @@card_sizes = {
+    bridge: { width: '2.5in', height: '3.75in' },
+    business: { width: '2.25in', height: '3.75in' },
+    divider: { width: '3.25in', height: '3.75in' },
+    domino: { width: '2in', height: '3.75in' },
+    euro_poker: { width: '2.73in', height: '3.71in' },
+    euro_square: { width: '3.01in', height: '3.01in' },
+    jumbo: { width: '3.75in', height: '5.75in' },
+    micro: { width: '1.5in', height: '2in' },
+    mini: { width: '2in', height: '2.75in' },
+    poker: { width: '2.75in', height: '3.75in' },
+    mint_tin: { width: '2.3in', height: '3.71in' },
+    small_square: { width: '2.75in', height: '2.75in' },
+    square: { width: '3.75in', height: '3.75in' },
+    tarot: { width: '2.75in', height: '5in' },
+    us_game: { width: '2.45in', height: '3.68in' }
+  }
+
+  def card_size(name, landscape: false)
+    dimensions = @@card_sizes.fetch name
+    dimensions = { width: dimensions[:height], height: dimensions[:width] } if landscape
+
+    { dpi: 300 }.merge dimensions
+  end
+  module_function :card_size
+end

data/lib/squib_plus/deck/avatar.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+require 'mechanize'
+
+module Squib
+  class Deck
+    def avatar(opts = {})
+      DSL::Avatar.new(self, __callee__).run(opts)
+    end
+  end
+
+  module DSL
+    # Add an avatar for placeholder art in your games
+    # using https://avatars.dicebear.com/. The image will
+    # be downloaded to your configured image directory if
+    # it doesn't already exist.
+    #
+    # Library can be male, female, human, identicon, initials,
+    # bottts, avataaars, jdenticon, gridy or micah.
+    #
+    # Seed can be any random string
+    #
+    # Example:
+    #   avatar library: 'micah', seed: '1234'
+    class Avatar
+      attr_reader :dsl_method, :deck
+
+      def initialize(deck, dsl_method)
+        @deck = deck
+        @dsl_method = dsl_method
+      end
+
+      def self.accepted_params
+        %i[
+          library seed
+          x y width height
+          blend mask
+          crop_x crop_y crop_width crop_height
+          crop_corner_radius crop_corner_x_radius crop_corner_y_radius
+          flip_horizontal flip_vertical angle
+          id force_id data
+          range layout
+          placeholder
+        ]
+      end
+
+      def run(opts)
+        Dir.chdir(deck.img_dir) do
+          defaults = { library: 'avataaars' }
+          options = defaults.merge opts
+
+          # Extract the default svg options
+          range = Args.extract_range opts, deck
+          svg_args = Args.extract_svg_special opts, deck
+          paint = Args.extract_paint opts, deck
+          box   = Args.extract_scale_box opts, deck
+          trans = Args.extract_transform opts, deck
+
+          deck.progress_bar.start('Loading Avatar(s)', range.size) do |bar|
+            range.each do |i|
+              library = options[:library]
+              seed = options[:seed][i]
+              next if seed.nil?
+
+              file = "avatar-#{library}-#{seed}.svg"
+
+              # Check if we need to download the image
+              unless File.exist?(file)
+                agent = Mechanize.new
+                agent.follow_meta_refresh = true
+                agent.keep_alive = false
+                agent.history.max_size = 10
+
+                response = agent.get_file("https://avatars.dicebear.com/api/#{library}/#{seed}.svg")
+                response = response.encode('ascii-8bit').force_encoding('utf-8')
+
+                File.open(file, 'w') { |f| f.write(response) }
+              end
+
+              deck.cards[i].svg(file, svg_args[i], box[i], paint[i], trans[i])
+              bar.increment
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/squib_plus/deck.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+
+module Squib
+  class Deck
+    # Adds a card number to the bottom right of the card by default.
+    # Helps with tracking down a specific card in your spreadsheet in
+    # games with many unique cards.
+    def card_num(opts = {})
+      defaults = {
+        x: width - 100,
+        y: height - 100,
+        width: 50,
+        height: 50,
+        font: 'sans-serif',
+        font_size: 9,
+        color: '#000',
+        align: :center,
+        valign: :middle
+      }
+      range = Args.extract_range opts, self
+
+      # Index from 1
+      text(str: range.map { |i| i + 1 }, **(defaults.merge opts))
+    end
+
+    # Shortcut for save_sheet with defaults that make sense for Tabletop Simulator
+    def tts(opts = {})
+      defaults = { columns: 10, rows: 7, trim: 37.5 }
+      save_sheet(defaults.merge(opts))
+    end
+
+    # Shortcut for creating a Print-n-Play sheet using poker-sized cards
+    def pnp(opts = {})
+      cut_zone stroke_color: '#888'
+      defaults = {
+        trim: 37.5,
+        sprue: if opts[:rtl]
+                 "#{File.dirname(__FILE__)}/sprues/letter_poker_tight_reverse.yml"
+               else
+                 "#{File.dirname(__FILE__)}/sprues/letter_poker_tight.yml"
+               end
+      }
+      save_pdf(defaults.merge(opts))
+    end
+  end
+
+  require_relative 'deck/avatar'
+end

data/lib/squib_plus/google_sheets.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'mechanize'
+
+module Squib
+  # gsheet allows you to load Deck data using Google Sheets.
+  #
+  # First, share your sheet using File > Publish to the web
+  # Select 'Entire document' and '.csv' as the format
+  # Copy the URL like
+  #   https://docs.google.com/spreadsheets/d/e/2PACX-.../pub?output=csv
+  #                                            ^^^^^^^^^
+  #   The code you need to pass is the long ID after /d/e.
+  #
+  # If the sheet has multiple tabs, you can specify a later tab using the gid from
+  # the non-share URL like
+  #   https://docs.google.com/spreadsheets/d/.../edit#gid=123456
+  #                                                       ^^^^^^
+  #   The gid is at the end of the URL after #gid=
+  #
+  # Example:
+  #   deck = Squib.gsheet('2PACX-...', 123456)
+  #
+  #   Squib::Deck.new(cards: deck['name'].size) do
+  #     ...
+  #   end
+  #
+  # You can optionally specify the tab to use with the second argument
+  def gsheet(sheet_id, index = 0)
+    agent = Mechanize.new
+    response = agent.get_file("https://docs.google.com/spreadsheets/d/e/#{sheet_id}/pub?gid=#{index}&output=csv")
+    response = response.encode('ascii-8bit').force_encoding('utf-8')
+
+    Squib.csv data: response
+  end
+  module_function :gsheet
+end

data/lib/squib_plus/pdf.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'combine_pdf'
+
+module Squib
+  # Merge PDFs together, collated for front/back printing
+  # Example:
+  #   # Deck front
+  #   Squib::Deck.new(cards: deck['name'].size) do
+  #     ...
+
+  #     pnp file: 'front.pdf'
+  #   end
+
+  #   # Deck back
+  #   Squib::Deck.new(cards: deck['name'].size) do
+  #     ...
+
+  #     pnp file: 'back.pdf'
+  #   end
+
+  #   # Combine PnP
+  #   Squib.combine_pdfs([
+  #     { :front => "_output/front.pdf", :back => "_output/back.pdf" },
+  #   ], "_output/pnp.pdf")
+  def combine_pdfs(sheets, file)
+    pdf = CombinePDF.new
+
+    sheets.each do |sheet|
+      front = CombinePDF.load(sheet[:front])
+
+      # Collate the back pages immediately after the relevant page,
+      # if a back-side is provided.
+      back = CombinePDF.load(sheet[:back]) if sheet.key?(:back)
+
+      i = 0
+      front.pages.each do |page|
+        pdf << page
+        pdf << back.pages[i] if sheet.key?(:back)
+
+        break if i == front.pages.count - 1
+
+        i += 1
+      end
+    end
+
+    pdf.save file
+  end
+  module_function :combine_pdfs
+end

data/lib/squib_plus/sprues/letter_poker_tight.yml

@@ -0,0 +1,42 @@
+---
+sheet_width: 8.5in
+sheet_height: 11in
+card_width: 2.5in
+card_height: 3.5in
+cards:
+- x: 0.5in
+  y: 0.225in
+- x: 3in
+  y: 0.225in
+- x: 5.5in
+  y: 0.225in
+- x: 0.5in
+  y: 3.725in
+- x: 3in
+  y: 3.725in
+- x: 5.5in
+  y: 3.725in
+- x: 0.5in
+  y: 7.225in
+- x: 3in
+  y: 7.225in
+- x: 5.5in
+  y: 7.225in
+crop_line:
+  lines:
+  - type: :vertical
+    position: 0.5in
+  - type: :vertical
+    position: 3in
+  - type: :vertical
+    position: 5.5in
+  - type: :vertical
+    position: 8in
+  - type: :horizontal
+    position: 0.225in
+  - type: :horizontal
+    position: 3.725in
+  - type: :horizontal
+    position: 7.225in
+  - type: :horizontal
+    position: 10.725in

data/lib/squib_plus/sprues/letter_poker_tight_reverse.yml

@@ -0,0 +1,42 @@
+---
+sheet_width: 8.5in
+sheet_height: 11in
+card_width: 2.5in
+card_height: 3.5in
+cards:
+- x: 5.5in
+  y: 0.225in
+- x: 3in
+  y: 0.225in
+- x: 0.5in
+  y: 0.225in
+- x: 5.5in
+  y: 3.725in
+- x: 3in
+  y: 3.725in
+- x: 0.5in
+  y: 3.725in
+- x: 5.5in
+  y: 7.225in
+- x: 3in
+  y: 7.225in
+- x: 0.5in
+  y: 7.225in
+crop_line:
+  lines:
+  - type: :vertical
+    position: 0.5in
+  - type: :vertical
+    position: 3in
+  - type: :vertical
+    position: 5.5in
+  - type: :vertical
+    position: 8in
+  - type: :horizontal
+    position: 0.225in
+  - type: :horizontal
+    position: 3.725in
+  - type: :horizontal
+    position: 7.225in
+  - type: :horizontal
+    position: 10.725in

data/lib/squib_plus/string.rb

@@ -0,0 +1,5 @@
+class String
+  def slug
+    downcase.strip.gsub(' ', '-').gsub(/[^\w-]/, '')
+  end
+end

data/lib/squib_plus/subset.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Squib
+  # Subset a selection of cards based on some criteria. Can be passed
+  # directly into the range argument of other DSL functions.
+  #
+  # Example:
+  #   gems = Squib.subset(deck['category'], -> (c) { c === 'gem' })
+  #   text range: gems, str: deck['gem_num'], layout: 'gem_label'
+  #
+  # You can invert the match using matching: false
+  # This allows you to use a single criteria function for positive/negative
+  # matches.
+  def subset(column, criteria, matching: true)
+    sub = {}
+    column.each_with_index { |c, i| (sub[criteria.call(c)] ||= []) << i }
+
+    sub[matching]
+  end
+  module_function :subset
+end

data/lib/squib_plus.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require_relative 'squib_plus/card_size'
+require_relative 'squib_plus/deck'
+require_relative 'squib_plus/string'
+require_relative 'squib_plus/subset'

data/squib_plus.gemspec

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |s|
+  s.name = 'squib_plus'
+  s.version       = '0.0.1'
+  s.files         = `git ls-files -z`.split("\x0")
+
+  s.authors     = ['Rob Newton']
+  s.summary     = 'Extensions for Squib'
+  s.description = 'Helper functions extending the functionality of Squib'
+  s.email       = 'robert@coinflip.games'
+  s.homepage    = 'https://rubygems.org/gems/squib_plus'
+  s.license     = 'MIT'
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: squib_plus
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Rob Newton
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-11-05 00:00:00.000000000 Z
+dependencies: []
+description: Helper functions extending the functionality of Squib
+email: robert@coinflip.games
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- lib/squib_plus.rb
+- lib/squib_plus/card_size.rb
+- lib/squib_plus/deck.rb
+- lib/squib_plus/deck/avatar.rb
+- lib/squib_plus/google_sheets.rb
+- lib/squib_plus/pdf.rb
+- lib/squib_plus/sprues/letter_poker_tight.yml
+- lib/squib_plus/sprues/letter_poker_tight_reverse.yml
+- lib/squib_plus/string.rb
+- lib/squib_plus/subset.rb
+- squib_plus.gemspec
+homepage: https://rubygems.org/gems/squib_plus
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
+summary: Extensions for Squib
+test_files: []