js-rails-routes 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d936f02d646b13f67d7460f66cef7e1804a37f36
+  data.tar.gz: 1b438a3b9963d857cb50ba5c6415068f2b0455ab
+SHA512:
+  metadata.gz: e83d45c4c891fb9ae5794320723161c67d82b37ac02c14a974c38b373671a5ab6136bbea741e6e4f41fef5bcd5302f30ec2b0e371e2ad8ddc22bfa29034c32d6
+  data.tar.gz: 11d00134a46f9f9e631a04929ddc998aad88f7a2669a175c48529a1092a0cc32a0c6c3cb438c39707b0a21ee9f945a9a417d91df49f28f3a2662b6934adbb860

data/bin/js-rails-routes

@@ -0,0 +1,70 @@
+#!/usr/bin/env ruby
+
+require 'js-rails-routes'
+
+def usage
+  puts <<EOF
+js-rails-routes [flags]
+
+    Run this command from the base directory of a Ruby on Rails project.
+    It will inspect the routes for the Rails project and generate a javascript file
+    that will add all the [route_name]_path functions to the global namespace.
+    By default, the generated javascript is output to stdout.
+    
+    Flags:
+      --help
+        Displays this message
+      --output
+        Writes the generated javascript to the file:
+        app/assets/javascripts/routes.js
+        This operation will fail if you are not in the base directory of a Rails project.
+        In other words, it does not try to create the subdirectories 
+        app/assets/javascripts, so will fail if it can not find them.
+        The idea behind requiring you to explicitly type "--output" is to protect 
+        against accidentally blowing away an old routes.js file, as this _will_ 
+        overwrite it if one exists.
+      --no-link-to
+        By default this utility produces a function named "link_to" that mimics a
+        simplified version of the Rails method by the same name.  This flag supresses
+        creating that function.
+EOF
+
+  abort
+end
+
+to_file = false
+do_link_to = true
+
+until ARGV.empty?
+  arg = ARGV.shift
+  if arg == '--help'
+    usage
+  elsif arg == '--output'
+    to_file = true
+  elsif arg == '--no-link-to'
+    do_link_to = false
+  else
+    usage
+  end
+end
+
+out = STDOUT
+
+if to_file
+  begin
+    out = File.open("app/assets/javascripts/routes.js", "w")
+  rescue
+    STDERR.puts "You must be in the base directory of a Rails project in order to output"
+    STDERR.puts "to a file!!!"
+    abort
+  end
+end
+  
+text = `rake routes`
+# Protect against goofy carriage returns on non-unix systems
+text.gsub!(/\r\n?/, "\n")
+
+# Get rid of the header
+text.sub!(/\A[^\n]+\n/, '')
+
+out.puts JsRailsRoutes::Routes.new(text).create_javascript(do_link_to)

data/lib/js-rails-routes.rb

@@ -0,0 +1,120 @@
+module JsRailsRoutes
+  VERSION = "1.0.0"
+  
+  class Routes
+  
+    def initialize(text)
+      @text = text      
+    end
+    
+    def create_javascript(with_link_to = true)
+      result = <<EOF
+// !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+//
+// This file is auto-generated by js-rails-routes #{VERSION}
+//
+// DO NOT EDIT BY HAND!!
+//
+   
+EOF
+
+      if with_link_to
+        result += generate_link_to
+      end
+
+    
+      lines = @text.split("\n")
+      
+      lines.each do |line|
+        # clear leading whitespace
+        line.sub!(/^\s+/, '')
+        (name, method, format, action) = line.split(/\s+/)
+        
+        # action will only contain something if there were at least four segments
+        # to split.  This is a little ass-backwards.  Really when action contains no
+        # non-whitespace, what it really means is that name contained no non-whitespace.
+        if action =~ /\S/
+          # Get rid of the (.:format) business at the end of each format
+          format.gsub!(/\(.*\)/, '')
+
+          # Get rid of the leading slash
+          format.sub!(/^\//, '')
+          
+          # Split it into its parts
+          parts = format.split("/")
+          
+          args = []
+          parts.each do |part|
+            if part =~ /^:/
+              args.push part.sub(/^:/, '')
+            end
+          end
+          
+          if args.empty?
+            # This is the easy case.  There are no parameters we need to deal with, just
+            # a simple path
+            
+            result += <<EOF
+
+var #{name}_path = function() {
+  return "/#{format}";
+}
+EOF
+          else
+            # The trickier case.  We want to accept values as args.  The first arg could
+            # be a hash object, containing all the information, or we could have several
+            # primitive arguments that appear in the order that they do in the format
+            result += <<EOF
+
+var #{name}_path = function(#{ args.join(", ") }) {
+  if (#{args[0]} instanceof Object) {
+EOF
+            result += '    return '
+            components = []
+            parts.each do |part|
+              components.push '"/"'
+              if part =~ /^:/
+                components.push args[0] + '["' + part.sub(/^:/, '') + '"]'
+              else
+                components.push '"' + part + '"'
+              end
+            end
+            result += components.join(" + ") + ";\n"
+            result += <<EOF
+  } else {
+EOF
+
+            result += '    return '
+            components = []
+            parts.each do |part|
+              components.push '"/"'
+              if part =~ /^:/
+                components.push part.sub(/^:/, '')
+              else
+                components.push '"' + part + '"'
+              end
+            end
+
+            result += components.join(' + ') + ";\n"
+            result += <<EOF
+  }
+}
+EOF
+          end
+        end
+      end
+      
+      result
+    end
+    
+    
+    def generate_link_to
+      # This is a fairly silly method.
+      # It just regurgitates javascript I've written elsewhere by hand.
+      
+      File.read File.expand_path("../js-rails-routes/js/link_to.js", __FILE__)
+    end
+    
+    
+  end
+end

data/lib/js-rails-routes/js/link_to.js

@@ -0,0 +1,28 @@
+// Generated by CoffeeScript 1.9.3
+var link_to;
+
+link_to = function(label, link, opts) {
+  var key, ref, result, value;
+  if (opts == null) {
+    opts = {};
+  }
+  result = '<a href="' + link + '"';
+  if (opts.id != null) {
+    result += ' id="' + opts.id + '"';
+  }
+  if (opts["class"] != null) {
+    result += ' class="' + opts["class"] + '"';
+  }
+  if (opts.method != null) {
+    result += ' rel="nofollow" data-method="' + opts.method + '"';
+  }
+  if (opts.data != null) {
+    ref = opts.data;
+    for (key in ref) {
+      value = ref[key];
+      result += ' data-' + key + '="' + value + '"';
+    }
+  }
+  result += '>' + label + '</a>';
+  return result;
+};

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: js-rails-routes
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Kirk Bowers
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+description: "+js-rails-routes+ is a utility for generating JavaScript equivalents
+  to the +<route>_path+\nfunctions provided by {Ruby on Rails}[https://github.com/rails/rails].
+  \ This allows you\nto do very similar things in your {+ejs+}[https://rubygems.org/gems/ejs/]
+  JavaScript templates as you would in your +erb+\nruby templates.  You can move html
+  rendering to the client and keep it looking very \nsimilar to how it would look
+  on the server.\n\nFor example, if you have a model +Item+ and a simple route to
+  list all the items, a link\nto that items page (using an explicit +a+ anchor tag
+  instead of the Rails +link_to+)\nwould look the same in either an +erb+ file or
+  an +ejs+ file:\n\n    <a href=\"<%= items_path() %>\">List all Items</a>\n\nThis
+  gem was originally developed as part of the {MVCoffee}[http://mvcoffee.org] suite
+  of tools, and integrates strongly with the {mvcoffee.js}[https://github.com/kirkbowers/mvcoffee]
+  CoffeeScript MVC framework."
+email:
+- kirkbowers@yahoo.com
+executables:
+- js-rails-routes
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gemtest"
+- bin/js-rails-routes
+- lib/js-rails-routes.rb
+- lib/js-rails-routes/js/link_to.js
+homepage: https://github.com/kirkbowers/js-rails-routes
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--main"
+- README.txt
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.3
+signing_key: 
+specification_version: 4
+summary: "+js-rails-routes+ is a utility for generating JavaScript equivalents to
+  the +<route>_path+ functions provided by {Ruby on Rails}[https://github.com/rails/rails]"
+test_files: []