redsnow 0.1.6 → 0.2.0

data/lib/redsnow/parseresult.rb

@@ -15,13 +15,14 @@ module RedSnow
     # Supported version of Api Blueprint
     SUPPORTED_VERSIONS = ["2.0"]
 
-    # @param result_handle [FFI::Pointer]
-    def initialize(blueprint_handle, result_handle)
+    # @param report_handle [FFI::Pointer]
+    def initialize(blueprint_handle, report_handle)
 
       @ast = Blueprint.new(blueprint_handle)
-      warnings = RedSnow::Binding.sc_warnings_handler(result_handle)
+      warnings = RedSnow::Binding.sc_warnings_handler(report_handle)
       warningsSize = RedSnow::Binding.sc_warnings_size(warnings)
       @warnings = Array.new
+
       for index in 0..(warningsSize - 1) do
         sc_warning_handler = RedSnow::Binding.sc_warning_handler(warnings, index)
 
@@ -33,6 +34,7 @@ module RedSnow
         sc_location_handler = RedSnow::Binding.sc_location_handler(sc_warning_handler)
         sc_location_size = RedSnow::Binding.sc_location_size(sc_location_handler)
         warning[:location] = Array.new
+
         if sc_location_size > 0
           for index in 0..(sc_location_size - 1)
             location = Location.new(sc_location_handler, index)
@@ -42,7 +44,7 @@ module RedSnow
         @warnings << warning
       end
 
-      error_handler = RedSnow::Binding.sc_error_handler(result_handle)
+      error_handler = RedSnow::Binding.sc_error_handler(report_handle)
       @error = Hash.new
       @error[:message] = RedSnow::Binding.sc_error_message(error_handler)
       @error[:code] = RedSnow::Binding.sc_error_code(error_handler)
@@ -51,6 +53,7 @@ module RedSnow
       sc_location_handler = RedSnow::Binding.sc_location_handler(error_handler)
       sc_location_size = RedSnow::Binding.sc_location_size(sc_location_handler)
       @error[:location] = Array.new
+
       if sc_location_size > 0
         for index in 0..(sc_location_size - 1) do
           location = Location.new(sc_location_handler, index)

data/lib/redsnow/version.rb

@@ -1,4 +1,4 @@
 module RedSnow
   # Gem version
-  VERSION = "0.1.6"
+  VERSION = "0.2.0"
 end

data/test/redsnow_binding_test.rb

@@ -6,12 +6,12 @@ class RedSnowBindingTest < Test::Unit::TestCase
     should "convert API Blueprint to AST" do
 
       blueprint = FFI::MemoryPointer.new :pointer
-      result = FFI::MemoryPointer.new :pointer
+      report = FFI::MemoryPointer.new :pointer
 
-      ret = RedSnow::Binding.sc_c_parse("meta: data\nfoo:bar\n#XXXX\ndescription for it", 0, result, blueprint)
+      ret = RedSnow::Binding.sc_c_parse("meta: data\nfoo:bar\n#XXXX\ndescription for it", 0, report, blueprint)
 
       blueprint = blueprint.get_pointer(0)
-      result = result.get_pointer(0)
+      report = report.get_pointer(0)
       assert_equal "XXXX", RedSnow::Binding.sc_blueprint_name(blueprint)
 
       assert_equal "description for it", RedSnow::Binding.sc_blueprint_description(blueprint)
@@ -19,16 +19,16 @@ class RedSnowBindingTest < Test::Unit::TestCase
       meta_data_col = RedSnow::Binding.sc_metadata_collection_handle(blueprint)
       assert_equal 2, RedSnow::Binding.sc_metadata_collection_size(meta_data_col)
 
-      warnings = RedSnow::Binding.sc_warnings_handler(result)
+      warnings = RedSnow::Binding.sc_warnings_handler(report)
       assert_equal 0, RedSnow::Binding.sc_warnings_size(warnings)
 
-      error = RedSnow::Binding.sc_error_handler(result)
+      error = RedSnow::Binding.sc_error_handler(report)
       assert_equal '', RedSnow::Binding.sc_error_message(error)
       assert_equal 0, RedSnow::Binding.sc_error_code(error)
       assert_equal 0, RedSnow::Binding.sc_error_ok(error)
 
       RedSnow::Binding.sc_blueprint_free(blueprint)
-      RedSnow::Binding.sc_result_free(result)
+      RedSnow::Binding.sc_report_free(report)
 
     end
   end

data/test/redsnow_parseresult_test.rb

@@ -37,7 +37,7 @@ class RedSnowParseResultTest < Test::Unit::TestCase
 
     should "have some warning" do
       assert_equal RedSnow::WarningCodes::EmptyDefinitionWarning, @result.warnings[0][:code]
-      assert_equal "no response defined for 'GET /'", @result.warnings[0][:message]
+      assert_equal "action is missing a response", @result.warnings[0][:message]
 
       assert_equal 20, @result.warnings[0][:location][0].index
       assert_equal 9, @result.warnings[0][:location][0].length

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redsnow
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.2.0
 platform: ruby
 authors:
 - Ladislav Prskavec
@@ -144,10 +144,16 @@ files:
 - ext/snowcrash/bin/snowcrash
 - ext/snowcrash/build/Makefile
 - ext/snowcrash/build/gyp-mac-tool
+- ext/snowcrash/build/libmarkdownparser.target.mk
 - ext/snowcrash/build/libsnowcrash.target.mk
+- ext/snowcrash/build/libsundown.target.mk
+- ext/snowcrash/build/out/Release/libmarkdownparser.a
 - ext/snowcrash/build/out/Release/libsnowcrash.dylib
 - ext/snowcrash/build/out/Release/libsundown.a
 - ext/snowcrash/build/out/Release/linker.lock
+- ext/snowcrash/build/out/Release/obj.target/libmarkdownparser/ext/markdown-parser/src/ByteBuffer.o
+- ext/snowcrash/build/out/Release/obj.target/libmarkdownparser/ext/markdown-parser/src/MarkdownNode.o
+- ext/snowcrash/build/out/Release/obj.target/libmarkdownparser/ext/markdown-parser/src/MarkdownParser.o
 - ext/snowcrash/build/out/Release/obj.target/libsnowcrash/src/CBlueprint.o
 - ext/snowcrash/build/out/Release/obj.target/libsnowcrash/src/CSourceAnnotation.o
 - ext/snowcrash/build/out/Release/obj.target/libsnowcrash/src/HTTP.o
@@ -155,13 +161,24 @@ files:
 - ext/snowcrash/build/out/Release/obj.target/libsnowcrash/src/MarkdownParser.o
 - ext/snowcrash/build/out/Release/obj.target/libsnowcrash/src/Parser.o
 - ext/snowcrash/build/out/Release/obj.target/libsnowcrash/src/ParserCore.o
+- ext/snowcrash/build/out/Release/obj.target/libsnowcrash/src/Section.o
 - ext/snowcrash/build/out/Release/obj.target/libsnowcrash/src/Serialize.o
 - ext/snowcrash/build/out/Release/obj.target/libsnowcrash/src/SerializeJSON.o
 - ext/snowcrash/build/out/Release/obj.target/libsnowcrash/src/SerializeYAML.o
+- ext/snowcrash/build/out/Release/obj.target/libsnowcrash/src/Signature.o
 - ext/snowcrash/build/out/Release/obj.target/libsnowcrash/src/UriTemplateParser.o
 - ext/snowcrash/build/out/Release/obj.target/libsnowcrash/src/csnowcrash.o
 - ext/snowcrash/build/out/Release/obj.target/libsnowcrash/src/posix/RegexMatch.o
 - ext/snowcrash/build/out/Release/obj.target/libsnowcrash/src/snowcrash.o
+- ext/snowcrash/build/out/Release/obj.target/libsundown/ext/markdown-parser/ext/sundown/html/houdini_href_e.o
+- ext/snowcrash/build/out/Release/obj.target/libsundown/ext/markdown-parser/ext/sundown/html/houdini_html_e.o
+- ext/snowcrash/build/out/Release/obj.target/libsundown/ext/markdown-parser/ext/sundown/html/html.o
+- ext/snowcrash/build/out/Release/obj.target/libsundown/ext/markdown-parser/ext/sundown/html/html_smartypants.o
+- ext/snowcrash/build/out/Release/obj.target/libsundown/ext/markdown-parser/ext/sundown/src/autolink.o
+- ext/snowcrash/build/out/Release/obj.target/libsundown/ext/markdown-parser/ext/sundown/src/buffer.o
+- ext/snowcrash/build/out/Release/obj.target/libsundown/ext/markdown-parser/ext/sundown/src/markdown.o
+- ext/snowcrash/build/out/Release/obj.target/libsundown/ext/markdown-parser/ext/sundown/src/src_map.o
+- ext/snowcrash/build/out/Release/obj.target/libsundown/ext/markdown-parser/ext/sundown/src/stack.o
 - ext/snowcrash/build/out/Release/obj.target/snowcrash/src/snowcrash/snowcrash.o
 - ext/snowcrash/build/out/Release/obj.target/sundown/sundown/html/houdini_href_e.o
 - ext/snowcrash/build/out/Release/obj.target/sundown/sundown/html/houdini_html_e.o
@@ -181,54 +198,81 @@ files:
 - ext/snowcrash/config.gypi
 - ext/snowcrash/config.mk
 - ext/snowcrash/configure
+- ext/snowcrash/ext/markdown-parser/Makefile
+- ext/snowcrash/ext/markdown-parser/ext/sundown/CONTRIBUTING.md
+- ext/snowcrash/ext/markdown-parser/ext/sundown/Makefile
+- ext/snowcrash/ext/markdown-parser/ext/sundown/Makefile.win
+- ext/snowcrash/ext/markdown-parser/ext/sundown/examples/smartypants.c
+- ext/snowcrash/ext/markdown-parser/ext/sundown/examples/sundown.c
+- ext/snowcrash/ext/markdown-parser/ext/sundown/html/houdini.h
+- ext/snowcrash/ext/markdown-parser/ext/sundown/html/houdini_href_e.c
+- ext/snowcrash/ext/markdown-parser/ext/sundown/html/houdini_html_e.c
+- ext/snowcrash/ext/markdown-parser/ext/sundown/html/html.c
+- ext/snowcrash/ext/markdown-parser/ext/sundown/html/html.h
+- ext/snowcrash/ext/markdown-parser/ext/sundown/html/html_smartypants.c
+- ext/snowcrash/ext/markdown-parser/ext/sundown/html_block_names.txt
+- ext/snowcrash/ext/markdown-parser/ext/sundown/src/autolink.c
+- ext/snowcrash/ext/markdown-parser/ext/sundown/src/autolink.h
+- ext/snowcrash/ext/markdown-parser/ext/sundown/src/buffer.c
+- ext/snowcrash/ext/markdown-parser/ext/sundown/src/buffer.h
+- ext/snowcrash/ext/markdown-parser/ext/sundown/src/html_blocks.h
+- ext/snowcrash/ext/markdown-parser/ext/sundown/src/markdown.c
+- ext/snowcrash/ext/markdown-parser/ext/sundown/src/markdown.h
+- ext/snowcrash/ext/markdown-parser/ext/sundown/src/src_map.c
+- ext/snowcrash/ext/markdown-parser/ext/sundown/src/src_map.h
+- ext/snowcrash/ext/markdown-parser/ext/sundown/src/stack.c
+- ext/snowcrash/ext/markdown-parser/ext/sundown/src/stack.h
+- ext/snowcrash/ext/markdown-parser/ext/sundown/sundown.def
+- ext/snowcrash/ext/markdown-parser/msvc/markdown/markdown.vcproj
+- ext/snowcrash/ext/markdown-parser/msvc/msvc.sln
+- ext/snowcrash/ext/markdown-parser/msvc/sundown/sundown.vcproj
+- ext/snowcrash/ext/markdown-parser/src/ByteBuffer.cc
+- ext/snowcrash/ext/markdown-parser/src/ByteBuffer.h
+- ext/snowcrash/ext/markdown-parser/src/MarkdownNode.cc
+- ext/snowcrash/ext/markdown-parser/src/MarkdownNode.h
+- ext/snowcrash/ext/markdown-parser/src/MarkdownParser.cc
+- ext/snowcrash/ext/markdown-parser/src/MarkdownParser.h
 - ext/snowcrash/provisioning.sh
 - ext/snowcrash/snowcrash.gyp
 - ext/snowcrash/src/ActionParser.h
 - ext/snowcrash/src/AssetParser.h
-- ext/snowcrash/src/BlockUtility.h
 - ext/snowcrash/src/Blueprint.h
 - ext/snowcrash/src/BlueprintParser.h
-- ext/snowcrash/src/BlueprintParserCore.h
-- ext/snowcrash/src/BlueprintSection.h
 - ext/snowcrash/src/BlueprintUtility.h
 - ext/snowcrash/src/CBlueprint.cc
 - ext/snowcrash/src/CBlueprint.h
 - ext/snowcrash/src/CSourceAnnotation.cc
 - ext/snowcrash/src/CSourceAnnotation.h
 - ext/snowcrash/src/CodeBlockUtility.h
-- ext/snowcrash/src/DescriptionSectionUtility.h
 - ext/snowcrash/src/HTTP.cc
 - ext/snowcrash/src/HTTP.h
-- ext/snowcrash/src/HeaderParser.h
-- ext/snowcrash/src/ListBlockUtility.h
-- ext/snowcrash/src/ListUtility.h
-- ext/snowcrash/src/MarkdownBlock.cc
-- ext/snowcrash/src/MarkdownBlock.h
-- ext/snowcrash/src/MarkdownParser.cc
-- ext/snowcrash/src/MarkdownParser.h
-- ext/snowcrash/src/ParameterDefinitonParser.h
+- ext/snowcrash/src/HeadersParser.h
+- ext/snowcrash/src/ParameterParser.h
 - ext/snowcrash/src/ParametersParser.h
-- ext/snowcrash/src/Parser.cc
-- ext/snowcrash/src/Parser.h
-- ext/snowcrash/src/ParserCore.cc
-- ext/snowcrash/src/ParserCore.h
 - ext/snowcrash/src/PayloadParser.h
 - ext/snowcrash/src/Platform.h
 - ext/snowcrash/src/RegexMatch.h
 - ext/snowcrash/src/ResourceGroupParser.h
 - ext/snowcrash/src/ResourceParser.h
-- ext/snowcrash/src/SectionUtility.h
+- ext/snowcrash/src/Section.cc
+- ext/snowcrash/src/Section.h
+- ext/snowcrash/src/SectionParser.h
+- ext/snowcrash/src/SectionParserData.h
+- ext/snowcrash/src/SectionProcessor.h
 - ext/snowcrash/src/Serialize.cc
 - ext/snowcrash/src/Serialize.h
 - ext/snowcrash/src/SerializeJSON.cc
 - ext/snowcrash/src/SerializeJSON.h
 - ext/snowcrash/src/SerializeYAML.cc
 - ext/snowcrash/src/SerializeYAML.h
+- ext/snowcrash/src/Signature.cc
+- ext/snowcrash/src/Signature.h
 - ext/snowcrash/src/SourceAnnotation.h
 - ext/snowcrash/src/StringUtility.h
 - ext/snowcrash/src/SymbolTable.h
 - ext/snowcrash/src/UriTemplateParser.cc
 - ext/snowcrash/src/UriTemplateParser.h
+- ext/snowcrash/src/ValuesParser.h
 - ext/snowcrash/src/Version.h
 - ext/snowcrash/src/csnowcrash.cc
 - ext/snowcrash/src/csnowcrash.h
@@ -237,30 +281,6 @@ files:
 - ext/snowcrash/src/snowcrash.h
 - ext/snowcrash/src/snowcrash/snowcrash.cc
 - ext/snowcrash/src/win/RegexMatch.cc
-- ext/snowcrash/sundown/CONTRIBUTING.md
-- ext/snowcrash/sundown/Makefile
-- ext/snowcrash/sundown/Makefile.win
-- ext/snowcrash/sundown/examples/smartypants.c
-- ext/snowcrash/sundown/examples/sundown.c
-- ext/snowcrash/sundown/html/houdini.h
-- ext/snowcrash/sundown/html/houdini_href_e.c
-- ext/snowcrash/sundown/html/houdini_html_e.c
-- ext/snowcrash/sundown/html/html.c
-- ext/snowcrash/sundown/html/html.h
-- ext/snowcrash/sundown/html/html_smartypants.c
-- ext/snowcrash/sundown/html_block_names.txt
-- ext/snowcrash/sundown/src/autolink.c
-- ext/snowcrash/sundown/src/autolink.h
-- ext/snowcrash/sundown/src/buffer.c
-- ext/snowcrash/sundown/src/buffer.h
-- ext/snowcrash/sundown/src/html_blocks.h
-- ext/snowcrash/sundown/src/markdown.c
-- ext/snowcrash/sundown/src/markdown.h
-- ext/snowcrash/sundown/src/src_map.c
-- ext/snowcrash/sundown/src/src_map.h
-- ext/snowcrash/sundown/src/stack.c
-- ext/snowcrash/sundown/src/stack.h
-- ext/snowcrash/sundown/sundown.def
 - ext/snowcrash/tools/gyp/AUTHORS
 - ext/snowcrash/tools/gyp/DEPS
 - ext/snowcrash/tools/gyp/OWNERS

data/ext/snowcrash/src/BlockUtility.h

@@ -1,186 +0,0 @@
-//
-//  BlockUtility.h
-//  snowcrash
-//
-//  Created by Zdenek Nemec on 11/11/13.
-//  Copyright (c) 2013 Apiary Inc. All rights reserved.
-//
-
-#ifndef SNOWCRASH_BLOCKUTILITY_H
-#define SNOWCRASH_BLOCKUTILITY_H
-
-#include "BlueprintSection.h"
-#include "StringUtility.h"
-
-namespace snowcrash {
-    
-    /**
-     *  \brief  Skip to the matching closing block.
-     *  \param  begin   Begin of the section inside a block buffer.
-     *  \param  end     End of the block buffer.
-     *  \param  sectionBegin    A %MarkdownBlockType of the beginning.
-     *  \param  sectionEnd      A %MarkdownBlockType of the end.
-     *  \return An iterator pointing to the end of the section.
-     *
-     *  Advances iterator from the begin of a section to the end
-     *  of a section at the same nesting level.
-     */
-    FORCEINLINE BlockIterator SkipToClosingBlock(const BlockIterator& begin,
-                                                 const BlockIterator& end,
-                                                 MarkdownBlockType sectionBegin,
-                                                 MarkdownBlockType sectionEnd) {
-        
-        BlockIterator currentBlock = begin;
-        if (currentBlock->type == sectionBegin) {
-            int level = 1;
-            ++currentBlock;
-            while (currentBlock != end && level) {
-                if (currentBlock->type == sectionBegin)
-                    ++level;
-                
-                if (currentBlock->type == sectionEnd)
-                    --level;
-                
-                if (level)
-                    ++currentBlock;
-            }
-        }
-        
-        return currentBlock;
-    }
-    
-    /**
-     *  \brief  Parse one line of raw `key:value` data.
-     *  \param  line    A line to parse.
-     *  \param  keyValuePair    The output buffer to place the parsed data into.
-     *  \return True on success, false otherwise.
-     */
-    FORCEINLINE bool KeyValueFromLine(const std::string& line,
-                                      KeyValuePair& keyValuePair) {
-        
-        std::vector<std::string> rawMetadata = SplitOnFirst(line, ':');
-        if (rawMetadata.size() != 2)
-            return false;
-        
-        keyValuePair = std::make_pair(rawMetadata[0], rawMetadata[1]);
-        TrimString(keyValuePair.first);
-        TrimString(keyValuePair.second);
-        
-        return (!keyValuePair.first.empty() && !keyValuePair.second.empty());
-    }
-    
-    /**
-     *  \brief  Construct unexpected block error message for given block.
-     *  \param  section A section being parsed.
-     *  \param  cue     Cursor to the unexpected markdown block.
-     *  \param  sourceData  Source data byte buffer.
-     *  \return An Error with description relevant to the type of the unexpected block.
-     *
-     *  This function 
-     */
-    FORCEINLINE Error UnexpectedBlockError(const BlueprintSection& section,
-                                           const BlockIterator& cur,
-                                           const SourceData& sourceData) {
-        
-        
-        std::stringstream ss;
-        ss << "unexpected " << BlockName(cur->type) << " block";
-        
-        if (section.hasParent()) {
-            
-            switch (section.parent().type) {
-
-                // Top-level section
-                case UndefinedSectionType:
-                    ss << ", expected a group, resource or an action definition, e.g. ";
-                    ss << "'# Group <name>', '# <resource name> [<URI>]' or '# <HTTP method> <URI>'";
-                    break;
-
-                // TODO: other sections
-                    
-                default:
-                    break;
-            }
-        }
-        
-        return Error(ss.str(),
-                     BusinessError,
-                     MapSourceDataBlock(cur->sourceMap, sourceData));
-    }
-    
-    
-    /**
-     *  \brief  Retrieves source code character map for a markdown block.
-     *  \param  cur         A block to retrieve the characters map for.
-     *  \param  fallback    Alternative block if %cur map source does not exists.
-     *  \param  bounds      Boundaries of the %cur and %fallback container.
-     *  \param  sourceData  Source data to map.
-     *  \returns            Character map for given markdown block or its alternative block,
-     *                      if exists. Empty source character map otherwise.
-     */
-    FORCEINLINE SourceCharactersBlock CharacterMapForBlock(const BlockIterator& cur,
-                                                           const BlockIterator& fallback,
-                                                           const SectionBounds& bounds,
-                                                           const SourceData& sourceData)
-    {
-        // Try to use cursor's source map
-        if (cur != bounds.second &&
-            !cur->sourceMap.empty()) {
-            return MapSourceDataBlock(cur->sourceMap, sourceData);
-        }
-        
-        // Fallback to alternative (previous) block
-        if (fallback != bounds.second &&
-            !fallback->sourceMap.empty()) {
-            return MapSourceDataBlock(fallback->sourceMap, sourceData);
-        }
-        
-        return SourceCharactersBlock();
-    }
-    
-    /**
-     *  \brief Checks cursor validity within its container.
-     *  \param section   A section to check against.
-     *  \param cur  An iterator to be checked.
-     *  \param sourceData   Source data byte buffer.
-     *  \param result   Error result output, an error object is added in case of failed check.
-     *  \returns True if cursor appears to be valid, false otherwise.
-     */
-    FORCEINLINE bool CheckCursor(const BlueprintSection& section,
-                                 const BlockIterator& cur,
-                                 const SourceData& sourceData,
-                                 Result& result) {
-        if (cur != section.bounds.second)
-            return true;
-        
-        if (!section.hasParent() ||
-            section.parent().bounds.first->sourceMap.empty())
-            return false;
-        
-        // ERR: Sanity check
-        SourceCharactersBlock sourceBlock = CharacterMapForBlock(section.parent().bounds.first,
-                                                                 section.parent().bounds.second,
-                                                                 section.parent().bounds,
-                                                                 sourceData);
-        result.error = Error("unexpected markdown closure",
-                             ApplicationError,
-                             sourceBlock);
-        return false;
-    }
-    
-    /**
-     *  \brief Check header block for an potential ambiguous signature
-     *  \return True if a header does not contain potential ambiguous signature, false otherwise.
-     */
-    template <class T>
-    FORCEINLINE bool CheckHeaderBlock(const BlueprintSection& section,
-                                      const BlockIterator& cur,
-                                      const SourceData& sourceData,
-                                      Result& result) {
-        
-        return false;
-    }
-}
-
-
-#endif