audio_book_creator 0.0.1

data/spec/audio_book_creator/chapter_spec.rb

@@ -0,0 +1,80 @@
+require "spec_helper"
+
+describe AudioBookCreator::Chapter do
+  subject { described_class.new(number: 1, title: "title1", body: ["body1"]) }
+
+  it "should set number" do
+    expect(subject.number).to eq(1)
+  end
+
+  it "should set title" do
+    expect(subject.title).to eq("title1")
+  end
+
+  it "should set body" do
+    expect(subject.body).to eq("body1")
+  end
+
+  it "should support string body (mostly for tests)" do
+    expect(described_class.new(body: "body1").body).to eq("body1")
+  end
+
+  it "should support string multiple body entries" do
+    expect(described_class.new(body: ["body1", nil, "body2"]).body).to eq("body1\n\nbody2")
+  end
+
+  it "should support other values for number, title, and body" do
+    other = described_class.new(number: 2, title: "title2")
+    expect(other.number).to eq(2)
+    expect(other.title).to eq("title2")
+  end
+
+  it "should set filename" do
+    expect(subject.filename).to eq("chapter01")
+  end
+
+  # this is how the values are currently passed from page_def into chapter
+  describe "#to_s" do
+    context "with dom nodes" do
+      subject { described_class.new(number: 1, title: "title1", body: dom_nodes("body1")) }
+      it "should support dom nodes with to_s" do
+        expect(subject.to_s).to eq("title1\n\nbody1\n")
+      end
+    end
+
+    it "should provide to_s" do
+      expect(subject.to_s).to eq("title1\n\nbody1\n")
+    end
+  end
+
+  it { expect(subject).not_to be_empty }
+  it { expect(subject).to be_present }
+  it { expect(described_class.new).to be_empty }
+  it { expect(described_class.new).not_to be_present }
+
+  describe "#eq1" do
+    it "should understand ==" do
+      expect(subject).to eq(Class.new(described_class).new(number: 1.0, title: "title1", body: "body1"))
+    end
+
+    it "should understand != nil" do
+      expect(subject).not_to eq(nil)
+    end
+
+    it "should understand != different class" do
+      expect(subject).not_to eq("abc")
+    end
+
+    it "should understand != number" do
+      expect(subject).not_to eq(described_class.new(number: 2, title: "title1", body: "body1"))
+    end
+
+    it "should understand != title" do
+      expect(subject).not_to eq(described_class.new(number: 1, title: "title2", body: "body1"))
+    end
+
+    it "should understand != body" do
+      expect(subject).not_to eq(described_class.new(number: 1, title: "title1", body: "body2"))
+    end
+  end
+end

data/spec/audio_book_creator/cli_spec.rb

@@ -0,0 +1,274 @@
+require 'spec_helper'
+require 'uri'
+require 'logger'
+# NOTE: cli class is not in the path by default
+#       it is only included by running the command
+require 'audio_book_creator/cli'
+
+describe AudioBookCreator::Cli do
+  # this sidesteps creating a database file
+  subject { described_class.new }
+
+  context "with no arguments" do
+    it "displays an error" do
+      expect($stdout).to receive(:puts).with(/url/, /Usage.*title/)
+      expect(subject).to receive(:exit).with(2).and_raise("exited")
+      expect { subject.parse([]) }.to raise_error("exited")
+    end
+  end
+
+  context "with one argument" do
+    it "assigns title and url" do
+      subject.parse(%w(http://site.com/title))
+      expect(subject.book_def.title).to eq("title")
+      expect(subject.book_def.urls).to eq(%w(http://site.com/title))
+    end
+
+    it "defaults to warn" do
+      subject.parse(%w(http://site.com/title))
+      expect(AudioBookCreator.logger.level).to eq(Logger::WARN)
+    end
+  end
+
+  context "with title and url" do
+    it "assigns title and url" do
+      subject.parse(%w(title http://site.com/))
+      expect(subject.book_def.title).to eq("title")
+      expect(subject.book_def.urls).to eq(%w(http://site.com/))
+    end
+  end
+
+  context "with multiple urls" do
+    it "assigns title and url" do
+      subject.parse(%w(http://site.com/title http://site.com/title2))
+      expect(subject.book_def.title).to eq("title")
+      expect(subject.book_def.urls).to eq(%w(http://site.com/title http://site.com/title2))
+    end
+  end
+
+  context "with title and multiple urls" do
+    it "has multiple urls" do
+      subject.parse(%w(title http://site.com/page1 http://site.com/page2))
+      expect(subject.book_def.title).to eq("title")
+      expect(subject.book_def.urls).to eq(%w(http://site.com/page1 http://site.com/page2))
+    end
+  end
+
+  context "with verbose" do
+    it "defaults to warning logging" do
+      subject.parse(%w(http://site.com/title --verbose))
+      expect(AudioBookCreator.logger.level).to eq(Logger::INFO)
+    end
+
+    it "defaults to warning" do
+      subject.parse(%w(http://site.com/title -v))
+      expect(AudioBookCreator.logger.level).to eq(Logger::INFO)
+    end
+  end
+
+
+  context "#parse" do
+    # actual cli calls subject.parse.run, so it needs to chain
+    it { expect(subject.parse(%w(http://site.com/title))).to eq(subject) }
+  end
+
+  # parameters
+
+  context "#defaults" do
+    it "should default values" do
+      # NOTE: calling with no constructor
+      pristine = described_class.new
+      expect(subject.surfer_def.max).not_to be_truthy
+      expect(subject.page_def.title_path).to eq("h1")
+      expect(subject.page_def.body_path).to eq("p")
+      expect(subject.page_def.link_path).to eq("a")
+    end
+  end
+
+  # file sanitization is tested in audio_book_creator.spec
+  context "#base_dir" do
+    it "should derive base_dir from title" do
+      subject.parse(%w(title http://site.com/))
+      expect(subject.book_def.base_dir).to eq("title")
+    end
+
+    it "should support titles with spaces" do
+      subject.parse(["title !for", "http://site.com/"])
+      expect(subject.book_def.base_dir).to eq("title-for")
+    end
+
+    it "should support titles with extra stuff" do
+      subject.parse(["title,for!", "http://site.com/"])
+      expect(subject.book_def.base_dir).to eq("title-for")
+    end
+
+    it "should override basedir" do
+      subject.parse(%w(title http://site.com/ --base-dir dir))
+      expect(subject.book_def.base_dir).to eq("dir")
+    end
+  end
+
+  context "with version" do
+    it "should provide version" do
+      expect($stdout).to receive(:puts).with(/audio_book_creator #{AudioBookCreator::VERSION}/)
+      expect { subject.parse(%w(--version)) }.to raise_error(SystemExit)
+    end
+  end
+
+  context "#help" do
+    {
+      "-v" => "Run verbosely",
+      "--verbose" => "Run verbosely",
+      "--title" => "Title css",
+      "--body" => "Content css",
+      "--link" => "Next Page css",
+      "--chapter" => "Next Chapter css",
+      "--no-max" => "Don't limit the number of pages to visit",
+      "--max" => "Maximum number of pages to visit",
+      "--force-audio" => "Regerate the audio",
+      "--force-html" => "Regerate the audio",
+      "--rate" => "Set words per minute",
+      "--voice" => "Set speaker voice",
+      "--base-dir" => "Directory to hold files",
+      "-A" => "Load book into itunes",
+      "--itunes" => "Load book into itunes",
+    }.each do |switch, text|
+      it "should display #{text} for #{switch} option" do
+        expect($stdout).to receive(:puts).with(/#{switch}.*#{text}/)
+        expect { subject.parse(%w(--help)) }.to raise_error(SystemExit)
+      end
+    end
+
+    it "should provide help" do
+      expect($stdout).to receive(:puts).with(/Usage/)
+      #expect(subject).to receive(:exit).with(1).and_raise("exited")
+      expect { subject.parse(%w(--help)) }.to raise_error(SystemExit)
+    end
+
+    it "should provide help (with short option)" do
+      expect($stdout).to receive(:puts).with(/Usage/)
+      expect { subject.parse(%w(-h)) }.to raise_error(SystemExit)
+    end
+  end
+
+  context "#page_def" do
+    it "should create page_def" do
+      subject.parse(%w(http://site.com/title))
+      # defaults
+      expect(subject.page_def.title_path).to eq("h1")
+      expect(subject.page_def.body_path).to eq("p")
+      expect(subject.page_def.link_path).to eq("a")
+    end
+
+    it "should support title" do
+      subject.parse(%w(http://site.com/title --title h1.big))
+      expect(subject.page_def.title_path).to eq("h1.big")
+    end
+
+    it "should support body" do
+      subject.parse(%w(http://site.com/title --body p.content))
+      expect(subject.page_def.body_path).to eq("p.content")
+    end
+
+    it "should support link" do
+      subject.parse(%w(http://site.com/title --link a.next_page))
+      expect(subject.page_def.link_path).to eq("a.next_page")
+    end
+  end
+
+  context "#book_def" do
+    it "should create book_def" do
+      subject.parse(%w(http://site.com/title))
+      # defaults
+      expect(subject.book_def.base_dir).to eq("title")
+      expect(subject.book_def.title).to eq("title")
+      expect(subject.book_def.author).to eq("Vicki")
+      expect(subject.book_def.itunes).not_to be_truthy
+    end
+
+    it "should support basedir" do
+      subject.parse(%w(http://site.com/title --base-dir dir))
+      # defaults
+      expect(subject.book_def.base_dir).to eq("dir")
+      expect(subject.book_def.title).to eq("title")
+    end
+
+    it "should set itunes" do
+      subject.parse(%w(http://site.com/title -A))
+      expect(subject.book_def.itunes).to be_truthy
+    end
+
+    it "should pass all urls to book_def" do
+      subject.parse(%w(http://site.com/title http://site.com/title http://site.com/title2))
+      expect(subject.book_def.urls).to eq(%w(http://site.com/title http://site.com/title http://site.com/title2))
+    end
+  end
+
+  context "#speaker_def" do
+    it "should default" do
+      subject.parse(%w(http://site.com/title))
+      expect(subject.speaker_def.voice).to eq("Vicki")
+      expect(subject.speaker_def.rate).to eq(280)
+      expect(subject.speaker_def.channels).to eq(1)
+      expect(subject.speaker_def.max_hours).to eq(7)
+      expect(subject.speaker_def.bit_rate).to eq(32)
+      expect(subject.speaker_def.sample_rate).to eq(22_050)
+      expect(subject.speaker_def.regen_audio).not_to be_truthy
+    end
+
+    it "should set voice" do
+      subject.parse(%w(http://site.com/title --voice Serena))
+      expect(subject.speaker_def.voice).to eq("Serena")
+    end
+
+    it "should set rate" do
+      subject.parse(%w(http://site.com/title --rate 200))
+      expect(subject.speaker_def.rate).to eq(200)
+    end
+
+    it "should set force" do
+      subject.parse(%w(http://site.com/title --force-audio))
+      expect(subject.speaker_def.regen_audio).to be_truthy
+    end
+  end
+
+  context "#surfer_def" do
+    it "assigns cache_filename" do
+      subject.parse(%w(http://site.com/title))
+      expect(subject.surfer_def.cache_filename).to eq("pages.db")
+    end
+  end
+
+  context "max param" do
+    it "should have a max" do
+      subject.parse(%w(http://site.com/title --max 20))
+      expect(subject.surfer_def.max).to eq(20)
+    end
+
+    it "should have no max" do
+      subject.parse(%w(http://site.com/title --max 20 --no-max))
+      expect(subject.surfer_def.max).not_to be_truthy
+    end
+  end
+
+  describe "#conductor" do
+    it "should create a conductor" do
+      subject.parse(%w(http://site.com/title))
+      expect(subject.conductor.page_def).to eq(subject.page_def)
+      expect(subject.conductor.book_def).to eq(subject.book_def)
+      expect(subject.conductor.speaker_def).to eq(subject.speaker_def)
+      expect(subject.conductor.surfer_def).to eq(subject.surfer_def)
+      expect(subject.conductor).to respond_to(:run)
+    end
+  end
+
+  describe "#run" do
+    it "should call book conductor" do
+      subject.parse(%w(http://site.com/title))
+      conductor = double(:conductor)
+      expect(conductor).to receive(:run).and_return("YAY")
+      expect(subject).to receive(:conductor).and_return(conductor)
+      expect(subject.run).to eq("YAY")
+    end
+  end
+end

data/spec/audio_book_creator/conductor_spec.rb

@@ -0,0 +1,102 @@
+require 'spec_helper'
+
+describe AudioBookCreator::Conductor do
+  let(:page_def)    { AudioBookCreator::PageDef.new("h1.title", "div", "a.link", "a.chapter") }
+  let(:book_def)    do
+    AudioBookCreator::BookDef.new("the title", "author", "dir", %w(a b), true).tap do |bd|
+      bd.urls = %w(http://www.host.com/ http://www.host.com/)
+    end
+  end
+  let(:speaker_def) { AudioBookCreator::SpeakerDef.new }
+  let(:surfer_def)  { AudioBookCreator::SurferDef.new("http://host.com/", 5, true, "database") }
+  subject           { described_class.new(page_def, book_def, speaker_def, surfer_def) }
+
+  context "#initialize" do
+    it { expect(subject.page_def).to    eq(page_def) }
+    it { expect(subject.book_def).to    eq(book_def) }
+    it { expect(subject.speaker_def).to eq(speaker_def) }
+    it { expect(subject.surfer_def).to  eq(surfer_def) }
+  end
+
+  context "#page_cache" do
+    it { expect(subject.page_cache.filename).to eq(subject.surfer_def.cache_filename) }
+  end
+
+  context "#web" do
+    it "sets references" do
+      expect(subject.web.max).to eq(subject.surfer_def.max)
+    end
+  end
+
+  context "#cached_web" do
+    it "sets references" do
+      expect(subject.cached_web.cache).to eq(subject.page_cache)
+      expect(subject.cached_web.main).to eq(subject.web)
+      expect(subject.cached_web).to respond_to(:main)
+    end
+  end
+
+  context "#invalid_urls" do
+    it "sets references" do
+      #expect(subject.invalid_urls.host).to eq(subject.surfer_def.host)
+      expect(subject.invalid_urls.host).to eq("host.com")
+    end
+  end
+
+  context "#spider" do
+    it "sets references" do
+      expect(subject.spider.page_def).to eq(subject.page_def)
+      expect(subject.spider.web).to eq(subject.cached_web)
+      expect(subject.spider.invalid_urls).to eq(subject.invalid_urls)
+    end
+  end
+
+  context "#editor" do
+    it "sets references" do
+      expect(subject.editor.page_def).to eq(subject.page_def)
+      # needs to be an editor
+      expect(subject.editor).to respond_to(:parse)
+      # hack
+      expect(subject.editor).not_to eq(subject)
+    end
+  end
+
+  context "#speaker" do
+    it "should create speaker" do
+      expect(subject.speaker.speaker_def).to eq(subject.speaker_def)
+      expect(subject.speaker.book_def).to eq(subject.book_def)
+      expect(subject.speaker).to respond_to(:say)
+    end
+  end
+
+  context "#binder" do
+    it "should create a binder" do
+      expect(subject.binder.book_def).to eq(subject.book_def)
+      expect(subject.binder.speaker_def).to eq(subject.speaker_def)
+      expect(subject.binder).to respond_to(:create)
+    end
+  end
+
+  describe "#creator" do
+    it "should create a book creator" do
+      expect(subject.creator.spider).to  eq(subject.spider)
+      expect(subject.creator.editor).to  eq(subject.editor)
+      expect(subject.creator.speaker).to eq(subject.speaker)
+      expect(subject.creator.binder).to  eq(subject.binder)
+      expect(subject.creator).to respond_to(:create)
+    end
+  end
+
+  describe "#outstanding" do
+    it "should set outstanding" do
+      expect(subject.outstanding).to eq(book_def.unique_urls)
+    end
+  end
+
+  describe "#run" do
+    it do
+      expect(subject.creator).to receive(:create).with(subject.outstanding)
+      subject.run
+    end
+  end
+end