minimum-term 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c8b2676a106025dc8b1940e68c3c711b82c77fda
-  data.tar.gz: 562cea8babc12813ac818aaa140ec5df1d24e865
+  metadata.gz: 30209807ad2ee5a4eaf45521202334f1eca06c5c
+  data.tar.gz: 568caddb9d7f929e9dfba7b6b27b2840c36ad302
 SHA512:
-  metadata.gz: 8b3072fecfb406b52f68f26d1085496cb33fc09a07dc64c42ca73d904c6576bf70efb8d92bb50af1807f5d7696fe1400874dac9a830aedc7bf9d137bc1c95167
-  data.tar.gz: d6621d9603a127b7b50169f258f22512f794232e40cd8c6daa751c00d8ad2ed30e2676ccd0164387c5e3aa78587a7228db132bbd122f25089847e9935a1f847f
+  metadata.gz: 0cb4f3aa6c7f29d4a2f05f82a961a298943801a528da3915e77d7fd1fc5ab85a514427da879520b1d6e844457b91f6fb7f61017feb43f898d0e0d8648f145f97
+  data.tar.gz: d782d81469c340aa3cd3016b4e83041eaf45f3ff1d14201471a7aec1ab3d696f4ec83490cf82bc75aa0c08e4882b752c20dc2c00fdf55659a4d3f3885e66ecdf

data/.gitignore

@@ -7,3 +7,4 @@ gems.tags
 coverage
 **/*.gem
 Gemfile.lock
+tmp/

data/README.markdown

@@ -1,41 +1,26 @@
+[![Circle CI](https://circleci.com/gh/moviepilot/minimum-term/tree/master.svg?style=svg)](https://circleci.com/gh/moviepilot/minimum-term/tree/master) [![Coverage Status](https://coveralls.io/repos/moviepilot/minimum-term/badge.svg?branch=master&service=github)](https://coveralls.io/github/moviepilot/minimum-term?branch=master) [![Code Climate](https://codeclimate.com/github/moviepilot/minimum-term/badges/gpa.svg)](https://codeclimate.com/github/moviepilot/minimum-term)
 # Minimum term
 
-This shall be a framework so that in each of our services one can define what messages it publishes and what messages it consumes. That way when changing what one service publishes or consumes, one can immediately see the effects on our other services.
+This gem can:
 
+- convert MSON to JSON Schema files
+- read a directory which contains one directory per service
+- read a publish.mson and a consume.mson from each service
+- build a model of your infrastructure knowing
+  - which services publishes what to which other service
+  - which service consumes what from which other service
+  - if all services consume and publish conforming to their contracts.
 
-## Prerequesites
+You likely don't want to use it on its own but head on over to the [Old Maid](https://github.com/moviepilot/old-maid) gem which explains things in more detail. If you're just looking for ONE way to transform MSON files into JSON Schema, read on:
 
-  - install drafter via `brew install --HEAD
-    https://raw.github.com/apiaryio/drafter/master/tools/homebrew/drafter.rb`
-  - run `bundle`
-
-## Tests and development
-  - run `guard` in a spare terminal which will run the tests,
-    install gems, and so forth
-  - run `rspec spec` to run all the tests
-  - check out  `open coverage/index.html` or `open coverage/rcov/index.html`
-  - run `bundle console` to play around with a console
-
-## Structure
-- Infrastructure
-  - Service
-    - Contracts
-      - Publish contract
-        - PublishedObjects
-      - Consume contract
-        - ConsumedObjects
-
-
-## Convert MSON to JSON Schema files
+## Getting started
 First, check out [this API Blueprint map](https://github.com/apiaryio/api-blueprint/wiki/API-Blueprint-Map) to understand how _API Blueprint_ documents are laid out:
 
 ![API Blueprint map](https://raw.githubusercontent.com/apiaryio/api-blueprint/master/assets/map.png)
 
 You can see that their structure covers a full API use case with resource groups, single resources, actions on those resources including requests and responses. All we want, though, is the little red top level branch called `Data structures`.
 
-In theory, we'd use a ruby gem called [RedSnow](https://github.com/apiaryio/redsnow), which has bindings to [SnowCrash](https://github.com/apiaryio/snowcrash) which parses _API Blueprints_ into an AST. Unfortunately, RedSnow ignores that red `Data structures` branch we want (SnowCrash parses it just fine).
-
-So for now, we use a command line tool called [drafter](https://github.com/apiaryio/drafter) to convert MSON into an _API Blueprint_ AST. From that AST we pic the `Data structures` entry and convert it into [JSON Schema]()s
+We're using a ruby gem called [RedSnow](https://github.com/apiaryio/redsnow), which has bindings to [SnowCrash](https://github.com/apiaryio/snowcrash) which parses _API Blueprints_ into an AST.
 
 Luckily, a rake task does all that for you. To convert all `*.mson` files in `contracts/` into `*.schema.json` files,
 
@@ -56,3 +41,23 @@ OK /home/dev/minimum-term/contracts/missing_required/consume.mson
 OK /home/dev/minimum-term/contracts/publisher/publish.mson
 /home/dev/minimum-term$
 ```
+
+## Tests and development
+  - run `bundle` once
+  - run `guard` in a spare terminal which will run the tests,
+    install gems, and so forth
+  - run `rspec spec` to run all the tests
+  - check out  `open coverage/index.html` or `open coverage/rcov/index.html`
+  - run `bundle console` to play around with a console
+
+## Structure
+
+By converting all files in a directory this gem will build up the following relationships:
+
+- Infrastructure
+  - Service
+    - Contracts
+      - Publish contract
+        - PublishedObjects
+      - Consume contract
+        - ConsumedObjects

data/circle.yml

@@ -1,5 +1,3 @@
-general:
-  build_dir: ruby
 machine:
   ruby:
     version: 2.2.1

data/lib/minimum-term/conversion.rb

@@ -2,6 +2,7 @@ require 'fileutils'
 require 'open3'
 require 'minimum-term/conversion/apiary_to_json_schema'
 require 'minimum-term/conversion/error'
+require 'redsnow'
 
 module MinimumTerm
   module Conversion
@@ -23,11 +24,10 @@ module MinimumTerm
 
       # Parse MSON to an apiary blueprint AST
       # (see https://github.com/apiaryio/api-blueprint/wiki/API-Blueprint-Map)
-      to_ast = mson_to_ast_json(filename)
-      raise Error, "Error: #{to_ast}" unless to_ast[:status] == 0
+      ast_file = mson_to_ast_json(filename)
 
       # Pluck out Data structures from it
-      data_structures = data_structures_from_blueprint_ast(to_ast[:outfile])
+      data_structures = data_structures_from_blueprint_ast(ast_file)
 
       # Generate json schema from each contained data structure
       schema = {
@@ -83,9 +83,8 @@ module MinimumTerm
       # }
       #
       data_structures.each do |data|
-        schema_data = data['content'].select{|d| d['element'] == 'object' }.first
-        id = schema_data['meta']['id']
-        json= DataStructure.new(id, schema_data, data_structure_autoscope).to_json
+        id = data['name']['literal']
+        json= DataStructure.new(id, data, data_structure_autoscope).to_json
         member = json.delete('title')
         schema['definitions'][member] = json
         schema['properties'][member] = {"$ref" => "#/definitions/#{member}"}
@@ -96,12 +95,12 @@ module MinimumTerm
       File.open(outfile, 'w'){ |f| f.puts JSON.pretty_generate(schema) }
 
       # Clean up
-      FileUtils.rm_f(to_ast[:outfile]) unless keep_intermediary_files
+      FileUtils.rm_f(ast_file) unless keep_intermediary_files
       true
     end
 
     def self.data_structures_from_blueprint_ast(filename)
-      c = JSON.parse(open(filename).read)['content'].first
+      c = JSON.parse(open(filename).read)['ast']['content'].first
       return [] unless c
       c['content']
     end
@@ -110,16 +109,24 @@ module MinimumTerm
       input = filename
       output = filename.gsub(/\.\w+$/, '.blueprint-ast.json')
 
-      cmd = "drafter -u -f json -o #{Shellwords.escape(output)} #{Shellwords.escape(input)}"
-      stdin, stdout, status = Open3.capture3(cmd)
 
-      {
-        cmd: cmd,
-        outfile: output,
-        stdin: stdin,
-        stdout: stdout,
-        status: status
-      }
+      parse_result = FFI::MemoryPointer.new :pointer
+      RedSnow::Binding.drafter_c_parse(open(input).read, 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
+
+      File.open(output, 'w'){ |f| f.puts(result)  }
+
+      output
+    ensure
+      RedSnow::Memory.free(parse_result)
     end
   end
 end

data/lib/minimum-term/conversion/data_structure.rb

@@ -26,47 +26,46 @@ module MinimumTerm
       private
 
       def add_description_to_json_schema
-        return unless @data['meta']
-        description = @data['meta']['description']
+        return unless @data['sections']
+        description = @data['sections'].select{|d| d['class'] == 'blockDescription' }.first
         return unless description
-        @schema['description'] = description.strip
+        @schema['description'] = description['content'].strip
       end
 
       def add_properties_to_json_schema
-        return unless @data['content']
-        members = @data['content'].select{|d| d['element'] == 'member' }
+        return unless @data['sections']
+        members = @data['sections'].select{|d| d['class'] == 'memberType' }.first['content'].select{|d| d['class'] == 'property' }
         members.each do |s|
           content = s['content']
-          type = content['value']['element']
+          type_definition = content['valueDefinition']['typeDefinition']
+          type = type_definition['typeSpecification']['name']
 
           spec = {}
-          name = s['content']['key']['content'].underscore
+          name = content['name']['literal'].underscore
 
           # This is either type: primimtive or $ref: reference_name
           spec.merge!(primitive_or_reference(type))
 
-          value_content = content['value']['content']
-
           # We might have a description
-          spec['description'] = s['meta']['description'] if s['meta']
+          spec['description'] = s['description']
 
           # If it's an array, we need to pluck out the item types
           if type == 'array'
-            nestedTypes = value_content.map{|d| d['element'] }.compact
+            nestedTypes = type_definition['typeSpecification']['nestedTypes']
             spec['items'] = nestedTypes.map{|t| primitive_or_reference(t) }
 
           # If it's an object, we need recursion
           elsif type == 'object'
             spec['properties'] = {}
-            value_content.select{|d| d['element'] == 'member'}.each do |data|
-              data_structure = DataStructure.new('tmp', content['value'], @scope).to_json
+            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
           end
 
           @schema['properties'][name] = spec
-          if attributes = s['attributes']
-            @schema['required'] << name if attributes['typeAttributes'].include?('required')
+          if attributes = type_definition['attributes']
+            @schema['required'] << name if attributes.include?('required')
           end
         end
       end
@@ -75,7 +74,7 @@ module MinimumTerm
         if PRIMITIVES.include?(type)
           { 'type' => type }
         else
-          { '$ref' => "#/definitions/#{self.class.scope(@scope, type)}" }
+          { '$ref' => "#/definitions/#{self.class.scope(@scope, type['literal'])}" }
         end
       end
 

data/lib/minimum-term/version.rb

@@ -1,3 +1,3 @@
 module MinimumTerm
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

data/minimum-term.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "activesupport", ["~> 4.2"]
   spec.add_runtime_dependency "rake",          ["~> 10.2"]
   spec.add_runtime_dependency "json-schema",   ["~> 2.5"]
+  spec.add_runtime_dependency "redsnow",       ["~> 0.4"]
   spec.add_runtime_dependency "colorize"
 
   spec.add_development_dependency "bundler",             ["~> 1"]
@@ -29,5 +30,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "guard-ctags-bundler", ["~> 1.4"]
   spec.add_development_dependency "guard-rspec",         ["~> 4.6"]
   spec.add_development_dependency "rspec",               ["~> 3.3"]
-  spec.add_development_dependency "simplecov-rcov",      ["~> 0.2"]
+  spec.add_development_dependency "coveralls",           ["~> 0.8"]
+  spec.add_development_dependency "codeclimate-test-reporter"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: minimum-term
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Jannis Hermanns
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: redsnow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: colorize
   requirement: !ruby/object:Gem::Requirement
@@ -137,19 +151,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.3'
 - !ruby/object:Gem::Dependency
-  name: simplecov-rcov
+  name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Specify which objects your services publish or consume in MSON (markdown)
   and let this gem validate these contracts.
 email:
@@ -218,3 +246,4 @@ signing_key:
 specification_version: 4
 summary: Markdown publish/consume contract parser and validator
 test_files: []
+has_rdoc: