playgroundbook 0.6.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a6d1f0ed65671bb4c70bf6cbd734b9648b1733ea
-  data.tar.gz: a40d6882aa7217a9ae7e13c882b1e4607cef78d0
+  metadata.gz: 000ecb1a02bff2b04307cd2a25a719a1aa242ae9
+  data.tar.gz: 5b30b076d2763c7132140535c2258b67221ef8b4
 SHA512:
-  metadata.gz: a0a69b41dec9497235562749b007e2321099585d0e5c7f9521da897a1348076891469e3cdecbb9fd61dcdd0b54ad0fd99827f13d5b95d7b611466c01bfe1904f
-  data.tar.gz: d97dc8dc75a1a64bf5f30a1d44e9ecc8b3ba7aee914877b0bfb6b937418308e85b783f07dc754e14206d54902f8776ee9de5eefbac80cf529b6a52f6f3475f8d
+  metadata.gz: ebd0b322c996b8a2698e553726319d575998573be3729f8a36af2a75940bd6401f81549e74d50aad1d772b9be8f8cc06108368d3075afa4a08b741b544e94e73
+  data.tar.gz: 7e7b5e305994ff92ef6b43200dcf50d8a6b84c3c8775f047a7b8fca4d710a7f88d5461e4148bcd4b8bba5bc9655d800113d78c79f8e6bd05d1d378f4a20bece6

data/README.md

@@ -55,32 +55,12 @@ Each chapter needs to have a corresponding playground; so `Chapter 1` requires t
 
 Only the link to the term must be URL encoded. For example, the term "reuse identifier" would be defined in the yaml as `reuse identifier` but linked to as `glossary://reuse%20identifier`.  
 
-Each chapter needs to be in the following format:
-
-```swift
-// This is the preamble that is shared among all the pages within this chapter.
-
-public var str = "Hi!"
-
-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."
-```
-
-Pages are divided by lines beginning with a quadruple slash, followed by that pages name.
+Each page in a chapter's `.playground` will be a separate page in the `.playgroundbook` and it's `Source`. The contents of the `Source` and `Resource` folders for each chapter and each page are copied.  
 
 ### Limitations of Book Rendering
 
+Playground books support a rich set of awesome features to make learning how to code really easy, and this tool only scratches the surface. Read over the [Playground Book reference](https://developer.apple.com/library/content/documentation/Xcode/Conceptual/swift_playgrounds_doc_format/) to see all the available options. If you have suggestions, please open an issue :+1:
+=======
 The preamble (anything about the first `////` page) is put in its own file. That means declarations there need to be `public` to be visible within individual pages (even though when you're writing, everything is in one file). Additionally, the preamble is at the top-level and can't contain expressions. This would cause a compiler error in the Swift Playrounds iPad app:
 
 ```swift
@@ -88,28 +68,6 @@ public let layout = UICollectionViewFlowLayout()
 layout.itemSize = CGSize(width: 20, height: 20)
 ```
 
-Instead, you have to wrap it in a closure, like this:
-
-```swift
-public var layout: UICollectionViewFlowLayout = {
-    let layout = UICollectionViewFlowLayout()
-    layout.itemSize = CGSize(width: 20, height: 20)
-    return layout
-}()
-```
-
-It's awkward; if you have suggestions, open an issue :+1:
-
-Sharing resources is only available book-wide and not specific to chapters. Sharing code outside the preamble isn't supported yet.
-
-#### Using Swift Package Manager Dependencies
-
-If you place a `Package.swift` file next to your playgroundbook manifest used for rendering a book and run `swift package fetch` to fetch the corresponding sources into `Packages/`, these will be copied into the playground book's top-level `Sources` when building and available in the finished book.
-These source files will also be copied into the original playground for each chapter to make these available for use in Xcode.
-Please note that this will work best with SPM packages containing pure Swift.
-
-Playground books support a rich set of awesome features to make learning how to code really easy, and this tool uses almost none of them. It sacrifices this experience for the sake of being able to easily write the books on your Mac.
-
 ### Creating a Playground from markdown
 
 Maybe you want to do something for a website, or a git repo first, and then generate your Playground? Well in those cases your source of truth is the markdown document. For that case, we have `playgroundbook wrapper`.

data/lib/renderer/chapter_collator.rb

@@ -1,8 +1,10 @@
 require "plist"
+require "fileutils"
 require "renderer/page_writer"
 
 module Playgroundbook
   SharedSourcesDirectoryName = "Sources".freeze
+  SharedResourcesDirectoryName = "Resources".freeze
   PreambleFileName = "Preamble.swift".freeze
 
   class ChapterCollator
@@ -26,12 +28,17 @@ 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, chapter)
+            page_source_names = parsed_chapter[:page_source_names][index]
+            page_resource_names = parsed_chapter[:page_resource_names][index]
+
+            @page_writer.write_page(page_name, page_dir_name, imports, page_contents, page_source_names, page_resource_names, chapter)
           end
         end
 
         write_chapter_manifest(chapter_name, parsed_chapter[:page_dir_names])
         write_preamble(parsed_chapter[:preamble])
+        copy_sources(parsed_chapter[:source_names])
+        copy_resources(parsed_chapter[:resource_names])
       end
     end
 
@@ -56,5 +63,21 @@ module Playgroundbook
         end
       end
     end
+
+    def copy_sources(source_names)
+      Dir.mkdir(SharedSourcesDirectoryName) unless Dir.exist?(SharedSourcesDirectoryName)
+
+      source_names.each do |source|
+        FileUtils.cp("../../../../#{source}", SharedSourcesDirectoryName)
+      end
+    end
+
+    def copy_resources(resource_names)
+      Dir.mkdir(SharedResourcesDirectoryName) unless Dir.exist?(SharedResourcesDirectoryName)
+
+      resource_names.each do |resource|
+        FileUtils.cp("../../../../#{resource}", SharedResourcesDirectoryName)
+      end
+    end
   end
 end

data/lib/renderer/page_parser.rb

@@ -1,6 +1,6 @@
 module Playgroundbook
   class PageParser
-    def parse_chapter_pages(chapter_contents)
+    def parse_chapter_pages(chapter_contents, source_names, resource_names)
       # Looks for //// PageName separators.
       page_names = chapter_contents.scan(/\/\/\/\/.*$/).map { |p| p.gsub("////", "").strip }
       page_dir_names = page_names.map { |p| "#{p}.playgroundpage" }
@@ -13,7 +13,29 @@ module Playgroundbook
         page_dir_names: page_dir_names,
         page_names: page_names,
         page_contents: page_contents,
-        preamble: preamble
+        preamble: preamble,
+        page_source_names: [[]] * page_names.count,   # TODO: Be less hacky
+        page_resource_names: [[]] * page_names.count, # TODO: Be less hacky
+        source_names: source_names,
+        resource_names: resource_names
+      }
+    end
+
+    def parse_chapter_xcplaygroundpages(pages_data, source_names, resource_names)
+      page_dir_names = pages_data.map { |p| "#{p[:name]}.playgroundpage" }
+      page_names = pages_data.map { |p| "#{p[:name]}" }
+      page_contents = pages_data.map { |p| "#{p[:contents]}" }
+      page_source_names = pages_data.map { |p| p[:sources] }
+      page_resource_names = pages_data.map { |p| p[:resources] }
+
+      {
+        page_dir_names: page_dir_names,
+        page_names: page_names,
+        page_contents: page_contents,
+        page_source_names: page_source_names,
+        page_resource_names: page_resource_names,
+        source_names: source_names,
+        resource_names: resource_names
       }
     end
   end

data/lib/renderer/page_writer.rb

@@ -8,7 +8,7 @@ module Playgroundbook
       @ui = ui
     end
 
-    def write_page(page_name, page_dir_name, imports, page_contents, chapter_info={})
+    def write_page(page_name, page_dir_name, imports, page_contents, page_sources, page_resources, chapter_info={})
       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"
@@ -29,6 +29,25 @@ module Playgroundbook
             "ContentVersion" => "1.0"
           }.to_plist)
         end
+
+        copy_page_sources(page_sources)
+        copy_page_resources(page_resources)
+      end
+    end
+
+    def copy_page_sources(source_names)
+      Dir.mkdir(SharedSourcesDirectoryName) unless Dir.exist?(SharedSourcesDirectoryName)
+
+      source_names.each do |source|
+        FileUtils.cp("../../../../../../#{source}", SharedSourcesDirectoryName)
+      end
+    end
+
+    def copy_page_resources(resource_names)
+      Dir.mkdir(SharedResourcesDirectoryName) unless Dir.exist?(SharedResourcesDirectoryName)
+
+      resource_names.each do |resource|
+        FileUtils.cp("../../../../../../#{resource}", SharedResourcesDirectoryName)
       end
     end
   end

data/lib/renderer/playgroundbook_renderer.rb

@@ -2,6 +2,7 @@ require "colored"
 require "pathname"
 require "yaml"
 require "fileutils"
+require "nokogiri"
 require "renderer/contents_manifest_generator"
 require "renderer/chapter_collator"
 require "renderer/page_parser"
@@ -39,17 +40,36 @@ module Playgroundbook
 
       book = yaml_contents
       book_dir_name = "#{book['name']}.playgroundbook"
-      book_chapter_contents = []
+      parsed_chapters = []
       # TODO: Validate YAML contents?
       begin
-        book_chapter_contents = book["chapters"].map do |chapter|
-          File.read("#{chapter['name']}.playground/Contents.swift")
+        parsed_chapters = book["chapters"].map do |chapter|
+          source_names = Dir["#{chapter['name']}.playground/Sources/*.swift"]
+          resource_names = Dir["#{chapter['name']}.playground/Resources/*"]
+          single_page_file = "#{chapter['name']}.playground/Contents.swift"
+          if File.exist?(single_page_file)
+            c = File.read(single_page_file)
+            page_parser.parse_chapter_pages(c, source_names, resource_names)
+          elsif !Dir.glob("#{chapter['name']}.playground/Pages/*.xcplaygroundpage").empty?
+            toc = Nokogiri::XML(File.read("#{chapter['name']}.playground/contents.xcplayground"))
+            page_names = toc.xpath("//page").map { |p| p["name"] }
+            pages_data = page_names.map do |p|
+              {
+                name: p,
+                contents: File.read("#{chapter['name']}.playground/Pages/#{p}.xcplaygroundpage/Contents.swift"),
+                sources: Dir["#{chapter['name']}.playground/Pages/#{p}.xcplaygroundpage/Sources/*.swift"],
+                resources: Dir["#{chapter['name']}.playground/Pages/#{p}.xcplaygroundpage/Resources/*"]
+              }
+            end
+            page_parser.parse_chapter_xcplaygroundpages(pages_data, source_names, resource_names)
+          else
+            raise "Missing valid playground for #{chapter['name']}."
+          end
         end
       rescue => e
-        ui.puts "Failed to open playground Contents.swift file."
+        ui.puts "Failed to open and parse playground chapter."
         raise e
       end
-      parsed_chapters = book_chapter_contents.map { |c| page_parser.parse_chapter_pages(c) }
 
       book["chapters"].map do |chapter|
         Dir.glob("Packages/**/Sources/*.swift").each do |file|

data/lib/version.rb

@@ -1,3 +1,3 @@
 module Playgroundbook
-  VERSION = "0.6.0".freeze
+  VERSION = "1.0.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: playgroundbook
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Ash Furrow
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-03 00:00:00.000000000 Z
+date: 2017-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: plist
@@ -59,19 +59,8 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".ruby-version"
-- Changelog.md
-- CodeOfConduct.md
-- Community.md
-- Gemfile
-- Gemfile.lock
-- Guardfile
 - LICENSE
 - README.md
-- Rakefile
 - bin/playgroundbook
 - lib/linter/abstract_linter.rb
 - lib/linter/chapter_linter.rb
@@ -94,39 +83,6 @@ files:
 - lib/renderer/playgroundbook_renderer.rb
 - lib/version.rb
 - lib/wrapper/markdown_wrapper.rb
-- playgroundbook.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/fixtures/wrapper/destination/swift_at_artsy_1.swift
-- spec/fixtures/wrapper/source/Swift-at-Artsy.playground/Contents.swift
-- spec/fixtures/wrapper/source/Swift-at-Artsy.playground/contents.xcplayground
-- spec/fixtures/wrapper/source/swift_at_artsy_1.md
-- spec/linter/chapter_linter_spec.rb
-- spec/linter/chapter_manifest_linter_spec.rb
-- spec/linter/contents_linter_spec.rb
-- spec/linter/cutscene_page_linter_spec.rb
-- spec/linter/cutscene_page_manifest_linter_spec.rb
-- spec/linter/manfiest_linter_spec.rb
-- spec/linter/page_linter_spec.rb
-- spec/linter/page_manifest_linter_spec.rb
-- spec/linter/playgroundbook_lint_spec.rb
-- spec/linter/root_manifest_linter_spec.rb
-- spec/renderer/chapter_collator_spec.rb
-- spec/renderer/contents_manfiest_generator_spec.rb
-- spec/renderer/glossary_generator_spec.rb
-- spec/renderer/page_processor_spec.rb
-- spec/renderer/page_writer_spec.rb
-- spec/renderer/playgroundbook_renderer_spec.rb
-- spec/spec_helper.rb
-- spec/wrapper/markdown_wrapper_spec.rb
 homepage: https://github.com/ashfurrow/playground-book-lint
 licenses:
 - MIT

data/.gitignore

@@ -1,50 +0,0 @@
-*.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

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

data/.rubocop.yml

@@ -1,112 +0,0 @@
-Metrics/LineLength:
-  Enabled: false
-
-Style/StringLiterals:
-  EnforcedStyle: double_quotes
-  Enabled: true
-
-# kind_of? is a good way to check a type
-Style/ClassCheck:
-  EnforcedStyle: kind_of?
-
-# It's better to be more explicit about the type
-Style/BracesAroundHashParameters:
-  Enabled: false
-
-# specs sometimes have useless assignments, which is fine
-Lint/UselessAssignment:
-  Exclude:
-    - '**/spec/**/*'
-
-# We could potentially enable the 2 below:
-Style/IndentHash:
-  Enabled: false
-
-Style/AlignHash:
-  Enabled: false
-
-# HoundCI doesn't like this rule
-Style/DotPosition:
-  Enabled: false
-
-# We allow !! as it's an easy way to convert ot boolean
-Style/DoubleNegation:
-  Enabled: false
-
-# Cop supports --auto-correct.
-Lint/UnusedBlockArgument:
-  Enabled: false
-
-# We want to allow class Fastlane::Class
-Style/ClassAndModuleChildren:
-  Enabled: false
-
-Metrics/AbcSize:
-  Max: 60
-
-# The %w might be confusing for new users
-Style/WordArray:
-  MinSize: 19
-
-# raise and fail are both okay
-Style/SignalException:
-  Enabled: false
-
-# Better too much 'return' than one missing
-Style/RedundantReturn:
-  Enabled: false
-
-# Having if in the same line might not always be good
-Style/IfUnlessModifier:
-  Enabled: false
-
-# and and or is okay
-Style/AndOr:
-  Enabled: false
-
-# Configuration parameters: CountComments.
-Metrics/ClassLength:
-  Max: 320
-
-Metrics/CyclomaticComplexity:
-  Max: 17
-
-# Configuration parameters: AllowURI, URISchemes.
-Metrics/LineLength:
-  Max: 370
-
-# Configuration parameters: CountKeywordArgs.
-Metrics/ParameterLists:
-  Max: 10
-
-Metrics/PerceivedComplexity:
-  Max: 18
-
-# Sometimes it's easier to read without guards
-Style/GuardClause:
-  Enabled: false
-
-# something = if something_else
-# that's confusing
-Style/ConditionalAssignment:
-  Enabled: false
-
-# Better to have too much self than missing a self
-Style/RedundantSelf:
-  Enabled: false
-
-Metrics/MethodLength:
-  Max: 60
-
-# We're not there yet
-Style/Documentation:
-  Enabled: false
-
-# Adds complexity
-Style/IfInsideElse:
-  Enabled: false
-
-# danger specific
-
-Style/BlockComments:
-  Enabled: false