ts_schema 0.1.10 → 0.1.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a5093baca17f4486d16008b5e3eb15dde18d5064b902a45c0d05defe5948f0ee
-  data.tar.gz: 14d0f1352c9c716af3040814447c8aac81a3cdb66b04870fe698c5f9fa1c98f9
+  metadata.gz: 8d6e690832a89b7cbde62be4a27e6dc9374be937df6627bff391db15c2f1e777
+  data.tar.gz: 9a6aec0dd27e0938cdd856ad723dc28898a582de67122b7ed9bc147ed6d335c6
 SHA512:
-  metadata.gz: b8425b8aefc7433b1360b6fb703ae9d0664513d6f6396e347f2b4c1e7d2345daf2a5047779c576cd070187c34fe87edd0da8aba6947dee644951c01e89fe2fbf
-  data.tar.gz: 146ce2d710732da6f36cad8d4c9a9ff4d9fb95f186247c937441719951539517d8705184b8b151f42446a413b20f0b19f2dde0e79476b29d96c69aa62271aadc
+  metadata.gz: 7df830e6e1a3543944f9550e57801f16c9ef2121462983c67944814e70f21c47f48b8fe6d5841286c92d1876cee50c8b32bf1533a49ae90f436234ed52723bcd
+  data.tar.gz: 1cc1c840bef030c08afee4480102d6a4cbda128d30c1de01969ad9b03312c9f71f3019c589ea382e23756ba267f0ab939bc839f62c79619381d7535e9be33de7

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:
 
@@ -28,7 +28,7 @@ rails ts_schema:generate
 
 ## 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/Rakefile

@@ -1,2 +1,3 @@
 require "bundler/setup"
 require "bundler/gem_tasks"
+require "ts_schema"

data/lib/generators/templates/ts_schema.rb

@@ -1,57 +1,102 @@
+# 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|
-  # Options: camel|snake|pascal
+  # Case options: 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
-	#
+  #
   # 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 passwoord as an optional field will append a ? in the output
+  # [: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/tasks/ts_schema_tasks.rake

@@ -1,8 +1,9 @@
 require "rake"
+require "ts_schema"
 
 namespace :ts_schema do
   desc "Generates a schema file in the default javascripts location, or the location specified in the ts_config initializer options"
-  task :generate do
+  task generate: :environment do
     TsSchema.output_file
   end
 end
@@ -12,19 +13,11 @@ namespace :db do
     TsSchema.output_file if TsSchema.configuration.auto_generate
   end
 
-  task migrate: :environment do
-    auto_generate_and_save_file
+  task :migrate do
+    at_exit { auto_generate_and_save_file }
   end
 
-  task rollback: :environment do
-    auto_generate_and_save_file
-  end
-
-  task reset: :environment do
-    auto_generate_and_save_file
-  end
-
-  task setup: :environment do
-    auto_generate_and_save_file
+  task :setup do
+    at_exit { auto_generate_and_save_file }
   end
 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)
@@ -37,6 +43,5 @@ module TsSchema
       end
       self
     end
-
   end
 end

data/lib/ts_schema/conversion_table.yml

@@ -2,7 +2,6 @@ string: string
 text: string
 integer: number
 enum: number
-bigint: number
 float: number
 decimal: number
 json: Record<string, any>
@@ -12,7 +11,6 @@ boolean: boolean
 date: string
 datetime: string
 timestamp: string
-datetime_with_timezone: string
 inet: string
 cidr: string
 macaddr: string

data/lib/ts_schema/railtie.rb

@@ -1,4 +1,7 @@
+require "rails"
+
 module TsSchema
   class Railtie < ::Rails::Railtie
+    load "tasks/ts_schema_tasks.rake"
   end
 end

data/lib/ts_schema/schema_generator.rb

@@ -2,65 +2,99 @@ require 'fileutils'
 
 module TsSchema
   class SchemaGenerator
-    def initialize
+    attr_accessor :config
+    attr_accessor :models
+
+    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)
-			unless TsSchema.configuration.additional_models.empty?
-				@models.concat(TsSchema.configuration.additional_models.map {|m| m.to_s.constantize })
+			@config.parent_classes.each do |parent|
+				@models.concat(get_subclasses(parent.to_s.constantize))
 			end
-      @types = TsSchema.configuration.types.merge(TsSchema.configuration.custom_types || {})
-    end
-
-    def generate
-      generate_typescript
+      unless @config.additional_models.empty?
+        @models.concat(@config.additional_models.map do |m| 
+          m.to_s.constantize
+        end)
+      end
+      @types = @config.types.stringify_keys.merge(@config.custom_types.stringify_keys || {})
     end
 
-    def output_file
-      path = TsSchema.configuration.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
+    def get_subclasses(model)
+      models = model.send(:subclasses)
+      unless nested_empty?(models)
+        models.concat(models.flat_map do |m|
+          get_subclasses(m)
+        end)
       end
+      models
     end
 
-    private
-
-    def generate_typescript
+    def generate
       type_template = ""
+			
       @models.each do |model|
         columns = map_column_types(model)
-        columns.concat(map_associations(model)) if TsSchema.configuration.include_associated
+        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 #{TsSchema.configuration.namespace} {
+        declare namespace #{@config.namespace} {
         #{indent_wrapper(type_template)}
         }
       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|
-        type = @types[i.type.to_s] || TsSchema.configuration.default_type
+        next if @config.field_overrides[i.name.to_s] == :omit
 
-        if(enum = model.defined_enums[i.name])
-          type = enum.keys.map { |k| "'#{k}'" }.join(" | ")
+        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[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)
@@ -80,8 +114,14 @@ module TsSchema
       end
     end
 
+    private
+
+    def nested_empty?(arr)
+      arr.is_a?(Array) && arr.flatten.empty?
+    end
+
     def column_name_cased(name)
-      case TsSchema.configuration.case.to_sym
+      case @config.case.to_sym
       when :camel
         name.camelize(:lower)
       when :pascal
@@ -92,18 +132,18 @@ module TsSchema
     end
 
     def indent_as_str
-      case TsSchema.configuration.indent.to_sym
+      case @config.indent.to_sym
       when :space || :spaces
-        "".rjust(TsSchema.configuration.spaces, " ")
+        "".rjust(@config.spaces, " ")
       else
         "\t"
       end
     end
 
     def indent_wrapper(str)
-      case TsSchema.configuration.indent.to_sym
+      case @config.indent.to_sym
       when :space || :spaces
-        str.indent(TsSchema.configuration.spaces)
+        str.indent(@config.spaces)
       else
         str.indent(1, "\t")
       end

data/lib/ts_schema/version.rb

@@ -1,3 +1,3 @@
 module TsSchema
-  VERSION = "0.1.10"
+  VERSION = "0.1.13"
 end

data/lib/ts_schema.rb

@@ -4,6 +4,7 @@ require "ts_schema/railtie"
 require "ts_schema/configuration"
 require "ts_schema/schema_generator"
 
+
 module TsSchema
   class << self
     def setup(&block)
@@ -15,14 +16,21 @@ module TsSchema
     end
 
     def generate
-      SchemaGenerator.new.generate
+      if ActiveRecord::Base.connection.migration_context.needs_migration?
+        puts "Aborting: There are pending migrations"
+      else 
+        SchemaGenerator.new(@configuration).generate
+      end
     end
 
 		def output_file
-			SchemaGenerator.new.output_file
+      if ActiveRecord::Base.connection.migration_context.needs_migration?
+        puts "Aborting: There are pending migrations"
+      else 
+        SchemaGenerator.new(@configuration).output_file
+      end
 		end
   end
 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.10
+  version: 0.1.13
 platform: ruby
 authors:
 - Avram Walden
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-04 00:00:00.000000000 Z
+date: 2022-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
 description: ''
 email:
 - aviemet@gmail.com
@@ -34,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
@@ -50,7 +63,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/aviemet
   source_code_uri: https://github.com/aviemet/ts_schema
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -66,7 +79,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.2.32
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Generates typescript definitions from ActiveRecord
 test_files: []

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