meal_planner 1.0.0

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2013 Peter Sumsion
+
+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.

data/README

@@ -0,0 +1,21 @@
+A program to ease and automate the planning of meals.
+
+Each meal has a main dish and optionally side dishes as well. These are currently loaded from the meals.csv file in the directory of the command line script. That will be changed in a future release when they will be loaded from a database instead.
+
+A menu consists of any number of days that the user chooses. Each day can have any meal as user wishes. When the program is run, the meals are loaded at random from the meal source and presented to the user. The user then has the option to switch out any that she doesn't want on a particular day. If two meals are given, the two meals are switched between each other. If only one meal is given, that meal is switched with another from the meal source that isn't already in the menu.
+
+When the user quits the program, the current menu is stored in a menu.txt file so that it can be printed and used in shopping, preparing meals, etc.
+
+In a future release, each dish in a meal will be associated with a recipe so that a shopping list and recipe book can be created directly from the same source.
+
+Known Issues:
+
+Switching Lunches with themselves or with other meals doesn't work well. This may need a redesign of how switch is called.
+
+If too many meals are replaced, the meal store eventually gets emptied and so meals are replaced with blanks
+
+FIXED: If more than 4 meals are planned at a time, the regular expression gathering meal numbers is no longer valid
+  This was fixed by updating the regular expression so that it accepts any numbers as long as they are comma separated.
+
+FIXED: For now, this makes it possible for invalid numbers to be entered. This is not acceptable and must be changed as it could result in loss of the entire list of planned meals because of a simple user error.
+  This was fixed by checking the gathered values to see if they are in the range covered by the planned_meals array indexes

data/bin/mealplan

@@ -0,0 +1,95 @@
+#!/usr/bin/env ruby
+
+require 'date'
+require_relative '../lib/meal_planner/validator'
+require_relative '../lib/meal_planner/meal'
+require_relative '../lib/meal_planner/menu_day'
+require_relative '../lib/meal_planner/menu'
+
+meals = []
+
+default_meals_file = File.join(File.dirname(__FILE__), 'meals.csv')
+
+File.open(default_meals_file, "r") do |file|
+  file.readlines.each { |line| meals << MealPlanner::Meal.new(line) }
+end
+
+loop do
+  puts "\nWelcome to Meal Planner"
+
+  puts "\nPlease enter the number of days to plan for"
+  number_of_days = MealPlanner::Validator.validate(/^\d+$/) do
+    puts "example: 7"
+    gets.chomp
+  end
+
+  #puts "\nPlease enter the date to start menu or Enter if today"
+  #start_date = MealPlanner::Validator.validate(/^(0{,1}[1-9]|1[0-2])\/(0{,1}[1-9]|[12][0-9]|3[01])\/\d{4}$/) do
+    #puts "example: 2/13/2013 for Feb. 13, 2013"
+    #gets.chomp
+  #end
+
+  puts "\nPlanning for #{number_of_days} days." #starting on #{start_date}."
+
+  menu = MealPlanner::Menu.new(Integer(number_of_days))
+  menu.plan(meals)
+
+  menu.each_menu_day do |menu_day|
+    puts menu_day
+  end
+
+  loop do
+
+    planned_meals = []
+    menu.each_planned_meal do |meal|
+      planned_meals << meal
+    end
+
+    puts "\nPlease enter 'quit' to exit or hit Enter key to continue"
+    command = gets.chomp
+
+    if command == 'quit'
+      File.open("menu.txt", "w") do |file|
+        menu.each_menu_day { |menu_day| file << menu_day }
+      end
+      break
+    end
+
+    puts "\nPlease choose a meal or two to switch:\n"
+    planned_meals.each_with_index do |meal, i|
+      puts "#{i} #{meal}"
+    end
+
+    validated = false
+
+    until validated do
+
+      meal_numbers_string = MealPlanner::Validator.validate(/^([0-9])([0-9]{1,})?(,([0-9])([0-9]{1,})?)?$/) do
+        puts "Example: 5\nExample: 2,4"
+        gets.chomp
+      end
+
+      meal_numbers = []
+
+      meal_numbers_string.split(",").each do |meal_number_string|
+        if (0..planned_meals.size).to_a.include? meal_number_string.to_i
+          meal_numbers << Integer(meal_number_string)
+          validated = true
+        else
+          validated = false
+        end
+      end
+    end
+
+    if meal_numbers.size == 1
+      meal1, meal2 = planned_meals[meal_numbers[0]], nil
+    else
+      meal1, meal2 = planned_meals[meal_numbers[0]], planned_meals[meal_numbers[1]]
+    end
+
+    menu.switch(meal1, meal2)
+
+    menu.each_menu_day { |menu_day| puts menu_day }
+  end
+  break
+end

data/bin/meals.csv

@@ -0,0 +1,8 @@
+Chicky and Rice
+Taco Salad
+Stuffed Chicken and Fried Potatoes
+Spaghetti
+Hot Wraps
+Taquitos, Rice, and Beans
+Hashbrowns, Saurkraut, and Bacon
+Fish, Coleslaw, and Rice

data/lib/meal_planner/array.rb

@@ -0,0 +1,12 @@
+class Array
+  def sample!(n=nil)
+    if n
+      sample = self.sample(n)
+      self.replace(self - sample)
+    else
+      sample = self.sample
+      self.delete(sample)
+    end
+    sample
+  end
+end

data/lib/meal_planner/meal.rb

@@ -0,0 +1,34 @@
+module MealPlanner
+  class Meal
+    attr_reader :main_dish
+
+    def initialize(main_dish)
+      @main_dish = main_dish
+      @sides = []
+    end
+
+    def add_side(side)
+      @sides << side
+    end
+
+    def each_side
+      if block_given?
+        @sides.each do |side|
+          yield side
+        end
+      end
+    end
+
+    def to_s
+      string = "Main Dish: #{@main_dish}"
+      each_side do |side|
+        string += ", Side: #{side}"
+      end
+      string
+    end
+
+    def ==(other)
+      @main_dish == other.main_dish
+    end
+  end
+end

data/lib/meal_planner/menu.rb

@@ -0,0 +1,72 @@
+require 'date'
+require_relative 'array'
+require_relative 'menu_day'
+
+module MealPlanner
+  class Menu
+
+    attr_reader :days, :unplanned_meals
+
+    def initialize(number_of_days)
+      @number_of_days = number_of_days
+      @start_date = Time.new.to_date
+      @unplanned_meals = []
+      @menu_days = []
+
+      0.upto(@number_of_days - 1) do |i|
+        @menu_days << MenuDay.new(@start_date + i)
+      end
+    end
+
+    def each_menu_day
+      if block_given?
+        @menu_days.each { |menu_day| yield menu_day }
+      end
+    end
+
+    def each_planned_meal
+      if block_given?
+
+        each_menu_day do |menu_day|
+          menu_day.each_meal do |time, meal|
+            unless meal.nil?
+              yield meal
+            end
+          end
+        end
+      end
+    end
+
+    def add_unplanned_meal(meal)
+      @unplanned_meals << meal
+    end
+
+    def plan(meals)
+      @unplanned_meals = meals
+
+      each_menu_day do |menu_day|
+        menu_day.add_meal(:lunch, Meal.new("Leftovers from yesterday"))
+        menu_day.add_meal(:dinner, @unplanned_meals.sample!)
+      end
+    end
+
+    def switch(switch_meal1, switch_meal2=nil)
+      menu_days = []
+      each_menu_day do |menu_day|
+        menu_day.each_meal do |time, meal|
+          if meal == switch_meal1 || (! switch_meal2.nil? && meal == switch_meal2)
+            menu_days << [menu_day, time, meal]
+          end
+        end
+      end
+
+      if switch_meal2.nil?
+        menu_days[0][0].switch_meal(menu_days[0][1], @unplanned_meals.sample!)
+      elsif menu_days.size == 2
+        menu_days[0][0].switch_meal(menu_days[1][1], menu_days[1][2])
+        menu_days[1][0].switch_meal(menu_days[0][1], menu_days[0][2])
+      end
+    end
+
+  end
+end

data/lib/meal_planner/menu_day.rb

@@ -0,0 +1,36 @@
+require_relative 'meal'
+
+module MealPlanner
+  class MenuDay
+    attr_reader :date
+
+    def initialize(date)
+      @date = date
+      @meals = {}
+    end
+
+    def add_meal(time, meal)
+      @meals[time] = meal
+    end
+
+    def switch_meal(time, meal)
+      add_meal(time, meal)
+    end
+
+    def each_meal
+      if block_given?
+        @meals.each do |time, meal|
+          yield time, meal
+        end
+      end
+    end
+
+    def to_s
+      menu_day_string = "\nPlan for #{@date}"
+      each_meal do |time, meal|
+        menu_day_string += "\n\t#{time.capitalize} is: #{meal}"
+      end
+      menu_day_string
+    end
+  end
+end

data/lib/meal_planner/recipe.rb

@@ -0,0 +1,20 @@
+module MealPlanner
+  Ingredient = Struct.new(:amount, :measure, :description)
+
+  class Recipe
+    attr_reader :name
+    def initialize(name)
+      @name = name
+      @ingredients = []
+    end
+
+    def add_ingredient(ingredient)
+      @ingredients << ingredient
+    end
+  end
+
+  if __FILE__ == $0
+    ingredient = Ingredient.new(2, "T.", "Chili Powder")
+    puts ingredient
+  end
+end

data/lib/meal_planner/regex_test.rb

@@ -0,0 +1,16 @@
+module MealPlanner
+  module RegexTest
+
+    def self.test(regex, array)
+      matched = true
+      array.each do |i|
+        unless i =~ regex
+          matched = false
+          break
+        end
+      end
+      matched
+    end
+
+  end
+end

data/lib/meal_planner/validator.rb

@@ -0,0 +1,13 @@
+module MealPlanner
+  module Validator
+    def self.validate(match)
+      if block_given?
+        value = yield
+        until (value =~ match)
+          value = yield
+        end
+        value
+      end
+    end
+  end
+end

data/spec/meal_planner/array_spec.rb

@@ -0,0 +1,27 @@
+require 'meal_planner/array.rb'
+
+module MealPlanner
+  describe Array do
+
+    before do
+      @original = %w(why would I do that)
+      @original_size = @original.size
+      @sample_size = 2
+    end
+
+    it "samples from an array and removes the sample from original" do
+      @sample = @original.sample!(@sample_size)
+      @sample.size.should == @sample_size
+      @original.size.should == @original_size - @sample_size
+      @original.should_not include(@sample)
+    end
+
+    it "samples only one from the array" do
+      sample = @original.sample!
+
+      @original.should_not include(sample)
+      sample.should be_an_instance_of String
+    end
+
+  end
+end

data/spec/meal_planner/meal_spec.rb

@@ -0,0 +1,52 @@
+require 'meal_planner/meal'
+
+module MealPlanner
+  describe Meal do
+    before do
+      @main_dish = "Rice and Meat Sauce"
+      @meal = Meal.new(@main_dish)
+    end
+
+    it "has a main dish" do
+      @meal.main_dish.should == @main_dish
+    end
+
+    it "has a string representation" do
+      @meal.to_s.should == "Main Dish: #{@main_dish}"
+    end
+
+    it "compares to others by main dish" do
+      @meal.should == Meal.new(@main_dish)
+    end
+
+    context "suggested sides have been added" do
+      before do
+        @main_dish = "Hashed Browns"
+        @meal = Meal.new(@main_dish)
+
+        @side1 = "Bacon"
+        @side2 = "Salsa"
+        @meal.add_side(@side1)
+        @meal.add_side(@side2)
+      end
+
+      it "returns each side" do
+
+        expected_sides = [@side1, @side2]
+        sides = []
+
+        @meal.each_side do |side|
+          sides << side
+        end
+
+        sides.should == expected_sides
+      end
+
+      it "lists sides in string representation" do
+        @meal.to_s.should ==
+          "Main Dish: #{@main_dish}, Side: #{@side1}, Side: #{@side2}"
+      end
+
+    end
+  end
+end

data/spec/meal_planner/menu_day_spec.rb

@@ -0,0 +1,57 @@
+require 'meal_planner/menu_day'
+
+module MealPlanner
+  describe MenuDay do
+
+    before do
+      @date = Date.new(2013, 10, 21)
+      @lunch = Meal.new("Sandwiches")
+      @dinner = Meal.new("Spaghetti")
+
+      @meals = { :lunch => @lunch, :dinner => @dinner }
+
+      @lunch2 = Meal.new("Leftovers")
+      @dinner2 = Meal.new("Chicken and Rice")
+
+      @meals2 = { :lunch => @lunch2, :dinner => @dinner2 }
+
+      @menu_day = MenuDay.new(@date)
+
+      @menu_day.add_meal(:lunch, @lunch)
+      @menu_day.add_meal(:dinner, @dinner)
+    end
+
+    it "has a date" do
+      @menu_day.date.should == @date
+    end
+
+    it "has a string representation" do
+      @menu_day.to_s.should == "\nPlan for #{@date}\n\tLunch is: #{@lunch}\n\tDinner is: #{@dinner}"
+    end
+
+    it "has a hash of meals" do
+
+      expected_meals = {}
+
+      @menu_day.each_meal do |time, meal|
+        expected_meals[time] = meal
+      end
+
+      expected_meals.should == @meals
+    end
+
+    it "substitutes meals with new meals" do
+      @menu_day.switch_meal(:lunch, @lunch2)
+      @menu_day.switch_meal(:dinner, @dinner2)
+
+      expected_meals = {}
+
+      @menu_day.each_meal do |time, meal|
+        expected_meals[time] = meal
+      end
+
+      expected_meals.should == @meals2
+    end
+
+  end
+end

data/spec/meal_planner/menu_spec.rb

@@ -0,0 +1,112 @@
+require 'meal_planner/menu.rb'
+require 'timecop'
+require 'date'
+
+module MealPlanner
+  describe Menu do
+    before do
+      Timecop.freeze(Date.new(2013, 7, 24))
+      @number_of_days = 2
+      @menu = Menu.new(@number_of_days)
+    end
+
+    it "returns each menu day" do
+      test_dates = [Date.new(2013, 7, 24), Date.new(2013, 7, 25)]
+      expected_dates = []
+
+      @menu.each_menu_day do |menu_day|
+        expected_dates << menu_day.date
+      end
+
+      expected_dates.should == test_dates
+    end
+
+    it "returns each planned meal" do
+      expected_meals = []
+
+      @menu.each_planned_meal do |planned_meal|
+        expected_meals << planned_meal
+      end
+
+      expected_meals.should == []
+    end
+
+    it "has a list of unplanned meals" do
+      @menu.unplanned_meals.should == []
+    end
+
+    it "adds an unplanned meal" do
+      meal = Meal.new("Coconut Currie Soup")
+      @menu.add_unplanned_meal(meal)
+      @menu.unplanned_meals.should == [meal]
+    end
+
+    context "meals have been planned" do
+
+      before do
+        Timecop.freeze(Date.new(2013, 7, 24))
+        @number_of_days = 2
+        @menu = Menu.new(@number_of_days)
+
+        @meals = [
+          Meal.new("Chicken and Rice"),
+          Meal.new("Sausage and Saurkraut"),
+          Meal.new("Steak, potatoes, and gravy"),
+          Meal.new("Hot tortilla sandwiches"),
+          Meal.new("Chicken Soup"),
+          Meal.new("Leftover Roast Soup")
+        ]
+
+        @menu.plan(@meals)
+
+        @planned_meals = []
+        @menu.each_planned_meal do |meal|
+          meal.should_not be_nil
+          @planned_meals << meal
+        end
+
+      end
+
+      it "has planned meals" do
+
+        @planned_meals.length.should == @number_of_days * 2
+
+      end
+
+      it "switches the places of two planned meals" do
+
+        switch_meal1 = @planned_meals[1]
+        switch_meal2 = @planned_meals[3]
+
+        @menu.switch(switch_meal1, switch_meal2)
+
+        @planned_meals = []
+        @menu.each_planned_meal do |meal|
+          @planned_meals << meal
+        end
+
+        @planned_meals[1].should == switch_meal2
+        @planned_meals[3].should == switch_meal1
+
+      end
+
+      it "switches a meal with another not yet on the menu" do
+
+        switch_meal = @planned_meals[1]
+
+        @menu.switch(switch_meal)
+
+        @planned_meals = []
+        @menu.each_planned_meal do |meal|
+          @planned_meals << meal
+        end
+
+        @planned_meals.size.should == 4
+        @planned_meals.should_not include(switch_meal)
+
+      end
+
+    end
+
+  end
+end

data/spec/meal_planner/regex_test_spec.rb

@@ -0,0 +1,16 @@
+require 'meal_planner/regex_test.rb'
+
+module MealPlanner
+  describe RegexTest do
+
+    it "should match" do
+      RegexTest.test(/[1-9]/, ('1'..'9').to_a).should be_true
+    end
+
+    it "shouldn't match" do
+      RegexTest.test(/test/, ('a'..'z').to_a).should be_false
+      RegexTest.test(/[1-9]/, (1..9).to_a).should be_false
+    end
+
+  end
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: meal_planner
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Peter Sumsion
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+description: ! "A program to ease and automate the planning of meals.\n\nEach meal
+  has a main dish and optionally side dishes as well. These are currently loaded from
+  the meals.csv file in the directory of the command line script. That will be changed
+  in a future release when they will be loaded from a database instead.\n\nA menu
+  consists of any number of days that the user chooses. Each day can have any meal
+  as user wishes. When the program is run, the meals are loaded at random from the
+  meal source and presented to the user. The user then has the option to switch out
+  any that she doesn't want on a particular day. If two meals are given, the two meals
+  are switched between each other. If only one meal is given, that meal is switched
+  with another from the meal source that isn't already in the menu.\n\nWhen the user
+  quits the program, the current menu is stored in a menu.txt file so that it can
+  be printed and used in shopping, preparing meals, etc.\n\nIn a future release, each
+  dish in a meal will be associated with a recipe so that a shopping list and recipe
+  book can be created directly from the same source.\n\nKnown Issues:\n\nSwitching
+  Lunches with themselves or with other meals doesn't work well. This may need a redesign
+  of how switch is called.\n\nIf too many meals are replaced, the meal store eventually
+  gets emptied and so meals are replaced with blanks\n\nFIXED: If more than 4 meals
+  are planned at a time, the regular expression gathering meal numbers is no longer
+  valid\n  This was fixed by updating the regular expression so that it accepts any
+  numbers as long as they are comma separated.\n\nFIXED: For now, this makes it possible
+  for invalid numbers to be entered. This is not acceptable and must be changed as
+  it could result in loss of the entire list of planned meals because of a simple
+  user error.\n  This was fixed by checking the gathered values to see if they are
+  in the range covered by the planned_meals array indexes\n"
+email: sumsionp@gmail.com
+executables:
+- mealplan
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/mealplan
+- bin/meals.csv
+- lib/meal_planner/array.rb
+- lib/meal_planner/meal.rb
+- lib/meal_planner/menu.rb
+- lib/meal_planner/menu_day.rb
+- lib/meal_planner/recipe.rb
+- lib/meal_planner/regex_test.rb
+- lib/meal_planner/validator.rb
+- spec/meal_planner/array_spec.rb
+- spec/meal_planner/meal_spec.rb
+- spec/meal_planner/menu_day_spec.rb
+- spec/meal_planner/menu_spec.rb
+- spec/meal_planner/regex_test_spec.rb
+- LICENSE
+- README
+homepage: http://rubygems.org/gems/meal_planner
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Command line meal planning program
+test_files:
+- spec/meal_planner/array_spec.rb
+- spec/meal_planner/meal_spec.rb
+- spec/meal_planner/menu_day_spec.rb
+- spec/meal_planner/menu_spec.rb
+- spec/meal_planner/regex_test_spec.rb