yard-tomdoc 0.3.0 → 0.3.1

data/HISTORY.md

@@ -1,5 +1,17 @@
 # RELEASE HISTORY
 
+
+## 0.3.1 | 2011-11-10
+
+This release simply modernizes the build configuration
+and adds an systems test. Functionally it has not changed.
+
+Changes:
+
+* Modernize the build configuration.
+* Add systems test and integrate Travis CI.
+
+
 ## 0.3.0 | 2011-06-08
 
 Okay,looks like tomdoc is ready to handle the dependency. If there

data/NOTICE.md

@@ -1,17 +1,37 @@
-COPYRIGHT NOTICES
-=================
+# COPYRIGHT NOTICES
 
-Yard TomDoc
------------
 
-Copyright (c) 2010 Loren Segal, Thomas Sawyer
+## YARD Tomdoc 
 
-Distributed under the terms of the MIT License (see MIT.txt).
+**Copyright (c) 2010 Loren Segal, Thomas Sawyer**
 
+Distributed under the terms of the MIT License (see below).
 
-TomDoc
-------
 
-Copyright (c) 2010 Tom Preston-Werner, Chris Wanstrath
+## Tomdoc 
+
+**Copyright (c) 2010 Tom Preston-Werner, Chris Wanstrath**
+
+Distributed under the terms of the MIT License (see below).
+
+
+## The MIT License
+
+    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.
 
-Distributed under the terms of the MIT License (see MIT.txt).

data/README.md

@@ -1,5 +1,12 @@
 # yard-tomdoc
 
+| Author:    | Thomas Sawyer <transfire@gmail.com>      |
+|------------|------------------------------------------------|
+| Copyright: | (c) 2010 Loren Segal, Thomas Sawyer            |
+| Home:      | http://rubyworks.github.com/yard-tomdoc        |
+| Issues:    | http://github.com/rubyworks/yard-tomdoc/issues |
+| Status:    | [![Build Status](https://secure.travis-ci.org/rubyworks/yard-tomdoc.png)](http://travis-ci.org/rubyworks/yard-tomdoc) |
+
 
 ## Description
 

data/lib/yard-tomdoc/tomdoc.rb

@@ -72,11 +72,11 @@ module TomDoc
 
     # Returns [String] cleansed comment text.
     def tomdoc
-      raw
-      #clean = raw.split("\n").map do |line|
-      #  line =~ /^(\s*# ?)/ ? line.sub($1, '') : line
-      #end.compact.join("\n")
-      #clean
+      #raw
+      clean = raw.split("\n").map do |line|
+        line =~ /^(\s*# ?)/ ? line.sub($1, '') : nil
+      end.compact.join("\n")
+      clean
     end
 
     # Returns [Array] document split into sections.

data/lib/yard-tomdoc/version.rb

@@ -0,0 +1,6 @@
+module YARD
+  module TomDoc
+    VERSION = "0.3.1"
+  end
+end
+

data/lib/yard-tomdoc-intern.rb

@@ -1,2 +1,3 @@
 require 'yard-tomdoc/tomdoc'
 require 'yard-tomdoc/yard'
+

data/test/helper.rb

@@ -0,0 +1,6 @@
+$:.unshift File.expand_path(File.dirname(__FILE__)) + "/../lib"
+
+require 'fileutils'
+require 'minitest/spec'
+require 'minitest/autorun'
+

data/test/system/sample/lib/example.rb

@@ -0,0 +1,23 @@
+# This is an example class.
+class Example
+
+  # Jump is not the kind of method you bring
+  # home to mother.
+  #
+  # how_high - Integer height of the jump
+  #
+  # Examples
+  #
+  #   Example.new.jump  #=> "tartar"
+  #
+  # Returns String of tartar.
+  def jump(how_high=nil)
+    "tartar"
+  end
+
+  # This is a subexample.
+  class SubExample
+  end
+
+end
+

data/test/system/sample/lib/hello_world.rb

@@ -0,0 +1,13 @@
+# This is your typical "hello world" class.
+class HelloWorld
+
+  # Hello simply prints out a greeting.
+  #
+  # string - Object that responds to #to_s.
+  #
+  # Returns nothing.
+  def hello(string="World")
+    puts "Hello #{string}"
+  end
+
+end

data/test/system/test_yardoc.rb

@@ -0,0 +1,30 @@
+dir = File.expand_path(File.dirname(__FILE__))
+tmp = dir + '/../../tmp'
+
+require dir + "/../helper.rb"
+
+# This test is design to run `yard doc` on the sample project and
+# check to make sure it was produced successufully.
+#
+# NOTE: There is only one test b/c generation has to happen first
+# and minitest will randomize the order of tests. You have fix?
+#
+describe "yard doc" do
+
+  before do
+    FileUtils.mkdir(tmp) unless File.directory?(tmp)
+    FileUtils.cp_r(dir + '/sample', tmp)
+  end
+
+  it "should generate documentation" do
+    Dir.chdir(tmp + '/sample') do
+      success = system "yard doc --plugin yard-tomdoc lib/"
+
+      assert(success, "failed to generate yard documentation")
+      assert File.directory?('doc')
+
+      # TODO: more verifications
+    end
+  end
+
+end

data/test/{test_docstring.rb → unit/test_docstring.rb}

@@ -1,29 +1,27 @@
-$:.unshift File.expand_path(File.dirname(__FILE__)) + "/../lib"
-
-require 'minitest/autorun'
+require File.expand_path(File.dirname(__FILE__)) + "/../helper.rb"
 
 require "yard"
-require "yard-tomdoc"
+#require "yard-tomdoc"
 
 # TODO: make separate test for this
-#require "yard-tomdoc-intern"
+require "yard-tomdoc-intern"
 
 describe YARD::Docstring do
 
   before do
     @docstring = YARD::Docstring.new <<-eof
-Duplicate some text an arbitrary number of times.
-
-text  - The String to be duplicated.
-count - The Integer number of times to duplicate the text.
-
-Examples
-  multiplex('Tom', 4)
-  # => 'TomTomTomTom'
-
-Returns the duplicated String.
-
-Raises ArgumentError if something bad happened
+# Duplicate some text an arbitrary number of times.
+# 
+# text  - The String to be duplicated.
+# count - The Integer number of times to duplicate the text.
+# 
+# Examples
+#   multiplex('Tom', 4)
+#   # => 'TomTomTomTom'
+#
+# Returns the duplicated String.
+#
+# Raises ArgumentError if something bad happened
 eof
   end
 

metadata

@@ -1,105 +1,108 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: yard-tomdoc
-version: !ruby/object:Gem::Version 
-  hash: 19
+version: !ruby/object:Gem::Version
+  version: 0.3.1
   prerelease: 
-  segments: 
-  - 0
-  - 3
-  - 0
-  version: 0.3.0
 platform: ruby
-authors: 
-- Loren Segal
+authors:
 - Thomas Sawyer
+- Loren Segal
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-06-08 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: ko
+date: 2012-02-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &30272280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *30272280
+- !ruby/object:Gem::Dependency
+  name: detroit
+  requirement: &30271760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
   prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: *30271760
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &30271260 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: redline
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *30271260
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &30270760 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
-description: Implements [TomDoc](http://tomdoc.org) syntax for YARD. 'Nuff said.
-email: transfire@gmail.com
+  prerelease: false
+  version_requirements: *30270760
+description: Use TomDoc documentation format with YARD.
+email:
+- transfire@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
+- HISTORY.md
 - README.md
-files: 
+- NOTICE.md
+files:
 - lib/yard-tomdoc/arg.rb
 - lib/yard-tomdoc/tomdoc.rb
+- lib/yard-tomdoc/version.rb
 - lib/yard-tomdoc/yard.rb
 - lib/yard-tomdoc-intern.rb
 - lib/yard-tomdoc.rb
-- test/test_docstring.rb
+- test/helper.rb
+- test/system/sample/lib/example.rb
+- test/system/sample/lib/hello_world.rb
+- test/system/test_yardoc.rb
+- test/unit/test_docstring.rb
 - HISTORY.md
 - README.md
-- MIT.txt
 - NOTICE.md
 homepage: http://rubyworks.github.com/yard-tomdoc
-licenses: 
+licenses:
 - MIT
 post_install_message: 
-rdoc_options: 
-- --title
-- YARD-TomDoc API
-- --main
-- README.md
-require_paths: 
+rdoc_options: []
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: yard-tomdoc
-rubygems_version: 1.8.2
+rubyforge_project: 
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: TomDoc for YARD
 test_files: []
-

data/MIT.txt

@@ -1,20 +0,0 @@
-The MIT License
-
-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.
-