playgroundbook 0.3.0 → 0.4.0

data/lib/playgroundbook.rb

@@ -1,9 +1,10 @@
-require 'playgroundbook_lint/playgroundbook_lint'
-require 'playgroundbook_renderer/playgroundbook_renderer'
+require "linter/playgroundbook_lint"
+require "renderer/playgroundbook_renderer"
+require "wrapper/markdown_wrapper"
 
 module Playgroundbook
-  ManifestFileName = 'Manifest.plist'.freeze
-  ContentsSwiftFileName = 'Contents.swift'.freeze
-  ResourcesDirectoryName = 'Resources'.freeze
-  PagesDirectoryName = 'Pages'.freeze
-end
+  ManifestFileName = "Manifest.plist".freeze
+  ContentsSwiftFileName = "Contents.swift".freeze
+  ResourcesDirectoryName = "Resources".freeze
+  PagesDirectoryName = "Pages".freeze
+end

data/lib/{playgroundbook_renderer → renderer}/chapter_collator.rb

@@ -1,9 +1,9 @@
-require 'plist'
-require 'playgroundbook_renderer/page_writer'
+require "plist"
+require "renderer/page_writer"
 
 module Playgroundbook
-  SharedSourcesDirectoryName = 'Sources'
-  PreambleFileName = 'Preamble.swift'
+  SharedSourcesDirectoryName = "Sources".freeze
+  PreambleFileName = "Preamble.swift".freeze
 
   class ChapterCollator
     def initialize(page_writer = PageWriter.new, ui = Cork::Board.new)
@@ -11,12 +11,12 @@ module Playgroundbook
       @ui = ui
     end
 
-    def collate!(chapter_name, parsed_chapter, imports)
+    def collate(chapter_name, parsed_chapter, imports)
       @ui.puts "Processing #{chapter_name.green}."
 
       chapter_directory_name = "#{chapter_name}.playgroundchapter"
       Dir.mkdir(chapter_directory_name) unless Dir.exist?(chapter_directory_name)
-      Dir.chdir(chapter_directory_name) do        
+      Dir.chdir(chapter_directory_name) do
         Dir.mkdir(PagesDirectoryName) unless Dir.exist?(PagesDirectoryName)
         Dir.chdir(PagesDirectoryName) do
           parsed_chapter[:page_names].each_with_index do |page_name, index|
@@ -25,35 +25,35 @@ module Playgroundbook
             page_contents = parsed_chapter[:page_contents][index]
             page_dir_name = parsed_chapter[:page_dir_names][index]
 
-            @page_writer.write_page!(page_name, page_dir_name, imports, page_contents)
+            @page_writer.write_page(page_name, page_dir_name, imports, page_contents)
           end
         end
 
-        write_chapter_manifest!(chapter_name, parsed_chapter[:page_dir_names])
-        write_preamble!(parsed_chapter[:preamble])
+        write_chapter_manifest(chapter_name, parsed_chapter[:page_dir_names])
+        write_preamble(parsed_chapter[:preamble])
       end
     end
 
-    def write_chapter_manifest!(chapter_name, page_dir_names)
+    def write_chapter_manifest(chapter_name, page_dir_names)
       manifest_contents = {
-        'Name' => chapter_name,
-        'Pages' => page_dir_names,
-        'Version' => '1.0',
-        'ContentVersion' => '1.0',
+        "Name" => chapter_name,
+        "Pages" => page_dir_names,
+        "Version" => "1.0",
+        "ContentVersion" => "1.0"
       }
-      File.open(ManifestFileName, 'w') do |file|
+      File.open(ManifestFileName, "w") do |file|
         file.write(manifest_contents.to_plist)
       end
     end
 
-    def write_preamble!(preamble)
+    def write_preamble(preamble)
       Dir.mkdir(SharedSourcesDirectoryName) unless Dir.exist?(SharedSourcesDirectoryName)
 
       Dir.chdir(SharedSourcesDirectoryName) do
-        File.open(PreambleFileName, 'w') do |file|
+        File.open(PreambleFileName, "w") do |file|
           file.write(preamble)
         end
       end
     end
   end
-end
+end

data/lib/renderer/contents_manifest_generator.rb

@@ -0,0 +1,35 @@
+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" }
+      manifest_contents = {
+        "Name" => book_metadata["name"],
+        "ContentIdentifier" => book_metadata["identifier"],
+        "DeploymentTarget" => book_metadata["deployment_target"] || "ios10.0",
+        "Chapters" => chapters,
+        "Version" => "1.0",
+        "ContentVersion" => "1.0"
+      }
+      manifest_contents["ImageReference"] = book_metadata["cover"] unless book_metadata["cover"].nil?
+      manifest_contents
+    end
+  end
+end

data/lib/{playgroundbook_renderer → renderer}/glossary_generator.rb

@@ -1,16 +1,16 @@
-require 'uri'
+require "uri"
 
 module Playgroundbook
-  GlossaryFileName = 'Glossary.plist'.freeze
+  GlossaryFileName = "Glossary.plist".freeze
 
   class GlossaryGenerator
-    def generate!(parsed_chapters, chapter_names, glossary)
+    def generate(parsed_chapters, chapter_names, glossary)
       glossary_plist = {
-        'Terms' => {}
+        "Terms" => {}
       }
 
       glossary.each do |term, definition|
-        glossary_plist['Terms'][term] = { 'Definition' => definition }
+        glossary_plist["Terms"][term] = { "Definition" => definition }
         escaped_term = URI.escape(term)
         parsed_chapters.each_with_index do |chapter, i|
           pages = chapter[:page_contents]
@@ -19,23 +19,20 @@ module Playgroundbook
 
           pages.each_with_index do |page, j|
             page_name = URI.escape(page_names[j])
-            unless page.scan("](glossary://#{escaped_term})").empty?
-              glossary_plist['Terms'][term].merge!({
-                'FirstUse' => {
-                  'Title' => page_names[j],
-                  'PageReference' => "#{chapter_name}/#{page_name}",
-                }
-              })
-              break
-            end
+            next if page.scan("](glossary://#{escaped_term})").empty?
+            glossary_plist["Terms"][term]["FirstUse"] = {
+                "Title" => page_names[j],
+                "PageReference" => "#{chapter_name}/#{page_name}"
+              }
+            break
           end
 
           # Break if we found the first user.
-          break unless glossary_plist['Terms'][term]['FirstUse'].empty?
+          break unless glossary_plist["Terms"][term]["FirstUse"].empty?
         end
       end
 
-      File.open(glossary_file_name, 'w') do |file|
+      File.open(glossary_file_name, "w") do |file|
         file.write(glossary_plist.to_plist)
       end
     end

data/lib/{playgroundbook_renderer → renderer}/page_parser.rb

@@ -1,18 +1,19 @@
 module Playgroundbook
   class PageParser
     def parse_chapter_pages(chapter_contents)
-      page_names = chapter_contents.scan(/\/\/\/\/.*$/).map { |p| p.gsub('////', '').strip }
+      # Looks for //// PageName separators.
+      page_names = chapter_contents.scan(/\/\/\/\/.*$/).map { |p| p.gsub("////", "").strip }
       page_dir_names = page_names.map { |p| "#{p}.playgroundpage" }
 
       split_file = chapter_contents.split(/\/\/\/\/.*$/)
-      page_contents = split_file.drop(1).map { |p| p.strip }
+      page_contents = split_file.drop(1).map(&:strip)
       preamble = split_file.first.strip
 
       {
         page_dir_names: page_dir_names,
         page_names: page_names,
         page_contents: page_contents,
-        preamble: preamble,
+        preamble: preamble
       }
     end
   end

data/lib/{playgroundbook_renderer → renderer}/page_writer.rb

@@ -1,5 +1,5 @@
-require 'plist'
-require 'playgroundbook_renderer/page_processor'
+require "plist"
+require "renderer/page_processor"
 
 module Playgroundbook
   class PageWriter
@@ -8,7 +8,7 @@ module Playgroundbook
       @ui = ui
     end
 
-    def write_page!(page_name, page_dir_name, imports, page_contents)
+    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"
@@ -17,19 +17,19 @@ module Playgroundbook
       contents_with_import += @page_processor.strip_extraneous_newlines(page_contents)
 
       Dir.chdir(page_dir_name) do
-        File.open(ContentsSwiftFileName, 'w') do |file|
+        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',
+        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
+end

data/lib/{playgroundbook_renderer → renderer}/playgroundbook_renderer.rb

@@ -1,15 +1,15 @@
-require 'colored'
-require 'pathname'
-require 'yaml'
-require 'fileutils'
-require 'playgroundbook_renderer/contents_manifest_generator'
-require 'playgroundbook_renderer/chapter_collator'
-require 'playgroundbook_renderer/page_parser'
-require 'playgroundbook_renderer/glossary_generator'
+require "colored"
+require "pathname"
+require "yaml"
+require "fileutils"
+require "renderer/contents_manifest_generator"
+require "renderer/chapter_collator"
+require "renderer/page_parser"
+require "renderer/glossary_generator"
 
 module Playgroundbook
-  ContentsDirectoryName = 'Contents'
-  ChaptersDirName = 'Chapters'
+  ContentsDirectoryName = "Contents".freeze
+  ChaptersDirName = "Chapters".freeze
 
   # A renderer for playground books.
   class Renderer < AbstractLinter
@@ -20,12 +20,12 @@ module Playgroundbook
     attr_accessor :glossary_generator
     attr_accessor :ui
 
-    def initialize(yaml_file_name, 
-        contents_manifest_generator = ContentsManifestGenerator.new,
-        page_parser = PageParser.new,
-        chapter_collator = ChapterCollator.new,
-        glossary_generator = GlossaryGenerator.new,
-        ui = Cork::Board.new)
+    def initialize(yaml_file_name,
+                   contents_manifest_generator = ContentsManifestGenerator.new,
+                   page_parser = PageParser.new,
+                   chapter_collator = ChapterCollator.new,
+                   glossary_generator = GlossaryGenerator.new,
+                   ui = Cork::Board.new)
       @yaml_file_name = yaml_file_name
       @contents_manifest_generator = contents_manifest_generator
       @page_parser = page_parser
@@ -34,19 +34,19 @@ module Playgroundbook
       @ui = ui
     end
 
-    def render!
+    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|
+        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.'
+        ui.puts "Failed to open playground Contents.swift file."
         raise e
       end
       parsed_chapters = book_chapter_contents.map { |c| page_parser.parse_chapter_pages(c) }
@@ -56,29 +56,29 @@ module Playgroundbook
         Dir.mkdir(ContentsDirectoryName) unless Dir.exist?(ContentsDirectoryName)
         Dir.chdir(ContentsDirectoryName) do
           Dir.mkdir(ResourcesDirectoryName) unless Dir.exist?(ResourcesDirectoryName) # Always create a Resources dir, even if empty.
-          resources_dir = book['resources']
-          if !(resources_dir.nil? || resources_dir.empty?)
+          resources_dir = book["resources"]
+          unless resources_dir.nil? || resources_dir.empty?
             @ui.puts "Copying resource directory (#{resources_dir.green}) contents."
             Dir.glob("../../#{resources_dir}/*").each do |file|
               FileUtils.cp(file, ResourcesDirectoryName)
             end
           end
-          @contents_manifest_generator.generate!(book)
+          @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|
+            book["chapters"].each_with_index do |chapter_file_name, index|
               parsed_chapter = parsed_chapters[index]
-              @chapter_collator.collate!(chapter_file_name, parsed_chapter, book['imports'] || ['UIKit'])
+              @chapter_collator.collate(chapter_file_name, parsed_chapter, book["imports"] || ["UIKit"])
             end
           end
         end
 
-        unless book['glossary'].nil?
-          @ui.puts 'Generating glossary.'
-          @glossary_generator.generate!(parsed_chapters, book['chapters'], book['glossary'])
-        end 
+        unless book["glossary"].nil?
+          @ui.puts "Generating glossary."
+          @glossary_generator.generate(parsed_chapters, book["chapters"], book["glossary"])
+        end
       end
     end
 

data/lib/version.rb

@@ -1,3 +1,3 @@
 module Playgroundbook
-  VERSION = '0.3.0'.freeze
+  VERSION = "0.4.0".freeze
 end

data/lib/wrapper/markdown_wrapper.rb

@@ -0,0 +1,58 @@
+require "fileutils"
+
+module Playgroundbook
+  # Converts a Markdown file into a Swift Playground
+  # Needs to:
+  #  - Switch out code from being in  a block to being a root element
+  #  - Comment out non-code comments
+  #  - Embed images inside the Resources Dir
+  #
+  class MarkdownWrapper
+    attr_accessor :source, :name, :playground_contents
+
+    def initialize(source, name)
+      self.source = source
+      self.name = name
+      self.playground_contents = File.read(source)
+    end
+
+    def generate
+      contents = swap_code_context(playground_contents)
+      create_a_playground_wrapper(contents)
+    end
+
+    def swap_code_context(file_content)
+      prefix = "/*:\n"
+      suffix = "*/"
+      content = file_content.gsub("```swift", "*/\n").gsub("```", "/*:")
+      prefix + content + suffix
+    end
+
+    def create_a_playground_wrapper(file_content)
+      folder = File.dirname(source)
+      playground = File.join(folder, name + ".playground")
+
+      FileUtils.rm_r(playground) if Dir.exist?(playground)
+      Dir.mkdir(playground)
+
+      xcplayground = <<-XML
+<?xml version='1.0' encoding='UTF-8' standalone='yes'?>
+<playground version='5.0' target-platform='osx' display-mode='rendered'>
+    <timeline fileName='timeline.xctimeline'/>
+</playground>
+XML
+
+      timeline = <<-XML
+<?xml version="1.0" encoding="UTF-8"?>
+<Timeline
+   version = "3.0">
+   <TimelineItems>
+   </TimelineItems>
+</Timeline>
+XML
+      File.write(File.join(playground, "contents.xcplayground"), xcplayground)
+      File.write(File.join(playground, "timeline.xctimeline"), timeline)
+      File.write(File.join(playground, "Contents.swift"), file_content)
+    end
+  end
+end

data/playground_book_lint.gemspec

@@ -1,21 +1,21 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'version'
+require "version"
 
 Gem::Specification.new do |s|
-  s.name        = 'playgroundbook'
+  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.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'
+  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