Initial website structure (#19)

* Update gitignore

* Initial template site

* Set travis jobs

* Fix compilation issues in docs

* Fix rendering issue

* Fix Travis commands

* Add correct path to main documentation page

* Remove nef images

Co-authored-by: Tomás Ruiz-López <truizlop@gmail.com>

Author: calvellido

.gitignore

@@ -37,3 +37,15 @@ Podfile.lock
 
 ## nef
 **/*/nef
+
+## Jekyll
+_site
+.sass-cache
+.jekyll-metadata
+
+## Ruby environment normalization:
+.bundle/
+vendor/
+/lib/bundler/man/
+docs/docs/*
+/docs/_data/sidebar.yml

.travis.yml

@@ -6,6 +6,9 @@ addons:
   homebrew:
     taps:
       - adoptopenjdk/openjdk
+      - bow-swift/nef
+    packages:
+      - nef
     casks:
       - adoptopenjdk/openjdk/adoptopenjdk8
 
@@ -14,6 +17,9 @@ env:
     - PROJECT="BowOpenAPI.xcodeproj"
     - JOB="XCODE"
     - DEST="platform=macOS,arch=x86_64"
+    - SCHEME="Markup"
+    - SDK="macosx"
+    - ACTION="test"
 
 jobs:
   include:
@@ -31,3 +37,22 @@ jobs:
       script:
         - set -o pipefail
         - xcodebuild test -project "$PROJECT" -scheme "Tests" -destination "$DEST" | xcpretty -c
+    - stage: verify documentation
+      before_install:
+        - gem update --system
+        - gem install cocoapods
+      script:
+        - nef compile Documentation.app
+    - stage: deploy microsite
+      if: branch = master AND type != pull_request
+      script:
+        - nef jekyll --project Documentation.app --output docs --main-page Documentation.app/Jekyll/Home.md
+      deploy:
+        provider: pages
+        skip-cleanup: true
+        github-token: $GITHUB_TOKEN
+        keep-history: true
+        local-dir: docs
+        target-branch: gh-pages
+        on:
+          all_branches: true

Documentation.app/Contents/MacOS/Consuming generated code.playground/Pages/Customizing the configuration.xcplaygroundpage/Contents.swift

@@ -9,9 +9,9 @@ import Bow
 import BowEffects
 import Foundation
 
-public enum DecodingError: Error {}
+enum DecodingError: Error {}
 
-public protocol ResponseDecoder {
+protocol ResponseDecoder {
     func safeDecode<T: Decodable>(_ type: T.Type, from: Data) -> IO<DecodingError, T>
 }
 
@@ -40,14 +40,22 @@ enum API {
             self.session = session
             self.decoder = decoder
         }
+        
+        static func ==(lhs: Config, rhs: Config) -> Bool {
+            lhs.basePath == rhs.basePath && lhs.headers == rhs.headers
+        }
+    }
+    
+    enum ContentType {
+        case json
     }
 }
 
 extension API.Config {
     func appending(headers: [String: String]) -> API.Config { self }
     func appending(contentType: API.ContentType) -> API.Config { self }
     func appendingHeader(value: String, forKey key: String) -> API.Config { self }
-    func appendingHeader(token: String) -> API.Config { self }
+    func appendingHeader(token: String) -> API.Config { self }
 }
 // nef:end
 /*:

Documentation.app/Contents/MacOS/Consuming generated code.playground/Pages/Running a network request.xcplaygroundpage/Contents.swift

@@ -38,16 +38,16 @@ protocol CustomerAPI {
 // nef:begin:hidden
 struct CustomerAPIClient: CustomerAPI {
     func getCustomers() -> EnvIO<API.Config, API.HTTPError, Customers> {
-        EnvIO { _ in
+        EnvIO { _ in
             IO.invoke {
-                [ Customer(id: 1, name: "Tomás") ]
+                [ Customer(identifier: 1, name: "Tomás") ]
             }
         }
     }
 }
 
 extension API {
-    var customer: CustomerAPI {
+    static var customer: CustomerAPI {
         CustomerAPIClient()
     }
 }
@@ -76,9 +76,14 @@ let either: Either<API.HTTPError, Customers> =
 
 // Asynchronous run
 customersRequest.provide(config).unsafeRunAsync { either in
-    either.fold({ httpError in /* ... */ },
-                { customers in /* ... */ })
+    either.fold({ httpError in
+                    // ...
+                },
+                { customers in
+                    // ...
+                })
 }
 
+
 // Changing queue
-let customers: Customers? = try? customersRequest.provide(config).unsafeRunSync(on: .background)
+try? customersRequest.provide(config).unsafeRunSync(on: .global(qos: .background))

Documentation.app/Contents/MacOS/Consuming generated code.playground/Pages/Testing your network calls.xcplaygroundpage/Contents.swift

@@ -21,7 +21,7 @@ enum API {
         }
     }
 
-    enum HTTPError {}
+    enum HTTPError: Error {}
 }
 
 struct Customer: Codable, Equatable {
@@ -42,7 +42,7 @@ struct CustomerAPIClient: CustomerAPI {
 }
 
 extension API {
-    var customer: CustomerAPI {
+    static var customer: CustomerAPI {
         CustomerAPIClient()
     }
 }

docs/CNAME

@@ -0,0 +1 @@
+openapi.bow-swift.io

docs/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gem "jekyll", ">= 3.7.4"

docs/Gemfile.lock

@@ -0,0 +1,63 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.6.0)
+      public_suffix (>= 2.0.2, < 4.0)
+    colorator (1.1.0)
+    concurrent-ruby (1.1.5)
+    em-websocket (0.5.1)
+      eventmachine (>= 0.12.9)
+      http_parser.rb (~> 0.6.0)
+    eventmachine (1.2.7)
+    ffi (1.10.0)
+    forwardable-extended (2.6.0)
+    http_parser.rb (0.6.0)
+    i18n (0.9.5)
+      concurrent-ruby (~> 1.0)
+    jekyll (3.8.5)
+      addressable (~> 2.4)
+      colorator (~> 1.0)
+      em-websocket (~> 0.5)
+      i18n (~> 0.7)
+      jekyll-sass-converter (~> 1.0)
+      jekyll-watch (~> 2.0)
+      kramdown (~> 1.14)
+      liquid (~> 4.0)
+      mercenary (~> 0.3.3)
+      pathutil (~> 0.9)
+      rouge (>= 1.7, < 4)
+      safe_yaml (~> 1.0)
+    jekyll-sass-converter (1.5.2)
+      sass (~> 3.4)
+    jekyll-watch (2.2.1)
+      listen (~> 3.0)
+    kramdown (1.17.0)
+    liquid (4.0.3)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    mercenary (0.3.6)
+    pathutil (0.16.2)
+      forwardable-extended (~> 2.6)
+    public_suffix (3.0.3)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.10.0)
+      ffi (~> 1.0)
+    rouge (3.3.0)
+    ruby_dep (1.5.0)
+    safe_yaml (1.0.5)
+    sass (3.7.4)
+      sass-listen (~> 4.0.0)
+    sass-listen (4.0.0)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jekyll (>= 3.7.4)
+
+BUNDLED WITH
+   2.1.1

docs/_config.yml

@@ -0,0 +1,20 @@
+title: Bow-OpenAPI
+#-------------------------
+name: Bow-OpenAPI
+#-------------------------
+description: A command-line tool to generate a Swift network client from an OpenAPI / Swagger specification file. Please, refer to the project website for extensive and detailed documentation about the project.
+#-------------------------
+author: 47 Degrees
+keywords: functional-programming, monads, monad-transformers, functional-data-structure, swift, bow, xcode, xcode-playgrounds, playgrounds, fp-types, adt, free-monads, tagless-final, mtl, for-comprehension, category-theory
+#-------------------------
+url: https://openapi.bow-swift.io
+#-------------------------
+markdown: kramdown
+sass:
+    sass_dir: _sass
+    style: compressed
+#-------------------------
+permalink: pretty
+#-------------------------
+exclude: ['config.ru', 'Gemfile', 'Gemfile.lock', 'vendor', 'Procfile', 'Rakefile']
+#-------------------------

docs/_data/features.yml

@@ -0,0 +1,16 @@
+content:
+    - title: Verification
+      description: Eases the creation of Xcode Playgrounds with support for third party libraries.
+      icon: img/main-image-primary.svg
+
+    - title: Compile
+      description: Compiles Xcode Playgrounds with support for third party libraries from the command line.
+      icon: img/main-image-secondary.svg
+
+    - title: Generation
+      description: Generates Markdown project from Xcode Playground.
+      icon: img/main-image-tertiary.svg
+
+    - title: Integration
+      description: Integrates Xcode Playgrounds with Carbon to export code snippets and Jekyll to create a microsite.
+      icon: img/main-image-quaternary.svg