/FEND-feed-reader

Feed Reader project for Udacity's Front End Web Developer nanodegree

Primary LanguageJavaScript

Feed Reader Project

Welcome to the Feed Reader, a web-based application that reads RSS feeds.

This project was done as a requirement for Udacity's Front-End Web Development Nanodegree.

Table of Contents

Overview

As provided by Udacity.

In this project you are given a web-based application that reads RSS feeds. The original developer of this application clearly saw the value in testing, they've already included Jasmine and even started writing their first test suite! Unfortunately, they decided to move on to start their own company and we're now left with an application with an incomplete test suite. That's where you come in.

How to use this project

The project scenario, as described above, provided the premise of the project itself. You may clone or download the .zip file of this project from my github repository. Open the index.html file in your favorite browser and you'll be presented with a feed reader. At the very bottom, you'll see the Jasmin specs showing you the different test suites that was required to run for the project. For reference of the different test suites, you can look at the feedreader.js file in jasmine/spec/--this is where the bulk of my edits for the project were made.

In addition to the feedreader.js file, you can access the app.js file in /js/ to look at application itself and how the two files reference each other.

To test the application yourself, you may modify the different test items in the feedreaders.js file, reload the index.html in your browser, and check the Jasmine spec at the very bottom.

E.g. in "The Menu" suite, change the menu's default visibility to false from true, reload the page in your browser and see if the specs pass.

The following is the rubric and how my coursemates and I were to complete this particular project.

Review the Feed Reader Testing Project Rubric

  1. Take the JavaScript Testing course
  2. Download the required project assets.
  3. Review the functionality of the application within your browser.
  4. Explore the application's HTML (./index.html), CSS (./css/style.css) and JavaScript (./js/app.js) to gain an understanding of how it works.
  5. Explore the Jasmine spec file in ./jasmine/spec/feedreader.js and review the Jasmine documentation.
  6. Edit the allFeeds variable in ./js/app.js to make the provided test fail and see how Jasmine visualizes this failure in your application.
  7. Return the allFeeds variable to a passing state.
  8. Write a test that loops through each feed in the allFeeds object and ensures it has a URL defined and that the URL is not empty.
  9. Write a test that loops through each feed in the allFeeds object and ensures it has a name defined and that the name is not empty.
  10. Write a new test suite named "The menu".
  11. Write a test that ensures the menu element is hidden by default. You'll have to analyze the HTML and the CSS to determine how we're performing the hiding/showing of the menu element.
  12. Write a test that ensures the menu changes visibility when the menu icon is clicked. This test should have two expectations: does the menu display when clicked and does it hide when clicked again.
  13. Write a test suite named "Initial Entries".
  14. Write a test that ensures when the loadFeed function is called and completes its work, there is at least a single .entry element within the .feed container.
  15. Write a test suite named "New Feed Selection".
  16. Write a test that ensures when a new feed is loaded by the loadFeed function that the content actually changes.
  17. No test should be dependent on the results of another.
  18. Callbacks should be used to ensure that feeds are loaded before they are tested.
  19. Implement error handling for undefined variables and out-of-bound array access.
  20. When complete - all of your tests should pass.
  21. Write a README file detailing all steps required to successfully run the application. If you have added additional tests (for Udacious Test Coverage), provide documentation for what these future features are and what the tests are checking for.

Why

As provided by Udacity.

Testing is an important part of the development process and many organizations practice a standard of development known as "test-driven development". This is when developers write tests first, before they ever start developing their application. All the tests initially fail and then they start writing application code to make these tests pass.

Whether you work in an organization that uses test-driven development or in an organization that uses tests to make sure future feature development doesn't break existing features, it's an important skill to have!

Dependencies

  • Udacity provided the starter files, which included a partially complete feedreader.js file, and a fully completed app.js file, among other files.
  • Jasmine

Resources

Lessons

I learned how to use Jasmine to write a number of tests against a pre-existing application. This prjoject testsed the underlying business logic of an RSS application, as well as event handling and manipulation of the DOM.

Contribute

This repo was part of a Udacity course and is not accepting contributions. You are, however, welcome to download or clone the repo and play with the package yourself.