lieutenant_governor 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: db59e80cc30f17c8fdce83886172e77f3d2743f2
-  data.tar.gz: bcc17cb24b5727a794bf8ce443fc68633f9dbd4d
+  metadata.gz: e51f9e7d5152f185c513691f110207963da446aa
+  data.tar.gz: 7fb45bbd4d370c91a2a7461e37cd5a01737bcded
 SHA512:
-  metadata.gz: f9bfbb3841cd49260a632027f159501c8e245dc74fd3ab21f8c81b13cf3fa014be7412ec499f859982bb0c7b6d3343083c4968d0637d8a8f24b84ff5e35f8a1e
-  data.tar.gz: 900fa98bebe2fe092df553abd59d8088de0171555fe965aa9fac60a60643097851b39802f332dcae9ccf2c3403d786d6d4bb6ca2bdeb4325cda2e2c604210e93
+  metadata.gz: 858b1027ee9b6272d36ffe4a3e7a0d5de419a71ef71433e3cf6bcf22b739c1e5c830d8b6ab393b7724d1c25413e482d7ab90c6cf78cf3e67163608fe69729ce3
+  data.tar.gz: 8b5eec21c8d3b5d084a15cf85f8113dd0b7d503835de8b23aefdd1f3ca1c921e3da2b328e43c6b6318c2b920499ed27f2aaedf39c11541fbe2077ffb16de6897

data/.babelrc

@@ -0,0 +1,3 @@
+{
+  "presets": ["es2015"]
+}

data/.gitignore

@@ -8,6 +8,7 @@
 /spec/reports/
 /tmp/
 /vendor
+/node_modules/
 
 # rspec failure tracking
 .rspec_status

data/.travis.yml

@@ -2,4 +2,10 @@ sudo: false
 language: ruby
 rvm:
   - 2.2.3
+
 before_install: gem install bundler -v 1.14.3
+install: 
+  - bundle install 
+  - npm install
+script: 
+  - bundle exec rspec & npm test

data/README.md

@@ -1,5 +1,7 @@
 # Lieutenant Governor
 
+[![Build Status](https://travis-ci.org/JordanLittell/lieutenant_governor.svg?branch=master)](https://travis-ci.org/JordanLittell/lieutenant_governor)
+
 **Objective**: A rails gem to make it simple to define your endpoints once in your ```routes.rb``` file and have them automatically generated for use on the client.
 
 
@@ -18,14 +20,18 @@ And then execute:
 Or install it yourself as:
 
     $ gem install lieutenant_governor
-    
-In the initialization of your app (ex. `config/initializers/lieutenant_governor.rb` ), invoke the generator:
-    
-    $ LieutenantGovernor::Generator.generate(path_to_js_helper)
 
-The path_to_js_helper is a required param that specifies the location of the generated helper.
+The lieutenant_governor gem uses your applications routes to construct a javascript module for making requests to the server. Hence, the routes need to be loaded before you invoke the generate method like so:
 
-    
+```ruby
+config.after_initialize do
+    Rails.application.reload_routes!
+    LieutenantGovernor::Generator.generate(path_to_js_helper) 
+    # path_to_js_helper is a string 
+    # to the desired location of the JS module that gets generated.
+end
+```
+We recommend doing this in `config/environments/development.rb`
 
 ## Example Usage
 

data/lib/lieutenant_governor/generators/js_route_helpers.rb

@@ -6,6 +6,7 @@ require_relative '../templates/js_paths_template_str'
 module LieutenantGovernor
 
   module Generators
+
     class JsRouteHelpers < Thor::Group
       extend Thor::Actions
       # Use the extractor to get the hash
@@ -13,7 +14,8 @@ module LieutenantGovernor
       # using Thor, open up a file, and then write the javascript text to
       # the file
 
-      def self.generate_paths_file(path='app/assets/javascripts/pathHelpers.js')
+      def self.generate_paths_file(path)
+        raise TypeError.new('Path must be String.') unless path.class == String
         routes = Rails.application.routes.routes
         route_table = LieutenantGovernor::Routing::Extractor.extract(routes)
         template = LieutenantGovernor::Templates::JsPaths.new(route_table)

data/lib/lieutenant_governor/routing/extractor.rb

@@ -26,7 +26,7 @@ module LieutenantGovernor
         routes.reduce(table) do |memo, obj|
           name = get_name(obj)
           path = get_path(obj)
-          table[name] = path if name.present? && path.present?
+          table[name] = path if name.length > 0 && path.length > 0
         end
 
         table

data/lib/lieutenant_governor/templates/js_paths_template_str.rb

@@ -4,7 +4,6 @@ module LieutenantGovernor
     %{
 const STRING = 'string';
 const PARAM = 'param';
-const path;
 
 const makeFullURL = ({
   path = [],
@@ -12,16 +11,20 @@ const makeFullURL = ({
   query = {},
 } = {}) => {
 
-  path = makePath({
+  const requestPath = makeRequestPath({
     path,
     params,
   });
   const queryStrings = makeQueryStrings(query);
-  return queryStrings.length > 0 ? `${path}?${queryStrings}`:path;
+  return queryStrings.length > 0
+  ? `${requestPath}?${queryStrings}`
+  :requestPath;
 }
 
-const makePath = ({ path, params }) => {
-  const isArray = obj => Object.prototype.toString.call(obj) === '[object Array]';
+const makeRequestPath = ({ path, params }) => {
+  const isArray = obj => {
+    return Object.prototype.toString.call(obj) === '[object Array]';
+  }
 
   if(!isArray(params)) {
     throw 'params argument must of type array';
@@ -32,7 +35,7 @@ const makePath = ({ path, params }) => {
   }, 0);
 
   if(params.length !== numRequiredParams) {
-    throw `${params.length} params given, but ${numRequiredParams} are required`;
+    throw `params: ${params.length} given, but ${numRequiredParams} required`;
   }
 
   let numUsedParams = 0;
@@ -48,11 +51,15 @@ const makePath = ({ path, params }) => {
 
 const makeQueryStrings = a => {
   const s = [];
-  const rbracket = /\[\]$/;
-  const isArray = obj => Object.prototype.toString.call(obj) === '[object Array]';
+  const rbracket = /\\[\\]$/;
+  const isArray = obj => {
+    return Object.prototype.toString.call(obj) === '[object Array]';
+  }
 
   const add = (k, v) => {
-      v = typeof v === 'function' ? v() : v === null ? '' : v === undefined ? '' : v;
+      v = typeof v === 'function'
+      ? v()
+      : v === null ? '' : v === undefined ? '' : v;
       s[s.length] = `${encodeURIComponent(k)}=${encodeURIComponent(v)}`;
     };
 
@@ -65,7 +72,10 @@ const makeQueryStrings = a => {
             if (rbracket.test(prefix)) {
               add(prefix, obj[i]);
             } else {
-              buildParams(`${prefix}[${typeof obj[i] === 'object' ? i : ''}]`, obj[i]);
+              buildParams(
+                `${prefix}[${typeof obj[i] === 'object' ? i : ''}]`,
+                obj[i]
+              );
             }
           }
         } else if (obj && String(obj) === '[object Object]') {

data/lib/lieutenant_governor/version.rb

@@ -1,3 +1,3 @@
 module LieutenantGovernor
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "lieutenant_governor",
+  "version": "0.1.0",
+  "description": "Sync routes in rails with client code",
+  "directories": {
+    "test": "test"
+  },
+  "scripts": {
+    "test": "mocha --require ./test/testHelper.js '+(test)/**/*test.js'"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/JordanLittell/lieutenant_governor.git"
+  },
+  "author": "Jordan Littell, Sam Turner",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/JordanLittell/lieutenant_governor/issues"
+  },
+  "homepage": "https://github.com/JordanLittell/lieutenant_governor#readme",
+  "devDependencies": {
+    "mocha": "3.2.0",
+    "babel-core": "6.24.0",
+    "babel-preset-es2015": "6.24.0",
+    "expect.js": "0.3.1"
+  },
+  "dependencies": {
+    "expect.js": "0.3.1"
+  }
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lieutenant_governor
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - jordanlittell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-20 00:00:00.000000000 Z
+date: 2017-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -73,6 +73,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".babelrc"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -91,6 +92,7 @@ files:
 - lib/lieutenant_governor/templates/js_paths_template_str.rb
 - lib/lieutenant_governor/version.rb
 - lieutenant_governor.gemspec
+- package.json
 homepage: https://github.com/JordanLittell/lieutenant_governor
 licenses:
 - MIT