js_from_routes 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b404b3e7cc0394a4a79ecb225b36fbcf0f29d07391ee6df877cd068f1af438fb
+  data.tar.gz: 646668b779ea86c0aeee8327fba4355619ac2d72231e9053e4ec1569a3fc4293
+SHA512:
+  metadata.gz: 8fd27cf2b1388f455c42a68b3ba892f9344e13cae2f46654e4ec0a9554c1d3e932366898ffdf1860027b0eec0a4be1112f7289d40f22a5426889ae4c16766d8c
+  data.tar.gz: ce4f56fd37aa81378d41633da4eb7b59486052115d4a9224e472d7f14330e62d39e14f5ef8d2ea8f7a2f8e03e9f6221419d6ee73a764145aac7a47b0030726b0

data/README.md

@@ -0,0 +1,152 @@
+<h1 align="center">
+JS From Rails Routes
+<p align="center">
+<a href="https://rubygems.org/gems/js_from_routes"><img alt="Gem Version" src="https://img.shields.io/gem/v/js_from_routes.svg?colorB=e9573f"/></a>
+<a href="https://travis-ci.org/ElMassimo/js_from_routes"><img alt="Build Status" src="https://travis-ci.org/ElMassimo/js_from_routes.svg"/></a>
+<a href="https://codeclimate.com/github/ElMassimo/js_from_routes"><img alt="Coverage Status" src="https://codeclimate.com/github/ElMassimo/request_store_rails/badges/coverage.svg"/></a>
+<a href="https://codeclimate.com/github/ElMassimo/js_from_routes"><img alt="Code Quality" src="https://codeclimate.com/github/ElMassimo/js_from_routes/badges/gpa.svg"/></a>
+<a href="http://inch-ci.org/github/ElMassimo/js_from_routes"><img alt="Inline docs" src="http://inch-ci.org/github/ElMassimo/js_from_routes.svg"/></a>
+<a href="https://github.com/ElMassimo/js_from_routes/blob/master/LICENSE.txt"><img alt="License" src="https://img.shields.io/badge/license-MIT-428F7E.svg"/></a>
+</p>
+</h1>
+
+_JS from Routes_ helps you by automatically generating path and API helpers from
+Rails route definitions, allowing you to save development effort and focus on
+the things that matter.
+
+## Why? 🤔
+
+Path helpers in Rails are useful to ensure the constructed URLs match endpoints
+defined in the app.
+
+With this library, it's possible the enjoy the same benefits in JS:
+
+- No need to manually specify the URL, preventing mistakes and saving development time.
+- If an action is renamed or removed, the helper ceases to exist, which causes
+  an error that is easier to detect than a 404.
+- We can embed the the HTTP verb in the helper. Changing the verb in the route causes the JS
+  code to be regenerated, no need to update the consumer!
+
+### Installation 💿
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'js_from_routes'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install js_from_routes
+
+### Usage 🚀
+
+#### 1. Specify the Rails routes you want to export
+
+Use the `export` attribute to determine which [routes](https://github.com/ElMassimo/js_from_routes/blob/master/spec/support/sample_app/config/routes.rb#L6) should be taken into account when generating JS.
+
+```ruby
+Rails.application.routes.draw do
+  resources :video_clips, export: true do
+    get :download, on: :member, export: :path_only
+    get :trending, on: :collection, export: false
+  end
+end
+```
+
+#### 2. Generate JS code from your routes
+
+This is usually done automatically the next time you make a request to your
+Rails server (such as when you refresh the page), which causes Rails reloader to
+kick in, and the routes to be generated.
+
+If you are not running a local development server, or prefer to do it manually,
+you can use a rake task instead:
+
+```
+bin/rake js_from_routes:generate
+```
+
+#### 3. Use the generated code in your JS application
+
+This can happen in many [different ways](https://github.com/ElMassimo/js_from_routes/blob/master/spec/support/sample_app/app/javascript/Videos.vue#L10), but to illustrate using the example above:
+
+```js
+import VideoClipsRequests from '@requests/VideoClipsRequests'
+
+VideoClipsRequests.get({ id: 'oHg5SJYRHA0' }).then(displayVideo)
+
+const path = VideoClipsRequests.downloadPath({ id })
+```
+
+Check the [examples](https://github.com/ElMassimo/js_from_routes/blob/master/spec/support/sample_app/app/javascript/Videos.vue) for ideas on how to [use it](https://github.com/ElMassimo/js_from_routes/blob/master/spec/support/sample_app/app/javascript/Videos.vue), and how you can [configure](https://github.com/ElMassimo/js_from_routes/blob/master/spec/support/sample_app/config/webpack/aliases.js#L11) Webpack to your convenience.
+
+Read on to find out how to customize the generated code to suit your needs.
+
+### Advanced Configuration 📖
+
+Since all projects are different, it's very unlikely that the default settings
+fulfill all your requirements.
+
+The following [settings](https://github.com/ElMassimo/js_from_routes/blob/master/lib/js_from_routes/generator.rb#L77-L80) are available:
+
+##### [`file_suffix`](https://github.com/ElMassimo/js_from_routes/blob/master/lib/js_from_routes/generator.rb#L77), default: `Requests.js`
+
+This suffix is added by default to all generated files. You can modify it to
+if you prefer a different convention.
+
+##### [`helper_mappings`](https://github.com/ElMassimo/js_from_routes/blob/master/lib/js_from_routes/generator.rb#L80)
+
+By default it maps `index` to `list` and `show` to `get`, which helps to make
+the JS code read more natural.
+
+##### [`output_folder`](https://github.com/ElMassimo/js_from_routes/blob/master/lib/js_from_routes/generator.rb#L78), default: `app/javascript/requests`
+
+The directory where the generated files are created.
+
+Tip: It's highly recommended to [add a webpack alias](https://github.com/ElMassimo/js_from_routes/blob/master/spec/support/sample_app/config/webpack/aliases.js#L11), to simplify [imports](https://github.com/ElMassimo/js_from_routes/blob/master/spec/support/sample_app/app/javascript/Videos.vue#2).
+
+##### [`template_path`](https://github.com/ElMassimo/js_from_routes/blob/master/lib/js_from_routes/generator.rb#L79)
+
+A [default template](https://github.com/ElMassimo/js_from_routes/blob/master/lib/js_from_routes/template.js.erb) is provided, but it makes assumptions about the [available](https://github.com/ElMassimo/js_from_routes/blob/master/spec/support/sample_app/app/javascript/services/ApiService.js#L17) [code](https://github.com/ElMassimo/js_from_routes/blob/master/spec/support/sample_app/app/javascript/helpers/UrlHelper.js#L28).
+
+You will probably want to use a custom template, such as:
+
+```ruby
+# config/initializers/js_from_routes.rb
+JsFromRoutes.config do |config|
+  config.template = Rails.root.join('app', 'views', 'custom_js_from_routes.js.erb')
+end
+```
+
+A `routes` variable will be available in the template, which will contain the
+endpoints exported for a controller.
+
+Each `route` exposes properties such as `verb` and `path`, please [check the
+source code](https://github.com/ElMassimo/js_from_routes/blob/master/lib/js_from_routes/generator.rb#L34-L71) for details on the [API](https://github.com/ElMassimo/js_from_routes/blob/master/lib/js_from_routes/generator.rb#L34-L71).
+
+### How does it work? ⚙️
+
+By adding a hook to Rails' reload process in development, it's possible to
+automatically generate files from routes when a route is added, modified, or removed.
+
+In order to optimize file generation, the generated JS files are split by
+controller, and add a cache key based on the routes to avoid rewriting the file
+if the route definition hasn't changed.
+
+When the Webpack development server is running, it detects when a new file is
+generated, automatically triggering a new build, which can now use the generated
+request methods or path helpers 😃
+
+### Take this idea 💡
+
+There are plenty of opportunities for automatic code generation, such as keeping
+enums in sync between Ruby and JS.
+
+Let me know if you come up with new or creative ways to use this technique 😃
+
+

data/lib/js_from_routes.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# Splitting the generator file allows consumers to skip the Railtie if desired:
+#  - gem 'js_from_routes', require: false
+#  - require 'js_from_routes/generator'
+require 'js_from_routes/generator'
+require 'js_from_routes/railtie'

data/lib/js_from_routes/generator.rb

@@ -0,0 +1,142 @@
+# frozen_string_literal: true
+
+require 'digest'
+require 'erubi'
+require 'fileutils'
+
+# Public: Automatically generates JS for Rails routes with { export: true }.
+# Generates one file per controller, and one function per route.
+module JsFromRoutes
+  # Internal: Helper class used as a presenter for the routes template.
+  class Routes
+    attr_reader :routes
+
+    def initialize(routes, config)
+      @config = config
+      @routes = routes
+        .uniq { |route| route.requirements.fetch(:action) }
+        .map { |route| Route.new(route, config.helper_mappings) }
+    end
+
+    # Public: Used to check whether the file should be generated again, changes
+    # based on the configuration, and route definition.
+    def cache_key
+      Digest::MD5.hexdigest(routes.map(&:inspect).join + [File.read(@config.template_path), @config.helper_mappings.inspect].join)
+    end
+
+    # Internal: By performing the evaluation here, we ensure only "routes" is
+    # exposed to the ERB template as a local variable.
+    def evaluate(compiled_template)
+      instance_eval(compiled_template)
+    end
+  end
+
+  # Internal: A presenter for an individual Rails action.
+  class Route
+    def initialize(route, mappings = {})
+      @route, @mappings = route, mappings
+    end
+
+    # Public: Whether it should export only the path.
+    def path_only?
+      @route.defaults[:export] == :path_only
+    end
+
+    # Public: Whether it should export only the path.
+    def request_method?
+      !path_only?
+    end
+
+    # Public: The HTTP verb for the action. Example: 'patch'
+    def verb
+      @route.verb.downcase
+    end
+
+    # Public: The path for the action. Example: '/users/:id/edit'
+    def path
+      @route.path.spec.to_s.chomp('(.:format)')
+    end
+
+    # Public: The name of the JS helper for the action. Example: 'destroyAll'
+    def helper
+      action = @route.requirements.fetch(:action).camelize(:lower)
+      name = @mappings.fetch(action, action)
+      path_only? ? "#{ name }Path" : name
+    end
+
+    # Internal: Useful as a cache key for the route, and for debugging purposes.
+    def inspect
+      "#{ verb } #{ helper } #{ path }"
+    end
+  end
+
+  class << self
+    # Public: Configuration of the code generator.
+    def config
+      @config ||= OpenStruct.new(
+        file_suffix: 'Requests.js',
+        output_folder: ::Rails.root&.join('app', 'javascript', 'requests'),
+        template_path: File.expand_path('template.js.erb', __dir__),
+        helper_mappings: { 'index' => 'list', 'show' => 'get' },
+      )
+      yield(@config) if block_given?
+      @config
+    end
+
+    # Public: Generates code for the specified routes with { export: true }.
+    def generate!(app_or_routes = Rails.application)
+      raise ArgumentError, 'A Rails app must be defined, or you must specify a custom `output_folder`' if config.output_folder.blank?
+      rails_routes = app_or_routes.is_a?(::Rails::Engine) ? app_or_routes.routes.routes : app_or_routes
+      @compiled_template = nil # Clear on every code reload in case the template changed.
+      exported_routes_by_controller(rails_routes).each do |controller, controller_routes|
+        routes = Routes.new(controller_routes, config)
+        write_if_changed(filename_for(controller), routes.cache_key) { render_template(routes) }
+      end
+    end
+
+  private
+
+    # Internal: Returns exported routes grouped by controller name.
+    def exported_routes_by_controller(routes)
+      routes.select { |route|
+        route.defaults.fetch(:export, false)
+      }.group_by { |route|
+        route.requirements.fetch(:controller)
+      }
+    end
+
+    # Internal: Name of the JS file with helpers for the the given controller.
+    def filename_for(controller)
+      config.output_folder.join("#{ controller.camelize }#{ config.file_suffix }".tr_s(':', '/'))
+    end
+
+    # Internal: Returns a String with the JS generated for a controller's routes.
+    def render_template(routes)
+      routes.evaluate(compiled_template)
+    end
+
+    # Internal: Returns the compiled ERB to generate JS from a set of routes.
+    def compiled_template
+      @compiled_template ||= begin
+        template = File.read(config.template_path)
+        Erubi::Engine.new(template, filename: config.template_path).src
+      end
+    end
+
+    # Internal: Writes if the file does not exist or the cache key has changed.
+    # The cache strategy consists of a comment on the first line of the file.
+    #
+    # Yields to receive the rendered file content when it needs to.
+    def write_if_changed(name, cache_key)
+      FileUtils.mkdir_p(name.dirname)
+      cache_key_comment = "// JsFromRoutes CacheKey #{ cache_key }\n"
+      File.open(name, 'a+') { |file|
+        if file.gets != cache_key_comment
+          file.truncate(0)
+          file.write(cache_key_comment)
+          file.write(yield)
+        end
+      }
+    end
+  end
+end

data/lib/js_from_routes/railtie.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+# NOTE: Not strictly required, but it helps to simplify the setup.
+class JsFromRoutes::Railtie < Rails::Railtie
+  railtie_name :js_from_routes
+
+  if Rails.env.development?
+    # Allows to automatically trigger code generation after updating routes.
+    initializer 'js_from_routes.reloader' do |app|
+      app.config.to_prepare do
+        JsFromRoutes.generate!(app)
+      end
+    end
+  end
+
+  # Suitable when triggering code generation manually.
+  rake_tasks do |app|
+    namespace :js_from_routes do
+      desc 'Generates JavaScript files from Rails routes, one file per controller, and one function per route.'
+      task generate: :environment do
+        JsFromRoutes.generate!(app)
+      end
+    end
+  end
+end

data/lib/js_from_routes/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module JsFromRoutes
+  # Public: This library adheres to semantic versioning.
+  VERSION = '1.0.0'
+end

data/spec/js_from_routes/js_from_routes_spec.rb

@@ -0,0 +1,75 @@
+require 'support/sample_app/config/application'
+require 'support/sample_app/config/routes'
+
+
+describe JsFromRoutes do
+  ORIGINAL_TEMPLATE_PATH = JsFromRoutes.config.template_path
+
+  let(:output_dir) { Pathname.new File.expand_path('../support/generated', __dir__) }
+  let(:sample_dir) { Rails.root.join('app', 'javascript', 'requests') }
+  let(:different_template_path) { File.expand_path('../support/different_template.js.erb', __dir__) }
+  let(:controllers_with_exported_routes) { %w[Comments UserPreferences VideoClips] }
+
+  def file_for(dir, name)
+    dir.join("#{ name }Requests.js")
+  end
+
+  def sample_file_for(name)
+    file_for(sample_dir, name)
+  end
+
+  def output_file_for(name)
+    file_for(output_dir, name)
+  end
+
+  before do
+    # Sanity checks
+    expect(sample_dir.exist?).to eq true
+    expect(Rails.application.routes.routes).to be_present
+
+    # Remove directory from a previous test run.
+    FileUtils.remove_dir(output_dir) rescue nil
+
+    # Change the configuration to use a different directory.
+    JsFromRoutes.config do |config|
+      config.output_folder = output_dir
+      config.template_path = ORIGINAL_TEMPLATE_PATH
+    end
+  end
+
+  # NOTE: We do a manual snapshot test for now, more tests coming in the future.
+  it 'should generate the files as expected' do
+    expect(JsFromRoutes).to receive(:render_template).exactly(3).times.and_call_original
+    JsFromRoutes.generate!
+
+    # It does not generate routes that don't have `export: true`.
+    expect(output_file_for('Welcome').exist?).to eq false
+
+    # It generates one file per controller with exported routes.
+    controllers_with_exported_routes.each do |file_name|
+      expect(output_file_for(file_name).read).to eq sample_file_for(file_name).read
+    end
+
+    # It detects changes to the template, and regenerates the files.
+    JsFromRoutes.config do |config|
+      config.template_path = different_template_path
+    end
+    expect(JsFromRoutes).to receive(:render_template).exactly(3).times.and_call_original
+    JsFromRoutes.generate!
+
+    # These files should no longer match the sample ones.
+    controllers_with_exported_routes.each do |file_name|
+      expect(output_file_for(file_name).read).not_to eq sample_file_for(file_name).read
+    end
+
+    # It should not rewrite the files if the cache key has not changed.
+    expect(JsFromRoutes).not_to receive(:render_template)
+    JsFromRoutes.generate!
+  end
+
+  it 'should have a rake task available' do
+    Rails.application.load_tasks
+    expect(JsFromRoutes).to receive(:render_template).exactly(3).times
+    expect { Rake::Task['js_from_routes:generate'].invoke }.not_to raise_error
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'simplecov'
+SimpleCov.start { add_filter '/spec/' }
+
+require 'rails'
+require 'js_from_routes'
+require 'rspec/given'
+require 'pry-byebug'

data/spec/support/sample_app/app/controllers/application_controller.rb

@@ -0,0 +1,2 @@
+class ApplicationController < ActionController::Base
+end

data/spec/support/sample_app/app/controllers/comments_controller.rb

@@ -0,0 +1,2 @@
+class CommentsController < ApplicationController
+end

data/spec/support/sample_app/app/controllers/user_preferences_controller.rb

@@ -0,0 +1,2 @@
+class UserPreferencesController < ApplicationController
+end

data/spec/support/sample_app/app/controllers/video_clips_controller.rb

@@ -0,0 +1,2 @@
+class VideoClipsController < ApplicationController
+end

data/spec/support/sample_app/app/controllers/welcome_controller.rb

@@ -0,0 +1,2 @@
+class WelcomeController < ApplicationController
+end

data/spec/support/sample_app/app/mailers/application_mailer.rb

@@ -0,0 +1,4 @@
+class ApplicationMailer < ActionMailer::Base
+  default from: 'from@example.com'
+  layout 'mailer'
+end

data/spec/support/sample_app/config/application.rb

@@ -0,0 +1,20 @@
+require_relative 'boot'
+
+require "action_controller/railtie"
+require "sprockets/railtie"
+
+# Require the gems listed in Gemfile, including any gems
+# you've limited to :test, :development, or :production.
+Bundler.require(*Rails.groups)
+
+module SampleApp
+  class Application < Rails::Application
+    # Initialize configuration defaults for originally generated Rails version.
+    config.load_defaults 6.0
+
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration can go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded after loading
+    # the framework and any gems in your application.
+  end
+end

data/spec/support/sample_app/config/boot.rb

@@ -0,0 +1,4 @@
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+
+require 'bundler/setup' # Set up gems listed in the Gemfile.
+require 'bootsnap/setup' # Speed up boot time by caching expensive operations.

data/spec/support/sample_app/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require_relative 'application'
+
+# Initialize the Rails application.
+Rails.application.initialize!

data/spec/support/sample_app/config/environments/development.rb

@@ -0,0 +1,33 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports.
+  config.consider_all_requests_local = true
+
+  # Store uploaded files on the local file system (see config/storage.yml for options).
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+
+  # Suppress logger output for asset requests.
+  config.assets.quiet = true
+
+  # Raises error for missing translations.
+  # config.action_view.raise_on_missing_translations = true
+
+  # Use an evented file watcher to asynchronously detect changes in source code,
+  # routes, locales, etc. This feature depends on the listen gem.
+  config.file_watcher = ActiveSupport::EventedFileUpdateChecker
+end

data/spec/support/sample_app/config/initializers/application_controller_renderer.rb

@@ -0,0 +1,8 @@
+# Be sure to restart your server when you modify this file.
+
+# ActiveSupport::Reloader.to_prepare do
+#   ApplicationController.renderer.defaults.merge!(
+#     http_host: 'example.org',
+#     https: false
+#   )
+# end

data/spec/support/sample_app/config/initializers/assets.rb

@@ -0,0 +1,14 @@
+# Be sure to restart your server when you modify this file.
+
+# Version of your assets, change this if you want to expire all your assets.
+Rails.application.config.assets.version = '1.0'
+
+# Add additional assets to the asset load path.
+# Rails.application.config.assets.paths << Emoji.images_path
+# Add Yarn node_modules folder to the asset load path.
+Rails.application.config.assets.paths << Rails.root.join('node_modules')
+
+# Precompile additional assets.
+# application.js, application.css, and all non-JS/CSS in the app/assets
+# folder are already added.
+# Rails.application.config.assets.precompile += %w( admin.js admin.css )

data/spec/support/sample_app/config/initializers/backtrace_silencers.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
+# Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ }
+
+# You can also remove all the silencers if you're trying to debug a problem that might stem from framework code.
+# Rails.backtrace_cleaner.remove_silencers!

data/spec/support/sample_app/config/initializers/content_security_policy.rb

@@ -0,0 +1,30 @@
+# Be sure to restart your server when you modify this file.
+
+# Define an application-wide content security policy
+# For further information see the following documentation
+# https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy
+
+# Rails.application.config.content_security_policy do |policy|
+#   policy.default_src :self, :https
+#   policy.font_src    :self, :https, :data
+#   policy.img_src     :self, :https, :data
+#   policy.object_src  :none
+#   policy.script_src  :self, :https
+#   policy.style_src   :self, :https
+#   # If you are using webpack-dev-server then specify webpack-dev-server host
+#   policy.connect_src :self, :https, "http://localhost:3035", "ws://localhost:3035" if Rails.env.development?
+
+#   # Specify URI for violation reports
+#   # policy.report_uri "/csp-violation-report-endpoint"
+# end
+
+# If you are using UJS then enable automatic nonce generation
+# Rails.application.config.content_security_policy_nonce_generator = -> request { SecureRandom.base64(16) }
+
+# Set the nonce only to specific directives
+# Rails.application.config.content_security_policy_nonce_directives = %w(script-src)
+
+# Report CSP violations to a specified URI
+# For further information see the following documentation:
+# https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy-Report-Only
+# Rails.application.config.content_security_policy_report_only = true

data/spec/support/sample_app/config/initializers/cookies_serializer.rb

@@ -0,0 +1,5 @@
+# Be sure to restart your server when you modify this file.
+
+# Specify a serializer for the signed and encrypted cookie jars.
+# Valid options are :json, :marshal, and :hybrid.
+Rails.application.config.action_dispatch.cookies_serializer = :json

data/spec/support/sample_app/config/initializers/filter_parameter_logging.rb

@@ -0,0 +1,4 @@
+# Be sure to restart your server when you modify this file.
+
+# Configure sensitive parameters which will be filtered from the log file.
+Rails.application.config.filter_parameters += [:password]

data/spec/support/sample_app/config/initializers/inflections.rb

@@ -0,0 +1,16 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new inflection rules using the following format. Inflections
+# are locale specific, and you may define rules for as many different
+# locales as you wish. All of these examples are active by default:
+# ActiveSupport::Inflector.inflections(:en) do |inflect|
+#   inflect.plural /^(ox)$/i, '\1en'
+#   inflect.singular /^(ox)en/i, '\1'
+#   inflect.irregular 'person', 'people'
+#   inflect.uncountable %w( fish sheep )
+# end
+
+# These inflection rules are supported but not enabled by default:
+# ActiveSupport::Inflector.inflections(:en) do |inflect|
+#   inflect.acronym 'RESTful'
+# end

data/spec/support/sample_app/config/initializers/mime_types.rb

@@ -0,0 +1,4 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new mime types for use in respond_to blocks:
+# Mime::Type.register "text/richtext", :rtf

data/spec/support/sample_app/config/initializers/wrap_parameters.rb

@@ -0,0 +1,14 @@
+# Be sure to restart your server when you modify this file.
+
+# This file contains settings for ActionController::ParamsWrapper which
+# is enabled by default.
+
+# Enable parameter wrapping for JSON. You can disable this by setting :format to an empty array.
+ActiveSupport.on_load(:action_controller) do
+  wrap_parameters format: [:json]
+end
+
+# To enable root element in JSON for ActiveRecord objects.
+# ActiveSupport.on_load(:active_record) do
+#   self.include_root_in_json = true
+# end

data/spec/support/sample_app/config/puma.rb

@@ -0,0 +1,38 @@
+# Puma can serve each request in a thread from an internal thread pool.
+# The `threads` method setting takes two numbers: a minimum and maximum.
+# Any libraries that use thread pools should be configured to match
+# the maximum value specified for Puma. Default is set to 5 threads for minimum
+# and maximum; this matches the default thread size of Active Record.
+#
+max_threads_count = ENV.fetch("RAILS_MAX_THREADS") { 5 }
+min_threads_count = ENV.fetch("RAILS_MIN_THREADS") { max_threads_count }
+threads min_threads_count, max_threads_count
+
+# Specifies the `port` that Puma will listen on to receive requests; default is 3000.
+#
+port        ENV.fetch("PORT") { 3000 }
+
+# Specifies the `environment` that Puma will run in.
+#
+environment ENV.fetch("RAILS_ENV") { "development" }
+
+# Specifies the `pidfile` that Puma will use.
+pidfile ENV.fetch("PIDFILE") { "tmp/pids/server.pid" }
+
+# Specifies the number of `workers` to boot in clustered mode.
+# Workers are forked web server processes. If using threads and workers together
+# the concurrency of the application would be max `threads` * `workers`.
+# Workers do not work on JRuby or Windows (both of which do not support
+# processes).
+#
+# workers ENV.fetch("WEB_CONCURRENCY") { 2 }
+
+# Use the `preload_app!` method when specifying a `workers` number.
+# This directive tells Puma to first boot the application and load code
+# before forking the application. This takes advantage of Copy On Write
+# process behavior so workers use less memory.
+#
+# preload_app!
+
+# Allow puma to be restarted by `rails restart` command.
+plugin :tmp_restart

data/spec/support/sample_app/config/routes.rb

@@ -0,0 +1,22 @@
+Rails.application.routes.draw do
+  root to: 'welcome#home'
+
+  resources :welcome
+
+  resources :video_clips, only: [:new, :edit, :create, :update, :destroy], export: true do
+    get :download, on: :member, export: :path_only
+    patch :add_to_playlist, on: :member
+    patch :remove_from_playlist, on: :member
+    get :trending, on: :collection
+    get '/thumbnail/:thumbnail_id', as: :thumbnail, action: :thumbnail, on: :member
+
+    resources :comments, only: [:show, :index], shallow: true, export: true
+  end
+
+  resources :user_preferences, only: [], export: true do
+    patch :switch_to_classic_navbar, on: :collection
+    get :switch_to_beta_navbar, on: :collection, export: false
+    get '/switch_to_classic/:page', action: :switch_to_classic, on: :collection, export: :path_only
+    get '/switch_to_beta/:page', action: :switch_to_beta, on: :collection, as: :switch_to_beta_page, export: :path_only
+  end
+end

data/spec/support/sample_app/node_modules/node-sass/src/libsass/extconf.rb

@@ -0,0 +1,6 @@
+require 'mkmf'
+# .. more stuff
+#$LIBPATH.push(Config::CONFIG['libdir'])
+$CFLAGS << " #{ENV["CFLAGS"]}"
+$LIBS << " #{ENV["LIBS"]}"
+create_makefile("libsass")

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: js_from_routes
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Máximo Mussini
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-06-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: js_from_routes helps you by automatically generating path and API helpers
+  from Rails route definitions, allowing you to save development effort and focus
+  on the things that matter.
+email:
+- maximomussini@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- README.md
+- lib/js_from_routes.rb
+- lib/js_from_routes/generator.rb
+- lib/js_from_routes/railtie.rb
+- lib/js_from_routes/version.rb
+- spec/js_from_routes/js_from_routes_spec.rb
+- spec/spec_helper.rb
+- spec/support/sample_app/app/controllers/application_controller.rb
+- spec/support/sample_app/app/controllers/comments_controller.rb
+- spec/support/sample_app/app/controllers/user_preferences_controller.rb
+- spec/support/sample_app/app/controllers/video_clips_controller.rb
+- spec/support/sample_app/app/controllers/welcome_controller.rb
+- spec/support/sample_app/app/mailers/application_mailer.rb
+- spec/support/sample_app/config/application.rb
+- spec/support/sample_app/config/boot.rb
+- spec/support/sample_app/config/environment.rb
+- spec/support/sample_app/config/environments/development.rb
+- spec/support/sample_app/config/initializers/application_controller_renderer.rb
+- spec/support/sample_app/config/initializers/assets.rb
+- spec/support/sample_app/config/initializers/backtrace_silencers.rb
+- spec/support/sample_app/config/initializers/content_security_policy.rb
+- spec/support/sample_app/config/initializers/cookies_serializer.rb
+- spec/support/sample_app/config/initializers/filter_parameter_logging.rb
+- spec/support/sample_app/config/initializers/inflections.rb
+- spec/support/sample_app/config/initializers/mime_types.rb
+- spec/support/sample_app/config/initializers/wrap_parameters.rb
+- spec/support/sample_app/config/puma.rb
+- spec/support/sample_app/config/routes.rb
+- spec/support/sample_app/node_modules/node-sass/src/libsass/extconf.rb
+homepage: https://github.com/ElMassimo/js_from_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: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Generate JS automatically from Rails routes.
+test_files:
+- spec/spec_helper.rb
+- spec/js_from_routes/js_from_routes_spec.rb
+- spec/support/sample_app/app/mailers/application_mailer.rb
+- spec/support/sample_app/app/controllers/video_clips_controller.rb
+- spec/support/sample_app/app/controllers/application_controller.rb
+- spec/support/sample_app/app/controllers/comments_controller.rb
+- spec/support/sample_app/app/controllers/welcome_controller.rb
+- spec/support/sample_app/app/controllers/user_preferences_controller.rb
+- spec/support/sample_app/config/routes.rb
+- spec/support/sample_app/config/environments/development.rb
+- spec/support/sample_app/config/environment.rb
+- spec/support/sample_app/config/application.rb
+- spec/support/sample_app/config/puma.rb
+- spec/support/sample_app/config/boot.rb
+- spec/support/sample_app/config/initializers/application_controller_renderer.rb
+- spec/support/sample_app/config/initializers/backtrace_silencers.rb
+- spec/support/sample_app/config/initializers/mime_types.rb
+- spec/support/sample_app/config/initializers/filter_parameter_logging.rb
+- spec/support/sample_app/config/initializers/wrap_parameters.rb
+- spec/support/sample_app/config/initializers/assets.rb
+- spec/support/sample_app/config/initializers/cookies_serializer.rb
+- spec/support/sample_app/config/initializers/content_security_policy.rb
+- spec/support/sample_app/config/initializers/inflections.rb
+- spec/support/sample_app/node_modules/node-sass/src/libsass/extconf.rb