wouter 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4731ee9735261f806ded54813c9655fcae91349f6c3b9a5061f0664ac2618b72
-  data.tar.gz: 0bb29c4009bcc7846e07dfad0dae5c8c0ba4af3ceaa5bf1607ca4f89590e3e59
+  metadata.gz: 328983ffb5c818d8e95bfd645fa6a4390bc97efee9d3b195d28cd86421b69315
+  data.tar.gz: '01191a528dab4215b98d03545b863c4cd8c3f0b5be7c0f9f91e97a0bbe300e72'
 SHA512:
-  metadata.gz: 81a9adf9928ce8af300ede523ed9fad8ac9c657ccee665fae108b4f13d54c3fa77a11c61cefdd3d4bceae992d4f68e8cf2e65e6f103dafd0b2287ca2e310fb1a
-  data.tar.gz: ad519803a201b62cbb9e9b1d93365329a74d0517859dd60fff1ca8b10088d86788baad5d9d5903aa04df8dbdd423bcf26f88433e3efd1f9e334ece9037ee59c0
+  metadata.gz: 5e1b52bc209def3b17235c036102d145c1e43ed31deb318288437956307489636573c037342dd064d541c8f59d6343b9d42f363c4e3638e4d36d83e9d2c2c9ea
+  data.tar.gz: a41ead4e722ebccfd50af05e13571cd880f3f580eec097d89cc992f09376bc6352ab96c1560d85589cb9cd20d1c08d4352c12d98f48146199d65ad14d8a11ae4

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec

data/README.md

@@ -0,0 +1,27 @@
+# Wouter
+
+Wouter is a modular web framework built on top of Rack.
+
+Wouter design goals: explicit, modular, readable.
+
+## Basic Usage
+
+Wouter allows you to define routes that connect to endpoints.
+
+Here is an example `rackup` compatible file:
+
+```ruby
+require 'wouty'
+
+class HelloWorld < Wouty::Endpoint
+  def respond
+    'Hello, world!'
+  end
+end
+
+class Routes < Wouty
+  get '/', HelloWorld
+end
+
+run Routes.build
+```

data/Rakefile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'bundler'
+Bundler.setup(:default, :test)
+
+desc 'Run tests'
+task :test do
+  require_relative './test/helper'
+
+  Dir['test/**/*_test.rb'].each do |file|
+    load file
+  end
+end

data/examples/hello.rb

@@ -0,0 +1,15 @@
+# Usage: rackup hello.rb
+
+require 'wouter'
+
+class HelloWorld < Wouty::Endpoint
+  def respond
+    'Hello, world!'
+  end
+end
+
+class Routes < Wouty
+  get '/', HelloWorld
+end
+
+run Routes.build

data/lib/wouter/endpoint.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+# `Wouter::Endpoint` is a class to help define Rack compatible endpoints that
+# can be assigned to a route path. Each `Wouter::Endpoint` instance is a Rack
+# application of it's own. It provides convience methods for creating endpoints.
+#
+class Wouter::Endpoint
+  class NotImplementedError < StandardError; end
+
+  attr_reader :req, :res
+
+  def initialize(req, res)
+    @req = req
+    @res = res
+  end
+
+  def self.call(env)
+    endpoint = new(Rack::Request.new(env), Rack::Response.new)
+    response = endpoint.respond
+
+    return response.finish if response.is_a?(Rack::Response)
+
+    endpoint.res.write response
+    endpoint.res.finish
+  end
+
+  def respond
+    raise NotImplementedError, 'you must implemented #respond in your Wouter::Endpoint class'
+  end
+
+  def params
+    @req.params
+  end
+
+  def headers(hash = nil)
+    @res.headers.merge! hash if hash
+    @res.headers
+  end
+
+  def status(code)
+    @res.status = code
+    @res.status
+  end
+
+  def not_found
+    Wouter::Util.not_found
+  end
+end

data/lib/wouter/route.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+# `Wouter::Route` represents a route definition. Example:
+#
+#     get '/users/:id/comments/:comment_id', RouteKlass
+#
+# It contains utility methods for matching a Rack request to a route.
+#
+class Wouter::Route
+  REGEX = '([A-Za-z0-9\-\_]+)'
+
+  attr_reader :request_method, :path, :klass
+
+  def initialize(request_method:, path:, klass:)
+    @request_method = request_method
+    @path = path
+    @klass = klass
+  end
+
+  # Expects `request` to be a `Rack::Request`
+  # Check `request.request_method` and `request.path`
+  def match?(request)
+    return false if request.request_method.to_sym != @request_method
+    return true if request.path == path
+
+    path_regex =~ request.path
+  end
+
+  # Expects `request` to be a `Rack::Request`
+  # Parse the path parameters out of `request.path`
+  def params(request)
+    request.path.match(named_path_regex)&.named_captures
+  end
+
+  private
+
+  # /user/:id/comments/:comment_id
+  # /\/user\/(?<id>\w+)\/comments\/(?<comment_id>\w+)/
+  def named_path_regex
+    @named_path_regex ||= begin
+      string_regex = path
+      path.scan(/(:\w+)/).flatten.each do |param|
+        string_regex = string_regex.gsub(param, '(?<' + param[1..-1] +'>' + REGEX + ')')
+      end
+      Regexp.new(string_regex)
+    end
+  end
+
+  # /user/:id/comments/:comment_id
+  # /\/user\/(\w+)\/comments\/(\w+)/
+  def path_regex
+    @path_regex ||= begin
+      string_regex = path
+      path.scan(/(:\w+)/).flatten.each do |param|
+        string_regex = string_regex.gsub(param, REGEX)
+      end
+      Regexp.new(string_regex)
+    end
+  end
+end

data/lib/wouter/util.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# `Wouter::Util` provides some common untility methods.
+#
+class Wouter::Util
+  # HTTP 404 Not Found
+  def self.not_found
+    resp = Rack::Response.new
+    resp.status = 404
+    resp.write 'Not Found'
+    resp
+  end
+end

data/lib/wouter/wrapper.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+# `Wouter::Wrapper` is a class that provides a top level Rack application containing
+# all the routing endpoints. HTTP requests come through `Wouter::Wrapper` and it dispatches
+# to the appropriate route class that was defined by the user.
+#
+class Wouter::Wrapper
+  def initialize(routes:)
+    @routes = routes
+  end
+
+  def call(env)
+    request = Rack::Request.new(env)
+    route = find_route(request)
+
+    if route
+      route.params(request).each do |name, value|
+        request.update_param(name, value)
+      end
+      route.klass.call(request.env)
+    else
+      Wouter::Util.not_found
+    end
+  end
+
+  private
+
+  def find_route(request)
+    @routes.find do |route|
+      route.match?(request)
+    end
+  end
+end

data/lib/wouter.rb

@@ -4,180 +4,54 @@ require 'bundler'
 Bundler.setup(:default)
 require 'rack'
 
-# Wouter main class to define routes from
-class Wouter
-  # ========== Endpoint class to make life easier
-  class Endpoint
-    attr_accessor :req, :res
+# Define `Wouter` so we can load stuff
+class Wouter; end
 
-    # @req : Request
-    # @res : Response
-    def initialize(req, res)
-      @req = req
-      @res = res
-    end
+require_relative 'wouter/util'
+require_relative 'wouter/route'
+require_relative 'wouter/endpoint'
+require_relative 'wouter/wrapper'
 
-    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 final_resp.is_a?(Rack::Response)
-        final_resp
-      else
-        endpoint.res.write final_resp
-        endpoint.res
-      end
-    end
-
-    # Users of `Wouter::Endpoint` should implement their own `#response`
-    def respond
-      @res
-    end
-
-    ## ~~~~~ Convience methods
-
-    def params
-      @req.params
+# Main route definition DSL
+class Wouter
+  class <<self
+    def get(route, klass)
+      define_route(:GET, route, klass)
     end
 
-    def json(body)
-      @res.set_header('Content-Type', 'application/json')
-      @res.write body
-      @res
+    def put(route, klass)
+      define_route(:PUT, route, klass)
     end
 
-    def status(code)
-      @res.status = code
-      @res
+    def post(route, klass)
+      define_route(:POST, route, klass)
     end
-  end
-
-  ## ========== Internal
 
-  def self.app
-    @app ||= Rack::Builder.new
-  end
-
-  def self.routes
-    @routes ||= []
-  end
-
-  ## ========== DSL
-
-  class <<self
-    %i[get post put delete].each do |m|
-      define_method(m) do |path, route_class|
-        route = {
-          method: m.to_s.upcase.to_sym,
-          path: path,
-          route_class: route_class
-        }
-        routes.push(route)
-      end
+    def delete(route, klass)
+      define_route(:DELETE, route, klass)
     end
 
     def middleware(klass, *args, &block)
       app.use(klass, *args, &block)
     end
-  end
-
-  ## ========== Build a Rack entry point
-
-  def self.build
-    app.run(Wrapper.new(routes))
-    app.to_app
-  end
-
-  # Wrapper class for creating single `.call` interface for `Rack::Builder`
-  class Wrapper
-    attr_reader :routes
-
-    def initialize(routes)
-      @routes = routes
-    end
-
-    def call(env)
-      request = Rack::Request.new(env)
-
-      route = routes.find do |r|
-        matching_route?(r, request)
-      end
-
-      return not_found unless route
 
-      path_parameters(route, request.path) do |name, value|
-        request.update_param(name, value)
-      end
-
-      resp = route[:route_class].call(request.env)
-      resp.finish
+    def build
+      app.run(Wrapper.new(routes: routes))
+      app.to_app
     end
 
     private
 
-    # 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?(':')
-    end
-
-    # 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)
-      params = split_path.find_all do |s|
-        if s.size > 1
-          s[0] == ':'
-        else
-          false
-        end
-      end
-      params.map { |s| s[1..-1] }
+    def app
+      @app ||= Rack::Builder.new
     end
 
-    # Turn the route into a regex: '/hello/:name' => '\/hello\/(\w*)'
-    def build_path_regex(split_path)
-      regex_string = split_path.map do |s|
-        if s[0] == ':'
-          '(\\w*)'
-        else
-          s
-        end
-      end
-      Regexp.new(regex_string.join('\/'))
+    def routes
+      @routes ||= []
     end
 
-    # Return HTTP 404
-    def not_found
-      resp = Rack::Response.new
-      resp.status = 404
-      resp.write 'Not Found'
-      resp
+    def define_route(request_method, path, klass)
+      routes << Wouter::Route.new(request_method: request_method, path: path, klass: klass)
     end
   end
 end

data/wouter.gemspec

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |s|
+  s.name        = 'wouter'
+  s.platform    = Gem::Platform::RUBY
+  s.version     = '0.0.6'
+  s.summary     = 'Rack web router.'
+  s.description = 'Wouter is a modular web router built on Rack.'
+  s.authors     = ['Robert Peterson']
+  s.email       = 'robertpeterson@gmail.com'
+  s.files       = Dir['lib/**/*', 'examples/*'] + ['README.md', 'Gemfile', 'Rakefile', 'wouter.gemspec']
+  s.test_files  = s.files.select { |p| p =~ /^test\/.*_test.rb/ }
+  s.license     = 'MIT'
+  s.homepage    = 'https://github.com/rawburt/wouter'
+
+  s.add_dependency 'rack', '~> 2.0', '>= 2.0.6'
+  s.add_development_dependency 'm', '~> 1.5', '>= 1.5.1'
+  s.add_development_dependency 'minitest', '~> 5.11', '>= 5.11.3'
+  s.add_development_dependency 'minitest-rg', '~> 5.2', '>= 5.2.0'
+  s.add_development_dependency 'mocha', '~> 1.7', '>= 1.7.0'
+  s.add_development_dependency 'rack-test', '~> 1.1', '>= 1.1.0'
+  s.add_development_dependency 'rake', '~> 12.3', '>= 12.3.1'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wouter
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Robert Peterson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-16 00:00:00.000000000 Z
+date: 2018-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -90,6 +90,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.2.0
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.0
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
@@ -136,7 +156,16 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- Gemfile
+- README.md
+- Rakefile
+- examples/hello.rb
 - lib/wouter.rb
+- lib/wouter/endpoint.rb
+- lib/wouter/route.rb
+- lib/wouter/util.rb
+- lib/wouter/wrapper.rb
+- wouter.gemspec
 homepage: https://github.com/rawburt/wouter
 licenses:
 - MIT