yard-web-plugin 0.1.2

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Alexey Ilyichev
+
+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/README.rdoc

@@ -0,0 +1,17 @@
+= yard-web-plugin
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Alexey Ilyichev. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "yard-web-plugin"
+    gem.summary = %Q{This is a fork of yard-rest-plugin}
+    gem.description = %Q{See yard-rest-plugin for more detail}
+    gem.email = "alexey.ilyichev@qik.com"
+    gem.homepage = "http://github.com/alexz77/yard-web-plugin"
+    gem.authors = ["Alexey Ilyichev"]
+    gem.add_dependency "yard", "~>0.6.1"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "yard-web-plugin #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.2

data/lib/yard-web-plugin.rb

@@ -0,0 +1,23 @@
+# Needed because running outside Gem
+# XXX Is there a better way to deal with this?
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__)))
+
+require "yard-web-plugin/base_helper"
+
+YARD::Templates::Engine.register_template_path File.dirname(__FILE__) + '/../templates'
+# TODO: Check ruby version and support ruby 1.9 in future
+YARD::Parser::SourceParser.parser_type = :ruby18
+
+# Define custom tags
+YARD::Tags::Library.define_tag("URL for Service", :url)
+YARD::Tags::Library.define_tag("Topic for Service", :topic)
+YARD::Tags::Library.define_tag("Arguments", :argument, :with_types_and_name)
+YARD::Tags::Library.define_tag("Example Request", :example_request)
+YARD::Tags::Library.define_tag("Request Fields", :request_field, :with_types_and_name)
+YARD::Tags::Library.define_tag("Example Response", :example_response)
+YARD::Tags::Library.define_tag("Response Fields", :response_field, :with_types_and_name)
+YARD::Tags::Library.define_tag("Headers", :header, :with_name)
+YARD::Tags::Library.define_tag("Response codes", :response_code, :with_name)
+YARD::Tags::Library.define_tag("Image", :image)
+YARD::Tags::Library.define_tag("Overall", :overall)
+

data/lib/yard-web-plugin/base_helper.rb

@@ -0,0 +1,41 @@
+require 'pp'
+
+module YARD::Templates::Helpers
+  module BaseHelper
+
+    # Adds additional test that only includes Objects that contain a URL tag
+    def run_verifier(list)
+
+      if options[:verifier]
+        list.reject! { |item| options[:verifier].call(item).is_a?(FalseClass) }
+      end
+
+      reject_module(list)
+    end
+
+    def index_objects(list)
+      res = reject_module(list)
+      res = reject_without_url(res)
+      res = reject_without_topic(res)
+      res = reject_overall(res)
+
+      res
+    end
+
+    def reject_module(list)
+      list.reject { |object| [:root, :module].include?(object.type) }
+    end
+
+    def reject_without_url(list)
+      list.reject { |object| [:class, :method].include?(object.type) and object.tags("url").empty? }
+    end
+
+    def reject_without_topic(list)
+      list.reject { |object| [:class].include?(object.type) and object.tags("topic").empty? }
+    end
+
+    def reject_overall(list)
+      list.reject { |object| object.has_tag?('overall') }
+    end
+  end
+end

data/templates/rest/class/html/header.erb

@@ -0,0 +1,39 @@
+<div class="service">
+  <h1>
+    <% if object.tags("url").size == 1 %>
+      <span class="minor_heading">Resource: </span>
+      <%= object.tag("url").text %>
+    <% elsif object.tags("url").size > 1 %>
+      <span class="minor_heading">Resource: </span>
+      <ul>
+        <% object.tags("url").each do |url_tag| %>
+          <li><%= url_tag.text %></li>
+        <% end %>
+      </ul>
+    <% end %>
+  </h1>
+  <% unless object.tags("topic").empty? %>
+    <h3 class="topic">Topics:</h3>
+    <ul class="box">
+      <% object.tags("topic").each do |topic| %>
+        <li><%= topic.text %></li>
+      <% end %>
+    </ul>
+  <% end %>
+  <% object.tags("image").each do |image| %>
+    <img src="<%= image.text %>">
+  <% end %>
+  <%= yieldall %>
+</div>
+
+
+
+
+
+
+
+
+
+
+
+

data/templates/rest/class/html/method_details_list.erb

@@ -0,0 +1,8 @@
+<% unless @meths.empty? %>
+  <div id="Services" class="method_details_list">
+    <h2>Actions</h2>
+    <% @meths.each_with_index do |meth, i| %>
+      <%= yieldall :object => meth, :index => i %>
+    <% end %>
+  </div>
+<% end %>

data/templates/rest/class/html/setup.rb

@@ -0,0 +1,9 @@
+def init
+  sections :header, [T('docstring'), :method_details_list, [T('method_details')]]
+end
+
+def method_details_list
+  @meths = object.meths(:inherited => false, :included => false) 
+  @meths = run_verifier(@meths)
+  erb(:method_details_list)
+end

data/templates/rest/disqus/html/disqus.erb

@@ -0,0 +1,24 @@
+<h2>Discuss this Resource</h2>
+<div id="disqus_thread"></div>
+<script type="text/javascript">
+  var disqus_shortname = 'vworkapi';
+  var disqus_identifier = "<%= @disqus_identifier %>";
+  // var disqus_developer = 1;
+  /**
+    * var disqus_identifier; [Optional but recommended: Define a unique identifier (e.g. post id or slug) for this thread] 
+    */
+  (function() {
+   var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;
+   dsq.src = 'http://vworkapi.disqus.com/embed.js';
+   (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
+  })();
+</script>
+<noscript>Please enable JavaScript to view the <a href="http://disqus.com/?ref_noscript=vworkapi">comments powered by Disqus.</a></noscript>
+<a href="http://disqus.com" class="dsq-brlink">API comments powered by <span class="logo-disqus">Disqus</span></a>
+<script type="text/javascript">
+(function () {
+  var s = document.createElement('script'); s.async = true;
+  s.src = 'http://disqus.com/forums/vworkapi/count.js';
+  (document.getElementsByTagName('HEAD')[0] || document.getElementsByTagName('BODY')[0]).appendChild(s);
+}());
+</script>

data/templates/rest/disqus/setup.rb

@@ -0,0 +1,9 @@
+def init
+  sections :disqus
+end
+
+def disqus()
+  @disqus_identifier = object.tag('url').text #.gsub(/\//, '_')
+  
+  erb('disqus')
+end

data/templates/rest/docstring/html/setup.rb

@@ -0,0 +1,4 @@
+def init
+  return if object.docstring.blank?
+  sections :text, T('tags')
+end

data/templates/rest/docstring/html/text.erb

@@ -0,0 +1 @@
+<%= htmlify(object.docstring.strip) %>

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

@@ -0,0 +1 @@
+/* Override this file with custom rules */

data/templates/rest/fulldoc/html/css/full_list.css

@@ -0,0 +1,78 @@
+body {
+  font-family:"Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif;
+  font-size:13px;
+  height:101%;
+  overflow-x:hidden;
+  margin:0;
+}
+
+h1 {
+  font-size:1.4em;
+  margin:0;
+  padding:12px 10px 0;
+}
+
+.clear { clear:both; }
+
+#search {
+  position:absolute;
+  right:5px;
+  top:9px;
+}
+
+#full_list {
+  list-style:none;
+  margin-left:0;
+  padding:0;
+}
+
+#full_list ul { padding:0; }
+
+#full_list li {
+  font-size:1.1em;
+  list-style:none;
+  margin:0;
+  padding:5px 5px 5px 12px;
+}
+
+#noresults {
+  display:none;
+  padding:7px 12px;
+}
+
+li {
+  color:#888;
+  cursor:pointer;
+}
+
+li.r1 { background: #fafafa; }
+li.r2 { background: #f0f0f0; }
+
+li:hover { background:#ddd; }
+
+a:link,a:visited {
+  text-decoration:none;
+  color:#05a;
+}
+
+li.clicked {
+  background:#05a;
+  color:#ccc;
+}
+
+li.clicked a:link,li.clicked a:visited {
+  color:#eee;
+}
+
+#search input {
+  border:1px solid #bbb;
+  -moz-border-radius:3px;
+  -webkit-border-radius:3px;
+}
+
+#full_list.insearch li.found {
+  display:list-item;
+  padding-left:10px;
+}
+
+#full_list.insearch li { display:none; }

data/templates/rest/fulldoc/html/css/style.css

@@ -0,0 +1,235 @@
+body { 
+  padding: 0 20px;
+  font-family: "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif; 
+  font-size: 13px;
+}
+
+h1 {
+  font-size: 25px; 
+  margin: 1em 0 0.5em; 
+  padding-top: 4px; 
+}
+
+h1.noborder { 
+  border-top: 0px; 
+  margin-top: 0; 
+  padding-top: 4px; 
+}
+
+h1.title { margin-bottom: 10px; }
+
+h1.alphaindex { 
+  margin-top: 0; 
+  font-size: 22px; 
+}
+
+h1 .minor_heading { color: #777777; }
+
+h2 { 
+  padding: 0;
+  padding-bottom: 3px;
+  border-bottom: 1px #aaa solid;
+  font-size: 1.4em;
+  margin: 1.8em 0 0.5em;
+}
+
+.inline { display: inline; }
+.inline p:first-child { display: inline; }
+
+h3.inherited {
+  font-style: italic;
+  font-family: "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif;
+  font-weight: normal;
+  padding: 0;
+  margin: 0;
+  margin-top: 12px;
+  margin-bottom: 3px;
+  font-size: 13px;
+}
+p.inherited {
+  padding: 0;
+  margin: 0;
+  margin-left: 25px;
+}
+
+/* Content */
+#content a:link, #content a:visited { 
+  text-decoration: none; 
+  color: #05a; 
+}
+#content a:hover { 
+  background: #ffffa5; 
+}
+
+/* Index files listing */
+#files { 
+  padding-left: 15px; 
+  font-size: 1.1em; 
+  padding: 0; 
+}
+#files li { 
+  list-style: none; 
+  display: inline; 
+  padding: 7px 12px; 
+  line-height: 35px; 
+}
+
+.method_details { 
+  border-top: 1px dotted #aaa; 
+  margin-top: 15px; 
+  padding-top: 0; 
+}
+.method_details.first { border: 0; }
+
+ul.signature { 
+  font-size: 1.1em; 
+  font-weight: normal; 
+  font-family: Monaco, Consolas, Courier, monospace; 
+  padding: 6px 10px; 
+  margin-top: 18px; 
+  background: #e5e8ff; 
+  border: 1px solid #d8d8e5; 
+  -moz-border-radius: 3px; 
+  -webkit-border-radius: 3px;
+  list-style: none;
+}
+
+/* All tags */
+.tags { margin-bottom: 12px; }
+.tags h3 { 
+  font-size: 1em; 
+  margin-bottom: 0; 
+}
+.tags ul { 
+  margin-top: 5px; 
+  padding-left: 30px; 
+  list-style: square; 
+}
+.tags ul li { 
+  margin-bottom: 3px; 
+}
+.tags ul .name { 
+  font-family: monospace; 
+  font-weight: bold; 
+}
+.tags ul p.note { padding: 3px 6px; }
+
+/* Repsonse example tag */
+.tags .examples h3 { margin-bottom: 10px; }
+.tags .examples h4 { 
+  padding: 0; 
+  margin: 0; 
+  margin-left: 15px; 
+  font-weight: bold; 
+  font-size: 0.9em; 
+}
+.tags .example { 
+  padding: 5px 12px; 
+  margin-top: 4px; 
+  border: 1px solid #eef; 
+  background: #f5f5ff;
+}
+
+
+/* Search menu */
+#search { 
+  position: absolute; 
+  right: 14px; 
+  top: 0px; 
+}
+#search a:link, #search a:visited { 
+  display: block; float: left; margin-right: 4px;
+  padding: 8px 10px; text-decoration: none; color: #05a; background: #eaeaff;
+  border: 1px solid #d8d8e5;
+  -moz-border-radius-bottomleft: 3px; -moz-border-radius-bottomright: 3px; 
+  -webkit-border-bottom-left-radius: 3px; -webkit-border-bottom-right-radius: 3px;
+}
+#search a:hover { 
+  background: #eef; 
+  color: #06b; 
+}
+#search a.active { 
+  background: #568; padding-bottom: 20px; color: #fff; border: 1px solid #457; 
+  -moz-border-radius-topleft: 5px; -moz-border-radius-topright: 5px;
+  -webkit-border-top-left-radius: 5px; -webkit-border-top-right-radius: 5px;
+}
+#search a.inactive { 
+  color: #999; 
+}
+
+/* Search frame */
+#search_frame {
+  background: #fff;
+  display: none;
+  position: absolute; 
+  top: 36px; 
+  right: 18px;
+  width: 500px;
+  height: 80%;
+  overflow-y: scroll;
+  border: 1px solid #999;
+  border-collapse: collapse;
+  -webkit-box-shadow: -2px 5px 25px #aaa;
+  -moz-box-shadow: -2px 5px 25px #aaa;
+  -moz-border-radius: 2px;
+  -webkit-border-radius: 2px;
+}
+
+/* Footer */
+#footer { 
+  margin-top: 15px; 
+  border-top: 1px solid #ccc; 
+  text-align: center; 
+  padding: 7px 0; 
+  color: #999; 
+}
+
+/* Alphabetal Index Listing */
+#listing ul.alpha { font-size: 1.1em; }
+#listing ul.alpha { margin: 0; padding: 0; padding-bottom: 10px; list-style: none; }
+#listing ul.alpha li.letter { font-size: 1.4em; padding-bottom: 10px; }
+#listing ul.alpha ul { margin: 0; padding-left: 15px; }
+
+li.r1 { background: #f0f0f0; }
+li.r2 { background: #fafafa; }
+
+/* Note tag */
+.note { 
+  color: #222;
+  -moz-border-radius: 3px; 
+  -webkit-border-radius: 3px; 
+  background: #e3e4e3; 
+  border: 1px solid #d5d5d5; 
+  padding: 7px 10px;
+}
+.note.todo { 
+  background: #ffffc5; 
+  border-color: #ececaa; 
+}
+.note.title { 
+  text-transform: lowercase; 
+  padding: 1px 5px; 
+  margin-left: 5px; 
+  font-size: 0.9em; 
+  font-family: "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif; 
+}
+h1 .note.title { 
+  font-size: 0.5em; 
+  font-weight: normal; 
+  padding: 3px 5px; 
+  position: relative; 
+  top: -3px; 
+  text-transform: capitalize; 
+}
+
+ul.box {
+  font-size: 1em;
+  height: 1em;
+}
+
+ul.box li {
+  float: left;
+  display: block;
+  text-align: left;
+  padding-right: 10px;
+}