railbus 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cbcb54ddcd018a65bb1345be55f6433656109be6fa47d5bcfb20f86114130d27
-  data.tar.gz: 7321d65b3ac0b95912d9d4ea2580cf7ecdb5719264f8a0bd9c7f6e0059ef8a13
+  metadata.gz: eca04d46928b46af6ee37969c8cd9e34ffa535ae8295b9a3efba843c4a1fbe32
+  data.tar.gz: a708f98d5b39524baf0888bd96f458df8a6dbc63e97a1827447fd2423ffeb03a
 SHA512:
-  metadata.gz: 6c00077aaa236f244565a3e87691a594e309806248ad36de5de5e3ba51379fe880e1406d1ac61ca895c683e713062d3ea3c1e80c3dc2c3450e7c4fd0db9961d6
-  data.tar.gz: 7a1c090bd7163c9c2aa01c2e2098c71870d4a7f494aa1f3f231a8220787fc61f027b7fb59b15e16467931712875f29fd112126ce60a5351f363ca8560daaf593
+  metadata.gz: b3f9a587e3d6658f6cacda733db67d37af4d8b2d8316e9d63f11f0a0899e54ad24b2d124a4f8750536786a923faa0200dd6a1c3025f926230d2257a8f3a6cca3
+  data.tar.gz: 35964ef3fd6e599cfca9aee232abc332d9ebf86ba072b1efde5fd5ad43aef1ad5c8670f268bef98ff3f4d2796cb25091a14357605bbc70647691ae7cba3f1001

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+# Version 0.1.2
+
+Extract JavaScript generators to NPM package called 'yambus'.
+Added Rails generator: `rails g railbus:install`.
+
 # Version 0.1.1
 
 Change prefix for `delete` routes from `destroy_` to `delete_`.

data/README.md

@@ -22,8 +22,15 @@ Or install it yourself as:
 
     $ gem install railbus
 
-To use it with Webpack, create `*.js.erb` file in `app/javascript`
-(e.g. `lib/routes.js.erb`):
+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`)
+   to use it with Webpack:
 
 ```erb
 /* rails-erb-loader-dependencies ../config/routes */
@@ -63,7 +70,7 @@ Here `String or Number, ...` represents values used in paths, e.g.
 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.
+`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.
 

data/lib/generators/railbus/install_generator.rb

@@ -0,0 +1,22 @@
+require 'rails/generators/base'
+
+module Railbus
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      desc 'Install dependencies and example file with routes'
+
+      def install
+        exit unless run 'yarn add @crosspath/yambus axios'
+
+        create_file('app/javascript/lib/routes.js.erb') do |f|
+          <<-LINE
+/* rails-erb-loader-dependencies ../config/routes */
+<%= Railbus.generate %>
+          LINE
+        end
+
+        puts 'Railbus installed!'
+      end
+    end
+  end
+end

data/lib/railbus/templates/js.erb

@@ -1,92 +1,25 @@
-const routes = <%= routes_json.html_safe %>;
+import yambus from '@crosspath/yambus'
 
 <% if client == 'axios' %>
 import axios from 'axios'
-
-function request(route, args) {
-  const params = build_request_options(route, args)
-  return axios.request({
-    url:    params.path,
-    method: route.verb,
-    params: params.url_options,
-    data:   params.data
-  })
-}
-<% else %>
-function request(route, args) {
-  const params = build_request_options(route, args)
-  return <%= client %>(route, params)
-}
 <% end %>
 
-const request_functions = Object.fromEntries(
-  Object.entries(routes).map(pair => {
-    const route = pair[1]
-    const func  = (...args) => request(route, args)
-    return [pair[0], func]
-  })
-)
-
-const path_functions = Object.fromEntries(
-  Object.entries(routes).map(pair => {
-    const route = pair[1]
-    const func  = (...args) => build_request_options(route, args).path
-    return [`${pair[0]}_path`, func]
-  })
-)
-
-export default Object.assign({}, request_functions, path_functions)
-
-function split_args(route, args) {
-  const required_params = route.required
-  let path_params = {}, url_options = {}, data = {}
-  for (let index in args) {
-    const arg = args[index]
-    if (['string', 'number'].includes(typeof arg)) {
-      path_params[required_params[index]] = arg
-    } else {
-      break
-    }
+const routes = <%= routes_json.html_safe %>
+
+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
+    })
+    <% else %>
+    return <%= client %>(route, params)
+    <% end %>
   }
-  let options = args[Object.keys(path_params).length]
-  data = args[Object.keys(path_params).length + 1]
-  if (typeof options !== 'object')
-    options = {}
-  if (typeof data !== 'object')
-    data = {}
-  for (let param of required_params) {
-    if (!(param in path_params)) {
-      if (param in options) {
-        path_params[param] = options[param]
-      } else {
-        throw new Error(required_param(route, param))
-      }
-    }
-  }
-  const format = presence(options.format)
-  const extracted = required_params.concat(['format'])
-  url_options = Object.fromEntries(
-    Object.entries(options).filter(pair => !extracted.includes(pair[0]))
-  )
-  return {path_params, format, url_options, data}
-}
-
-function presence(v) {
-  return (v != null && v !== '') ? v : null
-}
-
-function required_param(route, param) {
-  return `Cannot find "${param}" in passed URL options. `+
-      `This value is required for route "${route.name}" (${route.path}).`;
-}
-
-function build_request_options(route, args) {
-  const params = split_args(route, args)
-  let path = route.parts.
-      map(v => typeof v === 'string' ? v : params.path_params[v.a]).join('')
-  if (params.format)
-    path += `.${params.format}`
-  if (['get', 'delete'].includes(route.verb))
-    params.data = null
-  return {path: path, url_options: params.url_options, data: params.data}
-}
+)
+export default route_functions

data/lib/railbus/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: railbus
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Evgeniy Nochevnov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-22 00:00:00.000000000 Z
+date: 2020-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -69,6 +69,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- lib/generators/railbus/install_generator.rb
 - lib/railbus.rb
 - lib/railbus/route_set.rb
 - lib/railbus/route_set_presenter.rb