Skip to content

Latest commit

 

History

History
33 lines (27 loc) · 1.87 KB

README.md

File metadata and controls

33 lines (27 loc) · 1.87 KB

Mr Robot

Minimalist command line application built with ruby, using Thor for interface and params management. Tests are written using Rspec.

Installation

  • Make sure you are using ruby 3.2.2, e.g rbenv local 3.2.2
  • Clone the repo and cd to it
  • Run: bundle install
  • Play with it! Try typing bundle exec thor list to see the list of available commands with examples and params usage

About the app

  • Main App or "entry point" is app.thor. In it, you'll find the commands that compose the application: interactive and import.
  • Interactive runs the app on a loop that can be exited by typing exit or just by ctrl-c
    • bundle exec thor app:interactive will run the app and ask for a valid command
    • If an invalid command is passed, you should see an error message (Invalid command)
    • The input is case insensitive, e.g MoVe is a valid command.
  • Import takes a file path as an argument and reads the commands line by line.
    • bundle exec thor app:import spec/fixtures/commands.txt parse the commands and output the reports
    • If no file is found a Looks like you entered an invalid file message should be displayed

Run the tests

Just type bundle exec rspec to run all tests.

TODO

Final thoughts

Feel free to test with multiple files and play with the app!