strip \r (if present) before final \n

Merge pull request #4329 from shreeve/strip-cr-if-present
strip \r (if present) before final \n
strip \r (if present) before final \n
jashkenas · shreeve · lydell · alangpierce · alangpierce · alangpierce
diff --git a/.nojekyll b/.nojekyll
diff --git a/Cakefile b/Cakefile
@@ -1,9 +1,9 @@
-fs            = require 'fs'
-path          = require 'path'
-_             = require 'underscore'
-CoffeeScript  = require './lib/coffee-script'
-{spawn, exec} = require 'child_process'
-helpers       = require './lib/coffee-script/helpers'
+fs                        = require 'fs'
+path                      = require 'path'
+_                         = require 'underscore'
+{ spawn, exec, execSync } = require 'child_process'
+CoffeeScript              = require './lib/coffee-script'
+helpers                   = require './lib/coffee-script/helpers'
 
 # ANSI Terminal Colors.
 bold = red = green = reset = ''
@@ -24,6 +24,9 @@ header = """
    */
 """
 
+# Used in folder names like docs/v1
+majorVersion = CoffeeScript.VERSION.split('.')[0]
+
 # Build the CoffeeScript language from source.
 build = (cb) ->
   files = fs.readdirSync 'src'
@@ -35,76 +38,23 @@ run = (args, cb) ->
   proc =         spawn 'node', ['bin/coffee'].concat(args)
   proc.stderr.on 'data', (buffer) -> console.log buffer.toString()
   proc.on        'exit', (status) ->
-    process.exit(1) if status != 0
+    process.exit(1) if status isnt 0
     cb() if typeof cb is 'function'
 
 # Log a message with a color.
 log = (message, color, explanation) ->
   console.log color + message + reset + ' ' + (explanation or '')
 
-codeFor = ->
-  counter = 0
-  hljs = require 'highlight.js'
-  hljs.configure classPrefix: ''
-  (file, executable = false, showLoad = true) ->
-    counter++
-    return unless fs.existsSync "documentation/js/#{file}.js"
-    cs = fs.readFileSync "documentation/coffee/#{file}.coffee", 'utf-8'
-    js = fs.readFileSync "documentation/js/#{file}.js", 'utf-8'
-    js = js.replace /^\/\/ generated.*?\n/i, ''
-
-    cshtml = "<pre><code>#{hljs.highlight('coffeescript', cs).value}</code></pre>"
-    # Temporary fix until highlight.js adds support for newer CoffeeScript reserved words
-    if file is 'modules'
-      cshtml = cshtml.replace /(import|export|from|as|default) /g, '<span class="reserved">$1</span> '
-    jshtml = "<pre><code>#{hljs.highlight('javascript', js).value}</code></pre>"
-    append = if executable is yes then '' else "alert(#{executable});"
-    if executable and executable != yes
-      cs.replace /(\S)\s*\Z/m, "$1\n\nalert #{executable}"
-    run    = if executable is true then 'run' else "run: #{executable}"
-    name   = "example#{counter}"
-    script = "<script>window.#{name} = #{JSON.stringify cs}</script>"
-    load   = if showLoad then "<div class='minibutton load' onclick='javascript: loadConsole(#{name});'>load</div>" else ''
-    button = if executable then "<div class='minibutton ok' onclick='javascript: #{js};#{append}'>#{run}</div>" else ''
-    "<div class='code'>#{cshtml}#{jshtml}#{script}#{load}#{button}<br class='clear' /></div>"
-
-monthNames = [
-  'January'
-  'February'
-  'March'
-  'April'
-  'May'
-  'June'
-  'July'
-  'August'
-  'September'
-  'October'
-  'November'
-  'December'
-]
-
-formatDate = (date) ->
-  date.replace /^(\d\d\d\d)-(\d\d)-(\d\d)$/, (match, $1, $2, $3) ->
-    "#{monthNames[$2 - 1]} #{+$3}, #{$1}"
-
-releaseHeader = (date, version, prevVersion) -> """
-  <div class="anchor" id="#{version}"></div>
-  <b class="header">
-    #{prevVersion and "<a href=\"https://github.com/jashkenas/coffeescript/compare/#{prevVersion}...#{version}\">#{version}</a>" or version}
-    <span class="timestamp"> &mdash; <time datetime="#{date}">#{formatDate date}</time></span>
-  </b>
-"""
-
 option '-p', '--prefix [DIR]', 'set the installation prefix for `cake install`'
 
 task 'install', 'install CoffeeScript into /usr/local (or --prefix)', (options) ->
   base = options.prefix or '/usr/local'
   lib  = "#{base}/lib/coffee-script"
   bin  = "#{base}/bin"
   node = "~/.node_libraries/coffee-script"
-  console.log   "Installing CoffeeScript to #{lib}"
-  console.log   "Linking to #{node}"
-  console.log   "Linking 'coffee' to #{bin}/coffee"
+  console.log "Installing CoffeeScript to #{lib}"
+  console.log "Linking to #{node}"
+  console.log "Linking 'coffee' to #{bin}/coffee"
   exec([
     "mkdir -p #{lib} #{bin}"
     "cp -rf bin lib LICENSE README.md package.json src #{lib}"
@@ -133,10 +83,11 @@ task 'build:full', 'rebuild the source twice, and run the tests', ->
 
 
 task 'build:parser', 'rebuild the Jison parser (run build first)', ->
-  helpers.extend global, require('util')
+  helpers.extend global, require 'util'
   require 'jison'
   parser = require('./lib/coffee-script/grammar').parser
-  fs.writeFile 'lib/coffee-script/parser.js', parser.generate()
+  fs.writeFileSync 'lib/coffee-script/parser.js', parser.generate()
+
 
 task 'build:browser', 'rebuild the merged script for inclusion in the browser', ->
   code = ''
@@ -164,37 +115,139 @@ task 'build:browser', 'rebuild the merged script for inclusion in the browser',
     }(this));
   """
   unless process.env.MINIFY is 'false'
-    {code} = require('uglify-js').minify code, fromString: true
-  fs.writeFileSync 'extras/coffee-script.js', header + '\n' + code
+    {compiledCode} = require('google-closure-compiler-js').compile
+      jsCode: [
+        src: code
+        languageOut: if majorVersion is 1 then 'ES5' else 'ES6'
+      ]
+  outputFolder = "docs/v#{majorVersion}/browser-compiler"
+  fs.mkdirSync outputFolder unless fs.existsSync outputFolder
+  fs.writeFileSync "#{outputFolder}/coffee-script.js", header + '\n' + compiledCode
   console.log "built ... running browser tests:"
   invoke 'test:browser'
 
 
 task 'doc:site', 'watch and continually rebuild the documentation for the website', ->
-  source = 'documentation/index.html.js'
-  exec 'bin/coffee -bc -o documentation/js documentation/coffee/*.coffee'
+  # Helpers
+  codeFor = ->
+    counter = 0
+    hljs = require 'highlight.js'
+    hljs.configure classPrefix: ''
+    (file, executable = false, showLoad = true) ->
+      counter++
+      return unless fs.existsSync "docs/v#{majorVersion}/examples/#{file}.js"
+      cs = fs.readFileSync "documentation/examples/#{file}.coffee", 'utf-8'
+      js = fs.readFileSync "docs/v#{majorVersion}/examples/#{file}.js", 'utf-8'
+      js = js.replace /^\/\/ generated.*?\n/i, ''
+
+      cshtml = "<pre><code>#{hljs.highlight('coffeescript', cs).value}</code></pre>"
+      # Temporary fix until highlight.js adds support for newer CoffeeScript keywords
+      # Added in https://github.com/isagalaev/highlight.js/pull/1357, awaiting release
+      if file in ['generator_iteration', 'generators', 'modules']
+        cshtml = cshtml.replace /(yield|import|export|from|as|default) /g, '<span class="keyword">$1</span> '
+      jshtml = "<pre><code>#{hljs.highlight('javascript', js).value}</code></pre>"
+      append = if executable is yes then '' else "alert(#{executable});".replace /"/g, '&quot;'
+      if executable and executable isnt yes
+        cs.replace /(\S)\s*\Z/m, "$1\n\nalert #{executable}"
+      run    = if executable is true then 'run' else "run: #{executable}"
+      name   = "example#{counter}"
+      script = "<script>window.#{name} = #{JSON.stringify cs}</script>"
+      load   = if showLoad then "<div class='minibutton load' onclick='javascript: loadConsole(#{name});'>load</div>" else ''
+      button = if executable then """<div class="minibutton ok" onclick="javascript: #{js.replace /"/g, '&quot;'};#{append}">#{run}</div>""" else ''
+      "<div class='code'>#{cshtml}#{jshtml}#{script}#{load}#{button}<br class='clear' /></div>"
+
+  monthNames = [
+    'January'
+    'February'
+    'March'
+    'April'
+    'May'
+    'June'
+    'July'
+    'August'
+    'September'
+    'October'
+    'November'
+    'December'
+  ]
+
+  formatDate = (date) ->
+    date.replace /^(\d\d\d\d)-(\d\d)-(\d\d)$/, (match, $1, $2, $3) ->
+      "#{monthNames[$2 - 1]} #{+$3}, #{$1}"
+
+  releaseHeader = (date, version, prevVersion) -> """
+    <div class="anchor" id="#{version}"></div>
+    <b class="header">
+      #{prevVersion and "<a href=\"https://github.com/jashkenas/coffeescript/compare/#{prevVersion}...#{version}\">#{version}</a>" or version}
+      <span class="timestamp"> &mdash; <time datetime="#{date}">#{formatDate date}</time></span>
+    </b>
+  """
 
+  testHelpers = fs.readFileSync('test/support/helpers.coffee', 'utf-8').replace /exports\./g, '@'
+
+  testsInScriptBlocks = ->
+    output = ''
+    excludedTestFiles = ['error_messages.coffee']
+    for filename in fs.readdirSync 'test'
+      continue if filename in excludedTestFiles
+
+      if filename.indexOf('.coffee') isnt -1
+        type = 'coffeescript'
+      else if filename.indexOf('.litcoffee') isnt -1
+        type = 'literate-coffeescript'
+      else
+        continue
+
+      # Set the type to text/x-coffeescript or text/x-literate-coffeescript
+      # to prevent the browser compiler from automatically running the script
+      output += """
+        <script type="text/x-#{type}" class="test" id="#{filename.split('.')[0]}">
+        #{fs.readFileSync "test/#{filename}", 'utf-8'}
+        </script>\n
+      """
+    output
+
+  # Task
+  examplesSourceFolder = 'documentation/examples'
+  examplesOutputFolder = "docs/v#{majorVersion}/examples"
+  fs.mkdirSync examplesOutputFolder unless fs.existsSync examplesOutputFolder
+  do renderExamples = ->
+    execSync "bin/coffee -bc -o #{examplesOutputFolder} #{examplesSourceFolder}/*.coffee"
+
+  indexFile = 'documentation/index.html'
   do renderIndex = ->
-    codeSnippetCounter = 0
-    rendered = _.template fs.readFileSync(source, 'utf-8'),
+    render = _.template fs.readFileSync(indexFile, 'utf-8')
+    output = render
       codeFor: codeFor()
       releaseHeader: releaseHeader
-    fs.writeFileSync 'index.html', rendered
-    log "compiled", green, "#{source}"
-
-  fs.watchFile source, interval: 200, renderIndex
-  log "watching..." , green
+      majorVersion: majorVersion
+      fullVersion: CoffeeScript.VERSION
+    fs.writeFileSync "docs/v#{majorVersion}/index.html", output
+    log 'compiled', green, "#{indexFile} → docs/v#{majorVersion}/index.html"
+
+  testFile = 'documentation/test.html'
+  do renderTest = ->
+    render = _.template fs.readFileSync(testFile, 'utf-8')
+    output = render
+      testHelpers: testHelpers
+      tests: testsInScriptBlocks()
+      majorVersion: majorVersion
+    fs.writeFileSync "docs/v#{majorVersion}/test.html", output
+    log 'compiled', green, "#{testFile} → docs/v#{majorVersion}/test.html"
+
+  fs.watch examplesSourceFolder, interval: 200, ->
+    renderExamples()
+    renderIndex()
+  fs.watch indexFile, interval: 200, renderIndex
+  fs.watch testFile, interval: 200, renderTest
+  fs.watch 'test', interval: 200, renderTest
+  log 'watching...' , green
+
+
+task 'doc:source', 'rebuild the annotated source documentation', ->
+  exec "node_modules/docco/bin/docco src/*.*coffee --output docs/v#{majorVersion}/annotated-source", (err) -> throw err if err
 
 
-task 'doc:source', 'rebuild the internal documentation', ->
-  exec 'node_modules/.bin/docco src/*.*coffee && cp -rf docs documentation && rm -r docs', (err) ->
-    throw err if err
-
-
-task 'doc:underscore', 'rebuild the Underscore.coffee documentation page', ->
-  exec 'node_modules/.bin/docco examples/underscore.coffee && cp -rf docs documentation && rm -r docs', (err) ->
-    throw err if err
-
 task 'bench', 'quick benchmark of compilation time', ->
   {Rewriter} = require './lib/coffee-script/rewriter'
   sources = ['coffee-script', 'grammar', 'helpers', 'lexer', 'nodes', 'rewriter']
@@ -244,23 +297,7 @@ runTests = (CoffeeScript) ->
         description: description if description?
         source: fn.toString() if fn.toString?
 
-  # See http://wiki.ecmascript.org/doku.php?id=harmony:egal
-  egal = (a, b) ->
-    if a is b
-      a isnt 0 or 1/a is 1/b
-    else
-      a isnt a and b isnt b
-
-  # A recursive functional equivalence helper; uses egal for testing equivalence.
-  arrayEgal = (a, b) ->
-    if egal a, b then yes
-    else if a instanceof Array and b instanceof Array
-      return no unless a.length is b.length
-      return no for el, idx in a when not arrayEgal el, b[idx]
-      yes
-
-  global.eq      = (a, b, msg) -> ok egal(a, b), msg ? "Expected #{a} to equal #{b}"
-  global.arrayEq = (a, b, msg) -> ok arrayEgal(a,b), msg ? "Expected #{a} to deep equal #{b}"
+  helpers.extend global, require './test/support/helpers'
 
   # When all the tests have run, collect and print errors.
   # If a stacktrace is available, output the compiled function source.
@@ -280,11 +317,6 @@ runTests = (CoffeeScript) ->
   # Run every test in the `test` folder, recording failures.
   files = fs.readdirSync 'test'
 
-  # Ignore generators test file if generators are not available
-  generatorsAreAvailable = '--harmony' in process.execArgv or
-    '--harmony-generators' in process.execArgv
-  files.splice files.indexOf('generators.coffee'), 1 if not generatorsAreAvailable
-
   for file in files when helpers.isCoffee file
     literate = helpers.isLiterate file
     currentFile = filename = path.join 'test', file
@@ -301,7 +333,7 @@ task 'test', 'run the CoffeeScript language test suite', ->
 
 
 task 'test:browser', 'run the test suite against the merged browser script', ->
-  source = fs.readFileSync 'extras/coffee-script.js', 'utf-8'
+  source = fs.readFileSync "docs/v#{majorVersion}/browser-compiler/coffee-script.js", 'utf-8'
   result = {}
   global.testingBrowser = yes
   (-> eval source).call result
diff --git a/bower.json b/bower.json
@@ -1,6 +1,5 @@
 {
   "name": "coffee-script",
-  "version": "1.11.1",
   "main": [
     "lib/coffee-script/coffee-script.js"
   ],
@@ -11,13 +10,6 @@
     "coffeescript",
     "compiler"
   ],
-  "devDependencies": {
-    "uglify-js": "~2.2",
-    "jison": ">=0.2.0",
-    "highlight.js": "~9.6.0",
-    "underscore": "~1.5.2",
-    "docco": "~0.6.2"
-  },
   "author": {
     "name": "Jeremy Ashkenas"
   },
diff --git a/CNAME → docs/CNAME b/CNAME → docs/CNAME
diff --git a/docs/index.html b/docs/index.html
@@ -0,0 +1 @@
+v1/index.html
diff --git a/docs/v1/.gitignore b/docs/v1/.gitignore
@@ -0,0 +1 @@
+examples/
diff --git a/documentation/docs/browser.html → docs/v1/annotated-source/browser.html b/documentation/docs/browser.html → docs/v1/annotated-source/browser.html
diff --git a/documentation/docs/cake.html → docs/v1/annotated-source/cake.html b/documentation/docs/cake.html → docs/v1/annotated-source/cake.html