railbus 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eca04d46928b46af6ee37969c8cd9e34ffa535ae8295b9a3efba843c4a1fbe32
-  data.tar.gz: a708f98d5b39524baf0888bd96f458df8a6dbc63e97a1827447fd2423ffeb03a
+  metadata.gz: c9c2e34aa14ab37ae14293ac159f7c1d8850f36ee5063bc373ff63c3d26fea36
+  data.tar.gz: a2573f5dd914ed8a0f8756d5905696f4e770387d8f068f20b615b901b37397cf
 SHA512:
-  metadata.gz: b3f9a587e3d6658f6cacda733db67d37af4d8b2d8316e9d63f11f0a0899e54ad24b2d124a4f8750536786a923faa0200dd6a1c3025f926230d2257a8f3a6cca3
-  data.tar.gz: 35964ef3fd6e599cfca9aee232abc332d9ebf86ba072b1efde5fd5ad43aef1ad5c8670f268bef98ff3f4d2796cb25091a14357605bbc70647691ae7cba3f1001
+  metadata.gz: 2f058f3bbf84e63f96b5a797c7083e0aacb4c1a1ad7f40c19553c885dc28e223397976a57badfc95a77078bb5a41b2f5c8ce2335b273946d4763769b515a4728
+  data.tar.gz: 115f416c92960e08fd12dec4f2ad4f8eb76fb93f9b76450071546b8d5b3f9b91f2a5dffe61f842fb8f9a2d805dd684fba0e70a79549050ac4db91a5e0ce026c1

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+# Version 0.2.0
+
+1. Extract Axios-related functionality to NPM package 'yambus-axios'.
+2. Add support for `fetch` with NPM package 'yambus-fetch'.
+3. Custom request function now can add options before performing request
+   (`set_options` in `Railbus.generate`). Also it may be useful for logging
+   requests.
+4. Enriched support for multiple Rails engines. Now Railbus autodetects endpoint
+   for mounted engines for generating correct paths.
+
 # Version 0.1.2
 
 Extract JavaScript generators to NPM package called 'yambus'.

data/README.md

@@ -1,8 +1,10 @@
 # Railbus
 
-Do you want to use autogenerated set of Rails application routes in your JavaScript files?
+Do you want to use autogenerated set of Rails application routes in your
+JavaScript files?
 
-Do you want to make requests to your routes from JS with human-readable names like `create_news`, `update_message`?
+Do you want to make requests to your routes from JS with human-readable names
+like `create_news`, `update_message`?
 
 Here comes Railbus to you.
 
@@ -18,18 +20,16 @@ And then execute:
 
     $ bundle install
 
-Or install it yourself as:
-
-    $ gem install railbus
-
 You may call this to generate example file and install JavaScript dependencies:
 
     $ rails g railbus:install
 
 Or do it manually:
 
-1. Run `yarn add @crosspath/yambus`.
-2. Create `*.js.erb` file in `app/javascript` (e.g. `lib/routes.js.erb`)
+1. Run `yarn add @crosspath/yambus`. See its [README][1] for usage info.
+2. Recommended step: add adapter for [Axios][2] or [`fetch` function][3].
+   Default: add adapter for Axios as `yarn add @crosspath/yambus-axios`.
+3. Create `*.js.erb` file in `app/javascript` (e.g. `lib/routes.js.erb`)
    to use it with Webpack:
 
 ```erb
@@ -37,17 +37,23 @@ Or do it manually:
 <%= Railbus.generate %>
 ```
 
-And the last step, require this file in your `.js` files where you want to use application routes.
+And the last step, require this file in your `.js` files where you want to use
+application routes.
 
 ```js
 import Routes from 'lib/routes'
 ```
 
+[1]: https://github.com/crosspath/yambus
+[2]: https://github.com/crosspath/yambus/blob/master/adapters/axios/README.md
+[3]: https://github.com/crosspath/yambus/blob/master/adapters/fetch/README.md
+
 ## Usage
 
 In short:
 
-1. See output of `rails routes`, it includes route names. You may use these names in JS as functions for XHR requests.
+1. See output of `rails routes`, it includes route names. You may use these
+   names in JS as functions for requests.
 2. Append `_path` to a route name to get its URL.
 
 Route names in JS depend on route names in Rails:
@@ -62,48 +68,22 @@ create      | POST        | create_{singular_name} | create_{singular_name}_path
 update      | PUT/PATCH   | update_{singular_name} | update_{singular_name}_path
 destroy     | DELETE      | delete_{singular_name} | delete_{singular_name}_path
 
-### Functions' arguments
-
-Here `String or Number, ...` represents values used in paths, e.g.
-`:id`, `:category_id` (zero, one or more params).
-
-And `...path_params` means hash-like object with values for paths, e.g.
-`{id: 123, category_id: 56}` (zero, one or more params).
-
-`data` means request body (payload), it can be hash-like object, `FormData` and so on, its allowed types depend on XHR library or request function.
-
-All arguments are optional.
-
-```js
-// Request `index`, `show`, `new`, `edit`, `destroy` actions.
-({format: String, ...path_params, ...url_options})
-// Or:
-(String or Number, ..., {format: String, ...url_options})
-
-// Request `create` and `update` actions.
-({format: String, ...path_params, ...url_options}, data)
-// Or:
-(String or Number, ..., {format: String, ...url_options}, data)
-
-// Get path for any action (does not include query string starting with '?').
-({format: String, ...path_params})
-// Or:
-(String or Number, ..., {format: String})
-```
-
 ### Configuration
 
 By default Railbus generates functions for all routes defined
-in `Rails.application` and these functions use `axios`. You may change it:
+in `Rails.application`, and these functions use library `axios`.
 
-```js
+You may change it:
+
+```erb
 <%=
   Railbus.generate(
     # Here `YourApp::Engine` inherits `Rails::Engine`.
     # Default: `Rails.application`.
     app:    YourApp::Engine,
 
-    # 'axios' or the name of function defined or imported in this file.
+    # 'axios', 'fetch' or the name of function defined or imported in this file.
+    # Appropriate NPM package for adapter should be installed.
     # Default: 'axios'.
     client: 'request_api',
 
@@ -113,22 +93,41 @@ in `Rails.application` and these functions use `axios`. You may change it:
 
     # Exclude all route paths matching regexpes.
     # Empty array: do not exclude any routes (default).
-    exclude: [/edit|new/]
+    exclude: [/edit|new/],
+
+    # 'null' or the name of function defined or imported in this file.
+    #
+    # This function will be called before doing requests. It accepts
+    # `url`, `options`, `route`, `params` and should return `options`.
+    #
+    # You may use it to add options before performing request or for logging
+    # requests.
+    #
+    # Default: 'null' (no function).
+    set_options: 'null'
   )
 %>
+```
+```js
+import axios from 'axios'
 
-import axios from 'axios';
+// For example, pass all requests to subdomain `api`.
 const axios_api = axios.create({
-  baseURL: `${document.location.origin}/api/`
+  baseURL: `${document.location.protocol}//api.${document.location.host}/`
 })
 
-function request_api(route, params) {
-  return axios_api.request({
+function request_api(route, params, set_options) {
+  let options = {
     url:    params.path,
     method: route.verb,
     params: params.url_options,
     data:   params.data
-  })
+  }
+
+  if (typeof set_options === 'function')
+    options = set_options(params.path, options, route, params)
+  
+  return axios_api.request(options)
 }
 ```
 
@@ -146,8 +145,9 @@ namespace :my do
 end
 ```
 
-To make XHR requests with promises you may do this in JS
-([axios](https://github.com/axios/axios) required):
+Assume you have generated object with routes in JS file `lib/routes`.
+
+You may do this in JS to call requests:
 
 ```js
 import Routes from 'lib/routes'
@@ -155,48 +155,55 @@ import Routes from 'lib/routes'
 // Request all favourites and print to console. Note: using namespace `my`.
 // It will call `My::FavouritesController#index`.
 // Path: '/my/favourites'.
-Routes.my_favourites().then(response => console.log(response.data))
+Routes.my_favourites().then(resp => console.log(resp.data))
 
 // Request all news and print to console.
 // String `index` appended to distinguish `index` and `show` actions.
 // It will call `NewsController#index`.
 // Path: '/news'.
-Routes.news_index().then(response => console.log(response.data))
+Routes.news_index().then(resp => console.log(resp.data))
 
 // Request all news filtered by date, and print to console.
 // `NewsController#index` with param `date` in query string (GET).
 // Path: '/news' with query string '?date=2020-12-31'.
-Routes.news_index({date: '2020-12-31'}).then(response => console.log(response.data))
+Routes.news_index({date: '2020-12-31'}).then(resp => console.log(resp.data))
 
 // Request one news and print to console.
 // `NewsController#show` with param `id` = 327 (GET).
 // Path: '/news/327'.
-Routes.news(327).then(response => console.log(response.data))
+Routes.news(327).then(resp => console.log(resp.data))
 // Or
-Routes.news({id: 327}).then(response => console.log(response.data))
+Routes.news({id: 327}).then(resp => console.log(resp.data))
 
 // Specify format (for example, '.json').
 // `NewsController#show` with param `id` = 327 (GET) and `format` = 'json'.
 // Path: '/news/327.json'.
-Routes.news(327, {format: 'json'}).then(response => console.log(response.data))
+Routes.news(327, {format: 'json'}).then(resp => console.log(resp.data))
 // Or
-Routes.news({id: 327, format: 'json'}).then(response => console.log(response.data))
+Routes.news({id: 327, format: 'json'}).then(resp => console.log(resp.data))
 
 // Create news with given title.
 // `NewsController#create` with param `title` (POST).
-Routes.create_news({title: 'Bears showed up in Tomsk'}).then(response => console.log(response.data))
+Routes.create_news({title: 'Bears showed up in Tomsk'}).then(resp => {
+  console.log(resp.data)
+})
 
 // Create message with given title. Note: `message`, singular form.
 // `MessagesController#create` with params `body`, `to` (POST).
-Routes.create_message({body: 'Fantastic!', to: 23}).then(response => console.log(response.data))
+Routes.create_message({body: 'Fantastic!', to: 23}).then(resp => {
+  console.log(resp.data)
+})
 
 // Create message with given title. Note: using namespace `my`.
 // `My::FavouritesController#create` with param `url` (POST).
-Routes.create_my_favourite({url: 'https://best.site'}).then(response => console.log(response.data))
+Routes.create_my_favourite({url: 'https://best.site'}).then(resp => {
+  console.log(resp.data)
+})
 
 // Attach an image to the news.
-// `ImageController#create` with param `news_id` = 41 (GET), `blob` (POST).
-Routes.create_news_image(41, {blob: file})
+// `ImageController#create` with params `news_id` = 41 (GET),
+// `my_attachment` (POST).
+Routes.create_news_image(41, {my_attachment: file})
 
 // Get URL for `create` action.
 Routes.create_my_favourite_path() // => 'my/favourites'
@@ -204,26 +211,29 @@ Routes.create_my_favourite_path() // => 'my/favourites'
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies.
+Then, run `rake spec` to run the tests. You can also run `bin/console` for
+an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`.
 
 TODO:
 
-- Support [fetch](https://developer.mozilla.org/ru/docs/Web/API/Fetch_API/Using_Fetch)
-- Tests
+:white_check_mark: Support fetch — done!\
+:black_square_button: Tests
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at [github.com/crosspath/railbus](https://github.com/crosspath/railbus).
+Bug reports and pull requests are welcome on GitHub at
+[github.com/crosspath/railbus](https://github.com/crosspath/railbus).
 
 Please do not change version number in pull requests.
 
 ## Alternative solutions
 
 1. [rswag](https://github.com/rswag/rswag) +
-  [swagger-js](https://github.com/swagger-api/swagger-js) +
-  your integration specs (tests)
+   [swagger-js](https://github.com/swagger-api/swagger-js) +
+   your integration specs (tests)
 2. [railsware/js-routes](https://github.com/railsware/js-routes)
 3. [mtrpcic/js-routes](https://github.com/mtrpcic/js-routes)
 4. [less-js-routes](https://github.com/stevenbristol/less-js-routes)
@@ -231,4 +241,5 @@ Please do not change version number in pull requests.
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of
+the [MIT License](https://opensource.org/licenses/MIT).

data/lib/generators/railbus/install_generator.rb

@@ -6,7 +6,7 @@ module Railbus
       desc 'Install dependencies and example file with routes'
 
       def install
-        exit unless run 'yarn add @crosspath/yambus axios'
+        exit unless run 'yarn add @crosspath/yambus @crosspath/yambus-axios'
 
         create_file('app/javascript/lib/routes.js.erb') do |f|
           <<-LINE

data/lib/railbus.rb

@@ -9,11 +9,14 @@ require_relative 'railbus/route_set_presenter'
 module Railbus
   module_function
 
+  CLIENTS = %w[axios fetch]
+
   def generate(
-    app:     Rails.application,
-    client:  'axios',
-    include: [],
-    exclude: []
+    app:         Rails.application,
+    client:      'axios',
+    include:     [],
+    exclude:     [],
+    set_options: 'null'
   )
     route_set   = RouteSet.new(app, include, exclude)
     routes_json = Railbus::RouteSetPresenter.to_h(route_set).to_json
@@ -21,7 +24,7 @@ module Railbus
     js_template = File.join(__dir__, 'railbus', 'templates', 'js.erb')
     erb_engine  = Erubi::Engine.new(File.read(js_template))
 
-    # Template uses `routes_json`, `client`
+    # Template uses `routes_json`, `client`, 'set_options'
     client = client.to_s
     eval(erb_engine.src)
   end

data/lib/railbus/route_set.rb

@@ -23,9 +23,14 @@ class Railbus::RouteSet
   private
 
   def paths_for_app(app, include, exclude)
+    mounted_at = app.routes.find_script_name({})
+
     app.routes.set.routes.map do |route|
-      formatter   = route.instance_variable_get(:@path_formatter)
-      route_parts = parts_combined(formatter.instance_variable_get(:@parts))
+      formatter = route.instance_variable_get(:@path_formatter)
+      raw_parts = formatter.instance_variable_get(:@parts)
+      raw_parts.unshift(mounted_at)
+
+      route_parts = parts_combined(raw_parts)
 
       path = join_parts(route_parts)
       next nil unless include_path?(path, include, exclude)

data/lib/railbus/templates/js.erb

@@ -1,7 +1,6 @@
 import yambus from '@crosspath/yambus'
-
-<% if client == 'axios' %>
-import axios from 'axios'
+<% if Railbus::CLIENTS.include?(client) %>
+import { request } from '@crosspath/yambus-<%= client %>'
 <% end %>
 
 const routes = <%= routes_json.html_safe %>
@@ -10,15 +9,10 @@ const route_functions = yambus.generate_route_functions(
   routes,
   (route, args) => {
     const params = yambus.build_request_options(route, args)
-    <% if client == 'axios' %>
-    return axios.request({
-      url:    params.path,
-      method: route.verb,
-      params: params.url_options,
-      data:   params.data
-    })
+    <% if Railbus::CLIENTS.include?(client) %>
+    return request(route, params, <%= set_options %>)
     <% else %>
-    return <%= client %>(route, params)
+    return <%= client %>(route, params, <%= set_options %>)
     <% end %>
   }
 )

data/lib/railbus/version.rb

@@ -1,3 +1,3 @@
 module Railbus
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: railbus
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Evgeniy Nochevnov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-31 00:00:00.000000000 Z
+date: 2020-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport