mspec 1.5.16 → 1.5.17

data/Rakefile

@@ -18,7 +18,7 @@ spec = Gem::Specification.new do |s|
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors                   = ["Brian Ford"]
-  s.date                      = %q{2010-02-08}
+  s.date                      = %q{2010-03-13}
   s.email                     = %q{bford@engineyard.com}
   s.has_rdoc                  = true
   s.extra_rdoc_files          = %w[ README LICENSE ]

data/bin/mkspec

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-$:.unshift File.expand_path(File.dirname(__FILE__) + '/../lib')
+$:.unshift File.expand_path('../../lib', __FILE__)
 
 require 'mspec/commands/mkspec'
 

data/bin/mspec

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-$:.unshift File.expand_path(File.dirname(__FILE__) + '/../lib')
+$:.unshift File.expand_path('../../lib', __FILE__)
 
 require 'mspec/commands/mspec'
 

data/bin/mspec-ci

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-$:.unshift File.expand_path(File.dirname(__FILE__) + '/../lib')
+$:.unshift File.expand_path('../../lib', __FILE__)
 
 require 'mspec/commands/mspec-ci'
 require 'mspec'

data/bin/mspec-run

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-$:.unshift File.expand_path(File.dirname(__FILE__) + '/../lib')
+$:.unshift File.expand_path('../../lib', __FILE__)
 
 require 'mspec/commands/mspec-run'
 require 'mspec'

data/bin/mspec-tag

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-$:.unshift File.expand_path(File.dirname(__FILE__) + '/../lib')
+$:.unshift File.expand_path('../../lib', __FILE__)
 
 require 'mspec/commands/mspec-tag'
 require 'mspec'

data/lib/mspec/commands/mkspec.rb

@@ -16,13 +16,14 @@ class MkSpec
     @config = {
       :constants => [],
       :requires  => [],
-      :base      => "spec/ruby/1.8/core"
+      :base      => "core",
+      :version   => nil
     }
-    @map = NameMap.new
+    @map = NameMap.new true
   end
 
   def options(argv=ARGV)
-    options = MSpecOptions.new "mkspec [options]"
+    options = MSpecOptions.new "mkspec [options]", 32
 
     options.on("-c", "--constant", "CONSTANT",
                "Class or Module to generate spec stubs for") do |name|
@@ -36,6 +37,10 @@ class MkSpec
                "A library to require") do |file|
       config[:requires] << file
     end
+    options.on("-V", "--version-guard", "VERSION",
+               "Specify version for ruby_version_is guards") do |version|
+      config[:version] = version
+    end
     options.version MSpec::VERSION
     options.help
 
@@ -45,7 +50,7 @@ class MkSpec
     options.doc "   2. To create spec stubs for Fixnum\n"
     options.doc "     $ mkspec -c Fixnum\n"
     options.doc "   3. To create spec stubs for Complex in 'superspec/complex'\n"
-    options.doc "     $ mkspec -c Complex -rcomplex -b superspec"
+    options.doc "     $ mkspec -c Complex -r complex -b superspec"
     options.doc ""
 
     options.parse argv
@@ -71,13 +76,24 @@ class MkSpec
     parents = '../' * ($1.split('/').length + 1)
 
     File.open file, 'w' do |f|
-      f.puts "require File.dirname(__FILE__) + '/#{parents}spec_helper'"
+      f.puts "require File.expand_path('../#{parents}spec_helper', __FILE__)"
       config[:requires].each do |lib|
         f.puts "require '#{lib}'"
       end
     end
   end
 
+  def write_version(f)
+    f.puts ""
+    if version = config[:version]
+      f.puts "ruby_version_is #{version} do"
+      yield "  "
+      f.puts "end"
+    else
+      yield ""
+    end
+  end
+
   def write_spec(file, meth, exists)
     if exists
       out = `#{ruby} #{MSPEC_HOME}/bin/mspec-run --dry-run -fs -e '#{meth}' #{file}`
@@ -85,12 +101,13 @@ class MkSpec
     end
 
     File.open file, 'a' do |f|
-      f.puts <<-EOS
-
-describe "#{meth}" do
-  it "needs to be reviewed for spec completeness"
-end
+      write_version(f) do |indent|
+        f.puts <<-EOS
+#{indent}describe "#{meth}" do
+#{indent}  it "needs to be reviewed for spec completeness"
+#{indent}end
 EOS
+      end
     end
 
     puts file
@@ -107,7 +124,7 @@ EOS
   def run
     config[:requires].each { |lib| require lib }
     constants = config[:constants]
-    constants = @map.filter(Object.constants) if constants.empty?
+    constants = Object.constants if constants.empty?
 
     @map.map({}, constants).each do |mod, methods|
       name = mod.chop

data/lib/mspec/guards.rb

@@ -11,6 +11,7 @@ require 'mspec/guards/noncompliance'
 require 'mspec/guards/platform'
 require 'mspec/guards/quarantine'
 require 'mspec/guards/runner'
+require 'mspec/guards/specified'
 require 'mspec/guards/support'
 require 'mspec/guards/superuser'
 require 'mspec/guards/tty'

data/lib/mspec/guards/specified.rb

@@ -0,0 +1,66 @@
+require 'mspec/guards/guard'
+
+class UnspecifiedGuard < SpecGuard
+  def match?
+    not standard?
+  end
+end
+
+class SpecifiedOnGuard < SpecGuard
+  def match?
+    if @args.include? :ruby
+      raise Exception, "improper use of specified_on guard"
+    end
+    not standard? and implementation?(*@args)
+  end
+end
+
+class Object
+  # This guard wraps one or more #specified_on guards to group them and
+  # document the specs. The purpose of the guard is for situations where MRI
+  # either does not specify Ruby behavior or where MRI's behavior is all but
+  # impossible to spec, for example due to relying on platform-specific
+  # behavior that is not easily testable from Ruby code. In such cases, it
+  # may be desirable for implementations to explore a specified set of
+  # behaviors that are explicitly documented in the specs.
+  #
+  #   unspecified do
+  #     specified_on :rubinius, :ironruby do
+  #       it "returns true when passed :foo" do
+  #         # ...
+  #       end
+  #
+  #       it "returns false when passed :bar" do
+  #         # ...
+  #       end
+  #     end
+  #
+  #     specified_on :jruby do
+  #       it "returns true when passed :bar" do
+  #         # ...
+  #       end
+  #     end
+  #   end
+  #
+  # Note that these guards do not change the policy of the #compliant_on,
+  # #not_compliant_on, #deviates_on, #extended_on, and #not_supported_on
+  # guards.
+  #
+  def unspecified
+    g = UnspecifiedGuard.new
+    g.name = :unspecified
+    yield if g.yield?
+  ensure
+    g.unregister
+  end
+
+  # This guard wraps specs for one or more particular implementations. See the
+  # #unspecified guard for further documentation.
+  def specified_on(*args)
+    g = SpecifiedOnGuard.new(*args)
+    g.name = :specified_on
+    yield if g.yield?
+  ensure
+    g.unregister
+  end
+end

data/lib/mspec/helpers/io.rb

@@ -19,3 +19,18 @@ class IOStub < String
     self
   end
 end
+
+class Object
+  # Creates a "bare" file descriptor (i.e. one that is not associated
+  # with any Ruby object). The file descriptor can safely be passed
+  # to IO.new without creating a Ruby object alias to the fd.
+  def new_fd(name, mode="w:utf-8")
+    IO.sysopen name, fmode(mode)
+  end
+
+  # Creates an IO instance for a temporary file name. The file
+  # must be deleted.
+  def new_io(name, mode="w:utf-8")
+    IO.new new_fd(name, fmode(mode))
+  end
+end

data/lib/mspec/mocks/mock.rb

@@ -156,7 +156,12 @@ module Mock
 
         if pass
           proxy.called
-          return proxy.returning
+
+          if proxy.raising?
+            raise proxy.raising
+          else
+            return proxy.returning
+          end
         end
       end
     end

data/lib/mspec/mocks/proxy.rb

@@ -24,9 +24,12 @@ class NumericMockObject < Numeric
 end
 
 class MockProxy
+  attr_reader :raising, :yielding
+
   def initialize(type=nil)
     @multiple_returns = nil
     @returning = nil
+    @raising   = nil
     @yielding  = []
     @arguments = :any_args
     @type      = type || :mock
@@ -122,15 +125,23 @@ class MockProxy
     self
   end
 
+  def and_raise(exception)
+    if exception.kind_of? String
+      @raising = RuntimeError.new exception
+    else
+      @raising = exception
+    end
+  end
+
+  def raising?
+    @raising != nil
+  end
+
   def and_yield(*args)
     @yielding << args
     self
   end
 
-  def yielding
-    @yielding
-  end
-
   def yielding?
     !@yielding.empty?
   end

data/lib/mspec/utils/name_map.rb

@@ -60,8 +60,14 @@ class NameMap
     MSpecScript
     MkSpec
     DTracer
+    Etc
+    FileUtils
+    MSpecOption
+    MSpecOptions
     NameMap
     OptionParser
+    RbConfig
+    SpecVersion
     YAML
   ]
 

data/lib/mspec/version.rb

@@ -1,5 +1,5 @@
 require 'mspec/utils/version'
 
 module MSpec
-  VERSION = SpecVersion.new "1.5.16"
+  VERSION = SpecVersion.new "1.5.17"
 end

data/spec/commands/mkspec_spec.rb

@@ -74,6 +74,30 @@ describe "The -r, --require LIBRARY option" do
   end
 end
 
+describe "The -V, --version-guard VERSION option" do
+  before :each do
+    @options = MSpecOptions.new
+    MSpecOptions.stub!(:new).and_return(@options)
+    @script = MkSpec.new
+    @config = @script.config
+  end
+
+  it "is enabled by #options" do
+    @options.stub!(:on)
+    @options.should_receive(:on).with("-V", "--version-guard", "VERSION",
+      an_instance_of(String))
+    @script.options
+  end
+
+  it "sets the version for the ruby_version_is guards to VERSION" do
+    ["-r", "--require"].each do |opt|
+      @config[:requires] = []
+      @script.options [opt, "libspec"]
+      @config[:requires].should include("libspec")
+    end
+  end
+end
+
 describe MkSpec, "#options" do
   before :each do
     @options = MSpecOptions.new
@@ -143,13 +167,13 @@ describe MkSpec, "#write_requires" do
   end
 
   it "writes the spec_helper require line" do
-    @file.should_receive(:puts).with("require File.dirname(__FILE__) + '/../../../spec_helper'")
+    @file.should_receive(:puts).with("require File.expand_path('../../../../spec_helper', __FILE__)")
     @script.write_requires("spec/core/tcejbo", "spec/core/tcejbo/inspect_spec.rb")
   end
 
   it "writes require lines for each library specified on the command line" do
     @file.stub!(:puts)
-    @file.should_receive(:puts).with("require File.dirname(__FILE__) + '/../../../spec_helper'")
+    @file.should_receive(:puts).with("require File.expand_path('../../../../spec_helper', __FILE__)")
     @file.should_receive(:puts).with("require 'complex'")
     @script.config[:requires] << 'complex'
     @script.write_requires("spec/core/tcejbo", "spec/core/tcejbo/inspect_spec.rb")
@@ -158,8 +182,7 @@ end
 
 describe MkSpec, "#write_spec" do
   before :each do
-    @file = mock("file")
-    @file.stub!(:puts)
+    @file = IOStub.new
     File.stub!(:open).and_yield(@file)
 
     @script = MkSpec.new
@@ -198,26 +221,40 @@ describe MkSpec, "#write_spec" do
   end
 
   it "writes a template spec to the file if the spec file does not exist" do
-    @file.should_receive(:puts)
+    @file.should_receive(:puts).twice
     @script.should_receive(:puts).with("spec/core/tcejbo/inspect_spec.rb")
     @script.write_spec("spec/core/tcejbo/inspect_spec.rb", "Object#inspect", false)
   end
 
   it "writes a template spec to the file if it exists but contains no spec for the method" do
     @response.should_receive(:=~).and_return(false)
-    @file.should_receive(:puts)
+    @file.should_receive(:puts).twice
     @script.should_receive(:puts).with("spec/core/tcejbo/inspect_spec.rb")
     @script.write_spec("spec/core/tcejbo/inspect_spec.rb", "Object#inspect", true)
   end
 
   it "writes a template spec" do
-    @file.should_receive(:puts).with(<<EOS)
+    @script.write_spec("spec/core/tcejbo/inspect_spec.rb", "Object#inspect", true)
+    @file.should == <<EOS
 
 describe "Object#inspect" do
   it "needs to be reviewed for spec completeness"
 end
 EOS
+  end
+
+  it "writes a template spec with version guard" do
+    @script.config[:version] = '""..."1.9"'
     @script.write_spec("spec/core/tcejbo/inspect_spec.rb", "Object#inspect", true)
+    @file.should == <<EOS
+
+ruby_version_is ""..."1.9" do
+  describe "Object#inspect" do
+    it "needs to be reviewed for spec completeness"
+  end
+end
+EOS
+
   end
 end
 
@@ -283,14 +320,6 @@ describe MkSpec, "#run" do
     @script.run
   end
 
-  it "creates a map of Object.constants if not constants are specified" do
-    @script.config[:constants] = []
-    Object.stub!(:constants).and_return(["Object"])
-    @map.should_receive(:filter).with(["Object"]).and_return(["Object"])
-    @map.should_receive(:map).with({}, ["Object"]).and_return({})
-    @script.run
-  end
-
   it "calls #create_directory for each class/module in the map" do
     @script.should_receive(:create_directory).with("MkSpec").twice
     @script.run

data/spec/guards/specified_spec.rb

@@ -0,0 +1,102 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+require 'mspec/guards/specified'
+
+describe Object, "#unspecified" do
+  before :each do
+    ScratchPad.clear
+
+    @guard = UnspecifiedGuard.new
+    UnspecifiedGuard.stub!(:new).and_return(@guard)
+  end
+
+  it "does not yield if #standard? returns true" do
+    @guard.should_receive(:standard?).and_return(true)
+    unspecified { ScratchPad.record :yield }
+    ScratchPad.recorded.should be_nil
+  end
+
+  it "yields if #standard? returns false" do
+    @guard.should_receive(:standard?).and_return(false)
+    unspecified { ScratchPad.record :yield }
+    ScratchPad.recorded.should == :yield
+  end
+
+  it "sets the name of the guard to :unspecified" do
+    @guard.should_receive(:standard?).and_return(true)
+    unspecified { }
+    @guard.name.should == :unspecified
+  end
+
+  it "calls #unregister even when an exception is raised in the guard block" do
+    guard = UnspecifiedGuard.new :rubinius
+    UnspecifiedGuard.stub!(:new).and_return(guard)
+    guard.should_receive(:match?).and_return(true)
+    guard.should_receive(:unregister)
+
+    lambda do
+      unspecified { raise Exception }
+    end.should raise_error(Exception)
+  end
+end
+
+describe Object, "#specified_on" do
+  before :each do
+    ScratchPad.clear
+  end
+
+  it "raises an Exception when passed :ruby" do
+    lambda {
+      specifed_on(:ruby) { ScratchPad.record :yield }
+    }.should raise_error(Exception)
+    ScratchPad.recorded.should_not == :yield
+  end
+
+  it "does not yield when #standard? returns true" do
+    guard = SpecifiedOnGuard.new
+    SpecifiedOnGuard.stub!(:new).and_return(guard)
+    guard.should_receive(:standard?).and_return(true)
+
+    specified_on(:rubinius) { ScratchPad.record :yield }
+    ScratchPad.recorded.should be_nil
+  end
+
+  it "does not yield when #standard? returns false and #implementation? returns false" do
+    guard = SpecifiedOnGuard.new :rubinius
+    SpecifiedOnGuard.stub!(:new).and_return(guard)
+    guard.should_receive(:standard?).and_return(false)
+    guard.should_receive(:implementation?).with(:rubinius).and_return(false)
+
+    specified_on(:rubinius) { ScratchPad.record :yield }
+    ScratchPad.recorded.should be_nil
+  end
+
+  it "yields when #standard? returns false and #implementation? returns true" do
+    guard = SpecifiedOnGuard.new :rubinius
+    SpecifiedOnGuard.stub!(:new).and_return(guard)
+    guard.should_receive(:standard?).and_return(false)
+    guard.should_receive(:implementation?).with(:rubinius).and_return(true)
+
+    specified_on(:rubinius) { ScratchPad.record :yield }
+    ScratchPad.recorded.should == :yield
+  end
+
+  it "sets the name of the guard to :specified_on" do
+    guard = SpecifiedOnGuard.new :rubinius
+    SpecifiedOnGuard.stub!(:new).and_return(guard)
+    guard.should_receive(:match?).and_return(false)
+
+    specified_on(:rubinius) { }
+    guard.name.should == :specified_on
+  end
+
+  it "calls #unregister even when an exception is raised in the guard block" do
+    guard = SpecifiedOnGuard.new :rubinius
+    SpecifiedOnGuard.stub!(:new).and_return(guard)
+    guard.should_receive(:match?).and_return(true)
+    guard.should_receive(:unregister)
+
+    lambda do
+      specified_on(:rubinius) { raise Exception }
+    end.should raise_error(Exception)
+  end
+end

data/spec/helpers/io_spec.rb

@@ -1,4 +1,7 @@
 require File.dirname(__FILE__) + '/../spec_helper'
+require 'mspec/helpers/io'
+require 'mspec/helpers/fs'
+require 'mspec/helpers/tmp'
 
 describe IOStub do
   before :each do
@@ -41,3 +44,56 @@ describe IOStub do
     @out.flush.should == @out
   end
 end
+
+describe Object, "#new_fd" do
+  before :each do
+    @name = tmp("io_specs")
+  end
+
+  after :each do
+    @io.close unless @io.closed?
+    rm_r @name
+  end
+
+  it "returns a Fixnum that can be used to create an IO instance" do
+    fd = new_fd @name
+    fd.should be_an_instance_of(Fixnum)
+
+    @io = IO.new fd
+    @io.sync = true
+    @io.print "io data"
+
+    IO.read(@name).should == "io data"
+  end
+end
+
+describe Object, "#new_io" do
+  before :each do
+    @name = tmp("io_specs.txt")
+  end
+
+  after :each do
+    @io.close if @io and !@io.closed?
+    rm_r @name
+  end
+
+  it "returns an IO instance" do
+    @io = new_io @name
+    @io.should be_an_instance_of(IO)
+  end
+
+  it "opens the IO for reading if passed 'r'" do
+    touch(@name) { |f| f.print "io data" }
+    @io = new_io @name, "r"
+    @io.read.should == "io data"
+    lambda { @io.puts "more data" }.should raise_error(IOError)
+  end
+
+  it "opens the IO for writing if passed 'w'" do
+    @io = new_io @name, "w"
+    @io.sync = true
+
+    @io.print "io data"
+    IO.read(@name).should == "io data"
+  end
+end

data/spec/mocks/mock_spec.rb

@@ -207,6 +207,8 @@ describe Mock, ".install_method" do
   end
 end
 
+class MockAndRaiseError < Exception; end
+
 describe Mock, ".verify_call" do
   before :each do
     MSpec.stub!(:actions)
@@ -304,6 +306,13 @@ describe Mock, ".verify_call" do
       Mock.verify_call(@mock, :method_call) {|*a|}
     }.should_not raise_error(SpecExpectationNotMetError)
   end
+
+  it "raises an exception when expected to" do
+    @proxy.and_raise(MockAndRaiseError)
+    lambda {
+      Mock.verify_call @mock, :method_call
+    }.should raise_error(MockAndRaiseError)
+  end
 end
 
 describe Mock, ".verify_count" do

data/spec/mocks/proxy_spec.rb

@@ -330,6 +330,29 @@ describe MockProxy, "#and_yield" do
   end
 end
 
+describe MockProxy, "#raising" do
+  before :each do
+    @proxy = MockProxy.new
+  end
+
+  it "returns nil by default" do
+    @proxy.raising.should be_nil
+  end
+
+  it "returns the exception object passed to #and_raise" do
+    exc = mock("exception")
+    @proxy.and_raise(exc)
+    @proxy.raising.should equal(exc)
+  end
+
+  it "returns an instance of RuntimeError when a String is passed to #and_raise" do
+    @proxy.and_raise("an error")
+    exc = @proxy.raising
+    exc.should be_an_instance_of(RuntimeError)
+    exc.message.should == "an error"
+  end
+end
+
 describe MockProxy, "#yielding" do
   before :each do
     @proxy = MockProxy.new

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mspec
 version: !ruby/object:Gem::Version 
-  version: 1.5.16
+  version: 1.5.17
 platform: ruby
 authors: 
 - Brian Ford
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-08 00:00:00 -08:00
+date: 2010-03-13 00:00:00 -08:00
 default_executable: 
 dependencies: []
 
@@ -47,6 +47,7 @@ files:
 - lib/mspec/guards/platform.rb
 - lib/mspec/guards/quarantine.rb
 - lib/mspec/guards/runner.rb
+- lib/mspec/guards/specified.rb
 - lib/mspec/guards/superuser.rb
 - lib/mspec/guards/support.rb
 - lib/mspec/guards/tty.rb
@@ -180,6 +181,7 @@ files:
 - spec/guards/platform_spec.rb
 - spec/guards/quarantine_spec.rb
 - spec/guards/runner_spec.rb
+- spec/guards/specified_spec.rb
 - spec/guards/superuser_spec.rb
 - spec/guards/support_spec.rb
 - spec/guards/tty_spec.rb