json_routes_webpack 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8da1c274608e8970d81bfe25abd56a85b95e7e15
+  data.tar.gz: d1a5b4e516f3c78eb5925d15cbf99f54f289452c
+SHA512:
+  metadata.gz: a562d78537186d3bdbf691ff236efe970caba72d72079b3fe66640f9cea55c914d38a1455dddb28c5e42e165edd172a3fa6c45ef3c00cd61f938bd8312ad7a57
+  data.tar.gz: 209f7a54885316387b8836ab19d6150c37f6d40bed293d622c24940358950af19d056ae9c14d21fb67fa926883f90f9663ce20c292ac6a9b57a6ddc5b6fd7e3e

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,12 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.5
+  - 2.4.2
+  - ruby-head
+cache:
+  bundler: true
+install:
+  - bundle install
+script:
+  - bundle exec rake spec

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Change Log
+
+All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
+
+<a name="0.1.1"></a>
+## [0.1.1](https://github.com/Alignable/json_routes_webpack/compare/v0.1.0...v0.1.1) (2017-11-12)
+
+
+
+<a name="0.1.0"></a>
+# 0.1.0 (2017-11-12)

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in json_routes_webpack.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Alignable
+
+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,88 @@
+[![test][test]][test-url]
+[![coverage][cover]][cover-url]
+
+# JsonRoutesWebpack
+
+Exports Rails named routes to JSON that can be loaded in Javascript via webpack loaders like [js-routes-loader](https://github.com/Alignable/js-routes-loader)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'json_routes_webpack'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install json_routes_webpack
+
+## Usage
+
+### Add a Rails initializer
+
+Add an initializer that configures the routes you want to export and the file to write them too
+
+**config/initializers/json_routes_webpack.rb**
+```ruby
+JsonRoutesWebpack.configure do |config|
+  config.add_routes 'app/javascript/generated/routes.json'
+end
+```
+
+In addition to the file name to write the routes `add_routes` supports two options arguments
+* `include` - an array of regular expressions the route name must match to be included
+* `exclude` - an array of regular expression tht the route name must not match
+
+Example: suppose you wanted to export you app and admin routes to separate files
+```ruby
+JsonRoutesWebpack.configure do |config|
+  config.add_routes 'app/javascript/routes/routes.json', exclude: [/admin/]
+  config.add_routes 'app/javascript/routes/admin_routes.json', include: [/admin/]
+end
+```
+
+### Configure Rake to build json routes before Webpacker compiles
+
+We need the json routes to be available to webpack loaders add a rake hook to build the routes before Webpacker compiles our javascript
+
+**lib/tasks/js_routes.rake**
+```ruby
+# generate json routes before webpacker so they can be used by loaders
+if Rake::Task.task_defined?("webpacker:compile")
+  Rake::Task["webpacker:compile"].enhance ["json_routes_webpack:compile"]
+end
+```
+
+### Install `js-routes-loader` and configure Webpacker to use it for routes json files
+
+```bash
+$ yarn add js-routes-loader
+```
+
+**config/webpack/environment.js**
+```javascript
+const { environment } = require('@rails/webpacker');
+
+environment.loaders.set('js-routes', {
+  test: /routes\.json$/,
+  use: 'js-routes-loader',
+});
+
+module.exports = environment;
+```
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+[test]: http://img.shields.io/travis/Alignable/json_routes_webpack.svg
+[test-url]: https://travis-ci.org/Alignable/json_routes_webpack
+
+[cover]: https://codecov.io/gh/Alignable/json_routes_webpack/branch/master/graph/badge.svg
+[cover-url]: https://codecov.io/gh/Alignable/json_routes_webpack

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "json_routes_webpack"
+
+# 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/json_routes_webpack.gemspec

@@ -0,0 +1,32 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "json_routes_webpack/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "json_routes_webpack"
+  spec.version       = JsonRoutesWebpack::VERSION
+  spec.authors       = ["Jon Palmer"]
+  spec.email         = ["jon@alignable.com"]
+
+  spec.summary       = %q{Export rails routes to json for webpack js-route-loader }
+  spec.description   = %q{COnvert Ruby on Rails routes to webpack js-route-loader format and export to a json file.}
+  spec.homepage      = "https://github.com/Alignable/json_routes_webpack"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "railties", ">= 5.1"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec-mocks", "~> 3.0"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "codecov"
+end

data/lib/json_routes_webpack.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "json_routes_webpack/version"
+require "json_routes_webpack/configuration"
+require "json_routes_webpack/generator"
+
+require "json_routes_webpack/railtie" if defined?(Rails)
+
+module JsonRoutesWebpack
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+  def self.reset
+    @configuration = Configuration.new
+  end
+
+  def self.compile
+    JsonRoutesWebpack.configuration.generators.each(&:generate!)
+  end
+end

data/lib/json_routes_webpack/configuration.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "json_routes_webpack"
+
+module JsonRoutesWebpack
+  class Configuration
+    attr_reader :generators
+
+    def initialize
+      @generators = []
+    end
+
+    def add_routes(file, routes: nil, include: nil, exclude: nil)
+      @generators.push JsonRoutesWebpack::Generator.new(file, routes: routes, include: include, exclude: exclude)
+    end
+  end
+end

data/lib/json_routes_webpack/generator.rb

@@ -0,0 +1,145 @@
+# frozen_string_literal: true
+
+require "rails/application"
+require "action_dispatch/routing/inspector"
+
+module JsonRoutesWebpack
+  class Generator
+    # @return [String]
+    attr_reader :file
+
+    # @return [ActionDispatch::Routing::RouteSet]
+    attr_reader :routes
+
+    # @return [Array<Regexp>,nil] default to nil
+    attr_reader :include
+
+    # @return [Array<Regexp>,nil] default to nil
+    attr_reader :exclude
+
+    def initialize(file, routes: nil, include: nil, exclude: nil)
+      @file = file
+      @routes = routes || Rails.application.routes.routes
+      @include = include
+      @exclude = exclude
+    end
+
+    # Generate a hash of all the route definitions matching the include and exclude rules
+    # and write the hash as json to the configured file
+    #
+    # @return [Hash]
+    def generate!
+      out_file = Rails.root.join(file)
+
+      dirname = File.dirname(out_file)
+      FileUtils.mkdir_p(dirname) unless File.directory?(dirname)
+
+      File.open(out_file, "w") do |f|
+        f.write(JSON.fast_generate(generate))
+        # f.write(source.to_json)
+      end
+    end
+
+    # Generate a hash of all the route definitions matching the include and exclude rules
+    #
+    # @return [Hash]
+    def generate
+      Rails.application.reload_routes!
+      all_routes = collect_routes(routes)
+      group_routes = group_routes(all_routes)
+      routes_to_display = filter_routes(group_routes)
+      { routes: routes_to_display }
+    end
+
+    private
+
+    # collect the routes, including nested engine routes, and build the summaries we need for the json
+    #
+    # @param routes [Array<ActionDispatch::Routing::RouteSet>]
+    # @param parent_route [ActionDispatch::Routing::RouteWrapper]
+    # @return [Array<Hash>]
+    def collect_routes(routes, parent_route = nil)
+      routes.map do |route|
+        ActionDispatch::Routing::RouteWrapper.new(route)
+      end.reject(&:internal?)
+            .flat_map do |route|
+        route.engine? ? collect_engine_routes(route) : build_route_summary(route, parent_route)
+      end
+    end
+
+    # merge the parent_route with the route returing a hash of properties that we need for the json
+    #
+    # @param route [ActionDispatch::Routing::RouteWrapper]
+    # @param parent_route [ActionDispatch::Routing::RouteWrapper]
+    # @return [Array<Hash>]
+    def build_route_summary(route, parent_route = nil)
+      name = [parent_route&.name, route.name].compact.join("_")
+      method = parent_route&.verb.presence || route.verb
+      path = "#{parent_route&.path}#{route.path}"
+      required_parts = [parent_route&.required_parts, route.required_parts].compact.flatten
+      parts = [parent_route&.parts, route.parts].compact.flatten
+
+      {
+        name: name,
+        method: method,
+        path: path,
+        required_parts: required_parts,
+        parts: parts
+      }
+    end
+
+    # collect the routes associate with the engine route
+    #
+    # @param routes [ActionDispatch::Routing::RouteWrapper]
+    # @return [Array<Hash>, nil]
+    def collect_engine_routes(route)
+      return unless route.engine?
+
+      routes = route.rack_app.routes
+      if routes.is_a?(ActionDispatch::Routing::RouteSet)
+        collect_routes(routes.routes, route)
+      end
+    end
+
+    # apply the include and exclude matchers
+    #
+    # @param routes [Array<Hash>]
+    # @return [Array<Hash>]
+    def filter_routes(routes)
+      routes.reject do |route|
+        (exclude && any_match?(route, exclude)) || (include && !any_match?(route, include))
+      end
+    end
+
+    # decide if the route matches any of the matchers
+    #
+    # @param route [Hash]
+    # @param matchers [Array<Regexp>]
+    # @return [bool]
+    def any_match?(route, matchers)
+      matchers.any? { |pattern| route[:name] =~ pattern }
+    end
+
+    # group the routes by path, aggregate all the supported methods and compute the optional params
+    #
+    # @param routes [Array<Hash>]
+    # @return [Array<Hash>]
+    def group_routes(routes)
+      routes.group_by do |route|
+        route[:path]
+      end.map do |path, route_group|
+        methods = route_group.map { |route| route[:method] }
+        named_route = route_group.find { |route| route[:name].present? } # only one of the grouped routes will have a name
+        if named_route
+          {
+            name: named_route[:name],
+            methods: methods,
+            path: named_route[:path],
+            required_params: named_route[:required_parts],
+            optional_params: named_route[:parts] - named_route[:required_parts]
+          }
+        end
+      end.compact
+    end
+  end
+end

data/lib/json_routes_webpack/railtie.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "json_routes_webpack"
+require "rails"
+
+module JsonRoutesWebpack
+  class Railtie < Rails::Railtie
+    railtie_name :json_routes_webpack
+
+    rake_tasks do
+      load "tasks/json_routes_webpack.rake"
+    end
+  end
+end

data/lib/json_routes_webpack/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module JsonRoutesWebpack
+  VERSION = "0.1.1"
+end

data/lib/tasks/json_routes_webpack.rake

@@ -0,0 +1,8 @@
+# frozen_string_literal: true.
+
+namespace :json_routes_webpack do
+  desc "Export app routes to json format"
+  task compile: :environment do
+    JsonRoutesWebpack.compile
+  end
+end

data/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "json_routes_webpack",
+  "version": "0.1.1",
+  "scripts": {
+    "release": "standard-version -a"
+  },
+  "standard-version": {
+    "scripts": {
+      "postbump": "gem bump --no-commit -v `node -p -e \"require('./package.json').version\"`",
+      "precommit": "git add -f lib/json_routes_webpack/version.rb"
+    }
+  },
+  "devDependencies": {
+    "standard-version": "^4.2.0"
+  }
+}

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: json_routes_webpack
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Jon Palmer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-11-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  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'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: COnvert Ruby on Rails routes to webpack js-route-loader format and export
+  to a json file.
+email:
+- jon@alignable.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- json_routes_webpack.gemspec
+- lib/json_routes_webpack.rb
+- lib/json_routes_webpack/configuration.rb
+- lib/json_routes_webpack/generator.rb
+- lib/json_routes_webpack/railtie.rb
+- lib/json_routes_webpack/version.rb
+- lib/tasks/json_routes_webpack.rake
+- package.json
+homepage: https://github.com/Alignable/json_routes_webpack
+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.5.2
+signing_key: 
+specification_version: 4
+summary: Export rails routes to json for webpack js-route-loader
+test_files: []