marmalade 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in marmalade.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Rusty Geldmacher
+
+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,63 @@
+# Marmalade
+
+A Ruby library for helping with the boring, mechanical part of Google Code Jam puzzles, letting you focus on solving the problem instead of setting up the scaffolding.
+
+Most Code Jam input files look like something like this:
+
+    100     # Number of test cases
+    5 3     # Some data about case 1, say a number then some numnber of lines to read next
+    123     # First line to read
+    456     # Second line to read
+    789     # Third line to read
+    9 8     # Start of test case 2
+    
+When beginning a puzzle, wouldn't it be nice to focus on what you need to do to solve it rather than messing with read in the file in the right increments, debugging it, and making sure its doing what you expect? This is where Marmalade comes in. It gives you tools to use in order to quickly get down to the work of solving the actual problem. After all, time is of the essence!
+
+## Installation
+
+Install via RubyGems:
+
+    $ gem install marmalade
+
+## Usage
+
+### Basic Usage
+
+Once you create a Ruby file for solving a Code Jam puzzle, simply require the Marmalade gem:
+
+    #!/usr/bin/env ruby
+    
+    require 'rubygems'
+    require 'marmalade'
+   
+Make the file executable and Marmalade is ready to do the dirty work for you. Say we have an input file like the one described above. The first number in each test case is called `k` and the second is `n`, which is the number of `lines` to read in for each puzzle. Assuming we have a method called `solve_case` that returns the result we're looking for, we can instruct Marmalade to read that for us like so:
+
+    Marmalade.jam(:file => 'input.txt') do
+      read :num_cases, :type => :int
+      test_cases do
+        read [:k, :n], :type => :int
+        read :lines, :count => @n
+        puts_res solve_case(@k, @lines)
+    end
+
+Marmalade reads in each line and will assign the values to instance variables that you specify. When the result is ready to be printed, calling `puts_res` will output the proper format that Code Jam usually requires, much like:
+
+    Case #1: 12
+    Case #2: 55
+    # and so on...
+
+### Other Stuff
+
+- --debug and puts_dbg
+_ --case
+- --step and run_case
+- reading with :split
+- reading strings
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,13 @@
+#!/usr/bin/env rake
+require 'rake'
+require 'rspec'
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+
+desc 'Default: run the specs'
+task :default => 'spec'
+
+desc "Run specs"
+RSpec::Core::RakeTask.new('spec') do |t|
+   t.pattern = 'spec/**/*_spec.rb'
+end

data/lib/marmalade/file_reader.rb

@@ -0,0 +1,52 @@
+module Marmalade
+  # A class to help parsing out values from a Code Jam input file
+  class FileReader
+    attr_accessor :file_handle
+
+    def initialize(file_handle)
+      self.file_handle = file_handle
+    end
+
+    # Reads the next values from the file and returns them as a hash
+    def read(assignments, options = {})
+      line_count = options[:count]
+      read_options = options.dup
+      if assignments.is_a?(Array)
+        read_options[:split] = true
+      end
+      lines = 1.upto(line_count || 1).map { read_line(file_handle, read_options) }
+      lines = line_count.nil? ? lines.first : lines
+      assign_results(assignments, lines)
+    end
+
+    private
+
+    def read_line(file_handle, options)
+      line = file_handle.gets.strip
+      integers = [:int, :integer].include?(options[:type])
+      if options[:split]
+        line_a = line.split(' ')
+        if integers
+          line_a = line_a.map(&:to_i)
+        end
+        line_a
+      elsif integers
+        line = line.to_i
+      else
+        line
+      end
+    end
+
+    def assign_results(assignments, lines)
+      Hash.new.tap do |assigns|
+        if assignments.is_a?(Symbol)
+          assigns[assignments] = lines
+        elsif assignments.is_a?(Array)
+          assignments.each_with_index do |var, i|
+            assigns[var] = lines[i]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/marmalade/puzzle.rb

@@ -0,0 +1,52 @@
+module Marmalade
+  class Puzzle
+    attr_accessor :reader
+
+    def initialize(file_reader, options = {})
+      @options = options.dup
+      @debug = (@options.delete(:debug) == true)
+      self.reader = file_reader
+    end
+
+    def read(assignments, options = {})
+      # TODO: Check if we're in a 'run_case' block, if so throw an error
+      options = @options.merge(options)
+      assigns = reader.read(assignments, options)
+      assigns.each do |k, v|
+        instance_variable_set("@#{k.to_s}", v)
+      end
+    end
+
+    def test_cases(options = {}, &block)
+      # TODO: Make sure @num_cases is set
+      options = options.merge(@options)
+      1.upto(@num_cases) do |case_num|
+        @case_num = case_num
+        instance_eval(&block)
+        return if options[:case] == case_num
+        STDIN.getc if options[:step]
+      end
+    end
+
+    def run_case(&block)
+      if @options[:case].nil? || @options[:case] == @case_num
+        instance_eval(&block)
+      end
+    end
+
+    def puts(*args)
+      puts_with_case(*args)
+    end
+
+    def puts_dbg(*args)
+      puts_with_case(*args) if @debug
+    end
+
+    private
+
+    def puts_with_case(*args)
+      print "Case ##{@case_num}: ", *args
+      print "\n"
+    end
+  end
+end

data/lib/marmalade/version.rb

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

data/lib/marmalade.rb

@@ -0,0 +1,30 @@
+require 'rubygems'
+require 'trollop'
+
+require 'marmalade/file_reader'
+require 'marmalade/puzzle'
+require 'marmalade/version'
+
+module Marmalade
+
+  def self.jam(options = {}, &block)
+    options = parse_options.merge(options)
+    File.open(options[:file], 'r') do |file|
+      reader = FileReader.new(file)
+      puzzle = Puzzle.new(reader, options)
+      puzzle.instance_eval(&block)
+    end
+  end
+
+  private
+
+  def self.parse_options
+    options = Trollop::options do
+      opt :file, "Input file to read", :short => 'f', :type => :string
+      opt :debug, "Debug mode", :short => 'd', :default => false
+      opt :step, "Step through each case", :short => 's', :default => false
+      opt :case, "Only run the given case", :short => 'c', :type => :integer, :default => nil
+    end
+  end
+
+end

data/marmalade.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/marmalade/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Rusty Geldmacher"]
+  gem.email         = ["russell.geldmacher@gmail.com"]
+  gem.description   = %q{Marmalade gives you ready-to-go parsing and other helpers for Google Code Jam puzzles}
+  gem.summary       = %q{Helper for Google Code Jam puzzles}
+  gem.homepage      = "http://www.github.com/rustygeldmacher/marmalade"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "marmalade"
+  gem.require_paths = ["lib"]
+  gem.version       = Marmalade::VERSION
+
+  gem.add_dependency 'trollop', '~>1.16.2'
+
+  gem.add_development_dependency 'rspec', '~>2.9.0'
+  gem.add_development_dependency 'mocha', '~>0.10.5'
+end

data/spec/fixtures/input_0.txt

@@ -0,0 +1,11 @@
+3
+1 2
+foo
+bar
+9 4
+a
+b
+c
+d
+3 1
+hello world

data/spec/marmalade/file_reader_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+
+describe Marmalade::FileReader do
+
+  context "reading strings" do
+    it "will read a line from a file handle" do
+      reader = build_reader("hello world")
+      reader.read(:foo).should == { :foo => "hello world" }
+    end
+
+    it "will read a line and split it into an array" do
+      reader = build_reader("a b c")
+      reader.read(:foo, :split => true).should == { :foo => ['a', 'b', 'c'] }
+    end
+
+    it "will read multiple values from a line" do
+      reader = build_reader("hello world")
+      reader.read([:foo, :bar]).should == { :foo => "hello", :bar => "world" }
+    end
+
+    it "will strip whitespace from the end of the line" do
+      reader = build_reader("\thello world   ")
+      reader.read(:foo).should == { :foo => "hello world" }
+    end
+  end
+
+  context "reading integers" do
+    it "will read an integer value from a file" do
+      reader = build_reader("9")
+      reader.read(:foo, :type => :int).should == { :foo => 9 }
+    end
+
+    it "will read multiple integer values from a line" do
+      reader = build_reader("15 22")
+      reader.read([:foo, :bar], :type => :int).should == { :foo => 15, :bar => 22 }
+    end
+
+    it "will read an array of integers from a line" do
+      reader = build_reader("1 2 3")
+      reader.read(:foo, :type => :int, :split => true).should == { :foo => [1, 2, 3] }
+    end
+  end
+
+  context "reading multiple lines" do
+    it "will read multiple lines into a value" do
+      reader = build_reader('a b', 'c d', 'e f')
+      reader.read(:foo, :count => 3).should == { :foo => ['a b', 'c d', 'e f'] }
+    end
+
+    it "will read multiple values and split them into arrays" do
+      reader = build_reader('a b', 'c', 'd e')
+      reader.read(:foo, :count => 3, :split => true).should == { :foo => [['a', 'b'], ['c'], ['d', 'e']] }
+    end
+
+    it "will read multiple lines of integers" do
+      reader = build_reader('1', '2', '3')
+      reader.read(:foo, :count => 3, :type => :int).should == { :foo => [1, 2, 3] }
+    end
+
+    it "will return an array of lines even if asking for one line" do
+      reader = build_reader('abc')
+      reader.read(:foo, :count => 1).should == { :foo => ['abc'] }
+    end
+  end
+
+  def build_reader(*lines)
+    seq = sequence('file_handle')
+    file_handle = mock('file_handle')
+    lines.each do |line|
+      file_handle.expects(:gets).in_sequence(seq).returns(line)
+    end
+    Marmalade::FileReader.new(file_handle)
+  end
+
+end

data/spec/marmalade/marmalade_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe Marmalade do
+
+  it "will coordinate opening and reading a file full of test cases" do
+    cases = {}
+    Marmalade.jam(:file => fixture_file('input_0.txt')) do
+      read :num_cases, :type => :int
+      test_cases do
+        read [:dummy, :n], :type => :int
+        read :lines, :count => @n
+        run_case do
+          cases[@case_num] = { :dummy => @dummy, :lines => @lines }
+        end
+      end
+    end
+    cases.should == { 1 => { :dummy => 1, :lines => ['foo', 'bar'] },
+                      2 => { :dummy => 9, :lines => ['a', 'b', 'c', 'd'] },
+                      3 => { :dummy => 3, :lines => ['hello world'] } }
+  end
+end

data/spec/marmalade/puzzle_spec.rb

@@ -0,0 +1,101 @@
+require 'spec_helper'
+
+describe Marmalade::Puzzle do
+
+  describe "#read" do
+    it "will pass the options to the reader and assign instance varialbes based on the results" do
+      reader = mock()
+      reader.expects(:read).with([:foo, :bar], { :a => 1, :b => 2}).returns({:foo => "a", :bar => 2})
+      puzzle = Marmalade::Puzzle.new(reader, :a => 1)
+      puzzle.read([:foo, :bar], :b => 2)
+      puzzle.instance_eval do
+        @foo.should == 'a'
+        @bar.should == 2
+      end
+    end
+  end
+
+  describe "#test_cases" do
+    it "will run through all the test cases" do
+      run_test_cases.should == [1, 2, 3]
+    end
+
+    it "will return after the specified case as part of support for run_case" do
+      run_test_cases(:case => 2).should == [1, 2]
+    end
+
+    it "will pause after each case if the :step option is set" do
+      STDIN.expects(:getc).times(3)
+      run_test_cases(:step => true)
+    end
+
+    def run_test_cases(options = {})
+      puzzle = Marmalade::Puzzle.new(mock('reader'))
+      puzzle.instance_eval do
+        @num_cases = 3
+      end
+      case_numbers = []
+      puzzle.test_cases(options) do
+        case_numbers << @case_num
+      end
+      case_numbers
+    end
+  end
+
+  describe "#run_case" do
+    before do
+      @puzzle = Marmalade::Puzzle.new(mock('file_reader'))
+    end
+
+    it "will evaluate the given block if no case options are specified" do
+      build_puzzle(3).run_case do
+        'foo'
+      end.should == 'foo'
+    end
+
+    it "will evaluate the block if the given case and the current case match" do
+      build_puzzle(3, :case => 3).run_case do
+        'foo'
+      end.should == 'foo'
+    end
+
+    it "will not evalulate the block if the case numbers don't match" do
+      build_puzzle(3, :case => 4).run_case do
+        'foo'
+      end.should be_nil
+    end
+  end
+
+  describe "#puts" do
+    it "will print the message along with the current case number" do
+      puzzle = build_puzzle(4)
+      puzzle.expects(:print).with("Case #4: ", "hello")
+      puzzle.expects(:print).with("\n")
+      puzzle.puts("hello")
+    end
+  end
+
+  describe "#puts_dbg" do
+    it "will print the message with the case number if in debug mode" do
+      puzzle = build_puzzle(4, :debug => true)
+      puzzle.expects(:print).with("Case #4: ", "hello")
+      puzzle.expects(:print).with("\n")
+      puzzle.puts_dbg('hello')
+    end
+
+    it "will not print the message if the puzzle isn't in debug mode" do
+      puzzle = build_puzzle(4)
+      puzzle.expects(:print).never
+      puzzle.puts_dbg('hello')
+    end
+  end
+
+  def build_puzzle(case_num, options = {})
+    puzzle = Marmalade::Puzzle.new(mock('file_reader'), options)
+    puzzle.instance_eval do
+      @case_num = case_num
+    end
+    puzzle
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'marmalade'
+
+RSpec.configure do |config|
+  config.mock_framework = :mocha
+end
+
+def fixture_file(file_name)
+  File.join(File.expand_path("../fixtures", __FILE__), file_name)
+end
+

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification 
+name: marmalade
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Rusty Geldmacher
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-03-28 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: trollop
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 83
+        segments: 
+        - 1
+        - 16
+        - 2
+        version: 1.16.2
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 43
+        segments: 
+        - 2
+        - 9
+        - 0
+        version: 2.9.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 61
+        segments: 
+        - 0
+        - 10
+        - 5
+        version: 0.10.5
+  type: :development
+  version_requirements: *id003
+description: Marmalade gives you ready-to-go parsing and other helpers for Google Code Jam puzzles
+email: 
+- russell.geldmacher@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/marmalade.rb
+- lib/marmalade/file_reader.rb
+- lib/marmalade/puzzle.rb
+- lib/marmalade/version.rb
+- marmalade.gemspec
+- spec/fixtures/input_0.txt
+- spec/marmalade/file_reader_spec.rb
+- spec/marmalade/marmalade_spec.rb
+- spec/marmalade/puzzle_spec.rb
+- spec/spec_helper.rb
+homepage: http://www.github.com/rustygeldmacher/marmalade
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Helper for Google Code Jam puzzles
+test_files: 
+- spec/fixtures/input_0.txt
+- spec/marmalade/file_reader_spec.rb
+- spec/marmalade/marmalade_spec.rb
+- spec/marmalade/puzzle_spec.rb
+- spec/spec_helper.rb
+has_rdoc: