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,59 @@ | ||
| <template> | ||
| <div class="codebox"> | ||
| <pre v-highlightjs> | ||
| <code :class="language" :id="componentId">{{ code }}</code> | ||
| </pre> | ||
| <CopyButton variant="primary" :copyText="code">{{ $t('copy') }}</CopyButton> | ||
| </div> | ||
| </template> | ||
|
|
||
| <script> | ||
| export default { | ||
| name: "CodeBox", | ||
| components: { | ||
| CopyButton: () => import("./CopyButton.vue") | ||
| }, | ||
| props: { | ||
|
There was a problem hiding this comment. Both props should probably be required. |
||
| code: { | ||
| type: String, | ||
| default: "", | ||
| }, | ||
|
|
||
| language: { | ||
| type: String, | ||
| default: "", | ||
| }, | ||
| }, | ||
| data() { | ||
| return { | ||
| componentId: `${this.language}Content` | ||
| }; | ||
| }, | ||
| }; | ||
| </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 |
|---|---|---|
| @@ -0,0 +1,109 @@ | ||
| <template> | ||
| <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-tabs> | ||
| </template> | ||
|
|
||
| <script> | ||
| import { BTabs, BTab } from 'bootstrap-vue'; | ||
| export default { | ||
| name: "SearchCode", | ||
| components: { | ||
| BTab, | ||
| BTabs, | ||
| CodeBox: () => import('./CodeBox.vue'), | ||
| }, | ||
| props: { | ||
| catalogHref: { | ||
| type: String, | ||
| default: '', | ||
| }, | ||
| filters: { | ||
| type: Object, | ||
| default() { | ||
| return {}; | ||
| }, | ||
| }, | ||
| }, | ||
| data() { | ||
| return { | ||
| componentId: `${this.language}Content`, | ||
|
|
||
| pythonCode: null, | ||
| javascriptCode: null, | ||
| rCode: null | ||
|
|
||
| }; | ||
| }, | ||
| watch: { | ||
| filters: { | ||
| deep: true, | ||
| handler() { | ||
| this.updateCode(); | ||
| } | ||
| } | ||
| }, | ||
| created() { | ||
| this.updateCode(); | ||
| }, | ||
| methods: { | ||
| dedent(str) { | ||
|
There was a problem hiding this comment. This dedents a bit too much, the JS code is not indented at all, which looks rather weird. |
||
| const lines = str.split('\n').map(line => line.trim()); | ||
| return lines.join('\n').trim(); | ||
| }, | ||
| filterString() { | ||
| 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 this.dedent(`from pystac_client import Client | ||
|
|
||
| # Connect to STAC API | ||
| stac_endpoint = '${this.catalogHref}' | ||
| client = Client.open(stac_endpoint) | ||
|
|
||
| # Build query | ||
| query = ${this.filterString()} | ||
|
|
||
| # Perform search | ||
| search_result = client.search(query)`); | ||
| }, | ||
| generateJavascript() { | ||
| return this.dedent(`// Define the STAC API endpoint | ||
| const STAC_ENDPOINT = '${this.catalogHref}'; | ||
|
|
||
| // 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); | ||
| });`); | ||
| }, | ||
| updateCode() { | ||
|
There was a problem hiding this comment. It might be a bit better to only generate what's shown, not everything upfront, especially if we extend this. |
||
| this.pythonCode = this.generatePython(); | ||
| this.javascriptCode = this.generateJavascript(); | ||
| } | ||
| }, | ||
| }; | ||
| </script> | ||
|
|
||
| <style scoped> | ||
| </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
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
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.
Can this be registered so that it doesn't import into the global bundle? Ideally this would only be loaded if needed.
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.
Maybe you could say a bit more - I'm new to Vue, so some of the concepts here require me to squint a bit more than others might
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.
This should only be imported in the CodeBox component and not use Vue.use. I'm not sure whether this library supports this though.
Similarly, the Bootstrap Badges should also be imported individually where the are used. I think there should be examples around in the code if you search for the BBadge component.
I'm a bit busy right now so can't elaborate further at this point.
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.
I think I follow you - just been using python and jvm lingo for long enough that 'global bundle' tripped me up. Also, I think the badge plugin is from prior work and I accidentally shifted its order to the diff's confusion
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.
Global Bundle is probably also not the right terminology. I think better is "app bundle" or "initially loaded files". I pretty much just want that it is lazily loaded when needed, not everytime the page loads. :-)