balmung421 / night_writer Goto Github PK

The idea of Night Writing was first developed for Napoleon's army so soldiers could communicate silently at night without light. The concept of night writing led to Louis Braille's development of his Braille tactile writing system.

In this project we'll implement systems for generating Braille-like text from normal characters and the reverse.

Braille uses a two-by-three grid of dots to represent characters. We'll simulate that concept by using three lines of symbols:

0.0.0.0.0....00.0.0.00
00.00.0..0..00.0000..0
....0.0.0....00.0.0...

The 0 represents a raised dot. The period is an unraised space. The above code reads "hello world" in normal text. You can experiment with converting other words yourself and share some samples with your classmates.

Let's also constrain our Braille files to 80 braille characters (160 dots) wide.

• Practice breaking a program into logical components
• Testing components in isolation and in combination
• Applying Enumerable techniques in a real context
• Reading text from and writing text to files

The tool is used from the command line like so:

$ ruby ./lib/night_write.rb message.txt braille.txt
Created 'braille.txt' containing 256 characters

That will use the plaintext file message.txt to create a Braille simulation file braille.txt.

Then we can convert that Braille simulation back to normal text:

$ ruby ./lib/night_read.rb braille.txt original_message.txt
Created 'original_message.txt' containing 256 characters.

Use the lowercase letters a-z here from the American Foundation for the Blind for your project.

We also need to support capitalization. In Braille, capitalization comes from a shift character. You'll find that character at the end of the fourth row of the previous graphic. When that character appears, the next character (and only the next character) is a capital. So e comes out as one 2x3 set of Braille points, but E is 4x3: the shift character followed by the normal e. Consider how this will affect your line width restrictions.

As you work to implement the project below are some ideas of how you might start into the problem.

If you'd like an example of how you might extract the File I/O into an external class, check out this gist.

Write a Ruby program that can just output a string like:

$ ruby ./lib/night_write.rb message.txt braille.txt
Created 'braille.txt' containing 256 characters

Then work to:

• Pull the specified output filename from the command line arguments and print it in the terminal
• Get the actual number of characters from the message.txt and output it in the terminal

Your Braille-simulation file will need three lines of output for every one line of input. Start by outputting your input in three repeated rows.

hello world

Turns into

hello world
hello world
hello world

You'll need a component that takes a normal text character and returns the Braille equivalent. It's time to build that now.

Bringing together the Echo Characters idea with the Mapping idea, you can actually output your Braille characters to the file. Consider building a component that would take in a plain-text letter and a position (maybe numbered 0-5) and would return either a 0 or ..

About this point, you should try Braille-ifying a message and exchange it with a classmate. Are your outputs identical?

Then it's time to dive into the reading.

Return to the graphic referenced above and you'll find a the # in the bottom left corner. Notice that the representations for 1-9 are actually the same as a-i. This number sign is a "switch" which means that all of the following "letters", up to the next space, are actually numbers. After the space it's assumed that we're back to words/letters unless we see another number switch.

Add support for numbers to your program.

There are contractions commonly understood in Braille. They're a single letter symbol (so it has spaces on each side) which stands in for a common word.

Find the symbols here on Wikipedia and add support in your program for the following:

a, but, can, do, every, from, go, have, just, knowledge, like, more, not, people, quite, rather, so, that, us, very, it, you, as, child, shall, this, which, out, will, enough, were, in

These should be used both when going from standard characters to Braille (ie, from is output as one character of Braille) and in your expansion from Braille to standard characters.

Below are a few examples to help you develop your implementation. You're encouraged to submit additional examples, especially for the extensions, as pull requests.

"a"

0.
..
..

"ab"

0.0.
..0.
....

"A"

..0.
....
.0..

"AB"

..0...0.
......0.
.0...0..

"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.
................................................................................
................................................................................

"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.
................................................................................
................................................................................
0.
..
..

" !',-.?abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ"

..............0.0.00000.00000..0.00.0.00000.00000..0.00.0..000000...0...0...00..
..00..0...000...0....0.00.00000.00..0....0.00.00000.00..0.00...0.0......0.......
..0.0...00.000....................0.0.0.0.0.0.0.0.0.0.0000.0000000.0...0...0...0
00..0...00..00..0....0...0..0...0...00..00..0...00..00..0....0...0..0...0....0..
.0...0..0...00..00..0...00......0........0...0..0...00..00..0...00......0...00..
...0...0...0...0...0...0...00..00..00..00..00..00..00..00..00..00..000.000.0.0.0
00..00..0.
.....0...0
00.000.000

The project will be assessed with the following rubric:

• 4: Application demonstrates excellent knowledge of Ruby syntax, style, and refactoring
• 3: Application shows strong effort towards organization, content, and refactoring
• 2: Application runs but the code has long methods, unnecessary or poorly named variables, and needs significant refactoring
• 1: Application generates syntax error or crashes during execution

• 4: Application always breaks concepts into classes and methods which encapsulate functionality.
• 3: Application consistently breaks concepts into classes and methods which have appropriate scope and responsibilities (SRP).
• 2: Application makes use of some classes, but the divisions or encapsulation are unclear.
• 1: Application makes use of just a few huge methods to control the bulk of the functionality.

• 4: Application is broken into components which are well tested in both isolation and integration using appropriate data
• 3: Application is well tested but does not balance isolation and integration tests, using only the data necessary to test the functionality
• 2: Application makes use of tests, but the coverage is insufficient
• 1: Application does not demonstrate use of TDD, or an insufficient number of tests.

• 4: Application meets all requirements, and implements one extension properly.
• 3: Application meets all requirements as laid out per the specification.
• 2: Application runs, but does not work properly, or does not meet specifications.
• 1: Application does not run, crashes on start.