yard-thor 0.0.1

data/lib/yard-thor.rb

@@ -0,0 +1,65 @@
+class YARD::Handlers::Processor
+  attr_accessor :extra_state
+end
+
+class ThorHandler < YARD::Handlers::Ruby::Base
+  namespace_only
+  handles method_call(:desc)
+  
+  process do
+    parser.extra_state ||= {}
+    parser.extra_state[:thor_desc] = statement.parameters(false).map do |param|
+      param.jump(:string_content).source
+    end
+  end
+end
+
+class LegacyThorHandler < YARD::Handlers::Ruby::Legacy::Base
+  namespace_only
+  handles /\Adesc(\s|\()/
+  
+  process do
+    parser.extra_state ||= {}
+	  parser.extra_state[:thor_desc] = tokval_list(statement.tokens[1..-1], :attr)
+  end
+end
+
+module ThorMethodHandlerMixin
+  def register(*objs)
+    @registered_object = objs.first
+    super(*objs)
+  end
+  
+  def process
+    super
+    return if parser.extra_state[:thor_desc].nil?
+    params, desc = *parser.extra_state[:thor_desc]
+    @registered_object.docstring = desc
+    @registered_object.signature = params
+    @registered_object.namespace.groups = ["Thor Commands"]
+    @registered_object.group = "Thor Commands"
+    @registered_object.docstring.add_tag YARD::Tags::Tag.new(:thor_command, '')
+    parser.extra_state.delete(:thor_desc)
+  end
+end
+
+class YARD::Handlers::Ruby::MethodHandler 
+  include ThorMethodHandlerMixin
+end
+
+class YARD::Handlers::Ruby::Legacy::MethodHandler 
+  include ThorMethodHandlerMixin
+end
+
+module YARD::Templates::Helpers::HtmlHelper
+  def signature_for_thor_command(meth, link = true, *args)
+    if meth.has_tag?(:thor_command)
+      sig = link ? link_object(meth, meth.signature) : meth.signature
+      "$ " + sig 
+    else
+      old_signature(meth, link, *args)
+    end
+  end
+  alias old_signature signature
+  alias signature signature_for_thor_command
+end

data/yard-thor.gemspec

@@ -0,0 +1,20 @@
+Gem::Specification.new do |s|
+	s.name = 'yard-thor'
+	s.version = '0.0.1'
+
+	s.summary = "Thor plugin for YARD."
+
+	s.authors = ["lsegal", "tutuMatilda"]
+	s.email = ["lsegal@soen.ca", "tutuMatilda@me.com"]
+
+	s.files = %w[
+		lib/yard-thor.rb
+		yard-thor.gemspec
+		README.markdown
+	]
+
+	s.add_dependency 'yard'
+	s.add_dependency 'thor'
+
+	s.homepage = "http://github.com/tutuMatilda/yard-thor"
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification 
+name: yard-thor
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- lsegal
+- tutuMatilda
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-28 00:00:00 -05:00
+default_executable: 
+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: thor
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+description: 
+email: 
+- lsegal@soen.ca
+- tutuMatilda@me.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/yard-thor.rb
+- yard-thor.gemspec
+- README.markdown
+has_rdoc: true
+homepage: http://github.com/tutuMatilda/yard-thor
+licenses: []
+
+post_install_message: 
+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.6.2
+signing_key: 
+specification_version: 3
+summary: Thor plugin for YARD.
+test_files: []
+