cabbage_doc 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 07192d64517a805bfb047aa83db53300693f536b
-  data.tar.gz: cd5706e70532b54d62d70c9d55796234def32579
+  metadata.gz: 055cffe940d79679c10fcea332f7c1bc6bad9d06
+  data.tar.gz: 8721f7a7df58917bc532cf5540d1d96d0a50f47b
 SHA512:
-  metadata.gz: dd317702ce28ff77f3fa69b90663482bcf5140b379bfb9d945ba22e22ecbbfdc79df3a17de5aa91aef290b940ae1f2a6da861d99befc31db004eae21662f30f7
-  data.tar.gz: 67e4049149210bb756668167bf252060c4956e1896d3df789e0f47dee231673aaeb944aa0f29230a43616b3f5f2ef715caf003fe4d2504ac6cf3786bec3518b9
+  metadata.gz: 32c88f44aeca133c811f1ae80b7592eea6ed682ba80f4378355d0ce9a5e84714b30a351ac7acebbb4a42400d8bfe24f2204ebb8dabf9844acc82e030cc798852
+  data.tar.gz: ece56a88a5b0e29fd5125be604f301961e0471b52da71b1db455eaacdb48ca1b97fcf70cc684d28d476366128952ac3a7214a46b853079069beebcf5a7293c8f

data/lib/cabbage_doc/action.rb

@@ -4,6 +4,7 @@ module CabbageDoc
 
     METHODS = %w(GET POST PUT DELETE).freeze
     METHODS_REGEXP = METHODS.join('|').freeze
+    SECTION_REGEXP = "Parameters|Examples|#{METHODS_REGEXP}|#{VISIBILITY_REGEXP}".freeze
 
     attr_reader :label, :name, :description, :path, :method, :parameters, :examples, :visibility
 
@@ -37,22 +38,12 @@ module CabbageDoc
 
     private
 
-    # FIXME: get rid of this and optimize direct regex matches
-    def text_to_lines(text)
-      text.gsub(/\r\n?/, "\n").split(/\n/)[0..-2].map do |line|
-        line.strip!
-        line.slice!(0)
-        line.strip!
-        line if line.size > 0
-      end.compact
-    end
-
     def parse_parameters_and_examples(text)
       # FIXME: rewrite this to do a 'scan' with the right Regexp
       parameters = []
       examples = []
 
-      lines = text_to_lines(text)
+      lines = text_to_lines(text).map(&:strip).select { |line| line.size > 0 }
 
       lines.each do |line|
         if parameter = Parameter.parse(line)
@@ -81,8 +72,8 @@ module CabbageDoc
     end
 
     def parse_description(text)
-      m = text.match(/#\s*Description:(.*?)$/)
-      m[1].strip if m
+      m = text.match(/#\s*Description:\s+(.*?)(#\s*(#{SECTION_REGEXP}):|\z)/m)
+      text_to_lines(m[1]).join("\n").strip if m
     end
 
     def parse_visibility(text)
@@ -93,5 +84,12 @@ module CabbageDoc
         VISIBILITY.first
       end
     end
+
+    def text_to_lines(text)
+      text.strip.gsub(/\r\n?/, "\n").split("\n").map do |line|
+        line.sub!(/^(\s+)?#\s*/, "")
+        line if line !~ /#\s+?#{MARKER}$/
+      end.compact
+    end
   end
 end

data/lib/cabbage_doc/parameter.rb

@@ -2,7 +2,7 @@ module CabbageDoc
   class Parameter
     include Parser
 
-    TYPES = %i(numeric decimal integer string id enumeration array date time timestamp hash)
+    TYPES = %i(numeric decimal integer string id enumeration array date time timestamp hash number)
 
     attr_reader :label, :name, :type, :type_label, :default, :values, :required
 

data/lib/cabbage_doc/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cabbage_doc
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Mihail Szabolcs
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-19 00:00:00.000000000 Z
+date: 2017-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redcarpet
@@ -28,14 +28,14 @@ dependencies:
   name: haml
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 4.0.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 4.0.6
 - !ruby/object:Gem::Dependency
@@ -56,16 +56,16 @@ dependencies:
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.15.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.15.0
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -244,7 +244,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.6
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Interactive API documentation generator.