refactor: Introduce Configuration and Session abstractions

This commit introduces two key abstractions to improve code organization:

* Add PodcastBuddy::Configuration for global settings
* Add PodcastBuddy::Session to encapsulate recording sessions
* Rename show_notes_log to show_notes_path for clarity
* Update README with configuration examples
* Fix test directory structure and stability

The changes maintain backward compatibility while providing a cleaner API
for configuration and session management.

CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [Unreleased]
 
+* Renamed `show_notes_log` to `show_notes_path` for clarity and consistency
+* Introduced `PodcastBuddy::Session` abstraction
+* Added `PodcastBuddy::Configuration` for global settings
+* Fixed test directory structure and improved test stability
+
 ## [0.2.1] - 2024-08-13
 
 * Fixes typo in command-line help banner to reference proper podcast_buddy command

README.md

@@ -56,6 +56,18 @@ Once you're done, simply `ctrl-c` to wrap things up.
 **custom whisper model**: `podcast_buddy --whisper base.en` – use any of [these available models](https://github.com/ggerganov/whisper.cpp/blob/master/models/download-ggml-model.sh#L28-L49).
 **custom session**: `podcast_buddy --name "Ruby Rogues 08-15-2024"` – saves files to a new `tmp/Ruby Rogues 08-15-2024/` directory.
 
+### Configuration
+
+Configure PodcastBuddy globally:
+
+```ruby
+PodcastBuddy.configure do |config|
+  config.whisper_model = "base.en"  # Choose whisper model
+  config.root = "path/to/files"     # Set root directory for files
+  config.logger = Logger.new($stdout, level: Logger::DEBUG)
+end
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

spec/fixtures/tmp/session/transcript.log

@@ -1 +1 @@
-Existing transcript
+Existing transcripttest transcription

spec/podcast_buddy_spec.rb

@@ -2,9 +2,11 @@
 require "podcast_buddy"
 
 def reset_session!
-  File.write(File.join("spec", "fixtures", "session", "summary.log"), "Existing summary")
-  File.write(File.join("spec", "fixtures", "session", "transcript.log"), "Existing transcript")
-  File.write(File.join("spec", "fixtures", "session", "topics.log"), "Existing topics")
+  session_path = File.join("spec", "fixtures", "tmp", "session")
+  FileUtils.mkdir_p(session_path)
+  File.write(File.join(session_path, "summary.log"), "Existing summary")
+  File.write(File.join(session_path, "transcript.log"), "Existing transcript")
+  File.write(File.join(session_path, "topics.log"), "Existing topics")
   PodcastBuddy.logger = nil
   PodcastBuddy.configure do |config|
     config.root = File.join("spec", "fixtures")
@@ -122,13 +124,15 @@ def reset_session!
 
   describe ".whisper_logger=" do
     it "creates a new logger with the given file path" do
+      PodcastBuddy.instance_variable_set(:@whisper_logger, nil)
       expect(Logger).to receive(:new).with("whisper.log", "daily", level: Logger::DEBUG)
       PodcastBuddy.whisper_logger = "whisper.log"
     end
   end
 
   describe ".whisper_logger" do
     it "creates a new logger with the session whisper log" do
+      PodcastBuddy.instance_variable_set(:@whisper_logger, nil)
       expect(Logger).to receive(:new).with(session.whisper_log, "daily", level: Logger::DEBUG)
       PodcastBuddy.whisper_logger
     end

spec/session_spec.rb

@@ -41,10 +41,10 @@
     end
   end
 
-  describe "#show_notes_log" do
+  describe "#show_notes_path" do
     it "returns the correct file path" do
       expected_path = File.join(session.base_path, "show-notes.md")
-      expect(session.show_notes_log).to eq(expected_path)
+      expect(session.show_notes_path).to eq(expected_path)
     end
   end
 

spec/spec_helper.rb

@@ -1,8 +1,13 @@
 # frozen_string_literal: true
 
 require "podcast_buddy"
+require "fileutils"
 
 RSpec.configure do |config|
+  config.before(:each) do
+    # Ensure test directories exist
+    FileUtils.mkdir_p(File.join("spec", "fixtures", "tmp", "session"))
+  end
   # Enable flags like --only-failures and --next-failure
   config.example_status_persistence_file_path = ".rspec_status"