ts_schema 0.1.1

data/test/dummy/config/puma.rb

@@ -0,0 +1,43 @@
+# Puma can serve each request in a thread from an internal thread pool.
+# The `threads` method setting takes two numbers: a minimum and maximum.
+# Any libraries that use thread pools should be configured to match
+# the maximum value specified for Puma. Default is set to 5 threads for minimum
+# and maximum; this matches the default thread size of Active Record.
+#
+max_threads_count = ENV.fetch("RAILS_MAX_THREADS") { 5 }
+min_threads_count = ENV.fetch("RAILS_MIN_THREADS") { max_threads_count }
+threads min_threads_count, max_threads_count
+
+# Specifies the `worker_timeout` threshold that Puma will use to wait before
+# terminating a worker in development environments.
+#
+worker_timeout 3600 if ENV.fetch("RAILS_ENV", "development") == "development"
+
+# Specifies the `port` that Puma will listen on to receive requests; default is 3000.
+#
+port ENV.fetch("PORT") { 3000 }
+
+# Specifies the `environment` that Puma will run in.
+#
+environment ENV.fetch("RAILS_ENV") { "development" }
+
+# Specifies the `pidfile` that Puma will use.
+pidfile ENV.fetch("PIDFILE") { "tmp/pids/server.pid" }
+
+# Specifies the number of `workers` to boot in clustered mode.
+# Workers are forked web server processes. If using threads and workers together
+# the concurrency of the application would be max `threads` * `workers`.
+# Workers do not work on JRuby or Windows (both of which do not support
+# processes).
+#
+# workers ENV.fetch("WEB_CONCURRENCY") { 2 }
+
+# Use the `preload_app!` method when specifying a `workers` number.
+# This directive tells Puma to first boot the application and load code
+# before forking the application. This takes advantage of Copy On Write
+# process behavior so workers use less memory.
+#
+# preload_app!
+
+# Allow puma to be restarted by `bin/rails restart` command.
+plugin :tmp_restart

data/test/dummy/config/routes.rb

@@ -0,0 +1,6 @@
+Rails.application.routes.draw do
+  # Define your application routes per the DSL in https://guides.rubyonrails.org/routing.html
+
+  # Defines the root path route ("/")
+  # root "articles#index"
+end

data/test/dummy/config/storage.yml

@@ -0,0 +1,34 @@
+test:
+  service: Disk
+  root: <%= Rails.root.join("tmp/storage") %>
+
+local:
+  service: Disk
+  root: <%= Rails.root.join("storage") %>
+
+# Use bin/rails credentials:edit to set the AWS secrets (as aws:access_key_id|secret_access_key)
+# amazon:
+#   service: S3
+#   access_key_id: <%= Rails.application.credentials.dig(:aws, :access_key_id) %>
+#   secret_access_key: <%= Rails.application.credentials.dig(:aws, :secret_access_key) %>
+#   region: us-east-1
+#   bucket: your_own_bucket-<%= Rails.env %>
+
+# Remember not to checkin your GCS keyfile to a repository
+# google:
+#   service: GCS
+#   project: your_project
+#   credentials: <%= Rails.root.join("path/to/gcs.keyfile") %>
+#   bucket: your_own_bucket-<%= Rails.env %>
+
+# Use bin/rails credentials:edit to set the Azure Storage secret (as azure_storage:storage_access_key)
+# microsoft:
+#   service: AzureStorage
+#   storage_account_name: your_account_name
+#   storage_access_key: <%= Rails.application.credentials.dig(:azure_storage, :storage_access_key) %>
+#   container: your_container_name-<%= Rails.env %>
+
+# mirror:
+#   service: Mirror
+#   primary: local
+#   mirrors: [ amazon, google, microsoft ]

data/test/dummy/config.ru

@@ -0,0 +1,6 @@
+# This file is used by Rack-based servers to start the application.
+
+require_relative "config/environment"
+
+run Rails.application
+Rails.application.load_server

data/test/dummy/db/migrate/20220401195333_create_examples.rb

@@ -0,0 +1,23 @@
+class CreateExamples < ActiveRecord::Migration[7.0]
+  def change
+    create_table :examples do |t|
+      t.string :col_string, null: false
+      t.text :col_text, null: false
+      t.integer :col_integer, null: false
+			t.integer :col_enum, null: false
+      t.bigint :col_bigint, null: false
+      t.float :col_float, null: false
+      t.decimal :col_decimal, null: false
+      t.json :col_json
+      t.jsonb :col_jsonb
+      t.binary :col_binary
+      t.boolean :col_boolean
+      t.date :col_date
+      t.datetime :col_datetime
+      t.timestamp :col_timestamp
+			t.inet :col_inet
+			t.cidr :col_cidr
+			t.macaddr :col_macaddr
+    end
+  end
+end

data/test/dummy/db/migrate/20220402131712_create_ones.rb

@@ -0,0 +1,9 @@
+class CreateOnes < ActiveRecord::Migration[7.0]
+  def change
+    create_table :ones do |t|
+      t.references :example, null: false, foreign_key: true
+
+      t.timestamps
+    end
+  end
+end

data/test/dummy/db/migrate/20220402131955_create_twos.rb

@@ -0,0 +1,9 @@
+class CreateTwos < ActiveRecord::Migration[7.0]
+  def change
+    create_table :twos do |t|
+      t.references :example, null: false, foreign_key: true
+
+      t.timestamps
+    end
+  end
+end

data/test/dummy/db/migrate/20220402132415_create_threes.rb

@@ -0,0 +1,7 @@
+class CreateThrees < ActiveRecord::Migration[7.0]
+  def change
+    create_table :threes do |t|
+      t.timestamps
+    end
+  end
+end

data/test/dummy/db/migrate/20220402132543_create_fours.rb

@@ -0,0 +1,10 @@
+class CreateFours < ActiveRecord::Migration[7.0]
+  def change
+    create_table :fours do |t|
+      t.references :example, null: false, foreign_key: true
+      t.references :three, null: false, foreign_key: true
+
+      t.timestamps
+    end
+  end
+end

data/test/dummy/db/migrate/20220402132906_create_fives.rb

@@ -0,0 +1,12 @@
+class CreateFives < ActiveRecord::Migration[7.0]
+  def change
+    create_table :fives do |t|
+      t.timestamps
+    end
+
+		create_table :examples_fives, id: false do |t|
+			t.belongs_to :example
+			t.belongs_to :part
+		end
+  end
+end

data/test/dummy/db/schema.rb

@@ -0,0 +1,81 @@
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# This file is the source Rails uses to define your schema when running `bin/rails
+# db:schema:load`. When creating a new database, `bin/rails db:schema:load` tends to
+# be faster and is potentially less error prone than running all of your
+# migrations from scratch. Old migrations may fail to apply correctly if those
+# migrations use external dependencies or application code.
+#
+# It's strongly recommended that you check this file into your version control system.
+
+ActiveRecord::Schema[7.0].define(version: 2022_04_02_132906) do
+  # These are extensions that must be enabled in order to support this database
+  enable_extension "plpgsql"
+
+  create_table "examples", force: :cascade do |t|
+    t.string "col_string", null: false
+    t.text "col_text", null: false
+    t.integer "col_integer", null: false
+    t.integer "col_enum", null: false
+    t.bigint "col_bigint", null: false
+    t.float "col_float", null: false
+    t.decimal "col_decimal", null: false
+    t.json "col_json"
+    t.jsonb "col_jsonb"
+    t.binary "col_binary"
+    t.boolean "col_boolean"
+    t.date "col_date"
+    t.datetime "col_datetime"
+    t.datetime "col_timestamp", precision: nil
+    t.inet "col_inet"
+    t.cidr "col_cidr"
+    t.macaddr "col_macaddr"
+  end
+
+  create_table "examples_fives", id: false, force: :cascade do |t|
+    t.bigint "example_id"
+    t.bigint "part_id"
+    t.index ["example_id"], name: "index_examples_fives_on_example_id"
+    t.index ["part_id"], name: "index_examples_fives_on_part_id"
+  end
+
+  create_table "fives", force: :cascade do |t|
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+  end
+
+  create_table "fours", force: :cascade do |t|
+    t.bigint "example_id", null: false
+    t.bigint "three_id", null: false
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+    t.index ["example_id"], name: "index_fours_on_example_id"
+    t.index ["three_id"], name: "index_fours_on_three_id"
+  end
+
+  create_table "ones", force: :cascade do |t|
+    t.bigint "example_id", null: false
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+    t.index ["example_id"], name: "index_ones_on_example_id"
+  end
+
+  create_table "threes", force: :cascade do |t|
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+  end
+
+  create_table "twos", force: :cascade do |t|
+    t.bigint "example_id", null: false
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+    t.index ["example_id"], name: "index_twos_on_example_id"
+  end
+
+  add_foreign_key "fours", "examples"
+  add_foreign_key "fours", "threes"
+  add_foreign_key "ones", "examples"
+  add_foreign_key "twos", "examples"
+end

data/test/dummy/public/404.html

@@ -0,0 +1,67 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The page you were looking for doesn't exist (404)</title>
+  <meta name="viewport" content="width=device-width,initial-scale=1">
+  <style>
+  .rails-default-error-page {
+    background-color: #EFEFEF;
+    color: #2E2F30;
+    text-align: center;
+    font-family: arial, sans-serif;
+    margin: 0;
+  }
+
+  .rails-default-error-page div.dialog {
+    width: 95%;
+    max-width: 33em;
+    margin: 4em auto 0;
+  }
+
+  .rails-default-error-page div.dialog > div {
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #BBB;
+    border-top: #B00100 solid 4px;
+    border-top-left-radius: 9px;
+    border-top-right-radius: 9px;
+    background-color: white;
+    padding: 7px 12% 0;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+
+  .rails-default-error-page h1 {
+    font-size: 100%;
+    color: #730E15;
+    line-height: 1.5em;
+  }
+
+  .rails-default-error-page div.dialog > p {
+    margin: 0 0 1em;
+    padding: 1em;
+    background-color: #F7F7F7;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #999;
+    border-bottom-left-radius: 4px;
+    border-bottom-right-radius: 4px;
+    border-top-color: #DADADA;
+    color: #666;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  </style>
+</head>
+
+<body class="rails-default-error-page">
+  <!-- This file lives in public/404.html -->
+  <div class="dialog">
+    <div>
+      <h1>The page you were looking for doesn't exist.</h1>
+      <p>You may have mistyped the address or the page may have moved.</p>
+    </div>
+    <p>If you are the application owner check the logs for more information.</p>
+  </div>
+</body>
+</html>

data/test/dummy/public/422.html

@@ -0,0 +1,67 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The change you wanted was rejected (422)</title>
+  <meta name="viewport" content="width=device-width,initial-scale=1">
+  <style>
+  .rails-default-error-page {
+    background-color: #EFEFEF;
+    color: #2E2F30;
+    text-align: center;
+    font-family: arial, sans-serif;
+    margin: 0;
+  }
+
+  .rails-default-error-page div.dialog {
+    width: 95%;
+    max-width: 33em;
+    margin: 4em auto 0;
+  }
+
+  .rails-default-error-page div.dialog > div {
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #BBB;
+    border-top: #B00100 solid 4px;
+    border-top-left-radius: 9px;
+    border-top-right-radius: 9px;
+    background-color: white;
+    padding: 7px 12% 0;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+
+  .rails-default-error-page h1 {
+    font-size: 100%;
+    color: #730E15;
+    line-height: 1.5em;
+  }
+
+  .rails-default-error-page div.dialog > p {
+    margin: 0 0 1em;
+    padding: 1em;
+    background-color: #F7F7F7;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #999;
+    border-bottom-left-radius: 4px;
+    border-bottom-right-radius: 4px;
+    border-top-color: #DADADA;
+    color: #666;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  </style>
+</head>
+
+<body class="rails-default-error-page">
+  <!-- This file lives in public/422.html -->
+  <div class="dialog">
+    <div>
+      <h1>The change you wanted was rejected.</h1>
+      <p>Maybe you tried to change something you didn't have access to.</p>
+    </div>
+    <p>If you are the application owner check the logs for more information.</p>
+  </div>
+</body>
+</html>

data/test/dummy/public/500.html

@@ -0,0 +1,66 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>We're sorry, but something went wrong (500)</title>
+  <meta name="viewport" content="width=device-width,initial-scale=1">
+  <style>
+  .rails-default-error-page {
+    background-color: #EFEFEF;
+    color: #2E2F30;
+    text-align: center;
+    font-family: arial, sans-serif;
+    margin: 0;
+  }
+
+  .rails-default-error-page div.dialog {
+    width: 95%;
+    max-width: 33em;
+    margin: 4em auto 0;
+  }
+
+  .rails-default-error-page div.dialog > div {
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #BBB;
+    border-top: #B00100 solid 4px;
+    border-top-left-radius: 9px;
+    border-top-right-radius: 9px;
+    background-color: white;
+    padding: 7px 12% 0;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+
+  .rails-default-error-page h1 {
+    font-size: 100%;
+    color: #730E15;
+    line-height: 1.5em;
+  }
+
+  .rails-default-error-page div.dialog > p {
+    margin: 0 0 1em;
+    padding: 1em;
+    background-color: #F7F7F7;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #999;
+    border-bottom-left-radius: 4px;
+    border-bottom-right-radius: 4px;
+    border-top-color: #DADADA;
+    color: #666;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  </style>
+</head>
+
+<body class="rails-default-error-page">
+  <!-- This file lives in public/500.html -->
+  <div class="dialog">
+    <div>
+      <h1>We're sorry, but something went wrong.</h1>
+    </div>
+    <p>If you are the application owner check the logs for more information.</p>
+  </div>
+</body>
+</html>

data/test/install_generator_test.rb

@@ -0,0 +1,13 @@
+require "test_helper"
+
+class InstallGeneratorTest < Rails::Generators::TestCase
+	tests TsSchema::Generators::InstallGenerator
+	destination File.expand_path("../tmp", __FILE__)
+	setup :prepare_destination
+
+	test "it creats a file" do
+		run_generator
+
+		assert_file "config/initializers/ts_schema.rb"
+	end
+end

data/test/test_helper.rb

@@ -0,0 +1,18 @@
+# Configure Rails Environment
+ENV["RAILS_ENV"] = "test"
+
+require_relative "../test/dummy/config/environment"
+ActiveRecord::Migrator.migrations_paths = [File.expand_path("../test/dummy/db/migrate", __dir__)]
+require "rails/test_help"
+
+# Load fixtures from the engine
+if ActiveSupport::TestCase.respond_to?(:fixture_path=)
+  ActiveSupport::TestCase.fixture_path = File.expand_path("fixtures", __dir__)
+  ActionDispatch::IntegrationTest.fixture_path = ActiveSupport::TestCase.fixture_path
+  ActiveSupport::TestCase.file_fixture_path = ActiveSupport::TestCase.fixture_path + "/files"
+  ActiveSupport::TestCase.fixtures :all
+end
+
+# For generators
+require "rails/generators/test_case"
+require "generators/install_generator"

data/test/tmp/config/initializers/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/test/ts_schema_test.rb

@@ -0,0 +1,26 @@
+require "test_helper"
+
+class TsSchemaTest < ActiveSupport::TestCase
+	test "it loads custom config values from initializer" do
+		assert TsSchema.configuration.case
+		assert TsSchema.configuration.output
+		assert TsSchema.configuration.auto_generate
+		assert TsSchema.configuration.types
+		assert TsSchema.configuration.custom_types
+		assert TsSchema.configuration.default_type
+		assert TsSchema.configuration.include_associated
+		assert TsSchema.configuration.namespace
+	end
+
+	test "it generates a schema file" do
+		path = TsSchema.configuration.output
+		File.delete(path) if File.exist?(path)
+
+		TsSchema.generate
+		assert File.exist?(path)
+	end
+	
+  test "it has a version number" do
+    assert TsSchema::VERSION
+  end
+end

data/ts_schema.gemspec

@@ -0,0 +1,20 @@
+require_relative "lib/ts_schema/version"
+
+Gem::Specification.new do |spec|
+  spec.name        = "ts_schema"
+  spec.version     = TsSchema::VERSION
+  spec.authors     = ["Avram Walden"]
+  spec.email       = ["aviemet@gmail.com"]
+  spec.homepage    = "https://github.com/aviemet"
+  spec.summary     = "Generates typescript definitions from ActiveRecord"
+  spec.description = ""
+	spec.license     = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/aviemet/ts_schema"
+
+  spec.files = `git ls-files`.split("\n")
+	spec.require_paths = ["lib"]
+
+  spec.add_dependency 'rails', '~> 7.0', '>= 7.0.2.3'
+end