yard-bird 0.1.1

data/HISTORY.rdoc

@@ -0,0 +1,10 @@
+= RELEASE HISTORY
+
+== 0.1.1 | 2011-06-10
+
+This is the initial release of Yardbird.
+
+Changes:
+
+* Initial release.
+

data/NOTICE.rdoc

@@ -0,0 +1,75 @@
+= COPYRIGHT NOTICES
+
+== YardBird
+
+Copyright (c) 2011 Thomas Sawyer
+
+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.
+
+
+== YARD
+
+Copyright (c) 2007-2011 Loren Segal
+
+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.
+
+
+== Tomdoc
+
+Copyright (c) 2010 Tom Preston-Werner, Chris Wanstrath
+
+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.
+

data/README.rdoc

@@ -0,0 +1,53 @@
+= Yard Bird
+
+<i>"Sing sweet documentation in my ear."</i>
+
+
+== Description
+
+Yardbird is a YARD plugin that allows you, the developer, to customize your
+documentation parsing system.
+
+
+== Resources
+
+* home: http://rubyworks.github.com/
+* code: http://github.com/rubyworks/
+* mail: http://groups.google.com/group/rubyworks-mailinglist
+
+
+== Check It Out
+
+Sound like a chore? Until you see it allows you do this:
+
+  # .yard/name.song
+
+  When /^Returns\s+(.*?)$/ do |matchdata, comment|
+    create_tag(:return, matchdata[1])
+  end
+
+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].
+
+  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) }
+    tomdoc.args.each {|arg| create_tag(:param, "#{arg.name} #{arg.description}") }
+    tomdoc.raises.each {|r| create_tag(:raise, r.sub(/\ARaises\s+/, '')) }
+    tomdoc.returns.each {|r| create_tag(:return, r.sub(/\AReturns\s+/, '')) }
+    tomdoc.description
+  end
+
+
+== License
+
+(MIT License)
+
+Copyright (c) 2011 Thomas Sawyer
+
+See NOTICE.rdoc file for more details.

data/lib/yard-bird/rules.rb

@@ -0,0 +1,94 @@
+module YARD
+
+  module Bird
+
+    #
+    class Rules
+
+      # Returns [Rules] 
+      def self.load
+        new
+      end
+
+      # Create new Rules object.
+      def initialize()
+        @patterns = {}
+        load_rules
+        inject_rules
+      end
+
+      # Dot-bird filesa are loaded from `.yard/` project directory
+      # and sorted alphabetically. The sorting is useful for controlling
+      # application order when using multiple files --simply number the
+      # files, e.g.
+      #
+      #   .yard/01_special.bird
+      #   .yard/02_tomdoc.bird
+      #
+      # In the example the special rules will have precedence over the 
+      # tomdoc rules.
+      #
+      # Returns nothing.
+      def load_rules
+        files = Dir[".yard/*.bird"].sort
+        files.each do |file|
+          instance_eval(File.read(file), file)
+        end
+      end
+
+      # Define a new rule.
+      #
+      #   pattern - Regexp to match against comment.
+      #   block   - Proc for handling pattern match.
+      #
+      # Returns [Proc] the given block.
+      def When(pattern, &block)
+        patterns[pattern] = block
+      end
+
+      # Returns [Hash] patterns mapped to corresponding procedures.
+      def patterns
+        @patterns
+      end
+
+      # Rules are applied as YARD processes comments. All rules are applied
+      # in order until all rules have been tried, or a triggered rule returns
+      # a `:break` symbol, which will short-circuit further rule application.
+      def inject_rules
+        pats = patterns
+        ::YARD::Docstring.class_eval do
+          define_method :parse_comments do |comments|
+            comments = comments.join("\n") if Array === comments
+            result   = nil
+            pats.each do |pattern, block|
+              if md = pattern.match(comments)
+                result = instance_exec(md, comments, &block) #block.call(md)
+                break if result == :break
+                comments = result if String === result
+              end
+            end
+            comments.to_s #r.to_s
+          end
+        end
+      end
+
+    end
+
+  end
+
+end
+
+=begin
+module YARD
+  class Docstring
+    def parse_comments(comments)
+      Rules.patterns.each do |pattern, block|
+        if md = patterns.match(comments)
+          instance_exec(md, &block) #block.call(md)
+        end
+      end
+    end
+  end
+end
+=end
+

data/lib/yard-bird/version.rb

@@ -0,0 +1,6 @@
+module YARD
+  module Bird
+    VERSION = "0.1.1"
+  end
+end
+

data/lib/yard-bird.rb

@@ -0,0 +1,6 @@
+require 'yard' unless defined?(YARD)
+require 'yard-bird/version'
+require 'yard-bird/rules'
+
+YARD::Bird::Rules.load
+

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification 
+name: yard-bird
+version: !ruby/object:Gem::Version 
+  hash: 25
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- Thomas Sawyer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-10 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: qed
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        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: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- lib/yard-bird/rules.rb
+- lib/yard-bird/version.rb
+- lib/yard-bird.rb
+- HISTORY.rdoc
+- README.rdoc
+- NOTICE.rdoc
+homepage: http://rubyworks.github.com/yard-bird
+licenses: 
+- Apache 2.0
+- Apache 2.0
+- Apache 2.0
+post_install_message: 
+rdoc_options: 
+- --title
+- YARD Bird API
+- --main
+- README.rdoc
+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: yard-bird
+rubygems_version: 1.8.2
+signing_key: 
+specification_version: 3
+summary: Write documentation your way.
+test_files: []
+