From 9dd534ec90e0a38c0887ed14c42bdb2dd0348a2f Mon Sep 17 00:00:00 2001 From: Matt Todd Date: Thu, 25 Sep 2014 18:11:34 -0700 Subject: [PATCH 01/17] Bump to 1.0.2 --- bower.json | 2 +- lib/task_list/version.rb | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/bower.json b/bower.json index 7296990..69b1e76 100644 --- a/bower.json +++ b/bower.json @@ -1,6 +1,6 @@ { "name": "task_list", - "version": "1.0.1", + "version": "1.0.2", "dependencies": { "jquery": ">= 1.9.1" }, diff --git a/lib/task_list/version.rb b/lib/task_list/version.rb index 9574076..b1e0e70 100644 --- a/lib/task_list/version.rb +++ b/lib/task_list/version.rb @@ -1,3 +1,3 @@ class TaskList - VERSION = [1, 0, 1].join('.') + VERSION = [1, 0, 2].join('.') end From b1989c447979a8a748dc7e518f50de0eb3b9cc81 Mon Sep 17 00:00:00 2001 From: Matt Todd Date: Fri, 21 Nov 2014 15:27:44 -0800 Subject: [PATCH 02/17] Add Contributing and CLA docs --- CLA.md | 54 +++++++++++++++++++++++++++++++++++++++++++++++++ CONTRIBUTING.md | 5 +++++ 2 files changed, 59 insertions(+) create mode 100644 CLA.md create mode 100644 CONTRIBUTING.md diff --git a/CLA.md b/CLA.md new file mode 100644 index 0000000..3187cde --- /dev/null +++ b/CLA.md @@ -0,0 +1,54 @@ +GitHub CLA +=============== + +## Don't give up - please go ahead and create this PR. + +We welcome you to follow, fork, and work on, our open source projects. If you want to contribute back to this project, or any other GitHub project, we need to ask you to complete the Contributor License Agreement (CLA) below. If you are contributing on behalf of your employer, or as part of your role as an employee, remember that you are signing in the name of your employer and you have to make sure that that's okay before you sign. + +## What is this? + +This is GitHub Inc.'s Contributor License Agreement. If you've worked in the technology space before, contributed or maintained an open source project, there's a good chance that you've run across one or more of these in the past. What CLAs aim to do is make sure the project is able to merge contributions from multiple contributors without getting itself into different types of trouble. This one is no different in that sense. + +## Why is this? + +The answer is that we need to protect the open source projects that we maintain, their users and their contributors (including Hubber contributors, of course, but not just). Why? Just imagine a case when a contributor is making a contribution to a project and that contribution is subsequently merged and becomes an integral part of the project. Now, go on to imagine that our contributor copied the code, or that this contributor works for a company that doesn't want its employees to make contributions to this project or any project. What then? Well, the person the code was copied from or the company can do whatever the hell they like, including to come after the project and its users if using it, make them stop or even sue. If either has patent rights in the code, the project is in even deeper trouble. + + +## So. + +Please read the following terms, make sure you understand, and that if you agree, that you sign. Then, your pull request would be created and the project and the other contributors would be safe. It's important to us that you remember that except for the license you grant by signing this document - to GitHub, to your fellow contributors and to the project, you reserve all right, title, and interest in your contributions. + +### 1. Definitions. + +*You*, *you* (*Your*, or *your*) means the copyright owner or legal entity authorized by the copyright owner to sign this agreement. + +*Contribution* or *contribution* means any original work of authorship, including any modifications or additions to an existing work, that is submitted to a GitHub project. "Submitted" means via a Pull Request, an issue or any form of electronic, verbal, or written communication sent to GitHub. + +### 2. Grant of Copyright License. + +Subject to the terms and conditions of this agreement, you grant to GitHub, to fellow contributors and to the project a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, sublicense, and distribute your contributions and such derivative works. + +### 3. Grant of Patent License. + +Subject to the terms and conditions of this agreement, You hereby grant to GitHub, to fellow contributors to the project, and to its users a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer your contribution as part of the project, where such license applies only to those patent claims licensable by you that are necessarily infringed by your contribution or by combination of your contribution with the project to which this contribution was submitted. If any entity institutes patent litigation against you or any other entity (including a cross-claim or counterclaim in a lawsuit) alleging that your contribution, or the project to which you have contributed, constitutes direct or contributory patent infringement, then any patent licenses granted to that entity under this agreement for that contribution shall terminate as of the date such litigation is filed. + +### 4. You Can Grant this License. + +Signing would mean that you are legally entitled to grant the above license. If your employer(s) has rights to intellectual property that you create that includes your contributions, you have verified and are certain that you have received permission to make your contribution on behalf of that employer, that your employer has waived such rights for your contribution, or that your employer has executed a separate license with GitHub or the project. + +### 5. Your Contribution is Yours. + +Signing doesn't change the fact that your contribution is your original creation (see section 7 for submissions on behalf of others) and that they include complete details of any third-party license or other restriction (including related patents and trademarks) of which you are personally aware and which are associated with any part of your contributions. + +### 6. You Provide Your Contribution "as is". + +Signing this won't mean anybody will argue otherwise. In other words, your contributions are made without warranties or conditions of any kind. + +### 7. If Some or All Your Contributions Is Not Yours. + +That's fine but you need to identify the source or sources of the contribution and any license or other restriction (like related patents, trademarks, and license agreements) of which you are personally aware, and conspicuously marking the contribution as "Submitted on behalf of a third-party or third parties: [named here]". A place where you can do this is in a commit comment to the PR. + +### 8. If Any Circumstances of Your Contribution change. +You agree to notify the project and GitHub of any facts or circumstances of which you become aware. + +### 9. That's it! diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..d511bf4 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,5 @@ +# Contributions Welcome! + +Hi there! We're thrilled that you'd like to contribute to this project. Before you do, would you mind reading [this license agreement](CLA.md)? If you open a PR, we'll assume you agree to it. If you have any hesitation or disagreement, please do open a PR still, but note your concerns as well. + +Thanks! From 55415e5c008bf5e909bc3111a3a1daad4d1cc33b Mon Sep 17 00:00:00 2001 From: Matt Todd Date: Fri, 21 Nov 2014 15:43:38 -0800 Subject: [PATCH 03/17] Move/point to contributing guidelines --- CONTRIBUTING.md | 8 +++++++- README.md | 6 +----- 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d511bf4..1a3eded 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,4 +2,10 @@ Hi there! We're thrilled that you'd like to contribute to this project. Before you do, would you mind reading [this license agreement](CLA.md)? If you open a PR, we'll assume you agree to it. If you have any hesitation or disagreement, please do open a PR still, but note your concerns as well. -Thanks! +Once done, follow these steps: + +1. Fork this repository +2. Create your feature branch (`git checkout -b my-new-feature`) +3. Commit your changes (`git commit -am 'Add some feature'`) +4. Push to the branch (`git push origin my-new-feature`) +5. Create a Pull Request diff --git a/README.md b/README.md index f0da01e..dea4a21 100644 --- a/README.md +++ b/README.md @@ -69,8 +69,4 @@ Navigate to http://localhost:4011/test/functional/test_task_lists_behavior.html ## Contributing -1. Fork it -2. Create your feature branch (`git checkout -b my-new-feature`) -3. Commit your changes (`git commit -am 'Add some feature'`) -4. Push to the branch (`git push origin my-new-feature`) -5. Create new Pull Request +Read the [Contributing Guidelines] and open a Pull Request! From be013973bf0780d8934f599285fbb7083bce06f9 Mon Sep 17 00:00:00 2001 From: Matt Todd Date: Fri, 21 Nov 2014 15:44:12 -0800 Subject: [PATCH 04/17] Linkify Contributing Guidelines link --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index dea4a21..8efb951 100644 --- a/README.md +++ b/README.md @@ -69,4 +69,4 @@ Navigate to http://localhost:4011/test/functional/test_task_lists_behavior.html ## Contributing -Read the [Contributing Guidelines] and open a Pull Request! +Read the [Contributing Guidelines](CONTRIBUTING.md) and open a Pull Request! From 748e23834bf1b934c7345ecc1c4d716d4e56a4bd Mon Sep 17 00:00:00 2001 From: Matt Todd Date: Fri, 21 Nov 2014 16:26:49 -0800 Subject: [PATCH 05/17] Update the README --- README.md | 26 ++++++++++++++++++-------- 1 file changed, 18 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 8efb951..7c0fb6d 100644 --- a/README.md +++ b/README.md @@ -8,14 +8,18 @@ into your GitHub-flavored-Markdown user content. The Task List feature is actually made of several different components: -* GitHub-flavored-Markdown Filter -* Model: summarizes task list items -* JavaScript: task list update behavior +* GitHub-flavored-Markdown Ruby Filter +* Summary Ruby Model: summarizes task list items +* JavaScript: frontend task list update behavior * CSS: styles Markdown task list items ## Installation -Add this line to your application's Gemfile: +Task Lists are packaged as both a RubyGem with both backend and frontend behavior, and a Bower package wiht just the frontend behavior. + +### Backend: RubyGem + +For the backend Ruby components, add this line to your application's Gemfile: gem 'task_list' @@ -23,7 +27,13 @@ And then execute: $ bundle -### Rails 3+: Railtie method +### Frontend: Bower + +For the frontend components, add `task_list` to your Bower dependencies config. + +This is the preferred method for including the frontend assets in your application. Alternatively, for Rails methods using `Sprockets`, see below. + +### Frontend: Rails 3+ Railtie method ``` ruby # config/application.rb @@ -48,9 +58,9 @@ If you're not using Sprockets, you're on your own but it's pretty straight forward. `task_list/railtie` defines `TaskList.asset_paths` which you can use to manage building your asset bundles. -### CoffeeScript Requirements +### Dependencies -Aside from requiring CoffeeScript, jQuery is the only other requirement. +At a high level, the Ruby components integrate with the [`html-pipeline`](https://github.com/jch/html-pipeline) library, and the frontend components depend on the jQuery library. The frontend components are written in CoffeeScript and need to be preprocessed for production use. ## Testing and Development @@ -58,7 +68,7 @@ JavaScript unit tests can be run with `script/testsuite`. Ruby unit tests can be run with `rake test`. -Functional tests are more for manual testing in the browser. To run, install +Functional tests are useful for manual testing in the browser. To run, install the necessary components with `script/bootstrap` then run the server: ``` From 17cab363f79dc72bc3ad78f49a01ac26366bac3f Mon Sep 17 00:00:00 2001 From: Matt Todd Date: Fri, 21 Nov 2014 16:27:26 -0800 Subject: [PATCH 06/17] Fix frontend heading --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 7c0fb6d..96febe0 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,7 @@ This is the preferred method for including the frontend assets in your applicati require 'task_list/railtie' ``` -### Rails 2.3: Manual method +### Frontend: Rails 2.3 Manual method Wherever you have your Sprockets setup: From 1b3789a754ce1e877468244b1d5740477955308e Mon Sep 17 00:00:00 2001 From: Matt Todd Date: Fri, 21 Nov 2014 16:27:50 -0800 Subject: [PATCH 07/17] s/actual// --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 96febe0..5f3b4dc 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ into your GitHub-flavored-Markdown user content. ## Components -The Task List feature is actually made of several different components: +The Task List feature is made of several different components: * GitHub-flavored-Markdown Ruby Filter * Summary Ruby Model: summarizes task list items From 429bbb6f105509615b294bb6c18fe92d7a4c2885 Mon Sep 17 00:00:00 2001 From: Matt Todd Date: Fri, 21 Nov 2014 16:30:35 -0800 Subject: [PATCH 08/17] Update gemspec, bower package --- bower.json | 2 ++ task-lists.gemspec => task_list.gemspec | 0 2 files changed, 2 insertions(+) rename task-lists.gemspec => task_list.gemspec (100%) diff --git a/bower.json b/bower.json index 69b1e76..64685e7 100644 --- a/bower.json +++ b/bower.json @@ -1,6 +1,8 @@ { "name": "task_list", "version": "1.0.2", + "description": "GitHub-flavored-Markdown TaskList components", + "homepage": "https://github.com/github/task_list", "dependencies": { "jquery": ">= 1.9.1" }, diff --git a/task-lists.gemspec b/task_list.gemspec similarity index 100% rename from task-lists.gemspec rename to task_list.gemspec From a9ad044cbc51b5ea1648fe5fcc75641ba22a9594 Mon Sep 17 00:00:00 2001 From: Matt Todd Date: Fri, 21 Nov 2014 17:02:36 -0800 Subject: [PATCH 09/17] Document usage --- README.md | 56 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 56 insertions(+) diff --git a/README.md b/README.md index 5f3b4dc..4ce44ae 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,62 @@ The Task List feature is made of several different components: * JavaScript: frontend task list update behavior * CSS: styles Markdown task list items +## Usage + +The backend components are designed for rendering the Task List item checkboxes, and the frontend components handle updating the Markdown when . + +### Backend: Markdown pipeline filter + +Rendering Task List item checkboxes from source Markdown depends on the `TaskList::Filter`, designed to integrate with the [`html-pipeline`](https://github.com/jch/html-pipeline) gem. For example: + +``` ruby +require 'html/pipeline' +require 'task_list/filter' + +pipeline = HTML::Pipeline.new [ + HTML::Pipeline::MarkdownFilter, + TaskList::Filter +] + +pipeline.call "- [ ] task list item" +``` + +### Frontend: Markdown Updates + +Task List updates on the frontend require specific HTML markup structure, and must be enabled with JavaScript. + +Rendered HTML (the `
    ` element below) should be contained in a `js-task-list-container` container element and include a sibling `textarea.js-task-list-field` element that is updated when checkboxes are changed. + +``` markdown +- [ ] text +``` + +``` html +
    +
      +
    • + + text +
      • +
    +
    + +
    +
    +``` + +Enable Task List updates with: + +``` javascript +$('.js-task-list-container').taskList('enable') +``` + +NOTE: Updates are not persisted to the server automatically. Persistence is the responsibility of the integrating application, accomplished by hooking into the `tasklist:change` JavaScript event. For instance, we use AJAX to submit a hidden form on update. + +Read through the documented behaviors and samples [in the source][frontend_behaviors] for more detail, including documented events. + +[frontend_behaviors]: https://github.com/github/task_list/blob/master/app/assets/javascripts/task_list.coffee + ## Installation Task Lists are packaged as both a RubyGem with both backend and frontend behavior, and a Bower package wiht just the frontend behavior. From 2359946697ebbbc7b88e6736733b55bbea52c489 Mon Sep 17 00:00:00 2001 From: Matt Todd Date: Fri, 21 Nov 2014 17:14:13 -0800 Subject: [PATCH 10/17] Finish the sentence --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4ce44ae..4cb9f4e 100644 --- a/README.md +++ b/README.md @@ -13,9 +13,9 @@ The Task List feature is made of several different components: * JavaScript: frontend task list update behavior * CSS: styles Markdown task list items -## Usage +## Usage & Integration -The backend components are designed for rendering the Task List item checkboxes, and the frontend components handle updating the Markdown when . +The backend components are designed for rendering the Task List item checkboxes, and the frontend components handle updating the Markdown source (embedded in the markup). ### Backend: Markdown pipeline filter From bba24e3df22064196551d3fb834d956f64b31311 Mon Sep 17 00:00:00 2001 From: Yaroslav Shirokov Date: Sat, 22 Nov 2014 19:45:47 -0800 Subject: [PATCH 11/17] Accidentally a typo. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 4cb9f4e..6998786 100644 --- a/README.md +++ b/README.md @@ -71,7 +71,7 @@ Read through the documented behaviors and samples [in the source][frontend_behav ## Installation -Task Lists are packaged as both a RubyGem with both backend and frontend behavior, and a Bower package wiht just the frontend behavior. +Task Lists are packaged as both a RubyGem with both backend and frontend behavior, and a Bower package with just the frontend behavior. ### Backend: RubyGem From 18b540dccaea5628969d7c8e15f4d502298a648c Mon Sep 17 00:00:00 2001 From: Ryunosuke SATO Date: Wed, 26 Nov 2014 13:32:29 +0900 Subject: [PATCH 12/17] Test against Ruby 2.2 on Travis CI --- .travis.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.travis.yml b/.travis.yml index fb2cce9..bc4dcf5 100644 --- a/.travis.yml +++ b/.travis.yml @@ -5,5 +5,6 @@ rvm: - 1.9.3 - 2.0.0 - 2.1.1 + - 2.2 notifications: email: false From 77bb6ed67e07986a94212d4b5d52d60d0c6a7ab5 Mon Sep 17 00:00:00 2001 From: Blaine Schmeisser Date: Mon, 1 Dec 2014 19:27:54 -0600 Subject: [PATCH 13/17] Add community integrations to the readme. No others were found using this search: https://github.com/search?p=1&q=task_list+Gemfile+in%3Apath%2Cfile&ref=searchresults&type=Code&utf8=%E2%9C%93 --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 6998786..d2fe3fd 100644 --- a/README.md +++ b/README.md @@ -133,6 +133,10 @@ rackup -p 4011 Navigate to http://localhost:4011/test/functional/test_task_lists_behavior.html +## Community Integration +- [Waffle.io](http://waffle.io) +- [HuBoard](https://huboard.com/) + ## Contributing Read the [Contributing Guidelines](CONTRIBUTING.md) and open a Pull Request! From f59879bbdb73b4429f2ec88935472ac4f1cd1ae2 Mon Sep 17 00:00:00 2001 From: Juanito Fatas Date: Thu, 15 Jan 2015 13:51:40 +0800 Subject: [PATCH 14/17] Predicate complete? should return boolean. --- lib/task_list.rb | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/lib/task_list.rb b/lib/task_list.rb index 474ad15..bd59f6b 100644 --- a/lib/task_list.rb +++ b/lib/task_list.rb @@ -25,8 +25,20 @@ def summary class Item < Struct.new(:checkbox_text, :source) Complete = /\[[xX]\]/.freeze # see TaskList::Filter + + # Public: Check if a task list is complete. + # + # Examples + # + # Item.new(checkbox_text: "- [x]").complete? + # # => true + # + # Item.new(checkbox_text: "- [ ]").complete? + # # => false + # + # Returns true for checked list, false otherwise def complete? - checkbox_text =~ Complete + !!(checkbox_text =~ Complete) end end end From e9cbc477abcfa6f6a564c9246d7b0d77570148cc Mon Sep 17 00:00:00 2001 From: Juanito Fatas Date: Fri, 30 Jan 2015 08:23:31 +0800 Subject: [PATCH 15/17] Update Travis yml config file. - sudo: false More RAM, dedicated cpu cores, awesome network performance, fantastic VM boot times. > Using our new container-based stack only requires one additional line in your .travis.yml: > `sudo: false` Source: http://blog.travis-ci.com/2014-12-17-faster-builds-with-container-based- infrastructure/ - Test against latest 2.0 and 2.1. --- .travis.yml | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/.travis.yml b/.travis.yml index bc4dcf5..3756c5c 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,10 +1,11 @@ language: ruby +sudo: false install: ./script/bootstrap script: ./script/cibuild rvm: - 1.9.3 - - 2.0.0 - - 2.1.1 + - 2.0 + - 2.1 - 2.2 notifications: email: false From e72a07fd18f75edc1c84a0ea4cebae6df85ddcc4 Mon Sep 17 00:00:00 2001 From: Juanito Fatas Date: Tue, 24 Feb 2015 20:36:38 +0800 Subject: [PATCH 16/17] Add some pretty badges to polish the README.md. [ci skip] --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index d2fe3fd..7409a53 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,15 @@ # Task Lists +[![Gem Version](http://img.shields.io/gem/v/task_list.svg)][gem] +[![Build Status](http://img.shields.io/travis/github/task_list.svg)][travis] +[![Dependency Status](http://img.shields.io/gemnasium/github/task_list.svg)][gemnasium] +[![Inline docs](http://inch-ci.org/github/github/task_list.svg?branch=master)][inchpages] + +[gem]: https://rubygems.org/gems/task_list +[travis]: https://travis-ci.org/github/task_list +[gemnasium]: https://gemnasium.com/github/task_list +[inchpages]: http://inch-ci.org/github/github/task_list + This package provides various components necessary for integrating [Task Lists](https://github.com/blog/1375-task-lists-in-gfm-issues-pulls-comments) into your GitHub-flavored-Markdown user content. From 2df9b98a2264d98c42c5ef14df2e4e29849fcf8c Mon Sep 17 00:00:00 2001 From: Mike Skalnik Date: Thu, 17 Mar 2016 10:56:44 -0700 Subject: [PATCH 17/17] =?UTF-8?q?Lets=20be=20clear=20about=20this=20?= =?UTF-8?q?=F0=9F=98=BF?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 7409a53..4bfad02 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,8 @@ # Task Lists +*NOTE:* _This repository is no longer supported or updated by GitHub. If you wish to continue to develop this code yourself, we recommend you fork it._ + + [![Gem Version](http://img.shields.io/gem/v/task_list.svg)][gem] [![Build Status](http://img.shields.io/travis/github/task_list.svg)][travis] [![Dependency Status](http://img.shields.io/gemnasium/github/task_list.svg)][gemnasium] pFad - Phonifier reborn

    Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

    Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


    Alternative Proxies:

    Alternative Proxy

    pFad Proxy

    pFad v3 Proxy

    pFad v4 Proxy