my_yard 0.0.1

data/home_my_yard/templates/visualruby/module/setup.rb

@@ -0,0 +1,164 @@
+include Helpers::ModuleHelper
+
+def init
+  sections :header, :box_info, :pre_docstring, T('docstring'), :children,
+    :constant_summary, [T('docstring')], :inherited_constants,
+    :attribute_summary, [:item_summary], :inherited_attributes,
+    :method_summary, [:item_summary], :inherited_methods,
+    :methodmissing, [T('method_details')],
+    :attribute_details, [T('method_details')],
+    :method_details_list, [T('method_details')]
+end
+
+def pre_docstring
+  return if object.docstring.blank?
+  erb(:pre_docstring)
+end
+
+def children
+  @inner = [[:modules, []], [:classes, []]]
+  object.children.each do |child|
+    @inner[0][1] << child if child.type == :module
+    @inner[1][1] << child if child.type == :class
+  end
+  @inner.map! {|v| [v[0], run_verifier(v[1].sort_by {|o| o.name.to_s })] }
+  return if (@inner[0][1].size + @inner[1][1].size) == 0
+  erb(:children)
+end
+
+def methodmissing
+  mms = object.meths(:inherited => true, :included => true)
+  return unless @mm = mms.find {|o| o.name == :method_missing && o.scope == :instance }
+  erb(:methodmissing)
+end
+
+def method_listing(include_specials = true)
+  return @smeths ||= method_listing.reject {|o| special_method?(o) } unless include_specials
+  return @meths if @meths
+  @meths = object.meths(:inherited => false, :included => !options.embed_mixins.empty?)
+  if options.embed_mixins.size > 0
+    @meths = @meths.reject {|m| options.embed_mixins_match?(m.namespace) == false }
+  end
+  @meths = sort_listing(prune_method_listing(@meths))
+  @meths
+end
+
+def special_method?(meth)
+  return true if meth.name(true) == '#method_missing'
+  return true if meth.constructor?
+  false
+end
+
+def attr_listing
+  return @attrs if @attrs
+  @attrs = []
+  object.inheritance_tree(true).each do |superclass|
+    next if superclass.is_a?(CodeObjects::Proxy)
+    next if options.embed_mixins.size > 0 &&
+      options.embed_mixins_match?(superclass) == false
+    [:class, :instance].each do |scope|
+      superclass.attributes[scope].each do |name, rw|
+        attr = prune_method_listing([rw[:read], rw[:write]].compact, false).first
+        @attrs << attr if attr
+      end
+    end
+    break if options.embed_mixins.empty?
+  end
+  @attrs = sort_listing(@attrs)
+end
+
+def constant_listing
+  return @constants if @constants
+  @constants = object.constants(:included => false, :inherited => false)
+  @constants += object.cvars
+  @constants = run_verifier(@constants)
+  @constants
+end
+
+def sort_listing(list)
+  list.sort_by {|o| [o.scope.to_s, o.name.to_s.downcase] }
+end
+
+def inherited_attr_list(&block)
+  object.inheritance_tree(true)[1..-1].each do |superclass|
+    next if superclass.is_a?(YARD::CodeObjects::Proxy)
+    next if options.embed_mixins.size > 0 && options.embed_mixins_match?(superclass) != false
+    attribs = superclass.attributes[:instance]
+    attribs = attribs.reject {|name, rw| object.child(:scope => :instance, :name => name) != nil }
+    attribs = attribs.sort_by {|args| args.first.to_s }.map {|n, m| m[:read] || m[:write] }
+    attribs = prune_method_listing(attribs, false)
+    yield superclass, attribs if attribs.size > 0
+  end
+end
+
+def inherited_constant_list(&block)
+  object.inheritance_tree(true)[1..-1].each do |superclass|
+    next if superclass.is_a?(YARD::CodeObjects::Proxy)
+    next if options.embed_mixins.size > 0 && options.embed_mixins_match?(superclass) != false
+    consts = superclass.constants(:included => false, :inherited => false)
+    consts = consts.reject {|const| object.child(:type => :constant, :name => const.name) != nil }
+    consts = consts.sort_by {|const| const.name.to_s }
+    consts = run_verifier(consts)
+    yield superclass, consts if consts.size > 0
+  end
+end
+
+def docstring_full(obj)
+  docstring = ""
+  if obj.tags(:overload).size == 1 && obj.docstring.empty?
+    docstring = obj.tag(:overload).docstring
+  else
+    docstring = obj.docstring
+  end
+
+  if docstring.summary.empty? && obj.tags(:return).size == 1 && obj.tag(:return).text
+    docstring = Docstring.new(obj.tag(:return).text.gsub(/\A([a-z])/) {|x| x.upcase }.strip)
+  end
+
+  docstring
+end
+
+def docstring_summary(obj)
+  docstring_full(obj).summary
+end
+
+def groups(list, type = "Method")
+  if groups_data = object.groups
+    list.each {|m| groups_data |= [m.group] if m.group && owner != m.namespace }
+    others = list.select {|m| !m.group || !groups_data.include?(m.group) }
+    groups_data.each do |name|
+      items = list.select {|m| m.group == name }
+      yield(items, name) unless items.empty?
+    end
+  else
+    others = []
+    group_data = {}
+    list.each do |meth|
+      if meth.group
+        (group_data[meth.group] ||= []) << meth
+      else
+        others << meth
+      end
+    end
+    group_data.each {|group, items| yield(items, group) unless items.empty? }
+  end
+
+  scopes(others) {|items, scope| yield(items, "#{scope.to_s.capitalize} #{type} Summary") }
+end
+
+def scopes(list)
+  [:class, :instance].each do |scope|
+    items = list.select {|m| m.scope == scope }
+    yield(items, scope) unless items.empty?
+  end
+end
+
+def mixed_into(object)
+  unless globals.mixed_into
+    globals.mixed_into = {}
+    list = run_verifier Registry.all(:class, :module)
+    list.each {|o| o.mixins.each {|m| (globals.mixed_into[m.path] ||= []) << o } }
+  end
+
+  globals.mixed_into[object.path] || []
+end

data/home_my_yard/templates/visualruby/module/text/children.erb

@@ -0,0 +1,10 @@
+Defined Under Namespace:
+------------------------
+
+<% @inner.each do |name, list| %>
+<% if list.size > 0 %>
+<% text = list.map {|c| c.name }.join(", ") + " (#{name})" %>
+<%= indent(wrap(text)) %>
+
+<% end %>
+<% end %>

data/home_my_yard/templates/visualruby/module/text/class_meths_list.erb

@@ -0,0 +1,8 @@
+<% if class_meths.size > 0 %>
+Class methods:
+--------------
+
+<%= indent wrap(class_meths.map {|o| o.name.to_s }.join(", "), 68) %>
+
+
+<% end %>

data/home_my_yard/templates/visualruby/module/text/extends.erb

@@ -0,0 +1,8 @@
+<% if object.mixins(:class).size > 0 %>
+Extended by:
+------------
+
+<%= indent wrap(object.mixins(:class).join(", "), 68) %>
+
+
+<% end %>

data/home_my_yard/templates/visualruby/module/text/header.erb

@@ -0,0 +1,7 @@
+<%= title_align_right format_object_title(object) %>
+
+<%= yieldall %>
+
+<%= hr %>
+
+

data/home_my_yard/templates/visualruby/module/text/includes.erb

@@ -0,0 +1,8 @@
+<% if object.mixins(:instance).size > 0 %>
+Includes:
+---------
+
+<%= indent wrap(object.mixins(:instance).join(", "), 68) %>
+
+
+<% end %>

data/home_my_yard/templates/visualruby/module/text/instance_meths_list.erb

@@ -0,0 +1,8 @@
+<% if instance_meths.size > 0 %>
+Instance methods:
+-----------------
+
+<%= indent wrap(instance_meths.map {|o| o.name.to_s }.join(", "), 68) %>
+
+
+<% end %>

data/home_my_yard/templates/visualruby/module/text/setup.rb

@@ -0,0 +1,12 @@
+def init
+  sections :header, [T('docstring')], :children, :includes, :extends,
+    :class_meths_list, :instance_meths_list
+end
+
+def class_meths
+  @classmeths ||= method_listing.select {|o| o.scope == :class }
+end
+
+def instance_meths
+  @instmeths ||= method_listing.select {|o| o.scope == :instance }
+end

data/home_my_yard/templates/visualruby/onefile/html/files.erb

@@ -0,0 +1,5 @@
+<% @files.each do |file| %>
+  <% @file = file %>
+  <h2><%= file.title %></h2>
+  <%= diskfile %>
+<% end %>

data/home_my_yard/templates/visualruby/onefile/html/headers.erb

@@ -0,0 +1,6 @@
+<style type="text/css">
+  <%= @css_data %>
+</style>
+<script type="text/javascript" charset="utf-8">
+  <%= @js_data %>
+</script>

data/home_my_yard/templates/visualruby/onefile/html/layout.erb

@@ -0,0 +1,17 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=<%= charset %>" />
+    <title><%= @title %></title>
+    <%= erb(:headers) %>
+  </head>
+  <body>
+    <div id="content">
+      <h1><%= @title %></h1>
+      <%= yieldall %>
+    </div>
+
+    <%= erb(:footer) %>
+  </body>
+</html>

data/home_my_yard/templates/visualruby/onefile/html/readme.erb

@@ -0,0 +1,3 @@
+<div id="readme">
+  <%= htmlify(parse_top_comments_from_file) %>
+</div>

data/home_my_yard/templates/visualruby/onefile/html/setup.rb

@@ -0,0 +1,61 @@
+include T('default/layout/html')
+include YARD::Parser::Ruby::Legacy
+
+def init
+  override_serializer
+  @object = YARD::Registry.root
+  @files.shift
+  @objects.delete(YARD::Registry.root)
+  @objects.unshift(YARD::Registry.root)
+  sections :layout, [:readme, :files, :all_objects]
+end
+
+def all_objects
+  @objects.map {|obj| obj.format(options) }.join("\n")
+end
+
+def layout
+  fulldoc = Object.new.extend(T('fulldoc'))
+  layout = Object.new.extend(T('layout'))
+  @css_data = layout.stylesheets.map {|sheet| read_asset(sheet) }.join("\n")
+  @js_data = layout.javascripts.map {|script| read_asset(script) }.join("")
+
+  erb(:layout)
+end
+
+def read_asset(file)
+  return unless file = T('fulldoc').find_file(file)
+  data = File.read(file)
+  superfile = self.class.find_nth_file('fulldoc', 2)
+  data.gsub!('{{{__super__}}}', superfile ? IO.read(superfile) : "")
+  data
+end
+
+private
+
+def parse_top_comments_from_file
+  return unless @readme
+  return @readme.contents unless @readme.filename =~ /\.rb$/
+  data = ""
+  tokens = TokenList.new(@readme.contents)
+  tokens.each do |token|
+    break unless token.is_a?(RubyToken::TkCOMMENT) || token.is_a?(RubyToken::TkNL)
+    data << (token.text[/\A#\s{0,1}(.*)/, 1] || "\n")
+  end
+  YARD::Docstring.new(data)
+end
+
+def override_serializer
+  return if @serializer.nil?
+  class << @serializer
+    def serialize(object, data)
+      return unless object == 'index.html'
+      super
+    end
+
+    def serialized_path(object)
+      return object if object.is_a?(String)
+      return 'index.html'
+    end
+  end
+end

data/home_my_yard/templates/visualruby/root/dot/child.erb

@@ -0,0 +1,3 @@
+<% if inner = yieldall.gsub("\n", '') %>
+Root [label="{<%= inner %>}" rank=sink];
+<% end %>

data/home_my_yard/templates/visualruby/root/dot/setup.rb

@@ -0,0 +1,5 @@
+include T('default/module/dot')
+
+def format_path(object)
+  ""
+end

data/home_my_yard/templates/visualruby/root/html/setup.rb

@@ -0,0 +1 @@
+include T('default/module/html')

data/home_my_yard/templates/visualruby/tags/html/example.erb

@@ -0,0 +1,11 @@
+<% if object.has_tag?(:example) %>
+  <div class="examples">
+    <p class="tag_title">Examples:</p>
+    <% object.tags(:example).each do |tag| %>
+      <% unless tag.name.empty? %>
+        <p class="example_title"><%= htmlify_line(tag.name) %></p>
+      <% end %>
+      <pre class="example code"><code><%= html_syntax_highlight(tag.text) %></code></pre>
+    <% end %>
+  </div>
+<% end %>

data/home_my_yard/templates/visualruby/tags/html/index.erb

@@ -0,0 +1,3 @@
+<div class="tags">
+  <%= yieldall %>
+</div>

data/home_my_yard/templates/visualruby/tags/html/option.erb

@@ -0,0 +1,24 @@
+<% if object.has_tag?(:option) %>
+  <% object.parameters.each do |param, default| %>
+    <% tags = object.tags(:option).select {|x| x.name.to_s == param.to_s.sub(/^\*+/, '') } %>
+    <% next if tags.empty? %>
+    <p class="tag_title">Options Hash (<tt><%= param %></tt>):</p>
+    <ul class="option">
+      <% for tag in tags %>
+        <li>
+          <span class="name"><%= tag.pair.name %></span>
+          <span class="type"><%= format_types(tag.pair.types || ['Object']) %></span>
+          <span class="default">
+            <% if tag.pair.defaults %>
+              &mdash; default:
+              <%= tag.pair.defaults.map {|t| "<tt>#{h t}</tt>" }.join(", ") %>
+            <% end %>
+          </span>
+          <% if tag.pair.text && tag.pair.text =~ /\S/ %>
+            &mdash; <%= htmlify_line(tag.pair.text) %>
+          <% end %>
+        </li>
+      <% end %>
+    </ul>
+  <% end %>
+<% end %>

data/home_my_yard/templates/visualruby/tags/html/overload.erb

@@ -0,0 +1,14 @@
+<% if object.tags(:overload).size == 1 %>
+  <%= yieldall :object => object.tag(:overload) %>
+<% elsif object.has_tag?(:overload) && object.tags(:overload).any? {|o| !o.docstring.blank? } %>
+  <p class="tag_title">Overloads:</p>
+  <ul class="overload">
+    <% object.tags(:overload).each do |overload| %>
+      <% next if overload.docstring.blank? %>
+      <li class="overload_item">
+        <span class="signature"><%= signature(overload, false, false) %></span>
+        <%= yieldall :object => overload %>
+      </li>
+    <% end %>
+  </ul>
+<% end %>

data/home_my_yard/templates/visualruby/tags/html/see.erb

@@ -0,0 +1,8 @@
+<% if object.has_tag?(:see) %>
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+    <% for tag in object.tags(:see) %>
+      <li><%= linkify(tag.name, tag.text) %></li>
+    <% end %>
+  </ul>
+<% end %>

data/home_my_yard/templates/visualruby/tags/html/tag.erb

@@ -0,0 +1,20 @@
+<p class="tag_title"><%= @label ? @label : YARD::Tags::Library.labels[@name] %>:</p>
+<ul class="<%= @name %>">
+  <% object.tags(@name).each do |tag| %>
+    <li>
+      <% unless @no_names %>
+        <span class='name'><%= h tag.name %></span>
+      <% end %>
+      <% unless @no_types %>
+        <span class='type'><%= format_types(tag.types) %></span>
+      <% end %>
+      <% if @name == :param && (o=object.parameters.assoc(tag.name.to_s)) && o[1] %>
+        <em class="default">(defaults to: <tt><%= h o[1] %></tt>)</em>
+      <% end %>
+      <% if tag.text && !tag.text.empty? %>
+        <% unless (@no_types || tag.types.nil? || tag.types.empty?) && @no_names %>&mdash;<% end %>
+        <%= htmlify_line(tag.text) %>
+      <% end %>
+    </li>
+  <% end %>
+</ul>

data/home_my_yard/templates/visualruby/tags/setup.rb

@@ -0,0 +1,55 @@
+def init
+  tags = Tags::Library.visible_tags - [:abstract, :deprecated, :note, :todo]
+  create_tag_methods(tags - [:example, :option, :overload, :see])
+  sections :index, tags.map {|t| t.to_s.gsub('.', '_').to_sym }
+  sections.any(:overload).push(T('docstring'))
+end
+
+def return
+  if object.type == :method
+    return if object.constructor?
+    return if object.tags(:return).size == 1 && object.tag(:return).types == ['void']
+  end
+  tag(:return)
+end
+
+def param
+  tag(:param) if object.type == :method
+end
+
+private
+
+def tag(name, opts = nil)
+  return unless object.has_tag?(name)
+  opts ||= options_for_tag(name)
+  @no_names = true if opts[:no_names]
+  @no_types = true if opts[:no_types]
+  @name = name
+  out = erb('tag')
+  @no_names, @no_types = nil, nil
+  out
+end
+
+def create_tag_methods(tags)
+  tags.each do |tag|
+    tag_meth = tag.to_s.gsub('.', '_')
+    next if respond_to?(tag_meth)
+    instance_eval(<<-eof, __FILE__, __LINE__ + 1)
+      def #{tag_meth}; tag(#{tag.inspect}) end
+    eof
+  end
+end
+
+def options_for_tag(tag)
+  opts = {:no_types => true, :no_names => true}
+  case Tags::Library.factory_method_for(tag)
+  when :with_types
+    opts[:no_types] = false
+  when :with_types_and_name
+    opts[:no_types] = false
+    opts[:no_names] = false
+  when :with_name
+    opts[:no_names] = false
+  end
+  opts
+end

data/home_my_yard/templates/visualruby/tags/text/example.erb

@@ -0,0 +1,12 @@
+<% if object.has_tag?(:example) %>
+
+Examples:
+---------
+
+<% object.tags(:example).each_with_index do |tag, i| %>
+<%= indent("# " + tag.name + "\n") if tag.name %>
+<%= indent(format_source(tag.text)) + "\n" %>
+<%= "\n" if i < object.tags(:example).size - 1 %>
+<% end %>
+<% end %>
+

data/home_my_yard/templates/visualruby/tags/text/index.erb

@@ -0,0 +1 @@
+<%= yieldall %>

data/home_my_yard/templates/visualruby/tags/text/option.erb

@@ -0,0 +1,20 @@
+<% if object.has_tag?(:option) %>
+<% object.parameters.each do |param, default| %>
+<% tags = object.tags(:option).select {|x| x.name.to_s == param.to_s } %>
+<% next if tags.empty? %>
+Options Hash (<%= param %>):
+--------------<%= hr(param.to_s.length) %>--
+
+<% for tag in tags %>
+<% text = "" %>
+<% text += format_types(tag.pair.types || ['Object']) %>
+<% text += " " + tag.pair.name.to_s %>
+<% if tag.pair.defaults %>
+<% text += " - default: " + tag.pair.defaults.join(", ") %>
+<% end %>
+<% text += " - " + tag.pair.text if tag.pair.text %>
+<%= indent(wrap(text)) %>
+
+<% end %>
+<% end %>
+<% end %>

data/home_my_yard/templates/visualruby/tags/text/overload.erb

@@ -0,0 +1,19 @@
+<% if object.tags(:overload).size == 1 %>
+<%= wrap(yieldall(:object => object.tag(:overload))) %>
+<% elsif object.has_tag?(:overload) %>
+Overloads:
+----------
+
+<% object.tags(:overload).each do |overload| %>
+<% if overload.tags.size > 0 %>
+<%= hr %>
+
+<%= indent signature(overload) %>
+
+<%= hr %>
+
+<%= indent(wrap(yieldall(:object => overload))) %>
+
+<% end %>
+<% end %>
+<% end %>

data/home_my_yard/templates/visualruby/tags/text/see.erb

@@ -0,0 +1,11 @@
+<% if object.has_tag?(:see) %>
+See Also:
+---------
+
+<% for tag in object.tags(:see) %>
+<% text = "- " + tag.name %>
+<% text += " - " + tag.text if tag.text && !tag.text.empty? %>
+<%= indent(wrap(text)) %>
+<% end %>
+<% end %>
+

data/home_my_yard/templates/visualruby/tags/text/tag.erb

@@ -0,0 +1,13 @@
+<% title = @label ? @label : YARD::Tags::Library.labels[@name] %>
+<%= title %>:
+<%= hr(title.length) %>-
+
+<% object.tags(@name).each do |tag| %>
+<% text = "" %>
+<% text += format_types(tag.types) + " " unless @no_types || tag.types.nil? %>
+<% text += tag.name.to_s + " " unless @no_names %>
+<% text += "- " unless @no_names && @no_types %>
+<% text += tag.text if tag.text && !tag.text.empty? %>
+<%= indent wrap(text) %>
+
+<% end %>

data/home_my_yard/themes/visualruby.yaml

@@ -0,0 +1,36 @@
+--- !ruby/object:YardTheme
+css:
+  body {color}: "#000000"
+  "#main {background}": "#ffffff"
+  body {background-color}: "#ffffff"
+  body {font-size}: 15px
+  p {width}: 65%
+  "#main a, #main a:visited {color}": "#662211"
+  ".object_link a {color}": "#662211"
+  li.odd {background}: "#eeeeee"
+  li.even {background}: "#dddddd"
+  ".item:hover {background}": "#d7d5c1"
+  li.clicked > .item {background}: "#000000"
+  li.clicked > .item {color}: "#d3d7cf"
+  "#main a:hover {background}": "#f6f5cb"
+  h1 {font-family}: Assistant
+  h2 {font-family}: Raleway
+  h3 {font-family}: Rubik One
+  h1 {font-weight}: '200'
+  h2 {font-weight}: '300'
+  h3 {font-weight}: '300'
+  h1 {font-size}: 3em
+  h2 {font-size}: 1.4em
+  h3 {font-size}: 1.4em
+  h1 {color}: "#662211"
+  h2 {color}: "#000000"
+  h3 {color}: "#000000"
+  h1 {background}: "#ffffff"
+  h2 {background}: "#ffffff"
+  h3 {background}: "#ebeade"
+  "#toc {background-color}": "#f3f3eb"
+  p.signature, h3.signature {background}: "#0a6"
+  "#main p {width}": 65%
+vr_yaml_file: "/home/eric/my_yard/themes/visualruby.yaml"
+builder: !ruby/object:Gtk::Builder {}
+top_level_window: false

data/install.md

@@ -0,0 +1,11 @@
+# @title Installing my_yard
+
+Just do:
+
+  gem install my_yard
+
+That's it!
+
+Then go to the directory that you want to document, and enter:
+
+  my_yard

data/my_yard

@@ -0,0 +1,31 @@
+#!/usr/bin/ruby
+
+require "vrlib"
+require "yard"
+
+# from require_all gem:
+require_rel 'src/'
+
+def start_my_yard
+
+  # create /home/my_yard if doesn't exist
+  unless File.directory?(File.join(Dir.home, "my_yard"))
+    VR.copy_recursively File.join(File.dirname(__FILE__), "home_my_yard"), File.join(Dir.home, "my_yard")
+  end
+
+  VR::save_yaml(YardTheme.new(), File.join(Dir.home, "my_yard", "themes", "default.yaml"))
+
+  $open_project = (ARGV[0] and File.directory?(ARGV[0])) ? File.expand_path(ARGV[0]) : Dir.pwd
+
+  $env = VR::load_yaml(GlobalSettings, File.join(Dir.home, "my_yard", "global_settings.yaml"))
+
+  loop do 
+    $env.add_project($open_project) 
+    proj = VR::load_yaml(MyYard, File.join($open_project, ".yardoc", "my_yard.yaml"))
+    proj.show_glade()
+    break if $open_project == :exit
+  end
+
+end
+
+start_my_yard