Initial implementation of tutorial pages

src/coffee/models/item_page.coffee

@@ -22,7 +22,7 @@ module.exports = class ItemPage extends BaseModel
 
     compileDescription: ->
         return null unless @item?.description?
-        description = markdown.parse @item.description, 'Maruku'
+        description = _.parseMarkdown @item.description
         return description
 
     findComponentInItems: ->

src/coffee/models/mod.coffee

@@ -16,6 +16,7 @@ module.exports = class Mod extends BaseModel
 
     constructor: (attributes={}, options={})->
         if not attributes.slug? then throw new Error 'attributes.slug is required'
+
         attributes.author           ?= ''
         attributes.description      ?= ''
         attributes.documentationUrl ?= null
@@ -23,11 +24,13 @@ module.exports = class Mod extends BaseModel
         attributes.homePageUrl      ?= null
         attributes.modPack          ?= null
         attributes.name             ?= ''
+
         super attributes, options
 
         @_activeModVersion = null
         @_activeVersion    = null
         @_modVersions      = []
+        @_tutorials        = []
 
         Object.defineProperties this,
             'activeModVersion': { get:-> @_activeModVersion                    }
@@ -107,6 +110,31 @@ module.exports = class Mod extends BaseModel
 
     # Property Methods #############################################################################
 
+    getActiveVersion: ->
+        return @_activeVersion
+
+    setActiveVersion: (version)->
+        return if version is @_activeVersion
+
+        version ?= Mod.Version.None
+        if version is Mod.Version.Latest then version = _.last(@_modVersions).version
+
+        if version is Mod.Version.None
+            @_activeVersion = version
+            @_activateModVersion null
+
+            @trigger Event.change + ':activeVersion', this, @_activeVersion
+            @trigger Event.change, this
+        else
+            for modVersion in @_modVersions
+                if version is modVersion.version
+                    @_activateModVersion modVersion
+                    break
+
+            @_activeVersion = version
+            @trigger Event.change + ':activeVersion', this, @_activeVersion
+            @trigger Event.change, this
+
     addModVersion: (modVersion)->
         return unless modVersion?
         return if @_modVersions.indexOf(modVersion) isnt -1
@@ -136,30 +164,22 @@ module.exports = class Mod extends BaseModel
 
         return null
 
-    getActiveVersion: ->
-        return @_activeVersion
+    addTutorial: (tutorial)->
+        return unless tutorial?
+        if @getTutorial(tutorial.slug)? then throw new Error "duplicate tutorial: #{tutorial.name}"
+        @_tutorials.push tutorial
+        tutorial.modSlug = @slug
 
-    setActiveVersion: (version)->
-        return if version is @_activeVersion
+    getAllTutorials: ->
+        return @_tutorials[..]
 
-        version ?= Mod.Version.None
-        if version is Mod.Version.Latest then version = _.last(@_modVersions).version
+    getTutorial: (tutorialSlug)->
+        for tutorial in @_tutorials
+            return tutorial if tutorial.slug is tutorialSlug
+        return null
 
-        if version is Mod.Version.None
-            @_activeVersion = version
-            @_activateModVersion null
-
-            @trigger Event.change + ':activeVersion', this, @_activeVersion
-            @trigger Event.change, this
-        else
-            for modVersion in @_modVersions
-                if version is modVersion.version
-                    @_activateModVersion modVersion
-                    break
-
-            @_activeVersion = version
-            @trigger Event.change + ':activeVersion', this, @_activeVersion
-            @trigger Event.change, this
+    Object.defineProperties @prototype,
+        tutorials: { get:@prototype.getAllTutorials }
 
     # Backbone.View Overrides ######################################################################
 

src/coffee/models/parser_versions/mod_parser_v1.coffee

@@ -8,6 +8,7 @@ All rights reserved.
 CommandParserVersionBase = require './command_parser_version_base'
 Mod                      = require '../mod'
 ModVersion               = require '../mod_version'
+Tutorial                 = require '../tutorial'
 
 ########################################################################################################################
 
@@ -47,17 +48,23 @@ module.exports = class ModParserV1 extends CommandParserVersionBase
         if downloadUrl.length is 0 then throw new Error 'downloadUrl cannot be empty (omit it instead)'
         @_rawData.downloadUrl = downloadUrl
 
-    _command_name: (name)->
-        if @_rawData.name? then throw new Error 'duplicate declaration of "name"'
-        if name.length is 0 then throw new Error '"name" cannot be empty'
-        @_rawData.name = name
-
     _command_homePageUrl: (homePageUrl='')->
         if @_rawData.homePageUrl? then throw new Error 'duplicate declaration of "homePageUrl"'
         if homePageUrl.length is 0 then throw new Error 'homePageUrl cannot be empty'
 
         @_rawData.homePageUrl = homePageUrl
 
+    _command_name: (name)->
+        if @_rawData.name? then throw new Error 'duplicate declaration of "name"'
+        if name.length is 0 then throw new Error '"name" cannot be empty'
+        @_rawData.name = name
+
+    _command_tutorial: (nameParts...)->
+        name = nameParts.join(', ').trim()
+        if name.length is 0 then throw new Error '"name" cannot be empty'
+        @_rawData.tutorialNames ?= []
+        @_rawData.tutorialNames.push name
+
     _command_version: (version='')->
         if version.length is 0 then throw new Error 'version cannot be empty'
 
@@ -78,5 +85,9 @@ module.exports = class ModParserV1 extends CommandParserVersionBase
         model.name             = rawData.name
         model.homePageUrl      = rawData.homePageUrl
 
+        if rawData.tutorialNames?
+            for tutorialName in rawData.tutorialNames
+                model.addTutorial new Tutorial name:tutorialName
+
         for version in rawData.versions
             model.addModVersion new ModVersion modSlug:model.slug, version:version

src/coffee/models/parser_versions/tutorial_parser_v1.coffee

@@ -0,0 +1,65 @@
+###
+Crafting Guide - tutorial_parser_v1.coffee
+
+Copyright (c) 2014-2015 by Redwood Labs
+All rights reserved.
+###
+
+CommandParserVersionBase = require './command_parser_version_base'
+Tutorial                 = require '../tutorial'
+
+########################################################################################################################
+
+module.exports = class TutorialParserV1 extends CommandParserVersionBase
+
+    # CommandParserVersionBase Overrides ###########################################################
+
+    _buildModel: (rawData, model)->
+        @_buildTutorial rawData, model
+
+    _unparseModel: (builder, model)->
+        @_unparseTutorial builder, model
+
+    # Command Methods ##############################################################################
+
+    _command_content: (contentParts...)->
+        if not @_rawData.currentSection? then throw new Error 'cannot declare "title" before "section"'
+        if @_rawData.currentSection.content? then throw new Error 'duplicate declaration of content'
+        content = contentParts.join(', ').trim()
+        if not content.length > 0 then throw new Error 'content cannot be empty'
+
+        @_rawData.currentSection.content = content
+
+    _command_officialUrl: (officialUrl)->
+        if @_rawData.officialUrl? then throw new Error 'duplicate declaration of "officialUrl"'
+        if officialUrl.length is 0 then throw new Error 'officialUrl cannot be empty'
+        @_rawData.officialUrl = officialUrl
+
+    _command_section: (textParts...)->
+        @_rawData.sections ?= []
+        @_rawData.sections.push @_rawData.currentSection = {}
+
+    _command_title: (titleParts...)->
+        if not @_rawData.currentSection? then throw new Error 'cannot declare "title" before "section"'
+        if @_rawData.currentSection.title? then throw new Error 'duplicate declaration of title'
+        title = titleParts.join(', ').trim()
+        if not title.length > 0 then throw new Error 'title cannot be empty'
+
+        @_rawData.currentSection.title = title
+
+    _command_video: (youTubeId, nameParts...)->
+        if not youTubeId?.length then throw new Error 'video declaration requires a YouTubeID'
+        name = nameParts.join ', '
+        if not name?.length then throw new Error 'video declaration requires a name'
+
+        @_rawData.videos ?= []
+        @_rawData.videos.push youTubeId:youTubeId, name:name
+
+    # Object Building Methods ######################################################################
+
+    _buildTutorial: (rawData, model)->
+        if not rawData.sections? then throw new Error 'the "section" declaration is required'
+
+        model.officialUrl = rawData.officialUrl
+        model.videos      = rawData.videos
+        model.sections    = rawData.sections

src/coffee/models/tutorial.coffee

@@ -0,0 +1,35 @@
+###
+Crafting Guide - tutorial.coffee
+
+Copyright (c) 2015 by Redwood Labs
+All rights reserved.
+###
+
+BaseModel      = require './base_model'
+TutorialParser = require './tutorial_parser'
+{Url}          = require '../constants'
+
+########################################################################################################################
+
+module.exports = class Tutorial extends BaseModel
+
+    constructor: (attributes={}, options={})->
+        if not attributes.name?.length > 0 then throw new Error "attributes.name cannot be empty"
+        attributes.modSlug     ?= null
+        attributes.officialUrl ?= null
+        attributes.sections    ?= []
+        attributes.slug        ?= _.slugify attributes.name
+        attributes.videos      ?= []
+        super attributes, options
+
+    # Backbone.Model Overrides #####################################################################
+
+    parse: (text)->
+        TutorialParser = require './tutorial_parser' # to avoid require cycles
+        @_parser ?= new TutorialParser model:this
+        @_parser.parse text
+
+        return null # prevent calling `set`
+
+    url: ->
+        return Url.tutorialData modSlug:@modSlug, tutorialSlug:@slug

src/coffee/models/tutorial_parser.coffee

@@ -0,0 +1,19 @@
+###
+Crafting Guide - tutorial_parser.coffee
+
+Copyright (c) 2014-2015 by Redwood Labs
+All rights reserved.
+###
+
+VersionedParserBase = require './versioned_parser_base'
+TutorialParserV1    = require './parser_versions/tutorial_parser_v1'
+
+########################################################################################################################
+
+module.exports = class TutorialParser extends VersionedParserBase
+
+    # VersionedParserBase Overrides ################################################################
+
+    _createParsers: (options)->
+        return result =
+            '1': new TutorialParserV1 options