rdoc 4.1.0.preview.3 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 63a8392d312b7021635d3ca1f8b767fdeb703578
-  data.tar.gz: 9d8b4adcb0c60f3157d6b9fb41cdcfc4c8912ef1
+  metadata.gz: 0819c40fa54344a9bfad2ebcad36dbb0f5230345
+  data.tar.gz: 20484e07c670f704600a3a2ae4f1708984256f18
 SHA512:
-  metadata.gz: fbe17dd9ed231a22d9252f70d7f057cded0a482d7a2ca1fcd1423e22b2aa74613fb95253df0d362f38af8cd1747e477106cddaf0de85a48074c1e472e9a7d605
-  data.tar.gz: ee95d4887bff5955cc1fb3a976833871045dd0e5ece158124ff8cf8428a2e681f3c2cb58896b5e20461d933c55751f3a5d62d8362fb3aca517818201248c76d0
+  metadata.gz: 6f481cd483af36f9c8954874d035e4436dcc7e0ca654be6032b321f15aa560918c699b020eb8512d4acb96d4304c73b7bea68d2d385c03334560772cc95d8f5f
+  data.tar.gz: 2037b1742a963cd6d78afbda235235b12db016053e410071c765ca95e1e7d7680f765ac274b19f37135fbbb88bcd8c5f7fa1e936bf200010e5213277036a75f2

checksums.yaml.gz.sig

@@ -1 +1,3 @@
-qwܕt$@�A��SlE$G���u���Yb��o,z��2�
|�m�w��,��zo1��橖�#��m���x�>Ы>�;�>�[>!�� ��؍�jK��s?e�U�����N�&p3翙חށ��ܑ��K���r���'Y��Ҙc<�����qr�8oQ6i�M�E�iU��̖Q�%'���Ǣ�ܶ��h;��?f��S8�i���tss�ٰ�D0=m�ܱ��c���AF�0�����7@�x�/X
+�S!g����w?�^�V ��o��w8�S'W��I�g.rr�V�ǝ9��2��'�9���b��&��E�y`�[j[�؀9|��	��
+ps��y�s��)�(�WP��Fª��4�l�o���i�<�ϻd�G%�nw��koܞʄ�r�,rX#��Y��X饷
+�{�\�f��L׺�?ՔJӱ�|_'����׸B�i�I�?@�t`F���__$[�ރ4�(�\D5��/�MF��)o�P��6I�

data/History.rdoc

@@ -1,4 +1,14 @@
-=== 4.1.0.preview.3 / 2012-12-02
+=== 4.1.0 / 2013-12-26
+
+* Notable changes
+  * Improved accessibility of HTML output.  Accessibility review was provided
+    by:
+
+    Techvision – http://www.techvision.net.in
+
+    The accessibility consultants in Pune, India
+
+  * The look of RDoc has been updated.
 
 * Minor enhancements
   * RDoc can now link to [], []=, << and >> methods.  Pull request #202 by
@@ -25,6 +35,7 @@
     by Vít Ondruch.
 
 * Bug fixes
+  * Applied typo fixes by @dvsuresh from ruby/ruby@2c5dcdf
   * Restored behavior of --no-pager alias -T.  Pull request #223 by ruafozy.
   * Fixed extra whitespace output in the rdoc coverage report.  Bug #210 by
     Ryan Davis.

data/TODO.rdoc

@@ -45,3 +45,15 @@ API changes to RDoc
   * Rename TopLevel to File
   * Rename Context to Container
   * Rename NormalClass to Class
+
+=== Accessibility
+
+Page title in right hand side
+
+Table of contents in left hand side as sub-list under main heading
+
+For class list, never method list, method summary at top
+
+table-of-contents-navigation div => nav + role="navigation"
+
+type "mod", focus is still on "mod"

data/lib/rdoc.rb

@@ -64,7 +64,7 @@ module RDoc
   ##
   # RDoc version you are using
 
-  VERSION = '4.1.0.preview.3'
+  VERSION = '4.1.0'
 
   ##
   # Method visibilities

data/lib/rdoc/generator/template/darkfish/_sidebar_search.rhtml

@@ -3,13 +3,12 @@
     <div id="search-field-wrapper">
       <input id="search-field" role="combobox" aria-label="Search"
              aria-autocomplete="list" aria-controls="search-results"
-             type="text" name="search" placeholder="Search"
+             type="text" name="search" placeholder="Search" spellcheck="false"
              title="Type to search, Up and Down to navigate, Enter to load">
     </div>
 
     <ul id="search-results" aria-label="Search Results"
         aria-busy="false" aria-expanded="false"
-        aria-atomic="false" aria-live="polite"
-        aria-relevant="all" class="initially-hidden"></ul>
+        aria-atomic="false" class="initially-hidden"></ul>
   </form>
 </div>

data/lib/rdoc/generator/template/darkfish/js/search.js

@@ -14,7 +14,12 @@ Search.prototype = $.extend({}, Navigation, new function() {
 
   this.init = function() {
     var _this = this;
-    var observer = function() {
+    var observer = function(e) {
+      switch(e.originalEvent.keyCode) {
+        case 38: // Event.KEY_UP
+        case 40: // Event.KEY_DOWN
+          return;
+      }
       _this.search(_this.$input[0].value);
     };
     this.$input.keyup(observer);
@@ -82,6 +87,8 @@ Search.prototype = $.extend({}, Navigation, new function() {
       this.$input.attr('aria-activedescendant', $next.attr('id'));
       this.scrollIntoView($next[0], this.$view[0]);
       this.$current = $next;
+      this.$input.val($next[0].firstChild.firstChild.text);
+      this.$input.select();
     }
     return true;
   }

data/lib/rdoc/rd/block_parser.rb

@@ -144,9 +144,9 @@ def next_token # :nodoc:
         # call filter, part_out is output(Part object)
         part_out = @tree.filter[@in_part].call(part)
 
-        if @tree.filter[@in_part].mode == :rd # if output is RD formated
+        if @tree.filter[@in_part].mode == :rd # if output is RD formatted
           subtree = parse_subtree(part_out.to_a)
-        else # if output is target formated
+        else # if output is target formatted
           basename = TMPFILE.join('.')
           TMPFILE[-1] += 1
           tmpfile = open(@tree.tmp_dir + "/" + basename + ".#{@in_part}", "w")

data/lib/rdoc/rd/block_parser.ry

@@ -357,9 +357,9 @@ def next_token # :nodoc:
         # call filter, part_out is output(Part object)
         part_out = @tree.filter[@in_part].call(part)
 
-        if @tree.filter[@in_part].mode == :rd # if output is RD formated
+        if @tree.filter[@in_part].mode == :rd # if output is RD formatted
           subtree = parse_subtree(part_out.to_a)
-        else # if output is target formated
+        else # if output is target formatted
           basename = TMPFILE.join('.')
           TMPFILE[-1] += 1
           tmpfile = open(@tree.tmp_dir + "/" + basename + ".#{@in_part}", "w")

data/test/test_rdoc_task.rb

@@ -56,6 +56,23 @@ class TestRDocTask < RDoc::TestCase
     assert_equal :rdoc_dev, rd.name
   end
 
+  def test_tasks_option_parser
+    rdoc_task = RDoc::Task.new do |rd|
+      rd.title = "Test Tasks Option Parser"
+      rd.main = "README.md"
+      rd.rdoc_files.include("README.md")
+      rd.options << "--all"
+    end
+
+    assert rdoc_task.title, "Test Tasks Option Parser"
+    assert rdoc_task.main, "README.md"
+    assert rdoc_task.rdoc_files.include?("README.md")
+    assert rdoc_task.options.include?("--all")
+
+    args = %w[--all -o html --main README.md] << "--title" << "Test Tasks Option Parser" << "README.md"
+    assert_equal args, rdoc_task.option_list + rdoc_task.rdoc_files
+  end
+
   def test_generator_option
     rdoc_task = RDoc::Task.new do |rd|
       rd.generator = "ri"
@@ -64,6 +81,22 @@ class TestRDocTask < RDoc::TestCase
     assert_equal %w[-o html -f ri], rdoc_task.option_list
   end
 
+  def test_main_option
+    rdoc_task = RDoc::Task.new do |rd|
+      rd.main = "README.md"
+    end
+
+    assert_equal %w[-o html --main README.md], rdoc_task.option_list
+  end
+
+  def test_output_dir_option
+    rdoc_task = RDoc::Task.new do |rd|
+      rd.rdoc_dir = "zomg"
+    end
+
+    assert_equal %w[-o zomg], rdoc_task.option_list
+  end
+
   def test_rdoc_task_description
     assert_equal 'Build RDoc HTML files', @t.rdoc_task_description
   end
@@ -116,5 +149,21 @@ class TestRDocTask < RDoc::TestCase
     end
   end
 
+  def test_template_option
+    rdoc_task = RDoc::Task.new do |rd|
+      rd.template = "foo"
+    end
+
+    assert_equal %w[-o html -T foo], rdoc_task.option_list
+  end
+
+  def test_title_option
+    rdoc_task = RDoc::Task.new do |rd|
+      rd.title = "Test Title Option"
+    end
+
+    assert_equal %w[-o html] << "--title" << "Test Title Option", rdoc_task.option_list
+  end
+
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rdoc
 version: !ruby/object:Gem::Version
-  version: 4.1.0.preview.3
+  version: 4.1.0
 platform: ruby
 authors:
 - Eric Hodel
@@ -33,7 +33,7 @@ cert_chain:
   KDyY1VIazVgoC8XvR4h/95/iScPiuglzA+DBG1hip1xScAtw05BrXyUNrc9CEMYU
   wgF94UVoHRp6ywo8I7NP3HcwFQDFNEZPNGXsng==
   -----END CERTIFICATE-----
-date: 2013-12-03 00:00:00.000000000 Z
+date: 2013-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json