yard-xml 0.1.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in couchbase.gemspec
+gemspec

data/README.markdown

@@ -0,0 +1,20 @@
+# YardXML: an YARD extension for XML output
+
+YardXML is an YARD extension which allows to produce XML output from
+YARD registry.
+
+## Usage
+
+Install the gem:
+
+    gem install yard-xml
+
+Edit ~/.yard/config and insert the following line:
+
+    load_plugins: true
+
+Run yardoc with `-f xml` switch to specify XML format.
+
+    yard -f xml
+
+It will generate `doc/index.xml` file for you.

data/Rakefile

@@ -0,0 +1,20 @@
+# Author:: Couchbase <info@couchbase.com>
+# Copyright:: 2012 Couchbase, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'bundler/gem_tasks'
+
+Dir['tasks/*.rake'].sort.each { |f| load f }

data/lib/templates/default/class/xml/setup.rb

@@ -0,0 +1,38 @@
+# -*- encoding: utf-8 -*-
+# Author:: Couchbase <info@couchbase.com>
+# Copyright:: 2012 Couchbase, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+def init
+  xml = options[:xml_builder]
+  xml.class(:name => object.name, :superclass => object.superclass.name) do
+    xml.summary(docstring_summary(object))
+    xml.description do
+      xml.cdata!(html_markup_rdoc(object.docstring))
+    end
+    if object.respond_to?(:children)
+      object.children.sort_by do |child|
+        [
+          child.type.to_s,
+          child.respond_to?(:scope) ? child.scope.to_s : "",
+          child.name.to_s
+        ]
+      end.each do |child|
+        child.format(options.merge(:type => child.type))
+      end
+    end
+  end
+end

data/lib/templates/default/constant/xml/setup.rb

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+# Author:: Couchbase <info@couchbase.com>
+# Copyright:: 2012 Couchbase, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+def init
+  xml = options[:xml_builder]
+  xml.constant(:name => object.name, :value => object.value) do
+    xml.description do
+      xml.cdata!(html_markup_rdoc(object.docstring))
+    end
+  end
+end

data/lib/templates/default/fulldoc/xml/setup.rb

@@ -0,0 +1,34 @@
+# -*- encoding: utf-8 -*-
+# Author:: Couchbase <info@couchbase.com>
+# Copyright:: 2012 Couchbase, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+def init
+  Templates::Engine.with_serializer('index.xml', options[:serializer]) do
+    xml = Builder::XmlMarkup.new(:indent => 4)
+    xml.documetation do
+      YARD::Registry.root.children.sort_by do |child|
+        [
+          child.type.to_s,
+          child.respond_to?(:scope) ? child.scope.to_s : "",
+          child.name.to_s
+        ]
+      end.each do |child|
+        child.format(options.merge(:xml_builder => xml))
+      end
+    end
+  end
+end

data/lib/templates/default/method/xml/setup.rb

@@ -0,0 +1,185 @@
+# -*- encoding: utf-8 -*-
+# Author:: Couchbase <info@couchbase.com>
+# Copyright:: 2012 Couchbase, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+def init
+  xml = options[:xml_builder]
+  info = {:name => object.name, :scope => object.scope}
+  if object.is_attribute?
+    if object.name:default_format
+    end
+    info[:attribute] = true
+    info[:name] = object.name.to_s.sub(/=$/, '')
+    if rw = object.attr_info
+      if rw[:read]
+        info[:reader] = true
+        object.parent.children.delete(rw[:read])
+        if object.docstring.start_with?("rb_define")
+          object.docstring = rw[:read].docstring
+        end
+      end
+      if rw[:write]
+        info[:writer] = true
+        object.parent.children.delete(rw[:write])
+        if object.docstring.start_with?("rb_define")
+          object.docstring = rw[:write].docstring
+        end
+      end
+    end
+  end
+  if object.has_tag?(:since)
+    info[:since] = object.tag(:since).text
+  end
+  xml.method(info) do
+    xml.summary(docstring_summary(object))
+    if object.tags(:overload).size > 0
+      xml.description(docstring_description(object, object.docstring.summary))
+      xml.notes do
+        object.tags(:note).each do |note|
+          xml.note do
+            xml.cdata!(html_markup_rdoc(note.text || ""))
+          end
+        end
+      end if object.has_tag?(:note)
+    end
+    object.aliases.each do |aa|
+      xml.alias(:name => aa.name)
+    end
+    xml.overloads do
+      if object.tags(:overload).size > 0
+        object.tags(:overload).each do |overload|
+          describe_method(xml, object, overload)
+        end
+      else
+        describe_method(xml, object, object)
+      end
+    end
+  end unless object.is_alias?
+end
+
+def describe_method(xml, object, method)
+  xml.overload do
+    xml.signature(text_signature(method))
+    xml.description(docstring_description(method, object.docstring.summary))
+
+    option_tags = method.tags(:option)
+    [:param, :yieldparam].each do |tag_name|
+      xml.tag!("#{tag_name}s") do
+        method.tags(tag_name).each do |param|
+          info = {:name => param.name}
+          default = method.parameters.assoc(param.name)
+          if default && default[1]
+            info[:default] = default[1]
+          end
+          xml.tag!(param.tag_name, info) do
+            xml.types do
+              if param.types
+                param.types.each do |type|
+                  xml.type(type)
+                end
+              else
+                xml.type("Object")
+              end
+            end
+            options = option_tags.select{|x| x.name.to_s == param.name}
+            unless options.empty?
+              xml.options do
+                options.each do |option|
+                  info = {:name => option.pair.name}
+                  if option.pair.defaults
+                    info[:default] = option.pair.defaults.first
+                  end
+                  xml.option(info) do
+                    xml.types do
+                      if option.pair.types
+                        option.pair.types.each do |type|
+                          xml.type(type)
+                        end
+                      else
+                        xml.type("Object")
+                      end
+                    end
+                    xml.description do
+                      xml.cdata!(html_markup_rdoc(option.pair.text || ""))
+                    end
+                  end
+                end
+              end
+            end
+            xml.description do
+              xml.cdata!(html_markup_rdoc(param.text || ""))
+            end
+          end
+        end
+      end if method.has_tag?(tag_name)
+    end
+
+    [:yieldreturn, :return].each do |tag_name|
+      xml.tag!("#{tag_name}s") do
+        ret = method.tag(tag_name)
+        xml.types do
+          if ret.types
+            ret.types.each do |type|
+              xml.type(type)
+            end
+          else
+            xml.type("Object")
+          end
+        end
+        xml.description do
+          xml.cdata!(html_markup_rdoc(ret.text || ""))
+        end
+      end if method.has_tag?(tag_name)
+    end
+
+    xml.exceptions do
+      method.tags(:raise).each do |exc|
+        xml.exception do
+          xml.types do
+            if exc.types
+              exc.types.each do |type|
+                xml.type(type)
+              end
+            end
+          end
+          xml.description do
+            xml.cdata!(html_markup_rdoc(exc.text || ""))
+          end
+        end
+      end
+    end if method.has_tag?(:raise)
+
+    xml.notes do
+      method.tags(:note).each do |note|
+        xml.note do
+          xml.cdata!(html_markup_rdoc(note.text || ""))
+        end
+      end
+    end if method.has_tag?(:note)
+
+    xml.examples do
+      method.tags(:example).each do |example|
+        xml.example do
+          xml.description do
+            xml.cdata!(html_markup_rdoc(example.name || ""))
+          end
+          xml.code(example.text)
+        end
+      end
+    end if method.has_tag?(:example)
+  end
+end

data/lib/templates/default/module/xml/setup.rb

@@ -0,0 +1,34 @@
+# -*- encoding: utf-8 -*-
+# Author:: Couchbase <info@couchbase.com>
+# Copyright:: 2012 Couchbase, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+def init
+  xml = options[:xml_builder]
+  xml.module(:name => object.name) do
+    if object.respond_to?(:children)
+      object.children.sort_by do |child|
+        [
+          child.type.to_s,
+          child.respond_to?(:scope) ? child.scope.to_s : "",
+          child.name.to_s
+        ]
+      end.each do |child|
+        child.format(options.merge(:type => child.type))
+      end
+    end
+  end
+end

data/lib/yard-xml.rb

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+# Author:: Couchbase <info@couchbase.com>
+# Copyright:: 2012 Couchbase, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require File.dirname(__FILE__) + '/yard-xml/helper'
+YARD::Templates::Template.extra_includes = [YardXML::Helper]
+YARD::Templates::Engine.register_template_path(File.dirname(__FILE__) + '/templates')

data/lib/yard-xml/helper.rb

@@ -0,0 +1,43 @@
+# -*- encoding: utf-8 -*-
+# Author:: Couchbase <info@couchbase.com>
+# Copyright:: 2012 Couchbase, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'builder'
+
+module YardXML
+  module Helper
+
+    include YARD::Templates::Helpers::TextHelper
+    alias :text_signature :signature
+
+    include YARD::Templates::Helpers::HtmlHelper
+    alias :html_signature :signature
+
+    def docstring_summary(object)
+      object.docstring.summary.gsub(/\n\s*/m, ' ')
+    end
+
+    def docstring_description(object, summary)
+      body = object.docstring.to_s.dup
+      if body.start_with?(summary)
+        body[0..summary.size] = ''
+      end
+      html_markup_rdoc(body)
+    end
+
+  end
+end

data/lib/yard-xml/version.rb

@@ -0,0 +1,20 @@
+# Author:: Couchbase <info@couchbase.com>
+# Copyright:: 2012 Couchbase, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module YardXML
+  VERSION = "0.1.0"
+end

data/tasks/package.rake

@@ -0,0 +1,28 @@
+# Author:: Couchbase <info@couchbase.com>
+# Copyright:: 2012 Couchbase, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'rubygems/package_task'
+
+def gemspec
+  @clean_gemspec ||= eval(File.read(File.expand_path('../../yard-xml.gemspec', __FILE__)))
+end
+
+Gem::PackageTask.new(gemspec) do |pkg|
+  pkg.need_zip = true
+  pkg.need_tar = true
+end
+

data/yard-xml.gemspec

@@ -0,0 +1,36 @@
+# -*- encoding: utf-8 -*-
+# Author:: Couchbase <info@couchbase.com>
+# Copyright:: 2012 Couchbase, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+$:.push File.expand_path('../lib', __FILE__)
+require 'yard'
+require 'yard-xml/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'yard-xml'
+  s.version     = YardXML::VERSION
+  s.author      = 'Couchbase'
+  s.email       = 'support@couchbase.com'
+  s.license     = 'ASL-2'
+  s.homepage    = 'http://couchbase.org'
+  s.summary     = %q{XML plugin for YARD tool}
+  s.description = %q{This plugin allows to render YARD documentation into the single XML file for further processing.}
+
+  s.files         = `git ls-files`.split("\n")
+  s.add_dependency 'yard'
+  s.require_paths = ['lib']
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: yard-xml
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Couchbase
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-27 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This plugin allows to render YARD documentation into the single XML file
+  for further processing.
+email: support@couchbase.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.markdown
+- Rakefile
+- lib/templates/default/class/xml/setup.rb
+- lib/templates/default/constant/xml/setup.rb
+- lib/templates/default/fulldoc/xml/setup.rb
+- lib/templates/default/method/xml/setup.rb
+- lib/templates/default/module/xml/setup.rb
+- lib/yard-xml.rb
+- lib/yard-xml/helper.rb
+- lib/yard-xml/version.rb
+- tasks/package.rake
+- yard-xml.gemspec
+homepage: http://couchbase.org
+licenses:
+- ASL-2
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.18
+signing_key: 
+specification_version: 3
+summary: XML plugin for YARD tool
+test_files: []