yard-bird 0.1.1 → 0.1.2

data/HISTORY.rdoc

@@ -1,5 +1,15 @@
 = RELEASE HISTORY
 
+== 0.1.2 | 2011-11-10
+
+This release simply brings the build configuration
+up to date. Nothing has change functionally.
+
+Changes:
+
+* Modernize build configuration.
+
+
 == 0.1.1 | 2011-06-10
 
 This is the initial release of Yardbird.

data/NOTES.rdoc

@@ -0,0 +1,12 @@
+= Developer's Notes
+
+== TODO
+
+=== file://test/system/test_yardoc.rb
+
+* TODO: more verifications (26)
+
+=== file://test/unit/test_rules.rb
+
+* TODO: Write some unit tests!!! (25)
+

data/NOTICE.rdoc

@@ -2,7 +2,7 @@
 
 == YardBird
 
-Copyright (c) 2011 Thomas Sawyer
+Copyright (c) 2011 Rubyworks
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
@@ -50,7 +50,7 @@ FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 OTHER DEALINGS IN THE SOFTWARE.
 
 
-== Tomdoc
+== TomDoc
 
 Copyright (c) 2010 Tom Preston-Werner, Chris Wanstrath
 

data/README.rdoc

@@ -11,16 +11,17 @@ documentation parsing system.
 
 == Resources
 
-* home: http://rubyworks.github.com/
-* code: http://github.com/rubyworks/
-* mail: http://groups.google.com/group/rubyworks-mailinglist
+* {Homepage}[http://rubyworks.github.com]
+* {Source Code}[http://github.com/rubyworks]
+* {Mainling List}[http://groups.google.com/group/rubyworks-mailinglist]
+* {<img src="http://travis-ci.org/rubyworks/yard-bird.png" />}[http://travis-ci.org/rubyworks/yard-bird]
 
 
 == Check It Out
 
 Sound like a chore? Until you see it allows you do this:
 
-  # .yard/name.song
+  # .yard/example.bird
 
   When /^Returns\s+(.*?)$/ do |matchdata, comment|
     create_tag(:return, matchdata[1])
@@ -29,11 +30,10 @@ Sound like a chore? Until you see it allows you do this:
 Now, whenever your documentation starts with 'Returns ', the
 remainder of the line will be added to YARD as a :return tag.
 
-Now we can get even crazier with a basic implementation of Tomdoc[http://tomdoc].
+Now we can get even crazier a create a simplified implementation of {Tomdoc}[http://tomdoc].
 
   require 'tomdoc/tomdoc'
 
-  # God is /\A.*?\Z/
   When /\A.*?\Z/m do |matchdata, comment|
     tomdoc = TomDoc::TomDoc.new(comment)
     tomdoc.examples.each {|ex| create_tag(:example, "\n" + ex) }
@@ -43,11 +43,14 @@ Now we can get even crazier with a basic implementation of Tomdoc[http://tomdoc]
     tomdoc.description
   end
 
+Now it's your turn. You have the _power_*, Yard Bird will singe _Your_ song.
+And YARD will happily spit it out all pretty.
+
 
 == License
 
 (MIT License)
 
-Copyright (c) 2011 Thomas Sawyer
+Copyright (c) 2011 Rubyworks
 
 See NOTICE.rdoc file for more details.

data/lib/yard-bird/rules.rb

@@ -28,7 +28,7 @@ module YARD
       # In the example the special rules will have precedence over the 
       # tomdoc rules.
       #
-      # Returns nothing.
+      # @return Nothing
       def load_rules
         files = Dir[".yard/*.bird"].sort
         files.each do |file|
@@ -41,12 +41,14 @@ module YARD
       #   pattern - Regexp to match against comment.
       #   block   - Proc for handling pattern match.
       #
-      # Returns [Proc] the given block.
+      # @return [Proc] the given block
       def When(pattern, &block)
         patterns[pattern] = block
       end
 
-      # Returns [Hash] patterns mapped to corresponding procedures.
+      # Patterns to apply.
+      #
+      # @Return [Hash] patterns mapped to corresponding procedures
       def patterns
         @patterns
       end

data/lib/yard-bird/version.rb

@@ -1,6 +1,17 @@
 module YARD
   module Bird
-    VERSION = "0.1.1"
+    #
+    def self.dotruby
+      @dotruby ||= (
+        require 'yaml'
+        file = File.dirname(__FILE__)+'/../../.ruby'
+        File.exist?(file) ? YAML.load_file(file) : {}
+      )
+    end
+    #
+    def self.const_missing(name)
+      dotruby[name.to_s.downcase] || super(name)
+    end
   end
 end
 

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/.yard/yaml.bird

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+
+require 'yaml'
+
+# A really stupid simple example, using YAML mapping.
+# (It's stupid b/c only one tag can be used.)
+
+# God is /\A.*?\Z/
+When /\A.*?\Z/m do |matchdata, comment|
+  md = /\-\-\-.*?\.\.\./m.match(comment)
+  if md
+    yaml = md[0]
+    data = YAML.load(yaml)
+    data.each do |tag, desc|
+      create_tag(tag.to_sym, desc)
+    end
+    comment.sub(yaml, '')
+  else
+    comment
+  end
+end
+

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

@@ -0,0 +1,19 @@
+# This is an example class.
+class Example
+
+  # Jump is not the kind of method you bring
+  # home to mother.
+  #
+  # ---
+  # param: how_high [Integer] height of the jump
+  # return: "[String] string of tartar"
+  # example: |
+  #   Example.new.jump  #=> "tartar"
+  # ...
+  #
+  def jump(how_high=nil)
+    "tartar"
+  end
+
+end
+

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

@@ -0,0 +1,15 @@
+# This is a class.
+class HelloWorld
+
+  # Hello simply prints out a greeting.
+  #
+  # ---
+  # param: string [String] An object that responds to #to_s.
+  # return: 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 bird lib/"
+
+      assert(success, "failed to generate yard documentation")
+      assert File.directory?('doc')
+
+      # TODO: more verifications
+    end
+  end
+
+end

data/test/unit/test_rules.rb

@@ -0,0 +1,50 @@
+require File.expand_path(File.dirname(__FILE__)) + "/../helper.rb"
+
+require "yard"
+require "yard-bird"
+
+describe YARD::Bird::Rules 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
+eof
+  end
+
+  # TODO: Write some unit tests!!!
+
+  #it "should fill docstring with description" do
+  #  @docstring.must_equal "Duplicate some text an arbitrary number of times."
+  #end
+
+  #it "should fill param tags" do
+  #  tags = @docstring.tags(:param)
+  #  tags.size.must_equal 2
+  #  tags[0].name.must_equal 'text'
+  #  tags[1].name.must_equal 'count'
+  #end
+  
+  #it "should fill examples tags" do
+  #  @docstring.tags(:example).size.must_equal 1
+  #  @docstring.tag(:example).text.must_equal "multiplex('Tom', 4)\n  # => 'TomTomTomTom'"
+  #end
+  
+  #it "should fill return tag" do
+  #  @docstring.tag(:return).text.must_equal "the duplicated String."
+  #end
+
+  #it "should fill raise tag" do
+  #  @docstring.tag(:raise).text.must_equal "ArgumentError if something bad happened"
+  #end
+end

metadata

@@ -1,102 +1,103 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: yard-bird
-version: !ruby/object:Gem::Version 
-  hash: 25
+version: !ruby/object:Gem::Version
+  version: 0.1.2
   prerelease: 
-  segments: 
-  - 0
-  - 1
-  - 1
-  version: 0.1.1
 platform: ruby
-authors: 
-- Thomas Sawyer
+authors:
+- Trans
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-06-10 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-11-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: yard
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &24398660 !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: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: qed
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *24398660
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &24398060 !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: Yardbird is a YARD plugin that allows you, the developer, to customize your documentation parsing system.
-email: transfire@gmail.com
-executables: []
+  prerelease: false
+  version_requirements: *24398060
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &24397420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *24397420
+description: ! 'Yardbird is a YARD plugin that allows you, the developer, to write
+  documentation
 
-extensions: []
+  Your Way. Do you like TomDoc, but wish it were just a tad bit different? You can
 
-extra_rdoc_files: 
+  fix that. Have some radical idea for using ASCII table in your docs? You can do
+
+  that too.'
+email:
+- transfire@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- HISTORY.rdoc
 - README.rdoc
-files: 
+- NOTES.rdoc
+- NOTICE.rdoc
+files:
 - lib/yard-bird/rules.rb
 - lib/yard-bird/version.rb
 - lib/yard-bird.rb
+- test/helper.rb
+- test/system/sample/.yard/yaml.bird
+- test/system/sample/lib/example.rb
+- test/system/sample/lib/hello_world.rb
+- test/system/test_yardoc.rb
+- test/unit/test_rules.rb
 - HISTORY.rdoc
 - README.rdoc
+- NOTES.rdoc
 - NOTICE.rdoc
 homepage: http://rubyworks.github.com/yard-bird
-licenses: 
-- Apache 2.0
-- Apache 2.0
-- Apache 2.0
+licenses:
+- MIT
 post_install_message: 
-rdoc_options: 
-- --title
-- YARD Bird API
-- --main
-- README.rdoc
-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-bird
-rubygems_version: 1.8.2
+rubyforge_project: 
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: Write documentation your way.
+summary: Documentation Your Way!
 test_files: []
-