yard-mruby 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 08d0469722f4af2b09e0684dbb47f03e2c060734
-  data.tar.gz: ac36637449d471f3cdd81fe509e560c475839ff3
+  metadata.gz: 2331dc63f0fcd3803ccebebb54054fda385884b9
+  data.tar.gz: 668b9180bc48009d40f57f5e5ecd8f1b52431a17
 SHA512:
-  metadata.gz: 45d9a46db9354c8dafe08badec6fa347daeb8d9a4a65e3a3003e6d9169e742b30ab03e2b2b9fe7b0da3aa4a23c68e389960e4b6f8d9712de0a1c1dc4d2dfb9f2
-  data.tar.gz: 39c79479b9381ca33988d6c91251e6fc7a1cdca11ea0fed07e3719b6bc29ee1358b5313668aea8796d7cb567010f9325bf9c86279343b21f191f29684e70fd42
+  metadata.gz: 2c8b30a6f00e2f83ff8a58c8d43aeb3a9ea9070cceaa03108032617c12f5ad2d3609399ee4bd90d81adbb3b492ab70dc496fea7b96840e59231a51d51d8cfcc2
+  data.tar.gz: dd2b3f895761ae9315b76d1fc97d996ef6d87b319673b0096c941c3b48c539a811656286475b6fcdca0b2a6049fae9b15df9b9c3489b9ae6572646e69750f706

data/lib/yard-mruby.rb

@@ -1 +1 @@
-require 'yard/mruby'
+require 'yard/mruby' unless Kernel.const_defined?(:YARD) && YARD.const_defined?(:MRuby)

data/lib/yard/mruby.rb

@@ -4,5 +4,6 @@ require_relative "mruby/version"
 require_relative "mruby/code_objects"
 require_relative "mruby/parser"
 require_relative "mruby/handlers"
+require_relative "mruby/tags"
 require_relative "mruby/templates"
 require_relative "mruby/cli"

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

@@ -4,7 +4,7 @@ module YARD::MRuby::CLI
     # 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?
+      self.files = %w{src/**/*.c mrblib/**/*.rb include/**/*.h} if self.files.empty?
     end
   end
 

data/lib/yard/mruby/code_objects.rb

@@ -3,3 +3,4 @@ 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'
+require_relative 'code_objects/typedef_object'

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

@@ -11,6 +11,10 @@ module YARD::MRuby::CodeObjects
       children.find_all {|d| d.is_a?(DefineObject) } 
     end
 
+    def typedefs
+      children.find_all {|d| d.is_a?(TypedefObject) }
+    end
+
     def path
       self.name
     end

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

@@ -0,0 +1,8 @@
+module YARD::MRuby::CodeObjects
+
+  # A TypedefObject represents a MRuby C API typedef declaration inside a header inside an include directory
+  class TypedefObject < HeaderBaseObject
+  end
+end
+
+

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

@@ -2,3 +2,4 @@ require_relative 'header/base'
 require_relative 'header/function_handler'
 require_relative 'header/define_handler'
 require_relative 'header/header_decl_handler'
+require_relative 'header/typedef_handler'

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

@@ -0,0 +1,31 @@
+module YARD::MRuby::Handlers::C::Header
+  class TypedefHandler < Base
+    MATCH = /
+      typedef
+      (\s+(\*)?([A-Za-z0-9_\*]+))+
+      ;
+    /mx
+
+
+    handles MATCH
+    statement_class ToplevelStatement
+
+    process do
+      handle_typedef(statement)
+    end
+
+    def handle_typedef(statement)
+      header = self.header(statement.file)
+
+      statement.source.scan(MATCH) do |match|
+      name = match.last
+        register TypedefObject.new(header, name) do |obj|
+          if statement.comments
+            register_docstring(obj, statement.comments.source, statement)
+          end
+        end
+      end
+
+    end
+  end
+end

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

@@ -8,7 +8,7 @@ module YARD::MRuby::Handlers::C::Source
       \s*\(
       \s*\w+\s*,
       \s*(\w+)\s*,
-      \s*"(\w+)"\s*,
+      \s*"([^"]+)"\s*,
       \s*(\w+)\s*,
     /mx
 

data/lib/yard/mruby/tags.rb

@@ -0,0 +1,2 @@
+YARD::Tags::Library.define_tag("ISO Reference", :ISO, :with_title_and_text)
+YARD::Tags::Library.define_tag("Required mrbgem", :mrbgem, :with_title_and_text)

data/lib/yard/mruby/version.rb

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

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

@@ -5,6 +5,7 @@ def init
   sections :header, :pre_docstring, T('docstring'), :includes,
     :function_summary, [:item_summary],
     :define_summary, [T('docstring')],
+    :typedef_summary, [T('docstring')],
     :function_details_list, [T('function_details')]
 end
 
@@ -22,3 +23,10 @@ def define_listing
   @defines = object.defines
   @defines
 end
+
+def typedef_listing
+  return @typedefs if @typedefs
+
+  @typedefs = object.typedefs
+  @typedefs
+end

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

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

data/templates/default/tags/html/iso.erb

@@ -0,0 +1,3 @@
+<% if object.has_tag?(:ISO) %>
+	<p class="tag_title"><strong>ISO</strong>: <%= object.tag(:ISO).name %></p>
+<% end %>

data/templates/default/tags/html/mrbgem.erb

@@ -0,0 +1,3 @@
+<% if object.has_tag?(:mrbgem) %>
+	<p class="tag_title"><strong>Required mrbgem</strong>: <%= object.tag(:mrbgem).name %></p>
+<% end %>

data/templates/default/tags/setup.rb

@@ -1,5 +1,8 @@
 def init
   super
+
+  sections << :iso
+  sections << :mrbgem
 end
 
 def param

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yard-mruby
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Seba Gamboa
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-08 00:00:00.000000000 Z
+date: 2016-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -95,6 +95,7 @@ files:
 - 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/code_objects/typedef_object.rb
 - lib/yard/mruby/handlers.rb
 - lib/yard/mruby/handlers/c.rb
 - lib/yard/mruby/handlers/c/header.rb
@@ -102,6 +103,7 @@ files:
 - 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/header/typedef_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
@@ -115,6 +117,7 @@ files:
 - 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/tags.rb
 - lib/yard/mruby/templates.rb
 - lib/yard/mruby/templates/helpers.rb
 - lib/yard/mruby/templates/helpers/html_helper.rb
@@ -151,10 +154,13 @@ files:
 - templates/default/header/html/item_summary.erb
 - templates/default/header/html/pre_docstring.erb
 - templates/default/header/html/setup.rb
+- templates/default/header/html/typedef_summary.erb
 - 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/html/iso.erb
+- templates/default/tags/html/mrbgem.erb
 - templates/default/tags/setup.rb
 - yard-mruby.gemspec
 homepage: https://github.com/sagmor/yard-mruby