task_list 1.0.2

data/lib/task_list.rb

@@ -0,0 +1,32 @@
+require 'task_list/summary'
+require 'task_list/version'
+
+# encoding: utf-8
+class TaskList
+  attr_reader :record
+
+  # `record` is the resource with the Markdown source text with task list items
+  # following this syntax:
+  #
+  #   - [ ] a task list item
+  #   - [ ] another item
+  #   - [x] a completed item
+  #
+  def initialize(record)
+    @record = record
+  end
+
+  # Public: return the TaskList::Summary for this task list.
+  #
+  # Returns a TaskList::Summary.
+  def summary
+    @summary ||= TaskList::Summary.new(record.task_list_items)
+  end
+
+  class Item < Struct.new(:checkbox_text, :source)
+    Complete = /\[[xX]\]/.freeze # see TaskList::Filter
+    def complete?
+      checkbox_text =~ Complete
+    end
+  end
+end

data/lib/task_list/filter.rb

@@ -0,0 +1,149 @@
+# encoding: utf-8
+require 'html/pipeline'
+require 'task_list'
+
+class TaskList
+  # Returns a `Nokogiri::DocumentFragment` object.
+  def self.filter(*args)
+    Filter.call(*args)
+  end
+
+  # TaskList filter replaces task list item markers (`[ ]` and `[x]`) with
+  # checkboxes, marked up with metadata and behavior.
+  #
+  # This should be run on the HTML generated by the Markdown filter, after the
+  # SanitizationFilter.
+  #
+  # Syntax
+  # ------
+  #
+  # Task list items must be in a list format:
+  #
+  # ```
+  # - [ ] incomplete
+  # - [x] complete
+  # ```
+  #
+  # Results
+  # -------
+  #
+  # The following keys are written to the result hash:
+  #   :task_list_items - An array of TaskList::Item objects.
+  class Filter < HTML::Pipeline::Filter
+
+    Incomplete = "[ ]".freeze
+    Complete   = "[x]".freeze
+
+    IncompletePattern = /\[[[:space:]]\]/.freeze # matches all whitespace
+    CompletePattern   = /\[[xX]\]/.freeze        # matches any capitalization
+
+    # Pattern used to identify all task list items.
+    # Useful when you need iterate over all items.
+    ItemPattern = /
+      ^
+      (?:\s*[-+*]|(?:\d+\.))? # optional list prefix
+      \s*                     # optional whitespace prefix
+      (                       # checkbox
+        #{CompletePattern}|
+        #{IncompletePattern}
+      )
+      (?=\s)                  # followed by whitespace
+    /x
+
+    ListItemSelector = ".//li[task_list_item(.)]".freeze
+
+    class XPathSelectorFunction
+      def self.task_list_item(nodes)
+        nodes if nodes.text =~ ItemPattern
+      end
+    end
+
+    # Selects first P tag of an LI, if present
+    ItemParaSelector = "./p[1]".freeze
+
+    # List of `TaskList::Item` objects that were recognized in the document.
+    # This is available in the result hash as `:task_list_items`.
+    #
+    # Returns an Array of TaskList::Item objects.
+    def task_list_items
+      result[:task_list_items] ||= []
+    end
+
+    # Renders the item checkbox in a span including the item state.
+    #
+    # Returns an HTML-safe String.
+    def render_item_checkbox(item)
+      %(<input type="checkbox"
+        class="task-list-item-checkbox"
+        #{'checked="checked"' if item.complete?}
+        disabled="disabled"
+      />)
+    end
+
+    # Public: Marks up the task list item checkbox with metadata and behavior.
+    #
+    # NOTE: produces a string that, when assigned to a Node's `inner_html`,
+    # will corrupt the string contents' encodings. Instead, we parse the
+    # rendered HTML and explicitly set its encoding so that assignment will
+    # not change the encodings.
+    #
+    # See [this pull](https://github.com/github/github/pull/8505) for details.
+    #
+    # Returns the marked up task list item Nokogiri::XML::NodeSet object.
+    def render_task_list_item(item)
+      Nokogiri::HTML.fragment \
+        item.source.sub(ItemPattern, render_item_checkbox(item)), 'utf-8'
+    end
+
+    # Public: Select all task lists from the `doc`.
+    #
+    # Returns an Array of Nokogiri::XML::Element objects for ordered and
+    # unordered lists.
+    def list_items
+      doc.xpath(ListItemSelector, XPathSelectorFunction)
+    end
+
+    # Filters the source for task list items.
+    #
+    # Each item is wrapped in HTML to identify, style, and layer
+    # useful behavior on top of.
+    #
+    # Modifications apply to the parsed document directly.
+    #
+    # Returns nothing.
+    def filter!
+      list_items.reverse.each do |li|
+        add_css_class(li.parent, 'task-list')
+
+        outer, inner =
+          if p = li.xpath(ItemParaSelector)[0]
+            [p, p.inner_html]
+          else
+            [li, li.inner_html]
+          end
+        if match = (inner.chomp =~ ItemPattern && $1)
+          item = TaskList::Item.new(match, inner)
+          # prepend because we're iterating in reverse
+          task_list_items.unshift item
+
+          add_css_class(li, 'task-list-item')
+          outer.inner_html = render_task_list_item(item)
+        end
+      end
+    end
+
+    def call
+      filter!
+      doc
+    end
+
+    # Private: adds a CSS class name to a node, respecting existing class
+    # names.
+    def add_css_class(node, *new_class_names)
+      class_names = (node['class'] || '').split(' ')
+      return if new_class_names.all? { |klass| class_names.include?(klass) }
+      class_names.concat(new_class_names)
+      node['class'] = class_names.uniq.join(' ')
+    end
+  end
+end

data/lib/task_list/railtie.rb

@@ -0,0 +1,20 @@
+class TaskList
+
+  def self.root_path
+    @root_path ||= Pathname.new(File.expand_path("../../../", __FILE__))
+  end
+
+  def self.asset_paths
+    @paths ||= Dir[root_path.join("app/assets/*")]
+  end
+
+  if defined? ::Rails::Railtie
+    class Railtie < ::Rails::Railtie
+      initializer "task_list" do |app|
+        TaskList.asset_paths.each do |path|
+          app.config.assets.paths << path
+        end
+      end
+    end
+  end
+end

data/lib/task_list/summary.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+require 'html/pipeline'
+require 'task_list'
+
+class TaskList
+  # Provides a summary of provided TaskList `items`.
+  #
+  # `items` is an Array of TaskList::Item objects.
+  class Summary < Struct.new(:items)
+    # Public: returns true if there are any TaskList::Item objects.
+    def items?
+      item_count > 0
+    end
+
+    # Public: returns the number of TaskList::Item objects.
+    def item_count
+      items.size
+    end
+
+    # Public: returns the number of complete TaskList::Item objects.
+    def complete_count
+      items.select{ |i| i.complete? }.size
+    end
+
+    # Public: returns the number of incomplete TaskList::Item objects.
+    def incomplete_count
+      items.select{ |i| !i.complete? }.size
+    end
+  end
+end

data/lib/task_list/version.rb

@@ -0,0 +1,3 @@
+class TaskList
+  VERSION = [1, 0, 2].join('.')
+end

data/script/bootstrap

@@ -0,0 +1,13 @@
+#!/bin/sh
+set -e 0
+
+if ! bundle check 1>/dev/null 2>&1; then
+  bundle install --no-color --binstubs --path vendor/gems
+fi
+
+if ! npm list bower 2>&1 | grep 0.8.5 >/dev/null; then
+  # npm install bower
+  npm install git://github.com/twitter/bower.git
+fi
+
+bower install --no-color

data/script/cibuild

@@ -0,0 +1,6 @@
+#!/bin/sh -e
+# Usage: script/cibuild
+# CI build script.
+
+./script/testsuite 4018
+bundle exec rake test

data/script/testsuite

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+
+root = File.expand_path("../..", __FILE__)
+Dir.chdir root
+
+port = ARGV[0] || 4000
+
+pid = fork do
+  $stderr.reopen "/dev/null" # silence WEBrick output
+  exec 'bundle', 'exec', 'rackup', '-p', port.to_s
+end
+sleep 1
+
+status = system('phantomjs', "#{root}/test/run-qunit.coffee", "http://localhost:#{port}/test/index.html")
+
+Process.kill 'SIGINT', pid
+Process.wait pid
+
+exit status

data/task-lists.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'task_list/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "task_list"
+  gem.version       = TaskList::VERSION
+  gem.authors       = ["Matt Todd"]
+  gem.email         = ["matt@github.com"]
+  gem.description   = %q{GitHub-flavored-Markdown TaskList components}
+  gem.summary       = %q{GitHub-flavored-Markdown TaskList components}
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "html-pipeline"
+
+  gem.add_development_dependency "github-markdown"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "coffee-script"
+  gem.add_development_dependency "json"
+  gem.add_development_dependency "rack"
+  gem.add_development_dependency "sprockets"
+  gem.add_development_dependency "minitest", "~> 5.3.2"
+end

data/test/functional/helpers/remote.coffee

@@ -0,0 +1,3 @@
+#= require jquery
+#= require rails-behaviors/remote
+#= require task_list

data/test/functional/test_task_lists_behavior.html

@@ -0,0 +1,103 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="utf-8">
+  <script type="text/javascript" src="/assets/functional/helpers/remote.js"></script>
+  <script type="text/javascript">
+    function logEvent(event) {
+      console.log(event)
+      $('.log').prepend("<li>" + event.type + "</li>")
+    }
+
+    setInterval(function() {
+      if (!$('.log li:first').first().hasClass("timestamp"))
+        $('.log').prepend("<li class='timestamp'><time>" + new Date + "</time></li>")
+    }, 3000)
+
+    $(document).on('tasklist:enabled', logEvent)
+    $(document).on('tasklist:disabled', logEvent)
+    $(document).on('tasklist:change', '.js-task-list-field', function(event){
+      logEvent(event)
+      $(this).closest('.js-task-list-container').taskList('disable')
+    })
+    $(document).on('tasklist:changed', '.js-task-list-field', function(event){
+      logEvent(event)
+      $(this).closest('form').submit()
+    })
+
+    $(document).on('ajaxStart', logEvent)
+    $(document).on('ajaxSuccess', '.js-task-list-container', function(event){
+      logEvent(event)
+      $(this).taskList()
+    })
+  </script>
+
+  <style>
+    body {
+      font: 13px Helvetica;
+      padding: 20px;
+    }
+    input {
+      font-size: 20px;
+    }
+    time {
+      font-size: 10px;
+      font-style: oblique;
+    }
+
+    .task-list {
+      list-style-type: none;
+    }
+    .task-list .task-list-item {
+      opacity: 0.75;
+    }
+    .task-list .task-list-item.enabled {
+      opacity: 1.0;
+    }
+
+    .log {
+      position: absolute;
+      top: 20px;
+      right: 50px;
+      color: #222;
+      list-style: none;
+      margin: 0;
+      padding: 0;
+    }
+  </style>
+</head>
+<body>
+  <div class="js-task-list-container js-task-list-enable">
+    <div class="markdown">
+      <ul class="task-list">
+        <li class="task-list-item">
+          <input type="checkbox" class="task-list-item-checkbox" disabled />
+          I'm a task list item
+        </li>
+        <li class="task-list-item">
+          <input type="checkbox" class="task-list-item-checkbox" disabled />
+          with non-breaking space
+        </li>
+        <li class="task-list-item">
+          <input type="checkbox" class="task-list-item-checkbox" disabled checked />
+          completed, lower
+        </li>
+        <li class="task-list-item">
+          <input type="checkbox" class="task-list-item-checkbox" disabled checked />
+          completed capitalized
+        </li>
+      </ul>
+    </div>
+    <form action="/update" method="POST" data-remote data-type="json">
+      <textarea name="comment[body]" class="js-task-list-field" cols="40" rows="10">
+- [ ] I'm a task list item
+- [ ] with non-breaking space
+- [x] completed, lower
+- [X] completed capitalized</textarea>
+    </form>
+  </div>
+
+  <ul class="log">
+  </ul>
+</body>
+</html>

data/test/index.html

@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="utf-8">
+  <link rel="stylesheet" href="/assets/units.css">
+  <script type="text/javascript" src="/assets/units.js"></script>
+</head>
+<body>
+  <div id="qunit"></div>
+  <div id="qunit-fixture"></div>
+</body>
+</html>

data/test/run-qunit.coffee

@@ -0,0 +1,50 @@
+fs = require 'fs'
+print = (s) -> fs.write "/dev/stderr", s, 'w'
+
+page = new WebPage()
+page.onConsoleMessage = (msg) -> console.error msg
+
+timeoutId = null
+deferTimeout = ->
+  clearTimeout timeoutId if timeoutId
+  timeoutId = setTimeout ->
+    console.error "Timeout"
+    phantom.exit 1
+  , 3000
+
+page.open phantom.args[0], ->
+  deferTimeout()
+
+  setInterval ->
+    tests = page.evaluate ->
+      tests = document.getElementById('qunit-tests')?.children
+      return unless tests
+      for test in tests when test.className isnt 'running' and not test.recorded
+        test.recorded = true
+        if test.className is 'pass'
+          '.'
+        else if test.className is 'fail'
+          'F'
+
+    return unless tests
+    for test in tests when test
+      deferTimeout()
+      print test
+
+    result = page.evaluate ->
+      result = document.getElementById('qunit-testresult')
+      tests  = document.getElementById('qunit-tests').children
+
+      if result.innerText.match /completed/
+        console.error ""
+
+        for test in tests when test.className is 'fail'
+          console.error test.innerText
+
+        console.error result.innerText
+        return parseInt result.getElementsByClassName('failed')[0].innerText
+
+      return
+
+    phantom.exit result if result?
+  , 100