Class: Mustermann::Router::Simple

Inherits:
Object
  • Object
show all
Defined in:
lib/praxis/router/simple.rb

Overview

Simple pattern based router that allows matching a string to a given callback.

Examples:

require 'mustermann/router/simple'

router = Mustermann::Router::Simple.new do
  on ':name/:sub' do |string, params|
    params['sub']
  end

  on 'foo' do
    "bar"
  end
end

router.call("foo") # => "bar"
router.call("a/b") # => "b"
router.call("bar") # => nil

Direct Known Subclasses

Rack, Praxis::Router::RequestRouter

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(default: nil, **options, &block) ⇒ Mustermann::Router::Simple

Returns new router instance.

Examples:

with a default value

require 'mustermann/router/simple'

router = Mustermann::Router::Simple.new(default: 42)
router.on(':name', capture: :digit) { |string| string.to_i }
router.call("23")      # => 23
router.call("example") # => 42

block with implicit receiver

require 'mustermann/router/simple'

router = Mustermann::Router::Simple.new do
  on('/foo') { 'foo' }
  on('/bar') { 'bar' }
end

block with explicit receiver

require 'mustermann/router/simple'

router = Mustermann::Router::Simple.new(type: :rails) do |r|
  r.on('/foo') { 'foo' }
  r.on('/bar') { 'bar' }
end

Parameters:

  • default (defaults to: nil) —

    value to be returned if nothing matches

  • options (Hash) —

    pattern options



60
61
62
63
64
65
66
67
68
 
# File 'lib/praxis/router/simple.rb', line 60

def initialize(default: nil, **options, &block)
  @options = options
  @map     = []
  @default = default

  return unless block

  block.arity.zero? ? instance_eval(&block) : yield(self)
end

Instance Attribute Details

#default ⇒ Object

Default value for when no pattern matches



31
32
33
 
# File 'lib/praxis/router/simple.rb', line 31

def default
  @default
end

Instance Method Details

#[](string) ⇒ #call?

Returns callback for given string, if a pattern matches.

Examples:

require 'mustermann/router/simple'

router = Mustermann::Router::Simple.new
router.on(':a/:b') { 42 }
router['foo/bar'] # => <#Proc:...>
router['foo_bar'] # => nil

Returns:

  • (#call, nil) —

    callback for given string, if a pattern matches



79
80
81
82
 
# File 'lib/praxis/router/simple.rb', line 79

def [](string)
  string = string_for(string) unless string.is_a? String
  @map.detect { |p, _v| p === string }[1] # rubocop:disable Style/CaseEquality
end

#[]=(pattern, callback) ⇒ Object

Examples:

require 'mustermann/router/simple'

router = Mustermann::Router::Simple.new
router['/:name'] = proc { |string, params| params['name'] }
router.call('/foo') # => "foo"

Parameters:

  • pattern (String, Mustermann::Pattern) —

    matcher

  • callback (#call) —

    callback to call on match

See Also:



94
95
96
 
# File 'lib/praxis/router/simple.rb', line 94

def []=(pattern, callback)
  on(pattern, call: callback)
end

#call(input) ⇒ Object

Finds the matching callback and calls ‘call` on it with the given input and the params.

Returns:

  • the callback’s return value



129
130
131
132
133
134
135
136
137
138
 
# File 'lib/praxis/router/simple.rb', line 129

def call(input)
  @map.each do |pattern, callback|
    catch(:pass) do
      next unless (params = pattern.params(string_for(input)))

      return invoke(callback, input, params, pattern)
    end
  end
  @default
end

#on(*patterns, call: Proc.new, **options) ⇒ Object

Examples:

with block

require 'mustermann/router/simple'

router = Mustermann::Router::Simple.new

router.on(':a/:b') { 42 }
router.call('foo/bar') # => 42
router.call('foo_bar') # => nil

with callback option

require 'mustermann/router/simple'

callback = proc { 42 }
router   = Mustermann::Router::Simple.new

router.on(':a/:b', call: callback)
router.call('foo/bar') # => 42
router.call('foo_bar') # => nil

Parameters:

  • patterns (Array<String, Pattern>)
  • call (#call) (defaults to: Proc.new) —

    callback object, need to hand in block if missing

  • options (Hash) —

    pattern options



120
121
122
123
124
125
 
# File 'lib/praxis/router/simple.rb', line 120

def on(*patterns, call: Proc.new, **options)
  patterns.each do |pattern|
    pattern = Mustermann.new(pattern.to_str, **options, **@options) if pattern.respond_to? :to_str
    @map << [pattern, call]
  end
end