yard 0.8.7.2 → 0.8.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ef9efe4edad38a159aae8b484a45d222408c7c34
-  data.tar.gz: 68281500153ef94cdcaba336bc139a9e930ab46a
+  metadata.gz: 4baddf5f52f2913d492f130ec8b45a08d37a6bb7
+  data.tar.gz: 5f96f9b1e90711b3ff6b54b191f3dae793d70793
 SHA512:
-  metadata.gz: 876cde2d21d6952a00e48c7ab4db8131b54960b7a92d1c1e1fe02e68a253a7f58f9830a93607fe8d55e196acd94a99a8cc72db17352ceeda5d1101e4ffeee6fb
-  data.tar.gz: 71981d8942aeef7eff85bdac219896656a0d4fab0fc355202bc993e554f3d1e4fd51bef14224134b3d574306ad659238e78e0bda53a170302b32d55adf3c6885
+  metadata.gz: 286cf94f1999e471f05bf87ae34d60ca23609648eef332830873ea27b54d407cd68c01e8b552ab026880317ff684623c8a467df7338faef9233bcdc9f8b22d29
+  data.tar.gz: 853a3f70d00f98a04ac81cd0176e4a25f53db77536a451462c60ef7a9fc72d9ac5465806b916feadb5231efc29d138c2744bb9438814370586f7144e1c002d4a

data/README.md

@@ -7,8 +7,8 @@
 **Contributors**: http://github.com/lsegal/yard/contributors    
 **Copyright**:    2007-2013    
 **License**:      MIT License    
-**Latest Version**: 0.8.7.2    
-**Release Date**: September 18th 2013    
+**Latest Version**: 0.8.7.3    
+**Release Date**: November 1st 2013    
 
 ## Synopsis
 
@@ -283,6 +283,15 @@ More options can be seen by typing `yard graph --help`, but here is an example:
 
 ## Changelog
 
+- **November.1.13**: 0.8.7.3 release
+    - Handle Unicode method/class/file names in server URL encoding (lsegal/rubydoc.info#69).
+    - Style keyword style hashes with same symbol color in code highlighting (#707).
+    - Fix broken JS when visiting docs in file:// scheme (#706).
+    - Add support for new AsciiDoc file extensions (#704).
+    - Fix issues where non-Ruby code blocks would not display in Ruby 2 (#702).
+    - Add support for extra Ruby 2 symbol types in Ripper (#701).
+    - Ensure config directory exists before saving config file (#700).
+
 - **September.18.13**: 0.8.7.2 release
     - Disallow absolute URLs when using frame anchor support.
     - Support casted functions in CRuby method declarations (#697)

data/lib/yard/config.rb

@@ -132,6 +132,7 @@ module YARD
     # @return [void]
     def self.save
       require 'yaml'
+      Dir.mkdir(CONFIG_DIR) unless File.directory?(CONFIG_DIR)
       File.open(CONFIG_FILE, 'w') {|f| f.write(YAML.dump(options)) }
     end
 

data/lib/yard/handlers/ruby/alias_handler.rb

@@ -10,7 +10,7 @@ class YARD::Handlers::Ruby::AliasHandler < YARD::Handlers::Ruby::Base
     elsif statement.call?
       statement.parameters(false).each do |obj|
         case obj.type
-        when :symbol_literal
+        when :symbol_literal, :dyna_symbol
           names << obj.jump(:ident, :op, :kw, :const).source
         when :string_literal
           names << obj.jump(:string_content).source

data/lib/yard/handlers/ruby/legacy/alias_handler.rb

@@ -12,6 +12,7 @@ class YARD::Handlers::Ruby::Legacy::AliasHandler < YARD::Handlers::Ruby::Legacy:
     end
     raise YARD::Parser::UndocumentableError, statement.tokens.first.text if names.size != 2
 
+    names = names.map {|n| Symbol === n ? n.to_s.gsub('"', '') : n }
     new_meth, old_meth = names[0].to_sym, names[1].to_sym
     old_obj = namespace.child(:name => old_meth, :scope => scope)
     new_obj = register MethodObject.new(namespace, new_meth, scope) do |o|

data/lib/yard/server/doc_server_serializer.rb

@@ -16,18 +16,28 @@ module YARD
         when CodeObjects::RootObject
           "toplevel"
         when CodeObjects::ExtendedMethodObject
-          serialized_path(object.namespace) + ':' + escape(object.name.to_s)
+          name = object.name.to_s
+          serialized_path(object.namespace) + ':' + urlencode(object.name.to_s)
         when CodeObjects::MethodObject
           serialized_path(object.namespace) +
-            (object.scope == :instance ? ":" : ".") + escape(object.name.to_s)
+            (object.scope == :instance ? ":" : ".") + urlencode(object.name.to_s)
         when CodeObjects::ConstantObject, CodeObjects::ClassVariableObject
           serialized_path(object.namespace) + "##{object.name}-#{object.type}"
         when CodeObjects::ExtraFileObject
-          super(object).gsub(/^file./, 'file/')
+          super(object).gsub(/^file\./, 'file/')
         else
           super(object)
         end
       end
+
+      private
+
+      def urlencode(name)
+        if name.respond_to?(:force_encoding)
+          name = name.dup.force_encoding('binary')
+        end
+        escape(name)
+      end
     end
   end
 end

data/lib/yard/templates/helpers/html_syntax_highlight_helper.rb

@@ -18,6 +18,7 @@ module YARD
 
         def html_syntax_highlight_ruby_ripper(source)
           tokenlist = Parser::Ruby::RubyParser.parse(source, "(syntax_highlight)").tokens
+          raise Parser::ParserSyntaxError if tokenlist.empty? && !source.empty?
           output = ""
           tokenlist.each do |s|
             output << "<span class='tstring'>" if [:tstring_beg, :regexp_beg].include?(s[0])

data/lib/yard/templates/helpers/markup_helper.rb

@@ -57,7 +57,7 @@ module YARD
         :html => ['htm', 'html', 'shtml'],
         :text => ['txt'],
         :textile => ['textile', 'txtile'],
-        :asciidoc => ['asciidoc'],
+        :asciidoc => ['asciidoc', 'ad', 'adoc', 'asc'],
         :markdown => ['markdown', 'md', 'mdown', 'mkd'],
         :rdoc => ['rdoc'],
         :ruby => ['rb', 'ru']

data/lib/yard/version.rb

@@ -1,3 +1,3 @@
 module YARD
-  VERSION = "0.8.7.2"
+  VERSION = "0.8.7.3"
 end

data/spec/handlers/alias_handler_spec.rb

@@ -7,9 +7,10 @@ describe "YARD::Handlers::Ruby::#{LEGACY_PARSER ? "Legacy::" : ""}AliasHandler"
     P(:A).aliases[P("A#b")].should == :a
   end
 
-  ['c', 'd?', '[]', '[]=', '-@', '%', '*'].each do |a|
+  ['c', 'd?', '[]', '[]=', '-@', '%', '*', 'cstrkey', 'cstrmeth'].each do |a|
     it "should handle the Ruby 'alias' keyword syntax for method ##{a}" do
       P('A#' + a).should be_instance_of(CodeObjects::MethodObject)
+      P('A#' + a).is_alias?.should be_true
     end
   end
 

data/spec/handlers/examples/alias_handler_001.rb.txt

@@ -1,9 +1,11 @@
 module A
   def a; end
   alias_method :b, :a
+  alias_method :"cstrmeth", :"a"
 
   # Handle keyword syntax too
   alias :c :a
+  alias :"cstrkey" :a
   alias d? a
   alias [] a
   alias []= a

data/spec/server/doc_server_serializer_spec.rb

@@ -41,5 +41,10 @@ describe YARD::Server::DocServerSerializer do
       file = CodeObjects::ExtraFileObject.new('a/b/FooBar.md', '')
       @serializer.serialized_path(file).should == 'file/FooBar'
     end
+
+    it "should handle unicode data" do
+      file = CodeObjects::ExtraFileObject.new("test\u0160", '')
+      @serializer.serialized_path(file).should == 'file/test_C5A0'
+    end if defined?(::Encoding)
   end
 end

data/spec/templates/helpers/html_syntax_highlight_helper_spec.rb

@@ -44,5 +44,10 @@ describe YARD::Templates::Helpers::HtmlSyntaxHighlightHelper do
       should_receive(:options).and_return(Options.new.update(:highlight => true))
       html_syntax_highlight("def &x; ... end").should == "def &x; ... end"
     end if HAVE_RIPPER
+
+    it "should return escaped unhighlighted source if a syntax error is found (ripper)" do
+      should_receive(:options).and_return(Options.new.update(:highlight => true))
+      html_syntax_highlight("$ git clone http://url").should == "$ git clone http://url"
+    end if HAVE_RIPPER
   end
 end

data/templates/default/fulldoc/html/css/style.css

@@ -324,9 +324,9 @@ pre.code .dot + pre.code .id,
 pre.code .rubyid_to_i pre.code .rubyid_each { color: #0085FF; }
 pre.code .comment { color: #0066FF; }
 pre.code .const, pre.code .constant { color: #585CF6; }
+pre.code .label,
 pre.code .symbol { color: #C5060B; }
 pre.code .kw,
-pre.code .label,
 pre.code .rubyid_require,
 pre.code .rubyid_extend,
 pre.code .rubyid_include { color: #0000FF; }

data/templates/default/fulldoc/html/js/app.js

@@ -78,7 +78,12 @@ function framesInit() {
   if (hasFrames) {
     document.body.className = 'frames';
     $('#menu .noframes a').attr('href', document.location);
-    window.top.document.title = $('html head title').text();
+    try {
+      window.top.document.title = $('html head title').text();
+    } catch(error) {
+      // some browsers will not allow this when serving from file://
+      // but we don't want to stop the world.
+    }
   }
   else {
     $('#menu .noframes a').text('frames').attr('href', framesUrl);
@@ -211,4 +216,4 @@ $(linkSummaries);
 $(keyboardShortcuts);
 $(summaryToggle);
 $(fixOutsideWorldLinks);
-$(generateTOC);
+$(generateTOC);

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yard
 version: !ruby/object:Gem::Version
-  version: 0.8.7.2
+  version: 0.8.7.3
 platform: ruby
 authors:
 - Loren Segal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-18 00:00:00.000000000 Z
+date: 2013-11-01 00:00:00.000000000 Z
 dependencies: []
 description: |2
       YARD is a documentation generation tool for the Ruby programming language.