playground-book-lint 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4a9cd7db59000a89e781c372d8dd903060039fb5
+  data.tar.gz: 89947202a1f3f8de3c3ba5475fd0ff775c800e10
+SHA512:
+  metadata.gz: 532f5f3df487894832c008adfa88c1a35aa50dea33e82a1f368204d0fcfaa3cfdb5c3331c0c36911630714b916c67ab90fd7acab199377ffca91fc59c5bae1ab
+  data.tar.gz: 267257810a36d42b4dcc4225dd26c9888718a96cecc287ba5d468e449a72b4f5dc831971c34b4c3e0a20f964154a60db20cf916be78db3b359087a4404d844a7

data/.gitignore

@@ -0,0 +1,50 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.0.0-p247

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gem 'guard-rspec'
+gem 'mocha'
+gem 'bacon'
+gem 'mocha-on-bacon'
+gem 'prettybacon'
+gem 'fakefs'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,92 @@
+PATH
+  remote: .
+  specs:
+    playground-book-lint (0.0.1)
+      colored (~> 1.2)
+      cork (~> 0.1)
+      plist (~> 3.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    bacon (1.2.0)
+    coderay (1.1.1)
+    colored (1.2)
+    cork (0.1.0)
+      colored (~> 1.2)
+    diff-lcs (1.2.5)
+    fakefs (0.9.0)
+    ffi (1.9.10)
+    formatador (0.2.5)
+    guard (2.14.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (~> 1.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.2)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    listen (3.0.7)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9.7)
+    lumberjack (1.0.10)
+    metaclass (0.0.4)
+    method_source (0.8.2)
+    mocha (1.1.0)
+      metaclass (~> 0.0.1)
+    mocha-on-bacon (0.2.2)
+      mocha (>= 0.13.0)
+    nenv (0.3.0)
+    notiffany (0.1.0)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    plist (3.2.0)
+    prettybacon (0.0.2)
+      bacon (~> 1.2)
+    pry (0.10.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rb-fsevent (0.9.7)
+    rb-inotify (0.9.7)
+      ffi (>= 0.5.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.1)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    shellany (0.0.1)
+    slop (3.6.0)
+    thor (0.19.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bacon
+  fakefs
+  guard-rspec
+  mocha
+  mocha-on-bacon
+  playground-book-lint!
+  prettybacon
+
+RUBY VERSION
+   ruby 2.0.0p247
+
+BUNDLED WITH
+   1.12.5

data/Guardfile

@@ -0,0 +1,14 @@
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Ash Furrow
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,4 @@
+[![CircleCI](https://circleci.com/gh/ashfurrow/playground-book-lint.svg?style=svg)](https://circleci.com/gh/ashfurrow/playground-book-lint)
+
+# playground-book-lint
+Linter for Swift Playground books

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/playground_book_lint

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+playground_file_name = ARGV.first
+
+unless playground_file_name
+  puts "You must specify a playground file name."
+  exit 1
+end
+
+require 'playground_book_lint'
+
+linter = PlaygroundBookLint::Linter.new(playground_file_name)
+linter.lint()

data/lib/playground_book_lint.rb

@@ -0,0 +1,30 @@
+require 'colored'
+require 'playground_book_lint/abstract_linter'
+require 'playground_book_lint/contents_linter'
+require 'pathname'
+
+module PlaygroundBookLint
+  class Linter < AbstractLinter
+    attr_accessor :playground_file_name
+    attr_accessor :contents_linter
+
+    def initialize(playground_file_name, contents_linter = ContentsLinter.new())
+      @playground_file_name = playground_file_name
+      @contents_linter = contents_linter
+    end
+
+    def lint
+      message "Validating #{playground_file_name.yellow}..."
+      
+      fail_lint 'No Contents directory' unless contents_dir_exists?
+
+      Dir.chdir playground_file_name do
+        contents_linter.lint()
+      end
+    end
+
+    def contents_dir_exists?
+      return Dir.exists?(playground_file_name + '/Contents')
+    end
+  end
+end

data/lib/playground_book_lint/abstract_linter.rb

@@ -0,0 +1,21 @@
+require 'colored'
+require 'cork'
+
+module PlaygroundBookLint
+  class AbstractLinter
+    @@ui = Cork::Board.new()
+
+   def self.ui=(value)
+     @@ui = value
+   end
+
+    def fail_lint(msg)
+      @@ui.puts msg.red
+      exit 1
+    end
+
+    def message(msg)
+      @@ui.puts msg
+    end
+  end
+end

data/lib/playground_book_lint/chapter_linter.rb

@@ -0,0 +1,33 @@
+require 'plist'
+require 'playground_book_lint/abstract_linter'
+require 'playground_book_lint/chapter_manifest_linter'
+
+module PlaygroundBookLint
+  PAGES_DIRECTORY_NAME = 'Pages'
+  
+  class ChapterLinter < AbstractLinter
+    attr_accessor :chapter_manifest_linter
+
+    def initialize(chapter_manifest_linter = ChapterManifestLinter.new())
+      @chapter_manifest_linter = chapter_manifest_linter
+    end
+
+    def lint(chapter_directory_name)
+      fail_lint "Chapter specified in manifest does not exist: #{chapter_directory_name}." unless chapter_directory_exists?(chapter_directory_name)
+      
+      Dir.chdir chapter_directory_name do
+        fail_lint "Pages directory in chapter does not exist: #{chapter_directory_name}." unless pages_directory_exists?
+
+        chapter_manifest_linter.lint()
+      end
+    end
+
+    def chapter_directory_exists?(chapter_directory_name)
+      return Dir.exist? chapter_directory_name
+    end
+
+    def pages_directory_exists?
+      return Dir.exist? PAGES_DIRECTORY_NAME
+    end
+  end
+end

data/lib/playground_book_lint/chapter_manifest_linter.rb

@@ -0,0 +1,33 @@
+require 'playground_book_lint/manifest_linter'
+require 'playground_book_lint/page_linter'
+
+module PlaygroundBookLint
+  class ChapterManifestLinter < ManifestLinter
+    attr_accessor :page_linter
+
+    def initialize(page_linter = PageLinter.new())
+      @page_linter = page_linter
+    end
+
+    def lint
+      super()
+
+      fail_lint "Chapter has no pages in #{Dir.pwd}" unless chapter_has_manifest_pages?
+
+      manifest_plist_contents['Pages'].each do |page_directory_name|
+        # All pages exist inside the /Pages subdirectory, we need to chdir to there first.
+        Dir.chdir PAGES_DIRECTORY_NAME do
+          fail_lint "Chapter page directory #{page_directory_name} missing in #{Dir.pwd}" unless Dir.exist?(page_directory_name)
+          
+          Dir.chdir page_directory_name do
+            page_linter.lint()
+          end
+        end
+      end
+    end
+
+    def chapter_has_manifest_pages?
+      value_defined_in_manifest?('Pages')
+    end
+  end
+end

data/lib/playground_book_lint/contents_linter.rb

@@ -0,0 +1,19 @@
+require 'playground_book_lint/abstract_linter'
+require 'playground_book_lint/root_manifest_linter'
+
+module PlaygroundBookLint
+  class ContentsLinter < AbstractLinter
+    attr_accessor :root_manfiest_linter
+
+    def initialize(root_manfiest_linter = RootManifestLinter.new())
+      @root_manfiest_linter = root_manfiest_linter
+    end
+
+    def lint
+      Dir.chdir 'Contents' do
+        root_manfiest_linter.lint()
+        # TODO: Other linting?
+      end
+    end
+  end
+end

data/lib/playground_book_lint/manifest_linter.rb

@@ -0,0 +1,38 @@
+require 'plist'
+require 'playground_book_lint/abstract_linter'
+
+module PlaygroundBookLint
+  MANIFEST_FILE_NAME = 'Manifest.plist'
+
+  class ManifestLinter < AbstractLinter
+
+    #TODO: Should load manifest file in initialize instead of lazily.
+
+    def lint
+      fail_lint "No Manifest file in #{Dir.pwd}" unless manifest_file_exists?
+      fail_lint "Manifest file missing Name in #{Dir.pwd}" unless has_name?
+    end
+
+    def manifest_file_exists?
+      return File.exists? MANIFEST_FILE_NAME
+    end
+
+    def manifest_plist_contents
+      return @manifest_plist_contents unless @manifest_plist_contents.nil?
+      require 'plist'
+      @manifest_plist_contents = Plist::parse_xml(MANIFEST_FILE_NAME)
+      return @manifest_plist_contents
+    end
+
+    def has_name?
+      value_defined_in_manifest?('Name')
+    end
+
+    def value_defined_in_manifest?(key)
+      return false if manifest_plist_contents.nil?
+      return false if manifest_plist_contents[key].nil?
+      return false if manifest_plist_contents[key].empty?
+      return true
+    end
+  end
+end

data/lib/playground_book_lint/page_linter.rb

@@ -0,0 +1,24 @@
+require 'playground_book_lint/abstract_linter'
+require 'playground_book_lint/page_manifest_linter'
+
+module PlaygroundBookLint
+  CONTENTS_SWIFT_FILE_NAME = 'Contents.swift'
+
+  class PageLinter < AbstractLinter
+    attr_accessor :page_manifest_linter
+
+    def initialize(page_manifest_linter = PageManifestLinter.new())
+      @page_manifest_linter = page_manifest_linter
+    end
+
+    def lint
+      fail_lint "Missing #{CONTENTS_SWIFT_FILE_NAME} in #{Dir.pwd}" unless contents_swift_file_exists?
+
+      page_manifest_linter.lint()
+    end
+
+    def contents_swift_file_exists?
+      return File.exist? CONTENTS_SWIFT_FILE_NAME
+    end
+  end
+end

data/lib/playground_book_lint/page_manifest_linter.rb

@@ -0,0 +1,11 @@
+require 'plist'
+require 'playground_book_lint/manifest_linter'
+
+module PlaygroundBookLint
+  class PageManifestLinter < ManifestLinter
+    def lint
+      super()
+        # TODO: Check for valid LiveViewMode values.
+    end
+  end
+end

data/lib/playground_book_lint/root_manifest_linter.rb

@@ -0,0 +1,35 @@
+require 'plist'
+require 'playground_book_lint/manifest_linter'
+require 'playground_book_lint/chapter_linter'
+
+module PlaygroundBookLint
+  class RootManifestLinter < ManifestLinter
+    attr_accessor :chapter_linter
+
+    def initialize(chapter_linter = ChapterLinter.new())
+      @chapter_linter = chapter_linter
+    end
+    
+    def lint
+      super()
+      
+      fail_lint "No Chapters directory" unless chapters_directory_exist?
+      fail_lint "No Chapters specified" unless chapters_exist?
+      
+      # Go into Chapters/ and then each chapter directory, then lint it.
+      Dir.chdir 'Chapters' do
+        manifest_plist_contents['Chapters'].each do |chapter_directory_name|
+          chapter_linter.lint(chapter_directory_name)
+        end
+      end
+    end
+
+    def chapters_directory_exist?
+      return Dir.exist? 'Chapters'
+    end
+
+    def chapters_exist?
+      value_defined_in_manifest?('Chapters')
+    end
+  end
+end

data/lib/version.rb

@@ -0,0 +1,3 @@
+module PlaygroundBookLint
+  VERSION = '0.0.1'.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        = 'playground-book-lint'
+  s.version     = PlaygroundBookLint::VERSION
+  s.licenses    = ['MIT']
+  s.summary     = "Lints Swift Playground books."
+  s.description	= "Lints books for Swift Playgrounds on iOS"
+  s.authors     = ["Ash Furrow"]
+  s.homepage	= 'https://github.com/ashfurrow/playground-book-lint'
+  s.email       = 'ash@ashfurrow.com'
+  s.files       = `git ls-files`.split($/)
+  s.require_paths = ["lib"]
+  s.executables = ['playground_book_lint']
+  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/playground_book_lint/chapter_linter_spec.rb

@@ -0,0 +1,30 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+module PlaygroundBookLint
+  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 PlaygroundBookLint
+  describe ChapterManifestLinter do
+    include FakeFS::SpecHelpers
+    let(:chapter_manifest_linter) { ChapterManifestLinter.new(page_linter) }
+    let(:page_linter) { double(PageLinter) }
+    let!(:page_directory_name) { 'test_page_directory_name' }
+
+    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 PlaygroundBookLint
+  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/manfiest_linter_spec.rb

@@ -0,0 +1,71 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+module PlaygroundBookLint
+  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 PlaygroundBookLint
+  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('Contents.swift', '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,19 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+module PlaygroundBookLint
+  describe PageManifestLinter do
+    include FakeFS::SpecHelpers
+    let(:page_manifest_linter) { PageManifestLinter.new() }
+
+    it '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
+  end
+end

data/spec/playground_book_lint/root_manifest_linter_spec.rb

@@ -0,0 +1,35 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+module PlaygroundBookLint
+  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/playground_book_lint_spec.rb

@@ -0,0 +1,38 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+module PlaygroundBookLint
+  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/spec_helper.rb

@@ -0,0 +1,33 @@
+require 'pathname'
+require 'cork'
+require 'rspec'
+require 'plist'
+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 'playground_book_lint'
+require 'playground_book_lint/abstract_linter'
+require 'playground_book_lint/chapter_linter'
+require 'playground_book_lint/chapter_manifest_linter'
+require 'playground_book_lint/contents_linter'
+require 'playground_book_lint/manifest_linter'
+require 'playground_book_lint/page_linter'
+require 'playground_book_lint/page_manifest_linter'
+require 'playground_book_lint/root_manifest_linter'
+
+
+RSpec.configure do |config|
+  config.color = true
+
+  config.order = :random
+  Kernel.srand config.seed
+end
+
+def test_playground_book
+  'spec/fixtures/Starter.playgroundbook'
+end
+
+PlaygroundBookLint::AbstractLinter.ui = Cork::Board.new(silent: true)

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: playground-book-lint
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ash Furrow
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-07-22 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: Lints books for Swift Playgrounds on iOS
+email: ash@ashfurrow.com
+executables:
+- playground_book_lint
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-version
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/playground_book_lint
+- lib/playground_book_lint.rb
+- lib/playground_book_lint/abstract_linter.rb
+- lib/playground_book_lint/chapter_linter.rb
+- lib/playground_book_lint/chapter_manifest_linter.rb
+- lib/playground_book_lint/contents_linter.rb
+- lib/playground_book_lint/manifest_linter.rb
+- lib/playground_book_lint/page_linter.rb
+- lib/playground_book_lint/page_manifest_linter.rb
+- lib/playground_book_lint/root_manifest_linter.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/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/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/root_manifest_linter_spec.rb
+- spec/playground_book_lint_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.4.8
+signing_key: 
+specification_version: 4
+summary: Lints Swift Playground books.
+test_files: []