js_rails_routes 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aba31712b8f2349a61d9905e490c794f12aaf364
-  data.tar.gz: dd77a182d347b01babd5ff79711416e611b11d4e
+  metadata.gz: 6e515560aeebfbed4c3c9e98602e99e146aaaf3c
+  data.tar.gz: b78e6b72b763d058d563e888eabf9db8602d8f3f
 SHA512:
-  metadata.gz: 29ce55b6233855a315b6ff410c26367fc633efc5d0fcb37222d6931537f1949a0713326176d10fa43e54b22852538cea1d57538ceea9c225ebe46fa3876c528a
-  data.tar.gz: 0ae2281dcca1288f0af67bdd80169bf46e6b4adfe33d6b35bfd2f786455ca82fafda0ae402ed44639c78c9a8bf690d4f7b618ae99ae6e36cac1c08723be7b03b
+  metadata.gz: e8b6077597f785d6b8a3080b2a68235dd7ee254dfa983ad69fd06ec8b9ca9b2646ce340cb17d5ef821996fb610159354dd17bbdf0f9e1d0597b15712fc9c57ad
+  data.tar.gz: 7373315966e421c0f0c300c7e14e13fb9e21f4464187d591a745b4783dbda52356a310fbace72aa75310b1d2ea492d4d13489f0c6fc9c9d897944a5a0b8fd568

data/.gitignore

@@ -3,3 +3,4 @@
 Gemfile.lock
 spec/examples.txt
 coverage
+/tmp

data/.rubocop.yml

@@ -1,24 +1,9 @@
 Metrics/LineLength:
   Max: 120
 
-Metrics/AbcSize:
-  Max: 20
-
 Metrics/BlockLength:
   Exclude:
   - 'spec/**/*'
 
 Style/Documentation:
   Enabled: false
-
-Style/IndentHeredoc:
-  Enabled: false
-
-Style/SymbolArray:
-  Enabled: false
-
-Style/TrailingCommaInLiteral:
-  Enabled: false
-
-Style/PerlBackrefs:
-  Enabled: false

data/README.md

@@ -1,10 +1,10 @@
 # rake js:routes
 
 [![Gem](https://img.shields.io/gem/v/js_rails_routes.svg?maxAge=2592000)](https://rubygems.org/gems/js_rails_routes)
-[![Build Status](https://travis-ci.org/yuku-t/js_rails_routes.svg?branch=master)](https://travis-ci.org/yuku-t/js_rails_routes)
-[![Code Climate](https://codeclimate.com/github/yuku-t/js_rails_routes/badges/gpa.svg)](https://codeclimate.com/github/yuku-t/js_rails_routes)
-[![Test Coverage](https://codeclimate.com/github/yuku-t/js_rails_routes/badges/coverage.svg)](https://codeclimate.com/github/yuku-t/js_rails_routes/coverage)
-[![license](https://img.shields.io/github/license/yuku-t/js_rails_routes.svg?maxAge=2592000)](https://github.com/yuku-t/js_rails_routes/blob/master/LICENSE)
+[![Build Status](https://travis-ci.org/yuku-t/js_rails_routes.svg?branch=master)](https://travis-ci.org/yuku/js_rails_routes)
+[![Code Climate](https://codeclimate.com/github/yuku-t/js_rails_routes/badges/gpa.svg)](https://codeclimate.com/github/yuku/js_rails_routes)
+[![Test Coverage](https://codeclimate.com/github/yuku-t/js_rails_routes/badges/coverage.svg)](https://codeclimate.com/github/yuku/js_rails_routes/coverage)
+[![license](https://img.shields.io/github/license/yuku-t/js_rails_routes.svg?maxAge=2592000)](https://github.com/yuku/js_rails_routes/blob/master/LICENSE)
 [![Analytics](https://ga-beacon.appspot.com/UA-4932407-14/js_rails_routes/readme)](https://github.com/igrigorik/ga-beacon)
 
 Generate a ES6 module that contains Rails routes.
@@ -75,13 +75,14 @@ rake js:routes
 
 JSRailsRoutes supports several parameters:
 
-Name            | Type     | Description                             | Default
-----------------|----------|-----------------------------------------|----------------------------------------
-`include_paths` | `Regexp` | paths match to the regexp are included  | `/.*/`
-`exclude_paths` | `Regexp` | paths match to the regexp are excluded  | `/^$/`
-`include_names` | `Regexp` | names match to the regexp are included  | `/.*/`
-`exclude_names` | `Regexp` | names match to the regexp are excluded  | `/^$/`
-`path`          | `String` | JS file path                            | `Rails.root.join("app", "assets", "javascripts", "rails-routes.js")`
+Name              | Type     | Description                                    | Default
+------------------|----------|------------------------------------------------|----------------------------------------
+`include_paths`   | `Regexp` | Paths match to the regexp are included         | `/.*/`
+`exclude_paths`   | `Regexp` | Paths match to the regexp are excluded         | `/^$/`
+`include_names`   | `Regexp` | Names match to the regexp are included         | `/.*/`
+`exclude_names`   | `Regexp` | Names match to the regexp are excluded         | `/^$/`
+`exclude_engines` | `Regexp` | Rails engines match to the regexp are excluded | `/^$/`
+`output_dir`      | `String` | Output JS file into the specified directory    | `Rails.root.join("app", "assets", "javascripts")`
 
 You can configure via `JSRailsRoutes.configure`.
 
@@ -89,7 +90,7 @@ You can configure via `JSRailsRoutes.configure`.
 # Rakefile
 JSRailsRoutes.configure do |c|
   c.exclude_paths = %r{^/(rails|sidekiq)}
-  c.path = Rails.root.join('path', 'to', 'rails-routes.js')
+  c.output_dir = Rails.root.join('client/javascripts')
 end
 ```
 

data/Rakefile

@@ -5,4 +5,4 @@ require 'rubocop/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 RuboCop::RakeTask.new
 
-task default: [:rubocop, :spec]
+task default: %i[rubocop spec]

data/js_rails_routes.gemspec

@@ -1,4 +1,4 @@
-$LOAD_PATH << File.expand_path('../lib', __FILE__)
+$LOAD_PATH << File.expand_path('lib', __dir__)
 
 require 'js_rails_routes/version'
 
@@ -13,10 +13,10 @@ Gem::Specification.new do |spec|
   spec.files           = `git ls-files -z`.split("\x0")
   spec.require_paths   = ['lib']
   spec.add_dependency 'rails', '>= 3.2'
-  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'bundler', '~> 1.16'
   spec.add_development_dependency 'codeclimate-test-reporter', '~> 1.0'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.4.0'
-  spec.add_development_dependency 'rubocop', '~> 0.48.1'
-  spec.add_development_dependency 'simplecov', '~> 0.14'
+  spec.add_development_dependency 'rake', '~> 12.3'
+  spec.add_development_dependency 'rspec', '~> 3.7'
+  spec.add_development_dependency 'rubocop', '~> 0.57.2'
+  spec.add_development_dependency 'simplecov', '~> 0.16.1'
 end

data/lib/js_rails_routes/generator.rb

@@ -4,38 +4,43 @@ module JSRailsRoutes
   class Generator
     COMPARE_REGEXP = %r{:(.*?)(/|$)}
 
-    PROCESS_FUNC = <<-JAVASCRIPT.freeze
-function process(route, params, keys) {
-  var query = [];
-  for (var param in params) if (params.hasOwnProperty(param)) {
-    if (keys.indexOf(param) === -1) {
-      query.push(param + "=" + encodeURIComponent(params[param]));
-    }
-  }
-  return query.length ? route + "?" + query.join("&") : route;
-}
+    PROCESS_FUNC = <<-JAVASCRIPT.strip_heredoc.freeze
+      function process(route, params, keys) {
+        var query = [];
+        for (var param in params) if (params.hasOwnProperty(param)) {
+          if (keys.indexOf(param) === -1) {
+            query.push(param + "=" + encodeURIComponent(params[param]));
+          }
+        }
+        return query.length ? route + "?" + query.join("&") : route;
+      }
     JAVASCRIPT
 
     include Singleton
 
-    attr_accessor :include_paths, :exclude_paths, :include_names, :exclude_names, :path
+    attr_accessor :include_paths, :exclude_paths, :include_names, :exclude_names, :exclude_engines, :output_dir
 
     def initialize
-      self.include_paths = /.*/
-      self.exclude_paths = /^$/
-      self.include_names = /.*/
-      self.exclude_names = /^$/
-      self.path = Rails.root.join('app', 'assets', 'javascripts', 'rails-routes.js')
+      self.include_paths   = /.*/
+      self.exclude_paths   = /^$/
+      self.include_names   = /.*/
+      self.exclude_names   = /^$/
+      self.exclude_engines = /^$/
+
+      self.output_dir = Rails.root.join('app', 'assets', 'javascripts')
       Rails.application.reload_routes!
     end
 
     def generate(task)
-      lines = ["// Don't edit manually. `rake #{task}` generates this file.", PROCESS_FUNC]
-      lines += routes.map do |route_name, route_path|
-        handle_route(route_name, route_path) if match?(route_name, route_path)
-      end.compact
-      lines += [''] # End with new line
-      write(lines.join("\n"))
+      routes_with_engines.each do |rails_engine_name, routes|
+        lines = ["// Don't edit manually. `rake #{task}` generates this file.", PROCESS_FUNC]
+        lines += routes.map do |route_name, route_path|
+          handle_route(route_name, route_path) if match?(route_name, route_path)
+        end.compact
+
+        lines += [''] # End with new line
+        write(rails_engine_name, lines.join("\n"))
+      end
     end
 
     private
@@ -51,21 +56,37 @@ function process(route, params, keys) {
     def handle_route(route_name, route_path)
       keys = []
       while route_path =~ COMPARE_REGEXP
-        keys.push("'#{$1}'")
-        route_path.sub!(COMPARE_REGEXP, "' + params.#{$1} + '#{$2}")
+        keys.push("'#{Regexp.last_match(1)}'")
+        route_path.sub!(COMPARE_REGEXP, "' + params.#{Regexp.last_match(1)} + '#{Regexp.last_match(2)}")
       end
       "export function #{route_name}_path(params) { return process('#{route_path}', params, [#{keys.join(',')}]); }"
     end
 
-    def routes
-      @routes ||= Rails.application.routes.routes
-                       .select(&:name)
-                       .map { |r| [r.name, r.path.spec.to_s.split('(')[0]] }
-                       .sort { |a, b| a[0] <=> b[0] }
+    def routes_with_engines
+      @routes_with_engines ||= [default_routes] + subengine_routes
+    end
+
+    def make_routes(routes)
+      routes
+        .select(&:name)
+        .map { |r| [r.name, r.path.spec.to_s.split('(')[0]] }
+        .sort_by(&:first)
+    end
+
+    def write(rails_engine_name, string)
+      file_name = File.join(output_dir, "#{rails_engine_name.gsub('::Engine', '').downcase}-routes.js")
+      File.write(file_name, string)
+    end
+
+    def subengine_routes
+      Rails::Engine.subclasses
+                   .reject { |klass| klass.to_s.downcase =~ exclude_engines }
+                   .map { |engine| [engine.to_s, make_routes(engine.routes.routes)] }
+                   .reject { |_, routes| routes.empty? }
     end
 
-    def write(string)
-      File.open(path, 'w') { |f| f.write(string) }
+    def default_routes
+      ['Rails', make_routes(Rails.application.routes.routes)]
     end
   end
 end

data/lib/js_rails_routes/version.rb

@@ -1,3 +1,3 @@
 module JSRailsRoutes
-  VERSION = '0.5.0'.freeze
+  VERSION = '0.6.0'.freeze
 end

data/lib/tasks/js_rails_routes.rake

@@ -6,8 +6,8 @@ namespace :js do
     generator.exclude_paths = Regexp.new(ENV['exclude_paths']) if ENV['exclude_paths']
     generator.include_names = Regexp.new(ENV['include_names']) if ENV['include_names']
     generator.exclude_names = Regexp.new(ENV['exclude_names']) if ENV['exclude_names']
-    generator.path = ENV['path'] if ENV['path']
+    generator.output_dir = ENV['output_dir'] if ENV['output_dir']
     generator.generate(task)
-    puts "Routes saved to #{generator.path}."
+    puts "Routes saved into #{generator.output_dir}."
   end
 end

data/spec/js_rails_routes/generator_spec.rb

@@ -6,7 +6,9 @@ RSpec.describe JSRailsRoutes::Generator do
   it { expect(described_class).to include(Singleton) }
 
   describe '#generate' do
+    let(:output_dir) { File.expand_path('spec/tmp') }
     subject do
+      generator.output_dir = output_dir
       generator.generate(task)
     end
 
@@ -14,11 +16,24 @@ RSpec.describe JSRailsRoutes::Generator do
       'js:routes'
     end
 
-    it 'writes a JS file' do
-      expect(generator).to receive(:write).with(a_string_including("rake #{task}"))
+    it 'writes JS files' do
+      expect(generator).to receive(:write)
+        .with(be_in(['Rails', 'Admin::Engine']), a_string_including("rake #{task}"))
+        .twice
       subject
     end
 
+    context 'when actually creating files' do
+      let(:js_files) { Dir.glob(File.join(output_dir, '{admin,rails}-routes.js')).map { |file| Pathname.new(file) } }
+
+      after { FileUtils.rm_f(js_files) }
+
+      it 'creates JS files' do
+        subject
+        expect(js_files).to all be_file
+      end
+    end
+
     context 'when include_paths is given' do
       before do
         generator.include_paths = include_paths
@@ -29,11 +44,13 @@ RSpec.describe JSRailsRoutes::Generator do
       end
 
       it 'writes paths matching with the parameter' do
-        expect(generator).to receive(:write).with(a_kind_of(String)) do |arg|
-          paths = arg.split("\n")[(2 + described_class::PROCESS_FUNC.split("\n").size)..-1]
-          expect(paths).not_to be_empty
-          expect(paths).to all(match(include_paths))
-        end
+        expect(generator).to receive(:write)
+          .with(be_in(['Rails', 'Admin::Engine']), a_kind_of(String))
+          .twice do |_, arg|
+            paths = arg.split("\n")[(2 + described_class::PROCESS_FUNC.split("\n").size)..-1]
+            expect(paths).not_to be_empty
+            expect(paths).to all(match(include_paths))
+          end
         subject
       end
     end
@@ -48,13 +65,15 @@ RSpec.describe JSRailsRoutes::Generator do
       end
 
       it 'writes paths not matching with the parameter' do
-        expect(generator).to receive(:write).with(a_kind_of(String)) do |arg|
-          paths = arg.split("\n")[(2 + described_class::PROCESS_FUNC.split("\n").size)..-1]
-          expect(paths).not_to be_empty
-          paths.each do |path|
-            expect(path).to_not match(exclude_paths)
+        expect(generator).to receive(:write)
+          .with(be_in(['Rails', 'Admin::Engine']), a_kind_of(String))
+          .twice do |_, arg|
+            paths = arg.split("\n")[(2 + described_class::PROCESS_FUNC.split("\n").size)..-1]
+            expect(paths).not_to be_empty
+            paths.each do |path|
+              expect(path).to_not match(exclude_paths)
+            end
           end
-        end
         subject
       end
     end
@@ -65,15 +84,17 @@ RSpec.describe JSRailsRoutes::Generator do
       end
 
       let(:include_names) do
-        /user/
+        /user|note/
       end
 
       it 'writes paths matching with the parameter' do
-        expect(generator).to receive(:write).with(a_kind_of(String)) do |arg|
-          paths = arg.split("\n")[(2 + described_class::PROCESS_FUNC.split("\n").size)..-1]
-          expect(paths).not_to be_empty
-          expect(paths).to all(match(include_names))
-        end
+        expect(generator).to receive(:write)
+          .with(be_in(['Rails', 'Admin::Engine']), a_kind_of(String))
+          .twice do |_, arg|
+            paths = arg.split("\n")[(2 + described_class::PROCESS_FUNC.split("\n").size)..-1]
+            expect(paths).not_to be_empty
+            expect(paths).to all(match(include_names))
+          end
         subject
       end
     end
@@ -84,17 +105,46 @@ RSpec.describe JSRailsRoutes::Generator do
       end
 
       let(:exclude_names) do
-        /user/
+        /user|note/
+      end
+
+      it 'writes paths not matching with the parameter' do
+        expect(generator).to receive(:write)
+          .with(be_in(['Rails', 'Admin::Engine']), a_kind_of(String))
+          .twice do |_, arg|
+            paths = arg.split("\n")[(2 + described_class::PROCESS_FUNC.split("\n").size)..-1]
+            expect(paths).not_to be_empty
+            paths.each do |path|
+              expect(path).to_not match(exclude_names)
+            end
+          end
+        subject
+      end
+    end
+
+    context 'when exclude_engines is given' do
+      before do
+        generator.exclude_engines = exclude_engines
+      end
+
+      let(:exclude_engines) do
+        /^admin/
+      end
+
+      let(:excluded_routes) do
+        /note|photo/
       end
 
       it 'writes paths not matching with the parameter' do
-        expect(generator).to receive(:write).with(a_kind_of(String)) do |arg|
-          paths = arg.split("\n")[(2 + described_class::PROCESS_FUNC.split("\n").size)..-1]
-          expect(paths).not_to be_empty
-          paths.each do |path|
-            expect(path).to_not match(exclude_names)
+        expect(generator).to receive(:write)
+          .with(be_in(['Rails', 'Admin::Engine']), a_kind_of(String))
+          .once do |_, arg|
+            paths = arg.split("\n")[(2 + described_class::PROCESS_FUNC.split("\n").size)..-1]
+            expect(paths).not_to be_empty
+            paths.each do |path|
+              expect(path).to_not match(excluded_routes)
+            end
           end
-        end
         subject
       end
     end

data/spec/spec_helper.rb

@@ -1,4 +1,4 @@
-$LOAD_PATH << File.expand_path('../../lib', __FILE__)
+$LOAD_PATH << File.expand_path('../lib', __dir__)
 
 require 'simplecov'
 SimpleCov.start
@@ -7,7 +7,7 @@ require 'rails/all'
 require 'js_rails_routes'
 
 class TestApp < Rails::Application
-  config.root = File.expand_path('../test_app', __FILE__)
+  config.root = File.expand_path('test_app', __dir__)
 
   routes.draw do
     resources :blogs
@@ -15,6 +15,15 @@ class TestApp < Rails::Application
   end
 end
 
+module Admin
+  class Engine < ::Rails::Engine
+    routes.draw do
+      resources :notes
+      resources :photos
+    end
+  end
+end
+
 RSpec.configure do |config|
   config.expect_with :rspec do |expectations|
     expectations.include_chain_clauses_in_custom_matcher_descriptions = true

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: js_rails_routes
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Yuku Takahashi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-08 00:00:00.000000000 Z
+date: 2018-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.16'
 - !ruby/object:Gem::Dependency
   name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
@@ -58,56 +58,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: '3.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: '3.7'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.48.1
+        version: 0.57.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.48.1
+        version: 0.57.2
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: 0.16.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: 0.16.1
 description: 
 email:
 - taka84u9@gmail.com
@@ -134,6 +134,7 @@ files:
 - spec/js_rails_routes/generator_spec.rb
 - spec/js_rails_routes_spec.rb
 - spec/spec_helper.rb
+- spec/tmp/.keep
 homepage: https://github.com/yuku-t/js_rails_routes
 licenses:
 - MIT
@@ -154,7 +155,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Generate a ES6 module that contains Rails routes.