playgroundbook 0.6.0 → 1.0.0

data/spec/linter/contents_linter_spec.rb

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

data/spec/linter/cutscene_page_linter_spec.rb

@@ -1,14 +0,0 @@
-require File.expand_path("../../spec_helper", __FILE__)
-
-module Playgroundbook
-  describe CutscenePageLinter do
-    include FakeFS::SpecHelpers
-    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
-      expect(cutscene_page_manifest_linter).to receive(:lint)
-      expect { cutscene_page_linter.lint }.to_not raise_error
-    end
-  end
-end

data/spec/linter/cutscene_page_manifest_linter_spec.rb

@@ -1,63 +0,0 @@
-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

@@ -1,71 +0,0 @@
-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/linter/page_linter_spec.rb

@@ -1,19 +0,0 @@
-require File.expand_path("../../spec_helper", __FILE__)
-
-module Playgroundbook
-  describe PageLinter do
-    include FakeFS::SpecHelpers
-    let(:page_linter) { PageLinter.new(page_manifest_linter) }
-    let(:page_manifest_linter) { double(PageManifestLinter) }
-
-    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("") }
-      expect(page_manifest_linter).to receive(:lint)
-      expect { page_linter.lint }.to_not raise_error
-    end
-  end
-end

data/spec/linter/page_manifest_linter_spec.rb

@@ -1,43 +0,0 @@
-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
-      # 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) }
-        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
-        FakeFS do
-          plist = {
-            "Name" => "Test Page",
-            "LiveViewMode" => "HiddenByDefault"
-          }.to_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
-        FakeFS do
-          plist = {
-            "Name" => "Test Page",
-            "LiveViewMode" => "UnsupportedViewMode"
-          }.to_plist
-          File.open("Manifest.plist", "w") { |f| f.write(plist) }
-          expect { page_manifest_linter.lint }.to raise_error(SystemExit)
-        end
-      end
-    end
-  end
-end

data/spec/linter/playgroundbook_lint_spec.rb

@@ -1,38 +0,0 @@
-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
-      expect(linter.playground_file_name) == test_playground_book
-    end
-
-    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
-      allow(linter).to receive(:contents_dir_exists?)
-        .and_return(false)
-      allow(linter).to receive(:fail_lint)
-        .with("No Contents directory")
-        .and_raise(SystemExit)
-
-      expect { linter.lint }.to raise_error(SystemExit)
-    end
-
-    it "lints" do
-      allow(linter).to receive(:contents_dir_exists?)
-        .and_return(true)
-      allow(contents_linter).to receive(:lint)
-      expect(Dir).to receive(:chdir).with(test_playground_book)
-
-      linter.lint
-    end
-  end
-end

data/spec/linter/root_manifest_linter_spec.rb

@@ -1,35 +0,0 @@
-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

@@ -1,70 +0,0 @@
-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, parsed_chapter, [])
-
-      expect(File.exist?("#{chapter['name']}.playgroundchapter/#{ManifestFileName}")).to be_truthy
-    end
-
-    context "the chapter manifest" do
-      before do
-        collator.collate(chapter, 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()", {"name"=>"test_chapter"})
-      expect(page_writer).to receive(:write_page).with("Page 2", "Page 2.playgroundpage", [], "str = \"Page 2 awww yeah.\"\nsharedFunc()", {"name"=>"test_chapter"})
-
-      collator.collate(chapter, parsed_chapter, [])
-    end
-
-    it "does not explode if a Source directory already exists" do
-      expect { collator.collate(chapter, parsed_chapter, []) }.to_not raise_error
-    end
-
-    context "having colated" do
-      before do
-        collator.collate(chapter, 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

data/spec/renderer/contents_manfiest_generator_spec.rb

@@ -1,41 +0,0 @@
-require File.expand_path("../../spec_helper", __FILE__)
-
-module Playgroundbook
-  describe ContentsManifestGenerator do
-    include FakeFS::SpecHelpers
-    let(:generator) { ContentsManifestGenerator.new(test_ui) }
-    let(:test_ui) { Cork::Board.new(silent: true) }
-
-    it "creates the manifest file" do
-      generator.generate(test_book_metadata)
-
-      expect(File.exist?("Manifest.plist")).to be_truthy
-    end
-
-    describe "the manifest file" do
-      before do
-        generator.generate(test_book_metadata)
-      end
-
-      it "has a book name" do
-        expect(get_manifest["Name"]).to eq("Testing Book")
-      end
-
-      it "has an identifier" do
-        expect(get_manifest["ContentIdentifier"]).to eq("com.ashfurrow.testing")
-      end
-
-      it "has a deployment target" do
-        expect(get_manifest["DeploymentTarget"]).to eq("ios10.0")
-      end
-
-      it "has chapters specified" do
-        expect(get_manifest["Chapters"]).to eq(["test_chapter.playgroundchapter"])
-      end
-
-      it "has a ImageReference" do
-        expect(get_manifest["ImageReference"]).to eq("file.jpeg")
-      end
-    end
-  end
-end

data/spec/renderer/glossary_generator_spec.rb

@@ -1,54 +0,0 @@
-require File.expand_path("../../spec_helper", __FILE__)
-
-module Playgroundbook
-  describe GlossaryGenerator do
-    include FakeFS::SpecHelpers
-    let(:glossary_generator) { GlossaryGenerator.new }
-    let(:glossary) do
-      {
-      "example term" => "example definition"
-    }
-    end
-    let(:glossary_file_name) { "Contents/Resources/Glossary.plist" }
-
-    before do
-      FileUtils.mkdir_p("Contents/Resources")
-    end
-
-    it "generates a glossary plist" do
-      glossary_generator.generate({}, [], glossary)
-
-      expect(File.exist?(glossary_file_name)).to be_truthy
-    end
-
-    context "glossary plist" do
-      let(:glossary_plist) { Plist.parse_xml(glossary_file_name) }
-
-      it "has a glossary with correct terms" do
-        glossary_generator.generate({}, [], glossary)
-
-        expect(glossary_plist["Terms"]["example term"]["Definition"]).to eq("example definition")
-      end
-
-      it "generates correct first use page references" do
-        glossary_generator.generate([
-                                      {
-                                        page_names: ["Page 1"],
-                                        page_contents: ["/*: Here's how to use [a thing](glossary://example%20term) */"]
-                                      },
-                                      {
-                                        page_names: ["Should not see this"],
-                                        page_contents: ["/*: Here's how to use [a thing](glossary://example%20term) even though this shouldn't match' */"]
-                                      }
-                                    ],
-                                    ["Chapter 1", "Chapter 2"],
-                                    glossary)
-
-        expect(glossary_plist["Terms"]["example term"]["FirstUse"]).to eq({
-          "PageReference" => "Chapter%201/Page%201",
-          "Title" => "Page 1"
-        })
-      end
-    end
-  end
-end