cabbage_doc 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 055cffe940d79679c10fcea332f7c1bc6bad9d06
-  data.tar.gz: 8721f7a7df58917bc532cf5540d1d96d0a50f47b
+  metadata.gz: 8687ddb9c4feafb097fd54ea3b603ac6138d4e25
+  data.tar.gz: 4e549353204ac6b35a41878eb62e353d5ddf33f8
 SHA512:
-  metadata.gz: 32c88f44aeca133c811f1ae80b7592eea6ed682ba80f4378355d0ce9a5e84714b30a351ac7acebbb4a42400d8bfe24f2204ebb8dabf9844acc82e030cc798852
-  data.tar.gz: ece56a88a5b0e29fd5125be604f301961e0471b52da71b1db455eaacdb48ca1b97fcf70cc684d28d476366128952ac3a7214a46b853079069beebcf5a7293c8f
+  metadata.gz: 55aebe211b945f70ffcecf9f6e9539c68168d465cee6cdcdc4f3c2e1b76775f102663df6b02ed6b402d0cbbe60ba3587040d06925ae04dd050b136b34565ab5b
+  data.tar.gz: 949cac1f4e673ec0ed97ca6acc05ee8c01c6bfd76c717370f59f5c4d9b4bf0794442efca37fca500b91872afe8c1e46a188bf13d4595d6a84cd939c9fa4d6cc2

data/lib/cabbage_doc.rb

@@ -26,6 +26,8 @@ module CabbageDoc
   autoload :Task,           'cabbage_doc/task'
   autoload :Worker,         'cabbage_doc/worker'
   autoload :Cache,          'cabbage_doc/cache'
+  autoload :Markdown,       'cabbage_doc/markdown'
+  autoload :Highlighter,    'cabbage_doc/highlighter'
 
   class << self
     def configure
@@ -36,7 +38,11 @@ module CabbageDoc
     end
 
     def glob(*args)
-      proc { Dir.glob(File.join(*args)).sort.reverse }
+      proc do
+        arr = args.first
+        arr = [args] unless arr.is_a?(Array)
+        arr.map { |segs| Dir.glob(File.join(*segs)) }.flatten.sort.reverse
+      end
     end
   end
 end

data/lib/cabbage_doc/configuration.rb

@@ -40,6 +40,9 @@ module CabbageDoc
       visibility: [VISIBILITY.first],
       cache: Cache.new,
       request: proc { |request| request.perform },
+      authentication: proc { |auth, request| },
+      confirm: proc { |tag| true },
+      templates: {},
       theme: 'github',
       examples: false,
       format_example: method(:format_example),
@@ -53,10 +56,10 @@ module CabbageDoc
 
     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
+                              asset_path auto_generate generators tags json templates confirm).freeze
     REQUIRED_ATTRIBUTES = %i(domain controllers root).freeze
     ATTRIBUTES          = (OPTIONAL_ATTRIBUTES + REQUIRED_ATTRIBUTES).freeze
-    CALLABLE_ATTRIBUTES = %i(controllers authentication request format_example).freeze
+    CALLABLE_ATTRIBUTES = %i(controllers authentication request format_example confirm).freeze
 
     attr_accessor *ATTRIBUTES 
 

data/lib/cabbage_doc/controller.rb

@@ -35,20 +35,25 @@ module CabbageDoc
     def eval(text, tag)
       return [self] unless template?
 
-      templates = []
+      templates = {}
 
-      templates += parse_templates(@path)
-      templates += parse_templates(@label)
+      templates.merge!(parse_templates(path, tag))
+      templates.merge!(parse_templates(label, tag))
+
+      yield_actions(text) do |action|
+        templates.merge!(parse_templates(action, tag))
+      end
 
       return [] unless templates.any?
 
-      count = templates.first[:values].count
+      count = templates.values.first.count
+      return [] if templates.values.any? { |v| v.count != count }
 
-      (1..count).map do |i|
+      count.times.map do |i|
         template_text = text.dup
 
-        templates.each do |template|
-          template_text.gsub!(template[:text], template[:values].shift.to_s)
+        templates.each do |text, values|
+          template_text.gsub!(text, values.shift.to_s)
         end
 
         self.class.parse(template_text, tag)
@@ -95,9 +100,9 @@ module CabbageDoc
     def parse_actions(text)
       actions = []
 
-      text.scan(/(#\s*(#{VISIBILITY_REGEXP}):\s*.*?(#{Action::METHODS_REGEXP}):.*?def\s+.*?\s*#\s*#{MARKER})/m) do
-        actions << Action.parse(parse_action($1))
-      end 
+      yield_actions(text) do |action|
+        actions << Action.parse(parse_action(action))
+      end
 
       actions.compact
     end
@@ -144,12 +149,18 @@ module CabbageDoc
       end
     end
 
+    def yield_actions(text)
+      text.scan(/(#\s*(#{VISIBILITY_REGEXP}):\s*.*?(#{Action::METHODS_REGEXP}):.*?def\s+.*?\s*#\s*#{MARKER})/m) do
+        yield $1
+      end 
+    end
+
     def actions?
       @actions.any?
     end
 
     def template?
-      @path =~ /\/{.*?,.*?}/
+      @path =~ /\/\{.*?\}/ || @label =~ /\{.*?\}/
     end
   end
 end

data/lib/cabbage_doc/highlighter.rb

@@ -0,0 +1,23 @@
+require 'rouge'
+
+module CabbageDoc
+  class Highlighter
+    attr_accessor :formatter, :lexers
+
+    def initialize(options = {})
+      self.formatter = Rouge::Formatters::HTMLLegacy.new({ css_class: 'highlight' }.merge(options))
+      self.lexers = {}
+    end
+
+    def format(text, type = 'txt')
+      formatter.format(find_lexer(text, type).lex(text))
+    end
+
+    private
+
+    def find_lexer(text, type)
+      self.lexers[type.to_sym] ||= Rouge::Lexer.guess(source: text,
+                                                      filename: "highlight.#{type}").new
+    end
+  end
+end

data/lib/cabbage_doc/markdown.rb

@@ -0,0 +1,28 @@
+require 'redcarpet'
+require 'rouge'
+require 'rouge/plugins/redcarpet'
+
+module CabbageDoc
+  module Markdown
+    class HighlightedHTML < Redcarpet::Render::HTML
+      include Rouge::Plugins::Redcarpet
+    end
+
+    class << self
+      def new
+        Redcarpet::Markdown.new(
+          HighlightedHTML.new,
+          tables: true,
+          fenced_code_blocks: true,
+          disable_indented_code_blocks: true,
+          autolink: true,
+          no_intra_emphasis: true,
+          strikethrough: true,
+          space_after_headers: true,
+          with_toc_data: true,
+          hard_wrap: true
+        )
+      end
+    end
+  end
+end

data/lib/cabbage_doc/parser.rb

@@ -34,11 +34,15 @@ module CabbageDoc
       end
     end
 
-    def parse_templates(text)
-      templates = []
+    def parse_templates(text, tag = TAG)
+      templates = {}
+
+      mappings = Configuration.instance.templates.fetch(tag.to_sym, {})
 
       text.scan(/(\{(.*?)\})/) do
-        templates << { text: $1, values: $2.split(/,/).map(&:strip) }
+        text = $1.dup
+        values = Array(mappings.fetch(text, $2.split(/,/).map(&:strip)).dup)
+        templates[text] = values
       end
 
       templates

data/lib/cabbage_doc/response.rb

@@ -24,20 +24,28 @@ module CabbageDoc
 
     def to_json
       { 
-        url: url,
-        query: params.to_query, 
-        code: code, 
-        headers: prettify(headers),
-        body: prettify(body) 
+        url: highlight(url.join),
+        query: highlight(params.to_query),
+        code: highlight(code.to_s),
+        headers: highlight(prettify(headers), :json),
+        body: highlight(prettify(body), :json)
       }.to_json
     end
 
     private
 
-    def prettify(data)
-      JSON.pretty_generate(data)
+    def highlight(text, type = :sh)
+      highlighter.format(text, type)
+    end
+
+    def highlighter
+      @_highlighter ||= Highlighter.new
+    end
+
+    def prettify(text)
+      JSON.pretty_generate(text)
     rescue
-      data.to_s
+      text.to_s
     end
 
     def convert_headers(response)

data/lib/cabbage_doc/task.rb

@@ -3,7 +3,7 @@ require 'rake/tasklib'
 
 module CabbageDoc
   class Task < Rake::TaskLib
-    attr_accessor :generators, :tags, :name, :customize
+    attr_accessor :generators, :tags, :name, :customize, :confirm
 
     def self.define
       new.tap do |instance|
@@ -19,6 +19,7 @@ module CabbageDoc
       self.tags = config.tags.dup
       self.name = :cabbagedoc
       self.customize = true
+      self.confirm = config.confirm
     end
 
     def config
@@ -58,7 +59,7 @@ module CabbageDoc
       generators.each do |type|
         desc "Generate #{type}"
         task type => :environment do
-          Generator.perform(type)
+          Generator.perform(type) if confirm.call(:all)
         end
 
         define_generators_by_tag!(type)
@@ -74,7 +75,7 @@ module CabbageDoc
         tags.each do |tag|
           desc "Generate #{type} for #{tag}"
           task tag => :environment do
-            Generator.perform(type, tag)
+            Generator.perform(type, tag) if confirm.call(tag)
           end
         end
       end

data/lib/cabbage_doc/version.rb

@@ -1,3 +1,3 @@
 module CabbageDoc
-  VERSION = "0.1.2".freeze
+  VERSION = "0.1.3".freeze
 end

data/lib/cabbage_doc/web.rb

@@ -11,6 +11,8 @@ module CabbageDoc
     ROOT = File.expand_path("../../../web", __FILE__).freeze
 
     set :root, proc {
+      Configuration.instance.validate!
+
       dir = File.join(Configuration.instance.root, 'web')
       if Dir.exists?(dir)
         dir
@@ -44,8 +46,7 @@ module CabbageDoc
       response = config.request.call(post_request) if post_request.valid?
 
       if response.is_a?(Response)
-        content_type :json
-        response.to_json
+        format_json_response(response)
       elsif post_request.valid?
         response_by_id(post_request.id)
       else

data/lib/cabbage_doc/web_helper.rb

@@ -1,5 +1,4 @@
 require 'erb'
-require 'redcarpet'
 
 module CabbageDoc
   module WebHelper
@@ -26,13 +25,12 @@ module CabbageDoc
       end
     end
 
+    def highlighter
+      @_highlighter ||= Highlighter.new
+    end
+
     def markdown
-      @_markdown ||= Redcarpet::Markdown.new(
-        Redcarpet::Render::HTML.new,
-        tables: true,
-        fenced_code_blocks: true,
-        autolink: true
-      )
+      @_markdown ||= Markdown.new
     end
 
     def eval_with_erb(text)
@@ -63,6 +61,11 @@ module CabbageDoc
       tag.to_s.capitalize
     end
 
+    def format_json_response(response)
+      content_type :json
+      response.to_json
+    end
+
     def post_request
       @_post_request ||= Request.new(request, collection)
     end
@@ -71,8 +74,7 @@ module CabbageDoc
       response = Worker.get(id)
 
       if response.is_a?(Response)
-        content_type :json
-        response.to_json
+        format_json_response(response)
       else
         status 503
         content_type :json

data/web/public/css/highlight/github.css

@@ -1,99 +1,209 @@
-/*
-
-github.com style (c) Vasily Polovnyov <vast@whiteants.net>
-
-*/
-
-.hljs {
-  display: block;
-  overflow-x: auto;
-  padding: 0.5em;
-  color: #333;
-  background: #f8f8f8;
-}
-
-.hljs-comment,
-.hljs-quote {
-  color: #998;
+.highlight table td { padding: 5px; }
+.highlight table pre { margin: 0; }
+.highlight .cm {
+  color: #999988;
   font-style: italic;
 }
-
-.hljs-keyword,
-.hljs-selector-tag,
-.hljs-subst {
-  color: #333;
+.highlight .cp {
+  color: #999999;
   font-weight: bold;
 }
-
-.hljs-number,
-.hljs-literal,
-.hljs-variable,
-.hljs-template-variable,
-.hljs-tag .hljs-attr {
-  color: #008080;
+.highlight .c1 {
+  color: #999988;
+  font-style: italic;
 }
-
-.hljs-string,
-.hljs-doctag {
-  color: #d14;
+.highlight .cs {
+  color: #999999;
+  font-weight: bold;
+  font-style: italic;
+}
+.highlight .c, .highlight .cd {
+  color: #999988;
+  font-style: italic;
+}
+.highlight .err {
+  color: #a61717;
+  background-color: #e3d2d2;
+}
+.highlight .gd {
+  color: #000000;
+  background-color: #ffdddd;
+}
+.highlight .ge {
+  color: #000000;
+  font-style: italic;
 }
-
-.hljs-title,
-.hljs-section,
-.hljs-selector-id {
-  color: #900;
+.highlight .gr {
+  color: #aa0000;
+}
+.highlight .gh {
+  color: #999999;
+}
+.highlight .gi {
+  color: #000000;
+  background-color: #ddffdd;
+}
+.highlight .go {
+  color: #888888;
+}
+.highlight .gp {
+  color: #555555;
+}
+.highlight .gs {
   font-weight: bold;
 }
-
-.hljs-subst {
-  font-weight: normal;
+.highlight .gu {
+  color: #aaaaaa;
 }
-
-.hljs-type,
-.hljs-class .hljs-title {
-  color: #458;
+.highlight .gt {
+  color: #aa0000;
+}
+.highlight .kc {
+  color: #000000;
   font-weight: bold;
 }
-
-.hljs-tag,
-.hljs-name,
-.hljs-attribute {
-  color: #000080;
-  font-weight: normal;
+.highlight .kd {
+  color: #000000;
+  font-weight: bold;
+}
+.highlight .kn {
+  color: #000000;
+  font-weight: bold;
+}
+.highlight .kp {
+  color: #000000;
+  font-weight: bold;
+}
+.highlight .kr {
+  color: #000000;
+  font-weight: bold;
+}
+.highlight .kt {
+  color: #445588;
+  font-weight: bold;
+}
+.highlight .k, .highlight .kv {
+  color: #000000;
+  font-weight: bold;
+}
+.highlight .mf {
+  color: #009999;
+}
+.highlight .mh {
+  color: #009999;
+}
+.highlight .il {
+  color: #009999;
+}
+.highlight .mi {
+  color: #009999;
+}
+.highlight .mo {
+  color: #009999;
+}
+.highlight .m, .highlight .mb, .highlight .mx {
+  color: #009999;
+}
+.highlight .sb {
+  color: #d14;
+}
+.highlight .sc {
+  color: #d14;
+}
+.highlight .sd {
+  color: #d14;
 }
-
-.hljs-regexp,
-.hljs-link {
+.highlight .s2 {
+  color: #d14;
+}
+.highlight .se {
+  color: #d14;
+}
+.highlight .sh {
+  color: #d14;
+}
+.highlight .si {
+  color: #d14;
+}
+.highlight .sx {
+  color: #d14;
+}
+.highlight .sr {
   color: #009926;
 }
-
-.hljs-symbol,
-.hljs-bullet {
+.highlight .s1 {
+  color: #d14;
+}
+.highlight .ss {
   color: #990073;
 }
-
-.hljs-built_in,
-.hljs-builtin-name {
-  color: #0086b3;
+.highlight .s {
+  color: #d14;
+}
+.highlight .na {
+  color: #008080;
+}
+.highlight .bp {
+  color: #999999;
 }
-
-.hljs-meta {
-  color: #999;
+.highlight .nb {
+  color: #0086B3;
+}
+.highlight .nc {
+  color: #445588;
   font-weight: bold;
 }
-
-.hljs-deletion {
-  background: #fdd;
+.highlight .no {
+  color: #008080;
 }
-
-.hljs-addition {
-  background: #dfd;
+.highlight .nd {
+  color: #3c5d5d;
+  font-weight: bold;
 }
-
-.hljs-emphasis {
-  font-style: italic;
+.highlight .ni {
+  color: #800080;
 }
-
-.hljs-strong {
+.highlight .ne {
+  color: #990000;
   font-weight: bold;
 }
+.highlight .nf {
+  color: #990000;
+  font-weight: bold;
+}
+.highlight .nl {
+  color: #990000;
+  font-weight: bold;
+}
+.highlight .nn {
+  color: #555555;
+}
+.highlight .nt {
+  color: #000080;
+}
+.highlight .vc {
+  color: #008080;
+}
+.highlight .vg {
+  color: #008080;
+}
+.highlight .vi {
+  color: #008080;
+}
+.highlight .nv {
+  color: #008080;
+}
+.highlight .ow {
+  color: #000000;
+  font-weight: bold;
+}
+.highlight .o {
+  color: #000000;
+  font-weight: bold;
+}
+.highlight .w {
+  color: #bbbbbb;
+}
+.highlight {
+  background-color: #f8f8f8;
+}