yard 0.8.4 → 0.8.4.1

data/ChangeLog

@@ -1,6 +1,21 @@
+2013-02-05  Loren Segal <lsegal@soen.ca>
+
+  * ChangeLog, README.md, lib/yard/version.rb: Bump to 0.8.4.1
+
+  * lib/yard/code_objects/base.rb: Fix regression in loading codeobjects from
+  db  An instance variable in CodeObjects::Base was renamed (@docstring to
+  @base_docstring). Although this did not affect newly generated projects, it
+  broke the ability to properly load up yardoc databases generated with
+  versions prior to 0.8.4.  For backwards compatibility, this ivar has been
+  named back so that existing databases can still be loaded via YARD.  Fixes
+  #648
+
 2013-02-04  Loren Segal <lsegal@amazon.com>
 
-  * LICENSE, README.md, docs/WhatsNew.md, lib/yard/version.rb: Bump to 0.8.4
+  * README.md: Fix README formatting
+
+  * ChangeLog, LICENSE, README.md, docs/WhatsNew.md, lib/yard/version.rb: Bump
+  to 0.8.4
 
 2013-02-01  Loren Segal <lsegal@amazon.com>
 

data/README.md

@@ -8,8 +8,8 @@ YARD: Yay! A Ruby Documentation Tool
 **Contributors**: See Contributors section below    
 **Copyright**:    2007-2013    
 **License**:      MIT License    
-**Latest Version**: 0.8.4    
-**Release Date**: February 4th 2013    
+**Latest Version**: 0.8.4.1    
+**Release Date**: February 5th 2013    
 
 Synopsis
 --------
@@ -286,6 +286,9 @@ More options can be seen by typing `yard graph --help`, but here is an example:
 
 ## Changelog
 
+- **February.5.13**: 0.8.4.1 release
+    - Fix regression that broke loading of existing yardoc dbs (#648)
+
 - **February.4.13**: 0.8.4 release
     - Add `-B/--bind` switch to yard server (#593, #608)
     - Add CodeObjects::Base#title for plugins to customize how object

data/lib/yard/code_objects/base.rb

@@ -140,6 +140,8 @@ module YARD
       # @return [Docstring] the documentation string
       # @since 0.8.4
       attr_reader :base_docstring
+      undef base_docstring
+      def base_docstring; @docstring end
 
       # Marks whether or not the method is conditionally defined at runtime
       # @return [Boolean] true if the method is conditionally defined at runtime
@@ -220,7 +222,7 @@ module YARD
         @visibility = :public
         @tags = []
         @docstrings = {}
-        @base_docstring = Docstring.new('', self)
+        @docstring = Docstring.new('', self)
         @namespace = nil
         self.namespace = namespace
         yield(self) if block_given?
@@ -237,7 +239,7 @@ module YARD
           ivar = "@#{ivar}"
           other.instance_variable_set(ivar, instance_variable_get(ivar))
         end
-        other.docstring = @base_docstring.to_raw
+        other.docstring = @docstring.to_raw
         other
       end
 
@@ -372,8 +374,8 @@ module YARD
       # @return [Docstring] the documentation string
       def docstring(locale = I18n::Locale.default)
         if locale.nil?
-          @base_docstring.resolve_reference
-          return @base_docstring
+          @docstring.resolve_reference
+          return @docstring
         end
 
         if locale.is_a?(String)
@@ -395,9 +397,9 @@ module YARD
       def docstring=(comments)
         @docstrings.clear
         if Docstring === comments
-          @base_docstring = comments
+          @docstring = comments
         else
-          @base_docstring = Docstring.new(comments, self)
+          @docstring = Docstring.new(comments, self)
         end
       end
 
@@ -525,7 +527,7 @@ module YARD
       # @since 0.8.4
       def add_tag(*tags)
         @docstrings.clear
-        @base_docstring.add_tag(*tags)
+        @docstring.add_tag(*tags)
       end
 
       # @return whether or not this object is a RootObject
@@ -551,7 +553,7 @@ module YARD
       # @since 0.8.0
       def copyable_attributes
         vars = instance_variables.map {|ivar| ivar.to_s[1..-1] }
-        vars -= %w(base_docstring docstrings namespace name path)
+        vars -= %w(docstring docstrings namespace name path)
         vars
       end
 
@@ -569,13 +571,13 @@ module YARD
       end
 
       def translate_docstring(locale)
-        @base_docstring.resolve_reference
-        return @base_docstring if locale.nil?
+        @docstring.resolve_reference
+        return @docstring if locale.nil?
 
-        text = I18n::Text.new(@base_docstring)
+        text = I18n::Text.new(@docstring)
         localized_text = text.translate(locale)
         docstring = Docstring.new(localized_text, self)
-        docstring.add_tag(*@base_docstring.tags)
+        docstring.add_tag(*@docstring.tags)
         docstring
       end
     end

data/lib/yard/version.rb

@@ -1,3 +1,3 @@
 module YARD
-  VERSION = "0.8.4"
+  VERSION = "0.8.4.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yard
 version: !ruby/object:Gem::Version
-  version: 0.8.4
+  version: 0.8.4.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-04 00:00:00.000000000 Z
+date: 2013-02-05 00:00:00.000000000 Z
 dependencies: []
 description: ! "    YARD is a documentation generation tool for the Ruby programming
   language.\n    It enables the user to generate consistent, usable documentation