playgroundbook 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 50c5634d2dc4a7cc4835cb8f22d8635e5d6af5b9
+  data.tar.gz: a63778b8a2f1ff34a8574eb32b248e4cfc9e5c37
+SHA512:
+  metadata.gz: 1ef0dd0789b88d8e532cfc15012b46e041ab8d9ade116e017dfe89661283498f88e8c32551526a95f5233173b37c6513d0cbcb853267e252a8b33c093ee5ace4
+  data.tar.gz: 71b69a509bfc4d797cc8bec0411e8781fc88232b17f5f7846a342cc35d1f7a811596f073f33ec369a7077e771a3301bd544456c562032ee067618d6a3c3a33aa

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/.rubocop.yml

@@ -0,0 +1,2 @@
+Metrics/LineLength:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.1.1

data/Changelog.md

@@ -0,0 +1,17 @@
+# Current Master
+
+- Nothing yet.
+
+# 0.2.0
+
+- Book rendering.
+- Book linting moved to subcommand.
+
+# 0.1.0
+
+- Adds support for linting manifest file optional values. See [#3](https://github.com/ashfurrow/playground-book-lint/issues/3). - @rpowelll
+- Adds support for playground cutscene linting. See [#9](https://github.com/ashfurrow/playground-book-lint/issues/9). - @rpowelll
+
+# 0.0.1
+
+- Initial release.

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+gem 'guard-rspec'
+gem 'mocha'
+gem 'bacon'
+gem 'mocha-on-bacon'
+gem 'prettybacon'
+gem 'fakefs'
+gem 'rubocop', '~> 0.41.2', require: false
+
+require 'pp' # https://github.com/defunkt/fakefs/issues/99
+gemspec

data/Gemfile.lock

@@ -0,0 +1,103 @@
+PATH
+  remote: .
+  specs:
+    playground-book-lint (0.2.0)
+      colored (~> 1.2)
+      cork (~> 0.1)
+      plist (~> 3.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.3.0)
+    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)
+    parser (2.3.1.2)
+      ast (~> 2.2)
+    plist (3.2.0)
+    powerpack (0.1.1)
+    prettybacon (0.0.2)
+      bacon (~> 1.2)
+    pry (0.10.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rainbow (2.1.0)
+    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)
+    rubocop (0.41.2)
+      parser (>= 2.3.1.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.8.1)
+    shellany (0.0.1)
+    slop (3.6.0)
+    thor (0.19.1)
+    unicode-display_width (1.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bacon
+  fakefs
+  guard-rspec
+  mocha
+  mocha-on-bacon
+  playground-book-lint!
+  prettybacon
+  rubocop (~> 0.41.2)
+
+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,92 @@
+[![CircleCI](https://circleci.com/gh/ashfurrow/playground-book-lint.svg?style=svg)](https://circleci.com/gh/ashfurrow/playground-book-lint)
+
+# playgroundbook
+
+Linter for Swift Playground books based on [Apple's documentation](https://developer.apple.com/library/prerelease/content/documentation/Xcode/Conceptual/swift_playgrounds_doc_format/index.html#//apple_ref/doc/uid/TP40017343-CH47-SW4). It's a work in progress (see [issues](https://github.com/ashfurrow/playground-book-lint/issues)) but you can use it now.
+
+## Installation
+
+```sh
+> [sudo] gem install playgroundbook
+```
+
+## Usage
+
+To lint an existing playground book:
+
+```sh
+> playgroundbook lint MyPlaygroundbook.playgroundbook
+```
+
+To generate a playground book:
+
+```sh
+> playgroundbook render book.yaml
+```
+
+The yml file should be in the following format:
+
+```yaml
+name: Testing book
+identifier: com.ashfurrow.example
+resources: assets # Optional
+deployment_target: ios10.0 # Optional
+imports: # Optional, defaults to UIKit 
+ - UIKit
+ - CoreGraphics
+chapters:
+  - Chapter 1
+  - Chapter 2
+  - 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:
+
+```swift
+// This is the preamble that is shared among all the pages within this chapter.
+
+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.
+
+### 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:
+
+```swift
+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.
+
+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.
+
+## License
+
+MIT, except for the `starter.playgroundbook` in the unit tests, which is licensed by Apple.

data/Rakefile

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

data/bin/playgroundbook

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+
+unless ARGV.length >= 2
+  puts 'You must specify either lint or render. Example usage:'
+  puts '  playgroundbook [lint|render] file_name'
+  exit 1
+end
+
+command = ARGV[0]
+file_name = ARGV[1]
+
+require 'playgroundbook'
+
+if command == 'lint'
+  Playgroundbook::Linter.new(file_name).lint
+elsif command == 'render'
+  Playgroundbook::Renderer.new(file_name).render!
+else
+  puts "Unknown command: #{command}"
+  exit 1
+end
+

data/lib/playgroundbook.rb

@@ -0,0 +1,9 @@
+require 'playgroundbook_lint/playgroundbook_lint'
+require 'playgroundbook_renderer/playgroundbook_renderer'
+
+module Playgroundbook
+  ManifestFileName = 'Manifest.plist'.freeze
+  ContentsSwiftFileName = 'Contents.swift'.freeze
+  ResourcesDirectoryName = 'Resources'.freeze
+  PagesDirectoryName = 'Pages'.freeze
+end

data/lib/playgroundbook_lint/abstract_linter.rb

@@ -0,0 +1,23 @@
+require 'colored'
+require 'cork'
+
+module Playgroundbook
+  # AbstractLinter provides a base implementation of a linter which a concrete
+  # linter subclass can inherit from
+  class AbstractLinter
+    @ui = Cork::Board.new
+
+    class << self
+      attr_accessor :ui
+    end
+
+    def fail_lint(msg)
+      AbstractLinter.ui.puts msg.red
+      exit 1
+    end
+
+    def message(msg)
+      AbstractLinter.ui.puts msg
+    end
+  end
+end

data/lib/playgroundbook_lint/chapter_linter.rb

@@ -0,0 +1,34 @@
+require 'plist'
+require 'playgroundbook_lint/abstract_linter'
+require 'playgroundbook_lint/chapter_manifest_linter'
+
+module Playgroundbook
+  PAGES_DIRECTORY_NAME = 'Pages'.freeze
+
+  # A linter for verifying a chapter directory
+  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)
+      Dir.exist? chapter_directory_name
+    end
+
+    def pages_directory_exists?
+      Dir.exist? PAGES_DIRECTORY_NAME
+    end
+  end
+end