ts_schema 0.1.1 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 96932379344d1d2f349abd58ab8bdae2fb1f13f5d4d8ca4df3493c128c368570
-  data.tar.gz: 55df2424b71f2ea51974599412edda16699050eb1c0a59f6e3e2f13b30a8ead3
+  metadata.gz: c5d8f05efa9ac980177891e855cb0efc08e322b9020d5433b6106c7e32769ca4
+  data.tar.gz: be25c5bf7459c2fb2ed72f9d4aaf5fbc1af3d164feaabd4779ff4a2ec6d17da1
 SHA512:
-  metadata.gz: 00a7114be00a9aaf267910349fbdff03f2923c4fd318f564e2a950e0c4efe0b00324fe860099f5b2e9d3f87b68d526bc42d69f91108262af0331a27451279d08
-  data.tar.gz: 20b24ef08c0fac099b6accc8e722b8878dc47ebf6a55cb848cca54de779b661ec4ed9f0fb29c98c0844fe69a82ec10b72551778c0bcc6df4fad4a60775caa4f1
+  metadata.gz: 040e9d42b416b74485b00c6c31da518a958b1d5e76436e336087589b7a92858750bbdf23a5176dde746242c8bd23a44a952858afdfbd84b25a4b585e81434060
+  data.tar.gz: 51dbdfa59ebab1e83e371881df092a68ce871c5d46ab3a68665211f16d3456c24e70667cb01984a745a248fac1209cee465d6c654719135181573afa0cba0843

data/Rakefile

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

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/install_generator.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'rails/generators'
 require 'rails/generators/base'
 
 module TsSchema
@@ -12,10 +13,6 @@ module TsSchema
       def copy_initializer
         template "ts_schema.rb", "config/initializers/ts_schema.rb"
       end
-
-      # def show_readme
-      #   readme "README" if behavior == :invoke
-      # 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

@@ -1,24 +1,30 @@
+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 << 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.1"
+  VERSION = "0.1.5"
 end

data/lib/ts_schema.rb

@@ -17,5 +17,12 @@ module TsSchema
     def generate
       SchemaGenerator.new.generate
     end
+
+		def output_file
+			SchemaGenerator.new.output_file
+		end
   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.1
+  version: 0.1.5
 platform: ruby
 authors:
 - Avram Walden
@@ -37,13 +37,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- Gemfile
-- Gemfile.lock
 - MIT-LICENSE
 - README.md
 - Rakefile
-- bin/test
+- lib/generators/generate_generator.rb
 - lib/generators/install_generator.rb
 - lib/generators/templates/ts_schema.rb
 - lib/tasks/ts_schema_tasks.rake
@@ -53,64 +50,6 @@ files:
 - lib/ts_schema/railtie.rb
 - lib/ts_schema/schema_generator.rb
 - lib/ts_schema/version.rb
-- test/dummy/Rakefile
-- test/dummy/app/assets/images/.keep
-- test/dummy/app/assets/javascripts/schema.d.ts
-- test/dummy/app/assets/stylesheets/application.css
-- test/dummy/app/controllers/application_controller.rb
-- test/dummy/app/controllers/concerns/.keep
-- test/dummy/app/frontend/types/schema.d.ts
-- test/dummy/app/helpers/application_helper.rb
-- test/dummy/app/jobs/application_job.rb
-- test/dummy/app/models/application_record.rb
-- test/dummy/app/models/concerns/.keep
-- test/dummy/app/models/example.rb
-- test/dummy/app/models/five.rb
-- test/dummy/app/models/four.rb
-- test/dummy/app/models/one.rb
-- test/dummy/app/models/three.rb
-- test/dummy/app/models/two.rb
-- test/dummy/app/views/layouts/application.html.erb
-- test/dummy/bin/rails
-- test/dummy/bin/rake
-- test/dummy/bin/setup
-- test/dummy/config.ru
-- test/dummy/config/application.rb
-- test/dummy/config/boot.rb
-- test/dummy/config/database.yml
-- test/dummy/config/environment.rb
-- test/dummy/config/environments/development.rb
-- test/dummy/config/environments/production.rb
-- test/dummy/config/environments/test.rb
-- test/dummy/config/initializers/config/initializers/ts_schema.rb
-- test/dummy/config/initializers/content_security_policy.rb
-- test/dummy/config/initializers/filter_parameter_logging.rb
-- test/dummy/config/initializers/inflections.rb
-- test/dummy/config/initializers/permissions_policy.rb
-- test/dummy/config/locales/en.yml
-- test/dummy/config/puma.rb
-- test/dummy/config/routes.rb
-- test/dummy/config/storage.yml
-- test/dummy/db/migrate/20220401195333_create_examples.rb
-- test/dummy/db/migrate/20220402131712_create_ones.rb
-- test/dummy/db/migrate/20220402131955_create_twos.rb
-- test/dummy/db/migrate/20220402132415_create_threes.rb
-- test/dummy/db/migrate/20220402132543_create_fours.rb
-- test/dummy/db/migrate/20220402132906_create_fives.rb
-- test/dummy/db/schema.rb
-- test/dummy/lib/assets/.keep
-- test/dummy/log/.keep
-- test/dummy/public/404.html
-- test/dummy/public/422.html
-- test/dummy/public/500.html
-- test/dummy/public/apple-touch-icon-precomposed.png
-- test/dummy/public/apple-touch-icon.png
-- test/dummy/public/favicon.ico
-- test/install_generator_test.rb
-- test/test_helper.rb
-- test/tmp/config/initializers/ts_schema.rb
-- test/ts_schema_test.rb
-- ts_schema.gemspec
 homepage: https://github.com/aviemet
 licenses:
 - MIT

data/.gitignore

@@ -1,9 +0,0 @@
-/.bundle/
-/doc/
-/log/*.log
-/pkg/
-/tmp/
-/test/dummy/log/*.log
-/test/dummy/storage/
-/test/dummy/tmp/
-*.gem

data/Gemfile

@@ -1,10 +0,0 @@
-source "https://rubygems.org"
-git_source(:github) { |repo| "https://github.com/#{repo}.git" }
-
-# Specify your gem's dependencies in ts_schema.gemspec.
-gemspec
-
-gem "pg"
-
-# Start debugger with binding.b [https://github.com/ruby/debug]
-# gem "debug", ">= 1.0.0"

data/Gemfile.lock

@@ -1,160 +0,0 @@
-PATH
-  remote: .
-  specs:
-    ts_schema (0.1.0)
-      rails (>= 7.0.2.3)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    actioncable (7.0.2.3)
-      actionpack (= 7.0.2.3)
-      activesupport (= 7.0.2.3)
-      nio4r (~> 2.0)
-      websocket-driver (>= 0.6.1)
-    actionmailbox (7.0.2.3)
-      actionpack (= 7.0.2.3)
-      activejob (= 7.0.2.3)
-      activerecord (= 7.0.2.3)
-      activestorage (= 7.0.2.3)
-      activesupport (= 7.0.2.3)
-      mail (>= 2.7.1)
-      net-imap
-      net-pop
-      net-smtp
-    actionmailer (7.0.2.3)
-      actionpack (= 7.0.2.3)
-      actionview (= 7.0.2.3)
-      activejob (= 7.0.2.3)
-      activesupport (= 7.0.2.3)
-      mail (~> 2.5, >= 2.5.4)
-      net-imap
-      net-pop
-      net-smtp
-      rails-dom-testing (~> 2.0)
-    actionpack (7.0.2.3)
-      actionview (= 7.0.2.3)
-      activesupport (= 7.0.2.3)
-      rack (~> 2.0, >= 2.2.0)
-      rack-test (>= 0.6.3)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actiontext (7.0.2.3)
-      actionpack (= 7.0.2.3)
-      activerecord (= 7.0.2.3)
-      activestorage (= 7.0.2.3)
-      activesupport (= 7.0.2.3)
-      globalid (>= 0.6.0)
-      nokogiri (>= 1.8.5)
-    actionview (7.0.2.3)
-      activesupport (= 7.0.2.3)
-      builder (~> 3.1)
-      erubi (~> 1.4)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activejob (7.0.2.3)
-      activesupport (= 7.0.2.3)
-      globalid (>= 0.3.6)
-    activemodel (7.0.2.3)
-      activesupport (= 7.0.2.3)
-    activerecord (7.0.2.3)
-      activemodel (= 7.0.2.3)
-      activesupport (= 7.0.2.3)
-    activestorage (7.0.2.3)
-      actionpack (= 7.0.2.3)
-      activejob (= 7.0.2.3)
-      activerecord (= 7.0.2.3)
-      activesupport (= 7.0.2.3)
-      marcel (~> 1.0)
-      mini_mime (>= 1.1.0)
-    activesupport (7.0.2.3)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 1.6, < 2)
-      minitest (>= 5.1)
-      tzinfo (~> 2.0)
-    builder (3.2.4)
-    concurrent-ruby (1.1.10)
-    crass (1.0.6)
-    digest (3.1.0)
-    erubi (1.10.0)
-    globalid (1.0.0)
-      activesupport (>= 5.0)
-    i18n (1.10.0)
-      concurrent-ruby (~> 1.0)
-    loofah (2.15.0)
-      crass (~> 1.0.2)
-      nokogiri (>= 1.5.9)
-    mail (2.7.1)
-      mini_mime (>= 0.1.1)
-    marcel (1.0.2)
-    method_source (1.0.0)
-    mini_mime (1.1.2)
-    minitest (5.15.0)
-    net-imap (0.2.3)
-      digest
-      net-protocol
-      strscan
-    net-pop (0.1.1)
-      digest
-      net-protocol
-      timeout
-    net-protocol (0.1.3)
-      timeout
-    net-smtp (0.3.1)
-      digest
-      net-protocol
-      timeout
-    nio4r (2.5.8)
-    nokogiri (1.13.3-x86_64-linux)
-      racc (~> 1.4)
-    pg (1.3.5)
-    racc (1.6.0)
-    rack (2.2.3)
-    rack-test (1.1.0)
-      rack (>= 1.0, < 3)
-    rails (7.0.2.3)
-      actioncable (= 7.0.2.3)
-      actionmailbox (= 7.0.2.3)
-      actionmailer (= 7.0.2.3)
-      actionpack (= 7.0.2.3)
-      actiontext (= 7.0.2.3)
-      actionview (= 7.0.2.3)
-      activejob (= 7.0.2.3)
-      activemodel (= 7.0.2.3)
-      activerecord (= 7.0.2.3)
-      activestorage (= 7.0.2.3)
-      activesupport (= 7.0.2.3)
-      bundler (>= 1.15.0)
-      railties (= 7.0.2.3)
-    rails-dom-testing (2.0.3)
-      activesupport (>= 4.2.0)
-      nokogiri (>= 1.6)
-    rails-html-sanitizer (1.4.2)
-      loofah (~> 2.3)
-    railties (7.0.2.3)
-      actionpack (= 7.0.2.3)
-      activesupport (= 7.0.2.3)
-      method_source
-      rake (>= 12.2)
-      thor (~> 1.0)
-      zeitwerk (~> 2.5)
-    rake (13.0.6)
-    strscan (3.0.1)
-    thor (1.2.1)
-    timeout (0.2.0)
-    tzinfo (2.0.4)
-      concurrent-ruby (~> 1.0)
-    websocket-driver (0.7.5)
-      websocket-extensions (>= 0.1.0)
-    websocket-extensions (0.1.5)
-    zeitwerk (2.5.4)
-
-PLATFORMS
-  x86_64-linux
-
-DEPENDENCIES
-  pg
-  ts_schema!
-
-BUNDLED WITH
-   2.2.32

data/bin/test

@@ -1,5 +0,0 @@
-#!/usr/bin/env ruby
-$: << File.expand_path("../test", __dir__)
-
-require "bundler/setup"
-require "rails/plugin/test"

data/test/dummy/Rakefile

@@ -1,6 +0,0 @@
-# Add your own tasks in files placed in lib/tasks ending in .rake,
-# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
-
-require_relative "config/application"
-
-Rails.application.load_tasks

data/test/dummy/app/assets/javascripts/schema.d.ts

@@ -1,71 +0,0 @@
-declare namespace schema {
-	interface Example {
-		id: number;
-		colString: string;
-		colText: string;
-		colInteger: number;
-		colEnum: 'zero' | 'one' | 'two';
-		colBigint: number;
-		colFloat: number;
-		colDecimal: number;
-		colJson?: Record<string, any> | null;
-		colJsonb?: Record<string, any> | null;
-		colBinary?: string | null;
-		colBoolean?: boolean | null;
-		colDate?: string | null;
-		colDatetime?: string | null;
-		colTimestamp?: string | null;
-		colInet?: string | null;
-		colCidr?: string | null;
-		colMacaddr?: string | null;
-		one?: One;
-		two?: Two;
-		fours?: Four[];
-		threes?: Three[];
-		fives?: Five[];
-	}
-
-	interface Five {
-		id: number;
-		createdAt: string;
-		updatedAt: string;
-		examples?: Example[];
-	}
-
-	interface Four {
-		id: number;
-		exampleId: number;
-		threeId: number;
-		createdAt: string;
-		updatedAt: string;
-		example?: Example;
-		three?: Three;
-	}
-
-	interface One {
-		id: number;
-		exampleId: number;
-		createdAt: string;
-		updatedAt: string;
-		example?: Example;
-		two?: Two;
-	}
-
-	interface Three {
-		id: number;
-		createdAt: string;
-		updatedAt: string;
-		fours?: Four[];
-		examples?: Example[];
-	}
-
-	interface Two {
-		id: number;
-		exampleId: number;
-		createdAt: string;
-		updatedAt: string;
-		example?: Example;
-	}
-
-
-}

data/test/dummy/app/assets/stylesheets/application.css

@@ -1 +0,0 @@
-/* Application styles */

data/test/dummy/app/controllers/application_controller.rb

@@ -1,2 +0,0 @@
-class ApplicationController < ActionController::Base
-end

data/test/dummy/app/frontend/types/schema.d.ts

@@ -1,71 +0,0 @@
-declare namespace schema {
-	interface Example {
-		id: number;
-		colString: string;
-		colText: string;
-		colInteger: number;
-		colEnum: 'zero' | 'one' | 'two';
-		colBigint: number;
-		colFloat: number;
-		colDecimal: number;
-		colJson?: Record<string, any> | null;
-		colJsonb?: Record<string, any> | null;
-		colBinary?: string | null;
-		colBoolean?: boolean | null;
-		colDate?: string | null;
-		colDatetime?: string | null;
-		colTimestamp?: string | null;
-		colInet?: string | null;
-		colCidr?: string | null;
-		colMacaddr?: string | null;
-		one?: One;
-		two?: Two;
-		fours?: Four[];
-		threes?: Three[];
-		fives?: Five[];
-	}
-
-	interface Five {
-		id: number;
-		createdAt: string;
-		updatedAt: string;
-		examples?: Example[];
-	}
-
-	interface Four {
-		id: number;
-		exampleId: number;
-		threeId: number;
-		createdAt: string;
-		updatedAt: string;
-		example?: Example;
-		three?: Three;
-	}
-
-	interface One {
-		id: number;
-		exampleId: number;
-		createdAt: string;
-		updatedAt: string;
-		example?: Example;
-		two?: Two;
-	}
-
-	interface Three {
-		id: number;
-		createdAt: string;
-		updatedAt: string;
-		fours?: Four[];
-		examples?: Example[];
-	}
-
-	interface Two {
-		id: number;
-		exampleId: number;
-		createdAt: string;
-		updatedAt: string;
-		example?: Example;
-	}
-
-
-}

data/test/dummy/app/helpers/application_helper.rb

@@ -1,2 +0,0 @@
-module ApplicationHelper
-end

data/test/dummy/app/jobs/application_job.rb

@@ -1,7 +0,0 @@
-class ApplicationJob < ActiveJob::Base
-  # Automatically retry jobs that encountered a deadlock
-  # retry_on ActiveRecord::Deadlocked
-
-  # Most jobs are safe to ignore if the underlying records are no longer available
-  # discard_on ActiveJob::DeserializationError
-end

data/test/dummy/app/models/application_record.rb

@@ -1,3 +0,0 @@
-class ApplicationRecord < ActiveRecord::Base
-  primary_abstract_class
-end