ts_schema 0.1.14 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e970a98bd2aea544c74c48dac67799e5b713ef56ab8eaa023662f2901973983a
-  data.tar.gz: f259f07ed9fd61a06bf8b0c777df0a50696472534ba48f43737351a8982b3fb5
+  metadata.gz: 8795cf28b78a0558a5a8d5d602c340007625f8bfe1810cb34cb5bfdf6552f8b5
+  data.tar.gz: 14bd99114036a2115576d83325fe57c313d3f29a107d0b68eb93856893f4ef3e
 SHA512:
-  metadata.gz: 30fcd65e0da2df3d5741fe12ed25f84139d3d94b1bc840661a9404105fe5a15e5a0f7a328817283c23592de13ab196d1d31df4398281c6a186d3afcef0d23eb4
-  data.tar.gz: 1a44cc70e7acfb79209f03d2311eb368c1d128832c4e8f586c5ca7f7fa209d5f80641fd8ee57848f6e7b7f9573b1c97e399d372fcb8407b772dd4096b5d1be57
+  metadata.gz: 34e2a5851c811791eaabdcd8faff440d50aa185f226177082820d4cfacfc549eca74e0d5397fc64931b6ffe5284665bb3ac1513bfba0679ed1ba42ece97ba161
+  data.tar.gz: 4452a9c7c21247d714abcdf08e5c9711413b76bf48e559672f503156ec3edc9cefedc471637802524c2030c1de456fa464fd480004998865981582c93b885cf7

data/README.md

@@ -62,6 +62,7 @@ rails ts_schema:generate
 |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|
+|field_type_overrides|`{}`|`{ field_name: 'typescriptType' }`|Override all instances of a field name in any record with the supplied type. Useful for polymorphic associations, for example: `commentable_type: "'Product'|'Review'"`|
 |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|

data/Rakefile

@@ -1,3 +1,14 @@
+# frozen_string_literal: true
+
 require "bundler/setup"
 require "bundler/gem_tasks"
-require "ts_schema"
+require "ts_schema"
+# require "rails/plugin/test"
+
+# RSpec::Core::RakeTask.new(:test)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[rubocop]

data/lib/generators/templates/ts_schema.rb

@@ -1,19 +1,18 @@
+# frozen_string_literal: true
+
 TsSchema.setup do |config|
   # 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 after running migrations
   #
   # config.auto_generate = true
 
-
   # Add custom type mappings or overrides (as strings or symbols)
   #
   # Default type mappings:
@@ -37,20 +36,21 @@ TsSchema.setup do |config|
   #   macaddr:                string
   #
   # config.custom_types = {
-  #   
+  #
   # }
 
+  # Include null type for optional fields
+  #
+  # export_nulls = false
 
   # Default type for unrecognized types
   #
   # config.default_type = :string
 
-
   # Whether to generate types for associated models
   #
   # config.include_associated = true
 
-
   # Parent classes of models to generate (as strings or symbols)
   # Only classes inheriting from those in this list will have types generated
   #
@@ -58,15 +58,13 @@ TsSchema.setup do |config|
   #	  "ApplicationRecord",
   # ]
 
-
-  # Additional models to generate schema from, such as those added by other gems 
+  # 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.
   #
@@ -80,22 +78,26 @@ TsSchema.setup do |config|
   #   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
 
-
   # 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

data/lib/tasks/ts_schema_tasks.rake

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "rake"
 require "ts_schema"
 

data/lib/ts_schema/configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "pathname"
 
 module TsSchema
@@ -6,8 +8,9 @@ module TsSchema
       case: :camel,
       output: -> { Rails.root.join('app', 'assets', 'javascripts', 'schema.d.ts') },
       auto_generate: true,
-      types: ->{ YAML.load_file(File.expand_path(__dir__) + '/conversion_table.yml').to_h },
+      types: ->{ YAML.load_file("#{File.expand_path(__dir__)}/conversion_table.yml").to_h },
       custom_types: {},
+      export_nulls: false,
       default_type: :string,
       include_associated: true,
       parent_classes: ["ApplicationRecord"],
@@ -16,17 +19,19 @@ module TsSchema
         "encrypted_password" => :password,
         "password" => :optional,
       },
+      field_type_overrides: {},
       namespace: :schema,
       schema_type: :interface,
       indent: :tab,
       spaces: 2,
-    }
+    }.freeze
 
     attr_accessor(*DEFAULTS.keys)
 
     def initialize(attributes = nil)
       assign(DEFAULTS)
       return unless attributes
+
       assign(attributes)
     end
 
@@ -34,12 +39,11 @@ module TsSchema
       if !attributes && !block
         raise "Provide attributes or block"
       end
+
       tap(&block) if block
-      if attributes
-        attributes.each do |attribute, value|
-          value = value.call if value.is_a?(Proc)
-          send(:"#{attribute}=", value)
-        end
+      attributes&.each do |attribute, value|
+        value = value.call if value.is_a?(Proc)
+        send(:"#{attribute}=", value)
       end
       self
     end

data/lib/ts_schema/railtie.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "rails"
 
 module TsSchema

data/lib/ts_schema/schema_generator.rb

@@ -1,21 +1,23 @@
+# frozen_string_literal: true
+
 require 'fileutils'
 
 module TsSchema
   class SchemaGenerator
-    attr_accessor :config
-    attr_accessor :models
+    attr_accessor :config, :models
 
     def initialize(config = nil)
       @config = config || TsSchema::Configuration.new
       @config.field_overrides = @config.field_overrides.stringify_keys
-			@models = []
+      @config.field_type_overrides = @config.field_type_overrides.stringify_keys
+      @models = []
 
       Rails.application.eager_load!
-			@config.parent_classes.each do |parent|
-				@models.concat(get_subclasses(parent.to_s.constantize))
-			end
+      @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| 
+        @models.concat(@config.additional_models.map do |m|
           m.to_s.constantize
         end)
       end
@@ -40,9 +42,9 @@ module TsSchema
       @models.each do |model|
         columns = map_column_types(model)
         columns.concat(map_associations(model)) if @config.include_associated
-        
+
         type_template += <<~TYPESCRIPT
-          #{@config.schema_type} #{model.model_name.param_key.camelize} #{@config.schema_type.to_sym == :type ? "= " : ""}{
+          #{@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
@@ -62,27 +64,28 @@ module TsSchema
       content = generate
       return if File.exist?(path) && File.read(path) == content
 
-      File.open(path, 'w') do |f|
-        f.write content
-      end
+      File.write(path, content)
     end
 
     def map_column_types(model)
-      model.columns.map { |i|
-        next if @config.field_overrides[i.name.to_s] == :omit
+      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 = @types[i.type.to_s] || @config.default_type
-        name = map_name(i.name)
-        null = i.null
+        type = 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])
+        if (enum = model.defined_enums[name])
           type = enum.keys.map { |k| "'#{k}'" }.join("|")
         end
 
         {
-          name: "#{name}#{"?" if null }",
-          ts_type: "#{type}#{" | null" if null}"
+          name: "#{name}#{'?' if null}",
+          ts_type: "#{type}#{' | null' if @config.export_nulls && null}"
         }
       }.compact
     end
@@ -101,13 +104,12 @@ module TsSchema
 
     def map_associations(model)
       model.reflect_on_all_associations.reject(&:polymorphic?).map do |association|
-        case
-        when association.has_one? || association.belongs_to?
+        if association.has_one? || association.belongs_to?
           {
             name: "#{association.name}?",
             ts_type: association.class_name.constantize.model_name.param_key.camelize
           }
-        when association.collection?
+        elsif association.collection?
           {
             name: "#{association.name}?",
             ts_type: "#{association.class_name.constantize.model_name.param_key.camelize}[]"

data/lib/ts_schema/version.rb

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

data/lib/ts_schema.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
+
 require "ts_schema/version"
 require "ts_schema/railtie"
 
 require "ts_schema/configuration"
 require "ts_schema/schema_generator"
 
-
 module TsSchema
   class << self
     def setup(&block)
@@ -18,18 +19,18 @@ module TsSchema
     def generate
       if ActiveRecord::Base.connection.migration_context.needs_migration?
         puts "Aborting: There are pending migrations"
-      else 
+      else
         SchemaGenerator.new(@configuration).generate
       end
     end
 
-		def output_file
+    def output_file
       if ActiveRecord::Base.connection.migration_context.needs_migration?
         puts "Aborting: There are pending migrations"
-      else 
+      else
         SchemaGenerator.new(@configuration).output_file
       end
-		end
+    end
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ts_schema
 version: !ruby/object:Gem::Version
-  version: 0.1.14
+  version: 1.0.0
 platform: ruby
 authors:
 - Avram Walden
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-09 00:00:00.000000000 Z
+date: 2023-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -78,7 +78,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: Generates typescript definitions from ActiveRecord