enroute 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69b21678657d7b4e22392bb0fc93d825146f9af0ff90bcdbc5e356e8492cfb14
-  data.tar.gz: 3cef2464c5fbd9fa7e14a1a321e8a3f054c45ef4f92f9c1dd1814aeeaa0246ab
+  metadata.gz: 0a1933a0b54db509a086908e62c6c1c0cd32baa72fbeba4f2b19e180f179b7e0
+  data.tar.gz: 65cd118dfb50f62b13b43fc2fe6ec95f3ada98d0d15947a7261f2858ae8b4b83
 SHA512:
-  metadata.gz: 8802edb40c7a1e1ca283bda49f8aa7eb1cc5e68dd13f0234b77a7dcd4f51310fd64fc57a9a6276e4383b4ce78ea691ac4ad53e8b878c7ed9278425936adbf455
-  data.tar.gz: b96ce752c8b775de0b699e3368ef121e98cf66813a052db033084c2def29a54d9fad4d545ceee6cd7c2ae31b8f63393356e68c23b9faaa21d009391b8801b117
+  metadata.gz: 24398ef1734fe1964932aee1c3e5ea29efe4ff73a11e99612eadcc55579b31b0c8611e54e4a46a030059efbfcc597b4372d97fc856c62c420fb0dcb61f92419e
+  data.tar.gz: 23d765635d12a58a14a263cc5cbf595d814b4443a46fceef1fab4cd61b93519e86b0d2e74e526639abd93749f0e1764a8a9409dec4dba73bf0267f7393e92407

data/.github/FUNDING.yml

@@ -0,0 +1 @@
+github: [fnando]

data/.gitignore

@@ -8,4 +8,5 @@
 /tmp/
 /node_modules
 /test/enroute/routes.ts
+/test/enroute/routes_with_config.ts
 *.lock

data/.rubocop.yml

@@ -4,8 +4,7 @@ inherit_gem:
 
 AllCops:
   TargetRubyVersion: 2.7
+  NewCops: enable
 
-Metrics/BlockLength:
-  Exclude:
-    - test/**/*.rb
-    - "*.gemspec"
+Metrics:
+  Enabled: false

data/.tool-versions

@@ -1 +1 @@
-nodejs 12.16.0
+nodejs 16.7.0

data/README.md

@@ -25,16 +25,55 @@ All you have to do is call the `enroute` binary with the main file you want to
 load and a output path.
 
 ```console
-$ bundle exec enroute --output ./app/frontend/scripts/config/routes.ts
+$ bundle exec enroute export --output ./app/frontend/scripts/config/routes.ts
 ```
 
 By default, `<pwd>/config/environment.rb` will be loaded. If you want to use a
 different file, use the `--require` switch.
 
 ```console
-$ bundle exec enroute --require ./different-file.rb --output ./routes.ts
+$ bundle exec enroute export --require ./different-file.rb --output ./routes.ts
 ```
 
+You can also ignore routes by using a config file.
+
+```console
+$ bundle exec enroute export --output ./app/frontend/scripts/config/routes.ts --config ./config/enroute.yml
+```
+
+The config file must look like this:
+
+```yaml
+---
+ignore:
+  - route_name
+```
+
+There's also a `:only` option that will include only the matching named routes.
+
+```yaml
+---
+only:
+  - route_name
+```
+
+By default, route params will be typed as `any`. To add a custom typing
+annotation, you can use the `typings` key on the configuration file. Imagine you
+have the route `get "settings/edit(/:section)" => "", as: "edit_settings"`; you
+can have a config file like this:
+
+```yaml
+---
+typings:
+  _default:
+    format: '"html" | "json"'
+
+  edit_settings:
+    section: string
+```
+
+### Importing helpers on TypeScript
+
 You can then import any route that's been exported. Parameters are positional.
 
 ```typescript

data/enroute.gemspec

@@ -7,6 +7,7 @@ Gem::Specification.new do |spec|
   spec.version       = Enroute::VERSION
   spec.authors       = ["Nando Vieira"]
   spec.email         = ["me@fnando.com"]
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
 
   spec.summary       = "Export Rails routes to TypeScript definitions"
   spec.description   = spec.summary
@@ -27,9 +28,11 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) {|f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "activesupport"
   spec.add_dependency "thor"
   spec.add_development_dependency "minitest"
   spec.add_development_dependency "minitest-utils"
+  spec.add_development_dependency "pry-meta"
   spec.add_development_dependency "rails"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rubocop"

data/lib/enroute/cli.rb

@@ -24,12 +24,19 @@ module Enroute
            required: true,
            aliases: :o
 
+    option :config,
+           type: :string,
+           required: false,
+           aliases: :c,
+           default: File.join(Dir.pwd, "config/enroute.yml")
+
     def export
       require_path = File.expand_path(options["require"])
       output_path = File.expand_path(options["output"])
+      config_path = File.expand_path(options["config"])
 
       require require_path
-      Export.call(output_path)
+      Export.call(output_path, config_path)
     end
   end
 end

data/lib/enroute/export.rb

@@ -1,25 +1,36 @@
 # frozen_string_literal: true
 
 module Enroute
-  module Export
-    extend self
+  class Export
+    attr_reader :output_path, :config_path
 
-    def call(output_path)
-      FileUtils.mkdir_p(File.dirname(output_path))
+    def self.call(output_path, config_path)
+      new(output_path, config_path).call
+    end
 
-      write_template(output_path)
+    def initialize(output_path, config_path)
+      @output_path = output_path
+      @config_path = config_path
+    end
+
+    def config
+      @config ||= if File.file?(config_path)
+                    ActiveSupport::HashWithIndifferentAccess.new(
+                      YAML.load_file(config_path)
+                    )
+                  else
+                    {}
+                  end
     end
 
-    def params
-      {
-        routes: routes,
-        types: routes.map {|route| build_ts_definition(route) }.join("\n"),
-        router_type: routes.map {|route| build_ts_route_definition(route) }.join
-      }
+    def call
+      FileUtils.mkdir_p(File.dirname(output_path))
+
+      write_template(output_path)
     end
 
     def routes
-      Routes.call
+      @routes ||= Routes.call(config)
     end
 
     def write_template(output_path)
@@ -30,50 +41,42 @@ module Enroute
 
     def route_functions
       routes
-        .each_with_index
-        .map {|route, index| build_ts_function(route, index) }
+        .map {|route| build_ts_route_function(route) }
         .join("\n\n")
     end
 
-    def router_type_definitions
-      routes.map {|route| build_ts_route_definition(route) }.join
-    end
-
-    def type_definitions
-      routes.map {|route| build_ts_definition(route) }.join("\n")
+    def handler_functions
+      routes.map {|route| build_ts_handler_function(route) }.join("\n\n")
     end
 
     def render_template
       ERB.new(File.read("#{__dir__}/template.ts.erb")).result binding
     end
 
-    def build_ts_definition(route)
-      [
-        "export interface #{route[:typeName]} extends RouteHandler {",
-        "  (#{build_ts_args_definition(route)}): string;",
-        "}\n"
-      ].join("\n")
-    end
-
     def build_ts_args_definition(route)
       route[:segments].map do |segment|
+        type = route.dig(:typings, segment)&.chomp ||
+               config.dig(:typings, :_default, segment)&.chomp ||
+               "any"
+
         optional = route[:requiredSegments].include?(segment) ? "" : "?"
-        "#{segment.camelize(:lower)}#{optional}: any"
+        "#{segment.camelize(:lower)}#{optional}: #{type}"
       end.join(", ")
     end
 
-    def build_ts_function(route, index)
+    def build_ts_handler_function(route)
+      args = JSON.pretty_generate(route.except(:typings))
+      %[const #{route[:name]}Handler = buildRoute(#{args});]
+    end
+
+    def build_ts_route_function(route)
       args = build_ts_args_definition(route)
       segments = route[:segments].map {|segment| segment.camelize(:lower) }
 
       [
         %[export const #{route[:name]}Url = (#{args}): string =>],
-        %[  routeHandlers[#{index}](#{segments.join(', ')});]
+        %[  #{route[:name]}Handler(#{segments.join(', ')});]
       ].join("\n")
     end
-
-    def build_ts_route_definition(route)
-      %[\n  #{route[:name]}: #{route[:typeName]};]
-    end
   end
 end

data/lib/enroute/routes.rb

@@ -1,8 +1,16 @@
 # frozen_string_literal: true
 
 module Enroute
-  module Routes
-    extend self
+  class Routes
+    attr_reader :config
+
+    def self.call(config = {})
+      new(config).call
+    end
+
+    def initialize(config)
+      @config = config
+    end
 
     def call
       grouped_routes.each_with_object([]) do |(_pattern, routes), buffer|
@@ -17,12 +25,12 @@ module Enroute
     def build_payload(route)
       {
         name: route.name.camelize(:lower),
-        typeName: "#{route.name.camelize}RouteHandler",
         incomingPattern: camelize_pattern(route),
         outgoingPattern: route.ast.to_s,
         method: reduce_methods(routes),
         segments: route.segments,
-        requiredSegments: route.path.required_names
+        requiredSegments: route.path.required_names,
+        typings: config.dig(:typings, route.name) || {}
       }
     end
 
@@ -48,8 +56,24 @@ module Enroute
     end
 
     def filtered_routes
-      routes.reject do |route|
-        route.name =~ /rails|script/
+      only_conditions = config.fetch(:only, [])
+
+      # If `:only` has at least one item, then select matching routes.
+      # Otherwise, use all routes.
+      selected_routes = if only_conditions.empty?
+                          routes
+                        else
+                          routes.select do |route|
+                            only_conditions.include?(route.name)
+                          end
+                        end
+
+      # Filter out unnamed routes, Rails' internal routes, and anything present
+      # on `:ignore`.
+      selected_routes.reject do |route|
+        route.name.nil? ||
+          route.name.match?(/rails|script/) ||
+          config.fetch(:ignore, []).include?(route.name)
       end
     end
 

data/lib/enroute/template.ts.erb

@@ -90,17 +90,10 @@ function generate(route: Route): RouteHelper {
   };
 }
 
-export type PrimitiveType = number | string | null | undefined | boolean;
-export type ArrayType = AnyObject[];
-export type AnyObject = PrimitiveType | ArrayType | ObjectType | any;
-
-export interface ObjectType {
-  [key: string]: PrimitiveType | ArrayType | ObjectType;
-}
+type PrimitiveType = number | string | null | undefined | boolean;
 
 export interface Route {
   name: string;
-  typeName: string;
   pattern?: string;
   method: string[];
   segments: string[];
@@ -118,12 +111,6 @@ export type RouteHandler = RouteHelper & {
   underscore: RouteHelper;
 };
 
-<%= type_definitions %>
-
-export const routes: Route[] = <%= JSON.pretty_generate(routes) %>;
-
-export const routeHandlers: RouteHandler[] = [
-<%= routes.each_with_index.map {|route, index| %[  buildRoute(routes[#{index}]) as #{route[:typeName]},] }.join("\n") %>
-];
+<%= handler_functions %>
 
 <%= route_functions %>

data/lib/enroute/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Enroute
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/enroute.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require "thor"
+require "active_support/core_ext/hash"
+require "active_support/hash_with_indifferent_access"
 require "fileutils"
 require "erb"
 require "json"

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: enroute
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Nando Vieira
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-02-14 00:00:00.000000000 Z
+date: 2021-08-27 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-meta
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -117,6 +145,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".eslintrc.json"
+- ".github/FUNDING.yml"
 - ".gitignore"
 - ".prettierrc.js"
 - ".rubocop.yml"
@@ -138,7 +167,6 @@ files:
 - lib/enroute/version.rb
 - package.json
 - tsconfig.json
-- yarn.lock
 homepage: https://github.com/fnando/enroute
 licenses:
 - MIT
@@ -146,7 +174,7 @@ metadata:
   homepage_uri: https://github.com/fnando/enroute
   source_code_uri: https://github.com/fnando/enroute
   changelog_uri: https://github.com/fnando/enroute
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -154,15 +182,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: Export Rails routes to TypeScript definitions
 test_files: []