Skip to content

Commit

Permalink
Publish docs/2.4-M5
Browse files Browse the repository at this point in the history
  • Loading branch information
Spock Framework Robot committed Dec 29, 2024
1 parent cbce54b commit 97de102
Show file tree
Hide file tree
Showing 44 changed files with 29,648 additions and 0 deletions.
13,855 changes: 13,855 additions & 0 deletions docs/2.4-M5/all_in_one.html

Large diffs are not rendered by default.

424 changes: 424 additions & 0 deletions docs/2.4-M5/asciidoctor.css

Large diffs are not rendered by default.

87 changes: 87 additions & 0 deletions docs/2.4-M5/coderay-asciidoctor.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
/*! Stylesheet for CodeRay to loosely match GitHub themes | MIT License */
pre.CodeRay{background:#f7f7f8}
.CodeRay .line-numbers{border-right:1px solid;opacity:.35;padding:0 .5em 0 0;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none}
.CodeRay span.line-numbers{display:inline-block;margin-right:.75em}
.CodeRay .line-numbers strong{color:#000}
table.CodeRay{border-collapse:separate;border:0;margin-bottom:0;background:none}
table.CodeRay td{vertical-align:top;line-height:inherit}
table.CodeRay td.line-numbers{text-align:right}
table.CodeRay td.code{padding:0 0 0 .75em}
.CodeRay .debug{color:#fff!important;background:navy!important}
.CodeRay .annotation{color:#007}
.CodeRay .attribute-name{color:navy}
.CodeRay .attribute-value{color:#700}
.CodeRay .binary{color:#509}
.CodeRay .comment{color:#998;font-style:italic}
.CodeRay .char{color:#04d}
.CodeRay .char .content{color:#04d}
.CodeRay .char .delimiter{color:#039}
.CodeRay .class{color:#458;font-weight:bold}
.CodeRay .complex{color:#a08}
.CodeRay .constant,.CodeRay .predefined-constant{color:teal}
.CodeRay .color{color:#099}
.CodeRay .class-variable{color:#369}
.CodeRay .decorator{color:#b0b}
.CodeRay .definition{color:#099}
.CodeRay .delimiter{color:#000}
.CodeRay .doc{color:#970}
.CodeRay .doctype{color:#34b}
.CodeRay .doc-string{color:#d42}
.CodeRay .escape{color:#666}
.CodeRay .entity{color:#800}
.CodeRay .error{color:#808}
.CodeRay .exception{color:inherit}
.CodeRay .filename{color:#099}
.CodeRay .function{color:#900;font-weight:bold}
.CodeRay .global-variable{color:teal}
.CodeRay .hex{color:#058}
.CodeRay .integer,.CodeRay .float{color:#099}
.CodeRay .include{color:#555}
.CodeRay .inline{color:#000}
.CodeRay .inline .inline{background:#ccc}
.CodeRay .inline .inline .inline{background:#bbb}
.CodeRay .inline .inline-delimiter{color:#d14}
.CodeRay .inline-delimiter{color:#d14}
.CodeRay .important{color:#555;font-weight:bold}
.CodeRay .interpreted{color:#b2b}
.CodeRay .instance-variable{color:teal}
.CodeRay .label{color:#970}
.CodeRay .local-variable{color:#963}
.CodeRay .octal{color:#40e}
.CodeRay .predefined{color:#369}
.CodeRay .preprocessor{color:#579}
.CodeRay .pseudo-class{color:#555}
.CodeRay .directive{font-weight:bold}
.CodeRay .type{font-weight:bold}
.CodeRay .predefined-type{color:inherit}
.CodeRay .reserved,.CodeRay .keyword{color:#000;font-weight:bold}
.CodeRay .key{color:#808}
.CodeRay .key .delimiter{color:#606}
.CodeRay .key .char{color:#80f}
.CodeRay .value{color:#088}
.CodeRay .regexp .delimiter{color:#808}
.CodeRay .regexp .content{color:#808}
.CodeRay .regexp .modifier{color:#808}
.CodeRay .regexp .char{color:#d14}
.CodeRay .regexp .function{color:#404;font-weight:bold}
.CodeRay .string{color:#d20}
.CodeRay .string .string .string{background:#ffd0d0}
.CodeRay .string .content{color:#d14}
.CodeRay .string .char{color:#d14}
.CodeRay .string .delimiter{color:#d14}
.CodeRay .shell{color:#d14}
.CodeRay .shell .delimiter{color:#d14}
.CodeRay .symbol{color:#990073}
.CodeRay .symbol .content{color:#a60}
.CodeRay .symbol .delimiter{color:#630}
.CodeRay .tag{color:teal}
.CodeRay .tag-special{color:#d70}
.CodeRay .variable{color:#036}
.CodeRay .insert{background:#afa}
.CodeRay .delete{background:#faa}
.CodeRay .change{color:#aaf;background:#007}
.CodeRay .head{color:#f8f;background:#505}
.CodeRay .insert .insert{color:#080}
.CodeRay .delete .delete{color:#800}
.CodeRay .change .change{color:#66f}
.CodeRay .head .head{color:#f4f}
1,651 changes: 1,651 additions & 0 deletions docs/2.4-M5/data_driven_testing.html

Large diffs are not rendered by default.

2,908 changes: 2,908 additions & 0 deletions docs/2.4-M5/extensions.html

Large diffs are not rendered by default.

76 changes: 76 additions & 0 deletions docs/2.4-M5/faq.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
<!DOCTYPE html>
<html lang="">
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="Asciidoctor 2.0.23">
<meta name="author" content="Peter Niederwieser, Leonard Brünings, The Spock Framework Team">
<title>Frequently Asked Questions (FAQ)</title>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700">
<link rel="stylesheet" href="./asciidoctor.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css">
<style>
.includeSourceLinkerTable tr td:first-child {
padding: 0;
}
</style>
</head>
<body class="article">
<div id="header">
<h1>Frequently Asked Questions (FAQ)</h1>
<div class="details">
<span id="author" class="author">Peter Niederwieser, Leonard Brünings, The Spock Framework Team</span><br>
<span id="revnumber">version 2.4-M5</span>
</div>
</div>
<div id="content">
<div class="sect1">
<h2 id="_what_are_spocks_optional_dependencies_used_for"><a class="anchor" href="#_what_are_spocks_optional_dependencies_used_for"></a><a class="link" href="#_what_are_spocks_optional_dependencies_used_for">What are Spock&#8217;s optional dependencies used for?</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Spock runs fine without optional dependencies, hence the term <em>optional</em>. So what are they used for?</p>
</div>
<div class="ulist">
<ul>
<li>
<p>Objenesis (artifact <code>org.objenesis:objenesis</code>) is required for mocking classes without default constructors.</p>
</li>
<li>
<p>Either ByteBuddy (artifact <code>net.bytebuddy:byte-buddy</code>) or CGLIB (artifact <code>cglib:cglib-nodep</code>) are required for mocking classes and not just interfaces.</p>
</li>
</ul>
</div>
<div class="paragraph">
<p>See also <a href="interaction_based_testing.html#_mocking_classes">Mocking Classes</a>.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_why_are_there_two_options_bytebuddy_vs_cglib_for_mocking_classes"><a class="anchor" href="#_why_are_there_two_options_bytebuddy_vs_cglib_for_mocking_classes"></a><a class="link" href="#_why_are_there_two_options_bytebuddy_vs_cglib_for_mocking_classes">Why are there two options (ByteBuddy vs CGLIB) for mocking classes?</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>The main reason is backwards compatibility.
CGLIB came first historically, ByteBuddy was added later.
Both libraries basically provide identical features from a Spock user&#8217;s perspective.</p>
</div>
<div class="paragraph">
<p>If you are starting with Spock now, we recommend ByteBuddy as our preferred choice.</p>
</div>
<div class="paragraph">
<p>CGLIB is in legacy support mode, we will support it as long as the maintenance effort is relatively low.
So you may continue to use CGLIB for now if e.g. your tests use it in another context already.
If you have no compelling reasons to avoid ByteBuddy, you can just switch from CGLIB to ByteBuddy in an existing project.
Your tests should continue to run like before.</p>
</div>
</div>
</div>
</div>
<div id="footer">
<div id="footer-text">
Version 2.4-M5<br>
Last updated 2024-12-29 18:08:42 UTC
</div>
</div>
</body>
</html>
64 changes: 64 additions & 0 deletions docs/2.4-M5/getting_started.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
<!DOCTYPE html>
<html lang="">
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="Asciidoctor 2.0.23">
<meta name="author" content="Peter Niederwieser, Leonard Brünings, The Spock Framework Team">
<title>Getting Started</title>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700">
<link rel="stylesheet" href="./asciidoctor.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css">
<style>
.includeSourceLinkerTable tr td:first-child {
padding: 0;
}
</style>
</head>
<body class="article">
<div id="header">
<h1>Getting Started</h1>
<div class="details">
<span id="author" class="author">Peter Niederwieser, Leonard Brünings, The Spock Framework Team</span><br>
<span id="revnumber">version 2.4-M5</span>
</div>
</div>
<div id="content">
<div id="preamble">
<div class="sectionbody">
<div class="paragraph">
<p>It&#8217;s really easy to get started with Spock. This section shows you how.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_groovy_web_console"><a class="anchor" href="#_groovy_web_console"></a><a class="link" href="#_groovy_web_console">Groovy Web Console</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p><a href="https://groovyconsole.dev/">Groovy Web Console</a> is a website that allows you to instantly view, edit, run, and
even publish Spock specifications. It is the perfect place to toy around with Spock without making any commitments.
So why not run <a href="https://groovyconsole.dev/?g=groovy_4_0&amp;codez=eNpdizEKg0AQRfs9xU81hgTsBUuDTSpPYMYRBhc3ZEc0BO-ejbGy-5_3Xp6jVgNVi_BkQniID7Nj38aI-_umr2jNUxiymIxdxO9or9yahhEfB3TSg2rxPlwTDTycKDtvBKlKuhXb_juEC2jXUJbHMpmrW90Xc9sttg">Hello, Spock!</a> right away?</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_spock_example_project"><a class="anchor" href="#_spock_example_project"></a><a class="link" href="#_spock_example_project">Spock Example Project</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>To try Spock in your local environment, clone or download/unzip the
<a href="https://github.com/spockframework/spock-example">Spock Example Project</a>. It comes with fully working Ant, Gradle, and
Maven builds that require no further setup. The Gradle build even bootstraps Gradle itself and gets you up and
running in Eclipse or IDEA with a single command. See the README for detailed instructions.</p>
</div>
</div>
</div>
</div>
<div id="footer">
<div id="footer-text">
Version 2.4-M5<br>
Last updated 2024-12-29 18:08:42 UTC
</div>
</div>
</body>
</html>
Binary file added docs/2.4-M5/images/Blocks2Phases.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
24 changes: 24 additions & 0 deletions docs/2.4-M5/images/Spock Logo Use Guidelines.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
Logo Usage Guidelines
1. General. The Spock Framework Project (the “Company”) logo and trademark,
a copy of which is attached hereto as Annex A (the “Logo”),
shall be used only as set forth and under the terms and conditions and for the purposes described herein.
The party receiving these Logo Usage Guidelines (“Guidelines”) or using the Logo shall be referred to as “Licensee.”
Licensee may use the Logo as set forth in these Guidelines and agrees that Gradle, Inc.
(“Gradle”) and the Company each has the subsequent right to inspect the use of the Logo to ensure that such uses are permitted under these Guidelines.
All uses of the Logo shall comply with the following:
2. Appearance of Logos. Licensee shall ensure that the presentation of the Logo shall be consistent with the Company’s use of the Logo in comparable media.
3. Appearance. From time to time, the Company may provide Licensee with guidelines for the size, typeface,
colors and other graphic characteristics of the Logo, which upon delivery to Licensee shall be deemed to be incorporated into these Guidelines.
4. Restrictions Upon Use. The Logo shall not be presented or used:
a. in a manner that could be reasonably interpreted to suggest Licensee or third party editorial content has been authored by,
or represents the views or opinions of, the Company, Gradle, or each of the Company or Gradle’s personnel;
b. in a manner that is misleading, defamatory, libelous, obscene or otherwise objectionable, in the Company’s or Gradle’s reasonable opinion;
c. in a way that infringes, derogates, dilutes or impairs the rights of the Company or Gradle in the Logo;
d. as part of a name of a product or service of a company other than the Company, except as expressly provided in a written agreement by the Company or Gradle;
e. in an abbreviated form;
f. on commercial merchandise or for commercial purposes or in any manner which allows Licensee to profit from use of the Logo; or
g. in a manner that merges the Logo with other words, symbols, or numbers.
5. Attribution. Licensee must include the following statement in Licensee’s materials that include the Logo: The Spock Framework Project logo is a trademark of the Spock Framework Project.
6. Changes. Licensee will promptly make any changes to its use of the Logo as requested by the Company or Gradle.
7. Goodwill. Licensee acknowledges that all rights to the Logo are the exclusive property of the Company and of Gradle and all goodwill generated through Licensee’s use of the Logo will inure to the benefit of the Company.
8. Revisions. These Logo Usage Guidelines may be modified at any time by the Company upon written notice to Licensee.
1 change: 1 addition & 0 deletions docs/2.4-M5/images/concurrent-concurrent-execution.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 97de102

Please sign in to comment.