lacerda 1.0.0.beta1 → 1.0.0.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ba190f9b01d30f9afeb11e942c37982a3dd08ab4
-  data.tar.gz: 58a84ea79e3ee495ca67066f7ca7ffa7a5b5f68d
+  metadata.gz: e35159525996db21a172b54b47eb0d5f9c1e8c4f
+  data.tar.gz: 79cf8de3685ca9632dd67ec61f8e2e5720f0beb5
 SHA512:
-  metadata.gz: d4f7239617c9d9b789b3af53ba83d378e3bbd7de016944816f4910726f80c60e58b595a7888bd67effa8cf9f252d1d6772dc43094ef1162f7621db930812de19
-  data.tar.gz: 75401fc75ec919d81a8d998d7ecc876720f7d81d3ec332ad7649123b5d5f6615c97127effd9f0e3eb54ce618359cd5753ca2df922a94c765281c26ae75c85f2a
+  metadata.gz: 4fa08291be1572c8524b8d7d0c1995335ede5199821ed25eb56584a4c2381c6a996c55cfb9ea446bb0671d8628c32bb145ed0fafe73b76fcf69d0ab79c6e1a21
+  data.tar.gz: 1278693d32b1e496f5c361a5c27306a85af33559f6aefb3daf1e9c7e6f5ce878cad62eb6d01c19f611bac741ff174bd5635a2426193087476b17a6302d3d4761

data/CHANGELOG.markdown

@@ -1,3 +1,9 @@
+# 1.0.0
+- Disallow additional properties
+- Replace redsnow with lounge_lizard
+- Missing definitions raise errors now
+- Multitype arrays support
+
 # 0.14.6
 - relax rake dependency
 - relax tins dependency

data/lacerda.gemspec

@@ -24,9 +24,9 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency "json-schema",   ["~> 2.6.2"]
 
-  spec.add_runtime_dependency "redsnow",       ["~> 0.4.3"]
   spec.add_runtime_dependency "colorize"
   spec.add_runtime_dependency "blumquist",     ["~> 0.5"]
+  spec.add_runtime_dependency "lounge_lizard", [">= 0.1.3", "~> 0.1"]
 
   spec.add_runtime_dependency "tins"
 

data/lib/lacerda/conversion.rb

@@ -2,8 +2,8 @@ require 'fileutils'
 require 'open3'
 require 'lacerda/conversion/apiary_to_json_schema'
 require 'lacerda/conversion/error'
-require 'redsnow'
 require 'colorize'
+require 'lounge_lizard'
 
 module Lacerda
   module Conversion
@@ -31,10 +31,11 @@ module Lacerda
       # Parse MSON to an apiary blueprint AST
       # (see https://github.com/apiaryio/api-blueprint)
       ast_file = mson_to_ast_json(filename)
+      raise_parsing_errors(filename, ast_file)
 
       # Pluck out Data structures from it
       data_structures = data_structures_from_blueprint_ast(ast_file)
-
+ 
       # Generate json schema from each contained data structure
       schema = {
         "$schema"     => "http://json-schema.org/draft-04/schema#",
@@ -81,8 +82,8 @@ module Lacerda
       # }
       #
       data_structures.each do |data|
-        id = data['name']['literal']
-        json= DataStructure.new(id, data, nil).to_json
+        id = data['content'].first['meta']['id']
+        json= DataStructure.new(id, data['content'], nil).to_json
         member = json.delete('title')
         schema['definitions'][member] = json
         schema['properties'][member] = {"$ref" => "#/definitions/#{member}"}
@@ -97,10 +98,56 @@ module Lacerda
       true
     end
 
+    def self.raise_parsing_errors(mson_file, ast_file)
+      parsing_errors = ast_parsing_errors(ast_file)
+      return if parsing_errors.empty? 
+      raise Error, parsing_errors.prepend("The following errors were found in #{mson_file}:").join("\n")
+    end
+
+    # The structure is of an AST is normally something like
+    #    parseResult
+    #      - category             # (meta => api)            It seems there is always only 1
+    #        - category           # (meta => dataStructures) It seems there is always only 1
+    #            - dataStructure  #                          Bunch of data structures
+    #              . . .
+    #            - dataStructure
+    #              . . .
+    #
+    #      - annotation  # Bunch of annotations(errors/warnings
+    #        . . .
+    #      - annotation
+    #        . . .
     def self.data_structures_from_blueprint_ast(filename)
-      c = JSON.parse(open(filename).read)['ast']['content'].first
-      return [] unless c
-      c['content']
+      # The content of the ast parsing
+      elements = parse_result_contents_from_ast_file(filename)
+
+      # We keep the content of the categories only, they could be annotations otherwise
+      result_categories = elements.select do |element|
+        element['element'] == 'category'
+      end.map { |category| category['content'] }.flatten 
+
+      # From these categories we keep the 'dataStructures' category contents. 
+      # If there could be other types, no idea ¯\_(ツ)_/¯
+      data_structures_categories_contents = result_categories.select do |result_category|
+        result_category['meta']['classes'].include?('dataStructures')
+      end.map { |data_structures_category| data_structures_category['content'] }.flatten
+
+      # From the contents of 'dataStructures' categories we keep
+      # the 'dataStructure' elements. If there could be other types, 
+      # no idea ¯\_(ツ)_/¯
+      data_structures_categories_contents.select do |data_structures_content|
+        data_structures_content['element'] == 'dataStructure'
+      end
+    end
+
+    def self.ast_parsing_annotation_messages(filename, type)
+      annotations = annotations_from_blueprint_ast(filename).select do |annotation|
+        annotation['meta']['classes'].include?(type)
+      end
+      return [] if annotations.empty?
+      annotations.map do |annotation|
+        "#{type.capitalize} code #{annotation['attributes']['code']}: #{annotation['content']}"
+      end
     end
 
     def self.mson_to_ast_json(filename)
@@ -112,24 +159,26 @@ module Lacerda
       unless mson[/^\#[ ]*data[ ]+structure/i]
         mson = "# Data Structures\n#{mson}"
       end
+      result = LoungeLizard.parse(mson)
+      File.open(output, 'w'){ |f| f.puts(result)  }
+      output
+    end
 
-      parse_result = FFI::MemoryPointer.new :pointer
-      RedSnow::Binding.drafter_c_parse(mson, 0, parse_result)
-      parse_result = parse_result.get_pointer(0)
-
-      status = -1
-      result = ''
-
-      unless parse_result.null?
-        status = 0
-        result = parse_result.read_string
-      end
+    private_class_method def self.ast_parsing_errors(filename)
+      ast_parsing_annotation_messages(filename, 'error')
+    end
 
-      File.open(output, 'w'){ |f| f.puts(result)  }
+    # Reads a file containing a json representation of a blueprint AST file,
+    # and returns the content of a parse result. 
+    # It always returns an array.
+    private_class_method def self.parse_result_contents_from_ast_file(filename)
+      json = JSON.parse(open(filename).read)
+      json&.dig('content') || []
+    end
 
-      output
-    ensure
-      RedSnow::Memory.free(parse_result)
+    private_class_method def self.annotations_from_blueprint_ast(filename)
+      elements = parse_result_contents_from_ast_file(filename)
+      elements.select { |element| element['element'] == 'annotation' }
     end
   end
 end

data/lib/lacerda/conversion/data_structure.rb

@@ -1,4 +1,3 @@
-
 module Lacerda
   module Conversion
     class DataStructure
@@ -48,49 +47,53 @@ module Lacerda
       private
 
       def add_description_to_json_schema
-        return unless @data['sections']
-        description = @data['sections'].select{|d| d['class'] == 'blockDescription' }.first
+        return unless @data
+        description = @data.detect { |c| c.dig('meta', 'description') }
         return unless description
-        @schema['description'] = description['content'].strip
+        @schema['description'] = description['meta']['description'].strip
       end
 
       def add_properties_to_json_schema
-        return unless @data['sections']
-        return unless @data['sections'].length > 0
-        members = @data['sections'].select{|d| d['class'] == 'memberType' }.first['content'].select{|d| d['class'] == 'property' }
-
+        possible_members  = @data&.first&.dig('content')
+        return unless possible_members
+        # In the case that you create a nested data structure when type == 'object', 
+        # the possible_members can be just a Hash, instead of an array
+        possible_members = [possible_members] if possible_members.is_a?(Hash)
+        members = possible_members.select { |d| d['element'] == 'member' }
         # Iterate over each property
         members.each do |s|
 
           # Pluck some things out of the AST
           content = s['content']
-          type_definition = content['valueDefinition']['typeDefinition']
-          type = type_definition['typeSpecification']['name']
-          attributes = type_definition['attributes'] || []
+          type_definition = content['value']
+          type = type_definition['element']
+          attributes = s.dig('attributes', 'typeAttributes') || []
           is_required = attributes.include?('required')
 
           # Prepare the json schema fragment
           spec = {}
-          name = Lacerda.underscore(content['name']['literal'])
+          name = Lacerda.underscore(content['key']['content'])
 
           # This is either type: primimtive or a oneOf { $ref: reference_name }
           spec.merge!(primitive_or_oneOf(type, is_required))
 
           # We might have a description
-          spec['description'] = content['description']
+          spec['description'] = s.dig('meta', 'description')
 
           # If it's an array, we need to pluck out the item types
           if type == 'array'
-            nestedTypes = type_definition['typeSpecification']['nestedTypes']
+            nestedTypes = type_definition['content'].map{|vc| vc['element'] }.uniq
             spec['items'] = array_items(nestedTypes)
 
           # If it's an object, we need recursion
           elsif type == 'object'
             spec['properties'] = {}
-            content['sections'].select{|d| d['class'] == 'memberType'}.each do |data|
-              data_structure = DataStructure.new('tmp', content, @scope).to_json
-              spec['properties'].merge!(data_structure['properties'])
-            end
+            # The object has a value that will represent a data structure. the data
+            # passed to DataStructure normally is an array, but in this case if wouldn't
+            # So we have to wrap it if it's not an Array.
+            data = [content['value']] unless content['value'].is_a?(Array)
+            data_structure = DataStructure.new('tmp', [content['value']], @scope).to_json
+            spec['properties'].merge!(data_structure['properties'])
           end
 
           # Add the specification of this property to the schema
@@ -154,7 +157,7 @@ module Lacerda
       end
 
       def reference(type)
-        {'$ref' => "#/definitions/#{self.class.scope(@scope, type['literal'])}" }
+        {'$ref' => "#/definitions/#{self.class.scope(@scope, type)}" }
       end
 
       def json_schema_blueprint

data/lib/lacerda/version.rb

@@ -1,3 +1,3 @@
 module Lacerda
-  VERSION = '1.0.0.beta1'
+  VERSION = '1.0.0.beta2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lacerda
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta1
+  version: 1.0.0.beta2
 platform: ruby
 authors:
 - Jannis Hermanns
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-08 00:00:00.000000000 Z
+date: 2016-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -53,47 +53,53 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 2.6.2
 - !ruby/object:Gem::Dependency
-  name: redsnow
+  name: colorize
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.3
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.3
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: colorize
+  name: blumquist
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.5'
 - !ruby/object:Gem::Dependency
-  name: blumquist
+  name: lounge_lizard
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.3
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.3
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: tins
   requirement: !ruby/object:Gem::Requirement