rocket_docs 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 32c39440dae0113b812390a602c5da058815b478
-  data.tar.gz: e3ff07453b005d8a134b70a07e4893e25a72920a
+  metadata.gz: 4587cecf96880c211a54e3bbe066b57cf19f12e6
+  data.tar.gz: 7d1488f04217d661c268ec77899089ce69f2e9c5
 SHA512:
-  metadata.gz: d58b04d62b3a5fd2498c5e5fbbe7b63f1231acc35c5751ee90ee19f7df33b930db39d35872726fdf71dce214c264efb6dd49c017fc640ce0809ecf14168a2e77
-  data.tar.gz: 64bbe547bcc27b02fa786f752daa759555c9a23adf54e8a99d638dddd630a675e6f38a4f0adb9294ec365b03138e9fc3101206a56333e622541d98c71e103ee5
+  metadata.gz: 1ba39b697e13acb1f4d41427b09223be2aec3dff9f2dab7b843e20ecf59ebb1da47015b18594d68db7f1ddccbc361f0021bd620c747eaab6448953f6f9816197
+  data.tar.gz: 5c5c90a1b6dc45c06d8c4fb71ff42067097d9c2fbf57c16728081725905f5d25363854b86949c8045380be7b91733dce35ee950bbadbfb2f2c8a861de26750ac

data/app/views/layouts/rocket_docs/_api_description.slim

@@ -0,0 +1,10 @@
+- if RocketDocs.description
+  .panel-group id="rocket_docs_documentation_description_group"
+    .panel.panel-default
+      .panel-heading
+        h4.panel-title
+          = link_to 'Description', "#rocket_docs_documentation_description", data: { toggle: 'collapse' }
+      .panel-collapse.collapse id='rocket_docs_documentation_description'
+        .panel-body
+          .panel-group id="rocket_docs_documentation_description_accordion"
+            = RocketDocs.format_string(RocketDocs.description)

data/app/views/layouts/rocket_docs/_navigation.slim

@@ -2,7 +2,7 @@
   .navbar.navbar-default.navbar-fixed-top
     .container-fluid
       .navbar-header
-        = link_to 'Documentation', rocket_docs.root_path, class: 'navbar-brand'
+        = link_to RocketDocs.title, rocket_docs.root_path, class: 'navbar-brand'
       .collapse.navbar-collapse
         ul.nav.navbar-nav
           li = link_to 'All versions', rocket_docs.root_path

data/app/views/layouts/rocket_docs/application.slim

@@ -1,9 +1,10 @@
 head
-  title RocketDocs
+  title = RocketDocs.title
   = stylesheet_link_tag    "rocket_docs/application", media: "all"
   = javascript_include_tag "rocket_docs/application"
 body
   = render 'layouts/rocket_docs/navigation'
   .container
+    = render 'layouts/rocket_docs/api_description'
     = yield
   = render 'layouts/rocket_docs/modal'

data/lib/rocket_docs/documentation/action.rb

@@ -23,7 +23,7 @@ module RocketDocs
 
       def description(method = default_method)
         desc = (@doc[method] && @doc[method]['DOC']) || @doc['DOC']
-        desc && CGI.escapeHTML(desc).gsub("\n", '<br>').html_safe
+        RocketDocs.format_string(desc)
       end
 
       def params(method = default_method)

data/lib/rocket_docs/engine.rb

@@ -8,5 +8,14 @@ module RocketDocs
       g.test_framework :rspec
       g.fixture_replacement :factory_girl, dir: 'spec/factories'
     end
+
+    class << self
+      def setup(&block)
+        block.call(RocketDocs)
+        {
+          self => RocketDocs.url
+        }
+      end
+    end
   end
 end

data/lib/rocket_docs/version.rb

@@ -1,3 +1,3 @@
 module RocketDocs
-  VERSION = '0.0.7'
+  VERSION = '0.0.8'
 end

data/lib/rocket_docs.rb

@@ -6,24 +6,41 @@ require 'rocket_docs/parser'
 require 'rocket_docs/documentation'
 
 module RocketDocs
-  def self.documentation
-    Router.api_full.map do |version, controller|
-      Documentation.new(version, controller)
+  class << self
+    attr_accessor :url
+    attr_accessor :title
+    attr_accessor :description
+
+    def config(&block)
+      block.call(self)
     end
-  end
 
-  def self.documentation_for_version(version)
-    Documentation.new(version, Router.api_full[version])
-  end
+    def documentation
+      Router.api_full.map do |version, controller|
+        Documentation.new(version, controller)
+      end
+    end
+
+    def documentation_for_version(version)
+      Documentation.new(version.to_i, Router.api_full[version.to_i])
+    end
+
+    def documentation_for_files(files, version_name = 'Unknown')
+      fake_controlers = files.map do |file|
+        fake_controller = {
+          path: file,
+          actions: Hash[
+            Parser.method_comments(file).keys.map { |m, _c| [m, []] }
+          ]
+        }
+        [File.basename(file, '.rb'), fake_controller]
+      end
+      Documentation.new(version_name, Hash[fake_controlers])
+    end
 
-  def self.documentation_for_files(files, version_name = 'Unknown')
-    fake_controlers = files.map do |file|
-      fake_controller = {
-        path: file,
-        actions: Hash[Parser.method_comments(file).keys.map { |m, _c| [m, []] }]
-      }
-      [File.basename(file, '.rb'), fake_controller]
+    def format_string(string)
+      return unless string
+      CGI.escapeHTML(string).gsub("\n", '<br>').html_safe
     end
-    Documentation.new(version_name, Hash[fake_controlers])
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rocket_docs
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Stanko Krtalić Rusendić
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-18 00:00:00.000000000 Z
+date: 2015-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -258,6 +258,7 @@ files:
 - app/views/docs/rocket_docs/index.slim
 - app/views/docs/rocket_docs/show.markdown.erb
 - app/views/docs/rocket_docs/show.slim
+- app/views/layouts/rocket_docs/_api_description.slim
 - app/views/layouts/rocket_docs/_modal.slim
 - app/views/layouts/rocket_docs/_navigation.slim
 - app/views/layouts/rocket_docs/application.slim