yard-qed 0.1.0

data/.ruby

@@ -0,0 +1,44 @@
+---
+source:
+- var
+authors:
+- name: Trans
+  email: transfire@gmail.com
+copyrights:
+- holder: Rubyworks
+  year: '2011'
+replacements: []
+alternatives: []
+requirements:
+- name: yard
+- name: detroit
+  groups:
+  - build
+  development: true
+dependencies: []
+conflicts: []
+repositories:
+- uri: git://github.com/rubyworks/yard-qed.git
+  scm: git
+  name: upstream
+resources:
+  home: http://rubyworks.github.com/yard-qed
+  code: http://github.com/rubyworks/yard-qed
+  mail: http://groups.google.com/group/rubyworks-mailinglist
+  bugs: http://github.com/rubyworks/yard-qed/issues
+extra: {}
+load_path:
+- lib
+revision: 0
+created: '2011-11-18'
+summary: QED plugin for YARD
+title: YARD QED
+version: 0.1.0
+name: yard-qed
+description: ! 'YARD QED is a plugin for YARD that automatically
+
+  adds a QED document directory to YARD docs as a
+
+  single document.'
+organization: rubyworks
+date: '2011-11-19'

data/.yardopts

@@ -0,0 +1,8 @@
+--output-dir doc
+--readme README.rdoc
+--title "YARD QED"
+--protected
+--private
+lib
+-
+[A-Z]*.*

data/COPYING.rdoc

@@ -0,0 +1,31 @@
+= COPYRIGHT NOTICES
+
+== YARD QED
+
+Copyright:: (c) 2011 Rubyworks
+License:: BSD-2-Clause
+Website:: http://rubyworks.github.com/yard-qed
+
+    Copyright 2011 Rubyworks. All rights reserved.
+
+    Redistribution and use in source and binary forms, with or without
+    modification, are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+
+    THIS SOFTWARE IS PROVIDED BY Thomas Sawyer ``AS IS'' AND ANY EXPRESS
+    OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+    OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
+    NO EVENT SHALL Thomas Sawyer OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+    INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+    BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+    DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
+    OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+    EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

data/HISTORY.rdoc

@@ -0,0 +1,13 @@
+= RELEASE HISTORY
+
+== 0.1.0 | 2011-11-19
+
+Initial release of QED plugin for YARD. This plugin
+allows YARD to generate a single QED document to be
+included in the YARD documentation files, without any
+need to create and track an intermediary file (via qedoc).
+
+Changes:
+
+* Happy 1sts.
+

data/README.rdoc

@@ -0,0 +1,41 @@
+= YARD QED
+
+{Website}[http://github.com/rubyworks/yard-qed] |
+{Source Code}[http://github.com/rubyworls/yard-qed] |
+{Mailing List}[http://groups.google.com/group/rubyworks-mailinglist] |
+#rubyworks
+
+
+== Description
+
+Automatically add QED docs to YARD docs without need to create
+any intermediary files.
+
+
+== Usage
+
+As with most YARD plugins.
+
+  $ yardoc --plugin qed
+
+This will look for one of the default `qed`, `demo` or `spec` directories,
+and use the files located there.
+
+
+== Limitations
+
+* It is assume all your QED docs are in one format. Mixing and matching
+between RDoc and Markdown might cause some rendering issues.
+
+* There is currently no way to set
+the location or file globs to anything else --patches welcome.
+
+
+== Copying
+
+Copyright (c) 2011 Rubyworks. All rights reserved.
+
+YARD QED is distributable in accordance with the terms of
+the *BSD-2-Clause* license.
+
+See COPYING.rdoc for details.

data/lib/yard-qed.rb

@@ -0,0 +1,31 @@
+module YARD::CodeObjects
+  class QEDFileObject < ExtraFileObject
+    #
+    def initialize(dirname)
+      self.filename = dirname
+      self.name = File.basename(filename).gsub(/\.[^.]+$/, '').upcase
+      self.attributes = SymbolHash.new(false)
+
+      files = Dir["#{dirname}/**/*{.rdoc,.md,.qed,.markdown}"]
+      files = files.reject{ |f| File.directory?(f) }
+      files = files.sort
+      contents = files.map{ |f| File.read(f) }.join("\n\n")
+
+      parse_contents(contents)
+    end
+  end
+end
+
+module YARD
+  module CLI
+    class Yardoc
+      alias run_without_qed run
+      def run(*args)
+        dir = Dir['{qed/,demo/,spec/}'].first.chomp('/')
+        @options[:files] << CodeObjects::QEDFileObject.new(dir)
+        run_without_qed(*args)
+      end
+    end
+  end
+end
+

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: yard-qed
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Trans
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &14341000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *14341000
+- !ruby/object:Gem::Dependency
+  name: detroit
+  requirement: &14339440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *14339440
+description: ! 'YARD QED is a plugin for YARD that automatically
+
+  adds a QED document directory to YARD docs as a
+
+  single document.'
+email:
+- transfire@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- HISTORY.rdoc
+- README.rdoc
+- COPYING.rdoc
+files:
+- .ruby
+- .yardopts
+- lib/yard-qed.rb
+- HISTORY.rdoc
+- README.rdoc
+- COPYING.rdoc
+homepage: http://rubyworks.github.com/yard-qed
+licenses: []
+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.10
+signing_key: 
+specification_version: 3
+summary: QED plugin for YARD
+test_files: []