js-routes 0.2.0

data/.document

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

data/.rspec

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

data/Gemfile

@@ -0,0 +1,11 @@
+source "http://rubygems.org"
+
+gem "rails", ">= 3.0"
+
+group :development do
+  gem "therubyracer"
+  gem "rspec", "~> 2.3.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.2"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,97 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.9)
+      actionpack (= 3.0.9)
+      mail (~> 2.2.19)
+    actionpack (3.0.9)
+      activemodel (= 3.0.9)
+      activesupport (= 3.0.9)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.5.0)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.14)
+      rack-test (~> 0.5.7)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.9)
+      activesupport (= 3.0.9)
+      builder (~> 2.1.2)
+      i18n (~> 0.5.0)
+    activerecord (3.0.9)
+      activemodel (= 3.0.9)
+      activesupport (= 3.0.9)
+      arel (~> 2.0.10)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.9)
+      activemodel (= 3.0.9)
+      activesupport (= 3.0.9)
+    activesupport (3.0.9)
+    arel (2.0.10)
+    builder (2.1.2)
+    diff-lcs (1.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    git (1.2.5)
+    i18n (0.5.0)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    libv8 (3.3.10.2)
+    mail (2.2.19)
+      activesupport (>= 2.3.6)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    polyglot (0.3.2)
+    rack (1.2.3)
+    rack-mount (0.6.14)
+      rack (>= 1.0.0)
+    rack-test (0.5.7)
+      rack (>= 1.0)
+    rails (3.0.9)
+      actionmailer (= 3.0.9)
+      actionpack (= 3.0.9)
+      activerecord (= 3.0.9)
+      activeresource (= 3.0.9)
+      activesupport (= 3.0.9)
+      bundler (~> 1.0)
+      railties (= 3.0.9)
+    railties (3.0.9)
+      actionpack (= 3.0.9)
+      activesupport (= 3.0.9)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (~> 0.14.4)
+    rake (0.9.2)
+    rcov (0.9.9)
+    rdoc (3.9.1)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+    therubyracer (0.9.2)
+      libv8 (~> 3.3.10)
+    thor (0.14.6)
+    treetop (1.4.10)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.29)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.2)
+  rails (>= 3.0)
+  rcov
+  rspec (~> 2.3.0)
+  therubyracer

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,49 @@
+# 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 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "js-routes"
+  gem.homepage = "http://github.com/railsware/js-routes"
+  gem.license = "MIT"
+  gem.summary = %Q{Brings Rails named routes to javascript}
+  gem.description = %Q{Generates javascript file that defines all Rails named routes as javascript helpers}
+  gem.email = "agresso@gmail.com"
+  gem.authors = ["Bogdan Gusiev"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "js-routes #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/Readme.md

@@ -0,0 +1,38 @@
+## JsRoutes
+
+Generates javascript file that defines all Rails named routes as javascript helpers
+
+### Intallation
+
+Your Rails Gemfile:
+
+``` ruby
+gem "js-routes"
+```
+
+Your application initializer, like `config/initializers/jsroutes.rb`:
+
+``` ruby
+JsRoutes.generate!(
+    :file => "#{Rails.root}app/assets/javascripts/routes.js",  # This is default
+    :default_format => "json"                         # Default is blank
+)
+```
+
+### Usage
+
+This 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, {format: 'json'}) // => "/users/1.json"
+Routes.urer_project_path(1,2, {q: 'hello', custom: true}) // => "/users/1/projects/2?q=hello&custom=true"
+```
+
+In order to make routes helpers available globally:
+
+``` js
+$.extend(window, Routes)
+```
+
+#### Have fun 

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/jsroutes.gemspec

@@ -0,0 +1,69 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{jsroutes}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Bogdan Gusiev"]
+  s.date = %q{2011-08-04}
+  s.description = %q{Generates javascript file that defines all Rails named routes as javascript helpers}
+  s.email = %q{agresso@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "Rakefile",
+    "Readme.md",
+    "VERSION",
+    "jsroutes.gemspec",
+    "lib/js_routes.rb",
+    "lib/jsroutes.rb",
+    "lib/routes.js",
+    "lib/tasks/js_routes.rake",
+    "spec/js_routes_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/bogdan/jsroutes}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Brings Rails named routes to javascript}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rails>, [">= 0"])
+      s.add_development_dependency(%q<therubyracer>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<rails>, [">= 0"])
+      s.add_dependency(%q<therubyracer>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rails>, [">= 0"])
+    s.add_dependency(%q<therubyracer>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/lib/js_routes.rb

@@ -0,0 +1,88 @@
+module JsRoutes
+  class << self
+
+
+    def generate(options = {})
+      js = File.read(File.dirname(__FILE__) + "/routes.js")
+      js.gsub!("IDENTITY", js_routes(options))
+    end
+
+    def generate!(options = {})
+      file = options[:file] || default_file
+      File.open(file, 'w') do |f|
+        f.write generate(options)
+      end
+    end
+
+    #
+    # Implementation
+    #
+
+    protected
+    def js_routes(options = {})
+
+      options[:default_format] ||= ""
+
+      Rails.application.reload_routes!
+      Rails.application.routes.named_routes.routes.map do |name, route|
+        <<-JS
+  // #{route.name} => #{route.path}
+  #{name.to_s}_path: function(#{build_params route}) {
+    var opts = options || {};
+    var format = opts.format || '#{options[:default_format]}';
+    delete opts.format;
+  #{build_default_params route};
+    return Routes.check_path('#{build_path route}' + format) + Routes.serialize(opts);
+  },
+JS
+      end.join("\n")
+    end
+
+
+    def build_params route
+      route.conditions[:path_info].captures.map do |cap|
+        if cap.is_a?(Rack::Mount::GeneratableRegexp::DynamicSegment)
+          if cap.name.to_s == "format"
+            nil
+          else
+            cap.name.to_s.gsub(':', '')
+          end
+        end
+      end.compact.<<("options").join(', ')
+    end
+
+    def build_default_params route
+      route.conditions[:path_info].captures.map do |cap|
+        if cap.is_a?(Rack::Mount::GeneratableRegexp::DynamicSegment)
+          segg = cap.name.to_s.gsub(':', '')
+          "#{segg} = Routes.check_parameter(#{segg});"
+        end
+      end.join("\n")
+    end
+
+    def build_path route
+      s = route.path.gsub(/\(\.:format\)$/, ".")
+
+      route.conditions[:path_info].captures.each do |cap|
+        unless cap.name.to_s == "format"
+          if route.conditions[:path_info].required_params.include?(cap.name)
+            s.gsub!(/:#{cap.name.to_s}/){ "' + #{cap.name.to_s.gsub(':','')} + '" }
+          else
+            s.gsub!(/\((\.)?:#{cap.name.to_s}\)/){ "#{$1}' + #{cap.name.to_s.gsub(':','')} + '" }
+          end
+        end
+      end
+      s
+
+    end
+
+    def default_file
+      if Rails.version >= "3.1"
+        "#{Rails.root}/app/assets/javascripts/routes.js"
+      else
+        "#{Rails.root}/public/javascripts/routes.js"
+      end
+    end
+
+  end
+end

data/lib/jsroutes.rb

@@ -0,0 +1 @@
+require "js_routes"

data/lib/routes.js

@@ -0,0 +1,29 @@
+var Routes = {
+
+  IDENTITY
+
+  serialize: function(obj){
+    if (obj == null) {return '';}
+    var s = [];
+    for (prop in obj){
+      s.push(prop + "=" + obj[prop]);
+    }
+    if (s.length == 0) {
+      return '';
+    }
+    return "?" + s.join('&');
+  },
+
+
+  check_parameter: function(param) {
+    if (param === undefined) {
+      param = '';
+    }
+    return param;
+  },
+  
+  check_path: function(path) {
+    return path.replace(/\.$/m, '');
+  }
+
+}

data/lib/tasks/js_routes.rake

@@ -0,0 +1,14 @@
+
+namespace :less do
+  namespace :js do
+    desc "Make a js file that will have functions that will return restful routes/urls."
+    task :routes => :environment do
+      require "jsroutes"
+
+      # Hack for actually load the routes (taken from railties console/app.rb)
+      ActionDispatch::Callbacks.new(lambda {}, false)
+
+      JsRoutes.generate!
+    end
+  end
+end

data/spec/js_routes_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+require "fileutils"
+
+
+
+describe JsRoutes do
+  before(:each) do
+    evaljs(JsRoutes.generate(_options))
+  end
+
+  let(:_options) { {} }
+
+  it "should generate collection routing" do
+    evaljs("Routes.inboxes_path()").should == "/inboxes"
+  end
+
+  it "should generate member routing" do
+    evaljs("Routes.inbox_path(1)").should == "/inboxes/1"
+  end
+
+  it "should generate nested routing" do
+    evaljs("Routes.inbox_message_path(1,2)").should == "/inboxes/1/messages/2"
+  end
+
+  it "should generate routing with format" do
+    evaljs("Routes.inbox_path(1, {format: 'json'})").should == "/inboxes/1.json"
+  end
+
+  it "should support get parameters" do
+    evaljs("Routes.inbox_path(1, {format: 'json', q: 'hello', lang: 'ua'})").should == "/inboxes/1.json?q=hello&lang=ua"
+  end
+
+
+  context "when default_format is specified" do
+    let(:_options) { {:default_format => "json"} }
+    
+    it "should render routing with default_format" do
+      evaljs("Routes.inbox_path(1)").should == "/inboxes/1.json"
+    end
+
+    it "should override default_format implicitly" do
+      evaljs("Routes.inbox_path(1, {format: 'xml'})").should == "/inboxes/1.xml"
+    end
+
+  end
+
+  describe ".generate!" do
+    let(:name) {  "#{File.dirname(__FILE__)}/../routes.js" }
+    it "should generate routes file" do
+      FileUtils.rm_f(name)
+      JsRoutes.generate!({:file => name})
+      File.exists?(name).should be_true 
+    end
+    after(:all) do
+      FileUtils.rm_f(name)
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,30 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'jsroutes'
+require 'rails'
+require "v8"
+require "active_support/core_ext/hash/slice"
+
+def evaljs(string)
+  @context ||= V8::Context.new
+  @context.eval(string)
+end
+
+class App < Rails::Application
+  self.routes.draw do 
+    resources :inboxes do
+      resources :messages
+    end
+  end
+end
+
+
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification 
+name: js-routes
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- Bogdan Gusiev
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-04 00:00:00 +03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
+  requirement: *id001
+  type: :runtime
+  name: rails
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id002
+  type: :development
+  name: therubyracer
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 3
+        - 0
+        version: 2.3.0
+  requirement: *id003
+  type: :development
+  name: rspec
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  requirement: *id004
+  type: :development
+  name: bundler
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 1
+        - 6
+        - 2
+        version: 1.6.2
+  requirement: *id005
+  type: :development
+  name: jeweler
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id006
+  type: :development
+  name: rcov
+  prerelease: false
+description: Generates javascript file that defines all Rails named routes as javascript helpers
+email: agresso@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+files: 
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- Rakefile
+- Readme.md
+- VERSION
+- jsroutes.gemspec
+- lib/js_routes.rb
+- lib/jsroutes.rb
+- lib/routes.js
+- lib/tasks/js_routes.rake
+- spec/js_routes_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/railsware/js-routes
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Brings Rails named routes to javascript
+test_files: []
+