gisele-vm 0.6.0

data/spec/unit/test_logging.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+module Gisele
+  class VM
+    describe Logging do
+      include Logging
+
+      context 'without logger' do
+
+        it 'does not fail when logging message' do
+          info("something").should be_a(NullObject)
+          fatal("an error occured").something_else.should be_a(NullObject)
+        end
+
+        it 'returns false on query methods' do
+          if info?
+            true.should be_false
+          end
+        end
+
+      end # without logger
+
+      context 'with a logger' do
+
+        before do
+          self.logger = Object.new
+          def logger.info?
+            true
+          end
+          def logger.info(msg)
+            @msg = msg.upcase
+          end
+        end
+
+        it 'delegates logging calls' do
+          info("something to log").should eq("SOMETHING TO LOG")
+        end
+
+        it 'delegates query methods' do
+          info?.should be_true
+        end
+
+      end # with a logger
+
+    end
+  end
+end

data/spec/unit/test_prog.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+class Gisele::VM
+  describe Prog do
+
+    let(:h){
+      { :puid     => "puid",
+        :parent   => "parent",
+        :root     => "root",
+        :pc       => 12,
+        :waitfor => :enacter,
+        :waitlist => {:a => true},
+        :input    => [ :event ] }
+    }
+
+    it 'has defaults' do
+      s = Prog.new
+      s.puid.should     be_nil
+      s.parent.should   be_nil
+      s.root.should     be_nil
+      s.pc.should       eq(:main)
+      s.waitfor.should  eq(:none)
+      s.waitlist.should eq({})
+      s.input.should    eq([])
+    end
+
+    it 'understands options' do
+      s = Prog.new(h)
+      s.puid.should     eq("puid")
+      s.parent.should   eq("parent")
+      s.root.should     eq("root")
+      s.pc.should       eq(12)
+      s.waitfor.should  eq(:enacter)
+      s.waitlist.should eq({:a => true})
+      s.input.should    eq([:event])
+    end
+
+    it 'provides a to_hash' do
+      s = Prog.new(h)
+      s.to_hash.should eq(h)
+    end
+
+    it 'provides value-equal duplication' do
+      s = Prog.new(:puid => 12, :waitlist => {:a => true})
+      s.dup.object_id.should_not eq(s.object_id)
+      s.dup.should eq(s)
+    end
+
+    it 'duplicates deeply' do
+      s = Prog.new(h)
+      s.dup.waitlist[:b] = false
+      s.waitlist.should eq({:a => true})
+      s.dup.input << :blih
+      s.input.should eq([:event])
+    end
+
+  end
+end

data/spec/unit/test_prog_list.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+module Gisele
+  class VM
+    describe ProgList do
+
+      context 'with a ruby memory storage' do
+        subject do
+          ProgList.new ProgList::Memory.new
+        end
+        it_should_behave_like "a component"
+      end
+
+      context 'with a sqldb storage' do
+        subject do
+          ProgList.new ProgList.storage("memory")
+        end
+        it_should_behave_like "a component"
+      end
+
+    end
+  end
+end

data/spec/unit/vm/test_event_facace.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+module Gisele
+  describe VM, "the event facade" do
+
+    it 'delegates event calls to it' do
+      vm.event(an_event)
+      observed_events.should eq([an_event])
+    end
+
+  end
+end

data/spec/unit/vm/test_initialize.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+module Gisele
+  describe VM, "initialize" do
+
+    after do
+      vm.should_not be_running
+      vm.status.should eq(:stopped)
+      vm.components[0].should be_a(VM::Kernel)
+      vm.components[1].should be_a(VM::ProgList)
+      vm.components[2].should be_a(VM::EventManager)
+    end
+
+    context 'without block' do
+      let(:vm){ VM.new }
+
+      it 'uses the kernel bytecode' do
+        vm.bytecode[:start].should_not be_nil
+      end
+
+      it 'installs a default logger' do
+        vm.logger.should be_a(Logger)
+      end
+
+      it 'installs a default event manager' do
+        vm.event_manager.should be_a(VM::EventManager)
+      end
+    end
+
+    context 'with a block' do
+      let(:em)  { VM::EventManager.new }
+      let(:list){ VM::ProgList.new VM::ProgList.storage("memory") }
+      let(:vm){
+        VM.new([:gvm, [:block, :hello, [:nop]]]) do |vm|
+          vm.proglist      = list
+          vm.logger        = nil
+          vm.event_manager = em
+        end
+      }
+
+      it 'merges the kernel bytecode and the provided one' do
+        vm.bytecode[:hello].should_not be_nil
+        vm.bytecode[:start].should_not be_nil
+      end
+
+      it 'installs the provided proglist' do
+        vm.proglist.should eq(list)
+      end
+
+      it 'installs the provided logger' do
+        vm.logger.should be_nil
+      end
+
+      it 'installs the provided event manager' do
+        vm.event_manager.should eq(em)
+      end
+    end
+
+  end
+end

data/spec/unit/vm/test_proglist_facade.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+module Gisele
+  describe VM, "the proglist facade" do
+
+    let(:vm){
+      VM.new do |vm|
+        vm.proglist = VM::ProgList.memory
+      end
+    }
+
+    before do
+      vm.connect
+    end
+
+    it 'delegates fetch/save calls to it' do
+      puid = vm.save(VM::Prog.new(:pc => :ping))
+      vm.fetch(puid).pc.should eq(:ping)
+    end
+
+  end
+end

data/tasks/debug_mail.rake

@@ -0,0 +1,75 @@
+# Installs a rake task for debuging the announcement mail.
+#
+# This file installs the 'rake debug_mail' that flushes an announcement mail
+# for your library on the standard output. It is automatically generated
+# by Noe from your .noespec file, and should therefore be configured there,
+# under the variables/rake_tasks/debug_mail entry, as illustrated below:
+#
+# variables:
+#   rake_tasks:
+#     debug_mail:
+#       rx_changelog_sections: /^#/
+#       nb_changelog_sections: 1
+#       ...
+#
+# If you have specific needs requiring manual intervention on this file,
+# don't forget to set safe-override to false in your noe specification:
+#
+# template-info:
+#   manifest:
+#     tasks/debug_mail.rake:
+#       safe-override: false
+#
+# The mail template used can be found in debug_mail.txt. That file may be
+# changed to tune the mail you want to send. If you do so, don't forget to
+# add a manifest entry in your .noespec file to avoid overriding you
+# changes. The mail template uses wlang, with parentheses for block
+# delimiters.
+#
+# template-info:
+#   manifest:
+#     tasks/debug_mail.txt:
+#       safe-override: false
+#
+desc "Debug the release announcement mail"
+task :debug_mail do
+  begin
+    require 'wlang'
+  rescue LoadError
+    abort "wlang is not available. Try 'gem install wlang'"
+  end
+  require 'yaml'
+
+  # Check that a .noespec file exists
+  noespec_file = File.expand_path('../../gisele-vm.noespec', __FILE__)
+  unless File.exists?(noespec_file)
+    raise "Unable to find .noespec project file, sorry."
+  end
+
+  # Load it as well as variables and options
+  noespec = YAML::load(File.read(noespec_file))
+  vars = noespec['variables'] || {}
+
+  # Changes are taken from CHANGELOG
+  logs = Dir[File.expand_path("../../CHANGELOG.*", __FILE__)]
+  unless logs.size == 1
+    abort "Unable to find a changelog file"
+  end
+
+  # Load interesting changesets
+  changes, end_found = [], 0
+  File.readlines(logs.first).select{|line|
+    if line =~ /^# /
+      break if end_found >= 1
+      end_found += 1
+    end
+    changes << line
+  }
+  vars['changes'] = changes.join
+
+  # WLang template
+  template = File.expand_path('../debug_mail.txt', __FILE__)
+
+  # Let's go!
+  $stdout << WLang::file_instantiate(template, vars, "wlang/active-text")
+end

data/tasks/debug_mail.txt

@@ -0,0 +1,13 @@
+Subject: [ANN] !{lower} !{version} Released
+
+!{lower} version !{version} has been released!
+
+!{summary}
+
+*{links as l}{* <!{l}>}{!{"\n"}}
+
+!{description}
+
+Changes:
+
+!{changes}

data/tasks/gem.rake

@@ -0,0 +1,73 @@
+# Installs rake tasks for gemming and packaging
+#
+# This file installs the 'rake package', 'rake gem' tasks and associates
+# (clobber_package, repackage, ...). It is automatically generated by Noe
+# from your .noespec file, and should therefore be configured there, under
+# the variables/rake_tasks/gem entry, as illustrated below:
+#
+# variables:
+#   rake_tasks:
+#     gem:
+#       package_dir: pkg
+#       need_tar: false
+#       need_tar_gz: false
+#       need_tar_bz2: false
+#       need_zip: false
+#       ...
+#
+# If you have specific needs requiring manual intervention on this file,
+# don't forget to set safe-override to false in your noe specification:
+#
+# template-info:
+#   manifest:
+#     tasks/gem.rake:
+#       safe-override: false
+#
+begin
+  require 'rubygems/package_task'
+
+  # Dynamically load the gem spec
+  gemspec_file = File.expand_path('../../gisele-vm.gemspec', __FILE__)
+  gemspec      = Kernel.eval(File.read(gemspec_file))
+
+  Gem::PackageTask.new(gemspec) do |t|
+
+    # Name of the package
+    t.name = gemspec.name
+
+    # Version of the package
+    t.version = gemspec.version
+
+    # Directory used to store the package files
+    t.package_dir = "pkg"
+
+    # True if a gzipped tar file (tgz) should be produced
+    t.need_tar = false
+
+    # True if a gzipped tar file (tar.gz) should be produced
+    t.need_tar_gz = false
+
+    # True if a bzip2'd tar file (tar.bz2) should be produced
+    t.need_tar_bz2 = false
+
+    # True if a zip file should be produced (default is false)
+    t.need_zip = false
+
+    # List of files to be included in the package.
+    t.package_files = gemspec.files
+
+    # Tar command for gzipped or bzip2ed archives.
+    t.tar_command = "tar"
+
+    # Zip command for zipped archives.
+    t.zip_command = "zip"
+
+  end
+rescue LoadError
+  task :gem do
+    abort 'rubygems/package_task is not available. You should verify your rubygems installation'
+  end
+  task :package do
+    abort 'rubygems/package_task is not available. You should verify your rubygems installation'
+  end
+end

data/tasks/spec_test.rake

@@ -0,0 +1,71 @@
+# Installs a rake task for for running examples written using rspec.
+#
+# This file installs the 'rake spec_test' (aliased as 'rake spec') as well as
+# extends 'rake test' to run spec tests, if any. It is automatically generated
+# by Noe from your .noespec file, and should therefore be configured there,
+# under the variables/rake_tasks/spec_test entry, as illustrated below:
+#
+# variables:
+#   rake_tasks:
+#     spec_test:
+#       pattern: spec/**/*_spec.rb
+#       verbose: true
+#       rspec_opts: [--color, --backtrace]
+#       ...
+#
+# If you have specific needs requiring manual intervention on this file,
+# don't forget to set safe-override to false in your noe specification:
+#
+# template-info:
+#   manifest:
+#     tasks/spec_test.rake:
+#       safe-override: false
+#
+# This file has been written to conform to RSpec v2.4.0. More information about
+# rspec and options of the rake task defined below can be found on
+# http://relishapp.com/rspec
+#
+begin
+  require "rspec/core/rake_task"
+  desc "Run RSpec code examples"
+  RSpec::Core::RakeTask.new(:spec_test) do |t|
+    # Glob pattern to match files.
+    t.pattern = "spec/**/test_*.rb"
+
+    # Whether or not to fail Rake when an error occurs (typically when
+    # examples fail).
+    t.fail_on_error = true
+
+    # A message to print to stderr when there are failures.
+    t.failure_message = nil
+
+    # Use verbose output. If this is set to true, the task will print the
+    # executed spec command to stdout.
+    t.verbose = true
+
+    # Use rcov for code coverage?
+    t.rcov = false
+
+    # Path to rcov.
+    t.rcov_path = "rcov"
+
+    # Command line options to pass to rcov. See 'rcov --help' about this
+    t.rcov_opts = []
+
+    # Command line options to pass to ruby. See 'ruby --help' about this
+    t.ruby_opts = []
+
+    # Path to rspec
+    t.rspec_path = "rspec"
+
+    # Command line options to pass to rspec. See 'rspec --help' about this
+    t.rspec_opts = ["--color", "--backtrace"]
+  end
+rescue LoadError => ex
+  task :spec_test do
+    abort 'rspec is not available. In order to run spec, you must: gem install rspec'
+  end
+ensure
+  task :spec => [:spec_test]
+  task :test => [:spec_test]
+end