web_pipe 0.15.0 → 0.15.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a8ebc7025774af2e5938efb5c76a0ff120bc386f449900781e3f05d35eb6a15
-  data.tar.gz: a6e03d72fb7cb3bd384cea1f51369f21a375b4a009b8409ef3a588600adc07b7
+  metadata.gz: 8148f2a5701baf60d74d238ed32b6fcdaadaaf5006431322222a081d005caa01
+  data.tar.gz: 90a38228ba60cd9637584b85cffd06d0271df5bd2d3d9bc721b3d3cb7de61287
 SHA512:
-  metadata.gz: 278d8402ec4ea79266eefd3ee558522af3923bb23232b3fcefd8574d73dc64c8106757f910a1c312ceed57889ee352e5955c19641601dfdcb47bcbbc63673bb8
-  data.tar.gz: 99ae42906946fbdda913bbf4f0cdd2cc1a6c3951ffb5972b52bb11b5caf882b6b6c286b68aca9d92ce0e6974d6168178860ae164d3d49af7bcb36556202b70dc
+  metadata.gz: 4bd1b21978116a5743d53106cc4c2b8f042dba4cbe63804adbc370174bf08a9221f563561b123a10445e5cb3f87b7672d9cf0ef8c1161e53a9b54f83ae3aba13
+  data.tar.gz: a0028185e4bfe8858206fc90c8e355891d3e9a14db81fad7076fd8c05960f01abd1418fc05bece3c6fe73585a5732e2f13318a6529e9d6fef75f4e86181da376

data/CHANGELOG.md

@@ -4,11 +4,16 @@ 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.15.1] - 2021-09-19
+### Added
+- `:not_found` extension
+  [#46](https://github.com/waiting-for-dev/web_pipe/pull/46)
+
 ## [0.15.0] - 2021-09-12
+### Added
 - **BREAKING**. Switch `dry_view` extension with `hanami_view`.
   [#45](https://github.com/waiting-for-dev/web_pipe/pull/45)
 
-### Added
 ## [0.14.0] - 2021-04-14
 ### Added
 - Inspecting operations

data/README.md

@@ -41,6 +41,7 @@ extension](docs/extensions/rails.md).
    1. [Flash](docs/extensions/flash.md)
    1. [Dry Schema](docs/extensions/dry_schema.md)
    1. [Hanami View](docs/extensions/hanami_view.md)
+   1. [Not found](docs/extensions/not_found.md)
    1. [Params](docs/extensions/params.md)
    1. [Rails](docs/extensions/rails.md)
    1. [Redirect](docs/extensions/redirect.md)

data/docs/extensions/not_found.md

@@ -0,0 +1,40 @@
+# Not found
+
+This extension helps to build a not-found response in a single method
+invocation. The `WebPipe::Conn#not_found` method will:
+
+- Set 404 as response status.
+- Set 'Not found' as the response body, or instead run a step configured in
+`:not_found_body_step` config key.
+- Halt the connection struct.
+
+```ruby
+require 'web_pipe'
+require 'web_pipe/plugs/config'
+
+WebPipe.load_extensions(:params, :not_found)
+
+class ShowItem
+  include 'web_pipe'
+
+  plug :config, WebPipe::Plugs::Config.(
+    not_found_body_step: ->(conn) { conn.set_response_body('Nothing') }
+  )
+
+  plug :fetch_item do |conn|
+    conn.add(:item, Item[params['id']])
+  end
+
+  plug :check_item do |conn|
+    if conn.fetch(:item)
+      conn
+    else
+      conn.not_found
+    end
+  end
+
+  plug :render do |conn|
+    conn.set_response_body(conn.fetch(:item).name)
+  end
+end
+```

data/lib/web_pipe/extensions/not_found/not_found.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+#:nodoc:
+module WebPipe
+  # Generates a not-found response
+  #
+  # This extension helps to build a not-found response in a single method
+  # invocation. The {#not_found} method will:
+  #
+  # - Set 404 as response status.
+  # - Set 'Not found' as the response body, or instead run a step configured in
+  # a `:not_found_body_step` config key.
+  # - Halt the connection struct.
+  #
+  # @example
+  #   require 'web_pipe'
+  #   require 'web_pipe/plugs/config'
+  #
+  #   WebPipe.load_extensions(:params, :not_found)
+  #
+  #   class ShowItem
+  #     include 'web_pipe'
+  #
+  #     plug :config, WebPipe::Plugs::Config.(
+  #       not_found_body_step: ->(conn) { conn.set_response_body('Nothing') }
+  #     )
+  #
+  #     plug :fetch_item do |conn|
+  #       conn.add(:item, Item[params['id']])
+  #     end
+  #
+  #     plug :check_item do |conn|
+  #       if conn.fetch(:item)
+  #         conn
+  #       else
+  #         conn.not_found
+  #       end
+  #     end
+  #
+  #     plug :render do |conn|
+  #       conn.set_response_body(conn.fetch(:item).name)
+  #     end
+  #   end
+  module NotFound
+    # @api private
+    RESPONSE_BODY_STEP_CONFIG_KEY = :not_found_body_step
+
+    # Generates the not-found response
+    #
+    # @return [WebPipe::Conn::Halted]
+    # @see NotFound
+    def not_found
+      set_status(404)
+        .then do |conn|
+          response_body_step = conn.fetch_config(RESPONSE_BODY_STEP_CONFIG_KEY,
+                                                 ->(c) { c.set_response_body('Not found') })
+
+          response_body_step.call(conn)
+        end.halt
+    end
+
+    Conn.include(NotFound)
+  end
+end

data/lib/web_pipe/version.rb

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

data/lib/web_pipe.rb

@@ -62,4 +62,8 @@ module WebPipe
   register_extension :url do
     require 'web_pipe/extensions/url/url'
   end
+
+  register_extension :not_found do
+    require 'web_pipe/extensions/not_found/not_found'
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: web_pipe
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.15.1
 platform: ruby
 authors:
 - Marc Busqué
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-09-12 00:00:00.000000000 Z
+date: 2021-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-monads
@@ -279,6 +279,7 @@ files:
 - docs/extensions/dry_schema.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
@@ -320,6 +321,7 @@ files:
 - lib/web_pipe/extensions/dry_schema/plugs/sanitize_params.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