ts_schema 0.1.11 → 0.1.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55a01d015705b45bc3b21d80c74fde717172daf0b9cc8f8856ee24bdb6ffe00d
-  data.tar.gz: 662b58cf50169869845249b218ad760d7f3e4d96b5e833ae916a77a86e8447dd
+  metadata.gz: 8602c4a7ca10962ac35fd7c64a18d0669ed3f7d1ecdfdf7bc9c29a258bff754a
+  data.tar.gz: 322d779a986f2edf18d53829a6a8669326732be7aa4080567d2f4a1ecb1ebac0
 SHA512:
-  metadata.gz: 5f7ceb576b082e209567755d34c7ce25f826ec61891e3f61662f06289838b087c2d18b61f8fdcbabe4db097f59af90332ac55b861b25242a0cc20bc809ad8e9d
-  data.tar.gz: 785331c128754a645c9570146244fc01992329ea7864dc40b3295a587f67ce07bacfff3320a6e9a673552eff4f5489c891028715d7675be5965275a5598eb43b
+  metadata.gz: 88fd048bbffe0eb93ac910bdcaf456a35e4ded1bf934dab9330d5ad1dba4d57ad3106c07a549a92555f312fe4d713d1b1b4b8c7d29d3909d85a7062df96e6426
+  data.tar.gz: 4c778296ba8de708bf9539bdcd163d79370c0477600d2bdbfd98a0e5c0355d3e02872728452be964922032cc880b3ac92ee270f40269e251734fb48ebfb74bcb

data/lib/generators/templates/ts_schema.rb

@@ -1,57 +1,89 @@
+# 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 = [
+  #	
+  # ]
+
+
+  # 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

@@ -11,8 +11,10 @@ module TsSchema
       default_type: :string,
       include_associated: true,
       namespace: :schema,
+			schema_type: :interface,
       indent: :tab,
       spaces: 2,
+			parent_classes: ["ApplicationRecord"],
 			additional_models: []
     }
 

data/lib/ts_schema/schema_generator.rb

@@ -7,10 +7,12 @@ module TsSchema
 
     def initialize(config = nil)
       @config = config || TsSchema::Configuration.new
+			@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
@@ -30,33 +32,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,12 +52,24 @@ 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|
         type = @types[i.type.to_s] || @config.default_type
 
         if(enum = model.defined_enums[i.name])
-          type = enum.keys.map { |k| "'#{k}'" }.join(" | ")
+          type = enum.keys.map { |k| "'#{k}'" }.join("|")
         end
     
         {

data/lib/ts_schema/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ts_schema
 version: !ruby/object:Gem::Version
-  version: 0.1.11
+  version: 0.1.12
 platform: ruby
 authors:
 - Avram Walden
@@ -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