yard 0.9.5 → 0.9.6

data/spec/registry_store_spec.rb

@@ -1,6 +1,6 @@
-require File.join(File.dirname(__FILE__), "spec_helper")
+# frozen_string_literal: true
 
-describe YARD::RegistryStore do
+RSpec.describe YARD::RegistryStore do
   before do
     FileUtils.rm_rf("foo")
     @store = RegistryStore.new
@@ -16,7 +16,7 @@ describe YARD::RegistryStore do
       expect(File).to receive(:file?).with('foo/checksums').and_return(false)
       expect(File).to receive(:file?).with('foo/proxy_types').and_return(false)
       expect(File).to receive(:file?).with('foo/object_types').and_return(false)
-      expect(@serializer).to receive(:deserialize).with('root').and_return({:root => @foo, :A => @bar})
+      expect(@serializer).to receive(:deserialize).with('root').and_return(:root => @foo, :A => @bar)
       expect(@store.load('foo')).to be true
       expect(@store.root).to eq @foo
       expect(@store.get('A')).to eq @bar
@@ -75,7 +75,7 @@ describe YARD::RegistryStore do
         'file1 CHECKSUM1', '  file2 CHECKSUM2 '
       ])
       expect(@store.load('foo')).to be true
-      expect(@store.checksums).to eq({'file1' => 'CHECKSUM1', 'file2' => 'CHECKSUM2'})
+      expect(@store.checksums).to eq('file1' => 'CHECKSUM1', 'file2' => 'CHECKSUM2')
     end
 
     it "loads proxy_types if they exist" do
@@ -84,9 +84,9 @@ describe YARD::RegistryStore do
       expect(File).to receive(:file?).with('foo/proxy_types').and_return(true)
       expect(File).to receive(:file?).with('foo/object_types').and_return(false)
       expect(File).to receive(:file?).with('foo/objects/root.dat').and_return(false)
-      expect(File).to receive(:read_binary).with('foo/proxy_types').and_return(Marshal.dump({'a' => 'b'}))
+      expect(File).to receive(:read_binary).with('foo/proxy_types').and_return(Marshal.dump('a' => 'b'))
       expect(@store.load('foo')).to be true
-      expect(@store.proxy_types).to eq({'a' => 'b'})
+      expect(@store.proxy_types).to eq('a' => 'b')
     end
 
     it "loads root object if it exists" do
@@ -215,7 +215,7 @@ describe YARD::RegistryStore do
       expect(File).to receive(:file?).with('foo/checksums').and_return(false)
       expect(File).to receive(:file?).with('foo/proxy_types').and_return(false)
       expect(File).to receive(:file?).with('foo/object_types').and_return(false)
-      expect(@serializer).to receive(:deserialize).with('root').and_return({:'A#foo' => @foo, :A => @bar})
+      expect(@serializer).to receive(:deserialize).with('root').and_return(:'A#foo' => @foo, :A => @bar)
       @store.load('foo')
       expect(@store.paths_for_type(:method)).to eq ['#foo']
       expect(@store.paths_for_type(:class)).to eq ['Bar']

data/spec/rubygems/doc_manager_spec.rb

@@ -1,8 +1,8 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+# frozen_string_literal: true
 require File.join(YARD::ROOT, 'rubygems_plugin')
 require 'fileutils'
 
-describe Gem::DocManager do
+RSpec.describe Gem::DocManager do
   before do
     # Ensure filesystem integrity
     allow(FileUtils).to receive(:mkdir_p)

data/spec/serializers/file_system_serializer_spec.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
 require File.join(File.dirname(__FILE__), "spec_helper")
 
 require 'stringio'
 
-describe YARD::Serializers::FileSystemSerializer do
+RSpec.describe YARD::Serializers::FileSystemSerializer do
   before do
     allow(FileUtils).to receive(:mkdir_p)
     allow(File).to receive(:open)
@@ -43,7 +44,7 @@ describe YARD::Serializers::FileSystemSerializer do
       m = CodeObjects::MethodObject.new(nil, 'a')
       s = Serializers::FileSystemSerializer.new
 
-      { :gsub! => 'gsub_21_i.html',
+      {:gsub! => 'gsub_21_i.html',
         :ask? => 'ask_3F_i.html',
         :=== => '_3D_3D_3D_i.html',
         :+ => '_2B_i.html',
@@ -56,8 +57,7 @@ describe YARD::Serializers::FileSystemSerializer do
         :* => '_2A_i.html',
         :| => '_7C_i.html',
         :/ => '_2F_i.html',
-        :=~ => '_3D_7E_i.html'
-      }.each do |meth, value|
+        :=~ => '_3D_7E_i.html'}.each do |meth, value|
         allow(m).to receive(:name).and_return(meth)
         expect(s.serialized_path(m)).to eq value
       end
@@ -95,7 +95,8 @@ describe YARD::Serializers::FileSystemSerializer do
       o2 = CodeObjects::ClassObject.new(:root, "Ab")
       s = Serializers::FileSystemSerializer.new
       expect([["AB_.html", "Ab.html"], ["AB.html", "Ab_.html"]]).to include(
-        [s.serialized_path(o1), s.serialized_path(o2)])
+        [s.serialized_path(o1), s.serialized_path(o2)]
+      )
     end
 
     it "handles case sensitivity of nested paths for objects with matching names" do
@@ -117,9 +118,9 @@ describe YARD::Serializers::FileSystemSerializer do
       meth = CodeObjects::MethodObject.new(yard, :baz, :class)
       meth2 = CodeObjects::MethodObject.new(yard, :baz)
 
-      { 'foo/FooBar/baz_c.txt' => meth,
+      {'foo/FooBar/baz_c.txt' => meth,
         'foo/FooBar/baz_i.txt' => meth2,
-        'foo/FooBar.txt' => yard }.each do |path, obj|
+        'foo/FooBar.txt' => yard}.each do |path, obj|
         io = StringIO.new
         expect(File).to receive(:open).with(path, 'wb').and_yield(io)
         expect(io).to receive(:write).with("data")

data/spec/serializers/spec_helper.rb

@@ -1,2 +1,2 @@
-require File.join(File.dirname(__FILE__), "..", "spec_helper")
-include YARD
+# frozen_string_literal: true
+include YARD

data/spec/serializers/yardoc_serializer_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require File.dirname(__FILE__) + "/spec_helper"
 
 instance_eval do
@@ -7,7 +8,7 @@ instance_eval do
   end
 end
 
-describe YARD::Serializers::YardocSerializer do
+RSpec.describe YARD::Serializers::YardocSerializer do
   before do
     @serializer = YARD::Serializers::YardocSerializer.new('.yardoc')
 
@@ -28,8 +29,8 @@ describe YARD::Serializers::YardocSerializer do
 
     it "maintains hash key equality when loading a dumped object" do
       newfoo = @serializer.internal_dump(@foo)
-      expect({@foo => 1}).to have_key(newfoo)
-      expect({newfoo => 1}).to have_key(@foo)
+      expect(@foo => 1).to have_key(newfoo)
+      expect(newfoo => 1).to have_key(@foo)
     end
   end
 
@@ -74,4 +75,4 @@ describe YARD::Serializers::YardocSerializer do
       expect(@serializer.complete?).to eq true
     end
   end
-end
+end

data/spec/server/adapter_spec.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
 require File.dirname(__FILE__) + '/spec_helper'
 
-describe YARD::Server::Adapter do
+RSpec.describe YARD::Server::Adapter do
   after(:all) { Server::Adapter.shutdown }
 
   describe "#add_library" do
@@ -35,4 +36,4 @@ describe YARD::Server::Adapter do
       expect(Templates::Engine.template_paths).not_to include(YARD::ROOT + '/yard/server/templates')
     end
   end
-end
+end

data/spec/server/commands/base_spec.rb

@@ -1,14 +1,17 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+# frozen_string_literal: true
 
 class MyProcCommand < Base
-  def initialize(&block) self.class.send(:define_method, :run, &block) end
+  def initialize(&block)
+    self.class.send(:undef_method, :run)
+    self.class.send(:define_method, :run, &block)
+  end
 end
 
 class MyCacheCommand < Base
   def run; cache 'foo' end
 end
 
-describe YARD::Server::Commands::Base do
+RSpec.describe YARD::Server::Commands::Base do
   describe "#cache" do
     before do
       @command = MyCacheCommand.new(:adapter => mock_adapter, :caching => true)
@@ -39,48 +42,49 @@ describe YARD::Server::Commands::Base do
     it "returns a valid redirection" do
       cmd = MyProcCommand.new { redirect '/foo' }
       expect(cmd.call(mock_request('/foo'))).to eq(
-        [302, {"Content-Type" => "text/html", "Location" => "/foo"}, [""]])
+        [302, {"Content-Type" => "text/html", "Location" => "/foo"}, [""]]
+      )
     end
   end
 
   describe "#call" do
     it "handles a NotFoundError and use message as body" do
       cmd = MyProcCommand.new { raise NotFoundError, "hello world" }
-      s, h, b = *cmd.call(mock_request('/foo'))
+      s, _, b = *cmd.call(mock_request('/foo'))
       expect(s).to eq 404
       expect(b).to eq ["hello world"]
     end
 
     it "does not use message as body if not provided in NotFoundError" do
       cmd = MyProcCommand.new { raise NotFoundError }
-      s, h, b = *cmd.call(mock_request('/foo'))
+      s, _, b = *cmd.call(mock_request('/foo'))
       expect(s).to eq 404
       expect(b).to eq ["Not found: /foo"]
     end
 
     it "handles 404 status code from #run" do
       cmd = MyProcCommand.new { self.status = 404 }
-      s, h, b = *cmd.call(mock_request('/foo'))
+      s, _, b = *cmd.call(mock_request('/foo'))
       expect(s).to eq 404
       expect(b).to eq ["Not found: /foo"]
     end
 
     it "does not override body if status is 404 and body is defined" do
       cmd = MyProcCommand.new { self.body = "foo"; self.status = 404 }
-      s, h, b = *cmd.call(mock_request('/bar'))
+      s, _, b = *cmd.call(mock_request('/bar'))
       expect(s).to eq 404
       expect(b).to eq ['foo']
     end
 
     it "handles body as Array" do
       cmd = MyProcCommand.new { self.body = ['a', 'b', 'c'] }
-      s, h, b = *cmd.call(mock_request('/foo'))
+      _, _, b = *cmd.call(mock_request('/foo'))
       expect(b).to eq %w(a b c)
     end
 
     it "allows headers to be defined" do
-      cmd = MyProcCommand.new { self.headers['Foo'] = 'BAR' }
-      s, h, b = *cmd.call(mock_request('/foo'))
+      cmd = MyProcCommand.new { headers['Foo'] = 'BAR' }
+      _, h, = *cmd.call(mock_request('/foo'))
       expect(h['Foo']).to eq 'BAR'
     end
   end

data/spec/server/commands/library_command_spec.rb

@@ -1,7 +1,7 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+# frozen_string_literal: true
 require 'ostruct'
 
-describe YARD::Server::Commands::LibraryCommand do
+RSpec.describe YARD::Server::Commands::LibraryCommand do
   before do
     allow(Templates::Engine).to receive(:render)
     allow(Templates::Engine).to receive(:generate)

data/spec/server/doc_server_helper_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require File.dirname(__FILE__) + "/spec_helper"
 
 class MyDocServerSerializerRouter
@@ -26,7 +27,7 @@ class MockDocServerHelper
   def options; OpenStruct.new end
 end
 
-describe YARD::Server::DocServerHelper do
+RSpec.describe YARD::Server::DocServerHelper do
   before do
     @helper = MockDocServerHelper.new
   end
@@ -44,7 +45,7 @@ describe YARD::Server::DocServerHelper do
     end
 
     it "uses script name prefix if set" do
-      @helper.adapter.router.request.script_name = '/mount/point' 
+      @helper.adapter.router.request.script_name = '/mount/point'
       @helper.library = LibraryVersion.new('foo', 'bar')
       @helper.adapter.router.request.version_supplied = true
       expect(@helper.url_for(P('A'))).to eq '/mount/point/PREFIX/foo/bar/A'
@@ -63,7 +64,7 @@ describe YARD::Server::DocServerHelper do
     end
 
     it "uses script name prefix if set" do
-      @helper.adapter.router.request.script_name = '/mount/point' 
+      @helper.adapter.router.request.script_name = '/mount/point'
       file = CodeObjects::ExtraFileObject.new('a/b/FooBar.md', '')
       expect(@helper.url_for_file(file)).to eq '/mount/point/PREFIX/foo/file/a/b/FooBar.md'
     end

data/spec/server/doc_server_serializer_spec.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
 require File.dirname(__FILE__) + '/spec_helper'
 
-describe YARD::Server::DocServerSerializer do
+RSpec.describe YARD::Server::DocServerSerializer do
   describe "#serialized_path" do
     before do
       Registry.clear
@@ -56,4 +57,4 @@ describe YARD::Server::DocServerSerializer do
       end
     end if defined?(::Encoding)
   end
-end
+end

data/spec/server/rack_adapter_spec.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
 require File.dirname(__FILE__) + "/spec_helper"
 
-describe "YARD::Server::RackMiddleware" do
+RSpec.describe "YARD::Server::RackMiddleware" do
   before do
     begin; require 'rack'; rescue LoadError; pending "rack required for these tests" end
     @superapp = double(:superapp)
@@ -17,4 +18,4 @@ describe "YARD::Server::RackMiddleware" do
     expect(@superapp).to receive(:call).and_return([200, {}, ['OK']])
     expect(@app.call(Rack::MockRequest.env_for('/INVALID'))).to eq [200, {}, ['OK']]
   end
-end
+end

data/spec/server/router_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require File.dirname(__FILE__) + '/spec_helper'
 
 class MyRouterSpecRouter < Router
@@ -8,7 +9,7 @@ class MyRouterSpecRouter < Router
   def check_static_cache; nil end
 end
 
-describe YARD::Server::Router do
+RSpec.describe YARD::Server::Router do
   before do
     @adapter = mock_adapter
     @projects = @adapter.libraries['project']
@@ -55,7 +56,7 @@ describe YARD::Server::Router do
       expect(command).to receive(:new) do |*args|
         @command = command.allocate
         @command.send(:initialize, *args)
-        class << @command; def call(req); self end end
+        class << @command; define_method(:call) {|*| self } end
         @command
       end
       router.call(req)

data/spec/server/spec_helper.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + "/../spec_helper"
+# frozen_string_literal: true
 require 'ostruct'
 
 include Server
@@ -17,6 +17,6 @@ class MockRequest < OpenStruct
 end
 
 def mock_request(path_info = '/', script_name = '', extra_env = {})
-  opts = { :path_info => path_info, :script_name => script_name }
+  opts = {:path_info => path_info, :script_name => script_name}
   MockRequest.new(extra_env.merge(opts))
 end

data/spec/server/static_caching_spec.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
 require File.dirname(__FILE__) + '/spec_helper'
 
-describe YARD::Server::StaticCaching do
+RSpec.describe YARD::Server::StaticCaching do
   include StaticCaching
 
   describe "#check_static_cache" do
@@ -16,7 +17,7 @@ describe YARD::Server::StaticCaching do
       request.path_info = '/hello/world.html'
       expect(File).to receive(:file?).with('/public/hello/world.html').and_return(true)
       expect(File).to receive(:open).with('/public/hello/world.html', anything).and_return('body')
-      s, h, b = *check_static_cache
+      s, _, b = *check_static_cache
       expect(s).to eq 200
       expect(b).to eq ["body"]
     end
@@ -25,7 +26,7 @@ describe YARD::Server::StaticCaching do
       request.path_info = '/hello/world'
       expect(File).to receive(:file?).with('/public/hello/world.html').and_return(true)
       expect(File).to receive(:open).with('/public/hello/world.html', anything).and_return('body')
-      s, h, b = *check_static_cache
+      s, _, b = *check_static_cache
       expect(s).to eq 200
       expect(b).to eq ["body"]
     end

data/spec/server/webrick_servlet_spec.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
 require File.dirname(__FILE__) + '/spec_helper'
 
-describe YARD::Server::WebrickServlet do
+RSpec.describe YARD::Server::WebrickServlet do
   describe "#do_GET" do
     it "performs a GET" do
       resp = OpenStruct.new
@@ -9,11 +10,11 @@ describe YARD::Server::WebrickServlet do
       end
       server = double(:server, :[] => nil)
       adapter = mock_adapter
-      adapter.router = proc { [200, {'Header' => 'foo'}, ['body']]}
+      adapter.router = proc { [200, {'Header' => 'foo'}, ['body']] }
       WebrickServlet.new(server, adapter).do_GET(mock_request('/foo'), resp)
       expect(resp.status).to eq 200
-      expect(resp.headers).to eq({'Header' => 'foo'})
+      expect(resp.headers).to eq('Header' => 'foo')
       expect(resp.body).to eq 'body'
     end
   end
-end
+end

data/spec/server_spec.rb

@@ -1,6 +1,6 @@
-require File.dirname(__FILE__) + "/spec_helper"
+# frozen_string_literal: true
 
-describe YARD::Server do
+RSpec.describe YARD::Server do
   describe ".register_static_path" do
     it "registers a static path" do
       YARD::Server.register_static_path 'foo'
@@ -16,4 +16,4 @@ describe YARD::Server do
       expect(paths.last).to eq 'foo2'
     end
   end
-end
+end

data/spec/spec_helper.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "rubygems"
 begin
   require "rspec"
@@ -6,28 +7,15 @@ rescue LoadError
 end
 
 begin
-  require 'bundler'
-  Bundler.setup
+  require 'bundler/setup'
 rescue LoadError
+  nil # noop
 end
 
-begin
-  require 'simplecov'
-  SimpleCov.start
-  # TODO: hide some rb files from cov report
-  # hide = '_spec\.rb$,spec_helper\.rb$,ruby_lex\.rb$,autoload\.rb$'
-  # if YARD::Parser::SourceParser.parser_type == :ruby
-  #   hide += ',legacy\/.+_handler'
-  # else
-  #   hide += ',ruby_parser\.rb$,ast_node\.rb$,handlers\/ruby\/[^\/]+\.rb$'
-  # end
-rescue LoadError
-end if ENV['COVERAGE']
-
 require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'yard'))
 
 unless defined?(HAVE_RIPPER)
-  begin require 'ripper'; rescue LoadError; end
+  begin require 'ripper'; rescue LoadError; nil end
   HAVE_RIPPER = defined?(::Ripper) && !ENV['LEGACY'] ? true : false
   LEGACY_PARSER = !HAVE_RIPPER
 
@@ -36,6 +24,11 @@ unless defined?(HAVE_RIPPER)
   end if ENV['LEGACY']
 end
 
+begin
+  require 'coveralls'
+  Coveralls.wear!
+end if ENV['CI'] && HAVE_RIPPER
+
 NAMED_OPTIONAL_ARGUMENTS = RUBY_VERSION >= '2.1.0'
 
 def parse_file(file, thisfile = __FILE__, log_level = log.level, ext = '.rb.txt')
@@ -53,14 +46,14 @@ def described_in_docs(klass, meth, file = nil)
     YARD::Parser::SourceParser.new.parse(filename)
   else
     underscore = klass.class_name.gsub(/([a-z])([A-Z])/, '\1_\2').downcase.gsub('::', '/')
-    $".find_all {|p| p.include? underscore }.each do |filename|
-      next unless File.exist? filename
-      YARD::Parser::SourceParser.new.parse(filename)
+    $LOADED_FEATURES.find_all {|p| p.include? underscore }.each do |found_fname|
+      next unless File.exist? found_fname
+      YARD::Parser::SourceParser.new.parse(found_fname)
     end
   end
 
   # Get the object
-  objname = klass.name + (meth[0,1] == '#' ? meth : '::' + meth)
+  objname = klass.name + (meth[0, 1] == '#' ? meth : '::' + meth)
   obj = Registry.at(objname)
   raise "Cannot find object #{objname} described by spec." unless obj
   raise "#{obj.path} has no @it tags to spec." unless obj.has_tag? :it
@@ -84,7 +77,7 @@ end
 def docspec(objname = self.class.description, klass = self.class.described_type)
   # Parse the file (could be multiple files)
   underscore = klass.class_name.gsub(/([a-z])([A-Z])/, '\1_\2').downcase.gsub('::', '/')
-  $".find_all {|p| p.include? underscore }.each do |filename|
+  $LOADED_FEATURES.find_all {|p| p.include? underscore }.each do |filename|
     filename = File.join(YARD::ROOT, filename)
     next unless File.exist? filename
     YARD::Parser::SourceParser.new.parse(filename)
@@ -134,6 +127,86 @@ RSpec.configure do |config|
     example.run
     log.level = saved_level
   end
+
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    # mocks.verify_partial_doubles = true # FIXME: Not yet working
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = false
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the N slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 5
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  # config.order = :random # FIXME: Not yet working
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
 end
 
 include YARD