playgroundbook 0.2.0

data/spec/playground_book_lint/playgroundbook_lint_spec.rb

@@ -0,0 +1,38 @@
+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/playground_book_lint/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/playgroundbook_renderer_spec/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(:chapter_contents) { 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, chapter_contents, [])
+
+      expect(File.exist?("#{chapter_name}.playgroundchapter/#{ManifestFileName}")).to be_truthy
+    end
+
+    context 'the chapter manifest' do
+      before do
+        collator.collate!(chapter_name, chapter_contents, ['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, chapter_contents, [])
+    end
+
+    it 'does not explode if a Source directory already exists' do
+      expect{ collator.collate!(chapter_name, chapter_contents, []) }.to_not raise_error
+    end
+    
+    context 'having colated' do
+      before do
+        collator.collate!(chapter_name, chapter_contents, [])
+      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/playgroundbook_renderer_spec/contents_manfiest_generator_spec.rb

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

data/spec/playgroundbook_renderer_spec/page_writer_spec.rb

@@ -0,0 +1,57 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+module Playgroundbook
+  describe PageWriter do
+    include FakeFS::SpecHelpers
+    let(:page_writer) { PageWriter.new(test_ui) }
+    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." }
+
+    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
+
+    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/playgroundbook_renderer_spec/playgroundbook_renderer_spec.rb

@@ -0,0 +1,112 @@
+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, chapter_collator, test_ui) }
+    let(:yaml_file_name) { 'book.yml' }
+    let(:contents_manifest_generator) { double(ContentsManifestGenerator) }
+    let(:chapter_collator) { double(ChapterCollator) }
+    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!)
+    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
+        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
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,75 @@
+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'
+
+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',
+  }
+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

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: playgroundbook
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Ash Furrow
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: plist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: colored
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: cork
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+description: Tooks for Swift Playground books on iOS, a renderer and a linter.
+email: ash@ashfurrow.com
+executables:
+- playgroundbook
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- Changelog.md
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/playgroundbook
+- lib/playgroundbook.rb
+- lib/playgroundbook_lint/abstract_linter.rb
+- lib/playgroundbook_lint/chapter_linter.rb
+- lib/playgroundbook_lint/chapter_manifest_linter.rb
+- lib/playgroundbook_lint/contents_linter.rb
+- lib/playgroundbook_lint/cutscene_page_linter.rb
+- lib/playgroundbook_lint/cutscene_page_manifest_linter.rb
+- lib/playgroundbook_lint/manifest_linter.rb
+- lib/playgroundbook_lint/page_linter.rb
+- lib/playgroundbook_lint/page_manifest_linter.rb
+- lib/playgroundbook_lint/playgroundbook_lint.rb
+- lib/playgroundbook_lint/root_manifest_linter.rb
+- lib/playgroundbook_renderer/chapter_collator.rb
+- lib/playgroundbook_renderer/contents_manifest_generator.rb
+- lib/playgroundbook_renderer/page_writer.rb
+- lib/playgroundbook_renderer/playgroundbook_renderer.rb
+- lib/version.rb
+- playground_book_lint.gemspec
+- spec/fixtures/Starter.playgroundbook/Contents/Chapters/Chapter1.playgroundchapter/Manifest.plist
+- spec/fixtures/Starter.playgroundbook/Contents/Chapters/Chapter1.playgroundchapter/Pages/Page1.playgroundpage/Contents.swift
+- spec/fixtures/Starter.playgroundbook/Contents/Chapters/Chapter1.playgroundchapter/Pages/Page1.playgroundpage/Manifest.plist
+- spec/fixtures/Starter.playgroundbook/Contents/Chapters/Chapter1.playgroundchapter/Pages/Page2.playgroundpage/Contents.swift
+- spec/fixtures/Starter.playgroundbook/Contents/Chapters/Chapter1.playgroundchapter/Pages/Page2.playgroundpage/Manifest.plist
+- spec/fixtures/Starter.playgroundbook/Contents/Manifest.plist
+- spec/fixtures/assets/file.jpeg
+- spec/fixtures/book.yml
+- spec/fixtures/test_chapter.playground/Contents.swift
+- spec/fixtures/test_chapter.playground/contents.xcplayground
+- spec/playground_book_lint/chapter_linter_spec.rb
+- spec/playground_book_lint/chapter_manifest_linter_spec.rb
+- spec/playground_book_lint/contents_linter_spec.rb
+- spec/playground_book_lint/cutscene_page_linter_spec.rb
+- spec/playground_book_lint/cutscene_page_manifest_linter_spec.rb
+- spec/playground_book_lint/manfiest_linter_spec.rb
+- spec/playground_book_lint/page_linter_spec.rb
+- spec/playground_book_lint/page_manifest_linter_spec.rb
+- spec/playground_book_lint/playgroundbook_lint_spec.rb
+- spec/playground_book_lint/root_manifest_linter_spec.rb
+- spec/playgroundbook_renderer_spec/chapter_collator_spec.rb
+- spec/playgroundbook_renderer_spec/contents_manfiest_generator_spec.rb
+- spec/playgroundbook_renderer_spec/page_writer_spec.rb
+- spec/playgroundbook_renderer_spec/playgroundbook_renderer_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/ashfurrow/playground-book-lint
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Lints/renders Swift Playground books.
+test_files: []