js_rails_routes 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 61db98e6e7dc44440b72ab03ebc63a7a8f03a58a
+  data.tar.gz: 36a09a7db939d6ce498f5efd1e39b82785dc95db
+SHA512:
+  metadata.gz: 77cc9a29fbeaae2fbc634c9efdbc35c20ad45388c89df1718d59aeafbe943af392ee798846e67ca6c91ae4465d12b4f1938641d8a22856dd5bac1f06588145ff
+  data.tar.gz: c04d2e6e05e77a01c65aa32850fc782e432d977b8128ff6146e0bc4dfdaa892cef282c85037f090ad056fa480b9589758a19280ff8356500694a49ef7c634839

data/.gitignore

@@ -0,0 +1,3 @@
+/pkg/
+*.gem
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Yuku TAKAHASHI
+
+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,90 @@
+# rake js:rails\_routes
+
+Generate a ES6 module that contains Rails routes.
+
+## Description
+
+This gem provides "js:rails:routes" rake task.
+It generates a ES6 requirable module whith exports url helper functions defined by your Rails application.
+
+Suppose there are some routes defined:
+
+```rb
+# == Route Map
+#
+#       Prefix Verb   URI Pattern                        Controller#Action
+#     articles GET    /articles(.:format)                articles#index
+#              POST   /articles(.:format)                articles#create
+#  new_article GET    /articles/new(.:format)            articles#new
+# edit_article GET    /articles/:id/edit(.:format)       articles#edit
+#      article GET    /articles/:id(.:format)            articles#show
+#              PATCH  /articles/:id(.:format)            articles#update
+#              PUT    /articles/:id(.:format)            articles#update
+#              DELETE /articles/:id(.:format)            articles#destroy
+Rails.application.routes.draw do
+  resources :articles
+end
+```
+
+The JS file generated by this gem exports following functions:
+
+```js
+var RailsRoutes = require('./rails-routes');
+RailsRoutes.articles_path();              //=> '/articles'
+RailsRoutes.new_article_path();           //=> '/articles/new'
+RailsRoutes.edit_article_path({ id: 1 }); //=> '/articles/1/edit'
+RailsRoutes.article_path({ id: 1 });      //=> '/articles/1'
+```
+
+## VS.
+
+[railsware/js-routes](https://github.com/railsware/js-routes) spreads url helpers via global variable.
+
+This gem uses ES6 modules.
+
+## Requirement
+
+- Rails >= 3.0
+
+## Usage
+
+Write all routes to app/assets/javascripts/rails-routes.js:
+
+```
+rake js:rails:routes
+```
+
+Write to client/src/rails-routes.js:
+
+```
+rake js:rails:routes path='client/src/rails-routes.js'
+```
+
+Generate routes except paths start with "/rails/" or "/sidekiq/":
+
+```
+rake js:rails:routes excludes='^/(rails|sidekiq)/'
+```
+Generate routes start with "/articles/" only:
+
+```
+rake js:rails:routes includes='^/articles/'
+```
+
+## Install
+
+Your Rails Gemfile:
+
+```
+gem 'js_rails_routes', group: :development
+```
+
+## License
+
+[MIT](https://github.com/yuku-t/js_rails_routes/blob/master/LICENCE)
+
+## Author
+
+[mizchi](https://github.com/mizchi) wrote "js:rake" task with referencing [mtrpcic/js-routes](https://github.com/mtrpcic/js-routes).
+
+[yuku-t](https://yuku-t.com) refactor and improve the mizchi's script and published to rubygems.

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/js_rails_routes.gemspec

@@ -0,0 +1,18 @@
+$: << File.expand_path('../lib', __FILE__)
+
+require 'js_rails_routes/version'
+
+Gem::Specification.new do |spec|
+  spec.name            = 'js_rails_routes'
+  spec.version         = JSRailsRoutes::VERSION
+  spec.authors         = ['Yuku Takahashi']
+  spec.email           = ['taka84u9@gmail.com']
+  spec.summary         = 'Generate a ES6 module that contains Rails routes.'
+  spec.homepage        = 'https://github.com/yuku_t/js_rails_routes'
+  spec.license         = 'MIT'
+  spec.files           = `git ls-files -z`.split("\x0")
+  spec.require_paths   = ['lib']
+  spec.add_dependency 'rails', '>= 3'
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

data/lib/js_rails_routes.rb

@@ -0,0 +1,3 @@
+require 'js_rails_routes/engine'
+require 'js_rails_routes/generator'
+require 'js_rails_routes/version'

data/lib/js_rails_routes/engine.rb

@@ -0,0 +1,6 @@
+require 'rails'
+
+module JSRailsRoutes
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/js_rails_routes/generator.rb

@@ -0,0 +1,56 @@
+module JSRailsRoutes
+  class Generator
+    COMPARE_REGEXP = /:(.*?)(\/|$)/
+
+    def initialize(includes: nil, excludes: nil)
+      @includes = includes
+      @excludes = excludes
+      Rails.application.reload_routes!
+    end
+
+    def generate(task, save_path)
+      lines = ["// Don't edit manually. `rake #{task}#{env}` generates this file."]
+      lines += routes.map do |name, path|
+        handle_route(name, path) if match?(name, path)
+      end.compact
+      File.open(save_path, 'w') { |f| f.write(lines.join("\n")) }
+    end
+
+    private
+
+    attr_reader :includes, :excludes
+
+    def includes_regexp
+      @includes_regexp ||= Regexp.new(includes)
+    end
+
+    def excludes_regexp
+      @excludes_regexp ||= Regexp.new(excludes)
+    end
+
+    def match?(name, path)
+      return false if includes && includes_regexp !~ path
+      return false if excludes && excludes_regexp =~ path
+      true
+    end
+
+    def handle_route(name, path)
+      path.sub!(COMPARE_REGEXP, "' + params.#{$1} + '#{$2}") while path =~ COMPARE_REGEXP
+      "export function #{name}_path(params) { return '#{path}'; }"
+    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] }
+    end
+
+    def env
+      result = []
+      result << "includes='#{includes}'" if includes
+      result << "excludes='#{excludes}'" if excludes
+      result.empty? ? '' : ' ' + result.join(' ')
+    end
+  end
+end

data/lib/js_rails_routes/version.rb

@@ -0,0 +1,3 @@
+module JSRailsRoutes
+  VERSION = '0.1.0'
+end

data/lib/tasks/js_rails_routes.rake

@@ -0,0 +1,14 @@
+desc 'Generate a ES6 module that contains Rails routes'
+namespace :js do
+  namespace :rails do
+    task routes: :environment do |task|
+      path =  ENV['path'] || Rails.root.join('app', 'assets', 'javascripts', 'rails-routes.js')
+      generator = JSRailsRoutes::Generator.new(
+        includes: ENV['includes'],
+        excludes: ENV['excludes']
+      )
+      generator.generate(task, path)
+      puts "Routes saved to #{path}."
+    end
+  end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: js_rails_routes
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yuku Takahashi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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'
+description: 
+email:
+- taka84u9@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- js_rails_routes.gemspec
+- lib/js_rails_routes.rb
+- lib/js_rails_routes/engine.rb
+- lib/js_rails_routes/generator.rb
+- lib/js_rails_routes/version.rb
+- lib/tasks/js_rails_routes.rake
+homepage: https://github.com/yuku_t/js_rails_routes
+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.1
+signing_key: 
+specification_version: 4
+summary: Generate a ES6 module that contains Rails routes.
+test_files: []