sinatra-croon 0.1.1 → 0.2.0

data/lib/sinatra/croon/views/docs.haml

@@ -3,39 +3,58 @@
 %html
 
   %head
-    %title API Documentation
-    %link{ :rel => "stylesheet", :href => "docs.css" }
+    %title
+      API Documentation ::
+      = current_section || "General"
+
+    %link{ :rel => "stylesheet", :href => "#{documentation_base_uri}/docs.css" }
 
   %body
 
+    %h1
+      %a{ :href => "#{documentation_base_uri}/docs" } API Documentation
+
+    %ul#sidebar
+      - docs.keys.sort_by { |k| k.to_s }.each do |section|
+        %li
+          %a{ :href => "#{documentation_base_uri}/docs/#{urlify_section(section)}"}
+            = section || "General"
+          %ul.section
+            - docs[section].each do |doc|
+              %li
+                = doc[:verb].upcase
+                = doc[:uri]
+
     #content
 
-      %h1
-        %a{ :href => '/' } API Documentation
+      %h2
+        = current_section || "General"
+
+      - docs[current_section].each do |doc|
 
-      - docs.each do |doc|
+        #doc
 
-        .api
+          .api
 
-          .url
-            %a
-              = doc[:verb].upcase
-              = doc[:uri]
+            .url
+              %a
+                = doc[:verb].upcase
+                = doc[:uri]
 
-          .description
-            = doc[:description]
+            .description
+              = doc[:description]
 
-          - if (doc[:params] || []).length > 0
-            .params
-              - doc[:params].each do |param|
-                .param
-                  .type{ :class => (param[:required] && "required") }
-                    = (param[:required]) ? "REQUIRED" : "OPTIONAL"
-                  .name= escape_html(param[:name])
-                  .description= param[:description]
+            - if (doc[:params] || []).length > 0
+              .params
+                - doc[:params].each do |param|
+                  .param
+                    .type{ :class => (param[:required] && "required") }
+                      = (param[:required]) ? "REQUIRED" : "OPTIONAL"
+                    .name= escape_html(param[:name])
+                    .description= param[:description]
 
-          %code.request
-            = display_code doc[:request]
+            %code.request
+              = display_code doc[:request]
 
-          %code.response
-            = display_code doc[:response]
+            %code.response
+              = display_code doc[:response]

data/lib/sinatra/croon/views/docs.sass

@@ -12,15 +12,43 @@
   :margin-top -12px
   :margin-bottom 12px
 
-h2
-  :background #555
-  :color #fff
-  :border 1px #666 solid
-  :padding 10px
+h1
+  :background #ccc
+  :width 100%
+  :margin 0
+  :padding 10px 20px
   a
-    :color #fff
+    :color #000
     :text-decoration none
 
+h2
+  :margin 0
+  :margin-bottom 20px
+  :padding 0
+
+ul
+  :margin 0
+  :padding 0
+
+ul#sidebar
+  :float left
+  :border-right 1px #ccc solid
+  :padding-top 10px
+  & > li
+    :margin 0
+    :padding 10px 20px
+    :list-style-type none
+    :font-weight bold
+    a
+      :text-decoration none
+  ul
+    :margin-top 10px
+    li
+      :list-style-type none
+      :padding 6px 10px
+      :font-size 0.9em
+      :font-family Courier, monospace
+
 .api
   :margin-bottom 24px
   :background #eee
@@ -28,10 +56,10 @@ h2
 
   .url
     :padding 6px 10px
-    :background #aaa
+    :background #333
     :border-bottom 1px #ccc solid
     a
-      :color #333
+      :color #fff
       :font-size 1.6em
       :font-weight bold
       :font-family monospace
@@ -40,7 +68,7 @@ h2
     :padding 12px
 
   code
-    :font-family Monaco, monospace
+    :font-family Courier, monospace
     :white-space pre
     :padding 12px
     :display block
@@ -73,20 +101,25 @@ h2
   .request
     &:before
       +code_title
-      :content "Request"
+      :content "Example Request"
+      :font-family Helvetica, Arial, sans-serif
 
   .response
     &:before
       +code_title
-      :content "Response"
+      :content "Example Response"
+      :font-family Helvetica, Arial, sans-serif
 
 body
   :margin 0
   
 #content
-  :width 800px
-  :margin-left auto
-  :margin-right auto
+  :float left
+  :min-width 800px
+  :padding 20px
+  :margin-left -1px
+  :border-left 1px #ccc solid
+  :padding-bottom 0
 
 #index
   .section

data/lib/sinatra/croon.rb

@@ -3,7 +3,7 @@ require "sinatra/base"
 
 module Sinatra
   module Croon
-    VERSION = "0.1.1"
+    VERSION = "0.2.0"
 
     def self.registered(app)
       app.helpers Croon::Helpers
@@ -17,10 +17,14 @@ module Sinatra
         end
       end
 
-      app.get '/docs' do
+      app.get %r{^/docs/?([\w]+)?/?$} do |section|
         pass do
           template = File.read(File.expand_path("../croon/views/docs.haml", __FILE__))
-          haml template, :locals => { :docs => documentation }
+          sections = documentation.map { |doc| doc[:section] }.sort_by { |s| s.to_s }
+          haml template, :locals => {
+            :docs => documentation.group_by { |doc| doc[:section] },
+            :current_section => sections.detect { |s| urlify_section(s) == section }
+          }
         end
       end
     end
@@ -51,6 +55,14 @@ module Sinatra
       def documentation
         self.class.documentation
       end
+
+      def documentation_base_uri
+        env["REQUEST_PATH"].gsub(/#{env["PATH_INFO"]}\/?$/, '')
+      end
+
+      def urlify_section(section)
+        section.to_s.downcase.gsub(' ', '_')
+      end
     end
 
     module Parser

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sinatra-croon
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 23
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 1
-  version: 0.1.1
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - David Dollar
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-27 00:00:00 -04:00
+date: 2010-08-02 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency