NAME
bpom-tampilkan-ing - Render BPOM-compliant nutrition fact table (ING - informasi nilai gizi) in various formats
VERSION
This document describes version 0.025 of bpom-tampilkan-ing (from Perl distribution App-BPOMUtils-NutritionFacts), released on 2024-01-30.
SYNOPSIS
bpom-tampilkan-ing --help (or -h, -?)
bpom-tampilkan-ing --version (or -v)
bpom-tampilkan-ing [--browser] [--carbohydrate=ufloat] [--color=str] [--config-path=path|-c|--no-config|-C] [--config-profile=profile|-P] [--debug|--log-level=level|--quiet|--trace|--verbose] [--fat=ufloat] [--format=name|--json] [--(no)naked-res] [--name=str] [--no-env] [--output-format=str|-f=str] [--package-size=ufloat] [--page-result[=program]|--view-result[=program]] [--protein=ufloat] [--saturated-fat=ufloat] [--serving-size=ufloat] [--sodium=ufloat|--salt=ufloat] [--sugar=ufloat]
See examples in the "EXAMPLES" section.
OPTIONS
* marks required options.
Main options
- --carbohydrate=s*
-
Total carbohydrate, in g/100g.
- --fat=s*
-
Total fat, in g/100g.
- --name=s
-
(No description)
- --package-size=s*
-
Packaging size, in g.
- --protein=s*
-
Protein, in g/100g.
- --saturated-fat=s*
-
Saturated fat, in g/100g.
- --serving-size=s*
-
Serving size, in g.
- --sodium=s*, --salt
-
Sodium, in mg/100g.
- --sugar=s*
-
Total sugar, in g/100g.
Configuration options
- --config-path=s, -c
-
Set path to configuration file.
Can actually be specified multiple times to instruct application to read from multiple configuration files (and merge them).
- --config-profile=s, -P
-
Set configuration profile to use.
A single configuration file can contain profiles, i.e. alternative sets of values that can be selected. For example:
[profile=dev] username=foo pass=beaver [profile=production] username=bar pass=honeyWhen you specify
--config-profile=dev,usernamewill be set tofooandpasswordtobeaver. When you specify--config-profile=production,usernamewill be set tobarandpasswordtohoney. - --no-config, -C
-
Do not use any configuration file.
If you specify
--no-config, the application will not read any configuration file.
Environment options
- --no-env
-
Do not read environment for default options.
If you specify
--no-env, the application wil not read any environment variable.
Logging options
- --debug
-
Shortcut for --log-level=debug.
- --log-level=s
-
Set log level.
By default, these log levels are available (in order of increasing level of importance, from least important to most):
trace,debug,info,warn/warning,error,fatal. By default, the level is usually set towarn, which means that log statements with levelinfoand less important levels will not be shown. To increase verbosity, chooseinfo,debug, ortrace.For more details on log level and logging, as well as how new logging levels can be defined or existing ones modified, see Log::ger.
- --quiet
-
Shortcut for --log-level=error.
- --trace
-
Shortcut for --log-level=trace.
- --verbose
-
Shortcut for --log-level=info.
Output options
- --browser
-
View output HTML in browser instead of returning it.
- --color=s
-
Default value:
"auto"Valid values:
["always","auto","never"] - --format=s
-
Choose output format, e.g. json, text.
Default value:
undefOutput can be displayed in multiple formats, and a suitable default format is chosen depending on the application and/or whether output destination is interactive terminal (i.e. whether output is piped). This option specifically chooses an output format.
- --json
-
Set output format to json.
- --naked-res
-
When outputing as JSON, strip result envelope.
Default value:
0By default, when outputing as JSON, the full enveloped result is returned, e.g.:
[200,"OK",[1,2,3],{"func.extra"=>4}]The reason is so you can get the status (1st element), status message (2nd element) as well as result metadata/extra result (4th element) instead of just the result (3rd element). However, sometimes you want just the result, e.g. when you want to pipe the result for more post-processing. In this case you can use
--naked-resso you just get:[1,2,3] - --output-format=s, -f
-
Pick an output format for the nutrition fact.
Default value:
"vertical_text_table"Valid values:
["raw_table","vertical_html_table","vertical_text_table","linear_html","linear_text","raw_linear","calculation_html","calculation_text"]vertical_text_tableis the default. The /(vertical)?.*table/ formats presents the information in a table, while the /linear/ formats presents the information in a paragraph. - --page-result
-
Filter output through a pager.
This option will pipe the output to a specified pager program. If pager program is not specified, a suitable default e.g.
lessis chosen. - --view-result
-
View output using a viewer.
This option will first save the output to a temporary file, then open a viewer program to view the temporary file. If a viewer program is not chosen, a suitable default, e.g. the browser, is chosen.
Other options
COMPLETION
This script has shell tab completion capability with support for several shells.
bash
To activate bash completion for this script, put:
complete -C bpom-tampilkan-ing bpom-tampilkan-ingin your bash startup (e.g. ~/.bashrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.
It is recommended, however, that you install modules using cpanm-shcompgen which can activate shell completion for scripts immediately.
tcsh
To activate tcsh completion for this script, put:
complete bpom-tampilkan-ing 'p/*/`bpom-tampilkan-ing`/'in your tcsh startup (e.g. ~/.tcshrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.
It is also recommended to install shcompgen (see above).
other shells
For fish and zsh, install shcompgen as described above.
CONFIGURATION FILE
This script can read configuration files. Configuration files are in the format of IOD, which is basically INI with some extra features.
By default, these names are searched for configuration filenames (can be changed using --config-path): /home/u1/.config/bpom-tampilkan-ing.conf, /home/u1/bpom-tampilkan-ing.conf, or /etc/bpom-tampilkan-ing.conf.
All found files will be read and merged.
To disable searching for configuration files, pass --no-config.
You can put multiple profiles in a single file by using section names like [profile=SOMENAME] or [SOMESECTION profile=SOMENAME]. Those sections will only be read if you specify the matching --config-profile SOMENAME.
You can also put configuration for multiple programs inside a single file, and use filter program=NAME in section names, e.g. [program=NAME ...] or [SOMESECTION program=NAME]. The section will then only be used when the reading program matches.
You can also filter a section by environment variable using the filter env=CONDITION in section names. For example if you only want a section to be read if a certain environment variable is true: [env=SOMEVAR ...] or [SOMESECTION env=SOMEVAR ...]. If you only want a section to be read when the value of an environment variable equals some string: [env=HOSTNAME=blink ...] or [SOMESECTION env=HOSTNAME=blink ...]. If you only want a section to be read when the value of an environment variable does not equal some string: [env=HOSTNAME!=blink ...] or [SOMESECTION env=HOSTNAME!=blink ...]. If you only want a section to be read when the value of an environment variable includes some string: [env=HOSTNAME*=server ...] or [SOMESECTION env=HOSTNAME*=server ...]. If you only want a section to be read when the value of an environment variable does not include some string: [env=HOSTNAME!*=server ...] or [SOMESECTION env=HOSTNAME!*=server ...]. Note that currently due to simplistic parsing, there must not be any whitespace in the value being compared because it marks the beginning of a new section filter or section name.
To load and configure plugins, you can use either the -plugins parameter (e.g. -plugins=DumpArgs or -plugins=DumpArgs@before_validate_args), or use the [plugin=NAME ...] sections, for example:
[plugin=DumpArgs]
-event=before_validate_args
-prio=99
[plugin=Foo]
-event=after_validate_args
arg1=val1
arg2=val2which is equivalent to setting -plugins=-DumpArgs@before_validate_args@99,-Foo@after_validate_args,arg1,val1,arg2,val2.
List of available configuration parameters:
browser (see --browser)
carbohydrate (see --carbohydrate)
color (see --color)
fat (see --fat)
format (see --format)
log_level (see --log-level)
naked_res (see --naked-res)
name (see --name)
output_format (see --output-format)
package_size (see --package-size)
protein (see --protein)
saturated_fat (see --saturated-fat)
serving_size (see --serving-size)
sodium (see --sodium)
sugar (see --sugar)ENVIRONMENT
BPOM_TAMPILKAN_ING_OPT
String. Specify additional command-line options.
FILES
/home/u1/.config/bpom-tampilkan-ing.conf
/home/u1/bpom-tampilkan-ing.conf
/etc/bpom-tampilkan-ing.conf
EXAMPLES
An example, in linear text format (color/emphasis is shown with markup)
% bpom-tampilkan-ing --carbohydrate 13.113 --color never --fat 0.223 --output-format raw_linear --package-size 20 --protein 0.99 --saturated-fat 0.01 --serving-size 175 --sodium 0.223 --sugar 7.173
*INFORMASI NILAI GIZI* *JUMLAH PER KEMASAN (20 g)* : *Energi total 10 kkal*, Energi dari lemak 0 kkal, Energi dari lemak jenuh 0 kkal, *Lemak total 0 g (0% AKG)*, *Lemak jenuh 0 g (0% AKG)*, *Protein 0 g (0% AKG)*, *Karbohidrat total 3 g (1% AKG)*, *Gula 1 g*, *Garam (Natrium) 0 mg (0% AKG)*. /Persen AKG berdasarkan kebutuhan energi 2150 kkal. Kebutuhan energi Anda mungkin lebih tinggi atau lebih rendah./An example, in raw_linear format (just like linear_text but with no border)
% bpom-tampilkan-ing --carbohydrate 13.113 --color never --fat 0.223 --output-format linear_text --package-size 20 --protein 0.99 --saturated-fat 0.01 --serving-size 175 --sodium 0.223 --sugar 7.173
.---------------------------------------------------------------------------------.
| *INFORMASI NILAI GIZI* *JUMLAH PER KEMASAN (20 g)* : *Energi total 10 kkal*, |
| Energi dari lemak 0 kkal, Energi dari lemak jenuh 0 kkal, *Lemak total 0 g (0% |
| AKG)*, *Lemak jenuh 0 g (0% AKG)*, *Protein 0 g (0% AKG)*, *Karbohidrat total 3 |
| g (1% AKG)*, *Gula 1 g*, *Garam (Natrium) 0 mg (0% AKG)*. /Persen AKG |
| berdasarkan kebutuhan energi 2150 kkal. Kebutuhan energi Anda mungkin lebih |
| tinggi atau lebih rendah./ |
`---------------------------------------------------------------------------------'The same example in vertical HTML table format
% bpom-tampilkan-ing --carbohydrate 13.113 --fat 0.223 --output-format vertical_html_table --package-size 20 --protein 0.99 --saturated-fat 0.01 --serving-size 175 --sodium 0.223 --sugar 7.173
<style>
table.vertical_html_table { border-collapse: collapse; border: solid 1pt black; }
table.vertical_html_table tr.has_bottom_border { border-bottom: solid 1pt black; }
</style>
<table class="vertical_html_table"><colgroup><col style="width:16pt;"><col style="width:200pt;"><col style="width:48pt;"><col style="width:48pt;"><col style="width:36pt;"></colgroup>
<tbody>
<tr><td colspan=5 align="middle"><b>INFORMASI NILAI GIZI</b></td></tr>
<tr><td colspan=5></td></tr>
<tr><td colspan=5 align="left"><b>JUMLAH PER KEMASAN (20 g)</b></td></tr>
<tr class=has_bottom_border><td colspan=5><b>Energi total 10 kkal</b></td></tr>
<tr><td colspan=3></td><td colspan=2 align="middle"><b>% AKG</b>*</td></tr>
<tr><td colspan=2><b>Lemak total</b></td><td align="right"><b>0 g</b></td><td align="right">0 %</td><td></td></tr>
<tr><td colspan=2><b>Lemak jenuh</b></td><td align="right"><b>0 g</b></td><td align="right">0 %</td><td></td></tr>
<tr><td colspan=2><b>Protein</b></td><td align="right"><b>0 g</b></td><td align="right">0 %</td><td></td></tr>
<tr><td colspan=2><b>Karbohidrat total</b></td><td align="right"><b>3 g</b></td><td align="right">1 %</td><td></td></tr>
<tr><td colspan=2><b>Gula</b></td><td align="right"><b>1 g</b></td><td></td><td></td></tr>
<tr class=has_bottom_border><td colspan=2><b>Garam (Natrium)</b></td><td align="right"><b>0 mg</b></td><td align="right">0 %</td><td></td></tr>
<tr><td colspan=5><i>*Persen AKG berdasarkan kebutuhan energi 2150 kkal. Kebutuhan energi Anda mungkin lebih tinggi atau lebih rendah.</i></td></tr>
</tbody>
</table>The same example, in vertical text format (color/emphasis is shown with markup)
% bpom-tampilkan-ing --carbohydrate 13.113 --color never --fat 0.223 --output-format vertical_text_table --package-size 20 --protein 0.99 --saturated-fat 0.01 --serving-size 175 --sodium 0.223 --sugar 7.173
.---------------------------------------------------------------------------------------------------------------------.
| *INFORMASI NILAI GIZI* |
| |
| *JUMLAH PER KEMASAN (20 g)* |
| *Energi total 10 kkal* |
+-----------------------|----------------------|-----------------------+----------------------|-----------------------+
| | *% AKG** |
| *Lemak total* | *0 g* | 0 % | |
| *Lemak jenuh* | *0 g* | 0 % | |
| *Protein* | *0 g* | 0 % | |
| *Karbohidrat total* | *3 g* | 1 % | |
| *Gula* | *1 g* | | |
| *Garam (Natrium)* | *0 mg* | 0 % | |
+-----------------------|----------------------+-----------------------+----------------------+-----------------------+
| /*Persen AKG berdasarkan kebutuhan energi 2150 kkal. Kebutuhan energi Anda mungkin lebih tinggi atau lebih rendah./ |
`---------------------------------------------------------------------------------------------------------------------'The same example, in calculation text format
% bpom-tampilkan-ing --carbohydrate 13.113 --color never --fat 0.223 --output-format calculation_text --package-size 20 --protein 0.99 --saturated-fat 0.01 --serving-size 175 --sodium 0.223 --sugar 7.173
.-------------------------------------------------------------------------------------------------------------------------------------------------------------------------.
| *PERHITUNGAN INFORMASI NILAI GIZI* |
| *Energi total* |
| Energi total per 100 g | = lemak × 9 + protein × 4 + karbohidrat × 4 = 0.223 × 9 + 0.99 × 4 + 13.113 × 4 = 58.419 kkal |
| Energi total per kemasan 20 g | = 58.419 × 20 / 100 = 11.6838 kkal |
| (dibulatkan: <5 -> 0, <=50 -> 5 kkal terdekat, >50 -> 10 kkal terdekat) | = *10* kkal |
| | |
| *%AKG energi total* |
| %AKG | = 11.6838 / 2150 × 100 = 0.543432558139535 |
| (dibulatkan ke % terdekat) | = *1* |
| *Energi dari lemak* |
| Energi dari lemak per 100 g | = lemak × 9 = 0.223 × 9 = 2.007 kkal |
| Energi dari lemak per kemasan 20 g | = 2.007 × 20 / 100 = 3.51225 kkal |
| (dibulatkan: <5 -> 0, <=50 -> 5 kkal terdekat, >50 -> 10 kkal terdekat) | = *0* kkal |
| *Energi dari lemak jenuh* |
| Energi dari lemak per 100 g | = lemak jenuh × 9 = 0.01 × 9 = 0.09 kkal |
| Energi dari lemak jenuh per kemasan 20 g | = 0.09 × 20 / 100 = 0.018 kkal |
| (dibulatkan: <5 -> 0, <=50 -> 5 kkal terdekat, >50 -> 10 kkal terdekat) | = *0* kkal |
| *Lemak total* |
| Lemak total per 100 g | = 0.223 g |
| Lemak total per kemasan 20 g | = 0.223 × 20 / 100 = 0.0446 g |
| (dibulatkan: <0.5 -> 0, <=5 -> 0.5 g terdekat, >=5 -> 1 g terdekat) | = *0* g |
| | |
| *%AKG lemak total* |
| %AKG | = 0.0446 / 67 × 100 = 0.0665671641791045 |
| (dibulatkan ke % terdekat) | = *0* |
| *Lemak jenuh* |
| Lemak jenuh per 100 g | = 0.01 g |
| Lemak jenuh per kemasan 20 g | = 0.01 × 20 / 100 = 0.002 g |
| (dibulatkan: <0.5 -> 0, <=5 -> 0.5 g terdekat, >=5 -> 1 g terdekat) | = *0* g |
| | |
| *%AKG lemak jenuh* |
| %AKG | = 0.002 / 67 × 100 = 0.01 |
| (dibulatkan ke % terdekat) | = *0* |
| *Protein* |
| Protein per 100 g | = 0.99 g |
| Protein total per kemasan 20 g | = 0.99 × 20 / 100 = 0.198 g |
| (dibulatkan: <0.5 -> 0, >=0.5 -> 1 g terdekat) | = *0* g |
| | |
| *%AKG protein* |
| %AKG | = 0.198 / 60 × 100 = 0.33 |
| (dibulatkan ke % terdekat) | = *0* |
| *Karbohidrat total* |
| Karbohidrat total per 100 g | = 13.113 g |
| Karbohidrat total per kemasan 20 g | = 13.113 × 20 / 100 = 2.6226 g |
| (dibulatkan: <0.5 -> 0, >=0.5 -> 1 g terdekat) | = *3* g |
| | |
| *%AKG karbohidrat total* |
| %AKG | = 2.6226 / 325 × 100 = 0.0665671641791045 |
| (dibulatkan ke % terdekat) | = *1* |
| *Gula* |
| Gula per 100 g | = 7.173 g |
| Gula per kemasan 20 g | = 7.173 × 20 / 100 = 1.4346 g |
| (dibulatkan: <0.5 -> 0, >=0.5 -> 1 g terdekat) | = *1* g |
| *Natrium* |
| Natrium per 100 g | = 0.223 mg |
| Natrium per kemasan 20 g | = 0.223 × 20 / 100 = 0.0446 mg |
| (dibulatkan: <5 -> 0, <=140 -> 5 mg terdekat, >140 -> 10 mg terdekat) | = *0* mg |
| | |
| *%AKG natrium* |
| %AKG | = 0.0446 / 1500 × 100 = 0.00297333333333333 |
| (dibulatkan ke % terdekat) | = *0* |
`-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------'HOMEPAGE
Please visit the project's homepage at https://metacpan.org/release/App-BPOMUtils-NutritionFacts.
SOURCE
Source repository is at https://github.com/perlancar/perl-App-BPOMUtils-NutritionFacts.
AUTHOR
perlancar <perlancar@cpan.org>
CONTRIBUTING
To contribute, you can send patches by email/via RT, or send pull requests on GitHub.
Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then test via:
% prove -lIf you want to build the distribution (e.g. to try to install it locally on your system), you can install Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, Pod::Weaver::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla- and/or Pod::Weaver plugins. Any additional steps required beyond that are considered a bug and can be reported to me.
COPYRIGHT AND LICENSE
This software is copyright (c) 2024, 2023, 2022 by perlancar <perlancar@cpan.org>.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
BUGS
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-BPOMUtils-NutritionFacts
When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.