CLI Reading Log

Project roadmap

1. 01

   Set up the project with Bundler

   ~1h

   Install Ruby and create a project folder with bundle init. Add the gems activerecord and sqlite3 to the Gemfile and run bundle install. Create bin/reading as an executable Ruby script that prints the available commands when run without arguments. Done when: bin/reading prints the command list.

2. 02

   Create the database with ActiveRecord

   ~1.5h

   Connect ActiveRecord to a SQLite file (reading_log.sqlite3) and create two tables with ActiveRecord::Schema.define: books (title, author, total_pages) and sessions (book_id, pages, read_on date). Create the Book and ReadingSession models with has_many and belongs_to. Done when: running the script creates the database file with both tables.

3. 03

   Add books

   ~1.5h

   Implement add-book TITLE --pages N [--author NAME]. Add model validations: a title is required and unique, and total_pages is a whole number above 0. When a validation fails, print its error messages instead of crashing. Implement books, which lists every book with its progress. Done when: adding a book works, and adding it again or with --pages 0 prints a clear error.

4. 04

   Log reading sessions

   ~1.5h

   Implement log TITLE PAGES [--date YYYY-MM-DD], which records the pages read on that date (today by default). Validate that the book exists, pages is above 0, the date is valid and not in the future, and the total pages logged don't exceed the book's length. Done when: logging pages updates the book's progress in the books list.

5. 05

   Print the monthly report

   ~1.5h

   Implement report [--year YYYY], which prints the total pages read for each month of the year, the busiest month, and the books finished that year. Format it as an aligned table, and show a message when there's no data yet. Done when: after logging sessions over several months, the report shows correct monthly totals.

6. 06

   Write tests

   ~1.5h

   Add minitest (or RSpec) tests that use an in-memory SQLite database: validations, logging more pages than the book has, the monthly totals, and finished books. Add a Rakefile so rake test runs them. Done when: rake test passes.

Resources

• DocsRuby documentation
• DocsActive Record basics (Rails guides)
• DocsActive Record validations (Rails guides)
• DocsBundler getting started
• DocsMinitest documentation