├── .gitignore ├── LICENSE-GPL ├── LICENSE-MIT ├── README.md ├── dist ├── ba-routematcher.js └── ba-routematcher.min.js ├── grunt.js ├── lib └── routematcher.js ├── package.json └── test └── routematcher_test.js /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules/ 2 | -------------------------------------------------------------------------------- /LICENSE-GPL: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 2, June 1991 3 | 4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc. 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | Preamble 10 | 11 | The licenses for most software are designed to take away your 12 | freedom to share and change it. By contrast, the GNU General Public 13 | License is intended to guarantee your freedom to share and change free 14 | software--to make sure the software is free for all its users. This 15 | General Public License applies to most of the Free Software 16 | Foundation's software and to any other program whose authors commit to 17 | using it. (Some other Free Software Foundation software is covered by 18 | the GNU Lesser General Public License instead.) You can apply it to 19 | your programs, too. 20 | 21 | When we speak of free software, we are referring to freedom, not 22 | price. Our General Public Licenses are designed to make sure that you 23 | have the freedom to distribute copies of free software (and charge for 24 | this service if you wish), that you receive source code or can get it 25 | if you want it, that you can change the software or use pieces of it 26 | in new free programs; and that you know you can do these things. 27 | 28 | To protect your rights, we need to make restrictions that forbid 29 | anyone to deny you these rights or to ask you to surrender the rights. 30 | These restrictions translate to certain responsibilities for you if you 31 | distribute copies of the software, or if you modify it. 32 | 33 | For example, if you distribute copies of such a program, whether 34 | gratis or for a fee, you must give the recipients all the rights that 35 | you have. You must make sure that they, too, receive or can get the 36 | source code. And you must show them these terms so they know their 37 | rights. 38 | 39 | We protect your rights with two steps: (1) copyright the software, and 40 | (2) offer you this license which gives you legal permission to copy, 41 | distribute and/or modify the software. 42 | 43 | Also, for each author's protection and ours, we want to make certain 44 | that everyone understands that there is no warranty for this free 45 | software. If the software is modified by someone else and passed on, we 46 | want its recipients to know that what they have is not the original, so 47 | that any problems introduced by others will not reflect on the original 48 | authors' reputations. 49 | 50 | Finally, any free program is threatened constantly by software 51 | patents. We wish to avoid the danger that redistributors of a free 52 | program will individually obtain patent licenses, in effect making the 53 | program proprietary. To prevent this, we have made it clear that any 54 | patent must be licensed for everyone's free use or not licensed at all. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | GNU GENERAL PUBLIC LICENSE 60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 61 | 62 | 0. This License applies to any program or other work which contains 63 | a notice placed by the copyright holder saying it may be distributed 64 | under the terms of this General Public License. The "Program", below, 65 | refers to any such program or work, and a "work based on the Program" 66 | means either the Program or any derivative work under copyright law: 67 | that is to say, a work containing the Program or a portion of it, 68 | either verbatim or with modifications and/or translated into another 69 | language. (Hereinafter, translation is included without limitation in 70 | the term "modification".) Each licensee is addressed as "you". 71 | 72 | Activities other than copying, distribution and modification are not 73 | covered by this License; they are outside its scope. The act of 74 | running the Program is not restricted, and the output from the Program 75 | is covered only if its contents constitute a work based on the 76 | Program (independent of having been made by running the Program). 77 | Whether that is true depends on what the Program does. 78 | 79 | 1. You may copy and distribute verbatim copies of the Program's 80 | source code as you receive it, in any medium, provided that you 81 | conspicuously and appropriately publish on each copy an appropriate 82 | copyright notice and disclaimer of warranty; keep intact all the 83 | notices that refer to this License and to the absence of any warranty; 84 | and give any other recipients of the Program a copy of this License 85 | along with the Program. 86 | 87 | You may charge a fee for the physical act of transferring a copy, and 88 | you may at your option offer warranty protection in exchange for a fee. 89 | 90 | 2. You may modify your copy or copies of the Program or any portion 91 | of it, thus forming a work based on the Program, and copy and 92 | distribute such modifications or work under the terms of Section 1 93 | above, provided that you also meet all of these conditions: 94 | 95 | a) You must cause the modified files to carry prominent notices 96 | stating that you changed the files and the date of any change. 97 | 98 | b) You must cause any work that you distribute or publish, that in 99 | whole or in part contains or is derived from the Program or any 100 | part thereof, to be licensed as a whole at no charge to all third 101 | parties under the terms of this License. 102 | 103 | c) If the modified program normally reads commands interactively 104 | when run, you must cause it, when started running for such 105 | interactive use in the most ordinary way, to print or display an 106 | announcement including an appropriate copyright notice and a 107 | notice that there is no warranty (or else, saying that you provide 108 | a warranty) and that users may redistribute the program under 109 | these conditions, and telling the user how to view a copy of this 110 | License. (Exception: if the Program itself is interactive but 111 | does not normally print such an announcement, your work based on 112 | the Program is not required to print an announcement.) 113 | 114 | These requirements apply to the modified work as a whole. If 115 | identifiable sections of that work are not derived from the Program, 116 | and can be reasonably considered independent and separate works in 117 | themselves, then this License, and its terms, do not apply to those 118 | sections when you distribute them as separate works. But when you 119 | distribute the same sections as part of a whole which is a work based 120 | on the Program, the distribution of the whole must be on the terms of 121 | this License, whose permissions for other licensees extend to the 122 | entire whole, and thus to each and every part regardless of who wrote it. 123 | 124 | Thus, it is not the intent of this section to claim rights or contest 125 | your rights to work written entirely by you; rather, the intent is to 126 | exercise the right to control the distribution of derivative or 127 | collective works based on the Program. 128 | 129 | In addition, mere aggregation of another work not based on the Program 130 | with the Program (or with a work based on the Program) on a volume of 131 | a storage or distribution medium does not bring the other work under 132 | the scope of this License. 133 | 134 | 3. You may copy and distribute the Program (or a work based on it, 135 | under Section 2) in object code or executable form under the terms of 136 | Sections 1 and 2 above provided that you also do one of the following: 137 | 138 | a) Accompany it with the complete corresponding machine-readable 139 | source code, which must be distributed under the terms of Sections 140 | 1 and 2 above on a medium customarily used for software interchange; or, 141 | 142 | b) Accompany it with a written offer, valid for at least three 143 | years, to give any third party, for a charge no more than your 144 | cost of physically performing source distribution, a complete 145 | machine-readable copy of the corresponding source code, to be 146 | distributed under the terms of Sections 1 and 2 above on a medium 147 | customarily used for software interchange; or, 148 | 149 | c) Accompany it with the information you received as to the offer 150 | to distribute corresponding source code. (This alternative is 151 | allowed only for noncommercial distribution and only if you 152 | received the program in object code or executable form with such 153 | an offer, in accord with Subsection b above.) 154 | 155 | The source code for a work means the preferred form of the work for 156 | making modifications to it. For an executable work, complete source 157 | code means all the source code for all modules it contains, plus any 158 | associated interface definition files, plus the scripts used to 159 | control compilation and installation of the executable. However, as a 160 | special exception, the source code distributed need not include 161 | anything that is normally distributed (in either source or binary 162 | form) with the major components (compiler, kernel, and so on) of the 163 | operating system on which the executable runs, unless that component 164 | itself accompanies the executable. 165 | 166 | If distribution of executable or object code is made by offering 167 | access to copy from a designated place, then offering equivalent 168 | access to copy the source code from the same place counts as 169 | distribution of the source code, even though third parties are not 170 | compelled to copy the source along with the object code. 171 | 172 | 4. You may not copy, modify, sublicense, or distribute the Program 173 | except as expressly provided under this License. Any attempt 174 | otherwise to copy, modify, sublicense or distribute the Program is 175 | void, and will automatically terminate your rights under this License. 176 | However, parties who have received copies, or rights, from you under 177 | this License will not have their licenses terminated so long as such 178 | parties remain in full compliance. 179 | 180 | 5. You are not required to accept this License, since you have not 181 | signed it. However, nothing else grants you permission to modify or 182 | distribute the Program or its derivative works. These actions are 183 | prohibited by law if you do not accept this License. Therefore, by 184 | modifying or distributing the Program (or any work based on the 185 | Program), you indicate your acceptance of this License to do so, and 186 | all its terms and conditions for copying, distributing or modifying 187 | the Program or works based on it. 188 | 189 | 6. Each time you redistribute the Program (or any work based on the 190 | Program), the recipient automatically receives a license from the 191 | original licensor to copy, distribute or modify the Program subject to 192 | these terms and conditions. You may not impose any further 193 | restrictions on the recipients' exercise of the rights granted herein. 194 | You are not responsible for enforcing compliance by third parties to 195 | this License. 196 | 197 | 7. If, as a consequence of a court judgment or allegation of patent 198 | infringement or for any other reason (not limited to patent issues), 199 | conditions are imposed on you (whether by court order, agreement or 200 | otherwise) that contradict the conditions of this License, they do not 201 | excuse you from the conditions of this License. If you cannot 202 | distribute so as to satisfy simultaneously your obligations under this 203 | License and any other pertinent obligations, then as a consequence you 204 | may not distribute the Program at all. For example, if a patent 205 | license would not permit royalty-free redistribution of the Program by 206 | all those who receive copies directly or indirectly through you, then 207 | the only way you could satisfy both it and this License would be to 208 | refrain entirely from distribution of the Program. 209 | 210 | If any portion of this section is held invalid or unenforceable under 211 | any particular circumstance, the balance of the section is intended to 212 | apply and the section as a whole is intended to apply in other 213 | circumstances. 214 | 215 | It is not the purpose of this section to induce you to infringe any 216 | patents or other property right claims or to contest validity of any 217 | such claims; this section has the sole purpose of protecting the 218 | integrity of the free software distribution system, which is 219 | implemented by public license practices. Many people have made 220 | generous contributions to the wide range of software distributed 221 | through that system in reliance on consistent application of that 222 | system; it is up to the author/donor to decide if he or she is willing 223 | to distribute software through any other system and a licensee cannot 224 | impose that choice. 225 | 226 | This section is intended to make thoroughly clear what is believed to 227 | be a consequence of the rest of this License. 228 | 229 | 8. If the distribution and/or use of the Program is restricted in 230 | certain countries either by patents or by copyrighted interfaces, the 231 | original copyright holder who places the Program under this License 232 | may add an explicit geographical distribution limitation excluding 233 | those countries, so that distribution is permitted only in or among 234 | countries not thus excluded. In such case, this License incorporates 235 | the limitation as if written in the body of this License. 236 | 237 | 9. The Free Software Foundation may publish revised and/or new versions 238 | of the General Public License from time to time. Such new versions will 239 | be similar in spirit to the present version, but may differ in detail to 240 | address new problems or concerns. 241 | 242 | Each version is given a distinguishing version number. If the Program 243 | specifies a version number of this License which applies to it and "any 244 | later version", you have the option of following the terms and conditions 245 | either of that version or of any later version published by the Free 246 | Software Foundation. If the Program does not specify a version number of 247 | this License, you may choose any version ever published by the Free Software 248 | Foundation. 249 | 250 | 10. If you wish to incorporate parts of the Program into other free 251 | programs whose distribution conditions are different, write to the author 252 | to ask for permission. For software which is copyrighted by the Free 253 | Software Foundation, write to the Free Software Foundation; we sometimes 254 | make exceptions for this. Our decision will be guided by the two goals 255 | of preserving the free status of all derivatives of our free software and 256 | of promoting the sharing and reuse of software generally. 257 | 258 | NO WARRANTY 259 | 260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY 261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN 262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED 264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS 266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE 267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, 268 | REPAIR OR CORRECTION. 269 | 270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR 272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING 274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED 275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY 276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER 277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 278 | POSSIBILITY OF SUCH DAMAGES. -------------------------------------------------------------------------------- /LICENSE-MIT: -------------------------------------------------------------------------------- 1 | Copyright (c) 2011 "Cowboy" Ben Alman 2 | 3 | Permission is hereby granted, free of charge, to any person 4 | obtaining a copy of this software and associated documentation 5 | files (the "Software"), to deal in the Software without 6 | restriction, including without limitation the rights to use, 7 | copy, modify, merge, publish, distribute, sublicense, and/or sell 8 | copies of the Software, and to permit persons to whom the 9 | Software is furnished to do so, subject to the following 10 | conditions: 11 | 12 | The above copyright notice and this permission notice shall be 13 | included in all copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 16 | EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES 17 | OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 18 | NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT 19 | HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, 20 | WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 21 | FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR 22 | OTHER DEALINGS IN THE SOFTWARE. 23 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # JavaScript Basic Route Matcher 2 | 3 | A simple route matching / url building utility. Intended to be included as part of a larger routing library. 4 | 5 | ## Getting Started 6 | 7 | In Node.js, run `npm install route-matcher` and then use this code: 8 | 9 | ```javascript 10 | var routeMatcher = require("route-matcher").routeMatcher; 11 | var myRoute = routeMatcher("user/:id"); 12 | ``` 13 | 14 | Or in the browser: 15 | 16 | ```html 17 | 18 | 21 | ``` 22 | 23 | In the browser, you can attach routeMatcher to any object. 24 | 25 | ```html 26 | 29 | 30 | 33 | ``` 34 | 35 | ## Sample Usage 36 | ```javascript 37 | // Use routeMatcher to create a reusable route matching function. 38 | var search = routeMatcher("search/:query/p:page"); 39 | search.parse("search/gonna-fail") // null (no match) 40 | search.parse("search/cowboy/p5") // {query: "cowboy", page: "5"} 41 | search.parse("search/gnarf/p10") // {query: "gnarf", page: "10"} 42 | 43 | // But wait, it goes both ways! 44 | search.stringify({query: "bonus", page: "6"}) // "search/bonus/p6" 45 | 46 | // You can also pass in a map of per-param validators after the route, each can 47 | // be a RegExp to test against, function that accepts a value (and returns true 48 | // or false) or value to match against. 49 | var user = routeMatcher("user/:id/:other", { 50 | id: /^\d+$/, 51 | other: function(value) { return value === "" || value === "foo"; } 52 | }); 53 | user.parse("user/123/abc") // null (no match) 54 | user.parse("user/foo/") // null (no match) 55 | user.parse("user/123/") // {id: "123", other: ""} 56 | user.parse("user/123/foo") // {id: "123", other: "foo"} 57 | 58 | // Note that .stringify doesn't perform any validation. Should it? 59 | user.stringify({id: "abc", other: "xyz"}) // "user/abc/xyz" 60 | 61 | // You can pass in a RegExp route, which returns an object with a `captures` 62 | // property, or null if no match. Note that for RegExp routes, the .stringify 63 | // method always returns empty string, because stringification isn't supported. 64 | var users = routeMatcher(/^(users?)(?:\/(\d+)(?:\.\.(\d+))?)?/); 65 | users.parse("gonna-fail") // null (no match) 66 | users.parse("user") // {captures: ["user", undefined, undefined]} 67 | users.parse("users") // {captures: ["users", undefined, undefined]} 68 | users.parse("user/123") // {captures: ["user", "123", undefined]} 69 | users.parse("user/123..456") // {captures: ["user", "123", "456"]} 70 | ``` 71 | 72 | ## Documentation 73 | For now, look at the unit tests. 74 | 75 | ## Contributing 76 | In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [grunt](https://github.com/cowboy/node-grunt). 77 | 78 | _Also, please don't edit files in the "dist" subdirectory as they are generated via grunt. You'll find source code in the "lib" subdirectory!_ 79 | 80 | ## Release History 81 | Nothing official yet... 82 | 83 | ## License 84 | Copyright (c) 2011 "Cowboy" Ben Alman 85 | Dual licensed under the MIT and GPL licenses. 86 | 87 | -------------------------------------------------------------------------------- /dist/ba-routematcher.js: -------------------------------------------------------------------------------- 1 | /* JavaScript Route Matcher - v0.1.0 - 10/19/2011 2 | * http://github.com/cowboy/javascript-route-matcher 3 | * Copyright (c) 2011 "Cowboy" Ben Alman; Licensed MIT, GPL */ 4 | 5 | (function(exports) { 6 | // Characters to be escaped with \. RegExp borrowed from the Backbone router 7 | // but escaped (note: unnecessarily) to keep JSHint from complaining. 8 | var reEscape = /[\-\[\]{}()+?.,\\\^$|#\s]/g; 9 | // Match named :param or *splat placeholders. 10 | var reParam = /([:*])(\w+)/g; 11 | 12 | // Test to see if a value matches the corresponding rule. 13 | function validateRule(rule, value) { 14 | // For a given rule, get the first letter of the string name of its 15 | // constructor function. "R" -> RegExp, "F" -> Function (these shouldn't 16 | // conflict with any other types one might specify). Note: instead of 17 | // getting .toString from a new object {} or Object.prototype, I'm assuming 18 | // that exports will always be an object, and using its .toString method. 19 | // Bad idea? Let me know by filing an issue 20 | var type = exports.toString.call(rule).charAt(8); 21 | // If regexp, match. If function, invoke. Otherwise, compare. Note that == 22 | // is used because type coercion is needed, as `value` will always be a 23 | // string, but `rule` might not. 24 | return type === "R" ? rule.test(value) : type === "F" ? rule(value) : rule == value; 25 | } 26 | 27 | // Pass in a route string (or RegExp) plus an optional map of rules, and get 28 | // back an object with .parse and .stringify methods. 29 | exports.routeMatcher = function(route, rules) { 30 | // Object to be returned. The public API. 31 | var self = {}; 32 | // Matched param or splat names, in order 33 | var names = []; 34 | // Route matching RegExp. 35 | var re = route; 36 | 37 | // Build route RegExp from passed string. 38 | if (typeof route === "string") { 39 | // Escape special chars. 40 | re = re.replace(reEscape, "\\$&"); 41 | // Replace any :param or *splat with the appropriate capture group. 42 | re = re.replace(reParam, function(_, mode, name) { 43 | names.push(name); 44 | // :param should capture until the next / or EOL, while *splat should 45 | // capture until the next :param, *splat, or EOL. 46 | return mode === ":" ? "([^/]*)" : "(.*)"; 47 | }); 48 | // Add ^/$ anchors and create the actual RegExp. 49 | re = new RegExp("^" + re + "$"); 50 | 51 | // Match the passed url against the route, returning an object of params 52 | // and values. 53 | self.parse = function(url) { 54 | var i = 0; 55 | var param, value; 56 | var params = {}; 57 | var matches = url.match(re); 58 | // If no matches, return null. 59 | if (!matches) { return null; } 60 | // Add all matched :param / *splat values into the params object. 61 | while (i < names.length) { 62 | param = names[i++]; 63 | value = matches[i]; 64 | // If a rule exists for thie param and it doesn't validate, return null. 65 | if (rules && param in rules && !validateRule(rules[param], value)) { return null; } 66 | params[param] = value; 67 | } 68 | return params; 69 | }; 70 | 71 | // Build path by inserting the given params into the route. 72 | self.stringify = function(params) { 73 | var param, re; 74 | var result = route; 75 | // Insert each passed param into the route string. Note that this loop 76 | // doesn't check .hasOwnProperty because this script doesn't support 77 | // modifications to Object.prototype. 78 | for (param in params) { 79 | re = new RegExp("[:*]" + param + "\\b"); 80 | result = result.replace(re, params[param]); 81 | } 82 | // Missing params should be replaced with empty string. 83 | return result.replace(reParam, ""); 84 | }; 85 | } else { 86 | // RegExp route was passed. This is super-simple. 87 | self.parse = function(url) { 88 | var matches = url.match(re); 89 | return matches && {captures: matches.slice(1)}; 90 | }; 91 | // There's no meaningful way to stringify based on a RegExp route, so 92 | // return empty string. 93 | self.stringify = function() { return ""; }; 94 | } 95 | return self; 96 | }; 97 | 98 | }(typeof exports === "object" && exports || this)); 99 | -------------------------------------------------------------------------------- /dist/ba-routematcher.min.js: -------------------------------------------------------------------------------- 1 | /* JavaScript Route Matcher - v0.1.0 - 10/19/2011 2 | * http://github.com/cowboy/javascript-route-matcher 3 | * Copyright (c) 2011 "Cowboy" Ben Alman; Licensed MIT, GPL */ 4 | (function(a){function d(b,c){var d=a.toString.call(b).charAt(8);return d==="R"?b.test(c):d==="F"?b(c):b==c}var b=/[\-\[\]{}()+?.,\\\^$|#\s]/g,c=/([:*])(\w+)/g;a.routeMatcher=function(a,e){var f={},g=[],h=a;return typeof a=="string"?(h=h.replace(b,"\\$&"),h=h.replace(c,function(a,b,c){return g.push(c),b===":"?"([^/]*)":"(.*)"}),h=new RegExp("^"+h+"$"),f.parse=function(a){var b=0,c,f,i={},j=a.match(h);if(!j)return null;while(b', ''] 19 | }, 20 | min: { 21 | 'dist/ba-routematcher.min.js': ['', 'dist/ba-routematcher.js'] 22 | }, 23 | test: { 24 | files: ['test/**/*.js'] 25 | }, 26 | lint: { 27 | files: ['grunt.js', 'lib/**/*.js', 'test/**/*.js'] 28 | }, 29 | jshint: { 30 | options: { 31 | curly: true, 32 | //eqeqeq: true, 33 | immed: true, 34 | latedef: true, 35 | newcap: true, 36 | noarg: true, 37 | sub: true, 38 | undef: true, 39 | eqnull: true 40 | }, 41 | globals: { 42 | exports: true 43 | } 44 | }, 45 | uglify: {} 46 | }); 47 | 48 | // Default task. 49 | task.registerTask('default', 'lint:files test:files concat min'); 50 | -------------------------------------------------------------------------------- /lib/routematcher.js: -------------------------------------------------------------------------------- 1 | /* 2 | * JavaScript Route Matcher 3 | * http://benalman.com/ 4 | * 5 | * Copyright (c) 2011 "Cowboy" Ben Alman 6 | * Dual licensed under the MIT and GPL licenses. 7 | * http://benalman.com/about/license/ 8 | */ 9 | 10 | (function(exports) { 11 | // Characters to be escaped with \. RegExp borrowed from the Backbone router 12 | // but escaped (note: unnecessarily) to keep JSHint from complaining. 13 | var reEscape = /[\-\[\]{}()+?.,\\\^$|#\s]/g; 14 | // Match named :param or *splat placeholders. 15 | var reParam = /([:*])(\w+)/g; 16 | 17 | // Test to see if a value matches the corresponding rule. 18 | function validateRule(rule, value) { 19 | // For a given rule, get the first letter of the string name of its 20 | // constructor function. "R" -> RegExp, "F" -> Function (these shouldn't 21 | // conflict with any other types one might specify). Note: instead of 22 | // getting .toString from a new object {} or Object.prototype, I'm assuming 23 | // that exports will always be an object, and using its .toString method. 24 | // Bad idea? Let me know by filing an issue 25 | var type = exports.toString.call(rule).charAt(8); 26 | // If regexp, match. If function, invoke. Otherwise, compare. Note that == 27 | // is used because type coercion is needed, as `value` will always be a 28 | // string, but `rule` might not. 29 | return type === "R" ? rule.test(value) : type === "F" ? rule(value) : rule == value; 30 | } 31 | 32 | // Pass in a route string (or RegExp) plus an optional map of rules, and get 33 | // back an object with .parse and .stringify methods. 34 | exports.routeMatcher = function(route, rules) { 35 | // Object to be returned. The public API. 36 | var self = {}; 37 | // Matched param or splat names, in order 38 | var names = []; 39 | // Route matching RegExp. 40 | var re = route; 41 | 42 | // Build route RegExp from passed string. 43 | if (typeof route === "string") { 44 | // Escape special chars. 45 | re = re.replace(reEscape, "\\$&"); 46 | // Replace any :param or *splat with the appropriate capture group. 47 | re = re.replace(reParam, function(_, mode, name) { 48 | names.push(name); 49 | // :param should capture until the next / or EOL, while *splat should 50 | // capture until the next :param, *splat, or EOL. 51 | return mode === ":" ? "([^/]*)" : "(.*)"; 52 | }); 53 | // Add ^/$ anchors and create the actual RegExp. 54 | re = new RegExp("^" + re + "$"); 55 | 56 | // Match the passed url against the route, returning an object of params 57 | // and values. 58 | self.parse = function(url) { 59 | var i = 0; 60 | var param, value; 61 | var params = {}; 62 | var matches = url.match(re); 63 | // If no matches, return null. 64 | if (!matches) { return null; } 65 | // Add all matched :param / *splat values into the params object. 66 | while (i < names.length) { 67 | param = names[i++]; 68 | value = matches[i]; 69 | // If a rule exists for thie param and it doesn't validate, return null. 70 | if (rules && param in rules && !validateRule(rules[param], value)) { return null; } 71 | params[param] = value; 72 | } 73 | return params; 74 | }; 75 | 76 | // Build path by inserting the given params into the route. 77 | self.stringify = function(params) { 78 | var param, re; 79 | var result = route; 80 | // Insert each passed param into the route string. Note that this loop 81 | // doesn't check .hasOwnProperty because this script doesn't support 82 | // modifications to Object.prototype. 83 | for (param in params) { 84 | re = new RegExp("[:*]" + param + "\\b"); 85 | result = result.replace(re, params[param]); 86 | } 87 | // Missing params should be replaced with empty string. 88 | return result.replace(reParam, ""); 89 | }; 90 | } else { 91 | // RegExp route was passed. This is super-simple. 92 | self.parse = function(url) { 93 | var matches = url.match(re); 94 | return matches && {captures: matches.slice(1)}; 95 | }; 96 | // There's no meaningful way to stringify based on a RegExp route, so 97 | // return empty string. 98 | self.stringify = function() { return ""; }; 99 | } 100 | return self; 101 | }; 102 | 103 | }(typeof exports === "object" && exports || this)); 104 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "route-matcher", 3 | "version": "0.1.0", 4 | "author": "\"Cowboy\" Ben Alman (http://benalman.com/)", 5 | "description": "A simple route matching / url building utility. Intended to be included as part of a larger routing library.", 6 | "main": "dist/ba-routematcher.js", 7 | "directories": { 8 | "dist": "dist", 9 | "lib": "lib", 10 | "test": "test" 11 | }, 12 | "scripts": { 13 | "build": "grunt", 14 | "test": "grunt test" 15 | }, 16 | "repository": { 17 | "type": "git", 18 | "url": "git://github.com/cowboy/javascript-route-matcher.git" 19 | }, 20 | "keywords": [ 21 | "uri", 22 | "url", 23 | "routes" 24 | ], 25 | "bugs": { 26 | "url": "https://github.com/cowboy/javascript-route-matcher/issues" 27 | }, 28 | "license": "MIT/GPLv2", 29 | "homepage": "https://github.com/cowboy/javascript-route-matcher", 30 | "devDependencies": { 31 | "grunt": "^0.1.2" 32 | } 33 | } 34 | -------------------------------------------------------------------------------- /test/routematcher_test.js: -------------------------------------------------------------------------------- 1 | /*global require:true */ 2 | var routeMatcher = require('../lib/routematcher').routeMatcher; 3 | 4 | exports.parse = { 5 | "regex route": function(test) { 6 | var r = routeMatcher(/^(users?)(?:\/(\d+)(?:\.\.(\d+))?)?/); 7 | test.strictEqual(r.parse("foo"), null, "shouldn't match"); 8 | test.deepEqual(r.parse("user"), {captures: ["user", undefined, undefined]}, "should match"); 9 | test.deepEqual(r.parse("users"), {captures: ["users", undefined, undefined]}, "should match"); 10 | test.deepEqual(r.parse("user/123"), {captures: ["user", "123", undefined]}, "should match"); 11 | test.deepEqual(r.parse("user/123..456"), {captures: ["user", "123", "456"]}, "should match"); 12 | test.done(); 13 | }, 14 | "string route, basic": function(test) { 15 | var r = routeMatcher("users"); 16 | test.strictEqual(r.parse("fail"), null, "shouldn't match"); 17 | test.strictEqual(r.parse("users/"), null, "shouldn't match"); 18 | test.strictEqual(r.parse("users/foo"), null, "shouldn't match"); 19 | test.deepEqual(r.parse("users"), {}, "Should match"); 20 | test.done(); 21 | }, 22 | "string route, one variable": function(test) { 23 | var r = routeMatcher("users/:id"); 24 | test.strictEqual(r.parse("users"), null, "shouldn't match"); 25 | test.strictEqual(r.parse("users/123/456"), null, "shouldn't match"); 26 | test.deepEqual(r.parse("users/"), {id: ""}, "should match"); 27 | test.deepEqual(r.parse("users/123"), {id: "123"}, "should match"); 28 | test.done(); 29 | }, 30 | "string route, multiple variables": function(test) { 31 | var r = routeMatcher("users/:id/:other"); 32 | test.strictEqual(r.parse("users"), null, "shouldn't match"); 33 | test.strictEqual(r.parse("users/123"), null, "shouldn't match"); 34 | test.deepEqual(r.parse("users/123/456"), {id: "123", other: "456"}, "should match"); 35 | test.done(); 36 | }, 37 | "string route, one splat": function(test) { 38 | var r = routeMatcher("users/*stuff"); 39 | test.strictEqual(r.parse("users"), null, "shouldn't match"); 40 | test.deepEqual(r.parse("users/"), {stuff: ""}, "should match"); 41 | test.deepEqual(r.parse("users/123"), {stuff: "123"}, "should match"); 42 | test.deepEqual(r.parse("users/123/456"), {stuff: "123/456"}, "should match"); 43 | test.done(); 44 | }, 45 | "string route, multiple splats": function(test) { 46 | var r = routeMatcher("users/*stuff/*more"); 47 | test.strictEqual(r.parse("users"), null, "shouldn't match"); 48 | test.strictEqual(r.parse("users/123"), null, "shouldn't match"); 49 | test.deepEqual(r.parse("users/123/"), {stuff: "123", more: ""}, "should match"); 50 | test.deepEqual(r.parse("users//123"), {stuff: "", more: "123"}, "should match"); 51 | test.deepEqual(r.parse("users//"), {stuff: "", more: ""}, "should match"); 52 | test.deepEqual(r.parse("users///123"), {stuff: "/", more: "123"}, "should match"); 53 | test.deepEqual(r.parse("users/123/456"), {stuff: "123", more: "456"}, "should match"); 54 | test.deepEqual(r.parse("users/123/456/789"), {stuff: "123/456", more: "789"}, "capturing should be greedy"); 55 | test.done(); 56 | }, 57 | "string route, variables and splats": function(test) { 58 | var r = routeMatcher("users/:id/*stuff/:other/*more"); 59 | test.deepEqual(r.parse("users/123/aaa/456/bbb"), {id: "123", other: "456", stuff: "aaa", more: "bbb"}, "this is pushing it"); 60 | 61 | r = routeMatcher("users/:id/:other/*stuff/*more"); 62 | test.deepEqual(r.parse("users/123/456/aaa/bbb/ccc"), {id: "123", other: "456", stuff: "aaa/bbb", more: "ccc"}, "this is a little more reasonable"); 63 | test.done(); 64 | }, 65 | // These were pulled from the backbone.js unit tests. 66 | "a few backbone.js test routes": function(test) { 67 | var r = routeMatcher("search/:query/p:page"); 68 | test.deepEqual(r.parse("search/boston/p20"), {query: "boston", page: "20"}, "should match"); 69 | 70 | r = routeMatcher("*first/complex-:part/*rest"); 71 | test.deepEqual(r.parse("one/two/three/complex-part/four/five/six/seven"), {first: "one/two/three", part: "part", rest: "four/five/six/seven"}, "should match"); 72 | 73 | r = routeMatcher(":entity?*args"); 74 | test.deepEqual(r.parse("cowboy?a=b&c=d"), {entity: "cowboy", args: "a=b&c=d"}, "should match"); 75 | 76 | r = routeMatcher("*anything"); 77 | test.deepEqual(r.parse("doesnt-match-a-route"), {anything: "doesnt-match-a-route"}, "should match"); 78 | test.done(); 79 | }, 80 | "specific matching rules": function(test) { 81 | var digitsOnlyFn = function(value) { return value.match(/^\d+$/); }; 82 | var digitsOnlyRe = /^\d+$/; 83 | 84 | var r = routeMatcher("users/:id", {id: digitsOnlyRe}); 85 | test.strictEqual(r.parse("users"), null, "shouldn't match"); 86 | test.strictEqual(r.parse("users/"), null, "shouldn't match"); 87 | test.strictEqual(r.parse("users/abc"), null, "shouldn't match"); 88 | test.strictEqual(r.parse("users/123.456"), null, "shouldn't match"); 89 | test.deepEqual(r.parse("users/123"), {id: "123"}, "should match"); 90 | 91 | r = routeMatcher("users/:id", {id: digitsOnlyFn}); 92 | test.strictEqual(r.parse("users/abc"), null, "shouldn't match"); 93 | test.strictEqual(r.parse("users/123.456"), null, "shouldn't match"); 94 | test.deepEqual(r.parse("users/123"), {id: "123"}, "should match"); 95 | 96 | r = routeMatcher("users/:id", {id: 456}); 97 | test.strictEqual(r.parse("users/123"), null, "shouldn't match"); 98 | test.deepEqual(r.parse("users/456"), {id: "456"}, "should match"); 99 | 100 | r = routeMatcher("users/:id", {id: "abc123"}); 101 | test.strictEqual(r.parse("users/abc"), null, "shouldn't match"); 102 | test.deepEqual(r.parse("users/abc123"), {id: "abc123"}, "should match"); 103 | 104 | r = routeMatcher("users/:id/:other", {id: digitsOnlyRe, other: digitsOnlyFn}); 105 | test.strictEqual(r.parse("users/abc/def"), null, "shouldn't match"); 106 | test.strictEqual(r.parse("users/abc/123"), null, "shouldn't match"); 107 | test.strictEqual(r.parse("users/123/abc"), null, "shouldn't match"); 108 | test.deepEqual(r.parse("users/123/456"), {id: "123", other: "456"}, "should match"); 109 | test.done(); 110 | } 111 | }; 112 | 113 | exports.stringify = { 114 | "regex route": function(test) { 115 | var r = routeMatcher(/^(users?)(?:\/(\d+)(?:\.\.(\d+))?)?/); 116 | test.strictEqual(r.stringify("anything"), "", "always returns empty string if RegExp route"); 117 | test.done(); 118 | }, 119 | "one variable": function(test) { 120 | var r = routeMatcher("users/:id"); 121 | test.strictEqual(r.stringify({id: "123"}), "users/123", "should build"); 122 | test.strictEqual(r.stringify({id: ""}), "users/", "should build"); 123 | test.strictEqual(r.stringify({}), "users/", "omitted params default to empty string"); 124 | test.strictEqual(r.stringify(), "users/", "omitted argument default to behave like empty object passed"); 125 | test.done(); 126 | }, 127 | "multiple variables": function(test) { 128 | var r = routeMatcher("users/:id/:other"); 129 | test.strictEqual(r.stringify({id: "123", other: "456"}), "users/123/456", "should build"); 130 | test.strictEqual(r.stringify({id: "", other: "456"}), "users//456", "should build"); 131 | test.strictEqual(r.stringify({id: "123", other: ""}), "users/123/", "should build"); 132 | test.strictEqual(r.stringify({id: "", other: ""}), "users//", "should build"); 133 | test.strictEqual(r.stringify({id: "123"}), "users/123/", "omitted params default to empty string"); 134 | test.strictEqual(r.stringify({other: "456"}), "users//456", "omitted params default to empty string"); 135 | test.strictEqual(r.stringify({}), "users//", "omitted params default to empty string"); 136 | test.strictEqual(r.stringify(), "users//", "omitted params default to empty string"); 137 | test.done(); 138 | }, 139 | "one splat": function(test) { 140 | var r = routeMatcher("users/*stuff"); 141 | test.strictEqual(r.stringify({stuff: ""}), "users/", "should build"); 142 | test.strictEqual(r.stringify({stuff: "123"}), "users/123", "should build"); 143 | test.strictEqual(r.stringify({stuff: "123/456"}), "users/123/456", "should build"); 144 | test.strictEqual(r.stringify({}), "users/", "omitted params default to empty string"); 145 | test.strictEqual(r.stringify(), "users/", "omitted params default to empty string"); 146 | test.done(); 147 | }, 148 | "multiple splats": function(test) { 149 | var r = routeMatcher("users/*stuff/*more"); 150 | test.strictEqual(r.stringify({stuff: "123", more: "456"}), "users/123/456", "should build"); 151 | test.strictEqual(r.stringify({stuff: "123", more: ""}), "users/123/", "should build"); 152 | test.strictEqual(r.stringify({stuff: "", more: "123"}), "users//123", "should build"); 153 | test.strictEqual(r.stringify({stuff: "", more: ""}), "users//", "should build"); 154 | test.strictEqual(r.stringify({}), "users//", "omitted params default to empty string"); 155 | test.strictEqual(r.stringify(), "users//", "omitted params default to empty string"); 156 | test.done(); 157 | }, 158 | "possibly conflicting param names": function(test) { 159 | var r = routeMatcher(":a/:aa/*aaa/*aaaa"); 160 | test.strictEqual(r.stringify({a: 1, aa: 2, aaa: 3, aaaa: 4}), "1/2/3/4", "should build"); 161 | test.strictEqual(r.stringify({aaaa: 4, aaa: 3, aa: 2, a: 1}), "1/2/3/4", "should build"); 162 | test.done(); 163 | } 164 | }; 165 | --------------------------------------------------------------------------------