yard-appendix 0.1.6 → 0.1.8

data/lib/yard-appendix.rb

@@ -23,19 +23,22 @@
 $LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__)))
 
 require 'yard'
-require 'yard-appendix/version'
-require 'yard-appendix/namespace_resolver'
-require 'yard-appendix/code_objects/appendix_object'
-require 'yard-appendix/tags/appendix_directive'
-require 'yard-appendix/handlers/appendix_handler'
-require 'yard-appendix/templates/helpers/html_helper'
 
 module YARD
   module AppendixPlugin
     ROOT          = File.dirname(__FILE__)
     TEMPLATE_PATH = File.join(%W[#{ROOT} .. templates])
+    RUBY_19       = RUBY_VERSION >= '1.9.'
   end
 
+  require 'yard-appendix/version'
+  require 'yard-appendix/namespace_resolver'
+  require 'yard-appendix/code_objects/appendix_object'
+  require 'yard-appendix/tags/appendix_directive'
+  require 'yard-appendix/handlers/ruby/appendix_handler' if RUBY19
+  require 'yard-appendix/handlers/ruby/legacy/appendix_handler' unless RUBY19
+  require 'yard-appendix/templates/helpers/html_helper'
+  
   module Templates
     Engine.register_template_path YARD::AppendixPlugin::TEMPLATE_PATH
   end
@@ -43,4 +46,4 @@ module YARD
   module Tags
     Library.define_directive(:appendix, :with_title_and_text, AppendixDirective)
   end
-end
+end

data/lib/yard-appendix/handlers/appendix_handler.rb

@@ -20,7 +20,7 @@
 # SOFTWARE.
 #
 
-require 'yard/handlers/ruby/comment_handler'
+require 'yard/handlers/ruby/base'
 
 module YARD
   module Handlers
@@ -29,7 +29,7 @@ module YARD
       # it with the NamespaceResolver.
       #
       # @see YARD::AppendixPlugin::NamespaceResolver
-      class AppendixHandler < CommentHandler
+      class AppendixHandler < BaseHandler
         handles :class, :module
 
         def initialize(*args)
@@ -43,7 +43,6 @@ module YARD
         end
       end # AppendixHandler
 
-      CommentHandler.inherited(AppendixHandler)
     end # Ruby
   end # Handlers
 end # YARD

data/lib/yard-appendix/handlers/ruby/appendix_handler.rb

@@ -0,0 +1,49 @@
+#
+# Copyright (c) 2013 Instructure, Inc.
+#
+# Permission is hereby granted, free of charge, to any person obtaining a
+# copy of this software and associated documentation files (the "Software"),
+# to deal in the Software without restriction, including without limitation
+# the rights to use, copy, modify, merge, publish, distribute, sublicense,
+# and/or sell copies of the Software, and to permit persons to whom the
+# Software is furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+#
+
+require 'yard/handlers/ruby/comment_handler'
+
+module YARD
+  module Handlers
+    module Ruby
+      # Tracks every namespace defining statement and registers
+      # it with the NamespaceResolver.
+      #
+      # @see YARD::AppendixPlugin::NamespaceResolver
+      class AppendixHandler < CommentHandler
+        handles :class, :module
+
+        def initialize(*args)
+          super(*args)
+
+          globals.resolver ||= YARD::AppendixPlugin::NamespaceResolver.new
+        end
+
+        def process
+          globals.resolver.register_namespace(statement, namespace)
+        end
+      end # AppendixHandler
+
+      CommentHandler.inherited(AppendixHandler)
+    end # Ruby
+  end # Handlers
+end # YARD

data/lib/yard-appendix/handlers/ruby/legacy/appendix_handler.rb

@@ -0,0 +1,26 @@
+require 'yard/handlers/ruby/legacy/base'
+
+
+module YARD
+  module Handlers
+    module Ruby
+      module Legacy
+        class AppendixHandler < Base
+          MATCH = /\A(class|module)\s+([\w|_])+\s*[<|;|\n]?/
+          handles MATCH
+          
+          def initialize(*args)
+            super(*args)
+
+            globals.resolver ||= YARD::AppendixPlugin::NamespaceResolver.new
+          end
+
+          def process
+            ns = statement.tokens.to_s.split(/\s+/).last
+            globals.resolver.register_namespace(ns, namespace)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yard-appendix/namespace_resolver.rb

@@ -118,7 +118,7 @@ module YARD
         lines_to_namespaces.each_pair { |line, ast|
           distance = statement.line - line
           if closest.empty? || distance < closest[:distance]
-            closest = { node: ast, distance: distance }
+            closest = { :node => ast, :distance => distance }
           end
         }
 
@@ -134,16 +134,43 @@ module YARD
           end
         end
 
-        path += case node.type
-        when :class;  node.class_name.path.first
-        when :module; node.module_name.path.first
+
+        if node.is_a?(YARD::Parser::Ruby::AstNode)
+          path += case node.type
+          when :class;  node.class_name.path.first
+          when :module; node.module_name.path.first
+          end
+        else
+          path += node.to_s
         end
+        
+        path
       end
 
       def path_to(ast, ns)
         (ast && @namespaces[path_from_ast(ast, ns)]) || ns.to_s
       end
 
+      # Legacy YARD handler compatibility
+      module LegacyResolver
+        def self.included(b)
+          log.debug "yard-appendix: namespace resolver running in legacy mode"
+          
+          b.instance_eval { 
+            remove_method(:locate_enclosing_ns)
+            include InstanceMethods
+          }
+        end
+        
+        module InstanceMethods
+          def locate_enclosing_ns(__comment, outer_ns)
+            outer_ns.to_s
+          end
+        end
+      end
+      
+      include(LegacyResolver) unless RUBY19
     end
+    
   end
 end

data/lib/yard-appendix/version.rb

@@ -22,6 +22,6 @@
 
 module YARD
   module AppendixPlugin
-    VERSION = "0.1.6"
+    VERSION = "0.1.8"
   end
 end

data/spec/handlers/appendix_handler_spec.rb

@@ -20,6 +20,8 @@
 # SOFTWARE.
 #
 
+unless RUBY_VERSION < '1.9.'
+
 include Handlers::Ruby
 
 describe YARD::Handlers::Ruby::AppendixHandler do
@@ -34,14 +36,14 @@ describe YARD::Handlers::Ruby::AppendixHandler do
       def process; @@resolver ||= globals.resolver end
 
       # have to do this manually as to not clutter up the other specs
-      AppendixHandler.clear_subclasses
+      # AppendixHandler.clear_subclasses
     end
 
-    AppendixHandler.inherited(StubHandler)
+    # AppendixHandler.inherited(StubHandler)
   }
 
   after {
-    AppendixHandler.clear_subclasses
+    # AppendixHandler.clear_subclasses
   }
 
   it "should track a namespace statement" do
@@ -114,4 +116,5 @@ describe YARD::Handlers::Ruby::AppendixHandler do
 
   end
 
+end
 end

data/spec/handlers/appendix_legacy_handler_spec.rb

@@ -0,0 +1,120 @@
+#
+# Copyright (c) 2013 Instructure, Inc.
+#
+# Permission is hereby granted, free of charge, to any person obtaining a
+# copy of this software and associated documentation files (the "Software"),
+# to deal in the Software without restriction, including without limitation
+# the rights to use, copy, modify, merge, publish, distribute, sublicense,
+# and/or sell copies of the Software, and to permit persons to whom the
+# Software is furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+#
+
+unless RUBY19
+
+include Handlers::Ruby::Legacy
+
+describe YARD::Handlers::Ruby::Legacy::AppendixHandler do
+
+  before {
+    Registry.clear
+
+    class StubHandler < AppendixHandler
+      handles AppendixHandler::MATCH
+
+      def self.resolver; @@resolver end
+      def process; @@resolver ||= globals.resolver end
+    end
+  }
+
+  it "should track a namespace statement" do
+    YARD.parse_string <<-'eof'
+      module SomeModule
+        class SomeClass
+          # comment in SomeClass
+        end
+
+        # comment in SomeModule
+      end
+    eof
+
+    StubHandler.resolver.namespaces.size.should == 2
+    StubHandler.resolver.namespaces["SomeModule"].should == "SomeModule"
+    StubHandler.resolver.namespaces["SomeClass"].should == "SomeModule::SomeClass"
+  end
+
+  it "should locate an enclosing ns for a comment" do
+    class StubCommentHandler < Handlers::Ruby::Legacy::Base
+      handles TkCOMMENT
+      namespace_only
+
+      class << self
+        def comments; @@comments end
+      end
+
+      def process
+        @@comments ||= []
+        @@comments << [ statement.tokens.to_s, namespace ]
+      end
+    end
+
+
+    YARD.parse_string <<-'eof'
+      module SomeModule
+        class SomeClass
+          def f() end
+          # comment in SomeClass
+          
+          # another comment in SomeClass
+        end
+
+        # comment in SomeModule
+      end # should be ignored
+
+      # comment in :root
+    eof
+
+    comments = StubCommentHandler.comments
+    comments.size.should == 4
+
+    resolver = StubHandler.resolver
+    resolver.namespaces.size.should == 2
+
+    resolver.
+      namespace_for(
+        comments[0][0],
+        comments[0][1]).
+      should == Registry.at('SomeModule::SomeClass')
+    
+    resolver.
+      namespace_for(
+        comments[1][0],
+        comments[1][1]).
+      should == Registry.at('SomeModule::SomeClass')
+
+    resolver.
+      namespace_for(
+        comments[2][0],
+        comments[2][1]).
+      should == Registry.at('SomeModule')
+
+    resolver.
+      namespace_for(
+        comments[3][0],
+        comments[3][1]).
+      should == Registry.root
+
+  end
+
+end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yard-appendix
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-05 00:00:00.000000000 Z
+date: 2013-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -56,11 +56,14 @@ files:
 - lib/yard-appendix/code_objects/appendix_object.rb
 - lib/yard-appendix/version.rb
 - lib/yard-appendix/handlers/appendix_handler.rb
+- lib/yard-appendix/handlers/ruby/appendix_handler.rb
+- lib/yard-appendix/handlers/ruby/legacy/appendix_handler.rb
 - lib/yard-appendix/namespace_resolver.rb
 - lib/yard-appendix/tags/appendix_directive.rb
 - lib/yard-appendix/templates/helpers/html_helper.rb
 - lib/yard-appendix.rb
 - spec/code_objects/appendix_object_spec.rb
+- spec/handlers/appendix_legacy_handler_spec.rb
 - spec/handlers/appendix_handler_spec.rb
 - spec/spec_helper.rb
 - spec/tags/appendix_directive_spec.rb