lieutenant_governor 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: db59e80cc30f17c8fdce83886172e77f3d2743f2
+  data.tar.gz: bcc17cb24b5727a794bf8ce443fc68633f9dbd4d
+SHA512:
+  metadata.gz: f9bfbb3841cd49260a632027f159501c8e245dc74fd3ab21f8c81b13cf3fa014be7412ec499f859982bb0c7b6d3343083c4968d0637d8a8f24b84ff5e35f8a1e
+  data.tar.gz: 900fa98bebe2fe092df553abd59d8088de0171555fe965aa9fac60a60643097851b39802f332dcae9ccf2c3403d786d6d4bb6ca2bdeb4325cda2e2c604210e93

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.14.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at jordanlittell@yahoo.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in lieutenant_governor.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 jordanlittell
+
+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/README.md

@@ -0,0 +1,146 @@
+# 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.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'lieutenant_governor'
+```
+
+And then execute:
+
+    $ bundle
+
+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.
+
+    
+
+## Example Usage
+
+Creating a basic URL
+
+```js
+// questions/:questions_id
+
+import * as paths from 'paths';
+
+// questions function is created and exported by lieutenant governor
+const url = paths.questions({
+
+  // params to be used in the url
+  // number of params must match number in url
+  params: [ 1 ],
+  
+});
+
+console.log(url);
+// questions/1
+
+```
+
+
+Creating a URL with query strings appended
+
+```js
+// questions/:questions_id
+
+import * as paths from 'paths';
+
+const url = paths.questions({
+
+  params: [ 1 ],
+  
+  // query strings to be appended to the url
+  query: {
+    firstName: 'Fred',
+    lastName: 'Flintstone'
+  }
+});
+
+console.log(url);
+// questions/1?firstName=Fred&lastName=Flintstone
+
+```
+
+
+Creating a nested URL
+
+```js
+// questions/:questions_id/answers/:answer_id/votes
+
+import * as paths from 'paths';
+
+const url = paths.questionAnswerVotes({
+
+  params: [ 1, 'abc' ],
+  
+  query: {
+    firstName: 'Fred',
+    lastName: 'Flintstone'
+  }
+});
+
+console.log(url);
+// questions/1/answers/abc/votes?firstName=Fred&lastName=Flintstone
+
+```
+
+## API
+
+Lieutentant governor parses ```routes.rb``` and  generates client side functions to create paths
+
+Route                   | Controller Method      | Generated Function
+----------------------- | ---------------------- | -----------
+`/api/answer`           | `api_answer`   | paths.apiAnswer
+`/api/answers`          | `api_answers`  | paths.apiAnswers
+`/api/questions/:question_id/answers`              | `api_question_answers`  | paths.apiQuestionAnswers
+
+
+
+When creating the path, the function takes an object so that the developer can specify params and query strings
+
+```js
+paths#generatedFunction({ 
+   params: [],
+   query: {},
+});
+```
+
+Key                  | Type      | Description
+-------------------- | --------- | -----------
+`params`             | `array`   | Params to be used in the url. Length must equal count of params expected in url.
+`query`              | `object`  | Query strings to be appended to the url
+
+
+## Requirements
+
+1. Build system must support transpiling ES6
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jordanlittell/lieutenant_governor. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+require "bundler/setup"
+require "lieutenant_governor"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/lieutenant_governor/generators/js_route_helpers.rb

@@ -0,0 +1,27 @@
+require 'thor/group'
+require_relative '../routing/extractor'
+require_relative '../templates/js_paths.rb'
+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
+      # assume function exists to translate hash to javascript text
+      # 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')
+        routes = Rails.application.routes.routes
+        route_table = LieutenantGovernor::Routing::Extractor.extract(routes)
+        template = LieutenantGovernor::Templates::JsPaths.new(route_table)
+        # create_file '/client/paths.js', template.render
+        File.open(path, 'w') do |f|
+          f.puts template.render
+        end
+      end
+    end
+  end
+end

data/lib/lieutenant_governor/routing/extractor.rb

@@ -0,0 +1,53 @@
+# require 'action_dispatch/routing'
+
+module LieutenantGovernor
+  # singleton holding config for gem
+  module Routing
+
+    class Extractor
+
+      attr_reader :routes
+
+      # Takes applications routes and converts to hash
+      # @param [ActionDispatch::Routing::RouteSet]
+      # @return [Hash] table mapping names to paths
+      def self.extract(routes)
+        instance = new(routes)
+        instance.extract
+      end
+
+      def initialize(routes)
+        @routes = routes
+      end
+
+      def extract
+        table = {}
+        # possible to get blank strings as keys here
+        routes.reduce(table) do |memo, obj|
+          name = get_name(obj)
+          path = get_path(obj)
+          table[name] = path if name.present? && path.present?
+        end
+
+        table
+      end
+
+      private
+
+      # @param [ActionDispatch::Routing::Journey]
+      def get_name(obj)
+        wrap(obj).name.camelcase
+      end
+
+      # @param [ActionDispatch::Routing::Journey]
+      def get_path(obj)
+        wrap(obj).path.split('(.:format)')[0]
+      end
+
+      # @param [ActionDispatch::Routing::Journey]
+      def wrap(obj)
+        ActionDispatch::Routing::RouteWrapper.new(obj)
+      end
+    end
+  end
+end

data/lib/lieutenant_governor/templates/js_paths.rb

@@ -0,0 +1,19 @@
+require 'erb'
+
+module LieutenantGovernor
+  module Templates
+    class JsPaths
+
+      attr_reader :routes
+
+      def initialize(routes)
+        @routes = routes
+      end
+
+      def render
+        b = binding
+        ERB.new(LieutenantGovernor::Templates::JS_PATHS_TEMPLATE_STR).result b
+      end
+    end
+  end
+end

data/lib/lieutenant_governor/templates/js_paths_template_str.rb

@@ -0,0 +1,125 @@
+module LieutenantGovernor
+  module Templates
+    JS_PATHS_TEMPLATE_STR =
+    %{
+const STRING = 'string';
+const PARAM = 'param';
+const path;
+
+const makeFullURL = ({
+  path = [],
+  params = [],
+  query = {},
+} = {}) => {
+
+  path = makePath({
+    path,
+    params,
+  });
+  const queryStrings = makeQueryStrings(query);
+  return queryStrings.length > 0 ? `${path}?${queryStrings}`:path;
+}
+
+const makePath = ({ path, params }) => {
+  const isArray = obj => Object.prototype.toString.call(obj) === '[object Array]';
+
+  if(!isArray(params)) {
+    throw 'params argument must of type array';
+  }
+
+  const numRequiredParams = path.reduce((acc, param) => {
+    return acc + (param.type == PARAM);
+  }, 0);
+
+  if(params.length !== numRequiredParams) {
+    throw `${params.length} params given, but ${numRequiredParams} are required`;
+  }
+
+  let numUsedParams = 0;
+  return path.map(obj => {
+    if(obj.type === STRING) {
+      return obj.name;
+    } else if(obj.type === PARAM) {
+      numUsedParams+=1;
+      return params[numUsedParams - 1];
+    }
+  }).join('/');
+}
+
+const makeQueryStrings = a => {
+  const s = [];
+  const rbracket = /\[\]$/;
+  const isArray = obj => Object.prototype.toString.call(obj) === '[object Array]';
+
+  const add = (k, v) => {
+      v = typeof v === 'function' ? v() : v === null ? '' : v === undefined ? '' : v;
+      s[s.length] = `${encodeURIComponent(k)}=${encodeURIComponent(v)}`;
+    };
+
+  const buildParams = (prefix, obj) => {
+      let i, len, key;
+
+      if (prefix) {
+        if (isArray(obj)) {
+          for (i = 0, len = obj.length; i < len; i++) {
+            if (rbracket.test(prefix)) {
+              add(prefix, obj[i]);
+            } else {
+              buildParams(`${prefix}[${typeof obj[i] === 'object' ? i : ''}]`, obj[i]);
+            }
+          }
+        } else if (obj && String(obj) === '[object Object]') {
+          for (key in obj) {
+            buildParams(`${prefix}[${key}]`, obj[key]);
+          }
+        } else {
+          add(prefix, obj);
+        }
+      } else if (isArray(obj)) {
+        for (i = 0, len = obj.length; i < len; i++) {
+          add(obj[i].name, obj[i].value);
+        }
+      } else {
+        for (key in obj) {
+          buildParams(key, obj[key]);
+        }
+      }
+      return s;
+    };
+
+  return buildParams('', a).join('&');
+};
+
+<% @routes.each do |n, s_path| %>
+
+const <%= n %>Path = [
+<% s_path.split('/').each_with_index do |frag, idx| %>
+  <% next if frag.blank? %>
+  <% if frag[0] == ':' %>
+    {
+      type: PARAM
+    } <%= ',' if idx < s_path.split('/').count - 1 %>
+  <% else %>
+  {
+    type: STRING,
+    name: '<%= frag %>'
+  } <%= ',' if idx < s_path.split('/').count - 1 %>
+  <% end %>
+<% end %>
+];
+export function <%= n %>({ // pluralized model name
+  params = [], // params must be given in order inserted
+  query = {},
+} = {}) {
+
+  return makeFullURL({
+    path: <%= n %>Path,
+    params,
+    query,
+  });
+}
+
+<% end %>
+  }
+  end
+end

data/lib/lieutenant_governor/version.rb

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

data/lib/lieutenant_governor.rb

@@ -0,0 +1,12 @@
+require_relative "lieutenant_governor/version"
+require_relative 'lieutenant_governor/generators/js_route_helpers'
+
+module LieutenantGovernor
+
+  class Generator
+    def self.generate(path)
+      Generators::JsRouteHelpers.generate_paths_file(path)
+    end
+  end
+
+end

data/lieutenant_governor.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'lieutenant_governor/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "lieutenant_governor"
+  spec.version       = LieutenantGovernor::VERSION
+  spec.authors       = ["jordanlittell"]
+  spec.email         = ["jordanlittell@yahoo.com"]
+
+  spec.summary       = "Sync routes in rails with client code"
+  spec.description   = "Sync routes in rails with client code"
+  spec.homepage      = "https://github.com/JordanLittell/lieutenant_governor"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.require_paths = ["lib"]
+
+  # spec.add_dependency "actionpack"
+  spec.add_dependency "thor"
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: lieutenant_governor
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- jordanlittell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-03-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Sync routes in rails with client code
+email:
+- jordanlittell@yahoo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- client/paths.js
+- lib/lieutenant_governor.rb
+- lib/lieutenant_governor/generators/js_route_helpers.rb
+- lib/lieutenant_governor/routing/extractor.rb
+- lib/lieutenant_governor/templates/js_paths.rb
+- lib/lieutenant_governor/templates/js_paths_template_str.rb
+- lib/lieutenant_governor/version.rb
+- lieutenant_governor.gemspec
+homepage: https://github.com/JordanLittell/lieutenant_governor
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Sync routes in rails with client code
+test_files: []