tomdoc 0.1.0 → 0.2.0

data/README.md

@@ -1,8 +1,8 @@
 TomDoc
 ======
 
-TomDoc is documentation for humans.  Using a few simple rules and zero 
-special syntax you can produce great looking documentation for both humans 
+TomDoc is documentation for humans.  Using a few simple rules and zero
+special syntax you can produce great looking documentation for both humans
 and machines.
 
 Just follow these four easy steps:
@@ -100,5 +100,15 @@ or
 
 ![html](http://img.skitch.com/20100408-dbhtc4mef2q3ygmn63csxgh14w.png)
 
+Local Dev
+---------
+
+Want to hack on tomdoc.rb? Of course you do.
+
+    git clone http://github.com/defunkt/tomdoc.git
+    cd tomdoc
+    bundle install --local
+    ruby -rubygems ./bin/tomdoc lib/tomdoc/source_parser.rb
+
 [man]: https://github.com/defunkt/tomdoc/blob/tomdoc.rb/man/tomdoc.5.ronn
 [spec]: https://github.com/defunkt/tomdoc/blob/tomdoc.rb/tomdoc.md

data/bin/tomdoc

@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
 
+$:.unshift File.dirname(__FILE__) + '/../lib'
 require 'tomdoc'
 
 # Process options

data/lib/tomdoc/generators/html.rb

@@ -6,6 +6,7 @@ module TomDoc
       end
 
       def write_scope_header(scope, prefix)
+        #write "<h1>#{scope.name}</h1>"
       end
 
       def write_scope_footer(scope, prefix)
@@ -13,13 +14,13 @@ module TomDoc
 
       def write_class_methods(scope, prefix)
         out = '<ul>'
-        out << super.to_s
+        out << super.join
         write out
       end
 
       def write_instance_methods(scope, prefix)
         out = ''
-        out << super.to_s
+        out << super.join
         out << '</ul>'
         write out
       end

data/lib/tomdoc/source_parser.rb

@@ -86,9 +86,15 @@ module TomDoc
         process(ast[3], new_scope)
       when :imethod
         ast.shift
+        if !scope
+          scope = (@scopes[:main] ||= Scope.new(:main))
+        end
         scope.instance_methods << Method.new(*ast)
       when :cmethod
         ast.shift
+        if !scope
+          scope = (@scopes[:main] ||= Scope.new(:main))
+        end
         scope.class_methods << Method.new(*ast)
       when Array
         ast.map { |a| process(a, scope) }

data/lib/tomdoc/tomdoc.rb

@@ -66,6 +66,8 @@ module TomDoc
       args = []
       last_indent = nil
 
+      return args unless sections[1]
+
       sections[1].split("\n").each do |line|
         next if line.strip.empty?
         indent = line.scan(/^\s*/)[0].to_s.size

data/lib/tomdoc/version.rb

@@ -1,3 +1,3 @@
 module TomDoc
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/test/helper.rb

@@ -5,7 +5,7 @@ require 'test/fixtures/multiplex'
 require 'tomdoc'
 
 module TomDoc
-  class Test < Test::Unit::TestCase
+  class Test < ::Test::Unit::TestCase
     def self.test(name, &block)
       define_method("test_#{name.gsub(/\W/,'_')}", &block) if block
     end

metadata

@@ -1,29 +1,32 @@
 --- !ruby/object:Gem::Specification 
 name: tomdoc
 version: !ruby/object:Gem::Version 
-  prerelease: false
+  hash: 23
+  prerelease: 
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
+- Tom Preston-Werner
 - Chris Wanstrath
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-05-11 00:00:00 -07:00
-default_executable: 
+date: 2011-05-22 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: sexp_processor
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
-    - - "="
+    - - ">="
       - !ruby/object:Gem::Version 
+        hash: 15
         segments: 
         - 3
         - 0
@@ -35,9 +38,11 @@ dependencies:
   name: ParseTree
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
-    - - "="
+    - - ">="
       - !ruby/object:Gem::Version 
+        hash: 13
         segments: 
         - 3
         - 0
@@ -49,9 +54,11 @@ dependencies:
   name: RubyInline
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
-    - - "="
+    - - ">="
       - !ruby/object:Gem::Version 
+        hash: 27
         segments: 
         - 3
         - 7
@@ -63,9 +70,11 @@ dependencies:
   name: ruby_parser
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
-    - - "="
+    - - ">="
       - !ruby/object:Gem::Version 
+        hash: 7
         segments: 
         - 2
         - 0
@@ -73,6 +82,20 @@ dependencies:
         version: 2.0.4
   type: :runtime
   version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: colored
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id005
 description: "  TomDoc is flexible code documentation with human readers in\n  mind. The tomdoc gem is a Ruby library to discover and display\n  TomDoc'd methods and classes.\n\n  Given a Ruby file with TomDoc'd methods, tomdoc can generate HTML or\n  print to the console. You can use it to query up a single method or\n  a group of methods, and it's usable from irb.\n\n  If you're using TomDoc, tomdoc is for you.\n"
 email: chris@ozmm.org
 executables: 
@@ -85,31 +108,30 @@ files:
 - README.md
 - Rakefile
 - LICENSE
-- lib/tomdoc/arg.rb
-- lib/tomdoc/cli.rb
-- lib/tomdoc/generator.rb
+- lib/tomdoc.rb
 - lib/tomdoc/generators/console.rb
 - lib/tomdoc/generators/html.rb
-- lib/tomdoc/method.rb
-- lib/tomdoc/scope.rb
+- lib/tomdoc/cli.rb
 - lib/tomdoc/source_parser.rb
-- lib/tomdoc/tomdoc.rb
 - lib/tomdoc/version.rb
-- lib/tomdoc.rb
+- lib/tomdoc/tomdoc.rb
+- lib/tomdoc/generator.rb
+- lib/tomdoc/scope.rb
+- lib/tomdoc/arg.rb
+- lib/tomdoc/method.rb
 - bin/tomdoc
 - man/tomdoc.5
 - man/tomdoc.5.html
 - man/tomdoc.5.ronn
-- test/console_generator_test.rb
-- test/fixtures/chimney.rb
-- test/fixtures/multiplex.rb
-- test/fixtures/simple.rb
-- test/generator_test.rb
-- test/helper.rb
 - test/html_generator_test.rb
 - test/source_parser_test.rb
 - test/tomdoc_parser_test.rb
-has_rdoc: true
+- test/helper.rb
+- test/console_generator_test.rb
+- test/generator_test.rb
+- test/fixtures/multiplex.rb
+- test/fixtures/chimney.rb
+- test/fixtures/simple.rb
 homepage: http://github.com/defunkt/tomdoc
 licenses: []
 
@@ -119,23 +141,27 @@ rdoc_options: []
 require_paths: 
 - lib
 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 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.8.2
 signing_key: 
 specification_version: 3
 summary: A TomDoc library for Ruby.