Download Brew Source as Text File #1198

G-Ambatte · 2021-01-20T11:22:49Z

Download Brew Source

Purpose

The purpose of this branch is to allow users to download the source of a brew as a plain text file.

Work Completed So Far

Create code module to output Brew source as a text file
Add a new page (download) to get the Brew source using its ID
Incorporate the "Download" option into nav bar on Share page
Incorporate download option in brew items on User page

Considerations

Lint/CircleCi - The 200 line maximum requires that the code for the new page is moved to a new module, which I have called sourceFunctions.jsx in the sharePage directory. It seemed logical to also move the code for the existing "source" page here as well, as large portions of the two functions are identical.
"Source" vs "Download Source" in Share page nav bar - I have changed the button text from "Source" to "View Source", to better differentiate the function of the two buttons.

Conclusion

This functionality has been requested previously (e.g. #1129, or this workaround in JS from Reddit). This also goes some way towards a user being able to download all of their brews at once, either as several text files or a single ZIP archive.

It's probably not the cleanest code I've ever written and it's well past midnight so I'm doing this with only one eye opened as I write this PR, so I'd appreciate any feedback that you might have.
-- G

EDIT: These changes should also fix the issue reported with the unmodified ampersand in the HTML source as reported in issue #1188. I added the check and replacement strings as a key/value array, so it should simplify adding any further items to be replaced in the future, if any more should be discovered.

Add detailed MongoDB Install instructions

Eliminate requirement to CD into project directory prior to running `npm start` or `node server.js`.

Adds a RC.d daemon script to control the HomeBrewery status. Based on Andrew Pearson's Node-RED script for the same purpose.

Switch to latest version of MongoDB

Add config items and default values: - web_port (8001) - environment (local)

Remove environment variables from rc.d as they are now in config/default.json.

Change to setting NODE_ENV; default to 'local' if not set via environment variable or in the config file.

Remove --force option from `npm audit fix`. While this has not caused any issues to date, there is no guarantee that it will continue to be the case.

Initial write up of install instructions. Includes instruction to `wget` from the `naturalcrit/homebrewery` project rather than the FreeBSD fork, on the assumption that the PR will be merged at some point.

Change to main project repo, on assumption that the PR will be merged at some point

Change of install directory to `/usr/local/homebrewery`

Add `dev_mode` to the HomeBrewery service, which starts the HomeBrewery project in live rebuild mode.

Eliminating unnecessary debugging code, reducing line count and making lint happy :)

Lint is happy, now attempting to pacify CircleCI

…lt.json

Change default port assignment from 8000 to 8001 in config.json and FreeBSD service config

Change to enable use of rcvars for NODE_ENV and PORT

Switch to latest version of MongoDB

Add config items and default values: - web_port (8001) - environment (local)

Remove environment variables from rc.d as they are now in config/default.json.

Change to setting NODE_ENV; default to 'local' if not set via environment variable or in the config file.

Remove --force option from `npm audit fix`. While this has not caused any issues to date, there is no guarantee that it will continue to be the case.

Change to main project repo, on assumption that the PR will be merged at some point

Change of install directory to `/usr/local/homebrewery`

Add `dev_mode` to the HomeBrewery service, which starts the HomeBrewery project in live rebuild mode.

… in server.js

… the brew for the source page. Moved `source` page generation function to a new function module. Added option to function to create plain text download with a sanitized filename and made it accessible from a new page: `download`. Added the `download` item to the BrewItem so it appears on each brew on the User page. Added `sanitize-filename` dependency to `package.json`.

…tter describes it's actual function

Remove new function from `Homebrew.Model.js` Remove `sourceFunctions.jsx` module

G-Ambatte · 2021-01-21T10:04:32Z

Shifted the functions back into server.js and removed both the unnecessary changes to Homebrew.Model.js and the new module. Only four files are now affected by this change, at least two of which are trivial changes.
At this point, I haven't got a working NaturalCrit login system yet, so I've been unable to test with a logged in user yet, and by extension, any of the GoogleActions.

Test functionality with Google brews

…tem.jsx to eliminate white flash on User page when clicking link to download source of a brew.

… functions

…ways visible. Adjust eslint line in `server.js` to re-enable the test with a slightly higher maximum value.

G-Ambatte · 2021-01-28T09:31:18Z

Test functionality with Google brews

Login system now working, including Google linking. Download confirmed working identically for Google-stored brews as it does for locally stored brews.

Discussion points:

Download filename prefix: Prefixing the filename with "Homebrewery-" makes for quite a long filename. Would this feature benefit from a shorter filename prefix, e.g. "HB-"?
Other issues: What else have I forgotten to consider?

…wery and Google brews. Concats switched to string literals to make Linter happy.

G-Ambatte · 2021-01-29T11:05:33Z

/download appears to be working correctly in all respects, for all brews - local and on Google drive.

calculuschild · 2021-03-07T05:38:03Z

@G-Ambatte Just need the config value for const prefix = config.get('name_prefix'); in server.js, since the config file is missing from this PR. Can you remind me what we wanted to use for that?

Gonna try to trim down the Server.js since a lot of stuff is duplicated between HB and Google brews (replacing < with &lt, prepping the file for download, etc). This does reveal a lot of other duplicated stuff in the other URLs as well so I might refactor those as well.

G-Ambatte · 2021-03-07T08:32:27Z

@G-Ambatte Just need the config value for const prefix = config.get('name_prefix'); in server.js, since the config file is missing from this PR. Can you remind me what we wanted to use for that?

I was using "Homebrewery' but Gazook89 suggested "HB", which I have no objections to. From memory, I moved it to a config item so it could easily be changed later but also so I didn't actually have to make that decision at the time.

calculuschild · 2021-03-09T21:27:09Z

Ok. I'm just cleaning up the duplicated functions a bit and then this can merge and go out with v2.11.0

G-Ambatte added 30 commits November 30, 2020 19:30

Merge pull request #1 from naturalcrit/master

f419430

Add detailed MongoDB Install instructions

Update server.js

d33ae2a

Eliminate requirement to CD into project directory prior to running `npm start` or `node server.js`.

Add rc.d daemon script

9965635

Adds a RC.d daemon script to control the HomeBrewery status. Based on Andrew Pearson's Node-RED script for the same purpose.

Create install.sh

65f4094

Update install.sh

88631ed

Update install.sh

897e7dc

Switch to latest version of MongoDB

Add config items

1224a54

Add config items and default values: - web_port (8001) - environment (local)

Remove environment variables from rc.d

e727f17

Remove environment variables from rc.d as they are now in config/default.json.

Update server.js

443094d

Change to setting NODE_ENV; default to 'local' if not set via environment variable or in the config file.

Remove --force option

d3fa8a5

Remove --force option from `npm audit fix`. While this has not caused any issues to date, there is no guarantee that it will continue to be the case.

Create README.FREEBSD.md

38e098f

Initial write up of install instructions. Includes instruction to `wget` from the `naturalcrit/homebrewery` project rather than the FreeBSD fork, on the assumption that the PR will be merged at some point.

Update install.sh

5d126ff

Change to main project repo, on assumption that the PR will be merged at some point

Change install directory

90fdc71

Change of install directory to `/usr/local/homebrewery`

Update homebrewery

ac8988a

Add `dev_mode` to the HomeBrewery service, which starts the HomeBrewery project in live rebuild mode.

Update server.js

7ca9d60

Eliminating unnecessary debugging code, reducing line count and making lint happy :)

Update server.js

bd41623

Lint is happy, now attempting to pacify CircleCI

Move NODE_ENV to service file; remove from server.js and config/defau…

e394539

…lt.json

Remove hanging comma in config.json

3af4316

Change default port assignment from 8000 to 8001 in config.json and FreeBSD service config

Add link to FreeBSD install documenation in the main README.md file

b0c1a5a

Fix for MongoDB package update breaking install script

03e74af

Change to enable use of rcvars for NODE_ENV and PORT

Create install.sh

1b9d46f

Update install.sh

96b976f

Update install.sh

4ee891a

Switch to latest version of MongoDB

Add config items

8887961

Add config items and default values: - web_port (8001) - environment (local)

Remove environment variables from rc.d

6423d90

Remove environment variables from rc.d as they are now in config/default.json.

Update server.js

e140b65

Change to setting NODE_ENV; default to 'local' if not set via environment variable or in the config file.

Remove --force option

ea555eb

Remove --force option from `npm audit fix`. While this has not caused any issues to date, there is no guarantee that it will continue to be the case.

Update install.sh

8677994

Change to main project repo, on assumption that the PR will be merged at some point

Change install directory

4484cc7

Change of install directory to `/usr/local/homebrewery`

Update homebrewery

ed34b65

Add `dev_mode` to the HomeBrewery service, which starts the HomeBrewery project in live rebuild mode.

G-Ambatte added 8 commits January 17, 2021 17:23

Merge branch 'master' of https://github.com/G-Ambatte/homebrewery

717a588

Initial commit

715ddf2

Shift functionality to new file in attempt to reduce code duplication…

7fccb7e

… in server.js

Rename sanitizeHtml function to escapeTextForHtmlDisplay which be…

8060ed5

…tter describes it's actual function

Catch zero length filenames

0e8348f

Integrated download function into server.js

5c7a9c9

Remove new function from `Homebrew.Model.js` Remove `sourceFunctions.jsx` module

Fixes from Linter

06223d5

G-Ambatte added 6 commits January 22, 2021 13:56

Expand source text escaping/processing for improved readability

21f08c9

(WIP) Remove target=_blank and rel=noopener noreferrer from brewI…

4073536

…tem.jsx to eliminate white flash on User page when clicking link to download source of a brew.

(WIP) Unwinding refactoring to improve clarity and readability of new…

da32845

… functions

Unwinding refactored code + corrections.

6d219aa

Lint corrections

d88b047

Increase minimum height of brewItem in CSS so all four items are al…

bcbf596

…ways visible. Adjust eslint line in `server.js` to re-enable the test with a slightly higher maximum value.

calculuschild added this to the v2.11.0 milestone Jan 24, 2021

G-Ambatte added 2 commits January 28, 2021 23:13

Move filename prefix to configurable item in config/default.json

051773a

Prefix loading successfully from config/local.json for both Homebre…

c3bfd1e

…wery and Google brews. Concats switched to string literals to make Linter happy.

calculuschild added 2 commits March 6, 2021 22:42

Merge branch 'master' into pr/1198

08492b9

Tweaks to work with current Master

c4db94e

Hardcode prefix

6a12518

calculuschild changed the base branch from master to PRODUCTION March 13, 2021 03:26

calculuschild changed the base branch from PRODUCTION to master March 13, 2021 03:26

calculuschild merged commit 24957c6 into naturalcrit:master Mar 13, 2021

G-Ambatte deleted the sourceDL branch August 8, 2023 00:17

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Download Brew Source as Text File #1198

Download Brew Source as Text File #1198

G-Ambatte commented Jan 20, 2021 •

edited

Loading

G-Ambatte commented Jan 21, 2021

G-Ambatte commented Jan 28, 2021

G-Ambatte commented Jan 29, 2021

calculuschild commented Mar 7, 2021

G-Ambatte commented Mar 7, 2021

calculuschild commented Mar 9, 2021

Download Brew Source as Text File #1198

Download Brew Source as Text File #1198

Conversation

G-Ambatte commented Jan 20, 2021 • edited Loading

Download Brew Source

Purpose

Work Completed So Far

Considerations

Conclusion

G-Ambatte commented Jan 21, 2021

G-Ambatte commented Jan 28, 2021

G-Ambatte commented Jan 29, 2021

calculuschild commented Mar 7, 2021

G-Ambatte commented Mar 7, 2021

calculuschild commented Mar 9, 2021

G-Ambatte commented Jan 20, 2021 •

edited

Loading