js-routes 1.3.3 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5b720670fa76910ce7f6648985f595280bb07c16
-  data.tar.gz: 6ea110ece8ff7cf6e5fc1fe6635819f62c15464e
+  metadata.gz: da4a6b84210ad4604692606b4ea0e5c79fc9ee7a
+  data.tar.gz: 342a9ab0a4b396aef730e88af2abc782d64db743
 SHA512:
-  metadata.gz: 37d1e5fa18e348092b4f56525eb6c61626b8b4820e46bffc2b16f28466a181f3a233499c8cc9004db4dc5dee551c3dd1998efc8ed3515b43a9ee1e551e477c0b
-  data.tar.gz: fce1d09de9f6b5772a9b9b0a6f2a4759722f72f7a45e7032a9bcb7341f7987807624bff591d5115edfebcd1b04403aac258f4a46daa6f496f49f34dbddd94341
+  metadata.gz: 34511f3806f9985f569cfca45ead8e4766be104912d851c9e48ffb4ef2b0d25cb0df17d7eeac42c0d681aa847ab72324c4cb4a4046b63d7ad4dfc1ca51ecc915
+  data.tar.gz: 905284b66bb0e6f8889a6fee1bdbbd521012990d0d69186ccd13b651e10d0a0a202e8b34493290fb1cdc94844d31e087d7883907d75ab95fe6f5d8186446c2cb

data/.travis.yml

@@ -9,6 +9,7 @@ rvm:
   - 2.1
   - 2.2.5
   - 2.3.1
+  - 2.4.1
   - jruby-19mode
   - ruby-head
   - jruby-head
@@ -49,3 +50,11 @@ matrix:
       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

@@ -1,9 +1,9 @@
 appraise "rails32" do
-  gem "railties", "~> 3.2.18"
+  gem "railties", "~> 3.2.22.5"
   gem 'tzinfo'
 end
 
-{rails40: '4.0.5', rails41: '4.1.1', rails42: '4.2.1', rails50: '5.0.0'}.each do |rails, version|
+{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"
@@ -13,4 +13,4 @@ end
     gem "railties", "~> #{version}"
     gem "sprockets", "~> 3.0"
   end
-end
+end

data/CHANGELOG.md

@@ -1,5 +1,41 @@
 ## master
 
+* __breaking change!__ Implemented Routes.config() and Routes.configure instead of Routes.defaults
+
+New methods support 4 options at the moment:
+
+``` js
+Routes.configuration(); // =>
+/*
+{
+  prefix: "",
+  default_url_options: {},
+  special_options_key: '_options',
+  custom_serializer: function(...) { ... }
+}
+*/
+
+Routes.configure({
+ prefix: '/app',
+ default_url_options: {format: 'json'},
+ special_options_key: '_my_options_key',
+ custom_serializer: function(...) { ... }
+});
+```
+
+## 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

data/Readme.md

@@ -39,10 +39,19 @@ JsRoutes.setup do |config|
 end
 ```
 
+Or make a more dynamic configuration in JavaScript, but only specific options support the possibility of such configuration(see the list below):
+
+``` js
+Routes.configure({
+  option: value
+});
+Routes.config(); // current config
+```
+
 Available options:
 
 * `default_url_options` - default parameters used when generating URLs
-  * Note that only specific options are supported at this time.
+  * Option is configurable at JS level with `Routes.configure()`
   * Example: {:format => "json", :trailing\_slash => true, :protocol => "https", :host => "example.com", :port => 3000}
   * Default: {}
 * `exclude` - Array of regexps to exclude from js routes.
@@ -55,6 +64,7 @@ Available options:
   * Supports nested namespace like `MyProject.routes`
   * Default: `Routes`
 * `prefix` - String representing a url path to prepend to all paths.
+  * Option is configurable at JS level with `Routes.configure()`
   * 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.
@@ -68,11 +78,13 @@ Available options:
   * 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
+  * Option is configurable at JS level with `Routes.configure()`
   * 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
+  * Option is configurable at JS level with `Routes.configure()`
   * 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

data/gemfiles/rails32.gemfile

@@ -2,7 +2,7 @@
 
 source "http://rubygems.org"
 
-gem "railties", "~> 3.2.18"
+gem "railties", "~> 3.2.22.5"
 gem "tzinfo"
 
 gemspec :path => "../"

data/gemfiles/rails40.gemfile

@@ -2,7 +2,7 @@
 
 source "http://rubygems.org"
 
-gem "railties", "~> 4.0.5"
+gem "railties", "~> 4.0.13"
 gem "sprockets", "< 3"
 
 gemspec :path => "../"

data/gemfiles/rails40_sprockets3.gemfile

@@ -2,7 +2,7 @@
 
 source "http://rubygems.org"
 
-gem "railties", "~> 4.0.5"
+gem "railties", "~> 4.0.13"
 gem "sprockets", "~> 3.0"
 
 gemspec :path => "../"

data/gemfiles/rails41.gemfile

@@ -2,7 +2,7 @@
 
 source "http://rubygems.org"
 
-gem "railties", "~> 4.1.1"
+gem "railties", "~> 4.1.16"
 gem "sprockets", "< 3"
 
 gemspec :path => "../"

data/gemfiles/rails41_sprockets3.gemfile

@@ -2,7 +2,7 @@
 
 source "http://rubygems.org"
 
-gem "railties", "~> 4.1.1"
+gem "railties", "~> 4.1.16"
 gem "sprockets", "~> 3.0"
 
 gemspec :path => "../"

data/gemfiles/rails42.gemfile

@@ -2,8 +2,7 @@
 
 source "http://rubygems.org"
 
-gem "railties", "~> 4.2.1"
+gem "railties", "~> 4.2.8"
 gem "sprockets", "< 3"
-gem "nokogiri", "< 1.7"
 
 gemspec :path => "../"

data/gemfiles/rails42_sprockets3.gemfile

@@ -2,8 +2,7 @@
 
 source "http://rubygems.org"
 
-gem "railties", "~> 4.2.1"
+gem "railties", "~> 4.2.8"
 gem "sprockets", "~> 3.0"
-gem "nokogiri", "< 1.7"
 
 gemspec :path => "../"

data/gemfiles/rails50.gemfile

@@ -2,7 +2,7 @@
 
 source "http://rubygems.org"
 
-gem "railties", "~> 5.0.0"
+gem "railties", "~> 5.0.2"
 gem "sprockets", "< 3"
 
 gemspec :path => "../"

data/gemfiles/rails50_sprockets3.gemfile

@@ -2,7 +2,7 @@
 
 source "http://rubygems.org"
 
-gem "railties", "~> 5.0.0"
+gem "railties", "~> 5.0.2"
 gem "sprockets", "~> 3.0"
 
 gemspec :path => "../"

data/js-routes.gemspec

@@ -31,7 +31,6 @@ Gem::Specification.new do |s|
   else
     s.add_development_dependency(%q<byebug>)
     s.add_development_dependency(%q<pry-byebug>)
-    s.add_development_dependency(%q<therubyracer>, [">= 0.12.1"])
+    s.add_development_dependency(%q<therubyracer>, [">= 0.12.3"])
   end
 end
-

data/lib/js_routes.rb

@@ -15,13 +15,14 @@ class JsRoutes
     exclude: [],
     include: //,
     file: DEFAULT_PATH,
-    prefix: nil,
+    prefix: -> { Rails.application.config.relative_url_root || "" },
     url_links: false,
     camel_case: false,
     default_url_options: {},
     compact: false,
     serializer: nil,
     special_options_key: "_options",
+    application: -> { Rails.application }
   }
 
   NODE_TYPES = {
@@ -39,7 +40,29 @@ class JsRoutes
   FILTERED_DEFAULT_PARTS = [:controller, :action, :subdomain]
   URL_OPTIONS = [:protocol, :domain, :host, :port, :subdomain]
 
-  class Options < Struct.new(*DEFAULTS.keys)
+  class Configuration < Struct.new(*DEFAULTS.keys)
+    def initialize(attributes = nil)
+      assign(DEFAULTS)
+      return unless attributes
+      assign(attributes)
+    end
+
+    def assign(attributes)
+      attributes.each do |attribute, value|
+        value = value.call if value.is_a?(Proc)
+        send(:"#{attribute}=", value)
+      end
+      self
+    end
+
+    def [](attribute)
+      send(attribute)
+    end
+
+    def merge(attributes)
+      clone.assign(attributes)
+    end
+
     def to_hash
       Hash[*members.zip(values).flatten(1)].symbolize_keys
     end
@@ -51,13 +74,16 @@ class JsRoutes
 
   class << self
     def setup(&block)
-      options.tap(&block) if block
+      configuration.tap(&block) if block
     end
 
     def options
-      @options ||= Options.new.tap do |opts|
-        DEFAULTS.each_pair {|k,v| opts[k] = v}
-      end
+      ActiveSupport::Deprecation.warn('JsRoutes.options method is deprecated use JsRoutes.configuration instead')
+      configuration
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
     end
 
     def generate(opts = {})
@@ -92,7 +118,7 @@ class JsRoutes
   #
 
   def initialize(options = {})
-    @options = self.class.options.to_hash.merge(options)
+    @configuration = self.class.configuration.merge(options)
   end
 
   def generate
@@ -103,49 +129,28 @@ class JsRoutes
 
     {
       "GEM_VERSION"         => JsRoutes::VERSION,
-      "APP_CLASS"           => application.class.to_s,
-      "NAMESPACE"           => @options[:namespace],
-      "DEFAULT_URL_OPTIONS" => json(@options[:default_url_options].merge(deprecate_url_options)),
-      "PREFIX"              => @options[:prefix] || Rails.application.config.relative_url_root || "",
-      "NODE_TYPES"          => json(NODE_TYPES),
-      "SERIALIZER"          => @options[:serializer] || json(nil),
       "ROUTES"              => js_routes,
-      "SPECIAL_OPTIONS_KEY" => @options[:special_options_key].to_s,
       "DEPRECATED_BEHAVIOR" => Rails.version < "4",
+      "NODE_TYPES"          => json(NODE_TYPES),
+
+      "APP_CLASS"           => application.class.to_s,
+      "NAMESPACE"           => json(@configuration.namespace),
+      "DEFAULT_URL_OPTIONS" => json(@configuration.default_url_options),
+      "PREFIX"              => json(@configuration.prefix),
+      "SPECIAL_OPTIONS_KEY" => json(@configuration.special_options_key),
+      "SERIALIZER"          => @configuration.serializer || json(nil),
     }.inject(File.read(File.dirname(__FILE__) + "/routes.js")) do |js, (key, value)|
       js.gsub!(key, value.to_s)
     end
   end
 
-  def deprecate_url_options
-    result = {}
-    if @options.key?(:default_format)
-      warn("default_format option is deprecated. Use default_url_options = { format: <format> } instead")
-      result.merge!(  format: @options[:default_format]  )
-    end
-    if @options[:url_links].is_a?(String)
-      ActiveSupport::Deprecation.warn('js-routes url_links config value must be a boolean. Use default_url_options for specifying a default host.')
-
-      raise "invalid URL format in url_links (ex: http[s]://example.com)" if @options[:url_links].match(URI::Parser.new.make_regexp(%w(http https))).nil?
-      uri = URI.parse(@options[:url_links])
-      default_port = uri.scheme == "https" ? 443 : 80
-      port = uri.port == default_port ? nil : uri.port
-      result.merge!(
-        host: uri.host,
-        port: port,
-        protocol: uri.scheme,
-      )
-    end
-    result
-  end
-
   def generate!(file_name = nil)
     # Some libraries like Devise do not yet loaded their routes so we will wait
     # until initialization process finish
     # https://github.com/railsware/js-routes/issues/7
     Rails.configuration.after_initialize do
-      file_name ||= self.class.options['file']
-      File.open(Rails.root.join(file_name || DEFAULT_PATH), 'w') do |f|
+      file_name ||= self.class.configuration['file']
+      File.open(Rails.root.join(file_name), 'w') do |f|
         f.write generate
       end
     end
@@ -154,7 +159,7 @@ class JsRoutes
   protected
 
   def application
-    @options[:application] || Rails.application
+    @configuration.application
   end
 
   def named_routes
@@ -189,7 +194,7 @@ class JsRoutes
   end
 
   def build_route_if_match(route, parent_route=nil)
-    if any_match?(route, parent_route, @options[:exclude]) || !any_match?(route, parent_route, @options[:include])
+    if any_match?(route, parent_route, @configuration[:exclude]) || !any_match?(route, parent_route, @configuration[:include])
       nil
     else
       build_js(route, parent_route)
@@ -205,7 +210,7 @@ class JsRoutes
 
   def build_js(route, parent_route)
     name = [parent_route.try(:name), route.name].compact
-    route_name = generate_route_name(name, (:path unless @options[:compact]))
+    route_name = generate_route_name(name, (:path unless @configuration[:compact]))
     parent_spec = parent_route.try(:path).try(:spec)
     route_arguments = route_js_arguments(route, parent_spec)
     url_link = generate_url_link(name, route_name, route_arguments, route)
@@ -236,7 +241,7 @@ class JsRoutes
   end
 
   def generate_url_link(name, route_name, route_arguments, route)
-    return "" unless @options[:url_links]
+    return "" unless @configuration[:url_links]
     <<-JS.strip!
     #{generate_route_name(name, :url)}: Utils.route(#{route_arguments}, true)
     JS
@@ -245,7 +250,7 @@ class JsRoutes
   def generate_route_name(name, suffix)
     route_name = name.join('_')
     route_name << "_#{ suffix }" if suffix
-    @options[:camel_case] ? route_name.camelize(:lower) : route_name
+    @configuration[:camel_case] ? route_name.camelize(:lower) : route_name
   end
 
   def json(string)

data/lib/js_routes/engine.rb

@@ -30,13 +30,12 @@ end
 class Engine < ::Rails::Engine
   require 'sprockets/version'
   v2                = Gem::Dependency.new('', ' ~> 2')
-  v3                = Gem::Dependency.new('', ' >= 3' ,' < 3.7')
-  v37                = Gem::Dependency.new('', ' >= 3.7')
+  vgte3             = Gem::Dependency.new('', ' >= 3')
   sprockets_version = Gem::Version.new(::Sprockets::VERSION).release
   initializer_args  = case sprockets_version
                         when -> (v) { v2.match?('', v) }
                           { after: "sprockets.environment" }
-                        when -> (v) { v3.match?('', v) || v37.match?('', v) }
+                        when -> (v) { vgte3.match?('', v) }
                           { after: :engines_blank_point, before: :finisher_hook }
                         else
                           raise StandardError, "Sprockets version #{sprockets_version} is not supported"
@@ -48,8 +47,7 @@ class Engine < ::Rails::Engine
   initializer 'js-routes.dependent_on_routes', initializer_args do
     case sprockets_version
       when  -> (v) { v2.match?('', v) },
-            -> (v) { v3.match?('', v) },
-            -> (v) { v37.match?('', v) }
+            -> (v) { vgte3.match?('', v) }
 
       # It seems rails 3.2 is not working if
       # `Rails.application.config.assets.configure` is used for

data/lib/js_routes/version.rb

@@ -1,3 +1,3 @@
 class JsRoutes
-  VERSION = "1.3.3"
+  VERSION = "1.4.0"
 end