scottkit 0.0.0 → 0.1.0

data/README

@@ -70,6 +70,17 @@ STILL TO DO
 * Tweak compiler to break actions when they need too many arguments as
 	well as when they need too many instructions.
 * Write tutorial scaffolding.
-* Other documentation.
-* Gem packaging.
+* Write other documentation, e.g. reference guide.
+* Ensure that the right files are built by rdoc.
+* Figure out where the changelog is supposed to be and what format is
+	standard.
+* Write blog entry about learning language vs. packaging culture
+* Move git repo to one of the standard places.
+
+
+CHANGES
+
+0.1.0	Add -p option to compile and play a game from source.
+
+0.0.0	Initial release.
 

data/Rakefile

@@ -6,7 +6,7 @@ begin
   Jeweler::Tasks.new do |gem|
     gem.name = "scottkit"
     gem.summary = "ScottKit is a toolkit for compiling, decompiling and playing adventure games in the Scott Adams format."
-    gem.description = %Q{TODO: longer description of your gem}
+    gem.description = gem.summary
     gem.email = "mike@miketaylor.org.uk"
     gem.homepage = "http://www.miketaylor.org.uk/tech/advent/scottkit/"
     gem.author = "Mike Taylor"

data/VERSION

@@ -1 +1 @@
-0.0.0
+0.1.0

data/bin/scottkit

@@ -6,6 +6,8 @@
 #       scottkit -c game.sck > game.sao  # compile
 #       scottkit game.sao  # play the game; or use scottfree game.sao
 #       scottkit -d game.sao  # decompile -- useful for cheating
+# And the --play-from-source shortcut does not need an object file:
+#       scottkit -p game.sck
 #
 # Other command-line arguments enable wizard commands, load saved
 # games, set random seeds and enable various kinds of debugging
@@ -14,16 +16,32 @@
 require 'optparse'
 require 'stringio'
 require 'scottkit/game'
+require 'scottkit/withio'
 
-compile, decompile = false, false
+
+def play(game)
+  # Decompile (and discard result) to get entity names resolved in
+  # right order.  This ensures that debugging output that uses these
+  # names will use them in the same way as decompiler output.
+  dummy = StringIO.new
+  game.decompile(dummy)
+  game.play
+end
+
+
+mode = :play
 options = {}
+compile, decompile, play_from_source = false, false, false
 opts = OptionParser.new do |x|
   x.banner = "Usage: #$0 [options] [<data-file>]"
   x.on("-c", "--compile", "Compile <data-file> instead of loading") {
-    compile = true
+    mode = :compile
   }
   x.on("-d", "--decompile", "Decompile instead of playing") {
-    decompile = true
+    mode = :decompile
+  }
+  x.on("-p", "--play-from-source", "Compile and play from source") {
+    mode = :play_from_source
   }
   x.on("-w", "--wizard", "Wizard mode (enabled debugging commands)") {
     options[:wizard_mode] = true
@@ -72,25 +90,28 @@ rescue
 end
 
 game = ScottKit::Game.new(options)
-if (compile)
+case mode
+when :play_from_source
+  f = StringIO.new
+  withIO(nil, f) do
+    if !game.compile_to_stdout(ARGV[0])
+      $stderr.puts "#$0: compilation failed: not playing"
+      exit 1
+    end
+  end
+  game.load(f.string)
+  play(game)
+when :compile
   if !game.compile_to_stdout(ARGV[0])
     $stderr.puts "#$0: compilation failed"
     exit 1
-  else
-    exit 0
   end
-end
-
-game.load(IO.read(ARGV[0]))
-if (decompile)
-  f = StringIO.new()
+when :decompile
+  game.load(IO.read(ARGV[0]))
+  f = StringIO.new
   game.decompile(f)
   print f.string
-else
-  # Decompile (and discard result) to get entity names resolved in
-  # right order.  This ensures that debugging output that uses these
-  # names will use them in the same way as decompiler output.
-  dummy = StringIO.new()
-  game.decompile(dummy)
-  game.play()
+when :play
+  game.load(IO.read(ARGV[0]))
+  play(game)
 end

data/test/test_canonicalise.rb

@@ -1,7 +1,7 @@
 require 'test/unit'
 require 'scottkit/game'
 require 'stringio'
-require_relative 'withio'
+require 'scottkit/withio'
 
 # The idea here is that we can start with a source file and compile it
 # once.  Decompiling the result will of course yield a different

data/test/test_compile.rb

@@ -1,7 +1,7 @@
 require 'test/unit'
 require 'scottkit/game'
 require 'stringio'
-require_relative 'withio'
+require 'scottkit/withio'
 
 class TestCompile < Test::Unit::TestCase #:nodoc:
   EXPECTED = [

data/test/test_play.rb

@@ -1,7 +1,7 @@
 require 'test/unit'
 require 'scottkit/game'
 require 'stringio'
-require_relative 'withio'
+require 'scottkit/withio'
 
 class TestPlay < Test::Unit::TestCase #:nodoc:
   def test_play_tutorial7; play("t7"); end

data/test/test_playadams.rb

@@ -2,7 +2,7 @@ require 'test/unit'
 require 'scottkit/game'
 require 'stringio'
 require 'digest/md5'
-require_relative 'withio'
+require 'scottkit/withio'
 
 class TestPlayAdams < Test::Unit::TestCase #:nodoc:
   def test_play_adams

data/test/test_save.rb

@@ -1,7 +1,7 @@
 require 'test/unit'
 require 'scottkit/game'
 require 'stringio'
-require_relative 'withio'
+require 'scottkit/withio'
 
 class TestSave < Test::Unit::TestCase #:nodoc:
   # Can't use a setup() method here as the two test-cases need the

data/test/withio_test.rb

@@ -11,7 +11,7 @@
 #	oldout is of class IO
 
 require 'stringio'
-require_relative 'withio'
+require 'scottkit/withio'
 
 saved = nil
 begin

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: scottkit
 version: !ruby/object:Gem::Version 
-  version: 0.0.0
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
 platform: ruby
 authors: 
 - Mike Taylor
@@ -13,7 +18,7 @@ date: 2010-02-28 00:00:00 +00:00
 default_executable: scottkit
 dependencies: []
 
-description: "TODO: longer description of your gem"
+description: ScottKit is a toolkit for compiling, decompiling and playing adventure games in the Scott Adams format.
 email: mike@miketaylor.org.uk
 executables: 
 - scottkit
@@ -29,7 +34,6 @@ files:
 - Rakefile
 - VERSION
 - bin/scottkit
-- bin/scottkit.rb
 - data/.gitignore
 - data/adams/.gitignore
 - data/adams/AdamsGames.zip
@@ -75,6 +79,7 @@ files:
 - lib/scottkit/decompile.rb
 - lib/scottkit/game.rb
 - lib/scottkit/play.rb
+- lib/scottkit/withio.rb
 - notes/Definition
 - notes/Definition.saved-game
 - notes/Definition.scottfree-1.14
@@ -86,10 +91,11 @@ files:
 - test/test_play.rb
 - test/test_playadams.rb
 - test/test_save.rb
-- test/withio.rb
 - test/withio_test.rb
 has_rdoc: true
 homepage: http://www.miketaylor.org.uk/tech/advent/scottkit/
+licenses: []
+
 post_install_message: 
 rdoc_options: 
 - --charset=UTF-8
@@ -99,20 +105,22 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.1
+rubygems_version: 1.3.6
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: ScottKit is a toolkit for compiling, decompiling and playing adventure games in the Scott Adams format.
 test_files: []
 

data/bin/scottkit.rb

@@ -1,96 +0,0 @@
-#!/usr/local/bin/ruby1.9 -w
-
-# Command-line driver for the ScottKit toolkit, allowing Scott
-# Adams-format adventure games to be compiled, decompiled and played.
-# The three basic modes are invoked as follows:
-#       scottkit -c game.sck > game.sao  # compile
-#       scottkit game.sao  # play the game; or use scottfree game.sao
-#       scottkit -d game.sao  # decompile -- useful for cheating
-#
-# Other command-line arguments enable wizard commands, load saved
-# games, set random seeds and enable various kinds of debugging
-# output: run <tt>scottkit -h</tt> for details.
-
-require 'optparse'
-require 'stringio'
-require 'scottkit/game'
-
-compile, decompile = false, false
-options = {}
-opts = OptionParser.new do |x|
-  x.banner = "Usage: #$0 [options] [<data-file>]"
-  x.on("-c", "--compile", "Compile <data-file> instead of loading") {
-    compile = true
-  }
-  x.on("-d", "--decompile", "Decompile instead of playing") {
-    decompile = true
-  }
-  x.on("-w", "--wizard", "Wizard mode (enabled debugging commands)") {
-    options[:wizard_mode] = true
-  }
-  x.on("-l", "--load-game FILE", "Load a previously saved game") { |file|
-    options[:restore_file] = file
-  }
-  x.on("-f", "--read-file FILE", "Read initial commands from file") { |file|
-    options[:read_file] = file
-  }
-  x.on("-e", "--echo", "Echo input commands to output") {
-    options[:echo_input] = true
-  }
-  x.on("-s", "--random-seed VAL", "Set random seed for repeatability") { |val|
-    options[:random_seed] = Integer(val)
-  }
-  x.on("-b", "--bug-tolerant", "Copy with out-of-range locations, etc.") {
-    options[:bug_tolerant] = true
-  }
-  x.on("-W", "--no-wait", "Do not wait on pause actions or death") {
-    options[:no_wait] = true
-  }
-  x.on("-T", "--show-tokens", "Show lexical tokens as they are read") {
-    options[:show_tokens] = true
-  }
-  x.on("-R", "--show-random", "Show rolls of the random dice") {
-    options[:show_random] = true
-  }
-  x.on("-P", "--show-parse", "Show results of parsing verb/noun") {
-    options[:show_parse] = true
-  }
-  x.on("-C", "--show-conditions", "Show conditions being evaluated") {
-    options[:show_conditions] = true
-  }
-  x.on("-I", "--show-instructions", "Show instructions being executed") {
-    options[:show_instructions] = true
-  }
-end
-
-begin
-  opts.parse!(ARGV)
-  raise "#$0: No data-file specified" if ARGV.size != 1
-rescue
-  $stderr.puts $!, opts
-  exit 1
-end
-
-game = ScottKit::Game.new(options)
-if (compile)
-  if !game.compile_to_stdout(ARGV[0])
-    $stderr.puts "#$0: compilation failed"
-    exit 1
-  else
-    exit 0
-  end
-end
-
-game.load(IO.read(ARGV[0]))
-if (decompile)
-  f = StringIO.new()
-  game.decompile(f)
-  print f.string
-else
-  # Decompile (and discard result) to get entity names resolved in
-  # right order.  This ensures that debugging output that uses these
-  # names will use them in the same way as decompiler output.
-  dummy = StringIO.new()
-  game.decompile(dummy)
-  game.play()
-end