Skip to content

Commit 8ba47d5

Browse files
codediodeiocodediodeio
committed
initial working service
0 parents  commit 8ba47d5

40 files changed

Lines changed: 17706 additions & 0 deletions

‎.gitignore‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
node_modules/
2+
.rpt2_cache/

‎README.md‎

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
# GeoFireX - Realitme GeoLocation Tools for Firestore with RxJS
2+
3+
Live Demo
4+
5+
## QuickStart
6+
7+
```shell
8+
npm install firebase geofirex
9+
```
10+
11+
The client is a lighweight wrapper for the Firebase SDK.
12+
13+
```ts
14+
// Initnalize Firebase
15+
// var firebase = require('firebase/app')
16+
import * as firebase from 'firebase/app';
17+
firebase.initializeApp(config);
18+
19+
// Initialize the client
20+
import * as geofirex from 'geofirex';
21+
const gfx = geofirex.init(firebase);
22+
```
23+
24+
First, you'll need to add some geolocation data in your databse. A `collection` creates a reference to Firestore (just like the SDK), but with some extra geoquery features. The `geohash` method returns a class that helps you create geolocation data.
25+
26+
```ts
27+
const cities = gfx.collection('cities');
28+
29+
const location = gfx.geohash(40, -119);
30+
31+
cities.add({ name: 'Phoenix', location });
32+
```
33+
34+
Now let's make a query Firestore for _cities.location within 100km radius of a centerpoint_.
35+
36+
```ts
37+
const center = gfx.point(40.1, -119.1);
38+
const radius = 100;
39+
const field = 'location';
40+
41+
const query = cities.within(center, radius, field);
42+
```
43+
44+
The query returns a realtime Observable of the document data + some additional metadata.
45+
46+
```ts
47+
query.subscribe(console.log);
48+
// { ...data, geoQueryData: { distance: 1.23232, bearing: 230.23 } }
49+
```
50+
51+
## API
52+
53+
### `collection`
54+
55+
Returns a collection reference with
56+
57+
`within()` - Returns an Observable of queried based distance
58+
`data()` - Returns an Observable of queried documents mapped to the data payload
59+
60+
### `point`
61+
62+
Returns a GeoHash instance
63+
64+
`data` - Returns data in recommended format for database writes
65+
`coords` - Returns [lat, lng]
66+
`hash` - Returns geohash string at precision 9
67+
`geoPoint` Returns a firebase GeoPoint object
68+
`geoJSON` Returns data as a GeoJSON `Feature<Point>`
69+
70+
`distance(to)` Calulates the haversine distance to a point.
71+
`bearing(to)` Calulates the bearing to point to a point.
72+
73+
## Tips
74+
75+
### Save the `gfx.point` data as a document field
76+
77+
I recommend
78+
79+
### Always Order by `[Latitude, Longitude]`
80+
81+
The GeoJSON spec formats coords as `[Longitude, Latitude]` to represent an X/Y plane. However, the Firebase GeoPoint uses `[Latitude, Longitude]`. For consistency, this libary will always require you to use the latter format.
82+
83+
## Contribute

‎coverage/clover.xml‎

Lines changed: 306 additions & 0 deletions
Large diffs are not rendered by default.

‎coverage/coverage-final.json‎

Lines changed: 6 additions & 0 deletions
Large diffs are not rendered by default.

‎coverage/lcov-report/base.css‎

Lines changed: 223 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,223 @@
1+
body, html {
2+
margin:0; padding: 0;
3+
height: 100%;
4+
}
5+
body {
6+
font-family: Helvetica Neue, Helvetica, Arial;
7+
font-size: 14px;
8+
color:#333;
9+
}
10+
.small { font-size: 12px; }
11+
*, *:after, *:before {
12+
-webkit-box-sizing:border-box;
13+
-moz-box-sizing:border-box;
14+
box-sizing:border-box;
15+
}
16+
h1 { font-size: 20px; margin: 0;}
17+
h2 { font-size: 14px; }
18+
pre {
19+
font: 12px/1.4 Consolas, "Liberation Mono", Menlo, Courier, monospace;
20+
margin: 0;
21+
padding: 0;
22+
-moz-tab-size: 2;
23+
-o-tab-size: 2;
24+
tab-size: 2;
25+
}
26+
a { color:#0074D9; text-decoration:none; }
27+
a:hover { text-decoration:underline; }
28+
.strong { font-weight: bold; }
29+
.space-top1 { padding: 10px 0 0 0; }
30+
.pad2y { padding: 20px 0; }
31+
.pad1y { padding: 10px 0; }
32+
.pad2x { padding: 0 20px; }
33+
.pad2 { padding: 20px; }
34+
.pad1 { padding: 10px; }
35+
.space-left2 { padding-left:55px; }
36+
.space-right2 { padding-right:20px; }
37+
.center { text-align:center; }
38+
.clearfix { display:block; }
39+
.clearfix:after {
40+
content:'';
41+
display:block;
42+
height:0;
43+
clear:both;
44+
visibility:hidden;
45+
}
46+
.fl { float: left; }
47+
@media only screen and (max-width:640px) {
48+
.col3 { width:100%; max-width:100%; }
49+
.hide-mobile { display:none!important; }
50+
}
51+
52+
.quiet {
53+
color: #7f7f7f;
54+
color: rgba(0,0,0,0.5);
55+
}
56+
.quiet a { opacity: 0.7; }
57+
58+
.fraction {
59+
font-family: Consolas, 'Liberation Mono', Menlo, Courier, monospace;
60+
font-size: 10px;
61+
color: #555;
62+
background: #E8E8E8;
63+
padding: 4px 5px;
64+
border-radius: 3px;
65+
vertical-align: middle;
66+
}
67+
68+
div.path a:link, div.path a:visited { color: #333; }
69+
table.coverage {
70+
border-collapse: collapse;
71+
margin: 10px 0 0 0;
72+
padding: 0;
73+
}
74+
75+
table.coverage td {
76+
margin: 0;
77+
padding: 0;
78+
vertical-align: top;
79+
}
80+
table.coverage td.line-count {
81+
text-align: right;
82+
padding: 0 5px 0 20px;
83+
}
84+
table.coverage td.line-coverage {
85+
text-align: right;
86+
padding-right: 10px;
87+
min-width:20px;
88+
}
89+
90+
table.coverage td span.cline-any {
91+
display: inline-block;
92+
padding: 0 5px;
93+
width: 100%;
94+
}
95+
.missing-if-branch {
96+
display: inline-block;
97+
margin-right: 5px;
98+
border-radius: 3px;
99+
position: relative;
100+
padding: 0 4px;
101+
background: #333;
102+
color: yellow;
103+
}
104+
105+
.skip-if-branch {
106+
display: none;
107+
margin-right: 10px;
108+
position: relative;
109+
padding: 0 4px;
110+
background: #ccc;
111+
color: white;
112+
}
113+
.missing-if-branch .typ, .skip-if-branch .typ {
114+
color: inherit !important;
115+
}
116+
.coverage-summary {
117+
border-collapse: collapse;
118+
width: 100%;
119+
}
120+
.coverage-summary tr { border-bottom: 1px solid #bbb; }
121+
.keyline-all { border: 1px solid #ddd; }
122+
.coverage-summary td, .coverage-summary th { padding: 10px; }
123+
.coverage-summary tbody { border: 1px solid #bbb; }
124+
.coverage-summary td { border-right: 1px solid #bbb; }
125+
.coverage-summary td:last-child { border-right: none; }
126+
.coverage-summary th {
127+
text-align: left;
128+
font-weight: normal;
129+
white-space: nowrap;
130+
}
131+
.coverage-summary th.file { border-right: none !important; }
132+
.coverage-summary th.pct { }
133+
.coverage-summary th.pic,
134+
.coverage-summary th.abs,
135+
.coverage-summary td.pct,
136+
.coverage-summary td.abs { text-align: right; }
137+
.coverage-summary td.file { white-space: nowrap; }
138+
.coverage-summary td.pic { min-width: 120px !important; }
139+
.coverage-summary tfoot td { }
140+
141+
.coverage-summary .sorter {
142+
height: 10px;
143+
width: 7px;
144+
display: inline-block;
145+
margin-left: 0.5em;
146+
background: url(sort-arrow-sprite.png) no-repeat scroll 0 0 transparent;
147+
}
148+
.coverage-summary .sorted .sorter {
149+
background-position: 0 -20px;
150+
}
151+
.coverage-summary .sorted-desc .sorter {
152+
background-position: 0 -10px;
153+
}
154+
.status-line { height: 10px; }
155+
/* yellow */
156+
.cbranch-no { background: yellow !important; color: #111; }
157+
/* dark red */
158+
.red.solid, .status-line.low, .low .cover-fill { background:#C21F39 }
159+
.low .chart { border:1px solid #C21F39 }
160+
.highlighted,
161+
.highlighted .cstat-no, .highlighted .fstat-no, .highlighted .cbranch-no{
162+
background: #C21F39 !important;
163+
}
164+
/* medium red */
165+
.cstat-no, .fstat-no, .cbranch-no, .cbranch-no { background:#F6C6CE }
166+
/* light red */
167+
.low, .cline-no { background:#FCE1E5 }
168+
/* light green */
169+
.high, .cline-yes { background:rgb(230,245,208) }
170+
/* medium green */
171+
.cstat-yes { background:rgb(161,215,106) }
172+
/* dark green */
173+
.status-line.high, .high .cover-fill { background:rgb(77,146,33) }
174+
.high .chart { border:1px solid rgb(77,146,33) }
175+
176+
.medium .chart { border:1px solid #666; }
177+
.medium .cover-fill { background: #666; }
178+
179+
.cstat-skip { background: #ddd; color: #111; }
180+
.fstat-skip { background: #ddd; color: #111 !important; }
181+
.cbranch-skip { background: #ddd !important; color: #111; }
182+
183+
span.cline-neutral { background: #eaeaea; }
184+
.medium { background: #eaeaea; }
185+
186+
.coverage-summary td.empty {
187+
opacity: .5;
188+
padding-top: 4px;
189+
padding-bottom: 4px;
190+
line-height: 1;
191+
color: #888;
192+
}
193+
194+
.cover-fill, .cover-empty {
195+
display:inline-block;
196+
height: 12px;
197+
}
198+
.chart {
199+
line-height: 0;
200+
}
201+
.cover-empty {
202+
background: white;
203+
}
204+
.cover-full {
205+
border-right: none !important;
206+
}
207+
pre.prettyprint {
208+
border: none !important;
209+
padding: 0 !important;
210+
margin: 0 !important;
211+
}
212+
.com { color: #999 !important; }
213+
.ignore-none { color: #999; font-weight: normal; }
214+
215+
.wrapper {
216+
min-height: 100%;
217+
height: auto !important;
218+
height: 100%;
219+
margin: 0 auto -48px;
220+
}
221+
.footer, .push {
222+
height: 48px;
223+
}

‎coverage/lcov-report/block-navigation.js‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
var jumpToCode = (function init () {
2+
// Classes of code we would like to highlight
3+
var missingCoverageClasses = [ '.cbranch-no', '.cstat-no', '.fstat-no' ];
4+
5+
// We don't want to select elements that are direct descendants of another match
6+
var notSelector = ':not(' + missingCoverageClasses.join('):not(') + ') > '; // becomes `:not(a):not(b) > `
7+
8+
// Selecter that finds elements on the page to which we can jump
9+
var selector = notSelector + missingCoverageClasses.join(', ' + notSelector); // becomes `:not(a):not(b) > a, :not(a):not(b) > b`
10+
11+
// The NodeList of matching elements
12+
var missingCoverageElements = document.querySelectorAll(selector);
13+
14+
var currentIndex;
15+
16+
function toggleClass(index) {
17+
missingCoverageElements.item(currentIndex).classList.remove('highlighted');
18+
missingCoverageElements.item(index).classList.add('highlighted');
19+
}
20+
21+
function makeCurrent(index) {
22+
toggleClass(index);
23+
currentIndex = index;
24+
missingCoverageElements.item(index)
25+
.scrollIntoView({ behavior: 'smooth', block: 'center', inline: 'center' });
26+
}
27+
28+
function goToPrevious() {
29+
var nextIndex = 0;
30+
if (typeof currentIndex !== 'number' || currentIndex === 0) {
31+
nextIndex = missingCoverageElements.length - 1;
32+
} else if (missingCoverageElements.length > 1) {
33+
nextIndex = currentIndex - 1;
34+
}
35+
36+
makeCurrent(nextIndex);
37+
}
38+
39+
function goToNext() {
40+
var nextIndex = 0;
41+
42+
if (typeof currentIndex === 'number' && currentIndex < (missingCoverageElements.length - 1)) {
43+
nextIndex = currentIndex + 1;
44+
}
45+
46+
makeCurrent(nextIndex);
47+
}
48+
49+
return function jump(event) {
50+
switch (event.which) {
51+
case 78: // n
52+
case 74: // j
53+
goToNext();
54+
break;
55+
case 66: // b
56+
case 75: // k
57+
case 80: // p
58+
goToPrevious();
59+
break;
60+
}
61+
};
62+
}());
63+
window.addEventListener('keydown', jumpToCode);

0 commit comments

Comments
 (0)