lacerda 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b79f31c341b389ee76539bade775431468b9bd50
-  data.tar.gz: 4cfc0aaf1282b2b0cfe6982c0f33299fafefeb6e
+  metadata.gz: 732b9947f1b14ae426fb81521f97c71db31787a8
+  data.tar.gz: 568fccf33cecefd14d595e616d9fa5cd8cc165d5
 SHA512:
-  metadata.gz: 7d5be7e36ab570f3a860a52a91d7006248ddbf48751e44f7b8cf2437e5db8dea4aeee63c5583d6b301e533c02b12cd6c4b7337f75b003b3822362d7e30370e43
-  data.tar.gz: 90847e492f4b7bbede6bc1ca00a09a008fd89cdb3f07e6e6ed0e462e72a44d57ee0a5734ff5250e05dd4f867474bcaaa4a5eda1891c9796fb6c8735337945b85
+  metadata.gz: 4da97e585d8d88580e630c8eaeaba6ffb83f5cf47da8771c340e045049f5394a02360769171cb7ed6ff19217e255fb80136bf37fe15c9673cfefa9d5750b5e59
+  data.tar.gz: 2f91d653697e862dc113d8c0ab1ab9da8b1e7e81d4c2b5a0b298e99cf2d1c24043395647b55a489ae33797265320e24ceebf368c515f7da77bfd144e86323a5e

data/CHANGELOG.markdown

@@ -1,3 +1,7 @@
+# 0.8.0 (30-Oct-15)
+- support for custom reporters
+- extract current output into and stdout reporter
+
 # 0.7.0 (30-Oct-15)
 - change ServiceName:ObjectName to ServiceName::ObjectName
 

data/lib/lacerda/infrastructure.rb

@@ -1,4 +1,5 @@
 require 'active_support/core_ext/hash/indifferent_access'
+require 'active_support/core_ext/object/try'
 
 module Lacerda
   class Infrastructure
@@ -15,24 +16,35 @@ module Lacerda
       @services = nil
     end
 
-    def contracts_fulfilled?
+    def contracts_fulfilled?(reporter = nil)
+      reporter = Lacerda.validate_reporter(reporter)
+
       @mutex1.synchronize do
         @errors = {}
 
         # Check for incompatibility in published objects
+        reporter.try(:check_publishing)
         publishers.each do |publisher|
-          publisher.satisfies_consumers?(verbose: @verbose)
+          reporter.try(:check_publisher, publisher)
+          publisher.satisfies_consumers?(verbose: @verbose, reporter: reporter)
           next if publisher.errors.empty?
           @errors.merge! publisher.errors
         end
 
         # Check for missing publishers
+        reporter.try(:check_consuming)
         missing_publishers = {}
         consumers.each do |consumer|
+          reporter.try(:check_consumer, consumer)
           consumer.consumed_objects.each do |object|
-            next if object.publisher
-            missing_publishers[object.publisher_name.camelize] ||= []
-            missing_publishers[object.publisher_name.camelize] << consumer.name.camelize
+            if object.publisher
+              reporter.try(:object_publisher_existing, object, true)
+              next
+            else
+              reporter.try(:object_publisher_existing, object, false)
+              missing_publishers[object.publisher_name.camelize] ||= []
+              missing_publishers[object.publisher_name.camelize] << consumer.name.camelize
+            end
           end
         end
 
@@ -45,6 +57,8 @@ module Lacerda
           errors["Missing publishers: "] = missing
         end
 
+        reporter.try(:result, @errors)
+
         @errors.empty?
       end
     end

data/lib/lacerda/publish_contract.rb

@@ -8,9 +8,12 @@ module Lacerda
       @comparator.errors
     end
 
-    def satisfies?(consumer)
+    def satisfies?(consumer, reporter = nil)
+      Lacerda.validate_reporter(reporter)
       @comparator = Compare::JsonSchema.new(@schema)
-      @comparator.contains?(consumer.consume.scoped_schema(service), consumer.name)
+      result = @comparator.contains?(consumer.consume.scoped_schema(service), consumer.name)
+      reporter.try(:consume_specification_satisfied, consumer, result)
+      result
     end
 
     def object(name)

data/lib/lacerda/reporter.rb

@@ -0,0 +1,40 @@
+# This is so you can write your own reporters
+module Lacerda
+  class Reporter
+    def initialize(options = {})
+    end
+
+    def check_publishing
+      # Called before all publishers are iterated to check if they satisfy
+      # their consumers.
+    end
+
+    def check_publisher(publishing_service)
+      # Called before one single publisher is checked against its consumers
+    end
+
+    def object_publish_specification_valid(consumed_object, is_valid)
+      # Called after a consumed object's specification has been checked against
+      # the publisher's specification of that object.
+    end
+
+    def check_consuming
+      # Called before all consumers' consumed objects are iterated to make
+      # sure they have a publisher that meets their specification.
+    end
+
+    def check_consumer(consuming_service)
+      # Called before all consumed objects are iterated
+    end
+
+    def object_publisher_existing(consumed_object, is_published)
+      # Called after a consumed object was inspected (does a publish specification
+      # for this object exist?)
+    end
+
+    def result(errors)
+      # Called when everything is done with an array of errors. If that array
+      # is empty, go ahead and assume all specifications are valid
+    end
+  end
+end

data/lib/lacerda/reporters/multi.rb

@@ -0,0 +1,34 @@
+require 'lacerda/reporter'
+
+module Lacerda
+  module Reporters
+    class Multi < Lacerda::Reporter
+      def initialize(*reporters)
+        @reporters = []
+        [reporters].flatten.each do |r|
+          @reporters << Lacerda.validate_reporter(r)
+        end
+      end
+  
+       methods = Lacerda::Reporter.instance_methods - Object.instance_methods
+       methods.each do |method|
+         define_method method do |*args|
+           send_args = [method, args].flatten
+           @reporters.each do |r|
+             r.send(*send_args)
+           end
+         end
+       end
+    end
+  end
+end
+
+#methods = Lacerda::Reporter.instance_methods - Object.instance_methods
+#methods.each do |method|
+#  Lacerda::Reporters::Multi.send(:define_method, method) do |*args|
+#    send_args = [method, args].flatten.compact
+#    @reporters.each do |r|
+#      r.send(*[method, args].flatten)
+#    end
+#  end
+#end

data/lib/lacerda/reporters/rspec.rb

@@ -0,0 +1,6 @@
+module Lacerda
+  module Reporters
+    class RSpec < Lacerda::Reporter
+    end
+  end
+end

data/lib/lacerda/reporters/stdout.rb

@@ -0,0 +1,45 @@
+# coding: utf-8
+module Lacerda
+  module Reporters
+    class Stdout < Lacerda::Reporter
+      def initialize(options = {})
+        @verbose = options.fetch(:verbose, true)
+        @io = options.fetch(:output, $stdout)
+      end
+  
+      def check_publishing
+      end
+  
+      def check_publisher(publisher)
+        @io.print "\n#{publisher.name.camelize} satisfies: " if @verbose
+      end
+  
+      def consume_specification_satisfied(consumer, is_valid)
+        if is_valid
+          @io.print "#{consumer.name.camelize.green} " if @verbose
+        else
+          @io.print "#{consumer.name.camelize.red} " if @verbose
+        end
+      end
+  
+      def check_consuming
+        @io.print "\n" if @verbose
+      end
+  
+      def check_consumer(consuming_service)
+      end
+  
+      def object_publisher_existing(consumed_object, is_published)
+      end
+
+      def result(errors)
+        if errors.blank?
+          @io.puts "All contracts valid 🙌".green if @verbose
+        else
+          @io.puts JSON.pretty_generate(errors)
+          @io.puts "#{errors.length} contract violations".red
+        end
+      end
+    end
+  end
+end

data/lib/lacerda/service.rb

@@ -1,4 +1,5 @@
 require 'active_support/core_ext/string'
+require 'active_support/core_ext/object/try'
 require 'blumquist'
 require 'lacerda/service/error'
 
@@ -35,24 +36,20 @@ module Lacerda
       @publish.objects
     end
 
-    def satisfies?(service)
-      @publish.satisfies?(service)
+    def satisfies?(service, reporter = nil)
+      Lacerda.validate_reporter(reporter)
+      @publish.satisfies?(service, reporter)
     end
 
     def satisfies_consumers?(options = {})
-      verbose = options.fetch(:verbose, false)
+      reporter = Lacerda.validate_reporter(options.fetch(:reporter, nil))
+
       @errors = {}
-      print "#{name.camelize} satisfies: " if verbose
       consumers.each do |consumer|
-        @publish.satisfies?(consumer)
-        if @publish.errors.empty?
-          print "#{consumer.name.camelize.green} "if verbose
-          next
-        end
-          print "#{consumer.name.camelize.red} "if verbose
+        @publish.satisfies?(consumer, reporter)
+        next if @publish.errors.empty?
         @errors["#{name} -> #{consumer.name}"] = @publish.errors
       end
-      print "\n" if verbose
       @errors.empty?
     end
 

data/lib/lacerda/version.rb

@@ -1,3 +1,3 @@
 module Lacerda
-  VERSION = '0.7.0'
+  VERSION = '0.8.0'
 end

data/lib/lacerda.rb

@@ -1,13 +1,24 @@
-require "lacerda/conversion"
-require "lacerda/publish_contract"
-require "lacerda/consume_contract"
-require "lacerda/service"
-require "lacerda/infrastructure"
-require "lacerda/compare/json_schema"
+require 'lacerda/conversion'
+require 'lacerda/publish_contract'
+require 'lacerda/consume_contract'
+require 'lacerda/service'
+require 'lacerda/infrastructure'
+require 'lacerda/compare/json_schema'
+require 'lacerda/reporter'
+require 'lacerda/reporters/multi'
+require 'lacerda/reporters/rspec'
+require 'lacerda/reporters/stdout'
 
 module Lacerda
   SCOPE_SEPARATOR = '::'
 
+  def self.validate_reporter(reporter)
+    return Lacerda::Reporters::MultiReporter.new(reporter) if reporter.is_a?(Array)
+    return reporter unless reporter
+    return reporter if reporter.class <= Lacerda::Reporter
+    raise "reporter must inherit from Lacerda::Reporter, but #{reporter.class.name} doesn't"
+  end
+
   # An underscore that doesn't turn :: into /
   def self.underscore(string)
     string.gsub(/#{SCOPE_SEPARATOR}/, ':')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lacerda
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Jannis Hermanns
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-30 00:00:00.000000000 Z
+date: 2015-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -224,6 +224,10 @@ files:
 - lib/lacerda/object_description.rb
 - lib/lacerda/publish_contract.rb
 - lib/lacerda/published_object.rb
+- lib/lacerda/reporter.rb
+- lib/lacerda/reporters/multi.rb
+- lib/lacerda/reporters/rspec.rb
+- lib/lacerda/reporters/stdout.rb
 - lib/lacerda/service.rb
 - lib/lacerda/service/error.rb
 - lib/lacerda/tasks.rb