This commit is contained in:
Andrew Lalis 2023-01-24 21:47:46 +01:00
commit 53c51e8ecd
51 changed files with 1398 additions and 91 deletions

View File

@ -15,7 +15,10 @@
version="1.1" version="1.1"
id="svg8" id="svg8"
inkscape:version="0.92.5 (2060ec1f9f, 2020-04-08)" inkscape:version="0.92.5 (2060ec1f9f, 2020-04-08)"
sodipodi:docname="icon.svg"> sodipodi:docname="icon.svg"
inkscape:export-filename="/home/andrew/github-andrewlalis/Gymboard/design/icon_128.png"
inkscape:export-xdpi="384"
inkscape:export-ydpi="384">
<defs <defs
id="defs2" /> id="defs2" />
<sodipodi:namedview <sodipodi:namedview
@ -26,15 +29,15 @@
inkscape:pageopacity="0.0" inkscape:pageopacity="0.0"
inkscape:pageshadow="2" inkscape:pageshadow="2"
inkscape:zoom="22.4" inkscape:zoom="22.4"
inkscape:cx="16.756057" inkscape:cx="2.8035079"
inkscape:cy="13.672431" inkscape:cy="15.519297"
inkscape:document-units="px" inkscape:document-units="px"
inkscape:current-layer="layer1" inkscape:current-layer="layer1"
showgrid="false" showgrid="false"
units="px" units="px"
inkscape:window-width="1920" inkscape:window-width="1920"
inkscape:window-height="1009" inkscape:window-height="1049"
inkscape:window-x="0" inkscape:window-x="1920"
inkscape:window-y="0" inkscape:window-y="0"
inkscape:window-maximized="1" /> inkscape:window-maximized="1" />
<metadata <metadata
@ -45,7 +48,7 @@
<dc:format>image/svg+xml</dc:format> <dc:format>image/svg+xml</dc:format>
<dc:type <dc:type
rdf:resource="http://purl.org/dc/dcmitype/StillImage" /> rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
<dc:title></dc:title> <dc:title />
</cc:Work> </cc:Work>
</rdf:RDF> </rdf:RDF>
</metadata> </metadata>
@ -55,55 +58,55 @@
id="layer1" id="layer1"
transform="translate(0,-288.53333)"> transform="translate(0,-288.53333)">
<rect <rect
style="opacity:1;fill:#000000;fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-width:0.79374999;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" style="opacity:1;fill:#000000;fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-width:0.96639419;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1"
id="rect815" id="rect815"
width="1.5535041" width="1.8913983"
height="2.5136223" height="3.0603466"
x="0.8639006" x="0.13103379"
y="290.76736" y="290.25571"
rx="0.26458335" /> rx="0.32213143" />
<rect <rect
style="opacity:1;fill:#000000;fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-width:0.79374999;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" style="opacity:1;fill:#000000;fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-width:0.96639419;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1"
id="rect819" id="rect819"
width="3.1289527" width="3.809514"
height="0.90185839" height="1.0980167"
x="2.6688571" x="2.3285766"
y="291.52304" /> y="291.17575" />
<rect <rect
rx="0.26458335" rx="0.32213143"
y="290.76736" y="290.25571"
x="6.049262" x="6.4442344"
height="2.5136223" height="3.0603466"
width="1.5535041" width="1.8913983"
id="rect821" id="rect821"
style="opacity:1;fill:#000000;fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-width:0.79374999;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" /> style="opacity:1;fill:#000000;fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-width:0.96639419;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" />
<rect <rect
y="292.4281" y="292.27765"
x="2.8526049" x="2.5522902"
height="0.58447266" height="0.71159816"
width="2.761457" width="3.3620865"
id="rect823" id="rect823"
style="opacity:1;fill:#646464;fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-width:0.79374999;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" /> style="opacity:1;fill:#646464;fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-width:0.96639419;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" />
<rect <rect
style="opacity:1;fill:#898989;fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-width:0.79374999;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" style="opacity:1;fill:#898989;fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-width:0.96639419;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1"
id="rect825" id="rect825"
width="2.4071047" width="2.9306607"
height="0.58447266" height="0.71159816"
x="3.0297811" x="2.7680032"
y="293.01257" /> y="292.98926" />
<rect <rect
y="293.59705" y="293.70084"
x="3.201052" x="2.9765263"
height="0.58447266" height="0.71159816"
width="2.064563" width="2.5136149"
id="rect827" id="rect827"
style="opacity:1;fill:#a8a8a8;fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-width:0.79374999;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" /> style="opacity:1;fill:#a8a8a8;fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-width:0.96639419;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" />
<rect <rect
style="opacity:1;fill:#d2d2d2;fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-width:0.79374999;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" style="opacity:1;fill:#d2d2d2;fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-width:0.96639419;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1"
id="rect829" id="rect829"
width="1.6865873" width="2.0534277"
height="0.58447266" height="0.71159816"
x="3.3900397" x="3.2066195"
y="294.18152" /> y="294.41245" />
</g> </g>
</svg> </svg>

Before

Width:  |  Height:  |  Size: 4.1 KiB

After

Width:  |  Height:  |  Size: 4.2 KiB

BIN
design/icon_128.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.0 KiB

BIN
design/icon_16.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 375 B

BIN
design/icon_256.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.8 KiB

BIN
design/icon_32.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 516 B

BIN
design/icon_64.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 723 B

BIN
design/icon_96.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 872 B

View File

@ -1,3 +1,7 @@
# Gymboard API # Gymboard API
An HTTP/REST API powered by Java and Spring Boot. This API serves as the main entrypoint An HTTP/REST API powered by Java and Spring Boot. This API serves as the main entrypoint for all data processing, and is generally the first point-of-contact for the web app or other services that consume Gymboard data.
## Development
To ease development, `nl.andrewlalis.gymboard_api.model.SampleDataLoader` will run on startup and populate the database with some sample entities. You can regenerate this data by manually deleting the database, and deleting the `.sample_data` marker file that's generated in the project directory.

View File

@ -13,7 +13,6 @@ import java.io.IOException;
* Controller for accessing a particular gym. * Controller for accessing a particular gym.
*/ */
@RestController @RestController
@RequestMapping(path = "/gyms/{countryCode}/{cityCode}/{gymName}")
public class GymController { public class GymController {
private final GymService gymService; private final GymService gymService;
private final UploadService uploadService; private final UploadService uploadService;
@ -23,7 +22,7 @@ public class GymController {
this.uploadService = uploadService; this.uploadService = uploadService;
} }
@GetMapping @GetMapping(path = "/gyms/{countryCode}/{cityCode}/{gymName}")
public GymResponse getGym( public GymResponse getGym(
@PathVariable String countryCode, @PathVariable String countryCode,
@PathVariable String cityCode, @PathVariable String cityCode,
@ -32,7 +31,7 @@ public class GymController {
return gymService.getGym(new RawGymId(countryCode, cityCode, gymName)); return gymService.getGym(new RawGymId(countryCode, cityCode, gymName));
} }
@PostMapping(path = "/submissions") @PostMapping(path = "/gyms/{countryCode}/{cityCode}/{gymName}/submissions")
public ExerciseSubmissionResponse createSubmission( public ExerciseSubmissionResponse createSubmission(
@PathVariable String countryCode, @PathVariable String countryCode,
@PathVariable String cityCode, @PathVariable String cityCode,
@ -43,7 +42,7 @@ public class GymController {
} }
@PostMapping( @PostMapping(
path = "/submissions/upload", path = "/gyms/{countryCode}/{cityCode}/{gymName}/submissions/upload",
consumes = MediaType.MULTIPART_FORM_DATA_VALUE consumes = MediaType.MULTIPART_FORM_DATA_VALUE
) )
public UploadedFileResponse uploadVideo( public UploadedFileResponse uploadVideo(

View File

@ -3,13 +3,14 @@ package nl.andrewlalis.gymboard_api.dao;
import nl.andrewlalis.gymboard_api.model.Gym; import nl.andrewlalis.gymboard_api.model.Gym;
import nl.andrewlalis.gymboard_api.model.GymId; import nl.andrewlalis.gymboard_api.model.GymId;
import org.springframework.data.jpa.repository.JpaRepository; import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.data.jpa.repository.JpaSpecificationExecutor;
import org.springframework.data.jpa.repository.Query; import org.springframework.data.jpa.repository.Query;
import org.springframework.stereotype.Repository; import org.springframework.stereotype.Repository;
import java.util.Optional; import java.util.Optional;
@Repository @Repository
public interface GymRepository extends JpaRepository<Gym, GymId> { public interface GymRepository extends JpaRepository<Gym, GymId>, JpaSpecificationExecutor<Gym> {
@Query("SELECT g FROM Gym g " + @Query("SELECT g FROM Gym g " +
"WHERE g.id.shortName = :gym AND " + "WHERE g.id.shortName = :gym AND " +
"g.id.city.id.shortName = :city AND " + "g.id.city.id.shortName = :city AND " +

Binary file not shown.

Before

Width:  |  Height:  |  Size: 63 KiB

After

Width:  |  Height:  |  Size: 99 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 12 KiB

After

Width:  |  Height:  |  Size: 1.0 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 859 B

After

Width:  |  Height:  |  Size: 375 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.8 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 2.0 KiB

After

Width:  |  Height:  |  Size: 516 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 723 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 9.4 KiB

After

Width:  |  Height:  |  Size: 872 B

View File

@ -0,0 +1,30 @@
/**
* Module for interacting with the Gymboard search service's API.
*/
import axios from 'axios';
const api = axios.create({
baseURL: 'http://localhost:8081'
});
export interface GymSearchResult {
shortName: string,
displayName: string,
cityShortName: string,
cityName: string,
countryCode: string,
countryName: string,
streetAddress: string,
latitude: number,
longitude: number
}
/**
* Searches for gyms using the given query, and eventually returns results.
* @param query The query to use.
*/
export async function searchGyms(query: string): Promise<Array<GymSearchResult>> {
const response = await api.get('/search/gyms?q=' + query);
return response.data;
}

View File

@ -0,0 +1,26 @@
<template>
<q-item :to="getGymRoute(gym)">
<q-item-section>
<q-item-label>{{ gym.displayName }}</q-item-label>
<q-item-label caption lines="1">{{ gym.cityName }}</q-item-label>
<q-item-label caption lines="1">{{ gym.countryName }}</q-item-label>
</q-item-section>
<q-item-section side top>
<q-badge color="primary" label="10k"/>
</q-item-section>
</q-item>
</template>
<script setup lang="ts">
import {GymSearchResult} from 'src/api/gymboard-search';
import {getGymRoute} from 'src/router/gym-routing';
interface Props {
gym: GymSearchResult
}
defineProps<Props>();
</script>
<style scoped>
</style>

View File

@ -0,0 +1,9 @@
<template>
<div class="row justify-center">
<div class="col-xs-12 col-sm-8 col-md-6 col-lg-4">
<slot>
<p>Form content.</p>
</slot>
</div>
</div>
</template>

View File

@ -0,0 +1,18 @@
<!--
The standard wrapper for most content that appears in the app's central view,
which centers content into a column on larger screens, and expands to full
width for smaller screens.
Use this as the root component for any pages you create.
-->
<template>
<q-page>
<div class="row justify-center">
<div class="col-xs-12 col-md-6 q-px-sm">
<slot>
<p>Page content</p>
</slot>
</div>
</div>
</q-page>
</template>

View File

@ -1,7 +1,18 @@
// This is just an example,
// so you can safely delete all default props below
export default { export default {
failed: 'Action failed', mainLayout: {
success: 'Action was successful' language: 'Language',
pages: 'Pages'
},
gymPage: {
home: 'Home',
submit: 'Submit',
leaderboard: 'Leaderboard',
submitPage: {
exercise: 'Exercise',
weight: 'Weight',
reps: 'Repetitions',
date: 'Date',
submit: 'Submit'
}
}
}; };

View File

@ -1,5 +1,7 @@
import enUS from './en-US'; import enUS from './en-US';
import nlNL from './nl-NL';
export default { export default {
'en-US': enUS 'en-US': enUS,
'nl-NL': nlNL
}; };

View File

@ -0,0 +1,18 @@
export default {
mainLayout: {
language: 'Taal',
pages: 'Pagina\'s'
},
gymPage: {
home: 'Thuis',
submit: 'Indienen',
leaderboard: 'Scorebord',
submitPage: {
exercise: 'Oefening',
weight: 'Gewicht',
reps: 'Repetities',
date: 'Datum',
submit: 'Sturen'
}
}
}

View File

@ -14,6 +14,23 @@
<q-toolbar-title> <q-toolbar-title>
<router-link to="/" style="text-decoration: none; color: inherit;">Gymboard</router-link> <router-link to="/" style="text-decoration: none; color: inherit;">Gymboard</router-link>
</q-toolbar-title> </q-toolbar-title>
<q-select
v-model="i18n.locale.value"
:options="localeOptions"
:label="$t('mainLayout.language')"
dense
borderless
emit-value
map-options
options-dense
filled
hide-bottom-space
dark
options-dark
label-color="white"
options-selected-class="text-grey"
style="min-width: 150px"
/>
</q-toolbar> </q-toolbar>
</q-header> </q-header>
@ -26,7 +43,7 @@
<q-item-label <q-item-label
header header
> >
Pages {{ $t('mainLayout.pages') }}
</q-item-label> </q-item-label>
<q-item clickable>Gyms</q-item> <q-item clickable>Gyms</q-item>
<q-item clickable>Global Leaderboard</q-item> <q-item clickable>Global Leaderboard</q-item>
@ -39,21 +56,19 @@
</q-layout> </q-layout>
</template> </template>
<script lang="ts"> <script setup lang="ts">
import { defineComponent, ref } from 'vue'; import { ref } from 'vue';
import {useI18n} from 'vue-i18n';
export default defineComponent({ const i18n = useI18n({useScope: 'global'});
name: 'MainLayout', const localeOptions = [
{ value: 'en-US', label: 'English' },
{ value: 'nl-NL', label: 'Nederlands' }
];
setup () { const leftDrawerOpen = ref(false);
const leftDrawerOpen = ref(false)
return { function toggleLeftDrawer () {
leftDrawerOpen, leftDrawerOpen.value = !leftDrawerOpen.value
toggleLeftDrawer () { }
leftDrawerOpen.value = !leftDrawerOpen.value
}
}
}
});
</script> </script>

View File

@ -1,20 +1,77 @@
<template> <template>
<q-page> <StandardCenteredPage>
Index <q-input
<router-link to="/g/nl/groningen/trainmore-munnekeholm">Test</router-link> v-model="searchQuery"
<p> label="Search for a Gym"
Search bar for gyms. clearable
</p> :loading="searchBarLoadingState"
</q-page> @update:modelValue="onSearchQueryUpdated"
class="q-mt-lg"
>
<template v-slot:append>
<q-icon name="search" />
</template>
</q-input>
<q-list>
<SimpleGymItem v-for="gym in searchResults" :gym="gym" :key="gym.shortName" />
</q-list>
</StandardCenteredPage>
</template> </template>
<script lang="ts"> <script setup lang="ts">
import { defineComponent } from 'vue'; import {onMounted, ref, Ref} from 'vue';
import SimpleGymItem from 'components/SimpleGymItem.vue';
import {useRoute, useRouter} from 'vue-router';
import StandardCenteredPage from 'components/StandardCenteredPage.vue';
import {GymSearchResult, searchGyms} from 'src/api/gymboard-search';
export default defineComponent({ const route = useRoute();
name: 'IndexPage', const router = useRouter();
setup () {
return {}; const searchQuery: Ref<string> = ref('');
const searchBarLoadingState: Ref<boolean> = ref(false);
const searchResults: Ref<Array<GymSearchResult>> = ref([]);
let timer: ReturnType<typeof setTimeout> | null = null;
const SEARCH_TIMEOUT = 500;
onMounted(async () => {
if (route.query.search_query) {
searchQuery.value = route.query.search_query as string;
searchBarLoadingState.value = true;
await doSearch();
} }
}); });
/**
* Function that's called when the user's search query updates. It will start
* a timer that'll eventually trigger {@link doSearch}.
*/
function onSearchQueryUpdated() {
if (timer !== null) {
clearTimeout(timer);
}
timer = setTimeout(doSearch, SEARCH_TIMEOUT);
searchBarLoadingState.value = true;
}
/**
* Triggers a search of gyms using the current search query.
*/
async function doSearch() {
const searchQueryText = searchQuery.value;
let query = {};
if (searchQueryText && searchQueryText.length > 0) {
query = { search_query: searchQueryText };
}
await router.push({ path: '/', query: query });
try {
searchResults.value = await searchGyms(searchQueryText)
} catch (error) {
console.error(error);
} finally {
searchBarLoadingState.value = false;
}
}
</script> </script>

View File

@ -0,0 +1,21 @@
<template>
<q-page>
<h3>Gym Home Page</h3>
<p>
Maybe put an image of the gym here?
</p>
<p>
Put a description of the gym here?
</p>
<p>
Maybe show a snapshot of some recent lifts?
</p>
</q-page>
</template>
<script setup lang="ts">
</script>
<style scoped>
</style>

View File

@ -0,0 +1,15 @@
<template>
<q-page>
<h3>Leaderboards</h3>
<p>
Some text here.
</p>
</q-page>
</template>
<script setup lang="ts">
</script>
<style scoped>
</style>

View File

@ -0,0 +1,54 @@
<template>
<StandardCenteredPage v-if="gym">
<h3 class="q-my-md text-center">{{ gym.displayName }}</h3>
<q-btn-group spread square push>
<q-btn
:label="$t('gymPage.home')"
:to="getGymRoute(gym)"
:color="homePageSelected ? 'primary' : 'secondary'"
/>
<q-btn
:label="$t('gymPage.submit')"
:to="getGymRoute(gym) + '/submit'"
:color="submitPageSelected ? 'primary' : 'secondary'"
/>
<q-btn
:label="$t('gymPage.leaderboard')"
:to="getGymRoute(gym) + '/leaderboard'"
:color="leaderboardPageSelected ? 'primary' : 'secondary'"
/>
</q-btn-group>
<router-view/>
</StandardCenteredPage>
</template>
<script setup lang="ts">
import {computed, onMounted, ref, Ref} from 'vue';
import { getGym, Gym } from 'src/api/gymboard-api';
import {useRoute, useRouter} from 'vue-router';
import StandardCenteredPage from 'components/StandardCenteredPage.vue';
import {getGymRoute} from 'src/router/gym-routing';
const route = useRoute();
const router = useRouter();
const gym: Ref<Gym | undefined> = ref<Gym>();
// Once the component is mounted, load the gym that we're at.
onMounted(async () => {
try {
gym.value = await getGym(
route.params.countryCode as string,
route.params.cityShortName as string,
route.params.gymShortName as string
);
} catch (error) {
console.error(error);
await router.push('/');
}
});
const homePageSelected = computed(() => gym.value && getGymRoute(gym.value) === route.fullPath);
const submitPageSelected = computed(() => gym.value && route.fullPath === getGymRoute(gym.value) + '/submit');
const leaderboardPageSelected = computed(() => gym.value && route.fullPath === getGymRoute(gym.value) + '/leaderboard');
</script>

View File

@ -0,0 +1,93 @@
<template>
<q-page v-if="gym">
<q-form @submit="onSubmitted">
<SlimForm>
<div class="row">
<q-select
:options="exercises"
v-model="submissionModel.exercise"
:label="$t('gymPage.submitPage.exercise')"
class="col-12"
/>
</div>
<div class="row">
<q-input
:label="$t('gymPage.submitPage.weight')"
type="number"
v-model="submissionModel.weight"
class="col-8"
/>
<q-select
:options="weightUnits"
v-model="submissionModel.weightUnit"
class="col-4 q-pl-sm"
/>
</div>
<div class="row">
<q-input
:label="$t('gymPage.submitPage.reps')"
type="number"
v-model="submissionModel.repCount"
class="col-12"
/>
</div>
<div class="row">
<q-input
v-model="submissionModel.date"
type="date"
:label="$t('gymPage.submitPage.date')"
class="col-12"
/>
</div>
<div class="row">
<q-btn
:label="$t('gymPage.submitPage.submit')"
color="primary"
type="submit"
class="q-mt-sm"
/>
</div>
</SlimForm>
</q-form>
</q-page>
</template>
<script setup lang="ts">
import {onMounted, ref, Ref} from 'vue';
import {Gym} from 'src/api/gymboard-api';
import {getGymFromRoute} from 'src/router/gym-routing';
import SlimForm from 'components/SlimForm.vue';
// interface Props {
// gym: Gym
// }
// const props = defineProps<Props>();
const gym: Ref<Gym | undefined> = ref<Gym>();
let submissionModel = ref({
exercise: null,
weight: null,
weightUnit: 'Kg',
repCount: 1,
date: new Date().toLocaleDateString('en-CA')
});
const weightUnits = ['Kg', 'Lbs'];
const exercises = ['Bench Press', 'Squat', 'Deadlift'];
// TODO: Make it possible to pass the gym to this via props instead.
onMounted(async () => {
try {
gym.value = await getGymFromRoute();
} catch (error) {
console.error(error);
}
});
function onSubmitted() {
console.log('submitted');
}
</script>
<style scoped>
</style>

View File

@ -0,0 +1,31 @@
import {useRoute} from 'vue-router';
import {getGym, Gym} from 'src/api/gymboard-api';
/**
* Any object that contains the properties needed to identify a single gym.
*/
export interface GymRoutable {
countryCode: string;
cityShortName: string;
shortName: string
}
/**
* Gets the route that can be used to navigate to a particular gym's page.
* @param gym The gym to get the route for.
*/
export function getGymRoute(gym: GymRoutable): string {
return `/gyms/${gym.countryCode}/${gym.cityShortName}/${gym.shortName}`;
}
/**
* Gets the gym that's referred to by the current route's path params.
*/
export async function getGymFromRoute(): Promise<Gym> {
const route = useRoute();
return await getGym(
route.params.countryCode as string,
route.params.cityShortName as string,
route.params.gymShortName as string
);
}

View File

@ -1,20 +1,25 @@
import { RouteRecordRaw } from 'vue-router'; import { RouteRecordRaw } from 'vue-router';
import MainLayout from 'layouts/MainLayout.vue'; import MainLayout from 'layouts/MainLayout.vue';
import IndexPage from 'pages/IndexPage.vue'; import IndexPage from 'pages/IndexPage.vue';
import GymPage from 'pages/GymPage.vue'; import GymPage from 'pages/gym/GymPage.vue';
import GymSubmissionPage from 'pages/gym/GymSubmissionPage.vue';
import GymHomePage from 'pages/gym/GymHomePage.vue';
import GymLeaderboardsPage from 'pages/gym/GymLeaderboardsPage.vue';
const routes: RouteRecordRaw[] = [ const routes: RouteRecordRaw[] = [
{ {
path: '/', path: '/',
component: MainLayout, component: MainLayout,
children: [ children: [
{ path: '', component: IndexPage },
{ {
path: '', path: 'gyms/:countryCode/:cityShortName/:gymShortName',
component: IndexPage component: GymPage,
}, children: [
{ { path: '', component: GymHomePage },
path: 'g/:countryCode/:cityShortName/:gymShortName', { path: 'submit', component: GymSubmissionPage },
component: GymPage { path: 'leaderboard', component: GymLeaderboardsPage }
]
} }
], ],
}, },

35
gymboard-search/.gitignore vendored Normal file
View File

@ -0,0 +1,35 @@
HELP.md
target/
!.mvn/wrapper/maven-wrapper.jar
!**/src/main/**/target/
!**/src/test/**/target/
### STS ###
.apt_generated
.classpath
.factorypath
.project
.settings
.springBeans
.sts4-cache
### IntelliJ IDEA ###
.idea
*.iws
*.iml
*.ipr
### NetBeans ###
/nbproject/private/
/nbbuild/
/dist/
/nbdist/
/.nb-gradle/
build/
!**/src/main/**/build/
!**/src/test/**/build/
### VS Code ###
.vscode/
gym-index/

Binary file not shown.

View File

@ -0,0 +1,2 @@
distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.8.6/apache-maven-3.8.6-bin.zip
wrapperUrl=https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.1.0/maven-wrapper-3.1.0.jar

View File

@ -0,0 +1,9 @@
# Gymboard Search
A simple search API for Gymboard, backed by Apache Lucene. This application includes both indexing of Gyms and other searchable entities, and a public web interface for searching those indexes.
This application is configured with read-only access to the central Gymboard database, for its indexing operations.
## Developing
Currently, this application is designed to boot up and immediately read the latest data from the Gymboard API's database to rebuild its indexes.

316
gymboard-search/mvnw vendored Executable file
View File

@ -0,0 +1,316 @@
#!/bin/sh
# ----------------------------------------------------------------------------
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
# ----------------------------------------------------------------------------
# ----------------------------------------------------------------------------
# Maven Start Up Batch script
#
# Required ENV vars:
# ------------------
# JAVA_HOME - location of a JDK home dir
#
# Optional ENV vars
# -----------------
# M2_HOME - location of maven2's installed home dir
# MAVEN_OPTS - parameters passed to the Java VM when running Maven
# e.g. to debug Maven itself, use
# set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000
# MAVEN_SKIP_RC - flag to disable loading of mavenrc files
# ----------------------------------------------------------------------------
if [ -z "$MAVEN_SKIP_RC" ] ; then
if [ -f /usr/local/etc/mavenrc ] ; then
. /usr/local/etc/mavenrc
fi
if [ -f /etc/mavenrc ] ; then
. /etc/mavenrc
fi
if [ -f "$HOME/.mavenrc" ] ; then
. "$HOME/.mavenrc"
fi
fi
# OS specific support. $var _must_ be set to either true or false.
cygwin=false;
darwin=false;
mingw=false
case "`uname`" in
CYGWIN*) cygwin=true ;;
MINGW*) mingw=true;;
Darwin*) darwin=true
# Use /usr/libexec/java_home if available, otherwise fall back to /Library/Java/Home
# See https://developer.apple.com/library/mac/qa/qa1170/_index.html
if [ -z "$JAVA_HOME" ]; then
if [ -x "/usr/libexec/java_home" ]; then
export JAVA_HOME="`/usr/libexec/java_home`"
else
export JAVA_HOME="/Library/Java/Home"
fi
fi
;;
esac
if [ -z "$JAVA_HOME" ] ; then
if [ -r /etc/gentoo-release ] ; then
JAVA_HOME=`java-config --jre-home`
fi
fi
if [ -z "$M2_HOME" ] ; then
## resolve links - $0 may be a link to maven's home
PRG="$0"
# need this for relative symlinks
while [ -h "$PRG" ] ; do
ls=`ls -ld "$PRG"`
link=`expr "$ls" : '.*-> \(.*\)$'`
if expr "$link" : '/.*' > /dev/null; then
PRG="$link"
else
PRG="`dirname "$PRG"`/$link"
fi
done
saveddir=`pwd`
M2_HOME=`dirname "$PRG"`/..
# make it fully qualified
M2_HOME=`cd "$M2_HOME" && pwd`
cd "$saveddir"
# echo Using m2 at $M2_HOME
fi
# For Cygwin, ensure paths are in UNIX format before anything is touched
if $cygwin ; then
[ -n "$M2_HOME" ] &&
M2_HOME=`cygpath --unix "$M2_HOME"`
[ -n "$JAVA_HOME" ] &&
JAVA_HOME=`cygpath --unix "$JAVA_HOME"`
[ -n "$CLASSPATH" ] &&
CLASSPATH=`cygpath --path --unix "$CLASSPATH"`
fi
# For Mingw, ensure paths are in UNIX format before anything is touched
if $mingw ; then
[ -n "$M2_HOME" ] &&
M2_HOME="`(cd "$M2_HOME"; pwd)`"
[ -n "$JAVA_HOME" ] &&
JAVA_HOME="`(cd "$JAVA_HOME"; pwd)`"
fi
if [ -z "$JAVA_HOME" ]; then
javaExecutable="`which javac`"
if [ -n "$javaExecutable" ] && ! [ "`expr \"$javaExecutable\" : '\([^ ]*\)'`" = "no" ]; then
# readlink(1) is not available as standard on Solaris 10.
readLink=`which readlink`
if [ ! `expr "$readLink" : '\([^ ]*\)'` = "no" ]; then
if $darwin ; then
javaHome="`dirname \"$javaExecutable\"`"
javaExecutable="`cd \"$javaHome\" && pwd -P`/javac"
else
javaExecutable="`readlink -f \"$javaExecutable\"`"
fi
javaHome="`dirname \"$javaExecutable\"`"
javaHome=`expr "$javaHome" : '\(.*\)/bin'`
JAVA_HOME="$javaHome"
export JAVA_HOME
fi
fi
fi
if [ -z "$JAVACMD" ] ; then
if [ -n "$JAVA_HOME" ] ; then
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
# IBM's JDK on AIX uses strange locations for the executables
JAVACMD="$JAVA_HOME/jre/sh/java"
else
JAVACMD="$JAVA_HOME/bin/java"
fi
else
JAVACMD="`\\unset -f command; \\command -v java`"
fi
fi
if [ ! -x "$JAVACMD" ] ; then
echo "Error: JAVA_HOME is not defined correctly." >&2
echo " We cannot execute $JAVACMD" >&2
exit 1
fi
if [ -z "$JAVA_HOME" ] ; then
echo "Warning: JAVA_HOME environment variable is not set."
fi
CLASSWORLDS_LAUNCHER=org.codehaus.plexus.classworlds.launcher.Launcher
# traverses directory structure from process work directory to filesystem root
# first directory with .mvn subdirectory is considered project base directory
find_maven_basedir() {
if [ -z "$1" ]
then
echo "Path not specified to find_maven_basedir"
return 1
fi
basedir="$1"
wdir="$1"
while [ "$wdir" != '/' ] ; do
if [ -d "$wdir"/.mvn ] ; then
basedir=$wdir
break
fi
# workaround for JBEAP-8937 (on Solaris 10/Sparc)
if [ -d "${wdir}" ]; then
wdir=`cd "$wdir/.."; pwd`
fi
# end of workaround
done
echo "${basedir}"
}
# concatenates all lines of a file
concat_lines() {
if [ -f "$1" ]; then
echo "$(tr -s '\n' ' ' < "$1")"
fi
}
BASE_DIR=`find_maven_basedir "$(pwd)"`
if [ -z "$BASE_DIR" ]; then
exit 1;
fi
##########################################################################################
# Extension to allow automatically downloading the maven-wrapper.jar from Maven-central
# This allows using the maven wrapper in projects that prohibit checking in binary data.
##########################################################################################
if [ -r "$BASE_DIR/.mvn/wrapper/maven-wrapper.jar" ]; then
if [ "$MVNW_VERBOSE" = true ]; then
echo "Found .mvn/wrapper/maven-wrapper.jar"
fi
else
if [ "$MVNW_VERBOSE" = true ]; then
echo "Couldn't find .mvn/wrapper/maven-wrapper.jar, downloading it ..."
fi
if [ -n "$MVNW_REPOURL" ]; then
jarUrl="$MVNW_REPOURL/org/apache/maven/wrapper/maven-wrapper/3.1.0/maven-wrapper-3.1.0.jar"
else
jarUrl="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.1.0/maven-wrapper-3.1.0.jar"
fi
while IFS="=" read key value; do
case "$key" in (wrapperUrl) jarUrl="$value"; break ;;
esac
done < "$BASE_DIR/.mvn/wrapper/maven-wrapper.properties"
if [ "$MVNW_VERBOSE" = true ]; then
echo "Downloading from: $jarUrl"
fi
wrapperJarPath="$BASE_DIR/.mvn/wrapper/maven-wrapper.jar"
if $cygwin; then
wrapperJarPath=`cygpath --path --windows "$wrapperJarPath"`
fi
if command -v wget > /dev/null; then
if [ "$MVNW_VERBOSE" = true ]; then
echo "Found wget ... using wget"
fi
if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then
wget "$jarUrl" -O "$wrapperJarPath" || rm -f "$wrapperJarPath"
else
wget --http-user=$MVNW_USERNAME --http-password=$MVNW_PASSWORD "$jarUrl" -O "$wrapperJarPath" || rm -f "$wrapperJarPath"
fi
elif command -v curl > /dev/null; then
if [ "$MVNW_VERBOSE" = true ]; then
echo "Found curl ... using curl"
fi
if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then
curl -o "$wrapperJarPath" "$jarUrl" -f
else
curl --user $MVNW_USERNAME:$MVNW_PASSWORD -o "$wrapperJarPath" "$jarUrl" -f
fi
else
if [ "$MVNW_VERBOSE" = true ]; then
echo "Falling back to using Java to download"
fi
javaClass="$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.java"
# For Cygwin, switch paths to Windows format before running javac
if $cygwin; then
javaClass=`cygpath --path --windows "$javaClass"`
fi
if [ -e "$javaClass" ]; then
if [ ! -e "$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.class" ]; then
if [ "$MVNW_VERBOSE" = true ]; then
echo " - Compiling MavenWrapperDownloader.java ..."
fi
# Compiling the Java class
("$JAVA_HOME/bin/javac" "$javaClass")
fi
if [ -e "$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.class" ]; then
# Running the downloader
if [ "$MVNW_VERBOSE" = true ]; then
echo " - Running MavenWrapperDownloader.java ..."
fi
("$JAVA_HOME/bin/java" -cp .mvn/wrapper MavenWrapperDownloader "$MAVEN_PROJECTBASEDIR")
fi
fi
fi
fi
##########################################################################################
# End of extension
##########################################################################################
export MAVEN_PROJECTBASEDIR=${MAVEN_BASEDIR:-"$BASE_DIR"}
if [ "$MVNW_VERBOSE" = true ]; then
echo $MAVEN_PROJECTBASEDIR
fi
MAVEN_OPTS="$(concat_lines "$MAVEN_PROJECTBASEDIR/.mvn/jvm.config") $MAVEN_OPTS"
# For Cygwin, switch paths to Windows format before running java
if $cygwin; then
[ -n "$M2_HOME" ] &&
M2_HOME=`cygpath --path --windows "$M2_HOME"`
[ -n "$JAVA_HOME" ] &&
JAVA_HOME=`cygpath --path --windows "$JAVA_HOME"`
[ -n "$CLASSPATH" ] &&
CLASSPATH=`cygpath --path --windows "$CLASSPATH"`
[ -n "$MAVEN_PROJECTBASEDIR" ] &&
MAVEN_PROJECTBASEDIR=`cygpath --path --windows "$MAVEN_PROJECTBASEDIR"`
fi
# Provide a "standardized" way to retrieve the CLI args that will
# work with both Windows and non-Windows executions.
MAVEN_CMD_LINE_ARGS="$MAVEN_CONFIG $@"
export MAVEN_CMD_LINE_ARGS
WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain
exec "$JAVACMD" \
$MAVEN_OPTS \
$MAVEN_DEBUG_OPTS \
-classpath "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" \
"-Dmaven.home=${M2_HOME}" \
"-Dmaven.multiModuleProjectDirectory=${MAVEN_PROJECTBASEDIR}" \
${WRAPPER_LAUNCHER} $MAVEN_CONFIG "$@"

188
gymboard-search/mvnw.cmd vendored Normal file
View File

@ -0,0 +1,188 @@
@REM ----------------------------------------------------------------------------
@REM Licensed to the Apache Software Foundation (ASF) under one
@REM or more contributor license agreements. See the NOTICE file
@REM distributed with this work for additional information
@REM regarding copyright ownership. The ASF licenses this file
@REM to you under the Apache License, Version 2.0 (the
@REM "License"); you may not use this file except in compliance
@REM with the License. You may obtain a copy of the License at
@REM
@REM https://www.apache.org/licenses/LICENSE-2.0
@REM
@REM Unless required by applicable law or agreed to in writing,
@REM software distributed under the License is distributed on an
@REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
@REM KIND, either express or implied. See the License for the
@REM specific language governing permissions and limitations
@REM under the License.
@REM ----------------------------------------------------------------------------
@REM ----------------------------------------------------------------------------
@REM Maven Start Up Batch script
@REM
@REM Required ENV vars:
@REM JAVA_HOME - location of a JDK home dir
@REM
@REM Optional ENV vars
@REM M2_HOME - location of maven2's installed home dir
@REM MAVEN_BATCH_ECHO - set to 'on' to enable the echoing of the batch commands
@REM MAVEN_BATCH_PAUSE - set to 'on' to wait for a keystroke before ending
@REM MAVEN_OPTS - parameters passed to the Java VM when running Maven
@REM e.g. to debug Maven itself, use
@REM set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000
@REM MAVEN_SKIP_RC - flag to disable loading of mavenrc files
@REM ----------------------------------------------------------------------------
@REM Begin all REM lines with '@' in case MAVEN_BATCH_ECHO is 'on'
@echo off
@REM set title of command window
title %0
@REM enable echoing by setting MAVEN_BATCH_ECHO to 'on'
@if "%MAVEN_BATCH_ECHO%" == "on" echo %MAVEN_BATCH_ECHO%
@REM set %HOME% to equivalent of $HOME
if "%HOME%" == "" (set "HOME=%HOMEDRIVE%%HOMEPATH%")
@REM Execute a user defined script before this one
if not "%MAVEN_SKIP_RC%" == "" goto skipRcPre
@REM check for pre script, once with legacy .bat ending and once with .cmd ending
if exist "%USERPROFILE%\mavenrc_pre.bat" call "%USERPROFILE%\mavenrc_pre.bat" %*
if exist "%USERPROFILE%\mavenrc_pre.cmd" call "%USERPROFILE%\mavenrc_pre.cmd" %*
:skipRcPre
@setlocal
set ERROR_CODE=0
@REM To isolate internal variables from possible post scripts, we use another setlocal
@setlocal
@REM ==== START VALIDATION ====
if not "%JAVA_HOME%" == "" goto OkJHome
echo.
echo Error: JAVA_HOME not found in your environment. >&2
echo Please set the JAVA_HOME variable in your environment to match the >&2
echo location of your Java installation. >&2
echo.
goto error
:OkJHome
if exist "%JAVA_HOME%\bin\java.exe" goto init
echo.
echo Error: JAVA_HOME is set to an invalid directory. >&2
echo JAVA_HOME = "%JAVA_HOME%" >&2
echo Please set the JAVA_HOME variable in your environment to match the >&2
echo location of your Java installation. >&2
echo.
goto error
@REM ==== END VALIDATION ====
:init
@REM Find the project base dir, i.e. the directory that contains the folder ".mvn".
@REM Fallback to current working directory if not found.
set MAVEN_PROJECTBASEDIR=%MAVEN_BASEDIR%
IF NOT "%MAVEN_PROJECTBASEDIR%"=="" goto endDetectBaseDir
set EXEC_DIR=%CD%
set WDIR=%EXEC_DIR%
:findBaseDir
IF EXIST "%WDIR%"\.mvn goto baseDirFound
cd ..
IF "%WDIR%"=="%CD%" goto baseDirNotFound
set WDIR=%CD%
goto findBaseDir
:baseDirFound
set MAVEN_PROJECTBASEDIR=%WDIR%
cd "%EXEC_DIR%"
goto endDetectBaseDir
:baseDirNotFound
set MAVEN_PROJECTBASEDIR=%EXEC_DIR%
cd "%EXEC_DIR%"
:endDetectBaseDir
IF NOT EXIST "%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config" goto endReadAdditionalConfig
@setlocal EnableExtensions EnableDelayedExpansion
for /F "usebackq delims=" %%a in ("%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config") do set JVM_CONFIG_MAVEN_PROPS=!JVM_CONFIG_MAVEN_PROPS! %%a
@endlocal & set JVM_CONFIG_MAVEN_PROPS=%JVM_CONFIG_MAVEN_PROPS%
:endReadAdditionalConfig
SET MAVEN_JAVA_EXE="%JAVA_HOME%\bin\java.exe"
set WRAPPER_JAR="%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.jar"
set WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain
set DOWNLOAD_URL="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.1.0/maven-wrapper-3.1.0.jar"
FOR /F "usebackq tokens=1,2 delims==" %%A IN ("%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties") DO (
IF "%%A"=="wrapperUrl" SET DOWNLOAD_URL=%%B
)
@REM Extension to allow automatically downloading the maven-wrapper.jar from Maven-central
@REM This allows using the maven wrapper in projects that prohibit checking in binary data.
if exist %WRAPPER_JAR% (
if "%MVNW_VERBOSE%" == "true" (
echo Found %WRAPPER_JAR%
)
) else (
if not "%MVNW_REPOURL%" == "" (
SET DOWNLOAD_URL="%MVNW_REPOURL%/org/apache/maven/wrapper/maven-wrapper/3.1.0/maven-wrapper-3.1.0.jar"
)
if "%MVNW_VERBOSE%" == "true" (
echo Couldn't find %WRAPPER_JAR%, downloading it ...
echo Downloading from: %DOWNLOAD_URL%
)
powershell -Command "&{"^
"$webclient = new-object System.Net.WebClient;"^
"if (-not ([string]::IsNullOrEmpty('%MVNW_USERNAME%') -and [string]::IsNullOrEmpty('%MVNW_PASSWORD%'))) {"^
"$webclient.Credentials = new-object System.Net.NetworkCredential('%MVNW_USERNAME%', '%MVNW_PASSWORD%');"^
"}"^
"[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12; $webclient.DownloadFile('%DOWNLOAD_URL%', '%WRAPPER_JAR%')"^
"}"
if "%MVNW_VERBOSE%" == "true" (
echo Finished downloading %WRAPPER_JAR%
)
)
@REM End of extension
@REM Provide a "standardized" way to retrieve the CLI args that will
@REM work with both Windows and non-Windows executions.
set MAVEN_CMD_LINE_ARGS=%*
%MAVEN_JAVA_EXE% ^
%JVM_CONFIG_MAVEN_PROPS% ^
%MAVEN_OPTS% ^
%MAVEN_DEBUG_OPTS% ^
-classpath %WRAPPER_JAR% ^
"-Dmaven.multiModuleProjectDirectory=%MAVEN_PROJECTBASEDIR%" ^
%WRAPPER_LAUNCHER% %MAVEN_CONFIG% %*
if ERRORLEVEL 1 goto error
goto end
:error
set ERROR_CODE=1
:end
@endlocal & set ERROR_CODE=%ERROR_CODE%
if not "%MAVEN_SKIP_RC%"=="" goto skipRcPost
@REM check for post script, once with legacy .bat ending and once with .cmd ending
if exist "%USERPROFILE%\mavenrc_post.bat" call "%USERPROFILE%\mavenrc_post.bat"
if exist "%USERPROFILE%\mavenrc_post.cmd" call "%USERPROFILE%\mavenrc_post.cmd"
:skipRcPost
@REM pause the script if MAVEN_BATCH_PAUSE is set to 'on'
if "%MAVEN_BATCH_PAUSE%"=="on" pause
if "%MAVEN_TERMINATE_CMD%"=="on" exit %ERROR_CODE%
cmd /C exit /B %ERROR_CODE%

62
gymboard-search/pom.xml Normal file
View File

@ -0,0 +1,62 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>3.0.2</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>nl.andrewlalis</groupId>
<artifactId>gymboard-search</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>gymboard-search</name>
<description>Search API for Gymboard</description>
<properties>
<java.version>17</java.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.postgresql</groupId>
<artifactId>postgresql</artifactId>
<scope>runtime</scope>
</dependency>
<!-- https://mvnrepository.com/artifact/org.apache.lucene/lucene-core -->
<dependency>
<groupId>org.apache.lucene</groupId>
<artifactId>lucene-core</artifactId>
<version>9.4.2</version>
</dependency>
<!-- https://mvnrepository.com/artifact/org.apache.lucene/lucene-spatial -->
<dependency>
<groupId>org.apache.lucene</groupId>
<artifactId>lucene-spatial</artifactId>
<version>8.4.1</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>

View File

@ -0,0 +1,15 @@
package nl.andrewlalis.gymboardsearch;
import java.io.IOException;
import java.io.InputStream;
import java.nio.charset.StandardCharsets;
public class DbUtils {
public static String loadClasspathString(String resourceName) throws IOException {
InputStream in = DbUtils.class.getResourceAsStream(resourceName);
if (in == null) throw new IOException("Resource " + resourceName + " not found.");
String s = new String(in.readAllBytes(), StandardCharsets.UTF_8);
in.close();
return s;
}
}

View File

@ -0,0 +1,24 @@
package nl.andrewlalis.gymboardsearch;
import nl.andrewlalis.gymboardsearch.index.GymIndexGenerator;
import org.springframework.boot.CommandLineRunner;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class GymboardSearchApplication implements CommandLineRunner {
private final GymIndexGenerator gymIndexGenerator;
public GymboardSearchApplication(GymIndexGenerator gymIndexGenerator) {
this.gymIndexGenerator = gymIndexGenerator;
}
public static void main(String[] args) {
SpringApplication.run(GymboardSearchApplication.class, args);
}
@Override
public void run(String... args) throws Exception {
gymIndexGenerator.generateIndex();
}
}

View File

@ -0,0 +1,23 @@
package nl.andrewlalis.gymboardsearch;
import nl.andrewlalis.gymboardsearch.dto.GymResponse;
import nl.andrewlalis.gymboardsearch.index.GymIndexSearcher;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import java.util.List;
@RestController
public class SearchController {
private final GymIndexSearcher gymIndexSearcher;
public SearchController(GymIndexSearcher gymIndexSearcher) {
this.gymIndexSearcher = gymIndexSearcher;
}
@GetMapping(path = "/search/gyms")
public List<GymResponse> searchGyms(@RequestParam(name = "q", required = false) String query) {
return gymIndexSearcher.searchGyms(query);
}
}

View File

@ -0,0 +1,26 @@
package nl.andrewlalis.gymboardsearch.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.cors.CorsConfiguration;
import org.springframework.web.cors.UrlBasedCorsConfigurationSource;
import org.springframework.web.filter.CorsFilter;
import java.util.Arrays;
@Configuration
public class WebConfig {
@Bean
public CorsFilter corsFilter() {
final UrlBasedCorsConfigurationSource source = new UrlBasedCorsConfigurationSource();
final CorsConfiguration config = new CorsConfiguration();
config.setAllowCredentials(true);
// Don't do this in production, use a proper list of allowed origins
config.addAllowedOriginPattern("*");
config.setAllowedHeaders(Arrays.asList("Origin", "Content-Type", "Accept"));
config.setAllowedMethods(Arrays.asList("GET", "POST", "PUT", "OPTIONS", "DELETE", "PATCH"));
source.registerCorsConfiguration("/**", config);
return new CorsFilter(source);
}
}

View File

@ -0,0 +1,29 @@
package nl.andrewlalis.gymboardsearch.dto;
import org.apache.lucene.document.Document;
public record GymResponse(
String shortName,
String displayName,
String cityShortName,
String cityName,
String countryCode,
String countryName,
String streetAddress,
double latitude,
double longitude
) {
public GymResponse(Document doc) {
this(
doc.get("short_name"),
doc.get("display_name"),
doc.get("city_short_name"),
doc.get("city_name"),
doc.get("country_code"),
doc.get("country_name"),
doc.get("street_address"),
doc.getField("latitude").numericValue().doubleValue(),
doc.getField("longitude").numericValue().doubleValue()
);
}
}

View File

@ -0,0 +1,74 @@
package nl.andrewlalis.gymboardsearch.index;
import nl.andrewlalis.gymboardsearch.DbUtils;
import org.apache.lucene.analysis.Analyzer;
import org.apache.lucene.analysis.standard.StandardAnalyzer;
import org.apache.lucene.document.*;
import org.apache.lucene.index.IndexWriter;
import org.apache.lucene.index.IndexWriterConfig;
import org.apache.lucene.store.Directory;
import org.apache.lucene.store.FSDirectory;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Service;
import org.springframework.util.FileSystemUtils;
import java.math.BigDecimal;
import java.nio.file.Files;
import java.nio.file.Path;
import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
@Service
public class GymIndexGenerator {
private static final Logger log = LoggerFactory.getLogger(GymIndexGenerator.class);
public void generateIndex() throws Exception {
log.info("Starting Gym index generation.");
Path gymIndexDir = Path.of("gym-index");
FileSystemUtils.deleteRecursively(gymIndexDir);
Files.createDirectory(gymIndexDir);
long count = 0;
try (
Connection conn = DriverManager.getConnection("jdbc:postgresql://localhost:5432/gymboard-api-dev", "gymboard-api-dev", "testpass");
PreparedStatement stmt = conn.prepareStatement(DbUtils.loadClasspathString("/sql/select-gyms.sql"));
ResultSet resultSet = stmt.executeQuery();
Analyzer analyzer = new StandardAnalyzer();
Directory indexDir = FSDirectory.open(gymIndexDir);
IndexWriter indexWriter = new IndexWriter(indexDir, new IndexWriterConfig(analyzer))
) {
while (resultSet.next()) {
String shortName = resultSet.getString("short_name");
String displayName = resultSet.getString("display_name");
String cityShortName = resultSet.getString("city_short_name");
String cityName = resultSet.getString("city_name");
String countryCode = resultSet.getString("country_code");
String countryName = resultSet.getString("country_name");
String streetAddress = resultSet.getString("street_address");
BigDecimal latitude = resultSet.getBigDecimal("latitude");
BigDecimal longitude = resultSet.getBigDecimal("longitude");
String gymCompoundId = String.format("%s/%s/%s", countryCode, cityShortName, shortName);
Document doc = new Document();
doc.add(new StoredField("compound_id", gymCompoundId));
doc.add(new TextField("short_name", shortName, Field.Store.YES));
doc.add(new TextField("display_name", displayName, Field.Store.YES));
doc.add(new TextField("city_short_name", cityShortName, Field.Store.YES));
doc.add(new TextField("city_name", cityName, Field.Store.YES));
doc.add(new TextField("country_code", countryCode, Field.Store.YES));
doc.add(new TextField("country_name", countryName, Field.Store.YES));
doc.add(new TextField("street_address", streetAddress, Field.Store.YES));
doc.add(new DoublePoint("latitude_point", latitude.doubleValue()));
doc.add(new StoredField("latitude", latitude.doubleValue()));
doc.add(new DoublePoint("longitude_point", longitude.doubleValue()));
doc.add(new StoredField("longitude", longitude.doubleValue()));
indexWriter.addDocument(doc);
count++;
}
}
log.info("Gym index generation complete. {} gyms indexed.", count);
}
}

View File

@ -0,0 +1,63 @@
package nl.andrewlalis.gymboardsearch.index;
import nl.andrewlalis.gymboardsearch.dto.GymResponse;
import org.apache.lucene.document.Document;
import org.apache.lucene.index.DirectoryReader;
import org.apache.lucene.index.Term;
import org.apache.lucene.search.*;
import org.apache.lucene.store.FSDirectory;
import org.springframework.stereotype.Service;
import java.io.IOException;
import java.nio.file.Path;
import java.util.*;
/**
* Searcher that uses a Lucene {@link IndexSearcher} to search for gyms using
* a query that's built from a weighted list of wildcard search terms.
* <ol>
* <li>If the query is blank, return an empty list.</li>
* <li>Split the query into words, append the wildcard '*' to each word.</li>
* <li>For each word, add a boosted wildcard query for each weighted field.</li>
* </ol>
*/
@Service
public class GymIndexSearcher {
public List<GymResponse> searchGyms(String rawQuery) {
if (rawQuery == null || rawQuery.isBlank()) return Collections.emptyList();
String[] terms = rawQuery.split("\\s+");
BooleanQuery.Builder queryBuilder = new BooleanQuery.Builder();
Map<String, Float> fieldWeights = new HashMap<>();
fieldWeights.put("short_name", 3f);
fieldWeights.put("display_name", 3f);
fieldWeights.put("city_short_name", 1f);
fieldWeights.put("city_name", 1f);
fieldWeights.put("country_code", 0.25f);
fieldWeights.put("country_name", 0.5f);
fieldWeights.put("street_address", 0.1f);
for (String term : terms) {
String searchTerm = term.strip() + "*";
for (var entry : fieldWeights.entrySet()) {
Query baseQuery = new WildcardQuery(new Term(entry.getKey(), searchTerm));
queryBuilder.add(new BoostQuery(baseQuery, entry.getValue()), BooleanClause.Occur.SHOULD);
}
}
BooleanQuery query = queryBuilder.build();
Path gymIndexDir = Path.of("gym-index");
try (
var reader = DirectoryReader.open(FSDirectory.open(gymIndexDir))
) {
IndexSearcher searcher = new IndexSearcher(reader);
List<GymResponse> results = new ArrayList<>(10);
TopDocs topDocs = searcher.search(query, 10, Sort.RELEVANCE, false);
for (ScoreDoc scoreDoc : topDocs.scoreDocs) {
Document doc = searcher.doc(scoreDoc.doc);
results.add(new GymResponse(doc));
}
return results;
} catch (IOException e) {
e.printStackTrace();
return Collections.emptyList();
}
}
}

View File

@ -0,0 +1 @@
server.port=8081

View File

@ -0,0 +1 @@

View File

@ -0,0 +1,14 @@
SELECT
gym.short_name as short_name,
gym.display_name as display_name,
city.short_name as city_short_name,
city.name as city_name,
country.code as country_code,
country.name as country_name,
gym.street_address as street_address,
gym.latitude as latitude,
gym.longitude as longitude
FROM gym
LEFT JOIN city on gym.city_short_name = city.short_name
LEFT JOIN country on gym.city_country_code = country.code
ORDER BY gym.created_at;

View File

@ -0,0 +1,13 @@
package nl.andrewlalis.gymboardsearch;
import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;
@SpringBootTest
class GymboardSearchApplicationTests {
@Test
void contextLoads() {
}
}