rudimusmaximus / FENDp4

Project 4 - feedreader using frontend-nanodegree-feedreader-master

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Project Overview

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.

Why this Project?

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!

What will I learn?

You will learn how to use Jasmine to write a number of tests against a pre-existing application. These will test the underlying business logic of the application as well as the event handling and DOM manipulation.

How will this help my career?

  • Writing effective tests requires analyzing multiple aspects of an application including the HTML, CSS and JavaScript - an extremely important skill when changing teams or joining a new company.
  • Good tests give you the ability to quickly analyze whether new code breaks an existing feature within your codebase, without having to manually test all of the functionality.

How will I complete this 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.

How to use the feed reader

Just load and use the menu to select between the available sources.

To Load

Simply load the index.html file by clicking https://rudimusmaximus.github.io/FENDp4/

If your browser blocks loading, you may have to click on the 'load unsafe scripts link' to see the page. Screen Shot 2018-09-29 at 10.52.56 PM.png

When you select a source

Click on the menu bars to see the selection of sources.

With the menu open, click on a source to change the list of articles.

Click on any article title to visit it's web page.

My Notes Completing This

Lessons learned:

Area Comments
1. Included vs installed via npm a. Research pros/cons of including the library in the code base.
2. Gulp and eslint a. Research the install of google style via cli and what is applied when specified via .eslintrc and order of precedence against .editorconfig file.
3. Continuous Integration a. research suggested frameworks.
4. pre-commit hooks a. research as well.
5. package.json a. best practice about package-lock.json which i came across when learning gulp with sass and eslint and jasmine testing. Not an issue on this p4 as version of jasmine was included in the repo files.

Assumptions required to solve the problem

The following assumptions were made by evaluation the code and all given instructions:

  • most of our solution can be done in jasmine/spec/feedreader.js

  • gulp is not required as the course has setup the starting files to include a jasmine library

Work Flow

I followed git commit guidelines, a 'Git Flow' branching model committing into temporary feature branches that are merged into develop until ready to test and pushed to GitHub hosting of a develop and master branch. The repo was created using the starting repo as a baseline rather than fork, so I could have issues later. I used Atom and GitKraken with a Chrome browser for testing.

My focus is to catch up in the course, so I'm going to try to stick only to the requirements.

Now to finish in time! Thanks for reading this.

See develop for commit history with git commit style followed. Releases made to master and develop with tags on master following Semantic Versioning 2.0.0.

Resources used to complete this work

I watched Udacity FEND P4 Walkthrough by Ryan Boris I read Mathew Cranford's Feed Reader Walkthrough series parts 1 - 4 whenever I got stuck. Also, considered using an approach from https://jasmine.github.io/2.0/introduction.html for adjusting timeout interval in Asynchronous Support, but it was not necessary.

About

Project 4 - feedreader using frontend-nanodegree-feedreader-master


Languages

Language:JavaScript 96.5%Language:HTML 1.8%Language:CSS 1.7%