squib 0.0.2 → 0.0.3

data/spec/input_helpers_spec.rb

@@ -0,0 +1,117 @@
+require 'spec_helper'
+require 'squib/input_helpers'
+
+class DummyDeck
+  include  Squib::InputHelpers
+  attr_accessor :layout, :cards, :custom_colors
+end
+
+module Squib
+  def logger=(l)
+    @logger = l
+  end
+  module_function 'logger='
+end
+
+describe Squib::InputHelpers do
+
+
+  before(:each) do
+    @deck = DummyDeck.new
+    @deck.layout = {
+      'blah' => {x: 25}, 
+      'apples' => {x: 35},
+      'oranges' => {y: 45},
+    }
+    @deck.cards = %w(a b)
+    @deck.custom_colors = {}
+  end
+
+  context '#layoutify' do
+    it "warns on the logger when the layout doesn't exist" do
+      @old_logger = Squib.logger
+      Squib.logger = instance_double(Logger)
+      expect(Squib.logger).to receive(:warn).with("Layout entry 'foo' does not exist.").twice
+      expect(Squib.logger).to receive(:debug)
+      expect(@deck.send(:layoutify, {layout: :foo})).to eq({layout: [:foo,:foo]}) 
+      Squib.logger = @old_logger
+    end
+
+    it "applies the layout in a normal situation" do
+      expect(@deck.send(:layoutify, {layout: :blah})).to \
+        eq({layout: [:blah, :blah], x: [25, 25]}) 
+    end
+
+    it "applies two different layouts for two different situations" do
+      expect(@deck.send(:layoutify, {layout: ['blah', 'apples']})).to \
+        eq({layout: ['blah','apples'], x: [25, 35]}) 
+    end
+
+    it "still has nils when not applied two different layouts differ in structure" do
+      expect(@deck.send(:layoutify, {layout: ['apples', 'oranges']})).to \
+        eq({layout: ['apples','oranges'], x: [35], y: [nil, 45]}) 
+      #...this might behavior that is hard to debug for users. Trying to come up with a warning or something...
+    end
+
+    it "also looks up based on strings" do
+      expect(@deck.send(:layoutify, {layout: 'blah'})).to \
+        eq({layout: ['blah','blah'], x: [25, 25]}) 
+    end
+
+  end
+
+  context '#rangeify' do
+    it "must be within the card size range" do
+      expect{@deck.send(:rangeify, {range: 2..3})}.to \
+        raise_error(ArgumentError, '2..3 is outside of deck range of 0..1')
+    end
+
+    it "cannot be nil" do
+      expect{@deck.send(:rangeify, {range: nil})}.to \
+        raise_error(RuntimeError, 'Range cannot be nil')
+    end
+
+    it "defaults to a range of all cards if :all" do
+      expect(@deck.send(:rangeify, {range: :all})).to eq({range: 0..1})
+    end
+  end
+
+  context "#fileify" do
+    it "should throw an error if the file doesn't exist" do
+      expect{@deck.send(:fileify, {file: 'nonexist.txt'}, true)}.to \
+        raise_error(RuntimeError,"File #{File.expand_path('nonexist.txt')} does not exist!")
+    end
+  end
+
+  context "#dir" do
+    it "should raise an error if the directory does not exist" do
+      expect{@deck.send(:dirify, {dir: 'nonexist'}, :dir, false)}.to \
+        raise_error(RuntimeError,"'nonexist' does not exist!")
+    end
+  end
+
+  context "#colorify" do
+    it "should parse if nillable" do
+      color = @deck.send(:colorify, {color: ['#fff']}, true)[:color]
+      expect(color.to_a[0].to_a).to eq([1.0, 1.0, 1.0, 1.0])
+    end
+
+    it "raises and error if the color doesn't exist" do
+      expect{ @deck.send(:colorify, {color: [:nonexist]}, false) }.to \
+        raise_error(ArgumentError, "unknown color name: nonexist")
+    end
+
+    it "pulls from config's custom colors" do
+      @deck.custom_colors['foo'] = "#abc"
+      expect(@deck.send(:colorify, {color: [:foo]}, false)[:color][0].to_s).to \
+        eq('#AABBCCFF')
+    end
+
+    it "pulls from config's custom colors even when a string" do
+      @deck.custom_colors['foo'] = "#abc"
+      expect(@deck.send(:colorify, {color: ['foo']}, false)[:color][0].to_s).to \
+        eq('#AABBCCFF')
+    end
+  end
+
+end

data/spec/samples_run_spec.rb

@@ -1,15 +1,20 @@
-require 'spec_helper'
-require 'squib'
-
-describe Squib do 
-
-  it "should execute all examples with no errors" do
-    samples = File.expand_path('../samples', File.dirname(__FILE__))
-    Dir["#{samples}/**/*.rb"].each do |sample|
-      Dir.chdir(samples) do #to save to _output
-        require_relative "../samples/#{File.basename(sample)}"
-      end
-    end
-  end
-
+require 'spec_helper'
+require 'squib'
+require 'pp'
+
+describe Squib do 
+
+  context "all samples run without error" do
+    it "should execute with no errors" do
+      p = double("ProgressBar")
+      allow(ProgressBar).to receive(:create).and_return(Squib::DoNothing.new)
+      samples = File.expand_path('../samples', File.dirname(__FILE__))
+      Dir["#{samples}/**/*.rb"].each do |sample|
+        Dir.chdir(samples) do #to save to _output
+          require_relative "../samples/#{File.basename(sample)}"
+        end
+      end
+    end
+  end    
+
 end

data/spec/spec_helper.rb

@@ -7,3 +7,6 @@ SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
 ]
 SimpleCov.start
 
+def test_file(str)
+  "#{File.expand_path(File.dirname(__FILE__))}/data/#{str}"
+end

data/squib.gemspec

@@ -1,42 +1,46 @@
-# 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.specification_version = 2 if spec.respond_to? :specification_version=
-  spec.required_rubygems_version = Gem::Requirement.new(">= 0") if spec.respond_to? :required_rubygems_version=
-  spec.rubygems_version = '2.2.2'
-  spec.required_ruby_version = '>= 2.0.0'
-
-  spec.name          = "squib"
-  spec.version       = Squib::VERSION
-  spec.license       = "MIT"
-
-  spec.summary       = %q{A Ruby DSL for prototyping card games}
-  spec.description   = %q{Squib is a Ruby DSL for prototyping card games}
-  spec.authors       = ["Andy Meneely"]
-  spec.email         = ["playconfidencegames@gmail.com"]
-  spec.homepage      = "https://github.com/andymeneely/squib"
-
-  spec.rdoc_options = ["--charset=UTF-8"]
-  spec.extra_rdoc_files = %w[README.md LICENSE.txt]
-
-  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_runtime_dependency 'rsvg2', '~> 2.2.0'
-  spec.add_runtime_dependency 'mercenary', '~> 0.3.4'
-
-  spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "yard"
-  spec.add_development_dependency "coveralls"
-
-end
+# 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.specification_version = 2 if spec.respond_to? :specification_version=
+  spec.required_rubygems_version = Gem::Requirement.new(">= 0") if spec.respond_to? :required_rubygems_version=
+  spec.rubygems_version = '2.2.2'
+  spec.required_ruby_version = '>= 2.0.0'
+
+  spec.name          = "squib"
+  spec.version       = Squib::VERSION
+  spec.license       = "MIT"
+
+  spec.summary       = %q{A Ruby DSL for prototyping card games}
+  spec.description   = %q{Squib is a Ruby DSL for prototyping card games}
+  spec.authors       = ["Andy Meneely"]
+  spec.email         = ["playconfidencegames@gmail.com"]
+  spec.homepage      = "https://github.com/andymeneely/squib"
+
+  spec.rdoc_options = ["--charset=UTF-8"]
+  spec.extra_rdoc_files = %w[README.md LICENSE.txt]
+
+  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_runtime_dependency 'rsvg2', '~> 2.2.0'
+  spec.add_runtime_dependency 'mercenary', '~> 0.3.4'
+  spec.add_runtime_dependency 'ruby-progressbar', '~> 1.5.1'
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec-mocks", "~> 3.0"
+  spec.add_development_dependency "redcarpet", '~> 3.1.2'
+  spec.add_development_dependency "github-markup", '~> 1.2.1'
+  spec.add_development_dependency "yard"
+  spec.add_development_dependency "coveralls"
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: squib
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Andy Meneely
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-29 00:00:00.000000000 Z
+date: 2014-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cairo
@@ -80,6 +80,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.3.4
+- !ruby/object:Gem::Dependency
+  name: ruby-progressbar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +136,48 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  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'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.2
+- !ruby/object:Gem::Dependency
+  name: github-markup
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.1
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -163,7 +219,6 @@ files:
 - .gitignore
 - .travis.yml
 - .yardopts
-- API.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -189,6 +244,7 @@ files:
 - lib/squib/graphics/shapes.rb
 - lib/squib/graphics/text.rb
 - lib/squib/input_helpers.rb
+- lib/squib/progress.rb
 - lib/squib/project_template/.gitignore
 - lib/squib/project_template/ABOUT.md
 - lib/squib/project_template/Gemfile
@@ -199,16 +255,22 @@ files:
 - lib/squib/project_template/layout.yml
 - lib/squib/version.rb
 - samples/_output/gitkeep.txt
+- samples/ball.png
 - samples/basic.rb
 - samples/colors.rb
 - samples/custom-config.yml
 - samples/custom-layout.yml
 - samples/custom_config.rb
+- samples/customconfig-imgdir/shiny-purse2.png
+- samples/customconfig-imgdir/spanner2.svg
 - samples/draw_shapes.rb
 - samples/excel.rb
+- samples/grit.png
 - samples/hello_world.rb
 - samples/load_images.rb
+- samples/offset.svg
 - samples/pokercard.png
+- samples/portrait-landscape.rb
 - samples/ranges.rb
 - samples/sample.xlsx
 - samples/save_pdf.rb
@@ -220,7 +282,13 @@ files:
 - samples/use_layout.rb
 - spec/api/api_text_spec.rb
 - spec/commands/new_spec.rb
+- spec/data/multi-extends-single-entry.yml
+- spec/data/multi-level-extends.yml
+- spec/data/no-extends.yml
+- spec/data/single-extends.yml
+- spec/data/single-level-multi-extends.yml
 - spec/deck_spec.rb
+- spec/input_helpers_spec.rb
 - spec/samples_run_spec.rb
 - spec/spec_helper.rb
 - squib.gemspec
@@ -245,14 +313,20 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 2
 summary: A Ruby DSL for prototyping card games
 test_files:
 - spec/api/api_text_spec.rb
 - spec/commands/new_spec.rb
+- spec/data/multi-extends-single-entry.yml
+- spec/data/multi-level-extends.yml
+- spec/data/no-extends.yml
+- spec/data/single-extends.yml
+- spec/data/single-level-multi-extends.yml
 - spec/deck_spec.rb
+- spec/input_helpers_spec.rb
 - spec/samples_run_spec.rb
 - spec/spec_helper.rb
 has_rdoc: 

data/API.md

@@ -1,59 +0,0 @@
-# Squib API
-
-The Squib DSL is based on a collection of methods provided to the `Squib::Deck` class. The general philosophy of Squib is to specify as little as possible with layers of defaults, highly flexible input, and good ol' Ruby duck-typing. Ruby does a lot to make Squib useful.
-
-# Squib::Deck and Squib::Card
-
-Squib essentially has two main classes: `Deck` and `Card`. `Deck` is the front-end, and `Card` is the back-end. The contract of `Deck` is to do the various manipulations of options and then delegate the operation to `Card` to do the low-level graphical operations. 
-
-For most users, I recommending solely using `Deck` methods. If you want to roll up your sleeves and get your hands messy, you can access the Cairo or Pango contexts the directly via the `Card` class. The API documentation doesn't really cover these, however, so you're on your own there.
-
-# Specifying Parameters
-
-Squib is all about sane defaults and shorthand specification. Arguments are almost always using hashes, which look a lot like [Ruby 2.0's named parameters](http://www.ruby-doc.org/core-2.0.0/doc/syntax/calling_methods_rdoc.html#label-Keyword+Arguments). This means you can specify your parameters in any order you please. All parameters are optional. For example `x` and `y` default to 0 (i.e. the upper-left corner of the card). Any parameter that is specified in the command overrides any Squib defaults, `config.yml` settings, or layout rules. 
-
-# Specifying Ranges
-
-Most public `Deck` methods allow a `range` to be specified as a first parameter. This parameter is used to access an internal `Array` of `Squib::Cards`. This can be an actual Ruby range, or anything that implements `#each` (thus can be an `Enumerable`). Integers are also supported for changing one card only. Negatives work from the back of the deck. Here are some examples from `samples/ranges.rb` found [here](https://github.com/andymeneely/squib/tree/master/samples/ranges.rb)
-
-{include:file:samples/ranges.rb}
-
-Many more examples can be found in `ranges.rb` in the [samples](https://github.com/andymeneely/squib/tree/master/samples/) folder . In particular, take a look at some idioms that uses hashes to denote things like card "types", or future-proofing against creating and deleting cards with an ID column.
-
-# Pixels and Other Units
-
-By default, Squib thinks in pixels. This decision was made so that we can have pixel-perfect layouts without automatically scaling everything, even though working in units is sometimes easier. To convert, we provide the `Deck#inch` method, as shown in `samples/units.rb` found [here](https://github.com/andymeneely/squib/tree/master/samples/units.rb)
-
-{include:file:samples/units.rb}
-
-# Specifying Colors
-
-Colors can be specified in a wide variety of ways, mostly in a hex-string. Take a look at the examples from `samples/colors.rb`, found [here](https://github.com/andymeneely/squib/tree/master/samples/colors.rb)
-
-{include:file:samples/colors.rb}
-
-Under the hood, Squib uses the `rcairo` [color parser](https://github.com/rcairo/rcairo/blob/master/lib/cairo/color.rb) to accept a variety of color specifications, along with over [300 pre-defined constants](https://github.com/rcairo/rcairo/blob/master/lib/cairo/colors.rb). 
-
-# Specifying Files
-
-All files opened for reading or writing (e.g. for `png` and `xlsx`) are opened relative to the current directory. Files opened for writing (e.g. for `save_png`) will be overwritten without warning. 
-
-# Custom Layouts
-
-Working with x-y coordinates all the time can be tiresome, and ideally everything in a game prototype should be data-driven and easily changed. For this, many Squib methods allow for a `layout` to be set. In essence, layouts are a way of setting default values for any argument given to the command. 
-
-To use a layout, set the `layout:` option on a `Deck.new` command to point to a YAML file. Any command that allows a `layout` option can be set with a Ruby symbol or String, and the command will then load the specified `x`, `y`, `width`, and `height`. The individual command can also override these options. 
-
-Note: YAML is very finnicky about having tabs in the file. Use two spaces for indentation instead.
-
-Layouts will override Squib's defaults, but are overriden by anything specified in the command itself. Thus, the order of precedence looks like this:
-
-* Use what the command specified
-* If anything was not yet specified, use what was given in a layout (if a layout was specified in the command and the file was given to the Deck)
-* If still anything was not yet specified, use what was given in Squib's defaults.
-
-Layouts also allow for a special `extends` field that will copy all of the settings from another entry. Only a single level of extends are supported currently (contact the developer if you want multiple levels). 
-
-See the `use_layout` sample found [here](https://github.com/andymeneely/squib/tree/master/samples/)
-
-{include:file:samples/use_layout.rb}