raddocs 0.1.4 → 0.2.0

data/lib/public/application.css

@@ -35,3 +35,8 @@ body {
   -moz-border-radius: 3px;
   border-radius: 3px;
 }
+
+.nav-bar {
+  font-size: 1.2em;
+  margin-bottom: 15px;
+}

data/lib/raddocs.rb

@@ -5,6 +5,7 @@ require 'json'
 require 'raddocs/configuration'
 require 'raddocs/app'
 require 'raddocs/middleware'
+require 'raddocs/parameters'
 
 module Raddocs
   def self.configuration

data/lib/raddocs/app.rb

@@ -8,6 +8,17 @@ module Raddocs
       haml :index, :locals => { :index => index }
     end
 
+    get "/custom-css/*" do
+      file = "#{docs_dir}/styles/#{params[:splat][0]}"
+
+      if !File.exists?(file)
+        raise Sinatra::NotFound
+      end
+
+      content_type :css
+      File.read(file)
+    end
+
     get "/*" do
       file = "#{docs_dir}/#{params[:splat][0]}.json"
 
@@ -18,6 +29,7 @@ module Raddocs
       file_content = File.read(file)
 
       example = JSON.parse(file_content)
+      example["parameters"] = Parameters.new(example["parameters"]).parse
       haml :example, :locals => { :example => example }
     end
 
@@ -37,6 +49,23 @@ module Raddocs
       def api_name
         Raddocs.configuration.api_name
       end
+
+      def css_files
+        files = ["#{url_location}/codemirror.css", "#{url_location}/application.css"]
+
+        if Raddocs.configuration.include_bootstrap
+          files << "#{url_location}/bootstrap.min.css"
+        end
+
+        Dir.glob(File.join(docs_dir, "styles", "*.css")).each do |css_file|
+          basename = Pathname.new(css_file).basename
+          files << "#{url_location}/custom-css/#{basename}"
+        end
+
+        files.concat Array(Raddocs.configuration.external_css)
+
+        files
+      end
     end
 
     def docs_dir

data/lib/raddocs/configuration.rb

@@ -16,6 +16,8 @@ module Raddocs
     add_setting :docs_dir, :default => "docs"
     add_setting :docs_mime_type, :default => /text\/docs\+plain/
     add_setting :api_name, :default => "Api Documentation"
+    add_setting :include_bootstrap, :default => true
+    add_setting :external_css, :default => []
 
     def settings
       @settings ||= {}

data/lib/raddocs/parameters.rb

@@ -0,0 +1,16 @@
+module Raddocs
+  class Parameters
+    def initialize(params)
+      @params = params
+    end
+
+    def parse
+      extra_keys = @params.flat_map(&:keys).uniq - ["name", "description", "required", "scope"]
+
+      {
+        "extra_keys" => extra_keys,
+        "data" => @params
+      }
+    end
+  end
+end

data/lib/views/example.haml

@@ -24,6 +24,9 @@
     });
   });
 
+.nav-bar
+  = link_to "« Back to Index", "/"
+
 %h1== #{example["resource"]} API
 .article
   %h2= example["description"]
@@ -32,20 +35,29 @@
     %p.explanation
       = example["explanation"]
 
-  - if example["parameters"].count > 0
+  - if example["parameters"]["data"].count > 0
     %h3 Parameters
     %table.parameters
       %thead
         %tr
           %th Name
           %th Description
+          - example["parameters"]["extra_keys"].each do |key|
+            %th= key
       %tbody
-        - example["parameters"].each do |param|
+        - example["parameters"]["data"].each do |param|
           %tr.parameter
             %td{:class => ("required" if param["required"])}
-              %span.name= param["name"]
+              - if param["scope"]
+                %span.name #{param['scope']}[#{param["name"]}]
+              - else
+                %span.name= param["name"]
             %td
               %span.description= param["description"]
+            - example["parameters"]["extra_keys"].each do |key|
+              %td
+                %span.extras= param[key]
+
 
   - example["requests"].each_with_index do |request, index|
     .request{ :id => "request-#{index}" }

data/lib/views/layout.haml

@@ -2,9 +2,8 @@
 %html
   %head
     %title Raddocs
-    %link{:rel => "stylesheet", :href => "#{url_location}/bootstrap.min.css"}
-    %link{:rel => "stylesheet", :href => "#{url_location}/codemirror.css"}
-    %link{:rel => "stylesheet", :href => "#{url_location}/application.css"}
+    - css_files.each do |file|
+      %link{:rel => "stylesheet", :href => file}
     %script(src="#{url_location}/js/jquery-1-7-2.js")
     %script(src="#{url_location}/js/codemirror.js")
     %script(src="#{url_location}/js/mode/css/css.js")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: raddocs
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-16 00:00:00.000000000 Z
+date: 2013-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -142,6 +142,7 @@ files:
 - lib/raddocs/app.rb
 - lib/raddocs/configuration.rb
 - lib/raddocs/middleware.rb
+- lib/raddocs/parameters.rb
 - lib/raddocs.rb
 - lib/views/example.haml
 - lib/views/index.haml
@@ -166,7 +167,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Browse documentation generated by the rspec_api_documentation gem