Merge pull request #51 from apiaryio/shared/attributes-description

Attributes description

Author: pksunkara

.gitignore

@@ -21,3 +21,39 @@ node_modules/
 .cproject
 .project
 .settings
+
+# OS X and Xcode specific
+.DS_Store
+build/
+*.pbxuser
+!default.pbxuser
+*.mode1v3
+!default.mode1v3
+*.mode2v3
+!default.mode2v3
+*.perspectivev3
+!default.perspectivev3
+*.xcodeproj/*.xcworkspace
+xcuserdata
+xcshareddata
+profile
+*.moved-aside
+DerivedData
+.idea/
+
+# Generated files
+config.mk
+config.gypi
+bin/
+vendor/
+.vagrant/
+tmp/
+
+# Ruby
+.bundle/
+features/support/env-win.rb
+
+# Eclipse specific
+.cproject
+.project
+.settings

.gitmodules

@@ -1,3 +1,3 @@
-[submodule "snowcrash"]
-	path = snowcrash
-	url = https://github.com/apiaryio/snowcrash.git
+[submodule "drafter"]
+	path = drafter
+	url = https://github.com/apiaryio/drafter.git

.travis.yml

@@ -0,0 +1,23 @@
+language: node_js
+node_js:
+  - "0.12"
+  - "0.11"
+  - "0.10"
+  - "0.8"
+  - iojs
+script: "npm install && npm test"
+before_install:
+  - git submodule update --init --recursive
+  - ruby -e "\`npm i -g npm\` if '`npm -v`'<'2.0.0'"
+notifications:
+  email:
+    recipients:
+      - z@apiary.io
+    on_success: change
+    on_failure: always
+  hipchat:
+    rooms:
+      secure: "ZRKSctculEtR03uTxeUjWxQ8lDeC3v7hJJrmPS7JDGPBlzpzlJau1NHu3Zex\nkKWmKHH29t6otZ5tAWF3THDdUssk5VbIRMCpoEEVMJeHuBZijje7nwk2JZR/\ncPwNsIZ4keaAxujh9BBWC0i+PbkrTRxhrzIHTntawInL33ZQP9Q="
+    template:
+      - '%{repository}#%{build_number} (%{branch} - %{commit} : %{author}): %{message} (<a href="%{build_url}">Details</a>/<a href="%{compare_url}">Change view</a>)'
+    format: html

README.md

@@ -2,8 +2,9 @@
 
 # Protagonist
 
-[![Circle CI](https://circleci.com/gh/apiaryio/protagonist.svg?style=svg)](https://circleci.com/gh/apiaryio/protagonist)
-[![AppVeyor](https://ci.appveyor.com/api/projects/status/8ny3ffe2xf40yn22/branch/master?svg=true)](https://ci.appveyor.com/project/zdne/protagonist/branch/master)
+[![Circle CI](https://circleci.com/gh/apiaryio/protagonist.svg?style=shield)](https://circleci.com/gh/apiaryio/protagonist)
+[![AppVeyor](https://ci.appveyor.com/api/projects/status/uaa6ivk97urmoucr?svg=true)](https://ci.appveyor.com/project/Apiary/protagonist)
+
 
 
 ### API Blueprint Parser for Node.js
@@ -18,6 +19,8 @@ The best way to install Protagonist is by using its [NPM package](https://npmjs.
 $ npm install protagonist
 ```
 
+Works smoothly with node.js ~0.8.15, 0.10.x, 0.12.x and iojs v1.x.x
+
 ## Getting started
 
 ```js
@@ -47,7 +50,7 @@ will produce the following object (`result` variable):
 ```json
 {
   "ast": {
-    "_version": "2.1",
+    "_version": "3.0",
     "metadata": [],
     "name": "",
     "description": "",
@@ -110,7 +113,7 @@ will produce the following object (`result` variable):
 
 + `ast` ... This is the abstract syntax tree (AST) of the parsed blueprint.
 
-    The structure under this key is **1:1** with the [AST Blueprint serialization JSON media type v2.1](https://github.com/apiaryio/api-blueprint-ast#json-serialization) – `vnd.apiblueprint.ast.raw+json; version=2.1`.
+    The structure under this key is **1:1** with the [AST Blueprint serialization JSON media type v3.0](https://github.com/apiaryio/api-blueprint-ast#example-json-serialization) – `vnd.apiblueprint.ast.raw+json; version=3.0`.
 
 + `warnings` ... Array of the parser warnings as occurred during the parsing
     + `code` ...  Warning [group](https://github.com/apiaryio/snowcrash/blob/master/src/SourceAnnotation.h#L128) code
@@ -137,6 +140,7 @@ Protagonist uses [node-gyp](https://github.com/TooTallNate/node-gyp) build tool.
     $ git clone git://github.com/apiaryio/protagonist.git
     $ cd protagonist
     $ git submodule update --init --recursive
+    $ npm install
     ```
 
 3. Build:
@@ -150,7 +154,6 @@ Protagonist uses [node-gyp](https://github.com/TooTallNate/node-gyp) build tool.
 Inside the protagonist repository run:
 
 ```sh
-$ npm install
 $ npm test
 ```
 

binding.gyp

@@ -6,24 +6,28 @@
     {
       "target_name": "protagonist",
       "include_dirs": [
-        "./snowcrash/src",
-        "./snowcrash/ext/markdown-parser/src",
-        "./snowcrash/ext/markdown-parser/ext/sundown/src",
-        "./snowcrash/ext/markdown-parser/ext/sundown/html",
+        "drafter/src",
+        "drafter/ext/snowcrash/src",
+        "drafter/ext/snowcrash/ext/markdown-parser/src",
+        "drafter/ext/snowcrash/ext/markdown-parser/ext/sundown/src",
+        "drafter/ext/snowcrash/ext/markdown-parser/ext/sundown/html",
+        "drafter/ext/sos/src",
+        "<!(node -e \"require('nan')\")"
       ],
       "sources": [
         "src/annotation.cc",
-        "src/blueprint.cc",
-        "src/sourcemap.cc",
         "src/parse.cc",
         "src/protagonist.cc",
         "src/protagonist.h",
-        "src/result.cc"
+        "src/result.cc",
+        "src/v8_wrapper.cc"
       ],
       "dependencies": [
-        "./snowcrash/snowcrash.gyp:libsnowcrash",
-        "./snowcrash/snowcrash.gyp:libmarkdownparser",
-        "./snowcrash/snowcrash.gyp:libsundown"
+        "drafter/drafter.gyp:libdrafter",
+        "drafter/ext/snowcrash/snowcrash.gyp:libsnowcrash",
+        "drafter/ext/snowcrash/snowcrash.gyp:libmarkdownparser",
+        "drafter/ext/snowcrash/snowcrash.gyp:libsundown",
+        "drafter/drafter.gyp:libsos"
       ]
     }
   ]

common.gypi

@@ -10,7 +10,7 @@
 {
   'variables': {
     'target_arch%': 'ia32',
-    'libsnowcrash_type%': 'static_library'
+    'libdrafter_type%': 'static_library'
   },
   'target_defaults': {
     'configurations': {

drafter

@@ -1,6 +1,6 @@
 {
   "name": "protagonist",
-  "version": "0.17.2",
+  "version": "0.19.0",
   "description": "API Blueprint Parser",
   "author": "Apiary.io <support@apiary.io>",
   "main": "./build/Release/protagonist",
@@ -11,6 +11,9 @@
   "engines": {
     "node": ">=0.8.15"
   },
+  "dependencies": {
+    "nan": "~1.6.x"
+  },
   "devDependencies": {
     "coffee-script": "~1.6.0",
     "mocha": "~1.17.1",

package.json

@@ -16,48 +16,44 @@ Persistent<Function> SourceAnnotation::constructor;
 
 void SourceAnnotation::Init(Handle<Object> exports)
 {
-    HandleScope scope;
+    NanScope();
 
-    Local<FunctionTemplate> t = FunctionTemplate::New(New);
+    Local<FunctionTemplate> t = NanNew<FunctionTemplate>(New);
+    t->SetClassName(NanNew<String>("SourceAnnotation"));
     t->InstanceTemplate()->SetInternalFieldCount(1);
-    t->SetClassName(String::NewSymbol("SourceAnnotation"));
 
-    constructor = Persistent<Function>::New(t->GetFunction());
-    exports->Set(String::NewSymbol("SourceAnnotation"), constructor);
+    NanAssignPersistent<Function>(constructor, t->GetFunction());
+    exports->Set(NanNew<String>("SourceAnnotation"), t->GetFunction());
 }
 
-Handle<Value> SourceAnnotation::New(const Arguments& args)
+NAN_METHOD(SourceAnnotation::New)
 {
-    HandleScope scope;
+    NanScope();
+
     SourceAnnotation* annotation = ::new SourceAnnotation();
     annotation->Wrap(args.This());
-    return scope.Close(args.This());
-}
 
-Handle<Value> SourceAnnotation::NewInstance()
-{
-    HandleScope scope;
-    Local<Object> instance = constructor->NewInstance();
-    return scope.Close(instance);
+    NanReturnValue(args.This());
 }
 
 static Local<Object> WrapSourceCharactersRange(const mdp::CharactersRange& range)
 {
-    Local<Object> rangeObject = Object::New();
+    Local<Object> rangeObject = NanNew<Object>();
 
-    rangeObject->Set(String::NewSymbol("index"), Number::New(range.location));
-    rangeObject->Set(String::NewSymbol("length"), Number::New(range.length));
+    rangeObject->Set(NanNew<String>("index"), NanNew<Number>(range.location));
+    rangeObject->Set(NanNew<String>("length"), NanNew<Number>(range.length));
     return rangeObject;
 }
 
 Local<Object> SourceAnnotation::WrapSourceAnnotation(const snowcrash::SourceAnnotation& annotation)
 {
-    Local<Object> annotationWrap = constructor->NewInstance();
+    Local<Function> cons = NanNew<Function>(constructor);
+    Local<Object> annotationWrap = cons->NewInstance();
 
-    annotationWrap->Set(String::NewSymbol("code"), Number::New(annotation.code));
-    annotationWrap->Set(String::NewSymbol("message"), String::New(annotation.message.c_str()));
+    annotationWrap->Set(NanNew<String>("code"), NanNew<Number>(annotation.code));
+    annotationWrap->Set(NanNew<String>("message"), NanNew<String>(annotation.message.c_str()));
 
-    Local<Object> location = Array::New(annotation.location.size());
+    Local<Object> location = NanNew<Array>(annotation.location.size());
     size_t i = 0;
     for (mdp::CharactersRangeSet::const_iterator it = annotation.location.begin();
          it != annotation.location.end();
@@ -66,6 +62,6 @@ Local<Object> SourceAnnotation::WrapSourceAnnotation(const snowcrash::SourceAnno
         location->Set(i, WrapSourceCharactersRange(*it));
     }
 
-    annotationWrap->Set(String::NewSymbol("location"), location);    
+    annotationWrap->Set(NanNew<String>("location"), location);
     return annotationWrap;
 }