squib 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3977769e38bdf72d2dd035c62648b2ffaae2085c
+  data.tar.gz: e9d8ad1586160caee1be3d2b497ab9c71daa56b2
+SHA512:
+  metadata.gz: e8238d6b6e236a22a2bd164712771b9366f20e3d4d04101b0992d2517d666bd0e6cd8996c8ba24aeb56133b2d30b405ba37fd26a44f8d5b3017b1146bde63ad1
+  data.tar.gz: 4593d6fae7feac75dab22efa560042c7fc932f1b056d029ef53464bac21a1a2bda6a711336ef358c831de33930344251380975e66f16c73a1f1f8c1447191c0b

data/.gitignore

@@ -0,0 +1,26 @@
+.DS_Store
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+_img
+samples/_img
+samples/_output/*.png

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.0

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Andy Meneely
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,55 @@
+[![Gem Version](https://badge.fury.io/rb/squib.svg)](https://rubygems.org/gems/squib)
+[![Build Status](https://secure.travis-ci.org/andymeneely/squib.svg?branch=master)](https://travis-ci.org/andymeneely/squib)
+[![Dependency Status](https://gemnasium.com/andymeneely/squib.svg)](https://gemnasium.com/andymeneely/squib)
+
+# Squib
+
+Squib is a ruby DSL for prototyping card and board games. Think of it like [nanDeck](http://nandeck.it) done "the Ruby way". Start with some basic commands and generate print-ready PNGs and PDFs. 
+
+Squib is currently pre-release alpha. 
+
+```ruby
+require 'squib'
+
+Squib::Deck.new(width: 825, height: 1125, cards: 3) do
+  background color: [1.0,1.0,1.0]
+  data = xlsx file: 'sample.xlsx'
+
+  rect x: 15, y: 15, width: 795, height: 1095, x_radius: 50, y_radius: 50
+
+  text str: data['name'], x: 250, y: 55, font: 'Arial 54'
+  text str: data['level'], x: 65, y: 40, font: 'Arial 72'
+
+  png file: 'icon.png', x: 665, y: 30
+
+  save format: :png
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'squib'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install squib
+
+Note: Squib is based on the `cairo` and `pango` extensions, which require at least Ruby 2.0
+
+## API
+
+API docs to be written. See the `samples` directory.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/squib/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/squib

@@ -0,0 +1,2 @@
+#!/usr/bin/env ruby
+require 'squib'

data/lib/squib.rb

@@ -0,0 +1,2 @@
+require 'squib/deck'
+require 'squib/card'

data/lib/squib/api/background.rb

@@ -0,0 +1,12 @@
+module Squib
+  class Deck
+    #module API
+
+      def background(range: :all, color: '#000000')
+        range = rangeify(range)
+        range.each { |i| @cards[i].background(color) }
+      end
+      
+    #end
+  end
+end

data/lib/squib/api/data.rb

@@ -0,0 +1,29 @@
+require 'roo'
+
+module Squib
+  class Deck
+
+    def csv(file: 'deck.csv', header: true)
+      raise 'Not implemented!'
+    end
+
+    def xlsx(file: 'deck.xlsx', sheet: 0)
+      s = Roo::Excelx.new(file)
+      s.default_sheet = s.sheets.first
+      data = {}
+      s.first_column.upto(s.last_column) do |col|
+        header = s.cell(s.first_row,col).to_s
+        data[header] = []
+        (s.first_row+1).upto(s.last_row) do |row|
+          cell = s.cell(row,col)
+          # Roo hack for avoiding unnecessary .0's on whole integers
+          cell = s.excelx_value(row,col) if s.excelx_type(row,col) == [:numeric_or_formula, "General"]
+          data[header] << cell
+        end#row
+      end#col
+      data
+    end#xlsx
+
+  end
+end
+

data/lib/squib/api/image.rb

@@ -0,0 +1,11 @@
+module Squib
+  class Deck
+    
+    def png(range=:all, file: nil, x: 0, y: 0)
+      range = rangeify(range)
+      file = fileify(file)
+      range.each{ |i| @cards[i].png(file, x, y) }
+    end
+
+  end
+end

data/lib/squib/api/save.rb

@@ -0,0 +1,16 @@
+module Squib
+  class Deck
+  
+    def save(range: :all, dir: "_output", format: :png, prefix: "card_")
+      format = [format].flatten
+      save_png(range: range, dir: dir, prefix: prefix) if format.include? :png
+      save_pdf if format.include? :pdf
+    end
+    
+    def save_png(range: :all, dir: "_output", prefix: 'card_')
+      range = rangeify(range)
+      range.each { |i| @cards[i].save_png(i, dir, prefix) }
+    end
+
+  end
+end

data/lib/squib/api/shapes.rb

@@ -0,0 +1,13 @@
+module Squib
+  class Deck
+    
+    def rect(range: :all, x: 0, y: 0, width: 825, height: 1125, \
+              x_radius: 0, y_radius: 0)
+      range = rangeify(range)
+      range.each do |i|
+        @cards[i].draw_rectangle(x, y, width, height, x_radius, y_radius)
+      end
+    end
+    
+  end
+end

data/lib/squib/api/text.rb

@@ -0,0 +1,26 @@
+module Squib
+  class Deck
+    def fontify (font)
+      font = 'Arial 36' if font==:use_set
+      font
+    end
+
+    def font(type: 'Arial', size: 12, **options)
+      raise 'Not implemented!'
+    end
+
+    def set_font(type: 'Arial', size: 12, **options)
+      raise 'Not implemented!'
+    end
+
+    def text(range: :all, str: '', font: :use_set, x: 0, y: 0, **options)
+      range = rangeify(range)
+      str = [str] * @cards.size unless str.respond_to? :each
+      font = fontify(font)
+      range.each do |i|
+        cards[i].text(str[i], font, x, y, options)
+      end
+    end
+
+  end
+end

data/lib/squib/card.rb

@@ -0,0 +1,27 @@
+require 'cairo'
+
+module Squib
+
+	class Card
+    attr_reader :width, :height
+    attr_accessor :cairo_surface, :cairo_context
+
+    def initialize(width, height)
+      @width=width; @height=height
+      @cairo_surface = Cairo::ImageSurface.new(width,height)
+      @cairo_context = Cairo::Context.new(@cairo_surface)
+    end
+
+    ########################
+    ### 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/text'
+    
+	end
+
+end

data/lib/squib/deck.rb

@@ -0,0 +1,49 @@
+require 'squib/card'
+
+module Squib
+  class Deck
+    include Enumerable
+    attr_reader :width, :height
+    attr_reader :cards
+
+    def initialize(width: 825, height: 1125, cards: 1, &block)
+      @width=width; @height=height
+      @cards = []
+      cards.times{ @cards << Squib::Card.new(width, height) }
+      if block_given?
+        instance_eval(&block)
+      end
+    end
+
+    def [](key)
+      @cards[key]
+    end
+
+    #For Enumerable
+    def each(&block)
+      @cards.each { |card| block.call(card) }
+    end
+
+    def rangeify (range)
+      range = 0..(@cards.size-1) if range == :all
+      range = range..range if range.is_a? Integer
+      return range
+    end
+
+    def fileify(file)
+      raise 'File #{file} does not exist!' unless File.exists? file
+      file
+    end
+
+    ##################
+    ### PUBLIC API ###
+    ##################
+    require 'squib/api/background'
+    require 'squib/api/data'
+    require 'squib/api/image'
+    require 'squib/api/save'
+    require 'squib/api/shapes'
+    require 'squib/api/text'
+
+  end
+end

data/lib/squib/graphics/background.rb

@@ -0,0 +1,11 @@
+module Squib
+  class Card
+
+    def background(color)
+      cc = cairo_context
+      cc.set_source_rgb(*color)
+      cc.paint
+    end
+      
+  end
+end

data/lib/squib/graphics/image.rb

@@ -0,0 +1,12 @@
+module Squib
+  class Card
+
+    def png(file, x, y)
+      cc = cairo_context
+      png = Cairo::ImageSurface.from_png(file)
+      cc.set_source(png, x, y)
+      cc.paint
+    end
+
+  end
+end

data/lib/squib/graphics/save_doc.rb

@@ -0,0 +1,22 @@
+module Squib
+  class Deck
+
+    def save_pdf
+      #paper is 8.5x11
+      # PDF points are 1/72 of an inch
+      raise "Not implemented yet!"
+      width = 8.5 * 72
+      height = 11 * 72
+      cc = Cairo::Context.new(Cairo::PDFSurface.new('_img/deck.pdf', width, height))
+      x = 10
+      y = 10
+      @cards.each_with_index do |card, i|
+        cc.move_to(x,y)
+        x += 825*i
+        cc.set_source(card.cairo_surface, 0, 300)
+        cc.paint
+      end
+    end
+
+  end
+end

data/lib/squib/graphics/save_images.rb

@@ -0,0 +1,9 @@
+module Squib
+  class Card
+
+    def save_png(i, dir, prefix)
+      cairo_context.target.write_to_png("#{dir}/#{prefix}#{i}.png")
+    end
+
+  end
+end

data/lib/squib/graphics/shapes.rb

@@ -0,0 +1,12 @@
+module Squib
+  class Card
+      
+    def draw_rectangle(x, y, width, height, x_radius, y_radius)
+      cc = cairo_context
+      cc.set_source_rgb(0.0,0.0,0.0)
+      cc.rounded_rectangle(x, y, width, height, x_radius, y_radius)
+      cc.stroke
+    end
+      
+  end
+end

data/lib/squib/graphics/text.rb

@@ -0,0 +1,28 @@
+require 'pango'
+
+module Squib
+  class Card
+
+    def text(str, font, x, y, options)
+      cc = cairo_context
+      cc.set_source_color(:black) #black
+      cc.move_to(x,y)
+      layout = cc.create_pango_layout
+      layout.text = str.to_s
+      w = options[:width] ; h = options[:height] 
+      w ||= (@width - 2*x)  ; h ||= (@height - 2*y) # default centers to x,y 
+      w *= Pango::SCALE   ; h *= Pango::SCALE    
+      layout.width=w      ; layout.height=h
+      layout.wrap = Pango::WRAP_WORD
+      layout.justify = true
+      layout.alignment = Pango::ALIGN_LEFT
+      layout.font_description = Pango::FontDescription.new(font)
+      #Center it vertically?
+      #puts "Height: #{layout.extents[1].height / Pango::SCALE}"
+      #puts "Height: #{layout.pixel_size[1]*layout.line_count}"
+      cc.update_pango_layout(layout)
+      cc.show_pango_layout(layout)
+    end
+
+  end
+end

data/lib/squib/version.rb

@@ -0,0 +1,3 @@
+module Squib
+  VERSION = "0.0.1"
+end

data/samples/_output/watch.html

@@ -0,0 +1,25 @@
+<!doctype html>
+<html>
+	<head>
+		<style>
+			img{
+				border: 1px solid black;
+			}
+		</style>
+		<script src="http://code.jquery.com/jquery-1.9.1.min.js"></script>
+		<script>
+			setInterval(function () {
+    			$("#img0").attr("src", "sample_excel_0.png?"+new Date().getTime());
+    			$("#img1").attr("src", "sample_excel_1.png?"+new Date().getTime());
+
+			}, 1000);
+		</script>
+	</head>
+
+	<body>
+		<h1>Cards</h1>
+		<img id="img0" width=300 src="sample_excel_0.png"/>
+		<img id="img1" width=300 src="sample_excel_1.png"/>
+	</body>
+
+</html>

data/samples/basic.rb

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+require 'squib'
+
+data = {'name' => ['Thief', 'Grifter', 'Mastermind'], 
+        'level' => [1,2,3]}
+longtext = "Hello, World! What do you know about tweetle beetles? well... \nWhen tweetle beetles fight, it's called a tweetle beetle battle. And when they battle in a puddle, it's a tweetle beetle puddle battle. AND when tweetle beetles battle with paddles in a puddle, they call it a tweetle beetle puddle paddle battle. AND... When beetles battle beetles in a puddle paddle battle and the beetle battle puddle is a puddle in a bottle... ..they call this a tweetle beetle bottle puddle paddle battle muddle. AND... When beetles fight these battles in a bottle with their paddles and the bottle's on a poodle and the poodle's eating noodles... ...they call this a muddle puddle tweetle poodle beetle noodle bottle paddle battle."
+
+Squib::Deck.new(width: 825, height: 1125, cards: 3) do
+  background color: [1.0,1.0,1.0]
+  rect x: 15, y: 15, width: 795, height: 1095, x_radius: 50, y_radius: 50
+  rect x: 30, y: 30, width: 128, height: 128, x_radius: 25, y_radius: 25
+
+  text str: data['name'], x: 250, y: 55, font: 'Arial 54'
+  text str: data['level'], x: 65, y: 40, font: 'Arial 72'
+  text str: longtext, x: 100, y: 600, font: 'Arial 16'
+
+  png file: 'shiny-purse.png', x: 665, y: 30
+
+  save format: :png
+end
+
+puts "Done!"

data/samples/excel.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+require 'squib'
+
+Squib::Deck.new(width: 825, height: 1125, cards: 3) do
+  background color: [1.0,1.0,1.0]
+
+  data = xlsx file: 'sample.xlsx', sheet: 0
+
+  text str: data['Name'], x: 250, y: 55, font: 'Arial 54'
+  text str: data['Level'], x: 65, y: 65, font: 'Arial 72'
+  text str: data['Description'], x: 65, y: 600, font: 'Arial 36'
+
+  save format: :png, prefix: 'sample_excel_'
+end
+
+puts "Done!"

data/spec/deck_spec.rb

@@ -0,0 +1,48 @@
+require 'squib/deck'
+
+describe Squib::Deck do   
+
+  it "initializes with default parameters" do
+    d = Squib::Deck.new 
+    expect(d.width).to eq(825)
+    expect(d.height).to eq(1125)
+    expect(d.cards.size).to eq(1)
+  end
+
+  context "in dealing with ranges" do
+    it "calls text on all cards by default" do
+      card1 = instance_double(Squib::Card)
+      card2 = instance_double(Squib::Card) 
+      expect(card1).to receive(:text).with('blah','Arial 36',0,0,{}).once
+      expect(card2).to receive(:text).with('blah','Arial 36',0,0,{}).once
+      Squib::Deck.new do  
+        @cards = [card1, card2]  
+        text str: 'blah'
+      end
+    end
+
+    it "calls text on some cards with an integer" do
+      card1 = instance_double(Squib::Card)
+      card2 = instance_double(Squib::Card)
+      expect(card2).to receive(:text).with('blah','Arial 36',0,0,{}).once
+      Squib::Deck.new do  
+        @cards = [card1, card2]  
+        text range: 1, str: 'blah'
+      end
+    end  
+
+    it "calls text with ranges" do
+      card1 = instance_double(Squib::Card)
+      card2 = instance_double(Squib::Card)
+      card3 = instance_double(Squib::Card)
+      expect(card1).to receive(:text).with('blah','Arial 36',0,0,{}).once
+      expect(card2).to receive(:text).with('blah','Arial 36',0,0,{}).once
+      Squib::Deck.new do  
+        @cards = [card1, card2, card3]  
+        text range: 0..1, str: 'blah'
+      end
+    end
+  end
+
+end#describe
+

data/squib.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'squib/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "squib"
+  spec.version       = Squib::VERSION
+  spec.authors       = ["Andy Meneely"]
+  spec.email         = ["playconfidencegames@gmail.com"]
+  spec.summary       = %q{A Ruby API for prototyping card and other tabletop games}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'cairo', '~> 1.12.9'
+  spec.add_runtime_dependency 'pango', '~> 2.2.0'
+  spec.add_runtime_dependency 'roo', '~> 1.13.2'
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: squib
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andy Meneely
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cairo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.12.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.12.9
+- !ruby/object:Gem::Dependency
+  name: pango
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+- !ruby/object:Gem::Dependency
+  name: roo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.13.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.13.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- playconfidencegames@gmail.com
+executables:
+- squib
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/squib
+- lib/squib.rb
+- lib/squib/api/background.rb
+- lib/squib/api/data.rb
+- lib/squib/api/image.rb
+- lib/squib/api/save.rb
+- lib/squib/api/shapes.rb
+- lib/squib/api/text.rb
+- lib/squib/card.rb
+- lib/squib/deck.rb
+- lib/squib/graphics/background.rb
+- lib/squib/graphics/image.rb
+- lib/squib/graphics/save_doc.rb
+- lib/squib/graphics/save_images.rb
+- lib/squib/graphics/shapes.rb
+- lib/squib/graphics/text.rb
+- lib/squib/version.rb
+- samples/_output/watch.html
+- samples/basic.rb
+- samples/excel.rb
+- samples/sample.xlsx
+- samples/shiny-purse.png
+- spec/deck_spec.rb
+- squib.gemspec
+homepage: ''
+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: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A Ruby API for prototyping card and other tabletop games
+test_files:
+- spec/deck_spec.rb