ts_schema 0.1.12 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8602c4a7ca10962ac35fd7c64a18d0669ed3f7d1ecdfdf7bc9c29a258bff754a
-  data.tar.gz: 322d779a986f2edf18d53829a6a8669326732be7aa4080567d2f4a1ecb1ebac0
+  metadata.gz: cf11b26c1cf7b979dc749c5ed2a7cd5c6f580a1d93d715dc684a3dd11cdf0f1d
+  data.tar.gz: 671e245c29ff9511be5db1f83815bfe6553bccea06021eaabe86414e9f034fff
 SHA512:
-  metadata.gz: 88fd048bbffe0eb93ac910bdcaf456a35e4ded1bf934dab9330d5ad1dba4d57ad3106c07a549a92555f312fe4d713d1b1b4b8c7d29d3909d85a7062df96e6426
-  data.tar.gz: 4c778296ba8de708bf9539bdcd163d79370c0477600d2bdbfd98a0e5c0355d3e02872728452be964922032cc880b3ac92ee270f40269e251734fb48ebfb74bcb
+  metadata.gz: 39fd032dd6b861491e69439e46ca7d0150455795f6c3c85e192d14720f2b9299471ec9c333f8dddeb6e41f3eeae2759e3b6beed2c989c4f51d805340277e14e5
+  data.tar.gz: 938c2fd5b9bc1320e56a5db9444a644473909f876de0c9561d04af0245c2b91e2e9ec5f3feb4d1cd619d490e77317631334c3d458e76ec036080ebd6a736be36

data/README.md

@@ -16,9 +16,9 @@ rails generate ts_schema:install
 
 ## Usage
 
-All options with their defaults are in the config file.
+All options with their defaults are in the generated initializer file.
 
-By default, every migration, rollback, reset or setup task will auto generate a new schema file, replacing the existing one. You can disable this behavior in the config file.
+By default, every migration will auto generate a new schema file, replacing the existing one. You can disable this behavior in the config file.
 
 You can manually generate the schema file by running:
 
@@ -26,9 +26,51 @@ You can manually generate the schema file by running:
 rails ts_schema:generate
 ```
 
+### Default type mappings
+
+|Ruby Type|Typescript Type|
+|:---|:---|
+|string|string|
+|text|string|
+|integer|number|
+|enum|number|
+|bigint|number|
+|float|number|
+|decimal|number|
+|json|Record<string, any>|
+|jsonb|Record<string, any>|
+|binary|string|
+|boolean|boolean|
+|date|string|
+|datetime|string|
+|timestamp|string|
+|datetime_with_timezone|string|
+|inet|string|
+|cidr|string|
+|macaddr|string|
+
+### Initializer options
+
+|Option|Default|Values|Description|
+|---|---|---|---|
+|case              |`:camel`|`:camel`<br/>`:snake`<br/>`:pascal`|camelCase<br/>snake_case<br/>PascalCase|
+|output            |`Rails.root.join('app', 'assets', 'javascripts', 'schema.d.ts')`|Any path|Path to output generated file|
+|auto_generate     |`true`|`boolean`|Whether to automatically (re)generate the defenitions after running migrations|
+|custom_types      |`{}`|`{ ruby_type: 'typescriptType' }`|Use to add or override type mappings for any type|
+|default_type      |`:string`|Any typescript type|The default output type to use if a ruby type is not included in the type mappings|
+|include_associated|`true`|`boolean`|Whether to include associated models as fields on the generated interfaces|
+|parent_classes    |`["ApplicationRecord"]`|Array of string names of top level classes|Any class names included in this array will be querried for subclasses to generate types for|
+|additional_models |`[]`|Array of string names of ActiveRecord models|Add model names which don't inherit from classes included in `parent_classes`, but which should have types generated|
+|field_overrides   |`{ encrypted_password: :password,  password: :optional, }`|Hash of field names with the following values:<br/> `:optional`: Makes it an optional field by adding '?' to the defintion (example: password?: string)<br/>`:omit`: Omits the field from being output in the schema entirely<br/>`[string]`: Field name override. Will replace any instance of the hash key with the value. The default values replace `password` with `encrypted_password`|Overwrite, omit, or make optional any field name. Applies to all generated classes|
+|namespace         |`:schema`|string\|symbol|The typescript namespace to contain generated types|
+|schema_type       |`:interface`|`:interface`\|`:type`|Whether to generate typescript definitions as types or interfaces. Interfaces are recommended since they are easier to extend|
+|indent|`:tab`|`:tab`\|`:space`|Indentation using tabs or spaces|
+|spaces|`2`|number|Number of spaces for indentation if indentation is set to spaces|
+
+
 ## Gotchas
 
-Apparantly, sometimes ActiveRecord's inflections will alter the class name. For instance, with a class named `Five`; `"Fives".singularize` returns "Fife", which is not the classname. In the case where Rails alters the classname for an association, you must explicitly define it on the association in the model using `class_name`. Example: `has_many :fives, class_name: "Five"`.
+Sometimes ActiveRecord's inflections will alter the class name. For instance, with a class named `Five`; `"Fives".singularize` returns "Fife", which is not the classname. In the case where Rails alters the classname for an association, you must explicitly define it on the association in the model using `class_name`. Example: `has_many :fives, class_name: "Five"`.
 
 ## License
 

data/lib/generators/templates/ts_schema.rb

@@ -1,26 +1,5 @@
-# Default type mappings:
-#
-# string:                 string
-# text:                   string
-# integer:                number
-# enum:                   number
-# bigint:                 number
-# float:                  number
-# decimal:                number
-# json:                   Record<string, any>
-# jsonb:                  Record<string, any>
-# binary:                 string
-# boolean:                boolean
-# date:                   string
-# datetime:               string
-# timestamp:              string
-# datetime_with_timezone: string
-# inet:                   string
-# cidr:                   string
-# macaddr:                string
-
 TsSchema.setup do |config|
-  # Case options: camel|snake|pascal
+  # Case options for field names: camel|snake|pascal
   #
   # config.case = :camel
 
@@ -35,7 +14,27 @@ TsSchema.setup do |config|
   # config.auto_generate = true
 
 
-  # Add custom type mappings or overrides
+  # Add custom type mappings or overrides (as strings or symbols)
+  #
+  # Default type mappings:
+  #   string:                 string
+  #   text:                   string
+  #   integer:                number
+  #   enum:                   number
+  #   bigint:                 number
+  #   float:                  number
+  #   decimal:                number
+  #   json:                   Record<string, any>
+  #   jsonb:                  Record<string, any>
+  #   binary:                 string
+  #   boolean:                boolean
+  #   date:                   string
+  #   datetime:               string
+  #   timestamp:              string
+  #   datetime_with_timezone: string
+  #   inet:                   string
+  #   cidr:                   string
+  #   macaddr:                string
   #
   # config.custom_types = {
   #   
@@ -68,6 +67,28 @@ TsSchema.setup do |config|
   # ]
 
 
+  # Ignore certain fields, omitting them from the generated schema: :optional|(string)|false
+  # Key is the name of the field to override options for.
+  #
+  # [:optional] will make this an optional field by adding '?' to the defintion (example: password?: string)
+  # [(string)]  enter a field name override, for instance rename encrypted_password to password
+  #             In that scenario, also specifying password as an optional field will append a ? to password
+  # [:omit]     will omit the field from being output in the schema entirely
+  #
+  # config.field_overrides: {
+  #   encrypted_password: :password,
+  #   password: :optional,
+  # }
+
+  # Override types for fields by field name. This is globally applied.
+  # Useful for polymorphic associations which would otherwise be of type string, e.g.:
+  #   commentable_type: "'Product'|'Review'" 
+
+  # config.field_type_overrides: {
+
+  # }
+
+
   # Namespace for generated types
   #
   # config.namespace = :schema

data/lib/ts_schema/configuration.rb

@@ -10,12 +10,17 @@ module TsSchema
       custom_types: {},
       default_type: :string,
       include_associated: true,
+      parent_classes: ["ApplicationRecord"],
+      additional_models: [],
+      field_overrides: {
+        "encrypted_password" => :password,
+        "password" => :optional,
+      },
+      field_type_overrides: {},
       namespace: :schema,
-			schema_type: :interface,
+      schema_type: :interface,
       indent: :tab,
       spaces: 2,
-			parent_classes: ["ApplicationRecord"],
-			additional_models: []
     }
 
     attr_accessor(*DEFAULTS.keys)

data/lib/ts_schema/schema_generator.rb

@@ -7,6 +7,8 @@ module TsSchema
 
     def initialize(config = nil)
       @config = config || TsSchema::Configuration.new
+      @config.field_overrides = @config.field_overrides.stringify_keys
+      @config.field_type_overrides = @config.field_type_overrides.stringify_keys
 			@models = []
 
       Rails.application.eager_load!
@@ -18,6 +20,8 @@ module TsSchema
           m.to_s.constantize
         end)
       end
+      @models.sort_by! { |c| c.name }
+
       @types = @config.types.stringify_keys.merge(@config.custom_types.stringify_keys || {})
     end
 
@@ -33,7 +37,7 @@ module TsSchema
 
     def generate
       type_template = ""
-			
+
       @models.each do |model|
         columns = map_column_types(model)
         columns.concat(map_associations(model)) if @config.include_associated
@@ -65,18 +69,38 @@ module TsSchema
     end
 
     def map_column_types(model)
-      model.columns.map { |i|
-        type = @types[i.type.to_s] || @config.default_type
-
-        if(enum = model.defined_enums[i.name])
+      model.columns.map { |column|
+        column_name = column.name.to_s
+        next if @config.field_overrides[column_name] == :omit
+
+        type_override = config.field_type_overrides[column_name]
+                 
+        type = type_override ? type_override : @types[column.type.to_s] || @config.default_type
+        name = map_name(column.name)
+        null = column.null
+        null = true if @config.field_overrides[name]&.to_s == "optional"
+
+        if(enum = model.defined_enums[name])
           type = enum.keys.map { |k| "'#{k}'" }.join("|")
         end
-    
+
         {
-          name: "#{i.name}#{"?" if i.null }",
-          ts_type: "#{type}#{" | null" if i.null}"
+          name: "#{name}#{"?" if null }",
+          ts_type: "#{type}#{" | null" if null}"
         }
-      }
+      }.compact
+    end
+
+    def map_name(name)
+      final_name = name.to_s
+      return final_name unless @config.field_overrides[final_name]
+
+      if @config.field_overrides[final_name]&.to_s != "optional"
+        final_name = @config.field_overrides[final_name]&.to_s
+
+        final_name = map_name(final_name) if @config.field_overrides[final_name]
+      end
+      final_name
     end
 
     def map_associations(model)

data/lib/ts_schema/version.rb

@@ -1,3 +1,3 @@
 module TsSchema
-  VERSION = "0.1.12"
+  VERSION = "0.2.1"
 end

data/lib/ts_schema.rb

@@ -34,4 +34,3 @@ module TsSchema
 end
 
 require "generators/install_generator"
-require "generators/generate_generator"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ts_schema
 version: !ruby/object:Gem::Version
-  version: 0.1.12
+  version: 0.2.1
 platform: ruby
 authors:
 - Avram Walden
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-06 00:00:00.000000000 Z
+date: 2022-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails