Add node-localstorage

Has all methods in the localStorage spec interface including:

• length
• setItem(key, value)
• getItem(key)
• removeItem(key)
• key(n)
• clear()

LWdb.prototype.storeSettings = function(anObject) {

I have added

new file:   spec/learnwords2/LWdbSpec.js
new file:   src/LWdb.js

The jasmine task started by npm test does not find LWdb.js.

Create a repository LearnWords2-app-jq.
And do a simple LearnWords app which uses jQuery.

This is similar to #19 but instead of just using getElementById in the code jQuery is used.

The file jasmine-app-bundle.js is so long that the failure messages you get in SpecRunner.html are difficult to interpret. The file has more than 1400 lines because other stuff is added.

The data directory should probably have subdirectories

• csv
• json
• js
• xml
• markdown

which then would host the same data in different formats.

Or alternatively there are subfolders labeled with the nature of the data as for example German-English and that would contain the data in different formats

• ge-en.csv
• ge-en.json
• ge-en.xml
• ge-en.js
• ge-en.md

Currently the method is public

LWdb.prototype.invalidateIndex = function() {
   this.recalculateIndex = true;
}

It should go to the constructor function together with the property recalculateIndex which should become a private member of the constructor function.

Make

 indexNeedsRecalculation()

a privileged function and use as private property

indexIsDirty

Thus in the constructor function

 this._invalidateIndex = function() {
      this.indexIsDirty = true;
 }

 this._indexNeedsRecalculation = function() {
      return this.indexIsDirty
 }


 this._indexHasBeenUpdated = function() {
      this.indexIsDirty = false;
 }

Marking the functions with an underscore tells the application programmer that they do not belong to the public API. It is though still possible to call them. The effect this achieves is that the variable indexIsDirty is private and can is cannot be set to something other than a boolean.

Update the functions which have an effect on the index.

To create a new BoxOfQuestions currently

new BoxOfQuestions(name)

is used.

Change it to

new BoxOfQuestions([name], [options])

Cf. https://pouchdb.com/api.html#create_database

Options might include to

• have a user name
• reset the database of questions and reimport the data.

Failures:
1) LearnWords2 - App model BoxOfQuestions should be able to create a BoxOfQuestions object
  Message:
    TypeError: object is not a function
  Stack:
    TypeError: object is not a function
        at Object.<anonymous> (/home/user8/Documents/LearnWords2/spec/learnwords2/LWdbSpec.js:70:18)
  Message:
    ReferenceError: questions is not defined
  Stack:
    ReferenceError: questions is not defined
        at Object.<anonymous> (/home/user8/Documents/LearnWords2/spec/learnwords2/LWdbSpec.js:76:12)

In LWdbSpec.js we have

var LWdb = require('../../src/LWdb');
var BoxOfQuestions = require('../../src/BoxOfQuestions');
....

describe("LearnWords2 - App model", function() {

describe("BoxOfQuestions", function() {
  var db;


  beforeEach(function() {
    questions  = new BoxOfQuestions("LWquestions");
  });


  it("should be able to create a BoxOfQuestions object", function() {

    expect(questions).not.toBe(null);
    expect(questions).not.toBe(undefined);

      });

Add a docs directory and create a file which gives context information. In particular a diagram with the layers.

Write developer notes about how to set up a project like #19

Include

• a general note about bower
• instructions for loading the component with bower
• Step by step instructions how to a new project with the component

• Jasmine set up for browser and node command line.
• Constructor function for BoxOfQuestions() and some more specs.
• Have a build process for a release file for use in the browser.
• Documentation updated so that context information is given.

Plan for release 0.1 of the component

What needs to be implemented

• For the math questions no selection from a set of answer options is needed. The answer is just given by a number the user types on the command line.
• Load the math questions straight once into the db with importFrom command which does a force load. This will use 'putWord'.
• Have a run command to practice.

How is this developed?

• Develop this in a separate branch.
• Tag the issues needed for this release.

See also * #18

https://github.com/hhzl/LearnWords2/blob/JasmineInBrowser/spec/learnwords2/LWdbSpec.js#L19

putWord LWdb.js#L58 and postWord LWdb.js#L73 should work with localStorage in a similar way as putWord and postWord in https://pouchdb.com/api.html db.put() and db.post().

For milestone 0.1 implement putWord and postWord.

The method removeWords removes words from the localStorage.

A start of an implementation is here:

https://github.com/hhzl/LearnWords2/blob/master/src/LWdb.js#L130

The method needs to be rewritten,

Demo GUI

Implement what is given by #19.

Which is something like

<div id="learnWords2-area">
   <div id=question>...</div>
   <div id="optionsForAnswers">
       <div id="option1">...</div>
       <div id="option2">...</div>
       <div id="option3">...</div>
       <div id="option4">...</div>
   </div>
   <div id=feedback>...</div>
</div>

The demo should show what is implemented in release 0.3

Instead of #18, that will be for release 0.2; needs #29

As given in the usage paragraph of the README

Branch master

npm test

> [email protected] test /home/user8/Documents/LearnWords2
> node scripts/test.js


module.js:340
    throw err;
          ^
Error: Cannot find module '../../src/BoxOfQuestions'
    at Function.Module._resolveFilename (module.js:338:15)
    at Function.Module._load (module.js:280:25)
    at Module.require (module.js:364:17)
    at require (module.js:380:17)
    at Object.<anonymous> (/home/user8/Documents/LearnWords2/spec/learnwords2/LWdbSpec.js:2:22)
    at Module._compile (module.js:456:26)
    at Object.Module._extensions..js (module.js:474:10)
    at Module.load (module.js:356:32)
    at Function.Module._load (module.js:312:12)
    at Module.require (module.js:364:17)
npm ERR! weird error 8
npm WARN This failure might be due to the use of legacy binary "node"
npm WARN For further explanations, please read
/usr/share/doc/nodejs/README.Debian
 
npm ERR! not ok code 0

Create a file 'developer_journal' in a docs directory which states

• the relationship to LearnWords1
• the layers of LearnWords2
• that LearnWords2 focuses on the Non-GUI part (the component)
• context information
• misc note
• plans for extension

The component should just be visible in the global name space as an

 LW

object. Describe how this is done (Singleton vs. no singleton discussion).

The specs so far.

Note: This screenshot was produced opening SpecRunner.html in branch https://github.com/hhzl/LearnWords2/tree/JasmineInBrowser

This more or less the same as release 0.1 (issue #27 ) but this time with words
where the user has to type in the word on the command line.

Needs #8

There is now a branch https://github.com/hhzl/LearnWords2/tree/JasmineInBrowser which has a file SpecRunner.html in the root directory so that Jasmin tests may be run in the browser.

Check the setup; compare with issue #2

https://github.com/hhzl/LearnWords2/blob/JasmineInBrowser/src/LWdb.js#L187

Implement what is given by the following spec

  beforeEach(function() {
    questions  = new BoxOfQuestions("LWquestions");
  });

it("should be able to give a question, give options for answers and check the answer", function() {
    var q, a, opt, aChoice;

    q = questions.currQuestion();
    a = questions.currAnswer();
    opt = questions.currAnswerOptions(); // includes the correct answer
   
    questions.processAnswer(aChoice); 
    // add expect code here
    });

Open a paragraph 'usage' in the main readme stateing how the component is to be used.

  var LW = new BoxWithQuestions('learnwords', {"loadWordsFrom" : "aRelativePathToJSONfile"});

or

var LW = new BoxWithQuestions('learnwords', {"loadWordsFrom" : "aRelativePathToJSONfile", 
                                            "reinitializeDB" : "true"});

or

var LW = new BoxWithQuestions({"dbName": "John-learnwords", 
                              "loadWordsFrom" : "aRelativePathToJSONfile", 
                              "reinitializeDB" : "true"});

Give usage instructions.

Add to developer journal a note how to create a cli node project which uses the component as a node command line application.

Do this in a new repository LearnWords2-node-cli.

cf. https://pouchdb.com/api.html#create_document

db.post(obj)

The obj does not need to have a _id key.

Test data is kept here

https://github.com/hhzl/LearnWords2/blob/JasmineInBrowser/spec/helpers/learnwords2/SpecHelper.js

This directory
https://github.com/hhzl/LearnWords2/tree/JasmineInBrowser/data
is for "real" data.

Thus the file testData01-en-ge.js should be renamed.

The LWdb method

   importFrom(theWords)

https://github.com/hhzl/LearnWords2/blob/master/src/LWdb.js#L155

needs to check for the presence of all needed properties and if absent initialize them.

See also commented out version of LearnWords1.

https://github.com/hhzl/LearnWords2/blob/master/src/LWdb.js

into LWdb.js and BoxOfQuestions.js (or maybe better BoxWithQuestions.js?)

Specify and implement a Leitnerbox method box.moveForward(aWordId) or box.moveForward(aWord)

The method will rely on the existing step (level) information and the settings information for that level.

Move test data from
/LearnWords2/spec/learnwords2/LWdbSpec.js
to
/LearnWords2/spec/helpers/learnwords2/SpecHelper.js

Later on a specific test data directory might be used.

https://github.com/hhzl/LearnWords2/blob/master/src/LWdb.js#L102

Needs to give proper default values in case there were no previous settings.

Which default values are needed?

There is only on spec file at the moment called LWdbSpec . Split it into at least two spec files.

Adopt the pouchDB / CouchDB convention of using _id for the key attribute in data objects.

Tests of the specs are done with node / jasmine.

For user level tests of the component a command line interface is needed.

It should print out a word and

• either expect the user to type in the answer or
• give a list of numbered answer options. The user then enters the number of the answer and the system comes with the next question.

Task

Set up such a simple command line interface.

Define MVP specs for LWBoxOfQuestions and part of implementation.

We have as private methods in the LWdb API (see developer notes)

LWdb.prototype.incNumberOfWords = function() {
LWdb.prototype.invalidateIndex = function() {
LWdb.prototype.setNumberOfWords = function(n) {

How should they be marked?

Running grunt on Mac 10.11.6 using Node.js v6.7.0 results in the following error:

Fatal error: Cannot find module '_process' from '/LearnWords2/node_modules/node-localstorage'

Specify a helper method box.chooseRandomObject(anArray)

It gives back an random object from anArray.

Do an example in the browser with getElementById.
Use a HTML code snippet such as

<div id="learnWords2-area">
   <div id=question>...</div>
   <div id="optionsForAnswers">
       <div id="option1">...</div>
       <div id="option2">...</div>
       <div id="option3">...</div>
       <div id="option4">...</div>
   </div>
   <div id=feedback>...</div>
</div>

Hint: link to tutorial

Maybe do this in a new repository LearnWords2-test

Set up the Karma testing tool for #19

Choose a node command line module.

A node command line LearnWords app is done in #18.

Reasons for doing this

1. The user interface is minimal, thus there should be a quick result
2. A quick result will provide feedback for the development process
3. A node cli app is the proof that we actually have a component which does not use a GUI.
4. A component like this will be illustrative to learn about the project for other developers who might join the effort in the future.

Which node one should we choose?

https://www.npmjs.com/search?q=command+line+interface

Have grunt build a library file as well.

  dist/......

for the use in a browser.

Implement destroy() method for LWdb.

do this by renaming
https://github.com/hhzl/LearnWords2/blob/JasmineInBrowser/src/LWdb.js#L161

and implementing it.