Meal_Finder_CLI 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 62190bd6f69ca99b1e4f68442a98ef773d9d3b83410105cf9e00fa0a1765e960
+  data.tar.gz: b0fbb4174e9f7dd6a3357b62641a8c2b80164bc87def357715e61abb583da240
+SHA512:
+  metadata.gz: b8be4a3a5caebcbf90ac7dd45645e747d6aa3a9c61ae166310cb2d5f1b3163483d69278e66661302bd138066e1034ab9517005e3587a895fd48d0c246d79ff77
+  data.tar.gz: 1e2b157ab6acab0cf141c6b8af85bbceba8e61823e5940c8d20017f439fb9f5c18ad43991ed08970bc2a2db710c68ea44a4b4176b39cede635bf3741dc703788

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 2.0.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# 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 jenniferanndcb@gmail.com. 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/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in Meal_finder.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Jen
+
+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/NOTES.md

@@ -0,0 +1,46 @@
+Welcome greeting : 
+
+"Hello, choose whether you are looking for breakfast, lunch or dinner inspiration" 
+
+User types meal: "breakfast", "lunch" OR "dinner" 
+
+List recipe inspirations by meal #self.list_recipes (meal i.e. breakfast, lunch, dinner)
+
+List by skill level - Easy, More Effort, A Challenge 
+
+Select from list of recipes 
+
+Open URL or Pull methods 
+
+Add to "Today's #{meal} menu" 
+
+BONUS: Create a shopping list from recipes chosen and added to menu list
+
+FILES - Single Responsibility Principle: 
+
+/bin/cli - executable 
+
+cli.rb - handles display logic and user input #CLI Controller 
+
+meal.rb - first level scraping - breakfast, lunch, dinner 
+
+recipes.rb - second level scraping - recipes are saved 
+    --> if second time choose another recipe 
+    --> Done? List menu
+
+ingredients_and_method.rb - third level scraping - lists ingredients and method for chosen recipe 
+    --> asks users would you like to add to today's menu? 
+    --> go back one level 
+
+menu.rb - saves recipes added 
+    --> List shopping list? List ingredients.  
+
+
+
+
+
+
+
+LET THE USER CHOOSE WHERE TO GO - if in recipe menu - can go back to main menu - if in recipe - can get out to go back to recipe list 
+
+ONLY SCRAPE ONCE - if the user chose dinner - list recipe of dinner - if user got out, do not scrape again but bring up list of dinner recipes... how??? 

data/README.md

@@ -0,0 +1,43 @@
+# Meal Finder CLI
+
+Meal Finder is a comman line interface that enables the user to browse and find recipe inspirations from the BBC Good Food website. The user will be presented with a list of available courses, and then the recipes for their chosen course. The user can then choose a recipe to find out more about the ingredients needed and the step by step methods for making their chosen dish. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'Meal_Finder_CLI'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install Meal_finder_CLI_gem
+
+## Usage
+
+From the local directory, execute 
+
+    $ meal-finder-cli-gem
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/CLI_project. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the CLIProject project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/CLI_project/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "CLI_project"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/mealfinder

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby 
+
+require_relative "../lib/environment"
+
+ 
+RecipeInspiration::CLI.new.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/CLI_project/cli.rb

@@ -0,0 +1,179 @@
+require 'pry'
+
+
+module RecipeInspiration
+  class CLI
+
+    def start
+      puts "           -*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-"
+      puts "          |                                             |"
+      puts "          |  Hello and welcome to the Meal Finder CLI.  |"
+      puts "          |                                             |"
+      puts "           -*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-"
+      menu
+    end 
+  
+    def menu 
+      puts "\t If you are looking for inspirations for your next meal then you've come to the right place.
+      \t To see what courses we have available, simply type 'list courses'
+      \t To exit the program, simply type 'exit'"
+
+    menu_user_input 
+
+    end 
+    
+    
+    def menu_user_input
+      input = gets.chomp 
+
+      if input.downcase == "list courses"
+        RecipeInspiration::Course.list_course_names
+        list_courses
+      elsif input.downcase == "exit"
+        goodbye 
+      else 
+        puts "\t Sorry I did not recognise that..."
+        
+        menu
+
+      end 
+    end 
+    
+    def list_courses
+      
+      course_arr = RecipeInspiration::Course.all
+      
+      puts "\t 
+      \t Here are the courses that we have available.
+      \t To choose a course, type in the corresponding number below to get a list of recipe suggestions. 
+     
+      \t Or simply type 'exit' to exit the program
+      
+      \t"
+        
+      puts course_arr.map.with_index {|meal,index|
+          "\t#{index+1}. #{meal.name}"}
+ 
+      select_course(course_arr)
+
+    end 
+ 
+    def select_course(course_arr)
+      
+    input = gets.chomp
+
+      if input.downcase == "exit"
+        goodbye
+
+      elsif input.to_i > 0 && input.to_i < 23
+          selected_course = course_arr[input.to_i-1]
+
+          puts "\t Great! Here are some ideas for you to make for #{selected_course.name}. Please type in the number of the dish you would like to 
+          \t find out more about or simply type in 'list courses' to go back to the main menu and choose a different course\t" 
+        
+
+      else 
+        puts "\t Sorry, I did not recognise that..."
+
+        list_courses
+
+      end 
+        
+    RecipeInspiration::Recipes.list_recipe_names(selected_course)
+    list_recipes(selected_course)
+             
+    end 
+
+    def list_recipes(selected_course)
+      recipe_arr = RecipeInspiration::Recipes.all
+  
+      puts recipe_arr.map.with_index {|recipe, i| 
+        "#{i+1}. #{recipe.name}"}
+
+      select_recipe(recipe_arr)
+
+    end 
+    
+
+    def select_recipe(recipe_arr)
+    
+    input = gets.chomp 
+
+      
+    if input.downcase == "list courses"
+      RecipeInspiration::Recipes.all.clear 
+      list_courses
+
+      elsif input.downcase == "exit"
+        goodbye
+      
+      elsif input.to_i > 0 && input.to_i < 16
+          selected_recipe = recipe_arr[input.to_i-1]
+ 
+      recipe_details(selected_recipe)
+      
+      else 
+        puts "\t Sorry, I did not recognise that.
+        \t Please type in the number of the dish that you are looking for 
+        \t or 'list courses' to see the courses again or 'exit' to exit the program"
+      select_recipe(recipe_arr)
+      end 
+    end 
+  
+  
+    def recipe_details(selected_recipe)
+      
+      RecipeInspiration::Recipes.recipe_details(selected_recipe)
+
+      puts "\t Not quite what you are looking for? 
+      \t Type 'list recipes' to go back to list of recipes from the same Course and choose a different dish\n\t
+      \t To go back to the main menu, simply type 'list courses'
+      \t To exit the program, type 'exit'"
+      
+      recipe_next_steps
+
+    end 
+
+    def recipe_next_steps
+      
+      input = gets.chomp 
+
+      if input.downcase == "list recipes"
+        recipe_arr = RecipeInspiration::Recipes.all
+  
+        puts recipe_arr.map.with_index {|recipe, i| 
+          "#{i+1}. #{recipe.name}"}
+        
+        select_recipe(recipe_arr)
+
+      elsif input.downcase == "list courses"
+        RecipeInspiration::Recipes.all.clear
+        list_courses 
+        
+        
+        
+
+      elsif input.downcase == "exit"
+        goodbye
+
+      else 
+        puts "\t Sorry I did not recognise that...
+        \t Type 'list recipes' to go back to list of recipes from the same Course and choose a different dish\n\t
+        \t To go back to the main menu, simply type 'list courses'
+        \t To exit the program, type 'exit'"
+      
+      recipe_next_steps
+      
+      end 
+    end 
+  
+  def goodbye 
+    puts "\t Thank you for using the Meal Finder CLI. See you next time!"
+    exit 
+  end 
+
+  end 
+
+end
+
+

data/lib/CLI_project/concerns/memorable.rb

@@ -0,0 +1,13 @@
+module Memorable 
+
+  module InstanceMethods 
+
+    def initialize(name = nil, url = nil)
+      @name = name
+      @url = url
+      self.class.all << self 
+    end 
+
+  end 
+
+end 

data/lib/CLI_project/course.rb

@@ -0,0 +1,28 @@
+require_relative './concerns/memorable.rb'
+require 'nokogiri'
+require 'open-uri'
+require 'pry'
+
+module RecipeInspiration
+  class Course
+
+  include Memorable::InstanceMethods
+
+  attr_accessor :name, :url 
+
+  @@all = []
+  
+    def initialize
+      super 
+    end 
+   
+    def self.list_course_names
+      RecipeInspiration::Scraper.scrape_courses
+    end 
+
+    def self.all 
+     @@all
+    end 
+
+  end 
+end

data/lib/CLI_project/recipes.rb

@@ -0,0 +1,33 @@
+
+require_relative './concerns/memorable.rb'
+require 'pry'
+
+module RecipeInspiration
+  class Recipes
+
+    include Memorable::InstanceMethods 
+
+    attr_accessor :name, :url
+
+    @@recipe_collection = []
+
+
+    def initialize
+      super
+    end 
+
+
+    def self.list_recipe_names(selected_course)
+      RecipeInspiration::Scraper.scrape_recipes(selected_course)
+    end
+  
+    def self.recipe_details(selected_recipe)
+      RecipeInspiration::Scraper.scrape_recipe_details(selected_recipe)
+    end 
+    
+    def self.all 
+      @@recipe_collection
+    end 
+     
+  end
+end 

data/lib/CLI_project/scraper.rb

@@ -0,0 +1,74 @@
+module RecipeInspiration 
+
+  class Scraper 
+
+    BASE_URL = "https://www.bbcgoodfood.com" 
+
+    def self.scrape_courses
+      html = open('https://www.bbcgoodfood.com/search/recipes?query=')
+      doc = Nokogiri::HTML(html)
+  
+      doc.css('ul#facetapi-facet-search-apinode-index-block-field-bbcgf-course li.leaf').each do |course| 
+        new_course = Course.new 
+        new_course.name = course.css("a :first-child").text.gsub(/Apply|filter/, "").strip
+         
+        new_course.url = BASE_URL + course.css("a")[0]["href"]
+        
+      end  
+
+    end 
+    
+
+    def self.scrape_recipes(selected_course) 
+
+    doc = Nokogiri::HTML(open(selected_course.url))
+
+      doc.css(".view-content h3").each do |recipes|  
+        new_recipe = Recipes.new
+        new_recipe.name = recipes.css("a").text.strip
+        new_recipe.url = BASE_URL + recipes.css("a")[0]["href"]
+      
+      end 
+
+    end 
+
+
+    def self.scrape_recipe_details(selected_recipe)
+      ingredients_list = []
+      method_list = []
+
+      doc = Nokogiri::HTML(open(selected_recipe.url))
+
+      puts "\t"
+      puts "Here is the recipe for #{selected_recipe.name}\n\t"
+      puts "#{doc.css(".recipe-header__description p").text}\n\t"
+      puts "#{doc.css(".recipe-details .recipe-details__text .recipe-details__cooking-time-prep").text}"
+      puts "#{doc.css(".recipe-details .recipe-details__text .recipe-details__cooking-time-cook").text}\n\t"
+      
+
+      doc.css(".recipe-content").each do |recipe|
+        recipe.css(".ingredients-list li").each do |ingredient|
+          ingredients = ingredient.attr("content")
+          
+          ingredients_list << ingredients
+         
+        end 
+        recipe.css(".method__list li").each do |method|
+          method_actions = method.css("p").text 
+
+          method_list << method_actions
+
+        end
+        
+        puts "Ingredients:\n\t"
+        puts ingredients_list.collect {|item| "#{item}"}
+        puts "\nMethod:\n\t"
+        puts method_list.map.with_index {|method, index| "#{index+1}. #{method}\n\t"}
+      
+      end   
+
+    end 
+
+  end 
+
+end 

data/lib/CLI_project/version.rb

@@ -0,0 +1,3 @@
+module CLIProject
+  VERSION = "0.1.0"
+end

data/lib/environment.rb

@@ -0,0 +1,19 @@
+require 'pry'
+require 'nokogiri'
+require 'open-uri'
+require 'uri'
+
+require_relative "./CLI_project/recipes"
+require_relative "./CLI_project/cli"
+require_relative "./CLI_project/course"
+require_relative "./CLI_project/scraper"
+require_relative "./CLI_project/version"
+require_relative "./CLI_project/concerns/memorable"
+
+
+module CLIProject
+  class Error < StandardError; end
+  # Your code goes here...
+end
+
+

data/meal_finder.gemspec

@@ -0,0 +1,34 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "CLI_project/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "Meal_Finder_CLI"
+  spec.version       = CLIProject::VERSION
+  spec.authors       = ["Jen"]
+  spec.email         = ["jenniferanndcb@gmail.com"]
+
+  spec.summary       = %q{Meal Finder }
+  spec.description   = %q{Meal Finder CLI gives users the tool to find recipes from the BBC Good Food website by course.}
+  spec.homepage      = "https://github.com/jenniferanndcb/meal-finder-cli-gem"
+  spec.license       = "MIT"
+
+  
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: Meal_Finder_CLI
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-07-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Meal Finder CLI gives users the tool to find recipes from the BBC Good
+  Food website by course.
+email:
+- jenniferanndcb@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- NOTES.md
+- README.md
+- Rakefile
+- bin/console
+- bin/mealfinder
+- bin/setup
+- lib/CLI_project/cli.rb
+- lib/CLI_project/concerns/memorable.rb
+- lib/CLI_project/course.rb
+- lib/CLI_project/recipes.rb
+- lib/CLI_project/scraper.rb
+- lib/CLI_project/version.rb
+- lib/environment.rb
+- meal_finder.gemspec
+homepage: https://github.com/jenniferanndcb/meal-finder-cli-gem
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/jenniferanndcb/meal-finder-cli-gem
+  source_code_uri: https://github.com/jenniferanndcb/meal-finder-cli-gem
+  changelog_uri: https://github.com/jenniferanndcb/meal-finder-cli-gem
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.4
+signing_key: 
+specification_version: 4
+summary: Meal Finder
+test_files: []