strawberry_cough 0.1.0 → 0.2.0

data/.gitignore

@@ -2,3 +2,8 @@
 .bundle
 pkg/*
 *.gem
+tmp
+measurements
+doc
+.yardoc
+

data/.rvmrc

@@ -0,0 +1 @@
+rvm use --create 1.9.3@strawberry_cough

data/Gemfile

@@ -1,14 +1,15 @@
-source :rubygems
+source 'http://rubygems.org/'
 
 gemspec
 
-gem 'rake', '~> 0.8.7'
+gem 'rake'
 
-gem 'activesupport', '~> 3.0.0'
-gem 'railties',      '~> 3.0.0'
+gem 'activesupport', '~> 3.1'
+gem 'railties', '~> 3.1'
+gem 'tilt'
+gem 'sprockets-rails'
 
 group :test do
-  gem 'rspec',        '~> 2.0.0.beta.22'
-  gem 'therubyracer', '~> 0.7.5'
-  gem 'autotest',     '~> 4.3.2'
+  gem 'rspec'
+  gem 'therubyracer'
 end

data/Gemfile.lock

@@ -1,67 +1,82 @@
 PATH
   remote: .
   specs:
-    strawberry_cough (0.1.0)
+    strawberry_cough (0.2.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)
+    actionpack (3.1.1)
+      activemodel (= 3.1.1)
+      activesupport (= 3.1.1)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      i18n (~> 0.6)
+      rack (~> 1.3.2)
+      rack-cache (~> 1.1)
+      rack-mount (~> 0.8.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.0.2)
+    activemodel (3.1.1)
+      activesupport (= 3.1.1)
+      builder (~> 3.0.0)
+      i18n (~> 0.6)
+    activesupport (3.1.1)
+      multi_json (~> 1.0)
+    builder (3.0.0)
+    diff-lcs (1.1.3)
+    erubis (2.7.0)
+    hike (1.2.1)
+    i18n (0.6.0)
+    json (1.6.1)
+    multi_json (1.0.3)
+    rack (1.3.5)
+    rack-cache (1.1)
+      rack (>= 0.4)
+    rack-mount (0.8.3)
       rack (>= 1.0.0)
-    rack-test (0.5.5)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.1)
       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)
+    railties (3.1.1)
+      actionpack (= 3.1.1)
+      activesupport (= 3.1.1)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (~> 0.14.6)
+    rake (0.9.2.2)
+    rdoc (3.11)
+      json (~> 1.4)
+    rspec (2.7.0)
+      rspec-core (~> 2.7.0)
+      rspec-expectations (~> 2.7.0)
+      rspec-mocks (~> 2.7.0)
+    rspec-core (2.7.1)
+    rspec-expectations (2.7.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.7.0)
+    sprockets (2.0.3)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sprockets-rails (0.0.1)
+      sprockets (>= 1.0.2)
+    therubyracer (0.8.1)
+    thor (0.14.6)
+    tilt (1.3.3)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  activesupport (~> 3.0.0)
-  autotest (~> 4.3.2)
+  activesupport (~> 3.1)
   bundler (>= 1.0.0)
-  railties (~> 3.0.0)
-  rake (~> 0.8.7)
-  rspec (~> 2.0.0.beta.22)
+  railties (~> 3.1)
+  rake
+  rspec
+  sprockets-rails
   strawberry_cough!
-  therubyracer (~> 0.7.5)
+  therubyracer
+  tilt

data/README.md

@@ -28,16 +28,18 @@ 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.
+Then `//= require routes` in the JavaScript manifest file.
+
+If you want a differently named JavaScript file add
+`somefile.js.strawberry_cough` to your javascript assets.
 
 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.
+Right now, Strawberry Cough is **Rails 3.1 only**.
 
-It uses the `to_prepare` hook in Railties (refer to [Rails docs][1]).
+It uses Rails' asset pipeline to generate the route file.
+In development/test environments add config.assets.compile=true.
 
 Authors
 -------
@@ -48,7 +50,7 @@ Authors
 License
 -------
 
-Copyright 2010, Three Wise Men Inc. All rights reserved.
+Copyright 2011, 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:
@@ -75,4 +77,4 @@ 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"
+  [1]: http://api.rubyonrails.org/classes/Rails/Railtie.html "Railties docs"

data/Rakefile

@@ -1,8 +1,12 @@
+require 'rake'
+
 require 'rspec/core/rake_task'
 require 'bundler'
 
 Bundler::GemHelper.install_tasks
 
+FileList['tasks/**/*.rake'].each { |task| import task }
+
 RSpec::Core::RakeTask.new(:spec)
 
 task :default => :spec

data/config/flay.yml

@@ -0,0 +1,4 @@
+---
+threshold: 6.0
+total_score: 39.0
+

data/config/flog.yml

@@ -0,0 +1,3 @@
+---
+threshold: 24.8
+

data/config/site.reek

@@ -0,0 +1,97 @@
+---
+UncommunicativeParameterName:
+  accept: []
+  exclude: []
+  enabled: true
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+LargeClass:
+  max_methods: 16  # TODO: decrease max_methods to 10-15 or less
+  exclude: []
+  enabled: true
+  max_instance_variables: 3
+UncommunicativeMethodName:
+  accept: []
+  exclude: []
+  enabled: true
+  reject:
+  - !ruby/regexp /^[a-z]$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+LongParameterList:
+  max_params: 2  # TODO: decrease max_params to 2
+  exclude: []
+  enabled: true
+  overrides: {}
+FeatureEnvy:
+  exclude: []
+  enabled: true
+ClassVariable:
+  exclude: []
+  enabled: true
+BooleanParameter:
+  exclude: []
+  enabled: true
+IrresponsibleModule:
+  exclude: []
+  enabled: true
+UncommunicativeModuleName:
+  accept: []
+  exclude: []
+  enabled: true
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+NestedIterators:
+  ignore_iterators: []
+  exclude: []
+  enabled: true
+  max_allowed_nesting: 1
+LongMethod:
+  max_statements: 7  # TODO: decrease max_statements to 5 or less
+  exclude: []
+  enabled: true
+Duplication:
+  allow_calls: []
+  exclude: []
+  enabled: true
+  max_calls: 1
+UtilityFunction:
+  max_helper_calls: 1
+  exclude: []
+  enabled: true
+Attribute:
+  exclude: []
+  enabled: false
+UncommunicativeVariableName:
+  accept: []
+  exclude: []
+  enabled: true
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+SimulatedPolymorphism:
+  exclude: []
+  enabled: true
+  max_ifs: 1
+DataClump:
+  exclude: [
+    # all of these classes have utility class methods that are
+    # incorrectly identified as instance methods
+    Veritas::Relation::Operation::Binary::ClassMethods,
+    Veritas::Relation::Operation::Set::ClassMethods
+  ]
+  enabled: true
+  max_copies: 1
+  min_clump_size: 2
+ControlCouple:
+  exclude: []
+  enabled: true
+LongYieldList:
+  max_params: 1
+  exclude: []
+  enabled: true
+

data/config/yardstick.yml

@@ -0,0 +1,3 @@
+---
+threshold: 100
+

data/lib/strawberry_cough/path_compiler.rb

@@ -1,7 +1,13 @@
 module StrawberryCough
 
+  # Compiles a path to a JavaScript function
   class PathCompiler
 
+    # Compile path to JavaScript function
+    #
+    # @return [String]
+    #
+    # @api private
     def self.compile(path)
       params  = PathParser.parse_params(path)
       anchors = PathParser.parse_anchors(path)
@@ -19,16 +25,27 @@ function (#{args_list(params)}) {
     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
+    # Generate JavaScript to concatenate anchors and params into valid URL
+    #
+    # @return [String]
+    #
+    # @api private
+    def self.url_concatenation(anchors, params)
+      params_without_format = params.reject { |param| param == "format" }
+      quoted_anchors = anchors.map { |anchor| "\"#{anchor}\"" }
+      quoted_anchors.zip(params_without_format).flatten.compact.join(" + ")
+    end
+
 
+    # Generate argument listing for JavaScript function
+    #
+    # @return [String]
+    #
+    # @api private
+    def self.args_list(params)
+      params.join(", ")
+    end
+  end
 end
+

data/lib/strawberry_cough/path_parser.rb

@@ -1,18 +1,30 @@
 module StrawberryCough
 
+  # Parses a path into anchors and parameters
   class PathParser
+    PARAM_EXTRACTOR_PATTERN = /:([\w_\d]+)\(*/
+    ANCHOR_SPLIT_PATTERN = /:[\w_\d]+/
 
-    PARAM_PATTERN = /:([\w_\d]+)\(*/
-    SPLIT_ME = "{}{}}{}{}}{}"
-
+    # Get list of parameters from a path
+    #
+    # @return [Array]
+    #
+    # @api private
     def self.parse_params(path)
-      path.scan(PARAM_PATTERN).flatten
+      path.scan(PARAM_EXTRACTOR_PATTERN).flatten
     end
 
+    # Get list of anchors from a path
+    #
+    # @return [Array]
+    #
+    # @api private
     def self.parse_anchors(path)
-      path.gsub(/\(.*\)/, '').gsub(PARAM_PATTERN, SPLIT_ME).split(SPLIT_ME)
+      remove_format(path).split(ANCHOR_SPLIT_PATTERN)
     end
 
+    def self.remove_format(path)
+      path.gsub(/\(.*\)/, '')
+    end
   end
-
 end

data/lib/strawberry_cough/rails/engine.rb

@@ -0,0 +1,15 @@
+require 'strawberry_cough/routes_compiler'
+require 'rails/engine'
+
+module StrawberryCough
+  module Rails
+    class Engine < ::Rails::Engine
+      config.before_initialize do
+        if defined?(Sprockets::Engines)
+          Sprockets::Engines
+          Sprockets.register_engine '.strawberry_cough', RoutesJSTemplate
+        end
+      end
+    end
+  end
+end

data/lib/strawberry_cough/routes_compiler.rb

@@ -1,14 +1,22 @@
 require 'active_support/inflector'
+require 'active_support/core_ext'
 
 module StrawberryCough
 
+  # Compiles a set of routes to a JavaScript Routes object
   class RoutesCompiler
 
+    # Compile route set to a JavaScript object
+    #
+    # @return [String]
+    #
+    # @api private
     def self.compile(route_set)
-      functions = route_set.inject(Set.new) do |memo, route|
+      functions = named_routes(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}
@@ -16,9 +24,18 @@ var Routes = {
       COMPILED
     end
 
+    # Write set to IO object
+    #
+    # @return [IO]
+    #
+    # @api private
     def self.compile_to_io(route_set, io)
       io << compile(route_set)
     end
 
+    def self.named_routes(routes)
+      routes.select {|x| x.name.present? }
+    end
   end
 end
+

data/lib/strawberry_cough/routes_js_template.rb

@@ -0,0 +1,15 @@
+require 'tilt/template'
+require 'strawberry_cough/routes_compiler'
+
+module StrawberryCough
+  class RoutesJSTemplate < Tilt::Template
+
+    def prepare
+    end
+
+    def render(scope=Object.new, locals={}, &block)
+      route_set = ::Rails.application.routes
+      RoutesCompiler.compile(route_set.routes)
+    end
+  end
+end

data/lib/strawberry_cough/version.rb

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

data/lib/strawberry_cough.rb

@@ -2,4 +2,5 @@ require 'strawberry_cough/version'
 require 'strawberry_cough/path_compiler'
 require 'strawberry_cough/path_parser'
 require 'strawberry_cough/routes_compiler'
-require 'strawberry_cough/railtie'
+require 'strawberry_cough/rails/engine'
+require 'strawberry_cough/routes_js_template'

data/spec/routes_compiler_spec.rb

@@ -4,10 +4,11 @@ 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
+  it "generates an empty Routes object with an empty route set" do
+    empty_routes_object = compiler.compile([])
+    interpreter.eval(empty_routes_object)
+    property_check = "for (var prop in Routes) { return prop; }"
+    interpreter.eval(property_check).should be_nil
   end
 
   it "makes a Routes JavaScript object when given an array of routes" do
@@ -19,3 +20,4 @@ describe StrawberryCough::RoutesCompiler do
     interpreter.eval("typeof Routes.editParentPath === 'function'").should be_true
   end
 end
+

data/strawberry_cough.gemspec

@@ -5,7 +5,7 @@ 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.authors     = ["Craig Savolainen", "Nate Smith", "Shawn Lee-Kwong"]
   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."