matter_compiler 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a8a3595c4815e2491209423dacd1a141bd77941e
-  data.tar.gz: f1ee0b23a570bcc20de9d5971dc0704d8f0563fe
+  metadata.gz: 9153d21f8315633c3bc9d88554c1ce4e78c32787
+  data.tar.gz: ad37793f494ab8a5ed3e0a853d363fedde362f4c
 SHA512:
-  metadata.gz: d16e0c10a04234b6488813a8a889638aaa2b048f863f9028f6ab66140516aacd4531b7be7e7ce49e45ad5e65f8d2da8b338a4bd8a7fb3e2afb18e03efaaba62f
-  data.tar.gz: b9cbdaff4a66f23db7d2fd197d7214c3ff0b7b68353f90dce197dfeb68b975a1526cef25bd924bcdca65652bb922993d5a18f47ee6ac205e2ca8abfeffd38d28
+  metadata.gz: b031392eeeba9b4cb9bc0aca86259cf96d48aa7ad1d278c48c507bb7e96fcac9e1cc48631f9ec48c62c883886e6d0ce389fc58a36d048f9e4898ec75000501c2
+  data.tar.gz: 2ebb07a49858b3a01c7f74746c2f41498cdb4c0834a14836fac9302440b00f951d1bd0d33aa3810d264e0cd55dec9d6d904b38c93afb3918675b8baefc71e125

data/Gemfile.lock

@@ -10,7 +10,7 @@ GIT
 PATH
   remote: .
   specs:
-    matter_compiler (0.4.0)
+    matter_compiler (0.5.0)
 
 GEM
   remote: https://rubygems.org/

data/features/compose.feature

@@ -61,11 +61,11 @@
 
     And a file named "ast.yaml" with:
       """
-      _version: 1.0
+      _version: 2.0
       metadata:
-        FORMAT:
-          value: 1A
-      name: My API
+      - name: "FORMAT"
+        value: "1A"
+      name: "My API"
       description: "Description of *My API*.\n\n"
       resourceGroups:
       - name:
@@ -73,78 +73,73 @@
         resources:
         - name:
           description:
-          uriTemplate: /
+          uriTemplate: "/"
           model:
           parameters:
-          headers:
           actions:
           - name:
             description:
-            method: GET
+            method: "GET"
             parameters:
-            headers:
             examples:
             - name:
               description:
               requests:
               responses:
-              - name: 200
+              - name: "200"
                 description:
                 headers:
-                  Content-Type:
-                    value: text/plain
+                - name: "Content-Type"
+                  value: "text/plain"
                 body: "Hello World!\n"
                 schema:
-      - name: Red
+      - name: "Red"
         description: "Description of *Red* Group.\n\n"
         resources:
-        - name: My Resource
+        - name: "My Resource"
           description: "Description of *My Resource*\n\n"
           uriTemplate: "/myresource/{id}"
           model:
-            name: My Resource
+            name: "My Resource"
             description:
             headers:
-              Content-Type:
-                value: application/json
-              X-Header:
-                value: 1
+            - name: "Content-Type"
+              value: "application/json"
+            - name: "X-Header"
+              value: "1"
             body: "{ \"message\": \"Hello World\" }\n"
             schema: "{ \"$schema\": \"http://json-schema.org/draft-03/schema\" }\n"
           parameters:
-            id:
-              description: "Parameter `id` description.\n"
-              type: number
-              required: false
-              default: 42
-              example: 1000
-              values:
-          headers:
+          - name: "id"
+            description: "Parameter `id` description."
+            type: "number"
+            required: false
+            default: "42"
+            example: "1000"
+            values:
           actions:
-          - name: Retrieve My Resource
+          - name: "Retrieve My Resource"
             description:
-            method: GET
+            method: "GET"
             parameters:
-            headers:
             examples:
             - name:
               description:
               requests:
               responses:
-              - name: 200
+              - name: "200"
                 description:
                 headers:
-                  Content-Type:
-                    value: application/json
-                  X-Header:
-                    value: 1
+                - name: "Content-Type"
+                  value: "application/json"
+                - name: "X-Header"
+                  value: "1"
                 body: "{ \"message\": \"Hello World\" }\n"
                 schema: "{ \"$schema\": \"http://json-schema.org/draft-03/schema\" }\n"
-          - name: Create My Resource
+          - name: "Create My Resource"
             description:
-            method: POST
+            method: "POST"
             parameters:
-            headers:
             examples:
             - name:
               description:
@@ -152,28 +147,28 @@
               - name:
                 description:
                 headers:
-                  Content-Type:
-                    value: text/plain
+                - name: "Content-Type"
+                  value: "text/plain"
                 body: "Ni Hao!\n"
                 schema:
               responses:
-              - name: 204
+              - name: "204"
                 description:
                 headers:
                 body:
                 schema:
-
       """
 
     And a file named "ast.json" with:
       """
       {
-        "_version": "1.0",
-        "metadata": {
-          "FORMAT": {
+        "_version": "2.0",
+        "metadata": [
+          {
+            "name": "FORMAT",
             "value": "1A"
           }
-        },
+        ],
         "name": "My API",
         "description": "Description of *My API*.\n\n",
         "resourceGroups": [
@@ -186,15 +181,13 @@
                 "description": "",
                 "uriTemplate": "/",
                 "model": {},
-                "parameters": {},
-                "headers": {},
+                "parameters": [],
                 "actions": [
                   {
                     "name": "",
                     "description": "",
                     "method": "GET",
-                    "parameters": {},
-                    "headers": {},
+                    "parameters": [],
                     "examples": [
                       {
                         "name": "",
@@ -204,11 +197,12 @@
                           {
                             "name": "200",
                             "description": "",
-                            "headers": {
-                              "Content-Type": {
+                            "headers": [
+                              {
+                                "name": "Content-Type",
                                 "value": "text/plain"
                               }
-                            },
+                            ],
                             "body": "Hello World!\n",
                             "schema": ""
                           }
@@ -229,37 +223,38 @@
                 "description": "Description of *My Resource*\n\n",
                 "uriTemplate": "/myresource/{id}",
                 "model": {
-                    "name": "My Resource",
-                    "description": "",
-                    "headers": {
-                      "Content-Type": {
-                        "value": "application/json"
-                      },
-                      "X-Header": {
-                        "value": "1"
-                      }
+                  "name": "My Resource",
+                  "description": "",
+                  "headers": [
+                    {
+                      "name": "Content-Type",
+                      "value": "application/json"
                     },
-                    "body": "{ \"message\": \"Hello World\" }\n",
-                    "schema": "{ \"$schema\": \"http://json-schema.org/draft-03/schema\" }\n"
-                  },
-                "parameters": {
-                  "id": {
-                    "description": "Parameter `id` description.\n",
+                    {
+                      "name": "X-Header",
+                      "value": "1"
+                    }
+                  ],
+                  "body": "{ \"message\": \"Hello World\" }\n",
+                  "schema": "{ \"$schema\": \"http://json-schema.org/draft-03/schema\" }\n"
+                },
+                "parameters": [
+                  {
+                    "name": "id",
+                    "description": "Parameter `id` description.",
                     "type": "number",
                     "required": false,
                     "default": "42",
                     "example": "1000",
                     "values": []
                   }
-                },
-                "headers": {},
+                ],
                 "actions": [
                   {
                     "name": "Retrieve My Resource",
                     "description": "",
                     "method": "GET",
-                    "parameters": {},
-                    "headers": {},
+                    "parameters": [],
                     "examples": [
                       {
                         "name": "",
@@ -269,14 +264,16 @@
                           {
                             "name": "200",
                             "description": "",
-                            "headers": {
-                              "Content-Type": {
+                            "headers": [
+                              {
+                                "name": "Content-Type",
                                 "value": "application/json"
                               },
-                              "X-Header": {
+                              {
+                                "name": "X-Header",
                                 "value": "1"
                               }
-                            },
+                            ],
                             "body": "{ \"message\": \"Hello World\" }\n",
                             "schema": "{ \"$schema\": \"http://json-schema.org/draft-03/schema\" }\n"
                           }
@@ -288,8 +285,7 @@
                     "name": "Create My Resource",
                     "description": "",
                     "method": "POST",
-                    "parameters": {},
-                    "headers": {},
+                    "parameters": [],
                     "examples": [
                       {
                         "name": "",
@@ -298,11 +294,12 @@
                           {
                             "name": "",
                             "description": "",
-                            "headers": {
-                              "Content-Type": {
+                            "headers": [
+                              {
+                                "name": "Content-Type",
                                 "value": "text/plain"
                               }
-                            },
+                            ],
                             "body": "Ni Hao!\n",
                             "schema": ""
                           }
@@ -311,7 +308,7 @@
                           {
                             "name": "204",
                             "description": "",
-                            "headers": {},
+                            "headers": [],
                             "body": "",
                             "schema": ""
                           }
@@ -325,7 +322,6 @@
           }
         ]
       }
-
       """
 
   Scenario: Compose blueprint from an YAML stdin input
@@ -364,7 +360,7 @@
   Scenario: Explicitly set API Blueprint Format
     Given a file named "no-format.yaml" with:
     """
-    _version: 1.0
+    _version: 2.0
     metadata:
     name: My API
     description:
@@ -381,7 +377,7 @@
   Scenario: Attempt to compose a resource without URI template
     Given a file named "no-uri-template.yaml" with:
     """
-    _version: 1.0
+    _version: 2.0
     metadata:
     name: My API
     description:
@@ -409,8 +405,6 @@
             - name: 200
               description:
               headers:
-                Content-Type:
-                  value: text/plain
               body: "Hello World!\n"
               schema:
     """

data/lib/matter_compiler/blueprint.rb

@@ -1,40 +1,58 @@
+require 'object.rb'
+
+# The classes in this module should be 1:1 with the Snow Crash AST
+# counterparts (https://github.com/apiaryio/snowcrash/blob/master/src/Blueprint.h).
 module MatterCompiler
   
-  # The classes in this document should be 1:1 with relevant Snow Crash 
-  # counterparts (https://github.com/apiaryio/snowcrash/blob/master/src/Blueprint.h)
-  # until Matter Compiler becomes a wrapper for Snow Crash.
-
-  #
   # Blueprint AST node
+  #   Base class for API Blueprint AST nodes in Matter Compiler.
   #
+  # @abstract
   class BlueprintNode
+    
     ONE_INDENTATION_LEVEL = "    "
 
-    def initialize(hash = nil)
-      load_ast_hash!(hash) if hash
+    # Initialize the node
+    #
+    # @param ast [Array, Hash, nil] a hash or array to initialize the node with or nil
+    def initialize(ast = nil)
+      load_ast!(ast) if ast
     end
 
-    # Load AST has into block
-    def load_ast_hash!(hash)
+    # Load AST object content into node
+    #
+    # @param ast [Array, Hash] an ast object to load
+    def load_ast!(ast)
     end
 
-    # Serialize block to a Markdown string
-    # \param level ... optional requested indentation level
+    # Serialize node to a Markdown string buffer
+    #
+    # @param level [Integer, 0] requested indentation level
+    # @return [String, nil] content of the node serialized into Markdown or nil
     def serialize(level = 0)
     end
   end
 
+  # Blueprint AST node with name and description associated
+  # 
+  # @attr name [String] name of the node
+  # @attr description [String] description of the node
   #
-  # Named Blueprint AST node
-  #
+  # @abstract
   class NamedBlueprintNode < BlueprintNode
-    def load_ast_hash!(hash)
-      @name = hash[:name]
-      @description = hash[:description]
+
+    attr_accessor :name
+    attr_accessor :description
+
+    def load_ast!(ast)
+      @name = ast[:name]
+      @description = ast[:description]
     end
 
-    # Ensure a description serialization
-    # ends with two newlines.
+    # Ensure the input string buffer ends with two newlines.
+    #
+    # @param buffer [String] a buffer to check 
+    #   If the buffer does not ends with two newlines the newlines are added.
     def ensure_description_newlines(buffer)
       return if description.blank?
 
@@ -46,27 +64,28 @@ module MatterCompiler
     end        
   end
 
-  #
-  # Key-value collection
-  #
+  # Blueprint AST node for key-value collections
+  # 
+  # @abstract
+  # @attr collection [Array<Hash>] array of key value hashes
   class KeyValueCollection < BlueprintNode
+    
     attr_accessor :collection
 
-    def load_ast_hash!(hash)
-      return if hash.empty?
-
+    def load_ast!(ast)
+      return if ast.empty?
       @collection = Array.new
-      hash.each do |key, value_hash|
-        @collection << Hash[key, value_hash[:value]]
+      ast.each do |item|
+        @collection << Hash[item[:name].to_sym, item[:value]]
       end
     end
 
-    # Serialize key value pairs
-    # \param  ignore_keys ... optional array of keys to NOT be serialized
+    # Serialize key value collection node to a Markdown string buffer
+    #
+    # @param ignore_keys [Array<String>] array of keys that should be ignored (skipped) during the serialization
     def serialize(level = 0, ignore_keys = nil)
       buffer = ""
       @collection.each do |hash|
-        # Skip ignored keys
         unless ignore_keys && ignore_keys.include?(hash.keys.first)
           level.times { buffer << ONE_INDENTATION_LEVEL }
           buffer << "#{hash.keys.first}: #{hash.values.first}\n"
@@ -77,70 +96,73 @@ module MatterCompiler
       buffer
     end
 
-    # Returns collection without ignored keys
-    def ignore(ignore_keys)
+    # Filter collection keys
+    # 
+    # @returns [Array<Hash>] collection without ignored keys
+    def filter_collection(ignore_keys)
       return @collection if ignore_keys.blank?
       @collection.select { |kv_item| !ignore_keys.include?(kv_item.keys.first) }
     end    
   end
 
-  #
-  # Collection of metadata
-  #
+  # Metadata collection Blueprint AST node
+  #   represents 'metadata section'
   class Metadata < KeyValueCollection
   end
 
-  #
-  # Collection of headers 
-  #
+  # Headers collection Blueprint AST node
+  #   represents 'headers section'
   class Headers < KeyValueCollection
 
+    # HTTP 'Content-Type' header
     CONTENT_TYPE_HEADER_KEY = :'Content-Type'
 
     def serialize(level = 0, ignore_keys = nil)
-      return "" if @collection.blank? || ignore(ignore_keys).blank?
+      return "" if @collection.blank? || filter_collection(ignore_keys).blank?
 
       buffer = ""
       level.times { buffer << ONE_INDENTATION_LEVEL }
       buffer << "+ Headers\n\n"
-
       buffer << super(level + 2, ignore_keys)
     end
 
-    # Returns the value of Content-Type header, if any.
+    # @return [String] the value of 'Content-type' header if present or nil
     def content_type
       content_type_header = @collection.detect { |header| header.has_key?(CONTENT_TYPE_HEADER_KEY) }
       return (content_type_header.nil?) ? nil : content_type_header[CONTENT_TYPE_HEADER_KEY]
     end
   end;
 
+  # URI parameter Blueprint AST node
+  #   represents one 'parameters section' parameter
   #
-  # One URI parameter
-  #
-  class Parameter < BlueprintNode
-    attr_accessor :name
-    attr_accessor :description
+  # @attr type [String] an arbitrary type of the parameter or nil
+  # @attr use [Symbol] parameter necessity flag, `:required` or `:optional`
+  # @attr default_value [String] default value of the parameter or nil
+  #   This is a value used when the parameter is ommited in the request.
+  # @attr example_value [String] example value of the parameter or nil
+  # @attr values [Array<String>] an enumeration of possible parameter values
+  class Parameter < NamedBlueprintNode
+
     attr_accessor :type
     attr_accessor :use
     attr_accessor :default_value
     attr_accessor :example_value
     attr_accessor :values
 
-    def initialize(name = nil, hash = nil)
-      super(hash)
-      @name = name.to_s if name
-    end
+    def load_ast!(ast)
+      super(ast)
 
-    def load_ast_hash!(hash)
-      @description = hash[:description]
-      @type = hash[:type] if hash[:type]
-      @use = (hash[:required] && hash[:required] == true) ? :required : :optional
-      @default_value = hash[:default] if hash[:default]
-      @example_value = hash[:example] if hash[:example]
+      @type = ast[:type] if ast[:type]
+      @use = (ast[:required] && ast[:required] == true) ? :required : :optional
+      @default_value = ast[:default] if ast[:default]
+      @example_value = ast[:example] if ast[:example]
       
-      unless hash[:values].blank?
+      unless ast[:values].blank?
         @values = Array.new
-        hash[:values].each { |value| @values << value }
+        ast[:values].each do |item| 
+          @values << item[:value]
+        end
       end
     end
 
@@ -209,18 +231,20 @@ module MatterCompiler
     end
   end
 
+  # Collection of URI parameters Blueprint AST node
+  #   represents 'parameters section'
   #
-  # Collection of URI parameters
-  #
+  # @attr collection [Array<Parameter>] an array of URI parameters
   class Parameters < BlueprintNode
+
     attr_accessor :collection
 
-    def load_ast_hash!(hash)
-      return if hash.empty?
+    def load_ast!(ast)
+      return if ast.empty?
 
       @collection = Array.new
-      hash.each do |key, value_hash|
-        @collection << Parameter.new(key, value_hash)
+      ast.each do |item|
+        @collection << Parameter.new(item)
       end      
     end
 
@@ -237,23 +261,27 @@ module MatterCompiler
     end
   end
 
+  # HTTP message payload Blueprint AST node
+  #   base class for 'payload sections'
   #
-  # Generic payload base class
-  #
+  # @abstract
+  # @attr parameters [Array] ignored
+  # @attr headers [Array<Headers>] array of HTTP header fields of the message or nil
+  # @attr body [String] HTTP-message body or nil
+  # @attr schema [String] HTTP-message body validation schema or nil
   class Payload < NamedBlueprintNode
-    attr_accessor :name
-    attr_accessor :description
+  
     attr_accessor :parameters
     attr_accessor :headers
     attr_accessor :body
     attr_accessor :schema
 
-    def load_ast_hash!(hash)
-      super(hash)
+    def load_ast!(ast)
+      super(ast)
 
-      @headers = Headers.new(hash[:headers]) unless hash[:headers].blank?
-      @body = hash[:body] unless hash[:body].blank?
-      @schema = hash[:schema] unless hash[:schema].blank?
+      @headers = Headers.new(ast[:headers]) unless ast[:headers].blank?
+      @body = ast[:body] unless ast[:body].blank?
+      @schema = ast[:schema] unless ast[:schema].blank?
     end
 
     def serialize
@@ -271,7 +299,7 @@ module MatterCompiler
       end
 
       unless @body.blank?
-        abbreviated_synax = (headers.blank? || headers.ignore([Headers::CONTENT_TYPE_HEADER_KEY]).blank?) \
+        abbreviated_synax = (headers.blank? || headers.filter_collection([Headers::CONTENT_TYPE_HEADER_KEY]).blank?) \
                               & description.blank? \
                               & schema.blank?
         asset_indent_level = 2
@@ -311,10 +339,12 @@ module MatterCompiler
       buffer
     end
 
-    # Serialize payload section lead-in (begin)
-    # \param section ... section keyword name 
-    # \param ignore_name ... true to ignore section's name, false otherwise
-    def serialize_lead_in(section, ignore_name = false)
+    # Serialize payaload's definition (lead-in)
+    #
+    # @param section [String] section type keyword
+    # @param ignore_name [Boolean] object to ignore section name in serialization, false otherwise
+    # @return [String] buffer with serialized section definition
+    def serialize_definition(section, ignore_name = false)
       buffer = ""
       buffer << "+ #{section}"
       buffer << " #{@name}" unless ignore_name || @name.blank? 
@@ -327,56 +357,53 @@ module MatterCompiler
     end
   end
 
-  #
-  # Model Payload
-  #
+  # Model Payload Blueprint AST node
+  #   represents 'model section'
   class Model < Payload
     def serialize
-      buffer = serialize_lead_in("Model", true)
+      buffer = serialize_definition("Model", true)
       buffer << super
     end
   end
 
-  #
-  # Request Payload
-  #
+  # Request Payload Blueprint AST node
+  #   represents 'request section'
   class Request < Payload
     def serialize
-      buffer = serialize_lead_in("Request")
+      buffer = serialize_definition("Request")
       buffer << super
     end    
   end
 
-  #
   # Response Payload
-  #
+  #   represents 'response section'
   class Response < Payload;
     def serialize
-      buffer = serialize_lead_in("Response")
+      buffer = serialize_definition("Response")
       buffer << super
     end    
   end
 
+  # Transaction example Blueprint AST node
   #
-  # Transaction Example
-  #
+  # @attr requests [Array<Request>] example request payloads
+  # @attr response [Array<Response>] example response payloads
   class TransactionExample < NamedBlueprintNode
-    attr_accessor :name
-    attr_accessor :description
+
     attr_accessor :requests
     attr_accessor :responses
 
-    def load_ast_hash!(hash)
-      super(hash)
+    def load_ast!(ast)
+      super(ast)
 
-      unless hash[:requests].blank?
+      unless ast[:requests].blank?
         @requests = Array.new
-        hash[:requests].each { |request_hash| @requests << Request.new(request_hash) }
+        ast[:requests].each { |request_ast| @requests << Request.new(request_ast) }
       end
 
-      unless hash[:responses].blank?
+      unless ast[:responses].blank?
         @responses = Array.new
-        hash[:responses].each { |response_hash| @responses << Response.new(response_hash) }
+        ast[:responses].each { |response_ast| @responses << Response.new(response_ast) }
       end
     end
 
@@ -388,27 +415,27 @@ module MatterCompiler
     end
   end
 
+  # Action Blueprint AST node
+  #   represetns 'action sction'
   #
-  # Action
-  #
+  # @attr method [String] HTTP request method or nil
+  # @attr parameters [Parameters] action-specific URI parameters or nil
+  # @attr examples [Array<TransactionExample>] action transaction examples 
   class Action < NamedBlueprintNode
+
     attr_accessor :method
-    attr_accessor :name
-    attr_accessor :description
     attr_accessor :parameters
-    attr_accessor :headers
     attr_accessor :examples
 
-    def load_ast_hash!(hash)
-      super(hash)
+    def load_ast!(ast)
+      super(ast)
 
-      @method = hash[:method]
-      @parameters = Parameters.new(hash[:parameters]) unless hash[:parameters].blank?
-      @headers = Headers.new(hash[:headers]) unless hash[:headers].blank?
+      @method = ast[:method]
+      @parameters = Parameters.new(ast[:parameters]) unless ast[:parameters].blank?
       
-      unless hash[:examples].blank?
+      unless ast[:examples].blank?
         @examples = Array.new
-        hash[:examples].each { |example_hash| @examples << TransactionExample.new(example_hash) }
+        ast[:examples].each { |example_ast| @examples << TransactionExample.new(example_ast) }
       end
     end
 
@@ -424,42 +451,42 @@ module MatterCompiler
       ensure_description_newlines(buffer)
 
       buffer << @parameters.serialize unless @parameters.nil?
-      buffer << @headers.serialize unless @headers.nil?
 
       @examples.each { |example| buffer << example.serialize } unless @examples.nil?
       buffer
     end    
   end
   
+  # Resource Blueprint AST node
+  #   represents 'resource section' 
   #
-  # Resource
-  #
+  # @attr uri_template [String] RFC 6570 URI template
+  # @attr model [Model] model payload for the resource or nil
+  # @attr parameters [Parameters] action-specific URI parameters or nil
+  # @attr actions [Array<Action>] array of resource actions or nil
   class Resource < NamedBlueprintNode
+
     attr_accessor :uri_template
-    attr_accessor :name
-    attr_accessor :description
     attr_accessor :model
     attr_accessor :parameters
-    attr_accessor :headers
     attr_accessor :actions
 
-    def load_ast_hash!(hash)
-      super(hash)
+    def load_ast!(ast)
+      super(ast)
 
-      if hash[:uriTemplate].blank? || hash[:uriTemplate][0] != '/'
+      if ast[:uriTemplate].blank? || ast[:uriTemplate][0] != '/'
         failure_message = "Invalid input: A resource is missing URI template"
-        failure_message << " ('#{hash[:name]}' resource)" unless hash[:name].blank?
+        failure_message << " ('#{ast[:name]}' resource)" unless ast[:name].blank?
         abort(failure_message);
       end
 
-      @uri_template = hash[:uriTemplate]
-      @model = Model.new(hash[:model]) unless hash[:model].blank?
-      @parameters = Parameters.new(hash[:parameters]) unless hash[:parameters].blank?
-      @headers = Headers.new(hash[:headers]) unless hash[:headers].blank?
+      @uri_template = ast[:uriTemplate]
+      @model = Model.new(ast[:model]) unless ast[:model].blank?
+      @parameters = Parameters.new(ast[:parameters]) unless ast[:parameters].blank?
       
-      unless hash[:actions].blank?
+      unless ast[:actions].blank?
         @actions = Array.new
-        hash[:actions].each { |action_hash| @actions << Action.new(action_hash) }
+        ast[:actions].each { |action_ast| @actions << Action.new(action_ast) }
       end
     end
 
@@ -476,27 +503,26 @@ module MatterCompiler
 
       buffer << @model.serialize unless @model.nil?
       buffer << @parameters.serialize unless @parameters.nil?
-      buffer << @headers.serialize unless @headers.nil?
 
       @actions.each { |action| buffer << action.serialize } unless @actions.nil?
       buffer
     end
   end
 
+  # Resource group Blueprint AST node
+  #   represents 'resource group section'
   #
-  # Resource Group
-  #
+  # @attr resources [Array<Resource>] array of resources in the group
   class ResourceGroup < NamedBlueprintNode
-    attr_accessor :name
-    attr_accessor :description
+
     attr_accessor :resources
 
-    def load_ast_hash!(hash)
-      super(hash)
+    def load_ast!(ast)
+      super(ast)
 
-      unless hash[:resources].blank?
+      unless ast[:resources].blank?
         @resources = Array.new
-        hash[:resources].each { |resource_hash| @resources << Resource.new(resource_hash) }
+        ast[:resources].each { |resource_ast| @resources << Resource.new(resource_ast) }
       end
     end
 
@@ -511,30 +537,32 @@ module MatterCompiler
     end
   end
 
+
+  # Top-level Blueprint AST node
+  #   represents 'blueprint section'
   #
-  # Blueprint
-  #
+  # @attr metadata [Metadata] tool-specific metadata collection or nil
+  # @attr resource_groups [Array<ResourceGroup>] array of blueprint resource groups
   class Blueprint < NamedBlueprintNode
+
     attr_accessor :metadata
-    attr_accessor :name
-    attr_accessor :description
     attr_accessor :resource_groups
 
     VERSION_KEY = :_version
-    SUPPORTED_VERSIONS = ["1.0"]
+    SUPPORTED_VERSIONS = ["2.0"]
 
-    def load_ast_hash!(hash)
-      super(hash)
+    def load_ast!(ast)
+      super(ast)
       
       # Load Metadata
-      unless hash[:metadata].blank?
-        @metadata = Metadata.new(hash[:metadata])
+      unless ast[:metadata].blank?
+        @metadata = Metadata.new(ast[:metadata])
       end
       
       # Load Resource Groups
-      unless hash[:resourceGroups].blank?
+      unless ast[:resourceGroups].blank?
         @resource_groups = Array.new
-        hash[:resourceGroups].each { |group_hash| @resource_groups << ResourceGroup.new(group_hash) }
+        ast[:resourceGroups].each { |group_ast| @resource_groups << ResourceGroup.new(group_ast) }
       end
     end
 

data/lib/matter_compiler/composer.rb

@@ -74,6 +74,11 @@ module MatterCompiler
 
       # Check version of the AST
       unless Blueprint::SUPPORTED_VERSIONS.include?(ast_hash[Blueprint::VERSION_KEY].to_s)
+
+        if ast_hash[Blueprint::VERSION_KEY].to_s == "1.0"
+          puts "Use matter_compiler v0.4.0 to process AST media types prior AST v2.0"
+        end
+
         abort("Invalid input: Unsupported AST version: '#{ast_hash[Blueprint::VERSION_KEY]}'\n")
       end
 

data/lib/matter_compiler/version.rb

@@ -1,3 +1,3 @@
 module MatterCompiler
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/test/action_test.rb

@@ -10,7 +10,6 @@ class ActionTest < Minitest::Test
     :description => "Dolor sit amet\n\n",
     :method => "GET",
     :parameters => ParametersTest::AST_HASH,
-    :headers => HeadersTest::AST_HASH,
     :examples => [TransactionExampleTest::AST_HASH]
   }
 
@@ -18,7 +17,7 @@ class ActionTest < Minitest::Test
 %Q{### Into Action [GET]
 Dolor sit amet
 
-#{ParametersTest::BLUEPRINT}#{HeadersTest::BLUEPRINT}#{TransactionExampleTest::BLUEPRINT}}
+#{ParametersTest::BLUEPRINT}#{TransactionExampleTest::BLUEPRINT}}
 
   def test_from_ast_hash
     action = MatterCompiler::Action.new(ActionTest::AST_HASH)
@@ -28,11 +27,7 @@ Dolor sit amet
     
     assert_instance_of MatterCompiler::Parameters, action.parameters
     assert_instance_of Array, action.parameters.collection
-    assert_equal ParametersTest::AST_HASH.keys.length, action.parameters.collection.length
-
-    assert_instance_of MatterCompiler::Headers, action.headers
-    assert_instance_of Array, action.headers.collection
-    assert_equal HeadersTest::AST_HASH.keys.length, action.headers.collection.length
+    assert_equal ParametersTest::AST_HASH.length, action.parameters.collection.length
 
     assert_instance_of Array, action.examples
     assert_equal ActionTest::AST_HASH[:examples].length, action.examples.length

data/test/blueprint_test.rb

@@ -30,8 +30,8 @@ Lorem Ipsum
 
     assert_instance_of MatterCompiler::Metadata, blueprint.metadata
     assert_instance_of Array, blueprint.metadata.collection
-    assert_equal BlueprintTest::AST_HASH[:metadata].keys.length, blueprint.metadata.collection.length
-    assert_equal BlueprintTest::AST_HASH[:metadata].keys[0], blueprint.metadata.collection[0].keys[0]
+    assert_equal BlueprintTest::AST_HASH[:metadata].length, blueprint.metadata.collection.length
+    assert_equal BlueprintTest::AST_HASH[:metadata][0][:name], blueprint.metadata.collection[0].keys[0].to_s
   end
 
   def test_serialize

data/test/headers_test.rb

@@ -2,20 +2,23 @@ require 'minitest/autorun'
 require 'matter_compiler/blueprint'
 
 class HeadersTest < Minitest::Test
-  AST_HASH = {
-    :'X-Header' => {
+  AST_HASH = [
+    {
+      :name => "X-Header",
       :value => "1"      
     },
-    :'Content-Type' => {
+    {
+      :name => "Content-Type",
       :value => "text/plain"
     }
-  }
+  ]
 
-  AST_HASH_CONTENT_ONLY = {
-    :'Content-Type' => {
+  AST_HASH_CONTENT_ONLY = [
+    {
+      :name => "Content-Type",
       :value => "text/plain"
-    }
-  }  
+    }    
+  ]
 
   BLUEPRINT = \
 %Q{+ Headers

data/test/metadata_test.rb

@@ -2,11 +2,12 @@ require 'minitest/autorun'
 require 'matter_compiler/blueprint'
 
 class MetadataTest < Minitest::Test
-  AST_HASH = {
-    :FORMAT => {
-      :value => "1A"      
+  AST_HASH = [
+    {
+      :name => "FORMAT",
+      :value => "1A"
     }
-  }
+  ]
 
   BLUEPRINT = \
 %Q{FORMAT: 1A

data/test/parameters_test.rb

@@ -2,19 +2,25 @@ require 'minitest/autorun'
 require 'matter_compiler/blueprint'
 
 class ParametersTest < Minitest::Test
-  AST_HASH = {
-    :id => {
+  AST_HASH = [
+    {
+      :name => "id",
       :description => "Lorem\nIpsum\n",
       :type => "number",
       :required => false,
       :default => "42",
       :example => "1000",
-      :values => [ "42", "1000", "1AM4646" ]
+      :values => [ 
+        { :value => "42" }, 
+        { :value => "1000"}, 
+        { :value => "1AM4646"}
+      ]
     }
-  }
+  ]
 
-  AST_HASH_MANY = {
-    :id => {
+  AST_HASH_MANY = [
+    {
+      :name => "id",
       :description => "Lorem",
       :type => nil,
       :required => true,
@@ -22,7 +28,8 @@ class ParametersTest < Minitest::Test
       :example => nil,
       :values => nil
     },
-    :search => {
+    {
+      :name => "search",
       :description => "Ipsum",
       :type => nil,
       :required => true,
@@ -30,7 +37,7 @@ class ParametersTest < Minitest::Test
       :example => nil,
       :values => nil
     }    
-  }
+  ]
 
   BLUEPRINT = \
 %Q{+ Parameters
@@ -61,17 +68,17 @@ class ParametersTest < Minitest::Test
 
     parameter = parameters.collection[0]
     assert_equal :id.to_s, parameter.name
-    assert_equal ParametersTest::AST_HASH[:id][:description], parameter.description
-    assert_equal ParametersTest::AST_HASH[:id][:type], parameter.type
+    assert_equal ParametersTest::AST_HASH[0][:description], parameter.description
+    assert_equal ParametersTest::AST_HASH[0][:type], parameter.type
     assert_equal :optional, parameter.use
-    assert_equal ParametersTest::AST_HASH[:id][:default], parameter.default_value
-    assert_equal ParametersTest::AST_HASH[:id][:example], parameter.example_value
+    assert_equal ParametersTest::AST_HASH[0][:default], parameter.default_value
+    assert_equal ParametersTest::AST_HASH[0][:example], parameter.example_value
 
     assert_instance_of Array, parameter.values
-    assert_equal ParametersTest::AST_HASH[:id][:values].length, parameter.values.length
-    assert_equal ParametersTest::AST_HASH[:id][:values][0], parameter.values[0]
-    assert_equal ParametersTest::AST_HASH[:id][:values][1], parameter.values[1]
-    assert_equal ParametersTest::AST_HASH[:id][:values][2], parameter.values[2]
+    assert_equal ParametersTest::AST_HASH[0][:values].length, parameter.values.length
+    assert_equal ParametersTest::AST_HASH[0][:values][0][:value], parameter.values[0]
+    assert_equal ParametersTest::AST_HASH[0][:values][1][:value], parameter.values[1]
+    assert_equal ParametersTest::AST_HASH[0][:values][2][:value], parameter.values[2]
   end
 
   def test_serialize

data/test/payload_test.rb

@@ -144,7 +144,7 @@ class ResponseTest < Minitest::Test
 
     assert_instance_of MatterCompiler::Headers, response.headers
     assert_instance_of Array, response.headers.collection
-    assert_equal HeadersTest::AST_HASH.keys.length, response.headers.collection.length
+    assert_equal HeadersTest::AST_HASH.length, response.headers.collection.length
 
     assert_equal ResponseTest::AST_HASH[:body], response.body
     assert_equal ResponseTest::AST_HASH[:schema], response.schema

data/test/resource_test.rb

@@ -12,7 +12,6 @@ class ResourceTest < Minitest::Test
     :uriTemplate => "/my-resource/{id}",
     :model => ModelTest::AST_HASH,
     :parameters => ParametersTest::AST_HASH,
-    :headers => HeadersTest::AST_HASH,
     :actions => [ActionTest::AST_HASH]
   }
 
@@ -20,7 +19,7 @@ class ResourceTest < Minitest::Test
 %Q{## My Resource [/my-resource/{id}]
 Lorem ipsum dolor sit amet, consectetur adipiscing elit.
 
-#{ModelTest::BLUEPRINT}#{ParametersTest::BLUEPRINT}#{HeadersTest::BLUEPRINT}#{ActionTest::BLUEPRINT}}
+#{ModelTest::BLUEPRINT}#{ParametersTest::BLUEPRINT}#{ActionTest::BLUEPRINT}}
 
   def test_from_ast_hash
     resource = MatterCompiler::Resource.new(ResourceTest::AST_HASH)
@@ -33,11 +32,7 @@ Lorem ipsum dolor sit amet, consectetur adipiscing elit.
 
     assert_instance_of MatterCompiler::Parameters, resource.parameters
     assert_instance_of Array, resource.parameters.collection
-    assert_equal ParametersTest::AST_HASH.keys.length, resource.parameters.collection.length
-
-    assert_instance_of MatterCompiler::Headers, resource.headers
-    assert_instance_of Array, resource.headers.collection
-    assert_equal HeadersTest::AST_HASH.keys.length, resource.headers.collection.length
+    assert_equal ParametersTest::AST_HASH.length, resource.parameters.collection.length
 
     assert_instance_of Array, resource.actions
     assert_equal ResourceTest::AST_HASH[:actions].length, resource.actions.length

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: matter_compiler
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Zdenek Nemec
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-13 00:00:00.000000000 Z
+date: 2014-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler