webspicy 0.8.6 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 907eaa3406ba8520d040fc96133faf16d5b7a357
-  data.tar.gz: ea0d8ec2b1932f64ea4266c01e4ec31b283ded63
+  metadata.gz: 9ee44fbfe2ca04541a590d8d5cac3afc54e8bb92
+  data.tar.gz: b92cf71bf4ab3715918f544706f84a1f580ec59a
 SHA512:
-  metadata.gz: 64de80d4499aa9fad0578111a259d903fc804ec07af1805d0c84490531f7fece535060c5ea3947a25a06e9e7833cede56404d8fb4087164c990199e1105f479c
-  data.tar.gz: eaf0c4859bc5bbd844e0588e12620f270440b81a9acffc0211486a5a0d30a71725243b7b3febde8f63e495d0cad0150ebc54398fe9f4d40c81b83120a4a1362c
+  metadata.gz: 2478429f74cdf469a7182054bd6f9b110b2460bfbb7f6c8631dc3f554ff9c1c5e7dcfde9da928fd05316b5d71c3495daad6650e83802f7bc742eb582a3400586
+  data.tar.gz: 941daafd12fffa3d700b3bd4023ca009027fb229f9e13193582fda47bef18764f3cebb51c5995574b6436b40bf60e84294c9632257dfa475914dc365688c74bb

data/examples/restful/Gemfile.lock

@@ -1,13 +1,13 @@
 PATH
   remote: ../..
   specs:
-    webspicy (0.8.4)
-      finitio (~> 0.5.2)
+    webspicy (0.9.0)
+      finitio (>= 0.5.2)
       http (~> 2)
       path (~> 1.3)
       rack-robustness (~> 1.1.0)
       rack-test (~> 0.6.3)
-      rspec (~> 3.6)
+      rspec (~> 3.7)
 
 GEM
   remote: https://rubygems.org/

data/lib/webspicy/client.rb

@@ -10,12 +10,42 @@ module Webspicy
       scope.config
     end
 
+    def around(*args, &bl)
+      args << self
+      ls = config.listeners(:around_each)
+      if ls.size == 0
+        bl.call
+      elsif ls.size > 1
+        _around(ls.first, ls[1..-1], args, &bl)
+      else
+        ls.first.call(*args, &bl)
+      end
+    end
+
+    def _around(head, tail, args, &bl)
+      head.call(*args) do
+        if tail.empty?
+          bl.call
+        else
+          _around(tail.first, tail[1..-1], args, &bl)
+        end
+      end
+    end
+    private :_around
+
     def before(*args, &bl)
-      config.before_listeners.each do |beach|
-        args << self
+      args << self
+      config.listeners(:before_each).each do |beach|
         beach.call(*args, &bl)
       end
     end
 
+    def after(*args, &bl)
+      args << self
+      config.listeners(:after_each).each do |aeach|
+        aeach.call(*args, &bl)
+      end
+    end
+
   end
 end

data/lib/webspicy/configuration.rb

@@ -1,13 +1,15 @@
 module Webspicy
   class Configuration
 
+    LISTENER_KINDS = [ :before_all, :before_each, :after_all, :after_each, :around_each ]
+
     def initialize(folder = Path.pwd, parent = nil)
       @folder = folder
       @parent = parent
       @children = []
       @preconditions = []
       @postconditions = []
-      @before_listeners = []
+      @listeners = Hash.new{|h,k| h[k] = [] }
       @rspec_options = default_rspec_options
       @run_counterexamples = default_run_counterexamples
       @file_filter = default_file_filter
@@ -194,21 +196,56 @@ module Webspicy
     end
     attr_reader :client
 
+    # Registers a listener under a given kind.
+    def register_listener(kind, listener)
+      raise "Must respond to call" unless listener.respond_to?(:call)
+      @listeners[kind] << listener
+    end
+    private :register_listener
+
+    # Returns the listeners of a specific kind.
+    #
+    # Recognized kinds are `before_each`, `after_each`, `before_all` and `after_all`
+    def listeners(kind)
+      @listeners[kind]
+    end
+    attr_writer :listeners
+    protected :listeners=
+
+    # Installs a listener that will be called before all tests
+    #
+    # The `listener` must respond to `call`.
+    def before_all(&listener)
+      register_listener(:before_all, listener)
+    end
+
     # Installs a listener that will be called before each web service invocation.
     #
     # The `listener` must respond to `call`.
     def before_each(&listener)
-      raise "Must respond to call" unless listener.respond_to?(:call)
-      @before_listeners << listener
+      register_listener(:before_each, listener)
+    end
+
+    # Installs a listener that will be called after all tests
+    #
+    # The `listener` must respond to `call`.
+    def after_all(&listener)
+      register_listener(:after_all, listener)
     end
 
-    # Returns the list of listeners that must be called before each web service
-    # invocation.
-    def before_listeners
-      @before_listeners
+    # Installs a listener that will be called after each web service invocation.
+    #
+    # The `listener` must respond to `call`.
+    def after_each(&listener)
+      register_listener(:after_each, listener)
+    end
+
+    # Installs a listener that will be called around each web service invocation.
+    #
+    # The `listener` must respond to `call`.
+    def around_each(&listener)
+      register_listener(:around_each, listener)
     end
-    attr_writer :before_listeners
-    protected :before_listeners=
 
     # Allows setting the options passed at RSpec, which is used by both the runner
     # and checker classes.
@@ -267,7 +304,9 @@ module Webspicy
         d.preconditions = self.preconditions.dup
         d.postconditions = self.postconditions.dup
         d.rspec_options = self.rspec_options.dup
-        d.before_listeners = self.before_listeners.dup
+        d.listeners = LISTENER_KINDS.inject({}){|ls,kind|
+          ls.merge(kind => self.listeners(kind).dup)
+        }
         yield d if block_given?
       end
     end

data/lib/webspicy/resource.rb

@@ -25,7 +25,7 @@ module Webspicy
     def instantiate_url(params)
       url, rest = self.url, params.dup
       url_placeholders.each do |placeholder|
-        value, rest = extract_placeholder_value(params, placeholder)
+        value, rest = extract_placeholder_value(rest, placeholder)
         url = url.gsub("{#{placeholder}}", value.to_s)
       end
       [ url, rest ]

data/lib/webspicy/tester.rb

@@ -3,24 +3,48 @@ module Webspicy
 
     def initialize(config)
       @config = Configuration.dress(config)
+      @test_suite = load
     end
     attr_reader :config
 
-    def call
+    def call(err=$stderr, out=$stdout)
+      $_rspec_core_load_started_at = nil
+      options = RSpec::Core::ConfigurationOptions.new(config.rspec_options)
+      conf = RSpec::Core::Configuration.new
+      RSpec::Core::Runner.new(options, conf).run(err, out)
+    end
+
+  # protected
+
+    def load
+      tester = self
+      RSpec.reset
       rspec_config!
-      config.each_scope do |scope|
-        client = scope.get_client
-        scope.each_resource do |resource|
-          scope.each_service(resource) do |service|
-            rspec_service!(service, client, scope)
+      RSpec.describe "Webspicy test suite" do
+        before(:all) do
+          tester.config.listeners(:before_all).each do |l|
+            l.call(tester.config)
+          end
+        end
+        after(:all) do
+          tester.config.listeners(:after_all).each do |l|
+            l.call(tester.config)
+          end
+        end
+        tester.config.each_scope do |scope|
+          client = scope.get_client
+          scope.each_resource do |resource|
+            scope.each_service(resource) do |service|
+              tester.rspec_service!(self, service, client, scope)
+            end
           end
         end
       end
-      RSpec::Core::Runner.run config.rspec_options
+      self
     end
 
-    def rspec_service!(service, client, scope)
-      RSpec.describe service do
+    def rspec_service!(on, service, client, scope)
+      on.describe service do
         scope.each_testcase(service) do |test_case, counterexample|
           describe test_case do
             include_examples 'a successful test case invocation', client, test_case, counterexample
@@ -30,14 +54,15 @@ module Webspicy
     end
 
     def rspec_config!
-      return if @rspec_config
       RSpec.shared_examples "a successful test case invocation" do |client, test_case, counterexample|
 
-        before(:all) do
-          @invocation ||= begin
+        around(:each) do |example|
+          client.around(test_case) do
             client.before(test_case)
             test_case.instrument(client)
-            client.call(test_case)
+            @invocation = client.call(test_case)
+            example.run
+            client.after(test_case)
           end
         end
 
@@ -45,27 +70,17 @@ module Webspicy
           @invocation
         end
 
-        it 'meets the HTTP specification' do
+        it 'meets its specification' do
           expect(invocation.done?).to eq(true)
           expect(invocation.expected_status_unmet).to(be_nil)
           expect(invocation.expected_content_type_unmet).to(be_nil)
           expect(invocation.expected_headers_unmet).to(be_nil) if test_case.has_expected_headers?
           expect(invocation.expected_schema_unmet).to(be_nil)
+          expect(invocation.assertions_unmet).to(be_nil) if test_case.has_assertions?
+          expect(invocation.postconditions_unmet).to(be_nil) if test_case.service.has_postconditions? and not(counterexample)
+          expect(invocation.expected_error_unmet).to(be_nil) if test_case.has_expected_error?
         end
-
-        it 'meets all specific assertions' do
-          expect(invocation.assertions_unmet).to(be_nil)
-        end if test_case.has_assertions?
-
-        it 'meets declarative postconditions' do
-          expect(invocation.postconditions_unmet).to(be_nil)
-        end if test_case.service.has_postconditions? and not(counterexample)
-
-        it 'meets the specific error messages, if any (backward compatibility)' do
-          expect(@invocation.expected_error_unmet).to(be_nil)
-        end if test_case.has_expected_error?
       end
-      @rspec_config = true
     end
 
   end # class Tester

data/lib/webspicy/version.rb

@@ -1,8 +1,8 @@
 module Webspicy
   module Version
     MAJOR = 0
-    MINOR = 8
-    TINY  = 6
+    MINOR = 9
+    TINY  = 0
   end
   VERSION = "#{Version::MAJOR}.#{Version::MINOR}.#{Version::TINY}"
 end

data/spec/unit/client/test_around.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+module Webspicy
+  describe Client, "around" do
+
+    it 'work with no around at all' do
+      config = Configuration.new
+
+      seen = false
+      block = ->(){ seen = true }
+
+      scope = Scope.new(config)
+      Client.new(scope).around(1, 2, 3, &block)
+      expect(seen).to be(true)
+    end
+
+    it 'work with one around' do
+      config = Configuration.new
+
+      seen = false
+      seen_args = nil
+      config.around_each do |*args, &bl|
+        seen_args = args
+        bl.call
+      end
+
+      scope = Scope.new(config)
+      block = ->(){ seen = true }
+      Client.new(scope).around(1, 2, 3, &block)
+
+      expect(seen_args[0...-1]).to eql([1, 2, 3])
+      expect(seen).to be(true)
+    end
+
+    it 'works with two arounds' do
+      config = Configuration.new
+
+      seen = false
+
+      seen_args = []
+      config.around_each do |*args, &bl|
+        seen_args << args
+        bl.call
+      end
+      config.around_each do |*args, &bl|
+        seen_args << args
+        bl.call
+      end
+
+      scope = Scope.new(config)
+      block = ->(){ seen = true }
+      Client.new(scope).around(1, 2, 3, &block)
+
+      expect(seen_args.size).to eql(2)
+      expect(seen_args.all?{|sa| sa[0...-1] == [1,2,3] }).to be(true)
+      expect(seen).to be(true)
+    end
+
+  end
+end

data/spec/unit/resource/test_instantiate_url.rb

@@ -16,6 +16,13 @@ module Webspicy
       expect(params).to eq(baz: "coz")
     end
 
+    it 'instantiates placeholders and strips corresponding params even when multiple' do
+      r = Resource.new(url: "/test/{foo}/url/{bar}")
+      url, params = r.instantiate_url(foo: "bar", bar: "baz", baz: "coz")
+      expect(url).to eq("/test/bar/url/baz")
+      expect(params).to eq(baz: "coz")
+    end
+
     it 'supports placeholders corresponding to subentities' do
       r = Resource.new(url: "/test/{foo.id}/url")
       url, params = r.instantiate_url(foo: {id: "bar"}, baz: "coz")

data/spec/unit/test_configuration.rb

@@ -144,6 +144,30 @@ module Webspicy
       end
     end
 
+    describe 'before/after/listeners' do
+
+      let(:before_eacher) { ->(){} }
+      let(:after_eacher) { ->(){} }
+      let(:before_aller) { ->(){} }
+      let(:after_aller) { ->(){} }
+      let(:config) do
+        Configuration.new(Path.dir/'resource') do |c|
+          c.before_all(&before_aller)
+          c.before_each(&before_eacher)
+          c.after_each(&after_eacher)
+          c.after_all(&after_aller)
+        end
+      end
+
+      it 'correctly classifies and returns them on listeners' do
+        expect(config.listeners(:before_each)).to eql([before_eacher])
+        expect(config.listeners(:after_each)).to eql([after_eacher])
+        expect(config.listeners(:before_all)).to eql([before_aller])
+        expect(config.listeners(:after_all)).to eql([after_aller])
+      end
+
+    end
+
     describe 'dup' do
 
       let(:original) do
@@ -166,6 +190,7 @@ module Webspicy
         duped = original.dup do |d|
           d.rspec_options << "--hello"
           d.before_each do end
+          d.after_each do end
           d.precondition Class.new
           d.postcondition Class.new
         end
@@ -174,8 +199,9 @@ module Webspicy
         expect(duped.preconditions.size).to eq(1)
         expect(duped.postconditions.size).to eq(1)
 
-        expect(duped.before_listeners.size).to eq(1)
-        expect(original.before_listeners.size).to eq(0)
+        expect(duped.listeners(:before_each).size).to eq(1)
+        expect(original.listeners(:before_each).size).to eq(0)
+
         expect(original.preconditions.size).to eq(0)
         expect(original.postconditions.size).to eq(0)
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: webspicy
 version: !ruby/object:Gem::Version
-  version: 0.8.6
+  version: 0.9.0
 platform: ruby
 authors:
 - Bernard Lambeau
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '3.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '3.7'
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
@@ -163,6 +163,7 @@ files:
 - lib/webspicy/tester/asserter.rb
 - lib/webspicy/tester/assertions.rb
 - lib/webspicy/version.rb
+- spec/unit/client/test_around.rb
 - spec/unit/configuration/config.rb
 - spec/unit/resource/service/test_dress_params.rb
 - spec/unit/resource/test_instantiate_url.rb