js_rails_routes 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd2383225d89dcc53076b7dd12b2600c09659dae5ddee39e7da9dd2f7d8d09dd
-  data.tar.gz: a9162a939abd31bd7fe552255846caf6a4ffbcf1ba80737e058bfe868ca2b4c0
+  metadata.gz: e50948437613107c257fb18c1207d97578746364aec3cb07ca8a93b8bcab3102
+  data.tar.gz: 845917a81764d9f13531fb4a8498d4c8c71fee5b432c326b1fa31f5767c9d1ce
 SHA512:
-  metadata.gz: 1c900ddad4563c435937edba1c072a299438a80290b6cd77b48f2a00493c37919a987606ed7c8a7784480dcbfd2a85c52f9ce50f59b5896914165ea6bd5d1255
-  data.tar.gz: c27c9ce37e7d8de9031cdc13ff2c412c4ecc627f54183f67a478dd99d5dde4dde7e6c444320c7794a2e03156af22bb3c0a82b7293a359c37b33e50e4c9bd1e14
+  metadata.gz: d38cfab4a3d127c3423345a1c4c56b72d24b198909b4f294b0b83055ce73a7175a7ce66767eb22187beab6300a5909e554c9e1609cdcd8fcf9a2ec5f77c8d12e
+  data.tar.gz: 8fd42be0a4fbb917cef7719de28a9fc5013cbd4cd1022399194d42fa40cbae9e59236944af31b6b6d64dcdec064e51f9fe30f26e892a0214619498acde6e3ad9

data/.github/workflows/test.yml

@@ -15,7 +15,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: ['ubuntu-18.04', 'ubuntu-latest', 'macos-latest']
+        os: ['ubuntu-20.04', 'ubuntu-latest', 'macos-latest']
         ruby: [2.6, 2.7, 3.0, 3.1]
         experimental: [false]
         include:
@@ -27,7 +27,7 @@ jobs:
     steps:
       - name: Get branch names
         id: branch-name
-        uses: tj-actions/branch-names@v4.9
+        uses: tj-actions/branch-names@v7.0.7
       - uses: actions/checkout@v2
       - uses: ruby/setup-ruby@v1
         with:

data/CHANGELOG.md

@@ -6,6 +6,15 @@ This change log adheres to [keepachangelog.com](http://keepachangelog.com).
 
 ## [Unreleased]
 
+## [1.2.0] - 2024-04-19
+### Added
+- Add support for parameters as Array
+
+## [1.1.0] - 2024-02-09
+### Changed
+- Add eslint-disable comment not to affect eslint format
+- Update generated scripts to adopt eslint rule
+
 ## [1.0.0] - 2022-05-13
 
 ### Changed
@@ -89,7 +98,9 @@ This change log adheres to [keepachangelog.com](http://keepachangelog.com).
 ### Added
 - Implement "js:rails:routes" task
 
-[Unreleased]: https://github.com/increments/js_rails_routes/compare/v1.0.0...HEAD
+[Unreleased]: https://github.com/increments/js_rails_routes/compare/v1.2.0...HEAD
+[1.2.0]: https://github.com/increments/js_rails_routes/compare/v1.1.0...v1.2.0
+[1.1.0]: https://github.com/increments/js_rails_routes/compare/v1.0.0...v1.1.0
 [1.0.0]: https://github.com/increments/js_rails_routes/compare/v0.10.1...v1.0.0
 [0.10.1]: https://github.com/increments/js_rails_routes/compare/v0.10.0...v0.10.1
 [0.10.0]: https://github.com/increments/js_rails_routes/compare/v0.9.0...v0.10.0

data/README.md

@@ -38,7 +38,7 @@ then `rake js:routes` generates "app/assets/javascripts/rails-routes.js" as:
 // Don't edit manually. `rake js:routes` generates this file.
 function process(route, params, keys) {
   var query = [];
-  for (var param in params) if (params.hasOwnProperty(param)) {
+  for (var param in params) if (Object.prototype.hasOwnProperty.call(params, param)) {
     if (keys.indexOf(param) === -1) {
       query.push(param + "=" + encodeURIComponent(params[param]));
     }

data/lib/js_rails_routes/generator.rb

@@ -17,7 +17,11 @@ module JSRailsRoutes
     def generate(task)
       builder.build.each do |artifact|
         file_name = File.join(config.output_dir, artifact.file_name)
-        file_body = "// Don't edit manually. `rake #{task}` generates this file.\n#{artifact.body}"
+        file_body = <<~FILE_BODY.chomp
+          /* eslint-disable */
+          // Don't edit manually. `rake #{task}` generates this file.
+          #{artifact.body}
+        FILE_BODY
         writable.write(file_name, file_body)
       end
     end

data/lib/js_rails_routes/language/javascript.rb

@@ -9,9 +9,15 @@ module JSRailsRoutes
       PROCESS_FUNC = <<~JAVASCRIPT
         function process(route, params, keys) {
           var query = [];
-          for (var param in params) if (params.hasOwnProperty(param)) {
+          for (var param in params) if (Object.prototype.hasOwnProperty.call(params, param)) {
             if (keys.indexOf(param) === -1) {
-              query.push(param + "=" + encodeURIComponent(params[param]));
+              if (Array.isArray(params[param])) {
+                for (var value of params[param]) {
+                  query.push(param + "[]=" + encodeURIComponent(value));
+                }
+              } else {
+                query.push(param + "=" + encodeURIComponent(params[param]));
+              }
             }
           }
           return query.length ? route + "?" + query.join("&") : route;

data/lib/js_rails_routes/language/typescript.rb

@@ -7,14 +7,20 @@ module JSRailsRoutes
   module Language
     class TypeScript < JavaScript
       PROCESS_FUNC = <<~TYPESCRIPT
-        type Value = string | number
+        type Value = string | number | (string | number)[];
         type Params<Keys extends string> = { [key in Keys]: Value } & Record<string, Value>
         function process(route: string, params: Record<string, Value> | undefined, keys: string[]): string {
           if (!params) return route
           var query: string[] = [];
-          for (var param in params) if (params.hasOwnProperty(param)) {
+          for (var param in params) if (Object.prototype.hasOwnProperty.call(params, param)) {
             if (keys.indexOf(param) === -1) {
-              query.push(param + "=" + encodeURIComponent(params[param].toString()));
+              if (Array.isArray(params[param])) {
+                for (var value of params[param] as (string | number)[]) {
+                  query.push(param + "[]=" + encodeURIComponent(value.toString()));
+                }
+              } else {
+                query.push(param + "=" + encodeURIComponent(params[param].toString()));
+              }
             }
           }
           return query.length ? route + "?" + query.join("&") : route;

data/lib/js_rails_routes/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JSRailsRoutes
-  VERSION = '1.0.0'
+  VERSION = '1.2.0'
 end

data/spec/js_rails_routes/language/javascript_spec.rb

@@ -12,9 +12,15 @@ RSpec.describe JSRailsRoutes::Language::JavaScript do
       expect(subject).to eq <<~JAVASCRIPT
         function process(route, params, keys) {
           var query = [];
-          for (var param in params) if (params.hasOwnProperty(param)) {
+          for (var param in params) if (Object.prototype.hasOwnProperty.call(params, param)) {
             if (keys.indexOf(param) === -1) {
-              query.push(param + "=" + encodeURIComponent(params[param]));
+              if (Array.isArray(params[param])) {
+                for (var value of params[param]) {
+                  query.push(param + "[]=" + encodeURIComponent(value));
+                }
+              } else {
+                query.push(param + "=" + encodeURIComponent(params[param]));
+              }
             }
           }
           return query.length ? route + "?" + query.join("&") : route;

data/spec/js_rails_routes/language/typescript_spec.rb

@@ -10,14 +10,20 @@ RSpec.describe JSRailsRoutes::Language::TypeScript do
 
     it 'returns a typescript function' do
       expect(subject).to eq <<~TYPESCRIPT
-        type Value = string | number
+        type Value = string | number | (string | number)[];
         type Params<Keys extends string> = { [key in Keys]: Value } & Record<string, Value>
         function process(route: string, params: Record<string, Value> | undefined, keys: string[]): string {
           if (!params) return route
           var query: string[] = [];
-          for (var param in params) if (params.hasOwnProperty(param)) {
+          for (var param in params) if (Object.prototype.hasOwnProperty.call(params, param)) {
             if (keys.indexOf(param) === -1) {
-              query.push(param + "=" + encodeURIComponent(params[param].toString()));
+              if (Array.isArray(params[param])) {
+                for (var value of params[param] as (string | number)[]) {
+                  query.push(param + "[]=" + encodeURIComponent(value.toString()));
+                }
+              } else {
+                query.push(param + "=" + encodeURIComponent(params[param].toString()));
+              }
             }
           }
           return query.length ? route + "?" + query.join("&") : route;

data/spec/js_rails_routes_spec.rb

@@ -42,6 +42,7 @@ RSpec.describe JSRailsRoutes do
         subject
 
         expect(File.read(app_root.join('app/assets/javascripts/rails-routes.js'))).to eq <<~JAVASCRIPT
+          /* eslint-disable */
           // Don't edit manually. `rake #{task}` generates this file.
           #{JSRailsRoutes::Language::JavaScript::PROCESS_FUNC}
           export function blogs_path(params) { return process('/blogs', params, []); }
@@ -55,6 +56,7 @@ RSpec.describe JSRailsRoutes do
         JAVASCRIPT
 
         expect(File.read(app_root.join('app/assets/javascripts/admin-routes.js'))).to eq <<~JAVASCRIPT
+          /* eslint-disable */
           // Don't edit manually. `rake #{task}` generates this file.
           #{JSRailsRoutes::Language::JavaScript::PROCESS_FUNC}
           export function notes_path(params) { return process('/notes', params, []); }
@@ -94,6 +96,7 @@ RSpec.describe JSRailsRoutes do
         subject
 
         expect(File.read(app_root.join('app/assets/javascripts/rails-routes.ts'))).to eq <<~TYPESCRIPT
+          /* eslint-disable */
           // Don't edit manually. `rake #{task}` generates this file.
           #{JSRailsRoutes::Language::TypeScript::PROCESS_FUNC}
           export function blogs_path(params?: Record<string, Value>) { return process('/blogs', params, []); }
@@ -107,6 +110,7 @@ RSpec.describe JSRailsRoutes do
         TYPESCRIPT
 
         expect(File.read(app_root.join('app/assets/javascripts/admin-routes.ts'))).to eq <<~TYPESCRIPT
+          /* eslint-disable */
           // Don't edit manually. `rake #{task}` generates this file.
           #{JSRailsRoutes::Language::TypeScript::PROCESS_FUNC}
           export function notes_path(params?: Record<string, Value>) { return process('/notes', params, []); }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: js_rails_routes
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Qiita Inc.
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-13 00:00:00.000000000 Z
+date: 2024-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -170,7 +170,7 @@ dependencies:
     - - "!="
       - !ruby/object:Gem::Version
         version: 0.19.1
-description: 
+description:
 email:
 - engineers@qiita.com
 executables: []
@@ -219,7 +219,7 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -234,8 +234,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.4.1
+signing_key:
 specification_version: 4
 summary: Generate a ES6 module that contains Rails routes.
 test_files: []