playgroundbook 0.2.0

data/lib/playgroundbook_lint/chapter_manifest_linter.rb

@@ -0,0 +1,43 @@
+require 'playgroundbook_lint/manifest_linter'
+require 'playgroundbook_lint/page_linter'
+require 'playgroundbook_lint/cutscene_page_linter'
+
+module Playgroundbook
+  # A linter for verifying the contents of a chapter's Manifest.plist
+  class ChapterManifestLinter < ManifestLinter
+    attr_accessor :page_linter, :cutscene_page_linter
+
+    def initialize(page_linter = PageLinter.new, cutscene_page_linter = CutscenePageLinter.new)
+      @page_linter = page_linter
+      @cutscene_page_linter = cutscene_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)
+          lint_page page_directory_name
+        end
+      end
+    end
+
+    def lint_page(page_directory_name)
+      Dir.chdir page_directory_name do
+        if page_directory_name =~ /.+\.playgroundpage$/
+          page_linter.lint
+        elsif page_directory_name =~ /.+\.cutscenepage$/
+          cutscene_page_linter.lint
+        end
+      end
+    end
+
+    def chapter_has_manifest_pages?
+      value_defined_in_manifest?('Pages')
+    end
+  end
+end

data/lib/playgroundbook_lint/contents_linter.rb

@@ -0,0 +1,20 @@
+require 'playgroundbook_lint/abstract_linter'
+require 'playgroundbook_lint/root_manifest_linter'
+
+module Playgroundbook
+  # A linter for verifying the contents directory of a playground book
+  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/playgroundbook_lint/cutscene_page_linter.rb

@@ -0,0 +1,17 @@
+require 'playgroundbook_lint/abstract_linter'
+require 'playgroundbook_lint/cutscene_page_manifest_linter'
+
+module Playgroundbook
+  # A linter for verifying cutscene pages
+  class CutscenePageLinter < AbstractLinter
+    attr_accessor :cutscene_page_manifest_linter
+
+    def initialize(cutscene_page_manifest_linter = CutscenePageManifestLinter.new)
+      @cutscene_page_manifest_linter = cutscene_page_manifest_linter
+    end
+
+    def lint
+      cutscene_page_manifest_linter.lint
+    end
+  end
+end

data/lib/playgroundbook_lint/cutscene_page_manifest_linter.rb

@@ -0,0 +1,18 @@
+require 'playgroundbook_lint/manifest_linter'
+
+module Playgroundbook
+  # A linter for verifying the contents of a cutscene page's manifest
+  class CutscenePageManifestLinter < ManifestLinter
+    attr_accessor :page_manifest_linter
+
+    def lint
+      super()
+
+      # Cutscene references should point to an existent HTML file
+      cutscene_reference = manifest_plist_contents['CutsceneReference']
+      fail_lint "Cutscene manifest doesn't reference a cutscene file" if cutscene_reference.nil?
+      fail_lint "Cutscene file at '#{cutscene_reference}' isn't HTML" unless cutscene_reference =~ /^.+\.html$/i
+      fail_lint "Cutscene file at '#{cutscene_reference}' doesn't exist" unless File.exist? cutscene_reference
+    end
+  end
+end

data/lib/playgroundbook_lint/manifest_linter.rb

@@ -0,0 +1,39 @@
+require 'plist'
+require 'playgroundbook_lint/abstract_linter'
+
+module Playgroundbook
+  MANIFEST_FILE_NAME = 'Manifest.plist'.freeze
+
+  # A base inplementation of a linter for verifying the contents of manifest
+  # files.
+  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 name?
+    end
+
+    def manifest_file_exists?
+      File.exist? 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)
+      @manifest_plist_contents
+    end
+
+    def 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?
+      true
+    end
+  end
+end

data/lib/playgroundbook_lint/page_linter.rb

@@ -0,0 +1,23 @@
+require 'playgroundbook_lint/abstract_linter'
+require 'playgroundbook_lint/page_manifest_linter'
+
+module Playgroundbook
+  # A linter for verifying the contents of a page directory
+  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 #{ContentsSwiftFileName} in #{Dir.pwd}" unless contents_swift_file_exists?
+
+      page_manifest_linter.lint
+    end
+
+    def contents_swift_file_exists?
+      File.exist? ContentsSwiftFileName
+    end
+  end
+end

data/lib/playgroundbook_lint/page_manifest_linter.rb

@@ -0,0 +1,18 @@
+require 'plist'
+require 'playgroundbook_lint/manifest_linter'
+
+module Playgroundbook
+  # A linter for verifying the contents of a page's Manifest.plist
+  class PageManifestLinter < ManifestLinter
+    SUPPORTED_LIVE_VIEW_MODES = %w(VisibleByDefault HiddenByDefault).freeze
+
+    def lint
+      super()
+
+      live_view_mode = manifest_plist_contents['LiveViewMode']
+      unless live_view_mode.nil?
+        fail_lint "Unsopported LiveViewMoode '#{live_view_mode}'" unless SUPPORTED_LIVE_VIEW_MODES.include? live_view_mode
+      end
+    end
+  end
+end

data/lib/playgroundbook_lint/playgroundbook_lint.rb

@@ -0,0 +1,31 @@
+require 'colored'
+require 'playgroundbook_lint/abstract_linter'
+require 'playgroundbook_lint/contents_linter'
+require 'pathname'
+
+module Playgroundbook
+  # A linter for verifying a playground book
+  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?
+      Dir.exist?(playground_file_name + '/Contents')
+    end
+  end
+end

data/lib/playgroundbook_lint/root_manifest_linter.rb

@@ -0,0 +1,36 @@
+require 'plist'
+require 'playgroundbook_lint/manifest_linter'
+require 'playgroundbook_lint/chapter_linter'
+
+module Playgroundbook
+  # A linter for verifying the contents of a playground book's root manifest
+  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?
+      Dir.exist? 'Chapters'
+    end
+
+    def chapters_exist?
+      value_defined_in_manifest?('Chapters')
+    end
+  end
+end

data/lib/playgroundbook_renderer/chapter_collator.rb

@@ -0,0 +1,77 @@
+require 'plist'
+require 'playgroundbook_renderer/page_writer'
+
+module Playgroundbook
+  SharedSourcesDirectoryName = 'Sources'
+  PreambleFileName = 'Preamble.swift'
+
+  class ChapterCollator
+    def initialize(page_writer = PageWriter.new, ui = Cork::Board.new)
+      @page_writer = page_writer
+      @ui = ui
+    end
+
+    def collate!(chapter_name, chapter_file_contents, imports)
+      @ui.puts "Processing #{chapter_name.green}."
+
+      chater_directory_name = "#{chapter_name}.playgroundchapter"
+      Dir.mkdir(chater_directory_name) unless Dir.exist?(chater_directory_name)
+      Dir.chdir(chater_directory_name) do
+        pages = parse_pages(chapter_file_contents)
+        
+        Dir.mkdir(PagesDirectoryName) unless Dir.exist?(PagesDirectoryName)
+        Dir.chdir(PagesDirectoryName) do
+          pages[:page_names].each_with_index do |page_name, index|
+            @ui.puts "  Processing #{page_name.green}."
+
+            page_contents = pages[:page_contents][index]
+            page_dir_name = pages[:page_dir_names][index]
+
+            @page_writer.write_page!(page_name, page_dir_name, imports, page_contents)
+          end
+        end
+
+        write_chapter_manifest!(chapter_name, pages[:page_dir_names])
+        write_preamble!(pages[:preamble])
+      end
+    end
+
+    def parse_pages(swift)
+      page_names = swift.scan(/\/\/\/\/.*$/).map { |p| p.gsub('////', '').strip }
+      page_dir_names = page_names.map { |p| "#{p}.playgroundpage" }
+
+      split_file = swift.split(/\/\/\/\/.*$/)
+      page_contents = split_file.drop(1).map { |p| p.strip }
+      preamble = split_file.first.strip
+
+      {
+        page_dir_names: page_dir_names,
+        page_names: page_names,
+        page_contents: page_contents,
+        preamble: preamble,
+      }
+    end
+
+    def write_chapter_manifest!(chapter_name, page_dir_names)
+      manifest_contents = {
+        'Name' => chapter_name,
+        'Pages' => page_dir_names,
+        'Version' => '1.0',
+        'ContentVersion' => '1.0',
+      }
+      File.open(ManifestFileName, 'w') do |file|
+        file.write(manifest_contents.to_plist)
+      end
+    end
+
+    def write_preamble!(preamble)
+      Dir.mkdir(SharedSourcesDirectoryName) unless Dir.exist?(SharedSourcesDirectoryName)
+
+      Dir.chdir(SharedSourcesDirectoryName) do
+        File.open(PreambleFileName, 'w') do |file|
+          file.write(preamble)
+        end
+      end
+    end
+  end
+end

data/lib/playgroundbook_renderer/contents_manifest_generator.rb

@@ -0,0 +1,33 @@
+require 'plist'
+
+module Playgroundbook
+  class ContentsManifestGenerator
+    def initialize(ui = Cork::Board.new)
+      @ui = ui
+    end
+
+    def generate!(book_metadata)
+      @ui.puts "Generating main manifest file."
+      write_manifest_file!(book_metadata)
+      @ui.puts "Manifest file generated."
+    end
+
+    def write_manifest_file!(book_metadata)
+      File.open(ManifestFileName, 'w') do |file|
+        file.write(manifest_contents(book_metadata).to_plist)
+      end
+    end
+
+    def manifest_contents(book_metadata)
+      chapters = book_metadata['chapters'].map{ |c| "#{c}.playgroundchapter" }
+      {
+        'Name' => book_metadata['name'],
+        'ContentIdentifier' => book_metadata['identifier'],
+        'DeploymentTarget' => book_metadata['deployment_target'] || 'ios10.0',
+        'Chapters' => chapters,
+        'Version' => '1.0',
+        'ContentVersion' => '1.0',
+      }
+    end
+  end
+end

data/lib/playgroundbook_renderer/page_writer.rb

@@ -0,0 +1,34 @@
+require 'plist'
+
+module Playgroundbook
+  class PageWriter
+
+    def initialize(ui = Cork::Board.new)
+      @ui = ui
+    end
+
+    def write_page!(page_name, page_dir_name, imports, page_contents)
+      Dir.mkdir(page_dir_name) unless Dir.exist?(page_dir_name)
+
+      contents_with_import = "//#-hidden-code\n"
+      contents_with_import += imports.map { |i| "import #{i}" }.join("\n") + "\n"
+      contents_with_import += "//#-end-hidden-code\n"
+      contents_with_import += page_contents
+
+      Dir.chdir(page_dir_name) do
+        File.open(ContentsSwiftFileName, 'w') do |file|
+          file.write(contents_with_import)
+        end
+
+        File.open(MANIFEST_FILE_NAME, 'w') do |file|
+          file.write ({
+            'Name' => page_name,
+            'LiveViewMode' => 'HiddenByDefault',
+            'Version' => '1.0',
+            'ContentVersion' => '1.0',
+          }.to_plist)
+        end
+      end
+    end
+  end
+end

data/lib/playgroundbook_renderer/playgroundbook_renderer.rb

@@ -0,0 +1,75 @@
+require 'colored'
+require 'pathname'
+require 'yaml'
+require 'fileutils'
+require 'playgroundbook_renderer/contents_manifest_generator'
+require 'playgroundbook_renderer/chapter_collator'
+
+module Playgroundbook
+  ContentsDirName = 'Contents'
+  ChaptersDirName = 'Chapters'
+
+  # A renderer for playground books.
+  class Renderer < AbstractLinter
+    attr_accessor :yaml_file_name
+    attr_accessor :contents_manifest_generator
+    attr_accessor :chapter_collator
+    attr_accessor :ui
+
+    def initialize(yaml_file_name, 
+        contents_manifest_generator = ContentsManifestGenerator.new, 
+        chapter_collator = ChapterCollator.new,
+        ui = Cork::Board.new)
+      @yaml_file_name = yaml_file_name
+      @contents_manifest_generator = contents_manifest_generator
+      @chapter_collator = chapter_collator
+      @ui = ui
+    end
+
+    def render!
+      ui.puts "Rendering #{yaml_file_name.green}..."
+      
+      book = yaml_contents
+      book_dir_name = "#{book['name']}.playgroundbook"
+      book_chapter_contents = []
+      # TODO: Validate YAML contents?
+      begin
+        book_chapter_contents = book['chapters'].map do |chapter|
+          File.read("#{chapter}.playground/Contents.swift")
+        end
+      rescue => e
+        ui.puts 'Failed to open playground Contents.swift file.'
+        raise e
+      end
+
+      Dir.mkdir(book_dir_name) unless Dir.exist?(book_dir_name)
+      Dir.chdir(book_dir_name) do
+        Dir.mkdir(ContentsDirName) unless Dir.exist?(ContentsDirName)
+        Dir.chdir(ContentsDirName) do
+          resources_dir = book['resources']
+          if !(resources_dir.nil? || resources_dir.empty?)
+            @ui.puts "Copying resource directory (#{resources_dir.green}) contents."
+            Dir.mkdir(ResourcesDirectoryName) unless Dir.exist?(ResourcesDirectoryName)
+            Dir.glob("../../#{resources_dir}/*").each do |file|
+              FileUtils.cp(file, ResourcesDirectoryName)
+            end
+          end
+          @contents_manifest_generator.generate!(book)
+
+          Dir.mkdir(ChaptersDirName) unless Dir.exist?(ChaptersDirName)
+          Dir.chdir(ChaptersDirName) do
+            # Chapter file name becomes chapter name in playground book.
+            book['chapters'].each_with_index do |chapter_file_name, index|
+              chapter_file_contents = book_chapter_contents[index]
+              @chapter_collator.collate!(chapter_file_name, chapter_file_contents, book['imports'] || ['UIKit'])
+            end
+          end
+        end
+      end
+    end
+
+    def yaml_contents
+      YAML.load(File.open(@yaml_file_name))
+    end
+  end
+end