webpacker-routes 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 870c1f1a66d6273a647b5c278d7985d07e23a6814bce47f3626a69e8b46d3e64
+  data.tar.gz: 0afca05fd9696f6a14bad00d51a3be56180b80a8a55e8ec5875fc75352d313d3
+SHA512:
+  metadata.gz: 355ae6d680169c228079bb5e93287ef82bdd1521c075ba748528869fefa56d9ad2f6e063150efe864f815cf8f2711233aeaa000e15f4a690d967093bd565871c
+  data.tar.gz: 41bb64fe9f9fa95a0dd86f42e432c6e710815d3ac83a62c1b6c86fb12eb226cd3fbec3115f13b717427ee641e6d0c0ee2dbcf5a517e536a13bc07619a4c22c5a

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 David Harsha
+
+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,44 @@
+# Webpacker::Routes
+Webpacker Routes allows you to import Rails routes in your Webpacker javascript.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'webpacker-routes'
+```
+
+And then execute:
+```bash
+$ bundle
+$ bundle exec rails webpacker:install:routes
+```
+
+Finally, generate your routes file:
+```bash
+$ bundle exec rails webpacker:routes:generate
+```
+
+You will need to regenerate the routes file whenever you add a new Rails route.
+
+## Usage
+Import individual routes from any Webpacker-compiled file:
+
+```javascript
+import { root_path } from 'routes'
+
+console.log(root_path())
+```
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## TODO
+
+- fix handle_positional_args in rails
+- somehow generate routes automatically in development
+  - to_prepare?
+- support all valid route names
+- default_url_options
+- relative_url_root
+- camelcase

data/Rakefile

@@ -0,0 +1,27 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Webpacker::Routes'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/install/javascript/index.js

@@ -0,0 +1 @@
+// run `webpacker:routes:generate`

data/lib/install/template.rb

@@ -0,0 +1,5 @@
+say "Creating JavaScript app source directory"
+directory "#{__dir__}/javascript", Webpacker.config.source_path.join('routes')
+
+say "Installing all JavaScript dependencies"
+run "yarn add webpacker-routes@0.0.4 --exact"

data/lib/tasks/webpacker/routes_tasks.rake

@@ -0,0 +1,33 @@
+namespace :webpacker do
+  namespace :install do
+    desc "Install everything needed for routes"
+    task routes: ["webpacker:verify_install"] do
+      template = File.expand_path("../../install/template.rb", __dir__)
+      if Rails::VERSION::MAJOR >= 5
+        exec "#{RbConfig.ruby} ./bin/rails app:template LOCATION=#{template}"
+      else
+        exec "#{RbConfig.ruby} ./bin/rake rails:template LOCATION=#{template}"
+      end
+    end
+  end
+
+  namespace :routes do
+    desc "Verifies if routes is installed"
+    task verify_install: ["webpacker:verify_install"] do
+      if Webpacker.config.routes_path.exist?
+        $stdout.puts "Webpacker Routes is installed 🎉 🍰"
+        $stdout.puts "Using #{Webpacker.config.routes_path} file for generating routes"
+      else
+        $stderr.puts "Webpacker Routes directory not found. \n"\
+            "Make sure webpacker:install:routes is run successfully before " \
+            "running dependent tasks"
+        exit!
+      end
+    end
+
+    desc "Generate routes package"
+    task generate: [:verify_install, :environment] do
+      Webpacker::Routes.generate(Rails.application.routes)
+    end
+  end
+end

data/lib/webpacker/routes.rb

@@ -0,0 +1,35 @@
+require "webpacker/routes/railtie"
+
+module Webpacker
+  class Configuration
+    def routes_path
+      source_path.join('routes')
+    end
+  end
+
+  module Routes
+    JAVASCRIPT_VARIABLE_NAME_REGEX = /\A[_$a-z][_$a-z0-9]*\z/i
+
+    def self.generate(route_set)
+      File.atomic_write(Webpacker.config.routes_path.join('index.js')) do |file|
+        file.write(<<-JAVASCRIPT.strip_heredoc)
+          import { urlFor, pathFor } from 'webpacker-routes'
+        JAVASCRIPT
+
+        route_set.named_routes.sort_by(&:first).each do |name, route|
+          raise `Invalid route name for javascript: ${name}` unless JAVASCRIPT_VARIABLE_NAME_REGEX =~ name
+
+          spec = route.path.spec.to_s.to_json
+          segment_keys = route.segment_keys.uniq.to_json
+          defaults = route.defaults.except(:controller, :action).to_json
+
+          file.write(<<-JAVASCRIPT.strip_heredoc)
+            const #{name} = [#{spec}, #{segment_keys}, #{defaults}]
+            export const #{name}_url = (...args) => urlFor(#{name}, ...args)
+            export const #{name}_path = (...args) => pathFor(#{name}, ...args)
+          JAVASCRIPT
+        end
+      end
+    end
+  end
+end

data/lib/webpacker/routes/railtie.rb

@@ -0,0 +1,6 @@
+module Webpacker
+  module Routes
+    class Engine < ::Rails::Engine
+    end
+  end
+end

data/lib/webpacker/routes/version.rb

@@ -0,0 +1,5 @@
+module Webpacker
+  module Routes
+    VERSION = '0.0.4'
+  end
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: webpacker-routes
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- David Harsha
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-10-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.1
+- !ruby/object:Gem::Dependency
+  name: webpacker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: execjs
+  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: 
+email:
+- davishmcclurg@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/install/javascript/index.js
+- lib/install/template.rb
+- lib/tasks/webpacker/routes_tasks.rake
+- lib/webpacker/routes.rb
+- lib/webpacker/routes/railtie.rb
+- lib/webpacker/routes/version.rb
+homepage: https://github.com/davishmcclurg/webpacker-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.7.6
+signing_key: 
+specification_version: 4
+summary: Convert Rails routes to JavaScript modules
+test_files: []