cabbage_doc 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2a930fb03ad28bf25bc142204263b37ca8ec6ca4
-  data.tar.gz: 663236ed05c311345ab852f0dfa1de68a184f083
+  metadata.gz: 27a236fc7439566b6ea5056fcd4fb3ef08697d7e
+  data.tar.gz: f0cacbf8131c633330d0c5f08dc35bc77832a3bf
 SHA512:
-  metadata.gz: a3ce12e5601660eb0e4259be5dfb2ddcffc3b4bc7abef83e049c0de036e9da40cdfcef3a7eea0a6a7eae013adac4f119d59ad91c2fb95d89b8f5174df2d96727
-  data.tar.gz: bb24cb30b100840f4e6bc16b74ea61ec1ab894c02f22ba7a8c0b2a7aca0c078038f0dfa90f5df634646b5c2095acfc396edbf3998cf987b1fd419028ffc44b66
+  metadata.gz: 8d4a620a2020a673d25bd3706582e999183e2fb269795855154afb11873daa5263f2b235ee36584ea3dac7bc134f03342781bdb29690c4356f448ba08d70b816
+  data.tar.gz: 49a35368edc2326a9c7a47838063226eb698c0baf9e80ea8917aa0dc786141411dfcbe09829e9370d5a3cc9e05631474e23bf036ca2921a578a6e8fbc7baa1fe

data/lib/cabbage_doc/authentication.rb

@@ -36,6 +36,14 @@ module CabbageDoc
       @type = :basic
     end
 
+    def uri
+      if path && path != '/'
+        "#{root_uri}/#{path}"
+      else
+        root_uri
+      end
+    end
+
     def valid?
       case type
       when :basic
@@ -50,5 +58,15 @@ module CabbageDoc
     def configurable?
       @configurable.any?
     end
+
+    private
+
+    def root_uri
+      if subdomain
+        "#{scheme}://#{subdomain}.#{domain}"
+      else
+        "#{scheme}://#{domain}"
+      end
+    end
   end
 end

data/lib/cabbage_doc/cache.rb

@@ -0,0 +1,23 @@
+module CabbageDoc
+  class Cache
+    def initialize
+      clear
+    end
+
+    def write(key, value, options = {})
+      @_data[key] = value
+    end
+
+    def read(key)
+      @_data[key]
+    end
+
+    def delete(key)
+      @_data.delete(key)
+    end
+
+    def clear
+      @_data = {}
+    end
+  end
+end

data/lib/cabbage_doc/client.rb

@@ -6,12 +6,7 @@ module CabbageDoc
       def new(auth)
         Class.new(self) do |klass|
           klass.headers "User-Agent" => auth.user_agent
-    
-          if auth.subdomain
-            klass.base_uri "#{auth.scheme}://#{auth.subdomain}.#{auth.domain}/#{auth.path}"
-          else
-            klass.base_uri "#{auth.scheme}://#{auth.domain}/#{auth.path}"
-          end
+          klass.base_uri auth.uri
 
           if auth.type == :basic
             klass.basic_auth auth.username, auth.password

data/lib/cabbage_doc/configuration.rb

@@ -3,17 +3,20 @@ module CabbageDoc
     include Singleton
 
     DEFAULTS = {
-      version: 'v1',
       path: 'api/v1',
       title: 'Cabbage Doc',
       scheme: 'https',
-      verbose: false
+      verbose: false,
+      dev: false,
+      cache: Cache.new,
+      request: proc { |request| request.perform },
+      theme: 'github'
     }.freeze
 
-    OPTIONAL_ATTRIBUTES = %i(welcome path scheme version title verbose authentication).freeze
+    OPTIONAL_ATTRIBUTES = %i(welcome path scheme title verbose authentication dev request cache theme).freeze
     REQUIRED_ATTRIBUTES = %i(domain controllers root).freeze
     ATTRIBUTES          = (OPTIONAL_ATTRIBUTES + REQUIRED_ATTRIBUTES).freeze
-    CALLABLE_ATTRIBUTES = %i(controllers authentication).freeze
+    CALLABLE_ATTRIBUTES = %i(controllers authentication request).freeze
 
     attr_accessor *ATTRIBUTES 
 

data/lib/cabbage_doc/path.rb

@@ -2,7 +2,7 @@ module CabbageDoc
   class Path
     class << self
       def join(*args)
-        args.join('/').gsub(/\/+/, '/')
+        args.join('/').gsub(/\/+/, '/').gsub(/\/+$/, '')
       end
     end
   end

data/lib/cabbage_doc/processor.rb

@@ -1,14 +1,39 @@
 module CabbageDoc
   class Processor
+    class Error < StandardError; end
+    class InvalidType < Error; end
+    class InvalidPriority < Error; end
+
+    PRIORITIES = [:high, :medium, :low].freeze
+
     class << self
       def inherited(klass)
         all[klass.to_s.split('::').last.downcase.to_sym] = klass
       end
 
+      def priority(value = nil)
+        if value.is_a?(Symbol)
+          raise InvalidPriority, value unless PRIORITIES.include?(value)
+          @_priority = value
+        else
+          @_priority
+        end
+      end
+
       def all
         @_all ||= {}
       end
 
+      def perform(type)
+        klass = all[type]
+
+        if klass
+          klass.new.perform
+        else
+          raise InvalidType, type
+        end
+      end
+
       def load!
         Dir.glob(File.join(File.dirname(__FILE__), 'processors', '*.rb')).sort.each do |processor|
           require(processor)
@@ -22,6 +47,10 @@ module CabbageDoc
 
     protected
 
+    def cache
+      @_cache ||= Cache.new
+    end
+
     def client
       @_client ||= Client.new(auth)
     end
@@ -35,6 +64,10 @@ module CabbageDoc
         collection.load!
       end
     end
+
+    def config
+      @_config ||= Configuration.instance
+    end
   end
 
   Processor.load!

data/lib/cabbage_doc/processors/documentation.rb

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

data/lib/cabbage_doc/request.rb

@@ -1,9 +1,24 @@
+require 'yaml'
+require 'digest/sha1'
+
 module CabbageDoc
   class Request
     METHODS = %i[get post put delete].freeze
 
     attr_reader :raw_request, :collection
 
+    class << self
+      def parse(s)
+        variables = YAML.load(s)
+
+        new(nil, Collection.instance).tap do |instance|
+          [:@_id, :@_auth, :@_action, :@_method, :@_params].each_with_index do |k, i|
+            instance.instance_variable_set(k, variables[i])
+          end
+        end
+      end
+    end
+
     def initialize(raw_request, collection)
       @raw_request = raw_request
       @collection = collection
@@ -17,8 +32,27 @@ module CabbageDoc
       action && method && METHODS.include?(method)
     end
 
+    def to_yaml
+      YAML.dump([
+        id,
+        auth,
+        action,
+        method,
+        params
+      ])
+    end
+
+    def id
+      @_id ||= new_id
+    end
+
     private
 
+    def new_id
+      components = [MARKER, Time.now.utc, Process.pid, Thread.current.object_id, rand(99999)]
+      Digest::SHA1.hexdigest(components.join('_'))
+    end
+
     def perform_request
       key = (method == :get) ? :query : :body
       client.send(method, action, key => params.to_hash)
@@ -56,13 +90,17 @@ module CabbageDoc
     end
 
     def params
-      @_params ||= Params.new(raw_request.params, collection)
+      @_params ||= Params.new(raw_params, collection)
     end
 
     def auth
       @_auth ||= Authentication.new(raw_request)
     end
 
+    def raw_params
+      @_raw_params ||= raw_request.params
+    end
+
     def client
       @_client ||= Client.new(auth)
     end

data/lib/cabbage_doc/response.rb

@@ -1,7 +1,15 @@
+require 'yaml'
+
 module CabbageDoc
   class Response
     attr_reader :url, :headers, :params, :code, :body
 
+    class << self
+      def parse(s)
+        YAML.load(s)
+      end
+    end
+
     def initialize(url, params, response)
       @url = url
       @params = params
@@ -10,6 +18,10 @@ module CabbageDoc
       @body = response.parsed_response
     end
 
+    def to_yaml
+      YAML.dump(self)
+    end
+
     def to_json
       { 
         url: url,

data/lib/cabbage_doc/task.rb

@@ -9,6 +9,7 @@ module CabbageDoc
       new.tap do |instance|
         yield instance if block_given?
         instance.validate!
+        instance.sort!
         instance.define!
       end
     end
@@ -18,35 +19,22 @@ module CabbageDoc
       @name = :cabbagedoc
     end
 
-    def contracts=(value)
-      if value
-        @processors.delete(:rspec) if @processors.include?(:rspec)
-        @processors << :contracts
-        @processors << :rspec
-      else
-        @processors.delete(:contracts)
-      end
-    end
-
-    def rspec=(value)
-      if value
-        @processors << :contracts unless @processors.include?(:contracts)
-        @processors << :rspec
-      else
-        @processors.delete(:rspec)
-      end
+    def sort!
+      processors.sort! { |processor| Processor::PRIORITIES.index(Processor.all[processor].priority) }
     end
 
     def define!
       namespace name do
         processors.each do |processor|
           desc "Process #{processor}"
-          task processor.to_s => :environment do
-            Processor.all[processor].new.perform
+          namespace :process do
+            task processor.to_s => :environment do
+              Processor.all[processor].new.perform
+            end
           end
         end
 
-        desc "Customize Web"
+        desc "Customize Web UI"
         task :customize => :environment do
           Customizer.new.perform
         end

data/lib/cabbage_doc/version.rb

@@ -1,3 +1,3 @@
 module CabbageDoc
-  VERSION = "0.0.2".freeze
+  VERSION = "0.0.3".freeze
 end

data/lib/cabbage_doc/web.rb

@@ -25,12 +25,18 @@ module CabbageDoc
       haml :index
     end
 
+    get '/:id' do
+      response_by_id(params[:id])
+    end
+
     post '/' do
-      response = Request.new(request, collection).perform
+      response = Configuration.instance.request.call(post_request)
 
-      if response
-        content_type :json 
+      if response.is_a?(Response)
+        content_type :json
         response.to_json
+      elsif post_request.valid?
+        response_by_id(post_request.id)
       else
         halt 500
       end

data/lib/cabbage_doc/web_helper.rb

@@ -1,17 +1,35 @@
 module CabbageDoc
   module WebHelper
+    def asset_path(path)
+      [request.path, path].join('/').gsub(/\/\/+/, '/')
+    end
+
+    def theme_path
+      asset_path("css/highlight/#{config.theme}.css")
+    end
+
     def config
       Configuration.instance
     end
 
     def collection
+      if config.dev
+        Processor.perform(:documentation)
+        @_collection = nil
+      end
+
       @_collection ||= Collection.instance.tap do |collection|
         collection.load!
       end
     end
 
     def markdown
-      @_markdown ||= Redcarpet::Markdown.new(Redcarpet::Render::HTML.new)
+      @_markdown ||= Redcarpet::Markdown.new(
+        Redcarpet::Render::HTML.new,
+        tables: true,
+        fenced_code_blocks: true,
+        autolink: true
+      )
     end
 
     def title
@@ -21,5 +39,22 @@ module CabbageDoc
     def auth
       @_auth ||= Authentication.new(request)
     end
+
+    def post_request
+      @_post_request ||= Request.new(request, collection)
+    end
+
+    def response_by_id(id)
+      response = Worker.get(id)
+
+      if response.is_a?(Response)
+        content_type :json
+        response.to_json
+      else
+        status 503
+        content_type :json
+        { id: id }.to_json
+      end
+    end
   end
 end

data/lib/cabbage_doc/worker.rb

@@ -0,0 +1,28 @@
+module CabbageDoc
+  module Worker
+    EXPIRES_IN = 30.freeze # 30 seconds
+
+    class << self
+      def get(id)
+        response = CabbageDoc::Configuration.instance.cache.read([CabbageDoc::MARKER, id].join('_'))
+        Response.parse(response) if response
+      end
+    end
+
+    def perform(serialized_request)
+      request = Request.parse(serialized_request)
+      response = request.perform
+      write(request.id, response) if response
+    end
+
+    private
+
+    def write(id, response)
+      CabbageDoc::Configuration.instance.cache.write(
+        [CabbageDoc::MARKER, id].join('_'), 
+        response.to_yaml,
+        expires_in: EXPIRES_IN
+      )
+    end
+  end
+end

data/lib/cabbage_doc.rb

@@ -4,7 +4,6 @@ module CabbageDoc
   autoload :Path,           'cabbage_doc/path'
   autoload :Singleton,      'cabbage_doc/singleton'
   autoload :Cloneable,      'cabbage_doc/cloneable'
-  autoload :PactoHelper,    'cabbage_doc/pacto_helper'
   autoload :Parser,         'cabbage_doc/parser'
   autoload :Client,         'cabbage_doc/client'
   autoload :Request,        'cabbage_doc/request'
@@ -22,6 +21,8 @@ module CabbageDoc
   autoload :Processor,      'cabbage_doc/processor'
   autoload :Customizer,     'cabbage_doc/customizer'
   autoload :Task,           'cabbage_doc/task'
+  autoload :Worker,         'cabbage_doc/worker'
+  autoload :Cache,          'cabbage_doc/cache'
 
   class << self
     def configure

data/web/public/css/application.css

@@ -7,6 +7,11 @@ body
 pre, code, .authentication form
 {
 	font-family: monospace;
+	border: 1px solid #e5e0c6;
+}
+
+.authentication form
+{
 	background-color: #fcf6db;
 	border: 1px solid #e5e0c6;
 	padding: 10px;
@@ -178,6 +183,11 @@ a:hover
   margin-top: 10px;
 }
 
+.action .response pre
+{
+  overflow: hidden;
+}
+
 .action .description
 {
   margin-bottom: 20px;

data/web/public/css/highlight/agate.css

@@ -0,0 +1,108 @@
+/*!
+ * Agate by Taufik Nurrohman <https://github.com/tovic>
+ * ----------------------------------------------------
+ *
+ * #ade5fc
+ * #a2fca2
+ * #c6b4f0
+ * #d36363
+ * #fcc28c
+ * #fc9b9b
+ * #ffa
+ * #fff
+ * #333
+ * #62c8f3
+ * #888
+ *
+ */
+
+.hljs {
+  display: block;
+  overflow-x: auto;
+  padding: 0.5em;
+  background: #333;
+  color: white;
+}
+
+.hljs-name,
+.hljs-strong {
+  font-weight: bold;
+}
+
+.hljs-code,
+.hljs-emphasis {
+  font-style: italic;
+}
+
+.hljs-tag {
+  color: #62c8f3;
+}
+
+.hljs-variable,
+.hljs-template-variable,
+.hljs-selector-id,
+.hljs-selector-class {
+  color: #ade5fc;
+}
+
+.hljs-string,
+.hljs-bullet {
+  color: #a2fca2;
+}
+
+.hljs-type,
+.hljs-title,
+.hljs-section,
+.hljs-attribute,
+.hljs-quote,
+.hljs-built_in,
+.hljs-builtin-name {
+  color: #ffa;
+}
+
+.hljs-number,
+.hljs-symbol,
+.hljs-bullet {
+  color: #d36363;
+}
+
+.hljs-keyword,
+.hljs-selector-tag,
+.hljs-literal {
+  color: #fcc28c;
+}
+
+.hljs-comment,
+.hljs-deletion,
+.hljs-code {
+  color: #888;
+}
+
+.hljs-regexp,
+.hljs-link {
+  color: #c6b4f0;
+}
+
+.hljs-meta {
+  color: #fc9b9b;
+}
+
+.hljs-deletion {
+  background-color: #fc9b9b;
+  color: #333;
+}
+
+.hljs-addition {
+  background-color: #a2fca2;
+  color: #333;
+}
+
+.hljs a {
+  color: inherit;
+}
+
+.hljs a:focus,
+.hljs a:hover {
+  color: inherit;
+  text-decoration: underline;
+}

data/web/public/css/highlight/androidstudio.css

@@ -0,0 +1,66 @@
+/*
+Date: 24 Fev 2015
+Author: Pedro Oliveira <kanytu@gmail . com>
+*/
+
+.hljs {
+  color: #a9b7c6;
+  background: #282b2e;
+  display: block;
+  overflow-x: auto;
+  padding: 0.5em;
+}
+
+.hljs-number,
+.hljs-literal,
+.hljs-symbol,
+.hljs-bullet {
+  color: #6897BB;
+}
+
+.hljs-keyword,
+.hljs-selector-tag,
+.hljs-deletion {
+  color: #cc7832;
+}
+
+.hljs-variable,
+.hljs-template-variable,
+.hljs-link {
+  color: #629755;
+}
+
+.hljs-comment,
+.hljs-quote {
+  color: #808080;
+}
+
+.hljs-meta {
+  color: #bbb529;
+}
+
+.hljs-string,
+.hljs-attribute,
+.hljs-addition {
+  color: #6A8759;
+}
+
+.hljs-section,
+.hljs-title,
+.hljs-type {
+  color: #ffc66d;
+}
+
+.hljs-name,
+.hljs-selector-id,
+.hljs-selector-class {
+  color: #e8bf6a;
+}
+
+.hljs-emphasis {
+  font-style: italic;
+}
+
+.hljs-strong {
+  font-weight: bold;
+}