ts_routes 0.9.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0c6d751ca71ca6df642d568421ad9890985e3630
-  data.tar.gz: 32eac32e26dfa6bb697a03e076a615c7e4c4d502
+  metadata.gz: 27b91ef355275cd7f79b055e8493485146c49362
+  data.tar.gz: 2e8d7e12cb04fe15d048b831b60599cb3cbef694
 SHA512:
-  metadata.gz: 7c15b27aa28d02dcf9039523ff8a7614f0774f34c60eec31f2075794987142bdc51619b30d920ac100ef474ce7a4153e1d5c6a708fb2fde5f6fa6a64314e2aae
-  data.tar.gz: 4350847473b664df39f22b15a9ec1fb3bf4cd1d2a0910ed1eba8bbc6330b51ff30e2f52d6f8670d98c37671c026e09f3853275224cae8efdf6f21a68344a90a0
+  metadata.gz: 5a81dce07a3cefa6151604d0b0a5841777632518e9fa5e7aa45dab0e3c2dd4fe6f4c0a512fed4577e1faccffaad64c51764df16bdf2ba275d4a1ea9ef6680c7d
+  data.tar.gz: 399ca6066a7183134f0d5ecf054dd7cfd8d2bfc82f23f7a8a34615e1039da9044de4c8b97aa5d77488e3360257d574be35d26809e9a14baf386b769b86391d87

data/.rubocop.yml

@@ -4,18 +4,16 @@ AllCops:
   Exclude:
     - "vendor/**/*"
     - "node_modules/**/*"
+  DisabledByDefault: true
 
-Style:
-  Enabled: false
+Performance:
+  Enabled: true
 
-Layout:
+Performance/RedundantBlockCall:
   Enabled: false
 
-Metrics:
-  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: true
 
-Bundler:
-  Enabled: false
-
-Performance/RedundantBlockCall:
-  Enabled: false
+Style/EmptyLineAfterMagicComment:
+  Enabled: true

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# The Revision History of TsRoutes
+
+## v1.0.0 2017/06/27
+
+* Initial stable version

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
 # Specify your gem's dependencies in ts_routes.gemspec

data/README.md

@@ -1,14 +1,14 @@
 # TsRoutes for Rails [![Gem Version](https://badge.fury.io/rb/ts_routes.svg)](https://badge.fury.io/rb/ts_routes) [![Build Status](https://travis-ci.org/bitjourney/ts_routes-rails.svg?branch=master)](https://travis-ci.org/bitjourney/ts_routes-rails)
 
-This gem generates Rails URL helpers in TypeScript, inspired by [js-routes](https://github.com/railsware/js-routes).
+This gem generates Rails URL helpers in TypeScript, which is synchronized to `routes.rb`.
 
+This is inspired by [js-routes](https://github.com/railsware/js-routes), which invents the great idea to export URL helpers to JavaScript.
 
 ## Usage
 
 In your `lib/tasks/ts_routes.rake`:
 
-```ruby:ts_routes.rake
-
+```ruby
 namespace :ts do
   TS_ROUTES_FILENAME = "javascripts/generated/routes.ts"
 
@@ -27,9 +27,8 @@ Then, execute `rake ts:routes` to generate `routes.ts` in your favorite path.
 
 And you can import it in TypeScript code:
 
-
-```foo.ts
-import * as Routes from './generated/RailsRoutes.ts';
+```typescript
+import * as Routes from './generated/routes';
 
 console.log(Routes.entriesPath({ page: 1, per: 20 })); // => /entries?page=1&per=20
 console.log(Routes.entryPath(1)); // => /entries/1
@@ -39,10 +38,41 @@ Generated URL helpers are almost compatible with Rails, but they are more strict
 
 * You must pass required parameters to the helpers as non-named (i.e. normal) arguments
   * i.e. `Routes.entryPath(1)` for `/entries/:id`
-  * `Routes.entryPath({ id })` is refused
+  * `Routes.entryPath({ id })` is not allowed
+* Required parameters must not be `null` nor `undefined`
+  * i.e. `Routes.entyPath(null)` does not compile
 * You must pass optional parameters as the last argument
   * i.e. `Routes.entriesPath({ page: 1, per: 2 })`
 
+### Options
+
+Here are options for `TsRoutes.generate`:
+
+<table>
+<tr><th>name</th><th>description</th><th>default</th></tr>
+<tr><td>routes</td><td>Rails routes to export</td><td>Rails.application.routes</td></tr>
+<tr><td>camel_case</td><td>naming style; doesn't change if false</td><td>true</td></tr>
+<tr><td>route_suffix</td><td>suffix for each route</td><td>"path"</td></tr>
+<tr><td>include</td><td>Array of Regexp patterns to include</td><td>nil</td></tr>
+<tr><td>exclude</td><td>Array of Regexp patterns to exclude</td><td>nil</td></tr>
+<tr><td>header</td><td>additional parts of generated files</td><td>"/* tslint:disable */"</td></tr>
+</table>
+
+Note that `TsRoutes.generate(options)` is a shortcut of `TsRoutes::Generator.new(options).generate`.
+
+### How to Keep routes.ts Up-To-Date
+
+Use [Guard](https://github.com/guard/guard):
+
+```ruby
+# In Guardfile
+
+# Run `rake ts:routes` when routes.rb is updated.
+guard :rake, task: 'ts:routes' do
+  watch(%r{config/routes\.rb$})
+end
+```
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -53,11 +83,15 @@ gem 'ts_routes'
 
 And then execute:
 
-    $ bundle
+```console
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install ts_routes
+```console
+$ gem install ts_routes
+```
 
 ## Development
 

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rake/testtask"
 

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "bundler/setup"
 require "ts_routes"

data/lib/ts_routes/generator.rb

@@ -8,7 +8,7 @@ module TsRoutes
     FILTERED_DEFAULT_PARTS = [:controller, :action, :subdomain]
     URL_OPTIONS = [:protocol, :domain, :host, :port, :subdomain]
 
-    DEFAULT_FILE_HEADER = "/* tslint:disable:max-line-length variable-name whitespace */"
+    DEFAULT_FILE_HEADER = "/* tslint:disable */"
 
     # @return [ActionDispatch::Routing::RouteSet]
     attr_reader :routes
@@ -88,8 +88,7 @@ module TsRoutes
     # @param [ActionDispatch::Journey::Route] route
     # @param [ActionDispatch::Journey::Route] parent_route
     def build_route_function(route, parent_route = nil)
-      name_parts = [parent_route&.name, route.name].compact
-      route_name = build_route_name(*name_parts, route_suffix)
+      route_name = build_route_name(parent_route&.name, route.name, route_suffix)
 
       required_param_declarations = route.required_parts.map do |name|
         symbol = find_spec(route.path.spec, name)

data/lib/ts_routes/runtime.ts

@@ -1,6 +1,6 @@
 /* This is generated by ts_routes-rails */
 
-type ScalarType = string | number | boolean;
+export type ScalarType = string | number | boolean;
 
 function $buildOptions(options: any, names: string[]): string {
   if (options) {
@@ -12,7 +12,7 @@ function $buildOptions(options: any, names: string[]): string {
         continue;
       }
 
-      const value = options[ key ];
+      const value = options[key];
 
       if (key === "anchor") {
         anchor = `#${$encode(value)}`;
@@ -33,9 +33,10 @@ function $buildQuery(q: string[], key: string, value: any) {
     for (const v of value) {
       $buildQuery(q, `${key}[]`, v);
     }
-  } else if ($isNotNull(value)) { // i.e. non-null, non-scalar, non-array type
+  } else if ($isNotNull(value)) {
+    // i.e. non-null, non-scalar, non-array type
     for (const k of Object.keys(value)) {
-      $buildQuery(q, `${key}[${k}]`, value[ k ]);
+      $buildQuery(q, `${key}[${k}]`, value[k]);
     }
   }
 }
@@ -49,7 +50,11 @@ function $isNotNull(value: any): boolean {
 }
 
 function $isScalarType(value: any): value is ScalarType {
-  return typeof(value) === "string" || typeof(value) === "number" || typeof(value) === "boolean";
+  return (
+    typeof value === "string" ||
+    typeof value === "number" ||
+    typeof value === "boolean"
+  );
 }
 
 function $isPresent(value: any): boolean {
@@ -57,5 +62,5 @@ function $isPresent(value: any): boolean {
 }
 
 function $hasPresentOwnProperty(options: any, key: string): boolean {
-  return options && options.hasOwnProperty(key) && $isPresent(options[ key ]);
+  return options && options.hasOwnProperty(key) && $isPresent(options[key]);
 }

data/lib/ts_routes/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module TsRoutes
-  VERSION = "0.9.0"
+  VERSION = "1.0.0"
 end

data/lib/ts_routes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative "./ts_routes/version"
 require_relative "./ts_routes/generator"
 

data/package-lock.json

@@ -141,6 +141,12 @@
       "integrity": "sha1-PBrfhx6pzWyUMbbqK9dKD/BVxME=",
       "dev": true
     },
+    "prettier": {
+      "version": "1.4.4",
+      "resolved": "https://registry.npmjs.org/prettier/-/prettier-1.4.4.tgz",
+      "integrity": "sha512-GuuPazIvjW1DG26yLQgO+nagmRF/h9M4RaCtZWqu/eFW7csdZkQEwPJUeXX10d+LzmCnR9DuIZndqIOn3p2YoA==",
+      "dev": true
+    },
     "resolve": {
       "version": "1.3.3",
       "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.3.3.tgz",

data/package.json

@@ -1,8 +1,8 @@
 {
   "name": "ts_routes",
   "version": "1.0.0",
-  "description": "ts_routes-rails JavaScript runtime",
-  "main": "index.js",
+  "description": "ts_routes-rails JavaScript runtime (not a standalone package)",
+  "private": true,
   "directories": {
     "lib": "lib",
     "test": "test"
@@ -11,10 +11,12 @@
     "typescript": "^2.4.0"
   },
   "devDependencies": {
+    "prettier": "*",
     "tslint": "*"
   },
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "format": "prettier --write 'lib/**/*.ts' 'test/**/*.ts'",
+    "test": "rake test"
   },
   "repository": "https://github.com/bitjourney/ts_routes-rails",
   "author": "FUJI Goro",

data/ts_routes.gemspec

@@ -1,4 +1,6 @@
 # coding: utf-8
+# frozen_string_literal: true
+
 lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "ts_routes/version"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ts_routes
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 1.0.0
 platform: ruby
 authors:
 - FUJI Goro (gfx)
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-24 00:00:00.000000000 Z
+date: 2017-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -76,6 +76,7 @@ files:
 - ".gitignore"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md