chrisBirmingham/parameterised-paths

A little gem for matching potentially parameterised paths

Parameterised Paths

A little gem for matching potentially parameterised paths

Installation

Add this line to your application's Gemfile:

gem 'parameterised-paths'

Or add this line to your gemspec

spec.add_dependency 'parameterised-paths'

And then execute:

bundle install

Or install it yourself as:

gem install parameterised-paths

Usage

Simple Paths

require 'parameterised/paths'

path = Parameterised::Paths::Path.new('/hello/world')

match = path.match('/hello/world')

raise 'Paths do not match' if match.nil?

Parameter Paths

require 'parameterised/paths'

path = Parameterised::Paths::Path.new('/hello/:param')

match = path.match('/hello/world')

# Access parameter
param = match.params['param']

Shorthand methods

require 'parameterised/paths'

# Creating a path
path = Parameterised::Paths.path('/hello/world')

# Quick match
match = Parameterised::Paths.path_match('/hello/world', '/hello/developer')

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub.