yard-gobject 0.0.1

data/LICENSE.txt

@@ -0,0 +1,23 @@
+Copyright (c) 2010 Stojan Dimitrovski
+
+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/Manifest

@@ -0,0 +1,8 @@
+LICENSE.txt
+README.md
+Rakefile
+templates/default/fulldoc/html/css/common.css
+templates/default/tags/html/properties.erb
+templates/default/tags/setup.rb
+yard-gobject.rb
+Manifest

data/README.md

@@ -0,0 +1,28 @@
+YARD GObject Plugin
+===================
+
+This is a YARD plugin that assists in the documentation of Ruby bindings that make use of GObject, i.e. the Ruby-GNOME2 bindings.
+
+Features
+--------
+
+For now, it supports only one tag: <code>@properties</code>. This tag can be applied to any Class (<code>G_DEF_CLASS</code> macros), or Module (<code>G_DEF_INTERFACE</code> macros). It provides meta-data for the various GObject properties belonging to a GObject Class or GObject Interface.
+
+**Syntax**
+
+    # @properties property-name [PropertyType] description,
+    # another-property [PropertyType] description...
+
+<code>PropertyType</code> is formatted the same way YARD formats types. <code>description</code> can be ommited.
+
+License
+-------
+
+This plugin is Copyright © 2010 Stojan Dimitrovski, licensed under the MIT License. See the LICENSE.txt file included in this distribution for more information.
+
+References
+----------
+
+* [Ruby-GNOME2](http://http://ruby-gnome2.sourceforge.jp/)
+* [YARD](http://yardoc.org)
+

data/Rakefile

@@ -0,0 +1,13 @@
+require 'echoe'
+
+Echoe.new("yard-gobject") do |s|
+  s.version = "0.0.1"
+  s.author = "Stojan Dimitrovski"
+  s.email = "sdimitrovski@gmail.com"
+  s.url = "http://theact1v8.org"
+  s.summary = "Aids in the documentation of Ruby Objects derived from GObject"
+  s.lib_files = FileList["templates/**/*", "yard-gobject.rb"].to_a
+  s.runtime_dependencies = ['yard >=0.5.2']
+  s.development_dependencies = []
+end
+

data/templates/default/fulldoc/html/css/common.css

@@ -0,0 +1,32 @@
+.tags ul.gobject_properties {
+  list-style: none;
+}
+
+.tags ul.gobject_properties li {
+    margin-bottom: 14px;
+}
+
+.tags ul.gobject_properties li .name {
+  font-family: monospace;
+  font-size: 1em;
+  color: #609200;
+  background-color: #eaffd7;
+  padding: 1px 10px;
+  border: 1px solid #c9ff82;
+  border-radius: 3px;
+  -moz-border-radius: 3px;
+  -webkit-border-radius: 3px;
+}
+
+.tags ul.gobject_properties li .type {
+  font-family: monospace;
+  font-size: 1em;
+  color: gray;
+}
+
+.tags ul.gobject_properties li .description {
+  display: block;
+  margin: 0.45em auto auto 35px;
+  font-family: sans-serif;
+}
+

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

@@ -0,0 +1,16 @@
+<h2><%= @label ? @label : YARD::Tags::Library.labels[@name] %></h2>
+<ul class="gobject_properties">
+  <% object.tags(@name).each do |tag| %>
+    <% props = format_gobject_properties(tag) %>
+    <% props.each do |prop| %>
+    <li>
+      <span class="name"><%= prop[:name] %></span>
+      <span class="type"><%= format_types prop[:type] %></span>
+      <% if !prop[:description].nil? and !prop[:description].empty? %>
+      <span class="description"><%= htmlify_line prop[:description] %></span>
+      <% end %>
+    </li>
+    <% end %>
+  <% end %>
+</ul>
+

data/templates/default/tags/setup.rb

@@ -0,0 +1,20 @@
+def init
+  super
+
+  sections.last.place(:properties).after(:return)
+end
+
+def tag(name, opts = {})
+  return unless object.has_tag?(name)
+  @no_names = true if opts[:no_names]
+  @no_types = true if opts[:no_types]
+  @name = name
+  out = erb(name.to_s)
+  @no_names, @no_types = nil, nil
+  out
+end
+
+def properties
+  tag :properties
+end
+

data/yard-gobject.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{yard-gobject}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Stojan Dimitrovski"]
+  s.date = %q{2009-12-31}
+  s.description = %q{Aids in the documentation of Ruby Objects derived from GObject}
+  s.email = %q{sdimitrovski@gmail.com}
+  s.extra_rdoc_files = ["LICENSE.txt", "README.md"]
+  s.files = ["LICENSE.txt", "README.md", "Rakefile", "templates/default/fulldoc/html/css/common.css", "templates/default/tags/html/properties.erb", "templates/default/tags/setup.rb", "yard-gobject.rb", "Manifest", "yard-gobject.gemspec"]
+  s.homepage = %q{http://theact1v8.org}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Yard-gobject", "--main", "README.md"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{yard-gobject}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Aids in the documentation of Ruby Objects derived from GObject}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<yard>, [">= 0.5.2"])
+    else
+      s.add_dependency(%q<yard>, [">= 0.5.2"])
+    end
+  else
+    s.add_dependency(%q<yard>, [">= 0.5.2"])
+  end
+end

data/yard-gobject.rb

@@ -0,0 +1,66 @@
+ #
+ # yard-gobject.rb
+ # This file is part of yard-gobject
+ #
+ # Copyright (C) 2009 - Stojan Dimitrovski
+ #
+ # 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.
+ #
+
+require 'pathname'
+
+template_dir = Pathname.new(File.dirname(__FILE__) + '/templates').realpath.to_s
+
+YARD::Templates::Engine.register_template_path(template_dir)
+puts YARD::Templates::Engine.template_paths.inspect
+
+YARD::Tags::Library.define_tag("GObject Properties", :properties)
+
+module YARD::Templates::Helpers::HtmlHelper
+  def format_gobject_properties(tag)
+    puts 'Here'
+    text = tag.text
+    # text = tag
+
+    text.gsub! /\n\r?\t?/, ''
+    text.gsub! /\ +/, ' '
+    text.gsub! /-/, '_'
+
+    unformatted_properties = text.split /,\ */
+    properties = []
+
+    unformatted_properties.each do |prop|
+      p = {:name => nil, :type => nil, :description => nil}
+      prop_regex = prop.match(/\A([\w\-]+) \[([\w\S ]+)\] *(.*)\z/)
+
+      unless prop_regex.nil?
+        p[:name], p[:type], p[:description] = prop_regex.captures
+        p[:type] = p[:type].split /,\ */
+      end
+
+      properties << p
+    end
+
+    return properties
+  end
+end
+

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: yard-gobject
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Stojan Dimitrovski
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-31 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: yard
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.5.2
+    version: 
+description: Aids in the documentation of Ruby Objects derived from GObject
+email: sdimitrovski@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.md
+files: 
+- LICENSE.txt
+- README.md
+- Rakefile
+- templates/default/fulldoc/html/css/common.css
+- templates/default/tags/html/properties.erb
+- templates/default/tags/setup.rb
+- yard-gobject.rb
+- Manifest
+- yard-gobject.gemspec
+has_rdoc: true
+homepage: http://theact1v8.org
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Yard-gobject
+- --main
+- README.md
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: yard-gobject
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Aids in the documentation of Ruby Objects derived from GObject
+test_files: []
+