strawberry_cough 0.1.0

data/.gitignore

@@ -0,0 +1,4 @@
+.DS_Store
+.bundle
+pkg/*
+*.gem

data/.rspec

@@ -0,0 +1 @@
+--colour

data/Gemfile

@@ -0,0 +1,14 @@
+source :rubygems
+
+gemspec
+
+gem 'rake', '~> 0.8.7'
+
+gem 'activesupport', '~> 3.0.0'
+gem 'railties',      '~> 3.0.0'
+
+group :test do
+  gem 'rspec',        '~> 2.0.0.beta.22'
+  gem 'therubyracer', '~> 0.7.5'
+  gem 'autotest',     '~> 4.3.2'
+end

data/Gemfile.lock

@@ -0,0 +1,67 @@
+PATH
+  remote: .
+  specs:
+    strawberry_cough (0.1.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionpack (3.0.0)
+      activemodel (= 3.0.0)
+      activesupport (= 3.0.0)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4.1)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.12)
+      rack-test (~> 0.5.4)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.0)
+      activesupport (= 3.0.0)
+      builder (~> 2.1.2)
+      i18n (~> 0.4.1)
+    activesupport (3.0.0)
+    autotest (4.3.2)
+    builder (2.1.2)
+    diff-lcs (1.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    i18n (0.4.1)
+    rack (1.2.1)
+    rack-mount (0.6.13)
+      rack (>= 1.0.0)
+    rack-test (0.5.5)
+      rack (>= 1.0)
+    railties (3.0.0)
+      actionpack (= 3.0.0)
+      activesupport (= 3.0.0)
+      rake (>= 0.8.4)
+      thor (~> 0.14.0)
+    rake (0.8.7)
+    rspec (2.0.0.beta.22)
+      rspec-core (= 2.0.0.beta.22)
+      rspec-expectations (= 2.0.0.beta.22)
+      rspec-mocks (= 2.0.0.beta.22)
+    rspec-core (2.0.0.beta.22)
+    rspec-expectations (2.0.0.beta.22)
+      diff-lcs (>= 1.1.2)
+    rspec-mocks (2.0.0.beta.22)
+      rspec-core (= 2.0.0.beta.22)
+      rspec-expectations (= 2.0.0.beta.22)
+    therubyracer (0.7.5)
+    thor (0.14.2)
+    tzinfo (0.3.23)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport (~> 3.0.0)
+  autotest (~> 4.3.2)
+  bundler (>= 1.0.0)
+  railties (~> 3.0.0)
+  rake (~> 0.8.7)
+  rspec (~> 2.0.0.beta.22)
+  strawberry_cough!
+  therubyracer (~> 0.7.5)

data/LICENSE

@@ -0,0 +1,29 @@
+License
+-------
+
+Copyright 2010, Three Wise Men Inc. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+   1. Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+
+   2. Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THREE WISE MEN, INC "AS IS" AND ANY EXPRESS OR
+IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
+EVENT SHALL THREE WISE MEN, INC OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
+OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+The views and conclusions contained in the software and documentation are
+those of the authors and should not be interpreted as representing official
+policies, either expressed or implied, of Three Wise Men Inc.

data/README.md

@@ -0,0 +1,78 @@
+Strawberry Cough
+================
+
+Strawberry Cough lets you access your Rails 3 routes in your JavaScripts.
+
+Example
+-------
+
+    # In your routes.rb
+
+    resources :widgets
+    root :to => "widgets#index"
+
+With Strawberry Cough, you get access to URL helpers in JavaScript via the
+`Routes` object.
+
+    // In any JavaScript file
+
+    Routes.widgetsPath();          // "/widgets"
+    Routes.newWidgetPath();        // "/widgets/new"
+    Routes.newWidgetPath("xml");   // "/widgets/new.xml"
+    Routes.rootPath();             // "/"
+
+Installation
+------------
+
+To install, just add the following line to your Gemfile.
+
+    gem 'strawberry_cough'
+
+Then include the `routes.js` JavaScript file before any script that uses it in your layout/views.
+
+Notes
+-----
+
+Right now, Strawberry Cough is **Rails 3 only**.
+
+A file `public/javascripts/routes.js` will be generated on each request to your app in the development environment, and on the first request only in production.
+
+It uses the `to_prepare` hook in Railties (refer to [Rails docs][1]).
+
+Authors
+-------
+
+  * Craig Savolainen ([maedhr](http://github.com/maedhr))
+  * Nate Smith ([nwjsmith](http://github.com/nwjsmith))
+
+License
+-------
+
+Copyright 2010, Three Wise Men Inc. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+   1. Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+
+   2. Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THREE WISE MEN, INC "AS IS" AND ANY EXPRESS OR
+IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
+EVENT SHALL THREE WISE MEN, INC OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
+OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+The views and conclusions contained in the software and documentation are
+those of the authors and should not be interpreted as representing official
+policies, either expressed or implied, of Three Wise Men Inc.
+
+  [1]: http://api.rubyonrails.org/classes/Rails/Railtie.html "Railties docs"

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rspec/core/rake_task'
+require 'bundler'
+
+Bundler::GemHelper.install_tasks
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/TODO

@@ -0,0 +1,2 @@
+Make output file configurable.
+Make JS Routes object name configurable.

data/autotest/discover.rb

@@ -0,0 +1 @@
+Autotest.add_discovery { "rspec2" }

data/lib/strawberry_cough.rb

@@ -0,0 +1,5 @@
+require 'strawberry_cough/version'
+require 'strawberry_cough/path_compiler'
+require 'strawberry_cough/path_parser'
+require 'strawberry_cough/routes_compiler'
+require 'strawberry_cough/railtie'

data/lib/strawberry_cough/path_compiler.rb

@@ -0,0 +1,34 @@
+module StrawberryCough
+
+  class PathCompiler
+
+    def self.compile(path)
+      params  = PathParser.parse_params(path)
+      anchors = PathParser.parse_anchors(path)
+      js = <<-COMPILED
+function (#{args_list(params)}) {
+    var url = #{url_concatenation(anchors, params)};
+    if (format === undefined) {
+      return url;
+    } else {
+      return url + "." + format;
+    }
+}
+      COMPILED
+      js.strip
+    end
+
+    private
+      def self.url_concatenation(anchors, params)
+        params_without_format = params.reject { |p| p == "format" }
+        quoted_anchors = anchors.map { |a| "\"#{a}\"" }
+        anchors_paired_with_params = quoted_anchors.zip(params_without_format)
+        anchors_paired_with_params.flatten.compact.join(" + ")
+      end
+
+      def self.args_list(params)
+        params.join(", ")
+      end
+  end
+
+end

data/lib/strawberry_cough/path_parser.rb

@@ -0,0 +1,18 @@
+module StrawberryCough
+
+  class PathParser
+
+    PARAM_PATTERN = /:([\w_\d]+)\(*/
+    SPLIT_ME = "{}{}}{}{}}{}"
+
+    def self.parse_params(path)
+      path.scan(PARAM_PATTERN).flatten
+    end
+
+    def self.parse_anchors(path)
+      path.gsub(/\(.*\)/, '').gsub(PARAM_PATTERN, SPLIT_ME).split(SPLIT_ME)
+    end
+
+  end
+
+end

data/lib/strawberry_cough/railtie.rb

@@ -0,0 +1,19 @@
+require 'strawberry_cough/routes_compiler'
+require 'rails/railtie'
+
+module StrawberryCough
+
+  class Railtie < Rails::Railtie
+
+    config.to_prepare do
+      app = Rails.application
+      routes = app.routes.routes
+      file = File.join(app.root, "public", "javascripts", "routes.js")
+      File.open(file, "w") do |io|
+        RoutesCompiler.compile_to_io(routes, io)
+      end
+    end
+
+  end
+
+end

data/lib/strawberry_cough/routes_compiler.rb

@@ -0,0 +1,24 @@
+require 'active_support/inflector'
+
+module StrawberryCough
+
+  class RoutesCompiler
+
+    def self.compile(route_set)
+      functions = route_set.inject(Set.new) do |memo, route|
+        name = route.name.camelize(:lower) + "Path"
+        memo << "#{name} : " + PathCompiler.compile(route.path)
+      end.to_a.join(',')
+      <<-COMPILED
+var Routes = {
+    #{functions}
+};
+      COMPILED
+    end
+
+    def self.compile_to_io(route_set, io)
+      io << compile(route_set)
+    end
+
+  end
+end

data/lib/strawberry_cough/version.rb

@@ -0,0 +1,3 @@
+module StrawberryCough
+  VERSION = "0.1.0"
+end

data/spec/path_compiler_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe StrawberryCough::PathCompiler do
+  let(:compiler) { StrawberryCough::PathCompiler }
+  let(:interpreter) { V8::Context.new }
+
+  it "compiles a resource path into a JavaScript function that returns that path" do
+    resource_path = "/parent/:id/edit(.:format)"
+    path_function = compiler.compile(resource_path)
+    interpreter.eval("var path = #{path_function};")
+    interpreter.eval("path(1, 'xml')").should == '/parent/1/edit.xml'
+  end
+
+  it "compiles the root path to a JS function that returns the root path" do
+    root_path = "/(.:format)"
+    path_function = compiler.compile(root_path)
+    interpreter.eval("var rootPath = #{path_function};")
+    interpreter.eval("rootPath('xml')").should == '/.xml'
+  end
+
+  it "compiles a path without parameters to a JS function that returns that path" do
+    simple_path = "/parent/new(.:format)"
+    path_function = compiler.compile(simple_path)
+    interpreter.eval("var simplePath = #{path_function};")
+    interpreter.eval("simplePath('xml')").should == '/parent/new.xml'
+  end
+
+  it "compiles a path to a function that optionally takes a format" do
+    path_with_format = "/parent/new(.:format)"
+    path_function = compiler.compile(path_with_format)
+    interpreter.eval("var path = #{path_function}")
+    interpreter.eval("path()").should == "/parent/new"
+  end
+end

data/spec/path_parser_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe StrawberryCough::PathParser do
+  let(:parser) { StrawberryCough::PathParser }
+  let(:simple_resource_path) { "/parent/:id/edit(.:format)" }
+  let(:nested_resource_path) { "/parent/:parent_id/child/:id/edit(.:format)" }
+
+  describe ".parse_params" do
+    it "parses parameters from simple resource path" do
+      parser.parse_params(simple_resource_path).should == %w{id format}
+    end
+
+    it "parses parameters from nested resource path" do
+      parser.parse_params(nested_resource_path).should == %w{parent_id id format}
+    end
+  end
+
+  describe ".parse_anchors" do
+    it "parses anchors from a simple resource path" do
+      parser.parse_anchors(simple_resource_path).should == %w{/parent/ /edit}
+    end
+
+    it "parses anchors from a nested resource path" do
+      parser.parse_anchors(nested_resource_path).should == %w{/parent/ /child/ /edit}
+    end
+
+    it "combines anchors not followed by a parameter" do
+      parser.parse_anchors("/parent/new").should == %w{/parent/new}
+    end
+
+    it 'should parse root anchor' do
+      parser.parse_anchors("/").should == %w{/}
+    end
+  end
+end

data/spec/routes_compiler_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe StrawberryCough::RoutesCompiler do
+  let(:compiler) { StrawberryCough::RoutesCompiler }
+  let(:interpreter) { V8::Context.new }
+
+  it "makes an empty JavaScript object when given an empty route set" do
+    routes_object = compiler.compile([])
+    interpreter.eval(routes_object)
+    interpreter.eval("Routes.rootPath === undefined").should be_true
+  end
+
+  it "makes a Routes JavaScript object when given an array of routes" do
+    route = double('route')
+    route.stub(:path) { "/parent/:id/edit(.:format)" }
+    route.stub(:name) { "edit_parent" }
+    routes_object = compiler.compile([route])
+    interpreter.eval(routes_object)
+    interpreter.eval("typeof Routes.editParentPath === 'function'").should be_true
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+lib_dir = File.dirname(__FILE__) + '/../lib'
+$:.unshift lib_dir unless $:.include?(lib_dir)
+
+require 'rspec'
+require 'v8'
+
+require 'strawberry_cough'
+
+alias :context :describe

data/strawberry_cough.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path("../lib/strawberry_cough/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "strawberry_cough"
+  s.version     = StrawberryCough::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Craig Savolainen", "Nate Smith"]
+  s.email       = ["support@threewisemen.ca"]
+  s.homepage    = "http://github.com/ThreeWiseMen/strawberry_cough"
+  s.summary     = "Strawberry Cough lets you access your Rails 3 routes in your JavaScripts."
+
+  s.required_rubygems_version = ">= 1.3.6"
+  s.rubyforge_project         = "strawberry_cough"
+
+  s.add_development_dependency "bundler", ">= 1.0.0"
+
+  s.files        = `git ls-files`.split("\n")
+  s.require_path = 'lib'
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification 
+name: strawberry_cough
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Craig Savolainen
+- Nate Smith
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-25 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id001
+description: 
+email: 
+- support@threewisemen.ca
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- TODO
+- autotest/discover.rb
+- lib/strawberry_cough.rb
+- lib/strawberry_cough/path_compiler.rb
+- lib/strawberry_cough/path_parser.rb
+- lib/strawberry_cough/railtie.rb
+- lib/strawberry_cough/routes_compiler.rb
+- lib/strawberry_cough/version.rb
+- spec/path_compiler_spec.rb
+- spec/path_parser_spec.rb
+- spec/routes_compiler_spec.rb
+- spec/spec_helper.rb
+- strawberry_cough.gemspec
+has_rdoc: true
+homepage: http://github.com/ThreeWiseMen/strawberry_cough
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: -3654356472966179208
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: strawberry_cough
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Strawberry Cough lets you access your Rails 3 routes in your JavaScripts.
+test_files: []
+