SaisonBuilder:
a Nashville Software School capstone project
SaisonBuilder is my Unit 2 (Ruby) Capstone project for Nashville Software School Software Development Fundamentals course.
The constraints of the project are that they must use standard library Ruby with the exception of using ActiveRecord as an ORM. The concept with this capstone is to demonstrate mastery of Ruby itself.
The goal of this project is to create an app to help novice and veteran homebrewers alike navigate the nearly-limitless options available when designing and brewing an all-grain Saison, or Belgian Farmhouse ale.
Migrations/models in place.
Seed files in place.
The following commands are fully functional:
- ruby sb
- ruby sb style
- ruby sb techniques
- ruby sb ingredients
- ruby sb list
- ruby sb add ingredient
- ruby sb describe
- ruby sb modify
- ruby sb view [recipe name]
- ruby sb delete recipe [recipe name]
- ruby sb delete ingredient [ingredient name]
###To do:
- ruby sb build - implementation in progress.
- Implement build-by-ingredient functionality
- Change build & modify to take name arguments
- Allow user-generated recipe to be modified in addition to default recipes
The primary feature of this app is the ability to view one of six preloaded saison recipes, or to modify any of the six recipes to the user's custom specifications, and to save the modified recipe to the user's library. Modification are guided by a series of questions, allowing the user to make specific modifications to single elements of the recipe (ie, increase only a specific type of aroma hops, or remove a specific grain).
Additionally, a small library of ingredients and style/technique definitions is included.
In the future, saison builder will include the ability to generate recipes from the ground up, ingredient by ingredient, that can then be saved in a library for later use.
Planned usage is as follows:
To begin using the app, cd to the SaisonBuilder directory and type:
ruby sb
Optionally, add the following to your .zshrc or .bash_profile files in your root directory to open with a single 'sb' or 'saisonbuilder' command:
alias sb='ruby ~/your/file/path/sb'
alias saisonbuilder='ruby ~/your/file/path/sb'
In either case, executing the command will bring up a menu displaying the following options:
Return to this menu: ruby sb
Learn about the saison style: ruby sb style
Learn about brewing techniques: ruby sb techniques
Learn about ingredients: ruby sb ingredients
View recipe library: ruby sb list
Adding an ingredient: ruby sb add ingredient
Change or add a description: ruby sb describe
Build a new recipe: ruby sb build
Modify a recipe: ruby sb modify
View an existing recipe: ruby sb view <recipe_name>
Delete an existing recipe: ruby sb delete recipe <recipe_name>
Delete an existing ingredient: ruby sb delete ingredient <ingredient_name>
Most of these options are self-exlanatory. There are, however, several exceptions that deserve a more in-depth explanation:
Modify a recipe: ruby sb modify
When executed, sb modify guides the user through a series of questions that allow the user to change practically any aspect(s) of any of the five base recipes. After the user is finished modifying the recipe, the saved recipe can then be found in the library, and can be viewed, further modified, or deleted by the user. This process can then be repeated as often as the user wishes, for any recipe - base or modified - that is in the library.
Build a new recipe: ruby sb build
When executed, sb build displays a set of instructions on how to initiate a new recipe build. The user my then follow the instructions, and will be taken through the process of assigning a name and initial recipe parameters, adding a description, and finally, attaching individual ingredients, with quantities and usage, to the recipe. The user may add as many ingredients as he or she wishes.
Please download the app and try it out - it's free!
There will be bugs.
- 2013-5-10 - Created initial repository with README
- 2013-5-13 - Refined/fleshed out README and user_stories
- 2013-5-14 - Added initial gemfile, rakefile, bootstrap_ar, model, tests.
- 2013-5-15 - Added initial migration, db structure.
- 2013-5-18 - Added default recipe and ingredient list markdowns.
- 2013-5-19 - Implemented main menu, style, and techniques commands, seeding ingredients.
- 2013-5-20 - Implemented initial controllers, question_set module.
- 2013-5-21 - Implemented initial REPL.
- 2013-5-22 - Restructured and simplified database schema. Began work on seeding initial recipes.
- 2013-5-23 - Completed initial recipe seeding. Implemented view recipe command.
- 2013-5-24 - Fixed display bugs, streamlined recipe seeding and view method. Modify now clones base recipe.
- 2013-5-25 - Added majority of modify recipe ingredient methods.
- 2013-5-26 - Added last mod recipe ingr methods, and refactored those methods.
- 2013-5-27 - Implemented add description and remove ingredient functionality.
- 2013-5-28 - Extracted validation methods.
- 2013-5-29 - Bugfixes. Refactored initial ARGV assignment.
- 2013-5-30 - Added add/delete ingredient functionality to command line.
- 2013-5-31 - General reorganization of file structure.
- 2013-6-01 - Add ingr/recipe now takes arguments. Replaced validation methods with AR validation.
- 2013-6-02 - Solidified future app structure
- 2013-6-03 - Extensive refactoring.
I would like to thank the following NSS staff/mentors who have lent advice and perspective on this project:
- Eliza Brock
- Hassan Shamim
- Ben Bridges
- Adam Scott
- Jeff Felchner
- James Fryman
Dustin Moore
Copyright (c) 2013 Dustin Moore
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.