Added version release notes

Added to the macOS Configuration project, instead, since it makes more
sense to keep all pre and post install steps together in one place.

.github/ISSUE_TEMPLATE.md

@@ -1,16 +1,14 @@
-## Expected Behavior
+## Overview
-<!-- Required. Describe, in detail, the behavior experienced. -->
+<!-- Required. Describe, briefly, the behavior experienced. -->
-
-## Actual Behavior
-<!-- Required. Describe, in detail, what should be the correct behavior. -->
-
-## Steps to Recreate
-<!-- Required. List the exact steps to the reproduce errant behavior. -->
-
-0.
-
-## Environment
-<!-- Optional. What is your operating system, software version(s), etc. Delete if unused. -->
 
 ## Screenshots/Screencasts
-<!-- Optional. Attach screenshots/screencasts that demo the behavior. Delete if unused. -->
+<!-- Optional. Attach screenshot(s) and/or screencast(s) that demo the behavior. -->
+
+## Steps to Recreate
+<!-- Required. List exact steps (numbered list) to reproduce errant behavior. -->
+
+## Desired Behavior
+<!-- Required. Describe the behavior you'd like to see or your idea of a proposed solution. -->
+
+## Environment
+<!-- Required. What is your operating system, software version(s), etc. -->

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,11 +1,11 @@
 ## Overview
-<!-- Required. Why is this important/necessary? -->
+<!-- Required. Why is this important/necessary and what is the overarching architecture. -->
+
+## Screenshots/Screencasts
+<!-- Optional. Provide supporting image/video. -->
 
 ## Details
 <!-- Optional. List the key features/highlights as bullet points. -->
 
 ## Notes
-<!-- Optional. List additional notes/references as bullet points. Delete if unused. -->
+<!-- Optional. List additional notes/references as bullet points. -->
-
-## Screenshots/Screencasts
-<!-- Optional. Provide image/video support. Delete if unused. -->

.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

.ruby-version

@@ -0,0 +1 @@
+3.0.0

CHANGELOG.md

@@ -1,16 +0,0 @@
-# v1.2.0 (2016-10-12)
-
-- Fixed reinstaller path issues with application and extension scripts.
-- Added screencast to README.
-
-# v1.1.0 (2016-10-11)
-
-- Fixed Bash script header to dynamically load correct environment.
-- Fixed verification of Homebrew application installs.
-- Added script hook for App Store software install.
-- Added script hooks for unfinished custom configurations.
-- Updated and clarified README documentation.
-
-# v1.0.0 (2016-10-05)
-
-- Initial version.

CHANGES.adoc

@@ -0,0 +1,211 @@
+= Changes
+
+== 11.1.0 (2021-01-03)
+
+* Added caffeination to restore process - Brooke Kuhlmann
+* Updated boot disk instructions for main disk format - Brooke Kuhlmann
+* Updated troubleshooting documentation - Brooke Kuhlmann
+* Removed README Startup Security Utility documentation - Brooke Kuhlmann
+
+== 11.0.0 (2020-12-30)
+
+* Fixed Circle CI configuration for Bundler config path - Brooke Kuhlmann
+* Added Circle CI explicit Bundle install configuration - Brooke Kuhlmann
+* Updated to Git Lint 2.0.0 - Brooke Kuhlmann
+* Updated to Ruby 3.0.0 - Brooke Kuhlmann
+
+== 10.0.0 (2020-11-15)
+
+* Added macOS Big Sur support
+* Updated project documentation to conform to Rubysmith template
+* Updated to Git Lint 1.3.0
+* Updated to Ruby 2.7.2
+
+== 9.0.0 (2020-09-12)
+
+* Fixed Homebrew cask verifier deprecation warning
+* Removed Homebrew Mecurial formula verification check
+* Removed unnecessary verifier code comments
+* Refactored utility basename and extension utilities
+
+== 8.2.0 (2020-07-22)
+
+* Fixed project requirements
+* Fixed screencast image URL
+* Updated GitHub templates
+* Updated README credit URL
+* Updated README screencast URL
+* Updated README screencast cover to SVG format
+* Updated to Git Lint 1.0.0
+* Refactored Rakefile requirements
+
+== 8.1.0 (2020-04-01)
+
+* Added README production and development setup instructions
+* Updated Circle CI build label
+* Updated README screencast to use larger image
+* Updated documentation to ASCII Doc format
+* Updated to Code of Conduct 2.0.0
+* Updated to Git Cop 4.0.0
+* Updated to Ruby 2.7.1
+* Removed README images
+
+== 8.0.1 (2020-01-01)
+
+* Added Startup Security Utility to README.
+* Updated README screencast.
+* Updated to Ruby 2.7.0.
+* Refactored caffeinate machine function to process grep.
+
+== 8.0.0 (2019-10-12)
+
+* Updated to Rake 13.0.0.
+* Updated to Ruby 2.6.5.
+* Updated to macOS Catalina.
+
+== 7.2.1 (2019-09-01)
+
+* Updated README screencast tutorial.
+* Updated to Ruby 2.6.4.
+
+== 7.2.0 (2019-08-01)
+
+* Added file install function.
+
+== 7.1.2 (2019-06-01)
+
+* Updated contributing documentation.
+* Updated to Git Cop 3.5.0.
+
+== 7.1.1 (2019-05-01)
+
+* Added project icon to README.
+* Updated to Ruby 2.6.3.
+
+== 7.1.0 (2019-04-01)
+
+* Added XCode installer fix to troubleshooting section.
+* Updated to Ruby 2.6.1.
+* Updated to Ruby 2.6.2.
+
+== 7.0.0 (2019-01-01)
+
+* Fixed Circle CI cache for Ruby version.
+* Fixed installation of apps with no extension.
+* Fixed program installs.
+* Added Circle CI Bundler cache.
+* Added README boot disk documentation.
+* Added README troubleshooting section.
+* Updated to Git Cop 3.0.0.
+* Updated to Ruby 2.6.0.
+* Removed Java development tools from setup.
+* Removed download file function.
+
+== 6.1.0 (2018-11-01)
+
+* Updated to Java SE Development Kit 11.
+* Updated to Ruby 2.5.2.
+* Updated to Ruby 2.5.3.
+* Removed unnecessary source code comments.
+
+== 6.0.0 (2018-10-01)
+
+* Added XCode install tip.
+* Updated boot disk creation to macOS Mojave.
+* Updated to Contributor Covenant Code of Conduct 1.4.1.
+* Updated to Java SE Development Kit 10.
+
+== 5.0.0 (2018-08-01)
+
+* Fixed Markdown ordered list numbering.
+* Fixed verification of Homebrew formulas.
+* Added App Store application verification.
+* Added Homebrew cask application verifier.
+* Updated Git checkout to silence detached head warnings.
+* Updated README documentation.
+* Updated Semantic Versioning links to be HTTPS.
+* Updated boot disk format documentation.
+* Updated project changes to use semantic versions.
+* Removed Java install support.
+* Removed restorer functions.
+* Refactored function parameter documentation.
+* Refactored library function order.
+
+== 4.1.0 (2018-04-01)
+
+* Updated README license information.
+* Updated README screencast tutorial.
+* Updated to Circle CI 2.0.0 configuration.
+* Updated to Git Cop 2.2.0.
+* Updated to Ruby 2.5.1.
+* Removed Patreon badge from README.
+
+== 4.0.0 (2018-01-01)
+
+* Added Gemfile.lock to .gitignore.
+* Updated to Apache 2.0 license.
+* Updated to Ruby 2.4.3.
+* Updated to Ruby 2.5.0.
+
+== 3.1.0 (2017-11-26)
+
+* Updated Gemfile.lock file.
+* Updated boot disk documenation to mention APFS.
+* Updated to Bundler 1.16.0.
+* Updated to Git Cop 1.7.0.
+* Updated to Rake 12.3.0.
+* Updated to Rubocop 0.51.0.
+
+== 3.0.0 (2017-10-01)
+
+* Fixed table of contents.
+* Updated boot disk creation to use macOS High Sierra.
+* Updated gem dependencies.
+* Updated to Git Cop 1.6.0.
+* Updated to Ruby 2.4.2.
+
+== 2.2.0 (2017-07-16)
+
+* Added Git Cop support.
+* Updated CONTRIBUTING documentation.
+* Updated GitHub templates.
+* Updated README headers.
+* Updated gem dependencies.
+
+== 2.1.0 (2017-04-29)
+
+* Fixed Java SE Development Kit install.
+* Fixed install-all command
+
+== 2.0.0 (2017-04-09)
+
+* Added Homebrew Casks install script.
+* Updated README semantic versioning order.
+* Updated contributing documentation.
+* Refactored Homebrew software as Homebrew Formulas.
+
+== 1.3.1 (2017-01-08)
+
+* Fixed install of zip app downloads with sub-directories.
+
+== 1.3.0 (2017-01-01)
+
+* Updated README versioning documentation.
+* Removed CHANGELOG.md (use CHANGES.md instead).
+
+== 1.2.0 (2016-10-12)
+
+* Fixed reinstaller path issues with application and extension scripts.
+* Added screencast to README.
+
+== 1.1.0 (2016-10-11)
+
+* Fixed Bash script header to dynamically load correct environment.
+* Fixed verification of Homebrew application installs.
+* Added script hook for App Store software install.
+* Added script hooks for unfinished custom configurations.
+* Updated and clarified README documentation.
+
+== 1.0.0 (2016-10-05)
+
+* Initial version.

CODE_OF_CONDUCT.adoc

@@ -0,0 +1,113 @@
+= Contributor Covenant Code of Conduct
+
+== Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a
+harassment-free experience for everyone, regardless of age, body size, visible or invisible
+disability, ethnicity, sex characteristics, gender identity and expression, level of experience,
+education, socio-economic status, nationality, personal appearance, race, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and
+healthy community.
+
+== Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the
+  experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address, without their
+  explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+== Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior
+and will take appropriate and fair corrective action in response to any behavior that they deem
+inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits,
+code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and
+will communicate reasons for moderation decisions when appropriate.
+
+== Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is
+officially representing the community in public spaces. Examples of representing our community
+include using an official e-mail address, posting via an official social media account, or acting as
+an appointed representative at an online or offline event.
+
+== Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community
+leaders responsible for enforcement at link:mailto:brooke@alchemists.io?subject=Conduct[Brooke Kuhlmann].
+
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any
+incident.
+
+== Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for
+any action they deem in violation of this Code of Conduct:
+
+=== 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or
+unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the
+nature of the violation and an explanation of why the behavior was inappropriate. A public apology
+may be requested.
+
+=== 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people
+involved, including unsolicited interaction with those enforcing the Code of Conduct, for a
+specified period of time. This includes avoiding interactions in community spaces as well as
+external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+=== 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate
+behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the
+community for a specified period of time. No public or private interaction with the people involved,
+including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this
+period. Violating these terms may lead to a permanent ban.
+
+=== 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including
+sustained inappropriate behavior,  harassment of an individual, or aggression toward or
+disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+== Attribution
+
+This Code of Conduct is adapted from the
+link:https://www.contributor-covenant.org/version/2/0/code_of_conduct.html[Contributor Covenant,
+Version 2.0].
+
+Community Impact Guidelines were inspired by link:https://github.com/mozilla/diversity[Mozilla's
+code of conduct enforcement ladder].
+
+For answers to common questions about this code of conduct, see the
+link:https://www.contributor-covenant.org/faq[FAQ]. Translations are available
+link:https://www.contributor-covenant.org/translations[here].

CODE_OF_CONDUCT.md

@@ -1,61 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making
-participation in our project and our community a harassment-free experience for everyone, regardless of age, body size,
-disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race,
-religion, or sexual identity and orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take
-appropriate and fair corrective action in response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits,
-issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any
-contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the
-project or its community. Examples of representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed representative at an online or offline
-event. Representation of a project may be further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at
-[brooke@alchemists.io](mailto:brooke@alchemists.io). All complaints will be reviewed and investigated and will result in
-a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain
-confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be
-posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent
-repercussions as determined by other members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [http://contributor-covenant.org/version/1/4][version]
-
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.adoc

@@ -0,0 +1,22 @@
+= Contributing
+
+Thanks for taking an interest in this open source project. Your support and involvement is greatly
+appreciated. The following details what you need to know in order to contribute.
+
+== Code
+
+. Read the project link:README.adoc[README] before starting.
+. Fork and clone the `master` branch of this repository locally.
+. Ensure there are no setup, usage, and/or test issues.
+. Add tests for new functionality and ensure they pass.
+. Submit a pull request, follow the instructions provided, and ensure the build passes.
+
+== Issues
+
+Submit an issue via the GitHub Issues tab (assuming one does not already exist) and follow the
+instructions provided.
+
+== Feedback
+
+* Expect a response within one to three business days.
+* Changes, alternatives, and/or improvements may be suggested upon review.

CONTRIBUTING.md

@@ -1,35 +0,0 @@
-# Overview
-
-Thanks for taking an interest in this open source project. Your support and involvement is greatly appreciated. The
-following details what you need to know in order to contribute.
-
-# Requirements
-
-- Follow these [Basic Programming Styles](https://github.com/bkuhlmann/style_guides/blob/master/programming/basic.md).
-- Follow these [Code Review Styles](https://github.com/bkuhlmann/style_guides/blob/master/programming/code_reviews.md).
-- Follow these [Git Styles](https://github.com/bkuhlmann/style_guides/blob/master/programming/git.md).
-- Follow these [Bash Styles](https://github.com/bkuhlmann/style_guides/blob/master/programming/languages/bash.md).
-- Follow these [CSS Styles](https://github.com/bkuhlmann/style_guides/blob/master/programming/languages/css.md).
-- Follow these [Ruby Styles](https://github.com/bkuhlmann/style_guides/blob/master/programming/languages/ruby/ruby.md).
-
-# Contributing Code
-
-0. Read the project README thoroughly before starting.
-0. Fork the master branch of the repository.
-0. Ensure there are no setup, usage, and/or test issues (again, follow the README).
-0. Add tests for new functionality (refactoring and documentation changes can be excluded).
-0. Ensure all tests pass.
-0. Push your feature branch and submit a pull request.
-
-# Submitting Issues
-
-0. Submit an issue via the GitHub Issues tab (assuming one does not already exist).
-0. Clearly describe the issue (including steps to reproduce).
-0. Specify your enviroment setup (OS, browser, language, etc. with version info).
-0. Provide a stack dump (if possible).
-0. Explain any additional details that might help diagnose the problem quickly.
-
-# Feedback
-
-Expect a response within one to three business days.
-Changes, alternatives, and/or improvements might be suggested upon review.

Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gem "rake", "~> 13.0"
+gem "git-lint", "~> 2.0"

LICENSE.adoc

@@ -0,0 +1,162 @@
+= Apache License
+
+Version 2.0, January 2004
+
+http://www.apache.org/licenses
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+== 1. Definitions
+
+"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by
+Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is
+granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities that control, are
+controlled by, or are under common control with that entity. For the purposes of this definition,
+"control" means (i) the power, direct or indirect, to cause the direction or management of such
+entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this
+License.
+
+"Source" form shall mean the preferred form for making modifications, including but not limited to
+software source code, documentation source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical transformation or translation of a
+Source form, including but not limited to compiled object code, generated documentation, and
+conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form, made available under the
+License, as indicated by a copyright notice that is included in or attached to the work (an example
+is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or
+derived from) the Work and for which the editorial revisions, annotations, elaborations, or other
+modifications represent, as a whole, an original work of authorship. For the purposes of this
+License, Derivative Works shall not include works that remain separable from, or merely link (or
+bind by name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original version of the Work and any
+modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted
+to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity
+authorized to submit on behalf of the copyright owner. For the purposes of this definition,
+"submitted" means any form of electronic, verbal, or written communication sent to the Licensor or
+its representatives, including but not limited to communication on electronic mailing lists, source
+code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor
+for the purpose of discussing and improving the Work, but excluding communication that is
+conspicuously marked or otherwise designated in writing by the copyright owner as "Not a
+Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a
+Contribution has been received by Licensor and subsequently incorporated within the Work.
+
+== 2. Grant of Copyright License
+
+Subject to the terms and conditions of this License, each Contributor hereby grants to You a
+perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to
+reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and
+distribute the Work and such Derivative Works in Source or Object form.
+
+== 3. Grant of Patent License
+
+Subject to the terms and conditions of this License, each Contributor hereby grants to You a
+perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this
+section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer
+the Work, where such license applies only to those patent claims licensable by such Contributor that
+are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s)
+with the Work to which such Contribution(s) was submitted. If You institute patent litigation
+against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or
+a Contribution incorporated within the Work constitutes direct or contributory patent infringement,
+then any patent licenses granted to You under this License for that Work shall terminate as of the
+date such litigation is filed.
+
+== 4. Redistribution
+
+You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with
+or without modifications, and in Source or Object form, provided that You meet the following
+conditions:
+
+. You must give any other recipients of the Work or Derivative Works a copy of this License; and
+
+. You must cause any modified files to carry prominent notices stating that You changed the files;
+  and
+
+. You must retain, in the Source form of any Derivative Works that You distribute, all copyright,
+  patent, trademark, and attribution notices from the Source form of the Work, excluding those
+  notices that do not pertain to any part of the Derivative Works; and
+
+. If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works
+  that You distribute must include a readable copy of the attribution notices contained within such
+  NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in
+  at least one of the following places: within a NOTICE text file distributed as part of the
+  Derivative Works; within the Source form or documentation, if provided along with the Derivative
+  Works; or, within a display generated by the Derivative Works, if and wherever such third-party
+  notices normally appear. The contents of the NOTICE file are for informational purposes only and
+  do not modify the License. You may add Your own attribution notices within Derivative Works that
+  You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such
+  additional attribution notices cannot be construed as modifying the License.
+
+You may add Your own copyright statement to Your modifications and may provide additional or
+different license terms and conditions for use, reproduction, or distribution of Your modifications,
+or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of
+the Work otherwise complies with the conditions stated in this License.
+
+== 5. Submission of Contributions
+
+Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the
+Work by You to the Licensor shall be under the terms and conditions of this License, without any
+additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify
+the terms of any separate license agreement you may have executed with Licensor regarding such
+Contributions.
+
+== 6. Trademarks
+
+This License does not grant permission to use the trade names, trademarks, service marks, or product
+names of the Licensor, except as required for reasonable and customary use in describing the origin
+of the Work and reproducing the content of the NOTICE file.
+
+== 7. Disclaimer of Warranty
+
+Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each
+Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied, including, without limitation, any warranties or conditions of
+TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely
+responsible for determining the appropriateness of using or redistributing the Work and assume any
+risks associated with Your exercise of permissions under this License.
+
+== 8. Limitation of Liability
+
+In no event and under no legal theory, whether in tort (including negligence), contract, or
+otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or
+agreed to in writing, shall any Contributor be liable to You for damages, including any direct,
+indirect, special, incidental, or consequential damages of any character arising as a result of this
+License or out of the use or inability to use the Work (including but not limited to damages for
+loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial
+damages or losses), even if such Contributor has been advised of the possibility of such damages.
+
+== 9. Accepting Warranty or Additional Liability
+
+While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee
+for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights
+consistent with this License. However, in accepting such obligations, You may act only on Your own
+behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You
+agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or
+claims asserted against, such Contributor by reason of your accepting any such warranty or
+additional liability.
+
+END OF TERMS AND CONDITIONS
+
+Copyright 2016 link:https://www.alchemists.io/team/brooke_kuhlmann[Brooke Kuhlmann].
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in
+compliance with the License. You may obtain a link:https://www.apache.org/licenses/LICENSE-2.0[copy]
+of the License.
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is
+distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+implied. See the License for the specific language governing permissions and limitations under the
+License.

LICENSE.md

@@ -1,20 +0,0 @@
-Copyright (c) 2016 [Alchemists](https://www.alchemists.io).
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.adoc

@@ -0,0 +1,223 @@
+:toc: macro
+:toclevels: 5
+:figure-caption!:
+
+= macOS
+
+[link=https://circleci.com/gh/bkuhlmann/mac_os]
+image::https://circleci.com/gh/bkuhlmann/mac_os.svg?style=svg[Circle CI Status]
+
+Shell scripts for automated macOS machine setup.
+
+This project is a framework for automating the setup of a macOS machine. In order to illustrate the
+potential of what this project can do, please see the companion
+link:https://www.alchemists.io/projects/mac_os-config[macOS Config] project for details. The _macOS
+Config_ project is an opinionated configuration which meets the needs of my development environment
+but is also meant to serve as an example and guide for building your own personalized setup. Here is
+how the two projects are meant to be used:
+
+* *macOS* (this project) - The foundation framework for building customizated macOS machine setups.
+* *link:https://www.alchemists.io/projects/mac_os-config[macOS Configuration]* - The layer on top of
+  this _macOS_ project which defines a custom machine setup and base implementation. The project is
+  meant to be forked for as many custom machine setups as needed.
+
+toc::[]
+
+== Features
+
+* Provides a command line interface, written in Bash, with no additional dependencies for
+  installation and management of a macOS machine.
+* Supports macOS boot disk creation for fresh install of operating system.
+* Downloads and installs link:https://developer.apple.com/xcode[Xcode Command Line Tools].
+* Downloads, installs, and configures link:http://brew.sh[Homebrew Formulas].
+* Downloads, installs, and configures link:https://caskroom.github.io[Homebrew Casks].
+* Downloads, installs, and configures link:http://www.apple.com/macosx/whats-new/app-store.html[App
+  Store] software.
+* Downloads, installs, and configures non-App Store software applications.
+* Downloads, installs, and configures software application extensions.
+* Applies basic and default software settings.
+* Sets up and configures installed software for use.
+* Supports restoration of machine backups.
+
+== Screencast
+
+[link=https://www.alchemists.io/screencasts/mac_os]
+image::https://www.alchemists.io/images/screencasts/mac_os/cover.svg[Screencast,600,240,role=focal_point]
+
+== Requirements
+
+. link:https://www.apple.com/macos/big-sur[macOS Big Sur]
+. link:https://developer.apple.com/xcode[Xcode]
+
+== Setup
+
+To install, run:
+
+[source,bash]
+----
+git clone https://github.com/bkuhlmann/mac_os.git
+cd mac_os
+git checkout 11.1.0
+----
+
+== Usage
+
+Run the following:
+
+[source,bash]
+----
+bin/run
+----
+
+You will be presented with the following options (listed in order of
+use):
+
+....
+Boot:
+   B:  Create boot disk.
+Install:
+   b:  Apply basic settings.
+   t:  Install development tools.
+  hf:  Install Homebrew Formulas.
+  hc:  Install Homebrew Casks.
+   m:  Install Mac App Store software.
+   a:  Install application software.
+   x:  Install application software extensions.
+   d:  Apply default settings.
+   s:  Setup installed software.
+   i:  Install everything (i.e. executes all install options).
+Restore:
+   R:  Restore settings from backup.
+Manage:
+   c:  Check status of managed software.
+   C:  Caffeinate machine.
+  ua:  Uninstall application software.
+  ux:  Uninstall application software extension.
+  ra:  Reinstall application software.
+  rx:  Reinstall application software extension.
+   w:  Clean work (temp) directory.
+   q:  Quit/Exit.
+....
+
+Choose option `i` to run a full install or select a specific option to run a single action. Each
+option is designed to be re-run if necessary. This can also be handy for performing upgrades,
+re-running a missing/failed install, etc.
+
+The option prompt can be skipped by passing the desired option directly to the `bin/run` script. For
+example, executing `bin/run i` will execute the full install process.
+
+The machine should be rebooted after all install tasks have completed to ensure all settings have
+been loaded.
+
+It is recommended that the `mac_os` project directory not be deleted and kept on the local machine
+in order to manage installed software and benefit from future upgrades.
+
+=== Boot Disk
+
+When attempting to create a boot disk via `bin/run B`, you’ll be presented with the following
+documentation (provided here for reference):
+
+....
+macOS Boot Disk Tips
+  - Use a USB drive (8GB or higher).
+  - Use Disk Utility to format the USB drive as "Mac OS Extended (Journaled)".
+  - Use Disk Utility to label the USB drive as "Untitled".
+
+macOS Boot Disk Usage:
+  1. Insert the USB boot disk into the machine to be upgraded.
+  2. Reboot the machine.
+  3. Hold down the OPTION key before the Apple logo appears.
+  4. Select the USB boot disk from the menu.
+  5. Use Disk Utility to delete and/or erase the hard drive including associated partitions.
+  6. Use Disk Utility to create a single "APFS" drive as a "GUID Partition Table".
+  7. Install the new operating system.
+
+macOS Reinstall:
+  1. Click the Apple icon from the operating system main menu.
+  2. Select the "Restart..." menu option.
+  3. Hold down the COMMAND+R keys before the Apple logo appears.
+  4. Wait for the macOS installer to load from the recovery partition.
+  5. Use the dialog options to launch Disk Utility, reinstall the system, etc.
+....
+
+=== Customization
+
+All executable scripts can be found in the `bin` folder:
+
+* `bin/apply_basic_settings`: Applies basic, initial, settings for setting up a machine. _Can be
+  customized._
+* `bin/apply_default_settings`: Applies useful system and application defaults. _Can be customized._
+* `bin/create_boot_disk`: Creates macOS boot disk.
+* `bin/install_app_store`: Installs macOS, GUI-based, App Store applications. _Can be customized._
+* `bin/install_applications`: Installs macOS, GUI-based, non-App Store applications. _Can be
+  customized._
+* `bin/install_dev_tools`: Installs macOS development tools required by Homebrew.
+* `bin/install_extensions`: Installs macOS application extensions and add-ons. _Can be customized._
+* `bin/install_homebrew_casks`: Installs Homebrew Formulas. _Can be customized._
+* `bin/install_homebrew_formulas`: Installs Homebrew Casks. _Can be customized._
+* `bin/restore_backup`: Restores system/application settings from backup image. _Can be customized._
+* `bin/run`: The main script and interface for macOS setup.
+* `bin/setup_software`: Configures and launches (if necessary) installed software. _Can be
+  customized._
+
+The `lib` folder provides the base framework for installing, re-installing, and uninstalling
+software. Everything provided via the link:https://www.alchemists.io/projects/mac_os-config[macOS
+Config] project is built upon the functions found in the `lib` folder. See the
+link:https://www.alchemists.io/projects/mac_os-config[macOS Config] project for further details.
+
+* `lib/settings.sh`: Defines global settings for software applications, extensions, etc.
+
+== Troubleshooting
+
+* When using link:https://pi-hole.net[Pi-hole], make sure to temporarily disable prior to upgrading
+  as you might experience various errors with Apple not able to detect an internet connection which
+  prevents the installer from working.
+* When using the boot disk and the installer fails in some catestrophic manner, reboot the machine
+  into recovery mode (i.e. `COMMAND + R`) to download and install the last operating system used.
+  You can also use `COMMAND + OPTION + R` to attemp to download the latest operating system.
+* When using the boot disk, you might experience a situation where you see a black screen with a
+  white circle and diagonal line running through it. This means macOS lost or can’t find the boot
+  disk for some reason. To correct this, shut down and boot up the system again while holding down
+  the `OPTION+COMMAND+R+P` keys simultaneously. You might want to wait for the system boot sound to
+  happen a few times before releasing the keys. This will clear the system NVRAM/PRAM. At this point
+  you can shut down and restart the system following the boot disk instructions (the boot disk will
+  be recognized now).
+
+== Development
+
+To contribute, run:
+
+[source,bash]
+----
+git clone https://github.com/bkuhlmann/mac_os.git
+cd mac_os
+----
+
+== Versioning
+
+Read link:https://semver.org[Semantic Versioning] for details. Briefly, it means:
+
+* Major (X.y.z) - Incremented for any backwards incompatible public API changes.
+* Minor (x.Y.z) - Incremented for new, backwards compatible, public API enhancements/fixes.
+* Patch (x.y.Z) - Incremented for small, backwards compatible, bug fixes.
+
+== Code of Conduct
+
+Please note that this project is released with a link:CODE_OF_CONDUCT.adoc[CODE OF CONDUCT]. By
+participating in this project you agree to abide by its terms.
+
+== Contributions
+
+Read link:CONTRIBUTING.adoc[CONTRIBUTING] for details.
+
+== License
+
+Read link:LICENSE.adoc[LICENSE] for details.
+
+== History
+
+Read link:CHANGES.adoc[CHANGES] for details.
+
+== Credits
+
+Engineered by link:https://www.alchemists.io/team/brooke_kuhlmann[Brooke Kuhlmann].

README.md

@@ -1,187 +0,0 @@
-# macOS
-
-[![Patreon](https://img.shields.io/badge/patreon-donate-brightgreen.svg)](https://www.patreon.com/bkuhlmann)
-
-Shell scripts for automated macOS machine setup.
-
-This project is a framework for automating the setup of a macOS machine. In order to illustrate the
-potential of what this project can do, please see the companion
-[macOS Config](https://github.com/bkuhlmann/mac_os-config) project for details. The *macOS Config*
-project is an opinionated configuration which meets the needs of my development environment but is
-also meant to serve as an example and guide for building your own personalized setup. Here is how
-the two projects are meant to be used:
-
-- **macOS** (this project) - Foundation and framework for building customizated macOS machine
-  setups.
-- **[macOS Config](https://github.com/bkuhlmann/mac_os-config)** - The layer on top of this *macOS*
-  project which defines a custom machine setup and base implementation. The project is meant to be
-  forked for as many custom machine setups as needed.
-
-<!-- Tocer[start]: Auto-generated, don't remove. -->
-
-# Table of Contents
-
-- [Features](#features)
-- [Screencast](#screencast)
-- [Requirements](#requirements)
-- [Setup](#setup)
-- [Usage](#usage)
-  - [Customization](#customization)
-- [Versioning](#versioning)
-- [Code of Conduct](#code-of-conduct)
-- [Contributions](#contributions)
-- [License](#license)
-- [History](#history)
-- [Credits](#credits)
-
-<!-- Tocer[finish]: Auto-generated, don't remove. -->
-
-# Features
-
-- Provides a command line interface, written in Bash with no additional dependencies, for
-  installation and management of a macOS machine.
-- Supports macOS boot disk creation for setting up a machine with a fresh install of the operation
-  system.
-- Downloads and installs development tools (required by Homebrew):
-    - [Xcode Command Line Tools](https://developer.apple.com/xcode)
-    - [Java SE Development Kit](http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html)
-- Downloads, installs, and configures [Homebrew](http://brew.sh) command line software.
-- Downloads, installs, and configures
-  [App Store](http://www.apple.com/macosx/whats-new/app-store.html) software.
-- Downloads, installs, and configures non-App Store software applications.
-- Downloads, installs, and configures software application extensions.
-- Applies basic and default software settings.
-- Sets up and configures installed software for use.
-- Supports restoration of machine backups.
-
-# Screencast
-
-[![asciicast](https://asciinema.org/a/88971.png)](https://asciinema.org/a/88971)
-
-# Requirements
-
-0. [macOS Sierra](https://www.apple.com/macos) (with latest software updates applied)
-0. [Xcode](https://developer.apple.com/xcode) (with accepted license agreement)
-
-# Setup
-
-Open a terminal window and execute one of the following setup sequences depending on your version
-preference:
-
-Current Version (stable):
-
-    git clone https://github.com/bkuhlmann/mac_os.git
-    cd mac_os
-    git checkout v1.2.0
-
-Master Version (unstable):
-
-    git clone https://github.com/bkuhlmann/mac_os.git
-    cd mac_os
-
-# Usage
-
-Run the following script:
-
-    bin/run
-
-You will be presented with the following options:
-
-    Boot:
-      B:  Create boot disk.
-    Install:
-      b:  Apply basic settings.
-      t:  Install development tools.
-      h:  Install Homebrew software.
-      m:  Install Mac App Store software.
-      a:  Install application software.
-      x:  Install application software extensions.
-      d:  Apply default settings.
-      s:  Setup installed software.
-      i:  Install everything (i.e. executes all install options).
-    Restore:
-      R:  Restore settings from backup.
-    Manage:
-      c:  Check status of managed software.
-      C:  Caffeinate machine.
-      ua: Uninstall application software.
-      ux: Uninstall application software extension.
-      ra: Reinstall application software.
-      rx: Reinstall application software extension.
-      w:  Clean work (temp) directory.
-      q:  Quit/Exit.
-
-Choose option `i` to run all install options or select a specific option to run a single option.
-Each option is designed to be re-run if necessary. This can also be handy for performing upgrades,
-re-running a missing/failed install, etc.
-
-The option prompt can be skipped by passing the desired option directly to the `bin/run` script. For
-example, executing `bin/run i` will execute the complete software install process.
-
-The machine should be rebooted after all install tasks have completed to ensure all settings have
-been loaded.
-
-It is recommended that the `mac_os` project directory not be deleted and kept on the local machine
-in order to manage installed software and benefit from future upgrades.
-
-## Customization
-
-All executable scripts can be found in the `bin` folder:
-
-- `bin/apply_basic_settings`: Applies basic, initial, settings for setting up a machine. *This is
-  meant to be customized.*
-- `bin/apply_default_settings`: Applies useful system and application defaults. *This is meant to be
-  customized.*
-- `bin/create_boot_disk`: Creates macOS boot disk.
-- `bin/install_app_store`: Installs macOS, GUI-based, App Store applications. *This is meant to be
-  customized.*
-- `bin/install_applications`: Installs macOS, GUI-based, non-App Store applications. *This is meant
-  to be customized.*
-- `bin/install_dev_tools`: Installs macOS development tools required by Homebrew.
-- `bin/install_extensions`: Installs macOS application extensions and add-ons. *This is meant to be
-  customized.*
-- `bin/install_homebrew`: Installs Homebrew managed software. *This is meant to be customized.*
-- `bin/restore_backup`: Restores system/application settings from backup image. *This is meant to be
-  customized.*
-- `bin/run`: The main script and interface for macOS setup.
-- `bin/setup_software`: Configures and launches (if necessary) installed software. *This is meant to
-  be customized.*
-
-The `lib` folder provides the base framework for installing, re-installing, and uninstalling
-software. Everything provided via the [macOS Config](https://github.com/bkuhlmann/mac_os-config)
-project is built upon the functions found in the `lib` folder. See the
-[macOS Config](https://github.com/bkuhlmann/mac_os-config) project for further details.
-
-  - `lib/settings.sh`: Defines global settings for software applications, extensions, etc.
-
-# Versioning
-
-Read [Semantic Versioning](http://semver.org) for details. Briefly, it means:
-
-- Patch (x.y.Z) - Incremented for small, backwards compatible bug fixes.
-- Minor (x.Y.z) - Incremented for new, backwards compatible public API enhancements and/or bug fixes.
-- Major (X.y.z) - Incremented for any backwards incompatible public API changes.
-
-# Code of Conduct
-
-Please note that this project is released with a [CODE OF CONDUCT](CODE_OF_CONDUCT.md). By
-participating in this project you agree to abide by its terms.
-
-# Contributions
-
-Read [CONTRIBUTING](CONTRIBUTING.md) for details.
-
-# License
-
-Copyright (c) 2016 [Alchemists](https://www.alchemists.io).
-Read the [LICENSE](LICENSE.md) for details.
-
-# History
-
-Read the [CHANGELOG](CHANGELOG.md) for details.
-Built with [Bashsmith](https://github.com/bkuhlmann/bashsmith).
-
-# Credits
-
-Developed by [Brooke Kuhlmann](https://www.alchemists.io) at
-[Alchemists](https://www.alchemists.io).

Rakefile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require "git/lint/rake/setup"
+
+task default: :git_lint

bin/apply_basic_settings

@@ -1,16 +1,13 @@
 #! /usr/bin/env bash
 
-# DESCRIPTION
 # Applies basic system settings.
 
-# SETTINGS
 set -o nounset
 set -o errexit
 set -o pipefail
 IFS=$'\n\t'
 SCRIPT_PATH="$MAC_OS_CONFIG_PATH/bin/apply_basic_settings"
 
-# EXECUTION
 if [[ -x "$SCRIPT_PATH" ]]; then
   "$SCRIPT_PATH"
 else

bin/apply_default_settings

@@ -1,16 +1,13 @@
 #! /usr/bin/env bash
 
-# DESCRIPTION
 # Applies default settings.
 
-# SETTINGS
 set -o nounset
 set -o errexit
 set -o pipefail
 IFS=$'\n\t'
 SCRIPT_PATH="$MAC_OS_CONFIG_PATH/bin/apply_default_settings"
 
-# EXECUTION
 if [[ -x "$SCRIPT_PATH" ]]; then
   "$SCRIPT_PATH"
 else

bin/create_boot_disk

@@ -1,19 +1,19 @@
 #! /usr/bin/env bash
 
-# DESCRIPTION
 # Creates macOS boot disk.
 
-# EXECUTION
 printf "macOS Boot Disk Tips\n"
-printf "  - Use a USB drive (8GB or higher is best).\n"
+printf "  - Use a USB drive (8GB or higher).\n"
-printf "  - Use Disk Utility to format the USB drive (Use \"Untitled\" for the label).\n"
+printf "  - Use Disk Utility to format the USB drive as \"Mac OS Extended (Journaled)\".\n"
+printf "  - Use Disk Utility to label the USB drive as \"Untitled\".\n"
 printf "\nmacOS Boot Disk Usage:\n"
 printf "  1. Insert the USB boot disk into the machine to be upgraded.\n"
 printf "  2. Reboot the machine.\n"
 printf "  3. Hold down the OPTION key before the Apple logo appears.\n"
 printf "  4. Select the USB boot disk from the menu.\n"
-printf "  5. Format the machine's internal drive using Disk Utility.\n"
+printf "  5. Use Disk Utility to delete and/or erase the hard drive including associated partitions.\n"
-printf "  6. Install the new operating system.\n"
+printf "  6. Use Disk Utility to create a single \"APFS\" drive as a \"GUID Partition Table\".\n"
+printf "  7. Install the new operating system.\n"
 printf "\nmacOS Reinstall:\n"
 printf "  1. Click the Apple icon from the operating system main menu.\n"
 printf "  2. Select the \"Restart...\" menu option.\n"
@@ -23,8 +23,8 @@ printf "  5. Use the dialog options to launch Disk Utility, reinstall the system
 
 printf "\nCreating macOS boot disk...\n"
 
-if [[ ! -d "$MAC_OS_INSTALLER_PATH" ]]; then
+if [[ ! -e "$MAC_OS_BOOT_DISK_CREATOR" ]]; then
-  printf "ERROR: macOS installer does not exist: $MAC_OS_INSTALLER_PATH. Use the App Store to download.\n"
+  printf "ERROR: macOS installer does not exist: $MAC_OS_BOOT_DISK_CREATOR. Use System Preferences → Software Update to download.\n"
   exit 1
 fi
 
@@ -33,4 +33,4 @@ if [[ ! -d "$MAC_OS_BOOT_DISK_PATH" ]]; then
   exit 1
 fi
 
-sudo "$MAC_OS_BOOT_DISK_CREATOR" --volume "$MAC_OS_BOOT_DISK_PATH" --applicationpath "$MAC_OS_INSTALLER_PATH" --nointeraction
+sudo "$MAC_OS_BOOT_DISK_CREATOR" --volume "$MAC_OS_BOOT_DISK_PATH" --downloadassets --nointeraction

bin/install_app_store

@@ -1,16 +1,13 @@
 #! /usr/bin/env bash
 
-# DESCRIPTION
 # Installs App Store software.
 
-# SETTINGS
 set -o nounset
 set -o errexit
 set -o pipefail
 IFS=$'\n\t'
 SCRIPT_PATH="$MAC_OS_CONFIG_PATH/bin/install_app_store"
 
-# EXECUTION
 if [[ -x "$SCRIPT_PATH" ]]; then
   "$SCRIPT_PATH"
 else

bin/install_applications

@@ -1,16 +1,13 @@
 #! /usr/bin/env bash
 
-# DESCRIPTION
 # Installs applications.
 
-# SETTINGS
 set -o nounset
 set -o errexit
 set -o pipefail
 IFS=$'\n\t'
 SCRIPT_PATH="$MAC_OS_CONFIG_PATH/bin/install_applications"
 
-# EXECUTION
 if [[ -x "$SCRIPT_PATH" ]]; then
   "$SCRIPT_PATH"
 else

bin/install_dev_tools

@@ -1,16 +1,13 @@
 #! /usr/bin/env bash
 
-# DESCRIPTION
 # Installs development tooling requirements.
 
 printf "Installing Xcode CLI tools...\n"
 xcode-select --install
 
-read -p "Have you completed the Xcode CLI tools install (y/n)? " response
+printf "%s\n" "💡 ALT+TAB to view and accept Xcode license window."
-if [[ "$response" != "y" ]]; then
+read -p "Have you completed the Xcode CLI tools install (y/n)? " xcode_response
+if [[ "$xcode_response" != "y" ]]; then
   printf "ERROR: Xcode CLI tools must be installed before proceeding.\n"
   exit 1
 fi
-
-printf "Installing Java...\n"
-install_java "$JAVA_URL" "$JAVA_VOLUME_NAME"

bin/install_extensions

@@ -1,16 +1,13 @@
 #! /usr/bin/env bash
 
-# DESCRIPTION
 # Installs application extensions.
 
-# SETTINGS
 set -o nounset
 set -o errexit
 set -o pipefail
 IFS=$'\n\t'
 SCRIPT_PATH="$MAC_OS_CONFIG_PATH/bin/install_extensions"
 
-# EXECUTION
 if [[ -x "$SCRIPT_PATH" ]]; then
   "$SCRIPT_PATH"
 else

bin/install_homebrew

@@ -1,18 +0,0 @@
-#! /usr/bin/env bash
-
-# DESCRIPTION
-# Installs Homebrew software.
-
-# SETTINGS
-set -o nounset
-set -o errexit
-set -o pipefail
-IFS=$'\n\t'
-SCRIPT_PATH="$MAC_OS_CONFIG_PATH/bin/install_homebrew"
-
-# EXECUTION
-if [[ -x "$SCRIPT_PATH" ]]; then
-  "$SCRIPT_PATH"
-else
-  printf "WARNING: Homebrew install script does not exist or is not executable.\n"
-fi

bin/install_homebrew_casks

@@ -0,0 +1,15 @@
+#! /usr/bin/env bash
+
+# Installs Homebrew Cask software.
+
+set -o nounset
+set -o errexit
+set -o pipefail
+IFS=$'\n\t'
+SCRIPT_PATH="$MAC_OS_CONFIG_PATH/bin/install_homebrew_casks"
+
+if [[ -x "$SCRIPT_PATH" ]]; then
+  "$SCRIPT_PATH"
+else
+  printf "WARNING: Homebrew Casks install script does not exist or is not executable.\n"
+fi

bin/install_homebrew_formulas

@@ -0,0 +1,15 @@
+#! /usr/bin/env bash
+
+# Installs Homebrew Formula software.
+
+set -o nounset
+set -o errexit
+set -o pipefail
+IFS=$'\n\t'
+SCRIPT_PATH="$MAC_OS_CONFIG_PATH/bin/install_homebrew_formulas"
+
+if [[ -x "$SCRIPT_PATH" ]]; then
+  "$SCRIPT_PATH"
+else
+  printf "WARNING: Homebrew Formulas install script does not exist or is not executable.\n"
+fi

bin/restore_backup

@@ -1,16 +1,13 @@
 #! /usr/bin/env bash
 
-# DESCRIPTION
 # Performs restoration of backup data.
 
-# SETTINGS
 set -o nounset
 set -o errexit
 set -o pipefail
 IFS=$'\n\t'
 SCRIPT_PATH="$MAC_OS_CONFIG_PATH/bin/restore_backup"
 
-# EXECUTION
 if [[ -x "$SCRIPT_PATH" ]]; then
   "$SCRIPT_PATH"
 else

bin/run

@@ -1,16 +1,10 @@
 #! /usr/bin/env bash
 
-# DESCRIPTION
 # Executes the command line interface.
 
-# USAGE
-# ./run.sh OPTION
-
-# LIBRARY
 source lib/installers.sh
 source lib/options.sh
 source lib/reinstallers.sh
-source lib/restorers.sh
 source lib/settings.sh
 source lib/uninstallers.sh
 source lib/utilities.sh
@@ -29,7 +23,6 @@ else
   exit 1
 fi
 
-# EXECUTION
 while true; do
   if [[ $# == 0 ]]; then
     printf "\nUsage: run OPTION\n"
@@ -39,7 +32,8 @@ while true; do
     printf "  Install:\n"
     printf "     b:  Apply basic settings.\n"
     printf "     t:  Install development tools.\n"
-    printf "    h:  Install Homebrew software.\n"
+    printf "    hf:  Install Homebrew Formulas.\n"
+    printf "    hc:  Install Homebrew Casks.\n"
     printf "     m:  Install Mac App Store software.\n"
     printf "     a:  Install application software.\n"
     printf "     x:  Install application software extensions.\n"

bin/setup_software

@@ -1,16 +1,13 @@
 #! /usr/bin/env bash
 
-# DESCRIPTION
 # Sets up and launches (if necessary) installed software.
 
-# SETTINGS
 set -o nounset
 set -o errexit
 set -o pipefail
 IFS=$'\n\t'
 SCRIPT_PATH="$MAC_OS_CONFIG_PATH/bin/setup_software"
 
-# EXECUTION
 if [[ -x "$SCRIPT_PATH" ]]; then
   "$SCRIPT_PATH"
 else

circle.yml

@@ -0,0 +1,62 @@
+version: 2
+jobs:
+  build:
+    working_directory: ~/project
+    docker:
+      - image: circleci/ruby
+        environment:
+          BUNDLE_JOBS: 3
+          BUNDLE_RETRY: 3
+          BUNDLE_PATH: vendor/bundle
+          EDITOR: vim
+    steps:
+      - checkout
+
+      - run:
+          name: Environment Setup
+          command: |
+            printf "%s\n" 'export CI_RUBY_VERSION=$(cat ".ruby-version" | tr -d "\n")' >> $BASH_ENV
+
+      - type: cache-restore
+        name: Ruby Restore
+        key: ruby-{{checksum ".ruby-version"}}
+
+      - run:
+          name: Ruby Install
+          command: |
+            cd ..
+            curl https://cache.ruby-lang.org/pub/ruby/${CI_RUBY_VERSION::-2}/ruby-$CI_RUBY_VERSION.tar.gz > ruby-$CI_RUBY_VERSION.tar.gz
+            tar --extract --gzip --verbose --file ruby-$CI_RUBY_VERSION.tar.gz
+            cd ruby-$CI_RUBY_VERSION
+            ./configure
+            make
+            make update-gems
+            make extract-gems
+            sudo make install
+
+      - type: cache-save
+        name: Ruby Store
+        key: ruby-{{checksum ".ruby-version"}}
+        paths:
+          - ../ruby-$CI_RUBY_VERSION
+
+      - type: cache-restore
+        name: Bundler Restore
+        key: bundler-{{checksum "Gemfile"}}
+
+      - run:
+          name: Bundler Install
+          command: |
+            gem update --system
+            bundle config set path "vendor/bundle"
+            bundle install
+
+      - type: cache-save
+        name: Bundler Store
+        key: bundler-{{checksum "Gemfile"}}
+        paths:
+          - vendor/bundle
+
+      - run:
+          name: Build
+          command: bundle exec rake

lib/installers.sh

@@ -1,149 +1,19 @@
 #! /usr/bin/env bash
 
-# DESCRIPTION
 # Defines software installer functions.
 
-# Mounts a disk image.
-# Parameters:
-# $1 = The image path.
-mount_image() {
-  printf "Mounting image...\n"
-  hdiutil attach -quiet -nobrowse -noautoopen "$1"
-}
-export -f mount_image
-
-# Unmounts a disk image.
-# Parameters:
-# $1 = The mount path.
-unmount_image() {
-  printf "Unmounting image...\n"
-  hdiutil detach -force "$1"
-}
-export -f unmount_image
-
-# Downloads an installer to local disk.
-# Parameters:
-# $1 = The URL.
-# $2 = The file name.
-# $3 = The HTTP header.
-download_installer() {
-  local url="$1"
-  local file_name="$2"
-  local http_header="$3"
-
-  printf "%s\n" "Downloading $1..."
-  clean_work_path
-  mkdir $MAC_OS_WORK_PATH
-  curl --header "$http_header" --location --retry 3 --retry-delay 5 --fail --silent --show-error "$url" >> "$MAC_OS_WORK_PATH/$file_name"
-}
-export -f download_installer
-
-# Downloads an installer to the $HOME/Downloads folder for manual use.
-# Parameters:
-# $1 = The URL.
-# $2 = The file name.
-download_only() {
-  if [[ -e "$HOME/Downloads/$2" ]]; then
-    printf "Downloaded: $2.\n"
-  else
-    printf "Downloading $1...\n"
-    download_installer "$1" "$2"
-    mv "$MAC_OS_WORK_PATH/$2" "$HOME/Downloads"
-  fi
-}
-export -f download_only
-
-# Installs a single file.
-# Parameters:
-# $1 = The URL.
-# $2 = The install path.
-install_file() {
-  local file_url="$1"
-  local file_name=$(get_file_name "$1")
-  local install_path="$2"
-
-  if [[ ! -e "$install_path" ]]; then
-    printf "Installing: $install_path...\n"
-    download_installer "$file_url" "$file_name"
-    mkdir -p $(dirname "$install_path")
-    mv "$MAC_OS_WORK_PATH/$file_name" "$install_path"
-    printf "Installed: $file_name.\n"
-    verify_path "$install_path"
-  fi
-}
-export -f install_file
-
-# Installs an application.
-# Parameters:
-# $1 = The application source path.
-# $2 = The application name.
-install_app() {
-  local install_root=$(get_install_root "$2")
-  local file_extension=$(get_file_extension "$2")
-
-  printf "Installing: $install_root/$2...\n"
-
-  case $file_extension in
-    'app')
-      cp -a "$1/$2" "$install_root";;
-    'prefPane')
-      sudo cp -pR "$1/$2" "$install_root";;
-    'qlgenerator')
-      sudo cp -pR "$1/$2" "$install_root" && qlmanage -r;;
-    *)
-      printf "ERROR: Unknown file extension: $file_extension.\n"
-  esac
-}
-export -f install_app
-
-# Installs a package.
-# Parameters:
-# $1 = The package source path.
-# $2 = The application name.
-install_pkg() {
-  local install_root=$(get_install_root "$2")
-
-  printf "Installing: $install_root/$2...\n"
-  local package=$(sudo find "$1" -maxdepth 1 -type f -name "*.pkg" -o -name "*.mpkg")
-  sudo installer -pkg "$package" -target /
-}
-export -f install_pkg
-
-# Installs Java.
-# Parameters:
-# $1 = The URL.
-# $2 = The volume name.
-install_java() {
-  local url="$1"
-  local volume_path="/Volumes/$2"
-  local app_name="java"
-  local install_path="/usr/bin/$app_name"
-  local download_file="download.dmg"
-
-  download_installer "$url" "$download_file" "Cookie: oraclelicense=accept-securebackup-cookie"
-  mount_image "$MAC_OS_WORK_PATH/$download_file"
-  local package=$(sudo find "$volume_path" -maxdepth 1 -type f -name "*.pkg")
-  sudo installer -pkg "$package" -target /
-  unmount_image "$volume_path"
-  printf "Installed: $app_name.\n"
-}
-export -f install_java
-
 # Installs an application via a DMG file.
-# Parameters:
+# Parameters: $1 (required) - URL, $2 (required) - Mount path, $3 (required) - Application name.
-# $1 = The URL.
-# $2 = The mount path.
-# $3 = The application name.
 install_dmg_app() {
   local url="$1"
   local mount_point="/Volumes/$2"
   local app_name="$3"
   local install_path=$(get_install_path "$app_name")
-  local download_file="download.dmg"
+  local work_file="download.dmg"
 
   if [[ ! -e "$install_path" ]]; then
-    download_installer "$url" "$download_file"
+    download_file "$url" "$work_file"
-    mount_image "$MAC_OS_WORK_PATH/$download_file"
+    mount_image "$MAC_OS_WORK_PATH/$work_file"
     install_app "$mount_point" "$app_name"
     unmount_image "$mount_point"
     verify_application "$app_name"
@@ -152,20 +22,17 @@ install_dmg_app() {
 export -f install_dmg_app
 
 # Installs a package via a DMG file.
-# Parameters:
+# Parameters: $1 (required) - URL, $2 (required) - Mount path, $3 (required) - Application name.
-# $1 = The URL.
-# $2 = The mount path.
-# $3 = The application name.
 install_dmg_pkg() {
   local url="$1"
   local mount_point="/Volumes/$2"
   local app_name="$3"
   local install_path=$(get_install_path "$app_name")
-  local download_file="download.dmg"
+  local work_file="download.dmg"
 
   if [[ ! -e "$install_path" ]]; then
-    download_installer "$url" "$download_file"
+    download_file "$url" "$work_file"
-    mount_image "$MAC_OS_WORK_PATH/$download_file"
+    mount_image "$MAC_OS_WORK_PATH/$work_file"
     install_pkg "$mount_point" "$app_name"
     unmount_image "$mount_point"
     printf "Installed: $app_name.\n"
@@ -175,22 +42,21 @@ install_dmg_pkg() {
 export -f install_dmg_pkg
 
 # Installs an application via a zip file.
-# Parameters:
+# Parameters: $1 (required) - URL, $2 (required) - Application name.
-# $1 = The URL.
-# $2 = The application name.
 install_zip_app() {
   local url="$1"
   local app_name="$2"
   local install_path=$(get_install_path "$app_name")
-  local download_file="download.zip"
+  local work_file="download.zip"
 
   if [[ ! -e "$install_path" ]]; then
-    download_installer "$url" "$download_file"
+    download_file "$url" "$work_file"
 
     (
       printf "Preparing...\n"
       cd "$MAC_OS_WORK_PATH"
-      unzip -q "$download_file"
+      unzip -q "$work_file"
+      find . -type d -name "$app_name" -print -exec cp -pR {} . > /dev/null 2>&1 \;
     )
 
     install_app "$MAC_OS_WORK_PATH" "$app_name"
@@ -200,51 +66,21 @@ install_zip_app() {
 }
 export -f install_zip_app
 
-# Installs an application via a tar file.
-# Parameters:
-# $1 = The URL.
-# $2 = The application name.
-# $3 = The decompress options.
-install_tar_app() {
-  local url="$1"
-  local app_name="$2"
-  local options="$3"
-  local install_path=$(get_install_path "$app_name")
-  local download_file="download.tar"
-
-  if [[ ! -e "$install_path" ]]; then
-    download_installer "$url" "$download_file"
-
-    (
-      printf "Preparing...\n"
-      cd "$MAC_OS_WORK_PATH"
-      tar "$options" "$download_file"
-    )
-
-    install_app "$MAC_OS_WORK_PATH" "$app_name"
-    printf "Installed: $app_name.\n"
-    verify_application "$app_name"
-  fi
-}
-export -f install_tar_app
-
 # Installs a package via a zip file.
-# Parameters:
+# Parameters: $1 (required) - URL, $2 (required) - Application name.
-# $1 = The URL.
-# $2 = The application name.
 install_zip_pkg() {
   local url="$1"
   local app_name="$2"
   local install_path=$(get_install_path "$app_name")
-  local download_file="download.zip"
+  local work_file="download.zip"
 
   if [[ ! -e "$install_path" ]]; then
-    download_installer "$url" "$download_file"
+    download_file "$url" "$work_file"
 
     (
       printf "Preparing...\n"
       cd "$MAC_OS_WORK_PATH"
-      unzip -q "$download_file"
+      unzip -q "$work_file"
     )
 
     install_pkg "$MAC_OS_WORK_PATH" "$app_name"
@@ -254,14 +90,53 @@ install_zip_pkg() {
 }
 export -f install_zip_pkg
 
+# Installs an application via a tar file.
+# Parameters: $1 (required) - URL, $2 (required) - Application name, $3 (required) - Decompress options.
+install_tar_app() {
+  local url="$1"
+  local app_name="$2"
+  local options="$3"
+  local install_path=$(get_install_path "$app_name")
+  local work_file="download.tar"
+
+  if [[ ! -e "$install_path" ]]; then
+    download_file "$url" "$work_file"
+
+    (
+      printf "Preparing...\n"
+      cd "$MAC_OS_WORK_PATH"
+      tar "$options" "$work_file"
+    )
+
+    install_app "$MAC_OS_WORK_PATH" "$app_name"
+    printf "Installed: $app_name.\n"
+    verify_application "$app_name"
+  fi
+}
+export -f install_tar_app
+
+# Installs program (single file).
+# Parameters: $1 (required) - URL, $2 (required) - Program name.
+install_program() {
+  local url="$1"
+  local program_name="$2"
+  local install_path=$(get_install_path "$program_name")
+
+  if [[ ! -e "$install_path" ]]; then
+    download_file "$url" "$program_name"
+    mv "$MAC_OS_WORK_PATH/$program_name" "$install_path"
+    chmod 755 "$install_path"
+    printf "Installed: $program_name.\n"
+    verify_application "$program_name"
+  fi
+}
+export -f install_program
+
 # Installs application code from a Git repository.
-# Parameters:
+# Parameters: $1 (required) - Repository URL, $2 (required) - Install path, $3 (optional) - Git clone options.
-# $1 = Repository URL.
-# $2 = Install path.
-# $3 = Git clone options (if any).
 install_git_app() {
   local repository_url="$1"
-  local app_name=$(get_file_name "$2")
+  local app_name=$(get_basename "$2")
   local install_path="$2"
   local options="--quiet"
 
@@ -279,11 +154,7 @@ install_git_app() {
 export -f install_git_app
 
 # Installs settings from a Git repository.
-# Parameters:
+# Parameters: $1 (required) - Repository URL, $2 (required) - Repository version, $3 (required) - Project directory, $4 (required) - Script to run (including any arguments).
-# $1 = The repository URL.
-# $2 = The repository version.
-# $3 = The project directory.
-# $4 = The script to run (including any arguments).
 install_git_project() {
   local repo_url="$1"
   local repo_version="$2"
@@ -293,9 +164,90 @@ install_git_project() {
   git clone "$repo_url"
   (
     cd "$project_dir"
-    git checkout "$repo_version"
+    git -c advice.detachedHead=false checkout "$repo_version"
     eval "$script"
   )
   rm -rf "$project_dir"
 }
 export -f install_git_project
+
+# Installs a single file.
+# Parameters: $1 (required) - URL, $2 (required) - Install path.
+install_file() {
+  local file_url="$1"
+  local file_name=$(get_basename "$1")
+  local install_path="$2"
+
+  if [[ ! -e "$install_path" ]]; then
+    download_file "$file_url" "$file_name"
+    mkdir -p $(dirname "$install_path")
+    mv "$MAC_OS_WORK_PATH/$file_name" "$install_path"
+    printf "Installed: $file_name.\n"
+    verify_path "$install_path"
+  fi
+}
+export -f install_file
+
+# Downloads remote file to local disk.
+# Parameters: $1 (required) - URL, $2 (required) - File name, $3 (optional) - HTTP header.
+download_file() {
+  local url="$1"
+  local file_name="$2"
+  local http_header="$3"
+
+  printf "%s\n" "Downloading $1..."
+  clean_work_path
+  mkdir $MAC_OS_WORK_PATH
+  curl --header "$http_header" --location --retry 3 --retry-delay 5 --fail --silent --show-error "$url" >> "$MAC_OS_WORK_PATH/$file_name"
+}
+export -f download_file
+
+# Installs an application.
+# Parameters: $1 (required) - Application source path, $2 (required) - Application name.
+install_app() {
+  local install_root=$(get_install_root "$2")
+  local file_extension=$(get_extension "$2")
+
+  printf "Installing: $install_root/$2...\n"
+
+  case $file_extension in
+    '')
+      cp -a "$1/$2" "$install_root";;
+    'app')
+      cp -a "$1/$2" "$install_root";;
+    'prefPane')
+      sudo cp -pR "$1/$2" "$install_root";;
+    'qlgenerator')
+      sudo cp -pR "$1/$2" "$install_root" && qlmanage -r;;
+    *)
+      printf "ERROR: Unknown file extension: $file_extension.\n"
+  esac
+}
+export -f install_app
+
+# Installs a package.
+# Parameters: $1 (required) - Package source path, $2 (required) - Application name.
+install_pkg() {
+  local install_root=$(get_install_root "$2")
+
+  printf "Installing: $install_root/$2...\n"
+  local package=$(sudo find "$1" -maxdepth 1 -type f -name "*.pkg" -o -name "*.mpkg")
+  sudo installer -pkg "$package" -target /
+}
+export -f install_pkg
+
+# Mounts a disk image.
+# Parameters: $1 (required) - Image path.
+mount_image() {
+  printf "Mounting image...\n"
+  hdiutil attach -quiet -nobrowse -noautoopen "$1"
+}
+export -f mount_image
+
+# Unmounts a disk image.
+# Parameters: $1 (required) - Mount path.
+unmount_image() {
+  printf "Unmounting image...\n"
+  hdiutil detach -force "$1"
+}
+export -f unmount_image

lib/options.sh

@@ -1,11 +1,9 @@
 #! /usr/bin/env bash
 
-# DESCRIPTION
 # Defines command line prompt options.
 
 # Process option selection.
-# Parameters:
+# Parameters: $1 (required) - The option to process.
-# $1 = The option to process.
 process_option() {
   case $1 in
     'B')
@@ -14,8 +12,10 @@ process_option() {
       bin/apply_basic_settings;;
     't')
       bin/install_dev_tools;;
-    'h')
+    'hf')
-      bin/install_homebrew;;
+      bin/install_homebrew_formulas;;
+    'hc')
+      bin/install_homebrew_casks;;
     'm')
       bin/install_app_store;;
     'a')
@@ -30,7 +30,8 @@ process_option() {
       caffeinate_machine
       bin/apply_basic_settings
       bin/install_dev_tools
-      bin/install_homebrew
+      bin/install_homebrew_formulas
+      bin/install_homebrew_casks
       bin/install_app_store
       bin/install_applications
       bin/install_extensions
@@ -38,9 +39,12 @@ process_option() {
       bin/setup_software
       clean_work_path;;
     'R')
+      caffeinate_machine
       bin/restore_backup;;
     'c')
-      verify_homebrews
+      verify_homebrew_formulas
+      verify_homebrew_casks
+      verify_app_store_applications
       verify_applications
       verify_extensions;;
     'C')

lib/reinstallers.sh

@@ -1,6 +1,5 @@
 #! /usr/bin/env bash
 
-# DESCRIPTION
 # Defines reinstall functions.
 
 # Reinstall application.

lib/restorers.sh

@@ -1,31 +0,0 @@
-#! /usr/bin/env bash
-
-# DESCRIPTION
-# Defines software restore functions.
-
-# Label: Restore Preference
-# Description: Restores an application preference.
-# Parameters: $1 (required) - The backup volume root path, $2 (required) - The preference file.
-restore_preference() {
-  local backup_root="$1"
-  local preference_file="$2"
-  local backup_path="$backup_root/Users/$USER/Library/Preferences/$preference_file"
-  local restore_root="$HOME/Library/Preferences"
-
-  cp -p "$backup_path" "$restore_root"
-}
-export -f restore_preference
-
-# Label: Restore Application Support
-# Description: Restores application support files.
-# Parameters: $1 (required) - The backup volume root path, $2 required - The application name.
-restore_app_support() {
-  local backup_root="$1"
-  local app_name="$2"
-  local backup_path="$backup_root/Users/$USER/Library/Application Support/$app_name"
-  local restore_path="$HOME/Library/Application Support"
-
-  mkdir -p "$restore_path"
-  cp -pR "$backup_path" "$restore_path"
-}
-export -f restore_app_support

lib/settings.sh

@@ -1,22 +1,11 @@
 #! /usr/bin/env bash
 
-# DESCRIPTION
-# Defines global settings.
-
-# SETTINGS
-# General
 set -o nounset
 set -o errexit
 set -o pipefail
 IFS=$'\n\t'
 
-# Globals
+export MAC_OS_BOOT_DISK_CREATOR="/Applications/Install macOS Big Sur.app/Contents/Resources/createinstallmedia"
-export MAC_OS_BOOT_DISK_CREATOR="/Applications/Install macOS Sierra.app/Contents/Resources/createinstallmedia"
 export MAC_OS_BOOT_DISK_PATH="/Volumes/Untitled"
-export MAC_OS_INSTALLER_PATH="/Applications/Install macOS Sierra.app"
 export MAC_OS_WORK_PATH=/tmp/downloads
 export MAC_OS_CONFIG_PATH="../mac_os-config"
-
-# Java
-export JAVA_VOLUME_NAME="JDK 8 Update 101"
-export JAVA_URL="http://download.oracle.com/otn-pub/java/jdk/8u101-b13/jdk-8u101-macosx-x64.dmg"

lib/uninstallers.sh

@@ -1,6 +1,5 @@
 #! /usr/bin/env bash
 
-# DESCRIPTION
 # Defines uninstall functions.
 
 # Uninstalls selected application.

lib/utilities.sh

@@ -1,37 +1,40 @@
 #! /usr/bin/env bash
 
-# DESCRIPTION
 # Defines general utility functions.
 
-# Answers the file name.
+# Caffeinate machine.
-# Parameters:
+caffeinate_machine() {
-# $1 = The file path.
+  local pid=$(pgrep -x caffeinate)
-get_file_name() {
-  printf "${1##*/}" # Answers file or directory name.
-}
-export -f get_file_name
 
-# Answers the file extension.
+  if [[ -n "$pid" ]]; then
-# Parameters:
+    printf "Machine is already caffeinated!\n"
-# $1 = The file name.
-get_file_extension() {
-  local name=$(get_file_name "$1")
-  local extension="${1##*.}" # Excludes dot.
-
-  if [[ "$name" == "$extension" ]]; then
-    printf ''
   else
-    printf "$extension"
+    caffeinate -s -u -d -i -t 3153600000 > /dev/null &
+    printf "Machine caffeinated.\n"
   fi
 }
-export -f get_file_extension
+export -f caffeinate_machine
+
+# Answers the full install path (including file name) for file name.
+# Parameters: $1 (required) - The file name.
+get_install_path() {
+  local file_name="$1"
+  local install_path=$(get_install_root "$file_name")
+  printf "$install_path/$file_name"
+}
+export -f get_install_path
+
+# Cleans work path for temporary processing of installs.
+clean_work_path() {
+  rm -rf "$MAC_OS_WORK_PATH"
+}
+export -f clean_work_path
 
 # Answers the root install path for file name.
-# Parameters:
+# Parameters: $1 (required) - The file name.
-# $1 = The file name.
 get_install_root() {
   local file_name="$1"
-  local file_extension=$(get_file_extension "$file_name")
+  local file_extension=$(get_extension "$file_name")
 
   # Dynamically build the install path based on file extension.
   case $file_extension in
@@ -49,31 +52,23 @@ get_install_root() {
 }
 export -f get_install_root
 
-# Answers the full install path (including file name) for file name.
+# Answers the file or directory basename.
-# Parameters:
+# Parameters: $1 (required) - The file path.
-# $1 = The file name.
+get_basename() {
-get_install_path() {
+  printf "${1##*/}" # Answers file or directory name.
-  local file_name="$1"
-  local install_path=$(get_install_root "$file_name")
-  printf "$install_path/$file_name"
 }
-export -f get_install_path
+export -f get_basename
 
-# Cleans work path for temporary processing of installs.
+# Answers the file extension.
-clean_work_path() {
+# Parameters: $1 (required) - The file name.
-  rm -rf "$MAC_OS_WORK_PATH"
+get_extension() {
-}
+  local name=$(get_basename "$1")
-export -f clean_work_path
+  local extension="${1##*.}" # Excludes dot.
 
-# Caffeinate machine.
+  if [[ "$name" == "$extension" ]]; then
-caffeinate_machine() {
+    printf ''
-  local pid=$(ps aux | grep caffeinate | grep -v grep | awk '{print $2}')
-
-  if [[ -n "$pid" ]]; then
-    printf "Whoa, tweaker, machine is already caffeinated!\n"
   else
-    caffeinate -s -u -d -i -t 3153600000 > /dev/null &
+    printf "$extension"
-    printf "Machine caffeinated.\n"
   fi
 }
-export -f caffeinate_machine
+export -f get_extension

lib/verifiers.sh

@@ -1,29 +1,14 @@
 #! /usr/bin/env bash
 
-# DESCRIPTION
 # Defines verification/validation functions.
 
-# Verifies Homebrew software exists.
+# Checks for missing Homebrew formulas.
-# Parameters:
+verify_homebrew_formulas() {
-# $1 = The file name.
+  printf "Checking Homebrew formulas...\n"
-verify_homebrew() {
-  local application="$1"
-  local applications="$2"
-
-  if [[ "${applications[*]}" != *"$application"* ]]; then
-    printf " - Missing: $application\n"
-  fi
-}
-export -f verify_homebrew
-
-# Checks for missing Homebrew software.
-verify_homebrews() {
-  printf "Checking Homebrew software...\n"
 
   local applications="$(brew list)"
 
   while read line; do
-    # Skip blank or comment lines.
     if [[ "$line" == "brew install"* ]]; then
       local application=$(printf "$line" | awk '{print $3}')
 
@@ -32,33 +17,59 @@ verify_homebrews() {
         application="gnupg"
       fi
 
-      # Exception: "hg" is the binary but is listed as "mercurial".
+      verify_listed_application "$application" "${applications[*]}"
-      if [[ "$application" == "hg" ]]; then
-        application="mercurial"
     fi
+  done < "$MAC_OS_CONFIG_PATH/bin/install_homebrew_formulas"
 
-      verify_homebrew "$application" "${applications[*]}"
+  printf "Homebrew formula check complete.\n"
-    fi
-  done < "$MAC_OS_CONFIG_PATH/bin/install_homebrew"
-
-  printf "Homebrew check complete.\n"
 }
-export -f verify_homebrews
+export -f verify_homebrew_formulas
 
-# Verifies application exists.
+# Checks for missing Homebrew casks.
-# Parameters:
+verify_homebrew_casks() {
-# $1 = The file name.
+  printf "\nChecking Homebrew casks...\n"
-verify_application() {
-  local file_name="$1"
 
-  # Display the missing install if not found.
+  local applications="$(brew list --cask)"
-  local install_path=$(get_install_path "$file_name")
 
-  if [[ ! -e "$install_path" ]]; then
+  while read line; do
-    printf " - Missing: $file_name\n"
+    if [[ "$line" == "brew cask install"* ]]; then
+      local application=$(printf "$line" | awk '{print $4}')
+      verify_listed_application "$application" "${applications[*]}"
+    fi
+  done < "$MAC_OS_CONFIG_PATH/bin/install_homebrew_casks"
+
+  printf "Homebrew cask check complete.\n"
+}
+export -f verify_homebrew_casks
+
+# Checks for missing App Store applications.
+verify_app_store_applications() {
+  printf "\nChecking App Store applications...\n"
+
+  local applications="$(mas list)"
+
+  while read line; do
+    if [[ "$line" == "mas install"* ]]; then
+      local application=$(printf "$line" | awk '{print $3}')
+      verify_listed_application "$application" "${applications[*]}"
+    fi
+  done < "$MAC_OS_CONFIG_PATH/bin/install_app_store"
+
+  printf "App Store check complete.\n"
+}
+export -f verify_app_store_applications
+
+# Verifies listed application exists.
+# Parameters: $1 (required) - The current application, $2 (required) - The application list.
+verify_listed_application() {
+  local application="$1"
+  local applications="$2"
+
+  if [[ "${applications[*]}" != *"$application"* ]]; then
+    printf " - Missing: $application\n"
   fi
 }
-export -f verify_application
+export -f verify_listed_application
 
 # Checks for missing applications suffixed by "APP_NAME" as defined in settings.sh.
 verify_applications() {
@@ -69,7 +80,6 @@ verify_applications() {
 
   # For each application name, check to see if the application is installed. Otherwise, skip.
   for name in $file_names; do
-    # Pass the key value to verfication.
     verify_application "${!name}"
   done
 
@@ -77,18 +87,17 @@ verify_applications() {
 }
 export -f verify_applications
 
-# Verifies path exists.
+# Verifies application exists.
-# Parameters:
+# Parameters: $1 (required) - The file name.
-# $1 = The path.
+verify_application() {
-verify_path() {
+  local file_name="$1"
-  local path="$1"
+  local install_path=$(get_install_path "$file_name")
 
-  # Display the missing path if not found.
+  if [[ ! -e "$install_path" ]]; then
-  if [[ ! -e "$path" ]]; then
+    printf " - Missing: $file_name\n"
-    printf " - Missing: $path\n"
   fi
 }
-export -f verify_path
+export -f verify_application
 
 # Checks for missing extensions suffixed by "EXTENSION_PATH" as defined in settings.sh.
 verify_extensions() {
@@ -106,3 +115,14 @@ verify_extensions() {
   printf "Application extension check complete.\n"
 }
 export -f verify_extensions
+
+# Verifies path exists.
+# Parameters: $1 (required) - The path.
+verify_path() {
+  local path="$1"
+
+  if [[ ! -e "$path" ]]; then
+    printf " - Missing: $path\n"
+  fi
+}
+export -f verify_path