squib 0.8.0 → 0.9.0

data/RELEASE TODO.md

@@ -1,18 +1,18 @@
-Be sure to remember to do the following for releases. (Copy into a GitHub issue)
-
- - [ ] CHANGELOG is written for all new changes
- - [ ] README is updated
- - [ ] Samples are updated
- - [ ] `rake doc`
- - [ ] Check `sample_regression_spec.rb` regression tests are all enabled (i.e. `overwrite_sample` is commented out)
- - [ ] Bump version.rb
- - [ ] Do a full rake locally
- - [ ] `rake sanity`, and check visually
- - [ ] Travis is passing on dev branch
- - [ ] Merge master branch
- - [ ] Create GitHub release tag
- - [ ] `gem push pkg/squib-x.y.z.gem`
- - [ ] Github milestone closed
- - [ ] Push `rake doc` to website
- - [ ] Bump version.rb to the next alpha
- - [ ] Publish on BoardGameGeek thread
+Be sure to remember to do the following for releases. (Copy into a GitHub issue)
+
+ - [ ] CHANGELOG is written for all new changes
+ - [ ] README is updated
+ - [ ] Samples are updated
+ - [ ] `rake doc`
+ - [ ] Check `sample_regression_spec.rb` regression tests are all enabled (i.e. `overwrite_sample` is commented out)
+ - [ ] Bump version.rb
+ - [ ] Do a full rake locally
+ - [ ] `rake sanity`, and check visually
+ - [ ] Travis is passing on dev branch
+ - [ ] Merge master branch
+ - [ ] Create GitHub release tag
+ - [ ] `gem push pkg/squib-x.y.z.gem`
+ - [ ] Github milestone closed
+ - [ ] Push `rake doc` to website
+ - [ ] Bump version.rb to the next alpha
+ - [ ] Publish on BoardGameGeek thread

data/Rakefile

@@ -1,99 +1,106 @@
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-require 'yard'
-require 'benchmark'
-require 'byebug'
-
-task default: [:install, :spec]
-
-# Useful for hooking up with SublimeText.
-# e.g. rake sample[basic.rb]
-task :run,[:file] => :install do |t, args|
-  args.with_defaults(file: 'basic.rb')
-  Dir.chdir('samples') do
-    args[:file]  << ".rb" unless args[:file].end_with? '.rb'
-    puts "Running samples/#{args[:file]}"
-    load args[:file]
-  end
-end
-
-
-RSpec::Core::RakeTask.new(:spec)
-
-RSpec::Core::RakeTask.new(:spec_fastonly) do |t|
-  t.rspec_opts = "--tag ~slow"
-end
-
-task doc: [:yarddoc, :apply_google_analytics]
-
-YARD::Rake::YardocTask.new(:yarddoc) do |t|
-  t.files   = ['lib/**/*.rb', 'samples/**/*.rb']   # optional
-  #t.options = ['--any', '--extra', '--opts'] # optional
-end
-
-task benchmark: [:install] do
-  require 'squib'
-  Squib::logger.level = Logger::ERROR #silence warnings
-  Dir.chdir('benchmarks') do
-    Benchmark.bm(15) do |bm|
-      Dir['*.rb'].each do | script |
-        GC.start
-        bm.report(script) { load script }
-      end
-    end
-  end
-end
-
-task :sanity_only do
-  require_relative 'spec/samples/sanity.rb'
-  Sanity.new.run
-end
-
-task sanity: [:install, :spec, :sanity_only]
-
-task :apply_google_analytics do
-  # The string to replace in the html document. This is chosen to be the end
-  # body </body> tag. So the script can be injected as the last thing in the
-  # document body.
-  string_to_replace = "</body>"
-  # This is the string to replace with. It include the google analytics script
-  # as well as the end </body> tag.
-  string_to_replace_with = <<-EOF
-    <script>
-      (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
-      (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
-      m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
-      })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
-
-      ga('create', 'UA-54811605-1', 'auto');
-      ga('send', 'pageview');
-
-   </script>
-  </body>
-  EOF
-
-  files = Dir.glob("doc/**/*.html")
-
-  files.each do |html_file|
-    puts "Processing file: #{html_file}"
-    contents = ""
-    # Read the file contents
-    file =  File.open(html_file)
-    file.each { |line| contents << line }
-    file.close
-
-    # If the file already has google analytics tracking info, skip it.
-    if contents.include?(string_to_replace_with)
-      puts "Skipped..."
-      next
-    end
-
-    # Apply google analytics tracking info to the html file
-    contents.gsub!(string_to_replace, string_to_replace_with)
-
-    # Write the contents with the google analytics info to the file
-    file =  File.open(html_file, "w")
-    file.write(contents)
-    file.close
-  end
-end
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'yard'
+require 'benchmark'
+# require 'byebug'
+
+desc 'install + spec'
+task default: [:install, :spec]
+
+# Useful for hooking up with SublimeText.
+# e.g. rake sample[basic.rb]
+desc 'Run a specific sample'
+task :run,[:file] => :install do |t, args|
+  args.with_defaults(file: 'basic.rb')
+  Dir.chdir('samples') do
+    args[:file]  << ".rb" unless args[:file].end_with? '.rb'
+    puts "Running samples/#{args[:file]}"
+    load args[:file]
+  end
+end
+
+
+RSpec::Core::RakeTask.new(:spec)
+
+RSpec::Core::RakeTask.new(:spec_fastonly) do |t|
+  t.rspec_opts = "--tag ~slow"
+end
+
+desc 'Build API docs'
+task doc: [:yarddoc, :apply_google_analytics]
+
+YARD::Rake::YardocTask.new(:yarddoc) do |t|
+  t.files   = ['lib/**/*.rb', 'samples/**/*.rb']   # optional
+  #t.options = ['--any', '--extra', '--opts'] # optional
+end
+
+desc 'Run some performance benchmarks'
+task benchmark: [:install] do
+  require 'squib'
+  Squib::logger.level = Logger::ERROR #silence warnings
+  Dir.chdir('benchmarks') do
+    Benchmark.bm(15) do |bm|
+      Dir['*.rb'].each do | script |
+        GC.start
+        bm.report(script) { load script }
+      end
+    end
+  end
+end
+
+desc 'Run sanity tests without a full rebuild'
+task :sanity_only do
+  require_relative 'spec/samples/sanity.rb'
+  Sanity.new.run
+end
+
+desc 'Run full rebuild with sanity tests'
+task sanity: [:install, :spec, :sanity_only]
+
+desc 'Insert Google Analytics into documentation build'
+task :apply_google_analytics do
+  # The string to replace in the html document. This is chosen to be the end
+  # body </body> tag. So the script can be injected as the last thing in the
+  # document body.
+  string_to_replace = "</body>"
+  # This is the string to replace with. It include the google analytics script
+  # as well as the end </body> tag.
+  string_to_replace_with = <<-EOF
+    <script>
+      (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+      (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+      m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+      })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
+
+      ga('create', 'UA-54811605-1', 'auto');
+      ga('send', 'pageview');
+
+   </script>
+  </body>
+  EOF
+
+  files = Dir.glob("doc/**/*.html")
+
+  files.each do |html_file|
+    puts "Processing file: #{html_file}"
+    contents = ""
+    # Read the file contents
+    file =  File.open(html_file)
+    file.each { |line| contents << line }
+    file.close
+
+    # If the file already has google analytics tracking info, skip it.
+    if contents.include?(string_to_replace_with)
+      puts "Skipped..."
+      next
+    end
+
+    # Apply google analytics tracking info to the html file
+    contents.gsub!(string_to_replace, string_to_replace_with)
+
+    # Write the contents with the google analytics info to the file
+    file =  File.open(html_file, "w")
+    file.write(contents)
+    file.close
+  end
+end

data/appveyor.yml

@@ -0,0 +1,29 @@
+version: '{build}'
+
+skip_tags: true
+
+environment:
+  matrix:
+    - ruby_version: "200"
+    - ruby_version: "200-x64"
+    - ruby_version: "21"
+    - ruby_version: "21-x64"
+    - ruby_version: "22"
+    - ruby_version: "22-x64"
+
+install:
+  - SET PATH=C:\Ruby%ruby_version%\bin;%PATH%
+  - ruby --version
+  - gem --version
+  - gem install bundler --quiet --no-ri --no-rdoc
+  - bundler --version
+  - bundle install
+  - git submodule update --init --recursive
+
+test_script:
+  - rake
+
+artifacts:
+  - path: pkg\*.gem
+
+build: off

data/lib/squib.rb

@@ -1,32 +1,32 @@
-require 'logger'
-require 'cairo'
-require 'pango'
-require 'rsvg2'
-require 'squib/version'
-require 'squib/commands/new'
-require 'squib/deck'
-require 'squib/card'
-
-module Squib
-
-  # Access the internal logger that Squib uses. By default, Squib configure the logger to the WARN level
-  # Use this to suppress or increase output levels.
-  # @example
-  #   Squib.logger.level = Logger::DEBUG #show waaaay more information than you probably need, unless you're a dev
-  #   Squib.logger.level = Logger::ERROR #basically turns it off
-  #
-  # @return [Logger] the ruby logger
-  # @api public
-  def logger
-    if @logger.nil?
-      @logger = Logger.new($stdout)
-      @logger.level = Logger::WARN
-      @logger.formatter = proc do |severity, datetime, m_progname, msg|
-        "#{datetime} #{severity}: #{msg}\n"
-      end
-    end
-    @logger
-  end
-  module_function :logger
-
-end
+require 'logger'
+require 'cairo'
+require 'pango'
+require 'rsvg2'
+require 'squib/version'
+require 'squib/commands/new'
+require 'squib/deck'
+require 'squib/card'
+
+module Squib
+
+  # Access the internal logger that Squib uses. By default, Squib configure the logger to the WARN level
+  # Use this to suppress or increase output levels.
+  # @example
+  #   Squib.logger.level = Logger::DEBUG #show waaaay more information than you probably need, unless you're a dev
+  #   Squib.logger.level = Logger::ERROR #basically turns it off
+  #
+  # @return [Logger] the ruby logger
+  # @api public
+  def logger
+    if @logger.nil?
+      @logger = Logger.new($stdout)
+      @logger.level = Logger::WARN
+      @logger.formatter = proc do |severity, datetime, m_progname, msg|
+        "#{datetime} #{severity}: #{msg}\n"
+      end
+    end
+    @logger
+  end
+  module_function :logger
+
+end

data/lib/squib/api/background.rb

@@ -1,20 +1,20 @@
-module Squib
-  class Deck
-    # Fills the background with the given color
-    # @example
-    #   background color: :white
-    #
-    # Options support Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}
-    #
-    # @option opts range [Enumerable] (:all) the range of cards over which this will be rendered. See {file:README.md#Specifying_Ranges Specifying Ranges}
-    # @option opts color [String] (:black) the color the font will render to. See {file:README.md#Specifying_Colors___Gradients Specifying Colors & Gradients}.
-    # @return [nil] nothing
-    # @api public
-    def background(opts = {})
-      range = Args::CardRange.new(opts[:range], deck_size: size)
-      draw  = Args::Draw.new(custom_colors).load!(opts, expand_by: size, layout: layout, dpi: dpi)
-      range.each { |i| @cards[i].background(draw.color[i]) }
-    end
-
-  end
-end
+module Squib
+  class Deck
+    # Fills the background with the given color
+    # @example
+    #   background color: :white
+    #
+    # Options support Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}
+    #
+    # @option opts range [Enumerable] (:all) the range of cards over which this will be rendered. See {file:README.md#Specifying_Ranges Specifying Ranges}
+    # @option opts color [String] (:black) the color the font will render to. See {file:README.md#Specifying_Colors___Gradients Specifying Colors & Gradients}.
+    # @return [nil] nothing
+    # @api public
+    def background(opts = {})
+      range = Args::CardRange.new(opts[:range], deck_size: size)
+      draw  = Args::Draw.new(custom_colors).load!(opts, expand_by: size, layout: layout, dpi: dpi)
+      range.each { |i| @cards[i].background(draw.color[i]) }
+    end
+
+  end
+end

data/lib/squib/api/data.rb

@@ -1,131 +1,131 @@
-require 'roo'
-require 'csv'
-require 'squib/args/input_file'
-require 'squib/args/import'
-
-module Squib
-
-  # Pulls Excel data from `.xlsx` files into a column-based hash
-  #
-  # Pulls the data into a Hash of arrays based on the columns. First row is assumed to be the header row.
-  # See the example `samples/excel.rb` in the [source repository](https://github.com/andymeneely/squib/tree/master/samples)
-  #
-  # @example
-  #   # Excel file looks like this:
-  #   # | h1 | h2 |
-  #   # ------------
-  #   # | 1  | 2  |
-  #   # | 3  | 4  |
-  #   data = xlsx file: 'data.xlsx', sheet: 0
-  #   => {'h1' => [1,3], 'h2' => [2,4]}
-  #
-  # @option opts file [String]  the file to open. Must end in `.xlsx`. Opens relative to the current directory.
-  # @option opts sheet [Integer] (0) The zero-based index of the sheet from which to read.
-  # @option opts strip [Boolean] (true) When true, strips leading and trailing whitespace on values and headers
-  # @option opts explode [String] ('qty') Quantity explosion will be applied to the column this name. See README for example.
-  # @return [Hash] a hash of arrays based on columns in the spreadsheet
-  # @api public
-  def xlsx(opts = {})
-    input = Args::InputFile.new(file: 'deck.xlsx').load!(opts)
-    import = Args::Import.new.load!(opts)
-    s = Roo::Excelx.new(input.file[0])
-    s.default_sheet = s.sheets[input.sheet[0]]
-    data = {}
-    s.first_column.upto(s.last_column) do |col|
-      header = s.cell(s.first_row,col).to_s
-      header.strip! if import.strip?
-      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 (https://github.com/roo-rb/roo/issues/139)
-        cell = s.excelx_value(row,col) if s.excelx_type(row,col) == [:numeric_or_formula, 'General']
-        cell.strip! if cell.respond_to?(:strip) && import.strip?
-        cell = yield(header, cell) if block_given?
-        data[header] << cell
-      end#row
-    end#col
-    explode_quantities(data, import.explode)
-  end#xlsx
-  module_function :xlsx
-
-  # Pulls CSV data from `.csv` files into a column-based hash
-  #
-  # Pulls the data into a Hash of arrays based on the columns. First row is assumed to be the header row.
-  # See the example `samples/csv.rb` in the [source repository](https://github.com/andymeneely/squib/tree/master/samples)
-  #
-  # @example
-  #   # File data.csv looks like this (without the comment symbols)
-  #   # h1,h2
-  #   # 1,2
-  #   # 3,4
-  #   data = csv file: 'data.csv'
-  #   => {'h1' => [1,3], 'h2' => [2,4]}
-  #
-  # Parsing uses Ruby's CSV, with options `{headers: true, converters: :numeric}`
-  # http://www.ruby-doc.org/stdlib-2.0/libdoc/csv/rdoc/CSV.html
-  #
-  # @option opts file [String]  the CSV-formatted file to open. Opens relative to the current directory.
-  # @option opts strip [Boolean] (true) When true, strips leading and trailing whitespace on values and headers
-  # @option opts explode [String] ('qty') Quantity explosion will be applied to the column this name. See README for example.
-  # @return [Hash] a hash of arrays based on columns in the table
-  # @api public
-  def csv(opts = {})
-    file = Args::InputFile.new(file: 'deck.csv').load!(opts).file[0]
-    import = Args::Import.new.load!(opts)
-    table = CSV.read(file, headers: true, converters: :numeric)
-    check_duplicate_csv_headers(table)
-    hash = Hash.new
-    table.headers.each do |header|
-      new_header = header.to_s
-      new_header = new_header.strip if import.strip?
-      hash[new_header] ||= table[header]
-    end
-    if import.strip?
-      new_hash = Hash.new
-      hash.each do |header, col|
-        new_hash[header] = col.map { |str| str = str.strip if str.respond_to?(:strip); str }
-      end
-      hash = new_hash
-    end
-    return explode_quantities(hash, import.explode)
-  end
-  module_function :csv
-
-  # Check if the given CSV table has duplicate columns, and throw a warning
-  # @api private
-  def check_duplicate_csv_headers(table)
-    if table.headers.size != table.headers.uniq.size
-      dups = table.headers.select{|e| table.headers.count(e) > 1 }
-      Squib.logger.warn "CSV duplicated the following column keys: #{dups.join(',')}"
-    end
-  end
-  module_function :check_duplicate_csv_headers
-
-  def explode_quantities(data, qty)
-    return data unless data.key? qty.to_s.strip
-    qtys = data[qty]
-    new_data = {}
-    data.each do |col, arr|
-      new_data[col] = []
-      qtys.each_with_index do |qty, index|
-        qty.to_i.times { new_data[col] << arr[index] }
-      end
-    end
-    return new_data
-  end
-  module_function :explode_quantities
-
-  class Deck
-
-    # Convenience call on deck goes to the module function
-    def xlsx(opts = {})
-      Squib.xlsx(opts)
-    end
-
-    # Convenience call on deck goes to the module function
-    def csv(opts = {})
-      Squib.csv(opts)
-    end
-
-  end
-end
+require 'roo'
+require 'csv'
+require 'squib/args/input_file'
+require 'squib/args/import'
+
+module Squib
+
+  # Pulls Excel data from `.xlsx` files into a column-based hash
+  #
+  # Pulls the data into a Hash of arrays based on the columns. First row is assumed to be the header row.
+  # See the example `samples/excel.rb` in the [source repository](https://github.com/andymeneely/squib/tree/master/samples)
+  #
+  # @example
+  #   # Excel file looks like this:
+  #   # | h1 | h2 |
+  #   # ------------
+  #   # | 1  | 2  |
+  #   # | 3  | 4  |
+  #   data = xlsx file: 'data.xlsx', sheet: 0
+  #   => {'h1' => [1,3], 'h2' => [2,4]}
+  #
+  # @option opts file [String]  the file to open. Must end in `.xlsx`. Opens relative to the current directory.
+  # @option opts sheet [Integer] (0) The zero-based index of the sheet from which to read.
+  # @option opts strip [Boolean] (true) When true, strips leading and trailing whitespace on values and headers
+  # @option opts explode [String] ('qty') Quantity explosion will be applied to the column this name. See README for example.
+  # @return [Hash] a hash of arrays based on columns in the spreadsheet
+  # @api public
+  def xlsx(opts = {})
+    input = Args::InputFile.new(file: 'deck.xlsx').load!(opts)
+    import = Args::Import.new.load!(opts)
+    s = Roo::Excelx.new(input.file[0])
+    s.default_sheet = s.sheets[input.sheet[0]]
+    data = {}
+    s.first_column.upto(s.last_column) do |col|
+      header = s.cell(s.first_row,col).to_s
+      header.strip! if import.strip?
+      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 (https://github.com/roo-rb/roo/issues/139)
+        cell = s.excelx_value(row,col) if s.excelx_type(row,col) == [:numeric_or_formula, 'General']
+        cell.strip! if cell.respond_to?(:strip) && import.strip?
+        cell = yield(header, cell) if block_given?
+        data[header] << cell
+      end#row
+    end#col
+    explode_quantities(data, import.explode)
+  end#xlsx
+  module_function :xlsx
+
+  # Pulls CSV data from `.csv` files into a column-based hash
+  #
+  # Pulls the data into a Hash of arrays based on the columns. First row is assumed to be the header row.
+  # See the example `samples/csv.rb` in the [source repository](https://github.com/andymeneely/squib/tree/master/samples)
+  #
+  # @example
+  #   # File data.csv looks like this (without the comment symbols)
+  #   # h1,h2
+  #   # 1,2
+  #   # 3,4
+  #   data = csv file: 'data.csv'
+  #   => {'h1' => [1,3], 'h2' => [2,4]}
+  #
+  # Parsing uses Ruby's CSV, with options `{headers: true, converters: :numeric}`
+  # http://www.ruby-doc.org/stdlib-2.0/libdoc/csv/rdoc/CSV.html
+  #
+  # @option opts file [String]  the CSV-formatted file to open. Opens relative to the current directory.
+  # @option opts strip [Boolean] (true) When true, strips leading and trailing whitespace on values and headers
+  # @option opts explode [String] ('qty') Quantity explosion will be applied to the column this name. See README for example.
+  # @return [Hash] a hash of arrays based on columns in the table
+  # @api public
+  def csv(opts = {})
+    file = Args::InputFile.new(file: 'deck.csv').load!(opts).file[0]
+    import = Args::Import.new.load!(opts)
+    table = CSV.read(file, headers: true, converters: :numeric)
+    check_duplicate_csv_headers(table)
+    hash = Hash.new
+    table.headers.each do |header|
+      new_header = header.to_s
+      new_header = new_header.strip if import.strip?
+      hash[new_header] ||= table[header]
+    end
+    if import.strip?
+      new_hash = Hash.new
+      hash.each do |header, col|
+        new_hash[header] = col.map { |str| str = str.strip if str.respond_to?(:strip); str }
+      end
+      hash = new_hash
+    end
+    return explode_quantities(hash, import.explode)
+  end
+  module_function :csv
+
+  # Check if the given CSV table has duplicate columns, and throw a warning
+  # @api private
+  def check_duplicate_csv_headers(table)
+    if table.headers.size != table.headers.uniq.size
+      dups = table.headers.select{|e| table.headers.count(e) > 1 }
+      Squib.logger.warn "CSV duplicated the following column keys: #{dups.join(',')}"
+    end
+  end
+  module_function :check_duplicate_csv_headers
+
+  def explode_quantities(data, qty)
+    return data unless data.key? qty.to_s.strip
+    qtys = data[qty]
+    new_data = {}
+    data.each do |col, arr|
+      new_data[col] = []
+      qtys.each_with_index do |qty, index|
+        qty.to_i.times { new_data[col] << arr[index] }
+      end
+    end
+    return new_data
+  end
+  module_function :explode_quantities
+
+  class Deck
+
+    # Convenience call on deck goes to the module function
+    def xlsx(opts = {})
+      Squib.xlsx(opts)
+    end
+
+    # Convenience call on deck goes to the module function
+    def csv(opts = {})
+      Squib.csv(opts)
+    end
+
+  end
+end