playgroundbook 0.3.0 → 0.4.0

data/spec/{playground_book_lint → linter}/chapter_linter_spec.rb

@@ -1,24 +1,24 @@
-require File.expand_path('../../spec_helper', __FILE__)
+require File.expand_path("../../spec_helper", __FILE__)
 
 module Playgroundbook
   describe RootManifestLinter do
     include FakeFS::SpecHelpers
     let(:chapter_linter) { ChapterLinter.new(chapter_manifest_linter) }
     let(:chapter_manifest_linter) { double(ChapterManifestLinter) }
-    let!(:chapter_directory_name) { 'test_chapter' }
+    let(:chapter_directory_name) { "test_chapter" }
 
-    it 'fails when chapter directory does not exist' do
+    it "fails when chapter directory does not exist" do
       expect { chapter_linter.lint(chapter_directory_name) }.to raise_error(SystemExit)
     end
 
-    it 'fails when Pages subdirectory of chapter dir does not exist' do
+    it "fails when Pages subdirectory of chapter dir does not exist" do
       FakeFS do
         Dir.mkdir(chapter_directory_name)
         expect { chapter_linter.lint(chapter_directory_name) }.to raise_error(SystemExit)
       end
     end
 
-    it 'calls through to chapter manifest linter' do
+    it "calls through to chapter manifest linter" do
       FakeFS do
         expect(chapter_manifest_linter).to receive(:lint)
         FileUtils.mkdir_p("#{chapter_directory_name}/Pages")

data/spec/{playground_book_lint → linter}/chapter_manifest_linter_spec.rb

@@ -1,36 +1,36 @@
-require File.expand_path('../../spec_helper', __FILE__)
+require File.expand_path("../../spec_helper", __FILE__)
 
 module Playgroundbook
   describe ChapterManifestLinter do
     include FakeFS::SpecHelpers
     let(:chapter_manifest_linter) { ChapterManifestLinter.new(page_linter) }
     let(:page_linter) { double(PageLinter) }
-    let!(:page_directory_name) { 'test.playgroundpage' }
+    let(:page_directory_name) { "test.playgroundpage" }
 
-    it 'fails if no Pages defined in Manifest' do
+    it "fails if no Pages defined in Manifest" do
       FakeFS do
-        plist = { 'Name' => 'Test' }.to_plist
-        File.open('Manifest.plist', 'w') { |f| f.write(plist) }
+        plist = { "Name" => "Test" }.to_plist
+        File.open("Manifest.plist", "w") { |f| f.write(plist) }
 
         expect { chapter_manifest_linter.lint }.to raise_error(SystemExit)
       end
     end
 
-    it 'fails if Pages dir specified in Manifest does not exist' do
+    it "fails if Pages dir specified in Manifest does not exist" do
       FakeFS do
-        plist = { 'Name' => 'Test', 'Pages' => [page_directory_name] }.to_plist
-        File.open('Manifest.plist', 'w') { |f| f.write(plist) }
-        Dir.mkdir('Pages')
+        plist = { "Name" => "Test", "Pages" => [page_directory_name] }.to_plist
+        File.open("Manifest.plist", "w") { |f| f.write(plist) }
+        Dir.mkdir("Pages")
 
         expect { chapter_manifest_linter.lint }.to raise_error(SystemExit)
       end
     end
 
-    it 'calls through to page linter' do
+    it "calls through to page linter" do
       FakeFS do
         expect(page_linter).to receive(:lint)
-        plist = { 'Name' => 'Test', 'Pages' => [page_directory_name] }.to_plist
-        File.open('Manifest.plist', 'w') { |f| f.write(plist) }
+        plist = { "Name" => "Test", "Pages" => [page_directory_name] }.to_plist
+        File.open("Manifest.plist", "w") { |f| f.write(plist) }
         FileUtils.mkdir_p("Pages/#{page_directory_name}")
 
         expect { chapter_manifest_linter.lint }.to_not raise_error

data/spec/{playground_book_lint → linter}/contents_linter_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path('../../spec_helper', __FILE__)
+require File.expand_path("../../spec_helper", __FILE__)
 
 module Playgroundbook
   describe ContentsLinter do
@@ -6,11 +6,11 @@ module Playgroundbook
     let(:contents_linter) { ContentsLinter.new(root_manifest_linter) }
     let(:root_manifest_linter) { double(RootManifestLinter) }
 
-    it 'calls through to root manifest linter' do
+    it "calls through to root manifest linter" do
       expect(root_manifest_linter).to receive(:lint)
 
       FakeFS do
-        Dir.mkdir 'Contents'
+        Dir.mkdir "Contents"
         contents_linter.lint
       end
     end

data/spec/{playground_book_lint → linter}/cutscene_page_linter_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path('../../spec_helper', __FILE__)
+require File.expand_path("../../spec_helper", __FILE__)
 
 module Playgroundbook
   describe CutscenePageLinter do
@@ -6,7 +6,7 @@ module Playgroundbook
     let(:cutscene_page_linter) { CutscenePageLinter.new(cutscene_page_manifest_linter) }
     let(:cutscene_page_manifest_linter) { double(CutscenePageManifestLinter) }
 
-    it 'passes through to cutscene_page_manifest_linter' do
+    it "passes through to cutscene_page_manifest_linter" do
       expect(cutscene_page_manifest_linter).to receive(:lint)
       expect { cutscene_page_linter.lint }.to_not raise_error
     end

data/spec/linter/cutscene_page_manifest_linter_spec.rb

@@ -0,0 +1,63 @@
+require File.expand_path("../../spec_helper", __FILE__)
+
+module Playgroundbook
+  describe CutscenePageManifestLinter do
+    include FakeFS::SpecHelpers
+    let(:cutscene_page_manifest_linter) { CutscenePageManifestLinter.new }
+
+    it "given a valid manifest does not fail" do
+      FakeFS do
+        cutscene_reference = "RealFile.html"
+        plist = {
+          "Name" => "Test Page",
+          "CutsceneReference" => cutscene_reference
+        }.to_plist
+        File.open("Manifest.plist", "w") { |f| f.write(plist) }
+        File.open(cutscene_reference, "w")
+
+        expect { cutscene_page_manifest_linter.lint }.not_to raise_error
+      end
+    end
+
+    context "given a cutscene path" do
+      it "fails if the key doesn't exist" do
+        FakeFS do
+          cutscene_reference = "FakeFile.html"
+          plist = {
+            "Name" => "Test Page"
+          }.to_plist
+          File.open("Manifest.plist", "w") { |f| f.write(plist) }
+
+          expect { cutscene_page_manifest_linter.lint }.to raise_error(SystemExit)
+        end
+      end
+
+      it "fails if that file doesn't exist" do
+        FakeFS do
+          cutscene_reference = "FakeFile.html"
+          plist = {
+            "Name" => "Test Page",
+            "CutsceneReference" => cutscene_reference
+          }.to_plist
+          File.open("Manifest.plist", "w") { |f| f.write(plist) }
+
+          expect { cutscene_page_manifest_linter.lint }.to raise_error(SystemExit)
+        end
+      end
+
+      it "fails with a non-HTML file" do
+        FakeFS do
+          cutscene_reference = "RealFile.xml"
+          plist = {
+            "Name" => "Test Page",
+            "CutsceneReference" => cutscene_reference
+          }.to_plist
+          File.open("Manifest.plist", "w") { |f| f.write(plist) }
+          File.open(cutscene_reference, "w")
+
+          expect { cutscene_page_manifest_linter.lint }.to raise_error(SystemExit)
+        end
+      end
+    end
+  end
+end

data/spec/linter/manfiest_linter_spec.rb

@@ -0,0 +1,71 @@
+require File.expand_path("../../spec_helper", __FILE__)
+
+module Playgroundbook
+  describe RootManifestLinter do
+    include FakeFS::SpecHelpers
+    let(:manifest_linter) { ManifestLinter.new }
+
+    it "fails if a Manifest.plist file does not exist" do
+      expect { manifest_linter.lint }.to raise_error(SystemExit)
+    end
+
+    it "fails if the Manifest.plist file does not contain a Name value" do
+      FakeFS do
+        plist = {}.to_plist
+        File.open("Manifest.plist", "w") { |f| f.write(plist) }
+
+        expect { manifest_linter.lint }.to raise_error(SystemExit)
+      end
+    end
+
+    it "succeeds if the Manifest.plist file is well-formed" do
+      FakeFS do
+        plist = { "Name" => "My Test Name" }.to_plist
+        File.open("Manifest.plist", "w") { |f| f.write(plist) }
+
+        expect { manifest_linter.lint }.to_not raise_error
+      end
+    end
+
+    it "extracts Manfiest.plist contents from pwd" do
+      FakeFS do
+        contents = { "key" => "value" }
+        File.open("Manifest.plist", "w") { |f| f.write(contents.to_plist) }
+
+        expect(manifest_linter.manifest_plist_contents).to eq(contents)
+      end
+    end
+
+    describe "key-value checking" do
+      before do
+      end
+
+      it "checks for non-defined keys in manifest" do
+        FakeFS do
+          plist = {}.to_plist
+          File.open("Manifest.plist", "w") { |f| f.write(plist) }
+
+          expect(manifest_linter.value_defined_in_manifest?("key")).to be_falsy
+        end
+      end
+
+      it "checks for nil keys in manifest" do
+        FakeFS do
+          plist = { "key" => nil }.to_plist
+          File.open("Manifest.plist", "w") { |f| f.write(plist) }
+
+          expect(manifest_linter.value_defined_in_manifest?("key")).to be_falsy
+        end
+      end
+
+      it "checks for empty keys in manifest" do
+        FakeFS do
+          plist = { "key" => "value" }.to_plist
+          File.open("Manifest.plist", "w") { |f| f.write(plist) }
+
+          expect(manifest_linter.value_defined_in_manifest?("key")).to be_truthy
+        end
+      end
+    end
+  end
+end

data/spec/{playground_book_lint → linter}/page_linter_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path('../../spec_helper', __FILE__)
+require File.expand_path("../../spec_helper", __FILE__)
 
 module Playgroundbook
   describe PageLinter do
@@ -6,12 +6,12 @@ module Playgroundbook
     let(:page_linter) { PageLinter.new(page_manifest_linter) }
     let(:page_manifest_linter) { double(PageManifestLinter) }
 
-    it 'fails if Contents.swift does not exist' do
+    it "fails if Contents.swift does not exist" do
       expect { page_linter.lint }.to raise_error(SystemExit)
     end
 
-    it 'passes through to page_manifest_linter' do
-      File.open(ContentsSwiftFileName, 'w') { |f| f.write('') }
+    it "passes through to page_manifest_linter" do
+      File.open(ContentsSwiftFileName, "w") { |f| f.write("") }
       expect(page_manifest_linter).to receive(:lint)
       expect { page_linter.lint }.to_not raise_error
     end

data/spec/{playground_book_lint → linter}/page_manifest_linter_spec.rb

@@ -1,40 +1,40 @@
-require File.expand_path('../../spec_helper', __FILE__)
+require File.expand_path("../../spec_helper", __FILE__)
 
 module Playgroundbook
   describe PageManifestLinter do
     include FakeFS::SpecHelpers
     let(:page_manifest_linter) { PageManifestLinter.new }
 
-    it 'given a valid manifest does not fail' do
+    it "given a valid manifest does not fail" do
       # TODO: We're not checking optional values yet, more tests to come.
       # See page_manifest_linter.rb and https://github.com/ashfurrow/playground-book-lint/issues/3 for details.
 
       FakeFS do
-        plist = { 'Name' => 'Test Page' }.to_plist
-        File.open('Manifest.plist', 'w') { |f| f.write(plist) }
+        plist = { "Name" => "Test Page" }.to_plist
+        File.open("Manifest.plist", "w") { |f| f.write(plist) }
         expect { page_manifest_linter.lint }.to_not raise_error
       end
     end
 
-    describe 'context given a live view mode' do
-      it 'succeeds with valid values' do
+    describe "context given a live view mode" do
+      it "succeeds with valid values" do
         FakeFS do
           plist = {
-            'Name' => 'Test Page',
-            'LiveViewMode' => 'HiddenByDefault'
+            "Name" => "Test Page",
+            "LiveViewMode" => "HiddenByDefault"
           }.to_plist
-          File.open('Manifest.plist', 'w') { |f| f.write(plist) }
+          File.open("Manifest.plist", "w") { |f| f.write(plist) }
           expect { page_manifest_linter.lint }.to_not raise_error
         end
       end
 
-      it 'fails with invalid values' do
+      it "fails with invalid values" do
         FakeFS do
           plist = {
-            'Name' => 'Test Page',
-            'LiveViewMode' => 'UnsupportedViewMode'
+            "Name" => "Test Page",
+            "LiveViewMode" => "UnsupportedViewMode"
           }.to_plist
-          File.open('Manifest.plist', 'w') { |f| f.write(plist) }
+          File.open("Manifest.plist", "w") { |f| f.write(plist) }
           expect { page_manifest_linter.lint }.to raise_error(SystemExit)
         end
       end

data/spec/{playground_book_lint → linter}/playgroundbook_lint_spec.rb

@@ -1,32 +1,32 @@
-require File.expand_path('../../spec_helper', __FILE__)
+require File.expand_path("../../spec_helper", __FILE__)
 
 module Playgroundbook
   describe Linter do
     let(:linter) { Linter.new(test_playground_book, contents_linter) }
     let(:contents_linter) { double(ContentsLinter) }
 
-    it 'initializes correctly' do
+    it "initializes correctly" do
       expect(linter.playground_file_name) == test_playground_book
     end
 
-    it 'exits on lint failure' do
+    it "exits on lint failure" do
       allow(linter).to receive(:contents_dir_exists?)
         .and_return(false)
 
       expect { linter.lint }.to raise_error(SystemExit)
     end
 
-    it 'fails when file does not exist' do
+    it "fails when file does not exist" do
       allow(linter).to receive(:contents_dir_exists?)
         .and_return(false)
       allow(linter).to receive(:fail_lint)
-        .with('No Contents directory')
+        .with("No Contents directory")
         .and_raise(SystemExit)
 
       expect { linter.lint }.to raise_error(SystemExit)
     end
 
-    it 'lints' do
+    it "lints" do
       allow(linter).to receive(:contents_dir_exists?)
         .and_return(true)
       allow(contents_linter).to receive(:lint)

data/spec/linter/root_manifest_linter_spec.rb

@@ -0,0 +1,35 @@
+require File.expand_path("../../spec_helper", __FILE__)
+
+module Playgroundbook
+  describe RootManifestLinter do
+    include FakeFS::SpecHelpers
+    let(:root_manifest_linter) { RootManifestLinter.new(chapter_linter) }
+    let(:chapter_linter) { double(ChapterLinter) }
+
+    it "fails if Chapters directory does not exist" do
+      expect { root_manifest_linter.lint }.to raise_error(SystemExit)
+    end
+
+    it "fails if manfiest does not include Chapters" do
+      FakeFS do
+        Dir.mkdir("Chapters")
+        plist = { "Name" => "Test" }.to_plist
+        File.open("Manifest.plist", "w") { |f| f.write(plist) }
+
+        expect { root_manifest_linter.lint }.to raise_error(SystemExit)
+      end
+    end
+
+    it "calls through to lint each chapter" do
+      FakeFS do
+        plist = { "Chapters" => ["test_chapter_name"], "Name" => "Test" }.to_plist
+        File.open("Manifest.plist", "w") { |f| f.write(plist) }
+        Dir.mkdir("Chapters")
+
+        expect(chapter_linter).to receive(:lint).with("test_chapter_name")
+
+        expect { root_manifest_linter.lint }.to_not raise_error
+      end
+    end
+  end
+end

data/spec/renderer/chapter_collator_spec.rb

@@ -0,0 +1,70 @@
+require File.expand_path("../../spec_helper", __FILE__)
+
+module Playgroundbook
+  describe ChapterCollator do
+    include FakeFS::SpecHelpers
+    let(:collator) { ChapterCollator.new(page_writer, test_ui) }
+    let(:page_writer) { double(PageWriter) }
+    let(:test_ui) { Cork::Board.new(silent: true) }
+    let(:parsed_chapter) { PageParser.new.parse_chapter_pages(test_chapter_contents) }
+    let(:chapter_name) { "test_chapter" }
+
+    before do
+      allow(page_writer).to receive(:write_page)
+    end
+
+    it "creates a chapter manifest" do
+      collator.collate(chapter_name, parsed_chapter, [])
+
+      expect(File.exist?("#{chapter_name}.playgroundchapter/#{ManifestFileName}")).to be_truthy
+    end
+
+    context "the chapter manifest" do
+      before do
+        collator.collate(chapter_name, parsed_chapter, ["UIKit"])
+      end
+
+      it "has the correct name" do
+        expect(get_manifest("#{chapter_name}.playgroundchapter/#{ManifestFileName}")["Name"]).to eq(chapter_name)
+      end
+
+      it "has the correct pages" do
+        expect(get_manifest("#{chapter_name}.playgroundchapter/#{ManifestFileName}")["Pages"]).to eq([
+                                                                                                       "Page 1.playgroundpage",
+                                                                                                       "Page 2.playgroundpage"
+                                                                                                     ])
+      end
+    end
+
+    it "calls the page_writer for each page" do
+      expect(page_writer).to receive(:write_page).with("Page 1", "Page 1.playgroundpage", [], "str = \"Yo, it's page 1.\"\nsharedFunc()")
+      expect(page_writer).to receive(:write_page).with("Page 2", "Page 2.playgroundpage", [], "str = \"Page 2 awww yeah.\"\nsharedFunc()")
+
+      collator.collate(chapter_name, parsed_chapter, [])
+    end
+
+    it "does not explode if a Source directory already exists" do
+      expect { collator.collate(chapter_name, parsed_chapter, []) }.to_not raise_error
+    end
+
+    context "having colated" do
+      before do
+        collator.collate(chapter_name, parsed_chapter, [])
+      end
+
+      it "creates a Source directory if one does not exist" do
+        expect(Dir.exist?("#{chapter_name}.playgroundchapter/#{SharedSourcesDirectoryName}")).to be_truthy
+      end
+
+      context "Sources folder" do
+        it "has a Preamble.swift file" do
+          expect(File.exist?("#{chapter_name}.playgroundchapter/#{SharedSourcesDirectoryName}/#{PreambleFileName}")).to be_truthy
+        end
+
+        it "has the correct preamble contents" do
+          expect(File.read("#{chapter_name}.playgroundchapter/#{SharedSourcesDirectoryName}/#{PreambleFileName}")).to eq("import UIKit\n\nvar str = \"Hello, playground\"\n\nfunc sharedFunc() {\n  print(\"This should be accessible to all pages.\")\n}")
+        end
+      end
+    end
+  end
+end