web_pipe 0.13.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a993e68cff01cb6b0ef493b6bdf3207e62a7baca650302c9f65024f3981c18a
-  data.tar.gz: dc94f7dfabc97ad712a058f725e85831c38fe2658f42adeca3243b29f10273f9
+  metadata.gz: 248232882dde49a235e15080f2c9c2abb1188e29e10f228f43d0c30c6c5f116f
+  data.tar.gz: ad6afa0399cdb99d80ef46fb1bcdde037e987e8fe01756f2c667301a9f622d5e
 SHA512:
-  metadata.gz: 2e5925278ef21f20b3c9b8ae25f7bd614c7e17b278693f3521f018cefe1acd1ef63116aba61a9722bc1f4d5b98bfbeb56a6e03d0d246ac359aa595e4c451f6eb
-  data.tar.gz: baf191023d9a19ed7facfc77f3107db45e2adb1949a25e4fc306b0a9f85e061e474fc557848beb469aaf0c5ad0446918b9c285b63cc5501bf21d31c19229878c
+  metadata.gz: 399f912c144ac66bd1bfeaf58708a8e52ed7e296f5e592c9f9422fd3fd6553a4e3c16c0fec2986cf4fd278857d5acd1078d7b1a7e9e0e07ad9f18824303953ba
+  data.tar.gz: 41c539bee15aa9d3f8ae23bc88cd02ba5dc113ad9245290c330a269917716d12da5637852153d2f9bd7b324e8101f2a1329b267e5ebc409ae0c5cb419cd932f8

data/.rubocop.yml

@@ -13,3 +13,6 @@ Metrics/BlockLength:
 
 Naming/AccessorMethodName:
   Enabled: false
+
+Style/HashConversion:
+  Enabled: false

data/CHANGELOG.md

@@ -4,6 +4,15 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## [0.14.0] - 2021-04-14
+### Added
+- Inspecting operations
+  [#42](https://github.com/waiting-for-dev/web_pipe/pull/42)
+- Inspecting middlewares
+  [#43](https://github.com/waiting-for-dev/web_pipe/pull/43)
+- Testing support
+  [#44](https://github.com/waiting-for-dev/web_pipe/pull/44)
+
 ## [0.13.0] - 2021-01-15
 ### Added
 - **BREAKING**. Ruby 2.5 deprecated.

data/README.md

@@ -20,9 +20,11 @@ extension](docs/extensions/rails.md).
    1. [Resolving operations](docs/plugging_operations/resolving_operations.md)
    1. [Injecting operations](docs/plugging_operations/injecting_operations.md)
    1. [Composing operations](docs/plugging_operations/composing_operations.md)
+   1. [Inspecting operations](docs/plugging_operations/inspecting_operations.md)
 1. [Using rack middlewares](docs/using_rack_middlewares.md)
    1. [Injecting middlewares](docs/using_rack_middlewares/injecting_middlewares.md)
    1. [Composing middlewares](docs/using_rack_middlewares/composing_middlewares.md)
+   1. [Inspecting middlewares](docs/using_rack_middlewares/inspecting_middlewares.md)
 1. [Composing applications](docs/composing_applications.md)
 1. [Connection struct](docs/connection_struct.md)
    1. [Sharing data downstream](docs/connection_struct/sharing_data_downstream.md)
@@ -32,6 +34,7 @@ extension](docs/extensions/rails.md).
 1. [Plugs](docs/plugs.md)
    1. [Config](docs/plugs/config.md)
    1. [ContentType](docs/plugs/content_type.md)
+1. [Testing](docs/testing.md)
 1. [Extensions](docs/extensions.md)
    1. [Container](docs/extensions/container.md)
    1. [Cookies](docs/extensions/cookies.md)

data/docs/plugging_operations/inspecting_operations.md

@@ -0,0 +1,25 @@
+# Inspecting operations
+
+Once a `WebPipe` class is initialized all its operations get resolved. It
+happens because they are whether [resolved](resolving_operations.md) or
+[injected](injecting_operations.md). The final result can be accessed through
+the `#operations` method:
+
+
+```ruby
+require 'web_pipe'
+require 'web_pipe/conn_support/builder'
+
+class MyApp
+  include WebPipe
+
+  plug(:hello) do |conn|
+    conn.set_response_body('Hello world!')
+  end
+end
+
+app = MyApp.new
+conn = WebPipe::ConnSupport::Builder.call(Rack::MockRequest.env_for)
+new_conn = app.operations[:hello].call(con)
+conn.response_body #=> ['Hello world!']
+```

data/docs/testing.md

@@ -0,0 +1,64 @@
+# Testing
+
+## Testing the rack application
+
+A `WebPipe` instance is a just a rack application, so you can test it as such:
+
+```ruby
+require 'web_pipe'
+require 'rack/mock'
+require 'rspec'
+
+class MyApp
+  include WebPipe
+
+  plug :response
+
+  private
+
+  def response(conn)
+    conn
+      .set_response_body('Hello!')
+      .set_status(200)
+  end
+end
+
+RSpec.describe MyApp do
+  it 'responds with 200 status code' do
+    env = Rack::MockRequest.env_for
+
+    status, _headers, _body = described_class.new.call(env)
+
+    expect(status).to be(200)
+  end
+end
+```
+
+## Testing individual operations
+
+Each operation in a pipe is an isolated function that takes a connection struct
+as argument. You can leverage [the inspection of
+operations](docs/plugging_operations/inspecting_operations.md) to unit test them.
+
+There's also a `WebPipe::TestSupport` module that you can include to get a
+helper method `#build_conn` to easily create a connection struct.
+
+```ruby
+RSpec.describe MyApp do
+  include WebPipe::TestSupport
+
+  describe '#response' do
+    it 'responds with 200 status code' do
+      conn = build_conn
+      operation = described_class.new.operations[:response]
+
+      new_conn = operation.call(conn)
+
+      expect(new_conn.status).to be(200)
+    end
+  end
+end
+```
+
+Check the API documentation for the options you can provide to
+[`#build_conn`](https://www.rubydoc.info/github/waiting-for-dev/web_pipe/master/WebPipe/TestSupport#build_conn).

data/docs/using_rack_middlewares/inspecting_middlewares.md

@@ -0,0 +1,34 @@
+# Inspecting middlewares
+
+Once a `WebPipe` class is initialized all its middlewares get resolved. They
+can be accessed through the `#middlewares` method.
+
+Each middleware is represented by a
+`WebPipe::RackSupport::MiddlewareSpecification` instance, which contains two
+accessors: `middleware` returns the middleware class, while `options` returns
+an array with the arguments that are provided to the middleware on initialization.
+
+Kepp in mind that every middleware is resolved as an array. This is because it
+can in fact be composed by an chain of middlewares built through
+[composition](composing_middlewares.md).
+
+
+```ruby
+require 'web_pipe'
+require 'rack/session'
+
+class MyApp
+  include WebPipe
+  
+  use :session, Rack::Session::Cookie, key: 'my_app.session', secret: 'long'
+
+  plug(:hello) do |conn|
+    conn.set_response_body('Hello world!')
+  end
+end
+
+app = MyApp.new
+session_middleware = app.middlewares[:session][0]
+session_middleware.middleware # => Rack::Session::Cookie
+session_middleware.options # => [{ key: 'my_app.session', secret: 'long' }]
+```

data/lib/web_pipe/dsl/instance_methods.rb

@@ -42,10 +42,10 @@ module WebPipe
       # @return [RackSupport::AppWithMiddlewares[]]
       attr_reader :rack_app
 
-      # @return [ConnSupport::Composition::Operation[]]
+      # @return [Hash<Plug::Name[], ConnSupport::Composition::Operation[]>]
       attr_reader :operations
 
-      # @return [Array<RackSupport::Middlewares>]
+      # @return [Hash<RackSupport::MiddlewareSpecification::Name[], Array<RackSupport::Middlewares>]
       attr_reader :middlewares
 
       # rubocop:disable Metrics/AbcSize
@@ -58,8 +58,8 @@ module WebPipe
         @operations = Plug.inject_and_resolve(
           self.class.plugs, injections[:plugs], container, self
         )
-        app = App.new(operations)
-        @rack_app = RackSupport::AppWithMiddlewares.new(middlewares, app)
+        app = App.new(operations.values)
+        @rack_app = RackSupport::AppWithMiddlewares.new(middlewares.values.flatten, app)
       end
       # rubocop:enable Metrics/AbcSize
 
@@ -105,7 +105,7 @@ module WebPipe
       # @see ConnSupport::Composition
       def to_proc
         ConnSupport::Composition
-          .new(operations)
+          .new(operations.values)
           .method(:call)
           .to_proc
       end

data/lib/web_pipe/plug.rb

@@ -97,15 +97,26 @@ module WebPipe
     # @container container [Types::Container[]]
     # @object [Object]
     #
-    # @return [Array<ConnSupport::Composition::Operation[]>]
+    # @return [Hash<Name[], ConnSupport::Composition::Operation[]>]
     def self.inject_and_resolve(plugs, injections, container, object)
-      plugs.map do |plug|
-        if injections.key?(plug.name)
-          plug.with(injections[plug.name])
+      Hash[
+        plugs.map do |plug|
+          inject_and_resolve_plug(plug, injections, container, object)
+        end
+      ]
+    end
+
+    def self.inject_and_resolve_plug(plug, injections, container, object)
+      name = plug.name
+      [
+        name,
+        if injections.key?(name)
+          plug.with(injections[name])
         else
           plug
         end.call(container, object)
-      end
+      ]
     end
+    private_class_method :inject_and_resolve_plug
   end
 end

data/lib/web_pipe/rack_support/middleware_specification.rb

@@ -15,8 +15,6 @@ module WebPipe
     # - A single element array where it is an instance of a class
     # including {WebPipe}. This specifies all {RackSupport::Middlewares} for
     # that {WebPipe}.
-    #
-    # @api private
     class MiddlewareSpecification < Dry::Struct
       # Type for the name given to a middleware.
       Name = Types::Strict::Symbol.constructor(&:to_sym)
@@ -44,16 +42,27 @@ module WebPipe
       # @param middleware_specifications [Array<MiddlewareSpecification>]
       # @param injections [Injections[]]
       #
-      # @return [Array<RackSupport::Middleware>]
+      # @return [Hash<Name[], Array<RackSupport::Middleware>]
       def self.inject_and_resolve(middleware_specifications, injections)
-        middleware_specifications.map do |spec|
-          if injections.key?(spec.name)
-            spec.with(injections[spec.name])
+        Hash[
+          middleware_specifications.map do |middleware_spec|
+            inject_and_resolve_middleware(middleware_spec, injections)
+          end
+        ]
+      end
+
+      def self.inject_and_resolve_middleware(middleware_spec, injections)
+        name = middleware_spec.name
+        [
+          name,
+          if injections.key?(name)
+            middleware_spec.with(injections[name])
           else
-            spec
+            middleware_spec
           end.call
-        end.flatten
+        ]
       end
+      private_class_method :inject_and_resolve_middleware
 
       # Resolves {RackSupport::Middlewares} from given specification.
       #
@@ -63,7 +72,7 @@ module WebPipe
         options = spec[1..] || Types::EMPTY_ARRAY
         case klass
         when WebPipe
-          klass.middlewares
+          klass.middlewares.values
         when Class
           [Middleware.new(middleware: klass, options: options)]
         end

data/lib/web_pipe/test_support.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'web_pipe/conn_support/builder'
+require 'rack/mock'
+
+module WebPipe
+  # Test helper methods.
+  #
+  # This module is meant to be included in a test file to provide helper
+  # methods.
+  module TestSupport
+    # Builds a {WebPipe::Conn}
+    #
+    # @param uri [String] URI that will be used to populate the request
+    # attributes
+    # @param attributes [Hash<Symbol, Any>] Manually set attributes for the
+    # struct. It overrides what is taken from the `uri` parameter
+    # @param env_opts [Hash] Options to be added to the `env` from which the
+    # connection struct is created. See {Rack::MockRequest.env_for}.
+    # @return [Conn]
+    def build_conn(uri = '', attributes: {}, env_opts: {})
+      env = Rack::MockRequest.env_for(uri, env_opts)
+      ConnSupport::Builder
+        .call(env)
+        .new(attributes)
+    end
+  end
+end

data/lib/web_pipe/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module WebPipe
-  VERSION = '0.13.0'
+  VERSION = '0.14.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: web_pipe
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Marc Busqué
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-01-15 00:00:00.000000000 Z
+date: 2021-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-monads
@@ -289,6 +289,7 @@ files:
 - docs/plugging_operations.md
 - docs/plugging_operations/composing_operations.md
 - docs/plugging_operations/injecting_operations.md
+- docs/plugging_operations/inspecting_operations.md
 - docs/plugging_operations/resolving_operations.md
 - docs/plugs.md
 - docs/plugs/config.md
@@ -296,9 +297,11 @@ files:
 - docs/recipes/dry_rb_integration.md
 - docs/recipes/hanami_router_integration.md
 - docs/recipes/using_all_restful_methods.md
+- docs/testing.md
 - docs/using_rack_middlewares.md
 - docs/using_rack_middlewares/composing_middlewares.md
 - docs/using_rack_middlewares/injecting_middlewares.md
+- docs/using_rack_middlewares/inspecting_middlewares.md
 - lib/web_pipe.rb
 - lib/web_pipe/app.rb
 - lib/web_pipe/conn.rb
@@ -331,6 +334,7 @@ files:
 - lib/web_pipe/rack_support/app_with_middlewares.rb
 - lib/web_pipe/rack_support/middleware.rb
 - lib/web_pipe/rack_support/middleware_specification.rb
+- lib/web_pipe/test_support.rb
 - lib/web_pipe/types.rb
 - lib/web_pipe/version.rb
 - web_pipe.gemspec
@@ -356,7 +360,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Rack application builder through a pipe of operations on an immutable struct.