id
stringlengths 1
8
| text
stringlengths 72
9.81M
| addition_count
int64 0
10k
| commit_subject
stringlengths 0
3.7k
| deletion_count
int64 0
8.43k
| file_extension
stringlengths 0
32
| lang
stringlengths 1
94
| license
stringclasses 10
values | repo_name
stringlengths 9
59
|
|---|---|---|---|---|---|---|---|---|
10072350 | <NME> CONTRIBUTING.md
<BEF> # Contributing to Split
* Make your feature addition or bug fix.
* Add tests for it. This is important so I don't break it in a
future version unintentionally.
* Commit, do not mess with rakefile, version, or history.
(if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
* Send a pull request. Bonus points for topic branches.
* [Contributing to an existing issue](#contributing-to-an-existing-issue)
* [Our labels](#our-labels)
* [Additional info](#additional-info)
## Contribution workflow
* Fork the project.
* Make your feature addition or bug fix.
* Add tests for it. This is important so I don't break it in a
future version unintentionally.
* Add documentation if necessary.
* Commit. Do not mess with the Rakefile, version, or history.
(If you want to have your own version, that is fine. But bump version in a commit by itself I can ignore when I pull.)
* Send a pull request. Bonus points for topic branches.
* Discussion at the [Google Group](https://groups.google.com/d/forum/split-ruby)
## Setup instructions
You can find in-depth instructions to install in our [README](https://github.com/splitrb/split/blob/main/README.md).
*Note*: Split requires Ruby 1.9.2 or higher.
## Reporting a bug
So you've found a bug, and want to help us fix it? Before filing a bug report, please double-check the bug hasn't already been reported. You can do so [on our issue tracker](https://github.com/splitrb/split/issues?q=is%3Aissue+is%3Aopen+label%3Abug). If something hasn't been raised, you can go ahead and create a new issue with the following information:
* When did the error happen?
* How can the error be reproduced?
* If possible, please also provide an error message or a screenshot to illustrate the problem.
If you want to be really thorough, there is a great overview on Stack Overflow of [what you should consider when reporting a bug](http://stackoverflow.com/questions/240323/how-to-report-bugs-the-smart-way).
It goes without saying that you're welcome to help investigate further and/or find a fix for the bug. If you want to do so, just mention it in your bug report and offer your help!
## Contributing to an existing issue
### Finding an issue to work on
We've got a few open issues and are always glad to get help on that front. You can view the list of issues [here](https://github.com/splitrb/split/issues). Most of the issues are labelled, so you can use the labels to get an idea of which issue could be a good fit for you. (Here's [a good article](https://medium.freecodecamp.com/finding-your-first-open-source-project-or-bug-to-work-on-1712f651e5ba) on how to find your first bug to fix).
Before getting to work, take a look at the issue and at the conversation around it. Has someone already offered to work on the issue? Has someone been assigned to the issue? If so, you might want to check with them to see whether they're still actively working on it.
If the issue is a few months old, it might be a good idea to write a short comment to double-check that the issue or feature is still a valid one to jump on.
Feel free to ask for more detail on what is expected: are there any more details or specifications you need to know?
And if at any point you get stuck: don't hesitate to ask for help.
### Making your contribution
We've outlined the contribution workflow [here](#contribution-workflow). If you're a first-timer, don't worry! GitHub has a ton of guides to help you through your first pull request: You can find out more about pull requests [here](https://help.github.com/articles/about-pull-requests/) and about creating a pull request [here](https://help.github.com/articles/creating-a-pull-request/).
Especially if you're a newcomer to Open Source and you've found some little bumps along the way while contributing, we recommend you write about them. [Here](https://medium.freecodecamp.com/new-contributors-to-open-source-please-blog-more-920af14cffd)'s a great article about why writing about your experience is important; this will encourage other beginners to try their luck at Open Source, too!
<MSG> Added note about contributing documentation
<DFF> @@ -3,6 +3,7 @@
* Make your feature addition or bug fix.
* Add tests for it. This is important so I don't break it in a
future version unintentionally.
+* Add documentation if necessary.
* Commit, do not mess with rakefile, version, or history.
(if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
* Send a pull request. Bonus points for topic branches.
| 1 | Added note about contributing documentation | 0 | .md | md | mit | splitrb/split |
10072351 | <NME> CONTRIBUTING.md
<BEF> # Contributing to Split
* Make your feature addition or bug fix.
* Add tests for it. This is important so I don't break it in a
future version unintentionally.
* Commit, do not mess with rakefile, version, or history.
(if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
* Send a pull request. Bonus points for topic branches.
* [Contributing to an existing issue](#contributing-to-an-existing-issue)
* [Our labels](#our-labels)
* [Additional info](#additional-info)
## Contribution workflow
* Fork the project.
* Make your feature addition or bug fix.
* Add tests for it. This is important so I don't break it in a
future version unintentionally.
* Add documentation if necessary.
* Commit. Do not mess with the Rakefile, version, or history.
(If you want to have your own version, that is fine. But bump version in a commit by itself I can ignore when I pull.)
* Send a pull request. Bonus points for topic branches.
* Discussion at the [Google Group](https://groups.google.com/d/forum/split-ruby)
## Setup instructions
You can find in-depth instructions to install in our [README](https://github.com/splitrb/split/blob/main/README.md).
*Note*: Split requires Ruby 1.9.2 or higher.
## Reporting a bug
So you've found a bug, and want to help us fix it? Before filing a bug report, please double-check the bug hasn't already been reported. You can do so [on our issue tracker](https://github.com/splitrb/split/issues?q=is%3Aissue+is%3Aopen+label%3Abug). If something hasn't been raised, you can go ahead and create a new issue with the following information:
* When did the error happen?
* How can the error be reproduced?
* If possible, please also provide an error message or a screenshot to illustrate the problem.
If you want to be really thorough, there is a great overview on Stack Overflow of [what you should consider when reporting a bug](http://stackoverflow.com/questions/240323/how-to-report-bugs-the-smart-way).
It goes without saying that you're welcome to help investigate further and/or find a fix for the bug. If you want to do so, just mention it in your bug report and offer your help!
## Contributing to an existing issue
### Finding an issue to work on
We've got a few open issues and are always glad to get help on that front. You can view the list of issues [here](https://github.com/splitrb/split/issues). Most of the issues are labelled, so you can use the labels to get an idea of which issue could be a good fit for you. (Here's [a good article](https://medium.freecodecamp.com/finding-your-first-open-source-project-or-bug-to-work-on-1712f651e5ba) on how to find your first bug to fix).
Before getting to work, take a look at the issue and at the conversation around it. Has someone already offered to work on the issue? Has someone been assigned to the issue? If so, you might want to check with them to see whether they're still actively working on it.
If the issue is a few months old, it might be a good idea to write a short comment to double-check that the issue or feature is still a valid one to jump on.
Feel free to ask for more detail on what is expected: are there any more details or specifications you need to know?
And if at any point you get stuck: don't hesitate to ask for help.
### Making your contribution
We've outlined the contribution workflow [here](#contribution-workflow). If you're a first-timer, don't worry! GitHub has a ton of guides to help you through your first pull request: You can find out more about pull requests [here](https://help.github.com/articles/about-pull-requests/) and about creating a pull request [here](https://help.github.com/articles/creating-a-pull-request/).
Especially if you're a newcomer to Open Source and you've found some little bumps along the way while contributing, we recommend you write about them. [Here](https://medium.freecodecamp.com/new-contributors-to-open-source-please-blog-more-920af14cffd)'s a great article about why writing about your experience is important; this will encourage other beginners to try their luck at Open Source, too!
<MSG> Added note about contributing documentation
<DFF> @@ -3,6 +3,7 @@
* Make your feature addition or bug fix.
* Add tests for it. This is important so I don't break it in a
future version unintentionally.
+* Add documentation if necessary.
* Commit, do not mess with rakefile, version, or history.
(if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
* Send a pull request. Bonus points for topic branches.
| 1 | Added note about contributing documentation | 0 | .md | md | mit | splitrb/split |
10072352 | <NME> CONTRIBUTING.md
<BEF> # Contributing to Split
* Make your feature addition or bug fix.
* Add tests for it. This is important so I don't break it in a
future version unintentionally.
* Commit, do not mess with rakefile, version, or history.
(if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
* Send a pull request. Bonus points for topic branches.
* [Contributing to an existing issue](#contributing-to-an-existing-issue)
* [Our labels](#our-labels)
* [Additional info](#additional-info)
## Contribution workflow
* Fork the project.
* Make your feature addition or bug fix.
* Add tests for it. This is important so I don't break it in a
future version unintentionally.
* Add documentation if necessary.
* Commit. Do not mess with the Rakefile, version, or history.
(If you want to have your own version, that is fine. But bump version in a commit by itself I can ignore when I pull.)
* Send a pull request. Bonus points for topic branches.
* Discussion at the [Google Group](https://groups.google.com/d/forum/split-ruby)
## Setup instructions
You can find in-depth instructions to install in our [README](https://github.com/splitrb/split/blob/main/README.md).
*Note*: Split requires Ruby 1.9.2 or higher.
## Reporting a bug
So you've found a bug, and want to help us fix it? Before filing a bug report, please double-check the bug hasn't already been reported. You can do so [on our issue tracker](https://github.com/splitrb/split/issues?q=is%3Aissue+is%3Aopen+label%3Abug). If something hasn't been raised, you can go ahead and create a new issue with the following information:
* When did the error happen?
* How can the error be reproduced?
* If possible, please also provide an error message or a screenshot to illustrate the problem.
If you want to be really thorough, there is a great overview on Stack Overflow of [what you should consider when reporting a bug](http://stackoverflow.com/questions/240323/how-to-report-bugs-the-smart-way).
It goes without saying that you're welcome to help investigate further and/or find a fix for the bug. If you want to do so, just mention it in your bug report and offer your help!
## Contributing to an existing issue
### Finding an issue to work on
We've got a few open issues and are always glad to get help on that front. You can view the list of issues [here](https://github.com/splitrb/split/issues). Most of the issues are labelled, so you can use the labels to get an idea of which issue could be a good fit for you. (Here's [a good article](https://medium.freecodecamp.com/finding-your-first-open-source-project-or-bug-to-work-on-1712f651e5ba) on how to find your first bug to fix).
Before getting to work, take a look at the issue and at the conversation around it. Has someone already offered to work on the issue? Has someone been assigned to the issue? If so, you might want to check with them to see whether they're still actively working on it.
If the issue is a few months old, it might be a good idea to write a short comment to double-check that the issue or feature is still a valid one to jump on.
Feel free to ask for more detail on what is expected: are there any more details or specifications you need to know?
And if at any point you get stuck: don't hesitate to ask for help.
### Making your contribution
We've outlined the contribution workflow [here](#contribution-workflow). If you're a first-timer, don't worry! GitHub has a ton of guides to help you through your first pull request: You can find out more about pull requests [here](https://help.github.com/articles/about-pull-requests/) and about creating a pull request [here](https://help.github.com/articles/creating-a-pull-request/).
Especially if you're a newcomer to Open Source and you've found some little bumps along the way while contributing, we recommend you write about them. [Here](https://medium.freecodecamp.com/new-contributors-to-open-source-please-blog-more-920af14cffd)'s a great article about why writing about your experience is important; this will encourage other beginners to try their luck at Open Source, too!
<MSG> Added note about contributing documentation
<DFF> @@ -3,6 +3,7 @@
* Make your feature addition or bug fix.
* Add tests for it. This is important so I don't break it in a
future version unintentionally.
+* Add documentation if necessary.
* Commit, do not mess with rakefile, version, or history.
(if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
* Send a pull request. Bonus points for topic branches.
| 1 | Added note about contributing documentation | 0 | .md | md | mit | splitrb/split |
10072353 | <NME> pug.ts
<BEF> ADDFILE
<MSG> Working on Pug formatter
<DFF> @@ -0,0 +1,58 @@
+import { Abbreviation, AbbreviationNode } from '@emmetio/abbreviation';
+import { ResolvedConfig } from '../../types';
+import walk, { WalkState, WalkNext, createWalkState } from './walk';
+import { pushNewline, pushString } from '../../output-stream';
+import { isSnippet } from './utils';
+import { pushPrimaryAttributes, pushSecondaryAttributes, pushValue, collectAttributes } from './indent-format';
+
+export default function pug(abbr: Abbreviation, config: ResolvedConfig): string {
+ const state = createWalkState(config);
+ walk(abbr, element, state);
+ return state.out.value;
+}
+
+/**
+ * Outputs `node` content to output stream of `state`
+ * @param node Context node
+ * @param index Index of `node` in `items`
+ * @param items List of `node`’s siblings
+ * @param state Current walk state
+ */
+function element(node: AbbreviationNode, index: number, items: AbbreviationNode[], state: WalkState, next: WalkNext) {
+ const { out } = state;
+ const { primary, secondary } = collectAttributes(node);
+
+ // Pick offset level for current node
+ const level = state.parent ? 1 : 0;
+ out.level += level;
+
+ // Do not indent top-level elements
+ if (shouldFormat(node, index, items, state)) {
+ pushNewline(out, true);
+ }
+
+ if (node.name && (node.name !== 'div' || !primary.length)) {
+ pushString(out, node.name);
+ }
+
+ pushPrimaryAttributes(primary, state);
+ pushSecondaryAttributes(secondary, state, {
+ before: '(',
+ after: ')',
+ glue: ', ',
+ booleanValue: ''
+ });
+
+ pushValue(node, state, '| ');
+ node.children.forEach(next);
+
+ out.level -= level;
+}
+
+function shouldFormat(node: AbbreviationNode, index: number, items: AbbreviationNode[], state: WalkState): boolean {
+ // Do not format first top-level element or snippets
+ if (!state.parent && index === 0) {
+ return false;
+ }
+ return !isSnippet(node);
+}
| 58 | Working on Pug formatter | 0 | .ts | ts | mit | emmetio/emmet |
10072354 | <NME> pug.ts
<BEF> ADDFILE
<MSG> Working on Pug formatter
<DFF> @@ -0,0 +1,58 @@
+import { Abbreviation, AbbreviationNode } from '@emmetio/abbreviation';
+import { ResolvedConfig } from '../../types';
+import walk, { WalkState, WalkNext, createWalkState } from './walk';
+import { pushNewline, pushString } from '../../output-stream';
+import { isSnippet } from './utils';
+import { pushPrimaryAttributes, pushSecondaryAttributes, pushValue, collectAttributes } from './indent-format';
+
+export default function pug(abbr: Abbreviation, config: ResolvedConfig): string {
+ const state = createWalkState(config);
+ walk(abbr, element, state);
+ return state.out.value;
+}
+
+/**
+ * Outputs `node` content to output stream of `state`
+ * @param node Context node
+ * @param index Index of `node` in `items`
+ * @param items List of `node`’s siblings
+ * @param state Current walk state
+ */
+function element(node: AbbreviationNode, index: number, items: AbbreviationNode[], state: WalkState, next: WalkNext) {
+ const { out } = state;
+ const { primary, secondary } = collectAttributes(node);
+
+ // Pick offset level for current node
+ const level = state.parent ? 1 : 0;
+ out.level += level;
+
+ // Do not indent top-level elements
+ if (shouldFormat(node, index, items, state)) {
+ pushNewline(out, true);
+ }
+
+ if (node.name && (node.name !== 'div' || !primary.length)) {
+ pushString(out, node.name);
+ }
+
+ pushPrimaryAttributes(primary, state);
+ pushSecondaryAttributes(secondary, state, {
+ before: '(',
+ after: ')',
+ glue: ', ',
+ booleanValue: ''
+ });
+
+ pushValue(node, state, '| ');
+ node.children.forEach(next);
+
+ out.level -= level;
+}
+
+function shouldFormat(node: AbbreviationNode, index: number, items: AbbreviationNode[], state: WalkState): boolean {
+ // Do not format first top-level element or snippets
+ if (!state.parent && index === 0) {
+ return false;
+ }
+ return !isSnippet(node);
+}
| 58 | Working on Pug formatter | 0 | .ts | ts | mit | emmetio/emmet |
10072355 | <NME> index.ts
<BEF> import Scanner, { isAlphaWord, isAlpha, isNumber, isAlphaNumericWord, isSpace, isQuote } from '@emmetio/scanner';
import { AllTokens, Literal, OperatorType, NumberValue, ColorValue, WhiteSpace, Operator, Bracket, StringValue, Field } from './tokens';
import { Chars } from './utils';
export * from './tokens';
export default function tokenize(abbr: string, isValue?: boolean): AllTokens[] {
let brackets = 0;
let token: AllTokens | undefined;
const scanner = new Scanner(abbr);
const tokens: AllTokens[] = [];
while (!scanner.eof()) {
token = field(scanner)
|| numberValue(scanner)
|| colorValue(scanner)
|| stringValue(scanner)
|| bracket(scanner)
|| operator(scanner)
|| whiteSpace(scanner)
|| literal(scanner, brackets === 0 && !isValue);
if (!token) {
throw scanner.error('Unexpected character');
}
if (token.type === 'Bracket') {
if (!brackets && token.open) {
mergeTokens(scanner, tokens);
}
brackets += token.open ? 1 : -1;
if (brackets < 0) {
throw scanner.error('Unexpected bracket', token.start);
}
}
tokens.push(token);
// Forcibly consume next operator after unit-less numeric value or color:
// next dash `-` must be used as value delimiter
if (shouldConsumeDashAfter(token) && (token = operator(scanner))) {
tokens.push(token);
}
}
return tokens;
}
/**
* Returns next token from given scanner, if possible
*/
export function getToken(scanner: Scanner, short?: boolean) {
return field(scanner)
|| numberValue(scanner)
|| colorValue(scanner)
|| stringValue(scanner)
|| bracket(scanner)
|| operator(scanner)
|| whiteSpace(scanner)
|| literal(scanner, short);
}
function field(scanner: Scanner): Field | undefined {
const start = scanner.pos;
if (scanner.eat(Chars.Dollar) && scanner.eat(Chars.CurlyBracketOpen)) {
scanner.start = scanner.pos;
let index: number | undefined;
let name: string = '';
if (scanner.eatWhile(isNumber)) {
// It’s a field
index = Number(scanner.current());
name = scanner.eat(Chars.Colon) ? consumePlaceholder(scanner) : '';
} else if (isAlpha(scanner.peek())) {
// It’s a variable
name = consumePlaceholder(scanner);
}
if (scanner.eat(Chars.CurlyBracketClose)) {
return {
type: 'Field',
index, name,
start,
end: scanner.pos
};
}
throw scanner.error('Expecting }');
}
// If we reached here then there’s no valid field here, revert
// back to starting position
scanner.pos = start;
}
/**
* Consumes a placeholder: value right after `:` in field. Could be empty
*/
function consumePlaceholder(stream: Scanner): string {
const stack: number[] = [];
stream.start = stream.pos;
while (!stream.eof()) {
if (stream.eat(Chars.CurlyBracketOpen)) {
stack.push(stream.pos);
} else if (stream.eat(Chars.CurlyBracketClose)) {
if (!stack.length) {
stream.pos--;
break;
}
stack.pop();
} else {
stream.pos++;
}
}
if (stack.length) {
stream.pos = stack.pop()!;
throw stream.error(`Expecting }`);
}
return stream.current();
}
/**
* Consumes literal from given scanner
* @param short Use short notation for consuming value.
* The difference between “short” and “full” notation is that first one uses
* alpha characters only and used for extracting keywords from abbreviation,
* while “full” notation also supports numbers and dashes
*/
function literal(scanner: Scanner, short?: boolean): Literal | undefined {
const start = scanner.pos;
if (scanner.eat(isIdentPrefix)) {
// SCSS or LESS variable
// NB a bit dirty hack: if abbreviation starts with identifier prefix,
// consume alpha characters only to allow embedded variables
scanner.eatWhile(start ? isKeyword : isLiteral);
} else if (scanner.eat(isAlphaWord)) {
scanner.eatWhile(short ? isLiteral : isKeyword);
} else {
// Allow dots only at the beginning of literal
scanner.eat(Chars.Dot);
scanner.eatWhile(isLiteral);
}
if (start !== scanner.pos) {
scanner.start = start;
return createLiteral(scanner, scanner.start = start);
}
}
function createLiteral(scanner: Scanner, start = scanner.start, end = scanner.pos): Literal {
return {
type: 'Literal',
value: scanner.substring(start, end),
start,
end
};
}
/**
* Consumes numeric CSS value (number with optional unit) from current stream,
* if possible
*/
function numberValue(scanner: Scanner): NumberValue | undefined {
const start = scanner.pos;
if (consumeNumber(scanner)) {
scanner.start = start;
const rawValue = scanner.current();
// eat unit, which can be a % or alpha word
scanner.start = scanner.pos;
scanner.eat(Chars.Percent) || scanner.eatWhile(isAlphaWord);
return {
type: 'NumberValue',
value: Number(rawValue),
rawValue,
unit: scanner.current(),
start,
end: scanner.pos
};
}
}
/**
* Consumes quoted string value from given scanner
*/
function stringValue(scanner: Scanner): StringValue | undefined {
const ch = scanner.peek();
const start = scanner.pos;
let finished = false;
if (isQuote(ch)) {
scanner.pos++;
while (!scanner.eof()) {
// Do not throw error on malformed string
if (scanner.eat(ch)) {
finished = true;
break;
} else {
scanner.pos++;
}
}
scanner.start = start;
return {
type: 'StringValue',
value: scanner.substring(start + 1, scanner.pos - (finished ? 1 : 0)),
quote: ch === Chars.SingleQuote ? 'single' : 'double',
start,
end: scanner.pos
};
}
}
/**
* Consumes a color token from given string
*/
function colorValue(scanner: Scanner): ColorValue | Literal | undefined {
// supported color variations:
// #abc → #aabbccc
// #0 → #000000
// #fff.5 → rgba(255, 255, 255, 0.5)
// #t → transparent
const start = scanner.pos;
if (scanner.eat(Chars.Hash)) {
const valueStart = scanner.pos;
let color = '';
let alpha = '';
if (scanner.eatWhile(isHex)) {
color = scanner.substring(valueStart, scanner.pos);
alpha = colorAlpha(scanner);
} else if (scanner.eat(Chars.Transparent)) {
color = '0';
alpha = colorAlpha(scanner) || '0';
} else {
alpha = colorAlpha(scanner);
}
if (color || alpha || scanner.eof()) {
const { r, g, b, a } = parseColor(color, alpha);
return {
type: 'ColorValue',
r, g, b, a,
raw: scanner.substring(start + 1, scanner.pos),
start,
end: scanner.pos
};
} else {
// Consumed # but no actual value: invalid color value, treat it as literal
return createLiteral(scanner, start);
}
}
scanner.pos = start;
}
/**
* Consumes alpha value of color: `.1`
*/
function colorAlpha(scanner: Scanner): string {
const start = scanner.pos;
if (scanner.eat(Chars.Dot)) {
scanner.start = start;
if (scanner.eatWhile(isNumber)) {
return scanner.current();
}
return '1';
}
return '';
}
/**
* Consumes white space characters as string literal from given scanner
*/
function whiteSpace(scanner: Scanner): WhiteSpace | undefined {
const start = scanner.pos;
if (scanner.eatWhile(isSpace)) {
return {
type: 'WhiteSpace',
start,
end: scanner.pos
};
}
}
/**
* Consumes bracket from given scanner
*/
function bracket(scanner: Scanner): Bracket | undefined {
const ch = scanner.peek();
if (isBracket(ch)) {
return {
type: 'Bracket',
open: ch === Chars.RoundBracketOpen,
start: scanner.pos++,
end: scanner.pos
};
}
}
/**
* Consumes operator from given scanner
*/
function operator(scanner: Scanner): Operator | undefined {
const op = operatorType(scanner.peek());
if (op) {
return {
type: 'Operator',
operator: op,
start: scanner.pos++,
end: scanner.pos
};
}
}
/**
* Eats number value from given stream
* @return Returns `true` if number was consumed
*/
function consumeNumber(stream: Scanner): boolean {
const start = stream.pos;
stream.eat(Chars.Dash);
const afterNegative = stream.pos;
const hasDecimal = stream.eatWhile(isNumber);
const prevPos = stream.pos;
if (stream.eat(Chars.Dot)) {
// It’s perfectly valid to have numbers like `1.`, which enforces
// value to float unit type
const hasFloat = stream.eatWhile(isNumber);
if (!hasDecimal && !hasFloat) {
// Lone dot
stream.pos = prevPos;
}
}
// Edge case: consumed dash only: not a number, bail-out
if (stream.pos === afterNegative) {
stream.pos = start;
}
return stream.pos !== start;
}
function isIdentPrefix(code: number): boolean {
return code === Chars.At || code === Chars.Dollar;
}
/**
* If given character is an operator, returns it’s type
*/
function operatorType(ch: number): OperatorType | undefined {
return (ch === Chars.Sibling && OperatorType.Sibling)
|| (ch === Chars.Excl && OperatorType.Important)
|| (ch === Chars.Comma && OperatorType.ArgumentDelimiter)
|| (ch === Chars.Colon && OperatorType.PropertyDelimiter)
|| (ch === Chars.Dash && OperatorType.ValueDelimiter)
|| void 0;
}
/**
* Check if given code is a hex value (/0-9a-f/)
*/
function isHex(code: number): boolean {
return isNumber(code) || isAlpha(code, 65, 70); // A-F
}
function isKeyword(code: number): boolean {
return isAlphaNumericWord(code) || code === Chars.Dash;
}
function isBracket(code: number) {
return code === Chars.RoundBracketOpen || code === Chars.RoundBracketClose;
}
function isLiteral(code: number) {
return isAlphaWord(code) || code === Chars.Percent || code === Chars.Slash;
}
/**
* Parses given color value from abbreviation into RGBA format
*/
function parseColor(value: string, alpha?: string): { r: number, g: number, b: number, a: number } {
let r = '0';
let g = '0';
let b = '0';
let a = Number(alpha != null && alpha !== '' ? alpha : 1);
if (value === 't') {
a = 0;
} else {
switch (value.length) {
case 0:
break;
case 1:
r = g = b = value + value;
break;
case 2:
r = g = b = value;
break;
case 3:
r = value[0] + value[0];
g = value[1] + value[1];
b = value[2] + value[2];
break;
default:
value += value;
r = value.slice(0, 2);
g = value.slice(2, 4);
b = value.slice(4, 6);
}
}
return {
r: parseInt(r, 16),
g: parseInt(g, 16),
b: parseInt(b, 16),
a
};
}
/**
* Check if scanner reader must consume dash after given token.
* Used in cases where user must explicitly separate numeric values
*/
function shouldConsumeDashAfter(token: AllTokens): boolean {
return token.type === 'ColorValue' || (token.type === 'NumberValue' && !token.unit);
}
/**
* Merges last adjacent tokens into a single literal.
* This function is used to overcome edge case when function name was parsed
* as a list of separate tokens. For example, a `scale3d()` value will be
* parsed as literal and number tokens (`scale` and `3d`) which is a perfectly
* valid abbreviation but undesired result. This function will detect last adjacent
* literal and number values and combine them into single literal
*/
function mergeTokens(scanner: Scanner, tokens: AllTokens[]) {
let start = 0;
let end = 0;
while (tokens.length) {
const token = last(tokens)!;
if (token.type === 'Literal' || token.type === 'NumberValue') {
start = token.start!;
if (!end) {
end = token.end!;
}
tokens.pop();
} else {
break;
}
}
if (start !== end) {
tokens.push(createLiteral(scanner, start, end));
}
}
function last<T>(arr: T[]): T | undefined {
return arr[arr.length - 1];
}
<MSG> Code refactoring
<DFF> @@ -11,14 +11,7 @@ export default function tokenize(abbr: string, isValue?: boolean): AllTokens[] {
const tokens: AllTokens[] = [];
while (!scanner.eof()) {
- token = field(scanner)
- || numberValue(scanner)
- || colorValue(scanner)
- || stringValue(scanner)
- || bracket(scanner)
- || operator(scanner)
- || whiteSpace(scanner)
- || literal(scanner, brackets === 0 && !isValue);
+ token = getToken(scanner, brackets === 0 && !isValue);
if (!token) {
throw scanner.error('Unexpected character');
| 1 | Code refactoring | 8 | .ts | ts | mit | emmetio/emmet |
10072356 | <NME> index.ts
<BEF> import Scanner, { isAlphaWord, isAlpha, isNumber, isAlphaNumericWord, isSpace, isQuote } from '@emmetio/scanner';
import { AllTokens, Literal, OperatorType, NumberValue, ColorValue, WhiteSpace, Operator, Bracket, StringValue, Field } from './tokens';
import { Chars } from './utils';
export * from './tokens';
export default function tokenize(abbr: string, isValue?: boolean): AllTokens[] {
let brackets = 0;
let token: AllTokens | undefined;
const scanner = new Scanner(abbr);
const tokens: AllTokens[] = [];
while (!scanner.eof()) {
token = field(scanner)
|| numberValue(scanner)
|| colorValue(scanner)
|| stringValue(scanner)
|| bracket(scanner)
|| operator(scanner)
|| whiteSpace(scanner)
|| literal(scanner, brackets === 0 && !isValue);
if (!token) {
throw scanner.error('Unexpected character');
}
if (token.type === 'Bracket') {
if (!brackets && token.open) {
mergeTokens(scanner, tokens);
}
brackets += token.open ? 1 : -1;
if (brackets < 0) {
throw scanner.error('Unexpected bracket', token.start);
}
}
tokens.push(token);
// Forcibly consume next operator after unit-less numeric value or color:
// next dash `-` must be used as value delimiter
if (shouldConsumeDashAfter(token) && (token = operator(scanner))) {
tokens.push(token);
}
}
return tokens;
}
/**
* Returns next token from given scanner, if possible
*/
export function getToken(scanner: Scanner, short?: boolean) {
return field(scanner)
|| numberValue(scanner)
|| colorValue(scanner)
|| stringValue(scanner)
|| bracket(scanner)
|| operator(scanner)
|| whiteSpace(scanner)
|| literal(scanner, short);
}
function field(scanner: Scanner): Field | undefined {
const start = scanner.pos;
if (scanner.eat(Chars.Dollar) && scanner.eat(Chars.CurlyBracketOpen)) {
scanner.start = scanner.pos;
let index: number | undefined;
let name: string = '';
if (scanner.eatWhile(isNumber)) {
// It’s a field
index = Number(scanner.current());
name = scanner.eat(Chars.Colon) ? consumePlaceholder(scanner) : '';
} else if (isAlpha(scanner.peek())) {
// It’s a variable
name = consumePlaceholder(scanner);
}
if (scanner.eat(Chars.CurlyBracketClose)) {
return {
type: 'Field',
index, name,
start,
end: scanner.pos
};
}
throw scanner.error('Expecting }');
}
// If we reached here then there’s no valid field here, revert
// back to starting position
scanner.pos = start;
}
/**
* Consumes a placeholder: value right after `:` in field. Could be empty
*/
function consumePlaceholder(stream: Scanner): string {
const stack: number[] = [];
stream.start = stream.pos;
while (!stream.eof()) {
if (stream.eat(Chars.CurlyBracketOpen)) {
stack.push(stream.pos);
} else if (stream.eat(Chars.CurlyBracketClose)) {
if (!stack.length) {
stream.pos--;
break;
}
stack.pop();
} else {
stream.pos++;
}
}
if (stack.length) {
stream.pos = stack.pop()!;
throw stream.error(`Expecting }`);
}
return stream.current();
}
/**
* Consumes literal from given scanner
* @param short Use short notation for consuming value.
* The difference between “short” and “full” notation is that first one uses
* alpha characters only and used for extracting keywords from abbreviation,
* while “full” notation also supports numbers and dashes
*/
function literal(scanner: Scanner, short?: boolean): Literal | undefined {
const start = scanner.pos;
if (scanner.eat(isIdentPrefix)) {
// SCSS or LESS variable
// NB a bit dirty hack: if abbreviation starts with identifier prefix,
// consume alpha characters only to allow embedded variables
scanner.eatWhile(start ? isKeyword : isLiteral);
} else if (scanner.eat(isAlphaWord)) {
scanner.eatWhile(short ? isLiteral : isKeyword);
} else {
// Allow dots only at the beginning of literal
scanner.eat(Chars.Dot);
scanner.eatWhile(isLiteral);
}
if (start !== scanner.pos) {
scanner.start = start;
return createLiteral(scanner, scanner.start = start);
}
}
function createLiteral(scanner: Scanner, start = scanner.start, end = scanner.pos): Literal {
return {
type: 'Literal',
value: scanner.substring(start, end),
start,
end
};
}
/**
* Consumes numeric CSS value (number with optional unit) from current stream,
* if possible
*/
function numberValue(scanner: Scanner): NumberValue | undefined {
const start = scanner.pos;
if (consumeNumber(scanner)) {
scanner.start = start;
const rawValue = scanner.current();
// eat unit, which can be a % or alpha word
scanner.start = scanner.pos;
scanner.eat(Chars.Percent) || scanner.eatWhile(isAlphaWord);
return {
type: 'NumberValue',
value: Number(rawValue),
rawValue,
unit: scanner.current(),
start,
end: scanner.pos
};
}
}
/**
* Consumes quoted string value from given scanner
*/
function stringValue(scanner: Scanner): StringValue | undefined {
const ch = scanner.peek();
const start = scanner.pos;
let finished = false;
if (isQuote(ch)) {
scanner.pos++;
while (!scanner.eof()) {
// Do not throw error on malformed string
if (scanner.eat(ch)) {
finished = true;
break;
} else {
scanner.pos++;
}
}
scanner.start = start;
return {
type: 'StringValue',
value: scanner.substring(start + 1, scanner.pos - (finished ? 1 : 0)),
quote: ch === Chars.SingleQuote ? 'single' : 'double',
start,
end: scanner.pos
};
}
}
/**
* Consumes a color token from given string
*/
function colorValue(scanner: Scanner): ColorValue | Literal | undefined {
// supported color variations:
// #abc → #aabbccc
// #0 → #000000
// #fff.5 → rgba(255, 255, 255, 0.5)
// #t → transparent
const start = scanner.pos;
if (scanner.eat(Chars.Hash)) {
const valueStart = scanner.pos;
let color = '';
let alpha = '';
if (scanner.eatWhile(isHex)) {
color = scanner.substring(valueStart, scanner.pos);
alpha = colorAlpha(scanner);
} else if (scanner.eat(Chars.Transparent)) {
color = '0';
alpha = colorAlpha(scanner) || '0';
} else {
alpha = colorAlpha(scanner);
}
if (color || alpha || scanner.eof()) {
const { r, g, b, a } = parseColor(color, alpha);
return {
type: 'ColorValue',
r, g, b, a,
raw: scanner.substring(start + 1, scanner.pos),
start,
end: scanner.pos
};
} else {
// Consumed # but no actual value: invalid color value, treat it as literal
return createLiteral(scanner, start);
}
}
scanner.pos = start;
}
/**
* Consumes alpha value of color: `.1`
*/
function colorAlpha(scanner: Scanner): string {
const start = scanner.pos;
if (scanner.eat(Chars.Dot)) {
scanner.start = start;
if (scanner.eatWhile(isNumber)) {
return scanner.current();
}
return '1';
}
return '';
}
/**
* Consumes white space characters as string literal from given scanner
*/
function whiteSpace(scanner: Scanner): WhiteSpace | undefined {
const start = scanner.pos;
if (scanner.eatWhile(isSpace)) {
return {
type: 'WhiteSpace',
start,
end: scanner.pos
};
}
}
/**
* Consumes bracket from given scanner
*/
function bracket(scanner: Scanner): Bracket | undefined {
const ch = scanner.peek();
if (isBracket(ch)) {
return {
type: 'Bracket',
open: ch === Chars.RoundBracketOpen,
start: scanner.pos++,
end: scanner.pos
};
}
}
/**
* Consumes operator from given scanner
*/
function operator(scanner: Scanner): Operator | undefined {
const op = operatorType(scanner.peek());
if (op) {
return {
type: 'Operator',
operator: op,
start: scanner.pos++,
end: scanner.pos
};
}
}
/**
* Eats number value from given stream
* @return Returns `true` if number was consumed
*/
function consumeNumber(stream: Scanner): boolean {
const start = stream.pos;
stream.eat(Chars.Dash);
const afterNegative = stream.pos;
const hasDecimal = stream.eatWhile(isNumber);
const prevPos = stream.pos;
if (stream.eat(Chars.Dot)) {
// It’s perfectly valid to have numbers like `1.`, which enforces
// value to float unit type
const hasFloat = stream.eatWhile(isNumber);
if (!hasDecimal && !hasFloat) {
// Lone dot
stream.pos = prevPos;
}
}
// Edge case: consumed dash only: not a number, bail-out
if (stream.pos === afterNegative) {
stream.pos = start;
}
return stream.pos !== start;
}
function isIdentPrefix(code: number): boolean {
return code === Chars.At || code === Chars.Dollar;
}
/**
* If given character is an operator, returns it’s type
*/
function operatorType(ch: number): OperatorType | undefined {
return (ch === Chars.Sibling && OperatorType.Sibling)
|| (ch === Chars.Excl && OperatorType.Important)
|| (ch === Chars.Comma && OperatorType.ArgumentDelimiter)
|| (ch === Chars.Colon && OperatorType.PropertyDelimiter)
|| (ch === Chars.Dash && OperatorType.ValueDelimiter)
|| void 0;
}
/**
* Check if given code is a hex value (/0-9a-f/)
*/
function isHex(code: number): boolean {
return isNumber(code) || isAlpha(code, 65, 70); // A-F
}
function isKeyword(code: number): boolean {
return isAlphaNumericWord(code) || code === Chars.Dash;
}
function isBracket(code: number) {
return code === Chars.RoundBracketOpen || code === Chars.RoundBracketClose;
}
function isLiteral(code: number) {
return isAlphaWord(code) || code === Chars.Percent || code === Chars.Slash;
}
/**
* Parses given color value from abbreviation into RGBA format
*/
function parseColor(value: string, alpha?: string): { r: number, g: number, b: number, a: number } {
let r = '0';
let g = '0';
let b = '0';
let a = Number(alpha != null && alpha !== '' ? alpha : 1);
if (value === 't') {
a = 0;
} else {
switch (value.length) {
case 0:
break;
case 1:
r = g = b = value + value;
break;
case 2:
r = g = b = value;
break;
case 3:
r = value[0] + value[0];
g = value[1] + value[1];
b = value[2] + value[2];
break;
default:
value += value;
r = value.slice(0, 2);
g = value.slice(2, 4);
b = value.slice(4, 6);
}
}
return {
r: parseInt(r, 16),
g: parseInt(g, 16),
b: parseInt(b, 16),
a
};
}
/**
* Check if scanner reader must consume dash after given token.
* Used in cases where user must explicitly separate numeric values
*/
function shouldConsumeDashAfter(token: AllTokens): boolean {
return token.type === 'ColorValue' || (token.type === 'NumberValue' && !token.unit);
}
/**
* Merges last adjacent tokens into a single literal.
* This function is used to overcome edge case when function name was parsed
* as a list of separate tokens. For example, a `scale3d()` value will be
* parsed as literal and number tokens (`scale` and `3d`) which is a perfectly
* valid abbreviation but undesired result. This function will detect last adjacent
* literal and number values and combine them into single literal
*/
function mergeTokens(scanner: Scanner, tokens: AllTokens[]) {
let start = 0;
let end = 0;
while (tokens.length) {
const token = last(tokens)!;
if (token.type === 'Literal' || token.type === 'NumberValue') {
start = token.start!;
if (!end) {
end = token.end!;
}
tokens.pop();
} else {
break;
}
}
if (start !== end) {
tokens.push(createLiteral(scanner, start, end));
}
}
function last<T>(arr: T[]): T | undefined {
return arr[arr.length - 1];
}
<MSG> Code refactoring
<DFF> @@ -11,14 +11,7 @@ export default function tokenize(abbr: string, isValue?: boolean): AllTokens[] {
const tokens: AllTokens[] = [];
while (!scanner.eof()) {
- token = field(scanner)
- || numberValue(scanner)
- || colorValue(scanner)
- || stringValue(scanner)
- || bracket(scanner)
- || operator(scanner)
- || whiteSpace(scanner)
- || literal(scanner, brackets === 0 && !isValue);
+ token = getToken(scanner, brackets === 0 && !isValue);
if (!token) {
throw scanner.error('Unexpected character');
| 1 | Code refactoring | 8 | .ts | ts | mit | emmetio/emmet |
10072357 | <NME> spec_helper.rb
<BEF> require 'rubygems'
require 'bundler/setup'
require 'split'
def session
@session ||= {}
require "simplecov"
def params
@params ||= {}
end
let(:mock_user) { Split::User.new(double(session: {})) }
before(:each) do
Split.configuration = Split::Configuration.new
Split.redis = Redis.new
Split.redis.select(10)
Split.redis.flushdb
Split::Cache.clear
@ab_user = mock_user
@params = nil
end
end
RSpec.configure do |config|
config.order = "random"
config.include GlobalSharedContext
config.raise_errors_for_deprecations!
end
def session
@session ||= {}
end
def params
@params ||= {}
end
def request(ua = "Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_6_6; de-de) AppleWebKit/533.20.25 (KHTML, like Gecko) Version/5.0.4 Safari/533.20.27")
@request ||= begin
r = OpenStruct.new
r.user_agent = ua
r.ip = "192.168.1.1"
r
end
end
<MSG> Ignore robots and given the control alternative
<DFF> @@ -1,6 +1,7 @@
require 'rubygems'
require 'bundler/setup'
require 'split'
+require 'ostruct'
def session
@session ||= {}
@@ -8,4 +9,10 @@ end
def params
@params ||= {}
+end
+
+def request(ua = 'Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_6_6; de-de) AppleWebKit/533.20.25 (KHTML, like Gecko) Version/5.0.4 Safari/533.20.27')
+ r = OpenStruct.new
+ r.user_agent = ua
+ @request ||= r
end
\ No newline at end of file
| 7 | Ignore robots and given the control alternative | 0 | .rb | rb | mit | splitrb/split |
10072358 | <NME> spec_helper.rb
<BEF> require 'rubygems'
require 'bundler/setup'
require 'split'
def session
@session ||= {}
require "simplecov"
def params
@params ||= {}
end
let(:mock_user) { Split::User.new(double(session: {})) }
before(:each) do
Split.configuration = Split::Configuration.new
Split.redis = Redis.new
Split.redis.select(10)
Split.redis.flushdb
Split::Cache.clear
@ab_user = mock_user
@params = nil
end
end
RSpec.configure do |config|
config.order = "random"
config.include GlobalSharedContext
config.raise_errors_for_deprecations!
end
def session
@session ||= {}
end
def params
@params ||= {}
end
def request(ua = "Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_6_6; de-de) AppleWebKit/533.20.25 (KHTML, like Gecko) Version/5.0.4 Safari/533.20.27")
@request ||= begin
r = OpenStruct.new
r.user_agent = ua
r.ip = "192.168.1.1"
r
end
end
<MSG> Ignore robots and given the control alternative
<DFF> @@ -1,6 +1,7 @@
require 'rubygems'
require 'bundler/setup'
require 'split'
+require 'ostruct'
def session
@session ||= {}
@@ -8,4 +9,10 @@ end
def params
@params ||= {}
+end
+
+def request(ua = 'Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_6_6; de-de) AppleWebKit/533.20.25 (KHTML, like Gecko) Version/5.0.4 Safari/533.20.27')
+ r = OpenStruct.new
+ r.user_agent = ua
+ @request ||= r
end
\ No newline at end of file
| 7 | Ignore robots and given the control alternative | 0 | .rb | rb | mit | splitrb/split |
10072359 | <NME> spec_helper.rb
<BEF> require 'rubygems'
require 'bundler/setup'
require 'split'
def session
@session ||= {}
require "simplecov"
def params
@params ||= {}
end
let(:mock_user) { Split::User.new(double(session: {})) }
before(:each) do
Split.configuration = Split::Configuration.new
Split.redis = Redis.new
Split.redis.select(10)
Split.redis.flushdb
Split::Cache.clear
@ab_user = mock_user
@params = nil
end
end
RSpec.configure do |config|
config.order = "random"
config.include GlobalSharedContext
config.raise_errors_for_deprecations!
end
def session
@session ||= {}
end
def params
@params ||= {}
end
def request(ua = "Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_6_6; de-de) AppleWebKit/533.20.25 (KHTML, like Gecko) Version/5.0.4 Safari/533.20.27")
@request ||= begin
r = OpenStruct.new
r.user_agent = ua
r.ip = "192.168.1.1"
r
end
end
<MSG> Ignore robots and given the control alternative
<DFF> @@ -1,6 +1,7 @@
require 'rubygems'
require 'bundler/setup'
require 'split'
+require 'ostruct'
def session
@session ||= {}
@@ -8,4 +9,10 @@ end
def params
@params ||= {}
+end
+
+def request(ua = 'Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_6_6; de-de) AppleWebKit/533.20.25 (KHTML, like Gecko) Version/5.0.4 Safari/533.20.27')
+ r = OpenStruct.new
+ r.user_agent = ua
+ @request ||= r
end
\ No newline at end of file
| 7 | Ignore robots and given the control alternative | 0 | .rb | rb | mit | splitrb/split |
10072360 | <NME> configuration.rb
<BEF> # frozen_string_literal: true
module Split
class Configuration
attr_accessor :ignore_ip_addresses
attr_accessor :ignore_filter
'Gigabot' => 'Gigabot spider',
'Googlebot' => 'Google spider',
'msnbot' => 'Microsoft bot',
'rogerbot' => 'SeoMoz spider',
'Slurp' => 'Yahoo spider',
'Sogou' => 'Chinese search engine',
attr_accessor :persistence_cookie_domain
attr_accessor :algorithm
attr_accessor :store_override
attr_accessor :start_manually
attr_accessor :reset_manually
attr_accessor :on_trial
attr_accessor :on_trial_choose
attr_accessor :on_trial_complete
attr_accessor :on_experiment_reset
attr_accessor :on_experiment_delete
attr_accessor :on_before_experiment_reset
attr_accessor :on_experiment_winner_choose
attr_accessor :on_before_experiment_delete
attr_accessor :include_rails_helper
attr_accessor :beta_probability_simulations
attr_accessor :winning_alternative_recalculation_interval
attr_accessor :redis
attr_accessor :dashboard_pagination_default_per_page
attr_accessor :cache
attr_reader :experiments
attr_writer :bots
attr_writer :robot_regex
def bots
@bots ||= {
# Indexers
"AdsBot-Google" => "Google Adwords",
"Baidu" => "Chinese search engine",
"Baiduspider" => "Chinese search engine",
"bingbot" => "Microsoft bing bot",
"Butterfly" => "Topsy Labs",
"Gigabot" => "Gigabot spider",
"Googlebot" => "Google spider",
"MJ12bot" => "Majestic-12 spider",
"msnbot" => "Microsoft bot",
"rogerbot" => "SeoMoz spider",
"PaperLiBot" => "PaperLi is another content curation service",
"Slurp" => "Yahoo spider",
"Sogou" => "Chinese search engine",
"spider" => "generic web spider",
"UnwindFetchor" => "Gnip crawler",
"WordPress" => "WordPress spider",
"YandexAccessibilityBot" => "Yandex accessibility spider",
"YandexBot" => "Yandex spider",
"YandexMobileBot" => "Yandex mobile spider",
"ZIBB" => "ZIBB spider",
# HTTP libraries
"Apache-HttpClient" => "Java http library",
"AppEngine-Google" => "Google App Engine",
"curl" => "curl unix CLI http client",
"ColdFusion" => "ColdFusion http library",
"EventMachine HttpClient" => "Ruby http library",
"Go http package" => "Go http library",
"Go-http-client" => "Go http library",
"Java" => "Generic Java http library",
"libwww-perl" => "Perl client-server library loved by script kids",
"lwp-trivial" => "Another Perl library loved by script kids",
"Python-urllib" => "Python http library",
"PycURL" => "Python http library",
"Test Certificate Info" => "C http library?",
"Typhoeus" => "Ruby http library",
"Wget" => "wget unix CLI http client",
# URL expanders / previewers
"awe.sm" => "Awe.sm URL expander",
"bitlybot" => "bit.ly bot",
"[email protected]" => "Linkfluence bot",
"facebookexternalhit" => "facebook bot",
"Facebot" => "Facebook crawler",
"Feedfetcher-Google" => "Google Feedfetcher",
"https://developers.google.com/+/web/snippet" => "Google+ Snippet Fetcher",
"LinkedInBot" => "LinkedIn bot",
"LongURL" => "URL expander service",
"NING" => "NING - Yet Another Twitter Swarmer",
"Pinterestbot" => "Pinterest Bot",
"redditbot" => "Reddit Bot",
"ShortLinkTranslate" => "Link shortener",
"Slackbot" => "Slackbot link expander",
"TweetmemeBot" => "TweetMeMe Crawler",
"Twitterbot" => "Twitter URL expander",
"UnwindFetch" => "Gnip URL expander",
"vkShare" => "VKontake Sharer",
# Uptime monitoring
"check_http" => "Nagios monitor",
"GoogleStackdriverMonitoring" => "Google Cloud monitor",
"NewRelicPinger" => "NewRelic monitor",
"Panopta" => "Monitoring service",
"Pingdom" => "Pingdom monitoring",
"SiteUptime" => "Site monitoring services",
"UptimeRobot" => "Monitoring service",
# ???
"DigitalPersona Fingerprint Software" => "HP Fingerprint scanner",
"ShowyouBot" => "Showyou iOS app spider",
"ZyBorg" => "Zyborg? Hmmm....",
"ELB-HealthChecker" => "ELB Health Check"
}
end
def experiments=(experiments)
raise InvalidExperimentsFormatError.new("Experiments must be a Hash") unless experiments.respond_to?(:keys)
@experiments = experiments
end
def disabled?
!enabled
end
def experiment_for(name)
if normalized_experiments
# TODO symbols
normalized_experiments[name.to_sym]
end
end
def metrics
return @metrics if defined?(@metrics)
@metrics = {}
if self.experiments
self.experiments.each do |key, value|
metrics = value_for(value, :metric) rescue nil
Array(metrics).each do |metric_name|
if metric_name
@metrics[metric_name.to_sym] ||= []
@metrics[metric_name.to_sym] << Split::Experiment.new(key)
end
end
end
end
@metrics
end
def normalized_experiments
return nil if @experiments.nil?
experiment_config = {}
@experiments.keys.each do |name|
experiment_config[name.to_sym] = {}
end
@experiments.each do |experiment_name, settings|
alternatives = if (alts = value_for(settings, :alternatives))
normalize_alternatives(alts)
end
experiment_data = {
alternatives: alternatives,
goals: value_for(settings, :goals),
metadata: value_for(settings, :metadata),
algorithm: value_for(settings, :algorithm),
resettable: value_for(settings, :resettable)
}
experiment_data.each do |name, value|
experiment_config[experiment_name.to_sym][name] = value if value != nil
end
end
experiment_config
end
def normalize_alternatives(alternatives)
given_probability, num_with_probability = alternatives.inject([0, 0]) do |a, v|
p, n = a
if percent = value_for(v, :percent)
[p + percent, n + 1]
else
a
end
end
num_without_probability = alternatives.length - num_with_probability
unassigned_probability = ((100.0 - given_probability) / num_without_probability / 100.0)
if num_with_probability.nonzero?
alternatives = alternatives.map do |v|
if (name = value_for(v, :name)) && (percent = value_for(v, :percent))
{ name => percent / 100.0 }
elsif name = value_for(v, :name)
{ name => unassigned_probability }
else
{ v => unassigned_probability }
end
end
[alternatives.shift, alternatives]
else
alternatives = alternatives.dup
[alternatives.shift, alternatives]
end
end
def robot_regex
@robot_regex ||= /\b(?:#{escaped_bots.join('|')})\b|\A\W*\z/i
end
def initialize
@ignore_ip_addresses = []
@ignore_filter = proc { |request| is_robot? || is_ignored_ip_address? }
@db_failover = false
@db_failover_on_db_error = proc { |error| } # e.g. use Rails logger here
@on_experiment_reset = proc { |experiment| }
@on_experiment_delete = proc { |experiment| }
@on_before_experiment_reset = proc { |experiment| }
@on_before_experiment_delete = proc { |experiment| }
@on_experiment_winner_choose = proc { |experiment| }
@db_failover_allow_parameter_override = false
@allow_multiple_experiments = false
@enabled = true
@experiments = {}
@persistence = Split::Persistence::SessionAdapter
@persistence_cookie_length = 31536000 # One year from now
@persistence_cookie_domain = nil
@algorithm = Split::Algorithms::WeightedSample
@include_rails_helper = true
@beta_probability_simulations = 10000
@winning_alternative_recalculation_interval = 60 * 60 * 24 # 1 day
@redis = ENV.fetch(ENV.fetch("REDIS_PROVIDER", "REDIS_URL"), "redis://localhost:6379")
@dashboard_pagination_default_per_page = 10
end
private
def value_for(hash, key)
if hash.kind_of?(Hash)
hash.has_key?(key.to_s) ? hash[key.to_s] : hash[key.to_sym]
end
end
def escaped_bots
bots.map { |key, _| Regexp.escape(key) }
end
end
end
<MSG> Add Microsoft's Bing bot to the list of bots
<DFF> @@ -7,6 +7,7 @@ module Split
'Gigabot' => 'Gigabot spider',
'Googlebot' => 'Google spider',
'msnbot' => 'Microsoft bot',
+ 'bingbot' => 'Microsoft bing bot',
'rogerbot' => 'SeoMoz spider',
'Slurp' => 'Yahoo spider',
'Sogou' => 'Chinese search engine',
| 1 | Add Microsoft's Bing bot to the list of bots | 0 | .rb | rb | mit | splitrb/split |
10072361 | <NME> configuration.rb
<BEF> # frozen_string_literal: true
module Split
class Configuration
attr_accessor :ignore_ip_addresses
attr_accessor :ignore_filter
'Gigabot' => 'Gigabot spider',
'Googlebot' => 'Google spider',
'msnbot' => 'Microsoft bot',
'rogerbot' => 'SeoMoz spider',
'Slurp' => 'Yahoo spider',
'Sogou' => 'Chinese search engine',
attr_accessor :persistence_cookie_domain
attr_accessor :algorithm
attr_accessor :store_override
attr_accessor :start_manually
attr_accessor :reset_manually
attr_accessor :on_trial
attr_accessor :on_trial_choose
attr_accessor :on_trial_complete
attr_accessor :on_experiment_reset
attr_accessor :on_experiment_delete
attr_accessor :on_before_experiment_reset
attr_accessor :on_experiment_winner_choose
attr_accessor :on_before_experiment_delete
attr_accessor :include_rails_helper
attr_accessor :beta_probability_simulations
attr_accessor :winning_alternative_recalculation_interval
attr_accessor :redis
attr_accessor :dashboard_pagination_default_per_page
attr_accessor :cache
attr_reader :experiments
attr_writer :bots
attr_writer :robot_regex
def bots
@bots ||= {
# Indexers
"AdsBot-Google" => "Google Adwords",
"Baidu" => "Chinese search engine",
"Baiduspider" => "Chinese search engine",
"bingbot" => "Microsoft bing bot",
"Butterfly" => "Topsy Labs",
"Gigabot" => "Gigabot spider",
"Googlebot" => "Google spider",
"MJ12bot" => "Majestic-12 spider",
"msnbot" => "Microsoft bot",
"rogerbot" => "SeoMoz spider",
"PaperLiBot" => "PaperLi is another content curation service",
"Slurp" => "Yahoo spider",
"Sogou" => "Chinese search engine",
"spider" => "generic web spider",
"UnwindFetchor" => "Gnip crawler",
"WordPress" => "WordPress spider",
"YandexAccessibilityBot" => "Yandex accessibility spider",
"YandexBot" => "Yandex spider",
"YandexMobileBot" => "Yandex mobile spider",
"ZIBB" => "ZIBB spider",
# HTTP libraries
"Apache-HttpClient" => "Java http library",
"AppEngine-Google" => "Google App Engine",
"curl" => "curl unix CLI http client",
"ColdFusion" => "ColdFusion http library",
"EventMachine HttpClient" => "Ruby http library",
"Go http package" => "Go http library",
"Go-http-client" => "Go http library",
"Java" => "Generic Java http library",
"libwww-perl" => "Perl client-server library loved by script kids",
"lwp-trivial" => "Another Perl library loved by script kids",
"Python-urllib" => "Python http library",
"PycURL" => "Python http library",
"Test Certificate Info" => "C http library?",
"Typhoeus" => "Ruby http library",
"Wget" => "wget unix CLI http client",
# URL expanders / previewers
"awe.sm" => "Awe.sm URL expander",
"bitlybot" => "bit.ly bot",
"[email protected]" => "Linkfluence bot",
"facebookexternalhit" => "facebook bot",
"Facebot" => "Facebook crawler",
"Feedfetcher-Google" => "Google Feedfetcher",
"https://developers.google.com/+/web/snippet" => "Google+ Snippet Fetcher",
"LinkedInBot" => "LinkedIn bot",
"LongURL" => "URL expander service",
"NING" => "NING - Yet Another Twitter Swarmer",
"Pinterestbot" => "Pinterest Bot",
"redditbot" => "Reddit Bot",
"ShortLinkTranslate" => "Link shortener",
"Slackbot" => "Slackbot link expander",
"TweetmemeBot" => "TweetMeMe Crawler",
"Twitterbot" => "Twitter URL expander",
"UnwindFetch" => "Gnip URL expander",
"vkShare" => "VKontake Sharer",
# Uptime monitoring
"check_http" => "Nagios monitor",
"GoogleStackdriverMonitoring" => "Google Cloud monitor",
"NewRelicPinger" => "NewRelic monitor",
"Panopta" => "Monitoring service",
"Pingdom" => "Pingdom monitoring",
"SiteUptime" => "Site monitoring services",
"UptimeRobot" => "Monitoring service",
# ???
"DigitalPersona Fingerprint Software" => "HP Fingerprint scanner",
"ShowyouBot" => "Showyou iOS app spider",
"ZyBorg" => "Zyborg? Hmmm....",
"ELB-HealthChecker" => "ELB Health Check"
}
end
def experiments=(experiments)
raise InvalidExperimentsFormatError.new("Experiments must be a Hash") unless experiments.respond_to?(:keys)
@experiments = experiments
end
def disabled?
!enabled
end
def experiment_for(name)
if normalized_experiments
# TODO symbols
normalized_experiments[name.to_sym]
end
end
def metrics
return @metrics if defined?(@metrics)
@metrics = {}
if self.experiments
self.experiments.each do |key, value|
metrics = value_for(value, :metric) rescue nil
Array(metrics).each do |metric_name|
if metric_name
@metrics[metric_name.to_sym] ||= []
@metrics[metric_name.to_sym] << Split::Experiment.new(key)
end
end
end
end
@metrics
end
def normalized_experiments
return nil if @experiments.nil?
experiment_config = {}
@experiments.keys.each do |name|
experiment_config[name.to_sym] = {}
end
@experiments.each do |experiment_name, settings|
alternatives = if (alts = value_for(settings, :alternatives))
normalize_alternatives(alts)
end
experiment_data = {
alternatives: alternatives,
goals: value_for(settings, :goals),
metadata: value_for(settings, :metadata),
algorithm: value_for(settings, :algorithm),
resettable: value_for(settings, :resettable)
}
experiment_data.each do |name, value|
experiment_config[experiment_name.to_sym][name] = value if value != nil
end
end
experiment_config
end
def normalize_alternatives(alternatives)
given_probability, num_with_probability = alternatives.inject([0, 0]) do |a, v|
p, n = a
if percent = value_for(v, :percent)
[p + percent, n + 1]
else
a
end
end
num_without_probability = alternatives.length - num_with_probability
unassigned_probability = ((100.0 - given_probability) / num_without_probability / 100.0)
if num_with_probability.nonzero?
alternatives = alternatives.map do |v|
if (name = value_for(v, :name)) && (percent = value_for(v, :percent))
{ name => percent / 100.0 }
elsif name = value_for(v, :name)
{ name => unassigned_probability }
else
{ v => unassigned_probability }
end
end
[alternatives.shift, alternatives]
else
alternatives = alternatives.dup
[alternatives.shift, alternatives]
end
end
def robot_regex
@robot_regex ||= /\b(?:#{escaped_bots.join('|')})\b|\A\W*\z/i
end
def initialize
@ignore_ip_addresses = []
@ignore_filter = proc { |request| is_robot? || is_ignored_ip_address? }
@db_failover = false
@db_failover_on_db_error = proc { |error| } # e.g. use Rails logger here
@on_experiment_reset = proc { |experiment| }
@on_experiment_delete = proc { |experiment| }
@on_before_experiment_reset = proc { |experiment| }
@on_before_experiment_delete = proc { |experiment| }
@on_experiment_winner_choose = proc { |experiment| }
@db_failover_allow_parameter_override = false
@allow_multiple_experiments = false
@enabled = true
@experiments = {}
@persistence = Split::Persistence::SessionAdapter
@persistence_cookie_length = 31536000 # One year from now
@persistence_cookie_domain = nil
@algorithm = Split::Algorithms::WeightedSample
@include_rails_helper = true
@beta_probability_simulations = 10000
@winning_alternative_recalculation_interval = 60 * 60 * 24 # 1 day
@redis = ENV.fetch(ENV.fetch("REDIS_PROVIDER", "REDIS_URL"), "redis://localhost:6379")
@dashboard_pagination_default_per_page = 10
end
private
def value_for(hash, key)
if hash.kind_of?(Hash)
hash.has_key?(key.to_s) ? hash[key.to_s] : hash[key.to_sym]
end
end
def escaped_bots
bots.map { |key, _| Regexp.escape(key) }
end
end
end
<MSG> Add Microsoft's Bing bot to the list of bots
<DFF> @@ -7,6 +7,7 @@ module Split
'Gigabot' => 'Gigabot spider',
'Googlebot' => 'Google spider',
'msnbot' => 'Microsoft bot',
+ 'bingbot' => 'Microsoft bing bot',
'rogerbot' => 'SeoMoz spider',
'Slurp' => 'Yahoo spider',
'Sogou' => 'Chinese search engine',
| 1 | Add Microsoft's Bing bot to the list of bots | 0 | .rb | rb | mit | splitrb/split |
10072362 | <NME> configuration.rb
<BEF> # frozen_string_literal: true
module Split
class Configuration
attr_accessor :ignore_ip_addresses
attr_accessor :ignore_filter
'Gigabot' => 'Gigabot spider',
'Googlebot' => 'Google spider',
'msnbot' => 'Microsoft bot',
'rogerbot' => 'SeoMoz spider',
'Slurp' => 'Yahoo spider',
'Sogou' => 'Chinese search engine',
attr_accessor :persistence_cookie_domain
attr_accessor :algorithm
attr_accessor :store_override
attr_accessor :start_manually
attr_accessor :reset_manually
attr_accessor :on_trial
attr_accessor :on_trial_choose
attr_accessor :on_trial_complete
attr_accessor :on_experiment_reset
attr_accessor :on_experiment_delete
attr_accessor :on_before_experiment_reset
attr_accessor :on_experiment_winner_choose
attr_accessor :on_before_experiment_delete
attr_accessor :include_rails_helper
attr_accessor :beta_probability_simulations
attr_accessor :winning_alternative_recalculation_interval
attr_accessor :redis
attr_accessor :dashboard_pagination_default_per_page
attr_accessor :cache
attr_reader :experiments
attr_writer :bots
attr_writer :robot_regex
def bots
@bots ||= {
# Indexers
"AdsBot-Google" => "Google Adwords",
"Baidu" => "Chinese search engine",
"Baiduspider" => "Chinese search engine",
"bingbot" => "Microsoft bing bot",
"Butterfly" => "Topsy Labs",
"Gigabot" => "Gigabot spider",
"Googlebot" => "Google spider",
"MJ12bot" => "Majestic-12 spider",
"msnbot" => "Microsoft bot",
"rogerbot" => "SeoMoz spider",
"PaperLiBot" => "PaperLi is another content curation service",
"Slurp" => "Yahoo spider",
"Sogou" => "Chinese search engine",
"spider" => "generic web spider",
"UnwindFetchor" => "Gnip crawler",
"WordPress" => "WordPress spider",
"YandexAccessibilityBot" => "Yandex accessibility spider",
"YandexBot" => "Yandex spider",
"YandexMobileBot" => "Yandex mobile spider",
"ZIBB" => "ZIBB spider",
# HTTP libraries
"Apache-HttpClient" => "Java http library",
"AppEngine-Google" => "Google App Engine",
"curl" => "curl unix CLI http client",
"ColdFusion" => "ColdFusion http library",
"EventMachine HttpClient" => "Ruby http library",
"Go http package" => "Go http library",
"Go-http-client" => "Go http library",
"Java" => "Generic Java http library",
"libwww-perl" => "Perl client-server library loved by script kids",
"lwp-trivial" => "Another Perl library loved by script kids",
"Python-urllib" => "Python http library",
"PycURL" => "Python http library",
"Test Certificate Info" => "C http library?",
"Typhoeus" => "Ruby http library",
"Wget" => "wget unix CLI http client",
# URL expanders / previewers
"awe.sm" => "Awe.sm URL expander",
"bitlybot" => "bit.ly bot",
"[email protected]" => "Linkfluence bot",
"facebookexternalhit" => "facebook bot",
"Facebot" => "Facebook crawler",
"Feedfetcher-Google" => "Google Feedfetcher",
"https://developers.google.com/+/web/snippet" => "Google+ Snippet Fetcher",
"LinkedInBot" => "LinkedIn bot",
"LongURL" => "URL expander service",
"NING" => "NING - Yet Another Twitter Swarmer",
"Pinterestbot" => "Pinterest Bot",
"redditbot" => "Reddit Bot",
"ShortLinkTranslate" => "Link shortener",
"Slackbot" => "Slackbot link expander",
"TweetmemeBot" => "TweetMeMe Crawler",
"Twitterbot" => "Twitter URL expander",
"UnwindFetch" => "Gnip URL expander",
"vkShare" => "VKontake Sharer",
# Uptime monitoring
"check_http" => "Nagios monitor",
"GoogleStackdriverMonitoring" => "Google Cloud monitor",
"NewRelicPinger" => "NewRelic monitor",
"Panopta" => "Monitoring service",
"Pingdom" => "Pingdom monitoring",
"SiteUptime" => "Site monitoring services",
"UptimeRobot" => "Monitoring service",
# ???
"DigitalPersona Fingerprint Software" => "HP Fingerprint scanner",
"ShowyouBot" => "Showyou iOS app spider",
"ZyBorg" => "Zyborg? Hmmm....",
"ELB-HealthChecker" => "ELB Health Check"
}
end
def experiments=(experiments)
raise InvalidExperimentsFormatError.new("Experiments must be a Hash") unless experiments.respond_to?(:keys)
@experiments = experiments
end
def disabled?
!enabled
end
def experiment_for(name)
if normalized_experiments
# TODO symbols
normalized_experiments[name.to_sym]
end
end
def metrics
return @metrics if defined?(@metrics)
@metrics = {}
if self.experiments
self.experiments.each do |key, value|
metrics = value_for(value, :metric) rescue nil
Array(metrics).each do |metric_name|
if metric_name
@metrics[metric_name.to_sym] ||= []
@metrics[metric_name.to_sym] << Split::Experiment.new(key)
end
end
end
end
@metrics
end
def normalized_experiments
return nil if @experiments.nil?
experiment_config = {}
@experiments.keys.each do |name|
experiment_config[name.to_sym] = {}
end
@experiments.each do |experiment_name, settings|
alternatives = if (alts = value_for(settings, :alternatives))
normalize_alternatives(alts)
end
experiment_data = {
alternatives: alternatives,
goals: value_for(settings, :goals),
metadata: value_for(settings, :metadata),
algorithm: value_for(settings, :algorithm),
resettable: value_for(settings, :resettable)
}
experiment_data.each do |name, value|
experiment_config[experiment_name.to_sym][name] = value if value != nil
end
end
experiment_config
end
def normalize_alternatives(alternatives)
given_probability, num_with_probability = alternatives.inject([0, 0]) do |a, v|
p, n = a
if percent = value_for(v, :percent)
[p + percent, n + 1]
else
a
end
end
num_without_probability = alternatives.length - num_with_probability
unassigned_probability = ((100.0 - given_probability) / num_without_probability / 100.0)
if num_with_probability.nonzero?
alternatives = alternatives.map do |v|
if (name = value_for(v, :name)) && (percent = value_for(v, :percent))
{ name => percent / 100.0 }
elsif name = value_for(v, :name)
{ name => unassigned_probability }
else
{ v => unassigned_probability }
end
end
[alternatives.shift, alternatives]
else
alternatives = alternatives.dup
[alternatives.shift, alternatives]
end
end
def robot_regex
@robot_regex ||= /\b(?:#{escaped_bots.join('|')})\b|\A\W*\z/i
end
def initialize
@ignore_ip_addresses = []
@ignore_filter = proc { |request| is_robot? || is_ignored_ip_address? }
@db_failover = false
@db_failover_on_db_error = proc { |error| } # e.g. use Rails logger here
@on_experiment_reset = proc { |experiment| }
@on_experiment_delete = proc { |experiment| }
@on_before_experiment_reset = proc { |experiment| }
@on_before_experiment_delete = proc { |experiment| }
@on_experiment_winner_choose = proc { |experiment| }
@db_failover_allow_parameter_override = false
@allow_multiple_experiments = false
@enabled = true
@experiments = {}
@persistence = Split::Persistence::SessionAdapter
@persistence_cookie_length = 31536000 # One year from now
@persistence_cookie_domain = nil
@algorithm = Split::Algorithms::WeightedSample
@include_rails_helper = true
@beta_probability_simulations = 10000
@winning_alternative_recalculation_interval = 60 * 60 * 24 # 1 day
@redis = ENV.fetch(ENV.fetch("REDIS_PROVIDER", "REDIS_URL"), "redis://localhost:6379")
@dashboard_pagination_default_per_page = 10
end
private
def value_for(hash, key)
if hash.kind_of?(Hash)
hash.has_key?(key.to_s) ? hash[key.to_s] : hash[key.to_sym]
end
end
def escaped_bots
bots.map { |key, _| Regexp.escape(key) }
end
end
end
<MSG> Add Microsoft's Bing bot to the list of bots
<DFF> @@ -7,6 +7,7 @@ module Split
'Gigabot' => 'Gigabot spider',
'Googlebot' => 'Google spider',
'msnbot' => 'Microsoft bot',
+ 'bingbot' => 'Microsoft bing bot',
'rogerbot' => 'SeoMoz spider',
'Slurp' => 'Yahoo spider',
'Sogou' => 'Chinese search engine',
| 1 | Add Microsoft's Bing bot to the list of bots | 0 | .rb | rb | mit | splitrb/split |
10072363 | <NME> helper.rb
<BEF> # frozen_string_literal: true
module Split
module Helper
OVERRIDE_PARAM_NAME = "ab_test"
module_function
def ab_test(metric_descriptor, control = nil, *alternatives)
begin
experiment = ExperimentCatalog.find_or_initialize(metric_descriptor, control, *alternatives)
alternative = if Split.configuration.enabled && !exclude_visitor?
experiment.save
raise(Split::InvalidExperimentsFormatError) unless (Split.configuration.experiments || {}).fetch(experiment.name.to_sym, {})[:combined_experiments].nil?
trial = Trial.new(user: ab_user, experiment: experiment,
override: override_alternative(experiment.name), exclude: exclude_visitor?,
disabled: split_generically_disabled?)
alt = trial.choose!(self)
alt ? alt.name : nil
else
control_variable(experiment.control)
end
rescue Errno::ECONNREFUSED, Redis::BaseError, SocketError => e
raise(e) unless Split.configuration.db_failover
Split.configuration.db_failover_on_db_error.call(e)
if Split.configuration.db_failover_allow_parameter_override
alternative = override_alternative(experiment.name) if override_present?(experiment.name)
alternative = control_variable(experiment.control) if split_generically_disabled?
alternative.increment_completion
session[:split].delete(experiment_name) if options[:reset]
end
rescue Errno::ECONNREFUSED => e
raise unless Split.configuration.db_failover
Split.configuration.db_failover_on_db_error.call(e)
end
yield(alternative, metadata || {})
else
alternative
end
end
def reset!(experiment)
ab_user.delete(experiment.key)
end
def finish_experiment(experiment, options = { reset: true })
return false if active_experiments[experiment.name].nil?
return true if experiment.has_winner?
should_reset = experiment.resettable? && options[:reset]
if ab_user[experiment.finished_key] && !should_reset
true
else
alternative_name = ab_user[experiment.key]
trial = Trial.new(
user: ab_user,
experiment: experiment,
alternative: alternative_name,
goals: options[:goals],
)
trial.complete!(self)
if should_reset
reset!(experiment)
else
ab_user[experiment.finished_key] = true
end
end
end
def ab_finished(metric_descriptor, options = { reset: true })
return if exclude_visitor? || Split.configuration.disabled?
metric_descriptor, goals = normalize_metric(metric_descriptor)
experiments = Metric.possible_experiments(metric_descriptor)
if experiments.any?
experiments.each do |experiment|
next if override_present?(experiment.key)
finish_experiment(experiment, options.merge(goals: goals))
end
end
rescue => e
raise unless Split.configuration.db_failover
Split.configuration.db_failover_on_db_error.call(e)
end
def ab_record_extra_info(metric_descriptor, key, value = 1)
return if exclude_visitor? || Split.configuration.disabled?
metric_descriptor, _ = normalize_metric(metric_descriptor)
experiments = Metric.possible_experiments(metric_descriptor)
if experiments.any?
experiments.each do |experiment|
alternative_name = ab_user[experiment.key]
if alternative_name
alternative = experiment.alternatives.find { |alt| alt.name == alternative_name }
alternative.record_extra_info(key, value) if alternative
end
end
end
rescue => e
raise unless Split.configuration.db_failover
Split.configuration.db_failover_on_db_error.call(e)
end
def ab_active_experiments
ab_user.active_experiments
rescue => e
raise unless Split.configuration.db_failover
Split.configuration.db_failover_on_db_error.call(e)
end
end
end
end
rescue Errno::ECONNREFUSED => e
raise unless Split.configuration.db_failover
Split.configuration.db_failover_on_db_error.call(e)
ret = control_variable(control)
def override_alternative_by_params(experiment_name)
defined?(params) && params[OVERRIDE_PARAM_NAME] && params[OVERRIDE_PARAM_NAME][experiment_name]
end
def override_alternative_by_cookies(experiment_name)
return unless defined?(request)
if request.cookies && request.cookies.key?("split_override")
experiments = JSON.parse(request.cookies["split_override"]) rescue {}
experiments[experiment_name]
end
end
def split_generically_disabled?
defined?(params) && params["SPLIT_DISABLE"]
end
def ab_user
@ab_user ||= User.new(self)
end
def exclude_visitor?
defined?(request) && (instance_exec(request, &Split.configuration.ignore_filter) || is_ignored_ip_address? || is_robot? || is_preview?)
end
def is_robot?
defined?(request) && request.user_agent =~ Split.configuration.robot_regex
end
def is_preview?
defined?(request) && defined?(request.headers) && request.headers["x-purpose"] == "preview"
end
def is_ignored_ip_address?
return false if Split.configuration.ignore_ip_addresses.empty?
Split.configuration.ignore_ip_addresses.each do |ip|
return true if defined?(request) && (request.ip == ip || (ip.class == Regexp && request.ip =~ ip))
end
false
end
def active_experiments
ab_user.active_experiments
end
def normalize_metric(metric_descriptor)
if Hash === metric_descriptor
experiment_name = metric_descriptor.keys.first
goals = Array(metric_descriptor.values.first)
else
experiment_name = metric_descriptor
goals = []
end
return experiment_name, goals
end
def control_variable(control)
Hash === control ? control.keys.first.to_s : control.to_s
end
end
end
<MSG> Catch any exceptions, not only ECONNREFUSED
<DFF> @@ -30,7 +30,7 @@ module Split
alternative.increment_completion
session[:split].delete(experiment_name) if options[:reset]
end
- rescue Errno::ECONNREFUSED => e
+ rescue => e
raise unless Split.configuration.db_failover
Split.configuration.db_failover_on_db_error.call(e)
end
@@ -115,7 +115,7 @@ module Split
end
end
end
- rescue Errno::ECONNREFUSED => e
+ rescue => e
raise unless Split.configuration.db_failover
Split.configuration.db_failover_on_db_error.call(e)
ret = control_variable(control)
| 2 | Catch any exceptions, not only ECONNREFUSED | 2 | .rb | rb | mit | splitrb/split |
10072364 | <NME> helper.rb
<BEF> # frozen_string_literal: true
module Split
module Helper
OVERRIDE_PARAM_NAME = "ab_test"
module_function
def ab_test(metric_descriptor, control = nil, *alternatives)
begin
experiment = ExperimentCatalog.find_or_initialize(metric_descriptor, control, *alternatives)
alternative = if Split.configuration.enabled && !exclude_visitor?
experiment.save
raise(Split::InvalidExperimentsFormatError) unless (Split.configuration.experiments || {}).fetch(experiment.name.to_sym, {})[:combined_experiments].nil?
trial = Trial.new(user: ab_user, experiment: experiment,
override: override_alternative(experiment.name), exclude: exclude_visitor?,
disabled: split_generically_disabled?)
alt = trial.choose!(self)
alt ? alt.name : nil
else
control_variable(experiment.control)
end
rescue Errno::ECONNREFUSED, Redis::BaseError, SocketError => e
raise(e) unless Split.configuration.db_failover
Split.configuration.db_failover_on_db_error.call(e)
if Split.configuration.db_failover_allow_parameter_override
alternative = override_alternative(experiment.name) if override_present?(experiment.name)
alternative = control_variable(experiment.control) if split_generically_disabled?
alternative.increment_completion
session[:split].delete(experiment_name) if options[:reset]
end
rescue Errno::ECONNREFUSED => e
raise unless Split.configuration.db_failover
Split.configuration.db_failover_on_db_error.call(e)
end
yield(alternative, metadata || {})
else
alternative
end
end
def reset!(experiment)
ab_user.delete(experiment.key)
end
def finish_experiment(experiment, options = { reset: true })
return false if active_experiments[experiment.name].nil?
return true if experiment.has_winner?
should_reset = experiment.resettable? && options[:reset]
if ab_user[experiment.finished_key] && !should_reset
true
else
alternative_name = ab_user[experiment.key]
trial = Trial.new(
user: ab_user,
experiment: experiment,
alternative: alternative_name,
goals: options[:goals],
)
trial.complete!(self)
if should_reset
reset!(experiment)
else
ab_user[experiment.finished_key] = true
end
end
end
def ab_finished(metric_descriptor, options = { reset: true })
return if exclude_visitor? || Split.configuration.disabled?
metric_descriptor, goals = normalize_metric(metric_descriptor)
experiments = Metric.possible_experiments(metric_descriptor)
if experiments.any?
experiments.each do |experiment|
next if override_present?(experiment.key)
finish_experiment(experiment, options.merge(goals: goals))
end
end
rescue => e
raise unless Split.configuration.db_failover
Split.configuration.db_failover_on_db_error.call(e)
end
def ab_record_extra_info(metric_descriptor, key, value = 1)
return if exclude_visitor? || Split.configuration.disabled?
metric_descriptor, _ = normalize_metric(metric_descriptor)
experiments = Metric.possible_experiments(metric_descriptor)
if experiments.any?
experiments.each do |experiment|
alternative_name = ab_user[experiment.key]
if alternative_name
alternative = experiment.alternatives.find { |alt| alt.name == alternative_name }
alternative.record_extra_info(key, value) if alternative
end
end
end
rescue => e
raise unless Split.configuration.db_failover
Split.configuration.db_failover_on_db_error.call(e)
end
def ab_active_experiments
ab_user.active_experiments
rescue => e
raise unless Split.configuration.db_failover
Split.configuration.db_failover_on_db_error.call(e)
end
end
end
end
rescue Errno::ECONNREFUSED => e
raise unless Split.configuration.db_failover
Split.configuration.db_failover_on_db_error.call(e)
ret = control_variable(control)
def override_alternative_by_params(experiment_name)
defined?(params) && params[OVERRIDE_PARAM_NAME] && params[OVERRIDE_PARAM_NAME][experiment_name]
end
def override_alternative_by_cookies(experiment_name)
return unless defined?(request)
if request.cookies && request.cookies.key?("split_override")
experiments = JSON.parse(request.cookies["split_override"]) rescue {}
experiments[experiment_name]
end
end
def split_generically_disabled?
defined?(params) && params["SPLIT_DISABLE"]
end
def ab_user
@ab_user ||= User.new(self)
end
def exclude_visitor?
defined?(request) && (instance_exec(request, &Split.configuration.ignore_filter) || is_ignored_ip_address? || is_robot? || is_preview?)
end
def is_robot?
defined?(request) && request.user_agent =~ Split.configuration.robot_regex
end
def is_preview?
defined?(request) && defined?(request.headers) && request.headers["x-purpose"] == "preview"
end
def is_ignored_ip_address?
return false if Split.configuration.ignore_ip_addresses.empty?
Split.configuration.ignore_ip_addresses.each do |ip|
return true if defined?(request) && (request.ip == ip || (ip.class == Regexp && request.ip =~ ip))
end
false
end
def active_experiments
ab_user.active_experiments
end
def normalize_metric(metric_descriptor)
if Hash === metric_descriptor
experiment_name = metric_descriptor.keys.first
goals = Array(metric_descriptor.values.first)
else
experiment_name = metric_descriptor
goals = []
end
return experiment_name, goals
end
def control_variable(control)
Hash === control ? control.keys.first.to_s : control.to_s
end
end
end
<MSG> Catch any exceptions, not only ECONNREFUSED
<DFF> @@ -30,7 +30,7 @@ module Split
alternative.increment_completion
session[:split].delete(experiment_name) if options[:reset]
end
- rescue Errno::ECONNREFUSED => e
+ rescue => e
raise unless Split.configuration.db_failover
Split.configuration.db_failover_on_db_error.call(e)
end
@@ -115,7 +115,7 @@ module Split
end
end
end
- rescue Errno::ECONNREFUSED => e
+ rescue => e
raise unless Split.configuration.db_failover
Split.configuration.db_failover_on_db_error.call(e)
ret = control_variable(control)
| 2 | Catch any exceptions, not only ECONNREFUSED | 2 | .rb | rb | mit | splitrb/split |
10072365 | <NME> helper.rb
<BEF> # frozen_string_literal: true
module Split
module Helper
OVERRIDE_PARAM_NAME = "ab_test"
module_function
def ab_test(metric_descriptor, control = nil, *alternatives)
begin
experiment = ExperimentCatalog.find_or_initialize(metric_descriptor, control, *alternatives)
alternative = if Split.configuration.enabled && !exclude_visitor?
experiment.save
raise(Split::InvalidExperimentsFormatError) unless (Split.configuration.experiments || {}).fetch(experiment.name.to_sym, {})[:combined_experiments].nil?
trial = Trial.new(user: ab_user, experiment: experiment,
override: override_alternative(experiment.name), exclude: exclude_visitor?,
disabled: split_generically_disabled?)
alt = trial.choose!(self)
alt ? alt.name : nil
else
control_variable(experiment.control)
end
rescue Errno::ECONNREFUSED, Redis::BaseError, SocketError => e
raise(e) unless Split.configuration.db_failover
Split.configuration.db_failover_on_db_error.call(e)
if Split.configuration.db_failover_allow_parameter_override
alternative = override_alternative(experiment.name) if override_present?(experiment.name)
alternative = control_variable(experiment.control) if split_generically_disabled?
alternative.increment_completion
session[:split].delete(experiment_name) if options[:reset]
end
rescue Errno::ECONNREFUSED => e
raise unless Split.configuration.db_failover
Split.configuration.db_failover_on_db_error.call(e)
end
yield(alternative, metadata || {})
else
alternative
end
end
def reset!(experiment)
ab_user.delete(experiment.key)
end
def finish_experiment(experiment, options = { reset: true })
return false if active_experiments[experiment.name].nil?
return true if experiment.has_winner?
should_reset = experiment.resettable? && options[:reset]
if ab_user[experiment.finished_key] && !should_reset
true
else
alternative_name = ab_user[experiment.key]
trial = Trial.new(
user: ab_user,
experiment: experiment,
alternative: alternative_name,
goals: options[:goals],
)
trial.complete!(self)
if should_reset
reset!(experiment)
else
ab_user[experiment.finished_key] = true
end
end
end
def ab_finished(metric_descriptor, options = { reset: true })
return if exclude_visitor? || Split.configuration.disabled?
metric_descriptor, goals = normalize_metric(metric_descriptor)
experiments = Metric.possible_experiments(metric_descriptor)
if experiments.any?
experiments.each do |experiment|
next if override_present?(experiment.key)
finish_experiment(experiment, options.merge(goals: goals))
end
end
rescue => e
raise unless Split.configuration.db_failover
Split.configuration.db_failover_on_db_error.call(e)
end
def ab_record_extra_info(metric_descriptor, key, value = 1)
return if exclude_visitor? || Split.configuration.disabled?
metric_descriptor, _ = normalize_metric(metric_descriptor)
experiments = Metric.possible_experiments(metric_descriptor)
if experiments.any?
experiments.each do |experiment|
alternative_name = ab_user[experiment.key]
if alternative_name
alternative = experiment.alternatives.find { |alt| alt.name == alternative_name }
alternative.record_extra_info(key, value) if alternative
end
end
end
rescue => e
raise unless Split.configuration.db_failover
Split.configuration.db_failover_on_db_error.call(e)
end
def ab_active_experiments
ab_user.active_experiments
rescue => e
raise unless Split.configuration.db_failover
Split.configuration.db_failover_on_db_error.call(e)
end
end
end
end
rescue Errno::ECONNREFUSED => e
raise unless Split.configuration.db_failover
Split.configuration.db_failover_on_db_error.call(e)
ret = control_variable(control)
def override_alternative_by_params(experiment_name)
defined?(params) && params[OVERRIDE_PARAM_NAME] && params[OVERRIDE_PARAM_NAME][experiment_name]
end
def override_alternative_by_cookies(experiment_name)
return unless defined?(request)
if request.cookies && request.cookies.key?("split_override")
experiments = JSON.parse(request.cookies["split_override"]) rescue {}
experiments[experiment_name]
end
end
def split_generically_disabled?
defined?(params) && params["SPLIT_DISABLE"]
end
def ab_user
@ab_user ||= User.new(self)
end
def exclude_visitor?
defined?(request) && (instance_exec(request, &Split.configuration.ignore_filter) || is_ignored_ip_address? || is_robot? || is_preview?)
end
def is_robot?
defined?(request) && request.user_agent =~ Split.configuration.robot_regex
end
def is_preview?
defined?(request) && defined?(request.headers) && request.headers["x-purpose"] == "preview"
end
def is_ignored_ip_address?
return false if Split.configuration.ignore_ip_addresses.empty?
Split.configuration.ignore_ip_addresses.each do |ip|
return true if defined?(request) && (request.ip == ip || (ip.class == Regexp && request.ip =~ ip))
end
false
end
def active_experiments
ab_user.active_experiments
end
def normalize_metric(metric_descriptor)
if Hash === metric_descriptor
experiment_name = metric_descriptor.keys.first
goals = Array(metric_descriptor.values.first)
else
experiment_name = metric_descriptor
goals = []
end
return experiment_name, goals
end
def control_variable(control)
Hash === control ? control.keys.first.to_s : control.to_s
end
end
end
<MSG> Catch any exceptions, not only ECONNREFUSED
<DFF> @@ -30,7 +30,7 @@ module Split
alternative.increment_completion
session[:split].delete(experiment_name) if options[:reset]
end
- rescue Errno::ECONNREFUSED => e
+ rescue => e
raise unless Split.configuration.db_failover
Split.configuration.db_failover_on_db_error.call(e)
end
@@ -115,7 +115,7 @@ module Split
end
end
end
- rescue Errno::ECONNREFUSED => e
+ rescue => e
raise unless Split.configuration.db_failover
Split.configuration.db_failover_on_db_error.call(e)
ret = control_variable(control)
| 2 | Catch any exceptions, not only ECONNREFUSED | 2 | .rb | rb | mit | splitrb/split |
10072366 | <NME> README.md
<BEF> Semantic-UI-Angular
===================
[](https://david-dm.org/Semantic-Org/Semantic-UI-Angular)
[](https://david-dm.org/Semantic-Org/Semantic-UI-Angular#info=devDependencies)
[](https://david-dm.org/Semantic-Org/Semantic-UI-Angular#info=devDependencies)
[](http://commitizen.github.io/cz-cli/)
**Semantic-UI-Angular** is a pure AngularJS 1.x set of directives for Semantic-UI components.
We are considering Angular 2 support in the future. We've decided to use TypeScript as a step to Angular 2 friendly environment.
Status
------
**Work in progress**
We are working on setting up proper environment, contribution guidelines and everything else for comfortable community contributions.
Once we release first `alpha.0` we are happy to get community help.
Support
-------
We support AngularJS 1.4.8 version.
Building Semantic-UI-Angular
----------------------------
You have to have `nodejs` installed before running following commands.
```
npm install
npm run build
```
The distribution packages will be stored in `dist` folder.
Running tests
-------------
Single run:
```
npm test
```
Dev mode:
```
npm run test-dev
```
<MSG> docs(README): Added badge for the project build status
<DFF> @@ -1,5 +1,6 @@
Semantic-UI-Angular
===================
+[](https://travis-ci.org/Semantic-Org/Semantic-UI-Angular)
[](https://david-dm.org/Semantic-Org/Semantic-UI-Angular)
[](https://david-dm.org/Semantic-Org/Semantic-UI-Angular#info=devDependencies)
| 1 | docs(README): Added badge for the project build status | 0 | .md | md | mit | Semantic-Org/Semantic-UI-Angular |
10072367 | <NME> README.md
<BEF> Semantic-UI-Angular
===================
[](https://david-dm.org/Semantic-Org/Semantic-UI-Angular)
[](https://david-dm.org/Semantic-Org/Semantic-UI-Angular#info=devDependencies)
[](https://david-dm.org/Semantic-Org/Semantic-UI-Angular#info=devDependencies)
[](http://commitizen.github.io/cz-cli/)
**Semantic-UI-Angular** is a pure AngularJS 1.x set of directives for Semantic-UI components.
We are considering Angular 2 support in the future. We've decided to use TypeScript as a step to Angular 2 friendly environment.
Status
------
**Work in progress**
We are working on setting up proper environment, contribution guidelines and everything else for comfortable community contributions.
Once we release first `alpha.0` we are happy to get community help.
Support
-------
We support AngularJS 1.4.8 version.
Building Semantic-UI-Angular
----------------------------
You have to have `nodejs` installed before running following commands.
```
npm install
npm run build
```
The distribution packages will be stored in `dist` folder.
Running tests
-------------
Single run:
```
npm test
```
Dev mode:
```
npm run test-dev
```
<MSG> docs(README): Added badge for the project build status
<DFF> @@ -1,5 +1,6 @@
Semantic-UI-Angular
===================
+[](https://travis-ci.org/Semantic-Org/Semantic-UI-Angular)
[](https://david-dm.org/Semantic-Org/Semantic-UI-Angular)
[](https://david-dm.org/Semantic-Org/Semantic-UI-Angular#info=devDependencies)
| 1 | docs(README): Added badge for the project build status | 0 | .md | md | mit | Semantic-Org/Semantic-UI-Angular |
10072368 | <NME> README.md
<BEF> Semantic-UI-Angular
===================
[](https://david-dm.org/Semantic-Org/Semantic-UI-Angular)
[](https://david-dm.org/Semantic-Org/Semantic-UI-Angular#info=devDependencies)
[](https://david-dm.org/Semantic-Org/Semantic-UI-Angular#info=devDependencies)
[](http://commitizen.github.io/cz-cli/)
**Semantic-UI-Angular** is a pure AngularJS 1.x set of directives for Semantic-UI components.
We are considering Angular 2 support in the future. We've decided to use TypeScript as a step to Angular 2 friendly environment.
Status
------
**Work in progress**
We are working on setting up proper environment, contribution guidelines and everything else for comfortable community contributions.
Once we release first `alpha.0` we are happy to get community help.
Support
-------
We support AngularJS 1.4.8 version.
Building Semantic-UI-Angular
----------------------------
You have to have `nodejs` installed before running following commands.
```
npm install
npm run build
```
The distribution packages will be stored in `dist` folder.
Running tests
-------------
Single run:
```
npm test
```
Dev mode:
```
npm run test-dev
```
<MSG> docs(README): Added badge for the project build status
<DFF> @@ -1,5 +1,6 @@
Semantic-UI-Angular
===================
+[](https://travis-ci.org/Semantic-Org/Semantic-UI-Angular)
[](https://david-dm.org/Semantic-Org/Semantic-UI-Angular)
[](https://david-dm.org/Semantic-Org/Semantic-UI-Angular#info=devDependencies)
| 1 | docs(README): Added badge for the project build status | 0 | .md | md | mit | Semantic-Org/Semantic-UI-Angular |
10072369 | <NME> expand.ts
<BEF> import { strictEqual as equal } from 'assert';
import expand, { resolveConfig } from '../src';
describe('Expand Abbreviation', () => {
describe('Markup', () => {
it('basic', () => {
equal(expand('input[value="text$"]*2'), '<input type="text" value="text1"><input type="text" value="text2">');
equal(expand('ul>.item$*2'), '<ul>\n\t<li class="item1"></li>\n\t<li class="item2"></li>\n</ul>');
// insert text into abbreviation
equal(expand('ul>.item$*', { text: ['foo', 'bar'] }), '<ul>\n\t<li class="item1">foo</li>\n\t<li class="item2">bar</li>\n</ul>');
// insert TextMate-style fields/tabstops in output
equal(expand('ul>.item$*2', {
options: {
'output.field': (index, placeholder) => `\${${index}${placeholder ? ':' + placeholder : ''}}`
}
}), '<ul>\n\t<li class="item1">${1}</li>\n\t<li class="item2">${2}</li>\n</ul>');
});
it('attributes', () => {
const snippets = {
test: 'test[!foo bar. baz={}]'
};
const opt = { snippets };
const reverse = {
options: { 'output.reverseAttributes': true },
snippets
};
equal(expand('a.test'), '<a href="" class="test"></a>');
equal(expand('a.test', reverse), '<a class="test" href=""></a>');
equal(expand('test', opt), '<test bar="bar" baz={}></test>');
equal(expand('test[foo]', opt), '<test bar="bar" baz={}></test>');
equal(expand('test[baz=a foo=1]', opt), '<test foo="1" bar="bar" baz={a}></test>');
equal(expand('map'), '<map name=""></map>');
equal(expand('map[]'), '<map name=""></map>');
equal(expand('map[name="valid"]'), '<map name="valid"></map>');
equal(expand('map[href="invalid"]'), '<map name="" href="invalid"></map>');
// Apply attributes in reverse order
equal(expand('test', reverse), '<test bar="bar" baz={}></test>');
equal(expand('test[foo]', reverse), '<test bar="bar" baz={}></test>');
equal(expand('test[baz=a foo=1]', reverse), '<test baz={a} foo="1" bar="bar"></test>');
});
it('numbering', () => {
equal(expand('ul>li.item$@-*5'), '<ul>\n\t<li class="item5"></li>\n\t<li class="item4"></li>\n\t<li class="item3"></li>\n\t<li class="item2"></li>\n\t<li class="item1"></li>\n</ul>');
});
it('syntax', () => {
equal(expand('ul>.item$*2', { syntax: 'html' }), '<ul>\n\t<li class="item1"></li>\n\t<li class="item2"></li>\n</ul>');
equal(expand('ul>.item$*2', { syntax: 'slim' }), 'ul\n\tli.item1 \n\tli.item2 ');
equal(expand('xsl:variable[name=a select=b]>div', { syntax: 'xsl' }), '<xsl:variable name="a">\n\t<div></div>\n</xsl:variable>');
});
it('custom profile', () => {
equal(expand('img'), '<img src="" alt="">');
equal(expand('img', { options: { 'output.selfClosingStyle': 'xhtml' } }), '<img src="" alt="" />');
});
it('custom variables', () => {
const variables = { charset: 'ru-RU' };
equal(expand('[charset=${charset}]{${charset}}'), '<div charset="UTF-8">UTF-8</div>');
equal(expand('[charset=${charset}]{${charset}}', { variables }), '<div charset="ru-RU">ru-RU</div>');
});
it('custom snippets', () => {
const snippets = {
link: 'link[foo=bar href]/',
foo: '.foo[bar=baz]',
repeat: 'div>ul>li{Hello World}*3'
};
equal(expand('foo', { snippets }), '<div class="foo" bar="baz"></div>');
equal(expand('ul>.item$*2'), '<ul>\n\t<li class="item1"></li>\n\t<li class="item2"></li>\n</ul>');
equal(expand('ul>.item$*2', { options: { 'comment.enabled': true } }),
'<ul>\n\t<li class="item1"></li>\n\t<!-- /.item1 -->\n\t<li class="item2"></li>\n\t<!-- /.item2 -->\n</ul>');
});
it('JSX', () => {
it('formatter options', () => {
equal(expand('ul>.item$*2'), '<ul>\n\t<li class="item1"></li>\n\t<li class="item2"></li>\n</ul>');
equal(expand('ul>.item$*2', { options: { 'comment.enabled': true } }),
'<ul>\n\t<li class="item1"></li>\n\t<!-- /.item1 -->\n\t<li class="item2"></li>\n\t<!-- /.item2 -->\n</ul>');
equal(expand('div>p'), '<div>\n\t<p></p>\n</div>');
equal(expand('div>p', { options: { 'output.formatLeafNode': true } }), '<div>\n\t<p>\n\t\t\n\t</p>\n</div>');
});
it('JSX', () => {
const config = { syntax: 'jsx' };
equal(expand('div#foo.bar', config), '<div id="foo" className="bar"></div>');
equal(expand('label[for=a]', config), '<label htmlFor="a"></label>');
equal(expand('Foo.Bar', config), '<Foo.Bar></Foo.Bar>');
equal(expand('div.{theme.style}', config), '<div className={theme.style}></div>');
});
it('override attributes', () => {
const config = { syntax: 'jsx' };
equal(expand('.bar', config), '<div className="bar"></div>');
equal(expand('..bar', config), '<div styleName={styles.bar}></div>');
equal(expand('..foo-bar', config), '<div styleName={styles[\'foo-bar\']}></div>');
equal(expand('.foo', { syntax: 'vue' }), '<div class="foo"></div>');
equal(expand('..foo', { syntax: 'vue' }), '<div :class="foo"></div>');
});
it('wrap with abbreviation', () => {
equal(expand('div>ul', { text: ['<div>line1</div>\n<div>line2</div>'] }),
'<div>\n\t<ul>\n\t\t<div>line1</div>\n\t\t<div>line2</div>\n\t</ul>\n</div>');
equal(expand('p', { text: 'foo\nbar' }), '<p>\n\tfoo\n\tbar\n</p>');
equal(expand('p', { text: '<div>foo</div>' }), '<p>\n\t<div>foo</div>\n</p>');
equal(expand('p', { text: '<span>foo</span>' }), '<p><span>foo</span></p>');
equal(expand('p', { text: 'foo<span>foo</span>' }), '<p>foo<span>foo</span></p>');
equal(expand('p', { text: 'foo<div>foo</div>' }), '<p>foo<div>foo</div></p>');
});
it('wrap with abbreviation href', () => {
equal(expand('a', { text: ['www.google.it'] }), '<a href="http://www.google.it">www.google.it</a>');
equal(expand('a', { text: ['then www.google.it'] }), '<a href="">then www.google.it</a>');
equal(expand('a', { text: ['www.google.it'], options: { 'markup.href': false } }), '<a href="">www.google.it</a>');
equal(expand('map[name="https://example.com"]', { text: ['some text'] }),
'<map name="https://example.com">some text</map>');
equal(expand('map[href="https://example.com"]', { text: ['some text'] }),
'<map name="" href="https://example.com">some text</map>');
equal(expand('map[name="https://example.com"]>b', { text: ['some text'] }),
'<map name="https://example.com"><b>some text</b></map>');
equal(expand('a[href="https://example.com"]>b', { text: ['<u>some text false</u>'], options: { 'markup.href': false } }),
'<a href="https://example.com"><b><u>some text false</u></b></a>');
equal(expand('a[href="https://example.com"]>b', { text: ['<u>some text true</u>'], options: { 'markup.href': true } }),
'<a href="https://example.com"><b><u>some text true</u></b></a>');
equal(expand('a[href="https://example.com"]>div', { text: ['<p>some text false</p>'], options: { 'markup.href': false } }),
'<a href="https://example.com">\n\t<div>\n\t\t<p>some text false</p>\n\t</div>\n</a>');
equal(expand('a[href="https://example.com"]>div', { text: ['<p>some text true</p>'], options: { 'markup.href': true } }),
'<a href="https://example.com">\n\t<div>\n\t\t<p>some text true</p>\n\t</div>\n</a>');
});
// it.only('debug', () => {
// equal(expand('link:css'), '<link rel="stylesheet" href="style.css">');
// });
});
describe('Pug templates', () => {
const config = resolveConfig({ syntax: 'pug' });
it('basic', () => {
equal(expand('!', config), 'doctype html\nhtml(lang="en")\n\thead\n\t\tmeta(charset="UTF-8")\n\t\tmeta(http-equiv="X-UA-Compatible", content="IE=edge")\n\t\tmeta(name="viewport", content="width=device-width, initial-scale=1.0")\n\t\ttitle Document\n\tbody ');
});
});
});
<MSG> Added `output.formatLeafNode` options
Equivalent of `tag_nl_leaf` profile option in previour implementation
Fixes #559
<DFF> @@ -80,6 +80,9 @@ describe('Expand Abbreviation', () => {
equal(expand('ul>.item$*2'), '<ul>\n\t<li class="item1"></li>\n\t<li class="item2"></li>\n</ul>');
equal(expand('ul>.item$*2', { options: { 'comment.enabled': true } }),
'<ul>\n\t<li class="item1"></li>\n\t<!-- /.item1 -->\n\t<li class="item2"></li>\n\t<!-- /.item2 -->\n</ul>');
+
+ equal(expand('div>p'), '<div>\n\t<p></p>\n</div>');
+ equal(expand('div>p', { options: { 'output.formatLeafNode': true } }), '<div>\n\t<p>\n\t\t\n\t</p>\n</div>');
});
it('JSX', () => {
| 3 | Added `output.formatLeafNode` options | 0 | .ts | ts | mit | emmetio/emmet |
10072370 | <NME> expand.ts
<BEF> import { strictEqual as equal } from 'assert';
import expand, { resolveConfig } from '../src';
describe('Expand Abbreviation', () => {
describe('Markup', () => {
it('basic', () => {
equal(expand('input[value="text$"]*2'), '<input type="text" value="text1"><input type="text" value="text2">');
equal(expand('ul>.item$*2'), '<ul>\n\t<li class="item1"></li>\n\t<li class="item2"></li>\n</ul>');
// insert text into abbreviation
equal(expand('ul>.item$*', { text: ['foo', 'bar'] }), '<ul>\n\t<li class="item1">foo</li>\n\t<li class="item2">bar</li>\n</ul>');
// insert TextMate-style fields/tabstops in output
equal(expand('ul>.item$*2', {
options: {
'output.field': (index, placeholder) => `\${${index}${placeholder ? ':' + placeholder : ''}}`
}
}), '<ul>\n\t<li class="item1">${1}</li>\n\t<li class="item2">${2}</li>\n</ul>');
});
it('attributes', () => {
const snippets = {
test: 'test[!foo bar. baz={}]'
};
const opt = { snippets };
const reverse = {
options: { 'output.reverseAttributes': true },
snippets
};
equal(expand('a.test'), '<a href="" class="test"></a>');
equal(expand('a.test', reverse), '<a class="test" href=""></a>');
equal(expand('test', opt), '<test bar="bar" baz={}></test>');
equal(expand('test[foo]', opt), '<test bar="bar" baz={}></test>');
equal(expand('test[baz=a foo=1]', opt), '<test foo="1" bar="bar" baz={a}></test>');
equal(expand('map'), '<map name=""></map>');
equal(expand('map[]'), '<map name=""></map>');
equal(expand('map[name="valid"]'), '<map name="valid"></map>');
equal(expand('map[href="invalid"]'), '<map name="" href="invalid"></map>');
// Apply attributes in reverse order
equal(expand('test', reverse), '<test bar="bar" baz={}></test>');
equal(expand('test[foo]', reverse), '<test bar="bar" baz={}></test>');
equal(expand('test[baz=a foo=1]', reverse), '<test baz={a} foo="1" bar="bar"></test>');
});
it('numbering', () => {
equal(expand('ul>li.item$@-*5'), '<ul>\n\t<li class="item5"></li>\n\t<li class="item4"></li>\n\t<li class="item3"></li>\n\t<li class="item2"></li>\n\t<li class="item1"></li>\n</ul>');
});
it('syntax', () => {
equal(expand('ul>.item$*2', { syntax: 'html' }), '<ul>\n\t<li class="item1"></li>\n\t<li class="item2"></li>\n</ul>');
equal(expand('ul>.item$*2', { syntax: 'slim' }), 'ul\n\tli.item1 \n\tli.item2 ');
equal(expand('xsl:variable[name=a select=b]>div', { syntax: 'xsl' }), '<xsl:variable name="a">\n\t<div></div>\n</xsl:variable>');
});
it('custom profile', () => {
equal(expand('img'), '<img src="" alt="">');
equal(expand('img', { options: { 'output.selfClosingStyle': 'xhtml' } }), '<img src="" alt="" />');
});
it('custom variables', () => {
const variables = { charset: 'ru-RU' };
equal(expand('[charset=${charset}]{${charset}}'), '<div charset="UTF-8">UTF-8</div>');
equal(expand('[charset=${charset}]{${charset}}', { variables }), '<div charset="ru-RU">ru-RU</div>');
});
it('custom snippets', () => {
const snippets = {
link: 'link[foo=bar href]/',
foo: '.foo[bar=baz]',
repeat: 'div>ul>li{Hello World}*3'
};
equal(expand('foo', { snippets }), '<div class="foo" bar="baz"></div>');
equal(expand('ul>.item$*2'), '<ul>\n\t<li class="item1"></li>\n\t<li class="item2"></li>\n</ul>');
equal(expand('ul>.item$*2', { options: { 'comment.enabled': true } }),
'<ul>\n\t<li class="item1"></li>\n\t<!-- /.item1 -->\n\t<li class="item2"></li>\n\t<!-- /.item2 -->\n</ul>');
});
it('JSX', () => {
it('formatter options', () => {
equal(expand('ul>.item$*2'), '<ul>\n\t<li class="item1"></li>\n\t<li class="item2"></li>\n</ul>');
equal(expand('ul>.item$*2', { options: { 'comment.enabled': true } }),
'<ul>\n\t<li class="item1"></li>\n\t<!-- /.item1 -->\n\t<li class="item2"></li>\n\t<!-- /.item2 -->\n</ul>');
equal(expand('div>p'), '<div>\n\t<p></p>\n</div>');
equal(expand('div>p', { options: { 'output.formatLeafNode': true } }), '<div>\n\t<p>\n\t\t\n\t</p>\n</div>');
});
it('JSX', () => {
const config = { syntax: 'jsx' };
equal(expand('div#foo.bar', config), '<div id="foo" className="bar"></div>');
equal(expand('label[for=a]', config), '<label htmlFor="a"></label>');
equal(expand('Foo.Bar', config), '<Foo.Bar></Foo.Bar>');
equal(expand('div.{theme.style}', config), '<div className={theme.style}></div>');
});
it('override attributes', () => {
const config = { syntax: 'jsx' };
equal(expand('.bar', config), '<div className="bar"></div>');
equal(expand('..bar', config), '<div styleName={styles.bar}></div>');
equal(expand('..foo-bar', config), '<div styleName={styles[\'foo-bar\']}></div>');
equal(expand('.foo', { syntax: 'vue' }), '<div class="foo"></div>');
equal(expand('..foo', { syntax: 'vue' }), '<div :class="foo"></div>');
});
it('wrap with abbreviation', () => {
equal(expand('div>ul', { text: ['<div>line1</div>\n<div>line2</div>'] }),
'<div>\n\t<ul>\n\t\t<div>line1</div>\n\t\t<div>line2</div>\n\t</ul>\n</div>');
equal(expand('p', { text: 'foo\nbar' }), '<p>\n\tfoo\n\tbar\n</p>');
equal(expand('p', { text: '<div>foo</div>' }), '<p>\n\t<div>foo</div>\n</p>');
equal(expand('p', { text: '<span>foo</span>' }), '<p><span>foo</span></p>');
equal(expand('p', { text: 'foo<span>foo</span>' }), '<p>foo<span>foo</span></p>');
equal(expand('p', { text: 'foo<div>foo</div>' }), '<p>foo<div>foo</div></p>');
});
it('wrap with abbreviation href', () => {
equal(expand('a', { text: ['www.google.it'] }), '<a href="http://www.google.it">www.google.it</a>');
equal(expand('a', { text: ['then www.google.it'] }), '<a href="">then www.google.it</a>');
equal(expand('a', { text: ['www.google.it'], options: { 'markup.href': false } }), '<a href="">www.google.it</a>');
equal(expand('map[name="https://example.com"]', { text: ['some text'] }),
'<map name="https://example.com">some text</map>');
equal(expand('map[href="https://example.com"]', { text: ['some text'] }),
'<map name="" href="https://example.com">some text</map>');
equal(expand('map[name="https://example.com"]>b', { text: ['some text'] }),
'<map name="https://example.com"><b>some text</b></map>');
equal(expand('a[href="https://example.com"]>b', { text: ['<u>some text false</u>'], options: { 'markup.href': false } }),
'<a href="https://example.com"><b><u>some text false</u></b></a>');
equal(expand('a[href="https://example.com"]>b', { text: ['<u>some text true</u>'], options: { 'markup.href': true } }),
'<a href="https://example.com"><b><u>some text true</u></b></a>');
equal(expand('a[href="https://example.com"]>div', { text: ['<p>some text false</p>'], options: { 'markup.href': false } }),
'<a href="https://example.com">\n\t<div>\n\t\t<p>some text false</p>\n\t</div>\n</a>');
equal(expand('a[href="https://example.com"]>div', { text: ['<p>some text true</p>'], options: { 'markup.href': true } }),
'<a href="https://example.com">\n\t<div>\n\t\t<p>some text true</p>\n\t</div>\n</a>');
});
// it.only('debug', () => {
// equal(expand('link:css'), '<link rel="stylesheet" href="style.css">');
// });
});
describe('Pug templates', () => {
const config = resolveConfig({ syntax: 'pug' });
it('basic', () => {
equal(expand('!', config), 'doctype html\nhtml(lang="en")\n\thead\n\t\tmeta(charset="UTF-8")\n\t\tmeta(http-equiv="X-UA-Compatible", content="IE=edge")\n\t\tmeta(name="viewport", content="width=device-width, initial-scale=1.0")\n\t\ttitle Document\n\tbody ');
});
});
});
<MSG> Added `output.formatLeafNode` options
Equivalent of `tag_nl_leaf` profile option in previour implementation
Fixes #559
<DFF> @@ -80,6 +80,9 @@ describe('Expand Abbreviation', () => {
equal(expand('ul>.item$*2'), '<ul>\n\t<li class="item1"></li>\n\t<li class="item2"></li>\n</ul>');
equal(expand('ul>.item$*2', { options: { 'comment.enabled': true } }),
'<ul>\n\t<li class="item1"></li>\n\t<!-- /.item1 -->\n\t<li class="item2"></li>\n\t<!-- /.item2 -->\n</ul>');
+
+ equal(expand('div>p'), '<div>\n\t<p></p>\n</div>');
+ equal(expand('div>p', { options: { 'output.formatLeafNode': true } }), '<div>\n\t<p>\n\t\t\n\t</p>\n</div>');
});
it('JSX', () => {
| 3 | Added `output.formatLeafNode` options | 0 | .ts | ts | mit | emmetio/emmet |
10072371 | <NME> configuration_spec.rb
<BEF> # frozen_string_literal: true
require "spec_helper"
describe Split::Configuration do
before(:each) { @config = Split::Configuration.new }
it "should provide a default value for ignore_ip_addresses" do
expect(@config.ignore_ip_addresses).to eq([])
end
it "should provide default values for db failover" do
expect(@config.db_failover).to be_falsey
expect(@config.db_failover_on_db_error).to be_a Proc
end
it "should not allow multiple experiments by default" do
expect(@config.allow_multiple_experiments).to be_falsey
end
it "should be enabled by default" do
expect(@config.enabled).to be_truthy
end
it "disabled is the opposite of enabled" do
@config.enabled = false
expect(@config.disabled?).to be_truthy
end
it "should not store the overridden test group per default" do
expect(@config.store_override).to be_falsey
end
it "should provide a default pattern for robots" do
%w[Baidu Gigabot Googlebot libwww-perl lwp-trivial msnbot SiteUptime Slurp WordPress ZIBB ZyBorg YandexBot AdsBot-Google Wget curl bitlybot facebookexternalhit spider].each do |robot|
expect(@config.robot_regex).to match(robot)
end
expect(@config.robot_regex).to match("EventMachine HttpClient")
expect(@config.robot_regex).to match("libwww-perl/5.836")
expect(@config.robot_regex).to match("Pingdom.com_bot_version_1.4_(http://www.pingdom.com)")
@config.robot_regex.should_not =~ "Mozilla/4.0 (compatible; MSIE 8.0; Windows NT 5.1; Trident/4.0; F-6.0SP2-20041109; .NET CLR 2.0.50727; .NET CLR 3.0.04506.648; .NET CLR 3.5.21022; .NET CLR 1.1.4322; InfoPath.3)"
end
it "should use the session adapter for persistence by default" do
@config.persistence.should eq(Split::Persistence::SessionAdapter)
end
end
it "should use the session adapter for persistence by default" do
expect(@config.persistence).to eq(Split::Persistence::SessionAdapter)
end
it "should load a metric" do
@config.experiments = { my_experiment: { alternatives: ["control_opt", "other_opt"], metric: :my_metric } }
expect(@config.metrics).not_to be_nil
expect(@config.metrics.keys).to eq([:my_metric])
end
it "should allow loading of experiment using experment_for" do
@config.experiments = { my_experiment: { alternatives: ["control_opt", "other_opt"], metric: :my_metric } }
expect(@config.experiment_for(:my_experiment)).to eq({ alternatives: ["control_opt", ["other_opt"]] })
end
context "when experiments are defined via YAML" do
context "as strings" do
context "in a basic configuration" do
before do
experiments_yaml = <<-eos
my_experiment:
alternatives:
- Control Opt
- Alt One
- Alt Two
resettable: false
eos
@config.experiments = YAML.load(experiments_yaml)
end
it "should normalize experiments" do
expect(@config.normalized_experiments).to eq({ my_experiment: { resettable: false, alternatives: ["Control Opt", ["Alt One", "Alt Two"]] } })
end
end
context "in a configuration with metadata" do
before do
experiments_yaml = <<-eos
my_experiment:
alternatives:
- name: Control Opt
percent: 67
- name: Alt One
percent: 10
- name: Alt Two
percent: 23
metadata:
Control Opt:
text: 'Control Option'
Alt One:
text: 'Alternative One'
Alt Two:
text: 'Alternative Two'
resettable: false
eos
@config.experiments = YAML.load(experiments_yaml)
end
it "should have metadata on the experiment" do
meta = @config.normalized_experiments[:my_experiment][:metadata]
expect(meta).to_not be nil
expect(meta["Control Opt"]["text"]).to eq("Control Option")
end
end
context "in a complex configuration" do
before do
experiments_yaml = <<-eos
my_experiment:
alternatives:
- name: Control Opt
percent: 67
- name: Alt One
percent: 10
- name: Alt Two
percent: 23
resettable: false
metric: my_metric
another_experiment:
alternatives:
- a
- b
eos
@config.experiments = YAML.load(experiments_yaml)
end
it "should normalize experiments" do
expect(@config.normalized_experiments).to eq({ my_experiment: { resettable: false, alternatives: [{ "Control Opt"=>0.67 },
[{ "Alt One"=>0.1 }, { "Alt Two"=>0.23 }]] }, another_experiment: { alternatives: ["a", ["b"]] } })
end
it "should recognize metrics" do
expect(@config.metrics).not_to be_nil
expect(@config.metrics.keys).to eq([:my_metric])
end
end
end
context "as symbols" do
context "with valid YAML" do
before do
experiments_yaml = <<-eos
:my_experiment:
:alternatives:
- Control Opt
- Alt One
- Alt Two
:resettable: false
eos
@config.experiments = YAML.load(experiments_yaml)
end
it "should normalize experiments" do
expect(@config.normalized_experiments).to eq({ my_experiment: { resettable: false, alternatives: ["Control Opt", ["Alt One", "Alt Two"]] } })
end
end
context "with invalid YAML" do
let(:yaml) { YAML.load(input) }
context "with an empty string" do
let(:input) { "" }
it "should raise an error" do
expect { @config.experiments = yaml }.to raise_error(Split::InvalidExperimentsFormatError)
end
end
context "with just the YAML header" do
let(:input) { "---" }
it "should raise an error" do
expect { @config.experiments = yaml }.to raise_error(Split::InvalidExperimentsFormatError)
end
end
end
end
end
it "should normalize experiments" do
@config.experiments = {
my_experiment: {
alternatives: [
{ name: "control_opt", percent: 67 },
{ name: "second_opt", percent: 10 },
{ name: "third_opt", percent: 23 },
],
}
}
expect(@config.normalized_experiments).to eq({ my_experiment: { alternatives: [{ "control_opt"=>0.67 }, [{ "second_opt"=>0.1 }, { "third_opt"=>0.23 }]] } })
end
context "redis configuration" do
it "should default to local redis server" do
old_redis_url = ENV["REDIS_URL"]
ENV.delete("REDIS_URL")
expect(Split::Configuration.new.redis).to eq("redis://localhost:6379")
ENV["REDIS_URL"] = old_redis_url
end
it "should allow for redis url to be configured" do
@config.redis = "custom_redis_url"
expect(@config.redis).to eq("custom_redis_url")
end
context "provided REDIS_URL environment variable" do
it "should use the ENV variable" do
old_redis_url = ENV["REDIS_URL"]
ENV["REDIS_URL"] = "env_redis_url"
expect(Split::Configuration.new.redis).to eq("env_redis_url")
ENV["REDIS_URL"] = old_redis_url
end
end
end
context "persistence cookie length" do
it "should default to 1 year" do
expect(@config.persistence_cookie_length).to eq(31536000)
end
it "should allow the persistence cookie length to be configured" do
@config.persistence_cookie_length = 2592000
expect(@config.persistence_cookie_length).to eq(2592000)
end
end
context "persistence cookie domain" do
it "should default to nil" do
expect(@config.persistence_cookie_domain).to eq(nil)
end
it "should allow the persistence cookie domain to be configured" do
@config.persistence_cookie_domain = ".acme.com"
expect(@config.persistence_cookie_domain).to eq(".acme.com")
end
end
end
<MSG> adding test for config.bots
<DFF> @@ -43,6 +43,11 @@ describe Split::Configuration do
@config.robot_regex.should_not =~ "Mozilla/4.0 (compatible; MSIE 8.0; Windows NT 5.1; Trident/4.0; F-6.0SP2-20041109; .NET CLR 2.0.50727; .NET CLR 3.0.04506.648; .NET CLR 3.5.21022; .NET CLR 1.1.4322; InfoPath.3)"
end
+ it "should allow adding a bot to the bot list" do
+ @config.bots["newbot"] = "An amazing test bot"
+ @config.robot_regex.should =~ "newbot"
+ end
+
it "should use the session adapter for persistence by default" do
@config.persistence.should eq(Split::Persistence::SessionAdapter)
end
| 5 | adding test for config.bots | 0 | .rb | rb | mit | splitrb/split |
10072372 | <NME> configuration_spec.rb
<BEF> # frozen_string_literal: true
require "spec_helper"
describe Split::Configuration do
before(:each) { @config = Split::Configuration.new }
it "should provide a default value for ignore_ip_addresses" do
expect(@config.ignore_ip_addresses).to eq([])
end
it "should provide default values for db failover" do
expect(@config.db_failover).to be_falsey
expect(@config.db_failover_on_db_error).to be_a Proc
end
it "should not allow multiple experiments by default" do
expect(@config.allow_multiple_experiments).to be_falsey
end
it "should be enabled by default" do
expect(@config.enabled).to be_truthy
end
it "disabled is the opposite of enabled" do
@config.enabled = false
expect(@config.disabled?).to be_truthy
end
it "should not store the overridden test group per default" do
expect(@config.store_override).to be_falsey
end
it "should provide a default pattern for robots" do
%w[Baidu Gigabot Googlebot libwww-perl lwp-trivial msnbot SiteUptime Slurp WordPress ZIBB ZyBorg YandexBot AdsBot-Google Wget curl bitlybot facebookexternalhit spider].each do |robot|
expect(@config.robot_regex).to match(robot)
end
expect(@config.robot_regex).to match("EventMachine HttpClient")
expect(@config.robot_regex).to match("libwww-perl/5.836")
expect(@config.robot_regex).to match("Pingdom.com_bot_version_1.4_(http://www.pingdom.com)")
@config.robot_regex.should_not =~ "Mozilla/4.0 (compatible; MSIE 8.0; Windows NT 5.1; Trident/4.0; F-6.0SP2-20041109; .NET CLR 2.0.50727; .NET CLR 3.0.04506.648; .NET CLR 3.5.21022; .NET CLR 1.1.4322; InfoPath.3)"
end
it "should use the session adapter for persistence by default" do
@config.persistence.should eq(Split::Persistence::SessionAdapter)
end
end
it "should use the session adapter for persistence by default" do
expect(@config.persistence).to eq(Split::Persistence::SessionAdapter)
end
it "should load a metric" do
@config.experiments = { my_experiment: { alternatives: ["control_opt", "other_opt"], metric: :my_metric } }
expect(@config.metrics).not_to be_nil
expect(@config.metrics.keys).to eq([:my_metric])
end
it "should allow loading of experiment using experment_for" do
@config.experiments = { my_experiment: { alternatives: ["control_opt", "other_opt"], metric: :my_metric } }
expect(@config.experiment_for(:my_experiment)).to eq({ alternatives: ["control_opt", ["other_opt"]] })
end
context "when experiments are defined via YAML" do
context "as strings" do
context "in a basic configuration" do
before do
experiments_yaml = <<-eos
my_experiment:
alternatives:
- Control Opt
- Alt One
- Alt Two
resettable: false
eos
@config.experiments = YAML.load(experiments_yaml)
end
it "should normalize experiments" do
expect(@config.normalized_experiments).to eq({ my_experiment: { resettable: false, alternatives: ["Control Opt", ["Alt One", "Alt Two"]] } })
end
end
context "in a configuration with metadata" do
before do
experiments_yaml = <<-eos
my_experiment:
alternatives:
- name: Control Opt
percent: 67
- name: Alt One
percent: 10
- name: Alt Two
percent: 23
metadata:
Control Opt:
text: 'Control Option'
Alt One:
text: 'Alternative One'
Alt Two:
text: 'Alternative Two'
resettable: false
eos
@config.experiments = YAML.load(experiments_yaml)
end
it "should have metadata on the experiment" do
meta = @config.normalized_experiments[:my_experiment][:metadata]
expect(meta).to_not be nil
expect(meta["Control Opt"]["text"]).to eq("Control Option")
end
end
context "in a complex configuration" do
before do
experiments_yaml = <<-eos
my_experiment:
alternatives:
- name: Control Opt
percent: 67
- name: Alt One
percent: 10
- name: Alt Two
percent: 23
resettable: false
metric: my_metric
another_experiment:
alternatives:
- a
- b
eos
@config.experiments = YAML.load(experiments_yaml)
end
it "should normalize experiments" do
expect(@config.normalized_experiments).to eq({ my_experiment: { resettable: false, alternatives: [{ "Control Opt"=>0.67 },
[{ "Alt One"=>0.1 }, { "Alt Two"=>0.23 }]] }, another_experiment: { alternatives: ["a", ["b"]] } })
end
it "should recognize metrics" do
expect(@config.metrics).not_to be_nil
expect(@config.metrics.keys).to eq([:my_metric])
end
end
end
context "as symbols" do
context "with valid YAML" do
before do
experiments_yaml = <<-eos
:my_experiment:
:alternatives:
- Control Opt
- Alt One
- Alt Two
:resettable: false
eos
@config.experiments = YAML.load(experiments_yaml)
end
it "should normalize experiments" do
expect(@config.normalized_experiments).to eq({ my_experiment: { resettable: false, alternatives: ["Control Opt", ["Alt One", "Alt Two"]] } })
end
end
context "with invalid YAML" do
let(:yaml) { YAML.load(input) }
context "with an empty string" do
let(:input) { "" }
it "should raise an error" do
expect { @config.experiments = yaml }.to raise_error(Split::InvalidExperimentsFormatError)
end
end
context "with just the YAML header" do
let(:input) { "---" }
it "should raise an error" do
expect { @config.experiments = yaml }.to raise_error(Split::InvalidExperimentsFormatError)
end
end
end
end
end
it "should normalize experiments" do
@config.experiments = {
my_experiment: {
alternatives: [
{ name: "control_opt", percent: 67 },
{ name: "second_opt", percent: 10 },
{ name: "third_opt", percent: 23 },
],
}
}
expect(@config.normalized_experiments).to eq({ my_experiment: { alternatives: [{ "control_opt"=>0.67 }, [{ "second_opt"=>0.1 }, { "third_opt"=>0.23 }]] } })
end
context "redis configuration" do
it "should default to local redis server" do
old_redis_url = ENV["REDIS_URL"]
ENV.delete("REDIS_URL")
expect(Split::Configuration.new.redis).to eq("redis://localhost:6379")
ENV["REDIS_URL"] = old_redis_url
end
it "should allow for redis url to be configured" do
@config.redis = "custom_redis_url"
expect(@config.redis).to eq("custom_redis_url")
end
context "provided REDIS_URL environment variable" do
it "should use the ENV variable" do
old_redis_url = ENV["REDIS_URL"]
ENV["REDIS_URL"] = "env_redis_url"
expect(Split::Configuration.new.redis).to eq("env_redis_url")
ENV["REDIS_URL"] = old_redis_url
end
end
end
context "persistence cookie length" do
it "should default to 1 year" do
expect(@config.persistence_cookie_length).to eq(31536000)
end
it "should allow the persistence cookie length to be configured" do
@config.persistence_cookie_length = 2592000
expect(@config.persistence_cookie_length).to eq(2592000)
end
end
context "persistence cookie domain" do
it "should default to nil" do
expect(@config.persistence_cookie_domain).to eq(nil)
end
it "should allow the persistence cookie domain to be configured" do
@config.persistence_cookie_domain = ".acme.com"
expect(@config.persistence_cookie_domain).to eq(".acme.com")
end
end
end
<MSG> adding test for config.bots
<DFF> @@ -43,6 +43,11 @@ describe Split::Configuration do
@config.robot_regex.should_not =~ "Mozilla/4.0 (compatible; MSIE 8.0; Windows NT 5.1; Trident/4.0; F-6.0SP2-20041109; .NET CLR 2.0.50727; .NET CLR 3.0.04506.648; .NET CLR 3.5.21022; .NET CLR 1.1.4322; InfoPath.3)"
end
+ it "should allow adding a bot to the bot list" do
+ @config.bots["newbot"] = "An amazing test bot"
+ @config.robot_regex.should =~ "newbot"
+ end
+
it "should use the session adapter for persistence by default" do
@config.persistence.should eq(Split::Persistence::SessionAdapter)
end
| 5 | adding test for config.bots | 0 | .rb | rb | mit | splitrb/split |
10072373 | <NME> configuration_spec.rb
<BEF> # frozen_string_literal: true
require "spec_helper"
describe Split::Configuration do
before(:each) { @config = Split::Configuration.new }
it "should provide a default value for ignore_ip_addresses" do
expect(@config.ignore_ip_addresses).to eq([])
end
it "should provide default values for db failover" do
expect(@config.db_failover).to be_falsey
expect(@config.db_failover_on_db_error).to be_a Proc
end
it "should not allow multiple experiments by default" do
expect(@config.allow_multiple_experiments).to be_falsey
end
it "should be enabled by default" do
expect(@config.enabled).to be_truthy
end
it "disabled is the opposite of enabled" do
@config.enabled = false
expect(@config.disabled?).to be_truthy
end
it "should not store the overridden test group per default" do
expect(@config.store_override).to be_falsey
end
it "should provide a default pattern for robots" do
%w[Baidu Gigabot Googlebot libwww-perl lwp-trivial msnbot SiteUptime Slurp WordPress ZIBB ZyBorg YandexBot AdsBot-Google Wget curl bitlybot facebookexternalhit spider].each do |robot|
expect(@config.robot_regex).to match(robot)
end
expect(@config.robot_regex).to match("EventMachine HttpClient")
expect(@config.robot_regex).to match("libwww-perl/5.836")
expect(@config.robot_regex).to match("Pingdom.com_bot_version_1.4_(http://www.pingdom.com)")
@config.robot_regex.should_not =~ "Mozilla/4.0 (compatible; MSIE 8.0; Windows NT 5.1; Trident/4.0; F-6.0SP2-20041109; .NET CLR 2.0.50727; .NET CLR 3.0.04506.648; .NET CLR 3.5.21022; .NET CLR 1.1.4322; InfoPath.3)"
end
it "should use the session adapter for persistence by default" do
@config.persistence.should eq(Split::Persistence::SessionAdapter)
end
end
it "should use the session adapter for persistence by default" do
expect(@config.persistence).to eq(Split::Persistence::SessionAdapter)
end
it "should load a metric" do
@config.experiments = { my_experiment: { alternatives: ["control_opt", "other_opt"], metric: :my_metric } }
expect(@config.metrics).not_to be_nil
expect(@config.metrics.keys).to eq([:my_metric])
end
it "should allow loading of experiment using experment_for" do
@config.experiments = { my_experiment: { alternatives: ["control_opt", "other_opt"], metric: :my_metric } }
expect(@config.experiment_for(:my_experiment)).to eq({ alternatives: ["control_opt", ["other_opt"]] })
end
context "when experiments are defined via YAML" do
context "as strings" do
context "in a basic configuration" do
before do
experiments_yaml = <<-eos
my_experiment:
alternatives:
- Control Opt
- Alt One
- Alt Two
resettable: false
eos
@config.experiments = YAML.load(experiments_yaml)
end
it "should normalize experiments" do
expect(@config.normalized_experiments).to eq({ my_experiment: { resettable: false, alternatives: ["Control Opt", ["Alt One", "Alt Two"]] } })
end
end
context "in a configuration with metadata" do
before do
experiments_yaml = <<-eos
my_experiment:
alternatives:
- name: Control Opt
percent: 67
- name: Alt One
percent: 10
- name: Alt Two
percent: 23
metadata:
Control Opt:
text: 'Control Option'
Alt One:
text: 'Alternative One'
Alt Two:
text: 'Alternative Two'
resettable: false
eos
@config.experiments = YAML.load(experiments_yaml)
end
it "should have metadata on the experiment" do
meta = @config.normalized_experiments[:my_experiment][:metadata]
expect(meta).to_not be nil
expect(meta["Control Opt"]["text"]).to eq("Control Option")
end
end
context "in a complex configuration" do
before do
experiments_yaml = <<-eos
my_experiment:
alternatives:
- name: Control Opt
percent: 67
- name: Alt One
percent: 10
- name: Alt Two
percent: 23
resettable: false
metric: my_metric
another_experiment:
alternatives:
- a
- b
eos
@config.experiments = YAML.load(experiments_yaml)
end
it "should normalize experiments" do
expect(@config.normalized_experiments).to eq({ my_experiment: { resettable: false, alternatives: [{ "Control Opt"=>0.67 },
[{ "Alt One"=>0.1 }, { "Alt Two"=>0.23 }]] }, another_experiment: { alternatives: ["a", ["b"]] } })
end
it "should recognize metrics" do
expect(@config.metrics).not_to be_nil
expect(@config.metrics.keys).to eq([:my_metric])
end
end
end
context "as symbols" do
context "with valid YAML" do
before do
experiments_yaml = <<-eos
:my_experiment:
:alternatives:
- Control Opt
- Alt One
- Alt Two
:resettable: false
eos
@config.experiments = YAML.load(experiments_yaml)
end
it "should normalize experiments" do
expect(@config.normalized_experiments).to eq({ my_experiment: { resettable: false, alternatives: ["Control Opt", ["Alt One", "Alt Two"]] } })
end
end
context "with invalid YAML" do
let(:yaml) { YAML.load(input) }
context "with an empty string" do
let(:input) { "" }
it "should raise an error" do
expect { @config.experiments = yaml }.to raise_error(Split::InvalidExperimentsFormatError)
end
end
context "with just the YAML header" do
let(:input) { "---" }
it "should raise an error" do
expect { @config.experiments = yaml }.to raise_error(Split::InvalidExperimentsFormatError)
end
end
end
end
end
it "should normalize experiments" do
@config.experiments = {
my_experiment: {
alternatives: [
{ name: "control_opt", percent: 67 },
{ name: "second_opt", percent: 10 },
{ name: "third_opt", percent: 23 },
],
}
}
expect(@config.normalized_experiments).to eq({ my_experiment: { alternatives: [{ "control_opt"=>0.67 }, [{ "second_opt"=>0.1 }, { "third_opt"=>0.23 }]] } })
end
context "redis configuration" do
it "should default to local redis server" do
old_redis_url = ENV["REDIS_URL"]
ENV.delete("REDIS_URL")
expect(Split::Configuration.new.redis).to eq("redis://localhost:6379")
ENV["REDIS_URL"] = old_redis_url
end
it "should allow for redis url to be configured" do
@config.redis = "custom_redis_url"
expect(@config.redis).to eq("custom_redis_url")
end
context "provided REDIS_URL environment variable" do
it "should use the ENV variable" do
old_redis_url = ENV["REDIS_URL"]
ENV["REDIS_URL"] = "env_redis_url"
expect(Split::Configuration.new.redis).to eq("env_redis_url")
ENV["REDIS_URL"] = old_redis_url
end
end
end
context "persistence cookie length" do
it "should default to 1 year" do
expect(@config.persistence_cookie_length).to eq(31536000)
end
it "should allow the persistence cookie length to be configured" do
@config.persistence_cookie_length = 2592000
expect(@config.persistence_cookie_length).to eq(2592000)
end
end
context "persistence cookie domain" do
it "should default to nil" do
expect(@config.persistence_cookie_domain).to eq(nil)
end
it "should allow the persistence cookie domain to be configured" do
@config.persistence_cookie_domain = ".acme.com"
expect(@config.persistence_cookie_domain).to eq(".acme.com")
end
end
end
<MSG> adding test for config.bots
<DFF> @@ -43,6 +43,11 @@ describe Split::Configuration do
@config.robot_regex.should_not =~ "Mozilla/4.0 (compatible; MSIE 8.0; Windows NT 5.1; Trident/4.0; F-6.0SP2-20041109; .NET CLR 2.0.50727; .NET CLR 3.0.04506.648; .NET CLR 3.5.21022; .NET CLR 1.1.4322; InfoPath.3)"
end
+ it "should allow adding a bot to the bot list" do
+ @config.bots["newbot"] = "An amazing test bot"
+ @config.robot_regex.should =~ "newbot"
+ end
+
it "should use the session adapter for persistence by default" do
@config.persistence.should eq(Split::Persistence::SessionAdapter)
end
| 5 | adding test for config.bots | 0 | .rb | rb | mit | splitrb/split |
10072374 | <NME> 7.0.gemfile
<BEF> # This file was generated by Appraisal
source "https://rubygems.org"
gem "appraisal"
gem "codeclimate-test-reporter"
gem "rails", "~> 7.0"
gem "matrix"
gem "matrix"
gemspec path: "../"
<MSG> Remove appraisals
<DFF> @@ -1,8 +1,5 @@
-# This file was generated by Appraisal
-
source "https://rubygems.org"
-gem "appraisal"
gem "codeclimate-test-reporter"
gem "rails", "~> 7.0"
gem "matrix"
| 0 | Remove appraisals | 3 | .gemfile | 0 | mit | splitrb/split |
10072375 | <NME> 7.0.gemfile
<BEF> # This file was generated by Appraisal
source "https://rubygems.org"
gem "appraisal"
gem "codeclimate-test-reporter"
gem "rails", "~> 7.0"
gem "matrix"
gem "matrix"
gemspec path: "../"
<MSG> Remove appraisals
<DFF> @@ -1,8 +1,5 @@
-# This file was generated by Appraisal
-
source "https://rubygems.org"
-gem "appraisal"
gem "codeclimate-test-reporter"
gem "rails", "~> 7.0"
gem "matrix"
| 0 | Remove appraisals | 3 | .gemfile | 0 | mit | splitrb/split |
10072376 | <NME> 7.0.gemfile
<BEF> # This file was generated by Appraisal
source "https://rubygems.org"
gem "appraisal"
gem "codeclimate-test-reporter"
gem "rails", "~> 7.0"
gem "matrix"
gem "matrix"
gemspec path: "../"
<MSG> Remove appraisals
<DFF> @@ -1,8 +1,5 @@
-# This file was generated by Appraisal
-
source "https://rubygems.org"
-gem "appraisal"
gem "codeclimate-test-reporter"
gem "rails", "~> 7.0"
gem "matrix"
| 0 | Remove appraisals | 3 | .gemfile | 0 | mit | splitrb/split |
10072377 | <NME> forms.py
<BEF> import os
from django import forms
from django.conf import settings
from djangopypi.models import Project, Classifier, Release
from django.utils.translation import ugettext_lazy as _
class ProjectForm(forms.ModelForm):
class Meta:
model = Project
exclude = ['owner', 'classifiers']
class ReleaseForm(forms.ModelForm):
class Meta:
model = Release
exclude = ['project']import os
from django import forms
from djangopypi.models import Project, Classifier, Release
class PermissionDeniedError(Exception):
"""The user did not have the priveliges to execute an action."""
class ProjectRegisterForm(forms.Form):
name = forms.CharField()
platform = forms.CharField(required=False)
PermissionDeniedError = PermissionDeniedError
def save(self, classifiers, user, file=None):
values = dict(self.cleaned_data)
# filename, however with .tar.gz files django does the "wrong" thing
# and saves it as project-0.1.2.tar_.gz. So remove it before
# django sees anything.
if file:
try:
release = Release.objects.get(version=version,
platform=platform, project=project)
if os.path.exists(release.distribution.path):
os.remove(release.distribution.path)
release.delete()
except (Release.DoesNotExist, ValueError):
pass
<MSG> Added setting ``DJANGOPYPI_ALLOW_VERSION_OVERWRITE``, which if not True, doesn't allow you to overwrite project files anymore like on PyPI. Closes #1.
<DFF> @@ -33,11 +33,17 @@ POSSIBILITY OF SUCH DAMAGE.
import os
from django import forms
from djangopypi.models import Project, Classifier, Release
+from django.utils.translation import ugettext_lazy as _
class PermissionDeniedError(Exception):
- """The user did not have the priveliges to execute an action."""
+ """The user did not have the privileges to execute an action."""
+class AlreadyExistsError(Exception):
+ """Filename already exists."""
+
+ALREADY_EXISTS_FMT = _("""A file named "%s" already exists for %s. To fix """
+ + "problems with that you should create a new release.")
class ProjectRegisterForm(forms.Form):
name = forms.CharField()
@@ -53,6 +59,7 @@ class ProjectRegisterForm(forms.Form):
platform = forms.CharField(required=False)
PermissionDeniedError = PermissionDeniedError
+ AlreadyExistsError = AlreadyExistsError
def save(self, classifiers, user, file=None):
values = dict(self.cleaned_data)
@@ -84,13 +91,20 @@ class ProjectRegisterForm(forms.Form):
# filename, however with .tar.gz files django does the "wrong" thing
# and saves it as project-0.1.2.tar_.gz. So remove it before
# django sees anything.
+
+ allow_overwrite = getattr(settings,
+ "DJANGOPYPI_ALLOW_VERSION_OVERWRITE", False)
if file:
try:
release = Release.objects.get(version=version,
platform=platform, project=project)
if os.path.exists(release.distribution.path):
+ if not allow_overwrite:
+ raise self.AlreadyExistsError(ALREADY_EXISTS_FMT % (
+ release.filename, release))
os.remove(release.distribution.path)
+
release.delete()
except (Release.DoesNotExist, ValueError):
pass
| 15 | Added setting ``DJANGOPYPI_ALLOW_VERSION_OVERWRITE``, which if not True, doesn't allow you to overwrite project files anymore like on PyPI. Closes #1. | 1 | .py | py | bsd-3-clause | ask/chishop |
10072378 | <NME> experiment_catalog.rb
<BEF> ADDFILE
<MSG> Refactoring: Extract ExperimientStore
Extracts the responsibility of finding experiments to another class
<DFF> @@ -0,0 +1,45 @@
+module Split
+ class ExperimentCatalog
+ def self.all
+ Split.redis.smembers(:experiments).map {|e| find(e)}
+ end
+
+ # Return experiments without a winner (considered "active") first
+ def self.all_active_first
+ all.partition{|e| not e.winner}.map{|es| es.sort_by(&:name)}.flatten
+ end
+
+ def self.find(name)
+ if Split.redis.exists(name)
+ obj = Experiment.new name
+ obj.load_from_redis
+ else
+ obj = nil
+ end
+ obj
+ end
+
+ def self.find_or_create(label, *alternatives)
+ experiment_name_with_version, goals = normalize_experiment(label)
+ name = experiment_name_with_version.to_s.split(':')[0]
+
+ exp = Experiment.new name, :alternatives => alternatives, :goals => goals
+ exp.save
+ exp
+ end
+
+ private
+
+ def self.normalize_experiment(label)
+ if Hash === label
+ experiment_name = label.keys.first
+ goals = label.values.first
+ else
+ experiment_name = label
+ goals = []
+ end
+ return experiment_name, goals
+ end
+
+ end
+end
| 45 | Refactoring: Extract ExperimientStore | 0 | .rb | rb | mit | splitrb/split |
10072379 | <NME> experiment_catalog.rb
<BEF> ADDFILE
<MSG> Refactoring: Extract ExperimientStore
Extracts the responsibility of finding experiments to another class
<DFF> @@ -0,0 +1,45 @@
+module Split
+ class ExperimentCatalog
+ def self.all
+ Split.redis.smembers(:experiments).map {|e| find(e)}
+ end
+
+ # Return experiments without a winner (considered "active") first
+ def self.all_active_first
+ all.partition{|e| not e.winner}.map{|es| es.sort_by(&:name)}.flatten
+ end
+
+ def self.find(name)
+ if Split.redis.exists(name)
+ obj = Experiment.new name
+ obj.load_from_redis
+ else
+ obj = nil
+ end
+ obj
+ end
+
+ def self.find_or_create(label, *alternatives)
+ experiment_name_with_version, goals = normalize_experiment(label)
+ name = experiment_name_with_version.to_s.split(':')[0]
+
+ exp = Experiment.new name, :alternatives => alternatives, :goals => goals
+ exp.save
+ exp
+ end
+
+ private
+
+ def self.normalize_experiment(label)
+ if Hash === label
+ experiment_name = label.keys.first
+ goals = label.values.first
+ else
+ experiment_name = label
+ goals = []
+ end
+ return experiment_name, goals
+ end
+
+ end
+end
| 45 | Refactoring: Extract ExperimientStore | 0 | .rb | rb | mit | splitrb/split |
10072380 | <NME> experiment_catalog.rb
<BEF> ADDFILE
<MSG> Refactoring: Extract ExperimientStore
Extracts the responsibility of finding experiments to another class
<DFF> @@ -0,0 +1,45 @@
+module Split
+ class ExperimentCatalog
+ def self.all
+ Split.redis.smembers(:experiments).map {|e| find(e)}
+ end
+
+ # Return experiments without a winner (considered "active") first
+ def self.all_active_first
+ all.partition{|e| not e.winner}.map{|es| es.sort_by(&:name)}.flatten
+ end
+
+ def self.find(name)
+ if Split.redis.exists(name)
+ obj = Experiment.new name
+ obj.load_from_redis
+ else
+ obj = nil
+ end
+ obj
+ end
+
+ def self.find_or_create(label, *alternatives)
+ experiment_name_with_version, goals = normalize_experiment(label)
+ name = experiment_name_with_version.to_s.split(':')[0]
+
+ exp = Experiment.new name, :alternatives => alternatives, :goals => goals
+ exp.save
+ exp
+ end
+
+ private
+
+ def self.normalize_experiment(label)
+ if Hash === label
+ experiment_name = label.keys.first
+ goals = label.values.first
+ else
+ experiment_name = label
+ goals = []
+ end
+ return experiment_name, goals
+ end
+
+ end
+end
| 45 | Refactoring: Extract ExperimientStore | 0 | .rb | rb | mit | splitrb/split |
10072381 | <NME> README.md
<BEF> # [Split](https://libraries.io/rubygems/split)
[](http://badge.fury.io/rb/split)
[](https://codeclimate.com/github/splitrb/split)
[](https://codeclimate.com/github/splitrb/split/coverage)
[](https://github.com/RichardLitt/standard-readme)
[](https://www.codetriage.com/splitrb/split)
> 📈 The Rack Based A/B testing framework https://libraries.io/rubygems/split
Split is a rack based A/B testing framework designed to work with Rails, Sinatra or any other rack based app.
Split is heavily inspired by the [Abingo](https://github.com/ryanb/abingo) and [Vanity](https://github.com/assaf/vanity) Rails A/B testing plugins and [Resque](https://github.com/resque/resque) in its use of Redis.
Split is designed to be hacker friendly, allowing for maximum customisation and extensibility.
## Install
### Requirements
Split v4.0+ is currently tested with Ruby >= 2.5 and Rails >= 5.2.
If your project requires compatibility with Ruby 2.4.x or older Rails versions. You can try v3.0 or v0.8.0(for Ruby 1.9.3)
Split uses Redis as a datastore.
Split only supports Redis 4.0 or greater.
If you're on OS X, Homebrew is the simplest way to install Redis:
```bash
brew install redis
redis-server /usr/local/etc/redis.conf
```
You now have a Redis daemon running on port `6379`.
### Setup
```bash
gem install split
```
#### Rails
Adding `gem 'split'` to your Gemfile will autoload it when rails starts up, as long as you've configured Redis it will 'just work'.
#### Sinatra
To configure Sinatra with Split you need to enable sessions and mix in the helper methods. Add the following lines at the top of your Sinatra app:
```ruby
require 'split'
class MySinatraApp < Sinatra::Base
enable :sessions
helpers Split::Helper
get '/' do
...
end
```
## Usage
To begin your A/B test use the `ab_test` method, naming your experiment with the first argument and then the different alternatives which you wish to test on as the other arguments.
`ab_test` returns one of the alternatives, if a user has already seen that test they will get the same alternative as before, which you can use to split your code on.
It can be used to render different templates, show different text or any other case based logic.
`ab_finished` is used to make a completion of an experiment, or conversion.
Example: View
```erb
<% ab_test(:login_button, "/images/button1.jpg", "/images/button2.jpg") do |button_file| %>
<%= image_tag(button_file, alt: "Login!") %>
<% end %>
```
Example: Controller
```ruby
def register_new_user
# See what level of free points maximizes users' decision to buy replacement points.
@starter_points = ab_test(:new_user_free_points, '100', '200', '300')
end
```
Example: Conversion tracking (in a controller!)
```ruby
def buy_new_points
# some business logic
ab_finished(:new_user_free_points)
end
```
Example: Conversion tracking (in a view)
```erb
Thanks for signing up, dude! <% ab_finished(:signup_page_redesign) %>
```
You can find more examples, tutorials and guides on the [wiki](https://github.com/splitrb/split/wiki).
## Statistical Validity
Split has two options for you to use to determine which alternative is the best.
The first option (default on the dashboard) uses a z test (n>30) for the difference between your control and alternative conversion rates to calculate statistical significance. This test will tell you whether an alternative is better or worse than your control, but it will not distinguish between which alternative is the best in an experiment with multiple alternatives. Split will only tell you if your experiment is 90%, 95%, or 99% significant, and this test only works if you have more than 30 participants and 5 conversions for each branch.
As per this [blog post](https://www.evanmiller.org/how-not-to-run-an-ab-test.html) on the pitfalls of A/B testing, it is highly recommended that you determine your requisite sample size for each branch before running the experiment. Otherwise, you'll have an increased rate of false positives (experiments which show a significant effect where really there is none).
[Here](https://www.evanmiller.org/ab-testing/sample-size.html) is a sample size calculator for your convenience.
The second option uses simulations from a beta distribution to determine the probability that the given alternative is the winner compared to all other alternatives. You can view these probabilities by clicking on the drop-down menu labeled "Confidence." This option should be used when the experiment has more than just 1 control and 1 alternative. It can also be used for a simple, 2-alternative A/B test.
Calculating the beta-distribution simulations for a large number of experiments can be slow, so the results are cached. You can specify how often they should be recalculated (the default is once per day).
```ruby
Split.configure do |config|
config.winning_alternative_recalculation_interval = 3600 # 1 hour
end
```
## Extras
### Weighted alternatives
Perhaps you only want to show an alternative to 10% of your visitors because it is very experimental or not yet fully load tested.
To do this you can pass a weight with each alternative in the following ways:
```ruby
ab_test(:homepage_design, {'Old' => 18}, {'New' => 2})
ab_test(:homepage_design, 'Old', {'New' => 1.0/9})
ab_test(:homepage_design, {'Old' => 9}, 'New')
```
This will only show the new alternative to visitors 1 in 10 times, the default weight for an alternative is 1.
### Overriding alternatives
For development and testing, you may wish to force your app to always return an alternative.
You can do this by passing it as a parameter in the url.
If you have an experiment called `button_color` with alternatives called `red` and `blue` used on your homepage, a url such as:
http://myawesomesite.com?ab_test[button_color]=red
will always have red buttons. This won't be stored in your session or count towards to results, unless you set the `store_override` configuration option.
In the event you want to disable all tests without having to know the individual experiment names, add a `SPLIT_DISABLE` query parameter.
http://myawesomesite.com?SPLIT_DISABLE=true
It is not required to send `SPLIT_DISABLE=false` to activate Split.
### Rspec Helper
To aid testing with RSpec, write `spec/support/split_helper.rb` and call `use_ab_test(alternatives_by_experiment)` in your specs as instructed below:
```ruby
# Create a file with these contents at 'spec/support/split_helper.rb'
# and ensure it is `require`d in your rails_helper.rb or spec_helper.rb
module SplitHelper
# Force a specific experiment alternative to always be returned:
# use_ab_test(signup_form: "single_page")
#
# Force alternatives for multiple experiments:
# use_ab_test(signup_form: "single_page", pricing: "show_enterprise_prices")
#
def use_ab_test(alternatives_by_experiment)
allow_any_instance_of(Split::Helper).to receive(:ab_test) do |_receiver, experiment, &block|
variant = alternatives_by_experiment.fetch(experiment) { |key| raise "Unknown experiment '#{key}'" }
block.call(variant) unless block.nil?
variant
end
end
end
# Make the `use_ab_test` method available to all specs:
RSpec.configure do |config|
config.include SplitHelper
end
```
end
```
By default, cookies will expire in 1 year. To change that, set the `persistence_cookie_length` in the configuration.
```ruby
Split.configure do |config|
```
### Starting experiments manually
By default new A/B tests will be active right after deployment. In case you would like to start new test a while after
the deploy, you can do it by setting the `start_manually` configuration option to `true`.
After choosing this option tests won't be started right after deploy, but after pressing the `Start` button in Split admin dashboard. If a test is deleted from the Split dashboard, then it can only be started after pressing the `Start` button whenever being re-initialized.
### Reset after completion
When a user completes a test their session is reset so that they may start the test again in the future.
To stop this behaviour you can pass the following option to the `ab_finished` method:
```ruby
ab_finished(:experiment_name, reset: false)
```
The user will then always see the alternative they started with.
Any old unfinished experiment key will be deleted from the user's data storage if the experiment had been removed or is over and a winner had been chosen. This allows a user to enroll into any new experiment in cases when the `allow_multiple_experiments` config option is set to `false`.
### Reset experiments manually
By default Split automatically resets the experiment whenever it detects the configuration for an experiment has changed (e.g. you call `ab_test` with different alternatives). You can prevent this by setting the option `reset_manually` to `true`.
You may want to do this when you want to change something, like the variants' names, the metadata about an experiment, etc. without resetting everything.
### Multiple experiments at once
By default Split will avoid users participating in multiple experiments at once. This means you are less likely to skew results by adding in more variation to your tests.
To stop this behaviour and allow users to participate in multiple experiments at once set the `allow_multiple_experiments` config option to true like so:
```ruby
Split.configure do |config|
config.allow_multiple_experiments = true
end
```
This will allow the user to participate in any number of experiments and belong to any alternative in each experiment. This has the possible downside of a variation in one experiment influencing the outcome of another.
To address this, setting the `allow_multiple_experiments` config option to 'control' like so:
```ruby
Split.configure do |config|
config.allow_multiple_experiments = 'control'
end
```
For this to work, each and every experiment you define must have an alternative named 'control'. This will allow the user to participate in multiple experiments as long as the user belongs to the alternative 'control' in each experiment. As soon as the user belongs to an alternative named something other than 'control' the user may not participate in any more experiments. Calling ab_test(<other experiments>) will always return the first alternative without adding the user to that experiment.
### Experiment Persistence
Split comes with three built-in persistence adapters for storing users and the alternatives they've been given for each experiment.
By default Split will store the tests for each user in the session.
You can optionally configure Split to use a cookie, Redis, or any custom adapter of your choosing.
#### Cookies
```ruby
Split.configure do |config|
config.persistence = :cookie
end
```
When using the cookie persistence, Split stores data into an anonymous tracking cookie named 'split', which expires in 1 year. To change that, set the `persistence_cookie_length` in the configuration (unit of time in seconds).
```ruby
Split.configure do |config|
config.persistence = :cookie
config.persistence_cookie_length = 2592000 # 30 days
end
```
The data stored consists of the experiment name and the variants the user is in. Example: { "experiment_name" => "variant_a" }
__Note:__ Using cookies depends on `ActionDispatch::Cookies` or any identical API
#### Redis
Using Redis will allow ab_users to persist across sessions or machines.
```ruby
Split.configure do |config|
config.persistence = Split::Persistence::RedisAdapter.with_config(lookup_by: -> (context) { context.current_user_id })
# Equivalent
# config.persistence = Split::Persistence::RedisAdapter.with_config(lookup_by: :current_user_id)
end
```
Options:
* `lookup_by`: method to invoke per request for uniquely identifying ab_users (mandatory configuration)
* `namespace`: separate namespace to store these persisted values (default "persistence")
* `expire_seconds`: sets TTL for user key. (if a user is in multiple experiments most recent update will reset TTL for all their assignments)
#### Dual Adapter
The Dual Adapter allows the use of different persistence adapters for logged-in and logged-out users. A common use case is to use Redis for logged-in users and Cookies for logged-out users.
```ruby
cookie_adapter = Split::Persistence::CookieAdapter
redis_adapter = Split::Persistence::RedisAdapter.with_config(
lookup_by: -> (context) { context.send(:current_user).try(:id) },
expire_seconds: 2592000)
Split.configure do |config|
config.persistence = Split::Persistence::DualAdapter.with_config(
logged_in: -> (context) { !context.send(:current_user).try(:id).nil? },
logged_in_adapter: redis_adapter,
logged_out_adapter: cookie_adapter)
config.persistence_cookie_length = 2592000 # 30 days
end
```
#### Custom Adapter
Your custom adapter needs to implement the same API as existing adapters.
See `Split::Persistence::CookieAdapter` or `Split::Persistence::SessionAdapter` for a starting point.
```ruby
Split.configure do |config|
config.persistence = YourCustomAdapterClass
end
```
### Trial Event Hooks
You can define methods that will be called at the same time as experiment
alternative participation and goal completion.
For example:
``` ruby
Split.configure do |config|
config.on_trial = :log_trial # run on every trial
config.on_trial_choose = :log_trial_choose # run on trials with new users only
config.on_trial_complete = :log_trial_complete
end
```
Set these attributes to a method name available in the same context as the
`ab_test` method. These methods should accept one argument, a `Trial` instance.
``` ruby
def log_trial(trial)
logger.info "experiment=%s alternative=%s user=%s" %
[ trial.experiment.name, trial.alternative, current_user.id ]
end
def log_trial_choose(trial)
logger.info "[new user] experiment=%s alternative=%s user=%s" %
[ trial.experiment.name, trial.alternative, current_user.id ]
end
def log_trial_complete(trial)
logger.info "experiment=%s alternative=%s user=%s complete=true" %
[ trial.experiment.name, trial.alternative, current_user.id ]
end
```
#### Views
If you are running `ab_test` from a view, you must define your event
hook callback as a
[helper_method](https://apidock.com/rails/AbstractController/Helpers/ClassMethods/helper_method)
in the controller:
``` ruby
helper_method :log_trial_choose
def log_trial_choose(trial)
logger.info "experiment=%s alternative=%s user=%s" %
[ trial.experiment.name, trial.alternative, current_user.id ]
end
```
### Experiment Hooks
You can assign a proc that will be called when an experiment is reset or deleted. You can use these hooks to call methods within your application to keep data related to experiments in sync with Split.
For example:
``` ruby
Split.configure do |config|
# after experiment reset or deleted
config.on_experiment_reset = -> (example) { # Do something on reset }
config.on_experiment_delete = -> (experiment) { # Do something else on delete }
# before experiment reset or deleted
config.on_before_experiment_reset = -> (example) { # Do something on reset }
config.on_before_experiment_delete = -> (experiment) { # Do something else on delete }
# after experiment winner had been set
config.on_experiment_winner_choose = -> (experiment) { # Do something on winner choose }
end
```
## Web Interface
Split comes with a Sinatra-based front end to get an overview of how your experiments are doing.
If you are running Rails 2: You can mount this inside your app using Rack::URLMap in your `config.ru`
```ruby
require 'split/dashboard'
run Rack::URLMap.new \
"/" => Your::App.new,
"/split" => Split::Dashboard.new
```
However, if you are using Rails 3 or higher: You can mount this inside your app routes by first adding this to the Gemfile:
```ruby
gem 'split', require: 'split/dashboard'
```
Then adding this to config/routes.rb
```ruby
mount Split::Dashboard, at: 'split'
```
You may want to password protect that page, you can do so with `Rack::Auth::Basic` (in your split initializer file)
```ruby
# Rails apps or apps that already depend on activesupport
Split::Dashboard.use Rack::Auth::Basic do |username, password|
# Protect against timing attacks:
# - Use & (do not use &&) so that it doesn't short circuit.
# - Use digests to stop length information leaking
ActiveSupport::SecurityUtils.secure_compare(::Digest::SHA256.hexdigest(username), ::Digest::SHA256.hexdigest(ENV["SPLIT_USERNAME"])) &
ActiveSupport::SecurityUtils.secure_compare(::Digest::SHA256.hexdigest(password), ::Digest::SHA256.hexdigest(ENV["SPLIT_PASSWORD"]))
end
# Apps without activesupport
Split::Dashboard.use Rack::Auth::Basic do |username, password|
# Protect against timing attacks:
# - Use & (do not use &&) so that it doesn't short circuit.
# - Use digests to stop length information leaking
Rack::Utils.secure_compare(::Digest::SHA256.hexdigest(username), ::Digest::SHA256.hexdigest(ENV["SPLIT_USERNAME"])) &
Rack::Utils.secure_compare(::Digest::SHA256.hexdigest(password), ::Digest::SHA256.hexdigest(ENV["SPLIT_PASSWORD"]))
end
```
You can even use Devise or any other Warden-based authentication method to authorize users. Just replace `mount Split::Dashboard, :at => 'split'` in `config/routes.rb` with the following:
```ruby
match "/split" => Split::Dashboard, anchor: false, via: [:get, :post, :delete], constraints: -> (request) do
request.env['warden'].authenticated? # are we authenticated?
request.env['warden'].authenticate! # authenticate if not already
# or even check any other condition such as request.env['warden'].user.is_admin?
end
```
More information on this [here](https://steve.dynedge.co.uk/2011/12/09/controlling-access-to-routes-and-rack-apps-in-rails-3-with-devise-and-warden/)
### Screenshot
## Configuration
You can override the default configuration options of Split like so:
```ruby
Split.configure do |config|
config.db_failover = true # handle Redis errors gracefully
config.db_failover_on_db_error = -> (error) { Rails.logger.error(error.message) }
config.allow_multiple_experiments = true
config.enabled = true
config.persistence = Split::Persistence::SessionAdapter
#config.start_manually = false ## new test will have to be started manually from the admin panel. default false
#config.reset_manually = false ## if true, it never resets the experiment data, even if the configuration changes
config.include_rails_helper = true
config.redis = "redis://custom.redis.url:6380"
end
```
Split looks for the Redis host in the environment variable `REDIS_URL` then
defaults to `redis://localhost:6379` if not specified by configure block.
On platforms like Heroku, Split will use the value of `REDIS_PROVIDER` to
determine which env variable key to use when retrieving the host config. This
defaults to `REDIS_URL`.
### Filtering
In most scenarios you don't want to have AB-Testing enabled for web spiders, robots or special groups of users.
Split provides functionality to filter this based on a predefined, extensible list of bots, IP-lists or custom exclude logic.
```ruby
Split.configure do |config|
# bot config
config.robot_regex = /my_custom_robot_regex/ # or
config.bots['newbot'] = "Description for bot with 'newbot' user agent, which will be added to config.robot_regex for exclusion"
# IP config
config.ignore_ip_addresses << '81.19.48.130' # or regex: /81\.19\.48\.[0-9]+/
# or provide your own filter functionality, the default is proc{ |request| is_robot? || is_ignored_ip_address? || is_preview? }
config.ignore_filter = -> (request) { CustomExcludeLogic.excludes?(request) }
end
```
### Experiment configuration
Instead of providing the experiment options inline, you can store them
in a hash. This hash can control your experiment's alternatives, weights,
algorithm and if the experiment resets once finished:
```ruby
Split.configure do |config|
config.experiments = {
my_first_experiment: {
alternatives: ["a", "b"],
resettable: false
},
:my_second_experiment => {
algorithm: 'Split::Algorithms::Whiplash',
alternatives: [
{ name: "a", percent: 67 },
{ name: "b", percent: 33 }
]
}
}
end
```
You can also store your experiments in a YAML file:
```ruby
Split.configure do |config|
config.experiments = YAML.load_file "config/experiments.yml"
end
```
You can then define the YAML file like:
```yaml
my_first_experiment:
alternatives:
- a
- b
my_second_experiment:
alternatives:
- name: a
percent: 67
- name: b
percent: 33
resettable: false
```
This simplifies the calls from your code:
```ruby
ab_test(:my_first_experiment)
```
and:
```ruby
ab_finished(:my_first_experiment)
```
You can also add meta data for each experiment, which is very useful when you need more than an alternative name to change behaviour:
```ruby
Split.configure do |config|
config.experiments = {
my_first_experiment: {
alternatives: ["a", "b"],
metadata: {
"a" => {"text" => "Have a fantastic day"},
"b" => {"text" => "Don't get hit by a bus"}
}
}
}
end
```
```yaml
my_first_experiment:
alternatives:
- a
- b
metadata:
a:
text: "Have a fantastic day"
b:
text: "Don't get hit by a bus"
```
This allows for some advanced experiment configuration using methods like:
```ruby
trial.alternative.name # => "a"
trial.metadata['text'] # => "Have a fantastic day"
```
or in views:
```erb
<% ab_test("my_first_experiment") do |alternative, meta| %>
<%= alternative %>
<small><%= meta['text'] %></small>
<% end %>
```
The keys used in meta data should be Strings
#### Metrics
You might wish to track generic metrics, such as conversions, and use
those to complete multiple different experiments without adding more to
your code. You can use the configuration hash to do this, thanks to
the `:metric` option.
```ruby
Split.configure do |config|
config.experiments = {
my_first_experiment: {
alternatives: ["a", "b"],
metric: :my_metric
}
}
end
```
Your code may then track a completion using the metric instead of
the experiment name:
```ruby
ab_finished(:my_metric)
```
You can also create a new metric by instantiating and saving a new Metric object.
```ruby
Split::Metric.new(:my_metric)
Split::Metric.save
```
#### Goals
You might wish to allow an experiment to have multiple, distinguishable goals.
The API to define goals for an experiment is this:
```ruby
ab_test({link_color: ["purchase", "refund"]}, "red", "blue")
```
or you can define them in a configuration file:
```ruby
Split.configure do |config|
config.experiments = {
link_color: {
alternatives: ["red", "blue"],
goals: ["purchase", "refund"]
}
}
end
```
To complete a goal conversion, you do it like:
```ruby
ab_finished(link_color: "purchase")
```
Note that if you pass additional options, that should be a separate hash:
```ruby
ab_finished({ link_color: "purchase" }, reset: false)
```
**NOTE:** This does not mean that a single experiment can complete more than one goal.
Once you finish one of the goals, the test is considered to be completed, and finishing the other goal will no longer register. (Assuming the test runs with `reset: false`.)
**Good Example**: Test if listing Plan A first result in more conversions to Plan A (goal: "plana_conversion") or Plan B (goal: "planb_conversion").
**Bad Example**: Test if button color increases conversion rate through multiple steps of a funnel. THIS WILL NOT WORK.
**Bad Example**: Test both how button color affects signup *and* how it affects login, at the same time. THIS WILL NOT WORK.
#### Combined Experiments
If you want to test how button color affects signup *and* how it affects login at the same time, use combined experiments.
Configure like so:
```ruby
Split.configuration.experiments = {
:button_color_experiment => {
:alternatives => ["blue", "green"],
:combined_experiments => ["button_color_on_signup", "button_color_on_login"]
}
}
```
Starting the combined test starts all combined experiments
```ruby
ab_combined_test(:button_color_experiment)
```
Finish each combined test as normal
```ruby
ab_finished(:button_color_on_login)
ab_finished(:button_color_on_signup)
```
**Additional Configuration**:
* Be sure to enable `allow_multiple_experiments`
* In Sinatra include the CombinedExperimentsHelper
```
helpers Split::CombinedExperimentsHelper
```
### DB failover solution
Due to the fact that Redis has no automatic failover mechanism, it's
possible to switch on the `db_failover` config option, so that `ab_test`
and `ab_finished` will not crash in case of a db failure. `ab_test` always
delivers alternative A (the first one) in that case.
It's also possible to set a `db_failover_on_db_error` callback (proc)
for example to log these errors via Rails.logger.
### Redis
You may want to change the Redis host and port Split connects to, or
set various other options at startup.
Split has a `redis` setter which can be given a string or a Redis
object. This means if you're already using Redis in your app, Split
can re-use the existing connection.
String: `Split.redis = 'redis://localhost:6379'`
Redis: `Split.redis = $redis`
For our rails app we have a `config/initializers/split.rb` file where
we load `config/split.yml` by hand and set the Redis information
appropriately.
Here's our `config/split.yml`:
```yml
development: redis://localhost:6379
test: redis://localhost:6379
staging: redis://redis1.example.com:6379
fi: redis://localhost:6379
production: redis://redis1.example.com:6379
```
And our initializer:
```ruby
split_config = YAML.load_file(Rails.root.join('config', 'split.yml'))
Split.redis = split_config[Rails.env]
```
### Redis Caching (v4.0+)
In some high-volume usage scenarios, Redis load can be incurred by repeated
fetches for fairly static data. Enabling caching will reduce this load.
```ruby
Split.configuration.cache = true
````
This currently caches:
- `Split::ExperimentCatalog.find`
- `Split::Experiment.start_time`
- `Split::Experiment.winner`
## Namespaces
If you're running multiple, separate instances of Split you may want
to namespace the keyspaces so they do not overlap. This is not unlike
the approach taken by many memcached clients.
This feature can be provided by the [redis-namespace](https://github.com/defunkt/redis-namespace)
library. To configure Split to use `Redis::Namespace`, do the following:
1. Add `redis-namespace` to your Gemfile:
```ruby
gem 'redis-namespace'
```
2. Configure `Split.redis` to use a `Redis::Namespace` instance (possible in an
initializer):
```ruby
redis = Redis.new(url: ENV['REDIS_URL']) # or whatever config you want
Split.redis = Redis::Namespace.new(:your_namespace, redis: redis)
```
## Outside of a Web Session
Split provides the Helper module to facilitate running experiments inside web sessions.
Alternatively, you can access the underlying Metric, Trial, Experiment and Alternative objects to
conduct experiments that are not tied to a web session.
```ruby
# create a new experiment
experiment = Split::ExperimentCatalog.find_or_create('color', 'red', 'blue')
# create a new trial
trial = Split::Trial.new(:experiment => experiment)
# run trial
trial.choose!
# get the result, returns either red or blue
trial.alternative.name
# if the goal has been achieved, increment the successful completions for this alternative.
if goal_achieved?
trial.complete!
end
```
## Algorithms
By default, Split ships with `Split::Algorithms::WeightedSample` that randomly selects from possible alternatives for a traditional a/b test.
It is possible to specify static weights to favor certain alternatives.
`Split::Algorithms::Whiplash` is an implementation of a [multi-armed bandit algorithm](http://stevehanov.ca/blog/index.php?id=132).
This algorithm will automatically weight the alternatives based on their relative performance,
choosing the better-performing ones more often as trials are completed.
`Split::Algorithms::BlockRandomization` is an algorithm that ensures equal
participation across all alternatives. This algorithm will choose the alternative
with the fewest participants. In the event of multiple minimum participant alternatives
(i.e. starting a new "Block") the algorithm will choose a random alternative from
those minimum participant alternatives.
Users may also write their own algorithms. The default algorithm may be specified globally in the configuration file, or on a per experiment basis using the experiments hash of the configuration file.
To change the algorithm globally for all experiments, use the following in your initializer:
```ruby
Split.configure do |config|
config.algorithm = Split::Algorithms::Whiplash
end
```
## Extensions
- [Split::Export](https://github.com/splitrb/split-export) - Easily export A/B test data out of Split.
- [Split::Analytics](https://github.com/splitrb/split-analytics) - Push test data to Google Analytics.
- [Split::Mongoid](https://github.com/MongoHQ/split-mongoid) - Store experiment data in mongoid (still uses redis).
- [Split::Cacheable](https://github.com/harrystech/split_cacheable) - Automatically create cache buckets per test.
- [Split::Counters](https://github.com/bernardkroes/split-counters) - Add counters per experiment and alternative.
- [Split::Cli](https://github.com/craigmcnamara/split-cli) - A CLI to trigger Split A/B tests.
## Screencast
Ryan bates has produced an excellent 10 minute screencast about split on the Railscasts site: [A/B Testing with Split](http://railscasts.com/episodes/331-a-b-testing-with-split)
## Blogposts
* [Recipe: A/B testing with KISSMetrics and the split gem](https://robots.thoughtbot.com/post/9595887299/recipe-a-b-testing-with-kissmetrics-and-the-split-gem)
* [Rails A/B testing with Split on Heroku](http://blog.nathanhumbert.com/2012/02/rails-ab-testing-with-split-on-heroku.html)
## Backers
Support us with a monthly donation and help us continue our activities. [[Become a backer](https://opencollective.com/split#backer)]
<a href="https://opencollective.com/split/backer/0/website" target="_blank"><img src="https://opencollective.com/split/backer/0/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/1/website" target="_blank"><img src="https://opencollective.com/split/backer/1/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/2/website" target="_blank"><img src="https://opencollective.com/split/backer/2/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/3/website" target="_blank"><img src="https://opencollective.com/split/backer/3/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/4/website" target="_blank"><img src="https://opencollective.com/split/backer/4/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/5/website" target="_blank"><img src="https://opencollective.com/split/backer/5/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/6/website" target="_blank"><img src="https://opencollective.com/split/backer/6/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/7/website" target="_blank"><img src="https://opencollective.com/split/backer/7/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/8/website" target="_blank"><img src="https://opencollective.com/split/backer/8/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/9/website" target="_blank"><img src="https://opencollective.com/split/backer/9/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/10/website" target="_blank"><img src="https://opencollective.com/split/backer/10/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/11/website" target="_blank"><img src="https://opencollective.com/split/backer/11/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/12/website" target="_blank"><img src="https://opencollective.com/split/backer/12/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/13/website" target="_blank"><img src="https://opencollective.com/split/backer/13/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/14/website" target="_blank"><img src="https://opencollective.com/split/backer/14/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/15/website" target="_blank"><img src="https://opencollective.com/split/backer/15/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/16/website" target="_blank"><img src="https://opencollective.com/split/backer/16/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/17/website" target="_blank"><img src="https://opencollective.com/split/backer/17/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/18/website" target="_blank"><img src="https://opencollective.com/split/backer/18/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/19/website" target="_blank"><img src="https://opencollective.com/split/backer/19/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/20/website" target="_blank"><img src="https://opencollective.com/split/backer/20/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/21/website" target="_blank"><img src="https://opencollective.com/split/backer/21/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/22/website" target="_blank"><img src="https://opencollective.com/split/backer/22/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/23/website" target="_blank"><img src="https://opencollective.com/split/backer/23/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/24/website" target="_blank"><img src="https://opencollective.com/split/backer/24/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/25/website" target="_blank"><img src="https://opencollective.com/split/backer/25/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/26/website" target="_blank"><img src="https://opencollective.com/split/backer/26/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/27/website" target="_blank"><img src="https://opencollective.com/split/backer/27/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/28/website" target="_blank"><img src="https://opencollective.com/split/backer/28/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/29/website" target="_blank"><img src="https://opencollective.com/split/backer/29/avatar.svg"></a>
## Sponsors
Become a sponsor and get your logo on our README on Github with a link to your site. [[Become a sponsor](https://opencollective.com/split#sponsor)]
<a href="https://opencollective.com/split/sponsor/0/website" target="_blank"><img src="https://opencollective.com/split/sponsor/0/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/1/website" target="_blank"><img src="https://opencollective.com/split/sponsor/1/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/2/website" target="_blank"><img src="https://opencollective.com/split/sponsor/2/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/3/website" target="_blank"><img src="https://opencollective.com/split/sponsor/3/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/4/website" target="_blank"><img src="https://opencollective.com/split/sponsor/4/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/5/website" target="_blank"><img src="https://opencollective.com/split/sponsor/5/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/6/website" target="_blank"><img src="https://opencollective.com/split/sponsor/6/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/7/website" target="_blank"><img src="https://opencollective.com/split/sponsor/7/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/8/website" target="_blank"><img src="https://opencollective.com/split/sponsor/8/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/9/website" target="_blank"><img src="https://opencollective.com/split/sponsor/9/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/10/website" target="_blank"><img src="https://opencollective.com/split/sponsor/10/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/11/website" target="_blank"><img src="https://opencollective.com/split/sponsor/11/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/12/website" target="_blank"><img src="https://opencollective.com/split/sponsor/12/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/13/website" target="_blank"><img src="https://opencollective.com/split/sponsor/13/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/14/website" target="_blank"><img src="https://opencollective.com/split/sponsor/14/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/15/website" target="_blank"><img src="https://opencollective.com/split/sponsor/15/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/16/website" target="_blank"><img src="https://opencollective.com/split/sponsor/16/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/17/website" target="_blank"><img src="https://opencollective.com/split/sponsor/17/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/18/website" target="_blank"><img src="https://opencollective.com/split/sponsor/18/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/19/website" target="_blank"><img src="https://opencollective.com/split/sponsor/19/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/20/website" target="_blank"><img src="https://opencollective.com/split/sponsor/20/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/21/website" target="_blank"><img src="https://opencollective.com/split/sponsor/21/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/22/website" target="_blank"><img src="https://opencollective.com/split/sponsor/22/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/23/website" target="_blank"><img src="https://opencollective.com/split/sponsor/23/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/24/website" target="_blank"><img src="https://opencollective.com/split/sponsor/24/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/25/website" target="_blank"><img src="https://opencollective.com/split/sponsor/25/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/26/website" target="_blank"><img src="https://opencollective.com/split/sponsor/26/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/27/website" target="_blank"><img src="https://opencollective.com/split/sponsor/27/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/28/website" target="_blank"><img src="https://opencollective.com/split/sponsor/28/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/29/website" target="_blank"><img src="https://opencollective.com/split/sponsor/29/avatar.svg"></a>
## Contribute
Please do! Over 70 different people have contributed to the project, you can see them all here: https://github.com/splitrb/split/graphs/contributors.
### Development
The source code is hosted at [GitHub](https://github.com/splitrb/split).
Report issues and feature requests on [GitHub Issues](https://github.com/splitrb/split/issues).
You can find a discussion form on [Google Groups](https://groups.google.com/d/forum/split-ruby).
### Tests
Run the tests like this:
# Start a Redis server in another tab.
redis-server
bundle
rake spec
### A Note on Patches and Pull Requests
* Fork the project.
* Make your feature addition or bug fix.
* Add tests for it. This is important so I don't break it in a
future version unintentionally.
* Add documentation if necessary.
* Commit. Do not mess with the rakefile, version, or history.
(If you want to have your own version, that is fine. But bump the version in a commit by itself, which I can ignore when I pull.)
* Send a pull request. Bonus points for topic branches.
### Code of Conduct
Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
## Copyright
[MIT License](LICENSE) © 2019 [Andrew Nesbitt](https://github.com/andrew).
<MSG> update readme
<DFF> @@ -194,7 +194,7 @@ Split.configure do |config|
end
```
-By default, cookies will expire in 1 year. To change that, set the `persistence_cookie_length` in the configuration.
+By default, cookies will expire in 1 year. To change that, set the `persistence_cookie_length` in the configuration (unit of time in seconds).
```ruby
Split.configure do |config|
| 1 | update readme | 1 | .md | md | mit | splitrb/split |
10072382 | <NME> README.md
<BEF> # [Split](https://libraries.io/rubygems/split)
[](http://badge.fury.io/rb/split)
[](https://codeclimate.com/github/splitrb/split)
[](https://codeclimate.com/github/splitrb/split/coverage)
[](https://github.com/RichardLitt/standard-readme)
[](https://www.codetriage.com/splitrb/split)
> 📈 The Rack Based A/B testing framework https://libraries.io/rubygems/split
Split is a rack based A/B testing framework designed to work with Rails, Sinatra or any other rack based app.
Split is heavily inspired by the [Abingo](https://github.com/ryanb/abingo) and [Vanity](https://github.com/assaf/vanity) Rails A/B testing plugins and [Resque](https://github.com/resque/resque) in its use of Redis.
Split is designed to be hacker friendly, allowing for maximum customisation and extensibility.
## Install
### Requirements
Split v4.0+ is currently tested with Ruby >= 2.5 and Rails >= 5.2.
If your project requires compatibility with Ruby 2.4.x or older Rails versions. You can try v3.0 or v0.8.0(for Ruby 1.9.3)
Split uses Redis as a datastore.
Split only supports Redis 4.0 or greater.
If you're on OS X, Homebrew is the simplest way to install Redis:
```bash
brew install redis
redis-server /usr/local/etc/redis.conf
```
You now have a Redis daemon running on port `6379`.
### Setup
```bash
gem install split
```
#### Rails
Adding `gem 'split'` to your Gemfile will autoload it when rails starts up, as long as you've configured Redis it will 'just work'.
#### Sinatra
To configure Sinatra with Split you need to enable sessions and mix in the helper methods. Add the following lines at the top of your Sinatra app:
```ruby
require 'split'
class MySinatraApp < Sinatra::Base
enable :sessions
helpers Split::Helper
get '/' do
...
end
```
## Usage
To begin your A/B test use the `ab_test` method, naming your experiment with the first argument and then the different alternatives which you wish to test on as the other arguments.
`ab_test` returns one of the alternatives, if a user has already seen that test they will get the same alternative as before, which you can use to split your code on.
It can be used to render different templates, show different text or any other case based logic.
`ab_finished` is used to make a completion of an experiment, or conversion.
Example: View
```erb
<% ab_test(:login_button, "/images/button1.jpg", "/images/button2.jpg") do |button_file| %>
<%= image_tag(button_file, alt: "Login!") %>
<% end %>
```
Example: Controller
```ruby
def register_new_user
# See what level of free points maximizes users' decision to buy replacement points.
@starter_points = ab_test(:new_user_free_points, '100', '200', '300')
end
```
Example: Conversion tracking (in a controller!)
```ruby
def buy_new_points
# some business logic
ab_finished(:new_user_free_points)
end
```
Example: Conversion tracking (in a view)
```erb
Thanks for signing up, dude! <% ab_finished(:signup_page_redesign) %>
```
You can find more examples, tutorials and guides on the [wiki](https://github.com/splitrb/split/wiki).
## Statistical Validity
Split has two options for you to use to determine which alternative is the best.
The first option (default on the dashboard) uses a z test (n>30) for the difference between your control and alternative conversion rates to calculate statistical significance. This test will tell you whether an alternative is better or worse than your control, but it will not distinguish between which alternative is the best in an experiment with multiple alternatives. Split will only tell you if your experiment is 90%, 95%, or 99% significant, and this test only works if you have more than 30 participants and 5 conversions for each branch.
As per this [blog post](https://www.evanmiller.org/how-not-to-run-an-ab-test.html) on the pitfalls of A/B testing, it is highly recommended that you determine your requisite sample size for each branch before running the experiment. Otherwise, you'll have an increased rate of false positives (experiments which show a significant effect where really there is none).
[Here](https://www.evanmiller.org/ab-testing/sample-size.html) is a sample size calculator for your convenience.
The second option uses simulations from a beta distribution to determine the probability that the given alternative is the winner compared to all other alternatives. You can view these probabilities by clicking on the drop-down menu labeled "Confidence." This option should be used when the experiment has more than just 1 control and 1 alternative. It can also be used for a simple, 2-alternative A/B test.
Calculating the beta-distribution simulations for a large number of experiments can be slow, so the results are cached. You can specify how often they should be recalculated (the default is once per day).
```ruby
Split.configure do |config|
config.winning_alternative_recalculation_interval = 3600 # 1 hour
end
```
## Extras
### Weighted alternatives
Perhaps you only want to show an alternative to 10% of your visitors because it is very experimental or not yet fully load tested.
To do this you can pass a weight with each alternative in the following ways:
```ruby
ab_test(:homepage_design, {'Old' => 18}, {'New' => 2})
ab_test(:homepage_design, 'Old', {'New' => 1.0/9})
ab_test(:homepage_design, {'Old' => 9}, 'New')
```
This will only show the new alternative to visitors 1 in 10 times, the default weight for an alternative is 1.
### Overriding alternatives
For development and testing, you may wish to force your app to always return an alternative.
You can do this by passing it as a parameter in the url.
If you have an experiment called `button_color` with alternatives called `red` and `blue` used on your homepage, a url such as:
http://myawesomesite.com?ab_test[button_color]=red
will always have red buttons. This won't be stored in your session or count towards to results, unless you set the `store_override` configuration option.
In the event you want to disable all tests without having to know the individual experiment names, add a `SPLIT_DISABLE` query parameter.
http://myawesomesite.com?SPLIT_DISABLE=true
It is not required to send `SPLIT_DISABLE=false` to activate Split.
### Rspec Helper
To aid testing with RSpec, write `spec/support/split_helper.rb` and call `use_ab_test(alternatives_by_experiment)` in your specs as instructed below:
```ruby
# Create a file with these contents at 'spec/support/split_helper.rb'
# and ensure it is `require`d in your rails_helper.rb or spec_helper.rb
module SplitHelper
# Force a specific experiment alternative to always be returned:
# use_ab_test(signup_form: "single_page")
#
# Force alternatives for multiple experiments:
# use_ab_test(signup_form: "single_page", pricing: "show_enterprise_prices")
#
def use_ab_test(alternatives_by_experiment)
allow_any_instance_of(Split::Helper).to receive(:ab_test) do |_receiver, experiment, &block|
variant = alternatives_by_experiment.fetch(experiment) { |key| raise "Unknown experiment '#{key}'" }
block.call(variant) unless block.nil?
variant
end
end
end
# Make the `use_ab_test` method available to all specs:
RSpec.configure do |config|
config.include SplitHelper
end
```
end
```
By default, cookies will expire in 1 year. To change that, set the `persistence_cookie_length` in the configuration.
```ruby
Split.configure do |config|
```
### Starting experiments manually
By default new A/B tests will be active right after deployment. In case you would like to start new test a while after
the deploy, you can do it by setting the `start_manually` configuration option to `true`.
After choosing this option tests won't be started right after deploy, but after pressing the `Start` button in Split admin dashboard. If a test is deleted from the Split dashboard, then it can only be started after pressing the `Start` button whenever being re-initialized.
### Reset after completion
When a user completes a test their session is reset so that they may start the test again in the future.
To stop this behaviour you can pass the following option to the `ab_finished` method:
```ruby
ab_finished(:experiment_name, reset: false)
```
The user will then always see the alternative they started with.
Any old unfinished experiment key will be deleted from the user's data storage if the experiment had been removed or is over and a winner had been chosen. This allows a user to enroll into any new experiment in cases when the `allow_multiple_experiments` config option is set to `false`.
### Reset experiments manually
By default Split automatically resets the experiment whenever it detects the configuration for an experiment has changed (e.g. you call `ab_test` with different alternatives). You can prevent this by setting the option `reset_manually` to `true`.
You may want to do this when you want to change something, like the variants' names, the metadata about an experiment, etc. without resetting everything.
### Multiple experiments at once
By default Split will avoid users participating in multiple experiments at once. This means you are less likely to skew results by adding in more variation to your tests.
To stop this behaviour and allow users to participate in multiple experiments at once set the `allow_multiple_experiments` config option to true like so:
```ruby
Split.configure do |config|
config.allow_multiple_experiments = true
end
```
This will allow the user to participate in any number of experiments and belong to any alternative in each experiment. This has the possible downside of a variation in one experiment influencing the outcome of another.
To address this, setting the `allow_multiple_experiments` config option to 'control' like so:
```ruby
Split.configure do |config|
config.allow_multiple_experiments = 'control'
end
```
For this to work, each and every experiment you define must have an alternative named 'control'. This will allow the user to participate in multiple experiments as long as the user belongs to the alternative 'control' in each experiment. As soon as the user belongs to an alternative named something other than 'control' the user may not participate in any more experiments. Calling ab_test(<other experiments>) will always return the first alternative without adding the user to that experiment.
### Experiment Persistence
Split comes with three built-in persistence adapters for storing users and the alternatives they've been given for each experiment.
By default Split will store the tests for each user in the session.
You can optionally configure Split to use a cookie, Redis, or any custom adapter of your choosing.
#### Cookies
```ruby
Split.configure do |config|
config.persistence = :cookie
end
```
When using the cookie persistence, Split stores data into an anonymous tracking cookie named 'split', which expires in 1 year. To change that, set the `persistence_cookie_length` in the configuration (unit of time in seconds).
```ruby
Split.configure do |config|
config.persistence = :cookie
config.persistence_cookie_length = 2592000 # 30 days
end
```
The data stored consists of the experiment name and the variants the user is in. Example: { "experiment_name" => "variant_a" }
__Note:__ Using cookies depends on `ActionDispatch::Cookies` or any identical API
#### Redis
Using Redis will allow ab_users to persist across sessions or machines.
```ruby
Split.configure do |config|
config.persistence = Split::Persistence::RedisAdapter.with_config(lookup_by: -> (context) { context.current_user_id })
# Equivalent
# config.persistence = Split::Persistence::RedisAdapter.with_config(lookup_by: :current_user_id)
end
```
Options:
* `lookup_by`: method to invoke per request for uniquely identifying ab_users (mandatory configuration)
* `namespace`: separate namespace to store these persisted values (default "persistence")
* `expire_seconds`: sets TTL for user key. (if a user is in multiple experiments most recent update will reset TTL for all their assignments)
#### Dual Adapter
The Dual Adapter allows the use of different persistence adapters for logged-in and logged-out users. A common use case is to use Redis for logged-in users and Cookies for logged-out users.
```ruby
cookie_adapter = Split::Persistence::CookieAdapter
redis_adapter = Split::Persistence::RedisAdapter.with_config(
lookup_by: -> (context) { context.send(:current_user).try(:id) },
expire_seconds: 2592000)
Split.configure do |config|
config.persistence = Split::Persistence::DualAdapter.with_config(
logged_in: -> (context) { !context.send(:current_user).try(:id).nil? },
logged_in_adapter: redis_adapter,
logged_out_adapter: cookie_adapter)
config.persistence_cookie_length = 2592000 # 30 days
end
```
#### Custom Adapter
Your custom adapter needs to implement the same API as existing adapters.
See `Split::Persistence::CookieAdapter` or `Split::Persistence::SessionAdapter` for a starting point.
```ruby
Split.configure do |config|
config.persistence = YourCustomAdapterClass
end
```
### Trial Event Hooks
You can define methods that will be called at the same time as experiment
alternative participation and goal completion.
For example:
``` ruby
Split.configure do |config|
config.on_trial = :log_trial # run on every trial
config.on_trial_choose = :log_trial_choose # run on trials with new users only
config.on_trial_complete = :log_trial_complete
end
```
Set these attributes to a method name available in the same context as the
`ab_test` method. These methods should accept one argument, a `Trial` instance.
``` ruby
def log_trial(trial)
logger.info "experiment=%s alternative=%s user=%s" %
[ trial.experiment.name, trial.alternative, current_user.id ]
end
def log_trial_choose(trial)
logger.info "[new user] experiment=%s alternative=%s user=%s" %
[ trial.experiment.name, trial.alternative, current_user.id ]
end
def log_trial_complete(trial)
logger.info "experiment=%s alternative=%s user=%s complete=true" %
[ trial.experiment.name, trial.alternative, current_user.id ]
end
```
#### Views
If you are running `ab_test` from a view, you must define your event
hook callback as a
[helper_method](https://apidock.com/rails/AbstractController/Helpers/ClassMethods/helper_method)
in the controller:
``` ruby
helper_method :log_trial_choose
def log_trial_choose(trial)
logger.info "experiment=%s alternative=%s user=%s" %
[ trial.experiment.name, trial.alternative, current_user.id ]
end
```
### Experiment Hooks
You can assign a proc that will be called when an experiment is reset or deleted. You can use these hooks to call methods within your application to keep data related to experiments in sync with Split.
For example:
``` ruby
Split.configure do |config|
# after experiment reset or deleted
config.on_experiment_reset = -> (example) { # Do something on reset }
config.on_experiment_delete = -> (experiment) { # Do something else on delete }
# before experiment reset or deleted
config.on_before_experiment_reset = -> (example) { # Do something on reset }
config.on_before_experiment_delete = -> (experiment) { # Do something else on delete }
# after experiment winner had been set
config.on_experiment_winner_choose = -> (experiment) { # Do something on winner choose }
end
```
## Web Interface
Split comes with a Sinatra-based front end to get an overview of how your experiments are doing.
If you are running Rails 2: You can mount this inside your app using Rack::URLMap in your `config.ru`
```ruby
require 'split/dashboard'
run Rack::URLMap.new \
"/" => Your::App.new,
"/split" => Split::Dashboard.new
```
However, if you are using Rails 3 or higher: You can mount this inside your app routes by first adding this to the Gemfile:
```ruby
gem 'split', require: 'split/dashboard'
```
Then adding this to config/routes.rb
```ruby
mount Split::Dashboard, at: 'split'
```
You may want to password protect that page, you can do so with `Rack::Auth::Basic` (in your split initializer file)
```ruby
# Rails apps or apps that already depend on activesupport
Split::Dashboard.use Rack::Auth::Basic do |username, password|
# Protect against timing attacks:
# - Use & (do not use &&) so that it doesn't short circuit.
# - Use digests to stop length information leaking
ActiveSupport::SecurityUtils.secure_compare(::Digest::SHA256.hexdigest(username), ::Digest::SHA256.hexdigest(ENV["SPLIT_USERNAME"])) &
ActiveSupport::SecurityUtils.secure_compare(::Digest::SHA256.hexdigest(password), ::Digest::SHA256.hexdigest(ENV["SPLIT_PASSWORD"]))
end
# Apps without activesupport
Split::Dashboard.use Rack::Auth::Basic do |username, password|
# Protect against timing attacks:
# - Use & (do not use &&) so that it doesn't short circuit.
# - Use digests to stop length information leaking
Rack::Utils.secure_compare(::Digest::SHA256.hexdigest(username), ::Digest::SHA256.hexdigest(ENV["SPLIT_USERNAME"])) &
Rack::Utils.secure_compare(::Digest::SHA256.hexdigest(password), ::Digest::SHA256.hexdigest(ENV["SPLIT_PASSWORD"]))
end
```
You can even use Devise or any other Warden-based authentication method to authorize users. Just replace `mount Split::Dashboard, :at => 'split'` in `config/routes.rb` with the following:
```ruby
match "/split" => Split::Dashboard, anchor: false, via: [:get, :post, :delete], constraints: -> (request) do
request.env['warden'].authenticated? # are we authenticated?
request.env['warden'].authenticate! # authenticate if not already
# or even check any other condition such as request.env['warden'].user.is_admin?
end
```
More information on this [here](https://steve.dynedge.co.uk/2011/12/09/controlling-access-to-routes-and-rack-apps-in-rails-3-with-devise-and-warden/)
### Screenshot
## Configuration
You can override the default configuration options of Split like so:
```ruby
Split.configure do |config|
config.db_failover = true # handle Redis errors gracefully
config.db_failover_on_db_error = -> (error) { Rails.logger.error(error.message) }
config.allow_multiple_experiments = true
config.enabled = true
config.persistence = Split::Persistence::SessionAdapter
#config.start_manually = false ## new test will have to be started manually from the admin panel. default false
#config.reset_manually = false ## if true, it never resets the experiment data, even if the configuration changes
config.include_rails_helper = true
config.redis = "redis://custom.redis.url:6380"
end
```
Split looks for the Redis host in the environment variable `REDIS_URL` then
defaults to `redis://localhost:6379` if not specified by configure block.
On platforms like Heroku, Split will use the value of `REDIS_PROVIDER` to
determine which env variable key to use when retrieving the host config. This
defaults to `REDIS_URL`.
### Filtering
In most scenarios you don't want to have AB-Testing enabled for web spiders, robots or special groups of users.
Split provides functionality to filter this based on a predefined, extensible list of bots, IP-lists or custom exclude logic.
```ruby
Split.configure do |config|
# bot config
config.robot_regex = /my_custom_robot_regex/ # or
config.bots['newbot'] = "Description for bot with 'newbot' user agent, which will be added to config.robot_regex for exclusion"
# IP config
config.ignore_ip_addresses << '81.19.48.130' # or regex: /81\.19\.48\.[0-9]+/
# or provide your own filter functionality, the default is proc{ |request| is_robot? || is_ignored_ip_address? || is_preview? }
config.ignore_filter = -> (request) { CustomExcludeLogic.excludes?(request) }
end
```
### Experiment configuration
Instead of providing the experiment options inline, you can store them
in a hash. This hash can control your experiment's alternatives, weights,
algorithm and if the experiment resets once finished:
```ruby
Split.configure do |config|
config.experiments = {
my_first_experiment: {
alternatives: ["a", "b"],
resettable: false
},
:my_second_experiment => {
algorithm: 'Split::Algorithms::Whiplash',
alternatives: [
{ name: "a", percent: 67 },
{ name: "b", percent: 33 }
]
}
}
end
```
You can also store your experiments in a YAML file:
```ruby
Split.configure do |config|
config.experiments = YAML.load_file "config/experiments.yml"
end
```
You can then define the YAML file like:
```yaml
my_first_experiment:
alternatives:
- a
- b
my_second_experiment:
alternatives:
- name: a
percent: 67
- name: b
percent: 33
resettable: false
```
This simplifies the calls from your code:
```ruby
ab_test(:my_first_experiment)
```
and:
```ruby
ab_finished(:my_first_experiment)
```
You can also add meta data for each experiment, which is very useful when you need more than an alternative name to change behaviour:
```ruby
Split.configure do |config|
config.experiments = {
my_first_experiment: {
alternatives: ["a", "b"],
metadata: {
"a" => {"text" => "Have a fantastic day"},
"b" => {"text" => "Don't get hit by a bus"}
}
}
}
end
```
```yaml
my_first_experiment:
alternatives:
- a
- b
metadata:
a:
text: "Have a fantastic day"
b:
text: "Don't get hit by a bus"
```
This allows for some advanced experiment configuration using methods like:
```ruby
trial.alternative.name # => "a"
trial.metadata['text'] # => "Have a fantastic day"
```
or in views:
```erb
<% ab_test("my_first_experiment") do |alternative, meta| %>
<%= alternative %>
<small><%= meta['text'] %></small>
<% end %>
```
The keys used in meta data should be Strings
#### Metrics
You might wish to track generic metrics, such as conversions, and use
those to complete multiple different experiments without adding more to
your code. You can use the configuration hash to do this, thanks to
the `:metric` option.
```ruby
Split.configure do |config|
config.experiments = {
my_first_experiment: {
alternatives: ["a", "b"],
metric: :my_metric
}
}
end
```
Your code may then track a completion using the metric instead of
the experiment name:
```ruby
ab_finished(:my_metric)
```
You can also create a new metric by instantiating and saving a new Metric object.
```ruby
Split::Metric.new(:my_metric)
Split::Metric.save
```
#### Goals
You might wish to allow an experiment to have multiple, distinguishable goals.
The API to define goals for an experiment is this:
```ruby
ab_test({link_color: ["purchase", "refund"]}, "red", "blue")
```
or you can define them in a configuration file:
```ruby
Split.configure do |config|
config.experiments = {
link_color: {
alternatives: ["red", "blue"],
goals: ["purchase", "refund"]
}
}
end
```
To complete a goal conversion, you do it like:
```ruby
ab_finished(link_color: "purchase")
```
Note that if you pass additional options, that should be a separate hash:
```ruby
ab_finished({ link_color: "purchase" }, reset: false)
```
**NOTE:** This does not mean that a single experiment can complete more than one goal.
Once you finish one of the goals, the test is considered to be completed, and finishing the other goal will no longer register. (Assuming the test runs with `reset: false`.)
**Good Example**: Test if listing Plan A first result in more conversions to Plan A (goal: "plana_conversion") or Plan B (goal: "planb_conversion").
**Bad Example**: Test if button color increases conversion rate through multiple steps of a funnel. THIS WILL NOT WORK.
**Bad Example**: Test both how button color affects signup *and* how it affects login, at the same time. THIS WILL NOT WORK.
#### Combined Experiments
If you want to test how button color affects signup *and* how it affects login at the same time, use combined experiments.
Configure like so:
```ruby
Split.configuration.experiments = {
:button_color_experiment => {
:alternatives => ["blue", "green"],
:combined_experiments => ["button_color_on_signup", "button_color_on_login"]
}
}
```
Starting the combined test starts all combined experiments
```ruby
ab_combined_test(:button_color_experiment)
```
Finish each combined test as normal
```ruby
ab_finished(:button_color_on_login)
ab_finished(:button_color_on_signup)
```
**Additional Configuration**:
* Be sure to enable `allow_multiple_experiments`
* In Sinatra include the CombinedExperimentsHelper
```
helpers Split::CombinedExperimentsHelper
```
### DB failover solution
Due to the fact that Redis has no automatic failover mechanism, it's
possible to switch on the `db_failover` config option, so that `ab_test`
and `ab_finished` will not crash in case of a db failure. `ab_test` always
delivers alternative A (the first one) in that case.
It's also possible to set a `db_failover_on_db_error` callback (proc)
for example to log these errors via Rails.logger.
### Redis
You may want to change the Redis host and port Split connects to, or
set various other options at startup.
Split has a `redis` setter which can be given a string or a Redis
object. This means if you're already using Redis in your app, Split
can re-use the existing connection.
String: `Split.redis = 'redis://localhost:6379'`
Redis: `Split.redis = $redis`
For our rails app we have a `config/initializers/split.rb` file where
we load `config/split.yml` by hand and set the Redis information
appropriately.
Here's our `config/split.yml`:
```yml
development: redis://localhost:6379
test: redis://localhost:6379
staging: redis://redis1.example.com:6379
fi: redis://localhost:6379
production: redis://redis1.example.com:6379
```
And our initializer:
```ruby
split_config = YAML.load_file(Rails.root.join('config', 'split.yml'))
Split.redis = split_config[Rails.env]
```
### Redis Caching (v4.0+)
In some high-volume usage scenarios, Redis load can be incurred by repeated
fetches for fairly static data. Enabling caching will reduce this load.
```ruby
Split.configuration.cache = true
````
This currently caches:
- `Split::ExperimentCatalog.find`
- `Split::Experiment.start_time`
- `Split::Experiment.winner`
## Namespaces
If you're running multiple, separate instances of Split you may want
to namespace the keyspaces so they do not overlap. This is not unlike
the approach taken by many memcached clients.
This feature can be provided by the [redis-namespace](https://github.com/defunkt/redis-namespace)
library. To configure Split to use `Redis::Namespace`, do the following:
1. Add `redis-namespace` to your Gemfile:
```ruby
gem 'redis-namespace'
```
2. Configure `Split.redis` to use a `Redis::Namespace` instance (possible in an
initializer):
```ruby
redis = Redis.new(url: ENV['REDIS_URL']) # or whatever config you want
Split.redis = Redis::Namespace.new(:your_namespace, redis: redis)
```
## Outside of a Web Session
Split provides the Helper module to facilitate running experiments inside web sessions.
Alternatively, you can access the underlying Metric, Trial, Experiment and Alternative objects to
conduct experiments that are not tied to a web session.
```ruby
# create a new experiment
experiment = Split::ExperimentCatalog.find_or_create('color', 'red', 'blue')
# create a new trial
trial = Split::Trial.new(:experiment => experiment)
# run trial
trial.choose!
# get the result, returns either red or blue
trial.alternative.name
# if the goal has been achieved, increment the successful completions for this alternative.
if goal_achieved?
trial.complete!
end
```
## Algorithms
By default, Split ships with `Split::Algorithms::WeightedSample` that randomly selects from possible alternatives for a traditional a/b test.
It is possible to specify static weights to favor certain alternatives.
`Split::Algorithms::Whiplash` is an implementation of a [multi-armed bandit algorithm](http://stevehanov.ca/blog/index.php?id=132).
This algorithm will automatically weight the alternatives based on their relative performance,
choosing the better-performing ones more often as trials are completed.
`Split::Algorithms::BlockRandomization` is an algorithm that ensures equal
participation across all alternatives. This algorithm will choose the alternative
with the fewest participants. In the event of multiple minimum participant alternatives
(i.e. starting a new "Block") the algorithm will choose a random alternative from
those minimum participant alternatives.
Users may also write their own algorithms. The default algorithm may be specified globally in the configuration file, or on a per experiment basis using the experiments hash of the configuration file.
To change the algorithm globally for all experiments, use the following in your initializer:
```ruby
Split.configure do |config|
config.algorithm = Split::Algorithms::Whiplash
end
```
## Extensions
- [Split::Export](https://github.com/splitrb/split-export) - Easily export A/B test data out of Split.
- [Split::Analytics](https://github.com/splitrb/split-analytics) - Push test data to Google Analytics.
- [Split::Mongoid](https://github.com/MongoHQ/split-mongoid) - Store experiment data in mongoid (still uses redis).
- [Split::Cacheable](https://github.com/harrystech/split_cacheable) - Automatically create cache buckets per test.
- [Split::Counters](https://github.com/bernardkroes/split-counters) - Add counters per experiment and alternative.
- [Split::Cli](https://github.com/craigmcnamara/split-cli) - A CLI to trigger Split A/B tests.
## Screencast
Ryan bates has produced an excellent 10 minute screencast about split on the Railscasts site: [A/B Testing with Split](http://railscasts.com/episodes/331-a-b-testing-with-split)
## Blogposts
* [Recipe: A/B testing with KISSMetrics and the split gem](https://robots.thoughtbot.com/post/9595887299/recipe-a-b-testing-with-kissmetrics-and-the-split-gem)
* [Rails A/B testing with Split on Heroku](http://blog.nathanhumbert.com/2012/02/rails-ab-testing-with-split-on-heroku.html)
## Backers
Support us with a monthly donation and help us continue our activities. [[Become a backer](https://opencollective.com/split#backer)]
<a href="https://opencollective.com/split/backer/0/website" target="_blank"><img src="https://opencollective.com/split/backer/0/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/1/website" target="_blank"><img src="https://opencollective.com/split/backer/1/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/2/website" target="_blank"><img src="https://opencollective.com/split/backer/2/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/3/website" target="_blank"><img src="https://opencollective.com/split/backer/3/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/4/website" target="_blank"><img src="https://opencollective.com/split/backer/4/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/5/website" target="_blank"><img src="https://opencollective.com/split/backer/5/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/6/website" target="_blank"><img src="https://opencollective.com/split/backer/6/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/7/website" target="_blank"><img src="https://opencollective.com/split/backer/7/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/8/website" target="_blank"><img src="https://opencollective.com/split/backer/8/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/9/website" target="_blank"><img src="https://opencollective.com/split/backer/9/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/10/website" target="_blank"><img src="https://opencollective.com/split/backer/10/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/11/website" target="_blank"><img src="https://opencollective.com/split/backer/11/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/12/website" target="_blank"><img src="https://opencollective.com/split/backer/12/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/13/website" target="_blank"><img src="https://opencollective.com/split/backer/13/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/14/website" target="_blank"><img src="https://opencollective.com/split/backer/14/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/15/website" target="_blank"><img src="https://opencollective.com/split/backer/15/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/16/website" target="_blank"><img src="https://opencollective.com/split/backer/16/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/17/website" target="_blank"><img src="https://opencollective.com/split/backer/17/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/18/website" target="_blank"><img src="https://opencollective.com/split/backer/18/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/19/website" target="_blank"><img src="https://opencollective.com/split/backer/19/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/20/website" target="_blank"><img src="https://opencollective.com/split/backer/20/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/21/website" target="_blank"><img src="https://opencollective.com/split/backer/21/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/22/website" target="_blank"><img src="https://opencollective.com/split/backer/22/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/23/website" target="_blank"><img src="https://opencollective.com/split/backer/23/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/24/website" target="_blank"><img src="https://opencollective.com/split/backer/24/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/25/website" target="_blank"><img src="https://opencollective.com/split/backer/25/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/26/website" target="_blank"><img src="https://opencollective.com/split/backer/26/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/27/website" target="_blank"><img src="https://opencollective.com/split/backer/27/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/28/website" target="_blank"><img src="https://opencollective.com/split/backer/28/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/29/website" target="_blank"><img src="https://opencollective.com/split/backer/29/avatar.svg"></a>
## Sponsors
Become a sponsor and get your logo on our README on Github with a link to your site. [[Become a sponsor](https://opencollective.com/split#sponsor)]
<a href="https://opencollective.com/split/sponsor/0/website" target="_blank"><img src="https://opencollective.com/split/sponsor/0/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/1/website" target="_blank"><img src="https://opencollective.com/split/sponsor/1/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/2/website" target="_blank"><img src="https://opencollective.com/split/sponsor/2/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/3/website" target="_blank"><img src="https://opencollective.com/split/sponsor/3/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/4/website" target="_blank"><img src="https://opencollective.com/split/sponsor/4/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/5/website" target="_blank"><img src="https://opencollective.com/split/sponsor/5/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/6/website" target="_blank"><img src="https://opencollective.com/split/sponsor/6/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/7/website" target="_blank"><img src="https://opencollective.com/split/sponsor/7/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/8/website" target="_blank"><img src="https://opencollective.com/split/sponsor/8/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/9/website" target="_blank"><img src="https://opencollective.com/split/sponsor/9/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/10/website" target="_blank"><img src="https://opencollective.com/split/sponsor/10/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/11/website" target="_blank"><img src="https://opencollective.com/split/sponsor/11/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/12/website" target="_blank"><img src="https://opencollective.com/split/sponsor/12/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/13/website" target="_blank"><img src="https://opencollective.com/split/sponsor/13/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/14/website" target="_blank"><img src="https://opencollective.com/split/sponsor/14/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/15/website" target="_blank"><img src="https://opencollective.com/split/sponsor/15/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/16/website" target="_blank"><img src="https://opencollective.com/split/sponsor/16/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/17/website" target="_blank"><img src="https://opencollective.com/split/sponsor/17/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/18/website" target="_blank"><img src="https://opencollective.com/split/sponsor/18/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/19/website" target="_blank"><img src="https://opencollective.com/split/sponsor/19/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/20/website" target="_blank"><img src="https://opencollective.com/split/sponsor/20/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/21/website" target="_blank"><img src="https://opencollective.com/split/sponsor/21/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/22/website" target="_blank"><img src="https://opencollective.com/split/sponsor/22/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/23/website" target="_blank"><img src="https://opencollective.com/split/sponsor/23/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/24/website" target="_blank"><img src="https://opencollective.com/split/sponsor/24/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/25/website" target="_blank"><img src="https://opencollective.com/split/sponsor/25/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/26/website" target="_blank"><img src="https://opencollective.com/split/sponsor/26/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/27/website" target="_blank"><img src="https://opencollective.com/split/sponsor/27/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/28/website" target="_blank"><img src="https://opencollective.com/split/sponsor/28/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/29/website" target="_blank"><img src="https://opencollective.com/split/sponsor/29/avatar.svg"></a>
## Contribute
Please do! Over 70 different people have contributed to the project, you can see them all here: https://github.com/splitrb/split/graphs/contributors.
### Development
The source code is hosted at [GitHub](https://github.com/splitrb/split).
Report issues and feature requests on [GitHub Issues](https://github.com/splitrb/split/issues).
You can find a discussion form on [Google Groups](https://groups.google.com/d/forum/split-ruby).
### Tests
Run the tests like this:
# Start a Redis server in another tab.
redis-server
bundle
rake spec
### A Note on Patches and Pull Requests
* Fork the project.
* Make your feature addition or bug fix.
* Add tests for it. This is important so I don't break it in a
future version unintentionally.
* Add documentation if necessary.
* Commit. Do not mess with the rakefile, version, or history.
(If you want to have your own version, that is fine. But bump the version in a commit by itself, which I can ignore when I pull.)
* Send a pull request. Bonus points for topic branches.
### Code of Conduct
Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
## Copyright
[MIT License](LICENSE) © 2019 [Andrew Nesbitt](https://github.com/andrew).
<MSG> update readme
<DFF> @@ -194,7 +194,7 @@ Split.configure do |config|
end
```
-By default, cookies will expire in 1 year. To change that, set the `persistence_cookie_length` in the configuration.
+By default, cookies will expire in 1 year. To change that, set the `persistence_cookie_length` in the configuration (unit of time in seconds).
```ruby
Split.configure do |config|
| 1 | update readme | 1 | .md | md | mit | splitrb/split |
10072383 | <NME> README.md
<BEF> # [Split](https://libraries.io/rubygems/split)
[](http://badge.fury.io/rb/split)
[](https://codeclimate.com/github/splitrb/split)
[](https://codeclimate.com/github/splitrb/split/coverage)
[](https://github.com/RichardLitt/standard-readme)
[](https://www.codetriage.com/splitrb/split)
> 📈 The Rack Based A/B testing framework https://libraries.io/rubygems/split
Split is a rack based A/B testing framework designed to work with Rails, Sinatra or any other rack based app.
Split is heavily inspired by the [Abingo](https://github.com/ryanb/abingo) and [Vanity](https://github.com/assaf/vanity) Rails A/B testing plugins and [Resque](https://github.com/resque/resque) in its use of Redis.
Split is designed to be hacker friendly, allowing for maximum customisation and extensibility.
## Install
### Requirements
Split v4.0+ is currently tested with Ruby >= 2.5 and Rails >= 5.2.
If your project requires compatibility with Ruby 2.4.x or older Rails versions. You can try v3.0 or v0.8.0(for Ruby 1.9.3)
Split uses Redis as a datastore.
Split only supports Redis 4.0 or greater.
If you're on OS X, Homebrew is the simplest way to install Redis:
```bash
brew install redis
redis-server /usr/local/etc/redis.conf
```
You now have a Redis daemon running on port `6379`.
### Setup
```bash
gem install split
```
#### Rails
Adding `gem 'split'` to your Gemfile will autoload it when rails starts up, as long as you've configured Redis it will 'just work'.
#### Sinatra
To configure Sinatra with Split you need to enable sessions and mix in the helper methods. Add the following lines at the top of your Sinatra app:
```ruby
require 'split'
class MySinatraApp < Sinatra::Base
enable :sessions
helpers Split::Helper
get '/' do
...
end
```
## Usage
To begin your A/B test use the `ab_test` method, naming your experiment with the first argument and then the different alternatives which you wish to test on as the other arguments.
`ab_test` returns one of the alternatives, if a user has already seen that test they will get the same alternative as before, which you can use to split your code on.
It can be used to render different templates, show different text or any other case based logic.
`ab_finished` is used to make a completion of an experiment, or conversion.
Example: View
```erb
<% ab_test(:login_button, "/images/button1.jpg", "/images/button2.jpg") do |button_file| %>
<%= image_tag(button_file, alt: "Login!") %>
<% end %>
```
Example: Controller
```ruby
def register_new_user
# See what level of free points maximizes users' decision to buy replacement points.
@starter_points = ab_test(:new_user_free_points, '100', '200', '300')
end
```
Example: Conversion tracking (in a controller!)
```ruby
def buy_new_points
# some business logic
ab_finished(:new_user_free_points)
end
```
Example: Conversion tracking (in a view)
```erb
Thanks for signing up, dude! <% ab_finished(:signup_page_redesign) %>
```
You can find more examples, tutorials and guides on the [wiki](https://github.com/splitrb/split/wiki).
## Statistical Validity
Split has two options for you to use to determine which alternative is the best.
The first option (default on the dashboard) uses a z test (n>30) for the difference between your control and alternative conversion rates to calculate statistical significance. This test will tell you whether an alternative is better or worse than your control, but it will not distinguish between which alternative is the best in an experiment with multiple alternatives. Split will only tell you if your experiment is 90%, 95%, or 99% significant, and this test only works if you have more than 30 participants and 5 conversions for each branch.
As per this [blog post](https://www.evanmiller.org/how-not-to-run-an-ab-test.html) on the pitfalls of A/B testing, it is highly recommended that you determine your requisite sample size for each branch before running the experiment. Otherwise, you'll have an increased rate of false positives (experiments which show a significant effect where really there is none).
[Here](https://www.evanmiller.org/ab-testing/sample-size.html) is a sample size calculator for your convenience.
The second option uses simulations from a beta distribution to determine the probability that the given alternative is the winner compared to all other alternatives. You can view these probabilities by clicking on the drop-down menu labeled "Confidence." This option should be used when the experiment has more than just 1 control and 1 alternative. It can also be used for a simple, 2-alternative A/B test.
Calculating the beta-distribution simulations for a large number of experiments can be slow, so the results are cached. You can specify how often they should be recalculated (the default is once per day).
```ruby
Split.configure do |config|
config.winning_alternative_recalculation_interval = 3600 # 1 hour
end
```
## Extras
### Weighted alternatives
Perhaps you only want to show an alternative to 10% of your visitors because it is very experimental or not yet fully load tested.
To do this you can pass a weight with each alternative in the following ways:
```ruby
ab_test(:homepage_design, {'Old' => 18}, {'New' => 2})
ab_test(:homepage_design, 'Old', {'New' => 1.0/9})
ab_test(:homepage_design, {'Old' => 9}, 'New')
```
This will only show the new alternative to visitors 1 in 10 times, the default weight for an alternative is 1.
### Overriding alternatives
For development and testing, you may wish to force your app to always return an alternative.
You can do this by passing it as a parameter in the url.
If you have an experiment called `button_color` with alternatives called `red` and `blue` used on your homepage, a url such as:
http://myawesomesite.com?ab_test[button_color]=red
will always have red buttons. This won't be stored in your session or count towards to results, unless you set the `store_override` configuration option.
In the event you want to disable all tests without having to know the individual experiment names, add a `SPLIT_DISABLE` query parameter.
http://myawesomesite.com?SPLIT_DISABLE=true
It is not required to send `SPLIT_DISABLE=false` to activate Split.
### Rspec Helper
To aid testing with RSpec, write `spec/support/split_helper.rb` and call `use_ab_test(alternatives_by_experiment)` in your specs as instructed below:
```ruby
# Create a file with these contents at 'spec/support/split_helper.rb'
# and ensure it is `require`d in your rails_helper.rb or spec_helper.rb
module SplitHelper
# Force a specific experiment alternative to always be returned:
# use_ab_test(signup_form: "single_page")
#
# Force alternatives for multiple experiments:
# use_ab_test(signup_form: "single_page", pricing: "show_enterprise_prices")
#
def use_ab_test(alternatives_by_experiment)
allow_any_instance_of(Split::Helper).to receive(:ab_test) do |_receiver, experiment, &block|
variant = alternatives_by_experiment.fetch(experiment) { |key| raise "Unknown experiment '#{key}'" }
block.call(variant) unless block.nil?
variant
end
end
end
# Make the `use_ab_test` method available to all specs:
RSpec.configure do |config|
config.include SplitHelper
end
```
end
```
By default, cookies will expire in 1 year. To change that, set the `persistence_cookie_length` in the configuration.
```ruby
Split.configure do |config|
```
### Starting experiments manually
By default new A/B tests will be active right after deployment. In case you would like to start new test a while after
the deploy, you can do it by setting the `start_manually` configuration option to `true`.
After choosing this option tests won't be started right after deploy, but after pressing the `Start` button in Split admin dashboard. If a test is deleted from the Split dashboard, then it can only be started after pressing the `Start` button whenever being re-initialized.
### Reset after completion
When a user completes a test their session is reset so that they may start the test again in the future.
To stop this behaviour you can pass the following option to the `ab_finished` method:
```ruby
ab_finished(:experiment_name, reset: false)
```
The user will then always see the alternative they started with.
Any old unfinished experiment key will be deleted from the user's data storage if the experiment had been removed or is over and a winner had been chosen. This allows a user to enroll into any new experiment in cases when the `allow_multiple_experiments` config option is set to `false`.
### Reset experiments manually
By default Split automatically resets the experiment whenever it detects the configuration for an experiment has changed (e.g. you call `ab_test` with different alternatives). You can prevent this by setting the option `reset_manually` to `true`.
You may want to do this when you want to change something, like the variants' names, the metadata about an experiment, etc. without resetting everything.
### Multiple experiments at once
By default Split will avoid users participating in multiple experiments at once. This means you are less likely to skew results by adding in more variation to your tests.
To stop this behaviour and allow users to participate in multiple experiments at once set the `allow_multiple_experiments` config option to true like so:
```ruby
Split.configure do |config|
config.allow_multiple_experiments = true
end
```
This will allow the user to participate in any number of experiments and belong to any alternative in each experiment. This has the possible downside of a variation in one experiment influencing the outcome of another.
To address this, setting the `allow_multiple_experiments` config option to 'control' like so:
```ruby
Split.configure do |config|
config.allow_multiple_experiments = 'control'
end
```
For this to work, each and every experiment you define must have an alternative named 'control'. This will allow the user to participate in multiple experiments as long as the user belongs to the alternative 'control' in each experiment. As soon as the user belongs to an alternative named something other than 'control' the user may not participate in any more experiments. Calling ab_test(<other experiments>) will always return the first alternative without adding the user to that experiment.
### Experiment Persistence
Split comes with three built-in persistence adapters for storing users and the alternatives they've been given for each experiment.
By default Split will store the tests for each user in the session.
You can optionally configure Split to use a cookie, Redis, or any custom adapter of your choosing.
#### Cookies
```ruby
Split.configure do |config|
config.persistence = :cookie
end
```
When using the cookie persistence, Split stores data into an anonymous tracking cookie named 'split', which expires in 1 year. To change that, set the `persistence_cookie_length` in the configuration (unit of time in seconds).
```ruby
Split.configure do |config|
config.persistence = :cookie
config.persistence_cookie_length = 2592000 # 30 days
end
```
The data stored consists of the experiment name and the variants the user is in. Example: { "experiment_name" => "variant_a" }
__Note:__ Using cookies depends on `ActionDispatch::Cookies` or any identical API
#### Redis
Using Redis will allow ab_users to persist across sessions or machines.
```ruby
Split.configure do |config|
config.persistence = Split::Persistence::RedisAdapter.with_config(lookup_by: -> (context) { context.current_user_id })
# Equivalent
# config.persistence = Split::Persistence::RedisAdapter.with_config(lookup_by: :current_user_id)
end
```
Options:
* `lookup_by`: method to invoke per request for uniquely identifying ab_users (mandatory configuration)
* `namespace`: separate namespace to store these persisted values (default "persistence")
* `expire_seconds`: sets TTL for user key. (if a user is in multiple experiments most recent update will reset TTL for all their assignments)
#### Dual Adapter
The Dual Adapter allows the use of different persistence adapters for logged-in and logged-out users. A common use case is to use Redis for logged-in users and Cookies for logged-out users.
```ruby
cookie_adapter = Split::Persistence::CookieAdapter
redis_adapter = Split::Persistence::RedisAdapter.with_config(
lookup_by: -> (context) { context.send(:current_user).try(:id) },
expire_seconds: 2592000)
Split.configure do |config|
config.persistence = Split::Persistence::DualAdapter.with_config(
logged_in: -> (context) { !context.send(:current_user).try(:id).nil? },
logged_in_adapter: redis_adapter,
logged_out_adapter: cookie_adapter)
config.persistence_cookie_length = 2592000 # 30 days
end
```
#### Custom Adapter
Your custom adapter needs to implement the same API as existing adapters.
See `Split::Persistence::CookieAdapter` or `Split::Persistence::SessionAdapter` for a starting point.
```ruby
Split.configure do |config|
config.persistence = YourCustomAdapterClass
end
```
### Trial Event Hooks
You can define methods that will be called at the same time as experiment
alternative participation and goal completion.
For example:
``` ruby
Split.configure do |config|
config.on_trial = :log_trial # run on every trial
config.on_trial_choose = :log_trial_choose # run on trials with new users only
config.on_trial_complete = :log_trial_complete
end
```
Set these attributes to a method name available in the same context as the
`ab_test` method. These methods should accept one argument, a `Trial` instance.
``` ruby
def log_trial(trial)
logger.info "experiment=%s alternative=%s user=%s" %
[ trial.experiment.name, trial.alternative, current_user.id ]
end
def log_trial_choose(trial)
logger.info "[new user] experiment=%s alternative=%s user=%s" %
[ trial.experiment.name, trial.alternative, current_user.id ]
end
def log_trial_complete(trial)
logger.info "experiment=%s alternative=%s user=%s complete=true" %
[ trial.experiment.name, trial.alternative, current_user.id ]
end
```
#### Views
If you are running `ab_test` from a view, you must define your event
hook callback as a
[helper_method](https://apidock.com/rails/AbstractController/Helpers/ClassMethods/helper_method)
in the controller:
``` ruby
helper_method :log_trial_choose
def log_trial_choose(trial)
logger.info "experiment=%s alternative=%s user=%s" %
[ trial.experiment.name, trial.alternative, current_user.id ]
end
```
### Experiment Hooks
You can assign a proc that will be called when an experiment is reset or deleted. You can use these hooks to call methods within your application to keep data related to experiments in sync with Split.
For example:
``` ruby
Split.configure do |config|
# after experiment reset or deleted
config.on_experiment_reset = -> (example) { # Do something on reset }
config.on_experiment_delete = -> (experiment) { # Do something else on delete }
# before experiment reset or deleted
config.on_before_experiment_reset = -> (example) { # Do something on reset }
config.on_before_experiment_delete = -> (experiment) { # Do something else on delete }
# after experiment winner had been set
config.on_experiment_winner_choose = -> (experiment) { # Do something on winner choose }
end
```
## Web Interface
Split comes with a Sinatra-based front end to get an overview of how your experiments are doing.
If you are running Rails 2: You can mount this inside your app using Rack::URLMap in your `config.ru`
```ruby
require 'split/dashboard'
run Rack::URLMap.new \
"/" => Your::App.new,
"/split" => Split::Dashboard.new
```
However, if you are using Rails 3 or higher: You can mount this inside your app routes by first adding this to the Gemfile:
```ruby
gem 'split', require: 'split/dashboard'
```
Then adding this to config/routes.rb
```ruby
mount Split::Dashboard, at: 'split'
```
You may want to password protect that page, you can do so with `Rack::Auth::Basic` (in your split initializer file)
```ruby
# Rails apps or apps that already depend on activesupport
Split::Dashboard.use Rack::Auth::Basic do |username, password|
# Protect against timing attacks:
# - Use & (do not use &&) so that it doesn't short circuit.
# - Use digests to stop length information leaking
ActiveSupport::SecurityUtils.secure_compare(::Digest::SHA256.hexdigest(username), ::Digest::SHA256.hexdigest(ENV["SPLIT_USERNAME"])) &
ActiveSupport::SecurityUtils.secure_compare(::Digest::SHA256.hexdigest(password), ::Digest::SHA256.hexdigest(ENV["SPLIT_PASSWORD"]))
end
# Apps without activesupport
Split::Dashboard.use Rack::Auth::Basic do |username, password|
# Protect against timing attacks:
# - Use & (do not use &&) so that it doesn't short circuit.
# - Use digests to stop length information leaking
Rack::Utils.secure_compare(::Digest::SHA256.hexdigest(username), ::Digest::SHA256.hexdigest(ENV["SPLIT_USERNAME"])) &
Rack::Utils.secure_compare(::Digest::SHA256.hexdigest(password), ::Digest::SHA256.hexdigest(ENV["SPLIT_PASSWORD"]))
end
```
You can even use Devise or any other Warden-based authentication method to authorize users. Just replace `mount Split::Dashboard, :at => 'split'` in `config/routes.rb` with the following:
```ruby
match "/split" => Split::Dashboard, anchor: false, via: [:get, :post, :delete], constraints: -> (request) do
request.env['warden'].authenticated? # are we authenticated?
request.env['warden'].authenticate! # authenticate if not already
# or even check any other condition such as request.env['warden'].user.is_admin?
end
```
More information on this [here](https://steve.dynedge.co.uk/2011/12/09/controlling-access-to-routes-and-rack-apps-in-rails-3-with-devise-and-warden/)
### Screenshot
## Configuration
You can override the default configuration options of Split like so:
```ruby
Split.configure do |config|
config.db_failover = true # handle Redis errors gracefully
config.db_failover_on_db_error = -> (error) { Rails.logger.error(error.message) }
config.allow_multiple_experiments = true
config.enabled = true
config.persistence = Split::Persistence::SessionAdapter
#config.start_manually = false ## new test will have to be started manually from the admin panel. default false
#config.reset_manually = false ## if true, it never resets the experiment data, even if the configuration changes
config.include_rails_helper = true
config.redis = "redis://custom.redis.url:6380"
end
```
Split looks for the Redis host in the environment variable `REDIS_URL` then
defaults to `redis://localhost:6379` if not specified by configure block.
On platforms like Heroku, Split will use the value of `REDIS_PROVIDER` to
determine which env variable key to use when retrieving the host config. This
defaults to `REDIS_URL`.
### Filtering
In most scenarios you don't want to have AB-Testing enabled for web spiders, robots or special groups of users.
Split provides functionality to filter this based on a predefined, extensible list of bots, IP-lists or custom exclude logic.
```ruby
Split.configure do |config|
# bot config
config.robot_regex = /my_custom_robot_regex/ # or
config.bots['newbot'] = "Description for bot with 'newbot' user agent, which will be added to config.robot_regex for exclusion"
# IP config
config.ignore_ip_addresses << '81.19.48.130' # or regex: /81\.19\.48\.[0-9]+/
# or provide your own filter functionality, the default is proc{ |request| is_robot? || is_ignored_ip_address? || is_preview? }
config.ignore_filter = -> (request) { CustomExcludeLogic.excludes?(request) }
end
```
### Experiment configuration
Instead of providing the experiment options inline, you can store them
in a hash. This hash can control your experiment's alternatives, weights,
algorithm and if the experiment resets once finished:
```ruby
Split.configure do |config|
config.experiments = {
my_first_experiment: {
alternatives: ["a", "b"],
resettable: false
},
:my_second_experiment => {
algorithm: 'Split::Algorithms::Whiplash',
alternatives: [
{ name: "a", percent: 67 },
{ name: "b", percent: 33 }
]
}
}
end
```
You can also store your experiments in a YAML file:
```ruby
Split.configure do |config|
config.experiments = YAML.load_file "config/experiments.yml"
end
```
You can then define the YAML file like:
```yaml
my_first_experiment:
alternatives:
- a
- b
my_second_experiment:
alternatives:
- name: a
percent: 67
- name: b
percent: 33
resettable: false
```
This simplifies the calls from your code:
```ruby
ab_test(:my_first_experiment)
```
and:
```ruby
ab_finished(:my_first_experiment)
```
You can also add meta data for each experiment, which is very useful when you need more than an alternative name to change behaviour:
```ruby
Split.configure do |config|
config.experiments = {
my_first_experiment: {
alternatives: ["a", "b"],
metadata: {
"a" => {"text" => "Have a fantastic day"},
"b" => {"text" => "Don't get hit by a bus"}
}
}
}
end
```
```yaml
my_first_experiment:
alternatives:
- a
- b
metadata:
a:
text: "Have a fantastic day"
b:
text: "Don't get hit by a bus"
```
This allows for some advanced experiment configuration using methods like:
```ruby
trial.alternative.name # => "a"
trial.metadata['text'] # => "Have a fantastic day"
```
or in views:
```erb
<% ab_test("my_first_experiment") do |alternative, meta| %>
<%= alternative %>
<small><%= meta['text'] %></small>
<% end %>
```
The keys used in meta data should be Strings
#### Metrics
You might wish to track generic metrics, such as conversions, and use
those to complete multiple different experiments without adding more to
your code. You can use the configuration hash to do this, thanks to
the `:metric` option.
```ruby
Split.configure do |config|
config.experiments = {
my_first_experiment: {
alternatives: ["a", "b"],
metric: :my_metric
}
}
end
```
Your code may then track a completion using the metric instead of
the experiment name:
```ruby
ab_finished(:my_metric)
```
You can also create a new metric by instantiating and saving a new Metric object.
```ruby
Split::Metric.new(:my_metric)
Split::Metric.save
```
#### Goals
You might wish to allow an experiment to have multiple, distinguishable goals.
The API to define goals for an experiment is this:
```ruby
ab_test({link_color: ["purchase", "refund"]}, "red", "blue")
```
or you can define them in a configuration file:
```ruby
Split.configure do |config|
config.experiments = {
link_color: {
alternatives: ["red", "blue"],
goals: ["purchase", "refund"]
}
}
end
```
To complete a goal conversion, you do it like:
```ruby
ab_finished(link_color: "purchase")
```
Note that if you pass additional options, that should be a separate hash:
```ruby
ab_finished({ link_color: "purchase" }, reset: false)
```
**NOTE:** This does not mean that a single experiment can complete more than one goal.
Once you finish one of the goals, the test is considered to be completed, and finishing the other goal will no longer register. (Assuming the test runs with `reset: false`.)
**Good Example**: Test if listing Plan A first result in more conversions to Plan A (goal: "plana_conversion") or Plan B (goal: "planb_conversion").
**Bad Example**: Test if button color increases conversion rate through multiple steps of a funnel. THIS WILL NOT WORK.
**Bad Example**: Test both how button color affects signup *and* how it affects login, at the same time. THIS WILL NOT WORK.
#### Combined Experiments
If you want to test how button color affects signup *and* how it affects login at the same time, use combined experiments.
Configure like so:
```ruby
Split.configuration.experiments = {
:button_color_experiment => {
:alternatives => ["blue", "green"],
:combined_experiments => ["button_color_on_signup", "button_color_on_login"]
}
}
```
Starting the combined test starts all combined experiments
```ruby
ab_combined_test(:button_color_experiment)
```
Finish each combined test as normal
```ruby
ab_finished(:button_color_on_login)
ab_finished(:button_color_on_signup)
```
**Additional Configuration**:
* Be sure to enable `allow_multiple_experiments`
* In Sinatra include the CombinedExperimentsHelper
```
helpers Split::CombinedExperimentsHelper
```
### DB failover solution
Due to the fact that Redis has no automatic failover mechanism, it's
possible to switch on the `db_failover` config option, so that `ab_test`
and `ab_finished` will not crash in case of a db failure. `ab_test` always
delivers alternative A (the first one) in that case.
It's also possible to set a `db_failover_on_db_error` callback (proc)
for example to log these errors via Rails.logger.
### Redis
You may want to change the Redis host and port Split connects to, or
set various other options at startup.
Split has a `redis` setter which can be given a string or a Redis
object. This means if you're already using Redis in your app, Split
can re-use the existing connection.
String: `Split.redis = 'redis://localhost:6379'`
Redis: `Split.redis = $redis`
For our rails app we have a `config/initializers/split.rb` file where
we load `config/split.yml` by hand and set the Redis information
appropriately.
Here's our `config/split.yml`:
```yml
development: redis://localhost:6379
test: redis://localhost:6379
staging: redis://redis1.example.com:6379
fi: redis://localhost:6379
production: redis://redis1.example.com:6379
```
And our initializer:
```ruby
split_config = YAML.load_file(Rails.root.join('config', 'split.yml'))
Split.redis = split_config[Rails.env]
```
### Redis Caching (v4.0+)
In some high-volume usage scenarios, Redis load can be incurred by repeated
fetches for fairly static data. Enabling caching will reduce this load.
```ruby
Split.configuration.cache = true
````
This currently caches:
- `Split::ExperimentCatalog.find`
- `Split::Experiment.start_time`
- `Split::Experiment.winner`
## Namespaces
If you're running multiple, separate instances of Split you may want
to namespace the keyspaces so they do not overlap. This is not unlike
the approach taken by many memcached clients.
This feature can be provided by the [redis-namespace](https://github.com/defunkt/redis-namespace)
library. To configure Split to use `Redis::Namespace`, do the following:
1. Add `redis-namespace` to your Gemfile:
```ruby
gem 'redis-namespace'
```
2. Configure `Split.redis` to use a `Redis::Namespace` instance (possible in an
initializer):
```ruby
redis = Redis.new(url: ENV['REDIS_URL']) # or whatever config you want
Split.redis = Redis::Namespace.new(:your_namespace, redis: redis)
```
## Outside of a Web Session
Split provides the Helper module to facilitate running experiments inside web sessions.
Alternatively, you can access the underlying Metric, Trial, Experiment and Alternative objects to
conduct experiments that are not tied to a web session.
```ruby
# create a new experiment
experiment = Split::ExperimentCatalog.find_or_create('color', 'red', 'blue')
# create a new trial
trial = Split::Trial.new(:experiment => experiment)
# run trial
trial.choose!
# get the result, returns either red or blue
trial.alternative.name
# if the goal has been achieved, increment the successful completions for this alternative.
if goal_achieved?
trial.complete!
end
```
## Algorithms
By default, Split ships with `Split::Algorithms::WeightedSample` that randomly selects from possible alternatives for a traditional a/b test.
It is possible to specify static weights to favor certain alternatives.
`Split::Algorithms::Whiplash` is an implementation of a [multi-armed bandit algorithm](http://stevehanov.ca/blog/index.php?id=132).
This algorithm will automatically weight the alternatives based on their relative performance,
choosing the better-performing ones more often as trials are completed.
`Split::Algorithms::BlockRandomization` is an algorithm that ensures equal
participation across all alternatives. This algorithm will choose the alternative
with the fewest participants. In the event of multiple minimum participant alternatives
(i.e. starting a new "Block") the algorithm will choose a random alternative from
those minimum participant alternatives.
Users may also write their own algorithms. The default algorithm may be specified globally in the configuration file, or on a per experiment basis using the experiments hash of the configuration file.
To change the algorithm globally for all experiments, use the following in your initializer:
```ruby
Split.configure do |config|
config.algorithm = Split::Algorithms::Whiplash
end
```
## Extensions
- [Split::Export](https://github.com/splitrb/split-export) - Easily export A/B test data out of Split.
- [Split::Analytics](https://github.com/splitrb/split-analytics) - Push test data to Google Analytics.
- [Split::Mongoid](https://github.com/MongoHQ/split-mongoid) - Store experiment data in mongoid (still uses redis).
- [Split::Cacheable](https://github.com/harrystech/split_cacheable) - Automatically create cache buckets per test.
- [Split::Counters](https://github.com/bernardkroes/split-counters) - Add counters per experiment and alternative.
- [Split::Cli](https://github.com/craigmcnamara/split-cli) - A CLI to trigger Split A/B tests.
## Screencast
Ryan bates has produced an excellent 10 minute screencast about split on the Railscasts site: [A/B Testing with Split](http://railscasts.com/episodes/331-a-b-testing-with-split)
## Blogposts
* [Recipe: A/B testing with KISSMetrics and the split gem](https://robots.thoughtbot.com/post/9595887299/recipe-a-b-testing-with-kissmetrics-and-the-split-gem)
* [Rails A/B testing with Split on Heroku](http://blog.nathanhumbert.com/2012/02/rails-ab-testing-with-split-on-heroku.html)
## Backers
Support us with a monthly donation and help us continue our activities. [[Become a backer](https://opencollective.com/split#backer)]
<a href="https://opencollective.com/split/backer/0/website" target="_blank"><img src="https://opencollective.com/split/backer/0/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/1/website" target="_blank"><img src="https://opencollective.com/split/backer/1/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/2/website" target="_blank"><img src="https://opencollective.com/split/backer/2/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/3/website" target="_blank"><img src="https://opencollective.com/split/backer/3/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/4/website" target="_blank"><img src="https://opencollective.com/split/backer/4/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/5/website" target="_blank"><img src="https://opencollective.com/split/backer/5/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/6/website" target="_blank"><img src="https://opencollective.com/split/backer/6/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/7/website" target="_blank"><img src="https://opencollective.com/split/backer/7/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/8/website" target="_blank"><img src="https://opencollective.com/split/backer/8/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/9/website" target="_blank"><img src="https://opencollective.com/split/backer/9/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/10/website" target="_blank"><img src="https://opencollective.com/split/backer/10/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/11/website" target="_blank"><img src="https://opencollective.com/split/backer/11/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/12/website" target="_blank"><img src="https://opencollective.com/split/backer/12/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/13/website" target="_blank"><img src="https://opencollective.com/split/backer/13/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/14/website" target="_blank"><img src="https://opencollective.com/split/backer/14/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/15/website" target="_blank"><img src="https://opencollective.com/split/backer/15/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/16/website" target="_blank"><img src="https://opencollective.com/split/backer/16/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/17/website" target="_blank"><img src="https://opencollective.com/split/backer/17/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/18/website" target="_blank"><img src="https://opencollective.com/split/backer/18/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/19/website" target="_blank"><img src="https://opencollective.com/split/backer/19/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/20/website" target="_blank"><img src="https://opencollective.com/split/backer/20/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/21/website" target="_blank"><img src="https://opencollective.com/split/backer/21/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/22/website" target="_blank"><img src="https://opencollective.com/split/backer/22/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/23/website" target="_blank"><img src="https://opencollective.com/split/backer/23/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/24/website" target="_blank"><img src="https://opencollective.com/split/backer/24/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/25/website" target="_blank"><img src="https://opencollective.com/split/backer/25/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/26/website" target="_blank"><img src="https://opencollective.com/split/backer/26/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/27/website" target="_blank"><img src="https://opencollective.com/split/backer/27/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/28/website" target="_blank"><img src="https://opencollective.com/split/backer/28/avatar.svg"></a>
<a href="https://opencollective.com/split/backer/29/website" target="_blank"><img src="https://opencollective.com/split/backer/29/avatar.svg"></a>
## Sponsors
Become a sponsor and get your logo on our README on Github with a link to your site. [[Become a sponsor](https://opencollective.com/split#sponsor)]
<a href="https://opencollective.com/split/sponsor/0/website" target="_blank"><img src="https://opencollective.com/split/sponsor/0/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/1/website" target="_blank"><img src="https://opencollective.com/split/sponsor/1/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/2/website" target="_blank"><img src="https://opencollective.com/split/sponsor/2/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/3/website" target="_blank"><img src="https://opencollective.com/split/sponsor/3/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/4/website" target="_blank"><img src="https://opencollective.com/split/sponsor/4/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/5/website" target="_blank"><img src="https://opencollective.com/split/sponsor/5/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/6/website" target="_blank"><img src="https://opencollective.com/split/sponsor/6/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/7/website" target="_blank"><img src="https://opencollective.com/split/sponsor/7/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/8/website" target="_blank"><img src="https://opencollective.com/split/sponsor/8/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/9/website" target="_blank"><img src="https://opencollective.com/split/sponsor/9/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/10/website" target="_blank"><img src="https://opencollective.com/split/sponsor/10/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/11/website" target="_blank"><img src="https://opencollective.com/split/sponsor/11/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/12/website" target="_blank"><img src="https://opencollective.com/split/sponsor/12/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/13/website" target="_blank"><img src="https://opencollective.com/split/sponsor/13/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/14/website" target="_blank"><img src="https://opencollective.com/split/sponsor/14/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/15/website" target="_blank"><img src="https://opencollective.com/split/sponsor/15/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/16/website" target="_blank"><img src="https://opencollective.com/split/sponsor/16/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/17/website" target="_blank"><img src="https://opencollective.com/split/sponsor/17/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/18/website" target="_blank"><img src="https://opencollective.com/split/sponsor/18/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/19/website" target="_blank"><img src="https://opencollective.com/split/sponsor/19/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/20/website" target="_blank"><img src="https://opencollective.com/split/sponsor/20/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/21/website" target="_blank"><img src="https://opencollective.com/split/sponsor/21/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/22/website" target="_blank"><img src="https://opencollective.com/split/sponsor/22/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/23/website" target="_blank"><img src="https://opencollective.com/split/sponsor/23/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/24/website" target="_blank"><img src="https://opencollective.com/split/sponsor/24/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/25/website" target="_blank"><img src="https://opencollective.com/split/sponsor/25/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/26/website" target="_blank"><img src="https://opencollective.com/split/sponsor/26/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/27/website" target="_blank"><img src="https://opencollective.com/split/sponsor/27/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/28/website" target="_blank"><img src="https://opencollective.com/split/sponsor/28/avatar.svg"></a>
<a href="https://opencollective.com/split/sponsor/29/website" target="_blank"><img src="https://opencollective.com/split/sponsor/29/avatar.svg"></a>
## Contribute
Please do! Over 70 different people have contributed to the project, you can see them all here: https://github.com/splitrb/split/graphs/contributors.
### Development
The source code is hosted at [GitHub](https://github.com/splitrb/split).
Report issues and feature requests on [GitHub Issues](https://github.com/splitrb/split/issues).
You can find a discussion form on [Google Groups](https://groups.google.com/d/forum/split-ruby).
### Tests
Run the tests like this:
# Start a Redis server in another tab.
redis-server
bundle
rake spec
### A Note on Patches and Pull Requests
* Fork the project.
* Make your feature addition or bug fix.
* Add tests for it. This is important so I don't break it in a
future version unintentionally.
* Add documentation if necessary.
* Commit. Do not mess with the rakefile, version, or history.
(If you want to have your own version, that is fine. But bump the version in a commit by itself, which I can ignore when I pull.)
* Send a pull request. Bonus points for topic branches.
### Code of Conduct
Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
## Copyright
[MIT License](LICENSE) © 2019 [Andrew Nesbitt](https://github.com/andrew).
<MSG> update readme
<DFF> @@ -194,7 +194,7 @@ Split.configure do |config|
end
```
-By default, cookies will expire in 1 year. To change that, set the `persistence_cookie_length` in the configuration.
+By default, cookies will expire in 1 year. To change that, set the `persistence_cookie_length` in the configuration (unit of time in seconds).
```ruby
Split.configure do |config|
| 1 | update readme | 1 | .md | md | mit | splitrb/split |
10072384 | <NME> split.gemspec
<BEF> # -*- encoding: utf-8 -*-
# frozen_string_literal: true
$:.push File.expand_path("../lib", __FILE__)
require "split/version"
Gem::Specification.new do |s|
s.name = "split"
s.version = Split::VERSION
s.platform = Gem::Platform::RUBY
s.authors = ["Andrew Nesbitt"]
s.licenses = ["MIT"]
s.email = ["[email protected]"]
s.homepage = "https://github.com/splitrb/split"
s.summary = "Rack based split testing framework"
s.metadata = {
"homepage_uri" => "https://github.com/splitrb/split",
"changelog_uri" => "https://github.com/splitrb/split/blob/main/CHANGELOG.md",
s.add_dependency 'redis', '~> 2.1'
s.add_dependency 'redis-namespace', '~> 1.0.3'
s.add_dependency 'sinatra', '~> 1.2.6'
s.add_development_dependency 'bundler', '~> 1.0'
s.add_development_dependency 'rspec', '~> 2.6'
s.required_rubygems_version = ">= 2.0.0"
s.files = `git ls-files`.split("\n")
s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
s.require_paths = ["lib"]
s.add_dependency "redis", ">= 4.2"
s.add_dependency "sinatra", ">= 1.2.6"
s.add_dependency "rubystats", ">= 0.3.0"
s.add_development_dependency "bundler", ">= 1.17"
s.add_development_dependency "simplecov", "~> 0.15"
s.add_development_dependency "rack-test", "~> 2.0"
s.add_development_dependency "rake", "~> 13"
s.add_development_dependency "rspec", "~> 3.7"
s.add_development_dependency "pry", "~> 0.10"
s.add_development_dependency "rails", ">= 5.0"
end
<MSG> Merge pull request #24 from martinciu/master
Sinatra version update
<DFF> @@ -20,7 +20,7 @@ Gem::Specification.new do |s|
s.add_dependency 'redis', '~> 2.1'
s.add_dependency 'redis-namespace', '~> 1.0.3'
- s.add_dependency 'sinatra', '~> 1.2.6'
+ s.add_dependency 'sinatra', '>= 1.2.6'
s.add_development_dependency 'bundler', '~> 1.0'
s.add_development_dependency 'rspec', '~> 2.6'
| 1 | Merge pull request #24 from martinciu/master | 1 | .gemspec | gemspec | mit | splitrb/split |
10072385 | <NME> split.gemspec
<BEF> # -*- encoding: utf-8 -*-
# frozen_string_literal: true
$:.push File.expand_path("../lib", __FILE__)
require "split/version"
Gem::Specification.new do |s|
s.name = "split"
s.version = Split::VERSION
s.platform = Gem::Platform::RUBY
s.authors = ["Andrew Nesbitt"]
s.licenses = ["MIT"]
s.email = ["[email protected]"]
s.homepage = "https://github.com/splitrb/split"
s.summary = "Rack based split testing framework"
s.metadata = {
"homepage_uri" => "https://github.com/splitrb/split",
"changelog_uri" => "https://github.com/splitrb/split/blob/main/CHANGELOG.md",
s.add_dependency 'redis', '~> 2.1'
s.add_dependency 'redis-namespace', '~> 1.0.3'
s.add_dependency 'sinatra', '~> 1.2.6'
s.add_development_dependency 'bundler', '~> 1.0'
s.add_development_dependency 'rspec', '~> 2.6'
s.required_rubygems_version = ">= 2.0.0"
s.files = `git ls-files`.split("\n")
s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
s.require_paths = ["lib"]
s.add_dependency "redis", ">= 4.2"
s.add_dependency "sinatra", ">= 1.2.6"
s.add_dependency "rubystats", ">= 0.3.0"
s.add_development_dependency "bundler", ">= 1.17"
s.add_development_dependency "simplecov", "~> 0.15"
s.add_development_dependency "rack-test", "~> 2.0"
s.add_development_dependency "rake", "~> 13"
s.add_development_dependency "rspec", "~> 3.7"
s.add_development_dependency "pry", "~> 0.10"
s.add_development_dependency "rails", ">= 5.0"
end
<MSG> Merge pull request #24 from martinciu/master
Sinatra version update
<DFF> @@ -20,7 +20,7 @@ Gem::Specification.new do |s|
s.add_dependency 'redis', '~> 2.1'
s.add_dependency 'redis-namespace', '~> 1.0.3'
- s.add_dependency 'sinatra', '~> 1.2.6'
+ s.add_dependency 'sinatra', '>= 1.2.6'
s.add_development_dependency 'bundler', '~> 1.0'
s.add_development_dependency 'rspec', '~> 2.6'
| 1 | Merge pull request #24 from martinciu/master | 1 | .gemspec | gemspec | mit | splitrb/split |
10072386 | <NME> split.gemspec
<BEF> # -*- encoding: utf-8 -*-
# frozen_string_literal: true
$:.push File.expand_path("../lib", __FILE__)
require "split/version"
Gem::Specification.new do |s|
s.name = "split"
s.version = Split::VERSION
s.platform = Gem::Platform::RUBY
s.authors = ["Andrew Nesbitt"]
s.licenses = ["MIT"]
s.email = ["[email protected]"]
s.homepage = "https://github.com/splitrb/split"
s.summary = "Rack based split testing framework"
s.metadata = {
"homepage_uri" => "https://github.com/splitrb/split",
"changelog_uri" => "https://github.com/splitrb/split/blob/main/CHANGELOG.md",
s.add_dependency 'redis', '~> 2.1'
s.add_dependency 'redis-namespace', '~> 1.0.3'
s.add_dependency 'sinatra', '~> 1.2.6'
s.add_development_dependency 'bundler', '~> 1.0'
s.add_development_dependency 'rspec', '~> 2.6'
s.required_rubygems_version = ">= 2.0.0"
s.files = `git ls-files`.split("\n")
s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
s.require_paths = ["lib"]
s.add_dependency "redis", ">= 4.2"
s.add_dependency "sinatra", ">= 1.2.6"
s.add_dependency "rubystats", ">= 0.3.0"
s.add_development_dependency "bundler", ">= 1.17"
s.add_development_dependency "simplecov", "~> 0.15"
s.add_development_dependency "rack-test", "~> 2.0"
s.add_development_dependency "rake", "~> 13"
s.add_development_dependency "rspec", "~> 3.7"
s.add_development_dependency "pry", "~> 0.10"
s.add_development_dependency "rails", ">= 5.0"
end
<MSG> Merge pull request #24 from martinciu/master
Sinatra version update
<DFF> @@ -20,7 +20,7 @@ Gem::Specification.new do |s|
s.add_dependency 'redis', '~> 2.1'
s.add_dependency 'redis-namespace', '~> 1.0.3'
- s.add_dependency 'sinatra', '~> 1.2.6'
+ s.add_dependency 'sinatra', '>= 1.2.6'
s.add_development_dependency 'bundler', '~> 1.0'
s.add_development_dependency 'rspec', '~> 2.6'
| 1 | Merge pull request #24 from martinciu/master | 1 | .gemspec | gemspec | mit | splitrb/split |
10072387 | <NME> snippets.ts
<BEF> // import { fail } from 'assert';
import parseMarkup from '@emmetio/abbreviation';
// import parseStylesheet from '@emmetio/css-abbreviation';
import SnippetsRegistry from '../src/SnippetsRegistry';
import html from '../snippets/html.json';
// import css from '../snippets/css.json';
import xsl from '../snippets/xsl.json';
function markup(abbr: string) {
parseMarkup(abbr);
// try {
// } catch (err) {
// fail(`Unable to parse markup abbreviation "${abbr}": ${err.message}`);
// }
}
// function stylesheet(abbr: string) {
// try {
// parseStylesheet(abbr);
// } catch (err) {
// fail(`Unable to parse stylesheet abbreviation "${abbr}": ${err.message}`);
// }
// }
describe('Snippets', () => {
it('HTML', () => {
const snippets = new SnippetsRegistry(html);
snippets.values().forEach(s => markup(s.value as string));
});
it('XSL', () => {
const snippets = new SnippetsRegistry(xsl);
snippets.values().forEach(s => markup(s.value as string));
});
// it('CSS', () => {
// const snippets = new SnippetsRegistry(css);
// snippets.values().forEach(s => stylesheet(s.key as string));
// });
});
});
});
<MSG> Simplified & refactored abbreviation config
<DFF> @@ -1,40 +1,14 @@
-// import { fail } from 'assert';
-import parseMarkup from '@emmetio/abbreviation';
-// import parseStylesheet from '@emmetio/css-abbreviation';
-import SnippetsRegistry from '../src/SnippetsRegistry';
+import { ok } from 'assert';
+import markup from '@emmetio/abbreviation';
import html from '../snippets/html.json';
-// import css from '../snippets/css.json';
import xsl from '../snippets/xsl.json';
-function markup(abbr: string) {
- parseMarkup(abbr);
- // try {
- // } catch (err) {
- // fail(`Unable to parse markup abbreviation "${abbr}": ${err.message}`);
- // }
-}
-
-// function stylesheet(abbr: string) {
-// try {
-// parseStylesheet(abbr);
-// } catch (err) {
-// fail(`Unable to parse stylesheet abbreviation "${abbr}": ${err.message}`);
-// }
-// }
-
describe('Snippets', () => {
it('HTML', () => {
- const snippets = new SnippetsRegistry(html);
- snippets.values().forEach(s => markup(s.value as string));
+ Object.keys(html).forEach(k => ok(markup(html[k]), k));
});
it('XSL', () => {
- const snippets = new SnippetsRegistry(xsl);
- snippets.values().forEach(s => markup(s.value as string));
+ Object.keys(xsl).forEach(k => ok(markup(xsl[k]), k));
});
-
- // it('CSS', () => {
- // const snippets = new SnippetsRegistry(css);
- // snippets.values().forEach(s => stylesheet(s.key as string));
- // });
});
| 4 | Simplified & refactored abbreviation config | 30 | .ts | ts | mit | emmetio/emmet |
10072388 | <NME> snippets.ts
<BEF> // import { fail } from 'assert';
import parseMarkup from '@emmetio/abbreviation';
// import parseStylesheet from '@emmetio/css-abbreviation';
import SnippetsRegistry from '../src/SnippetsRegistry';
import html from '../snippets/html.json';
// import css from '../snippets/css.json';
import xsl from '../snippets/xsl.json';
function markup(abbr: string) {
parseMarkup(abbr);
// try {
// } catch (err) {
// fail(`Unable to parse markup abbreviation "${abbr}": ${err.message}`);
// }
}
// function stylesheet(abbr: string) {
// try {
// parseStylesheet(abbr);
// } catch (err) {
// fail(`Unable to parse stylesheet abbreviation "${abbr}": ${err.message}`);
// }
// }
describe('Snippets', () => {
it('HTML', () => {
const snippets = new SnippetsRegistry(html);
snippets.values().forEach(s => markup(s.value as string));
});
it('XSL', () => {
const snippets = new SnippetsRegistry(xsl);
snippets.values().forEach(s => markup(s.value as string));
});
// it('CSS', () => {
// const snippets = new SnippetsRegistry(css);
// snippets.values().forEach(s => stylesheet(s.key as string));
// });
});
});
});
<MSG> Simplified & refactored abbreviation config
<DFF> @@ -1,40 +1,14 @@
-// import { fail } from 'assert';
-import parseMarkup from '@emmetio/abbreviation';
-// import parseStylesheet from '@emmetio/css-abbreviation';
-import SnippetsRegistry from '../src/SnippetsRegistry';
+import { ok } from 'assert';
+import markup from '@emmetio/abbreviation';
import html from '../snippets/html.json';
-// import css from '../snippets/css.json';
import xsl from '../snippets/xsl.json';
-function markup(abbr: string) {
- parseMarkup(abbr);
- // try {
- // } catch (err) {
- // fail(`Unable to parse markup abbreviation "${abbr}": ${err.message}`);
- // }
-}
-
-// function stylesheet(abbr: string) {
-// try {
-// parseStylesheet(abbr);
-// } catch (err) {
-// fail(`Unable to parse stylesheet abbreviation "${abbr}": ${err.message}`);
-// }
-// }
-
describe('Snippets', () => {
it('HTML', () => {
- const snippets = new SnippetsRegistry(html);
- snippets.values().forEach(s => markup(s.value as string));
+ Object.keys(html).forEach(k => ok(markup(html[k]), k));
});
it('XSL', () => {
- const snippets = new SnippetsRegistry(xsl);
- snippets.values().forEach(s => markup(s.value as string));
+ Object.keys(xsl).forEach(k => ok(markup(xsl[k]), k));
});
-
- // it('CSS', () => {
- // const snippets = new SnippetsRegistry(css);
- // snippets.values().forEach(s => stylesheet(s.key as string));
- // });
});
| 4 | Simplified & refactored abbreviation config | 30 | .ts | ts | mit | emmetio/emmet |
10072389 | <NME> experiment_spec.rb
<BEF> # frozen_string_literal: true
require "spec_helper"
require "time"
describe Split::Experiment do
def new_experiment(goals = [])
Split::Experiment.new("link_color", alternatives: ["blue", "red", "green"], goals: goals)
end
def alternative(color)
Split::Alternative.new(color, "link_color")
end
let(:experiment) { new_experiment }
let(:blue) { alternative("blue") }
let(:green) { alternative("green") }
context "with an experiment" do
let(:experiment) { Split::Experiment.new("basket_text", alternatives: ["Basket", "Cart"]) }
it "should have a name" do
expect(experiment.name).to eq("basket_text")
end
it "should have alternatives" do
expect(experiment.alternatives.length).to be 2
end
it "should have alternatives with correct names" do
expect(experiment.alternatives.collect { |a| a.name }).to eq(["Basket", "Cart"])
end
it "should be resettable by default" do
expect(experiment.resettable).to be_truthy
end
it "should save to redis" do
experiment.save
expect(Split.redis.exists?("basket_text")).to be true
end
it "should save the start time to redis" do
experiment_start_time = Time.at(1372167761)
expect(Time).to receive(:now).and_return(experiment_start_time)
experiment.save
expect(Split::ExperimentCatalog.find("basket_text").start_time).to eq(experiment_start_time)
end
it "should not save the start time to redis when start_manually is enabled" do
expect(Split.configuration).to receive(:start_manually).and_return(true)
experiment.save
expect(Split::ExperimentCatalog.find("basket_text").start_time).to be_nil
end
it "should save the selected algorithm to redis" do
experiment_algorithm = Split::Algorithms::Whiplash
experiment.algorithm = experiment_algorithm
experiment.save
expect(Split::ExperimentCatalog.find("basket_text").algorithm).to eq(experiment_algorithm)
end
it "should handle having a start time stored as a string" do
experiment_start_time = Time.parse("Sat Mar 03 14:01:03")
expect(Time).to receive(:now).twice.and_return(experiment_start_time)
experiment.save
Split.redis.hset(:experiment_start_times, experiment.name, experiment_start_time.to_s)
expect(Split::ExperimentCatalog.find("basket_text").start_time).to eq(experiment_start_time)
end
it "should handle not having a start time" do
experiment_start_time = Time.parse("Sat Mar 03 14:01:03")
expect(Time).to receive(:now).and_return(experiment_start_time)
experiment.save
Split.redis.hdel(:experiment_start_times, experiment.name)
expect(Split::ExperimentCatalog.find("basket_text").start_time).to be_nil
end
it "should not create duplicates when saving multiple times" do
experiment.save
experiment.save
expect(Split.redis.exists?("basket_text")).to be true
expect(Split.redis.lrange("basket_text", 0, -1)).to eq(['{"Basket":1}', '{"Cart":1}'])
end
describe "new record?" do
it "should know if it hasn't been saved yet" do
expect(experiment.new_record?).to be_truthy
end
it "should know if it has been saved yet" do
experiment.save
expect(experiment.new_record?).to be_falsey
end
end
describe "control" do
it "should be the first alternative" do
experiment.save
expect(experiment.control.name).to eq("Basket")
end
end
end
describe "initialization" do
it "should set the algorithm when passed as an option to the initializer" do
experiment = Split::Experiment.new("basket_text", alternatives: ["Basket", "Cart"], algorithm: Split::Algorithms::Whiplash)
expect(experiment.algorithm).to eq(Split::Algorithms::Whiplash)
end
it "should be possible to make an experiment not resettable" do
experiment = Split::Experiment.new("basket_text", alternatives: ["Basket", "Cart"], resettable: false)
expect(experiment.resettable).to be_falsey
end
context "from configuration" do
let(:experiment_name) { :my_experiment }
let(:experiments) do
{
experiment_name => {
alternatives: ["Control Opt", "Alt one"]
}
}
end
before { Split.configuration.experiments = experiments }
it "assigns default values to the experiment" do
expect(Split::Experiment.new(experiment_name).resettable).to eq(true)
end
end
end
describe "persistent configuration" do
it "should persist resettable in redis" do
experiment = Split::Experiment.new("basket_text", alternatives: ["Basket", "Cart"], resettable: false)
experiment.save
e = Split::ExperimentCatalog.find("basket_text")
expect(e).to eq(experiment)
expect(e.resettable).to be_falsey
end
describe "#metadata" do
let(:experiment) { Split::Experiment.new("basket_text", alternatives: ["Basket", "Cart"], algorithm: Split::Algorithms::Whiplash, metadata: meta) }
let(:meta) { { a: "b" } }
before do
experiment.save
end
it "should delete the key when metadata is removed" do
experiment.metadata = nil
experiment.save
expect(Split.redis.exists?(experiment.metadata_key)).to be_falsey
end
context "simple hash" do
let(:meta) { { "basket" => "a", "cart" => "b" } }
it "should persist metadata in redis" do
e = Split::ExperimentCatalog.find("basket_text")
expect(e).to eq(experiment)
expect(e.metadata).to eq(meta)
end
experiment.delete
experiment.version.should eql(1)
end
end
it "should persist algorithm in redis" do
experiment = Split::Experiment.new("basket_text", alternatives: ["Basket", "Cart"], algorithm: Split::Algorithms::Whiplash)
experiment.save
e = Split::ExperimentCatalog.find("basket_text")
expect(e).to eq(experiment)
expect(e.algorithm).to eq(Split::Algorithms::Whiplash)
end
it "should persist a new experiment in redis, that does not exist in the configuration file" do
experiment = Split::Experiment.new("foobar", alternatives: ["tra", "la"], algorithm: Split::Algorithms::Whiplash)
experiment.save
e = Split::ExperimentCatalog.find("foobar")
expect(e).to eq(experiment)
expect(e.alternatives.collect { |a| a.name }).to eq(["tra", "la"])
end
end
describe "deleting" do
it "should delete itself" do
experiment = Split::Experiment.new("basket_text", alternatives: [ "Basket", "Cart"])
experiment.save
experiment.delete
expect(Split.redis.exists?("link_color")).to be false
expect(Split::ExperimentCatalog.find("link_color")).to be_nil
end
it "should increment the version" do
expect(experiment.version).to eq(0)
experiment.delete
expect(experiment.version).to eq(1)
end
it "should call the on_experiment_delete hook" do
expect(Split.configuration.on_experiment_delete).to receive(:call)
experiment.delete
experiment.reset
experiment.version.should eql(1)
end
end
describe 'algorithm' do
expect(experiment.start_time).to be_nil
end
it "should default cohorting back to false" do
experiment.disable_cohorting
expect(experiment.cohorting_disabled?).to eq(true)
experiment.delete
expect(experiment.cohorting_disabled?).to eq(false)
end
end
describe "winner" do
it "should have no winner initially" do
expect(experiment.winner).to be_nil
end
end
describe "winner=" do
it "should allow you to specify a winner" do
experiment.save
experiment.winner = "red"
expect(experiment.winner.name).to eq("red")
end
it "should call the on_experiment_winner_choose hook" do
expect(Split.configuration.on_experiment_winner_choose).to receive(:call)
experiment.winner = "green"
end
context "when has_winner state is memoized" do
before { expect(experiment).to_not have_winner }
it "should keep has_winner state consistent" do
experiment.winner = "red"
expect(experiment).to have_winner
end
end
end
describe "reset_winner" do
before { experiment.winner = "green" }
it "should reset the winner" do
experiment.reset_winner
expect(experiment.winner).to be_nil
end
context "when has_winner state is memoized" do
before { expect(experiment).to have_winner }
it "should keep has_winner state consistent" do
experiment.reset_winner
expect(experiment).to_not have_winner
end
end
end
describe "has_winner?" do
context "with winner" do
before { experiment.winner = "red" }
it "returns true" do
expect(experiment).to have_winner
end
end
context "without winner" do
it "returns false" do
expect(experiment).to_not have_winner
end
end
it "memoizes has_winner state" do
expect(experiment).to receive(:winner).once
expect(experiment).to_not have_winner
expect(experiment).to_not have_winner
end
end
describe "reset" do
let(:reset_manually) { false }
before do
allow(Split.configuration).to receive(:reset_manually).and_return(reset_manually)
experiment.save
green.increment_participation
green.increment_participation
end
it "should reset all alternatives" do
experiment.winner = "green"
expect(experiment.next_alternative.name).to eq("green")
green.increment_participation
experiment.reset
expect(green.participant_count).to eq(0)
expect(green.completed_count).to eq(0)
end
it "should reset the winner" do
experiment.winner = "green"
expect(experiment.next_alternative.name).to eq("green")
green.increment_participation
experiment.reset
expect(experiment.winner).to be_nil
end
it "should increment the version" do
expect(experiment.version).to eq(0)
experiment.reset
expect(experiment.version).to eq(1)
end
it "should call the on_experiment_reset hook" do
expect(Split.configuration.on_experiment_reset).to receive(:call)
experiment.reset
end
it "should call the on_before_experiment_reset hook" do
expect(Split.configuration.on_before_experiment_reset).to receive(:call)
experiment.reset
end
end
describe "algorithm" do
let(:experiment) { Split::ExperimentCatalog.find_or_create("link_color", "blue", "red", "green") }
it "should use the default algorithm if none is specified" do
expect(experiment.algorithm).to eq(Split.configuration.algorithm)
end
it "should use the user specified algorithm for this experiment if specified" do
experiment.algorithm = Split::Algorithms::Whiplash
expect(experiment.algorithm).to eq(Split::Algorithms::Whiplash)
end
end
describe "#next_alternative" do
context "with multiple alternatives" do
let(:experiment) { Split::ExperimentCatalog.find_or_create("link_color", "blue", "red", "green") }
context "with winner" do
it "should always return the winner" do
green = Split::Alternative.new("green", "link_color")
experiment.winner = "green"
expect(experiment.next_alternative.name).to eq("green")
green.increment_participation
expect(experiment.next_alternative.name).to eq("green")
end
end
context "without winner" do
it "should use the specified algorithm" do
experiment.algorithm = Split::Algorithms::Whiplash
expect(experiment.algorithm).to receive(:choose_alternative).and_return(Split::Alternative.new("green", "link_color"))
expect(experiment.next_alternative.name).to eq("green")
end
end
end
context "with single alternative" do
let(:experiment) { Split::ExperimentCatalog.find_or_create("link_color", "blue") }
it "should always return the only alternative" do
expect(experiment.next_alternative.name).to eq("blue")
expect(experiment.next_alternative.name).to eq("blue")
end
end
end
describe "#cohorting_disabled?" do
it "returns false when nothing has been configured" do
expect(experiment.cohorting_disabled?).to eq false
end
it "returns true when enable_cohorting is performed" do
experiment.enable_cohorting
expect(experiment.cohorting_disabled?).to eq false
end
it "returns false when nothing has been configured" do
experiment.disable_cohorting
expect(experiment.cohorting_disabled?).to eq true
end
end
describe "changing an existing experiment" do
def same_but_different_alternative
Split::ExperimentCatalog.find_or_create("link_color", "blue", "yellow", "orange")
end
it "should reset an experiment if it is loaded with different alternatives" do
experiment.save
blue.participant_count = 5
same_experiment = same_but_different_alternative
expect(same_experiment.alternatives.map(&:name)).to eq(["blue", "yellow", "orange"])
expect(blue.participant_count).to eq(0)
end
it "should only reset once" do
experiment.save
expect(experiment.version).to eq(0)
same_experiment = same_but_different_alternative
expect(same_experiment.version).to eq(1)
same_experiment_again = same_but_different_alternative
expect(same_experiment_again.version).to eq(1)
end
context "when metadata is changed" do
it "should increase version" do
experiment.save
experiment.metadata = { "foo" => "bar" }
expect { experiment.save }.to change { experiment.version }.by(1)
end
it "does not increase version" do
experiment.metadata = nil
experiment.save
expect { experiment.save }.to change { experiment.version }.by(0)
end
end
context "when experiment configuration is changed" do
let(:reset_manually) { false }
before do
experiment.save
allow(Split.configuration).to receive(:reset_manually).and_return(reset_manually)
green.increment_participation
green.increment_participation
experiment.set_alternatives_and_options(alternatives: %w(blue red green zip),
goals: %w(purchase))
experiment.save
end
it "resets all alternatives" do
expect(green.participant_count).to eq(0)
expect(green.completed_count).to eq(0)
end
context "when reset_manually is set" do
let(:reset_manually) { true }
it "does not reset alternatives" do
expect(green.participant_count).to eq(2)
expect(green.completed_count).to eq(0)
end
end
end
end
describe "alternatives passed as non-strings" do
it "should throw an exception if an alternative is passed that is not a string" do
expect { Split::ExperimentCatalog.find_or_create("link_color", :blue, :red) }.to raise_error(ArgumentError)
expect { Split::ExperimentCatalog.find_or_create("link_enabled", true, false) }.to raise_error(ArgumentError)
end
end
describe "specifying weights" do
let(:experiment_with_weight) {
Split::ExperimentCatalog.find_or_create("link_color", { "blue" => 1 }, { "red" => 2 })
}
it "should work for a new experiment" do
expect(experiment_with_weight.alternatives.map(&:weight)).to eq([1, 2])
end
it "should work for an existing experiment" do
experiment.save
expect(experiment_with_weight.alternatives.map(&:weight)).to eq([1, 2])
end
end
describe "specifying goals" do
let(:experiment) {
new_experiment(["purchase"])
}
context "saving experiment" do
let(:same_but_different_goals) { Split::ExperimentCatalog.find_or_create({ "link_color" => ["purchase", "refund"] }, "blue", "red", "green") }
before { experiment.save }
it "can find existing experiment" do
expect(Split::ExperimentCatalog.find("link_color").name).to eq("link_color")
end
it "should reset an experiment if it is loaded with different goals" do
same_but_different_goals
expect(Split::ExperimentCatalog.find("link_color").goals).to eq(["purchase", "refund"])
end
end
it "should have goals" do
expect(experiment.goals).to eq(["purchase"])
end
context "find or create experiment" do
it "should have correct goals" do
experiment = Split::ExperimentCatalog.find_or_create({ "link_color3" => ["purchase", "refund"] }, "blue", "red", "green")
expect(experiment.goals).to eq(["purchase", "refund"])
experiment = Split::ExperimentCatalog.find_or_create("link_color3", "blue", "red", "green")
expect(experiment.goals).to eq([])
end
end
end
describe "beta probability calculation" do
it "should return a hash with the probability of each alternative being the best" do
experiment = Split::ExperimentCatalog.find_or_create("mathematicians", "bernoulli", "poisson", "lagrange")
experiment.calc_winning_alternatives
expect(experiment.alternative_probabilities).not_to be_nil
end
it "should return between 46% and 54% probability for an experiment with 2 alternatives and no data" do
experiment = Split::ExperimentCatalog.find_or_create("scientists", "einstein", "bohr")
experiment.calc_winning_alternatives
expect(experiment.alternatives[0].p_winner).to be_within(0.04).of(0.50)
end
it "should calculate the probability of being the winning alternative separately for each goal", skip: true do
experiment = Split::ExperimentCatalog.find_or_create({ "link_color3" => ["purchase", "refund"] }, "blue", "red", "green")
goal1 = experiment.goals[0]
goal2 = experiment.goals[1]
experiment.alternatives.each do |alternative|
alternative.participant_count = 50
alternative.set_completed_count(10, goal1)
alternative.set_completed_count(15+rand(30), goal2)
end
experiment.calc_winning_alternatives
alt = experiment.alternatives[0]
p_goal1 = alt.p_winner(goal1)
p_goal2 = alt.p_winner(goal2)
expect(p_goal1).not_to be_within(0.04).of(p_goal2)
end
it "should return nil and not re-calculate probabilities if they have already been calculated today" do
experiment = Split::ExperimentCatalog.find_or_create({ "link_color3" => ["purchase", "refund"] }, "blue", "red", "green")
expect(experiment.calc_winning_alternatives).not_to be nil
expect(experiment.calc_winning_alternatives).to be nil
end
end
end
<MSG> Merge pull request #198 from craigmcnamara/add-experiment-reset-and-delete-hooks
Add hooks for experiment deletion and resetting.
<DFF> @@ -174,6 +174,11 @@ describe Split::Experiment do
experiment.delete
experiment.version.should eql(1)
end
+
+ it "should call the on_experiment_delete hook" do
+ expect(Split.configuration.on_experiment_delete).to receive(:call)
+ experiment.delete
+ end
end
@@ -219,6 +224,11 @@ describe Split::Experiment do
experiment.reset
experiment.version.should eql(1)
end
+
+ it "should call the on_experiment_reset hook" do
+ expect(Split.configuration.on_experiment_reset).to receive(:call)
+ experiment.reset
+ end
end
describe 'algorithm' do
| 10 | Merge pull request #198 from craigmcnamara/add-experiment-reset-and-delete-hooks | 0 | .rb | rb | mit | splitrb/split |
10072390 | <NME> experiment_spec.rb
<BEF> # frozen_string_literal: true
require "spec_helper"
require "time"
describe Split::Experiment do
def new_experiment(goals = [])
Split::Experiment.new("link_color", alternatives: ["blue", "red", "green"], goals: goals)
end
def alternative(color)
Split::Alternative.new(color, "link_color")
end
let(:experiment) { new_experiment }
let(:blue) { alternative("blue") }
let(:green) { alternative("green") }
context "with an experiment" do
let(:experiment) { Split::Experiment.new("basket_text", alternatives: ["Basket", "Cart"]) }
it "should have a name" do
expect(experiment.name).to eq("basket_text")
end
it "should have alternatives" do
expect(experiment.alternatives.length).to be 2
end
it "should have alternatives with correct names" do
expect(experiment.alternatives.collect { |a| a.name }).to eq(["Basket", "Cart"])
end
it "should be resettable by default" do
expect(experiment.resettable).to be_truthy
end
it "should save to redis" do
experiment.save
expect(Split.redis.exists?("basket_text")).to be true
end
it "should save the start time to redis" do
experiment_start_time = Time.at(1372167761)
expect(Time).to receive(:now).and_return(experiment_start_time)
experiment.save
expect(Split::ExperimentCatalog.find("basket_text").start_time).to eq(experiment_start_time)
end
it "should not save the start time to redis when start_manually is enabled" do
expect(Split.configuration).to receive(:start_manually).and_return(true)
experiment.save
expect(Split::ExperimentCatalog.find("basket_text").start_time).to be_nil
end
it "should save the selected algorithm to redis" do
experiment_algorithm = Split::Algorithms::Whiplash
experiment.algorithm = experiment_algorithm
experiment.save
expect(Split::ExperimentCatalog.find("basket_text").algorithm).to eq(experiment_algorithm)
end
it "should handle having a start time stored as a string" do
experiment_start_time = Time.parse("Sat Mar 03 14:01:03")
expect(Time).to receive(:now).twice.and_return(experiment_start_time)
experiment.save
Split.redis.hset(:experiment_start_times, experiment.name, experiment_start_time.to_s)
expect(Split::ExperimentCatalog.find("basket_text").start_time).to eq(experiment_start_time)
end
it "should handle not having a start time" do
experiment_start_time = Time.parse("Sat Mar 03 14:01:03")
expect(Time).to receive(:now).and_return(experiment_start_time)
experiment.save
Split.redis.hdel(:experiment_start_times, experiment.name)
expect(Split::ExperimentCatalog.find("basket_text").start_time).to be_nil
end
it "should not create duplicates when saving multiple times" do
experiment.save
experiment.save
expect(Split.redis.exists?("basket_text")).to be true
expect(Split.redis.lrange("basket_text", 0, -1)).to eq(['{"Basket":1}', '{"Cart":1}'])
end
describe "new record?" do
it "should know if it hasn't been saved yet" do
expect(experiment.new_record?).to be_truthy
end
it "should know if it has been saved yet" do
experiment.save
expect(experiment.new_record?).to be_falsey
end
end
describe "control" do
it "should be the first alternative" do
experiment.save
expect(experiment.control.name).to eq("Basket")
end
end
end
describe "initialization" do
it "should set the algorithm when passed as an option to the initializer" do
experiment = Split::Experiment.new("basket_text", alternatives: ["Basket", "Cart"], algorithm: Split::Algorithms::Whiplash)
expect(experiment.algorithm).to eq(Split::Algorithms::Whiplash)
end
it "should be possible to make an experiment not resettable" do
experiment = Split::Experiment.new("basket_text", alternatives: ["Basket", "Cart"], resettable: false)
expect(experiment.resettable).to be_falsey
end
context "from configuration" do
let(:experiment_name) { :my_experiment }
let(:experiments) do
{
experiment_name => {
alternatives: ["Control Opt", "Alt one"]
}
}
end
before { Split.configuration.experiments = experiments }
it "assigns default values to the experiment" do
expect(Split::Experiment.new(experiment_name).resettable).to eq(true)
end
end
end
describe "persistent configuration" do
it "should persist resettable in redis" do
experiment = Split::Experiment.new("basket_text", alternatives: ["Basket", "Cart"], resettable: false)
experiment.save
e = Split::ExperimentCatalog.find("basket_text")
expect(e).to eq(experiment)
expect(e.resettable).to be_falsey
end
describe "#metadata" do
let(:experiment) { Split::Experiment.new("basket_text", alternatives: ["Basket", "Cart"], algorithm: Split::Algorithms::Whiplash, metadata: meta) }
let(:meta) { { a: "b" } }
before do
experiment.save
end
it "should delete the key when metadata is removed" do
experiment.metadata = nil
experiment.save
expect(Split.redis.exists?(experiment.metadata_key)).to be_falsey
end
context "simple hash" do
let(:meta) { { "basket" => "a", "cart" => "b" } }
it "should persist metadata in redis" do
e = Split::ExperimentCatalog.find("basket_text")
expect(e).to eq(experiment)
expect(e.metadata).to eq(meta)
end
experiment.delete
experiment.version.should eql(1)
end
end
it "should persist algorithm in redis" do
experiment = Split::Experiment.new("basket_text", alternatives: ["Basket", "Cart"], algorithm: Split::Algorithms::Whiplash)
experiment.save
e = Split::ExperimentCatalog.find("basket_text")
expect(e).to eq(experiment)
expect(e.algorithm).to eq(Split::Algorithms::Whiplash)
end
it "should persist a new experiment in redis, that does not exist in the configuration file" do
experiment = Split::Experiment.new("foobar", alternatives: ["tra", "la"], algorithm: Split::Algorithms::Whiplash)
experiment.save
e = Split::ExperimentCatalog.find("foobar")
expect(e).to eq(experiment)
expect(e.alternatives.collect { |a| a.name }).to eq(["tra", "la"])
end
end
describe "deleting" do
it "should delete itself" do
experiment = Split::Experiment.new("basket_text", alternatives: [ "Basket", "Cart"])
experiment.save
experiment.delete
expect(Split.redis.exists?("link_color")).to be false
expect(Split::ExperimentCatalog.find("link_color")).to be_nil
end
it "should increment the version" do
expect(experiment.version).to eq(0)
experiment.delete
expect(experiment.version).to eq(1)
end
it "should call the on_experiment_delete hook" do
expect(Split.configuration.on_experiment_delete).to receive(:call)
experiment.delete
experiment.reset
experiment.version.should eql(1)
end
end
describe 'algorithm' do
expect(experiment.start_time).to be_nil
end
it "should default cohorting back to false" do
experiment.disable_cohorting
expect(experiment.cohorting_disabled?).to eq(true)
experiment.delete
expect(experiment.cohorting_disabled?).to eq(false)
end
end
describe "winner" do
it "should have no winner initially" do
expect(experiment.winner).to be_nil
end
end
describe "winner=" do
it "should allow you to specify a winner" do
experiment.save
experiment.winner = "red"
expect(experiment.winner.name).to eq("red")
end
it "should call the on_experiment_winner_choose hook" do
expect(Split.configuration.on_experiment_winner_choose).to receive(:call)
experiment.winner = "green"
end
context "when has_winner state is memoized" do
before { expect(experiment).to_not have_winner }
it "should keep has_winner state consistent" do
experiment.winner = "red"
expect(experiment).to have_winner
end
end
end
describe "reset_winner" do
before { experiment.winner = "green" }
it "should reset the winner" do
experiment.reset_winner
expect(experiment.winner).to be_nil
end
context "when has_winner state is memoized" do
before { expect(experiment).to have_winner }
it "should keep has_winner state consistent" do
experiment.reset_winner
expect(experiment).to_not have_winner
end
end
end
describe "has_winner?" do
context "with winner" do
before { experiment.winner = "red" }
it "returns true" do
expect(experiment).to have_winner
end
end
context "without winner" do
it "returns false" do
expect(experiment).to_not have_winner
end
end
it "memoizes has_winner state" do
expect(experiment).to receive(:winner).once
expect(experiment).to_not have_winner
expect(experiment).to_not have_winner
end
end
describe "reset" do
let(:reset_manually) { false }
before do
allow(Split.configuration).to receive(:reset_manually).and_return(reset_manually)
experiment.save
green.increment_participation
green.increment_participation
end
it "should reset all alternatives" do
experiment.winner = "green"
expect(experiment.next_alternative.name).to eq("green")
green.increment_participation
experiment.reset
expect(green.participant_count).to eq(0)
expect(green.completed_count).to eq(0)
end
it "should reset the winner" do
experiment.winner = "green"
expect(experiment.next_alternative.name).to eq("green")
green.increment_participation
experiment.reset
expect(experiment.winner).to be_nil
end
it "should increment the version" do
expect(experiment.version).to eq(0)
experiment.reset
expect(experiment.version).to eq(1)
end
it "should call the on_experiment_reset hook" do
expect(Split.configuration.on_experiment_reset).to receive(:call)
experiment.reset
end
it "should call the on_before_experiment_reset hook" do
expect(Split.configuration.on_before_experiment_reset).to receive(:call)
experiment.reset
end
end
describe "algorithm" do
let(:experiment) { Split::ExperimentCatalog.find_or_create("link_color", "blue", "red", "green") }
it "should use the default algorithm if none is specified" do
expect(experiment.algorithm).to eq(Split.configuration.algorithm)
end
it "should use the user specified algorithm for this experiment if specified" do
experiment.algorithm = Split::Algorithms::Whiplash
expect(experiment.algorithm).to eq(Split::Algorithms::Whiplash)
end
end
describe "#next_alternative" do
context "with multiple alternatives" do
let(:experiment) { Split::ExperimentCatalog.find_or_create("link_color", "blue", "red", "green") }
context "with winner" do
it "should always return the winner" do
green = Split::Alternative.new("green", "link_color")
experiment.winner = "green"
expect(experiment.next_alternative.name).to eq("green")
green.increment_participation
expect(experiment.next_alternative.name).to eq("green")
end
end
context "without winner" do
it "should use the specified algorithm" do
experiment.algorithm = Split::Algorithms::Whiplash
expect(experiment.algorithm).to receive(:choose_alternative).and_return(Split::Alternative.new("green", "link_color"))
expect(experiment.next_alternative.name).to eq("green")
end
end
end
context "with single alternative" do
let(:experiment) { Split::ExperimentCatalog.find_or_create("link_color", "blue") }
it "should always return the only alternative" do
expect(experiment.next_alternative.name).to eq("blue")
expect(experiment.next_alternative.name).to eq("blue")
end
end
end
describe "#cohorting_disabled?" do
it "returns false when nothing has been configured" do
expect(experiment.cohorting_disabled?).to eq false
end
it "returns true when enable_cohorting is performed" do
experiment.enable_cohorting
expect(experiment.cohorting_disabled?).to eq false
end
it "returns false when nothing has been configured" do
experiment.disable_cohorting
expect(experiment.cohorting_disabled?).to eq true
end
end
describe "changing an existing experiment" do
def same_but_different_alternative
Split::ExperimentCatalog.find_or_create("link_color", "blue", "yellow", "orange")
end
it "should reset an experiment if it is loaded with different alternatives" do
experiment.save
blue.participant_count = 5
same_experiment = same_but_different_alternative
expect(same_experiment.alternatives.map(&:name)).to eq(["blue", "yellow", "orange"])
expect(blue.participant_count).to eq(0)
end
it "should only reset once" do
experiment.save
expect(experiment.version).to eq(0)
same_experiment = same_but_different_alternative
expect(same_experiment.version).to eq(1)
same_experiment_again = same_but_different_alternative
expect(same_experiment_again.version).to eq(1)
end
context "when metadata is changed" do
it "should increase version" do
experiment.save
experiment.metadata = { "foo" => "bar" }
expect { experiment.save }.to change { experiment.version }.by(1)
end
it "does not increase version" do
experiment.metadata = nil
experiment.save
expect { experiment.save }.to change { experiment.version }.by(0)
end
end
context "when experiment configuration is changed" do
let(:reset_manually) { false }
before do
experiment.save
allow(Split.configuration).to receive(:reset_manually).and_return(reset_manually)
green.increment_participation
green.increment_participation
experiment.set_alternatives_and_options(alternatives: %w(blue red green zip),
goals: %w(purchase))
experiment.save
end
it "resets all alternatives" do
expect(green.participant_count).to eq(0)
expect(green.completed_count).to eq(0)
end
context "when reset_manually is set" do
let(:reset_manually) { true }
it "does not reset alternatives" do
expect(green.participant_count).to eq(2)
expect(green.completed_count).to eq(0)
end
end
end
end
describe "alternatives passed as non-strings" do
it "should throw an exception if an alternative is passed that is not a string" do
expect { Split::ExperimentCatalog.find_or_create("link_color", :blue, :red) }.to raise_error(ArgumentError)
expect { Split::ExperimentCatalog.find_or_create("link_enabled", true, false) }.to raise_error(ArgumentError)
end
end
describe "specifying weights" do
let(:experiment_with_weight) {
Split::ExperimentCatalog.find_or_create("link_color", { "blue" => 1 }, { "red" => 2 })
}
it "should work for a new experiment" do
expect(experiment_with_weight.alternatives.map(&:weight)).to eq([1, 2])
end
it "should work for an existing experiment" do
experiment.save
expect(experiment_with_weight.alternatives.map(&:weight)).to eq([1, 2])
end
end
describe "specifying goals" do
let(:experiment) {
new_experiment(["purchase"])
}
context "saving experiment" do
let(:same_but_different_goals) { Split::ExperimentCatalog.find_or_create({ "link_color" => ["purchase", "refund"] }, "blue", "red", "green") }
before { experiment.save }
it "can find existing experiment" do
expect(Split::ExperimentCatalog.find("link_color").name).to eq("link_color")
end
it "should reset an experiment if it is loaded with different goals" do
same_but_different_goals
expect(Split::ExperimentCatalog.find("link_color").goals).to eq(["purchase", "refund"])
end
end
it "should have goals" do
expect(experiment.goals).to eq(["purchase"])
end
context "find or create experiment" do
it "should have correct goals" do
experiment = Split::ExperimentCatalog.find_or_create({ "link_color3" => ["purchase", "refund"] }, "blue", "red", "green")
expect(experiment.goals).to eq(["purchase", "refund"])
experiment = Split::ExperimentCatalog.find_or_create("link_color3", "blue", "red", "green")
expect(experiment.goals).to eq([])
end
end
end
describe "beta probability calculation" do
it "should return a hash with the probability of each alternative being the best" do
experiment = Split::ExperimentCatalog.find_or_create("mathematicians", "bernoulli", "poisson", "lagrange")
experiment.calc_winning_alternatives
expect(experiment.alternative_probabilities).not_to be_nil
end
it "should return between 46% and 54% probability for an experiment with 2 alternatives and no data" do
experiment = Split::ExperimentCatalog.find_or_create("scientists", "einstein", "bohr")
experiment.calc_winning_alternatives
expect(experiment.alternatives[0].p_winner).to be_within(0.04).of(0.50)
end
it "should calculate the probability of being the winning alternative separately for each goal", skip: true do
experiment = Split::ExperimentCatalog.find_or_create({ "link_color3" => ["purchase", "refund"] }, "blue", "red", "green")
goal1 = experiment.goals[0]
goal2 = experiment.goals[1]
experiment.alternatives.each do |alternative|
alternative.participant_count = 50
alternative.set_completed_count(10, goal1)
alternative.set_completed_count(15+rand(30), goal2)
end
experiment.calc_winning_alternatives
alt = experiment.alternatives[0]
p_goal1 = alt.p_winner(goal1)
p_goal2 = alt.p_winner(goal2)
expect(p_goal1).not_to be_within(0.04).of(p_goal2)
end
it "should return nil and not re-calculate probabilities if they have already been calculated today" do
experiment = Split::ExperimentCatalog.find_or_create({ "link_color3" => ["purchase", "refund"] }, "blue", "red", "green")
expect(experiment.calc_winning_alternatives).not_to be nil
expect(experiment.calc_winning_alternatives).to be nil
end
end
end
<MSG> Merge pull request #198 from craigmcnamara/add-experiment-reset-and-delete-hooks
Add hooks for experiment deletion and resetting.
<DFF> @@ -174,6 +174,11 @@ describe Split::Experiment do
experiment.delete
experiment.version.should eql(1)
end
+
+ it "should call the on_experiment_delete hook" do
+ expect(Split.configuration.on_experiment_delete).to receive(:call)
+ experiment.delete
+ end
end
@@ -219,6 +224,11 @@ describe Split::Experiment do
experiment.reset
experiment.version.should eql(1)
end
+
+ it "should call the on_experiment_reset hook" do
+ expect(Split.configuration.on_experiment_reset).to receive(:call)
+ experiment.reset
+ end
end
describe 'algorithm' do
| 10 | Merge pull request #198 from craigmcnamara/add-experiment-reset-and-delete-hooks | 0 | .rb | rb | mit | splitrb/split |
10072391 | <NME> experiment_spec.rb
<BEF> # frozen_string_literal: true
require "spec_helper"
require "time"
describe Split::Experiment do
def new_experiment(goals = [])
Split::Experiment.new("link_color", alternatives: ["blue", "red", "green"], goals: goals)
end
def alternative(color)
Split::Alternative.new(color, "link_color")
end
let(:experiment) { new_experiment }
let(:blue) { alternative("blue") }
let(:green) { alternative("green") }
context "with an experiment" do
let(:experiment) { Split::Experiment.new("basket_text", alternatives: ["Basket", "Cart"]) }
it "should have a name" do
expect(experiment.name).to eq("basket_text")
end
it "should have alternatives" do
expect(experiment.alternatives.length).to be 2
end
it "should have alternatives with correct names" do
expect(experiment.alternatives.collect { |a| a.name }).to eq(["Basket", "Cart"])
end
it "should be resettable by default" do
expect(experiment.resettable).to be_truthy
end
it "should save to redis" do
experiment.save
expect(Split.redis.exists?("basket_text")).to be true
end
it "should save the start time to redis" do
experiment_start_time = Time.at(1372167761)
expect(Time).to receive(:now).and_return(experiment_start_time)
experiment.save
expect(Split::ExperimentCatalog.find("basket_text").start_time).to eq(experiment_start_time)
end
it "should not save the start time to redis when start_manually is enabled" do
expect(Split.configuration).to receive(:start_manually).and_return(true)
experiment.save
expect(Split::ExperimentCatalog.find("basket_text").start_time).to be_nil
end
it "should save the selected algorithm to redis" do
experiment_algorithm = Split::Algorithms::Whiplash
experiment.algorithm = experiment_algorithm
experiment.save
expect(Split::ExperimentCatalog.find("basket_text").algorithm).to eq(experiment_algorithm)
end
it "should handle having a start time stored as a string" do
experiment_start_time = Time.parse("Sat Mar 03 14:01:03")
expect(Time).to receive(:now).twice.and_return(experiment_start_time)
experiment.save
Split.redis.hset(:experiment_start_times, experiment.name, experiment_start_time.to_s)
expect(Split::ExperimentCatalog.find("basket_text").start_time).to eq(experiment_start_time)
end
it "should handle not having a start time" do
experiment_start_time = Time.parse("Sat Mar 03 14:01:03")
expect(Time).to receive(:now).and_return(experiment_start_time)
experiment.save
Split.redis.hdel(:experiment_start_times, experiment.name)
expect(Split::ExperimentCatalog.find("basket_text").start_time).to be_nil
end
it "should not create duplicates when saving multiple times" do
experiment.save
experiment.save
expect(Split.redis.exists?("basket_text")).to be true
expect(Split.redis.lrange("basket_text", 0, -1)).to eq(['{"Basket":1}', '{"Cart":1}'])
end
describe "new record?" do
it "should know if it hasn't been saved yet" do
expect(experiment.new_record?).to be_truthy
end
it "should know if it has been saved yet" do
experiment.save
expect(experiment.new_record?).to be_falsey
end
end
describe "control" do
it "should be the first alternative" do
experiment.save
expect(experiment.control.name).to eq("Basket")
end
end
end
describe "initialization" do
it "should set the algorithm when passed as an option to the initializer" do
experiment = Split::Experiment.new("basket_text", alternatives: ["Basket", "Cart"], algorithm: Split::Algorithms::Whiplash)
expect(experiment.algorithm).to eq(Split::Algorithms::Whiplash)
end
it "should be possible to make an experiment not resettable" do
experiment = Split::Experiment.new("basket_text", alternatives: ["Basket", "Cart"], resettable: false)
expect(experiment.resettable).to be_falsey
end
context "from configuration" do
let(:experiment_name) { :my_experiment }
let(:experiments) do
{
experiment_name => {
alternatives: ["Control Opt", "Alt one"]
}
}
end
before { Split.configuration.experiments = experiments }
it "assigns default values to the experiment" do
expect(Split::Experiment.new(experiment_name).resettable).to eq(true)
end
end
end
describe "persistent configuration" do
it "should persist resettable in redis" do
experiment = Split::Experiment.new("basket_text", alternatives: ["Basket", "Cart"], resettable: false)
experiment.save
e = Split::ExperimentCatalog.find("basket_text")
expect(e).to eq(experiment)
expect(e.resettable).to be_falsey
end
describe "#metadata" do
let(:experiment) { Split::Experiment.new("basket_text", alternatives: ["Basket", "Cart"], algorithm: Split::Algorithms::Whiplash, metadata: meta) }
let(:meta) { { a: "b" } }
before do
experiment.save
end
it "should delete the key when metadata is removed" do
experiment.metadata = nil
experiment.save
expect(Split.redis.exists?(experiment.metadata_key)).to be_falsey
end
context "simple hash" do
let(:meta) { { "basket" => "a", "cart" => "b" } }
it "should persist metadata in redis" do
e = Split::ExperimentCatalog.find("basket_text")
expect(e).to eq(experiment)
expect(e.metadata).to eq(meta)
end
experiment.delete
experiment.version.should eql(1)
end
end
it "should persist algorithm in redis" do
experiment = Split::Experiment.new("basket_text", alternatives: ["Basket", "Cart"], algorithm: Split::Algorithms::Whiplash)
experiment.save
e = Split::ExperimentCatalog.find("basket_text")
expect(e).to eq(experiment)
expect(e.algorithm).to eq(Split::Algorithms::Whiplash)
end
it "should persist a new experiment in redis, that does not exist in the configuration file" do
experiment = Split::Experiment.new("foobar", alternatives: ["tra", "la"], algorithm: Split::Algorithms::Whiplash)
experiment.save
e = Split::ExperimentCatalog.find("foobar")
expect(e).to eq(experiment)
expect(e.alternatives.collect { |a| a.name }).to eq(["tra", "la"])
end
end
describe "deleting" do
it "should delete itself" do
experiment = Split::Experiment.new("basket_text", alternatives: [ "Basket", "Cart"])
experiment.save
experiment.delete
expect(Split.redis.exists?("link_color")).to be false
expect(Split::ExperimentCatalog.find("link_color")).to be_nil
end
it "should increment the version" do
expect(experiment.version).to eq(0)
experiment.delete
expect(experiment.version).to eq(1)
end
it "should call the on_experiment_delete hook" do
expect(Split.configuration.on_experiment_delete).to receive(:call)
experiment.delete
experiment.reset
experiment.version.should eql(1)
end
end
describe 'algorithm' do
expect(experiment.start_time).to be_nil
end
it "should default cohorting back to false" do
experiment.disable_cohorting
expect(experiment.cohorting_disabled?).to eq(true)
experiment.delete
expect(experiment.cohorting_disabled?).to eq(false)
end
end
describe "winner" do
it "should have no winner initially" do
expect(experiment.winner).to be_nil
end
end
describe "winner=" do
it "should allow you to specify a winner" do
experiment.save
experiment.winner = "red"
expect(experiment.winner.name).to eq("red")
end
it "should call the on_experiment_winner_choose hook" do
expect(Split.configuration.on_experiment_winner_choose).to receive(:call)
experiment.winner = "green"
end
context "when has_winner state is memoized" do
before { expect(experiment).to_not have_winner }
it "should keep has_winner state consistent" do
experiment.winner = "red"
expect(experiment).to have_winner
end
end
end
describe "reset_winner" do
before { experiment.winner = "green" }
it "should reset the winner" do
experiment.reset_winner
expect(experiment.winner).to be_nil
end
context "when has_winner state is memoized" do
before { expect(experiment).to have_winner }
it "should keep has_winner state consistent" do
experiment.reset_winner
expect(experiment).to_not have_winner
end
end
end
describe "has_winner?" do
context "with winner" do
before { experiment.winner = "red" }
it "returns true" do
expect(experiment).to have_winner
end
end
context "without winner" do
it "returns false" do
expect(experiment).to_not have_winner
end
end
it "memoizes has_winner state" do
expect(experiment).to receive(:winner).once
expect(experiment).to_not have_winner
expect(experiment).to_not have_winner
end
end
describe "reset" do
let(:reset_manually) { false }
before do
allow(Split.configuration).to receive(:reset_manually).and_return(reset_manually)
experiment.save
green.increment_participation
green.increment_participation
end
it "should reset all alternatives" do
experiment.winner = "green"
expect(experiment.next_alternative.name).to eq("green")
green.increment_participation
experiment.reset
expect(green.participant_count).to eq(0)
expect(green.completed_count).to eq(0)
end
it "should reset the winner" do
experiment.winner = "green"
expect(experiment.next_alternative.name).to eq("green")
green.increment_participation
experiment.reset
expect(experiment.winner).to be_nil
end
it "should increment the version" do
expect(experiment.version).to eq(0)
experiment.reset
expect(experiment.version).to eq(1)
end
it "should call the on_experiment_reset hook" do
expect(Split.configuration.on_experiment_reset).to receive(:call)
experiment.reset
end
it "should call the on_before_experiment_reset hook" do
expect(Split.configuration.on_before_experiment_reset).to receive(:call)
experiment.reset
end
end
describe "algorithm" do
let(:experiment) { Split::ExperimentCatalog.find_or_create("link_color", "blue", "red", "green") }
it "should use the default algorithm if none is specified" do
expect(experiment.algorithm).to eq(Split.configuration.algorithm)
end
it "should use the user specified algorithm for this experiment if specified" do
experiment.algorithm = Split::Algorithms::Whiplash
expect(experiment.algorithm).to eq(Split::Algorithms::Whiplash)
end
end
describe "#next_alternative" do
context "with multiple alternatives" do
let(:experiment) { Split::ExperimentCatalog.find_or_create("link_color", "blue", "red", "green") }
context "with winner" do
it "should always return the winner" do
green = Split::Alternative.new("green", "link_color")
experiment.winner = "green"
expect(experiment.next_alternative.name).to eq("green")
green.increment_participation
expect(experiment.next_alternative.name).to eq("green")
end
end
context "without winner" do
it "should use the specified algorithm" do
experiment.algorithm = Split::Algorithms::Whiplash
expect(experiment.algorithm).to receive(:choose_alternative).and_return(Split::Alternative.new("green", "link_color"))
expect(experiment.next_alternative.name).to eq("green")
end
end
end
context "with single alternative" do
let(:experiment) { Split::ExperimentCatalog.find_or_create("link_color", "blue") }
it "should always return the only alternative" do
expect(experiment.next_alternative.name).to eq("blue")
expect(experiment.next_alternative.name).to eq("blue")
end
end
end
describe "#cohorting_disabled?" do
it "returns false when nothing has been configured" do
expect(experiment.cohorting_disabled?).to eq false
end
it "returns true when enable_cohorting is performed" do
experiment.enable_cohorting
expect(experiment.cohorting_disabled?).to eq false
end
it "returns false when nothing has been configured" do
experiment.disable_cohorting
expect(experiment.cohorting_disabled?).to eq true
end
end
describe "changing an existing experiment" do
def same_but_different_alternative
Split::ExperimentCatalog.find_or_create("link_color", "blue", "yellow", "orange")
end
it "should reset an experiment if it is loaded with different alternatives" do
experiment.save
blue.participant_count = 5
same_experiment = same_but_different_alternative
expect(same_experiment.alternatives.map(&:name)).to eq(["blue", "yellow", "orange"])
expect(blue.participant_count).to eq(0)
end
it "should only reset once" do
experiment.save
expect(experiment.version).to eq(0)
same_experiment = same_but_different_alternative
expect(same_experiment.version).to eq(1)
same_experiment_again = same_but_different_alternative
expect(same_experiment_again.version).to eq(1)
end
context "when metadata is changed" do
it "should increase version" do
experiment.save
experiment.metadata = { "foo" => "bar" }
expect { experiment.save }.to change { experiment.version }.by(1)
end
it "does not increase version" do
experiment.metadata = nil
experiment.save
expect { experiment.save }.to change { experiment.version }.by(0)
end
end
context "when experiment configuration is changed" do
let(:reset_manually) { false }
before do
experiment.save
allow(Split.configuration).to receive(:reset_manually).and_return(reset_manually)
green.increment_participation
green.increment_participation
experiment.set_alternatives_and_options(alternatives: %w(blue red green zip),
goals: %w(purchase))
experiment.save
end
it "resets all alternatives" do
expect(green.participant_count).to eq(0)
expect(green.completed_count).to eq(0)
end
context "when reset_manually is set" do
let(:reset_manually) { true }
it "does not reset alternatives" do
expect(green.participant_count).to eq(2)
expect(green.completed_count).to eq(0)
end
end
end
end
describe "alternatives passed as non-strings" do
it "should throw an exception if an alternative is passed that is not a string" do
expect { Split::ExperimentCatalog.find_or_create("link_color", :blue, :red) }.to raise_error(ArgumentError)
expect { Split::ExperimentCatalog.find_or_create("link_enabled", true, false) }.to raise_error(ArgumentError)
end
end
describe "specifying weights" do
let(:experiment_with_weight) {
Split::ExperimentCatalog.find_or_create("link_color", { "blue" => 1 }, { "red" => 2 })
}
it "should work for a new experiment" do
expect(experiment_with_weight.alternatives.map(&:weight)).to eq([1, 2])
end
it "should work for an existing experiment" do
experiment.save
expect(experiment_with_weight.alternatives.map(&:weight)).to eq([1, 2])
end
end
describe "specifying goals" do
let(:experiment) {
new_experiment(["purchase"])
}
context "saving experiment" do
let(:same_but_different_goals) { Split::ExperimentCatalog.find_or_create({ "link_color" => ["purchase", "refund"] }, "blue", "red", "green") }
before { experiment.save }
it "can find existing experiment" do
expect(Split::ExperimentCatalog.find("link_color").name).to eq("link_color")
end
it "should reset an experiment if it is loaded with different goals" do
same_but_different_goals
expect(Split::ExperimentCatalog.find("link_color").goals).to eq(["purchase", "refund"])
end
end
it "should have goals" do
expect(experiment.goals).to eq(["purchase"])
end
context "find or create experiment" do
it "should have correct goals" do
experiment = Split::ExperimentCatalog.find_or_create({ "link_color3" => ["purchase", "refund"] }, "blue", "red", "green")
expect(experiment.goals).to eq(["purchase", "refund"])
experiment = Split::ExperimentCatalog.find_or_create("link_color3", "blue", "red", "green")
expect(experiment.goals).to eq([])
end
end
end
describe "beta probability calculation" do
it "should return a hash with the probability of each alternative being the best" do
experiment = Split::ExperimentCatalog.find_or_create("mathematicians", "bernoulli", "poisson", "lagrange")
experiment.calc_winning_alternatives
expect(experiment.alternative_probabilities).not_to be_nil
end
it "should return between 46% and 54% probability for an experiment with 2 alternatives and no data" do
experiment = Split::ExperimentCatalog.find_or_create("scientists", "einstein", "bohr")
experiment.calc_winning_alternatives
expect(experiment.alternatives[0].p_winner).to be_within(0.04).of(0.50)
end
it "should calculate the probability of being the winning alternative separately for each goal", skip: true do
experiment = Split::ExperimentCatalog.find_or_create({ "link_color3" => ["purchase", "refund"] }, "blue", "red", "green")
goal1 = experiment.goals[0]
goal2 = experiment.goals[1]
experiment.alternatives.each do |alternative|
alternative.participant_count = 50
alternative.set_completed_count(10, goal1)
alternative.set_completed_count(15+rand(30), goal2)
end
experiment.calc_winning_alternatives
alt = experiment.alternatives[0]
p_goal1 = alt.p_winner(goal1)
p_goal2 = alt.p_winner(goal2)
expect(p_goal1).not_to be_within(0.04).of(p_goal2)
end
it "should return nil and not re-calculate probabilities if they have already been calculated today" do
experiment = Split::ExperimentCatalog.find_or_create({ "link_color3" => ["purchase", "refund"] }, "blue", "red", "green")
expect(experiment.calc_winning_alternatives).not_to be nil
expect(experiment.calc_winning_alternatives).to be nil
end
end
end
<MSG> Merge pull request #198 from craigmcnamara/add-experiment-reset-and-delete-hooks
Add hooks for experiment deletion and resetting.
<DFF> @@ -174,6 +174,11 @@ describe Split::Experiment do
experiment.delete
experiment.version.should eql(1)
end
+
+ it "should call the on_experiment_delete hook" do
+ expect(Split.configuration.on_experiment_delete).to receive(:call)
+ experiment.delete
+ end
end
@@ -219,6 +224,11 @@ describe Split::Experiment do
experiment.reset
experiment.version.should eql(1)
end
+
+ it "should call the on_experiment_reset hook" do
+ expect(Split.configuration.on_experiment_reset).to receive(:call)
+ experiment.reset
+ end
end
describe 'algorithm' do
| 10 | Merge pull request #198 from craigmcnamara/add-experiment-reset-and-delete-hooks | 0 | .rb | rb | mit | splitrb/split |
10072392 | <NME> split.gemspec
<BEF> # -*- encoding: utf-8 -*-
# frozen_string_literal: true
$:.push File.expand_path("../lib", __FILE__)
require "split/version"
Gem::Specification.new do |s|
s.name = "split"
s.version = Split::VERSION
s.platform = Gem::Platform::RUBY
s.authors = ["Andrew Nesbitt"]
s.licenses = ["MIT"]
s.email = ["[email protected]"]
s.homepage = "https://github.com/splitrb/split"
s.files = `git ls-files`.split("\n")
s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
s.require_paths = ["lib"]
s.add_dependency 'redis', '>= 2.1'
"bug_tracker_uri" => "https://github.com/splitrb/split/issues",
"wiki_uri" => "https://github.com/splitrb/split/wiki",
"mailing_list_uri" => "https://groups.google.com/d/forum/split-ruby"
}
s.required_ruby_version = ">= 2.5.0"
s.required_rubygems_version = ">= 2.0.0"
s.files = `git ls-files`.split("\n")
s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
s.require_paths = ["lib"]
s.add_dependency "redis", ">= 4.2"
s.add_dependency "sinatra", ">= 1.2.6"
s.add_dependency "rubystats", ">= 0.3.0"
s.add_development_dependency "bundler", ">= 1.17"
s.add_development_dependency "simplecov", "~> 0.15"
s.add_development_dependency "rack-test", "~> 2.0"
s.add_development_dependency "rake", "~> 13"
s.add_development_dependency "rspec", "~> 3.7"
s.add_development_dependency "pry", "~> 0.10"
s.add_development_dependency "rails", ">= 5.0"
end
<MSG> Removed executables line from gemspec
We don't have any executables to worry about
<DFF> @@ -15,7 +15,6 @@ Gem::Specification.new do |s|
s.files = `git ls-files`.split("\n")
s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
- s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
s.require_paths = ["lib"]
s.add_dependency 'redis', '>= 2.1'
| 0 | Removed executables line from gemspec | 1 | .gemspec | gemspec | mit | splitrb/split |
10072393 | <NME> split.gemspec
<BEF> # -*- encoding: utf-8 -*-
# frozen_string_literal: true
$:.push File.expand_path("../lib", __FILE__)
require "split/version"
Gem::Specification.new do |s|
s.name = "split"
s.version = Split::VERSION
s.platform = Gem::Platform::RUBY
s.authors = ["Andrew Nesbitt"]
s.licenses = ["MIT"]
s.email = ["[email protected]"]
s.homepage = "https://github.com/splitrb/split"
s.files = `git ls-files`.split("\n")
s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
s.require_paths = ["lib"]
s.add_dependency 'redis', '>= 2.1'
"bug_tracker_uri" => "https://github.com/splitrb/split/issues",
"wiki_uri" => "https://github.com/splitrb/split/wiki",
"mailing_list_uri" => "https://groups.google.com/d/forum/split-ruby"
}
s.required_ruby_version = ">= 2.5.0"
s.required_rubygems_version = ">= 2.0.0"
s.files = `git ls-files`.split("\n")
s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
s.require_paths = ["lib"]
s.add_dependency "redis", ">= 4.2"
s.add_dependency "sinatra", ">= 1.2.6"
s.add_dependency "rubystats", ">= 0.3.0"
s.add_development_dependency "bundler", ">= 1.17"
s.add_development_dependency "simplecov", "~> 0.15"
s.add_development_dependency "rack-test", "~> 2.0"
s.add_development_dependency "rake", "~> 13"
s.add_development_dependency "rspec", "~> 3.7"
s.add_development_dependency "pry", "~> 0.10"
s.add_development_dependency "rails", ">= 5.0"
end
<MSG> Removed executables line from gemspec
We don't have any executables to worry about
<DFF> @@ -15,7 +15,6 @@ Gem::Specification.new do |s|
s.files = `git ls-files`.split("\n")
s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
- s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
s.require_paths = ["lib"]
s.add_dependency 'redis', '>= 2.1'
| 0 | Removed executables line from gemspec | 1 | .gemspec | gemspec | mit | splitrb/split |
10072394 | <NME> split.gemspec
<BEF> # -*- encoding: utf-8 -*-
# frozen_string_literal: true
$:.push File.expand_path("../lib", __FILE__)
require "split/version"
Gem::Specification.new do |s|
s.name = "split"
s.version = Split::VERSION
s.platform = Gem::Platform::RUBY
s.authors = ["Andrew Nesbitt"]
s.licenses = ["MIT"]
s.email = ["[email protected]"]
s.homepage = "https://github.com/splitrb/split"
s.files = `git ls-files`.split("\n")
s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
s.require_paths = ["lib"]
s.add_dependency 'redis', '>= 2.1'
"bug_tracker_uri" => "https://github.com/splitrb/split/issues",
"wiki_uri" => "https://github.com/splitrb/split/wiki",
"mailing_list_uri" => "https://groups.google.com/d/forum/split-ruby"
}
s.required_ruby_version = ">= 2.5.0"
s.required_rubygems_version = ">= 2.0.0"
s.files = `git ls-files`.split("\n")
s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
s.require_paths = ["lib"]
s.add_dependency "redis", ">= 4.2"
s.add_dependency "sinatra", ">= 1.2.6"
s.add_dependency "rubystats", ">= 0.3.0"
s.add_development_dependency "bundler", ">= 1.17"
s.add_development_dependency "simplecov", "~> 0.15"
s.add_development_dependency "rack-test", "~> 2.0"
s.add_development_dependency "rake", "~> 13"
s.add_development_dependency "rspec", "~> 3.7"
s.add_development_dependency "pry", "~> 0.10"
s.add_development_dependency "rails", ">= 5.0"
end
<MSG> Removed executables line from gemspec
We don't have any executables to worry about
<DFF> @@ -15,7 +15,6 @@ Gem::Specification.new do |s|
s.files = `git ls-files`.split("\n")
s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
- s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
s.require_paths = ["lib"]
s.add_dependency 'redis', '>= 2.1'
| 0 | Removed executables line from gemspec | 1 | .gemspec | gemspec | mit | splitrb/split |
10072395 | <NME> helper_spec.rb
<BEF> # frozen_string_literal: true
require "spec_helper"
# TODO change some of these tests to use Rack::Test
describe Split::Helper do
include Split::Helper
let(:experiment) {
Split::ExperimentCatalog.find_or_create("link_color", "blue", "red")
}
describe "ab_test" do
it "should not raise an error when passed strings for alternatives" do
expect { ab_test("xyz", "1", "2", "3") }.not_to raise_error
end
it "should not raise an error when passed an array for alternatives" do
expect { ab_test("xyz", ["1", "2", "3"]) }.not_to raise_error
end
it "should raise the appropriate error when passed integers for alternatives" do
expect { ab_test("xyz", 1, 2, 3) }.to raise_error(ArgumentError)
end
it "should raise the appropriate error when passed symbols for alternatives" do
expect { ab_test("xyz", :a, :b, :c) }.to raise_error(ArgumentError)
end
it "should not raise error when passed an array for goals" do
expect { ab_test({ "link_color" => ["purchase", "refund"] }, "blue", "red") }.not_to raise_error
end
it "should not raise error when passed just one goal" do
expect { ab_test({ "link_color" => "purchase" }, "blue", "red") }.not_to raise_error
end
it "raises an appropriate error when processing combined expirements" do
Split.configuration.experiments = {
combined_exp_1: {
alternatives: [ { name: "control", percent: 50 }, { name: "test-alt", percent: 50 } ],
metric: :my_metric,
combined_experiments: [:combined_exp_1_sub_1]
}
}
Split::ExperimentCatalog.find_or_create("combined_exp_1")
expect { ab_test("combined_exp_1") }.to raise_error(Split::InvalidExperimentsFormatError)
end
it "should assign a random alternative to a new user when there are an equal number of alternatives assigned" do
ab_test("link_color", "blue", "red")
expect(["red", "blue"]).to include(ab_user["link_color"])
end
it "should increment the participation counter after assignment to a new user" do
previous_red_count = Split::Alternative.new("red", "link_color").participant_count
previous_blue_count = Split::Alternative.new("blue", "link_color").participant_count
ab_test("link_color", "blue", "red")
new_red_count = Split::Alternative.new("red", "link_color").participant_count
new_blue_count = Split::Alternative.new("blue", "link_color").participant_count
expect((new_red_count + new_blue_count)).to eq(previous_red_count + previous_blue_count + 1)
end
it "should not increment the counter for an experiment that the user is not participating in" do
ab_test("link_color", "blue", "red")
e = Split::ExperimentCatalog.find_or_create("button_size", "small", "big")
expect {
# User shouldn't participate in this second experiment
ab_test("button_size", "small", "big")
}.not_to change { e.participant_count }
end
it "should not increment the counter for an ended experiment" do
e = Split::ExperimentCatalog.find_or_create("button_size", "small", "big")
e.winner = "small"
expect {
a = ab_test("button_size", "small", "big")
expect(a).to eq("small")
finished('link_color')
session[:split].should == {}
end
end
describe 'conversions' do
experiment.winner = "orange"
expect(ab_test("link_color", "blue", "red")).to eq("orange")
end
it "should allow the alternative to be forced by passing it in the params" do
# ?ab_test[link_color]=blue
@params = { "ab_test" => { "link_color" => "blue" } }
alternative = ab_test("link_color", "blue", "red")
expect(alternative).to eq("blue")
alternative = ab_test("link_color", { "blue" => 1 }, "red" => 5)
expect(alternative).to eq("blue")
@params = { "ab_test" => { "link_color" => "red" } }
alternative = ab_test("link_color", "blue", "red")
expect(alternative).to eq("red")
alternative = ab_test("link_color", { "blue" => 5 }, "red" => 1)
expect(alternative).to eq("red")
end
it "should not allow an arbitrary alternative" do
@params = { "ab_test" => { "link_color" => "pink" } }
alternative = ab_test("link_color", "blue")
expect(alternative).to eq("blue")
end
it "should not store the split when a param forced alternative" do
@params = { "ab_test" => { "link_color" => "blue" } }
expect(ab_user).not_to receive(:[]=)
ab_test("link_color", "blue", "red")
end
it "SPLIT_DISABLE query parameter should also force the alternative (uses control)" do
@params = { "SPLIT_DISABLE" => "true" }
alternative = ab_test("link_color", "blue", "red")
expect(alternative).to eq("blue")
alternative = ab_test("link_color", { "blue" => 1 }, "red" => 5)
expect(alternative).to eq("blue")
alternative = ab_test("link_color", "red", "blue")
expect(alternative).to eq("red")
alternative = ab_test("link_color", { "red" => 5 }, "blue" => 1)
expect(alternative).to eq("red")
end
it "should not store the split when Split generically disabled" do
@params = { "SPLIT_DISABLE" => "true" }
expect(ab_user).not_to receive(:[]=)
ab_test("link_color", "blue", "red")
end
context "when store_override is set" do
before { Split.configuration.store_override = true }
it "should store the forced alternative" do
@params = { "ab_test" => { "link_color" => "blue" } }
expect(ab_user).to receive(:[]=).with("link_color", "blue")
ab_test("link_color", "blue", "red")
end
end
context "when on_trial_choose is set" do
before { Split.configuration.on_trial_choose = :some_method }
it "should call the method" do
expect(self).to receive(:some_method)
ab_test("link_color", "blue", "red")
end
end
it "should allow passing a block" do
alt = ab_test("link_color", "blue", "red")
ret = ab_test("link_color", "blue", "red") { |alternative| "shared/#{alternative}" }
expect(ret).to eq("shared/#{alt}")
end
it "should allow the share of visitors see an alternative to be specified" do
ab_test("link_color", { "blue" => 0.8 }, { "red" => 20 })
expect(["red", "blue"]).to include(ab_user["link_color"])
end
it "should allow alternative weighting interface as a single hash" do
ab_test("link_color", { "blue" => 0.01 }, "red" => 0.2)
experiment = Split::ExperimentCatalog.find("link_color")
expect(experiment.alternatives.map(&:name)).to eq(["blue", "red"])
expect(experiment.alternatives.collect { |a| a.weight }).to match_array([0.01, 0.2])
end
it "should only let a user participate in one experiment at a time" do
link_color = ab_test("link_color", "blue", "red")
ab_test("button_size", "small", "big")
expect(ab_user["link_color"]).to eq(link_color)
big = Split::Alternative.new("big", "button_size")
expect(big.participant_count).to eq(0)
small = Split::Alternative.new("small", "button_size")
expect(small.participant_count).to eq(0)
end
it "should let a user participate in many experiment with allow_multiple_experiments option" do
Split.configure do |config|
config.allow_multiple_experiments = true
end
link_color = ab_test("link_color", "blue", "red")
button_size = ab_test("button_size", "small", "big")
expect(ab_user["link_color"]).to eq(link_color)
expect(ab_user["button_size"]).to eq(button_size)
button_size_alt = Split::Alternative.new(button_size, "button_size")
expect(button_size_alt.participant_count).to eq(1)
end
context "with allow_multiple_experiments = 'control'" do
it "should let a user participate in many experiment with one non-'control' alternative" do
Split.configure do |config|
config.allow_multiple_experiments = "control"
end
groups = 100.times.map do |n|
ab_test("test#{n}".to_sym, { "control" => (100 - n) }, { "test#{n}-alt" => n })
end
experiments = ab_user.active_experiments
expect(experiments.size).to be > 1
count_control = experiments.values.count { |g| g == "control" }
expect(count_control).to eq(experiments.size - 1)
count_alts = groups.count { |g| g != "control" }
expect(count_alts).to eq(1)
end
context "when user already has experiment" do
let(:mock_user) { Split::User.new(self, { "test_0" => "test-alt" }) }
before do
Split.configure do |config|
config.allow_multiple_experiments = "control"
end
Split::ExperimentCatalog.find_or_initialize("test_0", "control", "test-alt").save
Split::ExperimentCatalog.find_or_initialize("test_1", "control", "test-alt").save
end
it "should restore previously selected alternative" do
expect(ab_user.active_experiments.size).to eq 1
expect(ab_test(:test_0, { "control" => 100 }, { "test-alt" => 1 })).to eq "test-alt"
expect(ab_test(:test_0, { "control" => 1 }, { "test-alt" => 100 })).to eq "test-alt"
end
it "should select the correct alternatives after experiment resets" do
experiment = Split::ExperimentCatalog.find(:test_0)
experiment.reset
mock_user[experiment.key] = "test-alt"
expect(ab_user.active_experiments.size).to eq 1
expect(ab_test(:test_0, { "control" => 100 }, { "test-alt" => 1 })).to eq "test-alt"
expect(ab_test(:test_0, { "control" => 0 }, { "test-alt" => 100 })).to eq "test-alt"
end
it "lets override existing choice" do
pending "this requires user store reset on first call not depending on whelther it is current trial"
@params = { "ab_test" => { "test_1" => "test-alt" } }
expect(ab_test(:test_0, { "control" => 0 }, { "test-alt" => 100 })).to eq "control"
expect(ab_test(:test_1, { "control" => 100 }, { "test-alt" => 1 })).to eq "test-alt"
end
end
end
it "should not over-write a finished key when an experiment is on a later version" do
experiment.increment_version
ab_user = { experiment.key => "blue", experiment.finished_key => true }
finished_session = ab_user.dup
ab_test("link_color", "blue", "red")
expect(ab_user).to eq(finished_session)
end
end
describe "metadata" do
context "is defined" do
before do
Split.configuration.experiments = {
my_experiment: {
alternatives: ["one", "two"],
resettable: false,
metadata: { "one" => "Meta1", "two" => "Meta2" }
}
}
end
it "should be passed to helper block" do
@params = { "ab_test" => { "my_experiment" => "two" } }
expect(ab_test("my_experiment")).to eq "two"
expect(ab_test("my_experiment") do |alternative, meta|
meta
end).to eq("Meta2")
end
it "should pass control metadata helper block if library disabled" do
Split.configure do |config|
config.enabled = false
end
expect(ab_test("my_experiment")).to eq "one"
expect(ab_test("my_experiment") do |_, meta|
meta
end).to eq("Meta1")
end
end
context "is not defined" do
before do
Split.configuration.experiments = {
my_experiment: {
alternatives: ["one", "two"],
resettable: false,
metadata: nil
}
}
end
it "should be passed to helper block" do
expect(ab_test("my_experiment") do |alternative, meta|
meta
end).to eq({})
end
it "should pass control metadata helper block if library disabled" do
Split.configure do |config|
config.enabled = false
end
expect(ab_test("my_experiment") do |_, meta|
meta
end).to eq({})
end
end
end
describe "ab_finished" do
context "for an experiment that the user participates in" do
before(:each) do
@experiment_name = "link_color"
@alternatives = ["blue", "red"]
@experiment = Split::ExperimentCatalog.find_or_create(@experiment_name, *@alternatives)
@alternative_name = ab_test(@experiment_name, *@alternatives)
@previous_completion_count = Split::Alternative.new(@alternative_name, @experiment_name).completed_count
end
it "should increment the counter for the completed alternative" do
ab_finished(@experiment_name)
new_completion_count = Split::Alternative.new(@alternative_name, @experiment_name).completed_count
expect(new_completion_count).to eq(@previous_completion_count + 1)
end
it "should set experiment's finished key if reset is false" do
ab_finished(@experiment_name, { reset: false })
expect(ab_user[@experiment.key]).to eq(@alternative_name)
expect(ab_user[@experiment.finished_key]).to eq(true)
end
it "should not increment the counter if reset is false and the experiment has been already finished" do
2.times { ab_finished(@experiment_name, { reset: false }) }
new_completion_count = Split::Alternative.new(@alternative_name, @experiment_name).completed_count
expect(new_completion_count).to eq(@previous_completion_count + 1)
end
it "should not increment the counter for an ended experiment" do
e = Split::ExperimentCatalog.find_or_create("button_size", "small", "big")
e.winner = "small"
a = ab_test("button_size", "small", "big")
expect(a).to eq("small")
expect {
ab_finished("button_size")
}.not_to change { Split::Alternative.new(a, "button_size").completed_count }
end
it "should clear out the user's participation from their session" do
expect(ab_user[@experiment.key]).to eq(@alternative_name)
ab_finished(@experiment_name)
expect(ab_user.keys).to be_empty
end
it "should not clear out the users session if reset is false" do
expect(ab_user[@experiment.key]).to eq(@alternative_name)
ab_finished(@experiment_name, { reset: false })
expect(ab_user[@experiment.key]).to eq(@alternative_name)
expect(ab_user[@experiment.finished_key]).to eq(true)
end
it "should reset the users session when experiment is not versioned" do
expect(ab_user[@experiment.key]).to eq(@alternative_name)
ab_finished(@experiment_name)
expect(ab_user.keys).to be_empty
end
it "should reset the users session when experiment is versioned" do
@experiment.increment_version
@alternative_name = ab_test(@experiment_name, *@alternatives)
expect(ab_user[@experiment.key]).to eq(@alternative_name)
ab_finished(@experiment_name)
expect(ab_user.keys).to be_empty
end
context "when on_trial_complete is set" do
before { Split.configuration.on_trial_complete = :some_method }
it "should call the method" do
expect(self).to receive(:some_method)
ab_finished(@experiment_name)
end
it "should not call the method without alternative" do
ab_user[@experiment.key] = nil
expect(self).not_to receive(:some_method)
ab_finished(@experiment_name)
end
end
end
context "for an experiment that the user is excluded from" do
before do
alternative = ab_test("link_color", "blue", "red")
expect(Split::Alternative.new(alternative, "link_color").participant_count).to eq(1)
alternative = ab_test("button_size", "small", "big")
expect(Split::Alternative.new(alternative, "button_size").participant_count).to eq(0)
end
it "should not increment the completed counter" do
# So, user should be participating in the link_color experiment and
# receive the control for button_size. As the user is not participating in
# the button size experiment, finishing it should not increase the
# completion count for that alternative.
expect {
ab_finished("button_size")
}.not_to change { Split::Alternative.new("small", "button_size").completed_count }
end
end
context "for an experiment that the user does not participate in" do
before do
Split::ExperimentCatalog.find_or_create(:not_started_experiment, "control", "alt")
end
it "should not raise an exception" do
expect { ab_finished(:not_started_experiment) }.not_to raise_exception
end
it "should not change the user state when reset is false" do
expect { ab_finished(:not_started_experiment, reset: false) }.not_to change { ab_user.keys }.from([])
end
it "should not change the user state when reset is true" do
expect(self).not_to receive(:reset!)
ab_finished(:not_started_experiment)
end
it "should not increment the completed counter" do
ab_finished(:not_started_experiment)
expect(Split::Alternative.new("control", :not_started_experiment).completed_count).to eq(0)
expect(Split::Alternative.new("alt", :not_started_experiment).completed_count).to eq(0)
end
end
end
context "finished with config" do
it "passes reset option" do
Split.configuration.experiments = {
my_experiment: {
alternatives: ["one", "two"],
resettable: false,
}
}
alternative = ab_test(:my_experiment)
experiment = Split::ExperimentCatalog.find :my_experiment
ab_finished :my_experiment
expect(ab_user[experiment.key]).to eq(alternative)
expect(ab_user[experiment.finished_key]).to eq(true)
end
end
context "finished with metric name" do
before { Split.configuration.experiments = {} }
before { expect(Split::Alternative).to receive(:new).at_least(1).times.and_call_original }
def should_finish_experiment(experiment_name, should_finish = true)
alts = Split.configuration.experiments[experiment_name][:alternatives]
experiment = Split::ExperimentCatalog.find_or_create(experiment_name, *alts)
alt_name = ab_user[experiment.key] = alts.first
alt = double("alternative")
expect(alt).to receive(:name).at_most(1).times.and_return(alt_name)
expect(Split::Alternative).to receive(:new).at_most(1).times.with(alt_name, experiment_name.to_s).and_return(alt)
if should_finish
expect(alt).to receive(:increment_completion).at_most(1).times
else
expect(alt).not_to receive(:increment_completion)
end
end
it "completes the test" do
Split.configuration.experiments[:my_experiment] = {
alternatives: [ "control_opt", "other_opt" ],
metric: :my_metric
}
should_finish_experiment :my_experiment
ab_finished :my_metric
end
it "completes all relevant tests" do
Split.configuration.experiments = {
exp_1: {
alternatives: [ "1-1", "1-2" ],
metric: :my_metric
},
exp_2: {
alternatives: [ "2-1", "2-2" ],
metric: :another_metric
},
exp_3: {
alternatives: [ "3-1", "3-2" ],
metric: :my_metric
},
}
should_finish_experiment :exp_1
should_finish_experiment :exp_2, false
should_finish_experiment :exp_3
ab_finished :my_metric
end
it "passes reset option" do
Split.configuration.experiments = {
my_exp: {
alternatives: ["one", "two"],
metric: :my_metric,
resettable: false,
}
}
alternative_name = ab_test(:my_exp)
exp = Split::ExperimentCatalog.find :my_exp
ab_finished :my_metric
expect(ab_user[exp.key]).to eq(alternative_name)
expect(ab_user[exp.finished_key]).to be_truthy
end
it "passes through options" do
Split.configuration.experiments = {
my_exp: {
alternatives: ["one", "two"],
metric: :my_metric,
}
}
alternative_name = ab_test(:my_exp)
exp = Split::ExperimentCatalog.find :my_exp
ab_finished :my_metric, reset: false
expect(ab_user[exp.key]).to eq(alternative_name)
expect(ab_user[exp.finished_key]).to be_truthy
end
end
describe "conversions" do
it "should return a conversion rate for an alternative" do
alternative_name = ab_test("link_color", "blue", "red")
previous_convertion_rate = Split::Alternative.new(alternative_name, "link_color").conversion_rate
expect(previous_convertion_rate).to eq(0.0)
ab_finished("link_color")
new_convertion_rate = Split::Alternative.new(alternative_name, "link_color").conversion_rate
expect(new_convertion_rate).to eq(1.0)
end
end
describe "active experiments" do
it "should show an active test" do
alternative = ab_test("def", "4", "5", "6")
expect(active_experiments.count).to eq 1
expect(active_experiments.first[0]).to eq "def"
expect(active_experiments.first[1]).to eq alternative
end
it "should show a finished test" do
alternative = ab_test("def", "4", "5", "6")
ab_finished("def", { reset: false })
expect(active_experiments.count).to eq 1
expect(active_experiments.first[0]).to eq "def"
expect(active_experiments.first[1]).to eq alternative
end
it "should show an active test when an experiment is on a later version" do
experiment.reset
expect(experiment.version).to eq(1)
ab_test("link_color", "blue", "red")
expect(active_experiments.count).to eq 1
expect(active_experiments.first[0]).to eq "link_color"
end
it "should show versioned tests properly" do
10.times { experiment.reset }
alternative = ab_test(experiment.name, "blue", "red")
ab_finished(experiment.name, reset: false)
expect(experiment.version).to eq(10)
expect(active_experiments.count).to eq 1
expect(active_experiments).to eq({ "link_color" => alternative })
end
it "should show multiple tests" do
Split.configure do |config|
config.allow_multiple_experiments = true
end
alternative = ab_test("def", "4", "5", "6")
another_alternative = ab_test("ghi", "7", "8", "9")
expect(active_experiments.count).to eq 2
expect(active_experiments["def"]).to eq alternative
expect(active_experiments["ghi"]).to eq another_alternative
end
it "should not show tests with winners" do
Split.configure do |config|
config.allow_multiple_experiments = true
end
e = Split::ExperimentCatalog.find_or_create("def", "4", "5", "6")
e.winner = "4"
ab_test("def", "4", "5", "6")
another_alternative = ab_test("ghi", "7", "8", "9")
expect(active_experiments.count).to eq 1
expect(active_experiments.first[0]).to eq "ghi"
expect(active_experiments.first[1]).to eq another_alternative
end
end
describe "when user is a robot" do
before(:each) do
@request = OpenStruct.new(user_agent: "Googlebot/2.1 (+http://www.google.com/bot.html)")
end
describe "ab_test" do
it "should return the control" do
alternative = ab_test("link_color", "blue", "red")
expect(alternative).to eq experiment.control.name
end
it "should not create a experiment" do
ab_test("link_color", "blue", "red")
expect(Split::Experiment.new("link_color")).to be_a_new_record
end
it "should not increment the participation count" do
previous_red_count = Split::Alternative.new("red", "link_color").participant_count
previous_blue_count = Split::Alternative.new("blue", "link_color").participant_count
ab_test("link_color", "blue", "red")
new_red_count = Split::Alternative.new("red", "link_color").participant_count
new_blue_count = Split::Alternative.new("blue", "link_color").participant_count
expect((new_red_count + new_blue_count)).to eq(previous_red_count + previous_blue_count)
end
end
describe "finished" do
it "should not increment the completed count" do
alternative_name = ab_test("link_color", "blue", "red")
previous_completion_count = Split::Alternative.new(alternative_name, "link_color").completed_count
ab_finished("link_color")
new_completion_count = Split::Alternative.new(alternative_name, "link_color").completed_count
expect(new_completion_count).to eq(previous_completion_count)
end
end
end
describe "when providing custom ignore logic" do
context "using a proc to configure custom logic" do
before(:each) do
Split.configure do |c|
c.ignore_filter = proc { |request| true } # ignore everything
end
end
it "ignores the ab_test" do
ab_test("link_color", "blue", "red")
red_count = Split::Alternative.new("red", "link_color").participant_count
blue_count = Split::Alternative.new("blue", "link_color").participant_count
expect((red_count + blue_count)).to be(0)
end
end
end
shared_examples_for "a disabled test" do
describe "ab_test" do
it "should return the control" do
alternative = ab_test("link_color", "blue", "red")
expect(alternative).to eq experiment.control.name
end
it "should not increment the participation count" do
previous_red_count = Split::Alternative.new("red", "link_color").participant_count
previous_blue_count = Split::Alternative.new("blue", "link_color").participant_count
ab_test("link_color", "blue", "red")
new_red_count = Split::Alternative.new("red", "link_color").participant_count
new_blue_count = Split::Alternative.new("blue", "link_color").participant_count
expect((new_red_count + new_blue_count)).to eq(previous_red_count + previous_blue_count)
end
end
describe "finished" do
it "should not increment the completed count" do
alternative_name = ab_test("link_color", "blue", "red")
previous_completion_count = Split::Alternative.new(alternative_name, "link_color").completed_count
ab_finished("link_color")
new_completion_count = Split::Alternative.new(alternative_name, "link_color").completed_count
expect(new_completion_count).to eq(previous_completion_count)
end
end
end
describe "when ip address is ignored" do
context "individually" do
before(:each) do
@request = OpenStruct.new(ip: "81.19.48.130")
Split.configure do |c|
c.ignore_ip_addresses << "81.19.48.130"
end
end
it_behaves_like "a disabled test"
end
context "for a range" do
before(:each) do
@request = OpenStruct.new(ip: "81.19.48.129")
Split.configure do |c|
c.ignore_ip_addresses << /81\.19\.48\.[0-9]+/
end
end
it_behaves_like "a disabled test"
end
context "using both a range and a specific value" do
before(:each) do
@request = OpenStruct.new(ip: "81.19.48.128")
Split.configure do |c|
c.ignore_ip_addresses << "81.19.48.130"
c.ignore_ip_addresses << /81\.19\.48\.[0-9]+/
end
end
it_behaves_like "a disabled test"
end
context "when ignored other address" do
before do
@request = OpenStruct.new(ip: "1.1.1.1")
Split.configure do |c|
c.ignore_ip_addresses << "81.19.48.130"
end
end
it "works as usual" do
alternative_name = ab_test("link_color", "red", "blue")
expect {
ab_finished("link_color")
}.to change(Split::Alternative.new(alternative_name, "link_color"), :completed_count).by(1)
end
end
end
describe "when user is previewing" do
before(:each) do
@request = OpenStruct.new(headers: { "x-purpose" => "preview" })
end
it_behaves_like "a disabled test"
end
describe "versioned experiments" do
it "should use version zero if no version is present" do
alternative_name = ab_test("link_color", "blue", "red")
expect(experiment.version).to eq(0)
expect(ab_user["link_color"]).to eq(alternative_name)
end
it "should save the version of the experiment to the session" do
experiment.reset
expect(experiment.version).to eq(1)
alternative_name = ab_test("link_color", "blue", "red")
expect(ab_user["link_color:1"]).to eq(alternative_name)
end
it "should load the experiment even if the version is not 0" do
experiment.reset
expect(experiment.version).to eq(1)
alternative_name = ab_test("link_color", "blue", "red")
expect(ab_user["link_color:1"]).to eq(alternative_name)
return_alternative_name = ab_test("link_color", "blue", "red")
expect(return_alternative_name).to eq(alternative_name)
end
it "should reset the session of a user on an older version of the experiment" do
alternative_name = ab_test("link_color", "blue", "red")
expect(ab_user["link_color"]).to eq(alternative_name)
alternative = Split::Alternative.new(alternative_name, "link_color")
expect(alternative.participant_count).to eq(1)
experiment.reset
expect(experiment.version).to eq(1)
alternative = Split::Alternative.new(alternative_name, "link_color")
expect(alternative.participant_count).to eq(0)
new_alternative_name = ab_test("link_color", "blue", "red")
expect(ab_user["link_color:1"]).to eq(new_alternative_name)
new_alternative = Split::Alternative.new(new_alternative_name, "link_color")
expect(new_alternative.participant_count).to eq(1)
end
it "should cleanup old versions of experiments from the session" do
alternative_name = ab_test("link_color", "blue", "red")
expect(ab_user["link_color"]).to eq(alternative_name)
alternative = Split::Alternative.new(alternative_name, "link_color")
expect(alternative.participant_count).to eq(1)
experiment.reset
expect(experiment.version).to eq(1)
alternative = Split::Alternative.new(alternative_name, "link_color")
expect(alternative.participant_count).to eq(0)
new_alternative_name = ab_test("link_color", "blue", "red")
expect(ab_user["link_color:1"]).to eq(new_alternative_name)
end
it "should only count completion of users on the current version" do
alternative_name = ab_test("link_color", "blue", "red")
expect(ab_user["link_color"]).to eq(alternative_name)
Split::Alternative.new(alternative_name, "link_color")
experiment.reset
expect(experiment.version).to eq(1)
ab_finished("link_color")
alternative = Split::Alternative.new(alternative_name, "link_color")
expect(alternative.completed_count).to eq(0)
end
end
context "when redis is not available" do
before(:each) do
expect(Split).to receive(:redis).at_most(5).times.and_raise(Errno::ECONNREFUSED.new)
end
context "and db_failover config option is turned off" do
before(:each) do
Split.configure do |config|
config.db_failover = false
end
end
describe "ab_test" do
it "should raise an exception" do
expect { ab_test("link_color", "blue", "red") }.to raise_error(Errno::ECONNREFUSED)
end
end
describe "finished" do
it "should raise an exception" do
expect { ab_finished("link_color") }.to raise_error(Errno::ECONNREFUSED)
end
end
describe "disable split testing" do
before(:each) do
Split.configure do |config|
config.enabled = false
end
end
it "should not attempt to connect to redis" do
expect { ab_test("link_color", "blue", "red") }.not_to raise_error
end
it "should return control variable" do
expect(ab_test("link_color", "blue", "red")).to eq("blue")
expect { ab_finished("link_color") }.not_to raise_error
end
end
end
context "and db_failover config option is turned on" do
before(:each) do
Split.configure do |config|
config.db_failover = true
end
end
describe "ab_test" do
it "should not raise an exception" do
expect { ab_test("link_color", "blue", "red") }.not_to raise_error
end
it "should call db_failover_on_db_error proc with error as parameter" do
Split.configure do |config|
config.db_failover_on_db_error = proc do |error|
expect(error).to be_a(Errno::ECONNREFUSED)
end
end
expect(Split.configuration.db_failover_on_db_error).to receive(:call).and_call_original
ab_test("link_color", "blue", "red")
end
it "should always use first alternative" do
expect(ab_test("link_color", "blue", "red")).to eq("blue")
expect(ab_test("link_color", { "blue" => 0.01 }, "red" => 0.2)).to eq("blue")
expect(ab_test("link_color", { "blue" => 0.8 }, { "red" => 20 })).to eq("blue")
expect(ab_test("link_color", "blue", "red") do |alternative|
"shared/#{alternative}"
end).to eq("shared/blue")
end
context "and db_failover_allow_parameter_override config option is turned on" do
before(:each) do
Split.configure do |config|
config.db_failover_allow_parameter_override = true
end
end
context "and given an override parameter" do
it "should use given override instead of the first alternative" do
@params = { "ab_test" => { "link_color" => "red" } }
expect(ab_test("link_color", "blue", "red")).to eq("red")
expect(ab_test("link_color", "blue", "red", "green")).to eq("red")
expect(ab_test("link_color", { "blue" => 0.01 }, "red" => 0.2)).to eq("red")
expect(ab_test("link_color", { "blue" => 0.8 }, { "red" => 20 })).to eq("red")
expect(ab_test("link_color", "blue", "red") do |alternative|
"shared/#{alternative}"
end).to eq("shared/red")
end
end
end
context "and preloaded config given" do
before do
Split.configuration.experiments[:link_color] = {
alternatives: [ "blue", "red" ],
}
end
it "uses first alternative" do
expect(ab_test(:link_color)).to eq("blue")
end
end
end
describe "finished" do
it "should not raise an exception" do
expect { ab_finished("link_color") }.not_to raise_error
end
it "should call db_failover_on_db_error proc with error as parameter" do
Split.configure do |config|
config.db_failover_on_db_error = proc do |error|
expect(error).to be_a(Errno::ECONNREFUSED)
end
end
expect(Split.configuration.db_failover_on_db_error).to receive(:call).and_call_original
ab_finished("link_color")
end
end
end
end
context "with preloaded config" do
before { Split.configuration.experiments = {} }
it "pulls options from config file" do
Split.configuration.experiments[:my_experiment] = {
alternatives: [ "control_opt", "other_opt" ],
goals: ["goal1", "goal2"]
}
ab_test :my_experiment
expect(Split::Experiment.new(:my_experiment).alternatives.map(&:name)).to eq([ "control_opt", "other_opt" ])
expect(Split::Experiment.new(:my_experiment).goals).to eq([ "goal1", "goal2" ])
end
it "can be called multiple times" do
Split.configuration.experiments[:my_experiment] = {
alternatives: [ "control_opt", "other_opt" ],
goals: ["goal1", "goal2"]
}
5.times { ab_test :my_experiment }
experiment = Split::Experiment.new(:my_experiment)
expect(experiment.alternatives.map(&:name)).to eq([ "control_opt", "other_opt" ])
expect(experiment.goals).to eq([ "goal1", "goal2" ])
expect(experiment.participant_count).to eq(1)
end
it "accepts multiple goals" do
Split.configuration.experiments[:my_experiment] = {
alternatives: [ "control_opt", "other_opt" ],
goals: [ "goal1", "goal2", "goal3" ]
}
ab_test :my_experiment
experiment = Split::Experiment.new(:my_experiment)
expect(experiment.goals).to eq([ "goal1", "goal2", "goal3" ])
end
it "allow specifying goals to be optional" do
Split.configuration.experiments[:my_experiment] = {
alternatives: [ "control_opt", "other_opt" ]
}
experiment = Split::Experiment.new(:my_experiment)
expect(experiment.goals).to eq([])
end
it "accepts multiple alternatives" do
Split.configuration.experiments[:my_experiment] = {
alternatives: [ "control_opt", "second_opt", "third_opt" ],
}
ab_test :my_experiment
experiment = Split::Experiment.new(:my_experiment)
expect(experiment.alternatives.map(&:name)).to eq([ "control_opt", "second_opt", "third_opt" ])
end
it "accepts probability on alternatives" do
Split.configuration.experiments[:my_experiment] = {
alternatives: [
{ name: "control_opt", percent: 67 },
{ name: "second_opt", percent: 10 },
{ name: "third_opt", percent: 23 },
],
}
ab_test :my_experiment
experiment = Split::Experiment.new(:my_experiment)
expect(experiment.alternatives.collect { |a| [a.name, a.weight] }).to eq([["control_opt", 0.67], ["second_opt", 0.1], ["third_opt", 0.23]])
end
it "accepts probability on some alternatives" do
Split.configuration.experiments[:my_experiment] = {
alternatives: [
{ name: "control_opt", percent: 34 },
"second_opt",
{ name: "third_opt", percent: 23 },
"fourth_opt",
],
}
ab_test :my_experiment
experiment = Split::Experiment.new(:my_experiment)
names_and_weights = experiment.alternatives.collect { |a| [a.name, a.weight] }
expect(names_and_weights).to eq([["control_opt", 0.34], ["second_opt", 0.215], ["third_opt", 0.23], ["fourth_opt", 0.215]])
expect(names_and_weights.inject(0) { |sum, nw| sum + nw[1] }).to eq(1.0)
end
it "allows name param without probability" do
Split.configuration.experiments[:my_experiment] = {
alternatives: [
{ name: "control_opt" },
"second_opt",
{ name: "third_opt", percent: 64 },
],
}
ab_test :my_experiment
experiment = Split::Experiment.new(:my_experiment)
names_and_weights = experiment.alternatives.collect { |a| [a.name, a.weight] }
expect(names_and_weights).to eq([["control_opt", 0.18], ["second_opt", 0.18], ["third_opt", 0.64]])
expect(names_and_weights.inject(0) { |sum, nw| sum + nw[1] }).to eq(1.0)
end
it "fails gracefully if config is missing experiment" do
Split.configuration.experiments = { other_experiment: { foo: "Bar" } }
expect { ab_test :my_experiment }.to raise_error(Split::ExperimentNotFound)
end
it "fails gracefully if config is missing" do
expect { Split.configuration.experiments = nil }.to raise_error(Split::InvalidExperimentsFormatError)
end
it "fails gracefully if config is missing alternatives" do
Split.configuration.experiments[:my_experiment] = { foo: "Bar" }
expect { ab_test :my_experiment }.to raise_error(NoMethodError)
end
end
it "should handle multiple experiments correctly" do
experiment2 = Split::ExperimentCatalog.find_or_create("link_color2", "blue", "red")
ab_test("link_color", "blue", "red")
ab_test("link_color2", "blue", "red")
ab_finished("link_color2")
experiment2.alternatives.each do |alt|
expect(alt.unfinished_count).to eq(0)
end
end
context "with goals" do
before do
@experiment = { "link_color" => ["purchase", "refund"] }
@alternatives = ["blue", "red"]
@experiment_name, @goals = normalize_metric(@experiment)
@goal1 = @goals[0]
@goal2 = @goals[1]
end
it "should normalize experiment" do
expect(@experiment_name).to eq("link_color")
expect(@goals).to eq(["purchase", "refund"])
end
describe "ab_test" do
it "should allow experiment goals interface as a single hash" do
ab_test(@experiment, *@alternatives)
experiment = Split::ExperimentCatalog.find("link_color")
expect(experiment.goals).to eq(["purchase", "refund"])
end
end
describe "ab_finished" do
before do
@alternative_name = ab_test(@experiment, *@alternatives)
end
it "should increment the counter for the specified-goal completed alternative" do
expect { ab_finished({ "link_color" => ["purchase"] }) }
.to change { Split::Alternative.new(@alternative_name, @experiment_name).completed_count(@goal2) }.by(0)
.and change { Split::Alternative.new(@alternative_name, @experiment_name).completed_count(@goal1) }.by(1)
end
end
end
end
<MSG> Added option to finished to not reset the users session
<DFF> @@ -83,6 +83,17 @@ describe Split::Helper do
finished('link_color')
session[:split].should == {}
end
+
+ it "should not clear out the users session if reset is false" do
+ experiment = Split::Experiment.find_or_create('link_color', 'blue', 'red')
+ alternative_name = ab_test('link_color', 'blue', 'red')
+
+ previous_completion_count = Split::Alternative.find(alternative_name, 'link_color').completed_count
+
+ session[:split].should eql("link_color" => alternative_name)
+ finished('link_color', :reset => false)
+ session[:split].should eql("link_color" => alternative_name)
+ end
end
describe 'conversions' do
| 11 | Added option to finished to not reset the users session | 0 | .rb | rb | mit | splitrb/split |
10072396 | <NME> helper_spec.rb
<BEF> # frozen_string_literal: true
require "spec_helper"
# TODO change some of these tests to use Rack::Test
describe Split::Helper do
include Split::Helper
let(:experiment) {
Split::ExperimentCatalog.find_or_create("link_color", "blue", "red")
}
describe "ab_test" do
it "should not raise an error when passed strings for alternatives" do
expect { ab_test("xyz", "1", "2", "3") }.not_to raise_error
end
it "should not raise an error when passed an array for alternatives" do
expect { ab_test("xyz", ["1", "2", "3"]) }.not_to raise_error
end
it "should raise the appropriate error when passed integers for alternatives" do
expect { ab_test("xyz", 1, 2, 3) }.to raise_error(ArgumentError)
end
it "should raise the appropriate error when passed symbols for alternatives" do
expect { ab_test("xyz", :a, :b, :c) }.to raise_error(ArgumentError)
end
it "should not raise error when passed an array for goals" do
expect { ab_test({ "link_color" => ["purchase", "refund"] }, "blue", "red") }.not_to raise_error
end
it "should not raise error when passed just one goal" do
expect { ab_test({ "link_color" => "purchase" }, "blue", "red") }.not_to raise_error
end
it "raises an appropriate error when processing combined expirements" do
Split.configuration.experiments = {
combined_exp_1: {
alternatives: [ { name: "control", percent: 50 }, { name: "test-alt", percent: 50 } ],
metric: :my_metric,
combined_experiments: [:combined_exp_1_sub_1]
}
}
Split::ExperimentCatalog.find_or_create("combined_exp_1")
expect { ab_test("combined_exp_1") }.to raise_error(Split::InvalidExperimentsFormatError)
end
it "should assign a random alternative to a new user when there are an equal number of alternatives assigned" do
ab_test("link_color", "blue", "red")
expect(["red", "blue"]).to include(ab_user["link_color"])
end
it "should increment the participation counter after assignment to a new user" do
previous_red_count = Split::Alternative.new("red", "link_color").participant_count
previous_blue_count = Split::Alternative.new("blue", "link_color").participant_count
ab_test("link_color", "blue", "red")
new_red_count = Split::Alternative.new("red", "link_color").participant_count
new_blue_count = Split::Alternative.new("blue", "link_color").participant_count
expect((new_red_count + new_blue_count)).to eq(previous_red_count + previous_blue_count + 1)
end
it "should not increment the counter for an experiment that the user is not participating in" do
ab_test("link_color", "blue", "red")
e = Split::ExperimentCatalog.find_or_create("button_size", "small", "big")
expect {
# User shouldn't participate in this second experiment
ab_test("button_size", "small", "big")
}.not_to change { e.participant_count }
end
it "should not increment the counter for an ended experiment" do
e = Split::ExperimentCatalog.find_or_create("button_size", "small", "big")
e.winner = "small"
expect {
a = ab_test("button_size", "small", "big")
expect(a).to eq("small")
finished('link_color')
session[:split].should == {}
end
end
describe 'conversions' do
experiment.winner = "orange"
expect(ab_test("link_color", "blue", "red")).to eq("orange")
end
it "should allow the alternative to be forced by passing it in the params" do
# ?ab_test[link_color]=blue
@params = { "ab_test" => { "link_color" => "blue" } }
alternative = ab_test("link_color", "blue", "red")
expect(alternative).to eq("blue")
alternative = ab_test("link_color", { "blue" => 1 }, "red" => 5)
expect(alternative).to eq("blue")
@params = { "ab_test" => { "link_color" => "red" } }
alternative = ab_test("link_color", "blue", "red")
expect(alternative).to eq("red")
alternative = ab_test("link_color", { "blue" => 5 }, "red" => 1)
expect(alternative).to eq("red")
end
it "should not allow an arbitrary alternative" do
@params = { "ab_test" => { "link_color" => "pink" } }
alternative = ab_test("link_color", "blue")
expect(alternative).to eq("blue")
end
it "should not store the split when a param forced alternative" do
@params = { "ab_test" => { "link_color" => "blue" } }
expect(ab_user).not_to receive(:[]=)
ab_test("link_color", "blue", "red")
end
it "SPLIT_DISABLE query parameter should also force the alternative (uses control)" do
@params = { "SPLIT_DISABLE" => "true" }
alternative = ab_test("link_color", "blue", "red")
expect(alternative).to eq("blue")
alternative = ab_test("link_color", { "blue" => 1 }, "red" => 5)
expect(alternative).to eq("blue")
alternative = ab_test("link_color", "red", "blue")
expect(alternative).to eq("red")
alternative = ab_test("link_color", { "red" => 5 }, "blue" => 1)
expect(alternative).to eq("red")
end
it "should not store the split when Split generically disabled" do
@params = { "SPLIT_DISABLE" => "true" }
expect(ab_user).not_to receive(:[]=)
ab_test("link_color", "blue", "red")
end
context "when store_override is set" do
before { Split.configuration.store_override = true }
it "should store the forced alternative" do
@params = { "ab_test" => { "link_color" => "blue" } }
expect(ab_user).to receive(:[]=).with("link_color", "blue")
ab_test("link_color", "blue", "red")
end
end
context "when on_trial_choose is set" do
before { Split.configuration.on_trial_choose = :some_method }
it "should call the method" do
expect(self).to receive(:some_method)
ab_test("link_color", "blue", "red")
end
end
it "should allow passing a block" do
alt = ab_test("link_color", "blue", "red")
ret = ab_test("link_color", "blue", "red") { |alternative| "shared/#{alternative}" }
expect(ret).to eq("shared/#{alt}")
end
it "should allow the share of visitors see an alternative to be specified" do
ab_test("link_color", { "blue" => 0.8 }, { "red" => 20 })
expect(["red", "blue"]).to include(ab_user["link_color"])
end
it "should allow alternative weighting interface as a single hash" do
ab_test("link_color", { "blue" => 0.01 }, "red" => 0.2)
experiment = Split::ExperimentCatalog.find("link_color")
expect(experiment.alternatives.map(&:name)).to eq(["blue", "red"])
expect(experiment.alternatives.collect { |a| a.weight }).to match_array([0.01, 0.2])
end
it "should only let a user participate in one experiment at a time" do
link_color = ab_test("link_color", "blue", "red")
ab_test("button_size", "small", "big")
expect(ab_user["link_color"]).to eq(link_color)
big = Split::Alternative.new("big", "button_size")
expect(big.participant_count).to eq(0)
small = Split::Alternative.new("small", "button_size")
expect(small.participant_count).to eq(0)
end
it "should let a user participate in many experiment with allow_multiple_experiments option" do
Split.configure do |config|
config.allow_multiple_experiments = true
end
link_color = ab_test("link_color", "blue", "red")
button_size = ab_test("button_size", "small", "big")
expect(ab_user["link_color"]).to eq(link_color)
expect(ab_user["button_size"]).to eq(button_size)
button_size_alt = Split::Alternative.new(button_size, "button_size")
expect(button_size_alt.participant_count).to eq(1)
end
context "with allow_multiple_experiments = 'control'" do
it "should let a user participate in many experiment with one non-'control' alternative" do
Split.configure do |config|
config.allow_multiple_experiments = "control"
end
groups = 100.times.map do |n|
ab_test("test#{n}".to_sym, { "control" => (100 - n) }, { "test#{n}-alt" => n })
end
experiments = ab_user.active_experiments
expect(experiments.size).to be > 1
count_control = experiments.values.count { |g| g == "control" }
expect(count_control).to eq(experiments.size - 1)
count_alts = groups.count { |g| g != "control" }
expect(count_alts).to eq(1)
end
context "when user already has experiment" do
let(:mock_user) { Split::User.new(self, { "test_0" => "test-alt" }) }
before do
Split.configure do |config|
config.allow_multiple_experiments = "control"
end
Split::ExperimentCatalog.find_or_initialize("test_0", "control", "test-alt").save
Split::ExperimentCatalog.find_or_initialize("test_1", "control", "test-alt").save
end
it "should restore previously selected alternative" do
expect(ab_user.active_experiments.size).to eq 1
expect(ab_test(:test_0, { "control" => 100 }, { "test-alt" => 1 })).to eq "test-alt"
expect(ab_test(:test_0, { "control" => 1 }, { "test-alt" => 100 })).to eq "test-alt"
end
it "should select the correct alternatives after experiment resets" do
experiment = Split::ExperimentCatalog.find(:test_0)
experiment.reset
mock_user[experiment.key] = "test-alt"
expect(ab_user.active_experiments.size).to eq 1
expect(ab_test(:test_0, { "control" => 100 }, { "test-alt" => 1 })).to eq "test-alt"
expect(ab_test(:test_0, { "control" => 0 }, { "test-alt" => 100 })).to eq "test-alt"
end
it "lets override existing choice" do
pending "this requires user store reset on first call not depending on whelther it is current trial"
@params = { "ab_test" => { "test_1" => "test-alt" } }
expect(ab_test(:test_0, { "control" => 0 }, { "test-alt" => 100 })).to eq "control"
expect(ab_test(:test_1, { "control" => 100 }, { "test-alt" => 1 })).to eq "test-alt"
end
end
end
it "should not over-write a finished key when an experiment is on a later version" do
experiment.increment_version
ab_user = { experiment.key => "blue", experiment.finished_key => true }
finished_session = ab_user.dup
ab_test("link_color", "blue", "red")
expect(ab_user).to eq(finished_session)
end
end
describe "metadata" do
context "is defined" do
before do
Split.configuration.experiments = {
my_experiment: {
alternatives: ["one", "two"],
resettable: false,
metadata: { "one" => "Meta1", "two" => "Meta2" }
}
}
end
it "should be passed to helper block" do
@params = { "ab_test" => { "my_experiment" => "two" } }
expect(ab_test("my_experiment")).to eq "two"
expect(ab_test("my_experiment") do |alternative, meta|
meta
end).to eq("Meta2")
end
it "should pass control metadata helper block if library disabled" do
Split.configure do |config|
config.enabled = false
end
expect(ab_test("my_experiment")).to eq "one"
expect(ab_test("my_experiment") do |_, meta|
meta
end).to eq("Meta1")
end
end
context "is not defined" do
before do
Split.configuration.experiments = {
my_experiment: {
alternatives: ["one", "two"],
resettable: false,
metadata: nil
}
}
end
it "should be passed to helper block" do
expect(ab_test("my_experiment") do |alternative, meta|
meta
end).to eq({})
end
it "should pass control metadata helper block if library disabled" do
Split.configure do |config|
config.enabled = false
end
expect(ab_test("my_experiment") do |_, meta|
meta
end).to eq({})
end
end
end
describe "ab_finished" do
context "for an experiment that the user participates in" do
before(:each) do
@experiment_name = "link_color"
@alternatives = ["blue", "red"]
@experiment = Split::ExperimentCatalog.find_or_create(@experiment_name, *@alternatives)
@alternative_name = ab_test(@experiment_name, *@alternatives)
@previous_completion_count = Split::Alternative.new(@alternative_name, @experiment_name).completed_count
end
it "should increment the counter for the completed alternative" do
ab_finished(@experiment_name)
new_completion_count = Split::Alternative.new(@alternative_name, @experiment_name).completed_count
expect(new_completion_count).to eq(@previous_completion_count + 1)
end
it "should set experiment's finished key if reset is false" do
ab_finished(@experiment_name, { reset: false })
expect(ab_user[@experiment.key]).to eq(@alternative_name)
expect(ab_user[@experiment.finished_key]).to eq(true)
end
it "should not increment the counter if reset is false and the experiment has been already finished" do
2.times { ab_finished(@experiment_name, { reset: false }) }
new_completion_count = Split::Alternative.new(@alternative_name, @experiment_name).completed_count
expect(new_completion_count).to eq(@previous_completion_count + 1)
end
it "should not increment the counter for an ended experiment" do
e = Split::ExperimentCatalog.find_or_create("button_size", "small", "big")
e.winner = "small"
a = ab_test("button_size", "small", "big")
expect(a).to eq("small")
expect {
ab_finished("button_size")
}.not_to change { Split::Alternative.new(a, "button_size").completed_count }
end
it "should clear out the user's participation from their session" do
expect(ab_user[@experiment.key]).to eq(@alternative_name)
ab_finished(@experiment_name)
expect(ab_user.keys).to be_empty
end
it "should not clear out the users session if reset is false" do
expect(ab_user[@experiment.key]).to eq(@alternative_name)
ab_finished(@experiment_name, { reset: false })
expect(ab_user[@experiment.key]).to eq(@alternative_name)
expect(ab_user[@experiment.finished_key]).to eq(true)
end
it "should reset the users session when experiment is not versioned" do
expect(ab_user[@experiment.key]).to eq(@alternative_name)
ab_finished(@experiment_name)
expect(ab_user.keys).to be_empty
end
it "should reset the users session when experiment is versioned" do
@experiment.increment_version
@alternative_name = ab_test(@experiment_name, *@alternatives)
expect(ab_user[@experiment.key]).to eq(@alternative_name)
ab_finished(@experiment_name)
expect(ab_user.keys).to be_empty
end
context "when on_trial_complete is set" do
before { Split.configuration.on_trial_complete = :some_method }
it "should call the method" do
expect(self).to receive(:some_method)
ab_finished(@experiment_name)
end
it "should not call the method without alternative" do
ab_user[@experiment.key] = nil
expect(self).not_to receive(:some_method)
ab_finished(@experiment_name)
end
end
end
context "for an experiment that the user is excluded from" do
before do
alternative = ab_test("link_color", "blue", "red")
expect(Split::Alternative.new(alternative, "link_color").participant_count).to eq(1)
alternative = ab_test("button_size", "small", "big")
expect(Split::Alternative.new(alternative, "button_size").participant_count).to eq(0)
end
it "should not increment the completed counter" do
# So, user should be participating in the link_color experiment and
# receive the control for button_size. As the user is not participating in
# the button size experiment, finishing it should not increase the
# completion count for that alternative.
expect {
ab_finished("button_size")
}.not_to change { Split::Alternative.new("small", "button_size").completed_count }
end
end
context "for an experiment that the user does not participate in" do
before do
Split::ExperimentCatalog.find_or_create(:not_started_experiment, "control", "alt")
end
it "should not raise an exception" do
expect { ab_finished(:not_started_experiment) }.not_to raise_exception
end
it "should not change the user state when reset is false" do
expect { ab_finished(:not_started_experiment, reset: false) }.not_to change { ab_user.keys }.from([])
end
it "should not change the user state when reset is true" do
expect(self).not_to receive(:reset!)
ab_finished(:not_started_experiment)
end
it "should not increment the completed counter" do
ab_finished(:not_started_experiment)
expect(Split::Alternative.new("control", :not_started_experiment).completed_count).to eq(0)
expect(Split::Alternative.new("alt", :not_started_experiment).completed_count).to eq(0)
end
end
end
context "finished with config" do
it "passes reset option" do
Split.configuration.experiments = {
my_experiment: {
alternatives: ["one", "two"],
resettable: false,
}
}
alternative = ab_test(:my_experiment)
experiment = Split::ExperimentCatalog.find :my_experiment
ab_finished :my_experiment
expect(ab_user[experiment.key]).to eq(alternative)
expect(ab_user[experiment.finished_key]).to eq(true)
end
end
context "finished with metric name" do
before { Split.configuration.experiments = {} }
before { expect(Split::Alternative).to receive(:new).at_least(1).times.and_call_original }
def should_finish_experiment(experiment_name, should_finish = true)
alts = Split.configuration.experiments[experiment_name][:alternatives]
experiment = Split::ExperimentCatalog.find_or_create(experiment_name, *alts)
alt_name = ab_user[experiment.key] = alts.first
alt = double("alternative")
expect(alt).to receive(:name).at_most(1).times.and_return(alt_name)
expect(Split::Alternative).to receive(:new).at_most(1).times.with(alt_name, experiment_name.to_s).and_return(alt)
if should_finish
expect(alt).to receive(:increment_completion).at_most(1).times
else
expect(alt).not_to receive(:increment_completion)
end
end
it "completes the test" do
Split.configuration.experiments[:my_experiment] = {
alternatives: [ "control_opt", "other_opt" ],
metric: :my_metric
}
should_finish_experiment :my_experiment
ab_finished :my_metric
end
it "completes all relevant tests" do
Split.configuration.experiments = {
exp_1: {
alternatives: [ "1-1", "1-2" ],
metric: :my_metric
},
exp_2: {
alternatives: [ "2-1", "2-2" ],
metric: :another_metric
},
exp_3: {
alternatives: [ "3-1", "3-2" ],
metric: :my_metric
},
}
should_finish_experiment :exp_1
should_finish_experiment :exp_2, false
should_finish_experiment :exp_3
ab_finished :my_metric
end
it "passes reset option" do
Split.configuration.experiments = {
my_exp: {
alternatives: ["one", "two"],
metric: :my_metric,
resettable: false,
}
}
alternative_name = ab_test(:my_exp)
exp = Split::ExperimentCatalog.find :my_exp
ab_finished :my_metric
expect(ab_user[exp.key]).to eq(alternative_name)
expect(ab_user[exp.finished_key]).to be_truthy
end
it "passes through options" do
Split.configuration.experiments = {
my_exp: {
alternatives: ["one", "two"],
metric: :my_metric,
}
}
alternative_name = ab_test(:my_exp)
exp = Split::ExperimentCatalog.find :my_exp
ab_finished :my_metric, reset: false
expect(ab_user[exp.key]).to eq(alternative_name)
expect(ab_user[exp.finished_key]).to be_truthy
end
end
describe "conversions" do
it "should return a conversion rate for an alternative" do
alternative_name = ab_test("link_color", "blue", "red")
previous_convertion_rate = Split::Alternative.new(alternative_name, "link_color").conversion_rate
expect(previous_convertion_rate).to eq(0.0)
ab_finished("link_color")
new_convertion_rate = Split::Alternative.new(alternative_name, "link_color").conversion_rate
expect(new_convertion_rate).to eq(1.0)
end
end
describe "active experiments" do
it "should show an active test" do
alternative = ab_test("def", "4", "5", "6")
expect(active_experiments.count).to eq 1
expect(active_experiments.first[0]).to eq "def"
expect(active_experiments.first[1]).to eq alternative
end
it "should show a finished test" do
alternative = ab_test("def", "4", "5", "6")
ab_finished("def", { reset: false })
expect(active_experiments.count).to eq 1
expect(active_experiments.first[0]).to eq "def"
expect(active_experiments.first[1]).to eq alternative
end
it "should show an active test when an experiment is on a later version" do
experiment.reset
expect(experiment.version).to eq(1)
ab_test("link_color", "blue", "red")
expect(active_experiments.count).to eq 1
expect(active_experiments.first[0]).to eq "link_color"
end
it "should show versioned tests properly" do
10.times { experiment.reset }
alternative = ab_test(experiment.name, "blue", "red")
ab_finished(experiment.name, reset: false)
expect(experiment.version).to eq(10)
expect(active_experiments.count).to eq 1
expect(active_experiments).to eq({ "link_color" => alternative })
end
it "should show multiple tests" do
Split.configure do |config|
config.allow_multiple_experiments = true
end
alternative = ab_test("def", "4", "5", "6")
another_alternative = ab_test("ghi", "7", "8", "9")
expect(active_experiments.count).to eq 2
expect(active_experiments["def"]).to eq alternative
expect(active_experiments["ghi"]).to eq another_alternative
end
it "should not show tests with winners" do
Split.configure do |config|
config.allow_multiple_experiments = true
end
e = Split::ExperimentCatalog.find_or_create("def", "4", "5", "6")
e.winner = "4"
ab_test("def", "4", "5", "6")
another_alternative = ab_test("ghi", "7", "8", "9")
expect(active_experiments.count).to eq 1
expect(active_experiments.first[0]).to eq "ghi"
expect(active_experiments.first[1]).to eq another_alternative
end
end
describe "when user is a robot" do
before(:each) do
@request = OpenStruct.new(user_agent: "Googlebot/2.1 (+http://www.google.com/bot.html)")
end
describe "ab_test" do
it "should return the control" do
alternative = ab_test("link_color", "blue", "red")
expect(alternative).to eq experiment.control.name
end
it "should not create a experiment" do
ab_test("link_color", "blue", "red")
expect(Split::Experiment.new("link_color")).to be_a_new_record
end
it "should not increment the participation count" do
previous_red_count = Split::Alternative.new("red", "link_color").participant_count
previous_blue_count = Split::Alternative.new("blue", "link_color").participant_count
ab_test("link_color", "blue", "red")
new_red_count = Split::Alternative.new("red", "link_color").participant_count
new_blue_count = Split::Alternative.new("blue", "link_color").participant_count
expect((new_red_count + new_blue_count)).to eq(previous_red_count + previous_blue_count)
end
end
describe "finished" do
it "should not increment the completed count" do
alternative_name = ab_test("link_color", "blue", "red")
previous_completion_count = Split::Alternative.new(alternative_name, "link_color").completed_count
ab_finished("link_color")
new_completion_count = Split::Alternative.new(alternative_name, "link_color").completed_count
expect(new_completion_count).to eq(previous_completion_count)
end
end
end
describe "when providing custom ignore logic" do
context "using a proc to configure custom logic" do
before(:each) do
Split.configure do |c|
c.ignore_filter = proc { |request| true } # ignore everything
end
end
it "ignores the ab_test" do
ab_test("link_color", "blue", "red")
red_count = Split::Alternative.new("red", "link_color").participant_count
blue_count = Split::Alternative.new("blue", "link_color").participant_count
expect((red_count + blue_count)).to be(0)
end
end
end
shared_examples_for "a disabled test" do
describe "ab_test" do
it "should return the control" do
alternative = ab_test("link_color", "blue", "red")
expect(alternative).to eq experiment.control.name
end
it "should not increment the participation count" do
previous_red_count = Split::Alternative.new("red", "link_color").participant_count
previous_blue_count = Split::Alternative.new("blue", "link_color").participant_count
ab_test("link_color", "blue", "red")
new_red_count = Split::Alternative.new("red", "link_color").participant_count
new_blue_count = Split::Alternative.new("blue", "link_color").participant_count
expect((new_red_count + new_blue_count)).to eq(previous_red_count + previous_blue_count)
end
end
describe "finished" do
it "should not increment the completed count" do
alternative_name = ab_test("link_color", "blue", "red")
previous_completion_count = Split::Alternative.new(alternative_name, "link_color").completed_count
ab_finished("link_color")
new_completion_count = Split::Alternative.new(alternative_name, "link_color").completed_count
expect(new_completion_count).to eq(previous_completion_count)
end
end
end
describe "when ip address is ignored" do
context "individually" do
before(:each) do
@request = OpenStruct.new(ip: "81.19.48.130")
Split.configure do |c|
c.ignore_ip_addresses << "81.19.48.130"
end
end
it_behaves_like "a disabled test"
end
context "for a range" do
before(:each) do
@request = OpenStruct.new(ip: "81.19.48.129")
Split.configure do |c|
c.ignore_ip_addresses << /81\.19\.48\.[0-9]+/
end
end
it_behaves_like "a disabled test"
end
context "using both a range and a specific value" do
before(:each) do
@request = OpenStruct.new(ip: "81.19.48.128")
Split.configure do |c|
c.ignore_ip_addresses << "81.19.48.130"
c.ignore_ip_addresses << /81\.19\.48\.[0-9]+/
end
end
it_behaves_like "a disabled test"
end
context "when ignored other address" do
before do
@request = OpenStruct.new(ip: "1.1.1.1")
Split.configure do |c|
c.ignore_ip_addresses << "81.19.48.130"
end
end
it "works as usual" do
alternative_name = ab_test("link_color", "red", "blue")
expect {
ab_finished("link_color")
}.to change(Split::Alternative.new(alternative_name, "link_color"), :completed_count).by(1)
end
end
end
describe "when user is previewing" do
before(:each) do
@request = OpenStruct.new(headers: { "x-purpose" => "preview" })
end
it_behaves_like "a disabled test"
end
describe "versioned experiments" do
it "should use version zero if no version is present" do
alternative_name = ab_test("link_color", "blue", "red")
expect(experiment.version).to eq(0)
expect(ab_user["link_color"]).to eq(alternative_name)
end
it "should save the version of the experiment to the session" do
experiment.reset
expect(experiment.version).to eq(1)
alternative_name = ab_test("link_color", "blue", "red")
expect(ab_user["link_color:1"]).to eq(alternative_name)
end
it "should load the experiment even if the version is not 0" do
experiment.reset
expect(experiment.version).to eq(1)
alternative_name = ab_test("link_color", "blue", "red")
expect(ab_user["link_color:1"]).to eq(alternative_name)
return_alternative_name = ab_test("link_color", "blue", "red")
expect(return_alternative_name).to eq(alternative_name)
end
it "should reset the session of a user on an older version of the experiment" do
alternative_name = ab_test("link_color", "blue", "red")
expect(ab_user["link_color"]).to eq(alternative_name)
alternative = Split::Alternative.new(alternative_name, "link_color")
expect(alternative.participant_count).to eq(1)
experiment.reset
expect(experiment.version).to eq(1)
alternative = Split::Alternative.new(alternative_name, "link_color")
expect(alternative.participant_count).to eq(0)
new_alternative_name = ab_test("link_color", "blue", "red")
expect(ab_user["link_color:1"]).to eq(new_alternative_name)
new_alternative = Split::Alternative.new(new_alternative_name, "link_color")
expect(new_alternative.participant_count).to eq(1)
end
it "should cleanup old versions of experiments from the session" do
alternative_name = ab_test("link_color", "blue", "red")
expect(ab_user["link_color"]).to eq(alternative_name)
alternative = Split::Alternative.new(alternative_name, "link_color")
expect(alternative.participant_count).to eq(1)
experiment.reset
expect(experiment.version).to eq(1)
alternative = Split::Alternative.new(alternative_name, "link_color")
expect(alternative.participant_count).to eq(0)
new_alternative_name = ab_test("link_color", "blue", "red")
expect(ab_user["link_color:1"]).to eq(new_alternative_name)
end
it "should only count completion of users on the current version" do
alternative_name = ab_test("link_color", "blue", "red")
expect(ab_user["link_color"]).to eq(alternative_name)
Split::Alternative.new(alternative_name, "link_color")
experiment.reset
expect(experiment.version).to eq(1)
ab_finished("link_color")
alternative = Split::Alternative.new(alternative_name, "link_color")
expect(alternative.completed_count).to eq(0)
end
end
context "when redis is not available" do
before(:each) do
expect(Split).to receive(:redis).at_most(5).times.and_raise(Errno::ECONNREFUSED.new)
end
context "and db_failover config option is turned off" do
before(:each) do
Split.configure do |config|
config.db_failover = false
end
end
describe "ab_test" do
it "should raise an exception" do
expect { ab_test("link_color", "blue", "red") }.to raise_error(Errno::ECONNREFUSED)
end
end
describe "finished" do
it "should raise an exception" do
expect { ab_finished("link_color") }.to raise_error(Errno::ECONNREFUSED)
end
end
describe "disable split testing" do
before(:each) do
Split.configure do |config|
config.enabled = false
end
end
it "should not attempt to connect to redis" do
expect { ab_test("link_color", "blue", "red") }.not_to raise_error
end
it "should return control variable" do
expect(ab_test("link_color", "blue", "red")).to eq("blue")
expect { ab_finished("link_color") }.not_to raise_error
end
end
end
context "and db_failover config option is turned on" do
before(:each) do
Split.configure do |config|
config.db_failover = true
end
end
describe "ab_test" do
it "should not raise an exception" do
expect { ab_test("link_color", "blue", "red") }.not_to raise_error
end
it "should call db_failover_on_db_error proc with error as parameter" do
Split.configure do |config|
config.db_failover_on_db_error = proc do |error|
expect(error).to be_a(Errno::ECONNREFUSED)
end
end
expect(Split.configuration.db_failover_on_db_error).to receive(:call).and_call_original
ab_test("link_color", "blue", "red")
end
it "should always use first alternative" do
expect(ab_test("link_color", "blue", "red")).to eq("blue")
expect(ab_test("link_color", { "blue" => 0.01 }, "red" => 0.2)).to eq("blue")
expect(ab_test("link_color", { "blue" => 0.8 }, { "red" => 20 })).to eq("blue")
expect(ab_test("link_color", "blue", "red") do |alternative|
"shared/#{alternative}"
end).to eq("shared/blue")
end
context "and db_failover_allow_parameter_override config option is turned on" do
before(:each) do
Split.configure do |config|
config.db_failover_allow_parameter_override = true
end
end
context "and given an override parameter" do
it "should use given override instead of the first alternative" do
@params = { "ab_test" => { "link_color" => "red" } }
expect(ab_test("link_color", "blue", "red")).to eq("red")
expect(ab_test("link_color", "blue", "red", "green")).to eq("red")
expect(ab_test("link_color", { "blue" => 0.01 }, "red" => 0.2)).to eq("red")
expect(ab_test("link_color", { "blue" => 0.8 }, { "red" => 20 })).to eq("red")
expect(ab_test("link_color", "blue", "red") do |alternative|
"shared/#{alternative}"
end).to eq("shared/red")
end
end
end
context "and preloaded config given" do
before do
Split.configuration.experiments[:link_color] = {
alternatives: [ "blue", "red" ],
}
end
it "uses first alternative" do
expect(ab_test(:link_color)).to eq("blue")
end
end
end
describe "finished" do
it "should not raise an exception" do
expect { ab_finished("link_color") }.not_to raise_error
end
it "should call db_failover_on_db_error proc with error as parameter" do
Split.configure do |config|
config.db_failover_on_db_error = proc do |error|
expect(error).to be_a(Errno::ECONNREFUSED)
end
end
expect(Split.configuration.db_failover_on_db_error).to receive(:call).and_call_original
ab_finished("link_color")
end
end
end
end
context "with preloaded config" do
before { Split.configuration.experiments = {} }
it "pulls options from config file" do
Split.configuration.experiments[:my_experiment] = {
alternatives: [ "control_opt", "other_opt" ],
goals: ["goal1", "goal2"]
}
ab_test :my_experiment
expect(Split::Experiment.new(:my_experiment).alternatives.map(&:name)).to eq([ "control_opt", "other_opt" ])
expect(Split::Experiment.new(:my_experiment).goals).to eq([ "goal1", "goal2" ])
end
it "can be called multiple times" do
Split.configuration.experiments[:my_experiment] = {
alternatives: [ "control_opt", "other_opt" ],
goals: ["goal1", "goal2"]
}
5.times { ab_test :my_experiment }
experiment = Split::Experiment.new(:my_experiment)
expect(experiment.alternatives.map(&:name)).to eq([ "control_opt", "other_opt" ])
expect(experiment.goals).to eq([ "goal1", "goal2" ])
expect(experiment.participant_count).to eq(1)
end
it "accepts multiple goals" do
Split.configuration.experiments[:my_experiment] = {
alternatives: [ "control_opt", "other_opt" ],
goals: [ "goal1", "goal2", "goal3" ]
}
ab_test :my_experiment
experiment = Split::Experiment.new(:my_experiment)
expect(experiment.goals).to eq([ "goal1", "goal2", "goal3" ])
end
it "allow specifying goals to be optional" do
Split.configuration.experiments[:my_experiment] = {
alternatives: [ "control_opt", "other_opt" ]
}
experiment = Split::Experiment.new(:my_experiment)
expect(experiment.goals).to eq([])
end
it "accepts multiple alternatives" do
Split.configuration.experiments[:my_experiment] = {
alternatives: [ "control_opt", "second_opt", "third_opt" ],
}
ab_test :my_experiment
experiment = Split::Experiment.new(:my_experiment)
expect(experiment.alternatives.map(&:name)).to eq([ "control_opt", "second_opt", "third_opt" ])
end
it "accepts probability on alternatives" do
Split.configuration.experiments[:my_experiment] = {
alternatives: [
{ name: "control_opt", percent: 67 },
{ name: "second_opt", percent: 10 },
{ name: "third_opt", percent: 23 },
],
}
ab_test :my_experiment
experiment = Split::Experiment.new(:my_experiment)
expect(experiment.alternatives.collect { |a| [a.name, a.weight] }).to eq([["control_opt", 0.67], ["second_opt", 0.1], ["third_opt", 0.23]])
end
it "accepts probability on some alternatives" do
Split.configuration.experiments[:my_experiment] = {
alternatives: [
{ name: "control_opt", percent: 34 },
"second_opt",
{ name: "third_opt", percent: 23 },
"fourth_opt",
],
}
ab_test :my_experiment
experiment = Split::Experiment.new(:my_experiment)
names_and_weights = experiment.alternatives.collect { |a| [a.name, a.weight] }
expect(names_and_weights).to eq([["control_opt", 0.34], ["second_opt", 0.215], ["third_opt", 0.23], ["fourth_opt", 0.215]])
expect(names_and_weights.inject(0) { |sum, nw| sum + nw[1] }).to eq(1.0)
end
it "allows name param without probability" do
Split.configuration.experiments[:my_experiment] = {
alternatives: [
{ name: "control_opt" },
"second_opt",
{ name: "third_opt", percent: 64 },
],
}
ab_test :my_experiment
experiment = Split::Experiment.new(:my_experiment)
names_and_weights = experiment.alternatives.collect { |a| [a.name, a.weight] }
expect(names_and_weights).to eq([["control_opt", 0.18], ["second_opt", 0.18], ["third_opt", 0.64]])
expect(names_and_weights.inject(0) { |sum, nw| sum + nw[1] }).to eq(1.0)
end
it "fails gracefully if config is missing experiment" do
Split.configuration.experiments = { other_experiment: { foo: "Bar" } }
expect { ab_test :my_experiment }.to raise_error(Split::ExperimentNotFound)
end
it "fails gracefully if config is missing" do
expect { Split.configuration.experiments = nil }.to raise_error(Split::InvalidExperimentsFormatError)
end
it "fails gracefully if config is missing alternatives" do
Split.configuration.experiments[:my_experiment] = { foo: "Bar" }
expect { ab_test :my_experiment }.to raise_error(NoMethodError)
end
end
it "should handle multiple experiments correctly" do
experiment2 = Split::ExperimentCatalog.find_or_create("link_color2", "blue", "red")
ab_test("link_color", "blue", "red")
ab_test("link_color2", "blue", "red")
ab_finished("link_color2")
experiment2.alternatives.each do |alt|
expect(alt.unfinished_count).to eq(0)
end
end
context "with goals" do
before do
@experiment = { "link_color" => ["purchase", "refund"] }
@alternatives = ["blue", "red"]
@experiment_name, @goals = normalize_metric(@experiment)
@goal1 = @goals[0]
@goal2 = @goals[1]
end
it "should normalize experiment" do
expect(@experiment_name).to eq("link_color")
expect(@goals).to eq(["purchase", "refund"])
end
describe "ab_test" do
it "should allow experiment goals interface as a single hash" do
ab_test(@experiment, *@alternatives)
experiment = Split::ExperimentCatalog.find("link_color")
expect(experiment.goals).to eq(["purchase", "refund"])
end
end
describe "ab_finished" do
before do
@alternative_name = ab_test(@experiment, *@alternatives)
end
it "should increment the counter for the specified-goal completed alternative" do
expect { ab_finished({ "link_color" => ["purchase"] }) }
.to change { Split::Alternative.new(@alternative_name, @experiment_name).completed_count(@goal2) }.by(0)
.and change { Split::Alternative.new(@alternative_name, @experiment_name).completed_count(@goal1) }.by(1)
end
end
end
end
<MSG> Added option to finished to not reset the users session
<DFF> @@ -83,6 +83,17 @@ describe Split::Helper do
finished('link_color')
session[:split].should == {}
end
+
+ it "should not clear out the users session if reset is false" do
+ experiment = Split::Experiment.find_or_create('link_color', 'blue', 'red')
+ alternative_name = ab_test('link_color', 'blue', 'red')
+
+ previous_completion_count = Split::Alternative.find(alternative_name, 'link_color').completed_count
+
+ session[:split].should eql("link_color" => alternative_name)
+ finished('link_color', :reset => false)
+ session[:split].should eql("link_color" => alternative_name)
+ end
end
describe 'conversions' do
| 11 | Added option to finished to not reset the users session | 0 | .rb | rb | mit | splitrb/split |
10072397 | <NME> helper_spec.rb
<BEF> # frozen_string_literal: true
require "spec_helper"
# TODO change some of these tests to use Rack::Test
describe Split::Helper do
include Split::Helper
let(:experiment) {
Split::ExperimentCatalog.find_or_create("link_color", "blue", "red")
}
describe "ab_test" do
it "should not raise an error when passed strings for alternatives" do
expect { ab_test("xyz", "1", "2", "3") }.not_to raise_error
end
it "should not raise an error when passed an array for alternatives" do
expect { ab_test("xyz", ["1", "2", "3"]) }.not_to raise_error
end
it "should raise the appropriate error when passed integers for alternatives" do
expect { ab_test("xyz", 1, 2, 3) }.to raise_error(ArgumentError)
end
it "should raise the appropriate error when passed symbols for alternatives" do
expect { ab_test("xyz", :a, :b, :c) }.to raise_error(ArgumentError)
end
it "should not raise error when passed an array for goals" do
expect { ab_test({ "link_color" => ["purchase", "refund"] }, "blue", "red") }.not_to raise_error
end
it "should not raise error when passed just one goal" do
expect { ab_test({ "link_color" => "purchase" }, "blue", "red") }.not_to raise_error
end
it "raises an appropriate error when processing combined expirements" do
Split.configuration.experiments = {
combined_exp_1: {
alternatives: [ { name: "control", percent: 50 }, { name: "test-alt", percent: 50 } ],
metric: :my_metric,
combined_experiments: [:combined_exp_1_sub_1]
}
}
Split::ExperimentCatalog.find_or_create("combined_exp_1")
expect { ab_test("combined_exp_1") }.to raise_error(Split::InvalidExperimentsFormatError)
end
it "should assign a random alternative to a new user when there are an equal number of alternatives assigned" do
ab_test("link_color", "blue", "red")
expect(["red", "blue"]).to include(ab_user["link_color"])
end
it "should increment the participation counter after assignment to a new user" do
previous_red_count = Split::Alternative.new("red", "link_color").participant_count
previous_blue_count = Split::Alternative.new("blue", "link_color").participant_count
ab_test("link_color", "blue", "red")
new_red_count = Split::Alternative.new("red", "link_color").participant_count
new_blue_count = Split::Alternative.new("blue", "link_color").participant_count
expect((new_red_count + new_blue_count)).to eq(previous_red_count + previous_blue_count + 1)
end
it "should not increment the counter for an experiment that the user is not participating in" do
ab_test("link_color", "blue", "red")
e = Split::ExperimentCatalog.find_or_create("button_size", "small", "big")
expect {
# User shouldn't participate in this second experiment
ab_test("button_size", "small", "big")
}.not_to change { e.participant_count }
end
it "should not increment the counter for an ended experiment" do
e = Split::ExperimentCatalog.find_or_create("button_size", "small", "big")
e.winner = "small"
expect {
a = ab_test("button_size", "small", "big")
expect(a).to eq("small")
finished('link_color')
session[:split].should == {}
end
end
describe 'conversions' do
experiment.winner = "orange"
expect(ab_test("link_color", "blue", "red")).to eq("orange")
end
it "should allow the alternative to be forced by passing it in the params" do
# ?ab_test[link_color]=blue
@params = { "ab_test" => { "link_color" => "blue" } }
alternative = ab_test("link_color", "blue", "red")
expect(alternative).to eq("blue")
alternative = ab_test("link_color", { "blue" => 1 }, "red" => 5)
expect(alternative).to eq("blue")
@params = { "ab_test" => { "link_color" => "red" } }
alternative = ab_test("link_color", "blue", "red")
expect(alternative).to eq("red")
alternative = ab_test("link_color", { "blue" => 5 }, "red" => 1)
expect(alternative).to eq("red")
end
it "should not allow an arbitrary alternative" do
@params = { "ab_test" => { "link_color" => "pink" } }
alternative = ab_test("link_color", "blue")
expect(alternative).to eq("blue")
end
it "should not store the split when a param forced alternative" do
@params = { "ab_test" => { "link_color" => "blue" } }
expect(ab_user).not_to receive(:[]=)
ab_test("link_color", "blue", "red")
end
it "SPLIT_DISABLE query parameter should also force the alternative (uses control)" do
@params = { "SPLIT_DISABLE" => "true" }
alternative = ab_test("link_color", "blue", "red")
expect(alternative).to eq("blue")
alternative = ab_test("link_color", { "blue" => 1 }, "red" => 5)
expect(alternative).to eq("blue")
alternative = ab_test("link_color", "red", "blue")
expect(alternative).to eq("red")
alternative = ab_test("link_color", { "red" => 5 }, "blue" => 1)
expect(alternative).to eq("red")
end
it "should not store the split when Split generically disabled" do
@params = { "SPLIT_DISABLE" => "true" }
expect(ab_user).not_to receive(:[]=)
ab_test("link_color", "blue", "red")
end
context "when store_override is set" do
before { Split.configuration.store_override = true }
it "should store the forced alternative" do
@params = { "ab_test" => { "link_color" => "blue" } }
expect(ab_user).to receive(:[]=).with("link_color", "blue")
ab_test("link_color", "blue", "red")
end
end
context "when on_trial_choose is set" do
before { Split.configuration.on_trial_choose = :some_method }
it "should call the method" do
expect(self).to receive(:some_method)
ab_test("link_color", "blue", "red")
end
end
it "should allow passing a block" do
alt = ab_test("link_color", "blue", "red")
ret = ab_test("link_color", "blue", "red") { |alternative| "shared/#{alternative}" }
expect(ret).to eq("shared/#{alt}")
end
it "should allow the share of visitors see an alternative to be specified" do
ab_test("link_color", { "blue" => 0.8 }, { "red" => 20 })
expect(["red", "blue"]).to include(ab_user["link_color"])
end
it "should allow alternative weighting interface as a single hash" do
ab_test("link_color", { "blue" => 0.01 }, "red" => 0.2)
experiment = Split::ExperimentCatalog.find("link_color")
expect(experiment.alternatives.map(&:name)).to eq(["blue", "red"])
expect(experiment.alternatives.collect { |a| a.weight }).to match_array([0.01, 0.2])
end
it "should only let a user participate in one experiment at a time" do
link_color = ab_test("link_color", "blue", "red")
ab_test("button_size", "small", "big")
expect(ab_user["link_color"]).to eq(link_color)
big = Split::Alternative.new("big", "button_size")
expect(big.participant_count).to eq(0)
small = Split::Alternative.new("small", "button_size")
expect(small.participant_count).to eq(0)
end
it "should let a user participate in many experiment with allow_multiple_experiments option" do
Split.configure do |config|
config.allow_multiple_experiments = true
end
link_color = ab_test("link_color", "blue", "red")
button_size = ab_test("button_size", "small", "big")
expect(ab_user["link_color"]).to eq(link_color)
expect(ab_user["button_size"]).to eq(button_size)
button_size_alt = Split::Alternative.new(button_size, "button_size")
expect(button_size_alt.participant_count).to eq(1)
end
context "with allow_multiple_experiments = 'control'" do
it "should let a user participate in many experiment with one non-'control' alternative" do
Split.configure do |config|
config.allow_multiple_experiments = "control"
end
groups = 100.times.map do |n|
ab_test("test#{n}".to_sym, { "control" => (100 - n) }, { "test#{n}-alt" => n })
end
experiments = ab_user.active_experiments
expect(experiments.size).to be > 1
count_control = experiments.values.count { |g| g == "control" }
expect(count_control).to eq(experiments.size - 1)
count_alts = groups.count { |g| g != "control" }
expect(count_alts).to eq(1)
end
context "when user already has experiment" do
let(:mock_user) { Split::User.new(self, { "test_0" => "test-alt" }) }
before do
Split.configure do |config|
config.allow_multiple_experiments = "control"
end
Split::ExperimentCatalog.find_or_initialize("test_0", "control", "test-alt").save
Split::ExperimentCatalog.find_or_initialize("test_1", "control", "test-alt").save
end
it "should restore previously selected alternative" do
expect(ab_user.active_experiments.size).to eq 1
expect(ab_test(:test_0, { "control" => 100 }, { "test-alt" => 1 })).to eq "test-alt"
expect(ab_test(:test_0, { "control" => 1 }, { "test-alt" => 100 })).to eq "test-alt"
end
it "should select the correct alternatives after experiment resets" do
experiment = Split::ExperimentCatalog.find(:test_0)
experiment.reset
mock_user[experiment.key] = "test-alt"
expect(ab_user.active_experiments.size).to eq 1
expect(ab_test(:test_0, { "control" => 100 }, { "test-alt" => 1 })).to eq "test-alt"
expect(ab_test(:test_0, { "control" => 0 }, { "test-alt" => 100 })).to eq "test-alt"
end
it "lets override existing choice" do
pending "this requires user store reset on first call not depending on whelther it is current trial"
@params = { "ab_test" => { "test_1" => "test-alt" } }
expect(ab_test(:test_0, { "control" => 0 }, { "test-alt" => 100 })).to eq "control"
expect(ab_test(:test_1, { "control" => 100 }, { "test-alt" => 1 })).to eq "test-alt"
end
end
end
it "should not over-write a finished key when an experiment is on a later version" do
experiment.increment_version
ab_user = { experiment.key => "blue", experiment.finished_key => true }
finished_session = ab_user.dup
ab_test("link_color", "blue", "red")
expect(ab_user).to eq(finished_session)
end
end
describe "metadata" do
context "is defined" do
before do
Split.configuration.experiments = {
my_experiment: {
alternatives: ["one", "two"],
resettable: false,
metadata: { "one" => "Meta1", "two" => "Meta2" }
}
}
end
it "should be passed to helper block" do
@params = { "ab_test" => { "my_experiment" => "two" } }
expect(ab_test("my_experiment")).to eq "two"
expect(ab_test("my_experiment") do |alternative, meta|
meta
end).to eq("Meta2")
end
it "should pass control metadata helper block if library disabled" do
Split.configure do |config|
config.enabled = false
end
expect(ab_test("my_experiment")).to eq "one"
expect(ab_test("my_experiment") do |_, meta|
meta
end).to eq("Meta1")
end
end
context "is not defined" do
before do
Split.configuration.experiments = {
my_experiment: {
alternatives: ["one", "two"],
resettable: false,
metadata: nil
}
}
end
it "should be passed to helper block" do
expect(ab_test("my_experiment") do |alternative, meta|
meta
end).to eq({})
end
it "should pass control metadata helper block if library disabled" do
Split.configure do |config|
config.enabled = false
end
expect(ab_test("my_experiment") do |_, meta|
meta
end).to eq({})
end
end
end
describe "ab_finished" do
context "for an experiment that the user participates in" do
before(:each) do
@experiment_name = "link_color"
@alternatives = ["blue", "red"]
@experiment = Split::ExperimentCatalog.find_or_create(@experiment_name, *@alternatives)
@alternative_name = ab_test(@experiment_name, *@alternatives)
@previous_completion_count = Split::Alternative.new(@alternative_name, @experiment_name).completed_count
end
it "should increment the counter for the completed alternative" do
ab_finished(@experiment_name)
new_completion_count = Split::Alternative.new(@alternative_name, @experiment_name).completed_count
expect(new_completion_count).to eq(@previous_completion_count + 1)
end
it "should set experiment's finished key if reset is false" do
ab_finished(@experiment_name, { reset: false })
expect(ab_user[@experiment.key]).to eq(@alternative_name)
expect(ab_user[@experiment.finished_key]).to eq(true)
end
it "should not increment the counter if reset is false and the experiment has been already finished" do
2.times { ab_finished(@experiment_name, { reset: false }) }
new_completion_count = Split::Alternative.new(@alternative_name, @experiment_name).completed_count
expect(new_completion_count).to eq(@previous_completion_count + 1)
end
it "should not increment the counter for an ended experiment" do
e = Split::ExperimentCatalog.find_or_create("button_size", "small", "big")
e.winner = "small"
a = ab_test("button_size", "small", "big")
expect(a).to eq("small")
expect {
ab_finished("button_size")
}.not_to change { Split::Alternative.new(a, "button_size").completed_count }
end
it "should clear out the user's participation from their session" do
expect(ab_user[@experiment.key]).to eq(@alternative_name)
ab_finished(@experiment_name)
expect(ab_user.keys).to be_empty
end
it "should not clear out the users session if reset is false" do
expect(ab_user[@experiment.key]).to eq(@alternative_name)
ab_finished(@experiment_name, { reset: false })
expect(ab_user[@experiment.key]).to eq(@alternative_name)
expect(ab_user[@experiment.finished_key]).to eq(true)
end
it "should reset the users session when experiment is not versioned" do
expect(ab_user[@experiment.key]).to eq(@alternative_name)
ab_finished(@experiment_name)
expect(ab_user.keys).to be_empty
end
it "should reset the users session when experiment is versioned" do
@experiment.increment_version
@alternative_name = ab_test(@experiment_name, *@alternatives)
expect(ab_user[@experiment.key]).to eq(@alternative_name)
ab_finished(@experiment_name)
expect(ab_user.keys).to be_empty
end
context "when on_trial_complete is set" do
before { Split.configuration.on_trial_complete = :some_method }
it "should call the method" do
expect(self).to receive(:some_method)
ab_finished(@experiment_name)
end
it "should not call the method without alternative" do
ab_user[@experiment.key] = nil
expect(self).not_to receive(:some_method)
ab_finished(@experiment_name)
end
end
end
context "for an experiment that the user is excluded from" do
before do
alternative = ab_test("link_color", "blue", "red")
expect(Split::Alternative.new(alternative, "link_color").participant_count).to eq(1)
alternative = ab_test("button_size", "small", "big")
expect(Split::Alternative.new(alternative, "button_size").participant_count).to eq(0)
end
it "should not increment the completed counter" do
# So, user should be participating in the link_color experiment and
# receive the control for button_size. As the user is not participating in
# the button size experiment, finishing it should not increase the
# completion count for that alternative.
expect {
ab_finished("button_size")
}.not_to change { Split::Alternative.new("small", "button_size").completed_count }
end
end
context "for an experiment that the user does not participate in" do
before do
Split::ExperimentCatalog.find_or_create(:not_started_experiment, "control", "alt")
end
it "should not raise an exception" do
expect { ab_finished(:not_started_experiment) }.not_to raise_exception
end
it "should not change the user state when reset is false" do
expect { ab_finished(:not_started_experiment, reset: false) }.not_to change { ab_user.keys }.from([])
end
it "should not change the user state when reset is true" do
expect(self).not_to receive(:reset!)
ab_finished(:not_started_experiment)
end
it "should not increment the completed counter" do
ab_finished(:not_started_experiment)
expect(Split::Alternative.new("control", :not_started_experiment).completed_count).to eq(0)
expect(Split::Alternative.new("alt", :not_started_experiment).completed_count).to eq(0)
end
end
end
context "finished with config" do
it "passes reset option" do
Split.configuration.experiments = {
my_experiment: {
alternatives: ["one", "two"],
resettable: false,
}
}
alternative = ab_test(:my_experiment)
experiment = Split::ExperimentCatalog.find :my_experiment
ab_finished :my_experiment
expect(ab_user[experiment.key]).to eq(alternative)
expect(ab_user[experiment.finished_key]).to eq(true)
end
end
context "finished with metric name" do
before { Split.configuration.experiments = {} }
before { expect(Split::Alternative).to receive(:new).at_least(1).times.and_call_original }
def should_finish_experiment(experiment_name, should_finish = true)
alts = Split.configuration.experiments[experiment_name][:alternatives]
experiment = Split::ExperimentCatalog.find_or_create(experiment_name, *alts)
alt_name = ab_user[experiment.key] = alts.first
alt = double("alternative")
expect(alt).to receive(:name).at_most(1).times.and_return(alt_name)
expect(Split::Alternative).to receive(:new).at_most(1).times.with(alt_name, experiment_name.to_s).and_return(alt)
if should_finish
expect(alt).to receive(:increment_completion).at_most(1).times
else
expect(alt).not_to receive(:increment_completion)
end
end
it "completes the test" do
Split.configuration.experiments[:my_experiment] = {
alternatives: [ "control_opt", "other_opt" ],
metric: :my_metric
}
should_finish_experiment :my_experiment
ab_finished :my_metric
end
it "completes all relevant tests" do
Split.configuration.experiments = {
exp_1: {
alternatives: [ "1-1", "1-2" ],
metric: :my_metric
},
exp_2: {
alternatives: [ "2-1", "2-2" ],
metric: :another_metric
},
exp_3: {
alternatives: [ "3-1", "3-2" ],
metric: :my_metric
},
}
should_finish_experiment :exp_1
should_finish_experiment :exp_2, false
should_finish_experiment :exp_3
ab_finished :my_metric
end
it "passes reset option" do
Split.configuration.experiments = {
my_exp: {
alternatives: ["one", "two"],
metric: :my_metric,
resettable: false,
}
}
alternative_name = ab_test(:my_exp)
exp = Split::ExperimentCatalog.find :my_exp
ab_finished :my_metric
expect(ab_user[exp.key]).to eq(alternative_name)
expect(ab_user[exp.finished_key]).to be_truthy
end
it "passes through options" do
Split.configuration.experiments = {
my_exp: {
alternatives: ["one", "two"],
metric: :my_metric,
}
}
alternative_name = ab_test(:my_exp)
exp = Split::ExperimentCatalog.find :my_exp
ab_finished :my_metric, reset: false
expect(ab_user[exp.key]).to eq(alternative_name)
expect(ab_user[exp.finished_key]).to be_truthy
end
end
describe "conversions" do
it "should return a conversion rate for an alternative" do
alternative_name = ab_test("link_color", "blue", "red")
previous_convertion_rate = Split::Alternative.new(alternative_name, "link_color").conversion_rate
expect(previous_convertion_rate).to eq(0.0)
ab_finished("link_color")
new_convertion_rate = Split::Alternative.new(alternative_name, "link_color").conversion_rate
expect(new_convertion_rate).to eq(1.0)
end
end
describe "active experiments" do
it "should show an active test" do
alternative = ab_test("def", "4", "5", "6")
expect(active_experiments.count).to eq 1
expect(active_experiments.first[0]).to eq "def"
expect(active_experiments.first[1]).to eq alternative
end
it "should show a finished test" do
alternative = ab_test("def", "4", "5", "6")
ab_finished("def", { reset: false })
expect(active_experiments.count).to eq 1
expect(active_experiments.first[0]).to eq "def"
expect(active_experiments.first[1]).to eq alternative
end
it "should show an active test when an experiment is on a later version" do
experiment.reset
expect(experiment.version).to eq(1)
ab_test("link_color", "blue", "red")
expect(active_experiments.count).to eq 1
expect(active_experiments.first[0]).to eq "link_color"
end
it "should show versioned tests properly" do
10.times { experiment.reset }
alternative = ab_test(experiment.name, "blue", "red")
ab_finished(experiment.name, reset: false)
expect(experiment.version).to eq(10)
expect(active_experiments.count).to eq 1
expect(active_experiments).to eq({ "link_color" => alternative })
end
it "should show multiple tests" do
Split.configure do |config|
config.allow_multiple_experiments = true
end
alternative = ab_test("def", "4", "5", "6")
another_alternative = ab_test("ghi", "7", "8", "9")
expect(active_experiments.count).to eq 2
expect(active_experiments["def"]).to eq alternative
expect(active_experiments["ghi"]).to eq another_alternative
end
it "should not show tests with winners" do
Split.configure do |config|
config.allow_multiple_experiments = true
end
e = Split::ExperimentCatalog.find_or_create("def", "4", "5", "6")
e.winner = "4"
ab_test("def", "4", "5", "6")
another_alternative = ab_test("ghi", "7", "8", "9")
expect(active_experiments.count).to eq 1
expect(active_experiments.first[0]).to eq "ghi"
expect(active_experiments.first[1]).to eq another_alternative
end
end
describe "when user is a robot" do
before(:each) do
@request = OpenStruct.new(user_agent: "Googlebot/2.1 (+http://www.google.com/bot.html)")
end
describe "ab_test" do
it "should return the control" do
alternative = ab_test("link_color", "blue", "red")
expect(alternative).to eq experiment.control.name
end
it "should not create a experiment" do
ab_test("link_color", "blue", "red")
expect(Split::Experiment.new("link_color")).to be_a_new_record
end
it "should not increment the participation count" do
previous_red_count = Split::Alternative.new("red", "link_color").participant_count
previous_blue_count = Split::Alternative.new("blue", "link_color").participant_count
ab_test("link_color", "blue", "red")
new_red_count = Split::Alternative.new("red", "link_color").participant_count
new_blue_count = Split::Alternative.new("blue", "link_color").participant_count
expect((new_red_count + new_blue_count)).to eq(previous_red_count + previous_blue_count)
end
end
describe "finished" do
it "should not increment the completed count" do
alternative_name = ab_test("link_color", "blue", "red")
previous_completion_count = Split::Alternative.new(alternative_name, "link_color").completed_count
ab_finished("link_color")
new_completion_count = Split::Alternative.new(alternative_name, "link_color").completed_count
expect(new_completion_count).to eq(previous_completion_count)
end
end
end
describe "when providing custom ignore logic" do
context "using a proc to configure custom logic" do
before(:each) do
Split.configure do |c|
c.ignore_filter = proc { |request| true } # ignore everything
end
end
it "ignores the ab_test" do
ab_test("link_color", "blue", "red")
red_count = Split::Alternative.new("red", "link_color").participant_count
blue_count = Split::Alternative.new("blue", "link_color").participant_count
expect((red_count + blue_count)).to be(0)
end
end
end
shared_examples_for "a disabled test" do
describe "ab_test" do
it "should return the control" do
alternative = ab_test("link_color", "blue", "red")
expect(alternative).to eq experiment.control.name
end
it "should not increment the participation count" do
previous_red_count = Split::Alternative.new("red", "link_color").participant_count
previous_blue_count = Split::Alternative.new("blue", "link_color").participant_count
ab_test("link_color", "blue", "red")
new_red_count = Split::Alternative.new("red", "link_color").participant_count
new_blue_count = Split::Alternative.new("blue", "link_color").participant_count
expect((new_red_count + new_blue_count)).to eq(previous_red_count + previous_blue_count)
end
end
describe "finished" do
it "should not increment the completed count" do
alternative_name = ab_test("link_color", "blue", "red")
previous_completion_count = Split::Alternative.new(alternative_name, "link_color").completed_count
ab_finished("link_color")
new_completion_count = Split::Alternative.new(alternative_name, "link_color").completed_count
expect(new_completion_count).to eq(previous_completion_count)
end
end
end
describe "when ip address is ignored" do
context "individually" do
before(:each) do
@request = OpenStruct.new(ip: "81.19.48.130")
Split.configure do |c|
c.ignore_ip_addresses << "81.19.48.130"
end
end
it_behaves_like "a disabled test"
end
context "for a range" do
before(:each) do
@request = OpenStruct.new(ip: "81.19.48.129")
Split.configure do |c|
c.ignore_ip_addresses << /81\.19\.48\.[0-9]+/
end
end
it_behaves_like "a disabled test"
end
context "using both a range and a specific value" do
before(:each) do
@request = OpenStruct.new(ip: "81.19.48.128")
Split.configure do |c|
c.ignore_ip_addresses << "81.19.48.130"
c.ignore_ip_addresses << /81\.19\.48\.[0-9]+/
end
end
it_behaves_like "a disabled test"
end
context "when ignored other address" do
before do
@request = OpenStruct.new(ip: "1.1.1.1")
Split.configure do |c|
c.ignore_ip_addresses << "81.19.48.130"
end
end
it "works as usual" do
alternative_name = ab_test("link_color", "red", "blue")
expect {
ab_finished("link_color")
}.to change(Split::Alternative.new(alternative_name, "link_color"), :completed_count).by(1)
end
end
end
describe "when user is previewing" do
before(:each) do
@request = OpenStruct.new(headers: { "x-purpose" => "preview" })
end
it_behaves_like "a disabled test"
end
describe "versioned experiments" do
it "should use version zero if no version is present" do
alternative_name = ab_test("link_color", "blue", "red")
expect(experiment.version).to eq(0)
expect(ab_user["link_color"]).to eq(alternative_name)
end
it "should save the version of the experiment to the session" do
experiment.reset
expect(experiment.version).to eq(1)
alternative_name = ab_test("link_color", "blue", "red")
expect(ab_user["link_color:1"]).to eq(alternative_name)
end
it "should load the experiment even if the version is not 0" do
experiment.reset
expect(experiment.version).to eq(1)
alternative_name = ab_test("link_color", "blue", "red")
expect(ab_user["link_color:1"]).to eq(alternative_name)
return_alternative_name = ab_test("link_color", "blue", "red")
expect(return_alternative_name).to eq(alternative_name)
end
it "should reset the session of a user on an older version of the experiment" do
alternative_name = ab_test("link_color", "blue", "red")
expect(ab_user["link_color"]).to eq(alternative_name)
alternative = Split::Alternative.new(alternative_name, "link_color")
expect(alternative.participant_count).to eq(1)
experiment.reset
expect(experiment.version).to eq(1)
alternative = Split::Alternative.new(alternative_name, "link_color")
expect(alternative.participant_count).to eq(0)
new_alternative_name = ab_test("link_color", "blue", "red")
expect(ab_user["link_color:1"]).to eq(new_alternative_name)
new_alternative = Split::Alternative.new(new_alternative_name, "link_color")
expect(new_alternative.participant_count).to eq(1)
end
it "should cleanup old versions of experiments from the session" do
alternative_name = ab_test("link_color", "blue", "red")
expect(ab_user["link_color"]).to eq(alternative_name)
alternative = Split::Alternative.new(alternative_name, "link_color")
expect(alternative.participant_count).to eq(1)
experiment.reset
expect(experiment.version).to eq(1)
alternative = Split::Alternative.new(alternative_name, "link_color")
expect(alternative.participant_count).to eq(0)
new_alternative_name = ab_test("link_color", "blue", "red")
expect(ab_user["link_color:1"]).to eq(new_alternative_name)
end
it "should only count completion of users on the current version" do
alternative_name = ab_test("link_color", "blue", "red")
expect(ab_user["link_color"]).to eq(alternative_name)
Split::Alternative.new(alternative_name, "link_color")
experiment.reset
expect(experiment.version).to eq(1)
ab_finished("link_color")
alternative = Split::Alternative.new(alternative_name, "link_color")
expect(alternative.completed_count).to eq(0)
end
end
context "when redis is not available" do
before(:each) do
expect(Split).to receive(:redis).at_most(5).times.and_raise(Errno::ECONNREFUSED.new)
end
context "and db_failover config option is turned off" do
before(:each) do
Split.configure do |config|
config.db_failover = false
end
end
describe "ab_test" do
it "should raise an exception" do
expect { ab_test("link_color", "blue", "red") }.to raise_error(Errno::ECONNREFUSED)
end
end
describe "finished" do
it "should raise an exception" do
expect { ab_finished("link_color") }.to raise_error(Errno::ECONNREFUSED)
end
end
describe "disable split testing" do
before(:each) do
Split.configure do |config|
config.enabled = false
end
end
it "should not attempt to connect to redis" do
expect { ab_test("link_color", "blue", "red") }.not_to raise_error
end
it "should return control variable" do
expect(ab_test("link_color", "blue", "red")).to eq("blue")
expect { ab_finished("link_color") }.not_to raise_error
end
end
end
context "and db_failover config option is turned on" do
before(:each) do
Split.configure do |config|
config.db_failover = true
end
end
describe "ab_test" do
it "should not raise an exception" do
expect { ab_test("link_color", "blue", "red") }.not_to raise_error
end
it "should call db_failover_on_db_error proc with error as parameter" do
Split.configure do |config|
config.db_failover_on_db_error = proc do |error|
expect(error).to be_a(Errno::ECONNREFUSED)
end
end
expect(Split.configuration.db_failover_on_db_error).to receive(:call).and_call_original
ab_test("link_color", "blue", "red")
end
it "should always use first alternative" do
expect(ab_test("link_color", "blue", "red")).to eq("blue")
expect(ab_test("link_color", { "blue" => 0.01 }, "red" => 0.2)).to eq("blue")
expect(ab_test("link_color", { "blue" => 0.8 }, { "red" => 20 })).to eq("blue")
expect(ab_test("link_color", "blue", "red") do |alternative|
"shared/#{alternative}"
end).to eq("shared/blue")
end
context "and db_failover_allow_parameter_override config option is turned on" do
before(:each) do
Split.configure do |config|
config.db_failover_allow_parameter_override = true
end
end
context "and given an override parameter" do
it "should use given override instead of the first alternative" do
@params = { "ab_test" => { "link_color" => "red" } }
expect(ab_test("link_color", "blue", "red")).to eq("red")
expect(ab_test("link_color", "blue", "red", "green")).to eq("red")
expect(ab_test("link_color", { "blue" => 0.01 }, "red" => 0.2)).to eq("red")
expect(ab_test("link_color", { "blue" => 0.8 }, { "red" => 20 })).to eq("red")
expect(ab_test("link_color", "blue", "red") do |alternative|
"shared/#{alternative}"
end).to eq("shared/red")
end
end
end
context "and preloaded config given" do
before do
Split.configuration.experiments[:link_color] = {
alternatives: [ "blue", "red" ],
}
end
it "uses first alternative" do
expect(ab_test(:link_color)).to eq("blue")
end
end
end
describe "finished" do
it "should not raise an exception" do
expect { ab_finished("link_color") }.not_to raise_error
end
it "should call db_failover_on_db_error proc with error as parameter" do
Split.configure do |config|
config.db_failover_on_db_error = proc do |error|
expect(error).to be_a(Errno::ECONNREFUSED)
end
end
expect(Split.configuration.db_failover_on_db_error).to receive(:call).and_call_original
ab_finished("link_color")
end
end
end
end
context "with preloaded config" do
before { Split.configuration.experiments = {} }
it "pulls options from config file" do
Split.configuration.experiments[:my_experiment] = {
alternatives: [ "control_opt", "other_opt" ],
goals: ["goal1", "goal2"]
}
ab_test :my_experiment
expect(Split::Experiment.new(:my_experiment).alternatives.map(&:name)).to eq([ "control_opt", "other_opt" ])
expect(Split::Experiment.new(:my_experiment).goals).to eq([ "goal1", "goal2" ])
end
it "can be called multiple times" do
Split.configuration.experiments[:my_experiment] = {
alternatives: [ "control_opt", "other_opt" ],
goals: ["goal1", "goal2"]
}
5.times { ab_test :my_experiment }
experiment = Split::Experiment.new(:my_experiment)
expect(experiment.alternatives.map(&:name)).to eq([ "control_opt", "other_opt" ])
expect(experiment.goals).to eq([ "goal1", "goal2" ])
expect(experiment.participant_count).to eq(1)
end
it "accepts multiple goals" do
Split.configuration.experiments[:my_experiment] = {
alternatives: [ "control_opt", "other_opt" ],
goals: [ "goal1", "goal2", "goal3" ]
}
ab_test :my_experiment
experiment = Split::Experiment.new(:my_experiment)
expect(experiment.goals).to eq([ "goal1", "goal2", "goal3" ])
end
it "allow specifying goals to be optional" do
Split.configuration.experiments[:my_experiment] = {
alternatives: [ "control_opt", "other_opt" ]
}
experiment = Split::Experiment.new(:my_experiment)
expect(experiment.goals).to eq([])
end
it "accepts multiple alternatives" do
Split.configuration.experiments[:my_experiment] = {
alternatives: [ "control_opt", "second_opt", "third_opt" ],
}
ab_test :my_experiment
experiment = Split::Experiment.new(:my_experiment)
expect(experiment.alternatives.map(&:name)).to eq([ "control_opt", "second_opt", "third_opt" ])
end
it "accepts probability on alternatives" do
Split.configuration.experiments[:my_experiment] = {
alternatives: [
{ name: "control_opt", percent: 67 },
{ name: "second_opt", percent: 10 },
{ name: "third_opt", percent: 23 },
],
}
ab_test :my_experiment
experiment = Split::Experiment.new(:my_experiment)
expect(experiment.alternatives.collect { |a| [a.name, a.weight] }).to eq([["control_opt", 0.67], ["second_opt", 0.1], ["third_opt", 0.23]])
end
it "accepts probability on some alternatives" do
Split.configuration.experiments[:my_experiment] = {
alternatives: [
{ name: "control_opt", percent: 34 },
"second_opt",
{ name: "third_opt", percent: 23 },
"fourth_opt",
],
}
ab_test :my_experiment
experiment = Split::Experiment.new(:my_experiment)
names_and_weights = experiment.alternatives.collect { |a| [a.name, a.weight] }
expect(names_and_weights).to eq([["control_opt", 0.34], ["second_opt", 0.215], ["third_opt", 0.23], ["fourth_opt", 0.215]])
expect(names_and_weights.inject(0) { |sum, nw| sum + nw[1] }).to eq(1.0)
end
it "allows name param without probability" do
Split.configuration.experiments[:my_experiment] = {
alternatives: [
{ name: "control_opt" },
"second_opt",
{ name: "third_opt", percent: 64 },
],
}
ab_test :my_experiment
experiment = Split::Experiment.new(:my_experiment)
names_and_weights = experiment.alternatives.collect { |a| [a.name, a.weight] }
expect(names_and_weights).to eq([["control_opt", 0.18], ["second_opt", 0.18], ["third_opt", 0.64]])
expect(names_and_weights.inject(0) { |sum, nw| sum + nw[1] }).to eq(1.0)
end
it "fails gracefully if config is missing experiment" do
Split.configuration.experiments = { other_experiment: { foo: "Bar" } }
expect { ab_test :my_experiment }.to raise_error(Split::ExperimentNotFound)
end
it "fails gracefully if config is missing" do
expect { Split.configuration.experiments = nil }.to raise_error(Split::InvalidExperimentsFormatError)
end
it "fails gracefully if config is missing alternatives" do
Split.configuration.experiments[:my_experiment] = { foo: "Bar" }
expect { ab_test :my_experiment }.to raise_error(NoMethodError)
end
end
it "should handle multiple experiments correctly" do
experiment2 = Split::ExperimentCatalog.find_or_create("link_color2", "blue", "red")
ab_test("link_color", "blue", "red")
ab_test("link_color2", "blue", "red")
ab_finished("link_color2")
experiment2.alternatives.each do |alt|
expect(alt.unfinished_count).to eq(0)
end
end
context "with goals" do
before do
@experiment = { "link_color" => ["purchase", "refund"] }
@alternatives = ["blue", "red"]
@experiment_name, @goals = normalize_metric(@experiment)
@goal1 = @goals[0]
@goal2 = @goals[1]
end
it "should normalize experiment" do
expect(@experiment_name).to eq("link_color")
expect(@goals).to eq(["purchase", "refund"])
end
describe "ab_test" do
it "should allow experiment goals interface as a single hash" do
ab_test(@experiment, *@alternatives)
experiment = Split::ExperimentCatalog.find("link_color")
expect(experiment.goals).to eq(["purchase", "refund"])
end
end
describe "ab_finished" do
before do
@alternative_name = ab_test(@experiment, *@alternatives)
end
it "should increment the counter for the specified-goal completed alternative" do
expect { ab_finished({ "link_color" => ["purchase"] }) }
.to change { Split::Alternative.new(@alternative_name, @experiment_name).completed_count(@goal2) }.by(0)
.and change { Split::Alternative.new(@alternative_name, @experiment_name).completed_count(@goal1) }.by(1)
end
end
end
end
<MSG> Added option to finished to not reset the users session
<DFF> @@ -83,6 +83,17 @@ describe Split::Helper do
finished('link_color')
session[:split].should == {}
end
+
+ it "should not clear out the users session if reset is false" do
+ experiment = Split::Experiment.find_or_create('link_color', 'blue', 'red')
+ alternative_name = ab_test('link_color', 'blue', 'red')
+
+ previous_completion_count = Split::Alternative.find(alternative_name, 'link_color').completed_count
+
+ session[:split].should eql("link_color" => alternative_name)
+ finished('link_color', :reset => false)
+ session[:split].should eql("link_color" => alternative_name)
+ end
end
describe 'conversions' do
| 11 | Added option to finished to not reset the users session | 0 | .rb | rb | mit | splitrb/split |
10072398 | <NME> users.py
<BEF> ADDFILE
<MSG> Merge branch 'master' of git://github.com/ask/chishop
<DFF> @@ -0,0 +1,24 @@
+from django.http import HttpResponse, HttpResponseBadRequest
+
+from registration.forms import RegistrationForm
+from registration.backends import get_backend
+
+DEFAULT_BACKEND = "registration.backends.default.DefaultBackend"
+
+
+def create_user(request, post_data, files, backend_name=DEFAULT_BACKEND):
+ """Create new user from a distutil client request"""
+ form = RegistrationForm({"username": post_data["name"],
+ "email": post_data["email"],
+ "password1": post_data["password"],
+ "password2": post_data["password"]})
+ if not form.is_valid():
+ # Dist Utils requires error msg in HTTP status: "HTTP/1.1 400 msg"
+ # Which is HTTP/WSGI incompatible, so we're just returning a empty 400.
+ return HttpResponseBadRequest()
+
+ backend = get_backend(backend_name)
+ if not backend.registration_allowed(request):
+ return HttpResponseBadRequest()
+ new_user = backend.register(request, **form.cleaned_data)
+ return HttpResponse("OK\n", status=200, mimetype='text/plain')
| 24 | Merge branch 'master' of git://github.com/ask/chishop | 0 | .py | py | bsd-3-clause | ask/chishop |
10072399 | <NME> Changes
<BEF> ADDFILE
<MSG> Wrote change history for 0.2.0 in the Changelog
<DFF> @@ -0,0 +1,41 @@
+==============
+Change history
+==============
+
+0.2.0 :date:`2009-03-22 1:21 A.M CET` :author:[email protected]
+--------------------------------------------------------------
+
+ Backwards incompatible changes
+ -------------------------------
+
+ * Projects now has an associated owner, so old projects
+ must be exported and imported to a new database.
+
+ * Registering projects and uploading releases now requires
+ authentication. Use the admin interface to create new users,
+ registering users via distutils won't be available until
+ :version:`0.3.0`.
+
+ * Every project now has an owner, so only the user registering the
+ project can add releases.
+
+ * md5sum is now properly listed in the release link.
+
+ * Project names can now have dots (`.`) in them.
+
+ * Fixed a bug where filenames was mangled if the distribution file
+ already existed. If someone uploaded version `1.0` of project `grail`
+ twice, the new filename was renamed to `grail-1.0.tar_.gz`, and a
+ backup of the old release was kept. Pip couldn't handle these filenames,
+ so we delete the old release first.
+
+ * Releases now list both project name and version, instead of just version
+ in the admin interface.
+
+ * Added a sample buildout.cfg. Thanks to Rune Halvorsen ([email protected]).
+
+
+0.1.0 :date:`2009-03-22 1:21 A.M CET` :author:[email protected]
+--------------------------------------------------------------
+
+ * Initial release
| 41 | Wrote change history for 0.2.0 in the Changelog | 0 | Changes | bsd-3-clause | ask/chishop |
|
10072400 | <NME> expand.ts
<BEF> import { strictEqual as equal } from 'assert';
import expand, { resolveConfig } from '../src';
describe('Expand Abbreviation', () => {
describe('Markup', () => {
it('basic', () => {
equal(expand('input[value="text$"]*2'), '<input type="text" value="text1"><input type="text" value="text2">');
equal(expand('ul>.item$*2'), '<ul>\n\t<li class="item1"></li>\n\t<li class="item2"></li>\n</ul>');
// insert text into abbreviation
equal(expand('ul>.item$*', { text: ['foo', 'bar'] }), '<ul>\n\t<li class="item1">foo</li>\n\t<li class="item2">bar</li>\n</ul>');
// insert TextMate-style fields/tabstops in output
equal(expand('ul>.item$*2', {
options: {
'output.field': (index, placeholder) => `\${${index}${placeholder ? ':' + placeholder : ''}}`
}
}), '<ul>\n\t<li class="item1">${1}</li>\n\t<li class="item2">${2}</li>\n</ul>');
});
it('attributes', () => {
const snippets = {
test: 'test[!foo bar. baz={}]'
};
const opt = { snippets };
const reverse = {
options: { 'output.reverseAttributes': true },
snippets
};
equal(expand('a.test'), '<a href="" class="test"></a>');
equal(expand('a.test', reverse), '<a class="test" href=""></a>');
equal(expand('test', opt), '<test bar="bar" baz={}></test>');
equal(expand('test[foo]', opt), '<test bar="bar" baz={}></test>');
equal(expand('test[baz=a foo=1]', opt), '<test foo="1" bar="bar" baz={a}></test>');
equal(expand('map'), '<map name=""></map>');
equal(expand('map[]'), '<map name=""></map>');
equal(expand('test[baz=a foo=1]', reverse), '<test baz={a} foo="1" bar="bar"></test>');
});
it('syntax', () => {
equal(expand('ul>.item$*2', { syntax: 'html' }), '<ul>\n\t<li class="item1"></li>\n\t<li class="item2"></li>\n</ul>');
equal(expand('ul>.item$*2', { syntax: 'slim' }), 'ul\n\tli.item1 \n\tli.item2 ');
equal(expand('ul>li.item$@-*5'), '<ul>\n\t<li class="item5"></li>\n\t<li class="item4"></li>\n\t<li class="item3"></li>\n\t<li class="item2"></li>\n\t<li class="item1"></li>\n</ul>');
});
it('syntax', () => {
equal(expand('ul>.item$*2', { syntax: 'html' }), '<ul>\n\t<li class="item1"></li>\n\t<li class="item2"></li>\n</ul>');
equal(expand('ul>.item$*2', { syntax: 'slim' }), 'ul\n\tli.item1 \n\tli.item2 ');
equal(expand('xsl:variable[name=a select=b]>div', { syntax: 'xsl' }), '<xsl:variable name="a">\n\t<div></div>\n</xsl:variable>');
});
it('custom profile', () => {
equal(expand('img'), '<img src="" alt="">');
equal(expand('img', { options: { 'output.selfClosingStyle': 'xhtml' } }), '<img src="" alt="" />');
});
it('custom variables', () => {
const variables = { charset: 'ru-RU' };
equal(expand('[charset=${charset}]{${charset}}'), '<div charset="UTF-8">UTF-8</div>');
equal(expand('[charset=${charset}]{${charset}}', { variables }), '<div charset="ru-RU">ru-RU</div>');
});
it('custom snippets', () => {
const snippets = {
link: 'link[foo=bar href]/',
foo: '.foo[bar=baz]',
repeat: 'div>ul>li{Hello World}*3'
};
equal(expand('foo', { snippets }), '<div class="foo" bar="baz"></div>');
// `link:css` depends on `link` snippet so changing it will result in
// altered `link:css` result
equal(expand('link:css'), '<link rel="stylesheet" href="style.css">');
equal(expand('link:css', { snippets }), '<link foo="bar" href="style.css">');
// https://github.com/emmetio/emmet/issues/468
equal(expand('repeat', { snippets }), '<div>\n\t<ul>\n\t\t<li>Hello World</li>\n\t\t<li>Hello World</li>\n\t\t<li>Hello World</li>\n\t</ul>\n</div>');
});
it('formatter options', () => {
equal(expand('ul>.item$*2'), '<ul>\n\t<li class="item1"></li>\n\t<li class="item2"></li>\n</ul>');
equal(expand('ul>.item$*2', { options: { 'comment.enabled': true } }),
'<ul>\n\t<li class="item1"></li>\n\t<!-- /.item1 -->\n\t<li class="item2"></li>\n\t<!-- /.item2 -->\n</ul>');
equal(expand('div>p'), '<div>\n\t<p></p>\n</div>');
equal(expand('div>p', { options: { 'output.formatLeafNode': true } }), '<div>\n\t<p>\n\t\t\n\t</p>\n</div>');
});
it('JSX', () => {
const config = { syntax: 'jsx' };
equal(expand('div#foo.bar', config), '<div id="foo" className="bar"></div>');
equal(expand('label[for=a]', config), '<label htmlFor="a"></label>');
equal(expand('Foo.Bar', config), '<Foo.Bar></Foo.Bar>');
equal(expand('div.{theme.style}', config), '<div className={theme.style}></div>');
});
it('override attributes', () => {
const config = { syntax: 'jsx' };
equal(expand('.bar', config), '<div className="bar"></div>');
equal(expand('..bar', config), '<div styleName={styles.bar}></div>');
equal(expand('..foo-bar', config), '<div styleName={styles[\'foo-bar\']}></div>');
equal(expand('.foo', { syntax: 'vue' }), '<div class="foo"></div>');
equal(expand('..foo', { syntax: 'vue' }), '<div :class="foo"></div>');
});
it('wrap with abbreviation', () => {
equal(expand('div>ul', { text: ['<div>line1</div>\n<div>line2</div>'] }),
'<div>\n\t<ul>\n\t\t<div>line1</div>\n\t\t<div>line2</div>\n\t</ul>\n</div>');
equal(expand('p', { text: 'foo\nbar' }), '<p>\n\tfoo\n\tbar\n</p>');
equal(expand('p', { text: '<div>foo</div>' }), '<p>\n\t<div>foo</div>\n</p>');
equal(expand('p', { text: '<span>foo</span>' }), '<p><span>foo</span></p>');
equal(expand('p', { text: 'foo<span>foo</span>' }), '<p>foo<span>foo</span></p>');
equal(expand('p', { text: 'foo<div>foo</div>' }), '<p>foo<div>foo</div></p>');
});
it('wrap with abbreviation href', () => {
equal(expand('a', { text: ['www.google.it'] }), '<a href="http://www.google.it">www.google.it</a>');
equal(expand('a', { text: ['then www.google.it'] }), '<a href="">then www.google.it</a>');
equal(expand('a', { text: ['www.google.it'], options: { 'markup.href': false } }), '<a href="">www.google.it</a>');
equal(expand('map[name="https://example.com"]', { text: ['some text'] }),
'<map name="https://example.com">some text</map>');
equal(expand('map[href="https://example.com"]', { text: ['some text'] }),
'<map name="" href="https://example.com">some text</map>');
equal(expand('map[name="https://example.com"]>b', { text: ['some text'] }),
'<map name="https://example.com"><b>some text</b></map>');
equal(expand('a[href="https://example.com"]>b', { text: ['<u>some text false</u>'], options: { 'markup.href': false } }),
'<a href="https://example.com"><b><u>some text false</u></b></a>');
equal(expand('a[href="https://example.com"]>b', { text: ['<u>some text true</u>'], options: { 'markup.href': true } }),
'<a href="https://example.com"><b><u>some text true</u></b></a>');
equal(expand('a[href="https://example.com"]>div', { text: ['<p>some text false</p>'], options: { 'markup.href': false } }),
'<a href="https://example.com">\n\t<div>\n\t\t<p>some text false</p>\n\t</div>\n</a>');
equal(expand('a[href="https://example.com"]>div', { text: ['<p>some text true</p>'], options: { 'markup.href': true } }),
'<a href="https://example.com">\n\t<div>\n\t\t<p>some text true</p>\n\t</div>\n</a>');
});
// it.only('debug', () => {
// equal(expand('link:css'), '<link rel="stylesheet" href="style.css">');
// });
});
describe('Pug templates', () => {
const config = resolveConfig({ syntax: 'pug' });
it('basic', () => {
equal(expand('!', config), 'doctype html\nhtml(lang="en")\n\thead\n\t\tmeta(charset="UTF-8")\n\t\tmeta(http-equiv="X-UA-Compatible", content="IE=edge")\n\t\tmeta(name="viewport", content="width=device-width, initial-scale=1.0")\n\t\ttitle Document\n\tbody ');
});
});
});
<MSG> Fixed reversed numbering
<DFF> @@ -40,6 +40,10 @@ describe('Expand Abbreviation', () => {
equal(expand('test[baz=a foo=1]', reverse), '<test baz={a} foo="1" bar="bar"></test>');
});
+ it('numbering', () => {
+ equal(expand('ul>li.item$@-*5'), '<ul>\n\t<li class="item5"></li>\n\t<li class="item4"></li>\n\t<li class="item3"></li>\n\t<li class="item2"></li>\n\t<li class="item1"></li>\n</ul>');
+ });
+
it('syntax', () => {
equal(expand('ul>.item$*2', { syntax: 'html' }), '<ul>\n\t<li class="item1"></li>\n\t<li class="item2"></li>\n</ul>');
equal(expand('ul>.item$*2', { syntax: 'slim' }), 'ul\n\tli.item1 \n\tli.item2 ');
| 4 | Fixed reversed numbering | 0 | .ts | ts | mit | emmetio/emmet |
10072401 | <NME> expand.ts
<BEF> import { strictEqual as equal } from 'assert';
import expand, { resolveConfig } from '../src';
describe('Expand Abbreviation', () => {
describe('Markup', () => {
it('basic', () => {
equal(expand('input[value="text$"]*2'), '<input type="text" value="text1"><input type="text" value="text2">');
equal(expand('ul>.item$*2'), '<ul>\n\t<li class="item1"></li>\n\t<li class="item2"></li>\n</ul>');
// insert text into abbreviation
equal(expand('ul>.item$*', { text: ['foo', 'bar'] }), '<ul>\n\t<li class="item1">foo</li>\n\t<li class="item2">bar</li>\n</ul>');
// insert TextMate-style fields/tabstops in output
equal(expand('ul>.item$*2', {
options: {
'output.field': (index, placeholder) => `\${${index}${placeholder ? ':' + placeholder : ''}}`
}
}), '<ul>\n\t<li class="item1">${1}</li>\n\t<li class="item2">${2}</li>\n</ul>');
});
it('attributes', () => {
const snippets = {
test: 'test[!foo bar. baz={}]'
};
const opt = { snippets };
const reverse = {
options: { 'output.reverseAttributes': true },
snippets
};
equal(expand('a.test'), '<a href="" class="test"></a>');
equal(expand('a.test', reverse), '<a class="test" href=""></a>');
equal(expand('test', opt), '<test bar="bar" baz={}></test>');
equal(expand('test[foo]', opt), '<test bar="bar" baz={}></test>');
equal(expand('test[baz=a foo=1]', opt), '<test foo="1" bar="bar" baz={a}></test>');
equal(expand('map'), '<map name=""></map>');
equal(expand('map[]'), '<map name=""></map>');
equal(expand('test[baz=a foo=1]', reverse), '<test baz={a} foo="1" bar="bar"></test>');
});
it('syntax', () => {
equal(expand('ul>.item$*2', { syntax: 'html' }), '<ul>\n\t<li class="item1"></li>\n\t<li class="item2"></li>\n</ul>');
equal(expand('ul>.item$*2', { syntax: 'slim' }), 'ul\n\tli.item1 \n\tli.item2 ');
equal(expand('ul>li.item$@-*5'), '<ul>\n\t<li class="item5"></li>\n\t<li class="item4"></li>\n\t<li class="item3"></li>\n\t<li class="item2"></li>\n\t<li class="item1"></li>\n</ul>');
});
it('syntax', () => {
equal(expand('ul>.item$*2', { syntax: 'html' }), '<ul>\n\t<li class="item1"></li>\n\t<li class="item2"></li>\n</ul>');
equal(expand('ul>.item$*2', { syntax: 'slim' }), 'ul\n\tli.item1 \n\tli.item2 ');
equal(expand('xsl:variable[name=a select=b]>div', { syntax: 'xsl' }), '<xsl:variable name="a">\n\t<div></div>\n</xsl:variable>');
});
it('custom profile', () => {
equal(expand('img'), '<img src="" alt="">');
equal(expand('img', { options: { 'output.selfClosingStyle': 'xhtml' } }), '<img src="" alt="" />');
});
it('custom variables', () => {
const variables = { charset: 'ru-RU' };
equal(expand('[charset=${charset}]{${charset}}'), '<div charset="UTF-8">UTF-8</div>');
equal(expand('[charset=${charset}]{${charset}}', { variables }), '<div charset="ru-RU">ru-RU</div>');
});
it('custom snippets', () => {
const snippets = {
link: 'link[foo=bar href]/',
foo: '.foo[bar=baz]',
repeat: 'div>ul>li{Hello World}*3'
};
equal(expand('foo', { snippets }), '<div class="foo" bar="baz"></div>');
// `link:css` depends on `link` snippet so changing it will result in
// altered `link:css` result
equal(expand('link:css'), '<link rel="stylesheet" href="style.css">');
equal(expand('link:css', { snippets }), '<link foo="bar" href="style.css">');
// https://github.com/emmetio/emmet/issues/468
equal(expand('repeat', { snippets }), '<div>\n\t<ul>\n\t\t<li>Hello World</li>\n\t\t<li>Hello World</li>\n\t\t<li>Hello World</li>\n\t</ul>\n</div>');
});
it('formatter options', () => {
equal(expand('ul>.item$*2'), '<ul>\n\t<li class="item1"></li>\n\t<li class="item2"></li>\n</ul>');
equal(expand('ul>.item$*2', { options: { 'comment.enabled': true } }),
'<ul>\n\t<li class="item1"></li>\n\t<!-- /.item1 -->\n\t<li class="item2"></li>\n\t<!-- /.item2 -->\n</ul>');
equal(expand('div>p'), '<div>\n\t<p></p>\n</div>');
equal(expand('div>p', { options: { 'output.formatLeafNode': true } }), '<div>\n\t<p>\n\t\t\n\t</p>\n</div>');
});
it('JSX', () => {
const config = { syntax: 'jsx' };
equal(expand('div#foo.bar', config), '<div id="foo" className="bar"></div>');
equal(expand('label[for=a]', config), '<label htmlFor="a"></label>');
equal(expand('Foo.Bar', config), '<Foo.Bar></Foo.Bar>');
equal(expand('div.{theme.style}', config), '<div className={theme.style}></div>');
});
it('override attributes', () => {
const config = { syntax: 'jsx' };
equal(expand('.bar', config), '<div className="bar"></div>');
equal(expand('..bar', config), '<div styleName={styles.bar}></div>');
equal(expand('..foo-bar', config), '<div styleName={styles[\'foo-bar\']}></div>');
equal(expand('.foo', { syntax: 'vue' }), '<div class="foo"></div>');
equal(expand('..foo', { syntax: 'vue' }), '<div :class="foo"></div>');
});
it('wrap with abbreviation', () => {
equal(expand('div>ul', { text: ['<div>line1</div>\n<div>line2</div>'] }),
'<div>\n\t<ul>\n\t\t<div>line1</div>\n\t\t<div>line2</div>\n\t</ul>\n</div>');
equal(expand('p', { text: 'foo\nbar' }), '<p>\n\tfoo\n\tbar\n</p>');
equal(expand('p', { text: '<div>foo</div>' }), '<p>\n\t<div>foo</div>\n</p>');
equal(expand('p', { text: '<span>foo</span>' }), '<p><span>foo</span></p>');
equal(expand('p', { text: 'foo<span>foo</span>' }), '<p>foo<span>foo</span></p>');
equal(expand('p', { text: 'foo<div>foo</div>' }), '<p>foo<div>foo</div></p>');
});
it('wrap with abbreviation href', () => {
equal(expand('a', { text: ['www.google.it'] }), '<a href="http://www.google.it">www.google.it</a>');
equal(expand('a', { text: ['then www.google.it'] }), '<a href="">then www.google.it</a>');
equal(expand('a', { text: ['www.google.it'], options: { 'markup.href': false } }), '<a href="">www.google.it</a>');
equal(expand('map[name="https://example.com"]', { text: ['some text'] }),
'<map name="https://example.com">some text</map>');
equal(expand('map[href="https://example.com"]', { text: ['some text'] }),
'<map name="" href="https://example.com">some text</map>');
equal(expand('map[name="https://example.com"]>b', { text: ['some text'] }),
'<map name="https://example.com"><b>some text</b></map>');
equal(expand('a[href="https://example.com"]>b', { text: ['<u>some text false</u>'], options: { 'markup.href': false } }),
'<a href="https://example.com"><b><u>some text false</u></b></a>');
equal(expand('a[href="https://example.com"]>b', { text: ['<u>some text true</u>'], options: { 'markup.href': true } }),
'<a href="https://example.com"><b><u>some text true</u></b></a>');
equal(expand('a[href="https://example.com"]>div', { text: ['<p>some text false</p>'], options: { 'markup.href': false } }),
'<a href="https://example.com">\n\t<div>\n\t\t<p>some text false</p>\n\t</div>\n</a>');
equal(expand('a[href="https://example.com"]>div', { text: ['<p>some text true</p>'], options: { 'markup.href': true } }),
'<a href="https://example.com">\n\t<div>\n\t\t<p>some text true</p>\n\t</div>\n</a>');
});
// it.only('debug', () => {
// equal(expand('link:css'), '<link rel="stylesheet" href="style.css">');
// });
});
describe('Pug templates', () => {
const config = resolveConfig({ syntax: 'pug' });
it('basic', () => {
equal(expand('!', config), 'doctype html\nhtml(lang="en")\n\thead\n\t\tmeta(charset="UTF-8")\n\t\tmeta(http-equiv="X-UA-Compatible", content="IE=edge")\n\t\tmeta(name="viewport", content="width=device-width, initial-scale=1.0")\n\t\ttitle Document\n\tbody ');
});
});
});
<MSG> Fixed reversed numbering
<DFF> @@ -40,6 +40,10 @@ describe('Expand Abbreviation', () => {
equal(expand('test[baz=a foo=1]', reverse), '<test baz={a} foo="1" bar="bar"></test>');
});
+ it('numbering', () => {
+ equal(expand('ul>li.item$@-*5'), '<ul>\n\t<li class="item5"></li>\n\t<li class="item4"></li>\n\t<li class="item3"></li>\n\t<li class="item2"></li>\n\t<li class="item1"></li>\n</ul>');
+ });
+
it('syntax', () => {
equal(expand('ul>.item$*2', { syntax: 'html' }), '<ul>\n\t<li class="item1"></li>\n\t<li class="item2"></li>\n</ul>');
equal(expand('ul>.item$*2', { syntax: 'slim' }), 'ul\n\tli.item1 \n\tli.item2 ');
| 4 | Fixed reversed numbering | 0 | .ts | ts | mit | emmetio/emmet |
10072402 | <NME> configuration.rb
<BEF> module Split
class Configuration
BOTS = {
# Indexers
"AdsBot-Google" => 'Google Adwords',
'Baidu' => 'Chinese search engine',
'Gigabot' => 'Gigabot spider',
'Googlebot' => 'Google spider',
'msnbot' => 'Microsoft bot',
'bingbot' => 'Microsoft bing bot',
'rogerbot' => 'SeoMoz spider',
'Slurp' => 'Yahoo spider',
'Sogou' => 'Chinese search engine',
"spider" => 'generic web spider',
'WordPress' => 'WordPress spider',
'ZIBB' => 'ZIBB spider',
'YandexBot' => 'Yandex spider',
# HTTP libraries
'Apache-HttpClient' => 'Java http library',
'AppEngine-Google' => 'Google App Engine',
"curl" => 'curl unix CLI http client',
'ColdFusion' => 'ColdFusion http library',
"EventMachine HttpClient" => 'Ruby http library',
"Go http package" => 'Go http library',
'Java' => 'Generic Java http library',
'libwww-perl' => 'Perl client-server library loved by script kids',
'lwp-trivial' => 'Another Perl library loved by script kids',
"Python-urllib" => 'Python http library',
"PycURL" => 'Python http library',
"Test Certificate Info" => 'C http library?',
"Wget" => 'wget unix CLI http client',
# URL expanders / previewers
'awe.sm' => 'Awe.sm URL expander',
"bitlybot" => 'bit.ly bot',
"facebookexternalhit" => 'facebook bot',
'LongURL' => 'URL expander service',
'Twitterbot' => 'Twitter URL expander',
'UnwindFetch' => 'Gnip URL expander',
# Uptime monitoring
'check_http' => 'Nagios monitor',
'NewRelicPinger' => 'NewRelic monitor',
'Panopta' => 'Monitoring service',
"Pingdom" => 'Pingdom monitoring',
'SiteUptime' => 'Site monitoring services',
# ???
"DigitalPersona Fingerprint Software" => 'HP Fingerprint scanner',
"ShowyouBot" => 'Showyou iOS app spider',
'ZyBorg' => 'Zyborg? Hmmm....',
}
attr_accessor :robot_regex
attr_accessor :ignore_ip_addresses
attr_accessor :db_failover
attr_accessor :db_failover
attr_accessor :db_failover_on_db_error
attr_accessor :db_failover_allow_parameter_override
attr_accessor :allow_multiple_experiments
attr_accessor :enabled
attr_accessor :persistence
attr_accessor :algorithm
def disabled?
!enabled
end
"EventMachine HttpClient" => "Ruby http library",
"Go http package" => "Go http library",
"Go-http-client" => "Go http library",
"Java" => "Generic Java http library",
"libwww-perl" => "Perl client-server library loved by script kids",
"lwp-trivial" => "Another Perl library loved by script kids",
"Python-urllib" => "Python http library",
"PycURL" => "Python http library",
"Test Certificate Info" => "C http library?",
"Typhoeus" => "Ruby http library",
"Wget" => "wget unix CLI http client",
# URL expanders / previewers
"awe.sm" => "Awe.sm URL expander",
"bitlybot" => "bit.ly bot",
"[email protected]" => "Linkfluence bot",
"facebookexternalhit" => "facebook bot",
"Facebot" => "Facebook crawler",
"Feedfetcher-Google" => "Google Feedfetcher",
"https://developers.google.com/+/web/snippet" => "Google+ Snippet Fetcher",
"LinkedInBot" => "LinkedIn bot",
"LongURL" => "URL expander service",
"NING" => "NING - Yet Another Twitter Swarmer",
"Pinterestbot" => "Pinterest Bot",
"redditbot" => "Reddit Bot",
"ShortLinkTranslate" => "Link shortener",
"Slackbot" => "Slackbot link expander",
"TweetmemeBot" => "TweetMeMe Crawler",
"Twitterbot" => "Twitter URL expander",
"UnwindFetch" => "Gnip URL expander",
"vkShare" => "VKontake Sharer",
# Uptime monitoring
"check_http" => "Nagios monitor",
"GoogleStackdriverMonitoring" => "Google Cloud monitor",
"NewRelicPinger" => "NewRelic monitor",
"Panopta" => "Monitoring service",
"Pingdom" => "Pingdom monitoring",
"SiteUptime" => "Site monitoring services",
"UptimeRobot" => "Monitoring service",
# ???
"DigitalPersona Fingerprint Software" => "HP Fingerprint scanner",
"ShowyouBot" => "Showyou iOS app spider",
"ZyBorg" => "Zyborg? Hmmm....",
"ELB-HealthChecker" => "ELB Health Check"
}
end
def experiments=(experiments)
raise InvalidExperimentsFormatError.new("Experiments must be a Hash") unless experiments.respond_to?(:keys)
@experiments = experiments
end
def disabled?
!enabled
end
def experiment_for(name)
if normalized_experiments
# TODO symbols
normalized_experiments[name.to_sym]
end
end
def metrics
return @metrics if defined?(@metrics)
@metrics = {}
if self.experiments
self.experiments.each do |key, value|
metrics = value_for(value, :metric) rescue nil
Array(metrics).each do |metric_name|
if metric_name
@metrics[metric_name.to_sym] ||= []
end
end
def initialize
@robot_regex = /\b(?:#{escaped_bots.join('|')})\b|\A\W*\z/i
@ignore_ip_addresses = []
@db_failover = false
@db_failover_on_db_error = proc{|error|} # e.g. use Rails logger here
experiment_config = {}
@experiments.keys.each do |name|
experiment_config[name.to_sym] = {}
end
@experiments.each do |experiment_name, settings|
alternatives = if (alts = value_for(settings, :alternatives))
normalize_alternatives(alts)
end
experiment_data = {
alternatives: alternatives,
goals: value_for(settings, :goals),
metadata: value_for(settings, :metadata),
end
def escaped_bots
BOTS.map { |key, _| Regexp.escape(key) }
end
end
end
end
experiment_config
end
def normalize_alternatives(alternatives)
given_probability, num_with_probability = alternatives.inject([0, 0]) do |a, v|
p, n = a
if percent = value_for(v, :percent)
[p + percent, n + 1]
else
a
end
end
num_without_probability = alternatives.length - num_with_probability
unassigned_probability = ((100.0 - given_probability) / num_without_probability / 100.0)
if num_with_probability.nonzero?
alternatives = alternatives.map do |v|
if (name = value_for(v, :name)) && (percent = value_for(v, :percent))
{ name => percent / 100.0 }
elsif name = value_for(v, :name)
{ name => unassigned_probability }
else
{ v => unassigned_probability }
end
end
[alternatives.shift, alternatives]
else
alternatives = alternatives.dup
[alternatives.shift, alternatives]
end
end
def robot_regex
@robot_regex ||= /\b(?:#{escaped_bots.join('|')})\b|\A\W*\z/i
end
def initialize
@ignore_ip_addresses = []
@ignore_filter = proc { |request| is_robot? || is_ignored_ip_address? }
@db_failover = false
@db_failover_on_db_error = proc { |error| } # e.g. use Rails logger here
@on_experiment_reset = proc { |experiment| }
@on_experiment_delete = proc { |experiment| }
@on_before_experiment_reset = proc { |experiment| }
@on_before_experiment_delete = proc { |experiment| }
@on_experiment_winner_choose = proc { |experiment| }
@db_failover_allow_parameter_override = false
@allow_multiple_experiments = false
@enabled = true
@experiments = {}
@persistence = Split::Persistence::SessionAdapter
@persistence_cookie_length = 31536000 # One year from now
@persistence_cookie_domain = nil
@algorithm = Split::Algorithms::WeightedSample
@include_rails_helper = true
@beta_probability_simulations = 10000
@winning_alternative_recalculation_interval = 60 * 60 * 24 # 1 day
@redis = ENV.fetch(ENV.fetch("REDIS_PROVIDER", "REDIS_URL"), "redis://localhost:6379")
@dashboard_pagination_default_per_page = 10
end
private
def value_for(hash, key)
if hash.kind_of?(Hash)
hash.has_key?(key.to_s) ? hash[key.to_s] : hash[key.to_sym]
end
end
def escaped_bots
bots.map { |key, _| Regexp.escape(key) }
end
end
end
<MSG> expose bots hash from config
<DFF> @@ -1,52 +1,6 @@
module Split
class Configuration
- BOTS = {
- # Indexers
- "AdsBot-Google" => 'Google Adwords',
- 'Baidu' => 'Chinese search engine',
- 'Gigabot' => 'Gigabot spider',
- 'Googlebot' => 'Google spider',
- 'msnbot' => 'Microsoft bot',
- 'bingbot' => 'Microsoft bing bot',
- 'rogerbot' => 'SeoMoz spider',
- 'Slurp' => 'Yahoo spider',
- 'Sogou' => 'Chinese search engine',
- "spider" => 'generic web spider',
- 'WordPress' => 'WordPress spider',
- 'ZIBB' => 'ZIBB spider',
- 'YandexBot' => 'Yandex spider',
- # HTTP libraries
- 'Apache-HttpClient' => 'Java http library',
- 'AppEngine-Google' => 'Google App Engine',
- "curl" => 'curl unix CLI http client',
- 'ColdFusion' => 'ColdFusion http library',
- "EventMachine HttpClient" => 'Ruby http library',
- "Go http package" => 'Go http library',
- 'Java' => 'Generic Java http library',
- 'libwww-perl' => 'Perl client-server library loved by script kids',
- 'lwp-trivial' => 'Another Perl library loved by script kids',
- "Python-urllib" => 'Python http library',
- "PycURL" => 'Python http library',
- "Test Certificate Info" => 'C http library?',
- "Wget" => 'wget unix CLI http client',
- # URL expanders / previewers
- 'awe.sm' => 'Awe.sm URL expander',
- "bitlybot" => 'bit.ly bot',
- "facebookexternalhit" => 'facebook bot',
- 'LongURL' => 'URL expander service',
- 'Twitterbot' => 'Twitter URL expander',
- 'UnwindFetch' => 'Gnip URL expander',
- # Uptime monitoring
- 'check_http' => 'Nagios monitor',
- 'NewRelicPinger' => 'NewRelic monitor',
- 'Panopta' => 'Monitoring service',
- "Pingdom" => 'Pingdom monitoring',
- 'SiteUptime' => 'Site monitoring services',
- # ???
- "DigitalPersona Fingerprint Software" => 'HP Fingerprint scanner',
- "ShowyouBot" => 'Showyou iOS app spider',
- 'ZyBorg' => 'Zyborg? Hmmm....',
- }
+ attr_accessor :bots
attr_accessor :robot_regex
attr_accessor :ignore_ip_addresses
attr_accessor :db_failover
@@ -58,6 +12,56 @@ module Split
attr_accessor :persistence
attr_accessor :algorithm
+ def bots
+ @bots ||= {
+ # Indexers
+ "AdsBot-Google" => 'Google Adwords',
+ 'Baidu' => 'Chinese search engine',
+ 'Gigabot' => 'Gigabot spider',
+ 'Googlebot' => 'Google spider',
+ 'msnbot' => 'Microsoft bot',
+ 'bingbot' => 'Microsoft bing bot',
+ 'rogerbot' => 'SeoMoz spider',
+ 'Slurp' => 'Yahoo spider',
+ 'Sogou' => 'Chinese search engine',
+ "spider" => 'generic web spider',
+ 'WordPress' => 'WordPress spider',
+ 'ZIBB' => 'ZIBB spider',
+ 'YandexBot' => 'Yandex spider',
+ # HTTP libraries
+ 'Apache-HttpClient' => 'Java http library',
+ 'AppEngine-Google' => 'Google App Engine',
+ "curl" => 'curl unix CLI http client',
+ 'ColdFusion' => 'ColdFusion http library',
+ "EventMachine HttpClient" => 'Ruby http library',
+ "Go http package" => 'Go http library',
+ 'Java' => 'Generic Java http library',
+ 'libwww-perl' => 'Perl client-server library loved by script kids',
+ 'lwp-trivial' => 'Another Perl library loved by script kids',
+ "Python-urllib" => 'Python http library',
+ "PycURL" => 'Python http library',
+ "Test Certificate Info" => 'C http library?',
+ "Wget" => 'wget unix CLI http client',
+ # URL expanders / previewers
+ 'awe.sm' => 'Awe.sm URL expander',
+ "bitlybot" => 'bit.ly bot',
+ "facebookexternalhit" => 'facebook bot',
+ 'LongURL' => 'URL expander service',
+ 'Twitterbot' => 'Twitter URL expander',
+ 'UnwindFetch' => 'Gnip URL expander',
+ # Uptime monitoring
+ 'check_http' => 'Nagios monitor',
+ 'NewRelicPinger' => 'NewRelic monitor',
+ 'Panopta' => 'Monitoring service',
+ "Pingdom" => 'Pingdom monitoring',
+ 'SiteUptime' => 'Site monitoring services',
+ # ???
+ "DigitalPersona Fingerprint Software" => 'HP Fingerprint scanner',
+ "ShowyouBot" => 'Showyou iOS app spider',
+ 'ZyBorg' => 'Zyborg? Hmmm....',
+ }
+ end
+
def disabled?
!enabled
end
@@ -138,8 +142,11 @@ module Split
end
end
+ def robot_regex
+ @robot_regex ||= /\b(?:#{escaped_bots.join('|')})\b|\A\W*\z/i
+ end
+
def initialize
- @robot_regex = /\b(?:#{escaped_bots.join('|')})\b|\A\W*\z/i
@ignore_ip_addresses = []
@db_failover = false
@db_failover_on_db_error = proc{|error|} # e.g. use Rails logger here
@@ -160,7 +167,7 @@ module Split
end
def escaped_bots
- BOTS.map { |key, _| Regexp.escape(key) }
+ bots.map { |key, _| Regexp.escape(key) }
end
end
end
| 56 | expose bots hash from config | 49 | .rb | rb | mit | splitrb/split |
10072403 | <NME> configuration.rb
<BEF> module Split
class Configuration
BOTS = {
# Indexers
"AdsBot-Google" => 'Google Adwords',
'Baidu' => 'Chinese search engine',
'Gigabot' => 'Gigabot spider',
'Googlebot' => 'Google spider',
'msnbot' => 'Microsoft bot',
'bingbot' => 'Microsoft bing bot',
'rogerbot' => 'SeoMoz spider',
'Slurp' => 'Yahoo spider',
'Sogou' => 'Chinese search engine',
"spider" => 'generic web spider',
'WordPress' => 'WordPress spider',
'ZIBB' => 'ZIBB spider',
'YandexBot' => 'Yandex spider',
# HTTP libraries
'Apache-HttpClient' => 'Java http library',
'AppEngine-Google' => 'Google App Engine',
"curl" => 'curl unix CLI http client',
'ColdFusion' => 'ColdFusion http library',
"EventMachine HttpClient" => 'Ruby http library',
"Go http package" => 'Go http library',
'Java' => 'Generic Java http library',
'libwww-perl' => 'Perl client-server library loved by script kids',
'lwp-trivial' => 'Another Perl library loved by script kids',
"Python-urllib" => 'Python http library',
"PycURL" => 'Python http library',
"Test Certificate Info" => 'C http library?',
"Wget" => 'wget unix CLI http client',
# URL expanders / previewers
'awe.sm' => 'Awe.sm URL expander',
"bitlybot" => 'bit.ly bot',
"facebookexternalhit" => 'facebook bot',
'LongURL' => 'URL expander service',
'Twitterbot' => 'Twitter URL expander',
'UnwindFetch' => 'Gnip URL expander',
# Uptime monitoring
'check_http' => 'Nagios monitor',
'NewRelicPinger' => 'NewRelic monitor',
'Panopta' => 'Monitoring service',
"Pingdom" => 'Pingdom monitoring',
'SiteUptime' => 'Site monitoring services',
# ???
"DigitalPersona Fingerprint Software" => 'HP Fingerprint scanner',
"ShowyouBot" => 'Showyou iOS app spider',
'ZyBorg' => 'Zyborg? Hmmm....',
}
attr_accessor :robot_regex
attr_accessor :ignore_ip_addresses
attr_accessor :db_failover
attr_accessor :db_failover
attr_accessor :db_failover_on_db_error
attr_accessor :db_failover_allow_parameter_override
attr_accessor :allow_multiple_experiments
attr_accessor :enabled
attr_accessor :persistence
attr_accessor :algorithm
def disabled?
!enabled
end
"EventMachine HttpClient" => "Ruby http library",
"Go http package" => "Go http library",
"Go-http-client" => "Go http library",
"Java" => "Generic Java http library",
"libwww-perl" => "Perl client-server library loved by script kids",
"lwp-trivial" => "Another Perl library loved by script kids",
"Python-urllib" => "Python http library",
"PycURL" => "Python http library",
"Test Certificate Info" => "C http library?",
"Typhoeus" => "Ruby http library",
"Wget" => "wget unix CLI http client",
# URL expanders / previewers
"awe.sm" => "Awe.sm URL expander",
"bitlybot" => "bit.ly bot",
"[email protected]" => "Linkfluence bot",
"facebookexternalhit" => "facebook bot",
"Facebot" => "Facebook crawler",
"Feedfetcher-Google" => "Google Feedfetcher",
"https://developers.google.com/+/web/snippet" => "Google+ Snippet Fetcher",
"LinkedInBot" => "LinkedIn bot",
"LongURL" => "URL expander service",
"NING" => "NING - Yet Another Twitter Swarmer",
"Pinterestbot" => "Pinterest Bot",
"redditbot" => "Reddit Bot",
"ShortLinkTranslate" => "Link shortener",
"Slackbot" => "Slackbot link expander",
"TweetmemeBot" => "TweetMeMe Crawler",
"Twitterbot" => "Twitter URL expander",
"UnwindFetch" => "Gnip URL expander",
"vkShare" => "VKontake Sharer",
# Uptime monitoring
"check_http" => "Nagios monitor",
"GoogleStackdriverMonitoring" => "Google Cloud monitor",
"NewRelicPinger" => "NewRelic monitor",
"Panopta" => "Monitoring service",
"Pingdom" => "Pingdom monitoring",
"SiteUptime" => "Site monitoring services",
"UptimeRobot" => "Monitoring service",
# ???
"DigitalPersona Fingerprint Software" => "HP Fingerprint scanner",
"ShowyouBot" => "Showyou iOS app spider",
"ZyBorg" => "Zyborg? Hmmm....",
"ELB-HealthChecker" => "ELB Health Check"
}
end
def experiments=(experiments)
raise InvalidExperimentsFormatError.new("Experiments must be a Hash") unless experiments.respond_to?(:keys)
@experiments = experiments
end
def disabled?
!enabled
end
def experiment_for(name)
if normalized_experiments
# TODO symbols
normalized_experiments[name.to_sym]
end
end
def metrics
return @metrics if defined?(@metrics)
@metrics = {}
if self.experiments
self.experiments.each do |key, value|
metrics = value_for(value, :metric) rescue nil
Array(metrics).each do |metric_name|
if metric_name
@metrics[metric_name.to_sym] ||= []
end
end
def initialize
@robot_regex = /\b(?:#{escaped_bots.join('|')})\b|\A\W*\z/i
@ignore_ip_addresses = []
@db_failover = false
@db_failover_on_db_error = proc{|error|} # e.g. use Rails logger here
experiment_config = {}
@experiments.keys.each do |name|
experiment_config[name.to_sym] = {}
end
@experiments.each do |experiment_name, settings|
alternatives = if (alts = value_for(settings, :alternatives))
normalize_alternatives(alts)
end
experiment_data = {
alternatives: alternatives,
goals: value_for(settings, :goals),
metadata: value_for(settings, :metadata),
end
def escaped_bots
BOTS.map { |key, _| Regexp.escape(key) }
end
end
end
end
experiment_config
end
def normalize_alternatives(alternatives)
given_probability, num_with_probability = alternatives.inject([0, 0]) do |a, v|
p, n = a
if percent = value_for(v, :percent)
[p + percent, n + 1]
else
a
end
end
num_without_probability = alternatives.length - num_with_probability
unassigned_probability = ((100.0 - given_probability) / num_without_probability / 100.0)
if num_with_probability.nonzero?
alternatives = alternatives.map do |v|
if (name = value_for(v, :name)) && (percent = value_for(v, :percent))
{ name => percent / 100.0 }
elsif name = value_for(v, :name)
{ name => unassigned_probability }
else
{ v => unassigned_probability }
end
end
[alternatives.shift, alternatives]
else
alternatives = alternatives.dup
[alternatives.shift, alternatives]
end
end
def robot_regex
@robot_regex ||= /\b(?:#{escaped_bots.join('|')})\b|\A\W*\z/i
end
def initialize
@ignore_ip_addresses = []
@ignore_filter = proc { |request| is_robot? || is_ignored_ip_address? }
@db_failover = false
@db_failover_on_db_error = proc { |error| } # e.g. use Rails logger here
@on_experiment_reset = proc { |experiment| }
@on_experiment_delete = proc { |experiment| }
@on_before_experiment_reset = proc { |experiment| }
@on_before_experiment_delete = proc { |experiment| }
@on_experiment_winner_choose = proc { |experiment| }
@db_failover_allow_parameter_override = false
@allow_multiple_experiments = false
@enabled = true
@experiments = {}
@persistence = Split::Persistence::SessionAdapter
@persistence_cookie_length = 31536000 # One year from now
@persistence_cookie_domain = nil
@algorithm = Split::Algorithms::WeightedSample
@include_rails_helper = true
@beta_probability_simulations = 10000
@winning_alternative_recalculation_interval = 60 * 60 * 24 # 1 day
@redis = ENV.fetch(ENV.fetch("REDIS_PROVIDER", "REDIS_URL"), "redis://localhost:6379")
@dashboard_pagination_default_per_page = 10
end
private
def value_for(hash, key)
if hash.kind_of?(Hash)
hash.has_key?(key.to_s) ? hash[key.to_s] : hash[key.to_sym]
end
end
def escaped_bots
bots.map { |key, _| Regexp.escape(key) }
end
end
end
<MSG> expose bots hash from config
<DFF> @@ -1,52 +1,6 @@
module Split
class Configuration
- BOTS = {
- # Indexers
- "AdsBot-Google" => 'Google Adwords',
- 'Baidu' => 'Chinese search engine',
- 'Gigabot' => 'Gigabot spider',
- 'Googlebot' => 'Google spider',
- 'msnbot' => 'Microsoft bot',
- 'bingbot' => 'Microsoft bing bot',
- 'rogerbot' => 'SeoMoz spider',
- 'Slurp' => 'Yahoo spider',
- 'Sogou' => 'Chinese search engine',
- "spider" => 'generic web spider',
- 'WordPress' => 'WordPress spider',
- 'ZIBB' => 'ZIBB spider',
- 'YandexBot' => 'Yandex spider',
- # HTTP libraries
- 'Apache-HttpClient' => 'Java http library',
- 'AppEngine-Google' => 'Google App Engine',
- "curl" => 'curl unix CLI http client',
- 'ColdFusion' => 'ColdFusion http library',
- "EventMachine HttpClient" => 'Ruby http library',
- "Go http package" => 'Go http library',
- 'Java' => 'Generic Java http library',
- 'libwww-perl' => 'Perl client-server library loved by script kids',
- 'lwp-trivial' => 'Another Perl library loved by script kids',
- "Python-urllib" => 'Python http library',
- "PycURL" => 'Python http library',
- "Test Certificate Info" => 'C http library?',
- "Wget" => 'wget unix CLI http client',
- # URL expanders / previewers
- 'awe.sm' => 'Awe.sm URL expander',
- "bitlybot" => 'bit.ly bot',
- "facebookexternalhit" => 'facebook bot',
- 'LongURL' => 'URL expander service',
- 'Twitterbot' => 'Twitter URL expander',
- 'UnwindFetch' => 'Gnip URL expander',
- # Uptime monitoring
- 'check_http' => 'Nagios monitor',
- 'NewRelicPinger' => 'NewRelic monitor',
- 'Panopta' => 'Monitoring service',
- "Pingdom" => 'Pingdom monitoring',
- 'SiteUptime' => 'Site monitoring services',
- # ???
- "DigitalPersona Fingerprint Software" => 'HP Fingerprint scanner',
- "ShowyouBot" => 'Showyou iOS app spider',
- 'ZyBorg' => 'Zyborg? Hmmm....',
- }
+ attr_accessor :bots
attr_accessor :robot_regex
attr_accessor :ignore_ip_addresses
attr_accessor :db_failover
@@ -58,6 +12,56 @@ module Split
attr_accessor :persistence
attr_accessor :algorithm
+ def bots
+ @bots ||= {
+ # Indexers
+ "AdsBot-Google" => 'Google Adwords',
+ 'Baidu' => 'Chinese search engine',
+ 'Gigabot' => 'Gigabot spider',
+ 'Googlebot' => 'Google spider',
+ 'msnbot' => 'Microsoft bot',
+ 'bingbot' => 'Microsoft bing bot',
+ 'rogerbot' => 'SeoMoz spider',
+ 'Slurp' => 'Yahoo spider',
+ 'Sogou' => 'Chinese search engine',
+ "spider" => 'generic web spider',
+ 'WordPress' => 'WordPress spider',
+ 'ZIBB' => 'ZIBB spider',
+ 'YandexBot' => 'Yandex spider',
+ # HTTP libraries
+ 'Apache-HttpClient' => 'Java http library',
+ 'AppEngine-Google' => 'Google App Engine',
+ "curl" => 'curl unix CLI http client',
+ 'ColdFusion' => 'ColdFusion http library',
+ "EventMachine HttpClient" => 'Ruby http library',
+ "Go http package" => 'Go http library',
+ 'Java' => 'Generic Java http library',
+ 'libwww-perl' => 'Perl client-server library loved by script kids',
+ 'lwp-trivial' => 'Another Perl library loved by script kids',
+ "Python-urllib" => 'Python http library',
+ "PycURL" => 'Python http library',
+ "Test Certificate Info" => 'C http library?',
+ "Wget" => 'wget unix CLI http client',
+ # URL expanders / previewers
+ 'awe.sm' => 'Awe.sm URL expander',
+ "bitlybot" => 'bit.ly bot',
+ "facebookexternalhit" => 'facebook bot',
+ 'LongURL' => 'URL expander service',
+ 'Twitterbot' => 'Twitter URL expander',
+ 'UnwindFetch' => 'Gnip URL expander',
+ # Uptime monitoring
+ 'check_http' => 'Nagios monitor',
+ 'NewRelicPinger' => 'NewRelic monitor',
+ 'Panopta' => 'Monitoring service',
+ "Pingdom" => 'Pingdom monitoring',
+ 'SiteUptime' => 'Site monitoring services',
+ # ???
+ "DigitalPersona Fingerprint Software" => 'HP Fingerprint scanner',
+ "ShowyouBot" => 'Showyou iOS app spider',
+ 'ZyBorg' => 'Zyborg? Hmmm....',
+ }
+ end
+
def disabled?
!enabled
end
@@ -138,8 +142,11 @@ module Split
end
end
+ def robot_regex
+ @robot_regex ||= /\b(?:#{escaped_bots.join('|')})\b|\A\W*\z/i
+ end
+
def initialize
- @robot_regex = /\b(?:#{escaped_bots.join('|')})\b|\A\W*\z/i
@ignore_ip_addresses = []
@db_failover = false
@db_failover_on_db_error = proc{|error|} # e.g. use Rails logger here
@@ -160,7 +167,7 @@ module Split
end
def escaped_bots
- BOTS.map { |key, _| Regexp.escape(key) }
+ bots.map { |key, _| Regexp.escape(key) }
end
end
end
| 56 | expose bots hash from config | 49 | .rb | rb | mit | splitrb/split |
10072404 | <NME> configuration.rb
<BEF> module Split
class Configuration
BOTS = {
# Indexers
"AdsBot-Google" => 'Google Adwords',
'Baidu' => 'Chinese search engine',
'Gigabot' => 'Gigabot spider',
'Googlebot' => 'Google spider',
'msnbot' => 'Microsoft bot',
'bingbot' => 'Microsoft bing bot',
'rogerbot' => 'SeoMoz spider',
'Slurp' => 'Yahoo spider',
'Sogou' => 'Chinese search engine',
"spider" => 'generic web spider',
'WordPress' => 'WordPress spider',
'ZIBB' => 'ZIBB spider',
'YandexBot' => 'Yandex spider',
# HTTP libraries
'Apache-HttpClient' => 'Java http library',
'AppEngine-Google' => 'Google App Engine',
"curl" => 'curl unix CLI http client',
'ColdFusion' => 'ColdFusion http library',
"EventMachine HttpClient" => 'Ruby http library',
"Go http package" => 'Go http library',
'Java' => 'Generic Java http library',
'libwww-perl' => 'Perl client-server library loved by script kids',
'lwp-trivial' => 'Another Perl library loved by script kids',
"Python-urllib" => 'Python http library',
"PycURL" => 'Python http library',
"Test Certificate Info" => 'C http library?',
"Wget" => 'wget unix CLI http client',
# URL expanders / previewers
'awe.sm' => 'Awe.sm URL expander',
"bitlybot" => 'bit.ly bot',
"facebookexternalhit" => 'facebook bot',
'LongURL' => 'URL expander service',
'Twitterbot' => 'Twitter URL expander',
'UnwindFetch' => 'Gnip URL expander',
# Uptime monitoring
'check_http' => 'Nagios monitor',
'NewRelicPinger' => 'NewRelic monitor',
'Panopta' => 'Monitoring service',
"Pingdom" => 'Pingdom monitoring',
'SiteUptime' => 'Site monitoring services',
# ???
"DigitalPersona Fingerprint Software" => 'HP Fingerprint scanner',
"ShowyouBot" => 'Showyou iOS app spider',
'ZyBorg' => 'Zyborg? Hmmm....',
}
attr_accessor :robot_regex
attr_accessor :ignore_ip_addresses
attr_accessor :db_failover
attr_accessor :db_failover
attr_accessor :db_failover_on_db_error
attr_accessor :db_failover_allow_parameter_override
attr_accessor :allow_multiple_experiments
attr_accessor :enabled
attr_accessor :persistence
attr_accessor :algorithm
def disabled?
!enabled
end
"EventMachine HttpClient" => "Ruby http library",
"Go http package" => "Go http library",
"Go-http-client" => "Go http library",
"Java" => "Generic Java http library",
"libwww-perl" => "Perl client-server library loved by script kids",
"lwp-trivial" => "Another Perl library loved by script kids",
"Python-urllib" => "Python http library",
"PycURL" => "Python http library",
"Test Certificate Info" => "C http library?",
"Typhoeus" => "Ruby http library",
"Wget" => "wget unix CLI http client",
# URL expanders / previewers
"awe.sm" => "Awe.sm URL expander",
"bitlybot" => "bit.ly bot",
"[email protected]" => "Linkfluence bot",
"facebookexternalhit" => "facebook bot",
"Facebot" => "Facebook crawler",
"Feedfetcher-Google" => "Google Feedfetcher",
"https://developers.google.com/+/web/snippet" => "Google+ Snippet Fetcher",
"LinkedInBot" => "LinkedIn bot",
"LongURL" => "URL expander service",
"NING" => "NING - Yet Another Twitter Swarmer",
"Pinterestbot" => "Pinterest Bot",
"redditbot" => "Reddit Bot",
"ShortLinkTranslate" => "Link shortener",
"Slackbot" => "Slackbot link expander",
"TweetmemeBot" => "TweetMeMe Crawler",
"Twitterbot" => "Twitter URL expander",
"UnwindFetch" => "Gnip URL expander",
"vkShare" => "VKontake Sharer",
# Uptime monitoring
"check_http" => "Nagios monitor",
"GoogleStackdriverMonitoring" => "Google Cloud monitor",
"NewRelicPinger" => "NewRelic monitor",
"Panopta" => "Monitoring service",
"Pingdom" => "Pingdom monitoring",
"SiteUptime" => "Site monitoring services",
"UptimeRobot" => "Monitoring service",
# ???
"DigitalPersona Fingerprint Software" => "HP Fingerprint scanner",
"ShowyouBot" => "Showyou iOS app spider",
"ZyBorg" => "Zyborg? Hmmm....",
"ELB-HealthChecker" => "ELB Health Check"
}
end
def experiments=(experiments)
raise InvalidExperimentsFormatError.new("Experiments must be a Hash") unless experiments.respond_to?(:keys)
@experiments = experiments
end
def disabled?
!enabled
end
def experiment_for(name)
if normalized_experiments
# TODO symbols
normalized_experiments[name.to_sym]
end
end
def metrics
return @metrics if defined?(@metrics)
@metrics = {}
if self.experiments
self.experiments.each do |key, value|
metrics = value_for(value, :metric) rescue nil
Array(metrics).each do |metric_name|
if metric_name
@metrics[metric_name.to_sym] ||= []
end
end
def initialize
@robot_regex = /\b(?:#{escaped_bots.join('|')})\b|\A\W*\z/i
@ignore_ip_addresses = []
@db_failover = false
@db_failover_on_db_error = proc{|error|} # e.g. use Rails logger here
experiment_config = {}
@experiments.keys.each do |name|
experiment_config[name.to_sym] = {}
end
@experiments.each do |experiment_name, settings|
alternatives = if (alts = value_for(settings, :alternatives))
normalize_alternatives(alts)
end
experiment_data = {
alternatives: alternatives,
goals: value_for(settings, :goals),
metadata: value_for(settings, :metadata),
end
def escaped_bots
BOTS.map { |key, _| Regexp.escape(key) }
end
end
end
end
experiment_config
end
def normalize_alternatives(alternatives)
given_probability, num_with_probability = alternatives.inject([0, 0]) do |a, v|
p, n = a
if percent = value_for(v, :percent)
[p + percent, n + 1]
else
a
end
end
num_without_probability = alternatives.length - num_with_probability
unassigned_probability = ((100.0 - given_probability) / num_without_probability / 100.0)
if num_with_probability.nonzero?
alternatives = alternatives.map do |v|
if (name = value_for(v, :name)) && (percent = value_for(v, :percent))
{ name => percent / 100.0 }
elsif name = value_for(v, :name)
{ name => unassigned_probability }
else
{ v => unassigned_probability }
end
end
[alternatives.shift, alternatives]
else
alternatives = alternatives.dup
[alternatives.shift, alternatives]
end
end
def robot_regex
@robot_regex ||= /\b(?:#{escaped_bots.join('|')})\b|\A\W*\z/i
end
def initialize
@ignore_ip_addresses = []
@ignore_filter = proc { |request| is_robot? || is_ignored_ip_address? }
@db_failover = false
@db_failover_on_db_error = proc { |error| } # e.g. use Rails logger here
@on_experiment_reset = proc { |experiment| }
@on_experiment_delete = proc { |experiment| }
@on_before_experiment_reset = proc { |experiment| }
@on_before_experiment_delete = proc { |experiment| }
@on_experiment_winner_choose = proc { |experiment| }
@db_failover_allow_parameter_override = false
@allow_multiple_experiments = false
@enabled = true
@experiments = {}
@persistence = Split::Persistence::SessionAdapter
@persistence_cookie_length = 31536000 # One year from now
@persistence_cookie_domain = nil
@algorithm = Split::Algorithms::WeightedSample
@include_rails_helper = true
@beta_probability_simulations = 10000
@winning_alternative_recalculation_interval = 60 * 60 * 24 # 1 day
@redis = ENV.fetch(ENV.fetch("REDIS_PROVIDER", "REDIS_URL"), "redis://localhost:6379")
@dashboard_pagination_default_per_page = 10
end
private
def value_for(hash, key)
if hash.kind_of?(Hash)
hash.has_key?(key.to_s) ? hash[key.to_s] : hash[key.to_sym]
end
end
def escaped_bots
bots.map { |key, _| Regexp.escape(key) }
end
end
end
<MSG> expose bots hash from config
<DFF> @@ -1,52 +1,6 @@
module Split
class Configuration
- BOTS = {
- # Indexers
- "AdsBot-Google" => 'Google Adwords',
- 'Baidu' => 'Chinese search engine',
- 'Gigabot' => 'Gigabot spider',
- 'Googlebot' => 'Google spider',
- 'msnbot' => 'Microsoft bot',
- 'bingbot' => 'Microsoft bing bot',
- 'rogerbot' => 'SeoMoz spider',
- 'Slurp' => 'Yahoo spider',
- 'Sogou' => 'Chinese search engine',
- "spider" => 'generic web spider',
- 'WordPress' => 'WordPress spider',
- 'ZIBB' => 'ZIBB spider',
- 'YandexBot' => 'Yandex spider',
- # HTTP libraries
- 'Apache-HttpClient' => 'Java http library',
- 'AppEngine-Google' => 'Google App Engine',
- "curl" => 'curl unix CLI http client',
- 'ColdFusion' => 'ColdFusion http library',
- "EventMachine HttpClient" => 'Ruby http library',
- "Go http package" => 'Go http library',
- 'Java' => 'Generic Java http library',
- 'libwww-perl' => 'Perl client-server library loved by script kids',
- 'lwp-trivial' => 'Another Perl library loved by script kids',
- "Python-urllib" => 'Python http library',
- "PycURL" => 'Python http library',
- "Test Certificate Info" => 'C http library?',
- "Wget" => 'wget unix CLI http client',
- # URL expanders / previewers
- 'awe.sm' => 'Awe.sm URL expander',
- "bitlybot" => 'bit.ly bot',
- "facebookexternalhit" => 'facebook bot',
- 'LongURL' => 'URL expander service',
- 'Twitterbot' => 'Twitter URL expander',
- 'UnwindFetch' => 'Gnip URL expander',
- # Uptime monitoring
- 'check_http' => 'Nagios monitor',
- 'NewRelicPinger' => 'NewRelic monitor',
- 'Panopta' => 'Monitoring service',
- "Pingdom" => 'Pingdom monitoring',
- 'SiteUptime' => 'Site monitoring services',
- # ???
- "DigitalPersona Fingerprint Software" => 'HP Fingerprint scanner',
- "ShowyouBot" => 'Showyou iOS app spider',
- 'ZyBorg' => 'Zyborg? Hmmm....',
- }
+ attr_accessor :bots
attr_accessor :robot_regex
attr_accessor :ignore_ip_addresses
attr_accessor :db_failover
@@ -58,6 +12,56 @@ module Split
attr_accessor :persistence
attr_accessor :algorithm
+ def bots
+ @bots ||= {
+ # Indexers
+ "AdsBot-Google" => 'Google Adwords',
+ 'Baidu' => 'Chinese search engine',
+ 'Gigabot' => 'Gigabot spider',
+ 'Googlebot' => 'Google spider',
+ 'msnbot' => 'Microsoft bot',
+ 'bingbot' => 'Microsoft bing bot',
+ 'rogerbot' => 'SeoMoz spider',
+ 'Slurp' => 'Yahoo spider',
+ 'Sogou' => 'Chinese search engine',
+ "spider" => 'generic web spider',
+ 'WordPress' => 'WordPress spider',
+ 'ZIBB' => 'ZIBB spider',
+ 'YandexBot' => 'Yandex spider',
+ # HTTP libraries
+ 'Apache-HttpClient' => 'Java http library',
+ 'AppEngine-Google' => 'Google App Engine',
+ "curl" => 'curl unix CLI http client',
+ 'ColdFusion' => 'ColdFusion http library',
+ "EventMachine HttpClient" => 'Ruby http library',
+ "Go http package" => 'Go http library',
+ 'Java' => 'Generic Java http library',
+ 'libwww-perl' => 'Perl client-server library loved by script kids',
+ 'lwp-trivial' => 'Another Perl library loved by script kids',
+ "Python-urllib" => 'Python http library',
+ "PycURL" => 'Python http library',
+ "Test Certificate Info" => 'C http library?',
+ "Wget" => 'wget unix CLI http client',
+ # URL expanders / previewers
+ 'awe.sm' => 'Awe.sm URL expander',
+ "bitlybot" => 'bit.ly bot',
+ "facebookexternalhit" => 'facebook bot',
+ 'LongURL' => 'URL expander service',
+ 'Twitterbot' => 'Twitter URL expander',
+ 'UnwindFetch' => 'Gnip URL expander',
+ # Uptime monitoring
+ 'check_http' => 'Nagios monitor',
+ 'NewRelicPinger' => 'NewRelic monitor',
+ 'Panopta' => 'Monitoring service',
+ "Pingdom" => 'Pingdom monitoring',
+ 'SiteUptime' => 'Site monitoring services',
+ # ???
+ "DigitalPersona Fingerprint Software" => 'HP Fingerprint scanner',
+ "ShowyouBot" => 'Showyou iOS app spider',
+ 'ZyBorg' => 'Zyborg? Hmmm....',
+ }
+ end
+
def disabled?
!enabled
end
@@ -138,8 +142,11 @@ module Split
end
end
+ def robot_regex
+ @robot_regex ||= /\b(?:#{escaped_bots.join('|')})\b|\A\W*\z/i
+ end
+
def initialize
- @robot_regex = /\b(?:#{escaped_bots.join('|')})\b|\A\W*\z/i
@ignore_ip_addresses = []
@db_failover = false
@db_failover_on_db_error = proc{|error|} # e.g. use Rails logger here
@@ -160,7 +167,7 @@ module Split
end
def escaped_bots
- BOTS.map { |key, _| Regexp.escape(key) }
+ bots.map { |key, _| Regexp.escape(key) }
end
end
end
| 56 | expose bots hash from config | 49 | .rb | rb | mit | splitrb/split |
10072405 | <NME> format.ts
<BEF> import { equal } from 'assert';
import html from '../src/markup/format/html';
import haml from '../src/markup/format/haml';
import pug from '../src/markup/format/pug';
import slim from '../src/markup/format/slim';
import parse from '../src/markup';
import createConfig, { Options } from '../src/config';
describe('Format', () => {
const defaultConfig = createConfig();
const field = createConfig({
options: {
'output.field': (index, placeholder) => placeholder ? `\${${index}:${placeholder}}` : `\${${index}}`
}
return config;
}
describe.only('HTML', () => {
const format = (abbr: string, config = defaultConfig) => html(parse(abbr, config), config);
it('basic', () => {
equal(format('div>p'), '<div>\n\t<p></p>\n</div>');
describe('HTML', () => {
const format = (abbr: string, config = defaultConfig) => html(parse(abbr, config), config);
it('basic', () => {
equal(format('div>p'), '<div>\n\t<p></p>\n</div>');
equal(format('div>p*3'), '<div>\n\t<p></p>\n\t<p></p>\n\t<p></p>\n</div>');
equal(format('div#a>p.b*2>span'), '<div id="a">\n\t<p class="b"><span></span></p>\n\t<p class="b"><span></span></p>\n</div>');
equal(format('div>div>div'), '<div>\n\t<div>\n\t\t<div></div>\n\t</div>\n</div>');
equal(format('table>tr*2>td{item}*2'),
'<table>\n\t<tr>\n\t\t<td>item</td>\n\t\t<td>item</td>\n\t</tr>\n\t<tr>\n\t\t<td>item</td>\n\t\t<td>item</td>\n\t</tr>\n</table>');
});
it('inline elements', () => {
const profile = createProfile({ 'output.inlineBreak': 3 });
const breakInline = createProfile({ 'output.inlineBreak': 1 });
const keepInline = createProfile({ 'output.inlineBreak': 0 });
const xhtml = createProfile({ 'output.selfClosingStyle': 'xhtml' });
equal(format('div>a>b*3', xhtml), '<div>\n\t<a href="">\n\t\t<b></b>\n\t\t<b></b>\n\t\t<b></b>\n\t</a>\n</div>');
equal(format('p>i', profile), '<p><i></i></p>');
equal(format('p>i*2', profile), '<p><i></i><i></i></p>');
equal(format('p>i*2', breakInline), '<p>\n\t<i></i>\n\t<i></i>\n</p>');
equal(format('p>i*3', profile), '<p>\n\t<i></i>\n\t<i></i>\n\t<i></i>\n</p>');
equal(format('p>i*3', keepInline), '<p><i></i><i></i><i></i></p>');
equal(format('i*2', profile), '<i></i><i></i>');
equal(format('i*3', profile), '<i></i>\n<i></i>\n<i></i>');
equal(format('i{a}+i{b}', profile), '<i>a</i><i>b</i>');
equal(format('img[src]/+p', xhtml), '<img src="" alt="" />\n<p></p>');
equal(format('div>img[src]/+p', xhtml), '<div>\n\t<img src="" alt="" />\n\t<p></p>\n</div>');
equal(format('div>p+img[src]/', xhtml), '<div>\n\t<p></p>\n\t<img src="" alt="" />\n</div>');
equal(format('div>p+img[src]/+p', xhtml), '<div>\n\t<p></p>\n\t<img src="" alt="" />\n\t<p></p>\n</div>');
equal(format('div>p+img[src]/*2+p', xhtml), '<div>\n\t<p></p>\n\t<img src="" alt="" /><img src="" alt="" />\n\t<p></p>\n</div>');
equal(format('div>p+img[src]/*3+p', xhtml), '<div>\n\t<p></p>\n\t<img src="" alt="" />\n\t<img src="" alt="" />\n\t<img src="" alt="" />\n\t<p></p>\n</div>');
});
it('generate fields', () => {
equal(format('a[href]', field), '<a href="${1}">${2}</a>');
equal(format('a[href]*2', field), '<a href="${1}">${2}</a><a href="${3}">${4}</a>');
equal(format('{${0} ${1:foo} ${2:bar}}*2', field), '${1} ${2:foo} ${3:bar}\n${4} ${5:foo} ${6:bar}');
equal(format('{${0} ${1:foo} ${2:bar}}*2'), ' foo bar\n foo bar');
equal(format('ul>li*2', field), '<ul>\n\t<li>${1}</li>\n\t<li>${2}</li>\n</ul>');
equal(format('div>img[src]/', field), '<div><img src="${1}" alt="${2}"></div>');
});
// it.only('debug', () => {
// equal(format('div>{foo}+{bar}+p'), '<div>\n\tfoobar\n\t<p></p>\n</div>');
// });
it('mixed content', () => {
equal(format('div{foo}'), '<div>foo</div>');
equal(format('div>{foo}'), '<div>foo</div>');
equal(format('div>{foo}+{bar}'), '<div>\n\tfoo\n\tbar\n</div>');
equal(format('div>{foo}+{bar}+p'), '<div>\n\tfoo\n\tbar\n\t<p></p>\n</div>');
equal(format('div>{foo}+{bar}+p+{foo}+{bar}+p'), '<div>\n\tfoo\n\tbar\n\t<p></p>\n\tfoo\n\tbar\n\t<p></p>\n</div>');
equal(format('div>{foo}+p+{bar}'), '<div>\n\tfoo\n\t<p></p>\n\tbar\n</div>');
equal(format('div>{foo}>p'), '<div>\n\tfoo\n\t<p></p>\n</div>');
equal(format('div>{<!-- ${0} -->}'), '<div><!-- --></div>');
equal(format('div>{<!-- ${0} -->}+p'), '<div>\n\t<!-- -->\n\t<p></p>\n</div>');
equal(format('div>p+{<!-- ${0} -->}'), '<div>\n\t<p></p>\n\t<!-- -->\n</div>');
equal(format('div>{<!-- ${0} -->}>p'), '<div>\n\t<!-- <p></p> -->\n</div>');
equal(format('div>{<!-- ${0} -->}*2>p'), '<div>\n\t<!-- <p></p> -->\n\t<!-- <p></p> -->\n</div>');
equal(format('div>{<!-- ${0} -->}>p*2'), '<div>\n\t<!-- \n\t<p></p>\n\t<p></p>\n\t-->\n</div>');
equal(format('div>{<!-- ${0} -->}*2>p*2'), '<div>\n\t<!-- \n\t<p></p>\n\t<p></p>\n\t-->\n\t<!-- \n\t<p></p>\n\t<p></p>\n\t-->\n</div>');
equal(format('div>{<!-- ${0} -->}>b'), '<div>\n\t<!-- <b></b> -->\n</div>');
equal(format('div>{<!-- ${0} -->}>b*2'), '<div>\n\t<!-- <b></b><b></b> -->\n</div>');
equal(format('div>{<!-- ${0} -->}>b*3'), '<div>\n\t<!-- \n\t<b></b>\n\t<b></b>\n\t<b></b>\n\t-->\n</div>');
equal(format('div>{<!-- ${0} -->}', field), '<div><!-- ${1} --></div>');
equal(format('div>{<!-- ${0} -->}>b', field), '<div>\n\t<!-- <b>${1}</b> -->\n</div>');
});
it('self-closing', () => {
const xmlStyle = createProfile({ 'output.selfClosingStyle': 'xml' });
const htmlStyle = createProfile({ 'output.selfClosingStyle': 'html' });
const xhtmlStyle = createProfile({ 'output.selfClosingStyle': 'xhtml' });
equal(format('img[src]/', htmlStyle), '<img src="" alt="">');
equal(format('img[src]/', xhtmlStyle), '<img src="" alt="" />');
equal(format('img[src]/', xmlStyle), '<img src="" alt=""/>');
equal(format('div>img[src]/', xhtmlStyle), '<div><img src="" alt="" /></div>');
});
it('boolean attributes', () => {
const compact = createProfile({ 'output.compactBoolean': true });
const noCompact = createProfile({ 'output.compactBoolean': false });
equal(format('p[b.]', noCompact), '<p b="b"></p>');
equal(format('p[b.]', compact), '<p b></p>');
equal(format('p[contenteditable]', compact), '<p contenteditable></p>');
equal(format('p[contenteditable]', noCompact), '<p contenteditable="contenteditable"></p>');
equal(format('p[contenteditable=foo]', compact), '<p contenteditable="foo"></p>');
});
it('no formatting', () => {
const profile = createProfile({ 'output.format': false });
equal(format('div>p', profile), '<div><p></p></div>');
equal(format('div>{foo}+p+{bar}', profile), '<div>foo<p></p>bar</div>');
equal(format('div>{foo}>p', profile), '<div>foo<p></p></div>');
equal(format('div>{<!-- ${0} -->}>p', profile), '<div><!-- <p></p> --></div>');
'<!DOCTYPE html>\n<html>\n<head>\n\t<meta charset="charset">\n\t<title>${2:Document}</title>\n</head>\n<body>\n\t${3}\n</body>\n</html>');
});
it.only('comment', () => {
const opt = createConfig();
opt.options.comment = { enabled: true };
it('comment', () => {
const opt = createConfig({ options: { 'comment.enabled': true } });
equal(format('ul>li.item', opt), '<ul>\n\t<li class="item"></li>\n\t<!-- /.item -->\n</ul>');
equal(format('div>ul>li.item#foo', opt), '<div>\n\t<ul>\n\t\t<li class="item" id="foo"></li>\n\t\t<!-- /#foo.item -->\n\t</ul>\n</div>');
opt.options['comment.after'] = ' { [%ID] }';
equal(format('div>ul>li.item#foo', opt), '<div>\n\t<ul>\n\t\t<li class="item" id="foo"></li> { %foo }\n\t</ul>\n</div>');
});
});
describe('HAML', () => {
const format = (abbr: string, config = defaultConfig) => haml(parse(abbr, config), config);
it('basic', () => {
equal(format('div#header>ul.nav>li[title=test].nav-item*2'),
'#header\n\t%ul.nav\n\t\t%li.nav-item(title="test") \n\t\t%li.nav-item(title="test") ');
// https://github.com/emmetio/emmet/issues/446
equal(format('li>a'), '%li\n\t%a(href="") ');
equal(format('div#foo[data-n1=v1 title=test data-n2=v2].bar'),
'#foo.bar(data-n1="v1" title="test" data-n2="v2") ');
let profile = createProfile({ 'output.compactBoolean': true });
equal(format('input[disabled. foo title=test]/', profile), '%input(type="text" disabled foo="" title="test")/');
profile = createProfile({ 'output.compactBoolean': false });
equal(format('input[disabled. foo title=test]/', profile), '%input(type="text" disabled=true foo="" title="test")/');
});
it('nodes with text', () => {
equal(format('{Text 1}'), 'Text 1');
equal(format('span{Text 1}'), '%span Text 1');
equal(format('span{Text 1}>b{Text 2}'), '%span Text 1\n\t%b Text 2');
equal(format('span{Text 1\nText 2}>b{Text 3}'), '%span\n\tText 1 |\n\tText 2 |\n\t%b Text 3');
equal(format('div>span{Text 1\nText 2\nText 123}>b{Text 3}'), '%div\n\t%span\n\t\tText 1 |\n\t\tText 2 |\n\t\tText 123 |\n\t\t%b Text 3');
});
it('generate fields', () => {
equal(format('a[href]', field), '%a(href="${1}") ${2}');
equal(format('a[href]*2', field), '%a(href="${1}") ${2}\n%a(href="${3}") ${4}');
equal(format('{${0} ${1:foo} ${2:bar}}*2', field), '${1} ${2:foo} ${3:bar}${4} ${5:foo} ${6:bar}');
equal(format('{${0} ${1:foo} ${2:bar}}*2'), ' foo bar foo bar');
equal(format('ul>li*2', field), '%ul\n\t%li ${1}\n\t%li ${2}');
equal(format('div>img[src]/', field), '%div\n\t%img(src="${1}" alt="${2}")/');
});
});
describe('Pug', () => {
const format = (abbr: string, config = defaultConfig) => pug(parse(abbr, config), config);
it('basic', () => {
equal(format('div#header>ul.nav>li[title=test].nav-item*2'),
'#header\n\tul.nav\n\t\tli.nav-item(title="test") \n\t\tli.nav-item(title="test") ');
equal(format('div#foo[data-n1=v1 title=test data-n2=v2].bar'),
'#foo.bar(data-n1="v1", title="test", data-n2="v2") ');
equal(format('input[disabled. foo title=test]'), 'input(type="text", disabled, foo="", title="test")');
// Use closing slash for XML output format
equal(format('input[disabled. foo title=test]', createProfile({ 'output.selfClosingStyle': 'xml' })), 'input(type="text", disabled, foo="", title="test")/');
});
it('nodes with text', () => {
equal(format('{Text 1}'), 'Text 1');
equal(format('span{Text 1}'), 'span Text 1');
equal(format('span{Text 1}>b{Text 2}'), 'span Text 1\n\tb Text 2');
equal(format('span{Text 1\nText 2}>b{Text 3}'), 'span\n\t| Text 1\n\t| Text 2\n\tb Text 3');
equal(format('div>span{Text 1\nText 2}>b{Text 3}'), 'div\n\tspan\n\t\t| Text 1\n\t\t| Text 2\n\t\tb Text 3');
});
it('generate fields', () => {
equal(format('a[href]', field), 'a(href="${1}") ${2}');
equal(format('a[href]*2', field), 'a(href="${1}") ${2}\na(href="${3}") ${4}');
equal(format('{${0} ${1:foo} ${2:bar}}*2', field), '${1} ${2:foo} ${3:bar}${4} ${5:foo} ${6:bar}');
equal(format('{${0} ${1:foo} ${2:bar}}*2'), ' foo bar foo bar');
equal(format('ul>li*2', field), 'ul\n\tli ${1}\n\tli ${2}');
equal(format('div>img[src]/', field), 'div\n\timg(src="${1}", alt="${2}")');
});
});
describe('Slim', () => {
const format = (abbr: string, config = defaultConfig) => slim(parse(abbr, config), config);
it('basic', () => {
equal(format('div#header>ul.nav>li[title=test].nav-item*2'),
'#header\n\tul.nav\n\t\tli.nav-item title="test" \n\t\tli.nav-item title="test" ');
equal(format('div#foo[data-n1=v1 title=test data-n2=v2].bar'),
'#foo.bar data-n1="v1" title="test" data-n2="v2" ');
// const profile = createProfile({ inlineBreak: 0 });
// equal(format('ul>li>span{Text}', profile), 'ul\n\tli: span Text');
// equal(format('ul>li>span{Text}'), 'ul\n\tli\n\t\tspan Text');
// equal(format('ul>li>span{Text}*2', profile), 'ul\n\tli\n\t\tspan Text\n\t\tspan Text');
});
// it.skip('attribute wrappers', () => {
// equal(format('input[disabled. foo title=test]'), 'input disabled=true foo="" title="test"');
// equal(format('input[disabled. foo title=test]', null, { attributeWrap: 'round' }),
// 'input(disabled foo="" title="test")');
// });
it('nodes with text', () => {
equal(format('{Text 1}'), 'Text 1');
equal(format('span{Text 1}'), 'span Text 1');
equal(format('span{Text 1}>b{Text 2}'), 'span Text 1\n\tb Text 2');
equal(format('span{Text 1\nText 2}>b{Text 3}'), 'span\n\t| Text 1\n\t| Text 2\n\tb Text 3');
equal(format('div>span{Text 1\nText 2}>b{Text 3}'), 'div\n\tspan\n\t\t| Text 1\n\t\t| Text 2\n\t\tb Text 3');
});
it('generate fields', () => {
equal(format('a[href]', field), 'a href="${1}" ${2}');
equal(format('a[href]*2', field), 'a href="${1}" ${2}\na href="${3}" ${4}');
equal(format('{${0} ${1:foo} ${2:bar}}*2', field), '${1} ${2:foo} ${3:bar}${4} ${5:foo} ${6:bar}');
equal(format('{${0} ${1:foo} ${2:bar}}*2'), ' foo bar foo bar');
equal(format('ul>li*2', field), 'ul\n\tli ${1}\n\tli ${2}');
equal(format('div>img[src]/', field), 'div\n\timg src="${1}" alt="${2}"/');
});
});
});
<MSG> Support node commenting
<DFF> @@ -15,7 +15,7 @@ describe('Format', () => {
return config;
}
- describe.only('HTML', () => {
+ describe('HTML', () => {
const format = (abbr: string, config = defaultConfig) => html(parse(abbr, config), config);
it('basic', () => {
equal(format('div>p'), '<div>\n\t<p></p>\n</div>');
@@ -127,7 +127,7 @@ describe('Format', () => {
'<!DOCTYPE html>\n<html>\n<head>\n\t<meta charset="charset">\n\t<title>${2:Document}</title>\n</head>\n<body>\n\t${3}\n</body>\n</html>');
});
- it.only('comment', () => {
+ it('comment', () => {
const opt = createConfig();
opt.options.comment = { enabled: true };
| 2 | Support node commenting | 2 | .ts | ts | mit | emmetio/emmet |
10072406 | <NME> format.ts
<BEF> import { equal } from 'assert';
import html from '../src/markup/format/html';
import haml from '../src/markup/format/haml';
import pug from '../src/markup/format/pug';
import slim from '../src/markup/format/slim';
import parse from '../src/markup';
import createConfig, { Options } from '../src/config';
describe('Format', () => {
const defaultConfig = createConfig();
const field = createConfig({
options: {
'output.field': (index, placeholder) => placeholder ? `\${${index}:${placeholder}}` : `\${${index}}`
}
return config;
}
describe.only('HTML', () => {
const format = (abbr: string, config = defaultConfig) => html(parse(abbr, config), config);
it('basic', () => {
equal(format('div>p'), '<div>\n\t<p></p>\n</div>');
describe('HTML', () => {
const format = (abbr: string, config = defaultConfig) => html(parse(abbr, config), config);
it('basic', () => {
equal(format('div>p'), '<div>\n\t<p></p>\n</div>');
equal(format('div>p*3'), '<div>\n\t<p></p>\n\t<p></p>\n\t<p></p>\n</div>');
equal(format('div#a>p.b*2>span'), '<div id="a">\n\t<p class="b"><span></span></p>\n\t<p class="b"><span></span></p>\n</div>');
equal(format('div>div>div'), '<div>\n\t<div>\n\t\t<div></div>\n\t</div>\n</div>');
equal(format('table>tr*2>td{item}*2'),
'<table>\n\t<tr>\n\t\t<td>item</td>\n\t\t<td>item</td>\n\t</tr>\n\t<tr>\n\t\t<td>item</td>\n\t\t<td>item</td>\n\t</tr>\n</table>');
});
it('inline elements', () => {
const profile = createProfile({ 'output.inlineBreak': 3 });
const breakInline = createProfile({ 'output.inlineBreak': 1 });
const keepInline = createProfile({ 'output.inlineBreak': 0 });
const xhtml = createProfile({ 'output.selfClosingStyle': 'xhtml' });
equal(format('div>a>b*3', xhtml), '<div>\n\t<a href="">\n\t\t<b></b>\n\t\t<b></b>\n\t\t<b></b>\n\t</a>\n</div>');
equal(format('p>i', profile), '<p><i></i></p>');
equal(format('p>i*2', profile), '<p><i></i><i></i></p>');
equal(format('p>i*2', breakInline), '<p>\n\t<i></i>\n\t<i></i>\n</p>');
equal(format('p>i*3', profile), '<p>\n\t<i></i>\n\t<i></i>\n\t<i></i>\n</p>');
equal(format('p>i*3', keepInline), '<p><i></i><i></i><i></i></p>');
equal(format('i*2', profile), '<i></i><i></i>');
equal(format('i*3', profile), '<i></i>\n<i></i>\n<i></i>');
equal(format('i{a}+i{b}', profile), '<i>a</i><i>b</i>');
equal(format('img[src]/+p', xhtml), '<img src="" alt="" />\n<p></p>');
equal(format('div>img[src]/+p', xhtml), '<div>\n\t<img src="" alt="" />\n\t<p></p>\n</div>');
equal(format('div>p+img[src]/', xhtml), '<div>\n\t<p></p>\n\t<img src="" alt="" />\n</div>');
equal(format('div>p+img[src]/+p', xhtml), '<div>\n\t<p></p>\n\t<img src="" alt="" />\n\t<p></p>\n</div>');
equal(format('div>p+img[src]/*2+p', xhtml), '<div>\n\t<p></p>\n\t<img src="" alt="" /><img src="" alt="" />\n\t<p></p>\n</div>');
equal(format('div>p+img[src]/*3+p', xhtml), '<div>\n\t<p></p>\n\t<img src="" alt="" />\n\t<img src="" alt="" />\n\t<img src="" alt="" />\n\t<p></p>\n</div>');
});
it('generate fields', () => {
equal(format('a[href]', field), '<a href="${1}">${2}</a>');
equal(format('a[href]*2', field), '<a href="${1}">${2}</a><a href="${3}">${4}</a>');
equal(format('{${0} ${1:foo} ${2:bar}}*2', field), '${1} ${2:foo} ${3:bar}\n${4} ${5:foo} ${6:bar}');
equal(format('{${0} ${1:foo} ${2:bar}}*2'), ' foo bar\n foo bar');
equal(format('ul>li*2', field), '<ul>\n\t<li>${1}</li>\n\t<li>${2}</li>\n</ul>');
equal(format('div>img[src]/', field), '<div><img src="${1}" alt="${2}"></div>');
});
// it.only('debug', () => {
// equal(format('div>{foo}+{bar}+p'), '<div>\n\tfoobar\n\t<p></p>\n</div>');
// });
it('mixed content', () => {
equal(format('div{foo}'), '<div>foo</div>');
equal(format('div>{foo}'), '<div>foo</div>');
equal(format('div>{foo}+{bar}'), '<div>\n\tfoo\n\tbar\n</div>');
equal(format('div>{foo}+{bar}+p'), '<div>\n\tfoo\n\tbar\n\t<p></p>\n</div>');
equal(format('div>{foo}+{bar}+p+{foo}+{bar}+p'), '<div>\n\tfoo\n\tbar\n\t<p></p>\n\tfoo\n\tbar\n\t<p></p>\n</div>');
equal(format('div>{foo}+p+{bar}'), '<div>\n\tfoo\n\t<p></p>\n\tbar\n</div>');
equal(format('div>{foo}>p'), '<div>\n\tfoo\n\t<p></p>\n</div>');
equal(format('div>{<!-- ${0} -->}'), '<div><!-- --></div>');
equal(format('div>{<!-- ${0} -->}+p'), '<div>\n\t<!-- -->\n\t<p></p>\n</div>');
equal(format('div>p+{<!-- ${0} -->}'), '<div>\n\t<p></p>\n\t<!-- -->\n</div>');
equal(format('div>{<!-- ${0} -->}>p'), '<div>\n\t<!-- <p></p> -->\n</div>');
equal(format('div>{<!-- ${0} -->}*2>p'), '<div>\n\t<!-- <p></p> -->\n\t<!-- <p></p> -->\n</div>');
equal(format('div>{<!-- ${0} -->}>p*2'), '<div>\n\t<!-- \n\t<p></p>\n\t<p></p>\n\t-->\n</div>');
equal(format('div>{<!-- ${0} -->}*2>p*2'), '<div>\n\t<!-- \n\t<p></p>\n\t<p></p>\n\t-->\n\t<!-- \n\t<p></p>\n\t<p></p>\n\t-->\n</div>');
equal(format('div>{<!-- ${0} -->}>b'), '<div>\n\t<!-- <b></b> -->\n</div>');
equal(format('div>{<!-- ${0} -->}>b*2'), '<div>\n\t<!-- <b></b><b></b> -->\n</div>');
equal(format('div>{<!-- ${0} -->}>b*3'), '<div>\n\t<!-- \n\t<b></b>\n\t<b></b>\n\t<b></b>\n\t-->\n</div>');
equal(format('div>{<!-- ${0} -->}', field), '<div><!-- ${1} --></div>');
equal(format('div>{<!-- ${0} -->}>b', field), '<div>\n\t<!-- <b>${1}</b> -->\n</div>');
});
it('self-closing', () => {
const xmlStyle = createProfile({ 'output.selfClosingStyle': 'xml' });
const htmlStyle = createProfile({ 'output.selfClosingStyle': 'html' });
const xhtmlStyle = createProfile({ 'output.selfClosingStyle': 'xhtml' });
equal(format('img[src]/', htmlStyle), '<img src="" alt="">');
equal(format('img[src]/', xhtmlStyle), '<img src="" alt="" />');
equal(format('img[src]/', xmlStyle), '<img src="" alt=""/>');
equal(format('div>img[src]/', xhtmlStyle), '<div><img src="" alt="" /></div>');
});
it('boolean attributes', () => {
const compact = createProfile({ 'output.compactBoolean': true });
const noCompact = createProfile({ 'output.compactBoolean': false });
equal(format('p[b.]', noCompact), '<p b="b"></p>');
equal(format('p[b.]', compact), '<p b></p>');
equal(format('p[contenteditable]', compact), '<p contenteditable></p>');
equal(format('p[contenteditable]', noCompact), '<p contenteditable="contenteditable"></p>');
equal(format('p[contenteditable=foo]', compact), '<p contenteditable="foo"></p>');
});
it('no formatting', () => {
const profile = createProfile({ 'output.format': false });
equal(format('div>p', profile), '<div><p></p></div>');
equal(format('div>{foo}+p+{bar}', profile), '<div>foo<p></p>bar</div>');
equal(format('div>{foo}>p', profile), '<div>foo<p></p></div>');
equal(format('div>{<!-- ${0} -->}>p', profile), '<div><!-- <p></p> --></div>');
'<!DOCTYPE html>\n<html>\n<head>\n\t<meta charset="charset">\n\t<title>${2:Document}</title>\n</head>\n<body>\n\t${3}\n</body>\n</html>');
});
it.only('comment', () => {
const opt = createConfig();
opt.options.comment = { enabled: true };
it('comment', () => {
const opt = createConfig({ options: { 'comment.enabled': true } });
equal(format('ul>li.item', opt), '<ul>\n\t<li class="item"></li>\n\t<!-- /.item -->\n</ul>');
equal(format('div>ul>li.item#foo', opt), '<div>\n\t<ul>\n\t\t<li class="item" id="foo"></li>\n\t\t<!-- /#foo.item -->\n\t</ul>\n</div>');
opt.options['comment.after'] = ' { [%ID] }';
equal(format('div>ul>li.item#foo', opt), '<div>\n\t<ul>\n\t\t<li class="item" id="foo"></li> { %foo }\n\t</ul>\n</div>');
});
});
describe('HAML', () => {
const format = (abbr: string, config = defaultConfig) => haml(parse(abbr, config), config);
it('basic', () => {
equal(format('div#header>ul.nav>li[title=test].nav-item*2'),
'#header\n\t%ul.nav\n\t\t%li.nav-item(title="test") \n\t\t%li.nav-item(title="test") ');
// https://github.com/emmetio/emmet/issues/446
equal(format('li>a'), '%li\n\t%a(href="") ');
equal(format('div#foo[data-n1=v1 title=test data-n2=v2].bar'),
'#foo.bar(data-n1="v1" title="test" data-n2="v2") ');
let profile = createProfile({ 'output.compactBoolean': true });
equal(format('input[disabled. foo title=test]/', profile), '%input(type="text" disabled foo="" title="test")/');
profile = createProfile({ 'output.compactBoolean': false });
equal(format('input[disabled. foo title=test]/', profile), '%input(type="text" disabled=true foo="" title="test")/');
});
it('nodes with text', () => {
equal(format('{Text 1}'), 'Text 1');
equal(format('span{Text 1}'), '%span Text 1');
equal(format('span{Text 1}>b{Text 2}'), '%span Text 1\n\t%b Text 2');
equal(format('span{Text 1\nText 2}>b{Text 3}'), '%span\n\tText 1 |\n\tText 2 |\n\t%b Text 3');
equal(format('div>span{Text 1\nText 2\nText 123}>b{Text 3}'), '%div\n\t%span\n\t\tText 1 |\n\t\tText 2 |\n\t\tText 123 |\n\t\t%b Text 3');
});
it('generate fields', () => {
equal(format('a[href]', field), '%a(href="${1}") ${2}');
equal(format('a[href]*2', field), '%a(href="${1}") ${2}\n%a(href="${3}") ${4}');
equal(format('{${0} ${1:foo} ${2:bar}}*2', field), '${1} ${2:foo} ${3:bar}${4} ${5:foo} ${6:bar}');
equal(format('{${0} ${1:foo} ${2:bar}}*2'), ' foo bar foo bar');
equal(format('ul>li*2', field), '%ul\n\t%li ${1}\n\t%li ${2}');
equal(format('div>img[src]/', field), '%div\n\t%img(src="${1}" alt="${2}")/');
});
});
describe('Pug', () => {
const format = (abbr: string, config = defaultConfig) => pug(parse(abbr, config), config);
it('basic', () => {
equal(format('div#header>ul.nav>li[title=test].nav-item*2'),
'#header\n\tul.nav\n\t\tli.nav-item(title="test") \n\t\tli.nav-item(title="test") ');
equal(format('div#foo[data-n1=v1 title=test data-n2=v2].bar'),
'#foo.bar(data-n1="v1", title="test", data-n2="v2") ');
equal(format('input[disabled. foo title=test]'), 'input(type="text", disabled, foo="", title="test")');
// Use closing slash for XML output format
equal(format('input[disabled. foo title=test]', createProfile({ 'output.selfClosingStyle': 'xml' })), 'input(type="text", disabled, foo="", title="test")/');
});
it('nodes with text', () => {
equal(format('{Text 1}'), 'Text 1');
equal(format('span{Text 1}'), 'span Text 1');
equal(format('span{Text 1}>b{Text 2}'), 'span Text 1\n\tb Text 2');
equal(format('span{Text 1\nText 2}>b{Text 3}'), 'span\n\t| Text 1\n\t| Text 2\n\tb Text 3');
equal(format('div>span{Text 1\nText 2}>b{Text 3}'), 'div\n\tspan\n\t\t| Text 1\n\t\t| Text 2\n\t\tb Text 3');
});
it('generate fields', () => {
equal(format('a[href]', field), 'a(href="${1}") ${2}');
equal(format('a[href]*2', field), 'a(href="${1}") ${2}\na(href="${3}") ${4}');
equal(format('{${0} ${1:foo} ${2:bar}}*2', field), '${1} ${2:foo} ${3:bar}${4} ${5:foo} ${6:bar}');
equal(format('{${0} ${1:foo} ${2:bar}}*2'), ' foo bar foo bar');
equal(format('ul>li*2', field), 'ul\n\tli ${1}\n\tli ${2}');
equal(format('div>img[src]/', field), 'div\n\timg(src="${1}", alt="${2}")');
});
});
describe('Slim', () => {
const format = (abbr: string, config = defaultConfig) => slim(parse(abbr, config), config);
it('basic', () => {
equal(format('div#header>ul.nav>li[title=test].nav-item*2'),
'#header\n\tul.nav\n\t\tli.nav-item title="test" \n\t\tli.nav-item title="test" ');
equal(format('div#foo[data-n1=v1 title=test data-n2=v2].bar'),
'#foo.bar data-n1="v1" title="test" data-n2="v2" ');
// const profile = createProfile({ inlineBreak: 0 });
// equal(format('ul>li>span{Text}', profile), 'ul\n\tli: span Text');
// equal(format('ul>li>span{Text}'), 'ul\n\tli\n\t\tspan Text');
// equal(format('ul>li>span{Text}*2', profile), 'ul\n\tli\n\t\tspan Text\n\t\tspan Text');
});
// it.skip('attribute wrappers', () => {
// equal(format('input[disabled. foo title=test]'), 'input disabled=true foo="" title="test"');
// equal(format('input[disabled. foo title=test]', null, { attributeWrap: 'round' }),
// 'input(disabled foo="" title="test")');
// });
it('nodes with text', () => {
equal(format('{Text 1}'), 'Text 1');
equal(format('span{Text 1}'), 'span Text 1');
equal(format('span{Text 1}>b{Text 2}'), 'span Text 1\n\tb Text 2');
equal(format('span{Text 1\nText 2}>b{Text 3}'), 'span\n\t| Text 1\n\t| Text 2\n\tb Text 3');
equal(format('div>span{Text 1\nText 2}>b{Text 3}'), 'div\n\tspan\n\t\t| Text 1\n\t\t| Text 2\n\t\tb Text 3');
});
it('generate fields', () => {
equal(format('a[href]', field), 'a href="${1}" ${2}');
equal(format('a[href]*2', field), 'a href="${1}" ${2}\na href="${3}" ${4}');
equal(format('{${0} ${1:foo} ${2:bar}}*2', field), '${1} ${2:foo} ${3:bar}${4} ${5:foo} ${6:bar}');
equal(format('{${0} ${1:foo} ${2:bar}}*2'), ' foo bar foo bar');
equal(format('ul>li*2', field), 'ul\n\tli ${1}\n\tli ${2}');
equal(format('div>img[src]/', field), 'div\n\timg src="${1}" alt="${2}"/');
});
});
});
<MSG> Support node commenting
<DFF> @@ -15,7 +15,7 @@ describe('Format', () => {
return config;
}
- describe.only('HTML', () => {
+ describe('HTML', () => {
const format = (abbr: string, config = defaultConfig) => html(parse(abbr, config), config);
it('basic', () => {
equal(format('div>p'), '<div>\n\t<p></p>\n</div>');
@@ -127,7 +127,7 @@ describe('Format', () => {
'<!DOCTYPE html>\n<html>\n<head>\n\t<meta charset="charset">\n\t<title>${2:Document}</title>\n</head>\n<body>\n\t${3}\n</body>\n</html>');
});
- it.only('comment', () => {
+ it('comment', () => {
const opt = createConfig();
opt.options.comment = { enabled: true };
| 2 | Support node commenting | 2 | .ts | ts | mit | emmetio/emmet |
10072407 | <NME> urls.py
<BEF> # -*- coding: utf-8 -*-
from django.conf.urls.defaults import patterns, url, include
from django.conf import settings
from django.contrib import admin
admin.autodiscover()
urlpatterns = patterns('')
# Serve static pages.
if settings.LOCAL_DEVELOPMENT:
urlpatterns += patterns("django.views",
url(r"^%s(?P<path>.*)$" % settings.MEDIA_URL[1:], "static.serve", {
"document_root": settings.MEDIA_ROOT}))
urlpatterns += patterns("",
# Admin interface
url(r'^admin/doc/', include("django.contrib.admindocs.urls")),
url(r'^admin/(.*)', admin.site.root),
# Registration
url(r'^accounts/', include('registration.backends.default.urls')),
# The Chishop
url(r'', include("djangopypi.urls"))
)
<MSG> bugfix: 404 and 505 pages could not be showed, not they can.
<DFF> @@ -1,5 +1,5 @@
# -*- coding: utf-8 -*-
-from django.conf.urls.defaults import patterns, url, include
+from django.conf.urls.defaults import patterns, url, include, handler404, handler500
from django.conf import settings
from django.contrib import admin
| 1 | bugfix: 404 and 505 pages could not be showed, not they can. | 1 | .py | py | bsd-3-clause | ask/chishop |
10072408 | <NME> algorithms.rb
<BEF> require 'rubystats'
module Split
module Split
module Algorithms
class << self
def beta_distribution_rng(a, b)
Rubystats::BetaDistribution.new(a, b).rng
end
end
end
end
<MSG> Require matrix to be installed in order to make it compatible with Ruby 3.1+
<DFF> @@ -1,3 +1,12 @@
+begin
+ require "matrix"
+rescue LoadError => error
+ if error.message.match?(/matrix/)
+ $stderr.puts "You don't have matrix installed in your application. Please add it to your Gemfile and run bundle install"
+ raise
+ end
+end
+
require 'rubystats'
module Split
| 9 | Require matrix to be installed in order to make it compatible with Ruby 3.1+ | 0 | .rb | rb | mit | splitrb/split |
10072409 | <NME> algorithms.rb
<BEF> require 'rubystats'
module Split
module Split
module Algorithms
class << self
def beta_distribution_rng(a, b)
Rubystats::BetaDistribution.new(a, b).rng
end
end
end
end
<MSG> Require matrix to be installed in order to make it compatible with Ruby 3.1+
<DFF> @@ -1,3 +1,12 @@
+begin
+ require "matrix"
+rescue LoadError => error
+ if error.message.match?(/matrix/)
+ $stderr.puts "You don't have matrix installed in your application. Please add it to your Gemfile and run bundle install"
+ raise
+ end
+end
+
require 'rubystats'
module Split
| 9 | Require matrix to be installed in order to make it compatible with Ruby 3.1+ | 0 | .rb | rb | mit | splitrb/split |
10072410 | <NME> algorithms.rb
<BEF> require 'rubystats'
module Split
module Split
module Algorithms
class << self
def beta_distribution_rng(a, b)
Rubystats::BetaDistribution.new(a, b).rng
end
end
end
end
<MSG> Require matrix to be installed in order to make it compatible with Ruby 3.1+
<DFF> @@ -1,3 +1,12 @@
+begin
+ require "matrix"
+rescue LoadError => error
+ if error.message.match?(/matrix/)
+ $stderr.puts "You don't have matrix installed in your application. Please add it to your Gemfile and run bundle install"
+ raise
+ end
+end
+
require 'rubystats'
module Split
| 9 | Require matrix to be installed in order to make it compatible with Ruby 3.1+ | 0 | .rb | rb | mit | splitrb/split |
10072411 | <NME> user_spec.rb
<BEF> # frozen_string_literal: true
require "spec_helper"
require 'split/user'
describe Split::User do
let(:context) do
double(:session => { split: { 'link_color' => 'blue' } })
end
before(:each) do
@subject = described_class.new(context)
before(:each) do
@subject = described_class.new(context)
end
expect(@subject['link_color']).to eq(@subject.user['link_color'])
end
context '#cleanup_old_experiments' do
let(:experiment) { Split::Experiment.new('link_color') }
it 'removes key if experiment is not found' do
@subject.cleanup_old_experiments
expect(@subject.keys).to be_empty
end
allow(Split::ExperimentCatalog).to receive(:find).with('link_color').and_return(experiment)
allow(experiment).to receive(:start_time).and_return(Date.today)
allow(experiment).to receive(:has_winner?).and_return(true)
@subject.cleanup_old_experiments
expect(@subject.keys).to be_empty
end
it 'removes key if experiment has not started yet' do
allow(Split::ExperimentCatalog).to receive(:find).with('link_color').and_return(experiment)
allow(experiment).to receive(:has_winner?).and_return(false)
@subject.cleanup_old_experiments
expect(@subject.keys).to be_empty
end
end
it "removes key if experiment has a winner" do
allow(Split::ExperimentCatalog).to receive(:find).with("link_color").and_return(experiment)
allow(experiment).to receive(:start_time).and_return(Date.today)
allow(experiment).to receive(:has_winner?).and_return(true)
@subject.cleanup_old_experiments!
expect(@subject.keys).to be_empty
end
it "removes key if experiment has not started yet" do
allow(Split::ExperimentCatalog).to receive(:find).with("link_color").and_return(experiment)
allow(experiment).to receive(:has_winner?).and_return(false)
@subject.cleanup_old_experiments!
expect(@subject.keys).to be_empty
end
context "with finished key" do
let(:user_keys) { { "link_color" => "blue", "link_color:finished" => true } }
it "does not remove finished key for experiment without a winner" do
allow(Split::ExperimentCatalog).to receive(:find).with("link_color").and_return(experiment)
allow(Split::ExperimentCatalog).to receive(:find).with("link_color:finished").and_return(nil)
allow(experiment).to receive(:start_time).and_return(Date.today)
allow(experiment).to receive(:has_winner?).and_return(false)
@subject.cleanup_old_experiments!
expect(@subject.keys).to include("link_color")
expect(@subject.keys).to include("link_color:finished")
end
end
context "when already cleaned up" do
before do
@subject.cleanup_old_experiments!
end
it "does not clean up again" do
expect(@subject).to_not receive(:keys_without_finished)
@subject.cleanup_old_experiments!
end
end
end
context "allows user to be loaded from adapter" do
it "loads user from adapter (RedisAdapter)" do
user = Split::Persistence::RedisAdapter.new(nil, 112233)
user["foo"] = "bar"
ab_user = Split::User.find(112233, :redis)
expect(ab_user["foo"]).to eql("bar")
end
it "returns nil if adapter does not implement a finder method" do
ab_user = Split::User.find(112233, :dual_adapter)
expect(ab_user).to be_nil
end
end
context "instantiated with custom adapter" do
let(:custom_adapter) { double(:persistence_adapter) }
before do
@subject = described_class.new(context, custom_adapter)
end
it "sets user to the custom adapter" do
expect(@subject.user).to eq(custom_adapter)
end
end
end
<MSG> Merge pull request #384 from andreibondarev/expand-user-abstraction
Growing the User abstraction; refactoring
<DFF> @@ -4,9 +4,9 @@ require 'split/experiment'
require 'split/user'
describe Split::User do
- let(:context) do
- double(:session => { split: { 'link_color' => 'blue' } })
- end
+ let(:user_keys) { { 'link_color' => 'blue' } }
+ let(:context) { double(:session => { split: user_keys }) }
+ let(:experiment) { Split::Experiment.new('link_color') }
before(:each) do
@subject = described_class.new(context)
@@ -16,11 +16,18 @@ describe Split::User do
expect(@subject['link_color']).to eq(@subject.user['link_color'])
end
- context '#cleanup_old_experiments' do
- let(:experiment) { Split::Experiment.new('link_color') }
+ context '#cleanup_old_versions!' do
+ let(:user_keys) { { 'link_color:1' => 'blue' } }
+
+ it 'removes key if old experiment is found' do
+ @subject.cleanup_old_versions!(experiment)
+ expect(@subject.keys).to be_empty
+ end
+ end
+ context '#cleanup_old_experiments!' do
it 'removes key if experiment is not found' do
- @subject.cleanup_old_experiments
+ @subject.cleanup_old_experiments!
expect(@subject.keys).to be_empty
end
@@ -28,14 +35,14 @@ describe Split::User do
allow(Split::ExperimentCatalog).to receive(:find).with('link_color').and_return(experiment)
allow(experiment).to receive(:start_time).and_return(Date.today)
allow(experiment).to receive(:has_winner?).and_return(true)
- @subject.cleanup_old_experiments
+ @subject.cleanup_old_experiments!
expect(@subject.keys).to be_empty
end
it 'removes key if experiment has not started yet' do
allow(Split::ExperimentCatalog).to receive(:find).with('link_color').and_return(experiment)
allow(experiment).to receive(:has_winner?).and_return(false)
- @subject.cleanup_old_experiments
+ @subject.cleanup_old_experiments!
expect(@subject.keys).to be_empty
end
end
| 15 | Merge pull request #384 from andreibondarev/expand-user-abstraction | 8 | .rb | rb | mit | splitrb/split |
10072412 | <NME> user_spec.rb
<BEF> # frozen_string_literal: true
require "spec_helper"
require 'split/user'
describe Split::User do
let(:context) do
double(:session => { split: { 'link_color' => 'blue' } })
end
before(:each) do
@subject = described_class.new(context)
before(:each) do
@subject = described_class.new(context)
end
expect(@subject['link_color']).to eq(@subject.user['link_color'])
end
context '#cleanup_old_experiments' do
let(:experiment) { Split::Experiment.new('link_color') }
it 'removes key if experiment is not found' do
@subject.cleanup_old_experiments
expect(@subject.keys).to be_empty
end
allow(Split::ExperimentCatalog).to receive(:find).with('link_color').and_return(experiment)
allow(experiment).to receive(:start_time).and_return(Date.today)
allow(experiment).to receive(:has_winner?).and_return(true)
@subject.cleanup_old_experiments
expect(@subject.keys).to be_empty
end
it 'removes key if experiment has not started yet' do
allow(Split::ExperimentCatalog).to receive(:find).with('link_color').and_return(experiment)
allow(experiment).to receive(:has_winner?).and_return(false)
@subject.cleanup_old_experiments
expect(@subject.keys).to be_empty
end
end
it "removes key if experiment has a winner" do
allow(Split::ExperimentCatalog).to receive(:find).with("link_color").and_return(experiment)
allow(experiment).to receive(:start_time).and_return(Date.today)
allow(experiment).to receive(:has_winner?).and_return(true)
@subject.cleanup_old_experiments!
expect(@subject.keys).to be_empty
end
it "removes key if experiment has not started yet" do
allow(Split::ExperimentCatalog).to receive(:find).with("link_color").and_return(experiment)
allow(experiment).to receive(:has_winner?).and_return(false)
@subject.cleanup_old_experiments!
expect(@subject.keys).to be_empty
end
context "with finished key" do
let(:user_keys) { { "link_color" => "blue", "link_color:finished" => true } }
it "does not remove finished key for experiment without a winner" do
allow(Split::ExperimentCatalog).to receive(:find).with("link_color").and_return(experiment)
allow(Split::ExperimentCatalog).to receive(:find).with("link_color:finished").and_return(nil)
allow(experiment).to receive(:start_time).and_return(Date.today)
allow(experiment).to receive(:has_winner?).and_return(false)
@subject.cleanup_old_experiments!
expect(@subject.keys).to include("link_color")
expect(@subject.keys).to include("link_color:finished")
end
end
context "when already cleaned up" do
before do
@subject.cleanup_old_experiments!
end
it "does not clean up again" do
expect(@subject).to_not receive(:keys_without_finished)
@subject.cleanup_old_experiments!
end
end
end
context "allows user to be loaded from adapter" do
it "loads user from adapter (RedisAdapter)" do
user = Split::Persistence::RedisAdapter.new(nil, 112233)
user["foo"] = "bar"
ab_user = Split::User.find(112233, :redis)
expect(ab_user["foo"]).to eql("bar")
end
it "returns nil if adapter does not implement a finder method" do
ab_user = Split::User.find(112233, :dual_adapter)
expect(ab_user).to be_nil
end
end
context "instantiated with custom adapter" do
let(:custom_adapter) { double(:persistence_adapter) }
before do
@subject = described_class.new(context, custom_adapter)
end
it "sets user to the custom adapter" do
expect(@subject.user).to eq(custom_adapter)
end
end
end
<MSG> Merge pull request #384 from andreibondarev/expand-user-abstraction
Growing the User abstraction; refactoring
<DFF> @@ -4,9 +4,9 @@ require 'split/experiment'
require 'split/user'
describe Split::User do
- let(:context) do
- double(:session => { split: { 'link_color' => 'blue' } })
- end
+ let(:user_keys) { { 'link_color' => 'blue' } }
+ let(:context) { double(:session => { split: user_keys }) }
+ let(:experiment) { Split::Experiment.new('link_color') }
before(:each) do
@subject = described_class.new(context)
@@ -16,11 +16,18 @@ describe Split::User do
expect(@subject['link_color']).to eq(@subject.user['link_color'])
end
- context '#cleanup_old_experiments' do
- let(:experiment) { Split::Experiment.new('link_color') }
+ context '#cleanup_old_versions!' do
+ let(:user_keys) { { 'link_color:1' => 'blue' } }
+
+ it 'removes key if old experiment is found' do
+ @subject.cleanup_old_versions!(experiment)
+ expect(@subject.keys).to be_empty
+ end
+ end
+ context '#cleanup_old_experiments!' do
it 'removes key if experiment is not found' do
- @subject.cleanup_old_experiments
+ @subject.cleanup_old_experiments!
expect(@subject.keys).to be_empty
end
@@ -28,14 +35,14 @@ describe Split::User do
allow(Split::ExperimentCatalog).to receive(:find).with('link_color').and_return(experiment)
allow(experiment).to receive(:start_time).and_return(Date.today)
allow(experiment).to receive(:has_winner?).and_return(true)
- @subject.cleanup_old_experiments
+ @subject.cleanup_old_experiments!
expect(@subject.keys).to be_empty
end
it 'removes key if experiment has not started yet' do
allow(Split::ExperimentCatalog).to receive(:find).with('link_color').and_return(experiment)
allow(experiment).to receive(:has_winner?).and_return(false)
- @subject.cleanup_old_experiments
+ @subject.cleanup_old_experiments!
expect(@subject.keys).to be_empty
end
end
| 15 | Merge pull request #384 from andreibondarev/expand-user-abstraction | 8 | .rb | rb | mit | splitrb/split |
10072413 | <NME> user_spec.rb
<BEF> # frozen_string_literal: true
require "spec_helper"
require 'split/user'
describe Split::User do
let(:context) do
double(:session => { split: { 'link_color' => 'blue' } })
end
before(:each) do
@subject = described_class.new(context)
before(:each) do
@subject = described_class.new(context)
end
expect(@subject['link_color']).to eq(@subject.user['link_color'])
end
context '#cleanup_old_experiments' do
let(:experiment) { Split::Experiment.new('link_color') }
it 'removes key if experiment is not found' do
@subject.cleanup_old_experiments
expect(@subject.keys).to be_empty
end
allow(Split::ExperimentCatalog).to receive(:find).with('link_color').and_return(experiment)
allow(experiment).to receive(:start_time).and_return(Date.today)
allow(experiment).to receive(:has_winner?).and_return(true)
@subject.cleanup_old_experiments
expect(@subject.keys).to be_empty
end
it 'removes key if experiment has not started yet' do
allow(Split::ExperimentCatalog).to receive(:find).with('link_color').and_return(experiment)
allow(experiment).to receive(:has_winner?).and_return(false)
@subject.cleanup_old_experiments
expect(@subject.keys).to be_empty
end
end
it "removes key if experiment has a winner" do
allow(Split::ExperimentCatalog).to receive(:find).with("link_color").and_return(experiment)
allow(experiment).to receive(:start_time).and_return(Date.today)
allow(experiment).to receive(:has_winner?).and_return(true)
@subject.cleanup_old_experiments!
expect(@subject.keys).to be_empty
end
it "removes key if experiment has not started yet" do
allow(Split::ExperimentCatalog).to receive(:find).with("link_color").and_return(experiment)
allow(experiment).to receive(:has_winner?).and_return(false)
@subject.cleanup_old_experiments!
expect(@subject.keys).to be_empty
end
context "with finished key" do
let(:user_keys) { { "link_color" => "blue", "link_color:finished" => true } }
it "does not remove finished key for experiment without a winner" do
allow(Split::ExperimentCatalog).to receive(:find).with("link_color").and_return(experiment)
allow(Split::ExperimentCatalog).to receive(:find).with("link_color:finished").and_return(nil)
allow(experiment).to receive(:start_time).and_return(Date.today)
allow(experiment).to receive(:has_winner?).and_return(false)
@subject.cleanup_old_experiments!
expect(@subject.keys).to include("link_color")
expect(@subject.keys).to include("link_color:finished")
end
end
context "when already cleaned up" do
before do
@subject.cleanup_old_experiments!
end
it "does not clean up again" do
expect(@subject).to_not receive(:keys_without_finished)
@subject.cleanup_old_experiments!
end
end
end
context "allows user to be loaded from adapter" do
it "loads user from adapter (RedisAdapter)" do
user = Split::Persistence::RedisAdapter.new(nil, 112233)
user["foo"] = "bar"
ab_user = Split::User.find(112233, :redis)
expect(ab_user["foo"]).to eql("bar")
end
it "returns nil if adapter does not implement a finder method" do
ab_user = Split::User.find(112233, :dual_adapter)
expect(ab_user).to be_nil
end
end
context "instantiated with custom adapter" do
let(:custom_adapter) { double(:persistence_adapter) }
before do
@subject = described_class.new(context, custom_adapter)
end
it "sets user to the custom adapter" do
expect(@subject.user).to eq(custom_adapter)
end
end
end
<MSG> Merge pull request #384 from andreibondarev/expand-user-abstraction
Growing the User abstraction; refactoring
<DFF> @@ -4,9 +4,9 @@ require 'split/experiment'
require 'split/user'
describe Split::User do
- let(:context) do
- double(:session => { split: { 'link_color' => 'blue' } })
- end
+ let(:user_keys) { { 'link_color' => 'blue' } }
+ let(:context) { double(:session => { split: user_keys }) }
+ let(:experiment) { Split::Experiment.new('link_color') }
before(:each) do
@subject = described_class.new(context)
@@ -16,11 +16,18 @@ describe Split::User do
expect(@subject['link_color']).to eq(@subject.user['link_color'])
end
- context '#cleanup_old_experiments' do
- let(:experiment) { Split::Experiment.new('link_color') }
+ context '#cleanup_old_versions!' do
+ let(:user_keys) { { 'link_color:1' => 'blue' } }
+
+ it 'removes key if old experiment is found' do
+ @subject.cleanup_old_versions!(experiment)
+ expect(@subject.keys).to be_empty
+ end
+ end
+ context '#cleanup_old_experiments!' do
it 'removes key if experiment is not found' do
- @subject.cleanup_old_experiments
+ @subject.cleanup_old_experiments!
expect(@subject.keys).to be_empty
end
@@ -28,14 +35,14 @@ describe Split::User do
allow(Split::ExperimentCatalog).to receive(:find).with('link_color').and_return(experiment)
allow(experiment).to receive(:start_time).and_return(Date.today)
allow(experiment).to receive(:has_winner?).and_return(true)
- @subject.cleanup_old_experiments
+ @subject.cleanup_old_experiments!
expect(@subject.keys).to be_empty
end
it 'removes key if experiment has not started yet' do
allow(Split::ExperimentCatalog).to receive(:find).with('link_color').and_return(experiment)
allow(experiment).to receive(:has_winner?).and_return(false)
- @subject.cleanup_old_experiments
+ @subject.cleanup_old_experiments!
expect(@subject.keys).to be_empty
end
end
| 15 | Merge pull request #384 from andreibondarev/expand-user-abstraction | 8 | .rb | rb | mit | splitrb/split |
10072414 | <NME> configuration_spec.rb
<BEF> # frozen_string_literal: true
require "spec_helper"
describe Split::Configuration do
before(:each) { @config = Split::Configuration.new }
it "should provide a default value for ignore_ip_addresses" do
expect(@config.ignore_ip_addresses).to eq([])
end
it "should provide default values for db failover" do
expect(@config.db_failover).to be_falsey
expect(@config.db_failover_on_db_error).to be_a Proc
end
it "should not allow multiple experiments by default" do
expect(@config.allow_multiple_experiments).to be_falsey
end
it "should be enabled by default" do
expect(@config.enabled).to be_truthy
end
it "disabled is the opposite of enabled" do
@config.enabled = false
expect(@config.disabled?).to be_truthy
end
it "should not store the overridden test group per default" do
expect(@config.store_override).to be_falsey
end
it "should provide a default pattern for robots" do
%w[Baidu Gigabot Googlebot libwww-perl lwp-trivial msnbot SiteUptime Slurp WordPress ZIBB ZyBorg YandexBot AdsBot-Google Wget curl bitlybot facebookexternalhit spider].each do |robot|
expect(@config.robot_regex).to match(robot)
end
expect(@config.robot_regex).to match("EventMachine HttpClient")
expect(@config.robot_regex).to match("libwww-perl/5.836")
expect(@config.robot_regex).to match("Pingdom.com_bot_version_1.4_(http://www.pingdom.com)")
expect(@config.robot_regex).to match(" - ")
end
it "should accept real UAs with the robot regexp" do
expect(@config.robot_regex).not_to match("Mozilla/5.0 (Windows; U; Windows NT 6.0; en-US; rv:1.9.1.4) Gecko/20091017 SeaMonkey/2.0")
expect(@config.robot_regex).not_to match("Mozilla/4.0 (compatible; MSIE 8.0; Windows NT 5.1; Trident/4.0; F-6.0SP2-20041109; .NET CLR 2.0.50727; .NET CLR 3.0.04506.648; .NET CLR 3.5.21022; .NET CLR 1.1.4322; InfoPath.3)")
end
it "should allow adding a bot to the bot list" do
@config.bots["newbot"] = "An amazing test bot"
expect(@config.robot_regex).to match("newbot")
end
it "should use the session adapter for persistence by default" do
expect(@config.persistence).to eq(Split::Persistence::SessionAdapter)
end
it "should load a metric" do
@config.experiments = { my_experiment: { alternatives: ["control_opt", "other_opt"], metric: :my_metric } }
expect(@config.metrics).not_to be_nil
expect(@config.metrics.keys).to eq([:my_metric])
end
it "should allow loading of experiment using experment_for" do
@config.experiments = { my_experiment: { alternatives: ["control_opt", "other_opt"], metric: :my_metric } }
expect(@config.experiment_for(:my_experiment)).to eq({ alternatives: ["control_opt", ["other_opt"]] })
end
context "when experiments are defined via YAML" do
context "as strings" do
context "in a basic configuration" do
before do
experiments_yaml = <<-eos
my_experiment:
alternatives:
- Control Opt
- Alt One
- Alt Two
resettable: false
eos
@config.experiments = YAML.load(experiments_yaml)
end
it "should normalize experiments" do
expect(@config.normalized_experiments).to eq({ my_experiment: { resettable: false, alternatives: ["Control Opt", ["Alt One", "Alt Two"]] } })
end
end
context "in a configuration with metadata" do
before do
experiments_yaml = <<-eos
my_experiment:
alternatives:
- name: Control Opt
percent: 67
- name: Alt One
percent: 10
- name: Alt Two
percent: 23
metadata:
Control Opt:
text: 'Control Option'
Alt One:
text: 'Alternative One'
Alt Two:
text: 'Alternative Two'
resettable: false
eos
@config.experiments = YAML.load(experiments_yaml)
end
it "should have metadata on the experiment" do
meta = @config.normalized_experiments[:my_experiment][:metadata]
expect(meta).to_not be nil
expect(meta["Control Opt"]["text"]).to eq("Control Option")
end
end
context "in a complex configuration" do
before do
experiments_yaml = <<-eos
my_experiment:
alternatives:
- name: Control Opt
percent: 67
- name: Alt One
percent: 10
- name: Alt Two
percent: 23
resettable: false
metric: my_metric
another_experiment:
alternatives:
- a
- b
eos
@config.experiments = YAML.load(experiments_yaml)
end
it "should normalize experiments" do
expect(@config.normalized_experiments).to eq({ my_experiment: { resettable: false, alternatives: [{ "Control Opt"=>0.67 },
[{ "Alt One"=>0.1 }, { "Alt Two"=>0.23 }]] }, another_experiment: { alternatives: ["a", ["b"]] } })
end
it "should recognize metrics" do
expect(@config.metrics).not_to be_nil
expect(@config.metrics.keys).to eq([:my_metric])
end
end
end
context "as symbols" do
context "with valid YAML" do
before do
experiments_yaml = <<-eos
:my_experiment:
:alternatives:
- Control Opt
- Alt One
- Alt Two
:resettable: false
eos
@config.experiments = YAML.load(experiments_yaml)
end
it "should normalize experiments" do
expect(@config.normalized_experiments).to eq({ my_experiment: { resettable: false, alternatives: ["Control Opt", ["Alt One", "Alt Two"]] } })
end
end
context "with invalid YAML" do
let(:yaml) { YAML.load(input) }
context "with an empty string" do
let(:input) { "" }
it "should raise an error" do
expect { @config.experiments = yaml }.to raise_error(Split::InvalidExperimentsFormatError)
end
end
context "with just the YAML header" do
let(:input) { "---" }
it "should raise an error" do
expect { @config.experiments = yaml }.to raise_error(Split::InvalidExperimentsFormatError)
end
end
end
end
end
it "should normalize experiments" do
@config.experiments = {
my_experiment: {
alternatives: [
{ name: "control_opt", percent: 67 },
{ name: "second_opt", percent: 10 },
{ name: "third_opt", percent: 23 },
],
}
}
expect(@config.normalized_experiments).to eq({ my_experiment: { alternatives: [{ "control_opt"=>0.67 }, [{ "second_opt"=>0.1 }, { "third_opt"=>0.23 }]] } })
end
expect(@config.normalized_experiments).to eq({:my_experiment=>{:alternatives=>[{"control_opt"=>0.67}, [{"second_opt"=>0.1}, {"third_opt"=>0.23}]]}})
end
end
context "persistence cookie length" do
it "should default to 1 year" do
expect(@config.persistence_cookie_length).to eq(31536000)
end
it "should allow the persistence cookie length to be configured" do
@config.persistence_cookie_length = 2592000
expect(@config.persistence_cookie_length).to eq(2592000)
end
end
context "persistence cookie domain" do
it "should default to nil" do
expect(@config.persistence_cookie_domain).to eq(nil)
end
it "should allow the persistence cookie domain to be configured" do
@config.persistence_cookie_domain = ".acme.com"
expect(@config.persistence_cookie_domain).to eq(".acme.com")
end
end
end
<MSG> allow for custom redis_url different from ENV variable
<DFF> @@ -210,4 +210,22 @@ describe Split::Configuration do
expect(@config.normalized_experiments).to eq({:my_experiment=>{:alternatives=>[{"control_opt"=>0.67}, [{"second_opt"=>0.1}, {"third_opt"=>0.23}]]}})
end
+
+ context "configuration URL" do
+ it "should default to local redis server" do
+ expect(@config.redis_url).to eq("localhost:6379")
+ end
+
+ it "should allow for redis url to be configured" do
+ @config.redis_url = "custom_redis_url"
+ expect(@config.redis_url).to eq("custom_redis_url")
+ end
+
+ context "provided REDIS_URL environment variable" do
+ it "should use the ENV variable" do
+ ENV['REDIS_URL'] = "env_redis_url"
+ expect(Split::Configuration.new.redis_url).to eq("env_redis_url")
+ end
+ end
+ end
end
| 18 | allow for custom redis_url different from ENV variable | 0 | .rb | rb | mit | splitrb/split |
10072415 | <NME> configuration_spec.rb
<BEF> # frozen_string_literal: true
require "spec_helper"
describe Split::Configuration do
before(:each) { @config = Split::Configuration.new }
it "should provide a default value for ignore_ip_addresses" do
expect(@config.ignore_ip_addresses).to eq([])
end
it "should provide default values for db failover" do
expect(@config.db_failover).to be_falsey
expect(@config.db_failover_on_db_error).to be_a Proc
end
it "should not allow multiple experiments by default" do
expect(@config.allow_multiple_experiments).to be_falsey
end
it "should be enabled by default" do
expect(@config.enabled).to be_truthy
end
it "disabled is the opposite of enabled" do
@config.enabled = false
expect(@config.disabled?).to be_truthy
end
it "should not store the overridden test group per default" do
expect(@config.store_override).to be_falsey
end
it "should provide a default pattern for robots" do
%w[Baidu Gigabot Googlebot libwww-perl lwp-trivial msnbot SiteUptime Slurp WordPress ZIBB ZyBorg YandexBot AdsBot-Google Wget curl bitlybot facebookexternalhit spider].each do |robot|
expect(@config.robot_regex).to match(robot)
end
expect(@config.robot_regex).to match("EventMachine HttpClient")
expect(@config.robot_regex).to match("libwww-perl/5.836")
expect(@config.robot_regex).to match("Pingdom.com_bot_version_1.4_(http://www.pingdom.com)")
expect(@config.robot_regex).to match(" - ")
end
it "should accept real UAs with the robot regexp" do
expect(@config.robot_regex).not_to match("Mozilla/5.0 (Windows; U; Windows NT 6.0; en-US; rv:1.9.1.4) Gecko/20091017 SeaMonkey/2.0")
expect(@config.robot_regex).not_to match("Mozilla/4.0 (compatible; MSIE 8.0; Windows NT 5.1; Trident/4.0; F-6.0SP2-20041109; .NET CLR 2.0.50727; .NET CLR 3.0.04506.648; .NET CLR 3.5.21022; .NET CLR 1.1.4322; InfoPath.3)")
end
it "should allow adding a bot to the bot list" do
@config.bots["newbot"] = "An amazing test bot"
expect(@config.robot_regex).to match("newbot")
end
it "should use the session adapter for persistence by default" do
expect(@config.persistence).to eq(Split::Persistence::SessionAdapter)
end
it "should load a metric" do
@config.experiments = { my_experiment: { alternatives: ["control_opt", "other_opt"], metric: :my_metric } }
expect(@config.metrics).not_to be_nil
expect(@config.metrics.keys).to eq([:my_metric])
end
it "should allow loading of experiment using experment_for" do
@config.experiments = { my_experiment: { alternatives: ["control_opt", "other_opt"], metric: :my_metric } }
expect(@config.experiment_for(:my_experiment)).to eq({ alternatives: ["control_opt", ["other_opt"]] })
end
context "when experiments are defined via YAML" do
context "as strings" do
context "in a basic configuration" do
before do
experiments_yaml = <<-eos
my_experiment:
alternatives:
- Control Opt
- Alt One
- Alt Two
resettable: false
eos
@config.experiments = YAML.load(experiments_yaml)
end
it "should normalize experiments" do
expect(@config.normalized_experiments).to eq({ my_experiment: { resettable: false, alternatives: ["Control Opt", ["Alt One", "Alt Two"]] } })
end
end
context "in a configuration with metadata" do
before do
experiments_yaml = <<-eos
my_experiment:
alternatives:
- name: Control Opt
percent: 67
- name: Alt One
percent: 10
- name: Alt Two
percent: 23
metadata:
Control Opt:
text: 'Control Option'
Alt One:
text: 'Alternative One'
Alt Two:
text: 'Alternative Two'
resettable: false
eos
@config.experiments = YAML.load(experiments_yaml)
end
it "should have metadata on the experiment" do
meta = @config.normalized_experiments[:my_experiment][:metadata]
expect(meta).to_not be nil
expect(meta["Control Opt"]["text"]).to eq("Control Option")
end
end
context "in a complex configuration" do
before do
experiments_yaml = <<-eos
my_experiment:
alternatives:
- name: Control Opt
percent: 67
- name: Alt One
percent: 10
- name: Alt Two
percent: 23
resettable: false
metric: my_metric
another_experiment:
alternatives:
- a
- b
eos
@config.experiments = YAML.load(experiments_yaml)
end
it "should normalize experiments" do
expect(@config.normalized_experiments).to eq({ my_experiment: { resettable: false, alternatives: [{ "Control Opt"=>0.67 },
[{ "Alt One"=>0.1 }, { "Alt Two"=>0.23 }]] }, another_experiment: { alternatives: ["a", ["b"]] } })
end
it "should recognize metrics" do
expect(@config.metrics).not_to be_nil
expect(@config.metrics.keys).to eq([:my_metric])
end
end
end
context "as symbols" do
context "with valid YAML" do
before do
experiments_yaml = <<-eos
:my_experiment:
:alternatives:
- Control Opt
- Alt One
- Alt Two
:resettable: false
eos
@config.experiments = YAML.load(experiments_yaml)
end
it "should normalize experiments" do
expect(@config.normalized_experiments).to eq({ my_experiment: { resettable: false, alternatives: ["Control Opt", ["Alt One", "Alt Two"]] } })
end
end
context "with invalid YAML" do
let(:yaml) { YAML.load(input) }
context "with an empty string" do
let(:input) { "" }
it "should raise an error" do
expect { @config.experiments = yaml }.to raise_error(Split::InvalidExperimentsFormatError)
end
end
context "with just the YAML header" do
let(:input) { "---" }
it "should raise an error" do
expect { @config.experiments = yaml }.to raise_error(Split::InvalidExperimentsFormatError)
end
end
end
end
end
it "should normalize experiments" do
@config.experiments = {
my_experiment: {
alternatives: [
{ name: "control_opt", percent: 67 },
{ name: "second_opt", percent: 10 },
{ name: "third_opt", percent: 23 },
],
}
}
expect(@config.normalized_experiments).to eq({ my_experiment: { alternatives: [{ "control_opt"=>0.67 }, [{ "second_opt"=>0.1 }, { "third_opt"=>0.23 }]] } })
end
expect(@config.normalized_experiments).to eq({:my_experiment=>{:alternatives=>[{"control_opt"=>0.67}, [{"second_opt"=>0.1}, {"third_opt"=>0.23}]]}})
end
end
context "persistence cookie length" do
it "should default to 1 year" do
expect(@config.persistence_cookie_length).to eq(31536000)
end
it "should allow the persistence cookie length to be configured" do
@config.persistence_cookie_length = 2592000
expect(@config.persistence_cookie_length).to eq(2592000)
end
end
context "persistence cookie domain" do
it "should default to nil" do
expect(@config.persistence_cookie_domain).to eq(nil)
end
it "should allow the persistence cookie domain to be configured" do
@config.persistence_cookie_domain = ".acme.com"
expect(@config.persistence_cookie_domain).to eq(".acme.com")
end
end
end
<MSG> allow for custom redis_url different from ENV variable
<DFF> @@ -210,4 +210,22 @@ describe Split::Configuration do
expect(@config.normalized_experiments).to eq({:my_experiment=>{:alternatives=>[{"control_opt"=>0.67}, [{"second_opt"=>0.1}, {"third_opt"=>0.23}]]}})
end
+
+ context "configuration URL" do
+ it "should default to local redis server" do
+ expect(@config.redis_url).to eq("localhost:6379")
+ end
+
+ it "should allow for redis url to be configured" do
+ @config.redis_url = "custom_redis_url"
+ expect(@config.redis_url).to eq("custom_redis_url")
+ end
+
+ context "provided REDIS_URL environment variable" do
+ it "should use the ENV variable" do
+ ENV['REDIS_URL'] = "env_redis_url"
+ expect(Split::Configuration.new.redis_url).to eq("env_redis_url")
+ end
+ end
+ end
end
| 18 | allow for custom redis_url different from ENV variable | 0 | .rb | rb | mit | splitrb/split |
10072416 | <NME> configuration_spec.rb
<BEF> # frozen_string_literal: true
require "spec_helper"
describe Split::Configuration do
before(:each) { @config = Split::Configuration.new }
it "should provide a default value for ignore_ip_addresses" do
expect(@config.ignore_ip_addresses).to eq([])
end
it "should provide default values for db failover" do
expect(@config.db_failover).to be_falsey
expect(@config.db_failover_on_db_error).to be_a Proc
end
it "should not allow multiple experiments by default" do
expect(@config.allow_multiple_experiments).to be_falsey
end
it "should be enabled by default" do
expect(@config.enabled).to be_truthy
end
it "disabled is the opposite of enabled" do
@config.enabled = false
expect(@config.disabled?).to be_truthy
end
it "should not store the overridden test group per default" do
expect(@config.store_override).to be_falsey
end
it "should provide a default pattern for robots" do
%w[Baidu Gigabot Googlebot libwww-perl lwp-trivial msnbot SiteUptime Slurp WordPress ZIBB ZyBorg YandexBot AdsBot-Google Wget curl bitlybot facebookexternalhit spider].each do |robot|
expect(@config.robot_regex).to match(robot)
end
expect(@config.robot_regex).to match("EventMachine HttpClient")
expect(@config.robot_regex).to match("libwww-perl/5.836")
expect(@config.robot_regex).to match("Pingdom.com_bot_version_1.4_(http://www.pingdom.com)")
expect(@config.robot_regex).to match(" - ")
end
it "should accept real UAs with the robot regexp" do
expect(@config.robot_regex).not_to match("Mozilla/5.0 (Windows; U; Windows NT 6.0; en-US; rv:1.9.1.4) Gecko/20091017 SeaMonkey/2.0")
expect(@config.robot_regex).not_to match("Mozilla/4.0 (compatible; MSIE 8.0; Windows NT 5.1; Trident/4.0; F-6.0SP2-20041109; .NET CLR 2.0.50727; .NET CLR 3.0.04506.648; .NET CLR 3.5.21022; .NET CLR 1.1.4322; InfoPath.3)")
end
it "should allow adding a bot to the bot list" do
@config.bots["newbot"] = "An amazing test bot"
expect(@config.robot_regex).to match("newbot")
end
it "should use the session adapter for persistence by default" do
expect(@config.persistence).to eq(Split::Persistence::SessionAdapter)
end
it "should load a metric" do
@config.experiments = { my_experiment: { alternatives: ["control_opt", "other_opt"], metric: :my_metric } }
expect(@config.metrics).not_to be_nil
expect(@config.metrics.keys).to eq([:my_metric])
end
it "should allow loading of experiment using experment_for" do
@config.experiments = { my_experiment: { alternatives: ["control_opt", "other_opt"], metric: :my_metric } }
expect(@config.experiment_for(:my_experiment)).to eq({ alternatives: ["control_opt", ["other_opt"]] })
end
context "when experiments are defined via YAML" do
context "as strings" do
context "in a basic configuration" do
before do
experiments_yaml = <<-eos
my_experiment:
alternatives:
- Control Opt
- Alt One
- Alt Two
resettable: false
eos
@config.experiments = YAML.load(experiments_yaml)
end
it "should normalize experiments" do
expect(@config.normalized_experiments).to eq({ my_experiment: { resettable: false, alternatives: ["Control Opt", ["Alt One", "Alt Two"]] } })
end
end
context "in a configuration with metadata" do
before do
experiments_yaml = <<-eos
my_experiment:
alternatives:
- name: Control Opt
percent: 67
- name: Alt One
percent: 10
- name: Alt Two
percent: 23
metadata:
Control Opt:
text: 'Control Option'
Alt One:
text: 'Alternative One'
Alt Two:
text: 'Alternative Two'
resettable: false
eos
@config.experiments = YAML.load(experiments_yaml)
end
it "should have metadata on the experiment" do
meta = @config.normalized_experiments[:my_experiment][:metadata]
expect(meta).to_not be nil
expect(meta["Control Opt"]["text"]).to eq("Control Option")
end
end
context "in a complex configuration" do
before do
experiments_yaml = <<-eos
my_experiment:
alternatives:
- name: Control Opt
percent: 67
- name: Alt One
percent: 10
- name: Alt Two
percent: 23
resettable: false
metric: my_metric
another_experiment:
alternatives:
- a
- b
eos
@config.experiments = YAML.load(experiments_yaml)
end
it "should normalize experiments" do
expect(@config.normalized_experiments).to eq({ my_experiment: { resettable: false, alternatives: [{ "Control Opt"=>0.67 },
[{ "Alt One"=>0.1 }, { "Alt Two"=>0.23 }]] }, another_experiment: { alternatives: ["a", ["b"]] } })
end
it "should recognize metrics" do
expect(@config.metrics).not_to be_nil
expect(@config.metrics.keys).to eq([:my_metric])
end
end
end
context "as symbols" do
context "with valid YAML" do
before do
experiments_yaml = <<-eos
:my_experiment:
:alternatives:
- Control Opt
- Alt One
- Alt Two
:resettable: false
eos
@config.experiments = YAML.load(experiments_yaml)
end
it "should normalize experiments" do
expect(@config.normalized_experiments).to eq({ my_experiment: { resettable: false, alternatives: ["Control Opt", ["Alt One", "Alt Two"]] } })
end
end
context "with invalid YAML" do
let(:yaml) { YAML.load(input) }
context "with an empty string" do
let(:input) { "" }
it "should raise an error" do
expect { @config.experiments = yaml }.to raise_error(Split::InvalidExperimentsFormatError)
end
end
context "with just the YAML header" do
let(:input) { "---" }
it "should raise an error" do
expect { @config.experiments = yaml }.to raise_error(Split::InvalidExperimentsFormatError)
end
end
end
end
end
it "should normalize experiments" do
@config.experiments = {
my_experiment: {
alternatives: [
{ name: "control_opt", percent: 67 },
{ name: "second_opt", percent: 10 },
{ name: "third_opt", percent: 23 },
],
}
}
expect(@config.normalized_experiments).to eq({ my_experiment: { alternatives: [{ "control_opt"=>0.67 }, [{ "second_opt"=>0.1 }, { "third_opt"=>0.23 }]] } })
end
expect(@config.normalized_experiments).to eq({:my_experiment=>{:alternatives=>[{"control_opt"=>0.67}, [{"second_opt"=>0.1}, {"third_opt"=>0.23}]]}})
end
end
context "persistence cookie length" do
it "should default to 1 year" do
expect(@config.persistence_cookie_length).to eq(31536000)
end
it "should allow the persistence cookie length to be configured" do
@config.persistence_cookie_length = 2592000
expect(@config.persistence_cookie_length).to eq(2592000)
end
end
context "persistence cookie domain" do
it "should default to nil" do
expect(@config.persistence_cookie_domain).to eq(nil)
end
it "should allow the persistence cookie domain to be configured" do
@config.persistence_cookie_domain = ".acme.com"
expect(@config.persistence_cookie_domain).to eq(".acme.com")
end
end
end
<MSG> allow for custom redis_url different from ENV variable
<DFF> @@ -210,4 +210,22 @@ describe Split::Configuration do
expect(@config.normalized_experiments).to eq({:my_experiment=>{:alternatives=>[{"control_opt"=>0.67}, [{"second_opt"=>0.1}, {"third_opt"=>0.23}]]}})
end
+
+ context "configuration URL" do
+ it "should default to local redis server" do
+ expect(@config.redis_url).to eq("localhost:6379")
+ end
+
+ it "should allow for redis url to be configured" do
+ @config.redis_url = "custom_redis_url"
+ expect(@config.redis_url).to eq("custom_redis_url")
+ end
+
+ context "provided REDIS_URL environment variable" do
+ it "should use the ENV variable" do
+ ENV['REDIS_URL'] = "env_redis_url"
+ expect(Split::Configuration.new.redis_url).to eq("env_redis_url")
+ end
+ end
+ end
end
| 18 | allow for custom redis_url different from ENV variable | 0 | .rb | rb | mit | splitrb/split |
10072417 | <NME> split.gemspec
<BEF> # -*- encoding: utf-8 -*-
# frozen_string_literal: true
$:.push File.expand_path("../lib", __FILE__)
require "split/version"
Gem::Specification.new do |s|
s.name = "split"
s.version = Split::VERSION
s.platform = Gem::Platform::RUBY
s.authors = ["Andrew Nesbitt"]
s.licenses = ["MIT"]
s.email = ["[email protected]"]
s.homepage = "https://github.com/splitrb/split"
s.summary = "Rack based split testing framework"
s.metadata = {
"homepage_uri" => "https://github.com/splitrb/split",
"changelog_uri" => "https://github.com/splitrb/split/blob/main/CHANGELOG.md",
"source_code_uri" => "https://github.com/splitrb/split",
"bug_tracker_uri" => "https://github.com/splitrb/split/issues",
"wiki_uri" => "https://github.com/splitrb/split/wiki",
"mailing_list_uri" => "https://groups.google.com/d/forum/split-ruby"
}
s.required_ruby_version = ">= 2.5.0"
s.required_rubygems_version = ">= 2.0.0"
s.files = `git ls-files`.split("\n")
s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
s.require_paths = ["lib"]
s.add_development_dependency 'bundler', '~> 1.0'
s.add_development_dependency 'rspec', '~> 2.12'
s.add_development_dependency 'rack-test', '~> 0.6'
end
s.add_development_dependency "simplecov", "~> 0.15"
s.add_development_dependency "rack-test", "~> 2.0"
s.add_development_dependency "rake", "~> 13"
s.add_development_dependency "rspec", "~> 3.7"
s.add_development_dependency "pry", "~> 0.10"
s.add_development_dependency "rails", ">= 5.0"
end
<MSG> WIP: Major changes to internals of Split to properly handle metrics, and configuration vs. redis storage. What a mess. Also tries to refactor helper.rb
<DFF> @@ -32,4 +32,6 @@ Gem::Specification.new do |s|
s.add_development_dependency 'bundler', '~> 1.0'
s.add_development_dependency 'rspec', '~> 2.12'
s.add_development_dependency 'rack-test', '~> 0.6'
+ s.add_development_dependency 'pry'
+ s.add_development_dependency 'pry-debugger'
end
| 2 | WIP: Major changes to internals of Split to properly handle metrics, and configuration vs. redis storage. What a mess. Also tries to refactor helper.rb | 0 | .gemspec | gemspec | mit | splitrb/split |
10072418 | <NME> split.gemspec
<BEF> # -*- encoding: utf-8 -*-
# frozen_string_literal: true
$:.push File.expand_path("../lib", __FILE__)
require "split/version"
Gem::Specification.new do |s|
s.name = "split"
s.version = Split::VERSION
s.platform = Gem::Platform::RUBY
s.authors = ["Andrew Nesbitt"]
s.licenses = ["MIT"]
s.email = ["[email protected]"]
s.homepage = "https://github.com/splitrb/split"
s.summary = "Rack based split testing framework"
s.metadata = {
"homepage_uri" => "https://github.com/splitrb/split",
"changelog_uri" => "https://github.com/splitrb/split/blob/main/CHANGELOG.md",
"source_code_uri" => "https://github.com/splitrb/split",
"bug_tracker_uri" => "https://github.com/splitrb/split/issues",
"wiki_uri" => "https://github.com/splitrb/split/wiki",
"mailing_list_uri" => "https://groups.google.com/d/forum/split-ruby"
}
s.required_ruby_version = ">= 2.5.0"
s.required_rubygems_version = ">= 2.0.0"
s.files = `git ls-files`.split("\n")
s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
s.require_paths = ["lib"]
s.add_development_dependency 'bundler', '~> 1.0'
s.add_development_dependency 'rspec', '~> 2.12'
s.add_development_dependency 'rack-test', '~> 0.6'
end
s.add_development_dependency "simplecov", "~> 0.15"
s.add_development_dependency "rack-test", "~> 2.0"
s.add_development_dependency "rake", "~> 13"
s.add_development_dependency "rspec", "~> 3.7"
s.add_development_dependency "pry", "~> 0.10"
s.add_development_dependency "rails", ">= 5.0"
end
<MSG> WIP: Major changes to internals of Split to properly handle metrics, and configuration vs. redis storage. What a mess. Also tries to refactor helper.rb
<DFF> @@ -32,4 +32,6 @@ Gem::Specification.new do |s|
s.add_development_dependency 'bundler', '~> 1.0'
s.add_development_dependency 'rspec', '~> 2.12'
s.add_development_dependency 'rack-test', '~> 0.6'
+ s.add_development_dependency 'pry'
+ s.add_development_dependency 'pry-debugger'
end
| 2 | WIP: Major changes to internals of Split to properly handle metrics, and configuration vs. redis storage. What a mess. Also tries to refactor helper.rb | 0 | .gemspec | gemspec | mit | splitrb/split |
10072419 | <NME> split.gemspec
<BEF> # -*- encoding: utf-8 -*-
# frozen_string_literal: true
$:.push File.expand_path("../lib", __FILE__)
require "split/version"
Gem::Specification.new do |s|
s.name = "split"
s.version = Split::VERSION
s.platform = Gem::Platform::RUBY
s.authors = ["Andrew Nesbitt"]
s.licenses = ["MIT"]
s.email = ["[email protected]"]
s.homepage = "https://github.com/splitrb/split"
s.summary = "Rack based split testing framework"
s.metadata = {
"homepage_uri" => "https://github.com/splitrb/split",
"changelog_uri" => "https://github.com/splitrb/split/blob/main/CHANGELOG.md",
"source_code_uri" => "https://github.com/splitrb/split",
"bug_tracker_uri" => "https://github.com/splitrb/split/issues",
"wiki_uri" => "https://github.com/splitrb/split/wiki",
"mailing_list_uri" => "https://groups.google.com/d/forum/split-ruby"
}
s.required_ruby_version = ">= 2.5.0"
s.required_rubygems_version = ">= 2.0.0"
s.files = `git ls-files`.split("\n")
s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
s.require_paths = ["lib"]
s.add_development_dependency 'bundler', '~> 1.0'
s.add_development_dependency 'rspec', '~> 2.12'
s.add_development_dependency 'rack-test', '~> 0.6'
end
s.add_development_dependency "simplecov", "~> 0.15"
s.add_development_dependency "rack-test", "~> 2.0"
s.add_development_dependency "rake", "~> 13"
s.add_development_dependency "rspec", "~> 3.7"
s.add_development_dependency "pry", "~> 0.10"
s.add_development_dependency "rails", ">= 5.0"
end
<MSG> WIP: Major changes to internals of Split to properly handle metrics, and configuration vs. redis storage. What a mess. Also tries to refactor helper.rb
<DFF> @@ -32,4 +32,6 @@ Gem::Specification.new do |s|
s.add_development_dependency 'bundler', '~> 1.0'
s.add_development_dependency 'rspec', '~> 2.12'
s.add_development_dependency 'rack-test', '~> 0.6'
+ s.add_development_dependency 'pry'
+ s.add_development_dependency 'pry-debugger'
end
| 2 | WIP: Major changes to internals of Split to properly handle metrics, and configuration vs. redis storage. What a mess. Also tries to refactor helper.rb | 0 | .gemspec | gemspec | mit | splitrb/split |
10072420 | <NME> radioButton.js
<BEF> ADDFILE
<MSG> feat(smRadioButton): Created smRadionGroup and smRadionButton directives
<DFF> @@ -0,0 +1,118 @@
+(function() {
+'use strict';
+
+angular
+ .module('semantic.ui.elements.radioButton', [])
+ .directive('smRadioGroup', smRadioGroup)
+ .directive('smRadioButton', smRadioButton);
+
+ smRadioButton.$inject = ['$animate'];
+
+ function smRadioGroup() {
+ return {
+ restrict: 'E',
+ replace: true,
+ require: ['smRadioGroup', '?ngModel'],
+ transclude: true,
+ controller: smRadioGroupController,
+ link: function(scope, element, attrs, ctrls) {
+ var smRadioGroupCtrl = ctrls[0];
+ var ngModelCtrl = ctrls[1];
+
+ if (!ngModelCtrl) { return; }
+
+ smRadioGroupCtrl.setNgModelCtrl(ngModelCtrl);
+ },
+ template: '<div class="ui buttons" ng-transclude></div>'
+ };
+
+ function smRadioGroupController() {
+ /*jshint validthis: true */
+ this._radioBtnElements = [];
+ this._radioBtnFns = [];
+
+ this.setNgModelCtrl = function(ngModelCtrl) {
+ this._ngModelCtrl = ngModelCtrl;
+ this._ngModelCtrl.$render = angular.bind(this, this.render);
+ };
+
+ this.registerBtnElement = function(element) {
+ this._radioBtnElements.push(element);
+ };
+
+ this.addBtn = function(renderFn) {
+ this._radioBtnFns.push(renderFn);
+ };
+
+ this.removeBtn = function(renderFn) {
+ var btnIndex = this._radioBtnFns.indexOf(renderFn);
+ if (btnIndex !== -1) {
+ this._radioBtnFns.splice(btnIndex, 1);
+ }
+ };
+
+ this.render = function() {
+ this._radioBtnFns.forEach(function(renderFn) {
+ renderFn();
+ });
+ };
+
+ this.setViewValue = function(value, event) {
+ this._ngModelCtrl.$setViewValue(value, event);
+ this.render();
+ };
+
+ this.getViewValue = function() {
+ return this._ngModelCtrl.$viewValue;
+ };
+
+ }
+
+ }
+
+ function smRadioButton($animate) {
+ return {
+ restrict: 'E',
+ replace: true,
+ require: '^smRadioGroup',
+ transclude: true,
+ link: function(scope, element, attrs, smRadioGroupCtrl) {
+ var isChecked;
+
+ smRadioGroupCtrl.registerBtnElement(element);
+ smRadioGroupCtrl.addBtn(render);
+ attrs.$observe('value', render);
+
+ element
+ .on('click', eventListener)
+ .on('$destroy', function() {
+ smRadioGroupCtrl.removeBtn(render);
+ });
+
+ function eventListener(event) {
+ if (element[0].hasAttribute('disabled') || attrs.value === void 0) { return; }
+
+ scope.$apply(function() {
+ smRadioGroupCtrl.setViewValue(attrs.value, event && event.type);
+ });
+ }
+
+ function render() {
+ var checked = (scope.$eval(attrs.value) === smRadioGroupCtrl.getViewValue());
+
+ if(isChecked === checked) { return; }
+
+ isChecked = checked;
+
+ if(checked) {
+ $animate.addClass(element, 'active');
+ } else {
+ $animate.removeClass(element, 'active');
+ }
+ }
+ },
+ template:'<div class="ui button" ng-transclude></div>'
+ };
+ }
+
+})();
\ No newline at end of file
| 118 | feat(smRadioButton): Created smRadionGroup and smRadionButton directives | 0 | .js | js | mit | Semantic-Org/Semantic-UI-Angular |
10072421 | <NME> radioButton.js
<BEF> ADDFILE
<MSG> feat(smRadioButton): Created smRadionGroup and smRadionButton directives
<DFF> @@ -0,0 +1,118 @@
+(function() {
+'use strict';
+
+angular
+ .module('semantic.ui.elements.radioButton', [])
+ .directive('smRadioGroup', smRadioGroup)
+ .directive('smRadioButton', smRadioButton);
+
+ smRadioButton.$inject = ['$animate'];
+
+ function smRadioGroup() {
+ return {
+ restrict: 'E',
+ replace: true,
+ require: ['smRadioGroup', '?ngModel'],
+ transclude: true,
+ controller: smRadioGroupController,
+ link: function(scope, element, attrs, ctrls) {
+ var smRadioGroupCtrl = ctrls[0];
+ var ngModelCtrl = ctrls[1];
+
+ if (!ngModelCtrl) { return; }
+
+ smRadioGroupCtrl.setNgModelCtrl(ngModelCtrl);
+ },
+ template: '<div class="ui buttons" ng-transclude></div>'
+ };
+
+ function smRadioGroupController() {
+ /*jshint validthis: true */
+ this._radioBtnElements = [];
+ this._radioBtnFns = [];
+
+ this.setNgModelCtrl = function(ngModelCtrl) {
+ this._ngModelCtrl = ngModelCtrl;
+ this._ngModelCtrl.$render = angular.bind(this, this.render);
+ };
+
+ this.registerBtnElement = function(element) {
+ this._radioBtnElements.push(element);
+ };
+
+ this.addBtn = function(renderFn) {
+ this._radioBtnFns.push(renderFn);
+ };
+
+ this.removeBtn = function(renderFn) {
+ var btnIndex = this._radioBtnFns.indexOf(renderFn);
+ if (btnIndex !== -1) {
+ this._radioBtnFns.splice(btnIndex, 1);
+ }
+ };
+
+ this.render = function() {
+ this._radioBtnFns.forEach(function(renderFn) {
+ renderFn();
+ });
+ };
+
+ this.setViewValue = function(value, event) {
+ this._ngModelCtrl.$setViewValue(value, event);
+ this.render();
+ };
+
+ this.getViewValue = function() {
+ return this._ngModelCtrl.$viewValue;
+ };
+
+ }
+
+ }
+
+ function smRadioButton($animate) {
+ return {
+ restrict: 'E',
+ replace: true,
+ require: '^smRadioGroup',
+ transclude: true,
+ link: function(scope, element, attrs, smRadioGroupCtrl) {
+ var isChecked;
+
+ smRadioGroupCtrl.registerBtnElement(element);
+ smRadioGroupCtrl.addBtn(render);
+ attrs.$observe('value', render);
+
+ element
+ .on('click', eventListener)
+ .on('$destroy', function() {
+ smRadioGroupCtrl.removeBtn(render);
+ });
+
+ function eventListener(event) {
+ if (element[0].hasAttribute('disabled') || attrs.value === void 0) { return; }
+
+ scope.$apply(function() {
+ smRadioGroupCtrl.setViewValue(attrs.value, event && event.type);
+ });
+ }
+
+ function render() {
+ var checked = (scope.$eval(attrs.value) === smRadioGroupCtrl.getViewValue());
+
+ if(isChecked === checked) { return; }
+
+ isChecked = checked;
+
+ if(checked) {
+ $animate.addClass(element, 'active');
+ } else {
+ $animate.removeClass(element, 'active');
+ }
+ }
+ },
+ template:'<div class="ui button" ng-transclude></div>'
+ };
+ }
+
+})();
\ No newline at end of file
| 118 | feat(smRadioButton): Created smRadionGroup and smRadionButton directives | 0 | .js | js | mit | Semantic-Org/Semantic-UI-Angular |
10072422 | <NME> radioButton.js
<BEF> ADDFILE
<MSG> feat(smRadioButton): Created smRadionGroup and smRadionButton directives
<DFF> @@ -0,0 +1,118 @@
+(function() {
+'use strict';
+
+angular
+ .module('semantic.ui.elements.radioButton', [])
+ .directive('smRadioGroup', smRadioGroup)
+ .directive('smRadioButton', smRadioButton);
+
+ smRadioButton.$inject = ['$animate'];
+
+ function smRadioGroup() {
+ return {
+ restrict: 'E',
+ replace: true,
+ require: ['smRadioGroup', '?ngModel'],
+ transclude: true,
+ controller: smRadioGroupController,
+ link: function(scope, element, attrs, ctrls) {
+ var smRadioGroupCtrl = ctrls[0];
+ var ngModelCtrl = ctrls[1];
+
+ if (!ngModelCtrl) { return; }
+
+ smRadioGroupCtrl.setNgModelCtrl(ngModelCtrl);
+ },
+ template: '<div class="ui buttons" ng-transclude></div>'
+ };
+
+ function smRadioGroupController() {
+ /*jshint validthis: true */
+ this._radioBtnElements = [];
+ this._radioBtnFns = [];
+
+ this.setNgModelCtrl = function(ngModelCtrl) {
+ this._ngModelCtrl = ngModelCtrl;
+ this._ngModelCtrl.$render = angular.bind(this, this.render);
+ };
+
+ this.registerBtnElement = function(element) {
+ this._radioBtnElements.push(element);
+ };
+
+ this.addBtn = function(renderFn) {
+ this._radioBtnFns.push(renderFn);
+ };
+
+ this.removeBtn = function(renderFn) {
+ var btnIndex = this._radioBtnFns.indexOf(renderFn);
+ if (btnIndex !== -1) {
+ this._radioBtnFns.splice(btnIndex, 1);
+ }
+ };
+
+ this.render = function() {
+ this._radioBtnFns.forEach(function(renderFn) {
+ renderFn();
+ });
+ };
+
+ this.setViewValue = function(value, event) {
+ this._ngModelCtrl.$setViewValue(value, event);
+ this.render();
+ };
+
+ this.getViewValue = function() {
+ return this._ngModelCtrl.$viewValue;
+ };
+
+ }
+
+ }
+
+ function smRadioButton($animate) {
+ return {
+ restrict: 'E',
+ replace: true,
+ require: '^smRadioGroup',
+ transclude: true,
+ link: function(scope, element, attrs, smRadioGroupCtrl) {
+ var isChecked;
+
+ smRadioGroupCtrl.registerBtnElement(element);
+ smRadioGroupCtrl.addBtn(render);
+ attrs.$observe('value', render);
+
+ element
+ .on('click', eventListener)
+ .on('$destroy', function() {
+ smRadioGroupCtrl.removeBtn(render);
+ });
+
+ function eventListener(event) {
+ if (element[0].hasAttribute('disabled') || attrs.value === void 0) { return; }
+
+ scope.$apply(function() {
+ smRadioGroupCtrl.setViewValue(attrs.value, event && event.type);
+ });
+ }
+
+ function render() {
+ var checked = (scope.$eval(attrs.value) === smRadioGroupCtrl.getViewValue());
+
+ if(isChecked === checked) { return; }
+
+ isChecked = checked;
+
+ if(checked) {
+ $animate.addClass(element, 'active');
+ } else {
+ $animate.removeClass(element, 'active');
+ }
+ }
+ },
+ template:'<div class="ui button" ng-transclude></div>'
+ };
+ }
+
+})();
\ No newline at end of file
| 118 | feat(smRadioButton): Created smRadionGroup and smRadionButton directives | 0 | .js | js | mit | Semantic-Org/Semantic-UI-Angular |
10072423 | <NME> cookie_adapter_spec.rb
<BEF> # frozen_string_literal: true
require 'rack/test'
describe Split::Persistence::CookieAdapter do
let(:env) { Rack::MockRequest.env_for("http://example.com:8080/") }
let(:request) { Rack::Request.new(env) }
let(:response) { Rack::MockResponse.new(200, {}, "") }
let(:context) { double(request: request, response: response, cookies: CookiesMock.new) }
subject { Split::Persistence::CookieAdapter.new(context) }
describe "#[] and #[]=" do
it "should set and return the value for given key" do
subject["my_key"] = "my_value"
expect(subject["my_key"]).to eq("my_value")
end
end
describe "#delete" do
it "should delete the given key" do
subject["my_key"] = "my_value"
subject.delete("my_key")
expect(subject["my_key"]).to be_nil
end
end
describe "#keys" do
it "should return an array of the session's stored keys" do
subject["my_key"] = "my_value"
subject["my_second_key"] = "my_second_value"
expect(subject.keys).to match(["my_key", "my_second_key"])
end
end
it "handles invalid JSON" do
context.request.cookies[:split] = { :value => '{"foo":2,', :expires => Time.now }
expect(subject["my_key"]).to be_nil
subject["my_key"] = "my_value"
expect(subject["my_key"]).to eq("my_value")
end
it "puts multiple experiments in a single cookie" do
subject["foo"] = "FOO"
subject["bar"] = "BAR"
expect(context.response.headers["Set-Cookie"]).to match(/\Asplit=%7B%22foo%22%3A%22FOO%22%2C%22bar%22%3A%22BAR%22%7D; path=\/; expires=[a-zA-Z]{3}, \d{2} [a-zA-Z]{3} \d{4} \d{2}:\d{2}:\d{2} -0000\Z/)
end
it "ensure other added cookies are not overriden" do
context.response.set_cookie 'dummy', 'wow'
subject["foo"] = "FOO"
expect(context.response.headers["Set-Cookie"]).to include("dummy=wow")
expect(context.response.headers["Set-Cookie"]).to include("split=")
end
it "uses ActionDispatch::Cookie when available for cookie writing" do
allow(subject).to receive(:action_dispatch?).and_return(true)
subject["foo"] = "FOO"
expect(subject['foo']).to eq('FOO')
end
end
let(:controller_class) { Class.new(ActionController::Base) }
include_examples "sets cookies correctly"
it "puts multiple experiments in a single cookie" do
subject["foo"] = "FOO"
subject["bar"] = "BAR"
expect(subject.keys).to eq(["foo", "bar"])
expect(subject["foo"]).to eq("FOO")
expect(subject["bar"]).to eq("BAR")
cookie_jar = context.request.env["action_dispatch.cookies"]
expect(cookie_jar["split"]).to eq('{"foo":"FOO","bar":"BAR"}')
end
end
end
<MSG> CookieAdapter: Fix cookies when @context is an ActionController (#526)
* CookieAdapter: Fix cookies when @context is an ActionController
Using ab_test from a controller was failing because "cookies" is a
private method of the controller instance which is assigned to @context.
It looks like this was broken in the commit that fixed the multiple
"Set-Cookie" headers bug:
https://github.com/splitrb/split/commit/3523e1c53988d727afb3f28a0208d7984f8fc31b
Using `.send(:cookies)` again when using Rails was the easiest way I
found to fix this.
Note: I was able to add an integration test for the case when it's
called from the controller, but I failed to a regression test that uses
and ActionView context object.
* Don't use to_h on CookieJar, it doesn't work on older rubies
<DFF> @@ -3,60 +3,104 @@ require "spec_helper"
require 'rack/test'
describe Split::Persistence::CookieAdapter do
+ subject { described_class.new(context) }
- let(:env) { Rack::MockRequest.env_for("http://example.com:8080/") }
- let(:request) { Rack::Request.new(env) }
- let(:response) { Rack::MockResponse.new(200, {}, "") }
- let(:context) { double(request: request, response: response, cookies: CookiesMock.new) }
- subject { Split::Persistence::CookieAdapter.new(context) }
+ shared_examples "sets cookies correctly" do
+ describe "#[] and #[]=" do
+ it "set and return the value for given key" do
+ subject["my_key"] = "my_value"
+ expect(subject["my_key"]).to eq("my_value")
+ end
- describe "#[] and #[]=" do
- it "should set and return the value for given key" do
- subject["my_key"] = "my_value"
- expect(subject["my_key"]).to eq("my_value")
+ it "handles invalid JSON" do
+ context.request.cookies[:split] = {
+ :value => '{"foo":2,',
+ :expires => Time.now
+ }
+ expect(subject["my_key"]).to be_nil
+ subject["my_key"] = "my_value"
+ expect(subject["my_key"]).to eq("my_value")
+ end
end
- end
- describe "#delete" do
- it "should delete the given key" do
- subject["my_key"] = "my_value"
- subject.delete("my_key")
- expect(subject["my_key"]).to be_nil
+ describe "#delete" do
+ it "should delete the given key" do
+ subject["my_key"] = "my_value"
+ subject.delete("my_key")
+ expect(subject["my_key"]).to be_nil
+ end
end
- end
- describe "#keys" do
- it "should return an array of the session's stored keys" do
- subject["my_key"] = "my_value"
- subject["my_second_key"] = "my_second_value"
- expect(subject.keys).to match(["my_key", "my_second_key"])
+ describe "#keys" do
+ it "should return an array of the session's stored keys" do
+ subject["my_key"] = "my_value"
+ subject["my_second_key"] = "my_second_value"
+ expect(subject.keys).to match(["my_key", "my_second_key"])
+ end
end
end
- it "handles invalid JSON" do
- context.request.cookies[:split] = { :value => '{"foo":2,', :expires => Time.now }
- expect(subject["my_key"]).to be_nil
- subject["my_key"] = "my_value"
- expect(subject["my_key"]).to eq("my_value")
- end
- it "puts multiple experiments in a single cookie" do
- subject["foo"] = "FOO"
- subject["bar"] = "BAR"
- expect(context.response.headers["Set-Cookie"]).to match(/\Asplit=%7B%22foo%22%3A%22FOO%22%2C%22bar%22%3A%22BAR%22%7D; path=\/; expires=[a-zA-Z]{3}, \d{2} [a-zA-Z]{3} \d{4} \d{2}:\d{2}:\d{2} -0000\Z/)
- end
+ context "when using Rack" do
+ let(:env) { Rack::MockRequest.env_for("http://example.com:8080/") }
+ let(:request) { Rack::Request.new(env) }
+ let(:response) { Rack::MockResponse.new(200, {}, "") }
+ let(:context) { double(request: request, response: response, cookies: CookiesMock.new) }
- it "ensure other added cookies are not overriden" do
- context.response.set_cookie 'dummy', 'wow'
- subject["foo"] = "FOO"
- expect(context.response.headers["Set-Cookie"]).to include("dummy=wow")
- expect(context.response.headers["Set-Cookie"]).to include("split=")
- end
+ include_examples "sets cookies correctly"
- it "uses ActionDispatch::Cookie when available for cookie writing" do
- allow(subject).to receive(:action_dispatch?).and_return(true)
- subject["foo"] = "FOO"
- expect(subject['foo']).to eq('FOO')
+ it "puts multiple experiments in a single cookie" do
+ subject["foo"] = "FOO"
+ subject["bar"] = "BAR"
+ expect(context.response.headers["Set-Cookie"]).to match(/\Asplit=%7B%22foo%22%3A%22FOO%22%2C%22bar%22%3A%22BAR%22%7D; path=\/; expires=[a-zA-Z]{3}, \d{2} [a-zA-Z]{3} \d{4} \d{2}:\d{2}:\d{2} -0000\Z/)
+ end
+
+ it "ensure other added cookies are not overriden" do
+ context.response.set_cookie 'dummy', 'wow'
+ subject["foo"] = "FOO"
+ expect(context.response.headers["Set-Cookie"]).to include("dummy=wow")
+ expect(context.response.headers["Set-Cookie"]).to include("split=")
+ end
end
+ context "when @context is an ActionController::Base" do
+ before :context do
+ require "rails"
+ require "action_controller/railtie"
+ end
+
+ let(:context) do
+ controller = controller_class.new
+ if controller.respond_to?(:set_request!)
+ controller.set_request!(ActionDispatch::Request.new({}))
+ else # Before rails 5.0
+ controller.send(:"request=", ActionDispatch::Request.new({}))
+ end
+
+ response = ActionDispatch::Response.new(200, {}, '').tap do |res|
+ res.request = controller.request
+ end
+
+ if controller.respond_to?(:set_response!)
+ controller.set_response!(response)
+ else # Before rails 5.0
+ controller.send(:set_response!, response)
+ end
+ controller
+ end
+
+ let(:controller_class) { Class.new(ActionController::Base) }
+
+ include_examples "sets cookies correctly"
+
+ it "puts multiple experiments in a single cookie" do
+ subject["foo"] = "FOO"
+ subject["bar"] = "BAR"
+ expect(subject.keys).to eq(["foo", "bar"])
+ expect(subject["foo"]).to eq("FOO")
+ expect(subject["bar"]).to eq("BAR")
+ cookie_jar = context.request.env["action_dispatch.cookies"]
+ expect(cookie_jar['split']).to eq("{\"foo\":\"FOO\",\"bar\":\"BAR\"}")
+ end
+ end
end
| 86 | CookieAdapter: Fix cookies when @context is an ActionController (#526) | 42 | .rb | rb | mit | splitrb/split |
10072424 | <NME> cookie_adapter_spec.rb
<BEF> # frozen_string_literal: true
require 'rack/test'
describe Split::Persistence::CookieAdapter do
let(:env) { Rack::MockRequest.env_for("http://example.com:8080/") }
let(:request) { Rack::Request.new(env) }
let(:response) { Rack::MockResponse.new(200, {}, "") }
let(:context) { double(request: request, response: response, cookies: CookiesMock.new) }
subject { Split::Persistence::CookieAdapter.new(context) }
describe "#[] and #[]=" do
it "should set and return the value for given key" do
subject["my_key"] = "my_value"
expect(subject["my_key"]).to eq("my_value")
end
end
describe "#delete" do
it "should delete the given key" do
subject["my_key"] = "my_value"
subject.delete("my_key")
expect(subject["my_key"]).to be_nil
end
end
describe "#keys" do
it "should return an array of the session's stored keys" do
subject["my_key"] = "my_value"
subject["my_second_key"] = "my_second_value"
expect(subject.keys).to match(["my_key", "my_second_key"])
end
end
it "handles invalid JSON" do
context.request.cookies[:split] = { :value => '{"foo":2,', :expires => Time.now }
expect(subject["my_key"]).to be_nil
subject["my_key"] = "my_value"
expect(subject["my_key"]).to eq("my_value")
end
it "puts multiple experiments in a single cookie" do
subject["foo"] = "FOO"
subject["bar"] = "BAR"
expect(context.response.headers["Set-Cookie"]).to match(/\Asplit=%7B%22foo%22%3A%22FOO%22%2C%22bar%22%3A%22BAR%22%7D; path=\/; expires=[a-zA-Z]{3}, \d{2} [a-zA-Z]{3} \d{4} \d{2}:\d{2}:\d{2} -0000\Z/)
end
it "ensure other added cookies are not overriden" do
context.response.set_cookie 'dummy', 'wow'
subject["foo"] = "FOO"
expect(context.response.headers["Set-Cookie"]).to include("dummy=wow")
expect(context.response.headers["Set-Cookie"]).to include("split=")
end
it "uses ActionDispatch::Cookie when available for cookie writing" do
allow(subject).to receive(:action_dispatch?).and_return(true)
subject["foo"] = "FOO"
expect(subject['foo']).to eq('FOO')
end
end
let(:controller_class) { Class.new(ActionController::Base) }
include_examples "sets cookies correctly"
it "puts multiple experiments in a single cookie" do
subject["foo"] = "FOO"
subject["bar"] = "BAR"
expect(subject.keys).to eq(["foo", "bar"])
expect(subject["foo"]).to eq("FOO")
expect(subject["bar"]).to eq("BAR")
cookie_jar = context.request.env["action_dispatch.cookies"]
expect(cookie_jar["split"]).to eq('{"foo":"FOO","bar":"BAR"}')
end
end
end
<MSG> CookieAdapter: Fix cookies when @context is an ActionController (#526)
* CookieAdapter: Fix cookies when @context is an ActionController
Using ab_test from a controller was failing because "cookies" is a
private method of the controller instance which is assigned to @context.
It looks like this was broken in the commit that fixed the multiple
"Set-Cookie" headers bug:
https://github.com/splitrb/split/commit/3523e1c53988d727afb3f28a0208d7984f8fc31b
Using `.send(:cookies)` again when using Rails was the easiest way I
found to fix this.
Note: I was able to add an integration test for the case when it's
called from the controller, but I failed to a regression test that uses
and ActionView context object.
* Don't use to_h on CookieJar, it doesn't work on older rubies
<DFF> @@ -3,60 +3,104 @@ require "spec_helper"
require 'rack/test'
describe Split::Persistence::CookieAdapter do
+ subject { described_class.new(context) }
- let(:env) { Rack::MockRequest.env_for("http://example.com:8080/") }
- let(:request) { Rack::Request.new(env) }
- let(:response) { Rack::MockResponse.new(200, {}, "") }
- let(:context) { double(request: request, response: response, cookies: CookiesMock.new) }
- subject { Split::Persistence::CookieAdapter.new(context) }
+ shared_examples "sets cookies correctly" do
+ describe "#[] and #[]=" do
+ it "set and return the value for given key" do
+ subject["my_key"] = "my_value"
+ expect(subject["my_key"]).to eq("my_value")
+ end
- describe "#[] and #[]=" do
- it "should set and return the value for given key" do
- subject["my_key"] = "my_value"
- expect(subject["my_key"]).to eq("my_value")
+ it "handles invalid JSON" do
+ context.request.cookies[:split] = {
+ :value => '{"foo":2,',
+ :expires => Time.now
+ }
+ expect(subject["my_key"]).to be_nil
+ subject["my_key"] = "my_value"
+ expect(subject["my_key"]).to eq("my_value")
+ end
end
- end
- describe "#delete" do
- it "should delete the given key" do
- subject["my_key"] = "my_value"
- subject.delete("my_key")
- expect(subject["my_key"]).to be_nil
+ describe "#delete" do
+ it "should delete the given key" do
+ subject["my_key"] = "my_value"
+ subject.delete("my_key")
+ expect(subject["my_key"]).to be_nil
+ end
end
- end
- describe "#keys" do
- it "should return an array of the session's stored keys" do
- subject["my_key"] = "my_value"
- subject["my_second_key"] = "my_second_value"
- expect(subject.keys).to match(["my_key", "my_second_key"])
+ describe "#keys" do
+ it "should return an array of the session's stored keys" do
+ subject["my_key"] = "my_value"
+ subject["my_second_key"] = "my_second_value"
+ expect(subject.keys).to match(["my_key", "my_second_key"])
+ end
end
end
- it "handles invalid JSON" do
- context.request.cookies[:split] = { :value => '{"foo":2,', :expires => Time.now }
- expect(subject["my_key"]).to be_nil
- subject["my_key"] = "my_value"
- expect(subject["my_key"]).to eq("my_value")
- end
- it "puts multiple experiments in a single cookie" do
- subject["foo"] = "FOO"
- subject["bar"] = "BAR"
- expect(context.response.headers["Set-Cookie"]).to match(/\Asplit=%7B%22foo%22%3A%22FOO%22%2C%22bar%22%3A%22BAR%22%7D; path=\/; expires=[a-zA-Z]{3}, \d{2} [a-zA-Z]{3} \d{4} \d{2}:\d{2}:\d{2} -0000\Z/)
- end
+ context "when using Rack" do
+ let(:env) { Rack::MockRequest.env_for("http://example.com:8080/") }
+ let(:request) { Rack::Request.new(env) }
+ let(:response) { Rack::MockResponse.new(200, {}, "") }
+ let(:context) { double(request: request, response: response, cookies: CookiesMock.new) }
- it "ensure other added cookies are not overriden" do
- context.response.set_cookie 'dummy', 'wow'
- subject["foo"] = "FOO"
- expect(context.response.headers["Set-Cookie"]).to include("dummy=wow")
- expect(context.response.headers["Set-Cookie"]).to include("split=")
- end
+ include_examples "sets cookies correctly"
- it "uses ActionDispatch::Cookie when available for cookie writing" do
- allow(subject).to receive(:action_dispatch?).and_return(true)
- subject["foo"] = "FOO"
- expect(subject['foo']).to eq('FOO')
+ it "puts multiple experiments in a single cookie" do
+ subject["foo"] = "FOO"
+ subject["bar"] = "BAR"
+ expect(context.response.headers["Set-Cookie"]).to match(/\Asplit=%7B%22foo%22%3A%22FOO%22%2C%22bar%22%3A%22BAR%22%7D; path=\/; expires=[a-zA-Z]{3}, \d{2} [a-zA-Z]{3} \d{4} \d{2}:\d{2}:\d{2} -0000\Z/)
+ end
+
+ it "ensure other added cookies are not overriden" do
+ context.response.set_cookie 'dummy', 'wow'
+ subject["foo"] = "FOO"
+ expect(context.response.headers["Set-Cookie"]).to include("dummy=wow")
+ expect(context.response.headers["Set-Cookie"]).to include("split=")
+ end
end
+ context "when @context is an ActionController::Base" do
+ before :context do
+ require "rails"
+ require "action_controller/railtie"
+ end
+
+ let(:context) do
+ controller = controller_class.new
+ if controller.respond_to?(:set_request!)
+ controller.set_request!(ActionDispatch::Request.new({}))
+ else # Before rails 5.0
+ controller.send(:"request=", ActionDispatch::Request.new({}))
+ end
+
+ response = ActionDispatch::Response.new(200, {}, '').tap do |res|
+ res.request = controller.request
+ end
+
+ if controller.respond_to?(:set_response!)
+ controller.set_response!(response)
+ else # Before rails 5.0
+ controller.send(:set_response!, response)
+ end
+ controller
+ end
+
+ let(:controller_class) { Class.new(ActionController::Base) }
+
+ include_examples "sets cookies correctly"
+
+ it "puts multiple experiments in a single cookie" do
+ subject["foo"] = "FOO"
+ subject["bar"] = "BAR"
+ expect(subject.keys).to eq(["foo", "bar"])
+ expect(subject["foo"]).to eq("FOO")
+ expect(subject["bar"]).to eq("BAR")
+ cookie_jar = context.request.env["action_dispatch.cookies"]
+ expect(cookie_jar['split']).to eq("{\"foo\":\"FOO\",\"bar\":\"BAR\"}")
+ end
+ end
end
| 86 | CookieAdapter: Fix cookies when @context is an ActionController (#526) | 42 | .rb | rb | mit | splitrb/split |
10072425 | <NME> cookie_adapter_spec.rb
<BEF> # frozen_string_literal: true
require 'rack/test'
describe Split::Persistence::CookieAdapter do
let(:env) { Rack::MockRequest.env_for("http://example.com:8080/") }
let(:request) { Rack::Request.new(env) }
let(:response) { Rack::MockResponse.new(200, {}, "") }
let(:context) { double(request: request, response: response, cookies: CookiesMock.new) }
subject { Split::Persistence::CookieAdapter.new(context) }
describe "#[] and #[]=" do
it "should set and return the value for given key" do
subject["my_key"] = "my_value"
expect(subject["my_key"]).to eq("my_value")
end
end
describe "#delete" do
it "should delete the given key" do
subject["my_key"] = "my_value"
subject.delete("my_key")
expect(subject["my_key"]).to be_nil
end
end
describe "#keys" do
it "should return an array of the session's stored keys" do
subject["my_key"] = "my_value"
subject["my_second_key"] = "my_second_value"
expect(subject.keys).to match(["my_key", "my_second_key"])
end
end
it "handles invalid JSON" do
context.request.cookies[:split] = { :value => '{"foo":2,', :expires => Time.now }
expect(subject["my_key"]).to be_nil
subject["my_key"] = "my_value"
expect(subject["my_key"]).to eq("my_value")
end
it "puts multiple experiments in a single cookie" do
subject["foo"] = "FOO"
subject["bar"] = "BAR"
expect(context.response.headers["Set-Cookie"]).to match(/\Asplit=%7B%22foo%22%3A%22FOO%22%2C%22bar%22%3A%22BAR%22%7D; path=\/; expires=[a-zA-Z]{3}, \d{2} [a-zA-Z]{3} \d{4} \d{2}:\d{2}:\d{2} -0000\Z/)
end
it "ensure other added cookies are not overriden" do
context.response.set_cookie 'dummy', 'wow'
subject["foo"] = "FOO"
expect(context.response.headers["Set-Cookie"]).to include("dummy=wow")
expect(context.response.headers["Set-Cookie"]).to include("split=")
end
it "uses ActionDispatch::Cookie when available for cookie writing" do
allow(subject).to receive(:action_dispatch?).and_return(true)
subject["foo"] = "FOO"
expect(subject['foo']).to eq('FOO')
end
end
let(:controller_class) { Class.new(ActionController::Base) }
include_examples "sets cookies correctly"
it "puts multiple experiments in a single cookie" do
subject["foo"] = "FOO"
subject["bar"] = "BAR"
expect(subject.keys).to eq(["foo", "bar"])
expect(subject["foo"]).to eq("FOO")
expect(subject["bar"]).to eq("BAR")
cookie_jar = context.request.env["action_dispatch.cookies"]
expect(cookie_jar["split"]).to eq('{"foo":"FOO","bar":"BAR"}')
end
end
end
<MSG> CookieAdapter: Fix cookies when @context is an ActionController (#526)
* CookieAdapter: Fix cookies when @context is an ActionController
Using ab_test from a controller was failing because "cookies" is a
private method of the controller instance which is assigned to @context.
It looks like this was broken in the commit that fixed the multiple
"Set-Cookie" headers bug:
https://github.com/splitrb/split/commit/3523e1c53988d727afb3f28a0208d7984f8fc31b
Using `.send(:cookies)` again when using Rails was the easiest way I
found to fix this.
Note: I was able to add an integration test for the case when it's
called from the controller, but I failed to a regression test that uses
and ActionView context object.
* Don't use to_h on CookieJar, it doesn't work on older rubies
<DFF> @@ -3,60 +3,104 @@ require "spec_helper"
require 'rack/test'
describe Split::Persistence::CookieAdapter do
+ subject { described_class.new(context) }
- let(:env) { Rack::MockRequest.env_for("http://example.com:8080/") }
- let(:request) { Rack::Request.new(env) }
- let(:response) { Rack::MockResponse.new(200, {}, "") }
- let(:context) { double(request: request, response: response, cookies: CookiesMock.new) }
- subject { Split::Persistence::CookieAdapter.new(context) }
+ shared_examples "sets cookies correctly" do
+ describe "#[] and #[]=" do
+ it "set and return the value for given key" do
+ subject["my_key"] = "my_value"
+ expect(subject["my_key"]).to eq("my_value")
+ end
- describe "#[] and #[]=" do
- it "should set and return the value for given key" do
- subject["my_key"] = "my_value"
- expect(subject["my_key"]).to eq("my_value")
+ it "handles invalid JSON" do
+ context.request.cookies[:split] = {
+ :value => '{"foo":2,',
+ :expires => Time.now
+ }
+ expect(subject["my_key"]).to be_nil
+ subject["my_key"] = "my_value"
+ expect(subject["my_key"]).to eq("my_value")
+ end
end
- end
- describe "#delete" do
- it "should delete the given key" do
- subject["my_key"] = "my_value"
- subject.delete("my_key")
- expect(subject["my_key"]).to be_nil
+ describe "#delete" do
+ it "should delete the given key" do
+ subject["my_key"] = "my_value"
+ subject.delete("my_key")
+ expect(subject["my_key"]).to be_nil
+ end
end
- end
- describe "#keys" do
- it "should return an array of the session's stored keys" do
- subject["my_key"] = "my_value"
- subject["my_second_key"] = "my_second_value"
- expect(subject.keys).to match(["my_key", "my_second_key"])
+ describe "#keys" do
+ it "should return an array of the session's stored keys" do
+ subject["my_key"] = "my_value"
+ subject["my_second_key"] = "my_second_value"
+ expect(subject.keys).to match(["my_key", "my_second_key"])
+ end
end
end
- it "handles invalid JSON" do
- context.request.cookies[:split] = { :value => '{"foo":2,', :expires => Time.now }
- expect(subject["my_key"]).to be_nil
- subject["my_key"] = "my_value"
- expect(subject["my_key"]).to eq("my_value")
- end
- it "puts multiple experiments in a single cookie" do
- subject["foo"] = "FOO"
- subject["bar"] = "BAR"
- expect(context.response.headers["Set-Cookie"]).to match(/\Asplit=%7B%22foo%22%3A%22FOO%22%2C%22bar%22%3A%22BAR%22%7D; path=\/; expires=[a-zA-Z]{3}, \d{2} [a-zA-Z]{3} \d{4} \d{2}:\d{2}:\d{2} -0000\Z/)
- end
+ context "when using Rack" do
+ let(:env) { Rack::MockRequest.env_for("http://example.com:8080/") }
+ let(:request) { Rack::Request.new(env) }
+ let(:response) { Rack::MockResponse.new(200, {}, "") }
+ let(:context) { double(request: request, response: response, cookies: CookiesMock.new) }
- it "ensure other added cookies are not overriden" do
- context.response.set_cookie 'dummy', 'wow'
- subject["foo"] = "FOO"
- expect(context.response.headers["Set-Cookie"]).to include("dummy=wow")
- expect(context.response.headers["Set-Cookie"]).to include("split=")
- end
+ include_examples "sets cookies correctly"
- it "uses ActionDispatch::Cookie when available for cookie writing" do
- allow(subject).to receive(:action_dispatch?).and_return(true)
- subject["foo"] = "FOO"
- expect(subject['foo']).to eq('FOO')
+ it "puts multiple experiments in a single cookie" do
+ subject["foo"] = "FOO"
+ subject["bar"] = "BAR"
+ expect(context.response.headers["Set-Cookie"]).to match(/\Asplit=%7B%22foo%22%3A%22FOO%22%2C%22bar%22%3A%22BAR%22%7D; path=\/; expires=[a-zA-Z]{3}, \d{2} [a-zA-Z]{3} \d{4} \d{2}:\d{2}:\d{2} -0000\Z/)
+ end
+
+ it "ensure other added cookies are not overriden" do
+ context.response.set_cookie 'dummy', 'wow'
+ subject["foo"] = "FOO"
+ expect(context.response.headers["Set-Cookie"]).to include("dummy=wow")
+ expect(context.response.headers["Set-Cookie"]).to include("split=")
+ end
end
+ context "when @context is an ActionController::Base" do
+ before :context do
+ require "rails"
+ require "action_controller/railtie"
+ end
+
+ let(:context) do
+ controller = controller_class.new
+ if controller.respond_to?(:set_request!)
+ controller.set_request!(ActionDispatch::Request.new({}))
+ else # Before rails 5.0
+ controller.send(:"request=", ActionDispatch::Request.new({}))
+ end
+
+ response = ActionDispatch::Response.new(200, {}, '').tap do |res|
+ res.request = controller.request
+ end
+
+ if controller.respond_to?(:set_response!)
+ controller.set_response!(response)
+ else # Before rails 5.0
+ controller.send(:set_response!, response)
+ end
+ controller
+ end
+
+ let(:controller_class) { Class.new(ActionController::Base) }
+
+ include_examples "sets cookies correctly"
+
+ it "puts multiple experiments in a single cookie" do
+ subject["foo"] = "FOO"
+ subject["bar"] = "BAR"
+ expect(subject.keys).to eq(["foo", "bar"])
+ expect(subject["foo"]).to eq("FOO")
+ expect(subject["bar"]).to eq("BAR")
+ cookie_jar = context.request.env["action_dispatch.cookies"]
+ expect(cookie_jar['split']).to eq("{\"foo\":\"FOO\",\"bar\":\"BAR\"}")
+ end
+ end
end
| 86 | CookieAdapter: Fix cookies when @context is an ActionController (#526) | 42 | .rb | rb | mit | splitrb/split |
10072426 | <NME> tokenizer.ts
<BEF> import { deepEqual } from 'assert';
import tokenize from '../src/tokenizer';
describe('Tokenizer', () => {
it('numeric values', () => {
deepEqual(tokenize('p10'), [
{ type: 'Literal', value: 'p', start: 0, end: 1 },
{ type: 'NumberValue', value: 10, rawValue: '10', unit: '', start: 1, end: 3 }
]);
deepEqual(tokenize('p-10'), [
{ type: 'Literal', value: 'p', start: 0, end: 1 },
{ type: 'NumberValue', value: -10, rawValue: '-10', unit: '', start: 1, end: 4 }
]);
deepEqual(tokenize('p-10-'), [
{ type: 'Literal', value: 'p', start: 0, end: 1 },
{ type: 'NumberValue', value: -10, rawValue: '-10', unit: '', start: 1, end: 4 },
{ type: 'Operator', operator: '-', start: 4, end: 5 }
]);
deepEqual(tokenize('p-10-20'), [
{ type: 'Literal', value: 'p', start: 0, end: 1 },
{ type: 'NumberValue', value: -10, rawValue: '-10', unit: '', start: 1, end: 4 },
{ type: 'Operator', operator: '-', start: 4, end: 5 },
{ type: 'NumberValue', value: 20, rawValue: '20', unit: '', start: 5, end: 7 }
]);
deepEqual(tokenize('p-10--20'), [
{ type: 'Literal', value: 'p', start: 0, end: 1 },
{ type: 'NumberValue', value: -10, rawValue: '-10', unit: '', start: 1, end: 4 },
{ type: 'Operator', operator: '-', start: 4, end: 5 },
{ type: 'NumberValue', value: -20, rawValue: '-20', unit: '', start: 5, end: 8 }
]);
deepEqual(tokenize('p-10-20--30'), [
{ type: 'Literal', value: 'p', start: 0, end: 1 },
{ type: 'NumberValue', value: -10, rawValue: '-10', unit: '', start: 1, end: 4 },
{ type: 'Operator', operator: '-', start: 4, end: 5 },
{ type: 'NumberValue', value: 20, rawValue: '20', unit: '', start: 5, end: 7 },
{ type: 'Operator', operator: '-', start: 7, end: 8 },
{ type: 'NumberValue', value: -30, rawValue: '-30', unit: '', start: 8, end: 11 }
]);
deepEqual(tokenize('p-10p-20--30'), [
{ type: 'Literal', value: 'p', start: 0, end: 1 },
{ type: 'NumberValue', value: -10, rawValue: '-10', unit: 'p', start: 1, end: 5 },
{ type: 'NumberValue', value: -20, rawValue: '-20', unit: '', start: 5, end: 8 },
{ type: 'Operator', operator: '-', start: 8, end: 9 },
{ type: 'NumberValue', value: -30, rawValue: '-30', unit: '', start: 9, end: 12 }
]);
deepEqual(tokenize('p-10%-20--30'), [
{ type: 'Literal', value: 'p', start: 0, end: 1 },
{ type: 'NumberValue', value: -10, rawValue: '-10', unit: '%', start: 1, end: 5 },
{ type: 'NumberValue', value: -20, rawValue: '-20', unit: '', start: 5, end: 8 },
{ type: 'Operator', operator: '-', start: 8, end: 9 },
{ type: 'NumberValue', value: -30, rawValue: '-30', unit: '', start: 9, end: 12 }
]);
});
it('float values', () => {
deepEqual(tokenize('p.5'), [
{ type: 'Literal', value: 'p', start: 0, end: 1 },
{ type: 'NumberValue', value: 0.5, rawValue: '.5', unit: '', start: 1, end: 3 }
]);
deepEqual(tokenize('p-.5'), [
{ type: 'Literal', value: 'p', start: 0, end: 1 },
{ type: 'NumberValue', value: -0.5, rawValue: '-.5', unit: '', start: 1, end: 4 }
]);
deepEqual(tokenize('p.1.2.3'), [
{ type: 'Literal', value: 'p', start: 0, end: 1 },
{ type: 'NumberValue', value: 0.1, rawValue: '.1', unit: '', start: 1, end: 3 },
{ type: 'NumberValue', value: 0.2, rawValue: '.2', unit: '', start: 3, end: 5 },
{ type: 'NumberValue', value: 0.3, rawValue: '.3', unit: '', start: 5, end: 7 }
]);
deepEqual(tokenize('p.1-.2.3'), [
{ type: 'Literal', value: 'p', start: 0, end: 1 },
{ type: 'NumberValue', value: 0.1, rawValue: '.1', unit: '', start: 1, end: 3 },
{ type: 'Operator', operator: '-', start: 3, end: 4 },
{ type: 'NumberValue', value: 0.2, rawValue: '.2', unit: '', start: 4, end: 6 },
{ type: 'NumberValue', value: 0.3, rawValue: '.3', unit: '', start: 6, end: 8 }
]);
deepEqual(tokenize('p.1--.2.3'), [
{ type: 'Literal', value: 'p', start: 0, end: 1 },
{ type: 'NumberValue', value: 0.1, rawValue: '.1', unit: '', start: 1, end: 3 },
{ type: 'Operator', operator: '-', start: 3, end: 4 },
{ type: 'NumberValue', value: -0.2, rawValue: '-.2', unit: '', start: 4, end: 7 },
{ type: 'NumberValue', value: 0.3, rawValue: '.3', unit: '', start: 7, end: 9 }
]);
deepEqual(tokenize('10'), [
{ type: 'NumberValue', value: 10, rawValue: '10', unit: '', start: 0, end: 2 },
]);
deepEqual(tokenize('.1'), [
{ type: 'NumberValue', value: 0.1, rawValue: '.1', unit: '', start: 0, end: 2 },
]);
// NB: now dot should be a part of literal
// throws(() => tokenize('.foo'), /Unexpected character at 1/);
});
it('color values', () => {
deepEqual(tokenize('c#'), [
{ type: 'Literal', value: 'c', start: 0, end: 1 },
{ type: 'ColorValue', r: 0, g: 0, b: 0, a: 1, raw: '', start: 1, end: 2 }
]);
deepEqual(tokenize('c#1'), [
{ type: 'Literal', value: 'c', start: 0, end: 1 },
{ type: 'ColorValue', r: 17, g: 17, b: 17, a: 1, raw: '1', start: 1, end: 3 }
]);
deepEqual(tokenize('c#.'), [
{ type: 'Literal', value: 'c', start: 0, end: 1 },
{ type: 'ColorValue', r: 0, g: 0, b: 0, a: 1, raw: '.', start: 1, end: 3 }
]);
deepEqual(tokenize('c#f'), [
{ type: 'Literal', value: 'c', start: 0, end: 1 },
{ type: 'ColorValue', r: 255, g: 255, b: 255, a: 1, raw: 'f', start: 1, end: 3 }
]);
deepEqual(tokenize('c#a#b#c'), [
{ type: 'Literal', value: 'c', start: 0, end: 1 },
{ type: 'ColorValue', r: 170, g: 170, b: 170, a: 1, raw: 'a', start: 1, end: 3 },
{ type: 'ColorValue', r: 187, g: 187, b: 187, a: 1, raw: 'b', start: 3, end: 5 },
{ type: 'ColorValue', r: 204, g: 204, b: 204, a: 1, raw: 'c', start: 5, end: 7 }
]);
deepEqual(tokenize('c#af'), [
{ type: 'Literal', value: 'c', start: 0, end: 1 },
{ type: 'ColorValue', r: 175, g: 175, b: 175, a: 1, raw: 'af', start: 1, end: 4 }
]);
deepEqual(tokenize('c#fc0'), [
{ type: 'Literal', value: 'c', start: 0, end: 1 },
{ type: 'ColorValue', r: 255, g: 204, b: 0, a: 1, raw: 'fc0', start: 1, end: 5 }
]);
deepEqual(tokenize('c#11.5'), [
{ type: 'Literal', value: 'c', start: 0, end: 1 },
{ type: 'ColorValue', r: 17, g: 17, b: 17, a: 0.5, raw: '11.5', start: 1, end: 6 }
]);
deepEqual(tokenize('c#.99'), [
{ type: 'Literal', value: 'c', start: 0, end: 1 },
{ type: 'ColorValue', r: 0, g: 0, b: 0, a: 0.99, raw: '.99', start: 1, end: 5 }
]);
deepEqual(tokenize('c#t'), [
{ type: 'Literal', value: 'c', start: 0, end: 1 },
{ type: 'ColorValue', r: 0, g: 0, b: 0, a: 0, raw: 't', start: 1, end: 3 }
]);
deepEqual(tokenize('c#${fff}'), [
{ type: 'Literal', value: 'c', start: 0, end: 1 },
{ type: 'Literal', value: '#', start: 1, end: 2 },
{ type: 'Field', index: undefined, name: 'fff', start: 2, end: 8 }
]);
});
it('keywords', () => {
deepEqual(tokenize('m:a'), [
{ type: 'Literal', value: 'm', start: 0, end: 1 },
{ type: 'Operator', operator: ':', start: 1, end: 2 },
{ type: 'Literal', value: 'a', start: 2, end: 3 }
]);
deepEqual(tokenize('m-a'), [
{ type: 'Literal', value: 'm', start: 0, end: 1 },
{ type: 'Operator', operator: '-', start: 1, end: 2 },
{ type: 'Literal', value: 'a', start: 2, end: 3 }
]);
deepEqual(tokenize('m-abc'), [
{ type: 'Literal', value: 'm', start: 0, end: 1 },
{ type: 'Operator', operator: '-', start: 1, end: 2 },
{ type: 'Literal', value: 'abc', start: 2, end: 5 }
]);
deepEqual(tokenize('m-a0'), [
{ type: 'Literal', value: 'm', start: 0, end: 1 },
{ type: 'Operator', operator: '-', start: 1, end: 2 },
{ type: 'Literal', value: 'a', start: 2, end: 3 },
{ type: 'NumberValue', value: 0, rawValue: '0', unit: '', start: 3, end: 4 }
]);
deepEqual(tokenize('m-a0-a'), [
{ type: 'Literal', value: 'm', start: 0, end: 1 },
{ type: 'Operator', operator: '-', start: 1, end: 2 },
{ type: 'Literal', value: 'a', start: 2, end: 3 },
{ type: 'NumberValue', value: 0, rawValue: '0', unit: '', start: 3, end: 4 },
{ type: 'Operator', operator: '-', start: 4, end: 5 },
{ type: 'Literal', value: 'a', start: 5, end: 6 }
]);
});
it('arguments', () => {
deepEqual(tokenize('lg(top, "red, black", rgb(0, 0, 0) 10%)'), [
{ type: 'Literal', value: 'lg', start: 0, end: 2 },
{ type: 'Bracket', open: true, start: 2, end: 3 },
{ type: 'Literal', value: 'top', start: 3, end: 6 },
{ type: 'Operator', operator: ',', start: 6, end: 7 },
{ type: 'WhiteSpace', start: 7, end: 8 },
{ type: 'StringValue', value: 'red, black', quote: 'double', start: 8, end: 20 },
{ type: 'Operator', operator: ',', start: 20, end: 21 },
{ type: 'WhiteSpace', start: 21, end: 22 },
{ type: 'Literal', value: 'rgb', start: 22, end: 25 },
{ type: 'Bracket', open: true, start: 25, end: 26 },
{ type: 'NumberValue', value: 0, rawValue: '0', unit: '', start: 26, end: 27 },
{ type: 'Operator', operator: ',', start: 27, end: 28 },
{ type: 'WhiteSpace', start: 28, end: 29 },
{ type: 'NumberValue', value: 0, rawValue: '0', unit: '', start: 29, end: 30 },
{ type: 'Operator', operator: ',', start: 30, end: 31 },
{ type: 'WhiteSpace', start: 31, end: 32 },
{ type: 'NumberValue', value: 0, rawValue: '0', unit: '', start: 32, end: 33 },
{ type: 'Bracket', open: false, start: 33, end: 34 },
{ type: 'WhiteSpace', start: 34, end: 35 },
{ type: 'NumberValue', value: 10, rawValue: '10', unit: '%', start: 35, end: 38 },
{ type: 'Bracket', open: false, start: 38, end: 39 }
]);
});
it('important', () => {
deepEqual(tokenize('!'), [
{ type: 'Operator', operator: '!', start: 0, end: 1 }
]);
deepEqual(tokenize('p!'), [
{ type: 'Literal', value: 'p', start: 0, end: 1 },
{ type: 'Operator', operator: '!', start: 1, end: 2 }
]);
deepEqual(tokenize('p10!'), [
{ type: 'Literal', value: 'p', start: 0, end: 1 },
{ type: 'NumberValue', value: 10, rawValue: '10', unit: '', start: 1, end: 3 },
{ type: 'Operator', operator: '!', start: 3, end: 4 }
]);
});
it('mixed', () => {
deepEqual(tokenize('bd1-s#fc0'), [
{ type: 'Literal', value: 'bd', start: 0, end: 2 },
{ type: 'NumberValue', value: 1, rawValue: '1', unit: '', start: 2, end: 3 },
{ type: 'Operator', operator: '-', start: 3, end: 4 },
{ type: 'Literal', value: 's', start: 4, end: 5 },
{ type: 'ColorValue', r: 255, g: 204, b: 0, a: 1, raw: 'fc0', start: 5, end: 9 }
]);
deepEqual(tokenize('bd#fc0-1'), [
{ type: 'Literal', value: 'bd', start: 0, end: 2 },
{ type: 'ColorValue', r: 255, g: 204, b: 0, a: 1, raw: 'fc0', start: 2, end: 6 },
{ type: 'Operator', operator: '-', start: 6, end: 7 },
{ type: 'NumberValue', value: 1, rawValue: '1', unit: '', start: 7, end: 8 }
]);
deepEqual(tokenize('p0+m0'), [
{ type: 'Literal', value: 'p', start: 0, end: 1 },
{ type: 'NumberValue', value: 0, unit: '', start: 5, end: 6 },
{ type: 'Operator', operator: '!', start: 6, end: 7 }
]);
});
it('embedded variables', () => {
{ type: 'Literal', value: 'm', start: 4, end: 5 },
{ type: 'NumberValue', value: 0, rawValue: '0', unit: '', start: 5, end: 6 },
{ type: 'Operator', operator: '!', start: 6, end: 7 }
]);
deepEqual(tokenize('${2:0}%'), [
{ type: 'Field', index: 2, name: '0', start: 0, end: 6 },
{ type: 'Literal', value: '%', start: 6, end: 7 }
]);
deepEqual(tokenize('.${1:5}'), [
{ type: 'Literal', value: '.', start: 0, end: 1 },
{ type: 'Field', index: 1, name: '5', start: 1, end: 7 },
]);
});
it('embedded variables', () => {
deepEqual(tokenize('foo$bar'), [
{ type: 'Literal', value: 'foo', start: 0, end: 3 },
{ type: 'Literal', value: '$bar', start: 3, end: 7 }
]);
deepEqual(tokenize('foo$bar-2'), [
{ type: 'Literal', value: 'foo', start: 0, end: 3 },
{ type: 'Literal', value: '$bar-2', start: 3, end: 9 }
]);
deepEqual(tokenize('foo$bar@bam'), [
{ type: 'Literal', value: 'foo', start: 0, end: 3 },
{ type: 'Literal', value: '$bar', start: 3, end: 7 },
{ type: 'Literal', value: '@bam', start: 7, end: 11 }
]);
deepEqual(tokenize('@k10'), [
{ type: 'Literal', value: '@k', start: 0, end: 2 },
{ type: 'NumberValue', value: 10, rawValue: '10', unit: '', start: 2, end: 4 }
]);
});
});
<MSG> Fix issue #547 (#575)
<DFF> @@ -265,6 +265,11 @@ describe('Tokenizer', () => {
{ type: 'NumberValue', value: 0, unit: '', start: 5, end: 6 },
{ type: 'Operator', operator: '!', start: 6, end: 7 }
]);
+
+ deepEqual(tokenize("${2:0}%"), [
+ { type: 'Field', index: 2, name: '0', start: 0, end: 6 },
+ { type: 'Literal', value: '%', start: 6, end: 7 }
+ ]);
});
it('embedded variables', () => {
| 5 | Fix issue #547 (#575) | 0 | .ts | ts | mit | emmetio/emmet |
10072427 | <NME> tokenizer.ts
<BEF> import { deepEqual } from 'assert';
import tokenize from '../src/tokenizer';
describe('Tokenizer', () => {
it('numeric values', () => {
deepEqual(tokenize('p10'), [
{ type: 'Literal', value: 'p', start: 0, end: 1 },
{ type: 'NumberValue', value: 10, rawValue: '10', unit: '', start: 1, end: 3 }
]);
deepEqual(tokenize('p-10'), [
{ type: 'Literal', value: 'p', start: 0, end: 1 },
{ type: 'NumberValue', value: -10, rawValue: '-10', unit: '', start: 1, end: 4 }
]);
deepEqual(tokenize('p-10-'), [
{ type: 'Literal', value: 'p', start: 0, end: 1 },
{ type: 'NumberValue', value: -10, rawValue: '-10', unit: '', start: 1, end: 4 },
{ type: 'Operator', operator: '-', start: 4, end: 5 }
]);
deepEqual(tokenize('p-10-20'), [
{ type: 'Literal', value: 'p', start: 0, end: 1 },
{ type: 'NumberValue', value: -10, rawValue: '-10', unit: '', start: 1, end: 4 },
{ type: 'Operator', operator: '-', start: 4, end: 5 },
{ type: 'NumberValue', value: 20, rawValue: '20', unit: '', start: 5, end: 7 }
]);
deepEqual(tokenize('p-10--20'), [
{ type: 'Literal', value: 'p', start: 0, end: 1 },
{ type: 'NumberValue', value: -10, rawValue: '-10', unit: '', start: 1, end: 4 },
{ type: 'Operator', operator: '-', start: 4, end: 5 },
{ type: 'NumberValue', value: -20, rawValue: '-20', unit: '', start: 5, end: 8 }
]);
deepEqual(tokenize('p-10-20--30'), [
{ type: 'Literal', value: 'p', start: 0, end: 1 },
{ type: 'NumberValue', value: -10, rawValue: '-10', unit: '', start: 1, end: 4 },
{ type: 'Operator', operator: '-', start: 4, end: 5 },
{ type: 'NumberValue', value: 20, rawValue: '20', unit: '', start: 5, end: 7 },
{ type: 'Operator', operator: '-', start: 7, end: 8 },
{ type: 'NumberValue', value: -30, rawValue: '-30', unit: '', start: 8, end: 11 }
]);
deepEqual(tokenize('p-10p-20--30'), [
{ type: 'Literal', value: 'p', start: 0, end: 1 },
{ type: 'NumberValue', value: -10, rawValue: '-10', unit: 'p', start: 1, end: 5 },
{ type: 'NumberValue', value: -20, rawValue: '-20', unit: '', start: 5, end: 8 },
{ type: 'Operator', operator: '-', start: 8, end: 9 },
{ type: 'NumberValue', value: -30, rawValue: '-30', unit: '', start: 9, end: 12 }
]);
deepEqual(tokenize('p-10%-20--30'), [
{ type: 'Literal', value: 'p', start: 0, end: 1 },
{ type: 'NumberValue', value: -10, rawValue: '-10', unit: '%', start: 1, end: 5 },
{ type: 'NumberValue', value: -20, rawValue: '-20', unit: '', start: 5, end: 8 },
{ type: 'Operator', operator: '-', start: 8, end: 9 },
{ type: 'NumberValue', value: -30, rawValue: '-30', unit: '', start: 9, end: 12 }
]);
});
it('float values', () => {
deepEqual(tokenize('p.5'), [
{ type: 'Literal', value: 'p', start: 0, end: 1 },
{ type: 'NumberValue', value: 0.5, rawValue: '.5', unit: '', start: 1, end: 3 }
]);
deepEqual(tokenize('p-.5'), [
{ type: 'Literal', value: 'p', start: 0, end: 1 },
{ type: 'NumberValue', value: -0.5, rawValue: '-.5', unit: '', start: 1, end: 4 }
]);
deepEqual(tokenize('p.1.2.3'), [
{ type: 'Literal', value: 'p', start: 0, end: 1 },
{ type: 'NumberValue', value: 0.1, rawValue: '.1', unit: '', start: 1, end: 3 },
{ type: 'NumberValue', value: 0.2, rawValue: '.2', unit: '', start: 3, end: 5 },
{ type: 'NumberValue', value: 0.3, rawValue: '.3', unit: '', start: 5, end: 7 }
]);
deepEqual(tokenize('p.1-.2.3'), [
{ type: 'Literal', value: 'p', start: 0, end: 1 },
{ type: 'NumberValue', value: 0.1, rawValue: '.1', unit: '', start: 1, end: 3 },
{ type: 'Operator', operator: '-', start: 3, end: 4 },
{ type: 'NumberValue', value: 0.2, rawValue: '.2', unit: '', start: 4, end: 6 },
{ type: 'NumberValue', value: 0.3, rawValue: '.3', unit: '', start: 6, end: 8 }
]);
deepEqual(tokenize('p.1--.2.3'), [
{ type: 'Literal', value: 'p', start: 0, end: 1 },
{ type: 'NumberValue', value: 0.1, rawValue: '.1', unit: '', start: 1, end: 3 },
{ type: 'Operator', operator: '-', start: 3, end: 4 },
{ type: 'NumberValue', value: -0.2, rawValue: '-.2', unit: '', start: 4, end: 7 },
{ type: 'NumberValue', value: 0.3, rawValue: '.3', unit: '', start: 7, end: 9 }
]);
deepEqual(tokenize('10'), [
{ type: 'NumberValue', value: 10, rawValue: '10', unit: '', start: 0, end: 2 },
]);
deepEqual(tokenize('.1'), [
{ type: 'NumberValue', value: 0.1, rawValue: '.1', unit: '', start: 0, end: 2 },
]);
// NB: now dot should be a part of literal
// throws(() => tokenize('.foo'), /Unexpected character at 1/);
});
it('color values', () => {
deepEqual(tokenize('c#'), [
{ type: 'Literal', value: 'c', start: 0, end: 1 },
{ type: 'ColorValue', r: 0, g: 0, b: 0, a: 1, raw: '', start: 1, end: 2 }
]);
deepEqual(tokenize('c#1'), [
{ type: 'Literal', value: 'c', start: 0, end: 1 },
{ type: 'ColorValue', r: 17, g: 17, b: 17, a: 1, raw: '1', start: 1, end: 3 }
]);
deepEqual(tokenize('c#.'), [
{ type: 'Literal', value: 'c', start: 0, end: 1 },
{ type: 'ColorValue', r: 0, g: 0, b: 0, a: 1, raw: '.', start: 1, end: 3 }
]);
deepEqual(tokenize('c#f'), [
{ type: 'Literal', value: 'c', start: 0, end: 1 },
{ type: 'ColorValue', r: 255, g: 255, b: 255, a: 1, raw: 'f', start: 1, end: 3 }
]);
deepEqual(tokenize('c#a#b#c'), [
{ type: 'Literal', value: 'c', start: 0, end: 1 },
{ type: 'ColorValue', r: 170, g: 170, b: 170, a: 1, raw: 'a', start: 1, end: 3 },
{ type: 'ColorValue', r: 187, g: 187, b: 187, a: 1, raw: 'b', start: 3, end: 5 },
{ type: 'ColorValue', r: 204, g: 204, b: 204, a: 1, raw: 'c', start: 5, end: 7 }
]);
deepEqual(tokenize('c#af'), [
{ type: 'Literal', value: 'c', start: 0, end: 1 },
{ type: 'ColorValue', r: 175, g: 175, b: 175, a: 1, raw: 'af', start: 1, end: 4 }
]);
deepEqual(tokenize('c#fc0'), [
{ type: 'Literal', value: 'c', start: 0, end: 1 },
{ type: 'ColorValue', r: 255, g: 204, b: 0, a: 1, raw: 'fc0', start: 1, end: 5 }
]);
deepEqual(tokenize('c#11.5'), [
{ type: 'Literal', value: 'c', start: 0, end: 1 },
{ type: 'ColorValue', r: 17, g: 17, b: 17, a: 0.5, raw: '11.5', start: 1, end: 6 }
]);
deepEqual(tokenize('c#.99'), [
{ type: 'Literal', value: 'c', start: 0, end: 1 },
{ type: 'ColorValue', r: 0, g: 0, b: 0, a: 0.99, raw: '.99', start: 1, end: 5 }
]);
deepEqual(tokenize('c#t'), [
{ type: 'Literal', value: 'c', start: 0, end: 1 },
{ type: 'ColorValue', r: 0, g: 0, b: 0, a: 0, raw: 't', start: 1, end: 3 }
]);
deepEqual(tokenize('c#${fff}'), [
{ type: 'Literal', value: 'c', start: 0, end: 1 },
{ type: 'Literal', value: '#', start: 1, end: 2 },
{ type: 'Field', index: undefined, name: 'fff', start: 2, end: 8 }
]);
});
it('keywords', () => {
deepEqual(tokenize('m:a'), [
{ type: 'Literal', value: 'm', start: 0, end: 1 },
{ type: 'Operator', operator: ':', start: 1, end: 2 },
{ type: 'Literal', value: 'a', start: 2, end: 3 }
]);
deepEqual(tokenize('m-a'), [
{ type: 'Literal', value: 'm', start: 0, end: 1 },
{ type: 'Operator', operator: '-', start: 1, end: 2 },
{ type: 'Literal', value: 'a', start: 2, end: 3 }
]);
deepEqual(tokenize('m-abc'), [
{ type: 'Literal', value: 'm', start: 0, end: 1 },
{ type: 'Operator', operator: '-', start: 1, end: 2 },
{ type: 'Literal', value: 'abc', start: 2, end: 5 }
]);
deepEqual(tokenize('m-a0'), [
{ type: 'Literal', value: 'm', start: 0, end: 1 },
{ type: 'Operator', operator: '-', start: 1, end: 2 },
{ type: 'Literal', value: 'a', start: 2, end: 3 },
{ type: 'NumberValue', value: 0, rawValue: '0', unit: '', start: 3, end: 4 }
]);
deepEqual(tokenize('m-a0-a'), [
{ type: 'Literal', value: 'm', start: 0, end: 1 },
{ type: 'Operator', operator: '-', start: 1, end: 2 },
{ type: 'Literal', value: 'a', start: 2, end: 3 },
{ type: 'NumberValue', value: 0, rawValue: '0', unit: '', start: 3, end: 4 },
{ type: 'Operator', operator: '-', start: 4, end: 5 },
{ type: 'Literal', value: 'a', start: 5, end: 6 }
]);
});
it('arguments', () => {
deepEqual(tokenize('lg(top, "red, black", rgb(0, 0, 0) 10%)'), [
{ type: 'Literal', value: 'lg', start: 0, end: 2 },
{ type: 'Bracket', open: true, start: 2, end: 3 },
{ type: 'Literal', value: 'top', start: 3, end: 6 },
{ type: 'Operator', operator: ',', start: 6, end: 7 },
{ type: 'WhiteSpace', start: 7, end: 8 },
{ type: 'StringValue', value: 'red, black', quote: 'double', start: 8, end: 20 },
{ type: 'Operator', operator: ',', start: 20, end: 21 },
{ type: 'WhiteSpace', start: 21, end: 22 },
{ type: 'Literal', value: 'rgb', start: 22, end: 25 },
{ type: 'Bracket', open: true, start: 25, end: 26 },
{ type: 'NumberValue', value: 0, rawValue: '0', unit: '', start: 26, end: 27 },
{ type: 'Operator', operator: ',', start: 27, end: 28 },
{ type: 'WhiteSpace', start: 28, end: 29 },
{ type: 'NumberValue', value: 0, rawValue: '0', unit: '', start: 29, end: 30 },
{ type: 'Operator', operator: ',', start: 30, end: 31 },
{ type: 'WhiteSpace', start: 31, end: 32 },
{ type: 'NumberValue', value: 0, rawValue: '0', unit: '', start: 32, end: 33 },
{ type: 'Bracket', open: false, start: 33, end: 34 },
{ type: 'WhiteSpace', start: 34, end: 35 },
{ type: 'NumberValue', value: 10, rawValue: '10', unit: '%', start: 35, end: 38 },
{ type: 'Bracket', open: false, start: 38, end: 39 }
]);
});
it('important', () => {
deepEqual(tokenize('!'), [
{ type: 'Operator', operator: '!', start: 0, end: 1 }
]);
deepEqual(tokenize('p!'), [
{ type: 'Literal', value: 'p', start: 0, end: 1 },
{ type: 'Operator', operator: '!', start: 1, end: 2 }
]);
deepEqual(tokenize('p10!'), [
{ type: 'Literal', value: 'p', start: 0, end: 1 },
{ type: 'NumberValue', value: 10, rawValue: '10', unit: '', start: 1, end: 3 },
{ type: 'Operator', operator: '!', start: 3, end: 4 }
]);
});
it('mixed', () => {
deepEqual(tokenize('bd1-s#fc0'), [
{ type: 'Literal', value: 'bd', start: 0, end: 2 },
{ type: 'NumberValue', value: 1, rawValue: '1', unit: '', start: 2, end: 3 },
{ type: 'Operator', operator: '-', start: 3, end: 4 },
{ type: 'Literal', value: 's', start: 4, end: 5 },
{ type: 'ColorValue', r: 255, g: 204, b: 0, a: 1, raw: 'fc0', start: 5, end: 9 }
]);
deepEqual(tokenize('bd#fc0-1'), [
{ type: 'Literal', value: 'bd', start: 0, end: 2 },
{ type: 'ColorValue', r: 255, g: 204, b: 0, a: 1, raw: 'fc0', start: 2, end: 6 },
{ type: 'Operator', operator: '-', start: 6, end: 7 },
{ type: 'NumberValue', value: 1, rawValue: '1', unit: '', start: 7, end: 8 }
]);
deepEqual(tokenize('p0+m0'), [
{ type: 'Literal', value: 'p', start: 0, end: 1 },
{ type: 'NumberValue', value: 0, unit: '', start: 5, end: 6 },
{ type: 'Operator', operator: '!', start: 6, end: 7 }
]);
});
it('embedded variables', () => {
{ type: 'Literal', value: 'm', start: 4, end: 5 },
{ type: 'NumberValue', value: 0, rawValue: '0', unit: '', start: 5, end: 6 },
{ type: 'Operator', operator: '!', start: 6, end: 7 }
]);
deepEqual(tokenize('${2:0}%'), [
{ type: 'Field', index: 2, name: '0', start: 0, end: 6 },
{ type: 'Literal', value: '%', start: 6, end: 7 }
]);
deepEqual(tokenize('.${1:5}'), [
{ type: 'Literal', value: '.', start: 0, end: 1 },
{ type: 'Field', index: 1, name: '5', start: 1, end: 7 },
]);
});
it('embedded variables', () => {
deepEqual(tokenize('foo$bar'), [
{ type: 'Literal', value: 'foo', start: 0, end: 3 },
{ type: 'Literal', value: '$bar', start: 3, end: 7 }
]);
deepEqual(tokenize('foo$bar-2'), [
{ type: 'Literal', value: 'foo', start: 0, end: 3 },
{ type: 'Literal', value: '$bar-2', start: 3, end: 9 }
]);
deepEqual(tokenize('foo$bar@bam'), [
{ type: 'Literal', value: 'foo', start: 0, end: 3 },
{ type: 'Literal', value: '$bar', start: 3, end: 7 },
{ type: 'Literal', value: '@bam', start: 7, end: 11 }
]);
deepEqual(tokenize('@k10'), [
{ type: 'Literal', value: '@k', start: 0, end: 2 },
{ type: 'NumberValue', value: 10, rawValue: '10', unit: '', start: 2, end: 4 }
]);
});
});
<MSG> Fix issue #547 (#575)
<DFF> @@ -265,6 +265,11 @@ describe('Tokenizer', () => {
{ type: 'NumberValue', value: 0, unit: '', start: 5, end: 6 },
{ type: 'Operator', operator: '!', start: 6, end: 7 }
]);
+
+ deepEqual(tokenize("${2:0}%"), [
+ { type: 'Field', index: 2, name: '0', start: 0, end: 6 },
+ { type: 'Literal', value: '%', start: 6, end: 7 }
+ ]);
});
it('embedded variables', () => {
| 5 | Fix issue #547 (#575) | 0 | .ts | ts | mit | emmetio/emmet |
10072428 | <NME> parser.ts
<BEF> import { strictEqual as equal, throws } from 'assert';
import parser from '../src/parser';
import tokenizer from '../src/tokenizer';
import stringify from './assets/stringify';
import { ParserOptions } from '../src';
const parse = (abbr: string, options?: ParserOptions) => parser(tokenizer(abbr), options);
const str = (abbr: string, options?: ParserOptions) => stringify(parse(abbr, options));
describe('Parser', () => {
equal(str('p'), '<p></p>');
equal(str('p{text}'), '<p>text</p>');
equal(str('.nav'), '<? class=nav></?>');
equal(str('#sample*3'), '<?*3 id=sample></?>');
equal(str('a>b'), '<a><b></b></a>');
// https://github.com/emmetio/emmet/issues/562
equal(str('li[repeat.for="todo of todoList"]'), '<li repeat.for="todo of todoList"></li>', 'Dots in attribute names');
equal(str('a>b'), '<a><b></b></a>');
equal(str('a+b'), '<a></a><b></b>');
equal(str('a+b>c+d'), '<a></a><b><c></c><d></d></b>');
equal(str('a>b>c+e'), '<a><b><c></c><e></e></b></a>');
equal(str('a>b>c^d'), '<a><b><c></c></b><d></d></a>');
equal(str('a>b>c^^^^d'), '<a><b><c></c></b></a><d></d>');
equal(str('a:b>c'), '<a:b><c></c></a:b>');
equal(str('ul.nav[title="foo"]'), '<ul class=nav title="foo"></ul>');
});
it('groups', () => {
equal(str('a>(b>c)+d'), '<a>(<b><c></c></b>)<d></d></a>');
equal(str('(a>b)+(c>d)'), '(<a><b></b></a>)(<c><d></d></c>)');
equal(str('a>((b>c)(d>e))f'), '<a>((<b><c></c></b>)(<d><e></e></d>))<f></f></a>');
equal(str('a>((((b>c))))+d'), '<a>((((<b><c></c></b>))))<d></d></a>');
equal(str('a>(((b>c))*4)+d'), '<a>(((<b><c></c></b>))*4)<d></d></a>');
equal(str('(div>dl>(dt+dd)*2)'), '(<div><dl>(<dt></dt><dd></dd>)*2</dl></div>)');
equal(str('a>()'), '<a>()</a>');
});
it('attributes', () => {
equal(str('[].foo'), '<? class=foo></?>');
equal(str('[a]'), '<? a></?>');
equal(str('[a b c [d]]'), '<? a b c [d]></?>');
equal(str('[a=b]'), '<? a=b></?>');
equal(str('[a=b c= d=e]'), '<? a=b c d=e></?>');
equal(str('[a=b.c d=тест]'), '<? a=b.c d=тест></?>');
equal(str('[[a]=b (c)=d]'), '<? [a]=b (c)=d></?>');
// Quoted attribute values
equal(str('[a="b"]'), '<? a="b"></?>');
equal(str('[a="b" c=\'d\' e=""]'), '<? a="b" c=\'d\' e=""></?>');
equal(str('[[a]="b" (c)=\'d\']'), '<? [a]="b" (c)=\'d\'></?>');
// Mixed quoted
equal(str('[a="foo\'bar" b=\'foo"bar\' c="foo\\\"bar"]'), '<? a="foo\'bar" b=\'foo"bar\' c="foo"bar"></?>');
// Boolean & implied attributes
equal(str('[a. b.]'), '<? a. b.></?>');
equal(str('[!a !b.]'), '<? !a !b.></?>');
// Default values
equal(str('["a.b"]'), '<? ?="a.b"></?>');
equal(str('[\'a.b\' "c=d" foo=bar "./test.html"]'), '<? ?=\'a.b\' ?="c=d" foo=bar ?="./test.html"></?>');
// Expressions as values
equal(str('[foo={1 + 2} bar={fn(1, "foo")}]'), '<? foo={1 + 2} bar={fn(1, "foo")}></?>');
// Tabstops as unquoted values
equal(str('[name=${1} value=${2:test}]'), '<? name=${1} value=${2:test}></?>');
});
it('malformed attributes', () => {
equal(str('[a'), '<? a></?>');
equal(str('[a={foo]'), '<? a={foo]></?>');
throws(() => str('[a="foo]'), /Unclosed quote/);
throws(() => str('[a=b=c]'), /Unexpected "Operator" token/);
});
it('elements', () => {
equal(str('div'), '<div></div>');
equal(str('div.foo'), '<div class=foo></div>');
equal(str('div#foo'), '<div id=foo></div>');
equal(str('div#foo.bar'), '<div id=foo class=bar></div>');
equal(str('div.foo#bar'), '<div class=foo id=bar></div>');
equal(str('div.foo.bar.baz'), '<div class=foo class=bar class=baz></div>');
equal(str('.foo'), '<? class=foo></?>');
equal(str('#foo'), '<? id=foo></?>');
equal(str('.foo_bar'), '<? class=foo_bar></?>');
equal(str('#foo.bar'), '<? id=foo class=bar></?>');
// Attribute shorthands
equal(str('.'), '<? class></?>');
equal(str('#'), '<? id></?>');
equal(str('#.'), '<? id class></?>');
equal(str('.#.'), '<? class id class></?>');
equal(str('.a..'), '<? class=a class></?>');
// Elements with attributes
equal(str('div[foo=bar]'), '<div foo=bar></div>');
equal(str('div.a[b=c]'), '<div class=a b=c></div>');
equal(str('div[b=c].a'), '<div b=c class=a></div>');
equal(str('div[a=b][c="d"]'), '<div a=b c="d"></div>');
equal(str('[b=c]'), '<? b=c></?>');
equal(str('.a[b=c]'), '<? class=a b=c></?>');
equal(str('[b=c].a#d'), '<? b=c class=a id=d></?>');
equal(str('[b=c]a'), '<? b=c></?><a></a>', 'Do not consume node name after attribute set');
// Element with text
equal(str('div{foo}'), '<div>foo</div>');
equal(str('{foo}'), '<?>foo</?>');
// Mixed
equal(str('div.foo{bar}'), '<div class=foo>bar</div>');
equal(str('.foo{bar}#baz'), '<? class=foo id=baz>bar</?>');
equal(str('.foo[b=c]{bar}'), '<? class=foo b=c>bar</?>');
// Repeated element
equal(str('div.foo*3'), '<div*3 class=foo></div>');
equal(str('.foo*'), '<?* class=foo></?>');
equal(str('.a[b=c]*10'), '<?*10 class=a b=c></?>');
equal(str('.a*10[b=c]'), '<?*10 class=a b=c></?>');
equal(str('.a*10{text}'), '<?*10 class=a>text</?>');
// Self-closing element
equal(str('div/'), '<div />');
equal(str('.foo/'), '<? class=foo />');
equal(str('.foo[bar]/'), '<? class=foo bar />');
equal(str('.foo/*3'), '<?*3 class=foo />');
equal(str('.foo*3/'), '<?*3 class=foo />');
throws(() => parse('/'), /Unexpected character/);
});
it('JSX', () => {
const opt = { jsx: true };
equal(str('foo.bar', opt), '<foo class=bar></foo>');
equal(str('Foo.bar', opt), '<Foo class=bar></Foo>');
equal(str('Foo.Bar', opt), '<Foo.Bar></Foo.Bar>');
equal(str('Foo.', opt), '<Foo class></Foo>');
equal(str('Foo.Bar.baz', opt), '<Foo.Bar class=baz></Foo.Bar>');
equal(str('Foo.Bar.Baz', opt), '<Foo.Bar.Baz></Foo.Bar.Baz>');
equal(str('.{theme.class}', opt), '<? class=theme.class></?>');
equal(str('#{id}', opt), '<? id=id></?>');
equal(str('Foo.{theme.class}', opt), '<Foo class=theme.class></Foo>');
});
it('errors', () => {
throws(() => parse('str?'), /Unexpected character at 4/);
throws(() => parse('foo,bar'), /Unexpected character at 4/);
equal(str('foo\\,bar'), '<foo,bar></foo,bar>');
equal(str('foo\\'), '<foo></foo>');
});
it('missing braces', () => {
// Do not throw errors on missing closing braces
equal(str('div[title="test"'), '<div title="test"></div>');
equal(str('div(foo'), '<div></div>(<foo></foo>)');
equal(str('div{foo'), '<div>foo</div>');
});
});
<MSG> Ensure escaped characters afe supported
<DFF> @@ -11,6 +11,7 @@ describe('Parser', () => {
equal(str('p'), '<p></p>');
equal(str('p{text}'), '<p>text</p>');
equal(str('.nav'), '<? class=nav></?>');
+ equal(str('div.width1\\/2'), '<div class=width1/2></div>');
equal(str('#sample*3'), '<?*3 id=sample></?>');
equal(str('a>b'), '<a><b></b></a>');
| 1 | Ensure escaped characters afe supported | 0 | .ts | ts | mit | emmetio/emmet |
10072429 | <NME> parser.ts
<BEF> import { strictEqual as equal, throws } from 'assert';
import parser from '../src/parser';
import tokenizer from '../src/tokenizer';
import stringify from './assets/stringify';
import { ParserOptions } from '../src';
const parse = (abbr: string, options?: ParserOptions) => parser(tokenizer(abbr), options);
const str = (abbr: string, options?: ParserOptions) => stringify(parse(abbr, options));
describe('Parser', () => {
equal(str('p'), '<p></p>');
equal(str('p{text}'), '<p>text</p>');
equal(str('.nav'), '<? class=nav></?>');
equal(str('#sample*3'), '<?*3 id=sample></?>');
equal(str('a>b'), '<a><b></b></a>');
// https://github.com/emmetio/emmet/issues/562
equal(str('li[repeat.for="todo of todoList"]'), '<li repeat.for="todo of todoList"></li>', 'Dots in attribute names');
equal(str('a>b'), '<a><b></b></a>');
equal(str('a+b'), '<a></a><b></b>');
equal(str('a+b>c+d'), '<a></a><b><c></c><d></d></b>');
equal(str('a>b>c+e'), '<a><b><c></c><e></e></b></a>');
equal(str('a>b>c^d'), '<a><b><c></c></b><d></d></a>');
equal(str('a>b>c^^^^d'), '<a><b><c></c></b></a><d></d>');
equal(str('a:b>c'), '<a:b><c></c></a:b>');
equal(str('ul.nav[title="foo"]'), '<ul class=nav title="foo"></ul>');
});
it('groups', () => {
equal(str('a>(b>c)+d'), '<a>(<b><c></c></b>)<d></d></a>');
equal(str('(a>b)+(c>d)'), '(<a><b></b></a>)(<c><d></d></c>)');
equal(str('a>((b>c)(d>e))f'), '<a>((<b><c></c></b>)(<d><e></e></d>))<f></f></a>');
equal(str('a>((((b>c))))+d'), '<a>((((<b><c></c></b>))))<d></d></a>');
equal(str('a>(((b>c))*4)+d'), '<a>(((<b><c></c></b>))*4)<d></d></a>');
equal(str('(div>dl>(dt+dd)*2)'), '(<div><dl>(<dt></dt><dd></dd>)*2</dl></div>)');
equal(str('a>()'), '<a>()</a>');
});
it('attributes', () => {
equal(str('[].foo'), '<? class=foo></?>');
equal(str('[a]'), '<? a></?>');
equal(str('[a b c [d]]'), '<? a b c [d]></?>');
equal(str('[a=b]'), '<? a=b></?>');
equal(str('[a=b c= d=e]'), '<? a=b c d=e></?>');
equal(str('[a=b.c d=тест]'), '<? a=b.c d=тест></?>');
equal(str('[[a]=b (c)=d]'), '<? [a]=b (c)=d></?>');
// Quoted attribute values
equal(str('[a="b"]'), '<? a="b"></?>');
equal(str('[a="b" c=\'d\' e=""]'), '<? a="b" c=\'d\' e=""></?>');
equal(str('[[a]="b" (c)=\'d\']'), '<? [a]="b" (c)=\'d\'></?>');
// Mixed quoted
equal(str('[a="foo\'bar" b=\'foo"bar\' c="foo\\\"bar"]'), '<? a="foo\'bar" b=\'foo"bar\' c="foo"bar"></?>');
// Boolean & implied attributes
equal(str('[a. b.]'), '<? a. b.></?>');
equal(str('[!a !b.]'), '<? !a !b.></?>');
// Default values
equal(str('["a.b"]'), '<? ?="a.b"></?>');
equal(str('[\'a.b\' "c=d" foo=bar "./test.html"]'), '<? ?=\'a.b\' ?="c=d" foo=bar ?="./test.html"></?>');
// Expressions as values
equal(str('[foo={1 + 2} bar={fn(1, "foo")}]'), '<? foo={1 + 2} bar={fn(1, "foo")}></?>');
// Tabstops as unquoted values
equal(str('[name=${1} value=${2:test}]'), '<? name=${1} value=${2:test}></?>');
});
it('malformed attributes', () => {
equal(str('[a'), '<? a></?>');
equal(str('[a={foo]'), '<? a={foo]></?>');
throws(() => str('[a="foo]'), /Unclosed quote/);
throws(() => str('[a=b=c]'), /Unexpected "Operator" token/);
});
it('elements', () => {
equal(str('div'), '<div></div>');
equal(str('div.foo'), '<div class=foo></div>');
equal(str('div#foo'), '<div id=foo></div>');
equal(str('div#foo.bar'), '<div id=foo class=bar></div>');
equal(str('div.foo#bar'), '<div class=foo id=bar></div>');
equal(str('div.foo.bar.baz'), '<div class=foo class=bar class=baz></div>');
equal(str('.foo'), '<? class=foo></?>');
equal(str('#foo'), '<? id=foo></?>');
equal(str('.foo_bar'), '<? class=foo_bar></?>');
equal(str('#foo.bar'), '<? id=foo class=bar></?>');
// Attribute shorthands
equal(str('.'), '<? class></?>');
equal(str('#'), '<? id></?>');
equal(str('#.'), '<? id class></?>');
equal(str('.#.'), '<? class id class></?>');
equal(str('.a..'), '<? class=a class></?>');
// Elements with attributes
equal(str('div[foo=bar]'), '<div foo=bar></div>');
equal(str('div.a[b=c]'), '<div class=a b=c></div>');
equal(str('div[b=c].a'), '<div b=c class=a></div>');
equal(str('div[a=b][c="d"]'), '<div a=b c="d"></div>');
equal(str('[b=c]'), '<? b=c></?>');
equal(str('.a[b=c]'), '<? class=a b=c></?>');
equal(str('[b=c].a#d'), '<? b=c class=a id=d></?>');
equal(str('[b=c]a'), '<? b=c></?><a></a>', 'Do not consume node name after attribute set');
// Element with text
equal(str('div{foo}'), '<div>foo</div>');
equal(str('{foo}'), '<?>foo</?>');
// Mixed
equal(str('div.foo{bar}'), '<div class=foo>bar</div>');
equal(str('.foo{bar}#baz'), '<? class=foo id=baz>bar</?>');
equal(str('.foo[b=c]{bar}'), '<? class=foo b=c>bar</?>');
// Repeated element
equal(str('div.foo*3'), '<div*3 class=foo></div>');
equal(str('.foo*'), '<?* class=foo></?>');
equal(str('.a[b=c]*10'), '<?*10 class=a b=c></?>');
equal(str('.a*10[b=c]'), '<?*10 class=a b=c></?>');
equal(str('.a*10{text}'), '<?*10 class=a>text</?>');
// Self-closing element
equal(str('div/'), '<div />');
equal(str('.foo/'), '<? class=foo />');
equal(str('.foo[bar]/'), '<? class=foo bar />');
equal(str('.foo/*3'), '<?*3 class=foo />');
equal(str('.foo*3/'), '<?*3 class=foo />');
throws(() => parse('/'), /Unexpected character/);
});
it('JSX', () => {
const opt = { jsx: true };
equal(str('foo.bar', opt), '<foo class=bar></foo>');
equal(str('Foo.bar', opt), '<Foo class=bar></Foo>');
equal(str('Foo.Bar', opt), '<Foo.Bar></Foo.Bar>');
equal(str('Foo.', opt), '<Foo class></Foo>');
equal(str('Foo.Bar.baz', opt), '<Foo.Bar class=baz></Foo.Bar>');
equal(str('Foo.Bar.Baz', opt), '<Foo.Bar.Baz></Foo.Bar.Baz>');
equal(str('.{theme.class}', opt), '<? class=theme.class></?>');
equal(str('#{id}', opt), '<? id=id></?>');
equal(str('Foo.{theme.class}', opt), '<Foo class=theme.class></Foo>');
});
it('errors', () => {
throws(() => parse('str?'), /Unexpected character at 4/);
throws(() => parse('foo,bar'), /Unexpected character at 4/);
equal(str('foo\\,bar'), '<foo,bar></foo,bar>');
equal(str('foo\\'), '<foo></foo>');
});
it('missing braces', () => {
// Do not throw errors on missing closing braces
equal(str('div[title="test"'), '<div title="test"></div>');
equal(str('div(foo'), '<div></div>(<foo></foo>)');
equal(str('div{foo'), '<div>foo</div>');
});
});
<MSG> Ensure escaped characters afe supported
<DFF> @@ -11,6 +11,7 @@ describe('Parser', () => {
equal(str('p'), '<p></p>');
equal(str('p{text}'), '<p>text</p>');
equal(str('.nav'), '<? class=nav></?>');
+ equal(str('div.width1\\/2'), '<div class=width1/2></div>');
equal(str('#sample*3'), '<?*3 id=sample></?>');
equal(str('a>b'), '<a><b></b></a>');
| 1 | Ensure escaped characters afe supported | 0 | .ts | ts | mit | emmetio/emmet |
10072430 | <NME> stylesheet.ts
<BEF> import { strictEqual as equal, ok } from 'assert';
import { stylesheet as expandAbbreviation, resolveConfig, CSSAbbreviationScope } from '../src';
import score from '../src/stylesheet/score';
const defaultConfig = resolveConfig({
type: 'stylesheet',
options: {
'output.field': (index, placeholder) => `\${${index}${placeholder ? ':' + placeholder : ''}}`,
'stylesheet.fuzzySearchMinScore': 0
},
snippets: {
mten: 'margin: 10px;',
fsz: 'font-size',
gt: 'grid-template: repeat(2,auto) / repeat(auto-fit, minmax(250px, 1fr))'
},
cache: {},
});
function expand(abbr: string, config = defaultConfig) {
return expandAbbreviation(abbr, config);
}
describe('Stylesheet abbreviations', () => {
describe('Scoring', () => {
const pick = (abbr: string, items: string[]) => items
.map(item => ({ item, score: score(abbr, item, true) }))
.filter(obj => obj.score)
.sort((a, b) => b.score - a.score)
.map(obj => obj.item)[0];
it('compare scores', () => {
equal(score('aaa', 'aaa'), 1);
equal(score('baa', 'aaa'), 0);
ok(!score('b', 'aaa'));
ok(score('a', 'aaa'));
ok(score('a', 'abc'));
ok(score('ac', 'abc'));
ok(score('a', 'aaa') < score('aa', 'aaa'));
ok(score('ab', 'abc') > score('ab', 'acb'));
// acronym bonus
ok(score('ab', 'a-b') > score('ab', 'acb'));
});
it('pick padding or position', () => {
const items = ['p', 'pb', 'pl', 'pos', 'pa', 'oa', 'soa', 'pr', 'pt'];
equal(pick('p', items), 'p');
equal(pick('poa', items), 'pos');
});
});
it('keywords', () => {
equal(expand('bd1-s'), 'border: 1px solid;');
equal(expand('dib'), 'display: inline-block;');
equal(expand('bxsz'), 'box-sizing: ${1:border-box};');
equal(expand('bxz'), 'box-sizing: ${1:border-box};');
equal(expand('bxzc'), 'box-sizing: content-box;');
equal(expand('fl'), 'float: ${1:left};');
equal(expand('fll'), 'float: left;');
equal(expand('pos'), 'position: ${1:relative};');
equal(expand('poa'), 'position: absolute;');
equal(expand('por'), 'position: relative;');
equal(expand('pof'), 'position: fixed;');
equal(expand('pos-a'), 'position: absolute;');
equal(expand('m'), 'margin: ${0};');
equal(expand('m0'), 'margin: 0;');
// use `auto` as global keyword
equal(expand('m0-a'), 'margin: 0 auto;');
equal(expand('m-a'), 'margin: auto;');
equal(expand('bg'), 'background: ${1:#000};');
equal(expand('bd'), 'border: ${1:1px} ${2:solid} ${3:#000};');
equal(expand('bd0-s#fc0'), 'border: 0 solid #fc0;');
equal(expand('bd0-dd#fc0'), 'border: 0 dot-dash #fc0;');
equal(expand('bd0-h#fc0'), 'border: 0 hidden #fc0;');
equal(expand('trf-trs'), 'transform: translate(${1:x}, ${2:y});');
// https://github.com/emmetio/emmet/issues/610
equal(expand('c'), 'color: ${1:#000};');
equal(expand('cr'), 'color: rgb(${1:0}, ${2:0}, ${3:0});');
equal(expand('cra'), 'color: rgba(${1:0}, ${2:0}, ${3:0}, ${4:.5});');
// https://github.com/emmetio/emmet/issues/647
equal(expand('gtc'), 'grid-template-columns: repeat(${0});');
equal(expand('gtr'), 'grid-template-rows: repeat(${0});');
equal(expand('lis:n'), 'list-style: none;');
equal(expand('list:n'), 'list-style-type: none;');
equal(expand('bdt:n'), 'border-top: none;');
equal(expand('bgi:n'), 'background-image: none;');
equal(expand('q:n'), 'quotes: none;');
});
it('numeric', () => {
equal(expand('p0'), 'padding: 0;', 'No unit for 0');
equal(expand('p10'), 'padding: 10px;', '`px` unit for integers');
equal(expand('p.4'), 'padding: 0.4em;', '`em` for floats');
equal(expand('fz10'), 'font-size: 10px;', '`px` for integers');
equal(expand('fz1.'), 'font-size: 1em;', '`em` for explicit float');
// https://github.com/emmetio/emmet/issues/558
equal(expand('us'), 'user-select: none;');
});
it('numeric with format options', () => {
// https://github.com/emmetio/emmet/issues/558
equal(expand('us'), 'user-select: none;');
// https://github.com/microsoft/vscode/issues/105697
equal(expand('opa1'), 'opacity: 1;', 'Unitless property');
equal(expand('opa.1'), 'opacity: 0.1;', 'Unitless property');
equal(expand('opa.a'), 'opacity: .a;', 'Unitless property');
});
it('numeric with format options', () => {
const config = resolveConfig({
type: 'stylesheet',
options: {
'stylesheet.intUnit': 'pt',
'stylesheet.floatUnit': 'vh',
'stylesheet.unitAliases': {
e: 'em',
p: '%',
x: 'ex',
r: ' / @rem'
}
}
});
equal(expand('p0', config), 'padding: 0;', 'No unit for 0');
equal(expand('p10', config), 'padding: 10pt;', '`pt` unit for integers');
equal(expand('p.4', config), 'padding: 0.4vh;', '`vh` for floats');
equal(expand('p10p', config), 'padding: 10%;', 'unit alias');
equal(expand('z10', config), 'z-index: 10;', 'Unitless property');
equal(expand('p10r', config), 'padding: 10 / @rem;', 'unit alias');
});
it('important', () => {
equal(expand('!'), '!important');
equal(expand('p!'), 'padding: ${0} !important;');
equal(expand('p0!'), 'padding: 0 !important;');
});
it('color', () => {
equal(expand('c'), 'color: ${1:#000};');
equal(expand('c#'), 'color: #000;');
equal(expand('c#f.5'), 'color: rgba(255, 255, 255, 0.5);');
equal(expand('c#f.5!'), 'color: rgba(255, 255, 255, 0.5) !important;');
equal(expand('bgc'), 'background-color: #${1:fff};');
});
it('snippets', () => {
equal(expand('@'), '@media ${1:screen} {\n\t${0}\n}');
// Insert value into snippet fields
equal(expand('@k-name'), '@keyframes name {\n\t${2}\n}');
equal(expand('@k-name10'), '@keyframes name {\n\t10\n}');
equal(expand('gt'), 'grid-template: repeat(2, auto) / repeat(auto-fit, minmax(250px, 1fr));');
});
it('multiple properties', () => {
equal(expand('p10+m10-20'), 'padding: 10px;\nmargin: 10px 20px;');
equal(expand('p+bd'), 'padding: ${0};\nborder: ${1:1px} ${2:solid} ${3:#000};');
});
it('functions', () => {
equal(expand('trf-s(2)'), 'transform: scale(2, ${2:y});');
equal(expand('trf-s(2, 3)'), 'transform: scale(2, 3);');
});
it('case insensitive matches', () => {
equal(expand('trf:rx'), 'transform: rotateX(${1:angle});');
});
it('gradient resolver', () => {
equal(expand('lg'), 'background-image: linear-gradient(${0});');
equal(expand('lg(to right, #0, #f00.5)'), 'background-image: linear-gradient(to right, #000, rgba(255, 0, 0, 0.5));');
});
it('unmatched abbreviation', () => {
// This example is useless: it’s unexpected to receive `align-self: unset`
// for `auto` snippet
// equal(expand('auto', resolveConfig({
// type: 'stylesheet',
// options: { 'stylesheet.fuzzySearchMinScore': 0 }
// })), 'align-self: unset;');
equal(expand('auto'), 'auto: ${0};');
});
it('CSS-in-JS', () => {
const config = resolveConfig({
type: 'stylesheet',
options: {
'stylesheet.json': true,
'stylesheet.between': ': '
}
});
equal(expand('p10+mt10-20', config), 'padding: 10,\nmarginTop: \'10px 20px\',');
equal(expand('bgc', config), 'backgroundColor: \'#fff\',');
});
it('resolve context value', () => {
const config = resolveConfig({
type: 'stylesheet',
context: { name: 'align-content' }
});
equal(expand('s', config), 'start');
equal(expand('a', config), 'auto');
});
it('limit snippets by scope', () => {
const sectionScope = resolveConfig({
type: 'stylesheet',
context: { name: CSSAbbreviationScope.Section },
snippets: {
mten: 'margin: 10px;',
fsz: 'font-size',
myCenterAwesome: 'body {\n\tdisplay: grid;\n}'
}
});
const propertyScope = resolveConfig({
type: 'stylesheet',
context: { name: CSSAbbreviationScope.Property },
snippets: {
mten: 'margin: 10px;',
fsz: 'font-size',
myCenterAwesome: 'body {\n\tdisplay: grid;\n}'
}
});
equal(expand('m', sectionScope), 'body {\n\tdisplay: grid;\n}');
equal(expand('b', sectionScope), '');
equal(expand('m', propertyScope), 'margin: ;');
});
});
<MSG> Fix vscode issue #105697 (#627)
<DFF> @@ -107,6 +107,11 @@ describe('Stylesheet abbreviations', () => {
// https://github.com/emmetio/emmet/issues/558
equal(expand('us'), 'user-select: none;');
+
+ // https://github.com/microsoft/vscode/issues/105697
+ equal(expand('opa1'), 'opacity: 1;', 'Unitless property');
+ equal(expand('opa.1'), 'opacity: 0.1;', 'Unitless property');
+ equal(expand('opa.a'), 'opacity: .a;', 'Unitless property');
});
it('numeric with format options', () => {
| 5 | Fix vscode issue #105697 (#627) | 0 | .ts | ts | mit | emmetio/emmet |
10072431 | <NME> stylesheet.ts
<BEF> import { strictEqual as equal, ok } from 'assert';
import { stylesheet as expandAbbreviation, resolveConfig, CSSAbbreviationScope } from '../src';
import score from '../src/stylesheet/score';
const defaultConfig = resolveConfig({
type: 'stylesheet',
options: {
'output.field': (index, placeholder) => `\${${index}${placeholder ? ':' + placeholder : ''}}`,
'stylesheet.fuzzySearchMinScore': 0
},
snippets: {
mten: 'margin: 10px;',
fsz: 'font-size',
gt: 'grid-template: repeat(2,auto) / repeat(auto-fit, minmax(250px, 1fr))'
},
cache: {},
});
function expand(abbr: string, config = defaultConfig) {
return expandAbbreviation(abbr, config);
}
describe('Stylesheet abbreviations', () => {
describe('Scoring', () => {
const pick = (abbr: string, items: string[]) => items
.map(item => ({ item, score: score(abbr, item, true) }))
.filter(obj => obj.score)
.sort((a, b) => b.score - a.score)
.map(obj => obj.item)[0];
it('compare scores', () => {
equal(score('aaa', 'aaa'), 1);
equal(score('baa', 'aaa'), 0);
ok(!score('b', 'aaa'));
ok(score('a', 'aaa'));
ok(score('a', 'abc'));
ok(score('ac', 'abc'));
ok(score('a', 'aaa') < score('aa', 'aaa'));
ok(score('ab', 'abc') > score('ab', 'acb'));
// acronym bonus
ok(score('ab', 'a-b') > score('ab', 'acb'));
});
it('pick padding or position', () => {
const items = ['p', 'pb', 'pl', 'pos', 'pa', 'oa', 'soa', 'pr', 'pt'];
equal(pick('p', items), 'p');
equal(pick('poa', items), 'pos');
});
});
it('keywords', () => {
equal(expand('bd1-s'), 'border: 1px solid;');
equal(expand('dib'), 'display: inline-block;');
equal(expand('bxsz'), 'box-sizing: ${1:border-box};');
equal(expand('bxz'), 'box-sizing: ${1:border-box};');
equal(expand('bxzc'), 'box-sizing: content-box;');
equal(expand('fl'), 'float: ${1:left};');
equal(expand('fll'), 'float: left;');
equal(expand('pos'), 'position: ${1:relative};');
equal(expand('poa'), 'position: absolute;');
equal(expand('por'), 'position: relative;');
equal(expand('pof'), 'position: fixed;');
equal(expand('pos-a'), 'position: absolute;');
equal(expand('m'), 'margin: ${0};');
equal(expand('m0'), 'margin: 0;');
// use `auto` as global keyword
equal(expand('m0-a'), 'margin: 0 auto;');
equal(expand('m-a'), 'margin: auto;');
equal(expand('bg'), 'background: ${1:#000};');
equal(expand('bd'), 'border: ${1:1px} ${2:solid} ${3:#000};');
equal(expand('bd0-s#fc0'), 'border: 0 solid #fc0;');
equal(expand('bd0-dd#fc0'), 'border: 0 dot-dash #fc0;');
equal(expand('bd0-h#fc0'), 'border: 0 hidden #fc0;');
equal(expand('trf-trs'), 'transform: translate(${1:x}, ${2:y});');
// https://github.com/emmetio/emmet/issues/610
equal(expand('c'), 'color: ${1:#000};');
equal(expand('cr'), 'color: rgb(${1:0}, ${2:0}, ${3:0});');
equal(expand('cra'), 'color: rgba(${1:0}, ${2:0}, ${3:0}, ${4:.5});');
// https://github.com/emmetio/emmet/issues/647
equal(expand('gtc'), 'grid-template-columns: repeat(${0});');
equal(expand('gtr'), 'grid-template-rows: repeat(${0});');
equal(expand('lis:n'), 'list-style: none;');
equal(expand('list:n'), 'list-style-type: none;');
equal(expand('bdt:n'), 'border-top: none;');
equal(expand('bgi:n'), 'background-image: none;');
equal(expand('q:n'), 'quotes: none;');
});
it('numeric', () => {
equal(expand('p0'), 'padding: 0;', 'No unit for 0');
equal(expand('p10'), 'padding: 10px;', '`px` unit for integers');
equal(expand('p.4'), 'padding: 0.4em;', '`em` for floats');
equal(expand('fz10'), 'font-size: 10px;', '`px` for integers');
equal(expand('fz1.'), 'font-size: 1em;', '`em` for explicit float');
// https://github.com/emmetio/emmet/issues/558
equal(expand('us'), 'user-select: none;');
});
it('numeric with format options', () => {
// https://github.com/emmetio/emmet/issues/558
equal(expand('us'), 'user-select: none;');
// https://github.com/microsoft/vscode/issues/105697
equal(expand('opa1'), 'opacity: 1;', 'Unitless property');
equal(expand('opa.1'), 'opacity: 0.1;', 'Unitless property');
equal(expand('opa.a'), 'opacity: .a;', 'Unitless property');
});
it('numeric with format options', () => {
const config = resolveConfig({
type: 'stylesheet',
options: {
'stylesheet.intUnit': 'pt',
'stylesheet.floatUnit': 'vh',
'stylesheet.unitAliases': {
e: 'em',
p: '%',
x: 'ex',
r: ' / @rem'
}
}
});
equal(expand('p0', config), 'padding: 0;', 'No unit for 0');
equal(expand('p10', config), 'padding: 10pt;', '`pt` unit for integers');
equal(expand('p.4', config), 'padding: 0.4vh;', '`vh` for floats');
equal(expand('p10p', config), 'padding: 10%;', 'unit alias');
equal(expand('z10', config), 'z-index: 10;', 'Unitless property');
equal(expand('p10r', config), 'padding: 10 / @rem;', 'unit alias');
});
it('important', () => {
equal(expand('!'), '!important');
equal(expand('p!'), 'padding: ${0} !important;');
equal(expand('p0!'), 'padding: 0 !important;');
});
it('color', () => {
equal(expand('c'), 'color: ${1:#000};');
equal(expand('c#'), 'color: #000;');
equal(expand('c#f.5'), 'color: rgba(255, 255, 255, 0.5);');
equal(expand('c#f.5!'), 'color: rgba(255, 255, 255, 0.5) !important;');
equal(expand('bgc'), 'background-color: #${1:fff};');
});
it('snippets', () => {
equal(expand('@'), '@media ${1:screen} {\n\t${0}\n}');
// Insert value into snippet fields
equal(expand('@k-name'), '@keyframes name {\n\t${2}\n}');
equal(expand('@k-name10'), '@keyframes name {\n\t10\n}');
equal(expand('gt'), 'grid-template: repeat(2, auto) / repeat(auto-fit, minmax(250px, 1fr));');
});
it('multiple properties', () => {
equal(expand('p10+m10-20'), 'padding: 10px;\nmargin: 10px 20px;');
equal(expand('p+bd'), 'padding: ${0};\nborder: ${1:1px} ${2:solid} ${3:#000};');
});
it('functions', () => {
equal(expand('trf-s(2)'), 'transform: scale(2, ${2:y});');
equal(expand('trf-s(2, 3)'), 'transform: scale(2, 3);');
});
it('case insensitive matches', () => {
equal(expand('trf:rx'), 'transform: rotateX(${1:angle});');
});
it('gradient resolver', () => {
equal(expand('lg'), 'background-image: linear-gradient(${0});');
equal(expand('lg(to right, #0, #f00.5)'), 'background-image: linear-gradient(to right, #000, rgba(255, 0, 0, 0.5));');
});
it('unmatched abbreviation', () => {
// This example is useless: it’s unexpected to receive `align-self: unset`
// for `auto` snippet
// equal(expand('auto', resolveConfig({
// type: 'stylesheet',
// options: { 'stylesheet.fuzzySearchMinScore': 0 }
// })), 'align-self: unset;');
equal(expand('auto'), 'auto: ${0};');
});
it('CSS-in-JS', () => {
const config = resolveConfig({
type: 'stylesheet',
options: {
'stylesheet.json': true,
'stylesheet.between': ': '
}
});
equal(expand('p10+mt10-20', config), 'padding: 10,\nmarginTop: \'10px 20px\',');
equal(expand('bgc', config), 'backgroundColor: \'#fff\',');
});
it('resolve context value', () => {
const config = resolveConfig({
type: 'stylesheet',
context: { name: 'align-content' }
});
equal(expand('s', config), 'start');
equal(expand('a', config), 'auto');
});
it('limit snippets by scope', () => {
const sectionScope = resolveConfig({
type: 'stylesheet',
context: { name: CSSAbbreviationScope.Section },
snippets: {
mten: 'margin: 10px;',
fsz: 'font-size',
myCenterAwesome: 'body {\n\tdisplay: grid;\n}'
}
});
const propertyScope = resolveConfig({
type: 'stylesheet',
context: { name: CSSAbbreviationScope.Property },
snippets: {
mten: 'margin: 10px;',
fsz: 'font-size',
myCenterAwesome: 'body {\n\tdisplay: grid;\n}'
}
});
equal(expand('m', sectionScope), 'body {\n\tdisplay: grid;\n}');
equal(expand('b', sectionScope), '');
equal(expand('m', propertyScope), 'margin: ;');
});
});
<MSG> Fix vscode issue #105697 (#627)
<DFF> @@ -107,6 +107,11 @@ describe('Stylesheet abbreviations', () => {
// https://github.com/emmetio/emmet/issues/558
equal(expand('us'), 'user-select: none;');
+
+ // https://github.com/microsoft/vscode/issues/105697
+ equal(expand('opa1'), 'opacity: 1;', 'Unitless property');
+ equal(expand('opa.1'), 'opacity: 0.1;', 'Unitless property');
+ equal(expand('opa.a'), 'opacity: .a;', 'Unitless property');
});
it('numeric with format options', () => {
| 5 | Fix vscode issue #105697 (#627) | 0 | .ts | ts | mit | emmetio/emmet |
10072432 | <NME> configuration.rb
<BEF> # frozen_string_literal: true
module Split
class Configuration
attr_accessor :ignore_ip_addresses
attr_accessor :ignore_filter
attr_accessor :db_failover
attr_accessor :db_failover_on_db_error
attr_accessor :db_failover_allow_parameter_override
attr_accessor :allow_multiple_experiments
attr_accessor :enabled
attr_accessor :persistence
attr_accessor :persistence_cookie_length
attr_accessor :persistence_cookie_domain
attr_accessor :algorithm
attr_accessor :store_override
attr_accessor :start_manually
attr_accessor :reset_manually
attr_accessor :on_trial
attr_accessor :on_trial_choose
attr_accessor :on_trial_complete
attr_accessor :on_experiment_reset
attr_accessor :on_experiment_delete
attr_accessor :on_before_experiment_reset
attr_accessor :on_experiment_winner_choose
attr_accessor :on_before_experiment_delete
attr_accessor :include_rails_helper
attr_accessor :beta_probability_simulations
attr_accessor :winning_alternative_recalculation_interval
attr_accessor :redis
attr_accessor :dashboard_pagination_default_per_page
attr_accessor :cache
attr_reader :experiments
attr_writer :bots
'Slurp' => 'Yahoo spider',
'Sogou' => 'Chinese search engine',
'spider' => 'generic web spider',
'UnwindFetchor' => 'Gnip crawler'
'WordPress' => 'WordPress spider',
'YandexBot' => 'Yandex spider',
'ZIBB' => 'ZIBB spider',
"Baiduspider" => "Chinese search engine",
"bingbot" => "Microsoft bing bot",
"Butterfly" => "Topsy Labs",
"Gigabot" => "Gigabot spider",
"Googlebot" => "Google spider",
"MJ12bot" => "Majestic-12 spider",
"msnbot" => "Microsoft bot",
"rogerbot" => "SeoMoz spider",
"PaperLiBot" => "PaperLi is another content curation service",
"Slurp" => "Yahoo spider",
"Sogou" => "Chinese search engine",
"spider" => "generic web spider",
"UnwindFetchor" => "Gnip crawler",
"WordPress" => "WordPress spider",
"YandexAccessibilityBot" => "Yandex accessibility spider",
"YandexBot" => "Yandex spider",
"YandexMobileBot" => "Yandex mobile spider",
"ZIBB" => "ZIBB spider",
# HTTP libraries
"Apache-HttpClient" => "Java http library",
"AppEngine-Google" => "Google App Engine",
"curl" => "curl unix CLI http client",
"ColdFusion" => "ColdFusion http library",
"EventMachine HttpClient" => "Ruby http library",
"Go http package" => "Go http library",
"Go-http-client" => "Go http library",
"Java" => "Generic Java http library",
"libwww-perl" => "Perl client-server library loved by script kids",
"lwp-trivial" => "Another Perl library loved by script kids",
"Python-urllib" => "Python http library",
"PycURL" => "Python http library",
"Test Certificate Info" => "C http library?",
"Typhoeus" => "Ruby http library",
"Wget" => "wget unix CLI http client",
# URL expanders / previewers
"awe.sm" => "Awe.sm URL expander",
"bitlybot" => "bit.ly bot",
"[email protected]" => "Linkfluence bot",
"facebookexternalhit" => "facebook bot",
"Facebot" => "Facebook crawler",
"Feedfetcher-Google" => "Google Feedfetcher",
"https://developers.google.com/+/web/snippet" => "Google+ Snippet Fetcher",
"LinkedInBot" => "LinkedIn bot",
"LongURL" => "URL expander service",
"NING" => "NING - Yet Another Twitter Swarmer",
"Pinterestbot" => "Pinterest Bot",
"redditbot" => "Reddit Bot",
"ShortLinkTranslate" => "Link shortener",
"Slackbot" => "Slackbot link expander",
"TweetmemeBot" => "TweetMeMe Crawler",
"Twitterbot" => "Twitter URL expander",
"UnwindFetch" => "Gnip URL expander",
"vkShare" => "VKontake Sharer",
# Uptime monitoring
"check_http" => "Nagios monitor",
"GoogleStackdriverMonitoring" => "Google Cloud monitor",
"NewRelicPinger" => "NewRelic monitor",
"Panopta" => "Monitoring service",
"Pingdom" => "Pingdom monitoring",
"SiteUptime" => "Site monitoring services",
"UptimeRobot" => "Monitoring service",
# ???
"DigitalPersona Fingerprint Software" => "HP Fingerprint scanner",
"ShowyouBot" => "Showyou iOS app spider",
"ZyBorg" => "Zyborg? Hmmm....",
"ELB-HealthChecker" => "ELB Health Check"
}
end
def experiments=(experiments)
raise InvalidExperimentsFormatError.new("Experiments must be a Hash") unless experiments.respond_to?(:keys)
@experiments = experiments
end
def disabled?
!enabled
end
def experiment_for(name)
if normalized_experiments
# TODO symbols
normalized_experiments[name.to_sym]
end
end
def metrics
return @metrics if defined?(@metrics)
@metrics = {}
if self.experiments
self.experiments.each do |key, value|
metrics = value_for(value, :metric) rescue nil
Array(metrics).each do |metric_name|
if metric_name
@metrics[metric_name.to_sym] ||= []
@metrics[metric_name.to_sym] << Split::Experiment.new(key)
end
end
end
end
@metrics
end
def normalized_experiments
return nil if @experiments.nil?
experiment_config = {}
@experiments.keys.each do |name|
experiment_config[name.to_sym] = {}
end
@experiments.each do |experiment_name, settings|
alternatives = if (alts = value_for(settings, :alternatives))
normalize_alternatives(alts)
end
experiment_data = {
alternatives: alternatives,
goals: value_for(settings, :goals),
metadata: value_for(settings, :metadata),
algorithm: value_for(settings, :algorithm),
resettable: value_for(settings, :resettable)
}
experiment_data.each do |name, value|
experiment_config[experiment_name.to_sym][name] = value if value != nil
end
end
experiment_config
end
def normalize_alternatives(alternatives)
given_probability, num_with_probability = alternatives.inject([0, 0]) do |a, v|
p, n = a
if percent = value_for(v, :percent)
[p + percent, n + 1]
else
a
end
end
num_without_probability = alternatives.length - num_with_probability
unassigned_probability = ((100.0 - given_probability) / num_without_probability / 100.0)
if num_with_probability.nonzero?
alternatives = alternatives.map do |v|
if (name = value_for(v, :name)) && (percent = value_for(v, :percent))
{ name => percent / 100.0 }
elsif name = value_for(v, :name)
{ name => unassigned_probability }
else
{ v => unassigned_probability }
end
end
[alternatives.shift, alternatives]
else
alternatives = alternatives.dup
[alternatives.shift, alternatives]
end
end
def robot_regex
@robot_regex ||= /\b(?:#{escaped_bots.join('|')})\b|\A\W*\z/i
end
def initialize
@ignore_ip_addresses = []
@ignore_filter = proc { |request| is_robot? || is_ignored_ip_address? }
@db_failover = false
@db_failover_on_db_error = proc { |error| } # e.g. use Rails logger here
@on_experiment_reset = proc { |experiment| }
@on_experiment_delete = proc { |experiment| }
@on_before_experiment_reset = proc { |experiment| }
@on_before_experiment_delete = proc { |experiment| }
@on_experiment_winner_choose = proc { |experiment| }
@db_failover_allow_parameter_override = false
@allow_multiple_experiments = false
@enabled = true
@experiments = {}
@persistence = Split::Persistence::SessionAdapter
@persistence_cookie_length = 31536000 # One year from now
@persistence_cookie_domain = nil
@algorithm = Split::Algorithms::WeightedSample
@include_rails_helper = true
@beta_probability_simulations = 10000
@winning_alternative_recalculation_interval = 60 * 60 * 24 # 1 day
@redis = ENV.fetch(ENV.fetch("REDIS_PROVIDER", "REDIS_URL"), "redis://localhost:6379")
@dashboard_pagination_default_per_page = 10
end
private
def value_for(hash, key)
if hash.kind_of?(Hash)
hash.has_key?(key.to_s) ? hash[key.to_s] : hash[key.to_sym]
end
end
def escaped_bots
bots.map { |key, _| Regexp.escape(key) }
end
end
end
<MSG> Adding missing separator.
<DFF> @@ -37,7 +37,7 @@ module Split
'Slurp' => 'Yahoo spider',
'Sogou' => 'Chinese search engine',
'spider' => 'generic web spider',
- 'UnwindFetchor' => 'Gnip crawler'
+ 'UnwindFetchor' => 'Gnip crawler',
'WordPress' => 'WordPress spider',
'YandexBot' => 'Yandex spider',
'ZIBB' => 'ZIBB spider',
| 1 | Adding missing separator. | 1 | .rb | rb | mit | splitrb/split |
10072433 | <NME> configuration.rb
<BEF> # frozen_string_literal: true
module Split
class Configuration
attr_accessor :ignore_ip_addresses
attr_accessor :ignore_filter
attr_accessor :db_failover
attr_accessor :db_failover_on_db_error
attr_accessor :db_failover_allow_parameter_override
attr_accessor :allow_multiple_experiments
attr_accessor :enabled
attr_accessor :persistence
attr_accessor :persistence_cookie_length
attr_accessor :persistence_cookie_domain
attr_accessor :algorithm
attr_accessor :store_override
attr_accessor :start_manually
attr_accessor :reset_manually
attr_accessor :on_trial
attr_accessor :on_trial_choose
attr_accessor :on_trial_complete
attr_accessor :on_experiment_reset
attr_accessor :on_experiment_delete
attr_accessor :on_before_experiment_reset
attr_accessor :on_experiment_winner_choose
attr_accessor :on_before_experiment_delete
attr_accessor :include_rails_helper
attr_accessor :beta_probability_simulations
attr_accessor :winning_alternative_recalculation_interval
attr_accessor :redis
attr_accessor :dashboard_pagination_default_per_page
attr_accessor :cache
attr_reader :experiments
attr_writer :bots
'Slurp' => 'Yahoo spider',
'Sogou' => 'Chinese search engine',
'spider' => 'generic web spider',
'UnwindFetchor' => 'Gnip crawler'
'WordPress' => 'WordPress spider',
'YandexBot' => 'Yandex spider',
'ZIBB' => 'ZIBB spider',
"Baiduspider" => "Chinese search engine",
"bingbot" => "Microsoft bing bot",
"Butterfly" => "Topsy Labs",
"Gigabot" => "Gigabot spider",
"Googlebot" => "Google spider",
"MJ12bot" => "Majestic-12 spider",
"msnbot" => "Microsoft bot",
"rogerbot" => "SeoMoz spider",
"PaperLiBot" => "PaperLi is another content curation service",
"Slurp" => "Yahoo spider",
"Sogou" => "Chinese search engine",
"spider" => "generic web spider",
"UnwindFetchor" => "Gnip crawler",
"WordPress" => "WordPress spider",
"YandexAccessibilityBot" => "Yandex accessibility spider",
"YandexBot" => "Yandex spider",
"YandexMobileBot" => "Yandex mobile spider",
"ZIBB" => "ZIBB spider",
# HTTP libraries
"Apache-HttpClient" => "Java http library",
"AppEngine-Google" => "Google App Engine",
"curl" => "curl unix CLI http client",
"ColdFusion" => "ColdFusion http library",
"EventMachine HttpClient" => "Ruby http library",
"Go http package" => "Go http library",
"Go-http-client" => "Go http library",
"Java" => "Generic Java http library",
"libwww-perl" => "Perl client-server library loved by script kids",
"lwp-trivial" => "Another Perl library loved by script kids",
"Python-urllib" => "Python http library",
"PycURL" => "Python http library",
"Test Certificate Info" => "C http library?",
"Typhoeus" => "Ruby http library",
"Wget" => "wget unix CLI http client",
# URL expanders / previewers
"awe.sm" => "Awe.sm URL expander",
"bitlybot" => "bit.ly bot",
"[email protected]" => "Linkfluence bot",
"facebookexternalhit" => "facebook bot",
"Facebot" => "Facebook crawler",
"Feedfetcher-Google" => "Google Feedfetcher",
"https://developers.google.com/+/web/snippet" => "Google+ Snippet Fetcher",
"LinkedInBot" => "LinkedIn bot",
"LongURL" => "URL expander service",
"NING" => "NING - Yet Another Twitter Swarmer",
"Pinterestbot" => "Pinterest Bot",
"redditbot" => "Reddit Bot",
"ShortLinkTranslate" => "Link shortener",
"Slackbot" => "Slackbot link expander",
"TweetmemeBot" => "TweetMeMe Crawler",
"Twitterbot" => "Twitter URL expander",
"UnwindFetch" => "Gnip URL expander",
"vkShare" => "VKontake Sharer",
# Uptime monitoring
"check_http" => "Nagios monitor",
"GoogleStackdriverMonitoring" => "Google Cloud monitor",
"NewRelicPinger" => "NewRelic monitor",
"Panopta" => "Monitoring service",
"Pingdom" => "Pingdom monitoring",
"SiteUptime" => "Site monitoring services",
"UptimeRobot" => "Monitoring service",
# ???
"DigitalPersona Fingerprint Software" => "HP Fingerprint scanner",
"ShowyouBot" => "Showyou iOS app spider",
"ZyBorg" => "Zyborg? Hmmm....",
"ELB-HealthChecker" => "ELB Health Check"
}
end
def experiments=(experiments)
raise InvalidExperimentsFormatError.new("Experiments must be a Hash") unless experiments.respond_to?(:keys)
@experiments = experiments
end
def disabled?
!enabled
end
def experiment_for(name)
if normalized_experiments
# TODO symbols
normalized_experiments[name.to_sym]
end
end
def metrics
return @metrics if defined?(@metrics)
@metrics = {}
if self.experiments
self.experiments.each do |key, value|
metrics = value_for(value, :metric) rescue nil
Array(metrics).each do |metric_name|
if metric_name
@metrics[metric_name.to_sym] ||= []
@metrics[metric_name.to_sym] << Split::Experiment.new(key)
end
end
end
end
@metrics
end
def normalized_experiments
return nil if @experiments.nil?
experiment_config = {}
@experiments.keys.each do |name|
experiment_config[name.to_sym] = {}
end
@experiments.each do |experiment_name, settings|
alternatives = if (alts = value_for(settings, :alternatives))
normalize_alternatives(alts)
end
experiment_data = {
alternatives: alternatives,
goals: value_for(settings, :goals),
metadata: value_for(settings, :metadata),
algorithm: value_for(settings, :algorithm),
resettable: value_for(settings, :resettable)
}
experiment_data.each do |name, value|
experiment_config[experiment_name.to_sym][name] = value if value != nil
end
end
experiment_config
end
def normalize_alternatives(alternatives)
given_probability, num_with_probability = alternatives.inject([0, 0]) do |a, v|
p, n = a
if percent = value_for(v, :percent)
[p + percent, n + 1]
else
a
end
end
num_without_probability = alternatives.length - num_with_probability
unassigned_probability = ((100.0 - given_probability) / num_without_probability / 100.0)
if num_with_probability.nonzero?
alternatives = alternatives.map do |v|
if (name = value_for(v, :name)) && (percent = value_for(v, :percent))
{ name => percent / 100.0 }
elsif name = value_for(v, :name)
{ name => unassigned_probability }
else
{ v => unassigned_probability }
end
end
[alternatives.shift, alternatives]
else
alternatives = alternatives.dup
[alternatives.shift, alternatives]
end
end
def robot_regex
@robot_regex ||= /\b(?:#{escaped_bots.join('|')})\b|\A\W*\z/i
end
def initialize
@ignore_ip_addresses = []
@ignore_filter = proc { |request| is_robot? || is_ignored_ip_address? }
@db_failover = false
@db_failover_on_db_error = proc { |error| } # e.g. use Rails logger here
@on_experiment_reset = proc { |experiment| }
@on_experiment_delete = proc { |experiment| }
@on_before_experiment_reset = proc { |experiment| }
@on_before_experiment_delete = proc { |experiment| }
@on_experiment_winner_choose = proc { |experiment| }
@db_failover_allow_parameter_override = false
@allow_multiple_experiments = false
@enabled = true
@experiments = {}
@persistence = Split::Persistence::SessionAdapter
@persistence_cookie_length = 31536000 # One year from now
@persistence_cookie_domain = nil
@algorithm = Split::Algorithms::WeightedSample
@include_rails_helper = true
@beta_probability_simulations = 10000
@winning_alternative_recalculation_interval = 60 * 60 * 24 # 1 day
@redis = ENV.fetch(ENV.fetch("REDIS_PROVIDER", "REDIS_URL"), "redis://localhost:6379")
@dashboard_pagination_default_per_page = 10
end
private
def value_for(hash, key)
if hash.kind_of?(Hash)
hash.has_key?(key.to_s) ? hash[key.to_s] : hash[key.to_sym]
end
end
def escaped_bots
bots.map { |key, _| Regexp.escape(key) }
end
end
end
<MSG> Adding missing separator.
<DFF> @@ -37,7 +37,7 @@ module Split
'Slurp' => 'Yahoo spider',
'Sogou' => 'Chinese search engine',
'spider' => 'generic web spider',
- 'UnwindFetchor' => 'Gnip crawler'
+ 'UnwindFetchor' => 'Gnip crawler',
'WordPress' => 'WordPress spider',
'YandexBot' => 'Yandex spider',
'ZIBB' => 'ZIBB spider',
| 1 | Adding missing separator. | 1 | .rb | rb | mit | splitrb/split |
10072434 | <NME> configuration.rb
<BEF> # frozen_string_literal: true
module Split
class Configuration
attr_accessor :ignore_ip_addresses
attr_accessor :ignore_filter
attr_accessor :db_failover
attr_accessor :db_failover_on_db_error
attr_accessor :db_failover_allow_parameter_override
attr_accessor :allow_multiple_experiments
attr_accessor :enabled
attr_accessor :persistence
attr_accessor :persistence_cookie_length
attr_accessor :persistence_cookie_domain
attr_accessor :algorithm
attr_accessor :store_override
attr_accessor :start_manually
attr_accessor :reset_manually
attr_accessor :on_trial
attr_accessor :on_trial_choose
attr_accessor :on_trial_complete
attr_accessor :on_experiment_reset
attr_accessor :on_experiment_delete
attr_accessor :on_before_experiment_reset
attr_accessor :on_experiment_winner_choose
attr_accessor :on_before_experiment_delete
attr_accessor :include_rails_helper
attr_accessor :beta_probability_simulations
attr_accessor :winning_alternative_recalculation_interval
attr_accessor :redis
attr_accessor :dashboard_pagination_default_per_page
attr_accessor :cache
attr_reader :experiments
attr_writer :bots
'Slurp' => 'Yahoo spider',
'Sogou' => 'Chinese search engine',
'spider' => 'generic web spider',
'UnwindFetchor' => 'Gnip crawler'
'WordPress' => 'WordPress spider',
'YandexBot' => 'Yandex spider',
'ZIBB' => 'ZIBB spider',
"Baiduspider" => "Chinese search engine",
"bingbot" => "Microsoft bing bot",
"Butterfly" => "Topsy Labs",
"Gigabot" => "Gigabot spider",
"Googlebot" => "Google spider",
"MJ12bot" => "Majestic-12 spider",
"msnbot" => "Microsoft bot",
"rogerbot" => "SeoMoz spider",
"PaperLiBot" => "PaperLi is another content curation service",
"Slurp" => "Yahoo spider",
"Sogou" => "Chinese search engine",
"spider" => "generic web spider",
"UnwindFetchor" => "Gnip crawler",
"WordPress" => "WordPress spider",
"YandexAccessibilityBot" => "Yandex accessibility spider",
"YandexBot" => "Yandex spider",
"YandexMobileBot" => "Yandex mobile spider",
"ZIBB" => "ZIBB spider",
# HTTP libraries
"Apache-HttpClient" => "Java http library",
"AppEngine-Google" => "Google App Engine",
"curl" => "curl unix CLI http client",
"ColdFusion" => "ColdFusion http library",
"EventMachine HttpClient" => "Ruby http library",
"Go http package" => "Go http library",
"Go-http-client" => "Go http library",
"Java" => "Generic Java http library",
"libwww-perl" => "Perl client-server library loved by script kids",
"lwp-trivial" => "Another Perl library loved by script kids",
"Python-urllib" => "Python http library",
"PycURL" => "Python http library",
"Test Certificate Info" => "C http library?",
"Typhoeus" => "Ruby http library",
"Wget" => "wget unix CLI http client",
# URL expanders / previewers
"awe.sm" => "Awe.sm URL expander",
"bitlybot" => "bit.ly bot",
"[email protected]" => "Linkfluence bot",
"facebookexternalhit" => "facebook bot",
"Facebot" => "Facebook crawler",
"Feedfetcher-Google" => "Google Feedfetcher",
"https://developers.google.com/+/web/snippet" => "Google+ Snippet Fetcher",
"LinkedInBot" => "LinkedIn bot",
"LongURL" => "URL expander service",
"NING" => "NING - Yet Another Twitter Swarmer",
"Pinterestbot" => "Pinterest Bot",
"redditbot" => "Reddit Bot",
"ShortLinkTranslate" => "Link shortener",
"Slackbot" => "Slackbot link expander",
"TweetmemeBot" => "TweetMeMe Crawler",
"Twitterbot" => "Twitter URL expander",
"UnwindFetch" => "Gnip URL expander",
"vkShare" => "VKontake Sharer",
# Uptime monitoring
"check_http" => "Nagios monitor",
"GoogleStackdriverMonitoring" => "Google Cloud monitor",
"NewRelicPinger" => "NewRelic monitor",
"Panopta" => "Monitoring service",
"Pingdom" => "Pingdom monitoring",
"SiteUptime" => "Site monitoring services",
"UptimeRobot" => "Monitoring service",
# ???
"DigitalPersona Fingerprint Software" => "HP Fingerprint scanner",
"ShowyouBot" => "Showyou iOS app spider",
"ZyBorg" => "Zyborg? Hmmm....",
"ELB-HealthChecker" => "ELB Health Check"
}
end
def experiments=(experiments)
raise InvalidExperimentsFormatError.new("Experiments must be a Hash") unless experiments.respond_to?(:keys)
@experiments = experiments
end
def disabled?
!enabled
end
def experiment_for(name)
if normalized_experiments
# TODO symbols
normalized_experiments[name.to_sym]
end
end
def metrics
return @metrics if defined?(@metrics)
@metrics = {}
if self.experiments
self.experiments.each do |key, value|
metrics = value_for(value, :metric) rescue nil
Array(metrics).each do |metric_name|
if metric_name
@metrics[metric_name.to_sym] ||= []
@metrics[metric_name.to_sym] << Split::Experiment.new(key)
end
end
end
end
@metrics
end
def normalized_experiments
return nil if @experiments.nil?
experiment_config = {}
@experiments.keys.each do |name|
experiment_config[name.to_sym] = {}
end
@experiments.each do |experiment_name, settings|
alternatives = if (alts = value_for(settings, :alternatives))
normalize_alternatives(alts)
end
experiment_data = {
alternatives: alternatives,
goals: value_for(settings, :goals),
metadata: value_for(settings, :metadata),
algorithm: value_for(settings, :algorithm),
resettable: value_for(settings, :resettable)
}
experiment_data.each do |name, value|
experiment_config[experiment_name.to_sym][name] = value if value != nil
end
end
experiment_config
end
def normalize_alternatives(alternatives)
given_probability, num_with_probability = alternatives.inject([0, 0]) do |a, v|
p, n = a
if percent = value_for(v, :percent)
[p + percent, n + 1]
else
a
end
end
num_without_probability = alternatives.length - num_with_probability
unassigned_probability = ((100.0 - given_probability) / num_without_probability / 100.0)
if num_with_probability.nonzero?
alternatives = alternatives.map do |v|
if (name = value_for(v, :name)) && (percent = value_for(v, :percent))
{ name => percent / 100.0 }
elsif name = value_for(v, :name)
{ name => unassigned_probability }
else
{ v => unassigned_probability }
end
end
[alternatives.shift, alternatives]
else
alternatives = alternatives.dup
[alternatives.shift, alternatives]
end
end
def robot_regex
@robot_regex ||= /\b(?:#{escaped_bots.join('|')})\b|\A\W*\z/i
end
def initialize
@ignore_ip_addresses = []
@ignore_filter = proc { |request| is_robot? || is_ignored_ip_address? }
@db_failover = false
@db_failover_on_db_error = proc { |error| } # e.g. use Rails logger here
@on_experiment_reset = proc { |experiment| }
@on_experiment_delete = proc { |experiment| }
@on_before_experiment_reset = proc { |experiment| }
@on_before_experiment_delete = proc { |experiment| }
@on_experiment_winner_choose = proc { |experiment| }
@db_failover_allow_parameter_override = false
@allow_multiple_experiments = false
@enabled = true
@experiments = {}
@persistence = Split::Persistence::SessionAdapter
@persistence_cookie_length = 31536000 # One year from now
@persistence_cookie_domain = nil
@algorithm = Split::Algorithms::WeightedSample
@include_rails_helper = true
@beta_probability_simulations = 10000
@winning_alternative_recalculation_interval = 60 * 60 * 24 # 1 day
@redis = ENV.fetch(ENV.fetch("REDIS_PROVIDER", "REDIS_URL"), "redis://localhost:6379")
@dashboard_pagination_default_per_page = 10
end
private
def value_for(hash, key)
if hash.kind_of?(Hash)
hash.has_key?(key.to_s) ? hash[key.to_s] : hash[key.to_sym]
end
end
def escaped_bots
bots.map { |key, _| Regexp.escape(key) }
end
end
end
<MSG> Adding missing separator.
<DFF> @@ -37,7 +37,7 @@ module Split
'Slurp' => 'Yahoo spider',
'Sogou' => 'Chinese search engine',
'spider' => 'generic web spider',
- 'UnwindFetchor' => 'Gnip crawler'
+ 'UnwindFetchor' => 'Gnip crawler',
'WordPress' => 'WordPress spider',
'YandexBot' => 'Yandex spider',
'ZIBB' => 'ZIBB spider',
| 1 | Adding missing separator. | 1 | .rb | rb | mit | splitrb/split |
10072435 | <NME> tokenizer.ts
<BEF> import { deepStrictEqual } from 'assert';
import tokenize from '../src/tokenizer';
describe('Tokenizer', () => {
it('basic abbreviations', () => {
deepStrictEqual(tokenize('ul>li'), [
{ type: 'Literal', value: 'ul', start: 0, end: 2 },
{ type: 'Operator', operator: 'child', start: 2, end: 3 },
{ type: 'Literal', value: 'li', start: 3, end: 5 }
]);
deepStrictEqual(tokenize('ul[title="foo+bar\'str\'" (attr)=bar]{(some > text)}'), [
{ type: 'Literal', value: 'ul', start: 0, end: 2 },
{ type: 'Bracket', open: true, context: 'attribute', start: 2, end: 3 },
{ type: 'Literal', value: 'title', start: 3, end: 8 },
{ type: 'Operator', operator: 'equal', start: 8, end: 9 },
{ type: 'Quote', single: false, start: 9, end: 10 },
{ type: 'Literal', value: 'foo+bar\'str\'', start: 10, end: 22 },
{ type: 'Quote', single: false, start: 22, end: 23 },
{ type: 'WhiteSpace', start: 23, end: 24 },
{ type: 'Bracket', open: true, context: 'group', start: 24, end: 25 },
{ type: 'Literal', value: 'attr', start: 25, end: 29 },
{ type: 'Bracket', open: false, context: 'group', start: 29, end: 30 },
{ type: 'Operator', operator: 'equal', start: 30, end: 31 },
{ type: 'Literal', value: 'bar', start: 31, end: 34 },
{ type: 'Bracket', open: false, context: 'attribute', start: 34, end: 35 },
{ type: 'Bracket', open: true, context: 'expression', start: 35, end: 36 },
{ type: 'Literal', value: '(some > text)', start: 36, end: 49 },
{ type: 'Bracket', open: false, context: 'expression', start: 49, end: 50 }
]);
deepStrictEqual(tokenize('h${some${1:field placeholder}}'), [
{ type: 'Literal', value: 'h', start: 0, end: 1 },
{ type: 'RepeaterNumber', size: 1, parent: 0, reverse: false, base: 1, start: 1, end: 2 },
{ type: 'Bracket', open: true, context: 'expression', start: 2, end: 3 },
{ type: 'Literal', value: 'some', start: 3, end: 7 },
{ type: 'Field', index: 1, name: 'field placeholder', start: 7, end: 29 },
{ type: 'Bracket', open: false, context: 'expression', start: 29, end: 30 }
]);
deepStrictEqual(tokenize('div{[}+a{}'), [
{ type: 'Literal', value: 'div', start: 0, end: 3 },
{ type: 'Bracket', open: true, context: 'expression', start: 3, end: 4 },
{ type: 'Literal', value: '[', start: 4, end: 5 },
{ type: 'Bracket', open: false, context: 'expression', start: 5, end: 6 },
{ type: 'Operator', operator: 'sibling', start: 6, end: 7 },
{ type: 'Literal', value: 'a', start: 7, end: 8 },
{ type: 'Bracket', open: true, context: 'expression', start: 8, end: 9 },
{ type: 'Bracket', open: false, context: 'expression', start: 9, end: 10 }
]);
});
it('repeater', () => {
deepStrictEqual(tokenize('#sample*3'), [
{ type: 'Operator', operator: 'id', start: 0, end: 1 },
{ type: 'Literal', value: 'sample', start: 1, end: 7 },
{ type: 'Repeater', count: 3, value: 0, implicit: false, start: 7, end: 9 }
]);
deepStrictEqual(tokenize('div[foo*3]'), [
{ type: 'Literal', value: 'div', start: 0, end: 3 },
{ type: 'Bracket', open: true, context: 'attribute', start: 3, end: 4 },
{ type: 'Literal', value: 'foo*3', start: 4, end: 9 },
{ type: 'Bracket', open: false, context: 'attribute', start: 9, end: 10 }
]);
deepStrictEqual(tokenize('({a*2})*3'), [
{ type: 'Bracket', open: true, context: 'group', start: 0, end: 1 },
{ type: 'Bracket', open: true, context: 'expression', start: 1, end: 2 },
{ type: 'Literal', value: 'a*2', start: 2, end: 5 },
{ type: 'Bracket', open: false, context: 'expression', start: 5, end: 6 },
{ type: 'Bracket', open: false, context: 'group', start: 6, end: 7 },
{ type: 'Repeater', count: 3, value: 0, implicit: false, start: 7, end: 9 }
]);
});
});
<MSG> Preserve whitespace characters in text nodes of abbreviation
<DFF> @@ -17,7 +17,7 @@ describe('Tokenizer', () => {
{ type: 'Quote', single: false, start: 9, end: 10 },
{ type: 'Literal', value: 'foo+bar\'str\'', start: 10, end: 22 },
{ type: 'Quote', single: false, start: 22, end: 23 },
- { type: 'WhiteSpace', start: 23, end: 24 },
+ { type: 'WhiteSpace', start: 23, end: 24, value: ' ' },
{ type: 'Bracket', open: true, context: 'group', start: 24, end: 25 },
{ type: 'Literal', value: 'attr', start: 25, end: 29 },
{ type: 'Bracket', open: false, context: 'group', start: 29, end: 30 },
| 1 | Preserve whitespace characters in text nodes of abbreviation | 1 | .ts | ts | mit | emmetio/emmet |
10072436 | <NME> tokenizer.ts
<BEF> import { deepStrictEqual } from 'assert';
import tokenize from '../src/tokenizer';
describe('Tokenizer', () => {
it('basic abbreviations', () => {
deepStrictEqual(tokenize('ul>li'), [
{ type: 'Literal', value: 'ul', start: 0, end: 2 },
{ type: 'Operator', operator: 'child', start: 2, end: 3 },
{ type: 'Literal', value: 'li', start: 3, end: 5 }
]);
deepStrictEqual(tokenize('ul[title="foo+bar\'str\'" (attr)=bar]{(some > text)}'), [
{ type: 'Literal', value: 'ul', start: 0, end: 2 },
{ type: 'Bracket', open: true, context: 'attribute', start: 2, end: 3 },
{ type: 'Literal', value: 'title', start: 3, end: 8 },
{ type: 'Operator', operator: 'equal', start: 8, end: 9 },
{ type: 'Quote', single: false, start: 9, end: 10 },
{ type: 'Literal', value: 'foo+bar\'str\'', start: 10, end: 22 },
{ type: 'Quote', single: false, start: 22, end: 23 },
{ type: 'WhiteSpace', start: 23, end: 24 },
{ type: 'Bracket', open: true, context: 'group', start: 24, end: 25 },
{ type: 'Literal', value: 'attr', start: 25, end: 29 },
{ type: 'Bracket', open: false, context: 'group', start: 29, end: 30 },
{ type: 'Operator', operator: 'equal', start: 30, end: 31 },
{ type: 'Literal', value: 'bar', start: 31, end: 34 },
{ type: 'Bracket', open: false, context: 'attribute', start: 34, end: 35 },
{ type: 'Bracket', open: true, context: 'expression', start: 35, end: 36 },
{ type: 'Literal', value: '(some > text)', start: 36, end: 49 },
{ type: 'Bracket', open: false, context: 'expression', start: 49, end: 50 }
]);
deepStrictEqual(tokenize('h${some${1:field placeholder}}'), [
{ type: 'Literal', value: 'h', start: 0, end: 1 },
{ type: 'RepeaterNumber', size: 1, parent: 0, reverse: false, base: 1, start: 1, end: 2 },
{ type: 'Bracket', open: true, context: 'expression', start: 2, end: 3 },
{ type: 'Literal', value: 'some', start: 3, end: 7 },
{ type: 'Field', index: 1, name: 'field placeholder', start: 7, end: 29 },
{ type: 'Bracket', open: false, context: 'expression', start: 29, end: 30 }
]);
deepStrictEqual(tokenize('div{[}+a{}'), [
{ type: 'Literal', value: 'div', start: 0, end: 3 },
{ type: 'Bracket', open: true, context: 'expression', start: 3, end: 4 },
{ type: 'Literal', value: '[', start: 4, end: 5 },
{ type: 'Bracket', open: false, context: 'expression', start: 5, end: 6 },
{ type: 'Operator', operator: 'sibling', start: 6, end: 7 },
{ type: 'Literal', value: 'a', start: 7, end: 8 },
{ type: 'Bracket', open: true, context: 'expression', start: 8, end: 9 },
{ type: 'Bracket', open: false, context: 'expression', start: 9, end: 10 }
]);
});
it('repeater', () => {
deepStrictEqual(tokenize('#sample*3'), [
{ type: 'Operator', operator: 'id', start: 0, end: 1 },
{ type: 'Literal', value: 'sample', start: 1, end: 7 },
{ type: 'Repeater', count: 3, value: 0, implicit: false, start: 7, end: 9 }
]);
deepStrictEqual(tokenize('div[foo*3]'), [
{ type: 'Literal', value: 'div', start: 0, end: 3 },
{ type: 'Bracket', open: true, context: 'attribute', start: 3, end: 4 },
{ type: 'Literal', value: 'foo*3', start: 4, end: 9 },
{ type: 'Bracket', open: false, context: 'attribute', start: 9, end: 10 }
]);
deepStrictEqual(tokenize('({a*2})*3'), [
{ type: 'Bracket', open: true, context: 'group', start: 0, end: 1 },
{ type: 'Bracket', open: true, context: 'expression', start: 1, end: 2 },
{ type: 'Literal', value: 'a*2', start: 2, end: 5 },
{ type: 'Bracket', open: false, context: 'expression', start: 5, end: 6 },
{ type: 'Bracket', open: false, context: 'group', start: 6, end: 7 },
{ type: 'Repeater', count: 3, value: 0, implicit: false, start: 7, end: 9 }
]);
});
});
<MSG> Preserve whitespace characters in text nodes of abbreviation
<DFF> @@ -17,7 +17,7 @@ describe('Tokenizer', () => {
{ type: 'Quote', single: false, start: 9, end: 10 },
{ type: 'Literal', value: 'foo+bar\'str\'', start: 10, end: 22 },
{ type: 'Quote', single: false, start: 22, end: 23 },
- { type: 'WhiteSpace', start: 23, end: 24 },
+ { type: 'WhiteSpace', start: 23, end: 24, value: ' ' },
{ type: 'Bracket', open: true, context: 'group', start: 24, end: 25 },
{ type: 'Literal', value: 'attr', start: 25, end: 29 },
{ type: 'Bracket', open: false, context: 'group', start: 29, end: 30 },
| 1 | Preserve whitespace characters in text nodes of abbreviation | 1 | .ts | ts | mit | emmetio/emmet |
10072437 | <NME> trial_spec.rb
<BEF> # frozen_string_literal: true
require "spec_helper"
require "split/trial"
describe Split::Trial do
let(:user) { mock_user }
let(:alternatives) { ["basket", "cart"] }
let(:experiment) do
Split::Experiment.new("basket_text", alternatives: alternatives).save
end
it "should be initializeable" do
experiment = double("experiment")
alternative = double("alternative", kind_of?: Split::Alternative)
trial = Split::Trial.new(experiment: experiment, alternative: alternative)
expect(trial.experiment).to eq(experiment)
expect(trial.alternative).to eq(alternative)
end
describe "alternative" do
it "should use the alternative if specified" do
alternative = double("alternative", kind_of?: Split::Alternative)
trial = Split::Trial.new(experiment: double("experiment"),
alternative: alternative, user: user)
expect(trial).not_to receive(:choose)
expect(trial.alternative).to eq(alternative)
end
it "should load the alternative when the alternative name is set" do
experiment = Split::Experiment.new("basket_text", alternatives: ["basket", "cart"])
experiment.save
end
end
describe "#choose!" do
def expect_alternative(trial, alternative_name)
3.times do
let(:context) { double(on_trial_callback: "test callback") }
let(:trial) do
Split::Trial.new(user: user, experiment: experiment)
end
shared_examples_for "a trial with callbacks" do
it "does not run if on_trial callback is not respondable" do
Split.configuration.on_trial = :foo
allow(context).to receive(:respond_to?).with(:foo, true).and_return false
expect(context).to_not receive(:foo)
trial.choose! context
end
it "runs on_trial callback" do
Split.configuration.on_trial = :on_trial_callback
expect(context).to receive(:on_trial_callback)
trial.choose! context
end
it "does not run nil on_trial callback" do
Split.configuration.on_trial = nil
expect(context).not_to receive(:on_trial_callback)
trial.choose! context
end
end
def expect_alternative(trial, alternative_name)
3.times do
trial.choose! context
expect(alternative_name).to include(trial.alternative.name)
end
end
context "when override is present" do
let(:override) { "cart" }
let(:trial) do
Split::Trial.new(user: user, experiment: experiment, override: override)
end
it_behaves_like "a trial with callbacks"
it "picks the override" do
expect(experiment).to_not receive(:next_alternative)
expect_alternative(trial, override)
end
context "when alternative doesn't exist" do
let(:override) { nil }
it "falls back on next_alternative" do
expect(experiment).to receive(:next_alternative).and_call_original
expect_alternative(trial, alternatives)
end
end
end
context "when disabled option is true" do
let(:trial) do
Split::Trial.new(user: user, experiment: experiment, disabled: true)
end
it "picks the control", :aggregate_failures do
Split.configuration.on_trial = :on_trial_callback
expect(experiment).to_not receive(:next_alternative)
expect(context).not_to receive(:on_trial_callback)
expect_alternative(trial, "basket")
Split.configuration.on_trial = nil
end
end
context "when Split is globally disabled" do
it "picks the control and does not run on_trial callbacks", :aggregate_failures do
Split.configuration.enabled = false
Split.configuration.on_trial = :on_trial_callback
expect(experiment).to_not receive(:next_alternative)
expect(context).not_to receive(:on_trial_callback)
expect_alternative(trial, "basket")
Split.configuration.enabled = true
Split.configuration.on_trial = nil
end
end
context "when experiment has winner" do
let(:trial) do
Split::Trial.new(user: user, experiment: experiment)
end
it_behaves_like "a trial with callbacks"
it "picks the winner" do
experiment.winner = "cart"
expect(experiment).to_not receive(:next_alternative)
expect_alternative(trial, "cart")
end
end
context "when exclude is true" do
let(:trial) do
Split::Trial.new(user: user, experiment: experiment, exclude: true)
end
it_behaves_like "a trial with callbacks"
it "picks the control" do
expect(experiment).to_not receive(:next_alternative)
expect_alternative(trial, "basket")
end
end
context "when user is already participating" do
it_behaves_like "a trial with callbacks"
it "picks the same alternative" do
user[experiment.key] = "basket"
expect(experiment).to_not receive(:next_alternative)
expect_alternative(trial, "basket")
end
context "when alternative is not found" do
it "falls back on next_alternative" do
user[experiment.key] = "notfound"
expect(experiment).to receive(:next_alternative).and_call_original
expect_alternative(trial, alternatives)
end
end
end
context "when user is a new participant" do
it "picks a new alternative and runs on_trial_choose callback", :aggregate_failures do
Split.configuration.on_trial_choose = :on_trial_choose_callback
expect(experiment).to receive(:next_alternative).and_call_original
expect(context).to receive(:on_trial_choose_callback)
trial.choose! context
expect(trial.alternative.name).to_not be_empty
Split.configuration.on_trial_choose = nil
end
it "assigns user to an alternative" do
trial.choose! context
expect(alternatives).to include(user[experiment.name])
end
context "when cohorting is disabled" do
before(:each) { allow(experiment).to receive(:cohorting_disabled?).and_return(true) }
it "picks the control and does not run on_trial callbacks" do
Split.configuration.on_trial = :on_trial_callback
expect(experiment).to_not receive(:next_alternative)
expect(context).not_to receive(:on_trial_callback)
expect_alternative(trial, "basket")
Split.configuration.enabled = true
Split.configuration.on_trial = nil
end
it "user is not assigned an alternative" do
trial.choose! context
expect(user[experiment]).to eq(nil)
end
end
end
end
describe "#complete!" do
context "when there are no goals" do
let(:trial) { Split::Trial.new(user: user, experiment: experiment) }
it "should complete the trial" do
trial.choose!
old_completed_count = trial.alternative.completed_count
trial.complete!
expect(trial.alternative.completed_count).to eq(old_completed_count + 1)
end
end
context "when there are many goals" do
let(:goals) { [ "goal1", "goal2" ] }
let(:trial) { Split::Trial.new(user: user, experiment: experiment, goals: goals) }
it "increments the completed count corresponding to the goals" do
trial.choose!
old_completed_counts = goals.map { |goal| [goal, trial.alternative.completed_count(goal)] }.to_h
trial.complete!
goals.each { | goal | expect(trial.alternative.completed_count(goal)).to eq(old_completed_counts[goal] + 1) }
end
end
context "when there is 1 goal of type string" do
let(:goal) { "goal" }
let(:trial) { Split::Trial.new(user: user, experiment: experiment, goals: goal) }
it "increments the completed count corresponding to the goal" do
trial.choose!
old_completed_count = trial.alternative.completed_count(goal)
trial.complete!
expect(trial.alternative.completed_count(goal)).to eq(old_completed_count + 1)
end
end
end
describe "alternative recording" do
before(:each) { Split.configuration.store_override = false }
context "when override is present" do
it "stores when store_override is true" do
trial = Split::Trial.new(user: user, experiment: experiment, override: "basket")
Split.configuration.store_override = true
expect(user).to receive("[]=")
trial.choose!
expect(trial.alternative.participant_count).to eq(1)
end
it "does not store when store_override is false" do
trial = Split::Trial.new(user: user, experiment: experiment, override: "basket")
expect(user).to_not receive("[]=")
trial.choose!
end
end
context "when disabled is present" do
it "stores when store_override is true" do
trial = Split::Trial.new(user: user, experiment: experiment, disabled: true)
Split.configuration.store_override = true
expect(user).to receive("[]=")
trial.choose!
end
it "does not store when store_override is false" do
trial = Split::Trial.new(user: user, experiment: experiment, disabled: true)
expect(user).to_not receive("[]=")
trial.choose!
end
end
context "when exclude is present" do
it "does not store" do
trial = Split::Trial.new(user: user, experiment: experiment, exclude: true)
expect(user).to_not receive("[]=")
trial.choose!
end
end
context "when experiment has winner" do
let(:trial) do
experiment.winner = "cart"
Split::Trial.new(user: user, experiment: experiment)
end
it "does not store" do
expect(user).to_not receive("[]=")
trial.choose!
end
end
end
end
<MSG> Merge pull request #291 from dekz/experiment_metadata
Added metadata to experiment.
<DFF> @@ -33,6 +33,27 @@ describe Split::Trial do
end
end
+ describe "metadata" do
+ let(:alternatives) { ['basket', 'cart'] }
+ let(:metadata) { Hash[alternatives.map { |k| [k, "Metadata for #{k}"] }] }
+ let(:experiment) do
+ Split::Experiment.new('basket_text', :alternatives => alternatives, :metadata => metadata).save
+ end
+
+ it 'has metadata on each trial' do
+ trial = Split::Trial.new(:experiment => experiment, :user => user, :metadata => metadata['cart'],
+ :override => 'cart')
+ expect(trial.metadata).to eq(metadata['cart'])
+ end
+
+ it 'has metadata on each trial from the experiment' do
+ trial = Split::Trial.new(:experiment => experiment, :user => user)
+ trial.choose!
+ expect(trial.metadata).to eq(metadata[trial.alternative.name])
+ expect(trial.metadata).to match /#{trial.alternative.name}/
+ end
+ end
+
describe "#choose!" do
def expect_alternative(trial, alternative_name)
3.times do
| 21 | Merge pull request #291 from dekz/experiment_metadata | 0 | .rb | rb | mit | splitrb/split |
10072438 | <NME> trial_spec.rb
<BEF> # frozen_string_literal: true
require "spec_helper"
require "split/trial"
describe Split::Trial do
let(:user) { mock_user }
let(:alternatives) { ["basket", "cart"] }
let(:experiment) do
Split::Experiment.new("basket_text", alternatives: alternatives).save
end
it "should be initializeable" do
experiment = double("experiment")
alternative = double("alternative", kind_of?: Split::Alternative)
trial = Split::Trial.new(experiment: experiment, alternative: alternative)
expect(trial.experiment).to eq(experiment)
expect(trial.alternative).to eq(alternative)
end
describe "alternative" do
it "should use the alternative if specified" do
alternative = double("alternative", kind_of?: Split::Alternative)
trial = Split::Trial.new(experiment: double("experiment"),
alternative: alternative, user: user)
expect(trial).not_to receive(:choose)
expect(trial.alternative).to eq(alternative)
end
it "should load the alternative when the alternative name is set" do
experiment = Split::Experiment.new("basket_text", alternatives: ["basket", "cart"])
experiment.save
end
end
describe "#choose!" do
def expect_alternative(trial, alternative_name)
3.times do
let(:context) { double(on_trial_callback: "test callback") }
let(:trial) do
Split::Trial.new(user: user, experiment: experiment)
end
shared_examples_for "a trial with callbacks" do
it "does not run if on_trial callback is not respondable" do
Split.configuration.on_trial = :foo
allow(context).to receive(:respond_to?).with(:foo, true).and_return false
expect(context).to_not receive(:foo)
trial.choose! context
end
it "runs on_trial callback" do
Split.configuration.on_trial = :on_trial_callback
expect(context).to receive(:on_trial_callback)
trial.choose! context
end
it "does not run nil on_trial callback" do
Split.configuration.on_trial = nil
expect(context).not_to receive(:on_trial_callback)
trial.choose! context
end
end
def expect_alternative(trial, alternative_name)
3.times do
trial.choose! context
expect(alternative_name).to include(trial.alternative.name)
end
end
context "when override is present" do
let(:override) { "cart" }
let(:trial) do
Split::Trial.new(user: user, experiment: experiment, override: override)
end
it_behaves_like "a trial with callbacks"
it "picks the override" do
expect(experiment).to_not receive(:next_alternative)
expect_alternative(trial, override)
end
context "when alternative doesn't exist" do
let(:override) { nil }
it "falls back on next_alternative" do
expect(experiment).to receive(:next_alternative).and_call_original
expect_alternative(trial, alternatives)
end
end
end
context "when disabled option is true" do
let(:trial) do
Split::Trial.new(user: user, experiment: experiment, disabled: true)
end
it "picks the control", :aggregate_failures do
Split.configuration.on_trial = :on_trial_callback
expect(experiment).to_not receive(:next_alternative)
expect(context).not_to receive(:on_trial_callback)
expect_alternative(trial, "basket")
Split.configuration.on_trial = nil
end
end
context "when Split is globally disabled" do
it "picks the control and does not run on_trial callbacks", :aggregate_failures do
Split.configuration.enabled = false
Split.configuration.on_trial = :on_trial_callback
expect(experiment).to_not receive(:next_alternative)
expect(context).not_to receive(:on_trial_callback)
expect_alternative(trial, "basket")
Split.configuration.enabled = true
Split.configuration.on_trial = nil
end
end
context "when experiment has winner" do
let(:trial) do
Split::Trial.new(user: user, experiment: experiment)
end
it_behaves_like "a trial with callbacks"
it "picks the winner" do
experiment.winner = "cart"
expect(experiment).to_not receive(:next_alternative)
expect_alternative(trial, "cart")
end
end
context "when exclude is true" do
let(:trial) do
Split::Trial.new(user: user, experiment: experiment, exclude: true)
end
it_behaves_like "a trial with callbacks"
it "picks the control" do
expect(experiment).to_not receive(:next_alternative)
expect_alternative(trial, "basket")
end
end
context "when user is already participating" do
it_behaves_like "a trial with callbacks"
it "picks the same alternative" do
user[experiment.key] = "basket"
expect(experiment).to_not receive(:next_alternative)
expect_alternative(trial, "basket")
end
context "when alternative is not found" do
it "falls back on next_alternative" do
user[experiment.key] = "notfound"
expect(experiment).to receive(:next_alternative).and_call_original
expect_alternative(trial, alternatives)
end
end
end
context "when user is a new participant" do
it "picks a new alternative and runs on_trial_choose callback", :aggregate_failures do
Split.configuration.on_trial_choose = :on_trial_choose_callback
expect(experiment).to receive(:next_alternative).and_call_original
expect(context).to receive(:on_trial_choose_callback)
trial.choose! context
expect(trial.alternative.name).to_not be_empty
Split.configuration.on_trial_choose = nil
end
it "assigns user to an alternative" do
trial.choose! context
expect(alternatives).to include(user[experiment.name])
end
context "when cohorting is disabled" do
before(:each) { allow(experiment).to receive(:cohorting_disabled?).and_return(true) }
it "picks the control and does not run on_trial callbacks" do
Split.configuration.on_trial = :on_trial_callback
expect(experiment).to_not receive(:next_alternative)
expect(context).not_to receive(:on_trial_callback)
expect_alternative(trial, "basket")
Split.configuration.enabled = true
Split.configuration.on_trial = nil
end
it "user is not assigned an alternative" do
trial.choose! context
expect(user[experiment]).to eq(nil)
end
end
end
end
describe "#complete!" do
context "when there are no goals" do
let(:trial) { Split::Trial.new(user: user, experiment: experiment) }
it "should complete the trial" do
trial.choose!
old_completed_count = trial.alternative.completed_count
trial.complete!
expect(trial.alternative.completed_count).to eq(old_completed_count + 1)
end
end
context "when there are many goals" do
let(:goals) { [ "goal1", "goal2" ] }
let(:trial) { Split::Trial.new(user: user, experiment: experiment, goals: goals) }
it "increments the completed count corresponding to the goals" do
trial.choose!
old_completed_counts = goals.map { |goal| [goal, trial.alternative.completed_count(goal)] }.to_h
trial.complete!
goals.each { | goal | expect(trial.alternative.completed_count(goal)).to eq(old_completed_counts[goal] + 1) }
end
end
context "when there is 1 goal of type string" do
let(:goal) { "goal" }
let(:trial) { Split::Trial.new(user: user, experiment: experiment, goals: goal) }
it "increments the completed count corresponding to the goal" do
trial.choose!
old_completed_count = trial.alternative.completed_count(goal)
trial.complete!
expect(trial.alternative.completed_count(goal)).to eq(old_completed_count + 1)
end
end
end
describe "alternative recording" do
before(:each) { Split.configuration.store_override = false }
context "when override is present" do
it "stores when store_override is true" do
trial = Split::Trial.new(user: user, experiment: experiment, override: "basket")
Split.configuration.store_override = true
expect(user).to receive("[]=")
trial.choose!
expect(trial.alternative.participant_count).to eq(1)
end
it "does not store when store_override is false" do
trial = Split::Trial.new(user: user, experiment: experiment, override: "basket")
expect(user).to_not receive("[]=")
trial.choose!
end
end
context "when disabled is present" do
it "stores when store_override is true" do
trial = Split::Trial.new(user: user, experiment: experiment, disabled: true)
Split.configuration.store_override = true
expect(user).to receive("[]=")
trial.choose!
end
it "does not store when store_override is false" do
trial = Split::Trial.new(user: user, experiment: experiment, disabled: true)
expect(user).to_not receive("[]=")
trial.choose!
end
end
context "when exclude is present" do
it "does not store" do
trial = Split::Trial.new(user: user, experiment: experiment, exclude: true)
expect(user).to_not receive("[]=")
trial.choose!
end
end
context "when experiment has winner" do
let(:trial) do
experiment.winner = "cart"
Split::Trial.new(user: user, experiment: experiment)
end
it "does not store" do
expect(user).to_not receive("[]=")
trial.choose!
end
end
end
end
<MSG> Merge pull request #291 from dekz/experiment_metadata
Added metadata to experiment.
<DFF> @@ -33,6 +33,27 @@ describe Split::Trial do
end
end
+ describe "metadata" do
+ let(:alternatives) { ['basket', 'cart'] }
+ let(:metadata) { Hash[alternatives.map { |k| [k, "Metadata for #{k}"] }] }
+ let(:experiment) do
+ Split::Experiment.new('basket_text', :alternatives => alternatives, :metadata => metadata).save
+ end
+
+ it 'has metadata on each trial' do
+ trial = Split::Trial.new(:experiment => experiment, :user => user, :metadata => metadata['cart'],
+ :override => 'cart')
+ expect(trial.metadata).to eq(metadata['cart'])
+ end
+
+ it 'has metadata on each trial from the experiment' do
+ trial = Split::Trial.new(:experiment => experiment, :user => user)
+ trial.choose!
+ expect(trial.metadata).to eq(metadata[trial.alternative.name])
+ expect(trial.metadata).to match /#{trial.alternative.name}/
+ end
+ end
+
describe "#choose!" do
def expect_alternative(trial, alternative_name)
3.times do
| 21 | Merge pull request #291 from dekz/experiment_metadata | 0 | .rb | rb | mit | splitrb/split |
10072439 | <NME> trial_spec.rb
<BEF> # frozen_string_literal: true
require "spec_helper"
require "split/trial"
describe Split::Trial do
let(:user) { mock_user }
let(:alternatives) { ["basket", "cart"] }
let(:experiment) do
Split::Experiment.new("basket_text", alternatives: alternatives).save
end
it "should be initializeable" do
experiment = double("experiment")
alternative = double("alternative", kind_of?: Split::Alternative)
trial = Split::Trial.new(experiment: experiment, alternative: alternative)
expect(trial.experiment).to eq(experiment)
expect(trial.alternative).to eq(alternative)
end
describe "alternative" do
it "should use the alternative if specified" do
alternative = double("alternative", kind_of?: Split::Alternative)
trial = Split::Trial.new(experiment: double("experiment"),
alternative: alternative, user: user)
expect(trial).not_to receive(:choose)
expect(trial.alternative).to eq(alternative)
end
it "should load the alternative when the alternative name is set" do
experiment = Split::Experiment.new("basket_text", alternatives: ["basket", "cart"])
experiment.save
end
end
describe "#choose!" do
def expect_alternative(trial, alternative_name)
3.times do
let(:context) { double(on_trial_callback: "test callback") }
let(:trial) do
Split::Trial.new(user: user, experiment: experiment)
end
shared_examples_for "a trial with callbacks" do
it "does not run if on_trial callback is not respondable" do
Split.configuration.on_trial = :foo
allow(context).to receive(:respond_to?).with(:foo, true).and_return false
expect(context).to_not receive(:foo)
trial.choose! context
end
it "runs on_trial callback" do
Split.configuration.on_trial = :on_trial_callback
expect(context).to receive(:on_trial_callback)
trial.choose! context
end
it "does not run nil on_trial callback" do
Split.configuration.on_trial = nil
expect(context).not_to receive(:on_trial_callback)
trial.choose! context
end
end
def expect_alternative(trial, alternative_name)
3.times do
trial.choose! context
expect(alternative_name).to include(trial.alternative.name)
end
end
context "when override is present" do
let(:override) { "cart" }
let(:trial) do
Split::Trial.new(user: user, experiment: experiment, override: override)
end
it_behaves_like "a trial with callbacks"
it "picks the override" do
expect(experiment).to_not receive(:next_alternative)
expect_alternative(trial, override)
end
context "when alternative doesn't exist" do
let(:override) { nil }
it "falls back on next_alternative" do
expect(experiment).to receive(:next_alternative).and_call_original
expect_alternative(trial, alternatives)
end
end
end
context "when disabled option is true" do
let(:trial) do
Split::Trial.new(user: user, experiment: experiment, disabled: true)
end
it "picks the control", :aggregate_failures do
Split.configuration.on_trial = :on_trial_callback
expect(experiment).to_not receive(:next_alternative)
expect(context).not_to receive(:on_trial_callback)
expect_alternative(trial, "basket")
Split.configuration.on_trial = nil
end
end
context "when Split is globally disabled" do
it "picks the control and does not run on_trial callbacks", :aggregate_failures do
Split.configuration.enabled = false
Split.configuration.on_trial = :on_trial_callback
expect(experiment).to_not receive(:next_alternative)
expect(context).not_to receive(:on_trial_callback)
expect_alternative(trial, "basket")
Split.configuration.enabled = true
Split.configuration.on_trial = nil
end
end
context "when experiment has winner" do
let(:trial) do
Split::Trial.new(user: user, experiment: experiment)
end
it_behaves_like "a trial with callbacks"
it "picks the winner" do
experiment.winner = "cart"
expect(experiment).to_not receive(:next_alternative)
expect_alternative(trial, "cart")
end
end
context "when exclude is true" do
let(:trial) do
Split::Trial.new(user: user, experiment: experiment, exclude: true)
end
it_behaves_like "a trial with callbacks"
it "picks the control" do
expect(experiment).to_not receive(:next_alternative)
expect_alternative(trial, "basket")
end
end
context "when user is already participating" do
it_behaves_like "a trial with callbacks"
it "picks the same alternative" do
user[experiment.key] = "basket"
expect(experiment).to_not receive(:next_alternative)
expect_alternative(trial, "basket")
end
context "when alternative is not found" do
it "falls back on next_alternative" do
user[experiment.key] = "notfound"
expect(experiment).to receive(:next_alternative).and_call_original
expect_alternative(trial, alternatives)
end
end
end
context "when user is a new participant" do
it "picks a new alternative and runs on_trial_choose callback", :aggregate_failures do
Split.configuration.on_trial_choose = :on_trial_choose_callback
expect(experiment).to receive(:next_alternative).and_call_original
expect(context).to receive(:on_trial_choose_callback)
trial.choose! context
expect(trial.alternative.name).to_not be_empty
Split.configuration.on_trial_choose = nil
end
it "assigns user to an alternative" do
trial.choose! context
expect(alternatives).to include(user[experiment.name])
end
context "when cohorting is disabled" do
before(:each) { allow(experiment).to receive(:cohorting_disabled?).and_return(true) }
it "picks the control and does not run on_trial callbacks" do
Split.configuration.on_trial = :on_trial_callback
expect(experiment).to_not receive(:next_alternative)
expect(context).not_to receive(:on_trial_callback)
expect_alternative(trial, "basket")
Split.configuration.enabled = true
Split.configuration.on_trial = nil
end
it "user is not assigned an alternative" do
trial.choose! context
expect(user[experiment]).to eq(nil)
end
end
end
end
describe "#complete!" do
context "when there are no goals" do
let(:trial) { Split::Trial.new(user: user, experiment: experiment) }
it "should complete the trial" do
trial.choose!
old_completed_count = trial.alternative.completed_count
trial.complete!
expect(trial.alternative.completed_count).to eq(old_completed_count + 1)
end
end
context "when there are many goals" do
let(:goals) { [ "goal1", "goal2" ] }
let(:trial) { Split::Trial.new(user: user, experiment: experiment, goals: goals) }
it "increments the completed count corresponding to the goals" do
trial.choose!
old_completed_counts = goals.map { |goal| [goal, trial.alternative.completed_count(goal)] }.to_h
trial.complete!
goals.each { | goal | expect(trial.alternative.completed_count(goal)).to eq(old_completed_counts[goal] + 1) }
end
end
context "when there is 1 goal of type string" do
let(:goal) { "goal" }
let(:trial) { Split::Trial.new(user: user, experiment: experiment, goals: goal) }
it "increments the completed count corresponding to the goal" do
trial.choose!
old_completed_count = trial.alternative.completed_count(goal)
trial.complete!
expect(trial.alternative.completed_count(goal)).to eq(old_completed_count + 1)
end
end
end
describe "alternative recording" do
before(:each) { Split.configuration.store_override = false }
context "when override is present" do
it "stores when store_override is true" do
trial = Split::Trial.new(user: user, experiment: experiment, override: "basket")
Split.configuration.store_override = true
expect(user).to receive("[]=")
trial.choose!
expect(trial.alternative.participant_count).to eq(1)
end
it "does not store when store_override is false" do
trial = Split::Trial.new(user: user, experiment: experiment, override: "basket")
expect(user).to_not receive("[]=")
trial.choose!
end
end
context "when disabled is present" do
it "stores when store_override is true" do
trial = Split::Trial.new(user: user, experiment: experiment, disabled: true)
Split.configuration.store_override = true
expect(user).to receive("[]=")
trial.choose!
end
it "does not store when store_override is false" do
trial = Split::Trial.new(user: user, experiment: experiment, disabled: true)
expect(user).to_not receive("[]=")
trial.choose!
end
end
context "when exclude is present" do
it "does not store" do
trial = Split::Trial.new(user: user, experiment: experiment, exclude: true)
expect(user).to_not receive("[]=")
trial.choose!
end
end
context "when experiment has winner" do
let(:trial) do
experiment.winner = "cart"
Split::Trial.new(user: user, experiment: experiment)
end
it "does not store" do
expect(user).to_not receive("[]=")
trial.choose!
end
end
end
end
<MSG> Merge pull request #291 from dekz/experiment_metadata
Added metadata to experiment.
<DFF> @@ -33,6 +33,27 @@ describe Split::Trial do
end
end
+ describe "metadata" do
+ let(:alternatives) { ['basket', 'cart'] }
+ let(:metadata) { Hash[alternatives.map { |k| [k, "Metadata for #{k}"] }] }
+ let(:experiment) do
+ Split::Experiment.new('basket_text', :alternatives => alternatives, :metadata => metadata).save
+ end
+
+ it 'has metadata on each trial' do
+ trial = Split::Trial.new(:experiment => experiment, :user => user, :metadata => metadata['cart'],
+ :override => 'cart')
+ expect(trial.metadata).to eq(metadata['cart'])
+ end
+
+ it 'has metadata on each trial from the experiment' do
+ trial = Split::Trial.new(:experiment => experiment, :user => user)
+ trial.choose!
+ expect(trial.metadata).to eq(metadata[trial.alternative.name])
+ expect(trial.metadata).to match /#{trial.alternative.name}/
+ end
+ end
+
describe "#choose!" do
def expect_alternative(trial, alternative_name)
3.times do
| 21 | Merge pull request #291 from dekz/experiment_metadata | 0 | .rb | rb | mit | splitrb/split |
10072440 | <NME> version.rb
<BEF> # frozen_string_literal: true
module Split
MAJOR = 3
MINOR = 3
PATCH = 2
VERSION = [MAJOR, MINOR, PATCH].join('.')
end
<MSG> Prep for v3.4.0 release
<DFF> @@ -1,7 +1,7 @@
# frozen_string_literal: true
module Split
MAJOR = 3
- MINOR = 3
- PATCH = 2
+ MINOR = 4
+ PATCH = 0
VERSION = [MAJOR, MINOR, PATCH].join('.')
end
| 2 | Prep for v3.4.0 release | 2 | .rb | rb | mit | splitrb/split |
10072441 | <NME> version.rb
<BEF> # frozen_string_literal: true
module Split
MAJOR = 3
MINOR = 3
PATCH = 2
VERSION = [MAJOR, MINOR, PATCH].join('.')
end
<MSG> Prep for v3.4.0 release
<DFF> @@ -1,7 +1,7 @@
# frozen_string_literal: true
module Split
MAJOR = 3
- MINOR = 3
- PATCH = 2
+ MINOR = 4
+ PATCH = 0
VERSION = [MAJOR, MINOR, PATCH].join('.')
end
| 2 | Prep for v3.4.0 release | 2 | .rb | rb | mit | splitrb/split |
10072442 | <NME> version.rb
<BEF> # frozen_string_literal: true
module Split
MAJOR = 3
MINOR = 3
PATCH = 2
VERSION = [MAJOR, MINOR, PATCH].join('.')
end
<MSG> Prep for v3.4.0 release
<DFF> @@ -1,7 +1,7 @@
# frozen_string_literal: true
module Split
MAJOR = 3
- MINOR = 3
- PATCH = 2
+ MINOR = 4
+ PATCH = 0
VERSION = [MAJOR, MINOR, PATCH].join('.')
end
| 2 | Prep for v3.4.0 release | 2 | .rb | rb | mit | splitrb/split |
10072443 | <NME> experiment_spec.rb
<BEF> # frozen_string_literal: true
require "spec_helper"
require "time"
describe Split::Experiment do
def new_experiment(goals = [])
Split::Experiment.new("link_color", alternatives: ["blue", "red", "green"], goals: goals)
end
def alternative(color)
Split::Alternative.new(color, "link_color")
end
let(:experiment) { new_experiment }
let(:blue) { alternative("blue") }
let(:green) { alternative("green") }
context "with an experiment" do
let(:experiment) { Split::Experiment.new("basket_text", alternatives: ["Basket", "Cart"]) }
it "should have a name" do
expect(experiment.name).to eq("basket_text")
end
it "should have alternatives" do
expect(experiment.alternatives.length).to be 2
end
it "should have alternatives with correct names" do
expect(experiment.alternatives.collect { |a| a.name }).to eq(["Basket", "Cart"])
end
it "should be resettable by default" do
expect(experiment.resettable).to be_truthy
end
it "should save to redis" do
experiment.save
expect(Split.redis.exists?("basket_text")).to be true
end
it "should save the start time to redis" do
experiment_start_time = Time.at(1372167761)
expect(Time).to receive(:now).and_return(experiment_start_time)
experiment.save
expect(Split::ExperimentCatalog.find("basket_text").start_time).to eq(experiment_start_time)
end
it "should not save the start time to redis when start_manually is enabled" do
expect(Split.configuration).to receive(:start_manually).and_return(true)
experiment.save
expect(Split::ExperimentCatalog.find("basket_text").start_time).to be_nil
end
it "should save the selected algorithm to redis" do
experiment_algorithm = Split::Algorithms::Whiplash
experiment.algorithm = experiment_algorithm
experiment.save
expect(Split::ExperimentCatalog.find("basket_text").algorithm).to eq(experiment_algorithm)
end
it "should handle having a start time stored as a string" do
experiment_start_time = Time.parse("Sat Mar 03 14:01:03")
expect(Time).to receive(:now).twice.and_return(experiment_start_time)
experiment.save
Split.redis.hset(:experiment_start_times, experiment.name, experiment_start_time.to_s)
expect(Split::ExperimentCatalog.find("basket_text").start_time).to eq(experiment_start_time)
end
it "should handle not having a start time" do
experiment_start_time = Time.parse("Sat Mar 03 14:01:03")
expect(Time).to receive(:now).and_return(experiment_start_time)
experiment.save
Split.redis.hdel(:experiment_start_times, experiment.name)
expect(Split::ExperimentCatalog.find("basket_text").start_time).to be_nil
end
it "should not create duplicates when saving multiple times" do
experiment.save
experiment.save
expect(Split.redis.exists?("basket_text")).to be true
expect(Split.redis.lrange("basket_text", 0, -1)).to eq(['{"Basket":1}', '{"Cart":1}'])
end
describe "new record?" do
it "should know if it hasn't been saved yet" do
expect(experiment.new_record?).to be_truthy
end
it "should know if it has been saved yet" do
experiment.save
expect(experiment.new_record?).to be_falsey
end
end
describe "control" do
it "should be the first alternative" do
experiment.save
expect(experiment.control.name).to eq("Basket")
end
end
end
describe "initialization" do
it "should set the algorithm when passed as an option to the initializer" do
experiment = Split::Experiment.new("basket_text", alternatives: ["Basket", "Cart"], algorithm: Split::Algorithms::Whiplash)
expect(experiment.algorithm).to eq(Split::Algorithms::Whiplash)
end
it "should be possible to make an experiment not resettable" do
experiment = Split::Experiment.new("basket_text", alternatives: ["Basket", "Cart"], resettable: false)
expect(experiment.resettable).to be_falsey
end
context "from configuration" do
let(:experiment_name) { :my_experiment }
let(:experiments) do
{
experiment_name => {
alternatives: ["Control Opt", "Alt one"]
}
}
end
before { Split.configuration.experiments = experiments }
it "assigns default values to the experiment" do
expect(Split::Experiment.new(experiment_name).resettable).to eq(true)
end
end
end
describe "persistent configuration" do
it "should persist resettable in redis" do
experiment = Split::Experiment.new("basket_text", alternatives: ["Basket", "Cart"], resettable: false)
experiment.save
e = Split::ExperimentCatalog.find("basket_text")
expect(e).to eq(experiment)
expect(e.resettable).to be_falsey
end
describe "#metadata" do
let(:experiment) { Split::Experiment.new("basket_text", alternatives: ["Basket", "Cart"], algorithm: Split::Algorithms::Whiplash, metadata: meta) }
let(:meta) { { a: "b" } }
before do
experiment.save
end
it "should delete the key when metadata is removed" do
experiment.metadata = nil
experiment.save
expect(Split.redis.exists?(experiment.metadata_key)).to be_falsey
end
context "simple hash" do
let(:meta) { { "basket" => "a", "cart" => "b" } }
it "should persist metadata in redis" do
e = Split::ExperimentCatalog.find("basket_text")
expect(e).to eq(experiment)
expect(e.metadata).to eq(meta)
end
end
context "nested hash" do
let(:meta) { { "basket" => { "one" => "two" }, "cart" => "b" } }
it "should persist metadata in redis" do
e = Split::ExperimentCatalog.find("basket_text")
expect(e).to eq(experiment)
expect(e.metadata).to eq(meta)
end
end
end
it "should persist algorithm in redis" do
experiment = Split::Experiment.new("basket_text", alternatives: ["Basket", "Cart"], algorithm: Split::Algorithms::Whiplash)
experiment.save
e = Split::ExperimentCatalog.find("basket_text")
expect(e).to eq(experiment)
expect(e.algorithm).to eq(Split::Algorithms::Whiplash)
end
it "should persist a new experiment in redis, that does not exist in the configuration file" do
experiment = Split::Experiment.new("foobar", alternatives: ["tra", "la"], algorithm: Split::Algorithms::Whiplash)
experiment.save
e = Split::ExperimentCatalog.find("foobar")
expect(e).to eq(experiment)
end
end
describe 'reset' do
before { experiment.save }
it 'should reset all alternatives' do
experiment.delete
end
it "should call the on_before_experiment_delete hook" do
expect(Split.configuration.on_before_experiment_delete).to receive(:call)
experiment.delete
end
it "should reset the start time if the experiment should be manually started" do
Split.configuration.start_manually = true
experiment.start
experiment.delete
expect(experiment.start_time).to be_nil
end
it "should default cohorting back to false" do
experiment.disable_cohorting
expect(experiment.cohorting_disabled?).to eq(true)
experiment.delete
expect(experiment.cohorting_disabled?).to eq(false)
end
end
describe "winner" do
it "should have no winner initially" do
expect(experiment.winner).to be_nil
end
end
describe "winner=" do
it "should allow you to specify a winner" do
experiment.save
experiment.winner = "red"
expect(experiment.winner.name).to eq("red")
end
it "should call the on_experiment_winner_choose hook" do
expect(Split.configuration.on_experiment_winner_choose).to receive(:call)
experiment.winner = "green"
end
context "when has_winner state is memoized" do
before { expect(experiment).to_not have_winner }
it "should keep has_winner state consistent" do
experiment.winner = "red"
expect(experiment).to have_winner
end
end
end
describe "reset_winner" do
before { experiment.winner = "green" }
it "should reset the winner" do
experiment.reset_winner
expect(experiment.winner).to be_nil
end
context "when has_winner state is memoized" do
before { expect(experiment).to have_winner }
it "should keep has_winner state consistent" do
experiment.reset_winner
expect(experiment).to_not have_winner
end
end
end
describe "has_winner?" do
context "with winner" do
before { experiment.winner = "red" }
it "returns true" do
expect(experiment).to have_winner
end
end
context "without winner" do
it "returns false" do
expect(experiment).to_not have_winner
end
end
it "memoizes has_winner state" do
expect(experiment).to receive(:winner).once
expect(experiment).to_not have_winner
expect(experiment).to_not have_winner
end
end
describe "reset" do
let(:reset_manually) { false }
before do
allow(Split.configuration).to receive(:reset_manually).and_return(reset_manually)
experiment.save
green.increment_participation
green.increment_participation
end
it "should reset all alternatives" do
experiment.winner = "green"
expect(experiment.next_alternative.name).to eq("green")
green.increment_participation
experiment.reset
expect(green.participant_count).to eq(0)
expect(green.completed_count).to eq(0)
end
it "should reset the winner" do
experiment.winner = "green"
expect(experiment.next_alternative.name).to eq("green")
green.increment_participation
experiment.reset
expect(experiment.winner).to be_nil
end
it "should increment the version" do
expect(experiment.version).to eq(0)
experiment.reset
expect(experiment.version).to eq(1)
end
it "should call the on_experiment_reset hook" do
expect(Split.configuration.on_experiment_reset).to receive(:call)
experiment.reset
end
it "should call the on_before_experiment_reset hook" do
expect(Split.configuration.on_before_experiment_reset).to receive(:call)
experiment.reset
end
end
describe "algorithm" do
let(:experiment) { Split::ExperimentCatalog.find_or_create("link_color", "blue", "red", "green") }
it "should use the default algorithm if none is specified" do
expect(experiment.algorithm).to eq(Split.configuration.algorithm)
end
it "should use the user specified algorithm for this experiment if specified" do
experiment.algorithm = Split::Algorithms::Whiplash
expect(experiment.algorithm).to eq(Split::Algorithms::Whiplash)
end
end
describe "#next_alternative" do
context "with multiple alternatives" do
let(:experiment) { Split::ExperimentCatalog.find_or_create("link_color", "blue", "red", "green") }
context "with winner" do
it "should always return the winner" do
green = Split::Alternative.new("green", "link_color")
experiment.winner = "green"
expect(experiment.next_alternative.name).to eq("green")
green.increment_participation
expect(experiment.next_alternative.name).to eq("green")
end
end
context "without winner" do
it "should use the specified algorithm" do
experiment.algorithm = Split::Algorithms::Whiplash
expect(experiment.algorithm).to receive(:choose_alternative).and_return(Split::Alternative.new("green", "link_color"))
expect(experiment.next_alternative.name).to eq("green")
end
end
end
context "with single alternative" do
let(:experiment) { Split::ExperimentCatalog.find_or_create("link_color", "blue") }
it "should always return the only alternative" do
expect(experiment.next_alternative.name).to eq("blue")
expect(experiment.next_alternative.name).to eq("blue")
end
end
end
describe "#cohorting_disabled?" do
it "returns false when nothing has been configured" do
expect(experiment.cohorting_disabled?).to eq false
end
it "returns true when enable_cohorting is performed" do
experiment.enable_cohorting
expect(experiment.cohorting_disabled?).to eq false
end
it "returns false when nothing has been configured" do
experiment.disable_cohorting
expect(experiment.cohorting_disabled?).to eq true
end
end
describe "changing an existing experiment" do
def same_but_different_alternative
Split::ExperimentCatalog.find_or_create("link_color", "blue", "yellow", "orange")
end
it "should reset an experiment if it is loaded with different alternatives" do
experiment.save
blue.participant_count = 5
same_experiment = same_but_different_alternative
expect(same_experiment.alternatives.map(&:name)).to eq(["blue", "yellow", "orange"])
expect(blue.participant_count).to eq(0)
end
it "should only reset once" do
experiment.save
expect(experiment.version).to eq(0)
same_experiment = same_but_different_alternative
expect(same_experiment.version).to eq(1)
same_experiment_again = same_but_different_alternative
expect(same_experiment_again.version).to eq(1)
end
context "when metadata is changed" do
it "should increase version" do
experiment.save
experiment.metadata = { "foo" => "bar" }
expect { experiment.save }.to change { experiment.version }.by(1)
end
it "does not increase version" do
experiment.metadata = nil
experiment.save
expect { experiment.save }.to change { experiment.version }.by(0)
end
end
context "when experiment configuration is changed" do
let(:reset_manually) { false }
before do
experiment.save
allow(Split.configuration).to receive(:reset_manually).and_return(reset_manually)
green.increment_participation
green.increment_participation
experiment.set_alternatives_and_options(alternatives: %w(blue red green zip),
goals: %w(purchase))
experiment.save
end
it "resets all alternatives" do
expect(green.participant_count).to eq(0)
expect(green.completed_count).to eq(0)
end
context "when reset_manually is set" do
let(:reset_manually) { true }
it "does not reset alternatives" do
expect(green.participant_count).to eq(2)
expect(green.completed_count).to eq(0)
end
end
end
end
describe "alternatives passed as non-strings" do
it "should throw an exception if an alternative is passed that is not a string" do
expect { Split::ExperimentCatalog.find_or_create("link_color", :blue, :red) }.to raise_error(ArgumentError)
expect { Split::ExperimentCatalog.find_or_create("link_enabled", true, false) }.to raise_error(ArgumentError)
end
end
describe "specifying weights" do
let(:experiment_with_weight) {
Split::ExperimentCatalog.find_or_create("link_color", { "blue" => 1 }, { "red" => 2 })
}
it "should work for a new experiment" do
expect(experiment_with_weight.alternatives.map(&:weight)).to eq([1, 2])
end
it "should work for an existing experiment" do
experiment.save
expect(experiment_with_weight.alternatives.map(&:weight)).to eq([1, 2])
end
end
describe "specifying goals" do
let(:experiment) {
new_experiment(["purchase"])
}
context "saving experiment" do
let(:same_but_different_goals) { Split::ExperimentCatalog.find_or_create({ "link_color" => ["purchase", "refund"] }, "blue", "red", "green") }
before { experiment.save }
it "can find existing experiment" do
expect(Split::ExperimentCatalog.find("link_color").name).to eq("link_color")
end
it "should reset an experiment if it is loaded with different goals" do
same_but_different_goals
expect(Split::ExperimentCatalog.find("link_color").goals).to eq(["purchase", "refund"])
end
end
it "should have goals" do
expect(experiment.goals).to eq(["purchase"])
end
context "find or create experiment" do
it "should have correct goals" do
experiment = Split::ExperimentCatalog.find_or_create({ "link_color3" => ["purchase", "refund"] }, "blue", "red", "green")
expect(experiment.goals).to eq(["purchase", "refund"])
experiment = Split::ExperimentCatalog.find_or_create("link_color3", "blue", "red", "green")
expect(experiment.goals).to eq([])
end
end
end
describe "beta probability calculation" do
it "should return a hash with the probability of each alternative being the best" do
experiment = Split::ExperimentCatalog.find_or_create("mathematicians", "bernoulli", "poisson", "lagrange")
experiment.calc_winning_alternatives
expect(experiment.alternative_probabilities).not_to be_nil
end
it "should return between 46% and 54% probability for an experiment with 2 alternatives and no data" do
experiment = Split::ExperimentCatalog.find_or_create("scientists", "einstein", "bohr")
experiment.calc_winning_alternatives
expect(experiment.alternatives[0].p_winner).to be_within(0.04).of(0.50)
end
it "should calculate the probability of being the winning alternative separately for each goal", skip: true do
experiment = Split::ExperimentCatalog.find_or_create({ "link_color3" => ["purchase", "refund"] }, "blue", "red", "green")
goal1 = experiment.goals[0]
goal2 = experiment.goals[1]
experiment.alternatives.each do |alternative|
alternative.participant_count = 50
alternative.set_completed_count(10, goal1)
alternative.set_completed_count(15+rand(30), goal2)
end
experiment.calc_winning_alternatives
alt = experiment.alternatives[0]
p_goal1 = alt.p_winner(goal1)
p_goal2 = alt.p_winner(goal2)
expect(p_goal1).not_to be_within(0.04).of(p_goal2)
end
it "should return nil and not re-calculate probabilities if they have already been calculated today" do
experiment = Split::ExperimentCatalog.find_or_create({ "link_color3" => ["purchase", "refund"] }, "blue", "red", "green")
expect(experiment.calc_winning_alternatives).not_to be nil
expect(experiment.calc_winning_alternatives).to be nil
end
end
end
<MSG> Add instance method has_winner? to Experiment
<DFF> @@ -201,6 +201,22 @@ describe Split::Experiment do
end
end
+ describe 'has_winner?' do
+ context 'with winner' do
+ before { experiment.winner = 'red' }
+
+ it 'returns true' do
+ expect(experiment).to have_winner
+ end
+ end
+
+ context 'without winner' do
+ it 'returns false' do
+ expect(experiment).to_not have_winner
+ end
+ end
+ end
+
describe 'reset' do
before { experiment.save }
it 'should reset all alternatives' do
| 16 | Add instance method has_winner? to Experiment | 0 | .rb | rb | mit | splitrb/split |
10072444 | <NME> experiment_spec.rb
<BEF> # frozen_string_literal: true
require "spec_helper"
require "time"
describe Split::Experiment do
def new_experiment(goals = [])
Split::Experiment.new("link_color", alternatives: ["blue", "red", "green"], goals: goals)
end
def alternative(color)
Split::Alternative.new(color, "link_color")
end
let(:experiment) { new_experiment }
let(:blue) { alternative("blue") }
let(:green) { alternative("green") }
context "with an experiment" do
let(:experiment) { Split::Experiment.new("basket_text", alternatives: ["Basket", "Cart"]) }
it "should have a name" do
expect(experiment.name).to eq("basket_text")
end
it "should have alternatives" do
expect(experiment.alternatives.length).to be 2
end
it "should have alternatives with correct names" do
expect(experiment.alternatives.collect { |a| a.name }).to eq(["Basket", "Cart"])
end
it "should be resettable by default" do
expect(experiment.resettable).to be_truthy
end
it "should save to redis" do
experiment.save
expect(Split.redis.exists?("basket_text")).to be true
end
it "should save the start time to redis" do
experiment_start_time = Time.at(1372167761)
expect(Time).to receive(:now).and_return(experiment_start_time)
experiment.save
expect(Split::ExperimentCatalog.find("basket_text").start_time).to eq(experiment_start_time)
end
it "should not save the start time to redis when start_manually is enabled" do
expect(Split.configuration).to receive(:start_manually).and_return(true)
experiment.save
expect(Split::ExperimentCatalog.find("basket_text").start_time).to be_nil
end
it "should save the selected algorithm to redis" do
experiment_algorithm = Split::Algorithms::Whiplash
experiment.algorithm = experiment_algorithm
experiment.save
expect(Split::ExperimentCatalog.find("basket_text").algorithm).to eq(experiment_algorithm)
end
it "should handle having a start time stored as a string" do
experiment_start_time = Time.parse("Sat Mar 03 14:01:03")
expect(Time).to receive(:now).twice.and_return(experiment_start_time)
experiment.save
Split.redis.hset(:experiment_start_times, experiment.name, experiment_start_time.to_s)
expect(Split::ExperimentCatalog.find("basket_text").start_time).to eq(experiment_start_time)
end
it "should handle not having a start time" do
experiment_start_time = Time.parse("Sat Mar 03 14:01:03")
expect(Time).to receive(:now).and_return(experiment_start_time)
experiment.save
Split.redis.hdel(:experiment_start_times, experiment.name)
expect(Split::ExperimentCatalog.find("basket_text").start_time).to be_nil
end
it "should not create duplicates when saving multiple times" do
experiment.save
experiment.save
expect(Split.redis.exists?("basket_text")).to be true
expect(Split.redis.lrange("basket_text", 0, -1)).to eq(['{"Basket":1}', '{"Cart":1}'])
end
describe "new record?" do
it "should know if it hasn't been saved yet" do
expect(experiment.new_record?).to be_truthy
end
it "should know if it has been saved yet" do
experiment.save
expect(experiment.new_record?).to be_falsey
end
end
describe "control" do
it "should be the first alternative" do
experiment.save
expect(experiment.control.name).to eq("Basket")
end
end
end
describe "initialization" do
it "should set the algorithm when passed as an option to the initializer" do
experiment = Split::Experiment.new("basket_text", alternatives: ["Basket", "Cart"], algorithm: Split::Algorithms::Whiplash)
expect(experiment.algorithm).to eq(Split::Algorithms::Whiplash)
end
it "should be possible to make an experiment not resettable" do
experiment = Split::Experiment.new("basket_text", alternatives: ["Basket", "Cart"], resettable: false)
expect(experiment.resettable).to be_falsey
end
context "from configuration" do
let(:experiment_name) { :my_experiment }
let(:experiments) do
{
experiment_name => {
alternatives: ["Control Opt", "Alt one"]
}
}
end
before { Split.configuration.experiments = experiments }
it "assigns default values to the experiment" do
expect(Split::Experiment.new(experiment_name).resettable).to eq(true)
end
end
end
describe "persistent configuration" do
it "should persist resettable in redis" do
experiment = Split::Experiment.new("basket_text", alternatives: ["Basket", "Cart"], resettable: false)
experiment.save
e = Split::ExperimentCatalog.find("basket_text")
expect(e).to eq(experiment)
expect(e.resettable).to be_falsey
end
describe "#metadata" do
let(:experiment) { Split::Experiment.new("basket_text", alternatives: ["Basket", "Cart"], algorithm: Split::Algorithms::Whiplash, metadata: meta) }
let(:meta) { { a: "b" } }
before do
experiment.save
end
it "should delete the key when metadata is removed" do
experiment.metadata = nil
experiment.save
expect(Split.redis.exists?(experiment.metadata_key)).to be_falsey
end
context "simple hash" do
let(:meta) { { "basket" => "a", "cart" => "b" } }
it "should persist metadata in redis" do
e = Split::ExperimentCatalog.find("basket_text")
expect(e).to eq(experiment)
expect(e.metadata).to eq(meta)
end
end
context "nested hash" do
let(:meta) { { "basket" => { "one" => "two" }, "cart" => "b" } }
it "should persist metadata in redis" do
e = Split::ExperimentCatalog.find("basket_text")
expect(e).to eq(experiment)
expect(e.metadata).to eq(meta)
end
end
end
it "should persist algorithm in redis" do
experiment = Split::Experiment.new("basket_text", alternatives: ["Basket", "Cart"], algorithm: Split::Algorithms::Whiplash)
experiment.save
e = Split::ExperimentCatalog.find("basket_text")
expect(e).to eq(experiment)
expect(e.algorithm).to eq(Split::Algorithms::Whiplash)
end
it "should persist a new experiment in redis, that does not exist in the configuration file" do
experiment = Split::Experiment.new("foobar", alternatives: ["tra", "la"], algorithm: Split::Algorithms::Whiplash)
experiment.save
e = Split::ExperimentCatalog.find("foobar")
expect(e).to eq(experiment)
end
end
describe 'reset' do
before { experiment.save }
it 'should reset all alternatives' do
experiment.delete
end
it "should call the on_before_experiment_delete hook" do
expect(Split.configuration.on_before_experiment_delete).to receive(:call)
experiment.delete
end
it "should reset the start time if the experiment should be manually started" do
Split.configuration.start_manually = true
experiment.start
experiment.delete
expect(experiment.start_time).to be_nil
end
it "should default cohorting back to false" do
experiment.disable_cohorting
expect(experiment.cohorting_disabled?).to eq(true)
experiment.delete
expect(experiment.cohorting_disabled?).to eq(false)
end
end
describe "winner" do
it "should have no winner initially" do
expect(experiment.winner).to be_nil
end
end
describe "winner=" do
it "should allow you to specify a winner" do
experiment.save
experiment.winner = "red"
expect(experiment.winner.name).to eq("red")
end
it "should call the on_experiment_winner_choose hook" do
expect(Split.configuration.on_experiment_winner_choose).to receive(:call)
experiment.winner = "green"
end
context "when has_winner state is memoized" do
before { expect(experiment).to_not have_winner }
it "should keep has_winner state consistent" do
experiment.winner = "red"
expect(experiment).to have_winner
end
end
end
describe "reset_winner" do
before { experiment.winner = "green" }
it "should reset the winner" do
experiment.reset_winner
expect(experiment.winner).to be_nil
end
context "when has_winner state is memoized" do
before { expect(experiment).to have_winner }
it "should keep has_winner state consistent" do
experiment.reset_winner
expect(experiment).to_not have_winner
end
end
end
describe "has_winner?" do
context "with winner" do
before { experiment.winner = "red" }
it "returns true" do
expect(experiment).to have_winner
end
end
context "without winner" do
it "returns false" do
expect(experiment).to_not have_winner
end
end
it "memoizes has_winner state" do
expect(experiment).to receive(:winner).once
expect(experiment).to_not have_winner
expect(experiment).to_not have_winner
end
end
describe "reset" do
let(:reset_manually) { false }
before do
allow(Split.configuration).to receive(:reset_manually).and_return(reset_manually)
experiment.save
green.increment_participation
green.increment_participation
end
it "should reset all alternatives" do
experiment.winner = "green"
expect(experiment.next_alternative.name).to eq("green")
green.increment_participation
experiment.reset
expect(green.participant_count).to eq(0)
expect(green.completed_count).to eq(0)
end
it "should reset the winner" do
experiment.winner = "green"
expect(experiment.next_alternative.name).to eq("green")
green.increment_participation
experiment.reset
expect(experiment.winner).to be_nil
end
it "should increment the version" do
expect(experiment.version).to eq(0)
experiment.reset
expect(experiment.version).to eq(1)
end
it "should call the on_experiment_reset hook" do
expect(Split.configuration.on_experiment_reset).to receive(:call)
experiment.reset
end
it "should call the on_before_experiment_reset hook" do
expect(Split.configuration.on_before_experiment_reset).to receive(:call)
experiment.reset
end
end
describe "algorithm" do
let(:experiment) { Split::ExperimentCatalog.find_or_create("link_color", "blue", "red", "green") }
it "should use the default algorithm if none is specified" do
expect(experiment.algorithm).to eq(Split.configuration.algorithm)
end
it "should use the user specified algorithm for this experiment if specified" do
experiment.algorithm = Split::Algorithms::Whiplash
expect(experiment.algorithm).to eq(Split::Algorithms::Whiplash)
end
end
describe "#next_alternative" do
context "with multiple alternatives" do
let(:experiment) { Split::ExperimentCatalog.find_or_create("link_color", "blue", "red", "green") }
context "with winner" do
it "should always return the winner" do
green = Split::Alternative.new("green", "link_color")
experiment.winner = "green"
expect(experiment.next_alternative.name).to eq("green")
green.increment_participation
expect(experiment.next_alternative.name).to eq("green")
end
end
context "without winner" do
it "should use the specified algorithm" do
experiment.algorithm = Split::Algorithms::Whiplash
expect(experiment.algorithm).to receive(:choose_alternative).and_return(Split::Alternative.new("green", "link_color"))
expect(experiment.next_alternative.name).to eq("green")
end
end
end
context "with single alternative" do
let(:experiment) { Split::ExperimentCatalog.find_or_create("link_color", "blue") }
it "should always return the only alternative" do
expect(experiment.next_alternative.name).to eq("blue")
expect(experiment.next_alternative.name).to eq("blue")
end
end
end
describe "#cohorting_disabled?" do
it "returns false when nothing has been configured" do
expect(experiment.cohorting_disabled?).to eq false
end
it "returns true when enable_cohorting is performed" do
experiment.enable_cohorting
expect(experiment.cohorting_disabled?).to eq false
end
it "returns false when nothing has been configured" do
experiment.disable_cohorting
expect(experiment.cohorting_disabled?).to eq true
end
end
describe "changing an existing experiment" do
def same_but_different_alternative
Split::ExperimentCatalog.find_or_create("link_color", "blue", "yellow", "orange")
end
it "should reset an experiment if it is loaded with different alternatives" do
experiment.save
blue.participant_count = 5
same_experiment = same_but_different_alternative
expect(same_experiment.alternatives.map(&:name)).to eq(["blue", "yellow", "orange"])
expect(blue.participant_count).to eq(0)
end
it "should only reset once" do
experiment.save
expect(experiment.version).to eq(0)
same_experiment = same_but_different_alternative
expect(same_experiment.version).to eq(1)
same_experiment_again = same_but_different_alternative
expect(same_experiment_again.version).to eq(1)
end
context "when metadata is changed" do
it "should increase version" do
experiment.save
experiment.metadata = { "foo" => "bar" }
expect { experiment.save }.to change { experiment.version }.by(1)
end
it "does not increase version" do
experiment.metadata = nil
experiment.save
expect { experiment.save }.to change { experiment.version }.by(0)
end
end
context "when experiment configuration is changed" do
let(:reset_manually) { false }
before do
experiment.save
allow(Split.configuration).to receive(:reset_manually).and_return(reset_manually)
green.increment_participation
green.increment_participation
experiment.set_alternatives_and_options(alternatives: %w(blue red green zip),
goals: %w(purchase))
experiment.save
end
it "resets all alternatives" do
expect(green.participant_count).to eq(0)
expect(green.completed_count).to eq(0)
end
context "when reset_manually is set" do
let(:reset_manually) { true }
it "does not reset alternatives" do
expect(green.participant_count).to eq(2)
expect(green.completed_count).to eq(0)
end
end
end
end
describe "alternatives passed as non-strings" do
it "should throw an exception if an alternative is passed that is not a string" do
expect { Split::ExperimentCatalog.find_or_create("link_color", :blue, :red) }.to raise_error(ArgumentError)
expect { Split::ExperimentCatalog.find_or_create("link_enabled", true, false) }.to raise_error(ArgumentError)
end
end
describe "specifying weights" do
let(:experiment_with_weight) {
Split::ExperimentCatalog.find_or_create("link_color", { "blue" => 1 }, { "red" => 2 })
}
it "should work for a new experiment" do
expect(experiment_with_weight.alternatives.map(&:weight)).to eq([1, 2])
end
it "should work for an existing experiment" do
experiment.save
expect(experiment_with_weight.alternatives.map(&:weight)).to eq([1, 2])
end
end
describe "specifying goals" do
let(:experiment) {
new_experiment(["purchase"])
}
context "saving experiment" do
let(:same_but_different_goals) { Split::ExperimentCatalog.find_or_create({ "link_color" => ["purchase", "refund"] }, "blue", "red", "green") }
before { experiment.save }
it "can find existing experiment" do
expect(Split::ExperimentCatalog.find("link_color").name).to eq("link_color")
end
it "should reset an experiment if it is loaded with different goals" do
same_but_different_goals
expect(Split::ExperimentCatalog.find("link_color").goals).to eq(["purchase", "refund"])
end
end
it "should have goals" do
expect(experiment.goals).to eq(["purchase"])
end
context "find or create experiment" do
it "should have correct goals" do
experiment = Split::ExperimentCatalog.find_or_create({ "link_color3" => ["purchase", "refund"] }, "blue", "red", "green")
expect(experiment.goals).to eq(["purchase", "refund"])
experiment = Split::ExperimentCatalog.find_or_create("link_color3", "blue", "red", "green")
expect(experiment.goals).to eq([])
end
end
end
describe "beta probability calculation" do
it "should return a hash with the probability of each alternative being the best" do
experiment = Split::ExperimentCatalog.find_or_create("mathematicians", "bernoulli", "poisson", "lagrange")
experiment.calc_winning_alternatives
expect(experiment.alternative_probabilities).not_to be_nil
end
it "should return between 46% and 54% probability for an experiment with 2 alternatives and no data" do
experiment = Split::ExperimentCatalog.find_or_create("scientists", "einstein", "bohr")
experiment.calc_winning_alternatives
expect(experiment.alternatives[0].p_winner).to be_within(0.04).of(0.50)
end
it "should calculate the probability of being the winning alternative separately for each goal", skip: true do
experiment = Split::ExperimentCatalog.find_or_create({ "link_color3" => ["purchase", "refund"] }, "blue", "red", "green")
goal1 = experiment.goals[0]
goal2 = experiment.goals[1]
experiment.alternatives.each do |alternative|
alternative.participant_count = 50
alternative.set_completed_count(10, goal1)
alternative.set_completed_count(15+rand(30), goal2)
end
experiment.calc_winning_alternatives
alt = experiment.alternatives[0]
p_goal1 = alt.p_winner(goal1)
p_goal2 = alt.p_winner(goal2)
expect(p_goal1).not_to be_within(0.04).of(p_goal2)
end
it "should return nil and not re-calculate probabilities if they have already been calculated today" do
experiment = Split::ExperimentCatalog.find_or_create({ "link_color3" => ["purchase", "refund"] }, "blue", "red", "green")
expect(experiment.calc_winning_alternatives).not_to be nil
expect(experiment.calc_winning_alternatives).to be nil
end
end
end
<MSG> Add instance method has_winner? to Experiment
<DFF> @@ -201,6 +201,22 @@ describe Split::Experiment do
end
end
+ describe 'has_winner?' do
+ context 'with winner' do
+ before { experiment.winner = 'red' }
+
+ it 'returns true' do
+ expect(experiment).to have_winner
+ end
+ end
+
+ context 'without winner' do
+ it 'returns false' do
+ expect(experiment).to_not have_winner
+ end
+ end
+ end
+
describe 'reset' do
before { experiment.save }
it 'should reset all alternatives' do
| 16 | Add instance method has_winner? to Experiment | 0 | .rb | rb | mit | splitrb/split |
10072445 | <NME> experiment_spec.rb
<BEF> # frozen_string_literal: true
require "spec_helper"
require "time"
describe Split::Experiment do
def new_experiment(goals = [])
Split::Experiment.new("link_color", alternatives: ["blue", "red", "green"], goals: goals)
end
def alternative(color)
Split::Alternative.new(color, "link_color")
end
let(:experiment) { new_experiment }
let(:blue) { alternative("blue") }
let(:green) { alternative("green") }
context "with an experiment" do
let(:experiment) { Split::Experiment.new("basket_text", alternatives: ["Basket", "Cart"]) }
it "should have a name" do
expect(experiment.name).to eq("basket_text")
end
it "should have alternatives" do
expect(experiment.alternatives.length).to be 2
end
it "should have alternatives with correct names" do
expect(experiment.alternatives.collect { |a| a.name }).to eq(["Basket", "Cart"])
end
it "should be resettable by default" do
expect(experiment.resettable).to be_truthy
end
it "should save to redis" do
experiment.save
expect(Split.redis.exists?("basket_text")).to be true
end
it "should save the start time to redis" do
experiment_start_time = Time.at(1372167761)
expect(Time).to receive(:now).and_return(experiment_start_time)
experiment.save
expect(Split::ExperimentCatalog.find("basket_text").start_time).to eq(experiment_start_time)
end
it "should not save the start time to redis when start_manually is enabled" do
expect(Split.configuration).to receive(:start_manually).and_return(true)
experiment.save
expect(Split::ExperimentCatalog.find("basket_text").start_time).to be_nil
end
it "should save the selected algorithm to redis" do
experiment_algorithm = Split::Algorithms::Whiplash
experiment.algorithm = experiment_algorithm
experiment.save
expect(Split::ExperimentCatalog.find("basket_text").algorithm).to eq(experiment_algorithm)
end
it "should handle having a start time stored as a string" do
experiment_start_time = Time.parse("Sat Mar 03 14:01:03")
expect(Time).to receive(:now).twice.and_return(experiment_start_time)
experiment.save
Split.redis.hset(:experiment_start_times, experiment.name, experiment_start_time.to_s)
expect(Split::ExperimentCatalog.find("basket_text").start_time).to eq(experiment_start_time)
end
it "should handle not having a start time" do
experiment_start_time = Time.parse("Sat Mar 03 14:01:03")
expect(Time).to receive(:now).and_return(experiment_start_time)
experiment.save
Split.redis.hdel(:experiment_start_times, experiment.name)
expect(Split::ExperimentCatalog.find("basket_text").start_time).to be_nil
end
it "should not create duplicates when saving multiple times" do
experiment.save
experiment.save
expect(Split.redis.exists?("basket_text")).to be true
expect(Split.redis.lrange("basket_text", 0, -1)).to eq(['{"Basket":1}', '{"Cart":1}'])
end
describe "new record?" do
it "should know if it hasn't been saved yet" do
expect(experiment.new_record?).to be_truthy
end
it "should know if it has been saved yet" do
experiment.save
expect(experiment.new_record?).to be_falsey
end
end
describe "control" do
it "should be the first alternative" do
experiment.save
expect(experiment.control.name).to eq("Basket")
end
end
end
describe "initialization" do
it "should set the algorithm when passed as an option to the initializer" do
experiment = Split::Experiment.new("basket_text", alternatives: ["Basket", "Cart"], algorithm: Split::Algorithms::Whiplash)
expect(experiment.algorithm).to eq(Split::Algorithms::Whiplash)
end
it "should be possible to make an experiment not resettable" do
experiment = Split::Experiment.new("basket_text", alternatives: ["Basket", "Cart"], resettable: false)
expect(experiment.resettable).to be_falsey
end
context "from configuration" do
let(:experiment_name) { :my_experiment }
let(:experiments) do
{
experiment_name => {
alternatives: ["Control Opt", "Alt one"]
}
}
end
before { Split.configuration.experiments = experiments }
it "assigns default values to the experiment" do
expect(Split::Experiment.new(experiment_name).resettable).to eq(true)
end
end
end
describe "persistent configuration" do
it "should persist resettable in redis" do
experiment = Split::Experiment.new("basket_text", alternatives: ["Basket", "Cart"], resettable: false)
experiment.save
e = Split::ExperimentCatalog.find("basket_text")
expect(e).to eq(experiment)
expect(e.resettable).to be_falsey
end
describe "#metadata" do
let(:experiment) { Split::Experiment.new("basket_text", alternatives: ["Basket", "Cart"], algorithm: Split::Algorithms::Whiplash, metadata: meta) }
let(:meta) { { a: "b" } }
before do
experiment.save
end
it "should delete the key when metadata is removed" do
experiment.metadata = nil
experiment.save
expect(Split.redis.exists?(experiment.metadata_key)).to be_falsey
end
context "simple hash" do
let(:meta) { { "basket" => "a", "cart" => "b" } }
it "should persist metadata in redis" do
e = Split::ExperimentCatalog.find("basket_text")
expect(e).to eq(experiment)
expect(e.metadata).to eq(meta)
end
end
context "nested hash" do
let(:meta) { { "basket" => { "one" => "two" }, "cart" => "b" } }
it "should persist metadata in redis" do
e = Split::ExperimentCatalog.find("basket_text")
expect(e).to eq(experiment)
expect(e.metadata).to eq(meta)
end
end
end
it "should persist algorithm in redis" do
experiment = Split::Experiment.new("basket_text", alternatives: ["Basket", "Cart"], algorithm: Split::Algorithms::Whiplash)
experiment.save
e = Split::ExperimentCatalog.find("basket_text")
expect(e).to eq(experiment)
expect(e.algorithm).to eq(Split::Algorithms::Whiplash)
end
it "should persist a new experiment in redis, that does not exist in the configuration file" do
experiment = Split::Experiment.new("foobar", alternatives: ["tra", "la"], algorithm: Split::Algorithms::Whiplash)
experiment.save
e = Split::ExperimentCatalog.find("foobar")
expect(e).to eq(experiment)
end
end
describe 'reset' do
before { experiment.save }
it 'should reset all alternatives' do
experiment.delete
end
it "should call the on_before_experiment_delete hook" do
expect(Split.configuration.on_before_experiment_delete).to receive(:call)
experiment.delete
end
it "should reset the start time if the experiment should be manually started" do
Split.configuration.start_manually = true
experiment.start
experiment.delete
expect(experiment.start_time).to be_nil
end
it "should default cohorting back to false" do
experiment.disable_cohorting
expect(experiment.cohorting_disabled?).to eq(true)
experiment.delete
expect(experiment.cohorting_disabled?).to eq(false)
end
end
describe "winner" do
it "should have no winner initially" do
expect(experiment.winner).to be_nil
end
end
describe "winner=" do
it "should allow you to specify a winner" do
experiment.save
experiment.winner = "red"
expect(experiment.winner.name).to eq("red")
end
it "should call the on_experiment_winner_choose hook" do
expect(Split.configuration.on_experiment_winner_choose).to receive(:call)
experiment.winner = "green"
end
context "when has_winner state is memoized" do
before { expect(experiment).to_not have_winner }
it "should keep has_winner state consistent" do
experiment.winner = "red"
expect(experiment).to have_winner
end
end
end
describe "reset_winner" do
before { experiment.winner = "green" }
it "should reset the winner" do
experiment.reset_winner
expect(experiment.winner).to be_nil
end
context "when has_winner state is memoized" do
before { expect(experiment).to have_winner }
it "should keep has_winner state consistent" do
experiment.reset_winner
expect(experiment).to_not have_winner
end
end
end
describe "has_winner?" do
context "with winner" do
before { experiment.winner = "red" }
it "returns true" do
expect(experiment).to have_winner
end
end
context "without winner" do
it "returns false" do
expect(experiment).to_not have_winner
end
end
it "memoizes has_winner state" do
expect(experiment).to receive(:winner).once
expect(experiment).to_not have_winner
expect(experiment).to_not have_winner
end
end
describe "reset" do
let(:reset_manually) { false }
before do
allow(Split.configuration).to receive(:reset_manually).and_return(reset_manually)
experiment.save
green.increment_participation
green.increment_participation
end
it "should reset all alternatives" do
experiment.winner = "green"
expect(experiment.next_alternative.name).to eq("green")
green.increment_participation
experiment.reset
expect(green.participant_count).to eq(0)
expect(green.completed_count).to eq(0)
end
it "should reset the winner" do
experiment.winner = "green"
expect(experiment.next_alternative.name).to eq("green")
green.increment_participation
experiment.reset
expect(experiment.winner).to be_nil
end
it "should increment the version" do
expect(experiment.version).to eq(0)
experiment.reset
expect(experiment.version).to eq(1)
end
it "should call the on_experiment_reset hook" do
expect(Split.configuration.on_experiment_reset).to receive(:call)
experiment.reset
end
it "should call the on_before_experiment_reset hook" do
expect(Split.configuration.on_before_experiment_reset).to receive(:call)
experiment.reset
end
end
describe "algorithm" do
let(:experiment) { Split::ExperimentCatalog.find_or_create("link_color", "blue", "red", "green") }
it "should use the default algorithm if none is specified" do
expect(experiment.algorithm).to eq(Split.configuration.algorithm)
end
it "should use the user specified algorithm for this experiment if specified" do
experiment.algorithm = Split::Algorithms::Whiplash
expect(experiment.algorithm).to eq(Split::Algorithms::Whiplash)
end
end
describe "#next_alternative" do
context "with multiple alternatives" do
let(:experiment) { Split::ExperimentCatalog.find_or_create("link_color", "blue", "red", "green") }
context "with winner" do
it "should always return the winner" do
green = Split::Alternative.new("green", "link_color")
experiment.winner = "green"
expect(experiment.next_alternative.name).to eq("green")
green.increment_participation
expect(experiment.next_alternative.name).to eq("green")
end
end
context "without winner" do
it "should use the specified algorithm" do
experiment.algorithm = Split::Algorithms::Whiplash
expect(experiment.algorithm).to receive(:choose_alternative).and_return(Split::Alternative.new("green", "link_color"))
expect(experiment.next_alternative.name).to eq("green")
end
end
end
context "with single alternative" do
let(:experiment) { Split::ExperimentCatalog.find_or_create("link_color", "blue") }
it "should always return the only alternative" do
expect(experiment.next_alternative.name).to eq("blue")
expect(experiment.next_alternative.name).to eq("blue")
end
end
end
describe "#cohorting_disabled?" do
it "returns false when nothing has been configured" do
expect(experiment.cohorting_disabled?).to eq false
end
it "returns true when enable_cohorting is performed" do
experiment.enable_cohorting
expect(experiment.cohorting_disabled?).to eq false
end
it "returns false when nothing has been configured" do
experiment.disable_cohorting
expect(experiment.cohorting_disabled?).to eq true
end
end
describe "changing an existing experiment" do
def same_but_different_alternative
Split::ExperimentCatalog.find_or_create("link_color", "blue", "yellow", "orange")
end
it "should reset an experiment if it is loaded with different alternatives" do
experiment.save
blue.participant_count = 5
same_experiment = same_but_different_alternative
expect(same_experiment.alternatives.map(&:name)).to eq(["blue", "yellow", "orange"])
expect(blue.participant_count).to eq(0)
end
it "should only reset once" do
experiment.save
expect(experiment.version).to eq(0)
same_experiment = same_but_different_alternative
expect(same_experiment.version).to eq(1)
same_experiment_again = same_but_different_alternative
expect(same_experiment_again.version).to eq(1)
end
context "when metadata is changed" do
it "should increase version" do
experiment.save
experiment.metadata = { "foo" => "bar" }
expect { experiment.save }.to change { experiment.version }.by(1)
end
it "does not increase version" do
experiment.metadata = nil
experiment.save
expect { experiment.save }.to change { experiment.version }.by(0)
end
end
context "when experiment configuration is changed" do
let(:reset_manually) { false }
before do
experiment.save
allow(Split.configuration).to receive(:reset_manually).and_return(reset_manually)
green.increment_participation
green.increment_participation
experiment.set_alternatives_and_options(alternatives: %w(blue red green zip),
goals: %w(purchase))
experiment.save
end
it "resets all alternatives" do
expect(green.participant_count).to eq(0)
expect(green.completed_count).to eq(0)
end
context "when reset_manually is set" do
let(:reset_manually) { true }
it "does not reset alternatives" do
expect(green.participant_count).to eq(2)
expect(green.completed_count).to eq(0)
end
end
end
end
describe "alternatives passed as non-strings" do
it "should throw an exception if an alternative is passed that is not a string" do
expect { Split::ExperimentCatalog.find_or_create("link_color", :blue, :red) }.to raise_error(ArgumentError)
expect { Split::ExperimentCatalog.find_or_create("link_enabled", true, false) }.to raise_error(ArgumentError)
end
end
describe "specifying weights" do
let(:experiment_with_weight) {
Split::ExperimentCatalog.find_or_create("link_color", { "blue" => 1 }, { "red" => 2 })
}
it "should work for a new experiment" do
expect(experiment_with_weight.alternatives.map(&:weight)).to eq([1, 2])
end
it "should work for an existing experiment" do
experiment.save
expect(experiment_with_weight.alternatives.map(&:weight)).to eq([1, 2])
end
end
describe "specifying goals" do
let(:experiment) {
new_experiment(["purchase"])
}
context "saving experiment" do
let(:same_but_different_goals) { Split::ExperimentCatalog.find_or_create({ "link_color" => ["purchase", "refund"] }, "blue", "red", "green") }
before { experiment.save }
it "can find existing experiment" do
expect(Split::ExperimentCatalog.find("link_color").name).to eq("link_color")
end
it "should reset an experiment if it is loaded with different goals" do
same_but_different_goals
expect(Split::ExperimentCatalog.find("link_color").goals).to eq(["purchase", "refund"])
end
end
it "should have goals" do
expect(experiment.goals).to eq(["purchase"])
end
context "find or create experiment" do
it "should have correct goals" do
experiment = Split::ExperimentCatalog.find_or_create({ "link_color3" => ["purchase", "refund"] }, "blue", "red", "green")
expect(experiment.goals).to eq(["purchase", "refund"])
experiment = Split::ExperimentCatalog.find_or_create("link_color3", "blue", "red", "green")
expect(experiment.goals).to eq([])
end
end
end
describe "beta probability calculation" do
it "should return a hash with the probability of each alternative being the best" do
experiment = Split::ExperimentCatalog.find_or_create("mathematicians", "bernoulli", "poisson", "lagrange")
experiment.calc_winning_alternatives
expect(experiment.alternative_probabilities).not_to be_nil
end
it "should return between 46% and 54% probability for an experiment with 2 alternatives and no data" do
experiment = Split::ExperimentCatalog.find_or_create("scientists", "einstein", "bohr")
experiment.calc_winning_alternatives
expect(experiment.alternatives[0].p_winner).to be_within(0.04).of(0.50)
end
it "should calculate the probability of being the winning alternative separately for each goal", skip: true do
experiment = Split::ExperimentCatalog.find_or_create({ "link_color3" => ["purchase", "refund"] }, "blue", "red", "green")
goal1 = experiment.goals[0]
goal2 = experiment.goals[1]
experiment.alternatives.each do |alternative|
alternative.participant_count = 50
alternative.set_completed_count(10, goal1)
alternative.set_completed_count(15+rand(30), goal2)
end
experiment.calc_winning_alternatives
alt = experiment.alternatives[0]
p_goal1 = alt.p_winner(goal1)
p_goal2 = alt.p_winner(goal2)
expect(p_goal1).not_to be_within(0.04).of(p_goal2)
end
it "should return nil and not re-calculate probabilities if they have already been calculated today" do
experiment = Split::ExperimentCatalog.find_or_create({ "link_color3" => ["purchase", "refund"] }, "blue", "red", "green")
expect(experiment.calc_winning_alternatives).not_to be nil
expect(experiment.calc_winning_alternatives).to be nil
end
end
end
<MSG> Add instance method has_winner? to Experiment
<DFF> @@ -201,6 +201,22 @@ describe Split::Experiment do
end
end
+ describe 'has_winner?' do
+ context 'with winner' do
+ before { experiment.winner = 'red' }
+
+ it 'returns true' do
+ expect(experiment).to have_winner
+ end
+ end
+
+ context 'without winner' do
+ it 'returns false' do
+ expect(experiment).to_not have_winner
+ end
+ end
+ end
+
describe 'reset' do
before { experiment.save }
it 'should reset all alternatives' do
| 16 | Add instance method has_winner? to Experiment | 0 | .rb | rb | mit | splitrb/split |
10072446 | <NME> stylesheet.ts
<BEF> import { strictEqual as equal, ok } from 'assert';
import { stylesheet as expandAbbreviation, resolveConfig, CSSAbbreviationScope } from '../src';
import score from '../src/stylesheet/score';
const defaultConfig = resolveConfig({
type: 'stylesheet',
options: {
'output.field': (index, placeholder) => `\${${index}${placeholder ? ':' + placeholder : ''}}`,
'stylesheet.fuzzySearchMinScore': 0
},
snippets: {
mten: 'margin: 10px;',
fsz: 'font-size',
gt: 'grid-template: repeat(2,auto) / repeat(auto-fit, minmax(250px, 1fr))'
},
cache: {},
});
function expand(abbr: string, config = defaultConfig) {
return expandAbbreviation(abbr, config);
}
describe('Stylesheet abbreviations', () => {
describe('Scoring', () => {
const pick = (abbr: string, items: string[]) => items
.map(item => ({ item, score: score(abbr, item, true) }))
.filter(obj => obj.score)
.sort((a, b) => b.score - a.score)
.map(obj => obj.item)[0];
it('compare scores', () => {
equal(score('aaa', 'aaa'), 1);
equal(score('baa', 'aaa'), 0);
ok(!score('b', 'aaa'));
ok(score('a', 'aaa'));
ok(score('a', 'abc'));
ok(score('ac', 'abc'));
ok(score('a', 'aaa') < score('aa', 'aaa'));
ok(score('ab', 'abc') > score('ab', 'acb'));
// acronym bonus
ok(score('ab', 'a-b') > score('ab', 'acb'));
});
it('pick padding or position', () => {
const items = ['p', 'pb', 'pl', 'pos', 'pa', 'oa', 'soa', 'pr', 'pt'];
equal(pick('p', items), 'p');
equal(pick('poa', items), 'pos');
});
});
it('keywords', () => {
equal(expand('bd1-s'), 'border: 1px solid;');
equal(expand('dib'), 'display: inline-block;');
equal(expand('bxsz'), 'box-sizing: ${1:border-box};');
equal(expand('bxz'), 'box-sizing: ${1:border-box};');
equal(expand('bxzc'), 'box-sizing: content-box;');
equal(expand('fl'), 'float: ${1:left};');
equal(expand('fll'), 'float: left;');
equal(expand('pos'), 'position: ${1:relative};');
equal(expand('poa'), 'position: absolute;');
equal(expand('por'), 'position: relative;');
equal(expand('pof'), 'position: fixed;');
equal(expand('pos-a'), 'position: absolute;');
equal(expand('m'), 'margin: ${0};');
equal(expand('m0'), 'margin: 0;');
// use `auto` as global keyword
equal(expand('m0-a'), 'margin: 0 auto;');
equal(expand('m-a'), 'margin: auto;');
equal(expand('bg'), 'background: ${1:#000};');
equal(expand('bd'), 'border: ${1:1px} ${2:solid} ${3:#000};');
equal(expand('bd0-s#fc0'), 'border: 0 solid #fc0;');
equal(expand('bd0-dd#fc0'), 'border: 0 dot-dash #fc0;');
equal(expand('bd0-h#fc0'), 'border: 0 hidden #fc0;');
equal(expand('trf-trs'), 'transform: translate(${1:x}, ${2:y});');
// https://github.com/emmetio/emmet/issues/610
equal(expand('c'), 'color: ${1:#000};');
equal(expand('cr'), 'color: rgb(${1:0}, ${2:0}, ${3:0});');
equal(expand('cra'), 'color: rgba(${1:0}, ${2:0}, ${3:0}, ${4:.5});');
// https://github.com/emmetio/emmet/issues/647
equal(expand('gtc'), 'grid-template-columns: repeat(${0});');
equal(expand('gtr'), 'grid-template-rows: repeat(${0});');
equal(expand('lis:n'), 'list-style: none;');
equal(expand('list:n'), 'list-style-type: none;');
equal(expand('bdt:n'), 'border-top: none;');
equal(expand('bgi:n'), 'background-image: none;');
equal(expand('q:n'), 'quotes: none;');
});
it('numeric', () => {
equal(expand('p0'), 'padding: 0;', 'No unit for 0');
equal(expand('p10'), 'padding: 10px;', '`px` unit for integers');
equal(expand('p.4'), 'padding: 0.4em;', '`em` for floats');
equal(expand('fz10'), 'font-size: 10px;', '`px` for integers');
equal(expand('fz1.'), 'font-size: 1em;', '`em` for explicit float');
equal(expand('p10p'), 'padding: 10%;', 'unit alias');
equal(expand('z10'), 'z-index: 10;', 'Unitless property');
equal(expand('p10r'), 'padding: 10rem;', 'unit alias');
equal(expand('mten'), 'margin: 10px;', 'Ignore terminating `;` in snippet');
// https://github.com/microsoft/vscode/issues/59951
equal(expand('fz'), 'font-size: ${0};');
equal(expand('fz12'), 'font-size: 12px;');
equal(expand('fsz'), 'font-size: ${0};');
equal(expand('fsz12'), 'font-size: 12px;');
equal(expand('fs'), 'font-style: ${1:italic};');
// https://github.com/emmetio/emmet/issues/558
equal(expand('us'), 'user-select: none;');
// https://github.com/microsoft/vscode/issues/105697
equal(expand('opa1'), 'opacity: 1;', 'Unitless property');
equal(expand('opa.1'), 'opacity: 0.1;', 'Unitless property');
equal(expand('opa.a'), 'opacity: .a;', 'Unitless property');
});
it('numeric with format options', () => {
const config = resolveConfig({
type: 'stylesheet',
options: {
'stylesheet.intUnit': 'pt',
'stylesheet.floatUnit': 'vh',
'stylesheet.unitAliases': {
e: 'em',
p: '%',
x: 'ex',
r: ' / @rem'
}
}
});
equal(expand('p0', config), 'padding: 0;', 'No unit for 0');
equal(expand('p10', config), 'padding: 10pt;', '`pt` unit for integers');
equal(expand('p.4', config), 'padding: 0.4vh;', '`vh` for floats');
equal(expand('p10p', config), 'padding: 10%;', 'unit alias');
equal(expand('z10', config), 'z-index: 10;', 'Unitless property');
equal(expand('p10r', config), 'padding: 10 / @rem;', 'unit alias');
});
it('important', () => {
equal(expand('!'), '!important');
equal(expand('p!'), 'padding: ${0} !important;');
equal(expand('p0!'), 'padding: 0 !important;');
});
it('color', () => {
equal(expand('c'), 'color: ${1:#000};');
equal(expand('c#'), 'color: #000;');
equal(expand('c#f.5'), 'color: rgba(255, 255, 255, 0.5);');
equal(expand('c#f.5!'), 'color: rgba(255, 255, 255, 0.5) !important;');
equal(expand('bgc'), 'background-color: #${1:fff};');
});
it('snippets', () => {
equal(expand('@'), '@media ${1:screen} {\n\t${0}\n}');
// Insert value into snippet fields
equal(expand('@k-name'), '@keyframes name {\n\t${2}\n}');
equal(expand('@k-name10'), '@keyframes name {\n\t10\n}');
equal(expand('gt'), 'grid-template: repeat(2, auto) / repeat(auto-fit, minmax(250px, 1fr));');
});
it('multiple properties', () => {
equal(expand('p10+m10-20'), 'padding: 10px;\nmargin: 10px 20px;');
equal(expand('p+bd'), 'padding: ${0};\nborder: ${1:1px} ${2:solid} ${3:#000};');
});
it('functions', () => {
equal(expand('trf-s(2)'), 'transform: scale(2, ${2:y});');
equal(expand('trf-s(2, 3)'), 'transform: scale(2, 3);');
});
it('case insensitive matches', () => {
equal(expand('trf:rx'), 'transform: rotateX(${1:angle});');
});
it('gradient resolver', () => {
equal(expand('lg'), 'background-image: linear-gradient(${0});');
equal(expand('lg(to right, #0, #f00.5)'), 'background-image: linear-gradient(to right, #000, rgba(255, 0, 0, 0.5));');
});
it('unmatched abbreviation', () => {
// This example is useless: it’s unexpected to receive `align-self: unset`
// for `auto` snippet
// equal(expand('auto', resolveConfig({
// type: 'stylesheet',
// options: { 'stylesheet.fuzzySearchMinScore': 0 }
// })), 'align-self: unset;');
equal(expand('auto'), 'auto: ${0};');
});
it('CSS-in-JS', () => {
const config = resolveConfig({
type: 'stylesheet',
options: {
'stylesheet.json': true,
'stylesheet.between': ': '
}
});
equal(expand('p10+mt10-20', config), 'padding: 10,\nmarginTop: \'10px 20px\',');
equal(expand('bgc', config), 'backgroundColor: \'#fff\',');
});
it('resolve context value', () => {
const config = resolveConfig({
type: 'stylesheet',
context: { name: 'align-content' }
});
});
equal(expand('m', sectionScope), 'body {\n\tdisplay: grid;\n}');
equal(expand('m', propertyScope), 'margin: ;');
});
});
context: { name: CSSAbbreviationScope.Section },
snippets: {
mten: 'margin: 10px;',
fsz: 'font-size',
myCenterAwesome: 'body {\n\tdisplay: grid;\n}'
}
});
const propertyScope = resolveConfig({
type: 'stylesheet',
context: { name: CSSAbbreviationScope.Property },
snippets: {
mten: 'margin: 10px;',
fsz: 'font-size',
myCenterAwesome: 'body {\n\tdisplay: grid;\n}'
}
});
equal(expand('m', sectionScope), 'body {\n\tdisplay: grid;\n}');
equal(expand('b', sectionScope), '');
equal(expand('m', propertyScope), 'margin: ;');
});
});
<MSG> Do not generate output for unmatched section-scoped abbreviations
<DFF> @@ -221,6 +221,7 @@ describe('Stylesheet abbreviations', () => {
});
equal(expand('m', sectionScope), 'body {\n\tdisplay: grid;\n}');
+ equal(expand('b', sectionScope), '');
equal(expand('m', propertyScope), 'margin: ;');
});
});
| 1 | Do not generate output for unmatched section-scoped abbreviations | 0 | .ts | ts | mit | emmetio/emmet |
10072447 | <NME> stylesheet.ts
<BEF> import { strictEqual as equal, ok } from 'assert';
import { stylesheet as expandAbbreviation, resolveConfig, CSSAbbreviationScope } from '../src';
import score from '../src/stylesheet/score';
const defaultConfig = resolveConfig({
type: 'stylesheet',
options: {
'output.field': (index, placeholder) => `\${${index}${placeholder ? ':' + placeholder : ''}}`,
'stylesheet.fuzzySearchMinScore': 0
},
snippets: {
mten: 'margin: 10px;',
fsz: 'font-size',
gt: 'grid-template: repeat(2,auto) / repeat(auto-fit, minmax(250px, 1fr))'
},
cache: {},
});
function expand(abbr: string, config = defaultConfig) {
return expandAbbreviation(abbr, config);
}
describe('Stylesheet abbreviations', () => {
describe('Scoring', () => {
const pick = (abbr: string, items: string[]) => items
.map(item => ({ item, score: score(abbr, item, true) }))
.filter(obj => obj.score)
.sort((a, b) => b.score - a.score)
.map(obj => obj.item)[0];
it('compare scores', () => {
equal(score('aaa', 'aaa'), 1);
equal(score('baa', 'aaa'), 0);
ok(!score('b', 'aaa'));
ok(score('a', 'aaa'));
ok(score('a', 'abc'));
ok(score('ac', 'abc'));
ok(score('a', 'aaa') < score('aa', 'aaa'));
ok(score('ab', 'abc') > score('ab', 'acb'));
// acronym bonus
ok(score('ab', 'a-b') > score('ab', 'acb'));
});
it('pick padding or position', () => {
const items = ['p', 'pb', 'pl', 'pos', 'pa', 'oa', 'soa', 'pr', 'pt'];
equal(pick('p', items), 'p');
equal(pick('poa', items), 'pos');
});
});
it('keywords', () => {
equal(expand('bd1-s'), 'border: 1px solid;');
equal(expand('dib'), 'display: inline-block;');
equal(expand('bxsz'), 'box-sizing: ${1:border-box};');
equal(expand('bxz'), 'box-sizing: ${1:border-box};');
equal(expand('bxzc'), 'box-sizing: content-box;');
equal(expand('fl'), 'float: ${1:left};');
equal(expand('fll'), 'float: left;');
equal(expand('pos'), 'position: ${1:relative};');
equal(expand('poa'), 'position: absolute;');
equal(expand('por'), 'position: relative;');
equal(expand('pof'), 'position: fixed;');
equal(expand('pos-a'), 'position: absolute;');
equal(expand('m'), 'margin: ${0};');
equal(expand('m0'), 'margin: 0;');
// use `auto` as global keyword
equal(expand('m0-a'), 'margin: 0 auto;');
equal(expand('m-a'), 'margin: auto;');
equal(expand('bg'), 'background: ${1:#000};');
equal(expand('bd'), 'border: ${1:1px} ${2:solid} ${3:#000};');
equal(expand('bd0-s#fc0'), 'border: 0 solid #fc0;');
equal(expand('bd0-dd#fc0'), 'border: 0 dot-dash #fc0;');
equal(expand('bd0-h#fc0'), 'border: 0 hidden #fc0;');
equal(expand('trf-trs'), 'transform: translate(${1:x}, ${2:y});');
// https://github.com/emmetio/emmet/issues/610
equal(expand('c'), 'color: ${1:#000};');
equal(expand('cr'), 'color: rgb(${1:0}, ${2:0}, ${3:0});');
equal(expand('cra'), 'color: rgba(${1:0}, ${2:0}, ${3:0}, ${4:.5});');
// https://github.com/emmetio/emmet/issues/647
equal(expand('gtc'), 'grid-template-columns: repeat(${0});');
equal(expand('gtr'), 'grid-template-rows: repeat(${0});');
equal(expand('lis:n'), 'list-style: none;');
equal(expand('list:n'), 'list-style-type: none;');
equal(expand('bdt:n'), 'border-top: none;');
equal(expand('bgi:n'), 'background-image: none;');
equal(expand('q:n'), 'quotes: none;');
});
it('numeric', () => {
equal(expand('p0'), 'padding: 0;', 'No unit for 0');
equal(expand('p10'), 'padding: 10px;', '`px` unit for integers');
equal(expand('p.4'), 'padding: 0.4em;', '`em` for floats');
equal(expand('fz10'), 'font-size: 10px;', '`px` for integers');
equal(expand('fz1.'), 'font-size: 1em;', '`em` for explicit float');
equal(expand('p10p'), 'padding: 10%;', 'unit alias');
equal(expand('z10'), 'z-index: 10;', 'Unitless property');
equal(expand('p10r'), 'padding: 10rem;', 'unit alias');
equal(expand('mten'), 'margin: 10px;', 'Ignore terminating `;` in snippet');
// https://github.com/microsoft/vscode/issues/59951
equal(expand('fz'), 'font-size: ${0};');
equal(expand('fz12'), 'font-size: 12px;');
equal(expand('fsz'), 'font-size: ${0};');
equal(expand('fsz12'), 'font-size: 12px;');
equal(expand('fs'), 'font-style: ${1:italic};');
// https://github.com/emmetio/emmet/issues/558
equal(expand('us'), 'user-select: none;');
// https://github.com/microsoft/vscode/issues/105697
equal(expand('opa1'), 'opacity: 1;', 'Unitless property');
equal(expand('opa.1'), 'opacity: 0.1;', 'Unitless property');
equal(expand('opa.a'), 'opacity: .a;', 'Unitless property');
});
it('numeric with format options', () => {
const config = resolveConfig({
type: 'stylesheet',
options: {
'stylesheet.intUnit': 'pt',
'stylesheet.floatUnit': 'vh',
'stylesheet.unitAliases': {
e: 'em',
p: '%',
x: 'ex',
r: ' / @rem'
}
}
});
equal(expand('p0', config), 'padding: 0;', 'No unit for 0');
equal(expand('p10', config), 'padding: 10pt;', '`pt` unit for integers');
equal(expand('p.4', config), 'padding: 0.4vh;', '`vh` for floats');
equal(expand('p10p', config), 'padding: 10%;', 'unit alias');
equal(expand('z10', config), 'z-index: 10;', 'Unitless property');
equal(expand('p10r', config), 'padding: 10 / @rem;', 'unit alias');
});
it('important', () => {
equal(expand('!'), '!important');
equal(expand('p!'), 'padding: ${0} !important;');
equal(expand('p0!'), 'padding: 0 !important;');
});
it('color', () => {
equal(expand('c'), 'color: ${1:#000};');
equal(expand('c#'), 'color: #000;');
equal(expand('c#f.5'), 'color: rgba(255, 255, 255, 0.5);');
equal(expand('c#f.5!'), 'color: rgba(255, 255, 255, 0.5) !important;');
equal(expand('bgc'), 'background-color: #${1:fff};');
});
it('snippets', () => {
equal(expand('@'), '@media ${1:screen} {\n\t${0}\n}');
// Insert value into snippet fields
equal(expand('@k-name'), '@keyframes name {\n\t${2}\n}');
equal(expand('@k-name10'), '@keyframes name {\n\t10\n}');
equal(expand('gt'), 'grid-template: repeat(2, auto) / repeat(auto-fit, minmax(250px, 1fr));');
});
it('multiple properties', () => {
equal(expand('p10+m10-20'), 'padding: 10px;\nmargin: 10px 20px;');
equal(expand('p+bd'), 'padding: ${0};\nborder: ${1:1px} ${2:solid} ${3:#000};');
});
it('functions', () => {
equal(expand('trf-s(2)'), 'transform: scale(2, ${2:y});');
equal(expand('trf-s(2, 3)'), 'transform: scale(2, 3);');
});
it('case insensitive matches', () => {
equal(expand('trf:rx'), 'transform: rotateX(${1:angle});');
});
it('gradient resolver', () => {
equal(expand('lg'), 'background-image: linear-gradient(${0});');
equal(expand('lg(to right, #0, #f00.5)'), 'background-image: linear-gradient(to right, #000, rgba(255, 0, 0, 0.5));');
});
it('unmatched abbreviation', () => {
// This example is useless: it’s unexpected to receive `align-self: unset`
// for `auto` snippet
// equal(expand('auto', resolveConfig({
// type: 'stylesheet',
// options: { 'stylesheet.fuzzySearchMinScore': 0 }
// })), 'align-self: unset;');
equal(expand('auto'), 'auto: ${0};');
});
it('CSS-in-JS', () => {
const config = resolveConfig({
type: 'stylesheet',
options: {
'stylesheet.json': true,
'stylesheet.between': ': '
}
});
equal(expand('p10+mt10-20', config), 'padding: 10,\nmarginTop: \'10px 20px\',');
equal(expand('bgc', config), 'backgroundColor: \'#fff\',');
});
it('resolve context value', () => {
const config = resolveConfig({
type: 'stylesheet',
context: { name: 'align-content' }
});
});
equal(expand('m', sectionScope), 'body {\n\tdisplay: grid;\n}');
equal(expand('m', propertyScope), 'margin: ;');
});
});
context: { name: CSSAbbreviationScope.Section },
snippets: {
mten: 'margin: 10px;',
fsz: 'font-size',
myCenterAwesome: 'body {\n\tdisplay: grid;\n}'
}
});
const propertyScope = resolveConfig({
type: 'stylesheet',
context: { name: CSSAbbreviationScope.Property },
snippets: {
mten: 'margin: 10px;',
fsz: 'font-size',
myCenterAwesome: 'body {\n\tdisplay: grid;\n}'
}
});
equal(expand('m', sectionScope), 'body {\n\tdisplay: grid;\n}');
equal(expand('b', sectionScope), '');
equal(expand('m', propertyScope), 'margin: ;');
});
});
<MSG> Do not generate output for unmatched section-scoped abbreviations
<DFF> @@ -221,6 +221,7 @@ describe('Stylesheet abbreviations', () => {
});
equal(expand('m', sectionScope), 'body {\n\tdisplay: grid;\n}');
+ equal(expand('b', sectionScope), '');
equal(expand('m', propertyScope), 'margin: ;');
});
});
| 1 | Do not generate output for unmatched section-scoped abbreviations | 0 | .ts | ts | mit | emmetio/emmet |
10072448 | <NME> split.gemspec
<BEF> # -*- encoding: utf-8 -*-
# frozen_string_literal: true
$:.push File.expand_path("../lib", __FILE__)
require "split/version"
Gem::Specification.new do |s|
s.name = "split"
s.version = Split::VERSION
s.platform = Gem::Platform::RUBY
s.authors = ["Andrew Nesbitt"]
s.licenses = ["MIT"]
s.email = ["[email protected]"]
s.homepage = "https://github.com/splitrb/split"
s.summary = "Rack based split testing framework"
s.metadata = {
"homepage_uri" => "https://github.com/splitrb/split",
"changelog_uri" => "https://github.com/splitrb/split/blob/main/CHANGELOG.md",
"source_code_uri" => "https://github.com/splitrb/split",
"bug_tracker_uri" => "https://github.com/splitrb/split/issues",
"wiki_uri" => "https://github.com/splitrb/split/wiki",
"mailing_list_uri" => "https://groups.google.com/d/forum/split-ruby"
}
s.required_ruby_version = ">= 2.5.0"
s.required_rubygems_version = ">= 2.0.0"
end
s.add_development_dependency 'rake'
s.add_development_dependency 'bundler', '~> 1.0'
s.add_development_dependency 'rspec', '~> 2.12'
s.add_development_dependency 'rack-test', '>= 0.5.7'
end
s.add_dependency "rubystats", ">= 0.3.0"
s.add_development_dependency "bundler", ">= 1.17"
s.add_development_dependency "simplecov", "~> 0.15"
s.add_development_dependency "rack-test", "~> 2.0"
s.add_development_dependency "rake", "~> 13"
s.add_development_dependency "rspec", "~> 3.7"
s.add_development_dependency "pry", "~> 0.10"
s.add_development_dependency "rails", ">= 5.0"
end
<MSG> Require a newer version of bundler for development
<DFF> @@ -28,7 +28,7 @@ Gem::Specification.new do |s|
end
s.add_development_dependency 'rake'
- s.add_development_dependency 'bundler', '~> 1.0'
+ s.add_development_dependency 'bundler', '~> 1.3'
s.add_development_dependency 'rspec', '~> 2.12'
s.add_development_dependency 'rack-test', '>= 0.5.7'
end
| 1 | Require a newer version of bundler for development | 1 | .gemspec | gemspec | mit | splitrb/split |
10072449 | <NME> split.gemspec
<BEF> # -*- encoding: utf-8 -*-
# frozen_string_literal: true
$:.push File.expand_path("../lib", __FILE__)
require "split/version"
Gem::Specification.new do |s|
s.name = "split"
s.version = Split::VERSION
s.platform = Gem::Platform::RUBY
s.authors = ["Andrew Nesbitt"]
s.licenses = ["MIT"]
s.email = ["[email protected]"]
s.homepage = "https://github.com/splitrb/split"
s.summary = "Rack based split testing framework"
s.metadata = {
"homepage_uri" => "https://github.com/splitrb/split",
"changelog_uri" => "https://github.com/splitrb/split/blob/main/CHANGELOG.md",
"source_code_uri" => "https://github.com/splitrb/split",
"bug_tracker_uri" => "https://github.com/splitrb/split/issues",
"wiki_uri" => "https://github.com/splitrb/split/wiki",
"mailing_list_uri" => "https://groups.google.com/d/forum/split-ruby"
}
s.required_ruby_version = ">= 2.5.0"
s.required_rubygems_version = ">= 2.0.0"
end
s.add_development_dependency 'rake'
s.add_development_dependency 'bundler', '~> 1.0'
s.add_development_dependency 'rspec', '~> 2.12'
s.add_development_dependency 'rack-test', '>= 0.5.7'
end
s.add_dependency "rubystats", ">= 0.3.0"
s.add_development_dependency "bundler", ">= 1.17"
s.add_development_dependency "simplecov", "~> 0.15"
s.add_development_dependency "rack-test", "~> 2.0"
s.add_development_dependency "rake", "~> 13"
s.add_development_dependency "rspec", "~> 3.7"
s.add_development_dependency "pry", "~> 0.10"
s.add_development_dependency "rails", ">= 5.0"
end
<MSG> Require a newer version of bundler for development
<DFF> @@ -28,7 +28,7 @@ Gem::Specification.new do |s|
end
s.add_development_dependency 'rake'
- s.add_development_dependency 'bundler', '~> 1.0'
+ s.add_development_dependency 'bundler', '~> 1.3'
s.add_development_dependency 'rspec', '~> 2.12'
s.add_development_dependency 'rack-test', '>= 0.5.7'
end
| 1 | Require a newer version of bundler for development | 1 | .gemspec | gemspec | mit | splitrb/split |