web_pipe 0.13.0 → 0.16.0

data/lib/web_pipe.rb

@@ -1,23 +1,83 @@
 # frozen_string_literal: true
 
+require 'dry/core/extensions'
 require 'web_pipe/dsl/builder'
 
-# See [the
-# README](https://github.com/waiting-for-dev/web_pipe/blob/master/README.md)
-# for a general overview of this library.
+# Entry-point for the DSL layer.
+#
+# Including this module into your class adds to it a DSL layer which makes it
+# convenient to interact with an instance of {WebPipe::Pipe} transparently. It
+# means that the DSL is actually an optional layer, and you can achieve
+# everything by using {WebPipe::Pipe} instances.
+#
+# Your class gets access to {WebPipe::DSL::ClassContext::DSL_METHODS} at the
+# class level, while {WebPipe::DSL::InstanceContext::PIPE_METHODS} are available
+# for every instance of it. Both groups of methods are delegating to
+# {WebPipe::Pipe}, so you can look there for documentation.
+#
+# @example
+#   class HelloWorld
+#     include WebPipe
+#
+#     use :runtime, Rack::Runtime
+#
+#     plug :content_type do |conn|
+#       conn.add_response_header('Content-Type', 'plain/text')
+#     end
+#
+#     plug :render do |conn|
+#       conn.set_response_body('Hello, World!')
+#     end
+#   end
+#
+# The instance of your class is itself the final rack application. When you
+# initialize it, you have the chance to inject different plugs or middlewares
+# from those defined at the class level.
+#
+# @example
+#   HelloWorld.new(
+#     middlewares: {
+#       runtime: [Class.new do
+#         def initialize(app)
+#           @app = app
+#         end
+#
+#         def call(env)
+#           status, headers, body = @app.call(env)
+#           [status, headers.merge('Injected' => '1'), body]
+#         end
+#       end]
+#     },
+#     plugs: {
+#       render: ->(conn) { conn.set_response_body('Injected!') }
+#     }
+#   )
 module WebPipe
   extend Dry::Core::Extensions
 
-  # Including just delegates to an instance of `Builder`, so
-  # `Builder#included` is finally called.
+  # Called via {Module#include}, makes available web_pipe's DSL.
+  #
+  # Includes an instance of `Builder`. That means that `Builder#included` is
+  # eventually called.
   def self.included(klass)
     klass.include(call)
   end
 
+  # Chained to {Module#include} to make the DSL available and provide options.
+  #
+  # @param container [#[]] Container from where resolve operations. See
+  # {WebPipe::Plug}.
+  #
+  # @example
+  #   include WebPipe.call(container: Container)
   def self.call(**opts)
     DSL::Builder.new(**opts)
   end
 
+  register_extension :container do
+    require 'web_pipe/extensions/container/container'
+  end
+
   register_extension :cookies do
     require 'web_pipe/extensions/cookies/cookies'
   end
@@ -27,24 +87,16 @@ module WebPipe
     require 'web_pipe/extensions/dry_schema/plugs/sanitize_params'
   end
 
-  register_extension :dry_view do
-    require 'web_pipe/extensions/dry_view/dry_view'
-  end
-
-  register_extension :container do
-    require 'web_pipe/extensions/container/container'
-  end
-
   register_extension :flash do
     require 'web_pipe/extensions/flash/flash'
   end
 
-  register_extension :router_params do
-    require 'web_pipe/extensions/router_params/router_params'
+  register_extension :hanami_view do
+    require 'web_pipe/extensions/hanami_view/hanami_view'
   end
 
-  register_extension :redirect do
-    require 'web_pipe/extensions/redirect/redirect'
+  register_extension :not_found do
+    require 'web_pipe/extensions/not_found/not_found'
   end
 
   register_extension :params do
@@ -55,6 +107,14 @@ module WebPipe
     require 'web_pipe/extensions/rails/rails'
   end
 
+  register_extension :redirect do
+    require 'web_pipe/extensions/redirect/redirect'
+  end
+
+  register_extension :router_params do
+    require 'web_pipe/extensions/router_params/router_params'
+  end
+
   register_extension :session do
     require 'web_pipe/extensions/session/session'
   end

data/web_pipe.gemspec

@@ -12,6 +12,7 @@ Gem::Specification.new do |spec|
 
   spec.summary       = 'Rack application builder through a pipe of operations on an immutable struct.'
   spec.homepage      = 'https://github.com/waiting-for-dev/web_pipe'
+  spec.licenses      = ['MIT']
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.
@@ -43,8 +44,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'dry-schema', '~> 1.0'
   spec.add_development_dependency 'dry-transformer', '~> 0.1'
-  # TODO: Readd when dry-rb 0.8 is released (ruby 3.0 support)
-  # spec.add_development_dependency 'dry-view', '~> 0.8'
   spec.add_development_dependency 'pry-byebug'
   spec.add_development_dependency 'rack-flash3', '~> 1.0'
   spec.add_development_dependency 'rack-test', '~> 1.1'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: web_pipe
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.16.0
 platform: ruby
 authors:
 - Marc Busqué
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-01-15 00:00:00.000000000 Z
+date: 2021-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-monads
@@ -277,8 +277,9 @@ files:
 - docs/extensions/container.md
 - docs/extensions/cookies.md
 - docs/extensions/dry_schema.md
-- docs/extensions/dry_view.md
 - docs/extensions/flash.md
+- docs/extensions/hanami_view.md
+- docs/extensions/not_found.md
 - docs/extensions/params.md
 - docs/extensions/rails.md
 - docs/extensions/redirect.md
@@ -289,16 +290,19 @@ 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
 - docs/plugs/content_type.md
-- docs/recipes/dry_rb_integration.md
+- docs/recipes/hanami_2_and_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
@@ -309,14 +313,14 @@ files:
 - lib/web_pipe/conn_support/types.rb
 - lib/web_pipe/dsl/builder.rb
 - lib/web_pipe/dsl/class_context.rb
-- lib/web_pipe/dsl/dsl_context.rb
-- lib/web_pipe/dsl/instance_methods.rb
+- lib/web_pipe/dsl/instance_context.rb
 - lib/web_pipe/extensions/container/container.rb
 - lib/web_pipe/extensions/cookies/cookies.rb
 - lib/web_pipe/extensions/dry_schema/dry_schema.rb
 - lib/web_pipe/extensions/dry_schema/plugs/sanitize_params.rb
-- lib/web_pipe/extensions/dry_view/dry_view.rb
 - lib/web_pipe/extensions/flash/flash.rb
+- lib/web_pipe/extensions/hanami_view/hanami_view.rb
+- lib/web_pipe/extensions/not_found/not_found.rb
 - lib/web_pipe/extensions/params/params.rb
 - lib/web_pipe/extensions/params/params/transf.rb
 - lib/web_pipe/extensions/rails/rails.rb
@@ -324,6 +328,7 @@ files:
 - lib/web_pipe/extensions/router_params/router_params.rb
 - lib/web_pipe/extensions/session/session.rb
 - lib/web_pipe/extensions/url/url.rb
+- lib/web_pipe/pipe.rb
 - lib/web_pipe/plug.rb
 - lib/web_pipe/plugs.rb
 - lib/web_pipe/plugs/config.rb
@@ -331,11 +336,13 @@ 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
 homepage: https://github.com/waiting-for-dev/web_pipe
-licenses: []
+licenses:
+- MIT
 metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/waiting-for-dev/web_pipe
@@ -356,7 +363,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.

data/docs/recipes/dry_rb_integration.md

@@ -1,18 +0,0 @@
-# dry-rb integration
-
-`web_pipe` has been designed to integrate smoothly with
-[dry-rb](https://dry-rb.org/) ecosystem. It shares same design
-principles and it ships with some extensions which even make this
-integration tighter (like
-[`:dry-view`](../extensions/dry_view.md) or
-[`:dry-schema`](../extensions/dry_schema.md) extensions).
-
-If you want to use `web_pipe` with the rest of dry-rb libraries,
-your best bet is to use
-[`dry-web-web_pipe`](https://github.com/waiting-for-dev/dry-web-web_pipe)
-skeleton generator. It is a fork of
-[`dry-web-roda`](https://github.com/dry-rb/dry-web-roda) with
-`roda` dependency switched to a combination of `web_pipe` and
-[`hanami-router`](https://github.com/hanami/router).
-
-Look at `dry-web-web_pipe` README for more details.

data/lib/web_pipe/dsl/dsl_context.rb

@@ -1,85 +0,0 @@
-# frozen_string_literal: true
-
-require 'web_pipe'
-require 'web_pipe/types'
-require 'web_pipe/plug'
-require 'web_pipe/rack_support/middleware_specification'
-
-module WebPipe
-  module DSL
-    # Defines the DSL for the pipe class and keeps it state.
-    #
-    # This allows adding rack middlewares and plugs at the class
-    # definition level.
-    #
-    # @api private
-    class DSLContext
-      # @!attribute middleware_specifications
-      # @return [Array<RackSupport::MiddlewareSpecifications>]
-      attr_reader :middleware_specifications
-
-      # @!attribute plugs
-      # @return [Array<Plug>]
-      attr_reader :plugs
-
-      def initialize(middleware_specifications, plugs)
-        @middleware_specifications = Types.Array(
-          RackSupport::MiddlewareSpecification
-        )[middleware_specifications]
-        @plugs = Types.Array(Plug::Instance)[plugs]
-      end
-
-      # Creates and add rack middleware specifications to the stack.
-      #
-      # The spec can be given in two forms:
-      #
-      # - As one or two arguments, first one being a
-      # rack middleware class and second one optionally its
-      # initialization options.
-      # - As a {WebPipe} class instance, in which case all its rack
-      # middlewares will be considered.
-      #
-      # @param name [RackSupport::MiddlewareSpecification::Name[]]
-      # @param spec [RackSupport::MiddlewareSpecification::Spec[]]
-      #
-      # @return [Array<RackSupport::Middleware>]
-      def use(name, *spec)
-        middleware_specifications << RackSupport::MiddlewareSpecification.new(name: name, spec: spec)
-      end
-
-      # Creates and adds a plug to the stack.
-      #
-      # The spec can be given as a {Plug::Spec}, as a block (which
-      # is captured into a {Proc}, one of the options for a
-      # {Plug::Spec} or as a {WebPipe} (in which case all its plugs
-      # will be composed).
-      #
-      # @param name [Plug::Name[]]
-      # @param spec [Plug::Spec[], WebPipe]
-      # @param block_spec [Proc]
-      #
-      # @return [Array<Plug>]
-      def plug(name, spec = nil, &block_spec)
-        plug_spec = if spec.is_a?(WebPipe)
-                      spec.to_proc
-                    elsif spec
-                      spec
-                    else
-                      block_spec
-                    end
-
-        plugs << Plug.new(name: name, spec: plug_spec)
-      end
-
-      # Adds middlewares and plugs from a WebPipe to respective
-      # stacks.
-      #
-      # @param name [Plug::Name[], Middleware::Name[]]
-      # @param spec [WebPipe]
-      def compose(name, spec)
-        use(name, spec)
-        plug(name, spec)
-      end
-    end
-  end
-end

data/lib/web_pipe/dsl/instance_methods.rb

@@ -1,114 +0,0 @@
-# frozen_string_literal: true
-
-require 'web_pipe/types'
-require 'web_pipe/conn'
-require 'web_pipe/app'
-require 'web_pipe/plug'
-require 'web_pipe/rack_support/app_with_middlewares'
-require 'web_pipe/rack_support/middleware_specification'
-require 'web_pipe/conn_support/composition'
-
-module WebPipe
-  module DSL
-    # Instance methods for the pipe.
-    #
-    # It is from here that you get the rack application you can route
-    # to. The initialization phase gives you the chance to inject any
-    # of the plugs or middlewares, while the instance you get has the
-    # `#call` method expected by rack.
-    #
-    # The pipe state can be accessed through the pipe class, which
-    # has been configured through {ClassContext}.
-    #
-    # @api private
-    module InstanceMethods
-      # No injections at all.
-      EMPTY_INJECTIONS = {
-        plugs: Types::EMPTY_HASH,
-        middlewares: Types::EMPTY_HASH
-      }.freeze
-
-      # Type for how plugs and middlewares should be injected.
-      Injections = Types::Strict::Hash.schema(
-        plugs: Plug::Injections,
-        middlewares: RackSupport::MiddlewareSpecification::Injections
-      )
-
-      # @!attribute [r] injections [Injections[]]
-      #   Injected plugs and middlewares that allow overriding what
-      # has been configured.
-      attr_reader :injections
-
-      # @return [RackSupport::AppWithMiddlewares[]]
-      attr_reader :rack_app
-
-      # @return [ConnSupport::Composition::Operation[]]
-      attr_reader :operations
-
-      # @return [Array<RackSupport::Middlewares>]
-      attr_reader :middlewares
-
-      # rubocop:disable Metrics/AbcSize
-      def initialize(injects = EMPTY_INJECTIONS)
-        @injections = Injections[injects]
-        container = self.class.container
-        @middlewares = RackSupport::MiddlewareSpecification.inject_and_resolve(
-          self.class.middleware_specifications, injections[:middlewares]
-        )
-        @operations = Plug.inject_and_resolve(
-          self.class.plugs, injections[:plugs], container, self
-        )
-        app = App.new(operations)
-        @rack_app = RackSupport::AppWithMiddlewares.new(middlewares, app)
-      end
-      # rubocop:enable Metrics/AbcSize
-
-      # Expected interface for rack.
-      #
-      # @param env [Hash] Rack env
-      #
-      # @return [Array] Rack response
-      def call(env)
-        rack_app.call(env)
-      end
-
-      # Proc for the composition of all operations.
-      #
-      # This can be used to plug a {WebPipe} itself as an operation.
-      #
-      # @example
-      #   class HtmlApp
-      #     include WebPipe
-      #
-      #     plug :html
-      #
-      #     private
-      #
-      #     def html(conn)
-      #       conn.add_response_header('Content-Type', 'text/html')
-      #     end
-      #   end
-      #
-      #   class App
-      #     include WebPipe
-      #
-      #     plug :html, &HtmlApp.new
-      #     plug :body
-      #
-      #     private
-      #
-      #     def body(conn)
-      #        conn.set_response_body('Hello, world!')
-      #     end
-      #   end
-      #
-      # @see ConnSupport::Composition
-      def to_proc
-        ConnSupport::Composition
-          .new(operations)
-          .method(:call)
-          .to_proc
-      end
-    end
-  end
-end

data/lib/web_pipe/extensions/dry_view/dry_view.rb

@@ -1,158 +0,0 @@
-# frozen_string_literal: true
-
-require 'web_pipe/types'
-require 'web_pipe/conn'
-require 'dry/view'
-
-#:nodoc:
-module WebPipe
-  # Integration with `dry-view` rendering system.
-  #
-  # This extensions adds a {#view} method to {WebPipe::Conn} which
-  # sets the string output of a `dry-view` view as response body.
-  #
-  # @example
-  #   WebPipe.load_extensions(:dry_view)
-  #
-  #   class SayHelloView < Dry::View
-  #     config.paths = [File.join(__dir__, '..', 'templates')]
-  #     config.template = 'say_hello'
-  #
-  #     expose :name
-  #   end
-  #
-  #   class App
-  #     include WebPipe
-  #
-  #     plug :render
-  #
-  #     def render(conn)
-  #       conn.view(SayHello.new, name: 'Joe')
-  #     end
-  #   end
-  #
-  # If there is a `:container` configured (in {Conn#config}), the view
-  # instance can be resolved from it.
-  #
-  # @example
-  #   WebPipe.load_extensions(:dry_view, :container)
-  #
-  #   class App
-  #     include WebPipe
-  #
-  #     Container = { 'views.say_hello' => SayHelloView.new }.freeze
-  #
-  #     plug :config_container, ->(conn) { conn.add_config(:container, Container) }
-  #     plug :render
-  #
-  #     def render(conn)
-  #       conn.view('views.say_hello', name: 'Joe')
-  #     end
-  #  end
-  #
-  # Context ({Dry::View::Context}) for the view can be set explicetly
-  # through the `context:` argument, as in a standard call to
-  # {Dry::View#call}. However, it is possible to leverage configured
-  # default context while still being able to inject request specific
-  # context. For that to work, `:view_context` should be present in
-  # {WebPipe::Conn#config}. Its value must be a lambda accepting the
-  # {Conn} instance and returning a hash, which will be passed to
-  # {Dry::View::Context#with} to create the final context at the
-  # moment {#view} is called.
-  #
-  # @example
-  #   class MyContext < Dry::View::Context
-  #     attr_reader :current_path
-  #
-  #     def initialize(current_path: nil, **options)
-  #       @current_path = current_path
-  #       super
-  #     end
-  #   end
-  #
-  #   class SayHelloView < Dry::View
-  #     config.paths = [File.join(__dir__, '..', 'templates')]
-  #     config.template = 'say_hello'
-  #     config.default_context = MyContext.new
-  #
-  #     expose :name
-  #   end
-  #
-  #   WebPipe.load_extensions(:url)
-  #
-  #   class App
-  #     include WebPipe
-  #
-  #     plug :config_view_context
-  #     plug :render
-  #
-  #     def config_view_context(conn)
-  #       conn.add_config(:view_context, ->(conn) {  { current_path: conn.full_path } })
-  #     end
-  #
-  #     def render(conn)
-  #       conn.view(SayHelloView.new, name: 'Joe') # `current_path`
-  #       # will be available in the view scope
-  #     end
-  #   end
-  #
-  # @see https://dry-rb.org/gems/dry-view/
-  # @see WebPipe::Container
-  module DryView
-    # Where to find in {#config} request's view context generator.
-    VIEW_CONTEXT_KEY = :view_context
-
-    # Default request's view context
-    DEFAULT_VIEW_CONTEXT = ->(_conn) { Types::EMPTY_HASH }
-
-    # Sets string output of a view as response body.
-    #
-    # If the view is not a {Dry::View} instance, it is resolved from
-    # the configured container.
-    #
-    # `kwargs` is used as the input for the view (the arguments that
-    # {Dry::View#call} receives). If they doesn't contain an explicit
-    # `context:` key, it can be added through the injection of the
-    # result of a lambda present in context's `:view_context`.(see
-    # {Dry::View::Context#with}).
-    #
-    # @param view_spec [Dry::View, Any]
-    # @param kwargs [Hash] Arguments to pass along to `Dry::View#call`
-    #
-    # @return WebPipe::Conn
-    def view(view_spec, **kwargs)
-      view_instance = view_instance(view_spec)
-      view_input = view_input(kwargs, view_instance)
-
-      set_response_body(
-        view_instance.call(
-          **view_input
-        ).to_str
-      )
-    end
-
-    private
-
-    def view_instance(view_spec)
-      return view_spec if view_spec.is_a?(Dry::View)
-
-      fetch_config(:container)[view_spec]
-    end
-
-    def view_input(kwargs, view_instance)
-      return kwargs if kwargs.key?(:context)
-
-      context = view_instance
-                .config
-                .default_context
-                .with(
-                  **fetch_config(
-                    VIEW_CONTEXT_KEY, DEFAULT_VIEW_CONTEXT
-                  ).call(self)
-                )
-      kwargs.merge(context: context)
-    end
-  end
-
-  Conn.include(DryView)
-end