yard-amp 0.4.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/.yardoc/checksums

@@ -0,0 +1,5 @@
+LICENSE 665ec4d7a681c6d942fe132844434b5f81e34999
+README.rdoc e8e816eaee11fbfd5dbe5170541a2fbe9b35bb5c
+lib/yard-amp.rb f2d20f66f531520be5409d7f94aacd4bdd91c619
+lib/yard-amp/modern_handler.rb 9469c52c02117165008f813690449bb4833ac178
+spec/examples/examples/simple_command.rb.txt 069ec92690ebdb1d263cf050951c1107dae4c316

data/.yardoc/proxy_types

@@ -0,0 +1,2 @@
+{"YARD::Handlers::Ruby::Base:
+class"YARD::CodeObjects:module

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Michael Edgar
+
+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.md

@@ -0,0 +1,17 @@
+# yard-amp
+
+Description goes here.
+
+## Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2010 Michael Edgar. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,47 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "yard-amp"
+    gem.summary = %Q{Automatically create YARD documentation for Amp commands.}
+    gem.description = %Q{yard-amp is a YARD plugin that enables the automatic creation of YARD } +
+                      %Q{documentation from amp command declarations.}
+    gem.email = "michael.j.edgar@dartmouth.edu"
+    gem.homepage = "http://github.com/michaeledgar/yard-amp"
+    gem.authors = ["Michael Edgar"]
+    gem.add_dependency "yard", ">= 0.4.0"
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+  spec.verbose = true
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.4.0

data/lib/yard-amp.rb

@@ -0,0 +1,7 @@
+require 'yard'
+require File.join(File.dirname(__FILE__), 'yard-amp', 'option')
+require File.join(File.dirname(__FILE__), 'yard-amp', 'parsing_helpers')
+require File.join(File.dirname(__FILE__), 'yard-amp', 'modern_handler')  if RUBY_VERSION >= "1.9"
+require File.join(File.dirname(__FILE__), 'yard-amp', 'legacy_handler')  unless RUBY_VERSION >= "1.9"
+
+YARD::Templates::Engine.register_template_path File.join(File.dirname(__FILE__), '..', 'templates')

data/lib/yard-amp/legacy_handler.rb

@@ -0,0 +1,117 @@
+module YARD::Amp
+  ##
+  # This handler is used by the Ruby 1.9+ parser engine. Uses AST nodes.
+  #
+  # All the interesting logic is actually all in SharedMethods. This class
+  # specifically defines the parsing logic to get the data ready for the
+  # Shared Methods.
+  class LegacyCommandHandler < YARD::Handlers::Ruby::Legacy::Base
+    MATCH = /command\(?\s*(.*?)\s*\)?\s*(do|\{)/
+    handles MATCH
+    #include YARD::CodeObjects
+    include ParsingHelpers
+    
+    def process
+      params = statement.tokens.to_s[MATCH, 1].split(",").map {|x| clean_string(x)}
+      if params.size != 1
+        raise YARD::Parser::UndocumentableError, 'command declaration with invalid parameters'
+      end
+      
+      command_name = params.first
+      command_name = command_name[1..-1] if command_name[0,1] == ":"
+      # 
+      klass = ClassObject.new(commands_module, command_name.capitalize) do |o|
+        o.superclass = P("Amp::Command")
+        o.superclass.type = :class if o.superclass.is_a?(Proxy)
+      end
+      klass[:amp_data] ||= {}
+      klass[:amp_data].merge!(:docstring => statement.comments)
+      # 
+      parse_block(:owner => klass)
+      register klass
+      construct_docstring(klass)
+    end
+    
+    def commands_module
+      mod = register ModuleObject.new(:root, "Amp")
+      com_mod = register ModuleObject.new(mod, "Commands")
+    end
+  end
+  # 
+  class LegacyAmpCommandHandler < YARD::Handlers::Ruby::Legacy::Base
+    include ParsingHelpers
+    def process
+      return nil unless owner.inheritance_tree(false).include?(P("Amp::Command"))
+      owner[:amp_data] ||= {}
+      true
+    end
+    
+    def attach_metadata(meta = {})
+      owner[:amp_data].merge!(meta)
+    end
+    
+  end
+  # 
+  class LegacyHelpHandler < LegacyAmpCommandHandler
+    MATCH = /help=?\(?\s*(.*)\s*\)?\s*/
+    handles MATCH
+    
+    def process
+      return unless super
+      param = clean_string(statement.tokens.to_s[MATCH, 1].strip)
+      attach_metadata(:help => param)
+    end
+  end
+  # 
+  class LegacyDescriptionHandler < LegacyAmpCommandHandler
+    MATCH = /desc=?\(?\s*(.*)\s*\)?\s*/
+    handles MATCH
+    
+    def process
+      return unless super
+
+      param = clean_string(statement.tokens.to_s[MATCH, 1].strip)
+      attach_metadata.merge!(:desc => param)
+    end
+  end
+  # 
+  class LegacyWorkflowHandler < LegacyAmpCommandHandler
+    MATCH = /workflow=?\(?\s*(.*)\s*\)?\s*/
+    handles MATCH
+    
+    def process
+      return unless super
+      param = clean_string(statement.tokens.to_s[MATCH, 1].strip)
+      attach_metadata.merge!(:workflow => param)
+    end
+  end
+  # 
+  class LegacyOptionHandler < LegacyAmpCommandHandler
+    MATCH = /(opt|add_opt)\(?\s*(.*)\s*\)?\s*/
+    handles MATCH
+    
+    def process
+      return unless super
+      params = split_by_comma_smart(statement.tokens.to_s[MATCH, 2]).map {|x| clean_string(x.strip)}
+      option = parse_parameters(params)
+      owner[:amp_data][:options] ||= []
+      owner[:amp_data][:options] << option
+    end
+    
+    def parse_parameters(params)
+      name = clean_string(params.first)
+      description = clean_string(params[1])
+      option = OptionObject.new(owner, name, description)
+      if params[2..-1]
+        reg = /(.*?)\s*=>\s*([^,]*)/
+        params[2..-1].each do |param|
+          if param =~ reg
+            option.options[clean_string($1)] = clean_string $2
+          end
+        end
+      end
+      option.docstring = statement.comments
+      option
+    end
+  end
+end

data/lib/yard-amp/modern_handler.rb

@@ -0,0 +1,108 @@
+module YARD::Amp
+  ##
+  # This handler is used by the Ruby 1.9+ parser engine. Uses AST nodes.
+  #
+  # All the interesting logic is actually all in SharedMethods. This class
+  # specifically defines the parsing logic to get the data ready for the
+  # Shared Methods.
+  class ModernCommandHandler < YARD::Handlers::Ruby::Base
+    handles method_call(:command)
+    include YARD::CodeObjects
+    include ParsingHelpers
+    
+    def process
+      if statement.parameters.size != 2
+        raise YARD::Parser::UndocumentableError, 'command declaration with invalid parameters'
+      end
+      command_name = statement.parameters.first.source
+      command_name = command_name[1..-1] if command_name[0,1] == ":"
+      
+      klass = ClassObject.new(commands_module, command_name.capitalize) do |o|
+        o.superclass = P("Amp::Command")
+        o.superclass.type = :class if o.superclass.is_a?(Proxy)
+      end
+      klass[:amp_data] ||= {}
+      klass[:amp_data].merge!(:docstring => statement.comments)
+
+      parse_block statement[2].children[1], owner: klass
+      register klass
+      construct_docstring(klass)
+    end
+    
+    def workflow_module(workflow)
+      register ModuleObject.new(commands_module, workflow.to_s.capitalize)
+    end
+    
+    def commands_module
+      mod = register ModuleObject.new(:root, "Amp")
+      com_mod = register ModuleObject.new(mod, "Commands")
+    end
+  end
+  
+  class ModernAmpCommandHandler < YARD::Handlers::Ruby::Base
+    include ParsingHelpers
+    def process
+      return nil unless owner.inheritance_tree(false).include?(P("Amp::Command"))
+      owner[:amp_data] ||= {}
+      true
+    end
+    
+    def attach_metadata(meta = {})
+      owner[:amp_data].merge!(meta)
+    end
+    
+  end
+  
+  class ModernHelpHandler < ModernAmpCommandHandler
+    handles method_call(:help), method_call(:help=)
+    
+    def process
+      return unless super
+      params = statement.parameters
+      attach_metadata(help: clean_string(params.first.source))
+    end
+  end
+  
+  class ModernDescriptionHandler < ModernAmpCommandHandler
+    handles method_call(:desc), method_call(:desc=)
+    
+    def process
+      return unless super
+      params = statement.parameters
+      attach_metadata.merge!(desc: clean_string(params.first.source))
+    end
+  end
+  
+  class ModernWorkflowHandler < ModernAmpCommandHandler
+    handles method_call(:workflow), method_call(:workflow=)
+    
+    def process
+      return unless super
+      params = statement.parameters
+      attach_metadata.merge!(workflow: clean_string(params.first.source))
+    end
+  end
+  
+  class ModernOptionHandler < ModernAmpCommandHandler
+    handles method_call(:opt), method_call(:add_opt)
+    
+    def process
+      return unless super
+      params = statement.parameters
+      option = parse_parameters(params)
+      owner[:amp_data][:options] ||= []
+      owner[:amp_data][:options] << option
+    end
+    
+    def parse_parameters(params)
+      name = clean_string(params.first.source)
+      description = clean_string(params[1].source)
+      option = OptionObject.new(owner, name, description)
+      if params[2]
+        option.options = parse_hash(params[2])
+      end
+      option.docstring = statement.comments
+      option
+    end
+  end
+end

data/lib/yard-amp/option.rb

@@ -0,0 +1,26 @@
+module YARD::Amp
+  class OptionObject < YARD::CodeObjects::Base
+    attr_accessor :description, :options
+    def initialize(namespace, name, description, opts = {}, *args)
+      super
+      self.description, self.options = description, opts
+      opts["type"] ||= "flag"
+    end
+    
+    def signature
+      "--#{self.name}" +
+        (options["short"] && options["short"] != "none" ? ", -#{options["short"]}" : "") +
+        case options["type"]
+        when "flag"; ""
+        when "int"; " &lt;i&gt;"
+        when "ints"; " &lt;i+&gt;"
+        when "string"; " &lt;s&gt;"
+        when "strings"; " &lt;s+&gt;"
+        when "float"; " &lt;f&gt;"
+        when "floats"; " &lt;f+&gt;"
+        when "io"; " &lt;filename/uri&gt;"
+        when "ios"; " &lt;filename/uri+&gt;"
+        end.to_s
+    end
+  end
+end

data/lib/yard-amp/parsing_helpers.rb

@@ -0,0 +1,62 @@
+module YARD::Amp
+  module ParsingHelpers
+    def clean_string(str)
+      if str[0,2] == ":\"" && str[-1,1] == "\""
+        str[2..-2]
+      elsif str[0,1] == ":"
+        str[1..-1]
+      elsif str[0,1] =~ /['"]/ && str[-1,1] == str[0,1]
+        str[1..-2]
+      elsif str[0,3] =~ /%q\{/i && str[-1,1] == "}"
+        str[3..-2]
+      elsif str[0,3] == "<<-"
+        prefix = str[3..-1] =~ /[\S]+/
+        if prefix
+          prefix = $&
+          # check if it starts and ends with it
+          if str[-1 * prefix.size..-1] == str[3...prefix.size+3]
+            return str[3 + prefix.size..(-1 * prefix.size - 2)]
+          end
+        end
+        str
+      else
+        str
+      end
+    end
+    
+    def construct_docstring(klass)
+      klass.docstring = "== #{klass[:amp_data][:desc]}\n\n#{klass[:amp_data][:help]}\n#{klass[:amp_data][:docstring]}"
+    end
+    
+    def parse_hash(node)
+      node.children.inject({}) do |hash, pair|
+        unless pair.type == :assoc
+          raise YARD::Parser::UndocumentableError, %Q{expected an :assoc in a hash but got #{pair.type}}
+        end
+        key = clean_string pair[0].source
+        val = clean_string pair[1].source
+        hash[key] = val
+        hash
+      end
+    end
+    
+    def split_by_comma_smart(string)
+      result = []
+      in_quote = false
+      last_spot = 0
+      string.split(//).each_with_index do |char, idx|
+        if char =~ /['"]/
+          in_quote = !in_quote
+        elsif char == "," && !in_quote
+          result << string[last_spot..(idx - 1)]
+          last_spot = idx + 1
+        end
+      end
+      unless last_spot == string.size - 1
+        result << string[last_spot..-1]
+      end
+      result
+    end
+    
+  end
+end

data/spec/examples/example_helper.rb

@@ -0,0 +1,23 @@
+require 'yard'
+
+##
+# Stolen from http://github.com/postmodern/yard-parameters/blob/master/spec/helpers/examples.rb.
+#
+# Thanks!
+
+module Helpers
+  module Examples
+    EXAMPLES_DIR = File.expand_path(File.join(File.dirname(__FILE__),'examples'))
+
+    def parse_file(file, thisfile = __FILE__)
+      YARD::Registry.clear
+
+      path = File.join(Helpers::Examples::EXAMPLES_DIR, "#{file}.rb.txt")
+      YARD::Parser::SourceParser.parse(path)
+    end
+
+    def yard(name)
+      YARD::Registry.at(name)
+    end
+  end
+end

data/spec/examples/examples/simple_command.rb.txt

@@ -0,0 +1,40 @@
+##
+# @example
+#    amp init --type=git
+# @example
+#    amp init --source=http://bitbucket.org/carbonica/amp/
+command :init do |c|
+  c.workflow :all
+  c.help %Q{Help info for init}
+  c.desc "Initializes a new repository in the current directory."
+  # This option is used for the multi-repo-ness of amp
+  c.opt :type, "Which type of repository (git, hg)", :short => '-t', :type => :string, :default => 'hg'
+  # @example amp init --source='http://github.com/michaeledgar/amp/'
+  c.opt :source, "Where the source repository could be found", :short => '-s', :multi => true
+  c.opt :"no-opts", "This has no extra configuration things" if x && y
+
+  c.on_run do |options, args|
+    path = args.first ? args.first : '.'
+    
+    case options[:type]
+    when 'hg'
+      Amp::Repositories::Mercurial::LocalRepository.new(path, true, options[:global_config])
+    when 'git'
+      Amp::Repositories::Git::LocalRepository.new(path, true, options[:global_config])
+    else
+      raise "Unknown repository type #{options[:type].inspect}"
+    end
+    
+    puts "New #{options[:type]} repository initialized."
+  end
+end
+
+command(:braced) {|c|
+  c.help "Some Help Info"
+  c.desc "More Descriptive stuff"
+}
+
+class NotACommand
+	help "Other help should never show up"
+	desc "Some description to be ignored"
+end

data/spec/parsing_helpers_spec.rb

@@ -0,0 +1,50 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe ::YARD::Amp::ParsingHelpers, '#clean_string' do
+  include YARD::Amp::ParsingHelpers
+  it "cleans normal symbols" do
+    clean_string(":some_symbol").should == "some_symbol"
+  end
+  
+  it "cleans quoted symbols" do
+    clean_string(":\"long symbol\"").should == "long symbol"
+  end
+  
+  it "cleans normal strings" do
+    clean_string("\"a big long string\"").should == "a big long string"
+  end
+  
+  it "cleans special-quoted strings" do
+    clean_string("%Q{some big long string}").should == "some big long string"
+  end
+  
+  it "cleans heredocs" do
+    clean_string("<<-EOF\nsome string\n another lines\n  another line\nEOF").should == "\nsome string\n another lines\n  another line"
+  end
+end
+
+describe ::YARD::Amp::ParsingHelpers, '#split_by_comma_smart' do
+  include YARD::Amp::ParsingHelpers
+  it "splits simple strings" do
+    split_by_comma_smart(":hello, :world, :im_mike").should == [":hello", " :world", " :im_mike"]
+  end
+  
+  it "splits slightly tougher strings" do
+    split_by_comma_smart(":hello, \"a big long, string\", :is_nice").should == [":hello", " \"a big long, string\"", " :is_nice"]
+  end
+end
+
+if RUBY19
+  describe ::YARD::Amp::ParsingHelpers, '#parse_hash' do
+    include YARD::Amp::ParsingHelpers
+    it "parses hashes into hash objects" do
+      ast = YARD::Parser::SourceParser.parse_string("{\"hello\" => \"world\"}").ast.first
+      parse_hash(ast).should == {"hello" => "world"}
+    end
+  
+    it "parses hashes with symbols into string-based hashes" do
+      ast = YARD::Parser::SourceParser.parse_string("{:\"no-color\" => true}").ast.first
+      parse_hash(ast).should == {"no-color" => "true"}
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rubygems'
+require 'yard-amp'
+require 'spec'
+require 'spec/autorun'
+require 'examples/example_helper'
+
+Spec::Runner.configure do |config|
+  
+end
+include YARD

data/spec/yard-amp_spec.rb

@@ -0,0 +1,105 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "::YARD::Amp::#{}ModernCommandHandler" do
+  include Helpers::Examples
+  before(:all) do
+    parse_file :simple_command
+    @init_cmd = Registry.at("Amp::Commands::Init")
+    @braced_cmd = Registry.at("Amp::Commands::Braced")
+  end
+  
+  it "creates commands when parsing a command declaration" do
+    @init_cmd.should_not be_nil
+  end
+  
+  it "assigns commands the superclass of Amp::Command" do
+    @init_cmd.superclass.path.should == "Amp::Command"
+  end
+  
+  it "creates a metadata hash on amp command classes" do
+    @init_cmd[:amp_data].should_not be_nil
+  end
+  
+  it "extracts help information and attaches it as metadata" do
+    @init_cmd[:amp_data].should have_key(:help)
+    @init_cmd[:amp_data][:help].should == "Help info for init"
+  end
+  
+  it "extracts description information and attaches it as metadata" do
+    @init_cmd[:amp_data].should have_key(:desc)
+    @init_cmd[:amp_data][:desc].should == "Initializes a new repository in the current directory."
+  end
+  
+  it "retains the docstring attached to the call to #command" do
+    @init_cmd.docstring.tags(:example).size.should_not == 0
+  end
+  
+  it "ignores help or description calls not in a command" do
+    Registry.at("NotACommand")[:amp_data].should be_nil
+  end
+  
+  it "parses brace syntax as well as do...end syntax" do
+    @braced_cmd.should_not be_nil
+  end
+  
+  it "constructs a reasonable docstring" do
+    @init_cmd.docstring.should == "== Initializes a new repository in the current directory.\n\nHelp info for init"
+  end
+  
+  it "processes all the command-line options" do
+    @init_cmd[:amp_data].should have_key(:options)
+    @init_cmd[:amp_data][:options].size.should == 3
+  end
+  
+  it "extracts the names of command-line options" do
+    found_opts = @init_cmd[:amp_data][:options]
+    ["type", "source", "no-opts"].each do |expected_opt|
+      opt = found_opts.find {|x| x.name.to_s == expected_opt}
+      fail "Option '#{expected_opt}' not found on the Init command." unless opt
+    end
+  end
+  
+  it "extracts the descriptions of command-line options" do
+    found_opts = @init_cmd[:amp_data][:options]
+    expected_descriptions = ["Which type of repository (git, hg)", "Where the source repository could be found"]
+    expected_descriptions.each do |expected_desc|
+      opt = found_opts.find {|x| x.description == expected_desc}
+      fail "Option with description '#{expected_desc}' not found on the Init command." unless opt
+    end
+  end
+  
+  it "extracts the additional options associated with individual command-line options" do
+    found_opts = @init_cmd[:amp_data][:options]
+    type_opt = found_opts.find {|x| x.name == :type}
+    source_opt = found_opts.find {|x| x.name == :source}
+    none_opt = found_opts.find {|x| x.name == :"no-opts"}
+
+    type_opt.should_not be_nil
+    source_opt.should_not be_nil
+    type_opt[:options].should_not be_nil
+    source_opt[:options].should_not be_nil
+
+    type_opt[:options]["short"].should == "-t"
+    type_opt[:options]["type"].should == "string"
+    type_opt[:options]["default"].should == "hg"
+    
+    source_opt[:options]["short"].should == "-s"
+    source_opt[:options]["multi"].should == "true"
+    
+    none_opt[:options].should == {"type" => "flag"}
+  end
+  
+  it "attaches comments to parsed options" do
+    found_opts = @init_cmd[:amp_data][:options]
+    type_opt = found_opts.find {|x| x.name == :type}
+    
+    type_opt.docstring.should == "This option is used for the multi-repo-ness of amp"
+  end
+  
+  it "attaches tags to parsed options" do
+    found_opts = @init_cmd[:amp_data][:options]
+    source_opt = found_opts.find {|x| x.name == :source}
+    
+    source_opt.docstring.tags(:example).should_not be_empty
+  end
+end

data/templates/default/class/html/amp_options.erb

@@ -0,0 +1,15 @@
+<% if @amp_options.size > 0 %>
+  <h2>Command-line Options</h2>
+    <ul class="summary">
+      <% @amp_options.each do |option| %>
+        <li class="public">
+          <span class="summary_signature"><%= option.signature %></span>
+          <span class="summary_desc">
+            <div class="inline">
+              <p><%= option.description %></p>
+            </div>
+          </span>
+        </li>
+      <% end %>
+    </ul>
+<% end %>

data/templates/default/class/setup.rb

@@ -0,0 +1,15 @@
+def init
+  super
+  sections.place(:amp_options).before(:constant_summary)
+end
+
+def amp_options
+  unless object[:amp_data] && object[:amp_data][:options]
+    @amp_options = [] 
+  else
+    @amp_options = object[:amp_data][:options].sort do |x, y|
+      x.name <=> y.name
+    end
+  end
+  erb(:amp_options)
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification 
+name: yard-amp
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 4
+  - 0
+  version: 0.4.0
+platform: ruby
+authors: 
+- Michael Edgar
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-14 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 4
+        - 0
+        version: 0.4.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id002
+description: yard-amp is a YARD plugin that enables the automatic creation of YARD documentation from amp command declarations.
+email: michael.j.edgar@dartmouth.edu
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .document
+- .gitignore
+- .yardoc/checksums
+- .yardoc/objects/YARD/Amp.dat
+- .yardoc/objects/YARD/Amp/ModernCommandHandler.dat
+- .yardoc/objects/YARD/Amp/ModernCommandHandler/commands_module_i.dat
+- .yardoc/objects/YARD/Amp/ModernCommandHandler/process_i.dat
+- .yardoc/objects/root.dat
+- .yardoc/proxy_types
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- lib/yard-amp.rb
+- lib/yard-amp/legacy_handler.rb
+- lib/yard-amp/modern_handler.rb
+- lib/yard-amp/option.rb
+- lib/yard-amp/parsing_helpers.rb
+- spec/examples/example_helper.rb
+- spec/examples/examples/simple_command.rb.txt
+- spec/parsing_helpers_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/yard-amp_spec.rb
+- templates/default/class/html/amp_options.erb
+- templates/default/class/setup.rb
+- templates/default/class/text/amp_options.erb
+has_rdoc: true
+homepage: http://github.com/michaeledgar/yard-amp
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: Automatically create YARD documentation for Amp commands.
+test_files: 
+- spec/examples/example_helper.rb
+- spec/parsing_helpers_spec.rb
+- spec/spec_helper.rb
+- spec/yard-amp_spec.rb