Skip to content

Commit a3f1593

Browse files
jameslambjameslamb
authored
Merge pull request #71 from jameslamb/release/v0.3.0
release v0.3.0
2 parents 8fdcd22 + 56d37b3 commit a3f1593

26 files changed

+442
-251
lines changed

‎CONDUCT.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -40,4 +40,4 @@ Project maintainers who do not follow or enforce the Code of Conduct in good fai
4040

4141
## Attribution
4242

43-
This Code of Conduct is adapted from the Contributor Covenant, version 1.4, available at http://contributor-covenant.org/version/1/4.
43+
This Code of Conduct is adapted from the Contributor Covenant, version 1.4, available at http://contributor-covenant.org/version/1/4.

‎DESCRIPTION

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Package: uptasticsearch
22
Type: Package
33
Title: Get Data Frame Representations of 'Elasticsearch' Results
4-
Version: 0.2.0.9999
4+
Version: 0.3.0
55
Authors@R: c(
66
person("James", "Lamb", email = "james.lamb@uptake.com", role = c("aut", "cre")),
77
person("Nick", "Paras", email = "nick.paras@uptake.com", role = c("aut")),

‎NEWS.md

+20
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,25 @@
11
# uptasticsearch 0.3.0
22

3+
## Features
4+
5+
### Full support for ES6.x
6+
- [#64](https://github.com/UptakeOpenSource/uptasticsearch/pull/64) added support for ES6.x. The biggest change between that major version and v5.x is that as of ES6.x all requests issued to the ES HTTP API must pass an explicit `Content-Type` header. Previous versions of ES tried to guess the `Content-Type` when none was declared
7+
- [#66](https://github.com/UptakeOpenSource/uptasticsearch/pull/66) completed support for ES6.x. ES6.x changed the supported strategy for issuing scrolling requests. `uptasticsearch` will now hit the cluster to try to figure out which version of ES it is running, then use the appropriate scrolling strategy.
8+
9+
## Bugfixes
10+
11+
### `get_fields` when your index has no aliases
12+
- previously, `get_fields` broke on some legacy versions of Elasticsearch where no aliases had been created. The response on the `_cat/aliases` endpoint has changed from major version to major version. [#66](https://github.com/UptakeOpenSource/uptasticsearch/pull/66) fixed this for all major versions of ES from 1.0 to 6.2
13+
14+
### `get_fields` when your index has multiple aliases
15+
- previously, if you had multiple aliases pointing to the same physical index, `get_fields` would only return one of those. As of [#73](https://github.com/UptakeOpenSource/uptasticsearch/pull/73), mappings for the underlying physical index will now be duplicated once per alias in the table returned by `get_fields`.
16+
17+
### bad parsing of ES major version
18+
- as of [#64](https://github.com/UptakeOpenSource/uptasticsearch/pull/64), `uptasticsearch` attempts to query the ES host to figure out what major version of Elasticsearch is running there. Implementation errors in that PR led to versions being parsed incorrectly but silently passing tests. This was fixed in [#66](https://github.com/UptakeOpenSource/uptasticsearch/pull/66). NOTE: this only impacted the dev version of the library on Github.
19+
20+
### `ignore_scroll_restriction` not being respected
21+
- In previous versions of `uptasticsearch`, the value passed to `es_search` for `ignore_scroll_restriction` was not actually respected. This was possible because an internal function had defaults specified, so we never caught the fact that that value wasn't getting passed through. [#66](https://github.com/UptakeOpenSource/uptasticsearch/pull/66) instituted the practice of not specifying defaults on function arguments in internal functions, so similar bugs won't be able to silently get through testing in the future.
22+
323
## Deprecations and Removals
424
- [#69](https://github.com/UptakeOpenSource/uptasticsearch/pull/69) added a deprecation warning on `get_counts`. This function was outside the core mission of the package and exposed us unnecessarily to changes in the Elasticsearch DSL
525

‎R/uptasticsearch.R

+10-8
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,16 @@
55
# See: http://stackoverflow.com/a/12429344
66
# Also: see hadley's comments on his own post there. They're great.
77

8-
utils::globalVariables(c('.'
9-
, '.I'
10-
, '.id'
11-
, 'field'
12-
, 'index'
13-
, 'V1'
14-
, 'V2'
15-
))
8+
utils::globalVariables(c(
9+
'.'
10+
, '.I'
11+
, '.id'
12+
, 'alias'
13+
, 'field'
14+
, 'index'
15+
, 'V1'
16+
, 'V2'
17+
))
1618

1719

1820
# NULL object for common parameter documentation

‎cran-comments.md

+6
Original file line numberDiff line numberDiff line change
@@ -77,4 +77,10 @@
7777
### CRAN Response
7878
* No issues. v0.2.0 released to CRAN!
7979

80+
## v0.3.0 - Submission 1 - (June 18, 2018)
8081

82+
### R CMD check results
83+
* No issues
84+
85+
### CRAN Response
86+
* No issues. v0.3.0 released to CRAN!

‎docs/CONDUCT.html

+5-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/LICENSE-text.html

+5-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/authors.html

+5-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/docsearch.css

+17-14
Original file line numberDiff line numberDiff line change
@@ -111,23 +111,26 @@
111111
}
112112

113113
.algolia-autocomplete .algolia-docsearch-footer {
114-
float: none;
115-
width: auto;
116-
height: auto;
117-
padding: .75rem 1rem 0;
118-
font-size: .95rem;
119-
line-height: 1;
120-
color: #767676;
121-
background-color: rgb(255, 255, 255);
122-
border-top: 1px solid rgba(0, 0, 0, .1)
114+
width: 110px;
115+
height: 20px;
116+
z-index: 3;
117+
margin-top: 10.66667px;
118+
float: right;
119+
font-size: 0;
120+
line-height: 0;
123121
}
124122

125123
.algolia-autocomplete .algolia-docsearch-footer--logo {
126-
display: inline;
127-
overflow: visible;
128-
color: inherit;
129-
text-indent: 0;
130-
background: 0 0
124+
background-image: url("data:image/svg+xml;utf8,<svg viewBox='0 0 130 18' xmlns='http://www.w3.org/2000/svg'><defs><linearGradient x1='-36.868%' y1='134.936%' x2='129.432%' y2='-27.7%' id='a'><stop stop-color='%2300AEFF' offset='0%'/><stop stop-color='%233369E7' offset='100%'/></linearGradient></defs><g fill='none' fill-rule='evenodd'><path d='M59.399.022h13.299a2.372 2.372 0 0 1 2.377 2.364V15.62a2.372 2.372 0 0 1-2.377 2.364H59.399a2.372 2.372 0 0 1-2.377-2.364V2.381A2.368 2.368 0 0 1 59.399.022z' fill='url(%23a)'/><path d='M66.257 4.56c-2.815 0-5.1 2.272-5.1 5.078 0 2.806 2.284 5.072 5.1 5.072 2.815 0 5.1-2.272 5.1-5.078 0-2.806-2.279-5.072-5.1-5.072zm0 8.652c-1.983 0-3.593-1.602-3.593-3.574 0-1.972 1.61-3.574 3.593-3.574 1.983 0 3.593 1.602 3.593 3.574a3.582 3.582 0 0 1-3.593 3.574zm0-6.418v2.664c0 .076.082.131.153.093l2.377-1.226c.055-.027.071-.093.044-.147a2.96 2.96 0 0 0-2.465-1.487c-.055 0-.11.044-.11.104l.001-.001zm-3.33-1.956l-.312-.311a.783.783 0 0 0-1.106 0l-.372.37a.773.773 0 0 0 0 1.101l.307.305c.049.049.121.038.164-.011.181-.245.378-.479.597-.697.225-.223.455-.42.707-.599.055-.033.06-.109.016-.158h-.001zm5.001-.806v-.616a.781.781 0 0 0-.783-.779h-1.824a.78.78 0 0 0-.783.779v.632c0 .071.066.12.137.104a5.736 5.736 0 0 1 1.588-.223c.52 0 1.035.071 1.534.207a.106.106 0 0 0 .131-.104z' fill='%23FFF'/><path d='M102.162 13.762c0 1.455-.372 2.517-1.123 3.193-.75.676-1.895 1.013-3.44 1.013-.564 0-1.736-.109-2.673-.316l.345-1.689c.783.163 1.819.207 2.361.207.86 0 1.473-.174 1.84-.523.367-.349.548-.866.548-1.553v-.349a6.374 6.374 0 0 1-.838.316 4.151 4.151 0 0 1-1.194.158 4.515 4.515 0 0 1-1.616-.278 3.385 3.385 0 0 1-1.254-.817 3.744 3.744 0 0 1-.811-1.351c-.192-.539-.29-1.504-.29-2.212 0-.665.104-1.498.307-2.054a3.925 3.925 0 0 1 .904-1.433 4.124 4.124 0 0 1 1.441-.926 5.31 5.31 0 0 1 1.945-.365c.696 0 1.337.087 1.961.191a15.86 15.86 0 0 1 1.588.332v8.456h-.001zm-5.954-4.206c0 .893.197 1.885.592 2.299.394.414.904.621 1.528.621.34 0 .663-.049.964-.142a2.75 2.75 0 0 0 .734-.332v-5.29a8.531 8.531 0 0 0-1.413-.18c-.778-.022-1.369.294-1.786.801-.411.507-.619 1.395-.619 2.223zm16.12 0c0 .719-.104 1.264-.318 1.858a4.389 4.389 0 0 1-.904 1.52c-.389.42-.854.746-1.402.975-.548.229-1.391.36-1.813.36-.422-.005-1.26-.125-1.802-.36a4.088 4.088 0 0 1-1.397-.975 4.486 4.486 0 0 1-.909-1.52 5.037 5.037 0 0 1-.329-1.858c0-.719.099-1.411.318-1.999.219-.588.526-1.09.92-1.509.394-.42.865-.741 1.402-.97a4.547 4.547 0 0 1 1.786-.338 4.69 4.69 0 0 1 1.791.338c.548.229 1.019.55 1.402.97.389.42.69.921.909 1.509.23.588.345 1.28.345 1.999h.001zm-2.191.005c0-.921-.203-1.689-.597-2.223-.394-.539-.948-.806-1.654-.806-.707 0-1.26.267-1.654.806-.394.539-.586 1.302-.586 2.223 0 .932.197 1.558.592 2.098.394.545.948.812 1.654.812.707 0 1.26-.272 1.654-.812.394-.545.592-1.166.592-2.098h-.001zm6.962 4.707c-3.511.016-3.511-2.822-3.511-3.274L113.583.926l2.142-.338v10.003c0 .256 0 1.88 1.375 1.885v1.792h-.001zm3.774 0h-2.153V5.072l2.153-.338v9.534zm-1.079-10.542c.718 0 1.304-.578 1.304-1.291 0-.714-.581-1.291-1.304-1.291-.723 0-1.304.578-1.304 1.291 0 .714.586 1.291 1.304 1.291zm6.431 1.013c.707 0 1.304.087 1.786.262.482.174.871.42 1.156.73.285.311.488.735.608 1.182.126.447.186.937.186 1.476v5.481a25.24 25.24 0 0 1-1.495.251c-.668.098-1.419.147-2.251.147a6.829 6.829 0 0 1-1.517-.158 3.213 3.213 0 0 1-1.178-.507 2.455 2.455 0 0 1-.761-.904c-.181-.37-.274-.893-.274-1.438 0-.523.104-.855.307-1.215.208-.36.487-.654.838-.883a3.609 3.609 0 0 1 1.227-.49 7.073 7.073 0 0 1 2.202-.103c.263.027.537.076.833.147v-.349c0-.245-.027-.479-.088-.697a1.486 1.486 0 0 0-.307-.583c-.148-.169-.34-.3-.581-.392a2.536 2.536 0 0 0-.915-.163c-.493 0-.942.06-1.353.131-.411.071-.75.153-1.008.245l-.257-1.749c.268-.093.668-.185 1.183-.278a9.335 9.335 0 0 1 1.66-.142l-.001-.001zm.181 7.731c.657 0 1.145-.038 1.484-.104v-2.168a5.097 5.097 0 0 0-1.978-.104c-.241.033-.46.098-.652.191a1.167 1.167 0 0 0-.466.392c-.121.169-.175.267-.175.523 0 .501.175.79.493.981.323.196.75.289 1.293.289h.001zM84.109 4.794c.707 0 1.304.087 1.786.262.482.174.871.42 1.156.73.29.316.487.735.608 1.182.126.447.186.937.186 1.476v5.481a25.24 25.24 0 0 1-1.495.251c-.668.098-1.419.147-2.251.147a6.829 6.829 0 0 1-1.517-.158 3.213 3.213 0 0 1-1.178-.507 2.455 2.455 0 0 1-.761-.904c-.181-.37-.274-.893-.274-1.438 0-.523.104-.855.307-1.215.208-.36.487-.654.838-.883a3.609 3.609 0 0 1 1.227-.49 7.073 7.073 0 0 1 2.202-.103c.257.027.537.076.833.147v-.349c0-.245-.027-.479-.088-.697a1.486 1.486 0 0 0-.307-.583c-.148-.169-.34-.3-.581-.392a2.536 2.536 0 0 0-.915-.163c-.493 0-.942.06-1.353.131-.411.071-.75.153-1.008.245l-.257-1.749c.268-.093.668-.185 1.183-.278a8.89 8.89 0 0 1 1.66-.142l-.001-.001zm.186 7.736c.657 0 1.145-.038 1.484-.104v-2.168a5.097 5.097 0 0 0-1.978-.104c-.241.033-.46.098-.652.191a1.167 1.167 0 0 0-.466.392c-.121.169-.175.267-.175.523 0 .501.175.79.493.981.318.191.75.289 1.293.289h.001zm8.682 1.738c-3.511.016-3.511-2.822-3.511-3.274L89.461.926l2.142-.338v10.003c0 .256 0 1.88 1.375 1.885v1.792h-.001z' fill='%23182359'/><path d='M5.027 11.025c0 .698-.252 1.246-.757 1.644-.505.397-1.201.596-2.089.596-.888 0-1.615-.138-2.181-.414v-1.214c.358.168.739.301 1.141.397.403.097.778.145 1.125.145.508 0 .884-.097 1.125-.29a.945.945 0 0 0 .363-.779.978.978 0 0 0-.333-.747c-.222-.204-.68-.446-1.375-.725-.716-.29-1.221-.621-1.515-.994-.294-.372-.44-.82-.44-1.343 0-.655.233-1.171.698-1.547.466-.376 1.09-.564 1.875-.564.752 0 1.5.165 2.245.494l-.408 1.047c-.698-.294-1.321-.44-1.869-.44-.415 0-.73.09-.945.271a.89.89 0 0 0-.322.717c0 .204.043.379.129.524.086.145.227.282.424.411.197.129.551.299 1.063.51.577.24.999.464 1.268.671.269.208.466.442.591.704.125.261.188.569.188.924l-.001.002zm3.98 2.24c-.924 0-1.646-.269-2.167-.808-.521-.539-.782-1.281-.782-2.226 0-.97.242-1.733.725-2.288.483-.555 1.148-.833 1.993-.833.784 0 1.404.238 1.858.714.455.476.682 1.132.682 1.966v.682H7.357c.018.577.174 1.02.467 1.329.294.31.707.465 1.241.465.351 0 .678-.033.98-.099a5.1 5.1 0 0 0 .975-.33v1.026a3.865 3.865 0 0 1-.935.312 5.723 5.723 0 0 1-1.08.091l.002-.001zm-.231-5.199c-.401 0-.722.127-.964.381s-.386.625-.432 1.112h2.696c-.007-.491-.125-.862-.354-1.115-.229-.252-.544-.379-.945-.379l-.001.001zm7.692 5.092l-.252-.827h-.043c-.286.362-.575.608-.865.739-.29.131-.662.196-1.117.196-.584 0-1.039-.158-1.367-.473-.328-.315-.491-.761-.491-1.337 0-.612.227-1.074.682-1.386.455-.312 1.148-.482 2.079-.51l1.026-.032v-.317c0-.38-.089-.663-.266-.851-.177-.188-.452-.282-.824-.282-.304 0-.596.045-.876.134a6.68 6.68 0 0 0-.806.317l-.408-.902a4.414 4.414 0 0 1 1.058-.384 4.856 4.856 0 0 1 1.085-.132c.756 0 1.326.165 1.711.494.385.329.577.847.577 1.552v4.002h-.902l-.001-.001zm-1.88-.859c.458 0 .826-.128 1.104-.384.278-.256.416-.615.416-1.077v-.516l-.763.032c-.594.021-1.027.121-1.297.298s-.406.448-.406.814c0 .265.079.47.236.615.158.145.394.218.709.218h.001zm7.557-5.189c.254 0 .464.018.628.054l-.124 1.176a2.383 2.383 0 0 0-.559-.064c-.505 0-.914.165-1.227.494-.313.329-.47.757-.47 1.284v3.105h-1.262V7.218h.988l.167 1.047h.064c.197-.354.454-.636.771-.843a1.83 1.83 0 0 1 1.023-.312h.001zm4.125 6.155c-.899 0-1.582-.262-2.049-.787-.467-.525-.701-1.277-.701-2.259 0-.999.244-1.767.733-2.304.489-.537 1.195-.806 2.119-.806.627 0 1.191.116 1.692.349l-.381 1.015c-.534-.208-.974-.312-1.321-.312-1.028 0-1.542.682-1.542 2.046 0 .666.128 1.166.384 1.501.256.335.631.502 1.125.502a3.23 3.23 0 0 0 1.595-.419v1.101a2.53 2.53 0 0 1-.722.285 4.356 4.356 0 0 1-.932.086v.002zm8.277-.107h-1.268V9.506c0-.458-.092-.8-.277-1.026-.184-.226-.477-.338-.878-.338-.53 0-.919.158-1.168.475-.249.317-.373.848-.373 1.593v2.949h-1.262V4.801h1.262v2.122c0 .34-.021.704-.064 1.09h.081a1.76 1.76 0 0 1 .717-.666c.306-.158.663-.236 1.072-.236 1.439 0 2.159.725 2.159 2.175v3.873l-.001-.001zm7.649-6.048c.741 0 1.319.269 1.732.806.414.537.62 1.291.62 2.261 0 .974-.209 1.732-.628 2.275-.419.542-1.001.814-1.746.814-.752 0-1.336-.27-1.751-.811h-.086l-.231.704h-.945V4.801h1.262v1.987l-.021.655-.032.553h.054c.401-.591.992-.886 1.772-.886zm-.328 1.031c-.508 0-.875.149-1.098.448-.224.299-.339.799-.346 1.501v.086c0 .723.115 1.247.344 1.571.229.324.603.486 1.123.486.448 0 .787-.177 1.018-.532.231-.354.346-.867.346-1.536 0-1.35-.462-2.025-1.386-2.025l-.001.001zm3.244-.924h1.375l1.209 3.368c.183.48.304.931.365 1.354h.043c.032-.197.091-.436.177-.717.086-.281.541-1.616 1.364-4.004h1.364l-2.541 6.73c-.462 1.235-1.232 1.853-2.31 1.853-.279 0-.551-.03-.816-.091v-.999c.19.043.406.064.65.064.609 0 1.037-.353 1.284-1.058l.22-.559-2.385-5.941h.001z' fill='%231D3657'/></g></svg>");
125+
background-repeat: no-repeat;
126+
background-position: 50%;
127+
background-size: 100%;
128+
overflow: hidden;
129+
text-indent: -9000px;
130+
width: 100%;
131+
height: 100%;
132+
display: block;
133+
transform: translate(-8px);
131134
}
132135

133136
.algolia-autocomplete .algolia-docsearch-suggestion--highlight {

‎docs/docsearch.js

+85
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
$(function() {
2+
3+
// register a handler to move the focus to the search bar
4+
// upon pressing shift + "/" (i.e. "?")
5+
$(document).on('keydown', function(e) {
6+
if (e.shiftKey && e.keyCode == 191) {
7+
e.preventDefault();
8+
$("#search-input").focus();
9+
}
10+
});
11+
12+
$(document).ready(function() {
13+
// do keyword highlighting
14+
/* modified from https://jsfiddle.net/julmot/bL6bb5oo/ */
15+
var mark = function() {
16+
17+
var referrer = document.URL ;
18+
var paramKey = "q" ;
19+
20+
if (referrer.indexOf("?") !== -1) {
21+
var qs = referrer.substr(referrer.indexOf('?') + 1);
22+
var qs_noanchor = qs.split('#')[0];
23+
var qsa = qs_noanchor.split('&');
24+
var keyword = "";
25+
26+
for (var i = 0; i < qsa.length; i++) {
27+
var currentParam = qsa[i].split('=');
28+
29+
if (currentParam.length !== 2) {
30+
continue;
31+
}
32+
33+
if (currentParam[0] == paramKey) {
34+
keyword = decodeURIComponent(currentParam[1].replace(/\+/g, "%20"));
35+
}
36+
}
37+
38+
if (keyword !== "") {
39+
$(".contents").unmark({
40+
done: function() {
41+
$(".contents").mark(keyword);
42+
}
43+
});
44+
}
45+
}
46+
};
47+
48+
mark();
49+
});
50+
});
51+
52+
/* Search term highlighting ------------------------------*/
53+
54+
function matchedWords(hit) {
55+
var words = [];
56+
57+
var hierarchy = hit._highlightResult.hierarchy;
58+
// loop to fetch from lvl0, lvl1, etc.
59+
for (var idx in hierarchy) {
60+
words = words.concat(hierarchy[idx].matchedWords);
61+
}
62+
63+
var content = hit._highlightResult.content;
64+
if (content) {
65+
words = words.concat(content.matchedWords);
66+
}
67+
68+
// return unique words
69+
var words_uniq = [...new Set(words)];
70+
return words_uniq;
71+
}
72+
73+
function updateHitURL(hit) {
74+
75+
var words = matchedWords(hit);
76+
var url = "";
77+
78+
if (hit.anchor) {
79+
url = hit.url_without_anchor + '?q=' + escape(words.join(" ")) + '#' + hit.anchor;
80+
} else {
81+
url = hit.url + '?q=' + escape(words.join(" "));
82+
}
83+
84+
return url;
85+
}

0 commit comments

Comments
 (0)