playgroundbook 0.6.0 → 1.0.0

data/spec/fixtures/wrapper/source/Swift-at-Artsy.playground/Contents.swift

@@ -1,199 +0,0 @@
-/*:
-(Note: a screen recording of a presentation of this material is [available on YouTube](https://github.com/artsy/Swift-at-Artsy/tree/master/Beginners/Lesson%20One).)
-
-Hey! So we're going to be looking at Swift from the perspective of learning programming. This means you get to ask awkward questions and I struggle to verbalise concepts that are the programming equivalent of muscle memory. It'll be fun!
-
-To start off we need to get to a point where we can write any code. We're going to assume that you already have a copy of Xcode 7 installed. With that, let's get started!
-
-Open Xcode and you'll get this Welcome dialogue. 
-
-![Xcode Welcome Screen](img/welcome.png)
-
-We'll be using _playgrounds_ to learn Swift. Click "Get started with a playground", give it a name, and make sure the platform is set to **OS X**. 
-
-![Creating a new playground](img/newplayground.png)
-
-Awesome. Xcode will create an open the playground for you. It'll look something like this. 
-
-![Empty Playground](img/emptyplayground.png)
-
-The large pane on the left is where we're going to write code. On the right is where the results of our code are displayed. You can see that there's already one line of code written for us, `var str = "Hello, playground"`, and the results pane says `"Hello, playground"`. Neat. 
-
-
-Normally for things I work with, the code we are writing gets transformed from something we, as humans, kind-of understand to something a machine understands via a compiler. Let's stick with the idea that it's basically a translator from human to machine. Normally its a big upfront conversion, for example Eigen can take 5 minutes to compile. 
-
-We're going to use Playgrounds, which is more like a back and forth conversation with the compiler, so it's much faster to write code and test things out. These are called REPLs.
-
-What this means is whatever you type will be run by Xcode and the results will be shown on the right. When Xcode is compiling code (whenever you change text), the top bar of the window will change to say "Running" and will show a little spinner. 
-
-Let's start by saying what _isn't_ code. You see the the first line, how it is greyed out? Well that's a comment. Comments are annotations in the code that are not ran by the compiler. We'll be using comments occasionally to skip bits of code, or to remind us what something is.
-
-OK let's write some code, let's try typing some things. 
-
-*/
-
-1 + 2
-
-1 / 2
-1.0 / 2.0
-
-"Hello, Artsy"
-/*:
-
-You can see the results in the results pane:
-
-![Results](img/results.png)
-
-In programming, we want to work with abstractions. So let's make our first variable. A variable holds a value that you can refer to later, you can name them (almost) whatever you want. 
-
-Variables are themselves an abstract concept, and it's normal for beginners to take time getting comfortable with them. In essence, a variable is a way to store something in a place that you can refer to later. There are a few good reasons to do this, but the most common one is that we need to refer to the same value more than once. 
-
-On an artist's Artsy page, we show their name more than once. It's useful to be able to store the artists name in a variable _once_ and then refer to that variable multiple times to show the user an artist's page.
-
-We're going to make a simple calculator with 3  variables. What I'd like to do is define a variable called `a` and `b` then add them together to make `c`. This is a simple example, but it's about foundations.
-
-*/
-
-var a = 2
-var b = 3
-
-var c = a + b
-/*:
-
-In this case, you can see that we're referring back to `a` and `b` as variables, instead of the numbers `2` and `3`. This is a simple example, and with more experience, you'll get more comfortable. 
-
-Variables all have a _type_. Some variables are numbers, and some are strings, and some are other things, too! Numbers are often `Int`, or an integer (basically a round number: 1, 2, 3, -500, 401). Swift is a **strongly-typed language**, which means that types matter a lot. Swift won't let you confuse one type for another. Even though we haven't _told_ Swift what the type of our variables are, the compiler figures it out automatically. 
-
-In Swift, `:` specifies a type. So the following two lines are equivalent.
-
-*/
-
-var myString = "Hello, Artsy"
-var myString: String = "Hello, Artsy"
-/*:
-
-In this case we're dealing with a collection of letters, that combined, we call a string. This is common terminology in most programming languages, think of it as a string of letters.
-
-*/
-
-var myString: String = 1
-/*:
-
-Swift will complain and say that `'Int' is not convertible to 'String'`. This is Swift's compile-time type checking. It prevents bugs from happening in apps at runtime by giving you errors before-hand. Swift's primary goal is safety against crashes in apps. 
-
-When we're writing code, very often we want to print out some useful information for someone to read. We're going to use this to show that some of our code is running. So lets add a print statement saying what the value of `c` is:
-
-*/
-
-print(c)
-/*: 
-
-With `print` working, we can start doing some logic. We want to start checking how big our `c` is, and just like in English, we'll use an `if` statement:
-
-*/
-
-if c > 6 {
-    print("Pretty big c you got there.")
-}
-/*:
-
-Let's unpack what we're seeing here. `if [something]` - what's happening here is that the bit after the `if` is checking to see if `c` is greater than the number (`Int`) `6`. If it is, then it will run the code inside the braces. 
-
-`if` statements are fundamentally about doing some code only under certain circumstances. For example, Artsy only shows the "Inquire on Artwork" button **if** that artwork can be inquired upon. There are lots of different places in our code where it's useful to do something only if a condition is met.
-
-It is common to use a left margin / indentation to indicate that something is inside a braced section. It's not enforced though.
-
-*/
-
-if c > 6 {
-            print("Pretty big c you got there.")
-}
-/*:
-
-*/
-
-if c > 6 { 
-print("Pretty big c you got there.") 
-}
-/*:
-
-*/
-
-if c > 6 { print("Pretty big c you got there.") }
-/*:
-
-We've got one more thing to go over, and that is loops. Loops repeat a section of code. Computers are really good at doing the same thing over and over, and loops are how programmers tell computers to do that. Repeating code is really useful in the Artsy's artwork pages, specifically in the related artworks section. As programmers, we tell the computer how to add _one_ artwork to the page, and then tell the computer to do that over and over for all the related artworks.
-
-Let's make a nice simple loop, one that reads like English. For _a_ number in _zero to c_. 
-
-*/
-
-for number in 0...c {
-    print("hi")
-}
-/*:
-
-It has the same behavior that we saw in the `if` example. It will run the thing inside the braces as many times as the value of `c`. Each time it will print out `"hi"`. I think we can expand on this one little bit. The word `number` here is actually a variable, let's make it sound all mathematical and call it `x` instead.
-
-*/
-
-for x in 0...c {
-    print("hi")
-}
-/*:
-
-Now we know it's a variable, lets print it!
-
-*/
-
-for x in 0...c {
-    print(x)
-}
-/*:
-
-For loops, often just called "loops", are foundational to programming. In this example above, we've looped over all the numbers from `0` to `c`, but you can loop over other things, too. Say we're making an app at Artsy that shows a bunch of artworks – we might loop over all the artworks to show them on the screen. 
-
-If you hit the little triangle in the bottom left you can see the printed output!
-
-----------------
-
-So let's recap.
-
-* We've learned a little bit about variables, they are named values that make it easier for us to think about what something represents vs what it is.
-
-* Then we looked at some `String`s, and showed that you can't change something from a string to a number once you've start using it as a `String`,
-
-* We then printed some information.
-
-* After that we looked at adding an `if` statement to add some logic to our code.
-
-* Finally we wrapped up with a `for in` loop.
-
-If you're keen, feel free to keep playing in the playground. Try changing things in the loops to see what happens. Is it what you expected to happen? Why or why not?
-
-What do you think this code would do?
-
-*/
-
-for number in 0...15 {
-	if number > 5 {
-		print("This is greater than five")
-	}
-}
-/*:
-
-What about this?
-
-*/
-
-for number in 0...15 {
-	if number > 5 {
-		print("This is greater than five")
-	} else {
-		print("This is less than five")
-	}
-}
-/*:
-
-You can also look at the free Stanford Swift Course: https://www.youtube.com/playlist?list=PLxwBNxx9j4PW4sY-wwBwQos3G6Kn3x6xP
-*/

data/spec/fixtures/wrapper/source/Swift-at-Artsy.playground/contents.xcplayground

@@ -1,4 +0,0 @@
-<?xml version='1.0' encoding='UTF-8' standalone='yes'?>
-<playground version='5.0' target-platform='osx' display-mode='rendered'>
-    <timeline fileName='timeline.xctimeline'/>
-</playground>

data/spec/fixtures/wrapper/source/swift_at_artsy_1.md

@@ -1,183 +0,0 @@
-(Note: a screen recording of a presentation of this material is [available on YouTube](https://github.com/artsy/Swift-at-Artsy/tree/master/Beginners/Lesson%20One).)
-
-Hey! So we're going to be looking at Swift from the perspective of learning programming. This means you get to ask awkward questions and I struggle to verbalise concepts that are the programming equivalent of muscle memory. It'll be fun!
-
-To start off we need to get to a point where we can write any code. We're going to assume that you already have a copy of Xcode 7 installed. With that, let's get started!
-
-Open Xcode and you'll get this Welcome dialogue. 
-
-![Xcode Welcome Screen](img/welcome.png)
-
-We'll be using _playgrounds_ to learn Swift. Click "Get started with a playground", give it a name, and make sure the platform is set to **OS X**. 
-
-![Creating a new playground](img/newplayground.png)
-
-Awesome. Xcode will create an open the playground for you. It'll look something like this. 
-
-![Empty Playground](img/emptyplayground.png)
-
-The large pane on the left is where we're going to write code. On the right is where the results of our code are displayed. You can see that there's already one line of code written for us, `var str = "Hello, playground"`, and the results pane says `"Hello, playground"`. Neat. 
-
-
-Normally for things I work with, the code we are writing gets transformed from something we, as humans, kind-of understand to something a machine understands via a compiler. Let's stick with the idea that it's basically a translator from human to machine. Normally its a big upfront conversion, for example Eigen can take 5 minutes to compile. 
-
-We're going to use Playgrounds, which is more like a back and forth conversation with the compiler, so it's much faster to write code and test things out. These are called REPLs.
-
-What this means is whatever you type will be run by Xcode and the results will be shown on the right. When Xcode is compiling code (whenever you change text), the top bar of the window will change to say "Running" and will show a little spinner. 
-
-Let's start by saying what _isn't_ code. You see the the first line, how it is greyed out? Well that's a comment. Comments are annotations in the code that are not ran by the compiler. We'll be using comments occasionally to skip bits of code, or to remind us what something is.
-
-OK let's write some code, let's try typing some things. 
-
-```swift
-1 + 2
-
-1 / 2
-1.0 / 2.0
-
-"Hello, Artsy"
-```
-
-You can see the results in the results pane:
-
-![Results](img/results.png)
-
-In programming, we want to work with abstractions. So let's make our first variable. A variable holds a value that you can refer to later, you can name them (almost) whatever you want. 
-
-Variables are themselves an abstract concept, and it's normal for beginners to take time getting comfortable with them. In essence, a variable is a way to store something in a place that you can refer to later. There are a few good reasons to do this, but the most common one is that we need to refer to the same value more than once. 
-
-On an artist's Artsy page, we show their name more than once. It's useful to be able to store the artists name in a variable _once_ and then refer to that variable multiple times to show the user an artist's page.
-
-We're going to make a simple calculator with 3  variables. What I'd like to do is define a variable called `a` and `b` then add them together to make `c`. This is a simple example, but it's about foundations.
-
-```swift
-var a = 2
-var b = 3
-
-var c = a + b
-```
-
-In this case, you can see that we're referring back to `a` and `b` as variables, instead of the numbers `2` and `3`. This is a simple example, and with more experience, you'll get more comfortable. 
-
-Variables all have a _type_. Some variables are numbers, and some are strings, and some are other things, too! Numbers are often `Int`, or an integer (basically a round number: 1, 2, 3, -500, 401). Swift is a **strongly-typed language**, which means that types matter a lot. Swift won't let you confuse one type for another. Even though we haven't _told_ Swift what the type of our variables are, the compiler figures it out automatically. 
-
-In Swift, `:` specifies a type. So the following two lines are equivalent.
-
-```swift
-var myString = "Hello, Artsy"
-var myString: String = "Hello, Artsy"
-```
-
-In this case we're dealing with a collection of letters, that combined, we call a string. This is common terminology in most programming languages, think of it as a string of letters.
-
-```swift
-var myString: String = 1
-```
-
-Swift will complain and say that `'Int' is not convertible to 'String'`. This is Swift's compile-time type checking. It prevents bugs from happening in apps at runtime by giving you errors before-hand. Swift's primary goal is safety against crashes in apps. 
-
-When we're writing code, very often we want to print out some useful information for someone to read. We're going to use this to show that some of our code is running. So lets add a print statement saying what the value of `c` is:
-
-```swift
-print(c)
-``` 
-
-With `print` working, we can start doing some logic. We want to start checking how big our `c` is, and just like in English, we'll use an `if` statement:
-
-```swift
-if c > 6 {
-    print("Pretty big c you got there.")
-}
-```
-
-Let's unpack what we're seeing here. `if [something]` - what's happening here is that the bit after the `if` is checking to see if `c` is greater than the number (`Int`) `6`. If it is, then it will run the code inside the braces. 
-
-`if` statements are fundamentally about doing some code only under certain circumstances. For example, Artsy only shows the "Inquire on Artwork" button **if** that artwork can be inquired upon. There are lots of different places in our code where it's useful to do something only if a condition is met.
-
-It is common to use a left margin / indentation to indicate that something is inside a braced section. It's not enforced though.
-
-```swift
-if c > 6 {
-            print("Pretty big c you got there.")
-}
-```
-
-```swift
-if c > 6 { 
-print("Pretty big c you got there.") 
-}
-```
-
-```swift
-if c > 6 { print("Pretty big c you got there.") }
-```
-
-We've got one more thing to go over, and that is loops. Loops repeat a section of code. Computers are really good at doing the same thing over and over, and loops are how programmers tell computers to do that. Repeating code is really useful in the Artsy's artwork pages, specifically in the related artworks section. As programmers, we tell the computer how to add _one_ artwork to the page, and then tell the computer to do that over and over for all the related artworks.
-
-Let's make a nice simple loop, one that reads like English. For _a_ number in _zero to c_. 
-
-```swift
-for number in 0...c {
-    print("hi")
-}
-```
-
-It has the same behavior that we saw in the `if` example. It will run the thing inside the braces as many times as the value of `c`. Each time it will print out `"hi"`. I think we can expand on this one little bit. The word `number` here is actually a variable, let's make it sound all mathematical and call it `x` instead.
-
-```swift
-for x in 0...c {
-    print("hi")
-}
-```
-
-Now we know it's a variable, lets print it!
-
-```swift
-for x in 0...c {
-    print(x)
-}
-```
-
-For loops, often just called "loops", are foundational to programming. In this example above, we've looped over all the numbers from `0` to `c`, but you can loop over other things, too. Say we're making an app at Artsy that shows a bunch of artworks – we might loop over all the artworks to show them on the screen. 
-
-If you hit the little triangle in the bottom left you can see the printed output!
-
-----------------
-
-So let's recap.
-
-* We've learned a little bit about variables, they are named values that make it easier for us to think about what something represents vs what it is.
-
-* Then we looked at some `String`s, and showed that you can't change something from a string to a number once you've start using it as a `String`,
-
-* We then printed some information.
-
-* After that we looked at adding an `if` statement to add some logic to our code.
-
-* Finally we wrapped up with a `for in` loop.
-
-If you're keen, feel free to keep playing in the playground. Try changing things in the loops to see what happens. Is it what you expected to happen? Why or why not?
-
-What do you think this code would do?
-
-```swift
-for number in 0...15 {
-	if number > 5 {
-		print("This is greater than five")
-	}
-}
-```
-
-What about this?
-
-```swift
-for number in 0...15 {
-	if number > 5 {
-		print("This is greater than five")
-	} else {
-		print("This is less than five")
-	}
-}
-```
-
-You can also look at the free Stanford Swift Course: https://www.youtube.com/playlist?list=PLxwBNxx9j4PW4sY-wwBwQos3G6Kn3x6xP

data/spec/linter/chapter_linter_spec.rb

@@ -1,30 +0,0 @@
-require File.expand_path("../../spec_helper", __FILE__)
-
-module Playgroundbook
-  describe RootManifestLinter do
-    include FakeFS::SpecHelpers
-    let(:chapter_linter) { ChapterLinter.new(chapter_manifest_linter) }
-    let(:chapter_manifest_linter) { double(ChapterManifestLinter) }
-    let(:chapter_directory_name) { "test_chapter" }
-
-    it "fails when chapter directory does not exist" do
-      expect { chapter_linter.lint(chapter_directory_name) }.to raise_error(SystemExit)
-    end
-
-    it "fails when Pages subdirectory of chapter dir does not exist" do
-      FakeFS do
-        Dir.mkdir(chapter_directory_name)
-        expect { chapter_linter.lint(chapter_directory_name) }.to raise_error(SystemExit)
-      end
-    end
-
-    it "calls through to chapter manifest linter" do
-      FakeFS do
-        expect(chapter_manifest_linter).to receive(:lint)
-        FileUtils.mkdir_p("#{chapter_directory_name}/Pages")
-
-        expect { chapter_linter.lint(chapter_directory_name) }.to_not raise_error
-      end
-    end
-  end
-end

data/spec/linter/chapter_manifest_linter_spec.rb

@@ -1,40 +0,0 @@
-require File.expand_path("../../spec_helper", __FILE__)
-
-module Playgroundbook
-  describe ChapterManifestLinter do
-    include FakeFS::SpecHelpers
-    let(:chapter_manifest_linter) { ChapterManifestLinter.new(page_linter) }
-    let(:page_linter) { double(PageLinter) }
-    let(:page_directory_name) { "test.playgroundpage" }
-
-    it "fails if no Pages defined in Manifest" do
-      FakeFS do
-        plist = { "Name" => "Test" }.to_plist
-        File.open("Manifest.plist", "w") { |f| f.write(plist) }
-
-        expect { chapter_manifest_linter.lint }.to raise_error(SystemExit)
-      end
-    end
-
-    it "fails if Pages dir specified in Manifest does not exist" do
-      FakeFS do
-        plist = { "Name" => "Test", "Pages" => [page_directory_name] }.to_plist
-        File.open("Manifest.plist", "w") { |f| f.write(plist) }
-        Dir.mkdir("Pages")
-
-        expect { chapter_manifest_linter.lint }.to raise_error(SystemExit)
-      end
-    end
-
-    it "calls through to page linter" do
-      FakeFS do
-        expect(page_linter).to receive(:lint)
-        plist = { "Name" => "Test", "Pages" => [page_directory_name] }.to_plist
-        File.open("Manifest.plist", "w") { |f| f.write(plist) }
-        FileUtils.mkdir_p("Pages/#{page_directory_name}")
-
-        expect { chapter_manifest_linter.lint }.to_not raise_error
-      end
-    end
-  end
-end