ts_schema 0.1.11 → 0.1.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55a01d015705b45bc3b21d80c74fde717172daf0b9cc8f8856ee24bdb6ffe00d
-  data.tar.gz: 662b58cf50169869845249b218ad760d7f3e4d96b5e833ae916a77a86e8447dd
+  metadata.gz: e970a98bd2aea544c74c48dac67799e5b713ef56ab8eaa023662f2901973983a
+  data.tar.gz: f259f07ed9fd61a06bf8b0c777df0a50696472534ba48f43737351a8982b3fb5
 SHA512:
-  metadata.gz: 5f7ceb576b082e209567755d34c7ce25f826ec61891e3f61662f06289838b087c2d18b61f8fdcbabe4db097f59af90332ac55b861b25242a0cc20bc809ad8e9d
-  data.tar.gz: 785331c128754a645c9570146244fc01992329ea7864dc40b3295a587f67ce07bacfff3320a6e9a673552eff4f5489c891028715d7675be5965275a5598eb43b
+  metadata.gz: 30fcd65e0da2df3d5741fe12ed25f84139d3d94b1bc840661a9404105fe5a15e5a0f7a328817283c23592de13ab196d1d31df4398281c6a186d3afcef0d23eb4
+  data.tar.gz: 1a44cc70e7acfb79209f03d2311eb368c1d128832c4e8f586c5ca7f7fa209d5f80641fd8ee57848f6e7b7f9573b1c97e399d372fcb8407b772dd4096b5d1be57

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,57 +1,102 @@
 TsSchema.setup do |config|
-  # Options: camel|snake|pascal
+  # Case options for field names: camel|snake|pascal
+  #
   # config.case = :camel
 
+
   # Customize output path and file name
+  #
   # config.output = Rails.root.join('app', 'assets', 'javascripts', 'schema.d.ts')
 
-  # Whether to generate the schema file on migrations and rollbacks
+
+  # Whether to generate the schema file after running migrations
+  #
   # config.auto_generate = true
 
-  # Add custom type mappings or overrides
-	#
-	# 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
-	#
+
+  # 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 = {
   #   
   # }
 
+
   # Default type for unrecognized types
+  #
   # config.default_type = :string
 
-  # Whether to generate types for associations
+
+  # Whether to generate types for associated models
+  #
   # config.include_associated = true
 
-	# Additional models to map which don't have a model file
-	# config.additional_models = [
-	#	
-	# ]
 
-  # Namespace
+  # Parent classes of models to generate (as strings or symbols)
+  # Only classes inheriting from those in this list will have types generated
+  #
+  # config.parent_classes = [
+  #	  "ApplicationRecord",
+  # ]
+
+
+  # Additional models to generate schema from, such as those added by other gems 
+  #  which don't have a model file. (as strings or symbols)
+  #
+  # config.additional_models = [
+  #	
+  # ]
+
+
+  # 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,
+  # }
+
+
+  # Namespace for generated types
+  #
   # config.namespace = :schema
 
-  # Options: tab|space
+
+  # Output schema as types or interfaces: type|interface
+  #
+  # config.schema_type = :interface
+
+
+  # Indentation options: tab|space
+  #
   # config.indent = :tab
 
+
   # If indent is spaces, specify how many
+  #
   # config.spaces = 2
 end

data/lib/ts_schema/configuration.rb

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

data/lib/ts_schema/schema_generator.rb

@@ -7,15 +7,20 @@ module TsSchema
 
     def initialize(config = nil)
       @config = config || TsSchema::Configuration.new
+      @config.field_overrides = @config.field_overrides.stringify_keys
+			@models = []
 
       Rails.application.eager_load!
-      # @models = ApplicationRecord.send(:subclasses)
-      @models = get_subclasses(ApplicationRecord)
+			@config.parent_classes.each do |parent|
+				@models.concat(get_subclasses(parent.to_s.constantize))
+			end
       unless @config.additional_models.empty?
         @models.concat(@config.additional_models.map do |m| 
           m.to_s.constantize
         end)
       end
+      @models.sort_by! { |c| c.name }
+
       @types = @config.types.stringify_keys.merge(@config.custom_types.stringify_keys || {})
     end
 
@@ -30,33 +35,19 @@ module TsSchema
     end
 
     def generate
-      generate_typescript
-    end
-
-    def output_file
-      path = @config.output
-      FileUtils.mkdir_p(File.dirname(path))
-
-      content = generate
-      return if File.exist?(path) && File.read(path) == content
-
-      File.open(path, 'w') do |f|
-        f.write content
-      end
-    end
-
-    def generate_typescript
       type_template = ""
+
       @models.each do |model|
         columns = map_column_types(model)
         columns.concat(map_associations(model)) if @config.include_associated
         
         type_template += <<~TYPESCRIPT
-          interface #{model.model_name.param_key.camelize} {
+          #{@config.schema_type} #{model.model_name.param_key.camelize} #{@config.schema_type.to_sym == :type ? "= " : ""}{
           #{columns.map { |column| "#{indent_as_str}#{column_name_cased(column[:name])}: #{column[:ts_type]};" }.join("\n")}
           }\n
         TYPESCRIPT
       end
+
       type_template = <<~TPL
         declare namespace #{@config.namespace} {
         #{indent_wrapper(type_template)}
@@ -64,19 +55,48 @@ module TsSchema
       TPL
     end
 
+    def output_file
+      path = @config.output
+      FileUtils.mkdir_p(File.dirname(path))
+
+      content = generate
+      return if File.exist?(path) && File.read(path) == content
+
+      File.open(path, 'w') do |f|
+        f.write content
+      end
+    end
+
     def map_column_types(model)
       model.columns.map { |i|
+        next if @config.field_overrides[i.name.to_s] == :omit
+
         type = @types[i.type.to_s] || @config.default_type
+        name = map_name(i.name)
+        null = i.null
+        null = true if @config.field_overrides[name]&.to_s == "optional"
 
-        if(enum = model.defined_enums[i.name])
-          type = enum.keys.map { |k| "'#{k}'" }.join(" | ")
+        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.11"
+  VERSION = "0.1.14"
 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.11
+  version: 0.1.14
 platform: ruby
 authors:
 - Avram Walden
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-06 00:00:00.000000000 Z
+date: 2022-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -48,7 +48,6 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
-- lib/generators/generate_generator.rb
 - lib/generators/install_generator.rb
 - lib/generators/templates/ts_schema.rb
 - lib/tasks/ts_schema_tasks.rake

data/lib/generators/generate_generator.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-require 'rails/generators'
-require 'rails/generators/base'
-
-module TsSchema
-  module Generators
-    class GenerateGenerator < Rails::Generators::Base
-
-      desc "Generates a schema.d.ts file"
-
-      def generate_schema
-        create_file TsSchema.configuration.output, TsSchema.generate
-      end
-    end
-  end
-end