lc3spec 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1f686a8679caa7f3110190bb0ee425e509626c98
-  data.tar.gz: 53041547c4ec8e20cbd53723f8adbf9619bfd0be
+  metadata.gz: 702d428ff4102c7ad87b31a65490bbee2e07af52
+  data.tar.gz: a96200247b660e91c42642b8a085bd7609fccf23
 SHA512:
-  metadata.gz: fd2f0ab0522bf867e8d9bff04160fb1a685ee06e958b26df5c6dd615bf3278c9fbc7ed46625ccafcb93829d1e377c9445b98e57461b1e20da4e670ac685afcaa
-  data.tar.gz: 9b2d49b370c77ef7753d84c5ead0bd047c1d7db968468a2f4584e29ceecbf84de4ee65e4b903655fec2ef05c866823a9a9d545dac4ca0dc52e173873878584d7
+  metadata.gz: 22cf5b67474d74a44a70ec88c9f87062009963176bce69968311446598ac2bcdecd0331fa3289eb4f6482152ace6bf618ba511161b2109cd4f7e6c272f8a8a7f
+  data.tar.gz: 300ce687d57e631811f47c636fcd35492358c306a90afd9df8ac938c7f6b7478eeb97d9cd713a639d2775badc7bace67cead4c68215801ed27d8e4c44bb6138e

data/README.md

@@ -2,10 +2,141 @@
 
 Testing and grading suite for LC-3 assembly programs
 
+# Description
+
+LC3Spec allows you to write tests for LC-3 assembly programs and run
+them in the lc3sim simulator. LC3Spec handles assembling code and
+creating temporary directories so that you don't have to.
+
+LC3Spec executes spec files that each describe a number of tests.
+Each test runs a new instance of lc3sim and allows you to interact
+with it programmatically.
+
+Consider the following assembly file, regs.asm, which is supposed to
+set registers R0, R1, R2, R3, and R4 to 0, 1, 2, 3, and 4, respectively:
+
+```
+    .ORIG x4000
+    AND R0, R0, 0
+    ADD R1, R0, 1
+    ADD R2, R0, 2
+    ADD R3, R0, 3
+    HALT
+    .END
+```
+
+We can write a spec, spec.rb, to test it:
+
+```ruby
+#!/usr/bin/env ruby
+
+require 'lc3spec'
+
+test 'Register Expectations' do
+  file 'regs'
+  set_breakpoint 'TRAP_HALT'
+  continue
+
+  expect_register R0, 0
+  expect_register R1, 1
+  expect_register R2, 2
+  expect_register R3, 3
+  expect_register R4, 4
+end
+```
+
+Running with `ruby spec.rb`:
+
+```
+Register Expectations [FAIL]
+  Incorrect R4: expected: x0004, actual: x0000
+```
+
+Oops, looks like we forgot to initialize R4. If we go back and add
+`ADD R4, R0, 4` to regs.asm and rerun the spec, we'll see:
+
+```
+Register Expectations [OK]
+```
+
+LC3Spec handles assembling files behind the scenes, a temporary directory
+is created to perform each test and all generated files (.obj, .sym) are
+discarded at the end of each test.
+
+## Configuration
+
+Configuration is performed by using `set :option, value`. Configuration
+changes can be enclosed in a `configure do ... end` block:
+
+```ruby
+configure do
+  set :output, 'feedback.txt'
+  set :keep_score, true
+end
+```
+
+There are currently two supported options:
+
+* :output - filename or file to write output to, default is $stdout
+* :keep_score - whether or not to display score for each test. If false,
+  only `[OK]` or `[FAIL]` are displayed, if true, a fractional score
+  is displayed, e.g., `0/1` or `4/4`
+
+An example:
+
+```ruby
+#!/usr/bin/env ruby
+
+require 'lc3spec'
+
+configure do
+  set :output, 'feedback.txt'
+  set :keep_score, true
+end
+
+test 'this is worth 1 point', 1 do
+  # ...
+end
+
+test 'this is worth 4 points', 4 do
+  # ...
+end
+
+test 'this should fail', 2 do
+  set_register R4, 'xFACE'
+  expect_register R4, 'xCAFE'
+end
+
+print_score
+```
+
+The print_score method prints the total score at the end of the file.
+Running the above spec will produce the following output in feedback.txt:
+
+```
+this is worth 1 point 1/1
+this is worth 4 points 4/4
+this should fail 0/2
+  Incorrect R4: expected: xCAFE, actual: xFACE
+
+Score: 5/7
+```
+
 # Requirements
 
 * [lc3tools for unix](http://highered.mcgraw-hill.com/sites/0072467509/student_view0/lc-3_simulator.html)
-* Ruby 2.0 (Does not work with 1.8.7, untested with 1.9.*)
+* Ruby 2.0.0 (Does not work with 1.8.7, untested with 1.9.*)
+
+# Install
+
+```
+gem install lc3spec
+```
+
+# TODO
+
+* Documentation
+* Tests
 
 # Bugs
 

data/bin/lc3spec

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+require 'lc3spec'
+
+if ARGV.empty?
+  puts "Usage: lc3spec <spec-file>"
+  exit false
+end
+
+ARGV.each do |arg|
+  if not File.readable? arg
+    raise ArgumentError, "Cannot open #{arg} for reading."
+  end
+end
+
+ARGV.each do |arg|
+  load arg
+end

data/lib/lc3spec/base.rb

@@ -96,9 +96,13 @@ module LC3Spec
 
     def method_missing(method_name, *arguments, &block)
       if @lc3.respond_to? method_name
-        @lc3.send(method_name, *arguments, &block)
+        res = @lc3.send(method_name, *arguments, &block)
 
-        self
+        if method_name.to_s =~ /^get_/
+          res
+        else
+          self
+        end
       elsif method_name.to_s =~ /^expect_/
         LC3Spec::Expectations.send(method_name, @lc3, @reporter, *arguments, &block)
 

data/lib/lc3spec/dsl.rb

@@ -1,11 +1,21 @@
 module LC3Spec
   module Dsl
-    def set(option, value = true)
-      @options ||= {
-        :output => $stdout,
-        :keep_score => false
-      }
+    def self.extended(base)
+      base.instance_eval do
+        @options ||= {
+          :output => $stdout,
+          :keep_score => false
+        }
+
+        @possible_points ||= 0
+        @earned_points ||= 0
+
+        @num_tests ||= 0
+        @num_passed ||= 0
+      end
+    end
 
+    def set(option, value = true)
       if option == :output
         case value
         when File
@@ -76,21 +86,15 @@ module LC3Spec
     end
 
     def count_points(result, possible)
-      @possible_points ||= 0
-      @earned_points ||= 0
-
       @earned_points += result == :pass ? possible : 0
       @possible_points += possible
 
-      @num_tests ||= 0
       @num_tests += 1
-
-      @num_passed ||= 0
       @num_passed += result == :pass ? 1 : 0
     end
 
     def print_score
-      return if @num_tests.nil? or (@num_tests == 0)
+      return if @num_tests == 0
 
       output = @options[:output]
 

data/lib/lc3spec/lc3.rb

@@ -41,11 +41,12 @@ class LC3
   end
 
   def get_register(reg)
+    reg = reg.to_s.upcase.to_sym  # Ruby 1.8 doesn't support Symbol#upcase
     @registers[reg]
   end
 
   def set_register(reg, val)
-    reg = reg.upcase # Don't use ! version because it doesn't work for symbols
+    reg = reg.to_s.upcase # Don't use ! version because it doesn't work for symbols
 
     unless @registers.keys.include? reg.to_sym
       raise "Invalid register: #{reg.to_s}"
@@ -195,8 +196,12 @@ class LC3
 
     # There is no signal that tells the GUI that output is ready...
     # FIXME: This is a bug waiting to happen
+    retries = 10
     until @output.ready?
-      sleep(0.01)
+      sleep(0.1)
+
+      retries -= 1
+      break if retries <= 0
     end
 
     while @output.ready?

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lc3spec
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Chun Yang
@@ -12,7 +12,8 @@ date: 2013-02-27 00:00:00.000000000 Z
 dependencies: []
 description: DSL for testing LC-3 assembly programs
 email: x@cyang.info
-executables: []
+executables:
+- lc3spec
 extensions: []
 extra_rdoc_files: []
 files:
@@ -26,6 +27,7 @@ files:
 - lib/lc3spec/lc3.rb
 - lib/lc3spec/main.rb
 - lib/lc3spec/reporter.rb
+- bin/lc3spec
 - LICENSE
 - README.md
 homepage: http://github.com/chunyang/lc3spec
@@ -40,7 +42,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
@@ -53,3 +55,4 @@ signing_key:
 specification_version: 4
 summary: Testing and grading suite for LC-3 assembly programs
 test_files: []
+has_rdoc: