ts_schema 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 96932379344d1d2f349abd58ab8bdae2fb1f13f5d4d8ca4df3493c128c368570
+  data.tar.gz: 55df2424b71f2ea51974599412edda16699050eb1c0a59f6e3e2f13b30a8ead3
+SHA512:
+  metadata.gz: 00a7114be00a9aaf267910349fbdff03f2923c4fd318f564e2a950e0c4efe0b00324fe860099f5b2e9d3f87b68d526bc42d69f91108262af0331a27451279d08
+  data.tar.gz: 20b24ef08c0fac099b6accc8e722b8878dc47ebf6a55cb848cca54de779b661ec4ed9f0fb29c98c0844fe69a82ec10b72551778c0bcc6df4fad4a60775caa4f1

data/.gitignore

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

data/Gemfile

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

@@ -0,0 +1,160 @@
+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/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2022 Avram Walden
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,35 @@
+# TsSchema
+
+Uses ActiveRecord to generate a schema.d.ts file for use in typescript frontends.
+
+## Installation
+
+```ruby
+bundle add "ts_schema"
+```
+
+Then generate the initializer file:
+
+```ruby
+rails generate ts_schema:install
+```
+
+## Usage
+
+All options with their defaults are in the config 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.
+
+You can manually generate the schema file by running:
+
+```ruby
+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"`.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

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

data/bin/test

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

data/lib/generators/install_generator.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'rails/generators/base'
+
+module TsSchema
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+
+      desc "Creates ts_schmea.rb in config/initializers with default options."
+
+      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

@@ -0,0 +1,30 @@
+TsSchema.setup do |config|
+  # 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
+  # config.auto_generate = true
+
+  # Add custom type mappings or overrides
+  # config.custom_types = {
+  #   
+  # }
+
+  # Default type for unrecognized types
+  # config.default_type = :string
+
+  # Whether to generate types for associations
+  # config.include_associated = true
+
+  # Namespace
+  # config.namespace = :schema
+
+  # Options: tab|space
+  # config.indent = :tab
+
+  # If indent is spaces, specify how many
+  # config.spaces = 2
+end

data/lib/tasks/ts_schema_tasks.rake

@@ -0,0 +1,24 @@
+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
+	end
+end
+
+namespace :db do
+  task migrate: :environment do
+    TsSchema.generate if TsSchema.configuration.auto_generate
+  end
+
+  task rollback: :environment do
+    TsSchema.generate if TsSchema.configuration.auto_generate
+  end
+
+  task reset: :environment do
+    TsSchema.generate if TsSchema.configuration.auto_generate
+  end
+
+  task setup: :environment do
+    TsSchema.generate if TsSchema.configuration.auto_generate
+  end
+end

data/lib/ts_schema/configuration.rb

@@ -0,0 +1,41 @@
+require "pathname"
+
+module TsSchema
+  class Configuration
+    DEFAULTS = {
+      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 },
+      custom_types: {},
+      default_type: :string,
+      include_associated: true,
+      namespace: :schema,
+      indent: :tab,
+      spaces: 2,
+    }
+
+    attr_accessor(*DEFAULTS.keys)
+
+    def initialize(attributes = nil)
+      assign(DEFAULTS)
+      return unless attributes
+      assign(attributes)
+    end
+
+    def assign(attributes = nil, &block)
+      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
+      end
+      self
+    end
+
+  end
+end

data/lib/ts_schema/conversion_table.yml

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

data/lib/ts_schema/railtie.rb

@@ -0,0 +1,4 @@
+module TsSchema
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/ts_schema/schema_generator.rb

@@ -0,0 +1,110 @@
+require 'fileutils'
+
+module TsSchema
+  class SchemaGenerator
+    def initialize
+      Rails.application.eager_load!
+      @models = ApplicationRecord.send(:subclasses)
+      @types = TsSchema.configuration.types.merge(TsSchema.configuration.custom_types || {})
+    end
+
+    def generate
+      ts = generate_typescript
+      output_file(ts)
+    end
+
+    private
+
+    def generate_typescript
+      type_template = ""
+      @models.each do |model|
+        columns = map_column_types(model)
+        columns.concat(map_associations(model)) if TsSchema.configuration.include_associated
+        
+        type_template += <<~TYPESCRIPT
+          interface #{model.model_name.name} {
+          #{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} {
+        #{indent_wrapper(type_template)}
+        }
+      TPL
+    end
+
+    def map_column_types(model)
+      model.columns.map { |i|
+        type = @types[i.type.to_s] || TsSchema.configuration.default_type
+
+        if(enum = model.defined_enums[i.name])
+          type = enum.keys.map { |k| "'#{k}'" }.join(" | ")
+        end
+    
+        {
+          name: "#{i.name}#{"?" if i.null }",
+          ts_type: "#{type}#{" | null" if i.null}"
+        }
+      }
+    end
+
+    def map_associations(model)
+      model.reflect_on_all_associations.reject(&:polymorphic?).map do |association|
+        case
+        when association.has_one? || association.belongs_to?
+          {
+            name: "#{association.name}?",
+            ts_type: association.class_name
+          }
+        when association.collection?
+          {
+            name: "#{association.name}?",
+            ts_type: "#{association.class_name}[]"
+          }
+        end
+      end
+    end
+
+    def column_name_cased(name)
+      case TsSchema.configuration.case.to_sym
+      when :camel
+        name.camelize(:lower)
+      when :pascal
+        name.camelize
+      else
+        name
+      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
+        "".rjust(TsSchema.configuration.spaces, " ")
+      else
+        "\t"
+      end
+    end
+
+    def indent_wrapper(str)
+      case TsSchema.configuration.indent.to_sym
+      when :space || :spaces
+        str.indent(TsSchema.configuration.spaces)
+      else
+        str.indent(1, "\t")
+      end
+    end
+
+  end
+end

data/lib/ts_schema/version.rb

@@ -0,0 +1,3 @@
+module TsSchema
+  VERSION = "0.1.1"
+end

data/lib/ts_schema.rb

@@ -0,0 +1,21 @@
+require "ts_schema/version"
+require "ts_schema/railtie"
+
+require "ts_schema/configuration"
+require "ts_schema/schema_generator"
+
+module TsSchema
+  class << self
+    def setup(&block)
+      configuration.assign(&block)
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def generate
+      SchemaGenerator.new.generate
+    end
+  end
+end

data/test/dummy/Rakefile

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

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

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

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

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