playgroundbook 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 50c5634d2dc4a7cc4835cb8f22d8635e5d6af5b9
-  data.tar.gz: a63778b8a2f1ff34a8574eb32b248e4cfc9e5c37
+  metadata.gz: b9284005e400363b56c6ad72c74da1d147b5f63b
+  data.tar.gz: e082821228fd38d19d3af795a62d5c80988ecc86
 SHA512:
-  metadata.gz: 1ef0dd0789b88d8e532cfc15012b46e041ab8d9ade116e017dfe89661283498f88e8c32551526a95f5233173b37c6513d0cbcb853267e252a8b33c093ee5ace4
-  data.tar.gz: 71b69a509bfc4d797cc8bec0411e8781fc88232b17f5f7846a342cc35d1f7a811596f073f33ec369a7077e771a3301bd544456c562032ee067618d6a3c3a33aa
+  metadata.gz: 351ca7d6d4c5af5c6246ccfeb76c7139adde5eeec7a5bcc666b8ed1d1ecf7afc1de90a05ccfca3eacc9d9297af53e7c26947acf9b4a0abfc4f6c0738e7b99b1e
+  data.tar.gz: 380e9c62a03fab27bfff3e64b8f9262f9ebc895b992306eaa49a85428197ec8989b54180aa85013e7ef8e87f901394ee816e3c4c8ee653cda3d3ab61903740ad

data/Changelog.md

@@ -2,6 +2,10 @@
 
 - Nothing yet.
 
+# 0.2.1
+
+- Support for cover images. See [#16](https://github.com/ashfurrow/playgroundbook/issues/16).
+
 # 0.2.0
 
 - Book rendering.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    playground-book-lint (0.2.0)
+    playgroundbook (0.2.1)
       colored (~> 1.2)
       cork (~> 0.1)
       plist (~> 3.2)
@@ -95,7 +95,7 @@ DEPENDENCIES
   guard-rspec
   mocha
   mocha-on-bacon
-  playground-book-lint!
+  playgroundbook!
   prettybacon
   rubocop (~> 0.41.2)
 

data/README.md

@@ -1,4 +1,4 @@
-[![CircleCI](https://circleci.com/gh/ashfurrow/playground-book-lint.svg?style=svg)](https://circleci.com/gh/ashfurrow/playground-book-lint)
+[![CircleCI](https://circleci.com/gh/ashfurrow/playgroundbook.svg?style=svg)](https://circleci.com/gh/ashfurrow/playgroundbook)
 
 # playgroundbook
 
@@ -30,6 +30,7 @@ The yml file should be in the following format:
 name: Testing book
 identifier: com.ashfurrow.example
 resources: assets # Optional
+cover: cover.jpeg # Optional
 deployment_target: ios10.0 # Optional
 imports: # Optional, defaults to UIKit 
  - UIKit
@@ -40,12 +41,16 @@ chapters:
   - etc...
 ```
 
-Each chapter needs to have a corresponding playground; so `Chapter 1` requires there be a `Chapter 1.playground` playground. The playgrounds can reference (not copy) resources from an optionally specified directory. `import` frameworks are specified in the yaml file and are added to every page of the book. Each chapter needs to be in the following format:
+Each chapter needs to have a corresponding playground; so `Chapter 1` requires there be a `Chapter 1.playground` playground. The playgrounds can reference (not copy) resources from an optionally specified directory. `import` frameworks are specified in the yaml file and are added to every page of the book. You can specify a cover image file name that's stored in the `resources` directory (it should be 400x300 pixels). 
+
+Each chapter needs to be in the following format:
 
 ```swift
 // This is the preamble that is shared among all the pages within this chapter.
 
-func sharedFunc() {
+public var str = "Hi!"
+
+public func sharedFunc() {
   print("This should be accessible to all pages.")
 }
 
@@ -64,7 +69,7 @@ Pages are divided by lines beginning with a quadruple slash, followed by that pa
 
 ### Limitations of Book Rendering
 
-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 experessions. This would cause a compiler error in the Swift Playrounds iPad app:
+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
 public let layout = UICollectionViewFlowLayout()

data/lib/playgroundbook_renderer/chapter_collator.rb

@@ -14,9 +14,9 @@ module Playgroundbook
     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
+      chapter_directory_name = "#{chapter_name}.playgroundchapter"
+      Dir.mkdir(chapter_directory_name) unless Dir.exist?(chapter_directory_name)
+      Dir.chdir(chapter_directory_name) do
         pages = parse_pages(chapter_file_contents)
         
         Dir.mkdir(PagesDirectoryName) unless Dir.exist?(PagesDirectoryName)

data/lib/playgroundbook_renderer/contents_manifest_generator.rb

@@ -20,7 +20,7 @@ module Playgroundbook
 
     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',
@@ -28,6 +28,8 @@ module Playgroundbook
         'Version' => '1.0',
         'ContentVersion' => '1.0',
       }
+      manifest_contents['ImageReference'] = book_metadata['cover'] unless book_metadata['cover'].nil?
+      manifest_contents
     end
   end
 end

data/lib/version.rb

@@ -1,3 +1,3 @@
 module Playgroundbook
-  VERSION = '0.2.0'.freeze
+  VERSION = '0.2.1'.freeze
 end

data/spec/fixtures/book.yml

@@ -1,5 +1,6 @@
 name: Testing book
 identifier: com.ashfurrow.example
 resources: assets
+cover: file.jpeg
 chapters:
   - test_chapter

data/spec/playgroundbook_renderer_spec/contents_manfiest_generator_spec.rb

@@ -32,6 +32,10 @@ module Playgroundbook
       it 'has chapters specified' do
         expect(get_manifest['Chapters']).to eq(['test_chapter.playgroundchapter'])
       end
+
+      it 'has a ImageReference' do
+        expect(get_manifest['ImageReference']).to eq('file.jpeg')
+      end
     end
   end
 end

data/spec/spec_helper.rb

@@ -45,6 +45,7 @@ def test_book_metadata
     'chapters' => ['test_chapter'],
     'identifier' => 'com.ashfurrow.testing',
     'resources' => 'assets',
+    'cover' => 'file.jpeg',
   }
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: playgroundbook
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Ash Furrow
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-27 00:00:00.000000000 Z
+date: 2016-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: plist