yard-mruby 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7e3468feb795ec8df9a061393de6d06130dcfa10
-  data.tar.gz: af22a19aebc351efb2dd5cb6d7c6d8b96e1981e2
+  metadata.gz: 08d0469722f4af2b09e0684dbb47f03e2c060734
+  data.tar.gz: ac36637449d471f3cdd81fe509e560c475839ff3
 SHA512:
-  metadata.gz: c89235ff1ffacc1ff1361baa8293a2be73682bf98c7814eb8c9fe1e4b52270a6e10a213f9bd547ab702e30af566018558f61d93a1b7c1641e0931bcf61e02bba
-  data.tar.gz: fae8caf9251763d8fa92eeea5cd4c7b68d878f7c525436bf503c8ac6e1710512c11efc46a2b0741b1cfb8ec284eb3d7f3a7fceff16b6f075cc5cbbc54f79463b
+  metadata.gz: 45d9a46db9354c8dafe08badec6fa347daeb8d9a4a65e3a3003e6d9169e742b30ab03e2b2b9fe7b0da3aa4a23c68e389960e4b6f8d9712de0a1c1dc4d2dfb9f2
+  data.tar.gz: 39c79479b9381ca33988d6c91251e6fc7a1cdca11ea0fed07e3719b6bc29ee1358b5313668aea8796d7cb567010f9325bf9c86279343b21f191f29684e70fd42

data/README.md

@@ -1,38 +1,28 @@
-# Yard::Mruby
+# yard-mruby
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/yard/mruby`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Gem](https://img.shields.io/gem/v/yard-mruby.svg)](https://rubygems.org/gems/yard-mruby)
+[![Travis](https://img.shields.io/travis/sagmor/yard-mruby.svg)](https://travis-ci.org/sagmor/yard-mruby)
 
-TODO: Delete this and the text above, and describe your gem
+This is a plugin that allows YARD to parse and generate documentation for MRuby sources as well as documenting it's C APIs.
 
-## Installation
+It still has it's [rough edges and missing features](https://github.com/sagmor/yard-mruby/issues) but you can see a [sample from it's current state when executed on MRuby's core here](https://sagmor.com/mruby/)
 
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'yard-mruby'
-```
-
-And then execute:
-
-    $ bundle
+## Usage
 
-Or install it yourself as:
+Install with rubygems
 
     $ gem install yard-mruby
 
-## Usage
-
-TODO: Write usage instructions here
+And execute `mrbdoc` to generate the docs
 
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/yard-mruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/sagmor/yard-mruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 
 ## License

data/exe/mrbdoc

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/yard/mruby'
+
+YARD::CLI::Yardoc.run(*ARGV)

data/lib/yard/mruby.rb

@@ -1,3 +1,8 @@
+require 'yard'
+
 require_relative "mruby/version"
 require_relative "mruby/code_objects"
-require_relative "handlers"
+require_relative "mruby/parser"
+require_relative "mruby/handlers"
+require_relative "mruby/templates"
+require_relative "mruby/cli"

data/lib/yard/mruby/cli.rb

@@ -0,0 +1 @@
+require_relative 'cli/yardoc'

data/lib/yard/mruby/cli/yardoc.rb

@@ -0,0 +1,14 @@
+module YARD::MRuby::CLI
+  module Yardoc
+
+    # Redefines default files for YARD::CLI::Yardoc
+    def parse_arguments(*args)
+      super(*args)
+      self.files = %w{mrblib/**/*.rb src/**/*.c include/**/*.h} if self.files.empty?
+    end
+  end
+
+  # Load Above modifications into YARD::CLI::Yardoc
+  YARD::CLI::Yardoc.include Yardoc
+end
+

data/lib/yard/mruby/code_objects.rb

@@ -1,3 +1,5 @@
+require_relative 'code_objects/headers_root'
+require_relative 'code_objects/header_base_object'
 require_relative 'code_objects/header_object'
 require_relative 'code_objects/function_object'
 require_relative 'code_objects/define_object'

data/lib/yard/mruby/code_objects/define_object.rb

@@ -1,7 +1,7 @@
 module YARD::MRuby::CodeObjects
 
   # A DefineObject represents a MRuby C API define macro declaration inside a header inside an include directory
-  class DefineObject < YARD::CodeObjects::Base
+  class DefineObject < HeaderBaseObject
   end
 end
 

data/lib/yard/mruby/code_objects/function_object.rb

@@ -1,7 +1,72 @@
 module YARD::MRuby::CodeObjects
 
   # A FunctionObject represents a MRuby C API function declaration inside a header inside an include directory
-  class FunctionObject < YARD::CodeObjects::Base
+  class FunctionObject < HeaderBaseObject
+    ParameterType = Struct.new(:type,:name)
+
+    # Returns the list of parameters parsed out of the method signature
+    # with their default values.
+    #
+    # @return [Array<Array(String, String)>] a list of parameter names followed
+    #   by their default values (or nil)
+    attr_accessor :parameters
+
+    def initialize(header, name, &block)
+      super
+    end
+
+    def attr_info
+      nil
+    end
+
+    def scope
+      ''
+    end
+
+    def return_type
+      @return_type
+    end
+
+    def return_type=(type)
+      @return_type = (type == 'void' ? nil : type)
+    end
+
+    # Returns the list of parameters parsed out of the method signature
+    # with their default values.
+    #
+    # @return [Array<Array(String, String)>] a list of parameter names followed
+    #   by their default values (or nil)
+    def parameters
+      parameter_types.map{|t| [(t.type == '...' ? '...' : t.name), nil] }
+    end
+
+    def parameter_types
+      @parameter_types || []
+    end
+
+    def parse_parameter_types(parameters)
+      @parameter_types = []
+      return if parameters.match /^\s*void\s*$/
+
+      parameters.split(',').each do |parameter|
+        parameter.scan(/((?:const\s+)?(?:struct\s+)?(?:\w+|\.\.\.)(?:\s*\*)?)\s*(\w+)?/) do |type,name|
+          @parameter_types << ParameterType.new(type,name)
+        end
+      end
+
+    end
+
+
+    # Returns all alias names of the object
+    # @return [Array<Symbol>] the alias names
+    def aliases
+      list = []
+      return list unless namespace.is_a?(HeaderObject)
+      namespace.aliases.each do |o, aname|
+        list << o if aname == name && o.scope == scope
+      end
+      list
+    end
   end
 end
 

data/lib/yard/mruby/code_objects/header_base_object.rb

@@ -0,0 +1,15 @@
+module YARD::MRuby::CodeObjects
+
+  # A FunctionObject represents a MRuby C API function declaration inside a header inside an include directory
+  class HeaderBaseObject < YARD::CodeObjects::Base
+
+    def header
+      self.namespace
+    end
+
+    # Header objects's shouln't be namespaced
+    def path
+      self.name.to_s
+    end
+  end
+end

data/lib/yard/mruby/code_objects/header_object.rb

@@ -3,5 +3,24 @@ module YARD::MRuby::CodeObjects
   # A HeaderObject represents a MRuby header inside an include directory
   # It groups C Functions and define macros.
   class HeaderObject < YARD::CodeObjects::NamespaceObject
+    def functions
+      children.find_all {|d| d.is_a?(FunctionObject) } 
+    end
+
+    def defines
+      children.find_all {|d| d.is_a?(DefineObject) } 
+    end
+
+    def path
+      self.name
+    end
+
+    def title
+      super.to_s
+    end
+
+    def inheritance_tree(*args)
+      return [self]
+    end
   end
 end

data/lib/yard/mruby/code_objects/headers_root.rb

@@ -0,0 +1,14 @@
+module YARD::MRuby::CodeObjects
+
+  class HeadersRoot < YARD::CodeObjects::NamespaceObject
+    def headers
+      children
+    end
+
+    def inheritance_tree(*args)
+      return [self]
+    end
+  end
+
+  HEADERS_ROOT = HeadersRoot.new(:root, "headers")
+end

data/lib/yard/mruby/handlers.rb

@@ -0,0 +1 @@
+require_relative 'handlers/c'

data/lib/yard/mruby/handlers/c.rb

@@ -0,0 +1,4 @@
+require_relative 'c/source'
+require_relative 'c/header'
+
+YARD::Handlers::Processor.namespace_for_handler.delete(:c)

data/lib/yard/mruby/handlers/c/header.rb

@@ -0,0 +1,4 @@
+require_relative 'header/base'
+require_relative 'header/function_handler'
+require_relative 'header/define_handler'
+require_relative 'header/header_decl_handler'

data/lib/yard/mruby/handlers/c/header/base.rb

@@ -0,0 +1,30 @@
+module YARD::MRuby::Handlers
+  module C
+    module Header
+      class Base < YARD::Handlers::C::Base
+        include YARD::MRuby::CodeObjects
+
+        def header(path)
+          # Remove include prefix
+          path = path.gsub(/^.*include\//,'')
+
+          headers[path] ||= begin
+                              header = HeaderObject.new(HEADERS_ROOT, path)
+                              register header
+                              header
+                            end
+
+
+        end
+
+        def headers
+          globals.mruby_headers ||= {}
+        end
+
+      end
+
+    end
+
+    YARD::Handlers::Processor.register_handler_namespace :header, Header
+  end
+end

data/lib/yard/mruby/handlers/c/header/define_handler.rb

@@ -0,0 +1,23 @@
+module YARD::MRuby::Handlers::C::Header
+  class DefineHandler < Base
+    MATCH = /
+      \#\s*define\s*(\w+)
+    /mx
+
+    handles MATCH
+    statement_class YARD::MRuby::Parser::C::DirectiveStatement
+
+    process do
+      header = self.header(statement.file)
+
+      statement.declaration.scan(MATCH) do |match|
+        register DefineObject.new(header, match.first) do |obj|
+          if statement.comments
+            register_docstring(obj, statement.comments.source, statement)
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/yard/mruby/handlers/c/header/function_handler.rb

@@ -0,0 +1,33 @@
+module YARD::MRuby::Handlers::C::Header
+  class FunctionHandler < Base
+    MATCH = /
+      MRB_(API|INLINE)\s+
+      ((struct\s+)?\w+(\s*\*)?)\s*
+      ((\w+\s+)+)?(\w+)\s*
+      \(([\w\s\*,\.]*)\)
+    /mx
+
+    handles MATCH
+    statement_class ToplevelStatement
+
+    process do
+      handle_function(statement)
+    end
+
+    def handle_function(statement)
+      header = self.header(statement.file)
+
+      statement.source.scan(MATCH) do |type, retype, _,_,_,_, name, parameters|
+        register FunctionObject.new(header, name) do |obj|
+          if statement.comments
+            register_docstring(obj, statement.comments.source, statement)
+          end
+
+          obj.return_type = retype
+          obj.parse_parameter_types(parameters)
+
+        end
+      end
+    end
+  end
+end

data/lib/yard/mruby/handlers/c/header/header_decl_handler.rb

@@ -0,0 +1,20 @@
+module YARD::MRuby::Handlers::C::Header
+  class HeaderDeclHandler < Base
+    MATCH = /
+      MRB_BEGIN_DECL
+    /mx
+
+    handles MATCH
+    statement_class ToplevelStatement
+
+    process do
+      header = self.header(statement.file)
+
+      if statement.comments
+        register_docstring(header, statement.comments.source, statement)
+      end
+    end
+
+  end
+end
+

data/lib/yard/mruby/handlers/c/source.rb

@@ -0,0 +1,7 @@
+require_relative 'source/base'
+require_relative 'source/init_handler'
+require_relative 'source/symbol_handler'
+require_relative 'source/class_handler'
+require_relative 'source/module_handler'
+require_relative 'source/method_handler'
+

data/lib/yard/mruby/handlers/c/source/base.rb

@@ -0,0 +1,56 @@
+module YARD::MRuby::Handlers
+  module C
+    module Source
+      class Base < YARD::Handlers::C::Base
+
+        DEFAULT_NAMESPACES = {
+          # 'mrb->top_self'      => '',
+          'object_class'  => 'Object',
+          'class_class'   => 'Class',
+          'module_class'  => 'Module',
+          'proc_class'    => 'Proc',
+          'string_class'  => 'String',
+          'array_class'   => 'Array',
+          'hash_class'    => 'Hash',
+          'float_class'   => 'Float',
+          'fixnum_class'  => 'Fixnum',
+          'true_class'    => 'TrueClass',
+          'false_class'   => 'FalseClass',
+          'nil_class'     => 'NilClass',
+          'symbol_class'  => 'Symbol',
+          'kernel_module' => 'Kernel',
+          'eException_class' => 'Exception',
+          'eStandardError_class' => 'StandardError'
+        }
+
+        def namespace_for_variable(var)
+          DEFAULT_NAMESPACES[ var[/^\w+->(\w+)$/, 1] ] || super
+        end
+
+        def handle_class(var_name, class_name, parent, stmt, in_module = nil)
+          object = super(var_name, class_name, parent, in_module)
+
+          if stmt.comments
+            register_docstring(object, stmt.comments.source, stmt)
+          end
+
+          object
+        end
+
+        def handle_module(var_name, module_name, stmt, in_module = nil)
+          object = super(var_name, module_name, in_module)
+
+          if stmt.comments
+            register_docstring(object, stmt.comments.source, stmt)
+          end
+
+          object
+        end
+
+      end
+
+    end
+
+    YARD::Handlers::Processor.register_handler_namespace :source, Source
+  end
+end

data/lib/yard/{handlers/c/mruby_class_handler.rb → mruby/handlers/c/source/class_handler.rb}

@@ -1,5 +1,5 @@
-module YARD::Handlers::C
-  class MRubyClassHandler < MRubyBase
+module YARD::MRuby::Handlers::C::Source
+  class ClassHandler < Base
 
     TOP_LEVEL_CLASS = /([\w]+)\s*=\s*mrb_define_class\s*
       \(

data/lib/yard/mruby/handlers/c/source/init_handler.rb

@@ -0,0 +1,16 @@
+module YARD::MRuby::Handlers::C::Source
+  class InitHandler < Base
+    MATCH1 = /mrb_\w+_gem_init\s*\(/mx
+    MATCH2 = /mrb_init_/mx
+
+    handles MATCH1
+    handles MATCH2
+    statement_class ToplevelStatement
+
+    process do
+      parse_block
+    end
+
+  end
+end
+

data/lib/yard/{handlers/c/mruby_method_handler.rb → mruby/handlers/c/source/method_handler.rb}

@@ -1,5 +1,5 @@
-module YARD::Handlers::C
-  class MRubyMethodHandler < MRubyBase
+module YARD::MRuby::Handlers::C::Source
+  class MethodHandler < Base
     MATCH1 = /mrb_define_(
         method |
         singleton_method |

data/lib/yard/{handlers/c/mruby_module_handler.rb → mruby/handlers/c/source/module_handler.rb}

@@ -1,5 +1,5 @@
-module YARD::Handlers::C
-  class MRubyModuleHandler < MRubyBase
+module YARD::MRuby::Handlers::C::Source
+  class ModuleHandler < Base
 
     TOP_LEVEL_MODULE = /([\w]+)\s*=\s*mrb_define_module\s*
       \(

data/lib/yard/{handlers/c/mruby_symbol_handler.rb → mruby/handlers/c/source/symbol_handler.rb}

@@ -1,6 +1,7 @@
-module YARD::Handlers::C
+module YARD::MRuby::Handlers::C::Source
   # Keeps track of function bodies for symbol lookup during MRuby method declarations
-  class MRubySymbolHandler < MRubyBase
+  class SymbolHandler < Base
+
     MATCH = /
       mrb_value\s*(\w+)\s*\(\s*mrb_state\s*\*\s*\w+,\s*mrb_value\s*\w+\s*\)
     /mx

data/lib/yard/mruby/parser.rb

@@ -0,0 +1 @@
+require_relative 'parser/c'

data/lib/yard/mruby/parser/c.rb

@@ -0,0 +1,4 @@
+require_relative 'c/parser'
+require_relative 'c/source_parser'
+require_relative 'c/header_parser'
+require_relative 'c/directive_statement'

data/lib/yard/mruby/parser/c/directive_statement.rb

@@ -0,0 +1,6 @@
+module YARD::MRuby::Parser::C
+  class DirectiveStatement < YARD::Parser::C::Statement
+    attr_accessor :declaration
+    attr_accessor :comments
+  end
+end

data/lib/yard/mruby/parser/c/header_parser.rb

@@ -0,0 +1,49 @@
+module YARD::MRuby::Parser::C
+  class HeaderParser < Parser
+
+    # Consumes a directive and generates a DirectiveStatement
+    def consume_directive
+      super if @in_body_statements
+
+      @newline = false
+      start = @index
+      line = @line
+      statement = DirectiveStatement.new(nil, @file, line)
+      @statements << statement
+      attach_comment(statement)
+
+      multiline = false
+      advance_loop do
+        chr = char
+        case chr
+        when '\\'; multiline=true; advance
+        when /\s/; consume_whitespace
+        else advance
+        end
+
+        if @newline
+          if multiline
+            multiline = false
+          else
+            break
+          end
+        end
+      end
+
+      decl = @content[start...@index]
+
+      statement.declaration = decl
+    end
+
+    def consume_body_statements
+      @in_body_statements = true
+      result = super
+      @in_body_statements = false
+      result
+    end
+  end
+
+  #
+  # Register all header files (.h) to be processed with the above HeaderParser
+  YARD::Parser::SourceParser.register_parser_type :header, HeaderParser, 'h'
+end

data/lib/yard/mruby/parser/c/parser.rb

@@ -0,0 +1,10 @@
+module YARD::MRuby::Parser
+  module C
+    class Parser < YARD::Parser::C::CParser
+    end
+
+    # Disable default C Parser
+    YARD::Parser::SourceParser.parser_types.delete(:c)
+    YARD::Parser::SourceParser.parser_type_extensions.delete(:c)
+  end
+end

data/lib/yard/mruby/parser/c/source_parser.rb

@@ -0,0 +1,9 @@
+module YARD::MRuby::Parser::C
+  class SourceParser < Parser
+  end
+
+  #
+  # Register all header files (.h) to be processed with the above HeaderParser
+  YARD::Parser::SourceParser.register_parser_type :source, SourceParser, 'c'
+
+end

data/lib/yard/mruby/templates.rb

@@ -0,0 +1,9 @@
+require_relative 'templates/helpers'
+
+YARD::MRuby::TEMPLATES_PATH = File.expand_path('../../../../templates', __FILE__)
+
+# This registered template works for yardoc
+YARD::Templates::Engine.register_template_path YARD::MRuby::TEMPLATES_PATH
+
+# The following static paths and templates are for yard server
+# YARD::Server.register_static_path File.join(YARD::MRuby::TEMPLATES_PATH,'default/fulldoc/html')

data/lib/yard/mruby/templates/helpers.rb

@@ -0,0 +1 @@
+require_relative 'helpers/html_helper'

data/lib/yard/mruby/templates/helpers/html_helper.rb

@@ -0,0 +1,32 @@
+module YARD::MRuby::Templates
+  module Helpers
+    # Helper methods for text template formats.
+    module HTMLHelper
+
+      def fsignature(func, link = true, show_extras = true)
+        name = func.name
+        prefix = func.return_type || 'void'
+        params = if func.parameter_types.empty?
+                    'void'
+                  else
+                    func.parameter_types.map do |t|
+                      if show_extras
+                        [t.type, t.name].join(' ')
+                      else
+                        t.type
+                      end
+                    end.join(', ')
+                  end
+        title = "%s <strong>%s</strong>(%s)" % [h(prefix), h(name), h(params)]
+
+        if link
+          url = url_for(func)
+          link_url(url, title, :title => name)
+        else
+          title
+        end
+      end
+
+    end
+  end
+end

data/lib/yard/mruby/version.rb

@@ -1,5 +1,5 @@
 module YARD
   module MRuby
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/sample/.yardopts

@@ -1,3 +1,4 @@
 --plugin mruby
 mrblib/**/*.rb
 src/**/*.c
+include/**/*.h

data/templates/default/fulldoc/html/full_list_functions.erb

@@ -0,0 +1,10 @@
+<% even_odd = 'odd'  %>
+<% @items.each do |item| %>
+  <li class="<%= even_odd %> <%= item.has_tag?(:deprecated) ? 'deprecated' : '' %>">
+    <div class="item">
+      <%= linkify item, h(item.name(true)) %>
+      <small><%= item.header.title %></small>
+    </div>
+  </li>
+  <% even_odd = (even_odd == 'even' ? 'odd' : 'even') %>
+<% end %>

data/templates/default/fulldoc/html/full_list_headers.erb

@@ -0,0 +1,10 @@
+<li id="object_" class="odd"><div class="item" style="padding-left:30px"><%= link_object(YARD::MRuby::CodeObjects::HEADERS_ROOT, "All Headers", nil, false) %></div></li>
+<% even_odd = 'odd'  %>
+<% @items.each do |item| %>
+   <li class="<%= even_odd %>">
+    <div class="item">
+      <%= linkify item, h(item.name(true)) %>
+    </div>
+  </li>
+  <% even_odd = (even_odd == 'even' ? 'odd' : 'even') %>
+<% end %>

data/templates/default/fulldoc/html/setup.rb

@@ -0,0 +1,62 @@
+def init
+  super
+
+   YARD::MRuby::CodeObjects::HEADERS_ROOT.tap do |root|
+
+     # Generates the requirements splash page with the 'include' template
+     serialize root
+
+     root.headers.each do |header|
+       serialize header
+     end
+   end
+
+end
+
+def generate_header_list
+  headers = Registry.all(:header)
+  headers_ordered_by_name = headers.sort {|x,y| x.name.to_s <=> y.name.to_s }
+  generate_full_list headers_ordered_by_name, :headers
+end
+
+def generate_function_list
+  functions = Registry.all(:function)
+  functions_ordered_by_name = functions.sort {|x,y| x.name.to_s <=> y.name.to_s }
+  generate_full_list functions_ordered_by_name, :functions
+end
+
+# Helpler method to generate a full_list page of the specified objects with the
+# specified type.
+def generate_full_list(objects,type,options = {})
+  defaults = { :list_title => "#{type.to_s.capitalize} List",
+    :css_class => "class",
+    :list_filename => "#{type.to_s.gsub(/s$/,'')}_list.html" }
+
+  options = defaults.merge(options)
+
+  @items = objects
+  @list_type = type
+  @list_title = options[:list_title]
+  @list_class = options[:css_class]
+  asset options[:list_filename], erb(:full_list)
+end
+
+#
+# @note This method overrides YARD's default template class_list method.
+#
+# The existing YARD 'Class List' search field contains all the YARD namespace objects.
+# We, however, do not want the Include Namespace YARD Object (which holds the headers)
+# as it is a meta-object.
+#
+# This method removes the namespace from the root node, generates the class list,
+# and then adds it back into the root node.
+#
+def class_list(root = Registry.root)
+  return super unless root == Registry.root
+
+  include_namespace = YARD::MRuby::CodeObjects::HEADERS_ROOT
+  root.instance_eval { children.delete include_namespace }
+  out = super(root)
+  root.instance_eval { children.push include_namespace }
+  out
+end

data/templates/default/function_details/html/function_signature.erb

@@ -0,0 +1,10 @@
+<h3 class="signature <%= 'first' if @index == 0 %>" id="<%= anchor_for(object) %>">
+  <%= fsignature(object, false) %>
+
+  <% if object.aliases.size > 0 %>
+    <span class="aliases">Also known as:
+    <span class="names"><%= object.aliases.map {|o|
+      "<span id='#{anchor_for(o)}'>" + h(o.name.to_s) + "</span>" }.join(", ") %></span>
+    </span>
+  <% end %>
+</h3>

data/templates/default/function_details/html/header.erb

@@ -0,0 +1,3 @@
+<div class="method_details <%= @index == 0 ? 'first' : '' %>">
+  <%= yieldall %>
+</div>

data/templates/default/function_details/html/source.erb

@@ -0,0 +1,10 @@
+<table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines"><%= "\n\n\n" %><%= h format_lines(object) %></pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File '<%= h object.file %>'<% if object.line %>, line <%= object.line %><% end %></span><%= "\n\n" %><%= html_syntax_highlight object.source %></pre>
+    </td>
+  </tr>
+</table>

data/templates/default/function_details/setup.rb

@@ -0,0 +1,12 @@
+include YARD::MRuby::Templates::Helpers::HTMLHelper
+
+def init
+  sections :header, [:function_signature, T('docstring'), :source]
+end
+
+def source
+  return if owner != object.namespace
+  return if Tags::OverloadTag === object
+  return if object.source.nil?
+  erb(:source)
+end

data/templates/default/header/html/define_summary.erb

@@ -0,0 +1,11 @@
+<% if define_listing.size > 0 %>
+  <h2>Define Summary</h2>
+  <dl class="constants">
+    <% define_listing.each do |define| %>
+      <dt id="<%= anchor_for(define) %>" class="<%= define.has_tag?(:deprecated) ? 'deprecated' : '' %>"><small>#define</small> <%= define.name %>
+        <%= yieldall :object => define %>
+      </dt>
+      <dd><pre class="code"><%#= format_constant define.value %></pre></dd>
+    <% end %>
+  </dl>
+<% end %>

data/templates/default/header/html/function_details_list.erb

@@ -0,0 +1,7 @@
+<div id="functions_details" class="method_details_list">
+  <h2>Function Details</h2>
+
+  <% function_listing.each_with_index do |func, i| %>
+    <%= yieldall :object => func, :owner => object, :index => i %>
+  <% end %>
+</div>

data/templates/default/header/html/function_summary.erb

@@ -0,0 +1,12 @@
+<% if function_listing.size > 0 %>
+  <h2>
+    Function Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+    <% function_listing.each do |func| %>
+      <%= yieldall :item => func %>
+    <% end %>
+  </ul>
+<% end %>

data/templates/default/header/html/functions.erb

@@ -0,0 +1 @@
+Header functions!

data/templates/default/header/html/header.erb

@@ -0,0 +1 @@
+<h1><%= format_object_title(object) %></h1>

data/templates/default/header/html/includes.erb

@@ -0,0 +1 @@
+Included heaers

data/templates/default/header/html/item_summary.erb

@@ -0,0 +1,19 @@
+<li class="<%= @item.visibility %> <%= @item.has_tag?(:deprecated) ? 'deprecated' : '' %>">
+  <span class="summary_signature">
+    <%= fsignature(@item, true, false) %>
+
+    <% if @item.aliases.size > 0 %>
+      (also: <%= @item.aliases.map {|o| h(o.name(true)) }.join(", ") %>)
+    <% end %>
+  </span>
+  <% if @item.visibility != :public %><span class="note title <%= @item.visibility %>"><%= @item.visibility %></span><% end %>
+  <% if @item.has_tag?(:abstract) %><span class="abstract note title">abstract</span><% end %>
+  <% if @item.has_tag?(:deprecated) %><span class="deprecated note title">deprecated</span><% end %>
+  <% if @item.has_tag?(:api) && @item.tag(:api).text == 'private' %><span class="private note title">private</span><% end %>
+
+  <% if @item.has_tag?(:deprecated) %>
+    <span class="summary_desc"><strong>Deprecated.</strong> <%= htmlify_line @item.tag(:deprecated).text %></span>
+  <% else %>
+    <span class="summary_desc"><%= htmlify_line docstring_summary(@item) %></span>
+  <% end %>
+</li>

data/templates/default/header/html/pre_docstring.erb

@@ -0,0 +1 @@
+<h2>Overview</h2>

data/templates/default/header/html/setup.rb

@@ -0,0 +1,24 @@
+include T('default/module')
+include YARD::MRuby::Templates::Helpers::HTMLHelper
+
+def init
+  sections :header, :pre_docstring, T('docstring'), :includes,
+    :function_summary, [:item_summary],
+    :define_summary, [T('docstring')],
+    :function_details_list, [T('function_details')]
+end
+
+
+def function_listing
+  return @funcs if @funcs
+
+  @funcs = object.functions
+  @funcs
+end
+
+def define_listing
+  return @defines if @defines
+
+  @defines = object.defines
+  @defines
+end

data/templates/default/headersroot/html/headers_list.erb

@@ -0,0 +1,6 @@
+<h2>All headers</h2>
+<p class="children">
+  <% headers.each do |header| %>
+    <%= linkify(header, header.name(true)) %>
+  <% end %>
+</p>

data/templates/default/headersroot/html/setup.rb

@@ -0,0 +1,10 @@
+def init
+  super
+  sections.push :headers_list
+
+  @namespace = object
+end
+
+def headers
+  object.headers
+end

data/templates/default/layout/html/footer.erb

@@ -0,0 +1,5 @@
+<div id="footer">
+  Generated on <%= Time.now.strftime("%c") %> by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  <%= YARD::VERSION %> in <a href="https://github.com/sagmor/yard-mruby">mruby mode</a> <%= YARD::MRuby::VERSION %> (ruby-<%= RUBY_VERSION %>).
+</div>

data/templates/default/layout/html/setup.rb

@@ -0,0 +1,52 @@
+def init
+  super
+end
+
+#
+# Append yard-cucumber stylesheet to yard core stylesheets
+#
+def stylesheets
+  super + %w(css/mruby.css)
+end
+
+#
+# Append yard-cucumber javascript to yard core javascripts
+#
+def javascripts
+  super + %w(js/mruby.js)
+end
+
+#
+# Append yard-cucumber specific menus 'features' and 'tags'
+#
+# 'features' and 'tags' are enabled by default.
+#
+# 'step definitions' and 'steps' may be enabled by setting up a value in
+# yard configuration file '~/.yard/config'
+#
+# @example `~/.yard.config`
+#
+#     yard-cucumber:
+#       menus: [ 'features', 'directories', 'tags', 'step definitions', 'steps' ]
+#
+def menu_lists
+  menus = super
+  last = menus.pop
+
+  menus.push({
+    type: 'header',
+    title: 'Headers',
+    search_title: 'Header List'
+  })
+
+  menus.push({
+    type: 'function',
+    title: 'Functions',
+    search_title: 'Function List'
+  })
+
+  menus.push last
+
+  menus
+end
+

data/templates/default/tags/setup.rb

@@ -0,0 +1,7 @@
+def init
+  super
+end
+
+def param
+  super || tag(:param) if object.type == :function
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yard-mruby
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Seba Gamboa
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-09-23 00:00:00.000000000 Z
+date: 2015-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -69,7 +69,8 @@ dependencies:
 description: Generate Yard documentation for MRuby projects.
 email:
 - me@sagmor.com
-executables: []
+executables:
+- mrbdoc
 extensions: []
 extra_rdoc_files: []
 files:
@@ -83,24 +84,40 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- exe/mrbdoc
 - lib/yard-mruby.rb
-- lib/yard/handlers.rb
-- lib/yard/handlers/c.rb
-- lib/yard/handlers/c/mruby_base.rb
-- lib/yard/handlers/c/mruby_class_handler.rb
-- lib/yard/handlers/c/mruby_method_handler.rb
-- lib/yard/handlers/c/mruby_module_handler.rb
-- lib/yard/handlers/c/mruby_symbol_handler.rb
-- lib/yard/handlers/header.rb
-- lib/yard/handlers/header/base.rb
-- lib/yard/handlers/header/define_handler.rb
-- lib/yard/handlers/header/function_handler.rb
-- lib/yard/handlers/header/header_handler.rb
 - lib/yard/mruby.rb
+- lib/yard/mruby/cli.rb
+- lib/yard/mruby/cli/yardoc.rb
 - lib/yard/mruby/code_objects.rb
 - lib/yard/mruby/code_objects/define_object.rb
 - lib/yard/mruby/code_objects/function_object.rb
+- lib/yard/mruby/code_objects/header_base_object.rb
 - lib/yard/mruby/code_objects/header_object.rb
+- lib/yard/mruby/code_objects/headers_root.rb
+- lib/yard/mruby/handlers.rb
+- lib/yard/mruby/handlers/c.rb
+- lib/yard/mruby/handlers/c/header.rb
+- lib/yard/mruby/handlers/c/header/base.rb
+- lib/yard/mruby/handlers/c/header/define_handler.rb
+- lib/yard/mruby/handlers/c/header/function_handler.rb
+- lib/yard/mruby/handlers/c/header/header_decl_handler.rb
+- lib/yard/mruby/handlers/c/source.rb
+- lib/yard/mruby/handlers/c/source/base.rb
+- lib/yard/mruby/handlers/c/source/class_handler.rb
+- lib/yard/mruby/handlers/c/source/init_handler.rb
+- lib/yard/mruby/handlers/c/source/method_handler.rb
+- lib/yard/mruby/handlers/c/source/module_handler.rb
+- lib/yard/mruby/handlers/c/source/symbol_handler.rb
+- lib/yard/mruby/parser.rb
+- lib/yard/mruby/parser/c.rb
+- lib/yard/mruby/parser/c/directive_statement.rb
+- lib/yard/mruby/parser/c/header_parser.rb
+- lib/yard/mruby/parser/c/parser.rb
+- lib/yard/mruby/parser/c/source_parser.rb
+- lib/yard/mruby/templates.rb
+- lib/yard/mruby/templates/helpers.rb
+- lib/yard/mruby/templates/helpers/html_helper.rb
 - lib/yard/mruby/version.rb
 - sample/.gitignore
 - sample/.inch.yml
@@ -116,6 +133,29 @@ files:
 - sample/mrblib/sample.rb
 - sample/src/sample.c
 - sample/test/sample_spec.rb
+- templates/default/fulldoc/html/css/mruby.css
+- templates/default/fulldoc/html/full_list_functions.erb
+- templates/default/fulldoc/html/full_list_headers.erb
+- templates/default/fulldoc/html/js/mruby.js
+- templates/default/fulldoc/html/setup.rb
+- templates/default/function_details/html/function_signature.erb
+- templates/default/function_details/html/header.erb
+- templates/default/function_details/html/source.erb
+- templates/default/function_details/setup.rb
+- templates/default/header/html/define_summary.erb
+- templates/default/header/html/function_details_list.erb
+- templates/default/header/html/function_summary.erb
+- templates/default/header/html/functions.erb
+- templates/default/header/html/header.erb
+- templates/default/header/html/includes.erb
+- templates/default/header/html/item_summary.erb
+- templates/default/header/html/pre_docstring.erb
+- templates/default/header/html/setup.rb
+- templates/default/headersroot/html/headers_list.erb
+- templates/default/headersroot/html/setup.rb
+- templates/default/layout/html/footer.erb
+- templates/default/layout/html/setup.rb
+- templates/default/tags/setup.rb
 - yard-mruby.gemspec
 homepage: https://github.com/sagmor/yard-mruby
 licenses:
@@ -137,7 +177,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Generate Yard documentation for MRuby projects.

data/lib/yard/handlers.rb

@@ -1,2 +0,0 @@
-require_relative 'handlers/c'
-#require_relative 'handlers/header'

data/lib/yard/handlers/c.rb

@@ -1,6 +0,0 @@
-require_relative 'c/mruby_base'
-require_relative 'c/mruby_symbol_handler'
-require_relative 'c/mruby_class_handler'
-require_relative 'c/mruby_module_handler'
-require_relative 'c/mruby_method_handler'
-

data/lib/yard/handlers/c/mruby_base.rb

@@ -1,47 +0,0 @@
-module YARD::Handlers::C
-  class MRubyBase < Base
-
-    DEFAULT_NAMESPACES = {
-      # 'mrb->top_self'      => '',
-      'object_class'  => 'Object',
-      'class_class'   => 'Class',
-      'module_class'  => 'Module',
-      'proc_class'    => 'Proc',
-      'string_class'  => 'String',
-      'array_class'   => 'Array',
-      'hash_class'    => 'Hash',
-      'float_class'   => 'Float',
-      'fixnum_class'  => 'Fixnum',
-      'true_class'    => 'TrueClass',
-      'false_class'   => 'FalseClass',
-      'nil_class'     => 'NilClass',
-      'symbol_class'  => 'Symbol',
-      'kernel_module' => 'Kernel'
-    }
-
-    def namespace_for_variable(var)
-      DEFAULT_NAMESPACES[ var[/^\w+->(\w+)$/, 1] ] || super
-    end
-
-    def handle_class(var_name, class_name, parent, stmt, in_module = nil)
-      object = super(var_name, class_name, parent, in_module)
-
-      if stmt.comments
-        register_docstring(object, stmt.comments.source, stmt)
-      end
-
-      object
-    end
-
-    def handle_module(var_name, module_name, stmt, in_module = nil)
-      object = super(var_name, module_name, in_module)
-
-      if stmt.comments
-        register_docstring(object, stmt.comments.source, stmt)
-      end
-
-      object
-    end
-
-  end
-end

data/lib/yard/handlers/header.rb

@@ -1 +0,0 @@
- require_relative 'header/base' 

data/lib/yard/handlers/header/base.rb

@@ -1,11 +0,0 @@
-module YARD
-  module MRuby
-    module Handlers
-      module Header
-        class Base < YARD::Handlers::Base
-          include YARD::Parser::C
-        end
-      end
-    end
-  end
-end