js-routes-zigexn 1.3.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9e596334de0a0fd64c5d88a4bea56c1fab971a70
+  data.tar.gz: b38ea25faef8856509140dfb57480c09121e68ac
+SHA512:
+  metadata.gz: fe1a1a7b65fa1d5bb0f256c7f36ebb4176cf569d58c8acc88f7ff0b9275e0722ec04b4b605a48e1cf5ccda4ce35f109069fd9fe3290026fb5b58b8dbbe1c85f3
+  data.tar.gz: 00def775ee6f0ccdac3d58136f7cf026482d83f70ede7be13fdaf9708bd52d8da48c5cf67b59591be5007d326bfde314df5f1431f44a648277c726c8a1f832b1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,60 @@
+# rcov generated
+coverage
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+log
+
+# bundler
+.bundle
+
+# jeweler generated
+pkg
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore:
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+#.DS_Store
+
+# For TextMate
+#*.tmproj
+#tmtags
+
+# For emacs:
+#*~
+#\#*
+#.\#*
+
+# For vim:
+#*.swp
+
+# For redcar:
+#.redcar
+
+# For rubinius:
+#*.rbc
+.rvmrc
+.ruby-version
+
+Gemfile.lock
+gemfiles/*.lock
+
+.DS_Store
+
+/spec/dummy/app/assets/javascripts/routes.js
+/spec/dummy/logs
+/spec/dummy/tmp

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,60 @@
+language: ruby
+cache: bundler
+
+before_install:
+  - gem install bundler # need for jruby and ruby-head
+
+rvm:
+  - 2.0
+  - 2.1
+  - 2.2.5
+  - 2.3.1
+  - 2.4.1
+  - jruby-19mode
+  - ruby-head
+  - jruby-head
+
+gemfile:
+  - gemfiles/rails32.gemfile
+  - gemfiles/rails40.gemfile
+  - gemfiles/rails40_sprockets3.gemfile
+  - gemfiles/rails41.gemfile
+  - gemfiles/rails41_sprockets3.gemfile
+  - gemfiles/rails42.gemfile
+  - gemfiles/rails42_sprockets3.gemfile
+  - gemfiles/rails50.gemfile
+  - gemfiles/rails50_sprockets3.gemfile
+
+sudo: false
+
+notifications:
+  email:
+    - agresso@gmail.com
+
+branches:
+  only:
+    - master
+
+matrix:
+  allow_failures:
+    - rvm: jruby-19mode
+    - rvm: ruby-head
+    - rvm: jruby-head
+    - gemfile: gemfiles/rails50.gemfile
+  exclude:
+    - rvm: 2.0
+      gemfile: gemfiles/rails50.gemfile
+    - rvm: 2.0
+      gemfile: gemfiles/rails50_sprockets3.gemfile
+    - rvm: 2.1
+      gemfile: gemfiles/rails50.gemfile
+    - rvm: 2.1
+      gemfile: gemfiles/rails50_sprockets3.gemfile
+    - rvm: 2.4.1
+      gemfile: gemfiles/rails40.gemfile # Segmentation fault (core dumped) for 2.4
+    - rvm: 2.4.1
+      gemfile: gemfiles/rails40_sprockets3.gemfile # Segmentation fault (core dumped) for 2.4
+    - rvm: 2.4.1
+      gemfile: gemfiles/rails41.gemfile # Segmentation fault (core dumped) for 2.4
+    - rvm: 2.4.1
+      gemfile: gemfiles/rails41_sprockets3.gemfile # Segmentation fault (core dumped) for 2.4

data/Appraisals

@@ -0,0 +1,16 @@
+appraise "rails32" do
+  gem "railties", "~> 3.2.22.5"
+  gem 'tzinfo'
+end
+
+{rails40: '4.0.13', rails41: '4.1.16', rails42: '4.2.8', rails50: '5.0.2'}.each do |rails, version|
+  appraise "#{rails}" do
+    gem "railties", "~> #{version}"
+    gem "sprockets", "< 3"
+  end
+
+  appraise "#{rails}-sprockets3" do
+    gem "railties", "~> #{version}"
+    gem "sprockets", "~> 3.0"
+  end
+end

data/CHANGELOG.md

@@ -0,0 +1,112 @@
+## master
+
+## v1.3.3
+
+* Improved optional parameters support #216
+
+## v1.3.2
+
+* Added `application` option #214
+
+## v1.3.1
+
+* Raise error object with id null passed as route paramter #209
+* Sprockets bugfixes #212
+
+## v1.3.0
+
+* Introduce the special _options key. Fixes #86
+
+## v1.2.9
+
+* Fixed deprecation varning on Sprockets 3.7
+
+## v1.2.8
+
+* Bugfix warning on Sprockets 4.0 #202
+
+## v1.2.7
+
+* Drop support 1.9.3
+* Add helper for indexOf, if no native implementation in JS engine
+* Add sprockets3 compatibility
+* Bugfix domain defaults to path #197
+
+## v1.2.6
+
+* Use default prefix from `Rails.application.config.relative_url_root` #186
+* Bugfix route globbing with optional fragments bug #191
+
+## v1.2.5
+
+* Bugfix subdomain default parameter in routes #184
+* Bugfix infinite recursion in some specific route sets #183
+
+## v1.2.4
+
+* Additional bugfixes to support all versions of Sprockets: 2.x and 3.x
+
+## v1.2.3
+
+* Sprockets ~= 3.0 support
+
+## v1.2.2
+
+* Sprockets ~= 3.0 support
+* Support default parameters specified in route.rb file
+
+## v1.2.1
+
+* Fixes for Rails 5
+
+## v1.2.0
+
+* Support host, port and protocol inline parameters
+* Support host, port and protocol parameters given to a route explicitly
+* Remove all incompatibilities between actiondispatch and js-routes in handling route URLs
+
+## v1.1.2
+
+* Bugfix support nested object null parameters #164
+* Bugfix support for nested optional parameters #162 #163
+
+## v1.1.1
+
+* Bugfix regression in serialisation on blank strings caused by [#155](https://github.com/railsware/js-routes/pull/155/files)
+
+## v1.1.0
+
+* Ensure routes are loaded, prior to generating them [#148](https://github.com/railsware/js-routes/pull/148)
+* Use `flat_map` rather than `map{...}.flatten` [#149](https://github.com/railsware/js-routes/pull/149)
+* URL escape routes.rb url to fix bad URI(is not URI?) error [#150](https://github.com/railsware/js-routes/pull/150)
+* Fix for rails 5 - test rails-edge on travis allowing failure [#151](https://github.com/railsware/js-routes/pull/151)
+* Adds `serializer` option [#155](https://github.com/railsware/js-routes/pull/155/files)
+
+## v1.0.1
+
+* Support sprockets-3
+* Performance optimization of include/exclude options
+
+## v1.0.0
+
+ * Add the compact mode [#125](https://github.com/railsware/js-routes/pull/125)
+ * Add support for host, protocol, and port configuration [#137](https://github.com/railsware/js-routes/pull/137)
+ * Routes path specs [#135](https://github.com/railsware/js-routes/pull/135)
+ * Support Rails 4.2 and Ruby 2.2 [#140](https://github.com/railsware/js-routes/pull/140)
+
+## v0.9.9
+
+* Bugfix Rails Engine subapplication route generation when they are nested [#120](https://github.com/railsware/js-routes/pull/120)
+
+## v0.9.8
+
+* Support AMD/Require.js [#111](https://github.com/railsware/js-routes/pull/111)
+* Support trailing slash [#106](https://github.com/railsware/js-routes/pull/106)
+
+## v0.9.7
+
+* Depend on railties [#97](https://github.com/railsware/js-routes/pull/97)
+* Fix typeof error for IE [#95](https://github.com/railsware/js-routes/pull/95)
+* Fix testing on ruby-head [#92](https://github.com/railsware/js-routes/pull/92)
+* Correct thread safety issue in js-routes generation [#90](https://github.com/railsware/js-routes/pull/90)
+* Use the `of` operator to detect for `to_param` and `id` in objects [#87](https://github.com/railsware/js-routes/pull/87)

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in js-routes.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Bogdan Gusiev
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,33 @@
+# encoding: utf-8
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'bundler/gem_tasks'
+require 'rspec/core'
+require 'rspec/core/rake_task'
+require 'appraisal'
+load "rails/tasks/routes.rake"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :test_all => :appraisal # test all rails
+
+task :default => :spec
+
+
+namespace :spec do
+  task :routes do
+    require './spec/spec_helper'
+    require 'action_dispatch/routing/inspector'
+    draw_routes
+    all_routes = Rails.application.routes.routes
+    inspector = ActionDispatch::Routing::RoutesInspector.new(all_routes)
+    puts inspector.format(ActionDispatch::Routing::ConsoleFormatter.new, ENV['CONTROLLER'])
+  end
+end

data/Readme.md

@@ -0,0 +1,234 @@
+# JsRoutes
+[![Build Status](https://travis-ci.org/railsware/js-routes.svg?branch=master)](https://travis-ci.org/railsware/js-routes)
+
+Generates javascript file that defines all Rails named routes as javascript helpers
+
+## Intallation
+
+Your Rails Gemfile:
+
+``` ruby
+gem "js-routes"
+```
+
+### Basic Setup
+
+Require js routes file in `application.js` or other bundle
+
+``` js
+//= require js-routes
+```
+
+Also in order to flush asset pipeline cache sometimes you might need to run:
+
+``` sh
+rake tmp:cache:clear
+```
+
+This cache is not flushed on server restart in development environment.
+
+**Important:** If routes.js file is not updated after some configuration change you need to run this rake task again.
+
+### Advanced Setup
+
+If you need to customize routes file create initializer, like `config/initializers/jsroutes.rb`:
+
+``` ruby
+JsRoutes.setup do |config|
+  config.option = value
+end
+```
+
+Available options:
+
+* `default_url_options` - default parameters used when generating URLs
+  * Note that only specific options are supported at this time.
+  * Example: {:format => "json", :trailing\_slash => true, :protocol => "https", :host => "example.com", :port => 3000}
+  * Default: {}
+* `exclude` - Array of regexps to exclude from js routes.
+  * Default: []
+  * The regexp applies only to the name before the `_path` suffix, eg: you want to match exactly `settings_path`, the regexp should be `/^settings$/`
+* `include` - Array of regexps to include in js routes.
+  * Default: []
+  * The regexp applies only to the name before the `_path` suffix, eg: you want to match exactly `settings_path`, the regexp should be `/^settings$/`
+* `namespace` - global object used to access routes.
+  * Supports nested namespace like `MyProject.routes`
+  * Default: `Routes`
+* `prefix` - String representing a url path to prepend to all paths.
+  * Example: `http://yourdomain.com`. This will cause route helpers to generate full path only.
+  * Default: `Rails.application.config.relative_url_root`
+* `camel_case` (version >= 0.8.8) - Generate camel case route names.
+  * Default: false
+* `url_links` (version >= 0.8.9) - Generate `*_url` helpers (in addition to the default `*_path` helpers).
+  * Example: true
+  * Default: false
+  * Note: generated URLs will first use the protocol, host, and port options specified in the route definition. Otherwise, the URL will be based on the option specified in the `default_url_options` config. If no default option has been set, then the URL will fallback to the current URL based on `window.location`.
+* `compact` (version > 0.9.9) - Remove `_path` suffix in path routes(`*_url` routes stay untouched if they were enabled)
+  * Default: false
+  * Sample route call when option is set to true: Routes.users() => `/users`
+* `serializer` (version >= 1.1.0) - Puts a JS function here that serializes a Javascript Hash object into URL paramters: `{a: 1, b: 2} => "a=1&b=2"`.
+  * Default: `nil`. Uses built-in serializer
+  * Example: `jQuery.param` - use jQuery's serializer algorithm. You can attach serialize function from your favorite AJAX framework.
+  * Example: `MyApp.custom_serialize` - use completely custom serializer of your application.
+
+* `special_options_key` - a special key that helps js-routes to destinguish serialized model from options hash
+  * This option is required because JS doesn't provide a difference between an object and a hash
+  * Default: `_options`
+* `application` - a key to specify which rails engine you want to generate routes too.
+  * This option allows to only generate routes for a specific rails engine, that is mounted into routes instead of all Rails app routes
+  * Default: `Rails.application`
+
+### Very Advanced Setup
+
+In case you need multiple route files for different parts of your application, you have to create the files manually.
+If your application has an `admin` and an `application` namespace for example:
+
+```
+# app/assets/javascripts/admin/routes.js.erb
+<%= JsRoutes.generate(namespace: "AdminRoutes", include: /admin/) %>
+
+# app/assets/javascripts/admin.js.coffee
+#= require admin/routes
+```
+
+```
+# app/assets/javascripts/application/routes.js.erb
+<%= JsRoutes.generate(namespace: "AppRoutes", exclude: /admin/) %>
+
+# app/assets/javascripts/application.js.coffee
+#= require application/routes
+```
+
+In order to generate the routes JS code to a string:
+
+```ruby
+routes_js = JsRoutes.generate(options)
+```
+
+If you want to generate the routes files outside of the asset pipeline, you can use `JsRoutes.generate!`:
+
+``` ruby
+path = "app/assets/javascripts"
+JsRoutes.generate!("#{path}/app_routes.js", :namespace => "AppRoutes", :exclude => [/^admin_/, /^api_/])
+JsRoutes.generate!("#{path}/adm_routes.js", :namespace => "AdmRoutes", :include => /^admin_/)
+JsRoutes.generate!("#{path}/api_routes.js", :namespace => "ApiRoutes", :include => /^api_/, :default_url_options => {:format => "json"})
+```
+
+### Rails relative URL root
+
+If you've installed your application in a sub-path or sub-URI of your server instead of at the root, you need to set the `RAILS_RELATIVE_URL_ROOT` environment variable to the correct path prefix for your application when you precompile assets. Eg., if your application's base URL is "https://appl.example.com/Application1", the command to precompile assets would be:
+```
+RAILS_RELATIVE_URL_ROOT=/Application1 RAILS_ENV=production bundle exec rake assets:precompile
+```
+The environment variable is only needed for precompilation of assets, at any other time (eg. when assets are compiled on-the-fly as in the development environment) Rails will set the relative URL root correctly on it's own.
+
+
+## Usage
+
+Configuration above will create a nice javascript file with `Routes` object that has all the rails routes available:
+
+``` js
+Routes.users_path() // => "/users"
+Routes.user_path(1) // => "/users/1"
+Routes.user_path(1, {format: 'json'}) // => "/users/1.json"
+Routes.user_path(1, {anchor: 'profile'}) // => "/users/1#profile"
+Routes.new_user_project_path(1, {format: 'json'}) // => "/users/1/projects/new.json"
+Routes.user_project_path(1,2, {q: 'hello', custom: true}) // => "/users/1/projects/2?q=hello&custom=true"
+Routes.user_project_path(1,2, {hello: ['world', 'mars']}) // => "/users/1/projects/2?hello%5B%5D=world&hello%5B%5D=mars"
+```
+
+Using serialized object as route function arguments:
+
+``` js
+var google = {id: 1, name: "Google"};
+Routes.company_path(google) // => "/companies/1"
+var google = {id: 1, name: "Google", to_param: "google"};
+Routes.company_path(google) // => "/companies/google"
+```
+
+In order to make routes helpers available globally:
+
+``` js
+jQuery.extend(window, Routes)
+```
+
+## Get spec of routes and required params
+
+Possible to get `spec` of route by function `toString`:
+
+```js
+Routes.users_path.toString() // => "/users(.:format)"
+Routes.user_path.toString() // => "/users/:id(.:format)"
+```
+
+This function allow to get the same `spec` for route, if you will get string representation of the route function:
+
+```js
+'' + Routes.users_path // => "/users(.:format)", a string representation of the object
+'' + Routes.user_path // => "/users/:id(.:format)"
+```
+
+Route function also contain inside attribute `required_params` required param names as array:
+
+```js
+Routes.users_path.required_params // => []
+Routes.user_path.required_params // => ['id']
+```
+
+
+## Rails Compatibilities
+
+JsRoutes ties to be as close as possible to rails behaviour in all aspects of routing API.
+Please make and issue in case of any incomtibilities found outside of described below.
+
+### Object and Hash distinction issue
+
+Sometimes the destinction between JS Hash and Object can not be found by js-routes.
+In this case you would need to pass a special key to help:
+
+``` js
+Routes.company_project_path({company_id: 1, id: 2}) // => Not Enough parameters
+Routes.company_project_path({company_id: 1, id: 2, _options: true}) // => "/companies/1/projects/2"
+```
+
+
+## What about security?
+
+js-routes itself do not have security holes. It makes URLs
+without access protection more reachable by potential attacker.
+In order to prevent this use `:exclude` option for sensitive urls like `/admin_/`
+
+## Spork
+
+When using Spork and `Spork.trap_method(Rails::Application::RoutesReloader, :reload!)` you should also do:
+
+``` ruby
+Spork.trap_method(JsRoutes, :generate!)
+```
+
+## JS-Routes and heroku
+
+Heroku environment has a specific problems with setup. It is impossible to use asset pipeline in this environment. You should use "Very Advanced Setup" schema in this case.
+
+For example create routes.js.erb in assets folder with needed content:
+
+``` erb
+<%= JsRoutes.generate(options) %>
+```
+
+This should just work.
+
+## Advantages over alternatives
+
+There are some alternatives available. Most of them has only basic feature and don't reach the level of quality I accept.
+Advantages of this one are:
+
+* Rails 3-5 support
+* Rich options set
+* Full rails compatibility
+* Support Rails `#to_param` convention for seo optimized paths
+* Well tested
+
+#### Thanks to [Contributors](https://github.com/railsware/js-routes/contributors)
+
+#### Have fun