@@ -1,101 +1,16 @@ -= Overview +** Beep ding clang ** -MSpec is a specialized framework that is syntax-compatible with RSpec for -basic things like +describe+, +it+ blocks and +before+, +after+ actions. MSpec -contains additional features that assist in writing the RubySpecs used by -multiple Ruby implementations. +We're sorry, the git repository you are trying to reach has been +disconnected. Please hang up and try this repository instead: -MSpec attempts to use the simplest Ruby language features so that beginning -Ruby implementations can run the Ruby specs. So, for example, there is not -great concern given to constant clashes. Namespacing (or module scoping) is -not used because implementing this correctly took a significant amount of work -in Rubinius and it is likely that other implementations would also face -difficulties. + http://github.com/rubyspec/mspec/tree/master -MSpec is not intended as a replacement for RSpec. MSpec attempts to provide a -subset of RSpec's features in some cases and a superset in others. It does not -provide all the matchers, for instance. However, MSpec provides several -extensions to facilitate writing the Ruby specs in a manner compatible with -multiple Ruby implementations. +To clone the code if you are NOT a committer: -First, MSpec offers a set of guards to control execution of the specs. These -guards not only enable or disable execution but also annotate the specs with -additional information about why they are run or not run. Second, MSpec -provides a different shared spec implementation specifically designed to ease -writing specs for the numerous aliased methods in Ruby. The MSpec shared spec -implementation should not conflict with RSpec's own shared behavior facility. -Third, MSpec provides various helper methods to simplify some specs, for -example, creating temporary file names. Finally, MSpec has several specialized -runner scripts that includes a configuration facility with a default project -file and user-specific overrides. + git clone git://github.com/rubyspec/mspec.git mspec -Caveats: +To clone the code if you ARE a committer: -* Use RSpec to run the MSpec specs. There are no plans currently to make - the MSpec specs runnable by MSpec. -* Don't mock the #hash method as MSpec's Mock implementation uses Hash - internally. This can be replaced if necessary, but at this point there is no - compelling need to do so. + git clone git@github.com:rubyspec/mspec.git mspec - -== Architecture - - -== Matchers - -Matchers are additional aids for the verification process. The default -is of course to #should or #should_not using the #== operator and its -friends but the matchers add a new set of 'operators' to help in the -task. They reside in `mspec/matchers/`. There are two broad categories, -those that apply to an individual object and those that apply to a -block: - -=== Object - -- `base` implements the standard #==, #< #<= #>= #> and #=~ with their - normal semantics for the objects that you invoke them on. - -- `be_ancestor_of` is equivalent to checking `obj.ancestors.include?`. - -- `be_close` is a "delta" for floating-point math. Due to the very - nature of it, floating-point comparisons should never be treated as - exact. By default the tolerance is 0.00003 but it can be altered if - so desired. So `0.23154.should be_close(0.23157)` would succeed - (which is usually close enough for floating point unless you are - doing some scientific computing.) - -- `be_empty` checks `obj.empty?` - -- `be_kind_of` is equivalent to `obj.kind_of?` - -- `include` is `obj.include?` - -=== Block - -All of these should be applied to a block created with `lambda` or `proc`: - -- `complain` is probably clearer stated as `lambda {...}.should complain`; - it checks that the block issues a warning. The message can be checked - against either a String or a Regexp. - -- `output` checks that the block produces the given output (stdout as well - as stderr, in that order) matched either to a String or a Regexp. This one - uses overrides so if that is a problem (for e.g. speccing Readline or - something) see below. - -- `output_to_fd` is a lower-level version and actually verifies that output - to a certain file descriptor is correct whether from an in-/output stream - or an actual file. Also can check with either a String or a Regexp. - -- `raise_error` verifies the exception type (if any) raised by the block it - is associated with. The exception class can be given for finer-grained - control (inheritance works normally so Exception would catch everything.) - - -== Guards - - -== Helpers - - -== Runners +Have a nice day! README LICENSE Rakefile bin/mkspec bin/mspec bin/mspec-ci bin/mspec-run bin/mspec-tag lib/mspec.rb lib/mspec/commands/mkspec.rb lib/mspec/commands/mspec-ci.rb lib/mspec/commands/mspec-run.rb lib/mspec/commands/mspec-tag.rb lib/mspec/commands/mspec.rb lib/mspec/expectations.rb lib/mspec/expectations/expectations.rb lib/mspec/expectations/should.rb lib/mspec/guards.rb lib/mspec/guards/bug.rb lib/mspec/guards/compliance.rb lib/mspec/guards/conflict.rb lib/mspec/guards/endian.rb lib/mspec/guards/extensions.rb lib/mspec/guards/guard.rb lib/mspec/guards/noncompliance.rb lib/mspec/guards/platform.rb lib/mspec/guards/quarantine.rb lib/mspec/guards/runner.rb lib/mspec/guards/superuser.rb lib/mspec/guards/support.rb lib/mspec/guards/version.rb lib/mspec/helpers.rb lib/mspec/helpers/bignum.rb lib/mspec/helpers/const_lookup.rb lib/mspec/helpers/flunk.rb lib/mspec/helpers/io.rb lib/mspec/helpers/scratch.rb lib/mspec/helpers/tmp.rb lib/mspec/matchers.rb lib/mspec/matchers/base.rb lib/mspec/matchers/be_ancestor_of.rb lib/mspec/matchers/be_close.rb lib/mspec/matchers/be_empty.rb lib/mspec/matchers/be_false.rb lib/mspec/matchers/be_kind_of.rb lib/mspec/matchers/be_nil.rb lib/mspec/matchers/be_true.rb lib/mspec/matchers/complain.rb lib/mspec/matchers/eql.rb lib/mspec/matchers/equal.rb lib/mspec/matchers/equal_utf16.rb lib/mspec/matchers/include.rb lib/mspec/matchers/output.rb lib/mspec/matchers/output_to_fd.rb lib/mspec/matchers/raise_error.rb lib/mspec/mocks.rb lib/mspec/mocks/mock.rb lib/mspec/mocks/object.rb lib/mspec/mocks/proxy.rb lib/mspec/runner.rb lib/mspec/runner/actions.rb lib/mspec/runner/actions/debug.rb lib/mspec/runner/actions/filter.rb lib/mspec/runner/actions/gdb.rb lib/mspec/runner/actions/tag.rb lib/mspec/runner/actions/tally.rb lib/mspec/runner/actions/timer.rb lib/mspec/runner/filters.rb lib/mspec/runner/filters/match.rb lib/mspec/runner/filters/profile.rb lib/mspec/runner/filters/regexp.rb lib/mspec/runner/filters/tag.rb lib/mspec/runner/formatters.rb lib/mspec/runner/formatters/dotted.rb lib/mspec/runner/formatters/html.rb lib/mspec/runner/formatters/specdoc.rb lib/mspec/runner/formatters/spinner.rb lib/mspec/runner/formatters/summary.rb lib/mspec/runner/formatters/unit.rb lib/mspec/runner/formatters/yaml.rb lib/mspec/runner/mspec.rb lib/mspec/runner/object.rb lib/mspec/runner/shared.rb lib/mspec/runner/state.rb lib/mspec/runner/tag.rb lib/mspec/utils/name_map.rb lib/mspec/utils/options.rb lib/mspec/utils/script.rb lib/mspec/version.rb mspec-1.0.0.gemspec spec/commands/mkspec_spec.rb spec/commands/mspec_ci_spec.rb spec/commands/mspec_run_spec.rb spec/commands/mspec_spec.rb spec/commands/mspec_tag_spec.rb spec/expectations/expectations_spec.rb spec/expectations/should_spec.rb spec/guards/bug_spec.rb spec/guards/compliance_spec.rb spec/guards/conflict_spec.rb spec/guards/endian_spec.rb spec/guards/extensions_spec.rb spec/guards/guard_spec.rb spec/guards/noncompliance_spec.rb spec/guards/platform_spec.rb spec/guards/quarantine_spec.rb spec/guards/runner_spec.rb spec/guards/superuser_spec.rb spec/guards/support_spec.rb spec/guards/version_spec.rb spec/helpers/bignum_spec.rb spec/helpers/const_lookup_spec.rb spec/helpers/flunk_spec.rb spec/helpers/io_spec.rb spec/helpers/scratch_spec.rb spec/helpers/tmp_spec.rb spec/matchers/base_spec.rb spec/matchers/be_ancestor_of_spec.rb spec/matchers/be_close_spec.rb spec/matchers/be_empty_spec.rb spec/matchers/be_false_spec.rb spec/matchers/be_kind_of_spec.rb spec/matchers/be_nil_spec.rb spec/matchers/be_true_spec.rb spec/matchers/complain_spec.rb spec/matchers/eql_spec.rb spec/matchers/equal_spec.rb spec/matchers/equal_utf16_spec.rb spec/matchers/include_spec.rb spec/matchers/output_spec.rb spec/matchers/output_to_fd_spec.rb spec/matchers/raise_error_spec.rb spec/mocks/mock_spec.rb spec/mocks/proxy_spec.rb spec/runner/actions/debug_spec.rb spec/runner/actions/filter_spec.rb spec/runner/actions/gdb_spec.rb spec/runner/actions/tag_spec.rb spec/runner/actions/tally_spec.rb spec/runner/actions/timer_spec.rb spec/runner/filters/a.yaml spec/runner/filters/b.yaml spec/runner/filters/match_spec.rb spec/runner/filters/profile_spec.rb spec/runner/filters/regexp_spec.rb spec/runner/filters/tag_spec.rb spec/runner/formatters/dotted_spec.rb spec/runner/formatters/html_spec.rb spec/runner/formatters/specdoc_spec.rb spec/runner/formatters/spinner_spec.rb spec/runner/formatters/summary_spec.rb spec/runner/formatters/unit_spec.rb spec/runner/formatters/yaml_spec.rb spec/runner/mspec_spec.rb spec/runner/shared_spec.rb spec/runner/state_spec.rb spec/runner/tag_spec.rb spec/runner/tags.txt spec/spec_helper.rb spec/utils/name_map_spec.rb spec/utils/options_spec.rb spec/utils/script_spec.rb c4affad54958e5bc9b1fd3cb573e6514abf16c0d Brian Ford bford@engineyard.com http://github.com/brixen/mspec/commit/ac13cf9efba814e961929155628c9a1d89ab54fb ac13cf9efba814e961929155628c9a1d89ab54fb 2008-06-02T12:31:42-07:00 2008-06-02T12:31:42-07:00 Remove code and redirect folks to new repository. 57e1549cd6e555e8ed137b8e79ee8fecf121ed6e Brian Ford bford@engineyard.com