Automatic word and phrase substitution for simple codes!
- The rails app need only be running for API calls for the AJAX UI at http://localhost:3000/pager
- for basic load/save, editing contents, see "Use the CLI" below
NOTE: For now, make sure to specify environment on every command. Example:
$ RAILS_ENV=production bundle exec rails server
$ RAILS_ENV=test bundle exec rspec
A simple DB-based app, entirely RESTful (HTTP), which stores code word / plaintext word mappings.
- PostgreSQL
- Note: show_counts_of_translations_like, one of the CLI translated_word_finders has hardcoded SQL
- Server side:
- Ruby on rails
- RESTful interface
- CLI utilities
- JavaScript
- jQuery
- backbone.js / underscore.js
- require.js
- development tools
- ruby: gem, bundler, rspec, rcov
- on OSX: rbenv
- ruby: gem, bundler, rspec, rcov
Current state:
- REST interface for
- Word
- TranslatedWord
- Sentence
- Paragraph
- Document: create
- models for all
- CLI utilities in bin
See doc/Development-log.md
Unfinished but prioritized:
- CLI output translated Document to file
$ bundle exec rspec
For more on the tests see doc/Install-steps.md
$ bundle exec rails server
http://localhost:3000/pager
see doc/manual-api-commands.md
$ createdb -O argotifier argotifier_test
$ RAILS_ENV=test bundle exec rake db:test:prepare
$ /Applications/Postgres.app/Contents/MacOS/bin/psql -U argotifier argotifier_test
$ document load "New Title" <plaintext_filename.txt>
$ document save "Existing Title" <translation_filename.txt>
$ paragraph 1
$ paragraph 12 14
Wraps to 80 columns
translates every instance of "foo" to "bar"
$ translation foo bar
Shows every word translated to "foo," with counts
$ translation foo
$ dictionary save <filename.csv>
$ dictionary load <filename.csv>
$ word <matching substring>
$ word -c <matching substring>
$ word -u <matching substring>
$ word -r
$ sentence <matching substring>
$ sentence -t <matching substring>