web_pipe 0.8.0 → 0.9.0

data/lib/web_pipe/dsl/class_context.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'web_pipe/types'
 require 'web_pipe/dsl/dsl_context'
 
@@ -32,7 +34,7 @@ module WebPipe
         define_container
         define_dsl
       end
-      
+
       private
 
       def define_container
@@ -47,11 +49,11 @@ module WebPipe
         DSL_METHODS.each do |method|
           module_exec(dsl_context) do |dsl_context|
             define_method(method) do |*args, &block|
-              dsl_context.method(method).(*args, &block)
+              dsl_context.method(method).call(*args, &block)
             end
           end
         end
       end
     end
   end
-end
+end

data/lib/web_pipe/dsl/dsl_context.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'web_pipe'
 require 'web_pipe/types'
 require 'web_pipe/plug'
@@ -59,11 +61,11 @@ module WebPipe
       # @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
+                      spec.to_proc
+                    elsif spec
+                      spec
+                    else
+                      block_spec
                end
 
         plugs << Plug.new(name: name, spec: plug_spec)

data/lib/web_pipe/dsl/instance_methods.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'web_pipe/types'
 require 'web_pipe/conn'
 require 'web_pipe/app'
@@ -58,7 +60,7 @@ module WebPipe
         app = App.new(operations)
         @rack_app = RackSupport::AppWithMiddlewares.new(middlewares, app)
       end
-      
+
       # Expected interface for rack.
       #
       # @param env [Hash] Rack env
@@ -100,10 +102,10 @@ module WebPipe
       #
       # @see ConnSupport::Composition
       def to_proc
-        ConnSupport::Composition.
-          new(operations).
-          method(:call).
-          to_proc
+        ConnSupport::Composition
+          .new(operations)
+          .method(:call)
+          .to_proc
       end
     end
   end

data/lib/web_pipe/extensions/container/container.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'web_pipe'
 
 module WebPipe

data/lib/web_pipe/extensions/cookies/cookies.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'web_pipe'
 require 'web_pipe/types'
 require 'rack/utils'
@@ -8,7 +10,7 @@ module WebPipe
   # This extension helps with the addition of the `Set-Cookie` header
   # to the response, which is the way the server has to instruct the
   # browser to keep a cookie. A cookie can be added with the
-  # {#add_cookie} method, while it can be marked for deletion with
+  # {#set_cookie} method, while it can be marked for deletion with
   # {#delete_cookie}. Remember that marking a cookie for deletion just
   # means adding the same cookie name with an expiration time in the
   # past.
@@ -54,8 +56,7 @@ module WebPipe
     def request_cookies
       request.cookies
     end
-    
-    
+
     # @param key [String]
     # @param value [String]
     # @param opts [SET_COOKIE_OPTIONS[]]

data/lib/web_pipe/extensions/dry_schema/dry_schema.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'web_pipe'
 
 WebPipe.load_extensions(:params)

data/lib/web_pipe/extensions/dry_schema/plugs/sanitize_params.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'web_pipe/types'
 require 'web_pipe/extensions/dry_schema/dry_schema'
 
@@ -18,11 +20,11 @@ module WebPipe
       # @return [ConnSupport::Composition::Operation[], Types::Undefined]
       def self.call(schema, handler = Types::Undefined)
         lambda do |conn|
-          result = schema.(conn.params)
+          result = schema.call(conn.params)
           if result.success?
             conn.add_config(DrySchema::SANITIZED_PARAMS_KEY, result.output)
           else
-            get_handler(conn, handler).(conn, result)
+            get_handler(conn, handler).call(conn, result)
           end
         end
       end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'web_pipe/types'
 require 'web_pipe/conn'
 require 'dry/view'
@@ -17,7 +19,7 @@ module WebPipe
   #
   #     expose :name
   #   end
-  #     
+  #
   #   class App
   #     include WebPipe
   #
@@ -39,7 +41,7 @@ module WebPipe
   #
   #     Container = { 'views.say_hello' => SayHelloView.new }.freeze
   #
-  #     plug :config_container, ->(conn) { conn.add_config(:container, Container[Container]) }
+  #     plug :config_container, ->(conn) { conn.add_config(:container, Container) }
   #     plug :render
   #
   #     def render(conn)
@@ -75,6 +77,8 @@ module WebPipe
   #     expose :name
   #   end
   #
+  #   WebPipe.load_extensions(:url)
+  #
   #   class App
   #     include WebPipe
   #
@@ -118,7 +122,7 @@ module WebPipe
     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
@@ -137,12 +141,12 @@ module WebPipe
     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).(self)
-                   )
+      context = view_instance
+                .config
+                .default_context
+                .with(
+                  fetch_config(VIEW_CONTEXT_KEY, DEFAULT_VIEW_CONTEXT).call(self)
+                )
       kwargs.merge(context: context)
     end
   end

data/lib/web_pipe/extensions/flash/flash.rb

@@ -4,7 +4,7 @@ require 'web_pipe/conn'
 require 'web_pipe/conn_support/errors'
 
 module WebPipe
-  # Provides with a tipical flash messages functionality.
+  # Provides with a typical flash messages functionality.
   #
   # @example
   #   require 'web_pipe'
@@ -12,15 +12,15 @@ module WebPipe
   #   require 'rack-flash'
   #
   #   WebPipe.load_extensions(:flash)
-  #   
+  #
   #   class MyApp
   #     include WebPipe
   #
   #     use :session, Rack::Session::Cookie, secret: 'secret'
   #     use :flash, Rack::Flash
   #
-  #     plug :add_in_flash, ->(conn) { conn.add_flash(:notice, 'Hello world') }
-  #     plug :add_in_flash_now, ->(conn) { conn.add_flash_now(:notice_now, 'Hello world now') }
+  #     plug :add_to_flash, ->(conn) { conn.add_flash(:notice, 'Hello world') }
+  #     plug :add_to_flash_now, ->(conn) { conn.add_flash_now(:notice_now, 'Hello world now') }
   #   end
   #
   # Usually, you will end up making `conn.flash` available to your view system:
@@ -37,7 +37,7 @@ module WebPipe
   # @see https://github.com/nakajima/rack-flash
   module Flash
     RACK_FLASH_KEY = 'x-rack.flash'
-    
+
     # Returns the flash bag.
     #
     # @return [Rack::Flash::FlashHash]
@@ -47,8 +47,8 @@ module WebPipe
     def flash
       env.fetch(RACK_FLASH_KEY) do
         raise ConnSupport::MissingMiddlewareError.new(
-                'flash', 'Rack::Flash', 'https://rubygems.org/gems/rack-flash3'
-              )
+          'flash', 'Rack::Flash', 'https://rubygems.org/gems/rack-flash3'
+        )
       end
     end
 

data/lib/web_pipe/extensions/params/params/transf.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'transproc'
 
 module WebPipe
@@ -12,4 +14,4 @@ module WebPipe
       end
     end
   end
-end
+end

data/lib/web_pipe/extensions/params/params.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'web_pipe/types'
 require 'web_pipe/extensions/params/params/transf'
 
@@ -32,7 +34,7 @@ module WebPipe
   # @example
   #   # http://www.example.com?foo=bar
   #   conn.
-  #     add_config(:param_transformation, [:deep_symbolize_keys]).
+  #     add_config(:param_transformations, [:deep_symbolize_keys]).
   #     params #=> { foo: 'bar' }
   #
   # You can register your own transformation functions:
@@ -61,7 +63,7 @@ module WebPipe
   #   # http://www.example.com?foo=bar
   #   fake = ->(_params) { { fake: :params } }
   #   conn.
-  #     params(fake) #=> { fake: :params } 
+  #     params(fake) #=> { fake: :params }
   #
   # @see https://github.com/solnic/transproc
   module Params
@@ -80,7 +82,7 @@ module WebPipe
         acc.>>transformation(t)
       end
 
-      Transf[transformations].(request.params)
+      Transf[transformations].call(request.params)
     end
 
     private
@@ -90,10 +92,10 @@ module WebPipe
       if (transformation.fn.arity - transformation.args.count) == 1
         transformation
       else
-        Transf[*[spec, self]]
+        Transf[spec, self]
       end
     end
   end
 
   Conn.include(Params)
-end
+end

data/lib/web_pipe/extensions/redirect/redirect.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'web_pipe/types'
 
 module WebPipe
@@ -26,14 +28,14 @@ module WebPipe
 
     # Valid type for a redirect status code
     RedirectCode = Types::Strict::Integer.constrained(gteq: 300, lteq: 399)
-    
-    # @param path [String]
+
+    # @param location [String]
     # @param code [Integer]
-    def redirect(path, code = 302)
-      add_response_header(LOCATION_HEADER, path).
-        set_status(RedirectCode[code])
+    def redirect(location, code = 302)
+      add_response_header(LOCATION_HEADER, location)
+        .set_status(RedirectCode[code])
     end
   end
 
   Conn.include(Redirect)
-end
+end

data/lib/web_pipe/extensions/router_params/router_params.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'web_pipe'
 require 'web_pipe/types'
 
@@ -45,7 +47,7 @@ module WebPipe
   # @see https://github.com/hanami/router#string-matching-with-variables
   module RouterParams
     ROUTER_PARAM_KEY = 'router.params'
-    
+
     # @param params [Hash]
     # @param conn [WebPipe::Conn]
     #
@@ -56,4 +58,4 @@ module WebPipe
 
     WebPipe::Params::Transf.register(:router_params, method(:call))
   end
-end
+end

data/lib/web_pipe/extensions/session/session.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'web_pipe/conn'
 require 'web_pipe/types'
 require 'rack'
@@ -13,13 +15,14 @@ module WebPipe
   #
   # @example
   #   require 'web_pipe'
+  #   require 'rack/session'
   #
   #   WebPipe.load_extensions(:session)
   #
   #   class MyApp
   #     include WebPipe
   #
-  #     use Rack::Cookie, secret: 'top_secret'
+  #     use Rack::Session::Cookie, secret: 'top_secret'
   #
   #     plug :add_session, ->(conn) { conn.add_session('foo', 'bar') }
   #     plug :fetch_session, ->(conn) { conn.add(:foo, conn.fetch_session('foo')) }
@@ -36,8 +39,8 @@ module WebPipe
     def session
       env.fetch(Rack::RACK_SESSION) do
         raise ConnSupport::MissingMiddlewareError.new(
-                'session', 'Rack::Session', 'https://www.rubydoc.info/github/rack/rack/Rack/Session'
-              )
+          'session', 'Rack::Session', 'https://www.rubydoc.info/github/rack/rack/Rack/Session'
+        )
       end
     end
 
@@ -53,7 +56,6 @@ module WebPipe
       session.fetch(*args, &block)
     end
 
-
     # Adds given key/value pair to the session.
     #
     # @param key [SESSION_KEY[]] Session key

data/lib/web_pipe/extensions/url/url.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module WebPipe
   # Adds helper methods related to the request URL.
   #
@@ -56,4 +58,4 @@ module WebPipe
   end
 
   Conn.include(Url)
-end
+end

data/lib/web_pipe/plug.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'dry/struct'
 require 'web_pipe/types'
 require 'web_pipe/conn_support/composition'
@@ -81,10 +83,10 @@ module WebPipe
         spec
       elsif spec.nil?
         pipe.method(name)
-      elsif container[spec] && container[spec].respond_to?(:call)
+      elsif container[spec]&.respond_to?(:call)
         container[spec]
       else
-        raise InvalidPlugError.new(name)
+        raise InvalidPlugError, name
       end
     end
 
@@ -98,12 +100,12 @@ module WebPipe
     # @return [Array<ConnSupport::Composition::Operation[]>]
     def self.inject_and_resolve(plugs, injections, container, object)
       plugs.map do |plug|
-        if injections.has_key?(plug.name)
+        if injections.key?(plug.name)
           plug.with(injections[plug.name])
         else
           plug
-        end.(container, object)
+        end.call(container, object)
       end
     end
   end
-end
+end

data/lib/web_pipe/plugs.rb

@@ -1,5 +1,11 @@
+# frozen_string_literal: true
+
 module WebPipe
   # Namespace for builders of operations on {WebPipe::Conn}.
+  #
+  # Plugs are just higher order functions: functions which return functions
+  # (operations). For this reason, as a convention its interface is also
+  # `#call`.
   module Plugs
   end
-end
+end

data/lib/web_pipe/rack_support/app_with_middlewares.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'web_pipe/types'
 require 'web_pipe/rack_support/middleware'
 require 'rack'
@@ -24,7 +26,7 @@ module WebPipe
 
       # @return [Rack::Builder]
       attr_reader :builder
-      
+
       def initialize(rack_middlewares, app)
         @rack_middlewares = Types.Array(Middleware)[rack_middlewares]
         @app = App[app]

data/lib/web_pipe/rack_support/middleware.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'web_pipe/types'
 require 'dry/struct'
 

data/lib/web_pipe/rack_support/middleware_specification.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'dry/struct'
 require 'web_pipe/rack_support/middleware'
 require 'web_pipe/types'
@@ -45,11 +47,11 @@ module WebPipe
       # @return [Array<RackSupport::Middleware>]
       def self.inject_and_resolve(middleware_specifications, injections)
         middleware_specifications.map do |spec|
-          if injections.has_key?(spec.name)
+          if injections.key?(spec.name)
             spec.with(injections[spec.name])
           else
             spec
-          end.()
+          end.call
         end.flatten
       end
 
@@ -69,7 +71,7 @@ module WebPipe
       # Returns new instance with {#spec} replaced.
       #
       # @param new_spec [Spec[]]
-      # 
+      #
       # @return [MiddlewareSpecification]
       def with(new_spec)
         new(spec: new_spec)

data/lib/web_pipe/types.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'dry/types'
 require 'dry/core/constants'
 
@@ -9,4 +11,4 @@ module WebPipe
 
     Container = Interface(:[])
   end
-end
+end

data/lib/web_pipe/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module WebPipe
-  VERSION = "0.8.0"
+  VERSION = '0.9.0'
 end

data/lib/web_pipe.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'web_pipe/dsl/builder'
 
 # See [the
@@ -9,7 +11,7 @@ module WebPipe
   # Including just delegates to an instance of `Builder`, so
   # `Builder#included` is finally called.
   def self.included(klass)
-    klass.include(call())
+    klass.include(call)
   end
 
   def self.call(*args)
@@ -24,7 +26,7 @@ module WebPipe
     require 'web_pipe/extensions/dry_schema/dry_schema'
     require 'web_pipe/extensions/dry_schema/plugs/sanitize_params'
   end
-  
+
   register_extension :dry_view do
     require 'web_pipe/extensions/dry_view/dry_view'
   end
@@ -56,4 +58,4 @@ module WebPipe
   register_extension :url do
     require 'web_pipe/extensions/url/url'
   end
-end
+end

data/web_pipe.gemspec

@@ -1,54 +1,54 @@
-# coding: utf-8
+# frozen_string_literal: true
 
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "web_pipe/version"
+require 'web_pipe/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "web_pipe"
+  spec.name          = 'web_pipe'
   spec.version       = WebPipe::VERSION
-  spec.authors       = ["Marc Busqué"]
-  spec.email         = ["marc@lamarciana.com"]
+  spec.authors       = ['Marc Busqué']
+  spec.email         = ['marc@lamarciana.com']
 
-  spec.summary       = %q{Rack application builder through a pipe of operations on an immutable struct.}
-  spec.homepage      = "https://github.com/waiting-for-dev/web_pipe"
+  spec.summary       = 'Rack application builder through a pipe of operations on an immutable struct.'
+  spec.homepage      = 'https://github.com/waiting-for-dev/web_pipe'
 
   # 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.
   if spec.respond_to?(:metadata)
-    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
 
-    spec.metadata["homepage_uri"] = spec.homepage
-    spec.metadata["source_code_uri"] = spec.homepage
-    spec.metadata["changelog_uri"] = spec.homepage + '/CHANGELOG.md'
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = spec.homepage
+    spec.metadata['changelog_uri'] = spec.homepage + '/CHANGELOG.md'
   else
-    raise "RubyGems 2.0 or newer is required to protect against " \
-      "public gem pushes."
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
   end
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_runtime_dependency "rack", "~> 2.0"
-  spec.add_runtime_dependency "dry-monads", "~> 1.3"
-  spec.add_runtime_dependency "dry-types", "~> 1.1"
-  spec.add_runtime_dependency "dry-struct", "~> 1.0"
-  spec.add_runtime_dependency "transproc", "~> 1.1"
-
-  spec.add_development_dependency "bundler", "~> 1.17"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "rack-test", "~> 1.1"
-  spec.add_development_dependency "yard", "~> 0.9", ">= 0.9.20"
-  spec.add_development_dependency "redcarpet", "~> 3.4"
-  spec.add_development_dependency "pry-byebug"
-  spec.add_development_dependency "dry-view", "~> 0.7"
-  spec.add_development_dependency "rack-flash3", "~> 1.0"
-  spec.add_development_dependency "dry-schema", "~> 1.0"
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'dry-monads', '~> 1.3'
+  spec.add_runtime_dependency 'dry-struct', '~> 1.0'
+  spec.add_runtime_dependency 'dry-types', '~> 1.1'
+  spec.add_runtime_dependency 'rack', '~> 2.0'
+  spec.add_runtime_dependency 'transproc', '~> 1.1'
+
+  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'dry-schema', '~> 1.0'
+  spec.add_development_dependency 'dry-view', '~> 0.7'
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'rack-flash3', '~> 1.0'
+  spec.add_development_dependency 'rack-test', '~> 1.1'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'redcarpet', '~> 3.4'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'yard', '~> 0.9', '>= 0.9.20'
 end