js-routes 0.8.7 → 0.8.8

data/lib/routes.js.coffee

@@ -0,0 +1,132 @@
+ParameterMissing = (@message) -> #
+ParameterMissing:: = new Error()
+defaults =
+  prefix: "PREFIX"
+  default_url_options: DEFAULT_URL_OPTIONS
+
+NodeTypes = NODE_TYPES
+Utils =
+  serialize: (obj) ->
+    return ""  unless obj
+    if window.jQuery
+      result = window.jQuery.param(obj)
+      return (if not result then "" else "?#{result}")
+    s = []
+    for own key, prop of obj
+      if prop?
+        if prop instanceof Array
+          for val, i in prop
+            s.push "#{key}#{encodeURIComponent("[]")}=#{encodeURIComponent(val.toString())}"
+        else
+          s.push "#{key}=#{encodeURIComponent(prop.toString())}"
+    return "" unless s.length
+    "?#{s.join("&")}"
+
+  clean_path: (path) ->
+    path = path.split("://")
+    last_index = path.length - 1
+    path[last_index] = path[last_index].replace(/\/+/g, "/").replace(/\/$/m, "")
+    path.join "://"
+
+  set_default_url_options: (optional_parts, options) ->
+    for part, i in optional_parts
+      if not options.hasOwnProperty(part) and defaults.default_url_options.hasOwnProperty(part)
+        options[part] = defaults.default_url_options[part]
+
+  extract_anchor: (options) ->
+    anchor = ""
+    if options.hasOwnProperty("anchor")
+      anchor = "##{options.anchor}"
+      options.anchor = null
+    anchor
+
+  extract_options: (number_of_params, args) ->
+    ret_value = {}
+    if args.length > number_of_params and typeof (args[args.length - 1]) is "object"
+      ret_value = args.pop()
+    ret_value
+
+  path_identifier: (object) ->
+    return "0"  if object is 0
+    # null, undefined, false or ''
+    return ""  unless object
+    property = object
+    if typeof (object) is "object"
+      property = object.to_param or object.id or object
+      property = property.call(object) if typeof (property) is "function"
+    property.toString()
+
+  clone: (obj) ->
+    return obj if null is obj or "object" isnt typeof obj
+    copy = obj.constructor()
+    copy[key] = attr for own key, attr of obj
+    copy
+
+  prepare_parameters: (required_parameters, actual_parameters, options) ->
+    result = @clone(options) or {}
+    result[val] = actual_parameters[i] for val, i in required_parameters
+    result
+
+  build_path: (required_parameters, optional_parts, route, args) ->
+    args = Array::slice.call(args)
+    opts = @extract_options(required_parameters.length, args)
+    throw new Error("Too many parameters provided for path") if args.length > required_parameters.length
+    parameters = @prepare_parameters(required_parameters, args, opts)
+    @set_default_url_options optional_parts, parameters
+    result = "#{Utils.get_prefix()}#{@visit(route, parameters)}"
+    Utils.clean_path("#{result}#{Utils.extract_anchor(parameters)}") + Utils.serialize(parameters)
+  #
+  # This function is JavaScript impelementation of the
+  # Journey::Visitors::Formatter that builds route by given parameters
+  # from route binary tree.
+  # Binary tree is serialized in the following way:
+  # [node type, left node, right node ]
+  #
+  # @param  {Boolean} optional  Marks the currently visited branch as optional.
+  # If set to `true`, this method will not throw when encountering
+  # a missing parameter (used in recursive calls).
+  #
+  visit: (route, parameters, optional) ->
+    [type, left, right] = route
+    switch type
+      when NodeTypes.GROUP, NodeTypes.STAR
+        @visit left, parameters, true
+      when NodeTypes.LITERAL, NodeTypes.SLASH, NodeTypes.DOT
+        left
+      when NodeTypes.CAT
+        left_part = @visit(left, parameters, optional)
+        right_part = @visit(right, parameters, optional)
+        return "" if optional and not (left_part and right_part)
+        "#{left_part}#{right_part}"
+      when NodeTypes.SYMBOL
+        value = parameters[left]
+        if value?
+          parameters[left] = null
+          return @path_identifier(value)
+        if optional
+          "" # missing parameter
+        else
+          throw new ParameterMissing("Route parameter missing: #{left}")
+      #
+      # I don't know what is this node type
+      # Please send your PR if you do
+      #
+      # when NodeTypes.OR:
+      else
+        throw new Error("Unknown Rails node type")
+
+  get_prefix: ->
+    prefix = defaults.prefix
+    prefix = (if prefix.match("/$") then prefix else "#{prefix}/") if prefix isnt ""
+    prefix
+
+  namespace: (root, namespaceString) ->
+    parts = (if namespaceString then namespaceString.split(".") else [])
+    return unless parts.length
+    current = parts.shift()
+    root[current] = root[current] or {}
+    Utils.namespace root[current], parts.join(".")
+
+Utils.namespace window, "NAMESPACE"
+window.NAMESPACE = ROUTES
+window.NAMESPACE.options = defaults

data/spec/js_routes/options_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe JsRoutes, "options" do
-  
+
   before(:each) do
     evaljs(_presetup)
     with_warnings(_warnings) do
@@ -14,7 +14,7 @@ describe JsRoutes, "options" do
   let(:_warnings) { true }
 
   context "when exclude is specified" do
-    
+
     let(:_options) { {:exclude => /^admin_/} }
 
     it "should exclude specified routes from file" do
@@ -26,7 +26,7 @@ describe JsRoutes, "options" do
     end
   end
   context "when include is specified" do
-    
+
     let(:_options) { {:include => /^admin_/} }
 
     it "should exclude specified routes from file" do
@@ -39,7 +39,7 @@ describe JsRoutes, "options" do
   end
 
   context "when prefix with trailing slash is specified" do
-    
+
     let(:_options) { {:prefix => "/myprefix/" } }
 
     it "should render routing with prefix" do
@@ -54,22 +54,22 @@ describe JsRoutes, "options" do
   end
 
   context "when prefix with http:// is specified" do
-    
+
     let(:_options) { {:prefix => "http://localhost:3000" } }
 
     it "should render routing with prefix" do
       evaljs("Routes.inbox_path(1)").should == _options[:prefix] + routes.inbox_path(1)
     end
   end
-  
+
   context "when prefix without trailing slash is specified" do
-    
+
     let(:_options) { {:prefix => "/myprefix" } }
 
     it "should render routing with prefix" do
       evaljs("Routes.inbox_path(1)").should == "/myprefix#{routes.inbox_path(1)}"
     end
-    
+
     it "should render routing with prefix set in JavaScript" do
       evaljs("Routes.options.prefix = '/newprefix'")
       evaljs("Routes.inbox_path(1)").should == "/newprefix#{routes.inbox_path(1)}"
@@ -80,7 +80,7 @@ describe JsRoutes, "options" do
   context "when default_format is specified" do
     let(:_options) { {:default_format => "json"} }
     let(:_warnings) { nil }
-    
+
     it "should render routing with default_format" do
       evaljs("Routes.inbox_path(1)").should == routes.inbox_path(1, :format => "json")
     end
@@ -110,7 +110,7 @@ describe JsRoutes, "options" do
     end
   end
 
-  describe "when nested namespace option is specified" do 
+  describe "when nested namespace option is specified" do
     context "and defined on client" do
       let(:_presetup) { "window.PHM = {}" }
       let(:_options) { {:namespace => "PHM.Routes"} }
@@ -123,7 +123,7 @@ describe JsRoutes, "options" do
       let(:_options) { {:namespace => "PHM.Routes"} }
       it "should initialize namespace" do
         evaljs("window.PHM.Routes.inbox_path").should_not be_nil
-      end 
+      end
     end
 
     context "and some parts are defined" do
@@ -152,4 +152,24 @@ describe JsRoutes, "options" do
       end
     end
   end
+
+  describe "camel_case" do
+    context "with default option" do
+      let(:_options) { Hash.new }
+      it "should use snake case routes" do
+        evaljs("Routes.inbox_path(1)").should == routes.inbox_path(1)
+        evaljs("Routes.inboxPath").should be_nil
+      end
+    end
+
+    context "with true" do
+      let(:_options) { { :camel_case => true } }
+      it "should generate camel case routes" do
+        evaljs("Routes.inbox_path").should be_nil
+        evaljs("Routes.inboxPath").should_not be_nil
+        evaljs("Routes.inboxPath(1)").should == routes.inbox_path(1)
+        evaljs("Routes.inboxMessagesPath(10)").should == routes.inbox_messages_path(:inbox_id => 10)
+      end
+    end
+  end
 end

data/spec/js_routes/rails_routes_compatibility_spec.rb

@@ -54,11 +54,11 @@ describe JsRoutes, "compatibility with Rails"  do
   it "should support url anchor given as parameter" do
     evaljs("Routes.inbox_path(1, {anchor: 'hello'})").should == routes.inbox_path(1, :anchor => "hello")
   end
-  
+
   it "should support engine routes" do
     evaljs("Routes.blog_app_posts_path()").should == blog_routes.posts_path()
   end
-  
+
   it "should support engine routes with parameter" do
     evaljs("Routes.blog_app_post_path(1)").should == blog_routes.post_path(1)
   end
@@ -149,7 +149,7 @@ describe JsRoutes, "compatibility with Rails"  do
   end
 
   context "when wrong parameters given" do
-    
+
     it "should throw Exception if not enough parameters" do
       lambda {
         evaljs("Routes.inbox_path()")

data/spec/spec_helper.rb

@@ -1,13 +1,14 @@
 # encoding: utf-8
 
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$:.unshift(File.dirname(__FILE__))
 require 'rspec'
 require 'rails/all'
 require 'js-routes'
 require "v8"
 require "cgi"
 require "active_support/core_ext/hash/slice"
+require 'coffee-script'
 
 def jscontext
   @context ||= V8::Context.new
@@ -44,7 +45,7 @@ def draw_routes
   BlogEngine::Engine.routes.draw do
     resources :posts
   end
-  App.routes.draw do 
+  App.routes.draw do
     resources :inboxes do
       resources :messages do
         resources :attachments
@@ -63,7 +64,7 @@ def draw_routes
     scope "(/optional/:optional_id)" do
       resources :things
     end
-    
+
     match "/other_optional/(:optional_id)" => "foo#foo", :as => :foo
 
     match 'books/*section/:title' => 'books#show', :as => :book
@@ -87,14 +88,20 @@ Rails.configuration.active_support.deprecation = :log
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
 
 RSpec.configure do |config|
-  
+
   config.before(:each) do
     evaljs("var window = this;")
-    jscontext[:cgi] = CGI
-    evaljs("function encodeURIComponent(string) {return cgi.escape(string);}")
+    # No need to replace native V8 functions for now
+    #jscontext[:cgi] = CGI
+    #evaljs("function encodeURIComponent(string) {return cgi.escape(string);}")
     jscontext[:log] = lambda {|arg| puts arg.inspect}
   end
   config.before(:all) do
+    # compile all js files begin
+    Dir["#{File.expand_path(File.join(File.dirname(__FILE__), "..", "lib"))}/**/*.coffee"].each do |coffee|
+      File.open(coffee.gsub(/\.coffee$/, ""), 'w') {|f| f.write(CoffeeScript.compile(File.read(coffee))) }
+    end
+    # compile all js files end
     draw_routes
   end
 end

metadata

@@ -1,163 +1,185 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: js-routes
-version: !ruby/object:Gem::Version 
-  hash: 49
+version: !ruby/object:Gem::Version
+  version: 0.8.8
   prerelease: 
-  segments: 
-  - 0
-  - 8
-  - 7
-  version: 0.8.7
 platform: ruby
-authors: 
+authors:
 - Bogdan Gusiev
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-02-13 00:00:00 +02:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 3
-        - 2
-        version: "3.2"
-  version_requirements: *id001
-  prerelease: false
+date: 2013-02-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rails
-  type: :runtime
-- !ruby/object:Gem::Dependency 
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  version_requirements: *id002
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
   name: therubyracer
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-- !ruby/object:Gem::Dependency 
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 39
-        segments: 
-        - 2
-        - 10
-        - 0
+      - !ruby/object:Gem::Version
         version: 2.10.0
-  version_requirements: *id003
-  prerelease: false
-  name: rspec
   type: :development
-- !ruby/object:Gem::Dependency 
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 19
-        segments: 
-        - 1
-        - 1
-        - 0
+      - !ruby/object:Gem::Version
+        version: 2.10.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.1.0
-  version_requirements: *id004
+  type: :development
   prerelease: false
-  name: bundler
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-- !ruby/object:Gem::Dependency 
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 11
-        segments: 
-        - 1
-        - 6
-        - 2
-        version: 1.6.2
-  version_requirements: *id005
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
   prerelease: false
-  name: jeweler
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-coffeescript
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-description: Generates javascript file that defines all Rails named routes as javascript helpers
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Generates javascript file that defines all Rails named routes as javascript
+  helpers
 email: agresso@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - LICENSE.txt
-files: 
+files:
 - .document
+- .gitignore
 - .rspec
 - .travis.yml
 - Gemfile
-- Gemfile.lock
+- Guardfile
 - LICENSE.txt
 - Rakefile
 - Readme.md
-- VERSION
 - app/assets/javascripts/js-routes.js.erb
 - js-routes.gemspec
 - lib/js-routes.rb
 - lib/js_routes.rb
 - lib/js_routes/engine.rb
+- lib/js_routes/version.rb
 - lib/routes.js
+- lib/routes.js.coffee
 - lib/tasks/js_routes.rake
 - spec/js_routes/generated_javascript_spec.rb
 - spec/js_routes/options_spec.rb
 - spec/js_routes/post_rails_init_spec.rb
 - spec/js_routes/rails_routes_compatibility_spec.rb
 - spec/spec_helper.rb
-has_rdoc: true
 homepage: http://github.com/railsware/js-routes
-licenses: 
+licenses:
 - MIT
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: -1021076515432540813
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.6.0
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Brings Rails named routes to javascript
 test_files: []
-