playgroundbook 0.3.0 → 0.4.0

data/spec/wrapper/markdown_wrapper_spec.rb

@@ -0,0 +1,33 @@
+require File.expand_path("../../spec_helper", __FILE__)
+
+module Playgroundbook
+  describe MarkdownWrapper do
+    let(:test_ui) { Cork::Board.new(silent: true) }
+
+    it "creates a swift file from a markdown file" do
+      source = "spec/fixtures/wrapper/source/swift_at_artsy_1.md"
+      destination = "spec/fixtures/wrapper/destination/swift_at_artsy_1.swift"
+      subject = MarkdownWrapper.new(source, "Swift at Artsy")
+      contents = File.read(source)
+      expect(subject.swap_code_context(contents)).to eq(File.read(destination))
+    end
+
+    it "creates a playground around the file" do
+      source = "spec/fixtures/wrapper/source/swift_at_artsy_1.md"
+
+      Dir.mktmpdir do |dir|
+        new_source = File.join(dir, File.basename(source))
+        FileUtils.cp(source, new_source)
+        subject = MarkdownWrapper.new(new_source, "Swift at Artsy")
+
+        subject.generate
+
+        playground = File.join(dir, "Swift at Artsy.playground")
+        expect(Dir.exist?(playground)).to eq(true)
+        expect(File.exist?(File.join(playground, "Contents.swift"))).to eq(true)
+        expect(File.exist?(File.join(playground, "timeline.xctimeline"))).to eq(true)
+        expect(File.exist?(File.join(playground, "contents.xcplayground"))).to eq(true)
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: playgroundbook
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Ash Furrow
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-07 00:00:00.000000000 Z
+date: 2016-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: plist
@@ -71,26 +71,27 @@ files:
 - README.md
 - Rakefile
 - bin/playgroundbook
+- lib/linter/abstract_linter.rb
+- lib/linter/chapter_linter.rb
+- lib/linter/chapter_manifest_linter.rb
+- lib/linter/contents_linter.rb
+- lib/linter/cutscene_page_linter.rb
+- lib/linter/cutscene_page_manifest_linter.rb
+- lib/linter/manifest_linter.rb
+- lib/linter/page_linter.rb
+- lib/linter/page_manifest_linter.rb
+- lib/linter/playgroundbook_lint.rb
+- lib/linter/root_manifest_linter.rb
 - lib/playgroundbook.rb
-- lib/playgroundbook_lint/abstract_linter.rb
-- lib/playgroundbook_lint/chapter_linter.rb
-- lib/playgroundbook_lint/chapter_manifest_linter.rb
-- lib/playgroundbook_lint/contents_linter.rb
-- lib/playgroundbook_lint/cutscene_page_linter.rb
-- lib/playgroundbook_lint/cutscene_page_manifest_linter.rb
-- lib/playgroundbook_lint/manifest_linter.rb
-- lib/playgroundbook_lint/page_linter.rb
-- lib/playgroundbook_lint/page_manifest_linter.rb
-- lib/playgroundbook_lint/playgroundbook_lint.rb
-- lib/playgroundbook_lint/root_manifest_linter.rb
-- lib/playgroundbook_renderer/chapter_collator.rb
-- lib/playgroundbook_renderer/contents_manifest_generator.rb
-- lib/playgroundbook_renderer/glossary_generator.rb
-- lib/playgroundbook_renderer/page_parser.rb
-- lib/playgroundbook_renderer/page_processor.rb
-- lib/playgroundbook_renderer/page_writer.rb
-- lib/playgroundbook_renderer/playgroundbook_renderer.rb
+- lib/renderer/chapter_collator.rb
+- lib/renderer/contents_manifest_generator.rb
+- lib/renderer/glossary_generator.rb
+- lib/renderer/page_parser.rb
+- lib/renderer/page_processor.rb
+- lib/renderer/page_writer.rb
+- lib/renderer/playgroundbook_renderer.rb
 - lib/version.rb
+- lib/wrapper/markdown_wrapper.rb
 - playground_book_lint.gemspec
 - spec/fixtures/Starter.playgroundbook/Contents/Chapters/Chapter1.playgroundchapter/Manifest.plist
 - spec/fixtures/Starter.playgroundbook/Contents/Chapters/Chapter1.playgroundchapter/Pages/Page1.playgroundpage/Contents.swift
@@ -102,23 +103,28 @@ files:
 - spec/fixtures/book.yml
 - spec/fixtures/test_chapter.playground/Contents.swift
 - spec/fixtures/test_chapter.playground/contents.xcplayground
-- spec/playground_book_lint/chapter_linter_spec.rb
-- spec/playground_book_lint/chapter_manifest_linter_spec.rb
-- spec/playground_book_lint/contents_linter_spec.rb
-- spec/playground_book_lint/cutscene_page_linter_spec.rb
-- spec/playground_book_lint/cutscene_page_manifest_linter_spec.rb
-- spec/playground_book_lint/manfiest_linter_spec.rb
-- spec/playground_book_lint/page_linter_spec.rb
-- spec/playground_book_lint/page_manifest_linter_spec.rb
-- spec/playground_book_lint/playgroundbook_lint_spec.rb
-- spec/playground_book_lint/root_manifest_linter_spec.rb
-- spec/playgroundbook_renderer_spec/chapter_collator_spec.rb
-- spec/playgroundbook_renderer_spec/contents_manfiest_generator_spec.rb
-- spec/playgroundbook_renderer_spec/glossary_generator_spec.rb
-- spec/playgroundbook_renderer_spec/page_processor_spec.rb
-- spec/playgroundbook_renderer_spec/page_writer_spec.rb
-- spec/playgroundbook_renderer_spec/playgroundbook_renderer_spec.rb
+- 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
@@ -139,7 +145,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Lints/renders Swift Playground books.

data/lib/playgroundbook_renderer/contents_manifest_generator.rb

@@ -1,35 +0,0 @@
-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/spec/playground_book_lint/cutscene_page_manifest_linter_spec.rb

@@ -1,63 +0,0 @@
-require File.expand_path('../../spec_helper', __FILE__)
-
-module Playgroundbook
-  describe CutscenePageManifestLinter do
-    include FakeFS::SpecHelpers
-    let(:cutscene_page_manifest_linter) { CutscenePageManifestLinter.new }
-
-    it 'given a valid manifest does not fail' do
-      FakeFS do
-        cutscene_reference = 'RealFile.html'
-        plist = {
-          'Name' => 'Test Page',
-          'CutsceneReference' => cutscene_reference
-        }.to_plist
-        File.open('Manifest.plist', 'w') { |f| f.write(plist) }
-        File.open(cutscene_reference, 'w')
-
-        expect { cutscene_page_manifest_linter.lint }.not_to raise_error
-      end
-    end
-
-    context 'given a cutscene path' do
-      it "fails if the key doesn't exist" do
-        FakeFS do
-          cutscene_reference = 'FakeFile.html'
-          plist = {
-            'Name' => 'Test Page',
-          }.to_plist
-          File.open('Manifest.plist', 'w') { |f| f.write(plist) }
-
-          expect { cutscene_page_manifest_linter.lint }.to raise_error(SystemExit)
-        end
-      end
-
-      it "fails if that file doesn't exist" do
-        FakeFS do
-          cutscene_reference = 'FakeFile.html'
-          plist = {
-            'Name' => 'Test Page',
-            'CutsceneReference' => cutscene_reference
-          }.to_plist
-          File.open('Manifest.plist', 'w') { |f| f.write(plist) }
-
-          expect { cutscene_page_manifest_linter.lint }.to raise_error(SystemExit)
-        end
-      end
-
-      it 'fails with a non-HTML file' do
-        FakeFS do
-          cutscene_reference = 'RealFile.xml'
-          plist = {
-            'Name' => 'Test Page',
-            'CutsceneReference' => cutscene_reference
-          }.to_plist
-          File.open('Manifest.plist', 'w') { |f| f.write(plist) }
-          File.open(cutscene_reference, 'w')
-
-          expect { cutscene_page_manifest_linter.lint }.to raise_error(SystemExit)
-        end
-      end
-    end
-  end
-end

data/spec/playground_book_lint/manfiest_linter_spec.rb

@@ -1,71 +0,0 @@
-require File.expand_path('../../spec_helper', __FILE__)
-
-module Playgroundbook
-  describe RootManifestLinter do
-    include FakeFS::SpecHelpers
-    let(:manifest_linter) { ManifestLinter.new }
-
-    it 'fails if a Manifest.plist file does not exist' do
-      expect { manifest_linter.lint }.to raise_error(SystemExit)
-    end
-
-    it 'fails if the Manifest.plist file does not contain a Name value' do
-      FakeFS do
-        plist = {}.to_plist
-        File.open('Manifest.plist', 'w') { |f| f.write(plist) }
-
-        expect { manifest_linter.lint }.to raise_error(SystemExit)
-      end
-    end
-
-    it 'succeeds if the Manifest.plist file is well-formed' do
-      FakeFS do
-        plist = { 'Name' => 'My Test Name' }.to_plist
-        File.open('Manifest.plist', 'w') { |f| f.write(plist) }
-
-        expect { manifest_linter.lint }.to_not raise_error
-      end
-    end
-
-    it 'extracts Manfiest.plist contents from pwd' do
-      FakeFS do
-        contents = { 'key' => 'value' }
-        File.open('Manifest.plist', 'w') { |f| f.write(contents.to_plist) }
-
-        expect(manifest_linter.manifest_plist_contents).to eq(contents)
-      end
-    end
-
-    describe 'key-value checking' do
-      before do
-      end
-
-      it 'checks for non-defined keys in manifest' do
-        FakeFS do
-          plist = {}.to_plist
-          File.open('Manifest.plist', 'w') { |f| f.write(plist) }
-
-          expect(manifest_linter.value_defined_in_manifest?('key')).to be_falsy
-        end
-      end
-
-      it 'checks for nil keys in manifest' do
-        FakeFS do
-          plist = { 'key' => nil }.to_plist
-          File.open('Manifest.plist', 'w') { |f| f.write(plist) }
-
-          expect(manifest_linter.value_defined_in_manifest?('key')).to be_falsy
-        end
-      end
-
-      it 'checks for empty keys in manifest' do
-        FakeFS do
-          plist = { 'key' => 'value' }.to_plist
-          File.open('Manifest.plist', 'w') { |f| f.write(plist) }
-
-          expect(manifest_linter.value_defined_in_manifest?('key')).to be_truthy
-        end
-      end
-    end
-  end
-end

data/spec/playground_book_lint/root_manifest_linter_spec.rb

@@ -1,35 +0,0 @@
-require File.expand_path('../../spec_helper', __FILE__)
-
-module Playgroundbook
-  describe RootManifestLinter do
-    include FakeFS::SpecHelpers
-    let(:root_manifest_linter) { RootManifestLinter.new(chapter_linter) }
-    let(:chapter_linter) { double(ChapterLinter) }
-
-    it 'fails if Chapters directory does not exist' do
-      expect { root_manifest_linter.lint }.to raise_error(SystemExit)
-    end
-
-    it 'fails if manfiest does not include Chapters' do
-      FakeFS do
-        Dir.mkdir('Chapters')
-        plist = { 'Name' => 'Test' }.to_plist
-        File.open('Manifest.plist', 'w') { |f| f.write(plist) }
-
-        expect { root_manifest_linter.lint }.to raise_error(SystemExit)
-      end
-    end
-
-    it 'calls through to lint each chapter' do
-      FakeFS do
-        plist = { 'Chapters' => ['test_chapter_name'], 'Name' => 'Test' }.to_plist
-        File.open('Manifest.plist', 'w') { |f| f.write(plist) }
-        Dir.mkdir('Chapters')
-
-        expect(chapter_linter).to receive(:lint).with('test_chapter_name')
-
-        expect { root_manifest_linter.lint }.to_not raise_error
-      end
-    end
-  end
-end

data/spec/playgroundbook_renderer_spec/chapter_collator_spec.rb

@@ -1,70 +0,0 @@
-require File.expand_path('../../spec_helper', __FILE__)
-
-module Playgroundbook
-  describe ChapterCollator do
-    include FakeFS::SpecHelpers
-    let(:collator) { ChapterCollator.new(page_writer, test_ui) }
-    let(:page_writer) { double(PageWriter) }
-    let(:test_ui) { Cork::Board.new(silent: true) }
-    let(:parsed_chapter) { PageParser.new.parse_chapter_pages(test_chapter_contents) }
-    let(:chapter_name) { 'test_chapter' }
-
-    before do
-      allow(page_writer).to receive(:write_page!)
-    end
-
-    it 'creates a chapter manifest' do
-      collator.collate!(chapter_name, parsed_chapter, [])
-
-      expect(File.exist?("#{chapter_name}.playgroundchapter/#{ManifestFileName}")).to be_truthy
-    end
-
-    context 'the chapter manifest' do
-      before do
-        collator.collate!(chapter_name, parsed_chapter, ['UIKit'])
-      end
-
-      it 'has the correct name' do
-        expect(get_manifest("#{chapter_name}.playgroundchapter/#{ManifestFileName}")['Name']).to eq(chapter_name)
-      end
-
-      it 'has the correct pages' do
-        expect(get_manifest("#{chapter_name}.playgroundchapter/#{ManifestFileName}")['Pages']).to eq([
-          'Page 1.playgroundpage', 
-          'Page 2.playgroundpage',
-        ])
-      end
-    end
-
-    it 'calls the page_writer for each page' do
-      expect(page_writer).to receive(:write_page!).with("Page 1", "Page 1.playgroundpage", [], "str = \"Yo, it's page 1.\"\nsharedFunc()")
-      expect(page_writer).to receive(:write_page!).with("Page 2", "Page 2.playgroundpage", [], "str = \"Page 2 awww yeah.\"\nsharedFunc()")
-
-      collator.collate!(chapter_name, parsed_chapter, [])
-    end
-
-    it 'does not explode if a Source directory already exists' do
-      expect{ collator.collate!(chapter_name, parsed_chapter, []) }.to_not raise_error
-    end
-    
-    context 'having colated' do
-      before do
-        collator.collate!(chapter_name, parsed_chapter, [])
-      end
-
-      it 'creates a Source directory if one does not exist' do
-        expect(Dir.exist?("#{chapter_name}.playgroundchapter/#{SharedSourcesDirectoryName}")).to be_truthy
-      end
-
-      context 'Sources folder' do
-        it 'has a Preamble.swift file' do
-          expect(File.exist?("#{chapter_name}.playgroundchapter/#{SharedSourcesDirectoryName}/#{PreambleFileName}")).to be_truthy
-        end
-
-        it 'has the correct preamble contents' do
-          expect(File.read("#{chapter_name}.playgroundchapter/#{SharedSourcesDirectoryName}/#{PreambleFileName}")).to eq("import UIKit\n\nvar str = \"Hello, playground\"\n\nfunc sharedFunc() {\n  print(\"This should be accessible to all pages.\")\n}")
-        end
-      end  
-    end
-  end
-end

data/spec/playgroundbook_renderer_spec/contents_manfiest_generator_spec.rb

@@ -1,41 +0,0 @@
-require File.expand_path('../../spec_helper', __FILE__)
-
-module Playgroundbook
-  describe ContentsManifestGenerator do
-    include FakeFS::SpecHelpers
-    let(:generator) { ContentsManifestGenerator.new(test_ui) }
-    let(:test_ui) { Cork::Board.new(silent: true) }
-
-    it 'creates the manifest file' do
-      generator.generate!(test_book_metadata)
-
-      expect(File.exist?('Manifest.plist')).to be_truthy
-    end
-
-    describe 'the manifest file' do
-      before do
-        generator.generate!(test_book_metadata)
-      end
-
-      it 'has a book name' do
-        expect(get_manifest['Name']).to eq('Testing Book')
-      end
-
-      it 'has an identifier' do
-        expect(get_manifest['ContentIdentifier']).to eq('com.ashfurrow.testing')
-      end
-
-      it 'has a deployment target' do
-        expect(get_manifest['DeploymentTarget']).to eq('ios10.0')
-      end
-
-      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