lacerda 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ff23a2681e40e382e4e01fb4ce0b67aaab1c24ce
-  data.tar.gz: 605bd530f4bc51914bbc2f6e513156e4e7eedc20
+  metadata.gz: 13bff5451aa612adedb40d0d20a26d6826796546
+  data.tar.gz: 4051b656fe279dea8381b73351b4dbc7a55d0cb8
 SHA512:
-  metadata.gz: 131589ccbb3c6ff9ada1e8498ce3836ad151eaa0cb778675086c67f23f5b3e36494c8914f7bcbf041156f4c0b49d23738ef8f6a424e186b1504fa5310fe4b9e4
-  data.tar.gz: d7d6ae3c7d5506772fe8eb787dc73365b8fa1337afc36977cf5685936007291f7aa9232da56512904bdf679e6f883cf07ee65f923959376c0a948aee35621c06
+  metadata.gz: d80147036af1a6424d731c34141d670519996363e3e1234ee5ee6e05393581bf0f07e63ebe6b883e2864851ffd83264ba4e18e26f68041b3cdeb4e385e660298
+  data.tar.gz: fb3ca9e05a706d6bae08d0461f5b6c319724120cb385af737bc25771eb8721934f950a58f76d29abdf066942b5a47e595211cacf25b785a3ff03ac9c98225674

data/CHANGELOG.markdown

@@ -1,3 +1,14 @@
+# 0.12.0 (06-Nov-15)
+- add Lacerda::Service#publishes?(object_name)
+- add Lacerda::Service#consumes?(object_name)
+- add Lacerda::Service#consumes_from?(service_name, object_name)
+- add Lacerda::Service#consume_object_from(service_name, object_name)
+- load Lacerda::VERSION
+- add missing json-schema require
+- fix a typo in the ERR_MISSING_DEFINITION error message
+- update blumquist
+- allow top level types without a publishing service prefix in consume specifications
+
 # 0.11.0 (04-Nov-15)
 - rename ConsumeContract and PublishContract to ConsumeSpecification and PublishSpecification
 - omit redundant service name in model names of publish contracts

data/Guardfile

@@ -27,14 +27,10 @@ guard 'ctags-bundler', :src_path => ["lib"] do
   watch(/^.+\.gemspec/)
 end
 
-guard :rspec, cmd: 'IGNORE_LOW_COVERAGE=1 rspec', all_on_start: true  do
+guard :rspec, cmd: 'rspec', all_on_start: true  do
   watch(%r{^spec/support/.*\.mson$}) { "spec" }
   watch(%r{^spec/support/.*\.rb$}) { "spec" }
   watch('spec/spec_helper.rb')  { "spec" }
-
-  # We could run individual specs, sure, but for now I dictate the tests
-  # are only green when we have 100% coverage, so partial runs will never
-  # succeed. Therefore, always run all the things.
   watch(%r{^(spec/.+_spec\.rb)$}) { "spec" }
   watch(%r{^lib/(.+)\.rb$})     { "spec" }
 end

data/README.md

@@ -1,4 +1,4 @@
-# Lacerda [![Circle CI](https://circleci.com/gh/moviepilot/lacerda/tree/master.svg?style=svg)](https://circleci.com/gh/moviepilot/lacerda/tree/master) [![Coverage Status](https://coveralls.io/repos/moviepilot/lacerda/badge.svg?branch=master&service=github)](https://coveralls.io/github/moviepilot/lacerda?branch=master) [![Code Climate](https://codeclimate.com/github/moviepilot/lacerda/badges/gpa.svg)](https://codeclimate.com/github/moviepilot/lacerda) [![Dependency Status](https://gemnasium.com/moviepilot/lacerda.svg)](https://gemnasium.com/moviepilot/lacerda)
+# Lacerda [![Circle CI](https://circleci.com/gh/moviepilot/lacerda/tree/master.svg?style=shield)](https://circleci.com/gh/moviepilot/lacerda/tree/master) [![Coverage Status](https://coveralls.io/repos/moviepilot/lacerda/badge.svg?branch=master&service=github)](https://coveralls.io/github/moviepilot/lacerda?branch=master) [![Code Climate](https://codeclimate.com/github/moviepilot/lacerda/badges/gpa.svg)](https://codeclimate.com/github/moviepilot/lacerda) [![Dependency Status](https://gemnasium.com/moviepilot/lacerda.svg)](https://gemnasium.com/moviepilot/lacerda) [![Gem Version](https://badge.fury.io/rb/lacerda.svg)](https://badge.fury.io/rb/lacerda)
 
 ![](https://dl.dropboxusercontent.com/u/1953503/lacerda.jpg)
 > «No, no -- we have to go on. We need total coverage.»<sup>[1](#references)</sup>
@@ -13,18 +13,15 @@ This gem can:
   - which service consumes what from which other service
   - if all services consume and publish conforming to their contracts.
 
-You likely don't want to use it on its own but head on over to the [Zeta](https://github.com/moviepilot/zeta) gem which explains things in more detail. If you're just looking for ONE way to transform MSON files into JSON Schema, read on:
+You likely **don't want to use it on its own** but integrate your infrastructure via
 
-## 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:
+⏩[Zeta](https://github.com/moviepilot/zeta) ⏪
 
-![API Blueprint map](https://raw.githubusercontent.com/apiaryio/api-blueprint/master/assets/map.png)
+. Click the link, it will explains things in more detail. If you're just looking for *one* way to transform MSON files into JSON Schema, read on:
 
-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`.
-
-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,
+## MSON to JSON schema
+*Lacerda* offers a rake task that converts MSON files into JSON schemas.
+To convert all `*.mson` files in `contracts/` into `*.schema.json` files,
 
 put this in your `Rakefile`:
 
@@ -44,17 +41,10 @@ OK /home/dev/lacerda/specifications/publisher/publish.mson
 /home/dev/lacerda$
 ```
 
-## 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:
+By loading all files in a directory this gem will build up the following
+relationships:
 
 - Infrastructure
   - Service
@@ -64,6 +54,30 @@ By converting all files in a directory this gem will build up the following rela
       - Consume specification
         - ConsumedObjects
 
-# References
+## Compatibility
+
+Until there is a native MSON to JSON schema parser available, we do the
+conversion ourselves. These features from the MSON specification are currently supported:
 
+- [x] primitive properties: `string`, `number`, `boolean`, `null`
+- [x] `object` properties
+- [x] `array` properties with items of one type
+- [ ] `array` properties of mixed types
+- [ ] `array` properties of arrays
+- [ ] `enum` properties
+- [ ] `One of` properties mutually exclusive properties
+- [x] `Referencing`
+- [ ] `Mixins` 
+- [ ] Variable property names
+
+
+## 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
+
+# References
 [1] This quote in French quotation marks is from "Fear and Loathing in Las Vegas". Since I can't link to the book, a link to the [movie script](http://www.dailyscript.com/scripts/fearandloathing.html) shall suffice.

data/lacerda.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "json-schema",   ["~> 2.5"]
   spec.add_runtime_dependency "redsnow",       ["~> 0.4"]
   spec.add_runtime_dependency "colorize"
-  spec.add_runtime_dependency "blumquist",     ["~> 0.2"]
+  spec.add_runtime_dependency "blumquist",     ["~> 0.3"]
 
   spec.add_development_dependency "bundler",             ["~> 1"]
   spec.add_development_dependency "guard-bundler",       ["~> 2.1"]
@@ -33,4 +33,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec",               ["~> 3.3"]
   spec.add_development_dependency "coveralls",           ["~> 0.8"]
   spec.add_development_dependency "codeclimate-test-reporter"
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'pry-rescue'
+  spec.add_development_dependency 'pry-stack_explorer'
 end

data/lib/lacerda.rb

@@ -1,3 +1,4 @@
+require 'lacerda/version'
 require 'lacerda/conversion'
 require 'lacerda/publish_specification'
 require 'lacerda/consume_specification'
@@ -7,6 +8,7 @@ require 'lacerda/compare/json_schema'
 require 'lacerda/reporter'
 require 'lacerda/reporters/multi'
 require 'lacerda/reporters/stdout'
+require 'active_support/core_ext/string'
 
 module Lacerda
   SCOPE_SEPARATOR = '::'
@@ -24,4 +26,9 @@ module Lacerda
           .underscore
           .gsub(/:/, SCOPE_SEPARATOR)
   end
+
+  # Poor man's deep copy: json 🆗 🆒
+  def self.deep_copy(object)
+    JSON.parse({m: object}.to_json)['m']
+  end
 end

data/lib/lacerda/compare/json_schema.rb

@@ -3,7 +3,7 @@ module Lacerda
     class JsonSchema
       ERRORS = {
         :ERR_ARRAY_ITEM_MISMATCH  => "The items in the published array don't match the consumer's specification.",
-        :ERR_MISSING_DEFINITION   => "The publish specification is missing a type defined in esothe consumer's specification.",
+        :ERR_MISSING_DEFINITION   => "The publish specification is missing a type defined in the consumer's specification.",
         :ERR_MISSING_POINTER      => "A JSON pointer could not be resolved.",
         :ERR_MISSING_PROPERTY     => "The published object is missing a property required by your specification.",
         :ERR_MISSING_REQUIRED     => "The published object has an optional property that you marked as required in your specification.",
@@ -22,18 +22,27 @@ module Lacerda
         @errors = []
         @initial_location = initial_location
         @contained_schema = contained_schema
-        definitions_contained?
+        properties_contained?
       end
 
       private
 
-      def definitions_contained?
-        @contained_schema['definitions'].each do |property, contained_property|
-          containing_property = @containing_schema['definitions'][property]
+      def properties_contained?
+        @contained_schema['properties'].each do |property, contained_property|
+          resolved_contained_property = data_for_pointer(property, @contained_schema)
+          containing_property = @containing_schema['properties'][property]
           if !containing_property
             _e(:ERR_MISSING_DEFINITION, [@initial_location, property]) 
           else
-            schema_contains?(containing_property, contained_property, [property])
+            resolved_containing_property = data_for_pointer(
+              containing_property,
+              @containing_schema
+            )
+            schema_contains?(
+              resolved_containing_property,
+              resolved_contained_property,
+              [property]
+            )
           end
         end
         @errors.empty?
@@ -49,7 +58,7 @@ module Lacerda
 
         # We can only compare types and $refs, so let's make
         # sure they're there
-        return _e(:ERR_MISSING_TYPE_AND_REF) unless
+        return _e(:ERR_MISSING_TYPE_AND_REF, location) unless
           (consume['type'] or consume['$ref']) and
           (publish['type'] or publish['$ref'])
 
@@ -117,6 +126,36 @@ module Lacerda
         true
       end
 
+      # Resolve pointer data idempotent(ally?). It will resolve
+      #
+      #     "foobar"
+      #
+      # or
+      #
+      #     { "$ref": "#/definitions/foobar" }
+      #
+      # or
+      #
+      #     { "type": "whatever", ... }
+      #
+      # to
+      #
+      #     { "type" :"whatever", ... }
+      #
+      def data_for_pointer(data_or_pointer, schema)
+        data = nil
+        if data_or_pointer['type']
+          data = data_or_pointer
+        elsif pointer = data_or_pointer['$ref']
+          data = resolve_pointer(pointer, schema)
+        else
+          data = schema['definitions'][data_or_pointer]
+        end
+        data
+      end
+
+      # Looks up a pointer like #/definitions/foobar and return
+      # its definition
       def resolve_pointer(pointer, schema)
         type = pointer[/\#\/definitions\/([^\/]+)$/, 1]
         return false unless type

data/lib/lacerda/consume_specification.rb

@@ -1,7 +1,34 @@
+require 'json'
 require 'lacerda/specification'
 
 module Lacerda
   class ConsumeSpecification < Lacerda::Specification
+
+    # We will remove any properties from the schema that are not referencing
+    # a published object from another service, but that are just local definitions
+    # i.e.
+    #
+    #     {
+    #       "type": "object",
+    #       "definitions": {
+    #         "message_properties": { ...},
+    #         "service::message": {...}
+    #         "
+    #       }
+    #       "properties": {
+    #         "message_properties": { "$ref": "#/message_properties }, <- remove
+    #         "service::message": { "$ref": "#/service::message" } <- keep
+    #       }
+    #     }
+    #
+    def initialize(service, schema_or_file)
+      super
+      return unless @schema['properties']
+      @schema['properties'] = @schema['properties'].keep_if do |k, v|
+        !!k.index(Lacerda::SCOPE_SEPARATOR)
+      end
+    end
+
     def object_description_class
       Lacerda::ConsumedObject
     end
@@ -9,19 +36,28 @@ module Lacerda
     def scoped_schema(service)
       service_name_prefix = Lacerda.underscore(service.name + Lacerda::SCOPE_SEPARATOR)
 
-      # Poor man's deep clone: json 🆗 🆒
-      filtered_schema = JSON.parse(schema.to_json)
-      filtered_schema['definitions'].select! do |k|
+      filtered_schema = Lacerda.deep_copy(schema)
+      filtered_schema['properties'].select! do |k|
         Lacerda.underscore(k).start_with?(service_name_prefix)
       end
       filtered_schema
     end
 
+    def object?(name)
+      underscored_name = Lacerda.underscore(name)
+      !!@schema[:definitions][underscored_name]
+    end
+
     def object(name)
       underscored_name = Lacerda.underscore(name)
-      schema = @schema[:definitions][underscored_name]
-      raise Lacerda::Service::InvalidObjectTypeError.new(underscored_name) unless schema
-      Lacerda::ConsumedObject.new(service, name, schema)
+      object_schema = Lacerda.deep_copy(@schema[:definitions][underscored_name])
+      raise Lacerda::Service::InvalidObjectTypeError.new("Invalid object type: #{underscored_name.to_s.to_json}") unless object_schema
+
+      # Copy the definitions of our schema into the schema for the
+      # object in case its properties include json pointers
+      object_schema[:definitions] = Lacerda.deep_copy(@schema[:definitions])
+
+      Lacerda::ConsumedObject.new(service, name, object_schema)
     end
   end
 end

data/lib/lacerda/conversion/data_structure.rb

@@ -1,4 +1,3 @@
-require 'active_support/core_ext/string'
 
 module Lacerda
   module Conversion

data/lib/lacerda/object_description.rb

@@ -1,3 +1,6 @@
+require 'json-schema'
+require 'active_support/core_ext/hash/indifferent_access'
+
 # This represents a description of an Object (as it was in MSON and later
 # JSON Schema). It can come in two flavors:
 #
@@ -21,7 +24,7 @@ module Lacerda
       @defined_in_service = defined_in_service
       @scoped_name = scoped_name
       @name = remove_service_from_scoped_name(scoped_name)
-      @schema = schema
+      @schema = schema.with_indifferent_access
     end
 
     def validate_data!(data)

data/lib/lacerda/publish_specification.rb

@@ -20,14 +20,13 @@ module Lacerda
       result
     end
 
-    def object(name)
-      scoped_name = Lacerda.underscore(name.to_s)
-
-      # Add our own prefix automatically if necessary
-      unless scoped_name.start_with?(Lacerda.underscore(service.name))
-        scoped_name = [Lacerda.underscore(service.name), scoped_name].join(Lacerda::SCOPE_SEPARATOR)
-      end
+    def object?(name)
+      scoped_name = scopify_name(name)
+      !!@schema[:definitions][scoped_name]
+    end
 
+    def object(name)
+      scoped_name = scopify_name(name)
       schema = @schema[:definitions][scoped_name]
       raise Lacerda::Service::InvalidObjectTypeError.new(scoped_name) unless schema
       Lacerda::PublishedObject.new(service, scoped_name, schema)
@@ -35,6 +34,14 @@ module Lacerda
 
     private
 
+    def scopify_name(name)
+      scoped_name = Lacerda.underscore(name.to_s)
+
+      # Add our own prefix automatically if necessary
+      return scoped_name if scoped_name.start_with?(Lacerda.underscore(service.name))
+      [Lacerda.underscore(service.name), scoped_name].join(Lacerda::SCOPE_SEPARATOR)
+    end
+
     def object_description_class
       Lacerda::PublishedObject
     end

data/lib/lacerda/service.rb

@@ -28,10 +28,23 @@ module Lacerda
 
     def consumed_objects(publisher = nil)
       @consume.objects.select do |o|
+        next if o.publisher_name.blank?
         publisher.blank? or o.publisher == publisher
       end
     end
 
+    def publishes?(object_name)
+      @publish.object?(object_name.to_s)
+    end
+
+    def consumes?(object_name)
+      @consume.object?(object_name.to_s)
+    end
+
+    def consumes_from?(service_name, object_name)
+      @consume.object?([service_name, object_name].join(Lacerda::SCOPE_SEPARATOR))
+    end
+
     def published_objects
       @publish.objects
     end
@@ -77,6 +90,10 @@ module Lacerda
       object_description.validate_data!(data)
     end
 
+    def consume_object_from(service_name, type, data)
+      consume_object([service_name, type].join(Lacerda::SCOPE_SEPARATOR), data)
+    end
+
     def consume_object(type, data)
       object_description = @consume.object(type)
       Blumquist.new(schema: object_description.schema, data: data)

data/lib/lacerda/version.rb

@@ -1,3 +1,3 @@
 module Lacerda
-  VERSION = '0.11.0'
+  VERSION = '0.12.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lacerda
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Jannis Hermanns
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-04 00:00:00.000000000 Z
+date: 2015-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -192,6 +192,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry-rescue
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry-stack_explorer
+  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: