playgroundbook 0.3.0 → 0.4.0

data/spec/renderer/contents_manfiest_generator_spec.rb

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

@@ -0,0 +1,54 @@
+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/{playgroundbook_renderer_spec → renderer}/page_processor_spec.rb

@@ -1,10 +1,10 @@
-require File.expand_path('../../spec_helper', __FILE__)
+require File.expand_path("../../spec_helper", __FILE__)
 
 module Playgroundbook
   describe PageProcessor do
     let(:page_processor) { PageProcessor.new }
-    
-    it 'removes newlines before markdown blocks' do
+
+    it "removes newlines before markdown blocks" do
       page_contents = <<-EOS
 let a = 6
 
@@ -18,11 +18,11 @@ 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
+    it "removes newlines after markdown blocks" do
       page_contents = <<-EOS
 /*:
  Some markdown.
@@ -36,11 +36,11 @@ let a = 6
 */
 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
+    it "removes newlines surrounding single-line markdown blocks" do
       page_contents = <<-EOS
 let a = 6
 
@@ -53,11 +53,11 @@ 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
+    it "does not strip newlines from code" do
       page_contents = <<-EOS
 let a = 6
 
@@ -67,19 +67,19 @@ let b = a
       expect(page_processor.strip_extraneous_newlines(page_contents)).to eq(page_contents)
     end
 
-    it 'it does not strip newlines from the markdown' do
+    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

data/spec/{playgroundbook_renderer_spec → renderer}/page_writer_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path('../../spec_helper', __FILE__)
+require File.expand_path("../../spec_helper", __FILE__)
 
 module Playgroundbook
   describe PageWriter do
@@ -6,8 +6,8 @@ module Playgroundbook
     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_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." }
 
@@ -18,51 +18,51 @@ module Playgroundbook
       end
     end
 
-    context 'with a pre-existing page directory' do
+    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
+      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
+    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)
+      page_writer.write_page(page_name, page_dir_name, ["UIKit"], page_contents)
     end
 
-    context 'as a consequence of writing rendering' do
+    context "as a consequence of writing rendering" do
       before do
-        page_writer.write_page!(page_name, page_dir_name, ['UIKit'],  page_contents)
+        page_writer.write_page(page_name, page_dir_name, ["UIKit"], page_contents)
       end
 
-      it 'creates a directory' do
+      it "creates a directory" do
         expect(Dir.exist?(page_dir_name)).to be_truthy
       end
 
-      it 'writes a manifest' do
+      it "writes a manifest" do
         expect(Dir.exist?(page_dir_name)).to be_truthy
       end
 
-      it 'writes a Contents.swift file' do
+      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
+      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
+      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)
+        it "has a name" do
+          expect(manifest["Name"]).to eq(page_name)
         end
 
-        it 'has a LiveViewMode' do
-          expect(manifest['LiveViewMode']).to eq('HiddenByDefault')
+        it "has a LiveViewMode" do
+          expect(manifest["LiveViewMode"]).to eq("HiddenByDefault")
         end
       end
     end

data/spec/renderer/playgroundbook_renderer_spec.rb

@@ -0,0 +1,122 @@
+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,32 +1,32 @@
-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 'playgroundbook_lint/abstract_linter'
-require 'playgroundbook_lint/chapter_linter'
-require 'playgroundbook_lint/chapter_manifest_linter'
-require 'playgroundbook_lint/contents_linter'
-require 'playgroundbook_lint/manifest_linter'
-require 'playgroundbook_lint/page_linter'
-require 'playgroundbook_lint/page_manifest_linter'
-require 'playgroundbook_lint/cutscene_page_linter'
-require 'playgroundbook_lint/cutscene_page_manifest_linter'
-require 'playgroundbook_lint/root_manifest_linter'
-
-require 'playgroundbook_renderer/contents_manifest_generator'
-require 'playgroundbook_renderer/chapter_collator'
-require 'playgroundbook_renderer/page_writer'
-require 'playgroundbook_renderer/page_parser'
-require 'playgroundbook_renderer/glossary_generator'
-require 'playgroundbook_renderer/page_processor'
+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
@@ -39,19 +39,19 @@ RSpec::Expectations.configuration.on_potential_false_positives = :nothing
 Playgroundbook::AbstractLinter.ui = Cork::Board.new(silent: true)
 
 def test_playground_book
-  'spec/fixtures/Starter.playgroundbook'
+  "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' => [
+    "name" => "Testing Book",
+    "chapters" => ["test_chapter"],
+    "identifier" => "com.ashfurrow.testing",
+    "resources" => "assets",
+    "cover" => "file.jpeg",
+    "glossary" => [
       {
-        'term' => 'definition'
+        "term" => "definition"
       }
     ]
   }
@@ -62,7 +62,7 @@ def get_manifest(file_name = Playgroundbook::ManifestFileName)
 end
 
 def test_chapter_contents
-<<-EOSwift
+  <<-EOSwift
 import UIKit
 
 var str = "Hello, playground"