Features, Maintainability, & Style changes by SidIcarus · Pull Request #8 · qzb/is.sh

SidIcarus · 2019-09-05T15:54:35Z

Note

I kept cmd|command separate from available|installed for two reasons:

to not break backward compatibility
because really determining if a command is available, installed, or is just
command, is more complicated; see has

I intended for these changes to be separate PR's but I got caught up and it got
a little too tedious to re-structure the commits.

Since this doesn't break backwards compatibility, I've updated the version from 1.1.2 -> 1.2.0

Changes

features
- options:
  - no args will display --version followed by --help
- conditions
  - alias, builtin, keyword, function|fn, int|integer,
    array, hash|dictionary, export|exported
  - bool|boolean, truthy, falsey
  - cmd|command
  - in
  - set|var|variable
- .editorconfig, .gitignore
- test
  - can now be passed in multiple arguments to test against the same condition
maintainability
- version & help are in their own function
  - printf over heredoc + cat
- reused logic for several conditions
- printf over echo
  - echo doesn't consistently behave the same across all systems
- use builtin/internal functionality from bash over external tools
  - since this tool doesn't check dependencies, it'll be safer
- removed duplicate codes
style
- spacing: 4 -> 2
- printf over heredoc to not have tabs or un-indented code
- assert.sh: move code continuation so syntax highlighting in VSCode doesn't
  mis-color the rest of the file

In the tests file, I kept reference to a bash bug I encountered when parsing the keyword & builtin, [[]] & [], respectively. I can add a note about what version this was found in.

- removes the need to do it in either path future commit can further remove the need to set the subsequent vars

- increases maintainability & testability

- `echo` is not standardized across platforms

- increases maintainability and allows for clearer review of history

- removes usage of external tools `cat`, as `printf` is a builtin - easier to adhere to style since we no longer have tabs & spaces - reduces duplicate hardcoded strings

…ion|fn` - excludes `_type` option from help so its functionality is not misconstrued for working for more types

- allow status code to propagate down to end - increases maintainability and clarity

- added post & pre-warming logs to indicate the beginning and completion of the warming

- since `assert` begins counting as soon as is sourced, it is misleading to have it be sourced before we warm

SidIcarus · 2019-09-06T17:19:02Z

@qzb
can you take a look?

qzb · 2019-09-11T06:08:21Z

Thanks for your PR, I'll try to review it today or tomorrow, but for now it looks great 😀

qzb · 2019-09-11T06:03:48Z

README.md

+* `is function NAME` - name is a function
+  * alternate(s) `fn`
+* `is keyword NAME` - name is a keyword
+* `is array NAME` - name is a variable


I guess it's kind of obvious, but still description should be more precise:

Suggested change

* `is array NAME` - name is a variable

* `is array NAME` - name is a variable of array type

If the intent of the README condition description is to tell you what you need to pass in to get a true resultant back, then yes. Would you want to update the rest of the type conditions to follow suite?

qzb · 2019-09-11T06:05:57Z

README.md

-if is equal $var 123.0; then
-    echo "it just works"
-fi
+$ is equal "$var" 123.0 && printf 'it just works!\n'


Why use printf in the examples? Isn't echo more common and easier to use (no \n at the end)?

from what I recall, printf is more portable & consistent then echo across platforms

is.sh

qzb

Some of new conditions work only when script is sourced. I think it should be described in README.md and help messages. Personally I would move all this conditions to separate section in README.

…r loop

- `bash v3.2.57` doesn't support `declare -g`

- internal lowercasing is faster then `tr` so the minor speed reduction due to the conditional is worth it overall

- now it really won't leak when

- unfortunately, this relatively increased the test duration quite a bit 0-1s to 2-3s on v5 & 4-5s on v3.2.57

- to keep with backwards compatibility previously, you could write `not an not an the not a` but with the change to using a while loop for the articles whilst keeping its check after not, you lost the ability to do that

…ntinuation

…y in 3.2.57

otherwise, the timing is not as percise

SidIcarus · 2019-09-20T14:47:08Z

Some of new conditions work only when script is sourced. I think it should be described in README.md and help messages. Personally I would move all this conditions to separate section in README.

Good idea. I'll fix up the tests to reflect this as well.

SidIcarus added 30 commits August 29, 2019 13:28

feat: add .editorconfig

6f7db32

refactor: use more standard path to the interpreter

435b310

doc: format file description

65d5eb5

doc: note on case-statements

8f8506a

style: keep line length under 80

d71806d

refactor(quotes): use single quotes when there is nothing to interpret

ef4e1b8

refactor(params): always shift the condition

b576a8e

- removes the need to do it in either path future commit can further remove the need to set the subsequent vars

refactor(var): remove unnecessary variables

e42c32c

refactor(help): move into it's own function

93cc9f4

refactor(version): move into it's own function

acee077

style: 4\s->2\s

4328b2b

refactor: reduce verbosity for help && version option checks

3a82287

refactor: decouple is from modularization logic

d32a02b

- increases maintainability & testability

style: remove unnecessary spacing

db783b9

refactor: use printf instead of echo

ffed426

- `echo` is not standardized across platforms

refactor: move name & version into variables

5e9b6dd

- increases maintainability and allows for clearer review of history

refactor(help): use printf over cat + heredoc

79bf0d2

- removes usage of external tools `cat`, as `printf` is a builtin - easier to adhere to style since we no longer have tabs & spaces - reduces duplicate hardcoded strings

fix: unset helper functions as to not pollute the sh environment

3f73fab

feat(options): show both version && help when no args are provided

b80ef4e

refactor: add explicit file descriptor number to case statement redirect

ba3966c

feat(condition): check if a variable is set

d593214

refactor(substring): use builtin instead of external tool

d7b723e

feat(condtion): allow check for alias,builtin,keyword, & `funct…

d61c2a2

…ion|fn` - excludes `_type` option from help so its functionality is not misconstrued for working for more types

refactor: remove unnecessary return statements

e1430d4

- allow status code to propagate down to end - increases maintainability and clarity

feat(condition): add explicit catch for unsupported conditions

b374a24

feat(condtion): expand valid number definition

a597c05

refactor(number): use builtin [[ over external grep -E

5d1a34e

perf(condition): reuse logic for gt|lt|ge|le,|eq|equal

9444142

refactor(test): use internal vs external tools to warm

7d36af7

- added post & pre-warming logs to indicate the beginning and completion of the warming

refactor(test): move srcing assert after warm

2f32d1d

- since `assert` begins counting as soon as is sourced, it is misleading to have it be sourced before we warm

SidIcarus added 6 commits September 5, 2019 15:35

refactor(test): update variable names to separate values & references

746bf66

feat(condition): array, hash, export, int|integer

dabde62

feat(condition): allow num to evaluate int references

6ca1400

refactor(test): use clearer naming for values

2572d11

refactor(test): move cmd tests next to available|installed ones

f11e1b5

refactor(test): differeniate literal references from string values

0a3349c

SidIcarus force-pushed the master branch from 42bd8e9 to fed5827 Compare September 6, 2019 17:15

qzb reviewed Sep 14, 2019

View reviewed changes

qzb requested changes Sep 14, 2019

View reviewed changes

SidIcarus added 17 commits September 19, 2019 18:18

doc(README): add usage on new features & alternate condition names

c975fc0

doc(help): bring content up to date

fa757f4

feat: add gitignore

51bb138

perf(article): loop article checking instead of recursively checking

60cb8c2

fix(test): provide empty condition so it actually runs through the fo…

10bb11b

…r loop

fix(test): use tr to uppercase instead of ${var^}

d0ffc52

fix(test): move test::warm() content back into top scope

7a03121

- `bash v3.2.57` doesn't support `declare -g`

fix: compatibility with bash 3.2.57

dd02a5a

- internal lowercasing is faster then `tr` so the minor speed reduction due to the conditional is worth it overall

doc(condition): acknowledge shellcheck warning for which

82f62a8

fix: helper function pollution when not using --help or --version

d13a1f3

- now it really won't leak when

fix(test): allow for tests to run on 3.2.57

428e840

- unfortunately, this relatively increased the test duration quite a bit 0-1s to 2-3s on v5 & 4-5s on v3.2.57

fix(negate): move not check after while loop

6a39771

- to keep with backwards compatibility previously, you could write `not an not an the not a` but with the change to using a while loop for the articles whilst keeping its check after not, you lost the ability to do that

style(assert): vscode sh syntax highlighting messes up w/ previous co…

7945cc0

…ntinuation

bump version 1.1.2 -> 1.2.0

180ccb0

fix(package.json): add is to scripts to allow bpkg to install is

d2a3719

fix(test): use Octal Escape Sequence over \u so it displays properl…

36eeb45

…y in 3.2.57

fix(assert): use gdate when testing on macos

1ceb76a

otherwise, the timing is not as percise

SidIcarus force-pushed the master branch from 293736c to 1ceb76a Compare September 19, 2019 22:20

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Features, Maintainability, & Style changes#8

Features, Maintainability, & Style changes#8
SidIcarus wants to merge 82 commits intoqzb:masterfrom
SidIcarus:master

SidIcarus commented Sep 5, 2019 •

edited

Loading

Uh oh!

SidIcarus commented Sep 6, 2019

Uh oh!

qzb commented Sep 11, 2019 •

edited

Loading

Uh oh!

qzb Sep 11, 2019

Uh oh!

SidIcarus Sep 19, 2019

Uh oh!

qzb Sep 11, 2019

Uh oh!

SidIcarus Sep 19, 2019

Uh oh!

Uh oh!

qzb left a comment

Uh oh!

SidIcarus commented Sep 20, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	* `is array NAME` - name is a variable
	* `is array NAME` - name is a variable of array type

Conversation

SidIcarus commented Sep 5, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Note

Changes

Uh oh!

SidIcarus commented Sep 6, 2019

Uh oh!

qzb commented Sep 11, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

qzb Sep 11, 2019

Choose a reason for hiding this comment

Uh oh!

SidIcarus Sep 19, 2019

Choose a reason for hiding this comment

Uh oh!

qzb Sep 11, 2019

Choose a reason for hiding this comment

Uh oh!

SidIcarus Sep 19, 2019

Choose a reason for hiding this comment

Uh oh!

Uh oh!

qzb left a comment

Choose a reason for hiding this comment

Uh oh!

SidIcarus commented Sep 20, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

SidIcarus commented Sep 5, 2019 •

edited

Loading

qzb commented Sep 11, 2019 •

edited

Loading