cabbage_doc 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 91e6336597672b91cdc338a24ad44aa2856e8cfa
-  data.tar.gz: 1ccc5abce46f5a6a37dae2665c9def1fcce02130
+  metadata.gz: 7bdad905798e6ed0c5e62b8ec075359acf0eb78c
+  data.tar.gz: 40c4b70fdaebe890f108ecd2cfc94c8e82608782
 SHA512:
-  metadata.gz: 4474ce6a1de2aaecfc981d344cafe6ebe794d0d4f2dfd9ead19a9d970caeb1e4dd5f18045d2211d0d40b8f5c0e89eaedb06ba978bd5453c13fb54f4ca3b8a86a
-  data.tar.gz: 55d173af4aed9f1cef47583c9b63def698741f3b173b28fd99fb6ba21f1b57fb98603da7e23b1aa7f0fc99c2c7f32c6e1c21eada54673ead26d831462eb4b013
+  metadata.gz: 493affb4f721afd804dfb7fcfb251d8bf22d36a8754452f727e0cc98816f5bc9aca235f308623435aac67a74ff45bffab1586188627d470e95c220a31614894a
+  data.tar.gz: 3410ed1938d0e208c1a61a1fb4918725fe922125269a36dbdfd2892a7cc44a89cbfe748d91bdeab4cf70f48f007ba3352866ced565f776529d3b98ea418f6119

data/lib/cabbage_doc.rb

@@ -1,6 +1,7 @@
 module CabbageDoc
+  TAG = :api
   MARKER = ':cabbagedoc:'.freeze
-  VISIBILITY = %i(public private internal beta).freeze
+  VISIBILITY = %i(public private internal beta unreleased).freeze
   VISIBILITY_REGEXP = VISIBILITY.map(&:to_s).map(&:capitalize).join('|').freeze
 
   autoload :Path,           'cabbage_doc/path'
@@ -20,7 +21,7 @@ module CabbageDoc
   autoload :Collection,     'cabbage_doc/collection'
   autoload :WebHelper,      'cabbage_doc/web_helper'
   autoload :Web,            'cabbage_doc/web'
-  autoload :Processor,      'cabbage_doc/processor'
+  autoload :Generator,      'cabbage_doc/generator'
   autoload :Customizer,     'cabbage_doc/customizer'
   autoload :Task,           'cabbage_doc/task'
   autoload :Worker,         'cabbage_doc/worker'
@@ -33,5 +34,9 @@ module CabbageDoc
         config.validate!
       end
     end
+
+    def glob(*args)
+      proc { Dir.glob(File.join(*args)).sort.reverse }
+    end
   end
 end

data/lib/cabbage_doc/action.rb

@@ -13,7 +13,7 @@ module CabbageDoc
       @visibility = VISIBILITY.first
     end
 
-    def parse(text)
+    def parse(text, tag = TAG)
       @method, @path = parse_method_and_path(text)
       return unless valid?
 

data/lib/cabbage_doc/authentication.rb

@@ -1,8 +1,9 @@
 module CabbageDoc
   class Authentication
     class << self
-      def new(request = nil)
+      def new(request = nil, tag = nil)
         super().tap do |auth|
+          auth.tag = tag if tag
           yield(auth) if block_given?
           Configuration.instance.authentication.call(auth, request)
         end
@@ -21,7 +22,9 @@ module CabbageDoc
                   :user_agent,
                   :configurable,
                   :verbose,
-                  :visibility
+                  :visibility,
+                  :tag,
+                  :json
 
     def initialize
       Configuration.instance.tap do |config|
@@ -31,6 +34,8 @@ module CabbageDoc
         @user_agent = config.title
         @verbose    = config.verbose
         @visibility = config.visibility.dup
+        @tag        = config.tags.first
+        @json       = config.json
       end
 
       @subdomains = []
@@ -53,9 +58,9 @@ module CabbageDoc
     def valid?
       case type
       when :basic
-        username && password
+        username && password && valid_subdomain?
       else
-        !token.nil?
+        !token.nil? && valid_subdomain?
       end
     end
 
@@ -65,6 +70,10 @@ module CabbageDoc
 
     private
 
+    def valid_subdomain?
+      !configurable.include?(:subdomain) || subdomain
+    end
+
     def root_uri
       if subdomain
         "#{scheme}://#{subdomain}.#{domain}"

data/lib/cabbage_doc/client.rb

@@ -1,3 +1,5 @@
+require 'httparty'
+
 module CabbageDoc
   class Client
     include HTTParty

data/lib/cabbage_doc/collection.rb

@@ -32,22 +32,26 @@ module CabbageDoc
       end
     end
 
-    def parse!(filename)
+    def parse!(filename, tag = TAG)
       text = File.read(filename) rescue nil
       return false unless text
 
-      controller = Controller.parse(text)
+      controller = Controller.parse(text, tag)
       return false unless controller
 
-      controllers = controller.eval(text)
+      controllers = controller.eval(text, tag)
 
       @_controllers.concat(controllers)
 
       controllers.any?
     end
 
-    def clear!
-      @_controllers = []
+    def clear!(tag = nil)
+      if tag && config.tags.size > 1
+        @_controllers.reject! { |controller| tag == controller.tag }
+      else
+        @_controllers = []
+      end
     end
 
     def load!
@@ -55,13 +59,26 @@ module CabbageDoc
     end
 
     def save!
+      sort!
       open(filename, 'w') { |f| f.write(YAML.dump(@_controllers)) } rescue nil
     end
 
     private
 
+    def sort!
+      return unless config.tags.size > 1
+
+      @_controllers.sort! do |controller|
+        -config.tags.index(controller.tag)
+      end
+    end
+
+    def config
+      @_config ||= Configuration.instance
+    end
+
     def filename
-      @_filename ||= Path.join(Configuration.instance.root, FILENAME)
+      @_filename ||= Path.join(config.root, FILENAME)
     end
   end
 end

data/lib/cabbage_doc/configuration.rb

@@ -30,7 +30,8 @@ module CabbageDoc
       end
     end
 
-    DEFAULTS = {
+    DEFAULTS =
+    {
       path: 'api/v1',
       title: 'Cabbage Doc',
       scheme: 'https',
@@ -41,10 +42,18 @@ module CabbageDoc
       request: proc { |request| request.perform },
       theme: 'github',
       examples: false,
-      format_example: method(:format_example)
+      format_example: method(:format_example),
+      page_root: 'pages',
+      page_ext: 'md',
+      auto_generate: true,
+      generators: [:api],
+      tags: [TAG],
+      json: false
     }.freeze
 
-    OPTIONAL_ATTRIBUTES = %i(welcome path scheme title verbose authentication dev request cache theme visibility examples format_example).freeze
+    OPTIONAL_ATTRIBUTES = %i(welcome path scheme title verbose authentication dev request cache
+                              theme visibility examples format_example page_root page_ext
+                              asset_path auto_generate generators tags json).freeze
     REQUIRED_ATTRIBUTES = %i(domain controllers root).freeze
     ATTRIBUTES          = (OPTIONAL_ATTRIBUTES + REQUIRED_ATTRIBUTES).freeze
     CALLABLE_ATTRIBUTES = %i(controllers authentication request format_example).freeze
@@ -87,7 +96,8 @@ module CabbageDoc
     def validate_visibility!
       self.visibility = Array(visibility)
       self.visibility.each do |v|
-        raise ArgumentError, "#{v} invalid visibility" unless VISIBILITY.include?(v)
+        valid = VISIBILITY.include?(v) || tags.include?(v)
+        raise ArgumentError, "#{v} invalid visibility" unless valid
       end
     end
   end

data/lib/cabbage_doc/controller.rb

@@ -3,15 +3,16 @@ module CabbageDoc
     include Parser
     include Cloneable
 
-    attr_reader :label, :klass, :name, :path, :actions, :visibility
+    attr_reader :label, :klass, :name, :path, :actions, :visibility, :tag
 
-    def initialize
+    def initialize(tag = TAG)
       @actions = []
       @visibility = VISIBILITY.first
+      @tag = tag
     end
 
-    def parse(text)
-      @label, @path, @klass, @visibility = parse_label_path_class_and_visibility(text)
+    def parse(text, tag = TAG)
+      @label, @path, @klass, @visibility, @tag = parse_label_path_class_visibility_and_tag(text, tag)
       return false unless @label && @klass
 
       @name = compose_name(klass)
@@ -31,7 +32,7 @@ module CabbageDoc
       end
     end
 
-    def eval(text)
+    def eval(text, tag)
       return [self] unless template?
 
       templates = []
@@ -50,7 +51,7 @@ module CabbageDoc
           template_text.gsub!(template[:text], template[:values].shift.to_s)
         end
 
-        self.class.parse(template_text)
+        self.class.parse(template_text, tag)
       end.compact
     end
 
@@ -69,10 +70,14 @@ module CabbageDoc
     end
 
     def compose_visbility(metadata)
-      metadata[:visibility] || :public
+      metadata[:visibility] || VISIBILITY.first
     end
 
-    def parse_label_path_class_and_visibility(text)
+    def compose_tag(metadata, tag = TAG)
+      metadata[:tag]&.to_sym || tag
+    end
+
+    def parse_label_path_class_visibility_and_tag(text, tag = TAG)
       klass = parse_class(text)
       return unless klass
 
@@ -82,7 +87,8 @@ module CabbageDoc
         compose_label(metadata, klass),
         compose_path(metadata, klass),
         klass,
-        compose_visbility(metadata)
+        compose_visbility(metadata),
+        compose_tag(metadata, tag)
       ]
     end
 

data/lib/cabbage_doc/example.rb

@@ -10,7 +10,7 @@ module CabbageDoc
       @params = {}
     end
 
-    def parse(text)
+    def parse(text, tag = TAG)
       m = text.match(/^(.*?)\s+-\s+(\(.*?\))$/)
       return false unless m
 

data/lib/cabbage_doc/{processor.rb → generator.rb}

@@ -1,5 +1,5 @@
 module CabbageDoc
-  class Processor
+  class Generator
     class Error < StandardError; end
     class InvalidType < Error; end
     class InvalidPriority < Error; end
@@ -11,6 +11,14 @@ module CabbageDoc
         all[klass.to_s.split('::').last.downcase.to_sym] = klass
       end
 
+      def tags(value = nil)
+        if value.nil?
+          @_tags
+        else
+          @_tags = !!value
+        end
+      end
+
       def priority(value = nil)
         if value.is_a?(Symbol)
           raise InvalidPriority, value unless PRIORITIES.include?(value)
@@ -24,40 +32,48 @@ module CabbageDoc
         @_all ||= {}
       end
 
-      def perform(type)
-        klass = all[type]
+      def supports?(type, what)
+        !!find(type).public_send(what)
+      end
 
-        if klass
-          klass.new.perform
+      def exists?(type)
+        all.has_key?(type)
+      end
+
+      def perform(type, tag = nil)
+        if type == :all
+          all.map { |_, klass| klass.new(tag).perform }
         else
-          raise InvalidType, type
+          find(type).new(tag).perform
         end
       end
 
+      def find(type)
+        klass = all[type]
+
+        raise InvalidType, type unless klass
+
+        klass
+      end
+
       def load!
-        Dir.glob(File.join(File.dirname(__FILE__), 'processors', '*.rb')).sort.each do |processor|
-          require(processor)
+        Dir.glob(File.join(File.dirname(__FILE__), 'generators', '*.rb')).sort.each do |generator|
+          require(generator)
         end
       end
     end
 
-    def perform
-      raise NotImplementedError
-    end
-
-    protected
+    attr_accessor :tag
 
-    def cache
-      @_cache ||= Cache.new
+    def initialize(tag = nil)
+      self.tag = tag
     end
 
-    def client
-      @_client ||= Client.new(auth)
+    def perform
+      raise NotImplementedError
     end
 
-    def auth
-      @_auth ||= Authentication.new
-    end
+    protected
 
     def collection
       @_collection ||= Collection.instance.tap do |collection|
@@ -65,10 +81,14 @@ module CabbageDoc
       end
     end
 
+    def controllers
+      @_controllers ||= config.controllers.call
+    end
+
     def config
       @_config ||= Configuration.instance
     end
   end
 
-  Processor.load!
+  Generator.load!
 end

data/lib/cabbage_doc/generators/api.rb

@@ -0,0 +1,39 @@
+module CabbageDoc
+  module Generators
+    class Api < Generator
+      priority :high
+      tags true
+
+      def perform
+        collection.clear!(tag)
+
+        if controllers.is_a?(Hash)
+          parse_with_tag!
+        else
+          parse_without_tag!
+        end
+
+        collection.save!
+      end
+
+      private
+
+      def parse_with_tag!
+        controllers.each do |tag, filenames|
+          next if self.tag && self.tag != tag
+          next unless filenames.respond_to?(:call)
+
+          filenames.call.each do |filename|
+            collection.parse!(filename, tag)
+          end
+        end
+      end
+
+      def parse_without_tag!
+        controllers.each do |filename|
+          collection.parse!(filename)
+        end
+      end
+    end
+  end
+end

data/lib/cabbage_doc/generators/pages.rb

@@ -0,0 +1,33 @@
+module CabbageDoc
+  module Generators
+    class Pages < Generator
+      priority :low
+
+      def perform
+        pages.each do |file|
+          generate(file)
+        end
+      end
+
+      private
+
+      def generate(file)
+        open(file.sub(/#{config.page_ext}$/, 'html'), 'w') do |f|
+          f.write(helper.markdown.render(File.read(file)))
+        end
+      end
+
+      def pages
+        @_pages ||= Dir.glob(File.join(config.root, config.page_root, "*.#{config.page_ext}"))
+      end
+
+      class Helper
+        include CabbageDoc::WebHelper
+      end
+
+      def helper
+        @_helper ||= Helper.new
+      end
+    end
+  end
+end

data/lib/cabbage_doc/parameter.rb

@@ -10,7 +10,7 @@ module CabbageDoc
       @values = []
     end
 
-    def parse(text)
+    def parse(text, tag = TAG)
       m = text.match(/^(.*?\s+\(.*?\).*?)\s+-\s+(.*?)$/)
       return false unless m
 

data/lib/cabbage_doc/params.rb

@@ -2,6 +2,10 @@ module CabbageDoc
   class Params
     include Enumerable
 
+    ACTION  = '__action'.freeze
+    METHOD  = '__method'.freeze
+    TAG     = '__tag'.freeze
+
     def initialize(params, collection)
       @_params = convert(params, collection)
     end
@@ -41,8 +45,8 @@ module CabbageDoc
     private
 
     def convert(params, collection)
-      method = params['method']
-      action = params['action']
+      method = params[METHOD]
+      action = params[ACTION]
 
       return {} unless action && method
 

data/lib/cabbage_doc/parser.rb

@@ -7,13 +7,13 @@ module CabbageDoc
     end
 
     module ClassMethods
-      def parse(text)
+      def parse(text, tag = TAG)
         instance = new
-        instance if instance.parse(text)
+        instance if instance.parse(text, tag)
       end
     end
 
-    def parse(text)
+    def parse(text, tag = TAG)
       raise NotImplementedError
     end
 

data/lib/cabbage_doc/request.rb

@@ -9,11 +9,11 @@ module CabbageDoc
     attr_reader :raw_request, :collection
 
     class << self
-      def parse(s)
+      def parse(s, tag = TAG)
         variables = YAML.load(s)
 
         new(OpenStruct.new(params: {}, env: {}), Collection.instance).tap do |instance|
-          [:@_id, :@_auth, :@_action, :@_method, :@_params].each_with_index do |k, i|
+          [:@_id, :@_auth, :@_action, :@_method, :@_tag, :@_params].each_with_index do |k, i|
             instance.instance_variable_set(k, variables[i])
           end
         end
@@ -30,7 +30,7 @@ module CabbageDoc
     end
 
     def valid?
-      action && method && METHODS.include?(method)
+      action && method && METHODS.include?(method) && auth.valid?
     end
 
     def to_yaml
@@ -39,6 +39,7 @@ module CabbageDoc
         auth,
         action,
         method,
+        tag,
         params
       ])
     end
@@ -56,7 +57,11 @@ module CabbageDoc
 
     def perform_request
       key = (method == :get) ? :query : :body
-      client.send(method, action, key => params.to_hash)
+
+      data = params.to_hash
+      data = data.to_json if key == :body && auth.json
+
+      client.public_send(method, action, key => data)
     end
 
     def url
@@ -64,11 +69,15 @@ module CabbageDoc
     end
 
     def action
-      @_action ||= compose_action(raw_request.params['action'])
+      @_action ||= compose_action(raw_request.params[Params::ACTION])
     end
 
     def method
-      @_method ||= compose_method(raw_request.params['method'])
+      @_method ||= compose_method(raw_request.params[Params::METHOD])
+    end
+
+    def tag
+      @_tag ||= compose_tag(raw_request.params[Params::TAG])
     end
 
     def compose_method(method)
@@ -90,12 +99,20 @@ module CabbageDoc
       action
     end
 
+    def compose_tag(tag)
+      if tag
+        tag.downcase.to_sym
+      else
+        TAG
+      end
+    end
+
     def params
       @_params ||= Params.new(raw_params, collection)
     end
 
     def auth
-      @_auth ||= Authentication.new(raw_request)
+      @_auth ||= Authentication.new(raw_request, tag)
     end
 
     def raw_params

data/lib/cabbage_doc/response.rb

@@ -5,7 +5,7 @@ module CabbageDoc
     attr_reader :url, :headers, :params, :code, :body
 
     class << self
-      def parse(s)
+      def parse(s, tag = TAG)
         YAML.load(s)
       end
     end

data/lib/cabbage_doc/task.rb

@@ -3,7 +3,7 @@ require 'rake/tasklib'
 
 module CabbageDoc
   class Task < Rake::TaskLib
-    attr_accessor :processors, :name
+    attr_accessor :generators, :tags, :name, :customize
 
     def self.define
       new.tap do |instance|
@@ -15,45 +15,77 @@ module CabbageDoc
     end
 
     def initialize
-      @processors = [:documentation]
-      @name = :cabbagedoc
+      self.generators = config.generators.dup
+      self.tags = config.tags.dup
+      self.name = :cabbagedoc
+      self.customize = true
+    end
+
+    def config
+      @_config ||= Configuration.instance
     end
 
     def sort!
-      processors.sort! { |processor| Processor::PRIORITIES.index(Processor.all[processor].priority) }
+      generators.sort! { |generator| Generator::PRIORITIES.index(Generator.all[generator].priority) }
     end
 
     def define!
       namespace name do
-        processors.each do |processor|
-          desc "Process #{processor}"
-          namespace :process do
-            task processor.to_s => :environment do
-              Processor.all[processor].new.perform
-            end
-          end
-        end
-
-        desc "Customize Web UI"
-        task :customize => :environment do
-          Customizer.new.perform
-        end
+        define_generators!
+        define_customizer!
       end
 
-      desc "Run all processors"
+      desc "Run all generators"
       task name => :environment do
-        processors.each do |name|
-          Processor.all[name].new.perform
+        generators.each do |type|
+          Generator.perform(type)
         end
       end
     end
 
     def validate!
       fail "Invalid 'name'" unless name.is_a?(Symbol)
-      fail "No 'processors' configured" unless processors.any?
+      fail "No 'generators' configured" unless generators.any?
+
+      generators.each do |generator|
+        fail "Invalid 'generator' #{generator}" unless Generator.exists?(generator)
+      end
+    end
+
+    private
+
+    def define_generators!
+      generators.each do |type|
+        desc "Generate #{type}"
+        task type => :environment do
+          Generator.perform(type)
+        end
+
+        define_generators_by_tag!(type)
+        define_customizer!
+      end
+    end
+
+    def define_generators_by_tag!(type)
+      return unless Generator.supports?(type, :tags)
+      return unless tags.size > 1
+
+      namespace type do
+        tags.each do |tag|
+          desc "Generate #{type} for #{tag}"
+          task tag => :environment do
+            Generator.perform(type, tag)
+          end
+        end
+      end
+    end
+
+    def define_customizer!
+      return unless customize
 
-      processors.each do |processor|
-        fail "Invalid 'processor' #{processor}" unless Processor.all.has_key?(processor)
+      desc "Customize Web UI"
+      task :customize => :environment do
+        Customizer.new.perform
       end
     end
   end

data/lib/cabbage_doc/version.rb

@@ -1,3 +1,3 @@
 module CabbageDoc
-  VERSION = "0.0.7".freeze
+  VERSION = "0.0.8".freeze
 end

data/lib/cabbage_doc/web.rb

@@ -36,12 +36,12 @@ module CabbageDoc
       haml :index
     end
 
-    get '/:id' do
+    get '/api/:id' do
       response_by_id(params[:id])
     end
 
-    post '/' do
-      response = Configuration.instance.request.call(post_request) if post_request.valid?
+    post '/api' do
+      response = config.request.call(post_request) if post_request.valid?
 
       if response.is_a?(Response)
         content_type :json
@@ -52,5 +52,19 @@ module CabbageDoc
         halt 500
       end
     end
+
+    get '/:slug' do
+      slug = params[:slug].to_s.gsub(/[^a-z\-_]/, '')
+      filename = File.join(config.root, config.page_root, "#{slug}.html") unless slug.empty?
+
+      content = if !filename.empty? && File.exists?(filename)
+                  File.read(filename)
+                else
+                  status 404
+                  "Page not found."
+                end
+
+      haml :page, layout: :page_layout, locals: { content: content }
+    end
   end
 end

data/lib/cabbage_doc/web_helper.rb

@@ -1,7 +1,9 @@
+require 'redcarpet'
+
 module CabbageDoc
   module WebHelper
     def asset_path(path)
-      [request.path, path].join('/').gsub(/\/\/+/, '/')
+      [config.asset_path || request.path, path].join('/').gsub(/\/\/+/, '/')
     end
 
     def theme_path
@@ -13,8 +15,8 @@ module CabbageDoc
     end
 
     def collection
-      if config.dev
-        Processor.perform(:documentation)
+      if config.dev && config.auto_generate
+        Generator.perform(:all)
         @_collection = nil
       end
 
@@ -44,10 +46,18 @@ module CabbageDoc
       auth.visibility.include?(o.visibility)
     end
 
+    def tag_visible?(tag)
+      config.tags.size <= 1 || auth.visibility.include?(tag)
+    end
+
     def format_visibility(o)
       o.visibility.to_s.capitalize if o.visibility != VISIBILITY.first
     end
 
+    def format_tag(tag)
+      tag.to_s.capitalize
+    end
+
     def post_request
       @_post_request ||= Request.new(request, collection)
     end

data/web/public/css/application.css

@@ -1,9 +1,3 @@
-body
-{
-	margin: 0;
-	padding: 0;
-}
-
 pre, code, .authentication form
 {
 	font-family: monospace;
@@ -32,18 +26,6 @@ input[type=button], input[type=submit]
   min-width: 98px;
 }
 
-a, a:active, a:visited, a:hover
-{
-	color: #000000;
-	text-decoration: none;
-	font-weight: bold;
-}
-
-a:hover
-{
-	text-decoration: underline;
-}
-
 .hidden
 {
 	display: none !important; 
@@ -70,13 +52,7 @@ a:hover
   float: right;
 }
 
-.application
-{
-	margin: 10px auto;
-	width: 1024px;
-}
-
-.welcome, .documentation, .authentication
+.welcome, .api, .authentication
 {
 	width: 100%;
 }

data/web/public/css/base.css

@@ -0,0 +1,23 @@
+body
+{
+	margin: 0;
+	padding: 0;
+}
+
+a, a:active, a:visited, a:hover
+{
+	color: #000000;
+	text-decoration: none;
+	font-weight: bold;
+}
+
+a:hover
+{
+	text-decoration: underline;
+}
+
+.application, .page
+{
+	margin: 10px auto;
+	width: 1024px;
+}

data/web/public/js/application.js

@@ -116,8 +116,9 @@ $(document).ready(function()
 
     var data = $('.authentication form').serializeArray().concat(form.serializeArray());
 
-    data.push({'name': 'method', 'value': form.attr('method') || ''});
-    data.push({'name': 'action', 'value': form.attr('action') || ''});
+    data.push({'name': '__method', 'value': form.attr('method')    || ''});
+    data.push({'name': '__action', 'value': form.attr('action')    || ''});
+    data.push({'name': '__tag',    'value': form.attr('data-tag')  || 'api'});
 
     data = $.grep(data, function(v, i)
     {
@@ -144,7 +145,7 @@ $(document).ready(function()
 
       setTimeout(function()
       {
-        $.ajax(compose_path('/' + id), {
+        $.ajax(compose_path('/api/' + id), {
           method: 'GET',
           dataType: 'json',
           complete: function(data)
@@ -158,7 +159,7 @@ $(document).ready(function()
       }, 1000);
     }
 
-    $.ajax(compose_path('/'), {
+    $.ajax(compose_path('/api'), {
       data: $.param(data),
       method: 'POST',
       dataType: 'json',
@@ -167,7 +168,7 @@ $(document).ready(function()
         var json = data.responseJSON || {};
 
         if(data.status == 503 && typeof json.id != 'undefined')
-          retry_later(form, json.id, 30);
+          retry_later(form, json.id, 5);
         else
           display_response(form, data);
       }

data/web/views/action.haml

@@ -6,10 +6,10 @@
     %span= " : #{action.label}"
     %span.visibility= format_visibility(action)
   .clear
-  %form.hidden{ action: action.path, method: action.method }
+  %form.hidden{ action: action.path, method: action.method, :'data-tag' => tag }
     - if action.description
       .description= markdown.render(action.description)
-    - if action.visibility == :beta
+    - if %i(unreleased beta).include?(action.visibility)
       .warning= 'This API is still under development and will continue to evolve.'
     - if config.examples && action.examples.any?
       .examples
@@ -24,4 +24,4 @@
           %th='Description'
         - action.parameters.each do |parameter|
           = haml :parameter, locals: { parameter: parameter }
-      = haml :response
+    = haml :response

data/web/views/api.haml

@@ -0,0 +1,14 @@
+.controllers
+  - if config.tags.size > 1
+    - grouped = collection.group_by(&:tag)
+    - config.tags.each { |tag| grouped.delete(tag) unless tag_visible?(tag) }
+    - if grouped.size > 1
+      - collection.group_by(&:tag).each do |tag, controllers|
+        .tag
+          .resource
+            = format_tag(tag)
+          = haml :controllers, locals: { controllers: controllers }
+    - else
+      = haml :controllers, locals: { controllers: grouped.values.first }
+  - else
+    = haml :controllers, locals: { controllers: collection }

data/web/views/controller.haml

@@ -7,4 +7,4 @@
   .actions.hidden
     - controller.actions.each do |action|
       - if visible?(action)
-        = haml :action, locals: { action: action }
+        = haml :action, locals: { action: action, tag: controller.tag }

data/web/views/controllers.haml

@@ -0,0 +1,3 @@
+- controllers.each do |controller|
+  - if visible?(controller)
+    = haml :controller, locals: { controller: controller }

data/web/views/index.haml

@@ -1,8 +1,11 @@
+.title
+  %h1=title
+
 .welcome
   = haml :welcome
 
 .authentication
   = haml :authentication
 
-.documentation
-  = haml :documentation
+.api
+  = haml :api

data/web/views/layout.haml

@@ -2,6 +2,7 @@
 %html
   %head
     %link{ rel: :stylesheet, href: theme_path, type: 'text/css' }
+    %link{ rel: :stylesheet, href: asset_path('css/base.css'), type: 'text/css' }
     %link{ rel: :stylesheet, href: asset_path('css/application.css'), type: 'text/css' }
     %script{ src: asset_path('js/jquery-1.12.3.min.js'), type: 'text/javascript' }
     %script{ src: asset_path('js/highlight.min.js'), type: 'text/javascript' }

data/web/views/page.haml

@@ -0,0 +1 @@
+= markdown.render(content) unless content.empty?

data/web/views/page_layout.haml

@@ -0,0 +1,13 @@
+!!!
+%html
+  %head
+    %link{ rel: :stylesheet, href: asset_path('css/base.css'), type: 'text/css' }
+
+  %title= title
+  %body
+    .page
+      .title
+        %h1=title
+        %a{href: '/'}="< Back"
+      .body
+        = yield

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cabbage_doc
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Mihail Szabolcs
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-03 00:00:00.000000000 Z
+date: 2017-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redcarpet
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: haml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
@@ -139,12 +153,13 @@ files:
 - lib/cabbage_doc/controller.rb
 - lib/cabbage_doc/customizer.rb
 - lib/cabbage_doc/example.rb
+- lib/cabbage_doc/generator.rb
+- lib/cabbage_doc/generators/api.rb
+- lib/cabbage_doc/generators/pages.rb
 - lib/cabbage_doc/parameter.rb
 - lib/cabbage_doc/params.rb
 - lib/cabbage_doc/parser.rb
 - lib/cabbage_doc/path.rb
-- lib/cabbage_doc/processor.rb
-- lib/cabbage_doc/processors/documentation.rb
 - lib/cabbage_doc/request.rb
 - lib/cabbage_doc/response.rb
 - lib/cabbage_doc/singleton.rb
@@ -155,6 +170,7 @@ files:
 - lib/cabbage_doc/worker.rb
 - web/helpers/helper.rb
 - web/public/css/application.css
+- web/public/css/base.css
 - web/public/css/highlight/agate.css
 - web/public/css/highlight/androidstudio.css
 - web/public/css/highlight/arduino-light.css
@@ -194,14 +210,17 @@ files:
 - web/public/js/highlight.min.js
 - web/public/js/jquery-1.12.3.min.js
 - web/views/action.haml
+- web/views/api.haml
 - web/views/array.haml
 - web/views/authentication.haml
 - web/views/controller.haml
-- web/views/documentation.haml
+- web/views/controllers.haml
 - web/views/enumeration.haml
 - web/views/example.haml
 - web/views/index.haml
 - web/views/layout.haml
+- web/views/page.haml
+- web/views/page_layout.haml
 - web/views/parameter.haml
 - web/views/response.haml
 - web/views/text.haml

data/lib/cabbage_doc/processors/documentation.rb

@@ -1,17 +0,0 @@
-module CabbageDoc
-  module Processors 
-    class Documentation < Processor
-      priority :high
-
-      def perform
-        collection.clear!
-
-        config.controllers.call.each do |filename|
-          collection.parse!(filename)
-        end
-
-        collection.save!
-      end
-    end
-  end
-end

data/web/views/documentation.haml

@@ -1,4 +0,0 @@
-.controllers
-  - collection.each do |controller|
-    - if visible?(controller)
-      = haml :controller, locals: { controller: controller }