yard 0.8.7 → 0.8.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d5a75a0de55c021ca90c4b39745a2eaadf856a42
-  data.tar.gz: 097ff460e4d225578721e043e22ea8fe3591fc2f
+  metadata.gz: 208c73915b432a5fabd54f533ca824a1c3b2e26d
+  data.tar.gz: 120c523ff3ca0f0fcdcc42f8981730004d091cde
 SHA512:
-  metadata.gz: 625943ad3908f4ba36764219b7c4ea50ae48ea29fa3bc7779a277871f809013d491157d682f1818a9f7b4d255ed0a4ef2146aaca7eaa1af2e168fac3b60160af
-  data.tar.gz: ba9d09f74bcdd0042af46807c78b3b702248bd57d507c6e14c3db4c8336328178b2ed383469bb1fef0e8ec3616250ea5319a86219c7a9b67acbdcf73817d83e7
+  metadata.gz: dc1f452675e2a7cdd91605ce36c294748d4d427d712e63cea8f157fbb35f5b8425546b0d8cb37dc10b330cb619618e9942ffa86a38f3b832bd423936883675fb
+  data.tar.gz: 1c513dd64c24b5d84aae04ce57c889daf552896f3cf62f243114297b388f68e01abbd9d33c3343078b22bd386df4a52730cdabce2eeeb62ff79836393b08207a

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    
-**Release Date**: July 26th 2013    
+**Latest Version**: 0.8.7.1    
+**Release Date**: September 11th 2013    
 
 ## Synopsis
 
@@ -48,7 +48,7 @@ following method documented with YARD formatting:
      # @param [String, #read] contents the contents to reverse
      # @return [String] the contents reversed lexically
      def reverse(contents)
-       contents = contents.read if respond_to? :read
+       contents = contents.read if contents.respond_to? :read
        contents.reverse
      end
 
@@ -283,6 +283,10 @@ More options can be seen by typing `yard graph --help`, but here is an example:
 
 ## Changelog
 
+- **September.11.13**: 0.8.7.1 release
+    - Fix potential XSS issue with frame anchor support.
+    - Add support for gettext 3.x gem.
+
 - **July.26.13**: 0.8.7 release
     - Added `--hide-api API` option to hide objects with a given `@api` tag (#685).
     - Added "Returns ...." prefix to summary when a lone @return tag is used.

data/lib/yard/i18n/locale.rb

@@ -46,20 +46,12 @@ module YARD
         po_file = File.join(locale_directory, "#{@name}.po")
         return false unless File.exist?(po_file)
 
-        begin
-          require "gettext/tools/poparser"
-          require "gettext/runtime/mofile"
-        rescue LoadError
-          log.warn "Need gettext gem for i18n feature:"
-          log.warn "  gem install gettext"
-          return false
-        end
+        require "yard/i18n/po_parser"
+        return false unless POParser.available?
+
+        po_parser = POParser.new
+        @messages.merge!(po_parser.parse(po_file))
 
-        parser = GetText::PoParser.new
-        parser.report_warning = false
-        data = GetText::MoFile.new
-        parser.parse_file(po_file, data)
-        @messages.merge!(data)
         true
       end
 

data/lib/yard/i18n/po_parser.rb

@@ -0,0 +1,60 @@
+module YARD
+  module I18n
+    # +Locale+ is a wrapper for gettext's PO parsing feature. It hides
+    # gettext API difference from YARD.
+    #
+    # @since 0.8.8
+    class POParser
+      if RUBY_VERSION < "1.9"
+        begin
+          require "gettext/tools/poparser"
+          require "gettext/runtime/mofile"
+          @@gettext_version = 2
+        rescue LoadError
+          log.warn "Need gettext gem 2.x for i18n feature:"
+          log.warn "  gem install gettext -v 2.3.9"
+        end
+      else
+        begin
+          require "gettext/po_parser"
+          require "gettext/mo"
+          @@gettext_version = 3
+        rescue LoadError
+          begin
+            require "gettext/tools/poparser"
+            require "gettext/runtime/mofile"
+            @@gettext_version = 2
+          rescue LoadError
+            log.warn "Need gettext gem for i18n feature:"
+            log.warn "  gem install gettext"
+          end
+        end
+      end
+
+      class << self
+        # @return [Boolean] true if gettext is available, false otherwise.
+        def available?
+          !@@gettext_version.nil?
+        end
+      end
+
+      # Parses PO file.
+      #
+      # @param [String] file path of PO file to be parsed.
+      # @return [Hash<String, String>] parsed messages.
+      def parse(file)
+        case @@gettext_version
+        when 2
+          parser = GetText::PoParser.new
+          data = GetText::MoFile.new
+        when 3
+          parser = GetText::POParser.new
+          data = GetText::MO.new
+        end
+        parser.report_warning = false
+        parser.parse_file(file, data)
+        data
+      end
+    end
+  end
+end

data/lib/yard/version.rb

@@ -1,3 +1,3 @@
 module YARD
-  VERSION = "0.8.7"
+  VERSION = "0.8.7.1"
 end

data/spec/i18n/locale_spec.rb

@@ -22,11 +22,24 @@ describe YARD::I18n::Locale do
     end
 
     have_gettext_gem = true
-    begin
-      require "gettext/tools/poparser"
-    rescue LoadError
-      have_gettext_gem = false
+    if RUBY_VERSION < "1.9"
+      begin
+        require "gettext/tools/poparser"
+      rescue LoadError
+        have_gettext_gem = false
+      end
+    else
+      begin
+        require "gettext/po_parser"
+      rescue LoadError
+        begin
+          require "gettext/tools/poparser"
+        rescue LoadError
+          have_gettext_gem = false
+        end
+      end
     end
+
     it "should return true for existent PO", :if => have_gettext_gem do
       data = <<-eop
 msgid ""
@@ -39,9 +52,9 @@ msgstr ""
 msgid "Hello"
 msgstr "Bonjour"
 eop
-      parser = GetText::PoParser.new
+      parser = GetText::POParser.new
       File.should_receive(:exist?).with('foo/fr.po').and_return(true)
-      GetText::PoParser.should_receive(:new).and_return(parser)
+      GetText::POParser.should_receive(:new).and_return(parser)
       parser.should_receive(:parse_file) do |file, hash|
         file.should == 'foo/fr.po'
         parser.parse(data, hash)

data/templates/default/fulldoc/html/frames.erb

@@ -8,14 +8,11 @@
 </head>
 <script type="text/javascript" charset="utf-8">
 window.onload = function() {
-  var match = window.location.hash.match(/^#!(.+)/);
-  var name = '<%= url_for_main %>';
-  if (match) {
-    name = unescape(match[1]);
-  }
+  var match = unescape(window.location.hash).match(/^#!(.+)/);
+  var name = match ? match[1] : '<%= url_for_main %>';
   document.writeln('<frameset cols="20%,*">' +
     '<frame name="list" src="<%= url_for_list('class') %>" />' +
-    '<frame name="main" src="' + name + '" />' +
+    '<frame name="main" src="' + escape(name) + '" />' +
     '</frameset>');
 }
 </script>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yard
 version: !ruby/object:Gem::Version
-  version: 0.8.7
+  version: 0.8.7.1
 platform: ruby
 authors:
 - Loren Segal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-26 00:00:00.000000000 Z
+date: 2013-09-11 00:00:00.000000000 Z
 dependencies: []
 description: |2
       YARD is a documentation generation tool for the Ruby programming language.
@@ -146,6 +146,7 @@ files:
 - lib/yard/i18n/locale.rb
 - lib/yard/i18n/message.rb
 - lib/yard/i18n/messages.rb
+- lib/yard/i18n/po_parser.rb
 - lib/yard/i18n/pot_generator.rb
 - lib/yard/i18n/text.rb
 - lib/yard/logging.rb