js_from_routes 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d4be8ed220b3710b57134de5269c2bd823ceb9c796d8df9156d919062c680c1
-  data.tar.gz: 7d7d2c8009889180159e6054192f1a860137107fc0672131befc5b4fa9be0fe0
+  metadata.gz: 8202e9323cb738556cdc4e126c7c343eaae6b01d52a72bdff00eb93b7ab925af
+  data.tar.gz: 3caa18595ef98a85e8dd7f162e0f530d708a464c2bcc1fd823b4cfbaea947af7
 SHA512:
-  metadata.gz: dddde4bcf699938557a19a3cabcf0914a3ba62c75601e4ab14be079b2fa6e8494ff88799fae9e50325bf9adced2b3acd2ba1922089975ec5de31a42bf94c0a5b
-  data.tar.gz: 553f6492bc3ddfed435c4e678986d45b4fc292bfdc09993aef35b0adab40e40ea78219f3f3c2148f6b54ac71ec41fbc57cbfd874654c5a24d9246a0bb51b304a
+  metadata.gz: 3bba34efe8b9a91114708326e556dcdfe7549231d61aeb366bb16759471615f8aedb87692eab8420b0039695b359e02da5be4f974c604a535a4ae19efa131ecc
+  data.tar.gz: f54793177eb17df4e42548775f1dbd935b366f838d49488947100f606008eefc48d96b6ad38c0611d95bc5d267c52a24aead758856ddfdd0c87adc3b745e46bf

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+## JsFromRoutes 1.0.2 (2021-03-10) ##
+
+*   Ensure a default `template.js.erb` ships with the gem.
+
+
+## JsFromRoutes 1.0.1 (2020-06-21) ##
+
+*   Expose `export_setting` in the `Route` API, to support custom workflows.
+
+
+## JsFromRoutes 1.0.0 (2020-06-21) ##
+
+*   Initial Release.

data/README.md

@@ -4,7 +4,7 @@ JS From Rails Routes
 <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="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://codeclimate.com/github/ElMassimo/js_from_routes"><img alt="Maintainability" src="https://codeclimate.com/github/ElMassimo/js_from_routes/badges/gpa.svg"/></a>
-<a href="https://codeclimate.com/github/ElMassimo/js_from_routes"><img alt="Test Coverage" 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="Test Coverage" src="https://codeclimate.com/github/ElMassimo/js_from_routes/badges/coverage.svg"/></a>
 <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://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>
@@ -14,6 +14,8 @@ _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.
 
+Check out [this pull request](https://github.com/ElMassimo/pingcrm-vite/pull/2) to get a sense of how flexible it can be.
+
 ### Why? 🤔
 
 Path helpers in Rails are useful, and make it easier to build urls, avoiding
@@ -26,10 +28,12 @@ With this library, it's possible the enjoy the same benefits in JS:
   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!
+  
+Read more about it in the [blog announcement](https://maximomussini.com/posts/js-from-routes/).
 
 ### Installation 💿
 
-Add this line to your application's Gemfile:
+Add this line to your application's Gemfile in the `development` group:
 
 ```ruby
 gem 'js_from_routes'
@@ -71,16 +75,37 @@ you can use a rake task instead:
 bin/rake js_from_routes:generate
 ```
 
+which can generate code such as:
+
+```js
+import { formatUrl } from '@helpers/UrlHelper'
+import { request } from '@services/ApiService'
+
+export default {
+  downloadPath: options =>
+    formatUrl('/video_clips/:id/download', options),
+
+  get: options =>
+    request('get', '/video_clips/:id', options),
+    
+  update: options =>
+    request('patch', '/video_clips/:id', options),
+}
+```
+
 #### 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:
+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, in combination with [`axios`](https://github.com/axios/axios) or `fetch`:
 
 ```js
 import VideoClipsRequests from '@requests/VideoClipsRequests'
 
-VideoClipsRequests.get({ id: 'oHg5SJYRHA0' }).then(displayVideo)
+VideoClipsRequests.get({ id: 'oHg5SJYRHA0' }).then(data => { this.video = data })
 
-const path = VideoClipsRequests.downloadPath({ id })
+const newVideo = { ...this.video, format: '.mp4' }
+VideoClipsRequests.update(newVideo)
+
+const path = VideoClipsRequests.downloadPath(newVideo)
 ```
 
 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.
@@ -97,7 +122,7 @@ The following [settings](https://github.com/ElMassimo/js_from_routes/blob/master
 ##### [`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.
+if you prefer a different convention, or if you use it to generate TypeScript.
 
 ##### [`helper_mappings`](https://github.com/ElMassimo/js_from_routes/blob/master/lib/js_from_routes/generator.rb#L80)
 
@@ -118,8 +143,10 @@ 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')
+if Rails.env.development?
+  JsFromRoutes.config do |config|
+    config.template_path = Rails.root.join('app', 'views', 'custom_js_from_routes.js.erb')
+  end
 end
 ```
 
@@ -144,9 +171,11 @@ request methods or path helpers 😃
 
 ### Take this idea 💡
 
-There are plenty of opportunities for automatic code generation, such as keeping
+While the original use cases intended to generate code that targes a custom `ApiService`, 
+it can be tweaked to generate TypeScript, [target jQuery](https://gist.github.com/ElMassimo/cab56e64e20ff797f3054b661a883646),
+or use it only to generate [path helpers](https://github.com/ElMassimo/js_from_routes/blob/master/spec/support/sample_app/app/javascript/requests/UserPreferencesRequests.js#L11-L15).
+
+There are plenty of other 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/template.js.erb

@@ -0,0 +1,22 @@
+//
+// DO NOT MODIFY: This file was automatically generated by JsFromRoutes.
+<%
+if routes.any?(&:path_only?)
+  %>import { formatUrl } from '@/helpers/UrlHelper'<%
+end
+%><% if routes.any?(&:path_only?) && routes.any?(&:request_method?) %><%= "\n" %><% end %><%
+if routes.any?(&:request_method?)
+  %>import { request } from '@/services/ApiService'<%
+end
+%>
+
+export default {
+<% routes.each_with_index do |route, index| %>
+<% if index > 0 %><%= "\n" %><% end
+%>  <%= route.helper %>: options =>
+    <% if route.path_only?
+       %>formatUrl(<% else
+       %>request('<%= route.verb %>', <% end
+                                    %>'<%= route.path %>', options),
+<% end %>
+}

data/lib/js_from_routes/version.rb

@@ -4,5 +4,5 @@
 # Generates one file per controller, and one function per route.
 module JsFromRoutes
   # Public: This library adheres to semantic versioning.
-  VERSION = '1.0.1'
+  VERSION = '1.0.2'
 end

data/spec/js_from_routes/js_from_routes_spec.rb

@@ -7,7 +7,7 @@ describe JsFromRoutes do
 
   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(:different_template_path) { File.expand_path('../support/jquery_template.js.erb', __dir__) }
   let(:controllers_with_exported_routes) { %w[Comments UserPreferences VideoClips] }
 
   def file_for(dir, name)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: js_from_routes
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Máximo Mussini
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-22 00:00:00.000000000 Z
+date: 2021-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -62,10 +62,12 @@ extensions: []
 extra_rdoc_files:
 - README.md
 files:
+- CHANGELOG.md
 - README.md
 - lib/js_from_routes.rb
 - lib/js_from_routes/generator.rb
 - lib/js_from_routes/railtie.rb
+- lib/js_from_routes/template.js.erb
 - lib/js_from_routes/version.rb
 - spec/js_from_routes/js_from_routes_spec.rb
 - spec/spec_helper.rb
@@ -96,7 +98,7 @@ homepage: https://github.com/ElMassimo/js_from_routes
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -111,8 +113,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Generate JS automatically from Rails routes.
 test_files: