rpicsim 0.2.5 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: afe68ca6fbd8c66eefc707b4927bbb453d2e37ef
-  data.tar.gz: fe03453f4ef52094c9f4bc7ec792c146ac1828a4
+  metadata.gz: bd4ff6f54bf53d46e52ab338f4cf495a099e2de5
+  data.tar.gz: 5f5dc6b5693fbaca9e88699a1e340fe9c36b11b1
 SHA512:
-  metadata.gz: e87d3ca4fbd555c4de565aaef804caf1214bb75cf0d742fd48ac0a2bedbca23dc974937e2ef731fd015b469a1d93c947345fa0c8b0bc3392606e16766ef65eb8
-  data.tar.gz: 5d07e1d1f9cf043b908477eba77f668205ea2460ff6df5e1484dd8e1743945c3533d0b31ca9f0c0dd4ec8e373e141d7a0ede172488cd7a1265e768b15190e67b
+  metadata.gz: 8effea68fe1786bf5d6517eaa6284827ff85867343de19ffd424ea81e1875175e92d8cd23ea4e0fa0504a890f0dacce649fa766e4e391bd0e8097393a2f40705
+  data.tar.gz: b9be314ea31c1885fa570386ab6e59ab94d0e9c7364d6a89bd4026891087d2722e9125c23aef5843445dd9c285da1014762c1f32facd6ec9ee0e4d1b0effafbb

data/Introduction.md

@@ -51,7 +51,7 @@ RPicSim is distributed as a Ruby gem named `rpicsim`.  To install RPicSim, run:
     jgem install rpicsim
 
 
-RPicSim has been tested with MPLAB X v1.85, v1.90, v1.95, v2.00, and v2.05.
+RPicSim has been tested with MPLAB X v1.85, v1.90, v1.95, v2.00, v2.05, and v2.10.
 However, it uses a lot of undocumented and internal features of the Microchip Java libraries, so it will probably need to be updated as new versions of MPLAB X are released.
 
 RPicSim is not intended to replace formal specifications, code reviews, and rigorous testing of your firmware on actual hardware.

data/README.md

@@ -53,7 +53,7 @@ RPicSim is distributed as a Ruby gem named `rpicsim`.  To install RPicSim, run:
     jgem install rpicsim
 
 
-RPicSim has been tested with MPLAB X v1.85, v1.90, v1.95, v2.00, and v2.05.
+RPicSim has been tested with MPLAB X v1.85, v1.90, v1.95, v2.00, v2.05, and v2.10.
 However, it uses a lot of undocumented and internal features of the Microchip Java libraries, so it will probably need to be updated as new versions of MPLAB X are released.
 
 RPicSim is not intended to replace formal specifications, code reviews, and rigorous testing of your firmware on actual hardware.

data/docs/KnownIssues.md

@@ -123,7 +123,7 @@ RAM watcher is useless because all of RAM seems to change on every step
 ----
 _Type: MPLAB X bug_
 
-_MPLAB X versions affected: 1.95, 2.00, 2.05_
+_MPLAB X versions affected: 1.95 and later_
 
 This issue is tested in `spec/mplab/memory_attach_spec.rb`.
 If you want to use the {file:RamWatcher.md RAM watcher}, you should use MPLAB X version 1.85 or 1.90.

data/docs/RSpecIntegration.md

@@ -113,7 +113,7 @@ This information can help when you are {file:Debugging.md debugging} issues.
 Better RSpec error messages
 ----
 
-RPicSim also overrides some of RSpec's error messages to be better.
+If you are using RSpec 2.x, RPicSim also overrides some of RSpec's error messages to be better.
 
 For example, instead of just saying an error message like "expected driving_high? to return true, got false", RSpec will actually say what object it called `driving_high?` on.
 This feature is important when you are using {file:PersistentExpectations.md persistent expectations} and want to know which expectation failed, because the stack trace will not help.

data/docs/SupportedMPLABXVersions.md

@@ -7,6 +7,7 @@ RPicSim uses code in MPLAB X to actually perform the PIC simulation.  Therefore,
 - 1.95
 - 2.00
 - 2.05
+- 2.10
 
 The different versions of MPLAB X have different problems that affect the simulation.  For more information, see the {file:KnownIssues.md Known issues page}.
 

data/lib/rpicsim/flaws.rb

@@ -51,27 +51,17 @@ module RPicSim
     add(:fr_memory_attach_useless) do |flaw|
       flaw.affects_version '1.85', false
       flaw.affects_version '1.90', false
-      flaw.affects_version '1.95', true
-      flaw.affects_version '2.00', true
-      flaw.affects_version '2.05', true
       flaw.probably_affects_other_versions true
     end
 
     add(:firmware_cannot_write_user_id0) do |flaw|
       flaw.affects_version '1.85', true
       flaw.affects_version '1.90', true
-      flaw.affects_version '1.95', false
-      flaw.affects_version '2.00', false
-      flaw.affects_version '2.05', false
       flaw.probably_affects_other_versions false
     end
 
     add(:adc_midrange) do |flaw|
       flaw.affects_version '1.85', :no_middle_values
-      flaw.affects_version '1.90', :bad_modulus
-      flaw.affects_version '1.95', :bad_modulus
-      flaw.affects_version '2.00', :bad_modulus
-      flaw.affects_version '2.05', :bad_modulus
       flaw.probably_affects_other_versions :bad_modulus
     end
 
@@ -80,8 +70,7 @@ module RPicSim
       flaw.affects_version '1.90', true
       flaw.affects_version '1.95', true
       flaw.affects_version '2.00', true
-      flaw.affects_version '2.05', false
-      flaw.probably_affects_other_versions :false
+      flaw.probably_affects_other_versions false
     end
   end
 end

data/lib/rpicsim/instruction.rb

@@ -205,6 +205,13 @@ module RPicSim
       transitions.map(&:next_address)
     end
 
+    # Returns true if this is actually a valid instruction.  Invalid
+    # instructions can occur when disassembling bytes that are not actually
+    # instructions.
+    def valid?
+      @valid
+    end
+
     private
 
     # For certain opcodes, this method gets over-written.
@@ -222,10 +229,6 @@ module RPicSim
       Transition.new(self, addr, @instruction_store, attrs)
     end
 
-    def valid?
-      @valid
-    end
-
     private
 
     # Returns the address indicated by the operand 'k'.

data/lib/rpicsim/rspec/be_predicate.rb

@@ -1,12 +1,17 @@
 # We override some parts of RSpec to provide better error messages.
+# This is only needed for RSpec 2.x, since th messages improved in RSpec 3.x
 # Instead of 'expected driving_high? to return true, got false' RSpec will actually
 # tell us what object it called driving_high on.
 class RSpec::Matchers::BuiltIn::BePredicate
-  def failure_message_for_should
-    "expected #{actual.inspect}.#{predicate}#{args_to_s} to return true, got #{@result.inspect}"
-  end
+  if instance_methods.include?(:failure_message_for_should)
+    # RSpec 2.x
+
+    def failure_message_for_should
+      "expected `#{actual.inspect}.#{predicate}#{args_to_s}` to return true, got #{@result.inspect}"
+    end
 
-  def failure_message_for_should_not
-    "expected #{actual.inspect}.#{predicate}#{args_to_s} to return false, got #{@result.inspect}"
+    def failure_message_for_should_not
+      "expected `#{actual.inspect}.#{predicate}#{args_to_s}` to return false, got #{@result.inspect}"
+    end
   end
 end

data/lib/rpicsim/rspec/sim_diagnostics.rb

@@ -1,51 +1,82 @@
 # If an example fails, store some diagnostic information about the state of the
 # simulation so we can print it later.
-RSpec.configure do |config|
-  config.after(:each) do
-    if @sim && example.exception
-      if @sim.respond_to? :cycle_count
-        example.metadata[:sim_cycle_count] = @sim.cycle_count
-      end
-      if @sim.respond_to? :stack_trace
-        example.metadata[:sim_stack_trace] = @sim.stack_trace
-      end
+
+module RPicSim::RSpec::SimDiagnostics
+  def self.store_diagnostics(example, sim)
+    if sim.respond_to? :cycle_count
+      example.metadata[:sim_cycle_count] = sim.cycle_count
+    end
+    if sim.respond_to? :stack_trace
+      example.metadata[:sim_stack_trace] = sim.stack_trace
     end
   end
-end
-
-require 'rspec/core/formatters/base_text_formatter'
-RSpec::Core::Formatters::BaseTextFormatter
 
-# We enhance rspec's backtrace so it will also show us the stack trace of the
-# simulation, if available.  These monkey patches are broken up into three
-# different functions so you can easily customize any of them without messing up
-# the other ones.
-class RSpec::Core::Formatters::BaseTextFormatter
-  alias_method :dump_backtrace_without_sim_diagnostics, :dump_backtrace
-
-  def dump_backtrace(example)
-    dump_backtrace_without_sim_diagnostics(example)
-    dump_sim_diagnostics(example)
+  def self.write_diagnostics(example, output, padding)
+    write_cycle_count(example, output, padding)
+    write_sim_stack_trace(example, output, padding)
   end
 
-  def dump_sim_diagnostics(example)
-    dump_sim_cycle_count(example)
-    dump_sim_stack_trace(example)
+  # Looks inside the metadata for the given RSpec example to see if a
+  # simulation stack trace was recorded.  If so, it outputs it with the
+  # appropriate indentation.
+  def self.write_sim_stack_trace(example, output, padding)
+    sim_stack_trace = example.metadata[:sim_stack_trace] or return
+    output.puts
+    output.puts padding + 'Simulation stack trace:'
+    sim_stack_trace.output(output, padding)
   end
 
-  def dump_sim_cycle_count(example)
+  def self.write_cycle_count(example, output, padding)
     cycle_count = example.metadata[:sim_cycle_count] or return
     output.puts
-    output.printf long_padding + "Simulation cycle count: %d\n", cycle_count
+    output.printf padding + "Simulation cycle count: %d\n", cycle_count
   end
+end
 
-  # Looks inside the metadata for the given RSpec example to see if a
-  # simulation stack trace was recorded.  If so, it outputs it with the
-  # appropriate indentation.
-  def dump_sim_stack_trace(example)
-    sim_stack_trace = example.metadata[:sim_stack_trace] or return
-    output.puts
-    output.puts long_padding + 'Simulation stack trace:'
-    sim_stack_trace.output(output, long_padding)
+RSpec.configure do |config|
+  config.after(:each) do
+    ex = if RSpec.respond_to?(:current_example)
+           RSpec.current_example  # RSpec 3.x and 2.99
+         else
+           example # RSpec 2.x
+         end
+    if @sim && ex.exception
+      RPicSim::RSpec::SimDiagnostics.store_diagnostics(example, @sim)
+    end
+  end
+end
+
+if defined?(RSpec::Core::Notifications)
+  # RSpec 3.x
+
+  require 'stringio'
+  class RSpec::Core::Notifications::FailedExampleNotification
+    alias_method :fully_formatted_without_sim_diagnostics, :fully_formatted
+    def fully_formatted(*args)
+      formatted = fully_formatted_without_sim_diagnostics(*args)
+      sio = StringIO.new
+      padding = '     '
+      RPicSim::RSpec::SimDiagnostics.write_diagnostics(example, sio, padding)
+      formatted << sio.string
+    end
+  end
+
+else
+  # RSpec 2.x
+
+  require 'rspec/core/formatters/base_text_formatter'
+  RSpec::Core::Formatters::BaseTextFormatter
+
+  # We enhance rspec's backtrace so it will also show us the stack trace of the
+  # simulation, if available.  These monkey patches are broken up into three
+  # different functions so you can easily customize any of them without messing up
+  # the other ones.
+  class RSpec::Core::Formatters::BaseTextFormatter
+    alias_method :dump_backtrace_without_sim_diagnostics, :dump_backtrace
+    def dump_backtrace(example)
+      dump_backtrace_without_sim_diagnostics(example)
+      RPicSim::RSpec::SimDiagnostics.write_diagnostics(example, output, long_padding)
+    end
   end
+
 end

data/lib/rpicsim/sim.rb

@@ -33,7 +33,7 @@ module RPicSim
       # You must call {#use_device} before calling this.
       def use_file(filename)
         raise "The device needs to be specified before filename (e.g. 'use_device \"PIC10F322\"')" unless @device
-        @filename = filename
+        @filename = filename.to_s
         load_program_file
       end
 

data/lib/rpicsim/version.rb

@@ -1,3 +1,3 @@
 module RPicSim
-  VERSION = '0.2.5'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rpicsim
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.3.0
 platform: ruby
 authors:
 - Pololu
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-05-02 00:00:00.000000000 Z
+date: 2014-06-20 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -16,50 +16,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/rpicsim.rb
-- lib/rpicsim/call_stack_info.rb
-- lib/rpicsim/composite_memory.rb
-- lib/rpicsim/flaws.rb
-- lib/rpicsim/instruction.rb
-- lib/rpicsim/label.rb
-- lib/rpicsim/memory.rb
-- lib/rpicsim/memory_watcher.rb
-- lib/rpicsim/mplab.rb
-- lib/rpicsim/pin.rb
-- lib/rpicsim/program_counter.rb
-- lib/rpicsim/program_file.rb
-- lib/rpicsim/rspec.rb
-- lib/rpicsim/search.rb
-- lib/rpicsim/sim.rb
-- lib/rpicsim/stack_pointer.rb
-- lib/rpicsim/stack_trace.rb
-- lib/rpicsim/variable.rb
-- lib/rpicsim/variable_set.rb
-- lib/rpicsim/version.rb
-- lib/rpicsim/mplab/mplab_assembly.rb
-- lib/rpicsim/mplab/mplab_device_info.rb
-- lib/rpicsim/mplab/mplab_disassembler.rb
-- lib/rpicsim/mplab/mplab_instruction.rb
-- lib/rpicsim/mplab/mplab_loader.rb
-- lib/rpicsim/mplab/mplab_memory.rb
-- lib/rpicsim/mplab/mplab_nmmr_info.rb
-- lib/rpicsim/mplab/mplab_observer.rb
-- lib/rpicsim/mplab/mplab_pin.rb
-- lib/rpicsim/mplab/mplab_processor.rb
-- lib/rpicsim/mplab/mplab_program_file.rb
-- lib/rpicsim/mplab/mplab_register.rb
-- lib/rpicsim/mplab/mplab_sfr_info.rb
-- lib/rpicsim/mplab/mplab_simulator.rb
-- lib/rpicsim/rspec/be_predicate.rb
-- lib/rpicsim/rspec/helpers.rb
-- lib/rpicsim/rspec/persistent_expectations.rb
-- lib/rpicsim/rspec/sim_diagnostics.rb
-- lib/rpicsim/storage/memory_integer.rb
-- lib/rpicsim/storage/register.rb
+- .yardopts
+- Gemfile
 - Introduction.md
 - LICENSE.txt
 - README.md
-- Gemfile
 - docs/ChangeLog.md
 - docs/Contributing.md
 - docs/Debugging.md
@@ -78,8 +39,8 @@ files:
 - docs/Pins.md
 - docs/PreventingCallStackOverflow.md
 - docs/QuickStartGuide.md
-- docs/RamWatcher.md
 - docs/RSpecIntegration.md
+- docs/RamWatcher.md
 - docs/Running.md
 - docs/Stubbing.md
 - docs/SupportedCompilers.md
@@ -88,7 +49,46 @@ files:
 - docs/SupportedOperatingSystems.md
 - docs/UnitTesting.md
 - docs/Variables.md
-- .yardopts
+- lib/rpicsim.rb
+- lib/rpicsim/call_stack_info.rb
+- lib/rpicsim/composite_memory.rb
+- lib/rpicsim/flaws.rb
+- lib/rpicsim/instruction.rb
+- lib/rpicsim/label.rb
+- lib/rpicsim/memory.rb
+- lib/rpicsim/memory_watcher.rb
+- lib/rpicsim/mplab.rb
+- lib/rpicsim/mplab/mplab_assembly.rb
+- lib/rpicsim/mplab/mplab_device_info.rb
+- lib/rpicsim/mplab/mplab_disassembler.rb
+- lib/rpicsim/mplab/mplab_instruction.rb
+- lib/rpicsim/mplab/mplab_loader.rb
+- lib/rpicsim/mplab/mplab_memory.rb
+- lib/rpicsim/mplab/mplab_nmmr_info.rb
+- lib/rpicsim/mplab/mplab_observer.rb
+- lib/rpicsim/mplab/mplab_pin.rb
+- lib/rpicsim/mplab/mplab_processor.rb
+- lib/rpicsim/mplab/mplab_program_file.rb
+- lib/rpicsim/mplab/mplab_register.rb
+- lib/rpicsim/mplab/mplab_sfr_info.rb
+- lib/rpicsim/mplab/mplab_simulator.rb
+- lib/rpicsim/pin.rb
+- lib/rpicsim/program_counter.rb
+- lib/rpicsim/program_file.rb
+- lib/rpicsim/rspec.rb
+- lib/rpicsim/rspec/be_predicate.rb
+- lib/rpicsim/rspec/helpers.rb
+- lib/rpicsim/rspec/persistent_expectations.rb
+- lib/rpicsim/rspec/sim_diagnostics.rb
+- lib/rpicsim/search.rb
+- lib/rpicsim/sim.rb
+- lib/rpicsim/stack_pointer.rb
+- lib/rpicsim/stack_trace.rb
+- lib/rpicsim/storage/memory_integer.rb
+- lib/rpicsim/storage/register.rb
+- lib/rpicsim/variable.rb
+- lib/rpicsim/variable_set.rb
+- lib/rpicsim/version.rb
 homepage: https://github.com/pololu/rpicsim
 licenses:
 - MIT
@@ -111,7 +111,7 @@ requirements:
 - JRuby
 - MPLAB X
 rubyforge_project:
-rubygems_version: 2.1.9
+rubygems_version: 2.3.0
 signing_key:
 specification_version: 4
 summary: RPicSim provides an interface to the MPLAB X PIC simulator that allows you to write simulator-based automated tests of PIC firmware with Ruby and RSpec.