playgroundbook 0.4.0 → 0.5.0

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

data/spec/renderer/page_processor_spec.rb

@@ -1,86 +0,0 @@
-require File.expand_path("../../spec_helper", __FILE__)
-
-module Playgroundbook
-  describe PageProcessor do
-    let(:page_processor) { PageProcessor.new }
-
-    it "removes newlines before markdown blocks" do
-      page_contents = <<-EOS
-let a = 6
-
-/*:
- Some markdown.
-*/
-      EOS
-      processed_page_contents = <<-EOS
-let a = 6
-/*:
- Some markdown.
-*/
-      EOS
-
-      expect(page_processor.strip_extraneous_newlines(page_contents)).to eq(processed_page_contents)
-    end
-
-    it "removes newlines after markdown blocks" do
-      page_contents = <<-EOS
-/*:
- Some markdown.
-*/
-
-let a = 6
-      EOS
-      processed_page_contents = <<-EOS
-/*:
- Some markdown.
-*/
-let a = 6
-      EOS
-
-      expect(page_processor.strip_extraneous_newlines(page_contents)).to eq(processed_page_contents)
-    end
-
-    it "removes newlines surrounding single-line markdown blocks" do
-      page_contents = <<-EOS
-let a = 6
-
-//: Some markdown.
-
-let b = a
-      EOS
-      processed_page_contents = <<-EOS
-let a = 6
-//: Some markdown.
-let b = a
-      EOS
-
-      expect(page_processor.strip_extraneous_newlines(page_contents)).to eq(processed_page_contents)
-    end
-
-    it "does not strip newlines from code" do
-      page_contents = <<-EOS
-let a = 6
-
-let b = a
-      EOS
-
-      expect(page_processor.strip_extraneous_newlines(page_contents)).to eq(page_contents)
-    end
-
-    it "it does not strip newlines from the markdown" do
-      page_contents = <<-EOS
-/*:
-
- # Header
-
- Some markdown. The following lines are purposefull left blank.
-
-
-
-*/
-      EOS
-
-      expect(page_processor.strip_extraneous_newlines(page_contents)).to eq(page_contents)
-    end
-  end
-end

data/spec/renderer/page_writer_spec.rb

@@ -1,70 +0,0 @@
-require File.expand_path("../../spec_helper", __FILE__)
-
-module Playgroundbook
-  describe PageWriter do
-    include FakeFS::SpecHelpers
-    let(:page_writer) { PageWriter.new(page_processor, test_ui) }
-    let(:page_processor) { double(PageProcessor) }
-    let(:test_ui) { Cork::Board.new(silent: true) }
-    let(:page_name) { "test page name" }
-    let(:page_dir_name) { "test page name.playgroundpage" }
-    let(:page_contents) { "// Some swift goes here." }
-    let(:generated_page_contesnts) { "//#-hidden-code\nimport UIKit\n//#-end-hidden-code\n// Some swift goes here." }
-
-    before do
-      allow(page_processor).to receive(:strip_extraneous_newlines) do |page_contents|
-        # Returns the parameter, unprocessed.
-        page_contents
-      end
-    end
-
-    context "with a pre-existing page directory" do
-      before do
-        Dir.mkdir(page_dir_name)
-      end
-
-      it "does not explode" do
-        expect { page_writer.write_page(page_name, page_dir_name, ["UIKit"], page_contents) }.to_not raise_error
-      end
-    end
-
-    it "calls the page processor" do
-      expect(page_processor).to receive(:strip_extraneous_newlines)
-      page_writer.write_page(page_name, page_dir_name, ["UIKit"], page_contents)
-    end
-
-    context "as a consequence of writing rendering" do
-      before do
-        page_writer.write_page(page_name, page_dir_name, ["UIKit"], page_contents)
-      end
-
-      it "creates a directory" do
-        expect(Dir.exist?(page_dir_name)).to be_truthy
-      end
-
-      it "writes a manifest" do
-        expect(Dir.exist?(page_dir_name)).to be_truthy
-      end
-
-      it "writes a Contents.swift file" do
-        expect(File.exist?("#{page_dir_name}/Contents.swift")).to be_truthy
-      end
-
-      it "has correct Contents.swift contents" do
-        expect(File.read("#{page_dir_name}/Contents.swift")).to eq(generated_page_contesnts)
-      end
-
-      context "the manifest" do
-        let(:manifest) { get_manifest("#{page_dir_name}/#{MANIFEST_FILE_NAME}") }
-
-        it "has a name" do
-          expect(manifest["Name"]).to eq(page_name)
-        end
-
-        it "has a LiveViewMode" do
-          expect(manifest["LiveViewMode"]).to eq("HiddenByDefault")
-        end
-      end
-    end
-  end
-end

data/spec/renderer/playgroundbook_renderer_spec.rb

@@ -1,122 +0,0 @@
-require File.expand_path("../../spec_helper", __FILE__)
-
-module Playgroundbook
-  describe Renderer do
-    include FakeFS::SpecHelpers
-    let(:renderer) { Renderer.new(yaml_file_name, contents_manifest_generator, page_parser, chapter_collator, glossary_generator, test_ui) }
-    let(:yaml_file_name) { "book.yml" }
-    let(:contents_manifest_generator) { double(ContentsManifestGenerator) }
-    let(:page_parser) { double(PageParser) }
-    let(:chapter_collator) { double(ChapterCollator) }
-    let(:glossary_generator) { double(GlossaryGenerator) }
-    let(:test_ui) { Cork::Board.new(silent: true) }
-
-    before do
-      File.open(yaml_file_name, "w") do |file|
-        file.write(test_book_metadata.to_yaml)
-      end
-
-      allow(contents_manifest_generator).to receive(:generate)
-      allow(chapter_collator).to receive(:collate)
-      allow(glossary_generator).to receive(:generate)
-    end
-
-    it "initializes correctly" do
-      expect(renderer.yaml_file_name) == yaml_file_name
-    end
-
-    it "explodes when there is no playground" do
-      expect { renderer.render }.to raise_error
-    end
-
-    context "with a playground" do
-      before do
-        allow(page_parser).to receive(:parse_chapter_pages)
-        Dir.mkdir("assets")
-        FileUtils.touch("assets/file.png")
-        Dir.mkdir("test_chapter.playground/")
-        File.open("test_chapter.playground/Contents.swift", "w") do |file|
-          file.write("")
-        end
-      end
-
-      it "creates a directory with book name" do
-        renderer.render
-
-        expect(Dir.exist?("Testing Book.playgroundbook")).to be_truthy
-      end
-
-      it "creates a resources folder" do
-        renderer.render
-
-        expect(Dir.exist?("Testing Book.playgroundbook/Contents/Resources")).to be_truthy
-      end
-
-      it "copies a resources folder contents" do
-        renderer.render
-
-        expect(File.exist?("Testing Book.playgroundbook/Contents/Resources/file.png")).to be_truthy
-      end
-
-      context "within an existing playgroundbook directory" do
-        before do
-          Dir.mkdir("Testing Book.playgroundbook")
-        end
-
-        it "does not explode when the directory already exists" do
-          expect { renderer.render }.to_not raise_error
-        end
-
-        it "creates a Contents directory within the main bundle dir" do
-          renderer.render
-
-          expect(Dir.exist?("Testing Book.playgroundbook/Contents")).to be_truthy
-        end
-
-        context "within the Contents directory" do
-          before do
-            Dir.mkdir("Testing Book.playgroundbook/Contents")
-          end
-
-          it "does not explode when the Contents directory already exists" do
-            expect { renderer.render }.to_not raise_error
-          end
-
-          it "renders main manifest" do
-            expect(contents_manifest_generator).to receive(:generate)
-
-            renderer.render
-          end
-
-          it "creates a Chapters directory within the Contents dir" do
-            renderer.render
-
-            expect(Dir.exist?("Testing Book.playgroundbook/Contents/Chapters")).to be_truthy
-          end
-
-          context "within the Chapters directory" do
-            before do
-              Dir.mkdir("Testing Book.playgroundbook/Contents/Chapters")
-            end
-
-            it "does not explode when the Chapters directory already exists" do
-              expect { renderer.render }.to_not raise_error
-            end
-
-            it "generates each chapter" do
-              expect(chapter_collator).to receive(:collate)
-
-              renderer.render
-            end
-          end
-        end
-      end
-
-      it "generates a glossary" do
-        expect(glossary_generator).to receive(:generate)
-
-        renderer.render
-      end
-    end
-  end
-end

data/spec/spec_helper.rb

@@ -1,84 +0,0 @@
-require "pathname"
-require "cork"
-require "rspec"
-require "plist"
-require "fileutils"
-require "fakefs/spec_helpers"
-
-ROOT = Pathname.new(File.expand_path("../../", __FILE__))
-$LOAD_PATH.unshift((ROOT + "lib").to_s)
-$LOAD_PATH.unshift((ROOT + "spec").to_s)
-
-require "playgroundbook"
-require "linter/abstract_linter"
-require "linter/chapter_linter"
-require "linter/chapter_manifest_linter"
-require "linter/contents_linter"
-require "linter/manifest_linter"
-require "linter/page_linter"
-require "linter/page_manifest_linter"
-require "linter/cutscene_page_linter"
-require "linter/cutscene_page_manifest_linter"
-require "linter/root_manifest_linter"
-
-require "renderer/contents_manifest_generator"
-require "renderer/chapter_collator"
-require "renderer/page_writer"
-require "renderer/page_parser"
-require "renderer/glossary_generator"
-require "renderer/page_processor"
-
-RSpec.configure do |config|
-  config.color = true
-
-  config.order = :random
-  Kernel.srand config.seed
-end
-RSpec::Expectations.configuration.on_potential_false_positives = :nothing
-
-Playgroundbook::AbstractLinter.ui = Cork::Board.new(silent: true)
-
-def test_playground_book
-  "spec/fixtures/Starter.playgroundbook"
-end
-
-def test_book_metadata
-  {
-    "name" => "Testing Book",
-    "chapters" => ["test_chapter"],
-    "identifier" => "com.ashfurrow.testing",
-    "resources" => "assets",
-    "cover" => "file.jpeg",
-    "glossary" => [
-      {
-        "term" => "definition"
-      }
-    ]
-  }
-end
-
-def get_manifest(file_name = Playgroundbook::ManifestFileName)
-  Plist.parse_xml(file_name)
-end
-
-def test_chapter_contents
-  <<-EOSwift
-import UIKit
-
-var str = "Hello, playground"
-
-func sharedFunc() {
-  print("This should be accessible to all pages.")
-}
-
-//// Page 1
-
-str = "Yo, it's page 1."
-sharedFunc()
-
-//// Page 2
-
-str = "Page 2 awww yeah."
-sharedFunc()
-EOSwift
-end

data/spec/wrapper/markdown_wrapper_spec.rb

@@ -1,33 +0,0 @@
-require File.expand_path("../../spec_helper", __FILE__)
-
-module Playgroundbook
-  describe MarkdownWrapper do
-    let(:test_ui) { Cork::Board.new(silent: true) }
-
-    it "creates a swift file from a markdown file" do
-      source = "spec/fixtures/wrapper/source/swift_at_artsy_1.md"
-      destination = "spec/fixtures/wrapper/destination/swift_at_artsy_1.swift"
-      subject = MarkdownWrapper.new(source, "Swift at Artsy")
-      contents = File.read(source)
-      expect(subject.swap_code_context(contents)).to eq(File.read(destination))
-    end
-
-    it "creates a playground around the file" do
-      source = "spec/fixtures/wrapper/source/swift_at_artsy_1.md"
-
-      Dir.mktmpdir do |dir|
-        new_source = File.join(dir, File.basename(source))
-        FileUtils.cp(source, new_source)
-        subject = MarkdownWrapper.new(new_source, "Swift at Artsy")
-
-        subject.generate
-
-        playground = File.join(dir, "Swift at Artsy.playground")
-        expect(Dir.exist?(playground)).to eq(true)
-        expect(File.exist?(File.join(playground, "Contents.swift"))).to eq(true)
-        expect(File.exist?(File.join(playground, "timeline.xctimeline"))).to eq(true)
-        expect(File.exist?(File.join(playground, "contents.xcplayground"))).to eq(true)
-      end
-    end
-  end
-end