vigia 0.1.1 → 0.1.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZjQ5YmJhYmRiNjc0MDI2NzFjZThlOGJhN2E0MjIwNTVmOTFlMjA5MA==
+    MjZiMjEwOTE3OGMzMjM3NDFlMThmOTc3YTU5MjRjNTUwYjAxNGE2OQ==
   data.tar.gz: !binary |-
-    MDJiZDJlNDNiZDJlYjg2YjRmYjJhNTNlNzJlNWZhM2E2ODA2ZTRmZg==
+    ODQ1M2U3ZTZmODNiMjJhMGIwMGZmYTM0NzZiYzRjOGQ3Zjk2M2MyZA==
 SHA512:
   metadata.gz: !binary |-
-    MThhNTJkMDU1NGNmMGYxOTU0Nzk2Yjg5NTdmMzU2NWE1NmU5NzE2YzQyYjY0
-    NGNlNDg2NTdlYTcwYjM4NDliNzU1YWJhODJkZGVhZTE2YjMxMGY4ZGE4YjFh
-    NDBhMGUxZjNiYzEyOTkxZDRjYzkwNTY2YzkwZDRmOTIwOTc0OTI=
+    MDYyYzJjZDYxNDFjNzdkOTQyN2MwY2Y3YjI2YzI0MDZiYTc0Y2U5NzljZmE4
+    MjAwYTY1YzZmN2VkNDBlOWM0ODJkMGIzZTA4MjYwZTBjZmM1ZjI4ZjZjYjJl
+    ZDk4NmMxZWQzOWZiMmZiNTJlYzNjZWIyODFhMzUzNzNjMGNiNzM=
   data.tar.gz: !binary |-
-    Y2Y5ODNhYmI0MzBiNDRmNTFlNTg5MjlkNTQxNmNkZDcyYzg2ZTAzYzZmMzJi
-    ZDEzZmQ4N2RjNzUzOTlmM2E2NTU4YzI3ZDQwYmZhZjI4ZDZlMDkxNDhmNDY1
-    MTI0MGE3MmM5YmMwMTFjODJiNWRiYTIyYTA2NGZmN2ZlNzNhNTk=
+    YWZmZGQ5NjJhN2ZkNTk2ZWM2YzhiOWMyMWQ0YWMyYjUwMjIxNTVkMzI2MTU0
+    M2IxZWYzYzZmYjA1NTQzMTQ2YmE3ZGM0ZmNkZDI4ZmNiYzVkOTc2ODZmNWE3
+    Njg0ZjcwZjkyYWZlZWM1NGRhYWJkMzBiMGM3OTUyMGYwNjYxNmI=

data/Rakefile

@@ -14,5 +14,9 @@ task :clobber do
 end
 
 # Not sure why simplecov is preventing cucumber for being run after spec
-# when running rake default
-task :default => [ :spec, :cucumber ]
+# when running rake default. That is why I am using commands to execute them
+task :default do
+  raise 'Cucumber Failed' unless system('bundle exec rake cucumber')
+  raise 'RSpec Failed'    unless system('bundle exec rake spec')
+end
+

data/lib/vigia/adapters/blueprint.rb

@@ -2,12 +2,13 @@ module Vigia
   module Adapters
     class Blueprint < Vigia::Adapter
 
-      attr_reader :apib
+      attr_reader :apib, :apib_source
 
       setup_adapter do
 
         after_initialize do
-          @apib_parsed = RedSnow::parse(File.read(source_file))
+          @apib_source = File.read(source_file)
+          @apib_parsed = RedSnow::parse(@apib_source, { :exportSourcemap => true })
           @apib        = @apib_parsed.ast
         end
 
@@ -73,8 +74,43 @@ module Vigia
         payload.body
       end
 
+      def inspector object
+        case object
+        when RedSnow::ResourceGroup
+          locate_in_sourcemap(:resource_groups, object)
+        when RedSnow::Resource
+          locate_in_sourcemap(:resources, object)
+        when RedSnow::Action
+          locate_in_sourcemap(:actions, object)
+        when RedSnow::TransactionExample
+          first_response = object.responses.first
+          locate_in_sourcemap(:responses, first_response)
+        when RedSnow::Payload
+          locate_in_sourcemap(:responses, object)
+        else
+          nil
+        end
+      end
+
       private
 
+      def locate_in_sourcemap(key, object)
+        node_index  = apib_structure[key].index(object)
+        source_node = apib_sourcemap[key][node_index]
+        character   = source_node.name.first.first
+
+        { line: return_line_number_at_character_count(character) }
+      end
+
+      def return_line_number_at_character_count(number)
+        total_chars = 0
+        @apib_source.lines.each_with_index do |line, index|
+          total_chars += line.length
+          next if total_chars < number
+          return index + 2
+        end
+      end
+
       def compile_headers(headers)
         headers.inject({}) do |hash, header|
           normalize_header_name = header[:name].gsub('-', '_').downcase.to_sym
@@ -88,10 +124,23 @@ module Vigia
         collection.flatten
       end
 
-#       def resources
-#         apib.resource_groups.map(&:resources).flatten
-#       end
+      def apib_sourcemap
+        @apib_sourcemap ||= build_structure(@apib_parsed.sourcemap)
+      end
 
+      def apib_structure
+        @apib_structure ||= build_structure(apib)
+      end
+
+      def build_structure(start_point)
+        {}.tap do |hash|
+          hash[:resource_groups] = start_point.resource_groups
+          hash[:resources]       = hash[:resource_groups].map(&:resources).flatten
+          hash[:actions]         = hash[:resources].map(&:actions).flatten
+          hash[:examples]        = hash[:actions].map(&:examples).flatten
+          hash[:responses]       = hash[:examples].map(&:responses).flatten
+        end
+      end
 
       def headers_for_payload(transactional_example, response)
         payload = get_payload(transactional_example, response)

data/lib/vigia/formatter.rb

@@ -0,0 +1,113 @@
+RSpec::Support.require_rspec_core 'formatters/base_text_formatter'
+
+module Vigia
+  class Formatter < RSpec::Core::Formatters::BaseTextFormatter
+
+    include RSpec::Core::Formatters::ConsoleCodes
+
+    RSpec::Core::Formatters.register self, :start, :example_group_started, :example_group_finished,
+                                           :example_pending, :example_passed, :example_failed
+
+    def initialize(output)
+      super
+      @example_collection = {}
+      @group_level        = 0
+      @verbose            = false
+    end
+
+    def start(start_notification)
+      output.puts 'Starting Vigia::RSpec'
+    end
+
+    def example_group_started(example_group_notification)
+      @group_level += 1
+    end
+
+    def example_group_finished(example_group_notification)
+      @group_level -= 1
+    end
+
+    def example_pending(example_notification)
+      output_example_result(example_notification, :pending)
+    end
+
+    def example_passed(example_notification)
+      output_example_result(example_notification, :success)
+    end
+
+    def example_failed(failed_example_notification)
+      output_example_result(failed_example_notification, :failed)
+     end
+
+    def dump_failures(examples_notification)
+      @examples_notification = examples_notification
+      print_context_failures
+    end
+
+    private
+
+    def print_context_failures
+      examples_by_context.each do |context, examples|
+        print_context_failure(context, examples)
+      end
+    end
+
+    def examples_by_context
+      @examples_notification.failed_examples.each_with_object({}) do |example, hash|
+        context         = example.metadata[:example_group]
+        hash[context] ||= []
+        hash[context] << example
+        hash
+      end
+    end
+
+    def print_context_failure(context, examples)
+      output.puts(''.tap do |string|
+        string << context_failure_title(context)
+        string << context_failure_examples(context, examples)
+        string << context_parents(context)
+      end)
+    end
+
+    def context_parents(context)
+      "\nGroups:\n#{ context_parent(context[:parent_example_group], '') }"
+    end
+
+    def context_parent(context, string)
+      unless context[:described_class] == context[:parent_example_group][:described_class]
+        string << "  - #{ context[:described_class].group.name } #{ context[:described_class].to_s }"
+        if Vigia::Rspec.adapter.respond_to?(:inspector)
+          info = Vigia::Rspec.adapter.inspector(context[:described_class].described_object)
+          string << wrap(" # #{ Vigia.config.source_file }:#{ info[:line] }", :cyan)
+        end
+        string << "\n"
+      end
+      unless context[:parent_example_group][:described_class] == Vigia::Rspec
+        string = context_parent(context[:parent_example_group], string)
+      end
+      string
+    end
+
+    def context_failure_title(context)
+      wrap("\nContext `#{ wrap(context[:description], :cyan) }` FAILED:", :bold)
+    end
+
+    def context_failure_examples(context, examples)
+      context_examples = @examples_notification.examples.select do |e|
+        e.metadata[:example_group] == context and e.execution_result.status == :failed
+      end
+
+      context_examples.each_with_object("\n") do |example, text|
+        text <<  " - Example: #{ example.metadata[:description] }\n"
+        text <<  "#{ wrap(example.exception.to_s, :failure) }"
+      end
+    end
+
+    def output_example_result(notification, category)
+      if @verbose
+      else
+        output.print(wrap('.', category))
+      end
+    end
+  end
+end

data/lib/vigia/hooks.rb

@@ -3,6 +3,11 @@ module Vigia
 
     def execute_hook(filter_name, rspec_context)
       hooks_for_object(filter_name).each do |hook|
+        if self.is_a?(Vigia::Sail::Context)
+          instance = self
+          rspec_context.define_singleton_method(:vigia_context, -> { instance })
+        end
+
         rspec_context.instance_exec(&hook)
       end
     end

data/lib/vigia/http_client/options.rb

@@ -8,6 +8,7 @@ module Vigia
           instance.options.each do |name, value|
             instance[name] = context.contextual_object(object: value, context: in_let_context)
           end
+          instance.headers ||= {}
           instance.use_uri_template       if instance.uri_template
           instance.include_config_headers if Vigia.config.headers.any?
           instance

data/lib/vigia/rspec.rb

@@ -21,10 +21,8 @@ module Vigia
     end
 
     def run!
-      with_rspec_options do
-        RSpec::Core::Runner::run(
-          [ Vigia.spec_folder ], Vigia.config.stderr, Vigia.config.stdout)
-      end
+      RSpec::Core::Runner::run(
+        [ Vigia.spec_folder ], Vigia.config.stderr, Vigia.config.stdout)
     end
 
     def start_tests(rspec)
@@ -57,6 +55,7 @@ module Vigia
     end
 
     def configure_vigia_rspec(rspec_config)
+      rspec_config.formatter = Vigia::Formatter
       return unless Vigia.config.rspec_config_block.respond_to?(:call)
       Vigia.config.rspec_config_block.call(rspec_config)
     end

data/lib/vigia/sail/context.rb

@@ -3,16 +3,7 @@ module Vigia
     class Context < RSpecObject
 
       def run
-        instance = self
-        rspec.context instance.to_s do
-          instance.with_hooks(self) do
-            let(:http_client_options) { instance.set_http_client_options(self) }
-            let(:expectations)        { instance.set_expectations(self) }
-
-            instance.run_examples(self)
-            instance.run_shared_examples(self)
-          end
-        end
+        run_rspec_context unless disabled?
       end
 
       def set_http_client_options(in_let_context)
@@ -42,7 +33,30 @@ module Vigia
       end
 
       def to_s
-        "context #{ name }"
+        (contextual_object(option_name: :description) || "context #{ name }").to_s
+      end
+
+      def run_rspec_context
+        instance = self
+        rspec.context instance.to_s do
+
+          define_singleton_method("context_#{ instance.name }", ->{ instance })
+
+          instance.with_hooks(self) do
+            let(:http_client_options) { instance.set_http_client_options(self) }
+            let(:expectations)        { instance.set_expectations(self) }
+
+            instance.run_examples(self)
+            instance.run_children(self)
+            instance.run_shared_examples(self)
+          end
+        end
+      end
+
+      def run_children(in_context)
+        children.each do |context_name|
+          Vigia::Sail::Context.setup_and_run(context_name, in_context)
+        end
       end
 
       private
@@ -61,6 +75,17 @@ module Vigia
       def default_expectations
         [ :code, :headers, :body ]
       end
+
+      def disabled?
+        return false unless options[:disable_if]
+        contextual_object(option_name: :disable_if, context: rspec)
+      end
+
+      def children
+        (self.class.collection.select do |k,v|
+          v.has_key?(:in_contexts) && [ *v[:in_contexts] ].include?(name)
+        end.keys + ([ *options[:contexts] ] || [])).uniq
+      end
     end
   end
 end

data/lib/vigia/sail/example.rb

@@ -9,11 +9,12 @@ module Vigia
 
         def run_in_context(context, rspec_context)
           @collection.each do |name, options|
-            setup_and_run(name, rspec_context) if example_contexts_include?(context, options[:contexts])
+            setup_and_run(name, rspec_context) if example_contexts_include?(context, name, options[:contexts])
           end
         end
 
-        def example_contexts_include?(context, enabled_contexts)
+        def example_contexts_include?(context, example_name, enabled_contexts)
+          return context.options[:examples].include?(example_name) if context.options[:examples].is_a?(Enumerable)
           [ *(enabled_contexts || :default) ].include?(context.name)
         end
       end

data/lib/vigia/sail/examples/default.rb

@@ -1,11 +1,17 @@
-Vigia::Sail::Example.register(
-  :code_match,
-  description: 'has the expected HTTP code',
-  expectation: -> { expect(result.code).to be(expectations.code) }
-)
+ Vigia::Sail::Example.register(
+   :code_match,
+   description: 'has the expected HTTP code',
+   expectation: -> {
+     if expectations.code.is_a?(Range)
+       expect(expectations.code.member?(result.code)).to be true
+     else
+       expect(result.code).to be(expectations.code)
+     end
+   }
+ )
 
-Vigia::Sail::Example.register(
-  :include_headers,
-  description: 'includes the expected headers',
-  expectation: -> { expect(result[:headers]).to include(expectations[:headers]) }
-)
+ Vigia::Sail::Example.register(
+   :include_headers,
+   description: 'includes the expected headers',
+   expectation: -> { expect(result.headers).to include(expectations.headers) }
+ )

data/lib/vigia/sail/rspec_object.rb

@@ -10,8 +10,10 @@ module Vigia
         end
 
         def setup_and_run(name, rspec)
-          name, options  = collection.select{ |k,v| k == name }.first
-          instance       = new(name, options, rspec)
+          items = collection.select{ |k,v| k == name }
+          raise "Cannot find #{ self.name } with name #{ name }" if items.empty?
+          name, options = items.first
+          instance      = new(name, options, rspec)
           instance.run
         end
       end

data/lib/vigia/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 
 module Vigia
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/lib/vigia.rb

@@ -9,6 +9,7 @@ require_relative 'vigia/adapter'
 require_relative 'vigia/adapters/blueprint'
 require_relative 'vigia/config'
 require_relative 'vigia/hooks'
+require_relative 'vigia/formatter'
 require_relative 'vigia/http_client/options'
 require_relative 'vigia/http_client/rest_client'
 require_relative 'vigia/http_client/requests'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vigia
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - David Tapiador
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-11 00:00:00.000000000 Z
+date: 2014-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -194,19 +194,20 @@ files:
 - lib/vigia/http_client/options.rb
 - lib/vigia/spec/support/utils.rb
 - lib/vigia/spec/api_spec.rb
-- lib/vigia/rspec.rb
 - lib/vigia/adapters/blueprint.rb
 - lib/vigia/parameters.rb
 - lib/vigia/sail/group.rb
 - lib/vigia/sail/group_instance.rb
+- lib/vigia/sail/examples/default.rb
 - lib/vigia/sail/context.rb
 - lib/vigia/sail/example.rb
-- lib/vigia/sail/examples/default.rb
 - lib/vigia/sail/rspec_object.rb
 - lib/vigia/adapter.rb
 - lib/vigia/config.rb
-- lib/vigia/hooks.rb
 - lib/vigia/url.rb
+- lib/vigia/formatter.rb
+- lib/vigia/hooks.rb
+- lib/vigia/rspec.rb
 - lib/vigia/version.rb
 - lib/vigia.rb
 - README.md