wouter 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb608868bb7ca95a7e244c723598b71ce229d5a3bf0547e98b8845d0d3c5ee09
-  data.tar.gz: b20aa9ec15c8cf94d0700dc0c5e618161dacdce1b9f2dd0aa7dae50e2baaacd3
+  metadata.gz: 4731ee9735261f806ded54813c9655fcae91349f6c3b9a5061f0664ac2618b72
+  data.tar.gz: 0bb29c4009bcc7846e07dfad0dae5c8c0ba4af3ceaa5bf1607ca4f89590e3e59
 SHA512:
-  metadata.gz: ba6b29440962dd0b887d7d933b8a6445da9e3b9f4b8be6195a1c915cb235d39e1b5a49f1de8a5ba4f487586067919d81126b4ad38c6f4266bfc06939980f3cee
-  data.tar.gz: 0caa411508ceb2d28b7bf69e52162026b1234b974a9d6cfd8c0a94d77ede7ac89e187870d30ee3714d70fab22085f4c11096a5d4fb8305dd819e658e0bd22be7
+  metadata.gz: 81a9adf9928ce8af300ede523ed9fad8ac9c657ccee665fae108b4f13d54c3fa77a11c61cefdd3d4bceae992d4f68e8cf2e65e6f103dafd0b2287ca2e310fb1a
+  data.tar.gz: ad519803a201b62cbb9e9b1d93365329a74d0517859dd60fff1ca8b10088d86788baad5d9d5903aa04df8dbdd423bcf26f88433e3efd1f9e334ece9037ee59c0

data/lib/wouter.rb

@@ -1,12 +1,11 @@
-require "bundler"
+# frozen_string_literal: true
+
+require 'bundler'
 Bundler.setup(:default)
-require "rack"
+require 'rack'
 
+# Wouter main class to define routes from
 class Wouter
-  # ========== Rack wrappers
-  class Request < Rack::Request; end
-  class Response < Rack::Response; end
-
   # ========== Endpoint class to make life easier
   class Endpoint
     attr_accessor :req, :res
@@ -21,7 +20,7 @@ class Wouter
     def self.call(env)
       endpoint = new(Rack::Request.new(env), Rack::Response.new)
       final_resp = endpoint.respond
-      # Return a `Rack::Response` or write to the body of the response if the return value of `response` is not `Rack::Response`
+      # Return a `Rack::Response` or write to the body of the response
       if final_resp.is_a?(Rack::Response)
         final_resp
       else
@@ -68,11 +67,12 @@ class Wouter
   class <<self
     %i[get post put delete].each do |m|
       define_method(m) do |path, route_class|
-        routes.push({
+        route = {
           method: m.to_s.upcase.to_sym,
           path: path,
           route_class: route_class
-        })
+        }
+        routes.push(route)
       end
     end
 
@@ -88,6 +88,7 @@ class Wouter
     app.to_app
   end
 
+  # Wrapper class for creating single `.call` interface for `Rack::Builder`
   class Wrapper
     attr_reader :routes
 
@@ -98,58 +99,84 @@ class Wouter
     def call(env)
       request = Rack::Request.new(env)
 
-      route = routes.find do |route|
-        if route[:method] == request.request_method.to_sym
-          if parameterized_path?(route[:path])
-            split_path = route[:path].split("/")
-            path_regex = build_path_regex(split_path)
-            path_regex.match?(request.path)
-          else
-            route[:path] == request.path
-          end
-        end
+      route = routes.find do |r|
+        matching_route?(r, request)
       end
 
-      if route
-        if parameterized_path?(route[:path])
-          split_path = route[:path].split("/")
-          path_parameter_data = build_path_regex(split_path).match(request.path)
-          path_parameter_names = find_parameter_names_in_path(split_path)
-          path_parameter_names.each_with_index do |parameter_name, i|
-            request.update_param(parameter_name, path_parameter_data[i+1])
-          end
-        end
+      return not_found unless route
 
-        resp = route[:route_class].call(request.env)
-        resp.finish
-      else
-        not_found
+      path_parameters(route, request.path) do |name, value|
+        request.update_param(name, value)
       end
+
+      resp = route[:route_class].call(request.env)
+      resp.finish
     end
 
     private
 
-    # Does the path have a parameter in it? ex: "/user/:id"
+    # Does the given route match the request
+    def matching_route?(route, request)
+      return false unless route[:method] == request.request_method.to_sym
+
+      if parameterized_path?(route[:path])
+        path_regex = build_path_regex(route[:path].split('/'))
+        path_regex.match?(request.path)
+      else
+        route[:path] == request.path
+      end
+    end
+
+    # Yield the parameters parsed from the path
+    # Example definition: "/hello/:name"
+    # Example request: "/hello/robert"
+    # Example yield: name, robert
+    def path_parameters(route, path)
+      return unless parameterized_path?(route[:path])
+
+      split_path = route[:path].split('/')
+      path_parameter_data = build_path_regex(split_path).match(path)
+      path_parameter_names = find_parameter_names_in_path(split_path)
+      path_parameter_names.each_with_index do |parameter_name, i|
+        yield parameter_name, path_parameter_data[i + 1]
+      end
+    end
+
+    # Does the path have a parameter in it? ex: '/user/:id'
     def parameterized_path?(path)
-      path.include?(":")
+      path.include?(':')
     end
 
-    # Find all the named parameters in the route, drop the ":" so we have the names: ":id" => "id"
+    # Find all the named parameters in the route
+    # Then drop the ':' so we have the names: ':id' => 'id'
     def find_parameter_names_in_path(split_path)
-      split_path.find_all { |s| s.size > 1 ? s[0] == ":" : false }.map { |s| s[1..-1] }
+      params = split_path.find_all do |s|
+        if s.size > 1
+          s[0] == ':'
+        else
+          false
+        end
+      end
+      params.map { |s| s[1..-1] }
     end
 
-    # Turn the route into a regex: "/hello/:name" => "\/hello\/(\w*)"
+    # Turn the route into a regex: '/hello/:name' => '\/hello\/(\w*)'
     def build_path_regex(split_path)
-      regex_string = split_path.map { |s| s[0] == ":" ? "(\\w*)" : s }.join("\/")
-      Regexp.new(regex_string)
+      regex_string = split_path.map do |s|
+        if s[0] == ':'
+          '(\\w*)'
+        else
+          s
+        end
+      end
+      Regexp.new(regex_string.join('\/'))
     end
 
     # Return HTTP 404
     def not_found
       resp = Rack::Response.new
       resp.status = 404
-      resp.write "Not Found"
+      resp.write 'Not Found'
       resp
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wouter
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Robert Peterson
@@ -31,107 +31,106 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 2.0.6
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: m
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '1.5'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 12.3.1
+        version: 1.5.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '1.5'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 12.3.1
+        version: 1.5.1
 - !ruby/object:Gem::Dependency
-  name: rack-test
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '5.11'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 5.11.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '5.11'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 5.11.3
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: minitest-rg
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.11'
+        version: '5.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.11.3
+        version: 5.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.11'
+        version: '5.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.11.3
+        version: 5.2.0
 - !ruby/object:Gem::Dependency
-  name: minitest-rg
+  name: rack-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '1.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.2.0
+        version: 1.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '1.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.2.0
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
-  name: m
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '12.3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.1
+        version: 12.3.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '12.3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.1
-description: Wouter is a modular web router built on Rack. I like explicitness. I
-  like modularity. Wouter aims to make both of those aspects simple.
+        version: 12.3.1
+description: Wouter is a modular web router built on Rack.
 email: robertpeterson@gmail.com
 executables: []
 extensions: []