playgroundbook 0.2.0

data/lib/version.rb

@@ -0,0 +1,3 @@
+module Playgroundbook
+  VERSION = '0.2.0'.freeze
+end

data/playground_book_lint.gemspec

@@ -0,0 +1,21 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'version'
+
+Gem::Specification.new do |s|
+  s.name        = 'playgroundbook'
+  s.version     = Playgroundbook::VERSION
+  s.licenses    = ['MIT']
+  s.summary     = 'Lints/renders Swift Playground books.'
+  s.description	= 'Tooks for Swift Playground books on iOS, a renderer and a linter.'
+  s.authors     = ['Ash Furrow']
+  s.homepage	= 'https://github.com/ashfurrow/playground-book-lint'
+  s.email       = 'ash@ashfurrow.com'
+  s.files       = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  s.require_paths = ['lib']
+  s.executables = ['playgroundbook']
+  s.add_runtime_dependency 'plist', '~> 3.2'
+  s.add_runtime_dependency 'colored', '~> 1.2'
+  s.add_runtime_dependency 'cork', '~> 0.1'
+end

data/spec/fixtures/Starter.playgroundbook/Contents/Chapters/Chapter1.playgroundchapter/Manifest.plist

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>Version</key>
+	<string>1.0</string>
+	<key>Name</key>
+	<string>Sample Chapter</string>
+	<key>Pages</key>
+	<array>
+		<string>Page1.playgroundpage</string>
+		<string>Page2.playgroundpage</string>
+	</array>
+</dict>
+</plist>

data/spec/fixtures/Starter.playgroundbook/Contents/Chapters/Chapter1.playgroundchapter/Pages/Page1.playgroundpage/Contents.swift

@@ -0,0 +1,8 @@
+/*
+ Copyright (C) 2016 Apple Inc. All Rights Reserved.
+ See LICENSE.txt for this sample’s licensing information.
+ 
+ This is an example playground page.
+*/
+
+print("Hello World")

data/spec/fixtures/Starter.playgroundbook/Contents/Chapters/Chapter1.playgroundchapter/Pages/Page1.playgroundpage/Manifest.plist

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>Version</key>
+	<string>1.0</string>
+	<key>Name</key>
+	<string>Example Page</string>
+	<key>LiveViewMode</key>
+	<string>HiddenByDefault</string>
+</dict>
+</plist>

data/spec/fixtures/Starter.playgroundbook/Contents/Chapters/Chapter1.playgroundchapter/Pages/Page2.playgroundpage/Contents.swift

@@ -0,0 +1,8 @@
+/*
+ Copyright (C) 2016 Apple Inc. All Rights Reserved.
+ See LICENSE.txt for this sample’s licensing information.
+ 
+ This is a second example page.
+*/
+
+print("Hello World")

data/spec/fixtures/Starter.playgroundbook/Contents/Chapters/Chapter1.playgroundchapter/Pages/Page2.playgroundpage/Manifest.plist

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>Version</key>
+	<string>1.0</string>
+	<key>Name</key>
+	<string>Second Example Page</string>
+	<key>LiveViewMode</key>
+	<string>HiddenByDefault</string>
+</dict>
+</plist>

data/spec/fixtures/Starter.playgroundbook/Contents/Manifest.plist

@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>Version</key>
+	<string>1.0</string>
+	<key>ContentVersion</key>
+	<string>1.0</string>
+	<key>Name</key>
+	<string>Starter</string>
+	<key>ContentIdentifier</key>
+	<string>com.example.apple-samplecode.Starter</string>
+	<key>DeploymentTarget</key>
+	<string>ios10.0</string>
+	<key>Chapters</key>
+	<array>
+		<string>Chapter1.playgroundchapter</string>
+	</array>
+</dict>
+</plist>

data/spec/fixtures/book.yml

@@ -0,0 +1,5 @@
+name: Testing book
+identifier: com.ashfurrow.example
+resources: assets
+chapters:
+  - test_chapter

data/spec/fixtures/test_chapter.playground/Contents.swift

@@ -0,0 +1,17 @@
+import UIKit
+
+public var str = "Hello, playground"
+
+public func sharedFunc() {
+  print("This should be accessible to all pages.")
+}
+
+//// Page 1
+
+str = "Yo, it's page 1."
+sharedFunc()
+
+//// Page 2
+
+sharedFunc()
+str = "Page 2 awww yeah."

data/spec/fixtures/test_chapter.playground/contents.xcplayground

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<playground version='5.0' target-platform='ios'>
+    <timeline fileName='timeline.xctimeline'/>
+</playground>

data/spec/playground_book_lint/chapter_linter_spec.rb

@@ -0,0 +1,30 @@
+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' }
+
+    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
+      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
+      FakeFS do
+        expect(chapter_manifest_linter).to receive(:lint)
+        FileUtils.mkdir_p("#{chapter_directory_name}/Pages")
+
+        expect { chapter_linter.lint(chapter_directory_name) }.to_not raise_error
+      end
+    end
+  end
+end

data/spec/playground_book_lint/chapter_manifest_linter_spec.rb

@@ -0,0 +1,40 @@
+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' }
+
+    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) }
+
+        expect { chapter_manifest_linter.lint }.to raise_error(SystemExit)
+      end
+    end
+
+    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')
+
+        expect { chapter_manifest_linter.lint }.to raise_error(SystemExit)
+      end
+    end
+
+    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) }
+        FileUtils.mkdir_p("Pages/#{page_directory_name}")
+
+        expect { chapter_manifest_linter.lint }.to_not raise_error
+      end
+    end
+  end
+end

data/spec/playground_book_lint/contents_linter_spec.rb

@@ -0,0 +1,18 @@
+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/playground_book_lint/cutscene_page_linter_spec.rb

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

@@ -0,0 +1,19 @@
+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/playground_book_lint/page_manifest_linter_spec.rb

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