yard-restful 1.2.2 → 1.2.3

data/README.markdown

@@ -1,9 +1,14 @@
 # Yardoc RESTful Web Service Plugin
-
 A plugin for [Yardoc](http://yardoc.org/) that generates documentation for RESTful web services.
 
 Previous authors: [vWorkApp](http://www.vworkapp.com), [rknLA](http://github.com/rknLA), [lsegal](http://gnuu.org/), [spape](http://github.com/spape), [DerNalia](http://github.com/DerNalia)
 
+## Main features
+Plugin provides custom tags to describe resources (controllers) and resulting objects (models).
+
+If you use an object name in description of resource parameters, it will
+be linked to the object description.
+
 ## Install
 Bundler will reduce your headaches:
 
@@ -18,8 +23,8 @@ It also requires the Jeweler gem if you plan to use the rake build tasks.
 
 You'll probably want to add these to your .gitignore as well
 
-	/.yardoc
-	/public/api
+	.yardoc
+	public/api
 
 So you'll have to re-genenarte your API on every machine. This should encourage more up to dateness
 
@@ -27,7 +32,7 @@ So you'll have to re-genenarte your API on every machine. This should encourage
 It is recommended that you use a .yardopts file
 
 	--title "My API Documentation"
-	--plugin rest
+	--plugin restful
 	--readme API_README
 	--output-dir ./public/api
 	app/models/**/*.rb

data/Rakefile

@@ -31,6 +31,14 @@ end
 namespace :example do
   desc "Generate example docs"
   task :generate do
+    unless gem_available?('yard-restful')
+      puts 'Gem yard-restful is not installed. Trying to build from local version.'
+      Rake::Task["rebuild"].execute
+      puts 'Gem yard-restful should be installed.'
+    end
+    unless gem_available?('redcarpet')
+      puts 'Warning: gem redcarpet is not installed. Some texts may look ugly.'
+    end
     puts `yardoc -e ./lib/yard-restful.rb --title "Example Books API" --readme ./example/API_README.md --markup markdown ./example/*.rb`
     # `x-www-browser ./doc/index.html`
     puts 'On success open ./doc/index.html or ./doc/frames.html in your preferred browser'
@@ -43,3 +51,17 @@ namespace :example do
     puts 'Done!'
   end
 end
+
+def gem_available?(name, requirements = nil)
+  Gem::Specification.find_by_name(name, requirements)
+  true
+rescue Gem::LoadError
+  false
+rescue
+   Gem.available?(name)
+#  Gem.source_index.find_name(name, requirements).empty?
+#  gem name.to_s, requirements
+#  return true
+#rescue GEM::LoadError
+#  return false
+end

data/VERSION

@@ -1 +1 @@
-1.2.2
+1.2.4

data/lib/yard-restful/html_blocks_helper.rb

@@ -12,5 +12,12 @@ module HtmlBlocksHelper
     @counter[name].even? ? elements[0] : elements[1]
   end
 
+  def type_as_string(type)
+    if type.resource? and type.tag(:restful_api).text
+      "#{type.name.to_s.gsub(/Controller/, '')} [#{type.tag(:restful_api).text}]"
+    else
+      type.name.to_s
+    end
+  end
 end
 

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

@@ -1,7 +1,7 @@
 <div class="service">
   <h1 class="noborder title"><%= options[:title] %></h1>
     <a class="back" href="<%= url_for('index.html') %>" title="back to the overview">&laquo; back to overview</a>
-    <h2><%= object.name.to_s.gsub(/Controller/,"") %></h2>
+    <h2><%= type_as_string(object) %></h2>
     <%= yieldall %>
 </div>
 

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

@@ -1,6 +1,5 @@
 def init
   @page_title = "#{object.name.to_s.gsub(/Controller/,"")} - #{options[:title]}"
-  #sections :header, [T('docstring'), :method_details_list, [:fields_list], [T('method_details')]]
   sections :header, [T('docstring'), :object_details, [:fields_list], :resource_details, [:fields_list]]
 end
 

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

@@ -1 +1,3 @@
-<%= htmlify(object.docstring.strip) %>
+<div class="description">
+  <%= htmlify(object.docstring.strip) %>
+</div>

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

@@ -10,7 +10,12 @@ body {
   right: 0;
   position: fixed;
   top: 0;
-  width: 230px;
+  width: 246px;
+  overflow-y: scroll;
+  margin-right: -16px;
+}
+#toc ol {
+  padding-bottom: 10px;
 }
 #header {
   position: fixed;
@@ -49,9 +54,8 @@ p.method_desc {
 h2 {
   margin: 2.4em 0 0.5em;
 }
-.service h2 + p {
+.service .description p {
   font-size: 1.2em;
-  margin-bottom: 62px;
 }
 .method {
   display: block;

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

@@ -1,5 +1,5 @@
 <% @items.each do |resource| %>
   <li class="<%= rotate(:r2_r1) %>">
-    <%= linkify(resource, resource.name.to_s.gsub(/Controller/, "")) %>
+    <%= linkify(resource, type_as_string(resource)) %>
   </li>
 <% end %>

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

@@ -7,7 +7,7 @@
   <ul id="resources">
 	<% unless @resources.nil? %>
     <% @resources.each do |resource| %>
-	    <li><%= linkify(resource, resource.name.to_s.gsub(/Controller/, "")) %></li>
+	    <li><%= linkify(resource, type_as_string(resource)) %></li>
     <% end %>
   <% end %>
   </ul>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yard-restful
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.2.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-24 00:00:00.000000000 Z
+date: 2014-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -82,7 +82,6 @@ requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Yardoc plugin for Restful web services
 test_files: []
-has_rdoc: