tomdoc 0.1.0

data/test/fixtures/multiplex.rb

@@ -0,0 +1,47 @@
+module TomDoc
+  module Fixtures
+    class Multiplex
+      # Duplicate some text an abitrary number of times.
+      #
+      # text  - The String to be duplicated.
+      # count - The Integer number of times to duplicate the text.
+      #
+      # Examples
+      #   multiplex('Tom', 4)
+      #   # => 'TomTomTomTom'
+      #
+      #   multiplex('Bo', 2)
+      #   # => 'BoBo'
+      #
+      #   multiplex('Chris', -1)
+      #   # => nil
+      #
+      # Returns the duplicated String when the count is > 1.
+      # Returns nil when the count is < 1.
+      # Returns the atomic mass of the element as a Float. The value is in
+      #   unified atomic mass units.
+      def multiplex(text, count)
+        text * count
+      end
+
+      # Duplicate some text an abitrary number of times.
+      #
+      # Returns the duplicated String.
+      def multiplex2(text, count)
+        text * count
+      end
+
+      # Duplicate some text an abitrary number of times.
+      #
+      # Examples
+      #   multiplex('Tom', 4)
+      #   # => 'TomTomTomTom'
+      #
+      #   multiplex('Bo', 2)
+      #   # => 'BoBo'
+      def multiplex3(text, count)
+        text * count
+      end
+    end
+  end
+end

data/test/fixtures/simple.rb

@@ -0,0 +1,10 @@
+class Simple
+  # Just a simple method.
+  #
+  # text - The String to return.
+  #
+  # Returns a String.
+  def string(text)
+    text
+  end
+end

data/test/generator_test.rb

@@ -0,0 +1,47 @@
+require 'test/helper'
+
+class GeneratorTest < TomDoc::Test
+  def setup
+    @class = Class.new(TomDoc::Generator) do
+      def write_method(method, prefix = '')
+        @buffer = [] if @buffer.is_a?(String)
+        @buffer << method.name
+      end
+    end
+
+    @generator = @class.new
+  end
+
+  test "can ignore validation methods" do
+    @generator.options[:validate] = false
+    methods = @generator.generate(fixture(:chimney))
+    assert_equal 47, methods.size
+  end
+
+  test "ignores invalid methods" do
+    @generator.options[:validate] = true
+    methods = @generator.generate(fixture(:chimney))
+    assert_equal 39, methods.size
+  end
+
+  test "detects built-in constants" do
+    assert @generator.constant?('Object')
+    assert @generator.constant?('Kernel')
+    assert @generator.constant?('String')
+  end
+
+  test "detects common constants" do
+    assert @generator.constant?('Boolean')
+    assert @generator.constant?('Test::Unit::TestCase')
+  end
+
+  test "picks up constants from the thing we're TomDocin'" do
+    scope = { :Chimney => TomDoc::Scope.new('Chimney') }
+    @generator.instance_variable_set(:@scopes, scope)
+    assert @generator.constant?('Chimney')
+  end
+
+  test "ignores non-constants" do
+    assert !@generator.constant?('Dog')
+  end
+end

data/test/helper.rb

@@ -0,0 +1,21 @@
+require 'test/unit'
+
+require 'test/fixtures/multiplex'
+
+require 'tomdoc'
+
+module TomDoc
+  class Test < Test::Unit::TestCase
+    def self.test(name, &block)
+      define_method("test_#{name.gsub(/\W/,'_')}", &block) if block
+    end
+
+    def default_test
+    end
+
+    def fixture(name)
+      @fixtures ||= {}
+      @fixtures[name] ||= File.read("test/fixtures/#{name}.rb")
+    end
+  end
+end

data/test/html_generator_test.rb

@@ -0,0 +1,18 @@
+require 'test/helper'
+
+class HTMLGeneratorTest < TomDoc::Test
+  def setup
+    @html = TomDoc::Generators::HTML.generate(fixture(:simple))
+  end
+
+  test "works" do
+    assert_equal <<html, @html
+<ul>
+<li><b>Simple#string(text)</b><pre>Just a simple method.
+
+text - The String to return.
+
+Returns a String.</pre></li></ul>
+html
+  end
+end

data/test/source_parser_test.rb

@@ -0,0 +1,66 @@
+require 'test/helper'
+
+class ChimneySourceParserTest < TomDoc::Test
+  def setup
+    @parser = TomDoc::SourceParser.new
+    @result = @parser.parse(fixture(:chimney))
+
+    @chimney = @result[:GitHub][:Chimney]
+  end
+
+  test "finds instance methods" do
+    assert_equal 35, @chimney.instance_methods.size
+  end
+
+  test "attaches TomDoc" do
+    m = @chimney.instance_methods.detect { |m| m.name == :get_user_route }
+    assert_equal [:user], m.tomdoc.args.map { |a| a.name }
+  end
+
+  test "finds class methods" do
+    assert_equal 9, @chimney.class_methods.size
+  end
+
+  test "finds namespaces" do
+    assert @result[:GitHub][:Math]
+    assert_equal 2, @result.keys.size
+    assert_equal 3, @result[:GitHub].keys.size
+  end
+
+  test "finds methods in a namespace" do
+    assert_equal 1, @result[:GitHub].class_methods.size
+  end
+
+  test "finds multiple classes in one file" do
+    assert_equal 1, @result[:GitHub][:Math].instance_methods.size
+    assert_equal 1, @result[:GitHub][:Jobs].instance_methods.size
+  end
+end
+
+class SourceParserTest < TomDoc::Test
+  def setup
+    @parser = TomDoc::SourceParser.new
+  end
+
+  test "finds single class in one file" do
+    result = @parser.parse(fixture(:simple))
+
+    assert result[:Simple]
+
+    methods = result[:Simple].instance_methods
+    assert_equal 1, methods.size
+    assert_equal [:string], methods.map { |m| m.name }
+  end
+
+  test "finds single module in one file"
+  test "finds module in a module"
+  test "finds module in a class"
+  test "finds class in a class"
+
+  test "finds class in a module in a module" do
+    result = @parser.parse(fixture(:multiplex))
+    klass = result[:TomDoc][:Fixtures][:Multiplex]
+    assert klass
+    assert_equal 3, klass.instance_methods.size
+  end
+end

data/test/tomdoc_parser_test.rb

@@ -0,0 +1,127 @@
+require 'test/helper'
+
+class TomDocParserTest < TomDoc::Test
+  def setup
+    @comment = TomDoc::TomDoc.new(<<comment)
+    # Duplicate some text an abitrary number of times.
+    #
+    # text    - The String to be duplicated.
+    # count   - The Integer number of times to
+    #           duplicate the text.
+    # reverse - An optional Boolean indicating
+    #           whether to reverse the result text or not.
+    #
+    # Examples
+    #   multiplex('Tom', 4)
+    #   # => 'TomTomTomTom'
+    #
+    #   multiplex('Bo', 2)
+    #   # => 'BoBo'
+    #
+    #   multiplex('Chris', -1)
+    #   # => nil
+    #
+    # Returns the duplicated String when the count is > 1.
+    # Returns the atomic mass of the element as a Float. The value is in
+    #   unified atomic mass units.
+    # Returns nil when the count is < 1.
+    # Raises ExpectedString if the first argument is not a String.
+    # Raises ExpectedInteger if the second argument is not an Integer.
+comment
+
+    @comment2 = TomDoc::TomDoc.new(<<comment2)
+    # Duplicate some text an abitrary number of times.
+    #
+    # Returns the duplicated String.
+comment2
+
+    @comment3 = TomDoc::TomDoc.new(<<comment3)
+    # Duplicate some text an abitrary number of times.
+    #
+    # Examples
+    #
+    #   multiplex('Tom', 4)
+    #   # => 'TomTomTomTom'
+    #
+    #   multiplex('Bo', 2)
+    #   # => 'BoBo'
+comment3
+  end
+
+  test "knows when TomDoc is invalid" do
+    assert_raises TomDoc::InvalidTomDoc do
+      @comment3.validate
+    end
+  end
+
+  test "parses a description" do
+    assert_equal "Duplicate some text an abitrary number of times.",
+      @comment.description
+  end
+
+  test "parses args" do
+    assert_equal 3, @comment.args.size
+  end
+
+  test "knows an arg's name" do
+    assert_equal :text, @comment.args.first.name
+    assert_equal :count, @comment.args[1].name
+    assert_equal :reverse, @comment.args[2].name
+  end
+
+  test "knows an arg's description" do
+    assert_equal 'The Integer number of times to duplicate the text.',
+      @comment.args[1].description
+
+    reverse = 'An optional Boolean indicating whether to reverse the'
+    reverse << ' result text or not.'
+    assert_equal reverse, @comment.args[2].description
+  end
+
+  test "knows an arg's optionality" do
+    assert_equal false, @comment.args.first.optional?
+    assert_equal true, @comment.args.last.optional?
+  end
+
+  test "knows what to do when there are no args" do
+    assert_equal 0, @comment2.args.size
+  end
+
+  test "knows how many examples there are" do
+    assert_equal 3, @comment.examples.size
+  end
+
+  test "knows each example" do
+    assert_equal "  multiplex('Bo', 2)\n  # => 'BoBo'",
+      @comment.examples[1].to_s
+  end
+
+  test "knows what to do when there are no examples" do
+    assert_equal 0, @comment2.examples.size
+  end
+
+  test "knows how many return examples there are" do
+    assert_equal 3, @comment.returns.size
+  end
+
+  test "knows if the method raises anything" do
+    assert_equal 2, @comment.raises.size
+  end
+
+  test "knows each return example" do
+    assert_equal "Returns the duplicated String when the count is > 1.",
+      @comment.returns.first.to_s
+
+    string = ''
+    string << "Returns the atomic mass of the element as a Float. "
+    string << "The value is in unified atomic mass units."
+    assert_equal string, @comment.returns[1].to_s
+
+    assert_equal "Returns nil when the count is < 1.",
+      @comment.returns[2].to_s
+  end
+
+  test "knows what to do when there are no return examples" do
+    assert_equal 0, @comment2.examples.size
+  end
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification 
+name: tomdoc
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Chris Wanstrath
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-11 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: sexp_processor
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 4
+        version: 3.0.4
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: ParseTree
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 5
+        version: 3.0.5
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: RubyInline
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 7
+        - 0
+        version: 3.7.0
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: ruby_parser
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 4
+        version: 2.0.4
+  type: :runtime
+  version_requirements: *id004
+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: 
+- tomdoc
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.md
+- Rakefile
+- LICENSE
+- lib/tomdoc/arg.rb
+- lib/tomdoc/cli.rb
+- lib/tomdoc/generator.rb
+- lib/tomdoc/generators/console.rb
+- lib/tomdoc/generators/html.rb
+- lib/tomdoc/method.rb
+- lib/tomdoc/scope.rb
+- lib/tomdoc/source_parser.rb
+- lib/tomdoc/tomdoc.rb
+- lib/tomdoc/version.rb
+- lib/tomdoc.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
+homepage: http://github.com/defunkt/tomdoc
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A TomDoc library for Ruby.
+test_files: []
+