cabbage_doc 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 27a236fc7439566b6ea5056fcd4fb3ef08697d7e
-  data.tar.gz: f0cacbf8131c633330d0c5f08dc35bc77832a3bf
+  metadata.gz: f917cf99ef4214b287c6714f7e6d71d1a3f69b04
+  data.tar.gz: aba8fdad553277c3bfed0c2554ea3179a9f3c9d9
 SHA512:
-  metadata.gz: 8d4a620a2020a673d25bd3706582e999183e2fb269795855154afb11873daa5263f2b235ee36584ea3dac7bc134f03342781bdb29690c4356f448ba08d70b816
-  data.tar.gz: 49a35368edc2326a9c7a47838063226eb698c0baf9e80ea8917aa0dc786141411dfcbe09829e9370d5a3cc9e05631474e23bf036ca2921a578a6e8fbc7baa1fe
+  metadata.gz: 5f080b355f30ac79ec7fc630f5179876fda59ae6e872c76ce120e19723f17da0e91ab074f5fc8d7f9d898f934d4aa14987a54077744d8fe27c6fd25545b19222
+  data.tar.gz: 3da078b0c834baa3c8b0158166cb75f9029939c1782207a1f17857400d32fe56ee6e9df839482e1c70e8d877623174c3a70619beaabbdf9a43d223ef46afb3a1

data/lib/cabbage_doc.rb

@@ -1,5 +1,7 @@
 module CabbageDoc
   MARKER = ':cabbagedoc:'.freeze
+  VISIBILITY = %i(public private internal).freeze
+  VISIBILITY_REGEXP = VISIBILITY.map(&:to_s).map(&:capitalize).join('|').freeze
 
   autoload :Path,           'cabbage_doc/path'
   autoload :Singleton,      'cabbage_doc/singleton'

data/lib/cabbage_doc/action.rb

@@ -5,11 +5,12 @@ module CabbageDoc
     METHODS = %w(GET POST PUT DELETE).freeze
     METHODS_REGEXP = METHODS.join('|').freeze
 
-    attr_reader :label, :name, :description, :path, :method, :parameters, :examples
+    attr_reader :label, :name, :description, :path, :method, :parameters, :examples, :visibility
 
     def initialize
       @parameters = []
       @examples = []
+      @visibility = VISIBILITY.first
     end
 
     def parse(text)
@@ -19,6 +20,7 @@ module CabbageDoc
       @name = parse_name(text)
       @label = parse_label(text)
       @description = parse_description(text)
+      @visibility = parse_visibility(text)
 
       @parameters, @examples = parse_parameters_and_examples(text)
 
@@ -74,13 +76,22 @@ module CabbageDoc
     end
 
     def parse_label(text)
-      m = text.match(/#\s*Public:(.*?)$/)
-      m[1].strip if m
+      m = text.match(/#\s*(#{VISIBILITY_REGEXP}):(.*?)$/)
+      m[2].strip if m
     end
 
     def parse_description(text)
       m = text.match(/#\s*Description:(.*?)$/)
       m[1].strip if m
     end
+
+    def parse_visibility(text)
+      m = text.match(/#\s*(#{VISIBILITY_REGEXP}):(.*?)$/)
+      if m
+        m[1].strip.downcase.to_sym
+      else
+        VISIBILITY.first
+      end
+    end
   end
 end

data/lib/cabbage_doc/authentication.rb

@@ -20,7 +20,8 @@ module CabbageDoc
                   :path,
                   :user_agent,
                   :configurable,
-                  :verbose
+                  :verbose,
+                  :visibility
 
     def initialize
       Configuration.instance.tap do |config|
@@ -28,14 +29,19 @@ module CabbageDoc
         @scheme     = config.scheme
         @path       = config.path
         @user_agent = config.title
+        @verbose    = config.verbose
+        @visibility = config.visibility.dup
       end
 
-      @verbose = false
       @subdomains = []
       @configurable = []
       @type = :basic
     end
 
+    def visibility=(value)
+      @visibility = Array(value)
+    end
+
     def uri
       if path && path != '/'
         "#{root_uri}/#{path}"

data/lib/cabbage_doc/configuration.rb

@@ -8,12 +8,13 @@ module CabbageDoc
       scheme: 'https',
       verbose: false,
       dev: false,
+      visibility: [VISIBILITY.first],
       cache: Cache.new,
       request: proc { |request| request.perform },
       theme: 'github'
     }.freeze
 
-    OPTIONAL_ATTRIBUTES = %i(welcome path scheme title verbose authentication dev request cache theme).freeze
+    OPTIONAL_ATTRIBUTES = %i(welcome path scheme title verbose authentication dev request cache theme visibility).freeze
     REQUIRED_ATTRIBUTES = %i(domain controllers root).freeze
     ATTRIBUTES          = (OPTIONAL_ATTRIBUTES + REQUIRED_ATTRIBUTES).freeze
     CALLABLE_ATTRIBUTES = %i(controllers authentication request).freeze
@@ -30,6 +31,7 @@ module CabbageDoc
       validate_required!
       validate_callable!
       validate_root!
+      validate_visibility!
     end
 
     private
@@ -51,5 +53,12 @@ module CabbageDoc
     def validate_root!
       raise ArgumentError, "#{root} directory doesn't exist" unless Dir.exists?(root)
     end
+
+    def validate_visibility!
+      self.visibility = Array(visibility)
+      self.visibility.each do |v|
+        raise ArgumentError, "#{v} invalid visibility" unless VISIBILITY.include?(v)
+      end
+    end
   end
 end

data/lib/cabbage_doc/controller.rb

@@ -3,14 +3,15 @@ module CabbageDoc
     include Parser
     include Cloneable
 
-    attr_reader :label, :klass, :name, :path, :actions
+    attr_reader :label, :klass, :name, :path, :actions, :visibility
 
     def initialize
       @actions = []
+      @visibility = VISIBILITY.first
     end
 
     def parse(text)
-      @label, @path, @klass = parse_label_path_and_class(text)
+      @label, @path, @klass, @visibility = parse_label_path_class_and_visibility(text)
       return false unless @label && @klass
 
       @name = compose_name(klass)
@@ -67,45 +68,76 @@ module CabbageDoc
       compose_label({}, klass).downcase
     end
 
-    def parse_label_path_and_class(text)
+    def compose_visbility(metadata)
+      metadata[:visibility] || :public
+    end
+
+    def parse_label_path_class_and_visibility(text)
       klass = parse_class(text)
       return unless klass
 
       metadata = parse_metadata(text)
 
-      [compose_label(metadata, klass), compose_path(metadata, klass), klass]
+      [
+        compose_label(metadata, klass),
+        compose_path(metadata, klass),
+        klass,
+        compose_visbility(metadata)
+      ]
     end
 
     def parse_actions(text)
       actions = []
 
-      text.scan(/(#\s*Public:\s*.*?(#{Action::METHODS_REGEXP}):.*?def\s+.*?\s*#\s*#{MARKER})/m) do
-        actions << Action.parse($1.strip)
+      text.scan(/(#\s*(#{VISIBILITY_REGEXP}):\s*.*?(#{Action::METHODS_REGEXP}):.*?def\s+.*?\s*#\s*#{MARKER})/m) do
+        actions << Action.parse(parse_action($1))
       end 
 
       actions.compact
     end
 
+    def parse_action(text)
+      new_text = text.strip
+
+      if new_text.scan(/#\s*(#{VISIBILITY_REGEXP}):\s*/).size > 1
+        new_text.sub(/#\s*(#{VISIBILITY_REGEXP}):.*?#\s*(#{VISIBILITY_REGEXP}):/m, '# \2:').strip
+      else
+        new_text
+      end
+    end
+
     def parse_class(text)
       m = text.match(/class\s+(.*?)\s+?#\s+?#{MARKER}$/)
       m[1].strip.split('<').first.strip if m
     end
 
     def parse_metadata(text)
-      m = text.match(/(#\s*Public:\s*.*?class\s+.*?\s*#\s*#{MARKER})/m)
+      m = text.match(/(#\s*(#{VISIBILITY_REGEXP}):\s*.*?class\s+.*?\s*#\s*#{MARKER})/m)
       return {} unless m
 
       metadata = m[1].strip
 
       {}.tap do |hash|
-        m = metadata.match(/#\s*Public:(.*?)$/)
-        hash[:label] = m[1].strip if m
+        m = metadata.match(/#\s*(#{VISIBILITY_REGEXP}):(.*?)$/)
+        if m
+          hash[:visibility] = parse_visibility(m[1])
+          hash[:label] = m[2].strip
+        end
 
         m = metadata.match(/#\s*PATH:\s*\/(.*?)$/)
         hash[:path] = m[1].strip if m
       end
     end
 
+    def parse_visibility(text)
+      visibility = text.to_s.strip.downcase
+      if visibility.size > 0
+        visibility.to_sym
+      else
+        VISIBILITY.first
+      end
+    end
+
     def actions?
       @actions.any?
     end

data/lib/cabbage_doc/version.rb

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

data/lib/cabbage_doc/web_helper.rb

@@ -40,6 +40,14 @@ module CabbageDoc
       @_auth ||= Authentication.new(request)
     end
 
+    def visible?(o)
+      auth.visibility.include?(o.visibility)
+    end
+
+    def format_visibility(o)
+      o.visibility.to_s.capitalize if o.visibility != VISIBILITY.first
+    end
+
     def post_request
       @_post_request ||= Request.new(request, collection)
     end

data/web/public/css/application.css

@@ -49,11 +49,27 @@ a:hover
 	display: none !important; 
 }
 
+.left
+{
+  float: left;
+}
+
+.right
+{
+  float: right;
+}
+
 .clear
 {
 	clear: both;
 }
 
+.visibility
+{
+  font-style: italic;
+  float: right;
+}
+
 .application
 {
 	margin: 10px auto;
@@ -137,7 +153,6 @@ a:hover
 
 .action .subresource
 {
-	float: left;
 	line-height: 31px;
 }
 

data/web/views/action.haml

@@ -4,6 +4,7 @@
   .subresource
     %a{ href: 'javascript:void(0);' }= action.path
     %span= " : #{action.label}"
+    %span.visibility= format_visibility(action)
   .clear
   %form.hidden{ action: action.path, method: action.method }
     - if action.description

data/web/views/controller.haml

@@ -2,6 +2,9 @@
   .resource
     %a{ href: 'javascript:void(0);' }= controller.path
     %span= " : #{controller.label}"
+    %span.visibility= format_visibility(controller)
+    .clear
   .actions.hidden
     - controller.actions.each do |action|
-      = haml :action, locals: { action: action }
+      - if visible?(action)
+        = haml :action, locals: { action: action }

data/web/views/documentation.haml

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cabbage_doc
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Mihail Szabolcs
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-03 00:00:00.000000000 Z
+date: 2016-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redcarpet
@@ -159,57 +159,24 @@ files:
 - web/public/css/highlight/arduino-light.css
 - web/public/css/highlight/arta.css
 - web/public/css/highlight/ascetic.css
-- web/public/css/highlight/atelier-cave-dark.css
-- web/public/css/highlight/atelier-cave-light.css
-- web/public/css/highlight/atelier-dune-dark.css
-- web/public/css/highlight/atelier-dune-light.css
-- web/public/css/highlight/atelier-estuary-dark.css
-- web/public/css/highlight/atelier-estuary-light.css
-- web/public/css/highlight/atelier-forest-dark.css
-- web/public/css/highlight/atelier-forest-light.css
-- web/public/css/highlight/atelier-heath-dark.css
-- web/public/css/highlight/atelier-heath-light.css
-- web/public/css/highlight/atelier-lakeside-dark.css
-- web/public/css/highlight/atelier-lakeside-light.css
-- web/public/css/highlight/atelier-plateau-dark.css
-- web/public/css/highlight/atelier-plateau-light.css
-- web/public/css/highlight/atelier-savanna-dark.css
-- web/public/css/highlight/atelier-savanna-light.css
-- web/public/css/highlight/atelier-seaside-dark.css
-- web/public/css/highlight/atelier-seaside-light.css
-- web/public/css/highlight/atelier-sulphurpool-dark.css
-- web/public/css/highlight/atelier-sulphurpool-light.css
-- web/public/css/highlight/brown-paper.css
 - web/public/css/highlight/codepen-embed.css
-- web/public/css/highlight/color-brewer.css
-- web/public/css/highlight/dark.css
 - web/public/css/highlight/darkula.css
 - web/public/css/highlight/default.css
 - web/public/css/highlight/docco.css
 - web/public/css/highlight/dracula.css
-- web/public/css/highlight/far.css
 - web/public/css/highlight/foundation.css
 - web/public/css/highlight/github-gist.css
 - web/public/css/highlight/github.css
 - web/public/css/highlight/googlecode.css
 - web/public/css/highlight/grayscale.css
-- web/public/css/highlight/gruvbox-dark.css
-- web/public/css/highlight/gruvbox-light.css
-- web/public/css/highlight/hopscotch.css
 - web/public/css/highlight/hybrid.css
 - web/public/css/highlight/idea.css
 - web/public/css/highlight/ir-black.css
-- web/public/css/highlight/kimbie.dark.css
-- web/public/css/highlight/kimbie.light.css
 - web/public/css/highlight/magula.css
 - web/public/css/highlight/mono-blue.css
 - web/public/css/highlight/monokai-sublime.css
 - web/public/css/highlight/monokai.css
 - web/public/css/highlight/obsidian.css
-- web/public/css/highlight/ocean.css
-- web/public/css/highlight/paraiso-dark.css
-- web/public/css/highlight/paraiso-light.css
-- web/public/css/highlight/pojoaque.css
 - web/public/css/highlight/purebasic.css
 - web/public/css/highlight/qtcreator_dark.css
 - web/public/css/highlight/qtcreator_light.css
@@ -219,14 +186,8 @@ files:
 - web/public/css/highlight/solarized-dark.css
 - web/public/css/highlight/solarized-light.css
 - web/public/css/highlight/sunburst.css
-- web/public/css/highlight/tomorrow-night-blue.css
-- web/public/css/highlight/tomorrow-night-bright.css
-- web/public/css/highlight/tomorrow-night-eighties.css
-- web/public/css/highlight/tomorrow-night.css
-- web/public/css/highlight/tomorrow.css
 - web/public/css/highlight/vs.css
 - web/public/css/highlight/xcode.css
-- web/public/css/highlight/xt256.css
 - web/public/css/highlight/zenburn.css
 - web/public/js/application.js
 - web/public/js/highlight.min.js

data/web/public/css/highlight/atelier-cave-dark.css

@@ -1,83 +0,0 @@
-/* Base16 Atelier Cave Dark - Theme */
-/* by Bram de Haan (http://atelierbram.github.io/syntax-highlighting/atelier-schemes/cave) */
-/* Original Base16 color scheme by Chris Kempson (https://github.com/chriskempson/base16) */
-
-/* Atelier-Cave Comment */
-.hljs-comment,
-.hljs-quote {
-  color: #7e7887;
-}
-
-/* Atelier-Cave Red */
-.hljs-variable,
-.hljs-template-variable,
-.hljs-attribute,
-.hljs-regexp,
-.hljs-link,
-.hljs-tag,
-.hljs-name,
-.hljs-selector-id,
-.hljs-selector-class {
-  color: #be4678;
-}
-
-/* Atelier-Cave Orange */
-.hljs-number,
-.hljs-meta,
-.hljs-built_in,
-.hljs-builtin-name,
-.hljs-literal,
-.hljs-type,
-.hljs-params {
-  color: #aa573c;
-}
-
-/* Atelier-Cave Green */
-.hljs-string,
-.hljs-symbol,
-.hljs-bullet {
-  color: #2a9292;
-}
-
-/* Atelier-Cave Blue */
-.hljs-title,
-.hljs-section {
-  color: #576ddb;
-}
-
-/* Atelier-Cave Purple */
-.hljs-keyword,
-.hljs-selector-tag {
-  color: #955ae7;
-}
-
-.hljs-deletion,
-.hljs-addition {
-  color: #19171c;
-  display: inline-block;
-  width: 100%;
-}
-
-.hljs-deletion {
-  background-color: #be4678;
-}
-
-.hljs-addition {
-  background-color: #2a9292;
-}
-
-.hljs {
-  display: block;
-  overflow-x: auto;
-  background: #19171c;
-  color: #8b8792;
-  padding: 0.5em;
-}
-
-.hljs-emphasis {
-  font-style: italic;
-}
-
-.hljs-strong {
-  font-weight: bold;
-}