Code example generation for search page #381
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| <template> | ||
| <div class="codebox"> | ||
| <pre v-highlightjs> | ||
| <code :class="language" :id="componentId"> | ||
| {{ code }} | ||
| </code> | ||
| </pre> | ||
| <button ref="copyButton" :data-clipboard-target="'#' + componentId">Copy</button> | ||
| </div> | ||
| </template> | ||
|
|
||
| <script> | ||
| import Clipboard from 'clipboard'; | ||
|
|
||
| export default { | ||
| name: "CodeBox", | ||
| props: { | ||
|
There was a problem hiding this comment. Both props should probably be required. |
||
| code: String, | ||
| language: String | ||
| }, | ||
| data() { | ||
| return { | ||
| componentId: `${this.language}Content` | ||
| } | ||
| }, | ||
| mounted() { | ||
| new Clipboard(this.$refs.copyButton); | ||
| }, | ||
| }; | ||
| </script> | ||
|
|
||
| <style scoped> | ||
| .codebox { | ||
| border: 1px solid #ccc; | ||
| padding: 16px; | ||
| border-radius: 8px; | ||
| } | ||
| .codebox button { | ||
| background-color: #007BFF; | ||
| color: #FFF; | ||
| padding: 5px 15px; | ||
| border: none; | ||
| border-radius: 5px; | ||
| cursor: pointer; | ||
| transition: background-color 0.3s; | ||
| } | ||
|
|
||
| .codebox button:hover { | ||
| background-color: #0056b3; | ||
| } | ||
| .codebox pre, .codebox code { | ||
| padding: 0; | ||
| margin: 0; | ||
| } | ||
|
|
||
| </style> | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -17,40 +17,58 @@ | |
| @input="setFilters" | ||
| /> | ||
| </b-tab> | ||
|
|
||
| </b-tabs> | ||
| </b-col> | ||
| <b-col class="right"> | ||
| <b-alert v-if="error" variant="error" show>{{ error }}</b-alert> | ||
| <Loading v-else-if="!data && loading" fill top /> | ||
| <b-alert v-else-if="data === null" variant="info" show>{{ $t('search.modifyCriteria') }}</b-alert> | ||
| <b-alert v-else-if="results.length === 0" variant="warning" show>{{ $t('search.noItemsFound') }}</b-alert> | ||
| <template v-else> | ||
| <b-row> | ||
| <b-col class="left"> | ||
| <b-tabs> | ||
| <b-tab title="Python"> | ||
| <CodeBox :code="pythonCode" language="python" /> | ||
| </b-tab> | ||
| <b-tab title="Javascript"> | ||
| <CodeBox :code="javascriptCode" language="javascript" /> | ||
| </b-tab> | ||
| <b-tab title="R"> | ||
| <CodeBox :code="rCode" language="r" /> | ||
| </b-tab> | ||
| </b-tabs> | ||
| </b-col> | ||
| <b-col class="right"> | ||
| <div id="search-map" v-if="itemCollection"> | ||
| <Map :stac="stac" :stacLayerData="itemCollection" scrollWheelZoom popover /> | ||
| </div> | ||
| </b-col> | ||
| </b-row> | ||
| <Catalogs | ||
| v-if="isCollectionSearch" :catalogs="results" collectionsOnly | ||
| :pagination="pagination" :loading="loading" @paginate="loadResults" | ||
| :count="totalCount" | ||
| > | ||
| <template #catalogFooter="slot"> | ||
| <b-button-group v-if="itemSearch || canFilterItems(slot.data)" vertical size="sm"> | ||
| <b-button v-if="itemSearch" variant="outline-primary" :pressed="selectedCollections[slot.data.id]" @click="selectForItemSearch(slot.data)"> | ||
| <b-icon-check-square v-if="selectedCollections[slot.data.id]" /> | ||
| <b-icon-square v-else /> | ||
| <span class="ml-2">{{ $t('search.selectForItemSearch') }}</span> | ||
| </b-button> | ||
| <StacLink :button="{variant: 'outline-primary', disabled: !canFilterItems(slot.data)}" :data="slot.data" :title="$t('search.filterCollection')" :state="{itemFilterOpen: 1}" /> | ||
| </b-button-group> | ||
| </template> | ||
| </Catalogs> | ||
| <Items | ||
| v-else | ||
| :stac="stac" :items="results" :api="true" :allowFilter="false" | ||
| :pagination="pagination" :loading="loading" @paginate="loadResults" | ||
| :count="totalCount" | ||
| /> | ||
| </template> | ||
| </b-col> | ||
| </b-row> | ||
| <b-alert v-if="selectedCollectionCount > 0" show variant="dark" class="selected-collections-action"> | ||
|
|
@@ -78,6 +96,7 @@ export default { | |
| BTab, | ||
| BTabs, | ||
| Catalogs: () => import('../components/Catalogs.vue'), | ||
| CodeBox: () => import('../components/CodeBox.vue'), | ||
| Loading, | ||
| Items: () => import('../components/Items.vue'), | ||
| Map: () => import('../components/Map.vue'), | ||
|
|
@@ -102,7 +121,11 @@ export default { | |
| itemFilters: {}, | ||
| collectionFilters: {}, | ||
| activeSearch: 0, | ||
| selectedCollections: {}, | ||
|
|
||
| pythonCode: null, | ||
| javascriptCode: null, | ||
| rCode: null | ||
| }; | ||
| }, | ||
| computed: { | ||
|
|
@@ -237,13 +260,90 @@ export default { | |
| } | ||
| return false; | ||
| }, | ||
| filterString() { | ||
|
There was a problem hiding this comment. Ideally all the code related to the code generation etc. should be in a separate component, not in the Search component. There was a problem hiding this comment. Actually, even better would be to have model classes for code generation. One method per use case and one class per language. Similarly to what I did here for another project: https://github.com/Open-EO/openeo-web-editor/tree/master/src/export All UI related stuff should still be in the Vue Component, of course. So really just the code generation in classes. |
||
| let obj = this.filters || {} | ||
| for (let key in obj) { | ||
| if (obj[key] === null || (Array.isArray(obj[key]) && obj[key].length === 0)) { | ||
| delete obj[key]; | ||
| } | ||
| } | ||
| return JSON.stringify(obj) | ||
| }, | ||
| generatePython() { | ||
| return ` | ||
| from pystac_client import Client | ||
|
|
||
| # Connect to STAC API | ||
| stac_endpoint = '${this.searchLink.href}' | ||
| client = Client.open(stac_endpoint) | ||
|
|
||
| # Build query | ||
| query = ${this.filterString()} | ||
|
|
||
| # Perform search | ||
| search_result = client.search(query) | ||
| ` | ||
| }, | ||
| generateJavascript() { | ||
| return ` | ||
| // Define the STAC API endpoint | ||
| const STAC_ENDPOINT = '${this.searchLink.href}'; | ||
|
|
||
| // Define your search parameters | ||
| const searchParams = ${this.filterString()}; | ||
|
|
||
| // Perform the search | ||
| fetch(STAC_ENDPOINT, { | ||
| method: "POST", | ||
| headers: { | ||
| "Content-Type": "application/json" | ||
| }, | ||
| body: JSON.stringify(searchParams) | ||
| }) | ||
| .then(response => response.json()) | ||
| .then(data => { | ||
| console.log("STAC search results:", data); | ||
| }) | ||
| .catch(error => { | ||
| console.error("Error fetching STAC data:", error); | ||
| }); | ||
| ` | ||
| }, | ||
| generateR() { | ||
| let filterString = JSON.stringify(this.filters || {}) | ||
| return ` | ||
| from pystac_client import Client | ||
|
|
||
| # Connect to STAC API | ||
| stac_api_url = '${this.searchLink}' | ||
| client = Client.open(stac_api_url) | ||
|
|
||
| # Build query | ||
| query = ${filterString} | ||
|
|
||
| # Perform search | ||
| search_result = client.search(query) | ||
| ` | ||
| }, | ||
| updateCode() { | ||
| this.pythonCode = this.generatePython() | ||
| this.javascriptCode = this.generateJavascript() | ||
| this.rCode = this.generateR() | ||
| }, | ||
| async loadResults(link) { | ||
| this.error = null; | ||
| this.loading = true; | ||
| try { | ||
| this.link = Utils.addFiltersToLink(link, this.filters, this.itemsPerPage); | ||
| console.log("link", this.link) | ||
| this.pythonCode = this.generatePython(this.link) | ||
| this.javascriptCode = this.generateJavascript(this.link) | ||
| this.rCode = this.generateR(this.link) | ||
|
|
||
| let key = this.isCollectionSearch ? 'collections' : 'features'; | ||
| // console.log(1, this.$store) | ||
| // console.log(2, this.link) | ||
| // console.log(3, key) | ||
| let response = await stacRequest(this.$store, this.link); | ||
| if (response) { | ||
| this.showPage(response.config.url); | ||
|
|
@@ -274,6 +374,7 @@ export default { | |
| } | ||
| else { | ||
| await this.loadResults(this.searchLink); | ||
| this.updateCode(this.searchLink) | ||
| } | ||
| }, | ||
| showPage(url) { | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We already use v-clipboard, can you re-use that instead of a new/this dependency?