ts_schema 0.1.3 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77d28bf3fa481c9cee1708d44202497b93168c5c41c1912fe3153e87594c2a85
-  data.tar.gz: 4b5d1eb645ba546a5152b879481c897b735e6bd5a3f58cbf82913ff0160f8b86
+  metadata.gz: bd4c606265d13a68760b14f6a3e439e8b6e4bf0dbf5a82262a98d8ed30702107
+  data.tar.gz: bced11b47a17ed266bb1d04edbc0e9e962370e802455f8b01a5c314a63a5d069
 SHA512:
-  metadata.gz: e4d295418b3c84c8b6c9c1c0e2ae80a4bbe5595fe8a34d223c3207d95083da7fb0a61ecf83878333f499d6493752bc0ebe818b775c110ad2c0746eda2dc05208
-  data.tar.gz: a1ce2c28636f2a9e5071e11ea42de845d5d411602d661f792e303039fd89b31d5138d63a556744d4df15b72233d135f538e42dab1cbdfcc0fc2a61f9c4dd5f89
+  metadata.gz: cd921fb8519068436415f72f03307cb9ed4442e5f90e0119063426a0949ebba3ffc019e1803bd30d0c2cc1a975978ca1ee2c4abdd87d97aafae1519d27c1024c
+  data.tar.gz: 2e0e87c7355b7b42baac898aaff6c4e22aa04122ecc75b28f88d50b31be94577e96506c3d011c5ffae87d205429f5352aa2570e3902a3ddd475589e89d6302ec

data/lib/generators/generate_generator.rb

@@ -0,0 +1,17 @@
+# 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

data/lib/generators/templates/ts_schema.rb

@@ -9,6 +9,28 @@ TsSchema.setup do |config|
   # 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 = {
   #   
   # }
@@ -19,6 +41,11 @@ TsSchema.setup do |config|
   # Whether to generate types for associations
   # config.include_associated = true
 
+	# Additional models to map which don't have a model file
+	# config.additional_models = [
+	#	
+	# ]
+
   # Namespace
   # config.namespace = :schema
 

data/lib/tasks/ts_schema_tasks.rake

@@ -3,24 +3,28 @@ require "rake"
 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
-		TsSchema.generate
+		TsSchema.output_file
 	end
 end
 
 namespace :db do
+	def auto_generate_and_save_file
+		TsSchema.output_file if TsSchema.configuration.auto_generate
+	end
+
   task migrate: :environment do
-    TsSchema.generate if TsSchema.configuration.auto_generate
+    auto_generate_and_save_file
   end
 
   task rollback: :environment do
-    TsSchema.generate if TsSchema.configuration.auto_generate
+		auto_generate_and_save_file
   end
 
   task reset: :environment do
-    TsSchema.generate if TsSchema.configuration.auto_generate
+		auto_generate_and_save_file
   end
 
   task setup: :environment do
-    TsSchema.generate if TsSchema.configuration.auto_generate
+		auto_generate_and_save_file
   end
 end

data/lib/ts_schema/configuration.rb

@@ -13,6 +13,7 @@ module TsSchema
       namespace: :schema,
       indent: :tab,
       spaces: 2,
+			additional_models: []
     }
 
     attr_accessor(*DEFAULTS.keys)

data/lib/ts_schema/conversion_table.yml

@@ -12,7 +12,7 @@ boolean: boolean
 date: string
 datetime: string
 timestamp: string
-datetime_with_timezone: :string
+datetime_with_timezone: string
 inet: string
 cidr: string
 macaddr: string

data/lib/ts_schema/schema_generator.rb

@@ -5,12 +5,24 @@ module TsSchema
     def initialize
       Rails.application.eager_load!
       @models = ApplicationRecord.send(:subclasses)
+			@models.merge(TsSchema.configuration.additional_models) unless TsSchema.configuration.additional_models.empty?
       @types = TsSchema.configuration.types.merge(TsSchema.configuration.custom_types || {})
     end
 
     def generate
-      ts = generate_typescript
-      output_file(ts)
+      generate_typescript
+    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
+      end
     end
 
     private
@@ -22,7 +34,7 @@ module TsSchema
         columns.concat(map_associations(model)) if TsSchema.configuration.include_associated
         
         type_template += <<~TYPESCRIPT
-          interface #{model.model_name.name} {
+          interface #{model.model_name.param_key.camelize} {
           #{columns.map { |column| "#{indent_as_str}#{column_name_cased(column[:name])}: #{column[:ts_type]};" }.join("\n")}
           }\n
         TYPESCRIPT
@@ -77,17 +89,6 @@ module TsSchema
       end
     end
 
-    def output_file(content)
-      path = TsSchema.configuration.output
-      FileUtils.mkdir_p(File.dirname(path))
-
-      return if File.exist?(path) && File.read(path) == content
-
-      File.open(path, 'w') do |f|
-        f.write content
-      end
-    end
-
     def indent_as_str
       case TsSchema.configuration.indent.to_sym
       when :space || :spaces

data/lib/ts_schema/version.rb

@@ -1,3 +1,3 @@
 module TsSchema
-  VERSION = "0.1.3"
+  VERSION = "0.1.6"
 end

data/lib/ts_schema.rb

@@ -17,7 +17,12 @@ module TsSchema
     def generate
       SchemaGenerator.new.generate
     end
+
+		def output_file
+			SchemaGenerator.new.output_file
+		end
   end
 end
 
 require "generators/install_generator"
+require "generators/generate_generator"

metadata

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