ts_schema 0.1.12 → 0.1.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8602c4a7ca10962ac35fd7c64a18d0669ed3f7d1ecdfdf7bc9c29a258bff754a
-  data.tar.gz: 322d779a986f2edf18d53829a6a8669326732be7aa4080567d2f4a1ecb1ebac0
+  metadata.gz: 8d6e690832a89b7cbde62be4a27e6dc9374be937df6627bff391db15c2f1e777
+  data.tar.gz: 9a6aec0dd27e0938cdd856ad723dc28898a582de67122b7ed9bc147ed6d335c6
 SHA512:
-  metadata.gz: 88fd048bbffe0eb93ac910bdcaf456a35e4ded1bf934dab9330d5ad1dba4d57ad3106c07a549a92555f312fe4d713d1b1b4b8c7d29d3909d85a7062df96e6426
-  data.tar.gz: 4c778296ba8de708bf9539bdcd163d79370c0477600d2bdbfd98a0e5c0355d3e02872728452be964922032cc880b3ac92ee270f40269e251734fb48ebfb74bcb
+  metadata.gz: 7df830e6e1a3543944f9550e57801f16c9ef2121462983c67944814e70f21c47f48b8fe6d5841286c92d1876cee50c8b32bf1533a49ae90f436234ed52723bcd
+  data.tar.gz: 1cc1c840bef030c08afee4480102d6a4cbda128d30c1de01969ad9b03312c9f71f3019c589ea382e23756ba267f0ab939bc839f62c79619381d7535e9be33de7

data/README.md

@@ -16,9 +16,9 @@ rails generate ts_schema:install
 
 ## Usage
 
-All options with their defaults are in the config file.
+All options with their defaults are in the generated initializer 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.
+By default, every migration 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:
 
@@ -28,7 +28,7 @@ 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"`.
+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
 

data/lib/generators/templates/ts_schema.rb

@@ -68,6 +68,19 @@ TsSchema.setup do |config|
   # ]
 
 
+  # Ignore certain fields, omitting them from the generated schema: :optional|(string)|false
+  # Key is the name of the field to override options for.
+  # [:optional] will make this an optional field by adding '?' to the defintion (example: password?: string)
+  # [(string)]  enter a field name override, for instance rename encrypted_password to password
+  #   In that scenario, also specifying passwoord as an optional field will append a ? in the output
+  # [:omit]     will omit the field from being output in the schema entirely
+  #
+  # config.field_overrides: {
+  #   encrypted_password: :password,
+  #   password: :optional,
+  # }
+
+
   # Namespace for generated types
   #
   # config.namespace = :schema

data/lib/ts_schema/configuration.rb

@@ -10,12 +10,16 @@ module TsSchema
       custom_types: {},
       default_type: :string,
       include_associated: true,
+      parent_classes: ["ApplicationRecord"],
+      additional_models: [],
+      field_overrides: {
+        "encrypted_password" => :password,
+        "password" => :optional,
+      },
       namespace: :schema,
-			schema_type: :interface,
+      schema_type: :interface,
       indent: :tab,
       spaces: 2,
-			parent_classes: ["ApplicationRecord"],
-			additional_models: []
     }
 
     attr_accessor(*DEFAULTS.keys)

data/lib/ts_schema/schema_generator.rb

@@ -7,6 +7,7 @@ module TsSchema
 
     def initialize(config = nil)
       @config = config || TsSchema::Configuration.new
+      @config.field_overrides = @config.field_overrides.stringify_keys
 			@models = []
 
       Rails.application.eager_load!
@@ -66,17 +67,34 @@ module TsSchema
 
     def map_column_types(model)
       model.columns.map { |i|
+        next if @config.field_overrides[i.name.to_s] == :omit
+
         type = @types[i.type.to_s] || @config.default_type
+        name = map_name(i.name)
+        null = i.null
+        null = true if @config.field_overrides[name]&.to_s == "optional"
 
-        if(enum = model.defined_enums[i.name])
+        if(enum = model.defined_enums[name])
           type = enum.keys.map { |k| "'#{k}'" }.join("|")
         end
-    
+
         {
-          name: "#{i.name}#{"?" if i.null }",
-          ts_type: "#{type}#{" | null" if i.null}"
+          name: "#{name}#{"?" if null }",
+          ts_type: "#{type}#{" | null" if null}"
         }
-      }
+      }.compact
+    end
+
+    def map_name(name)
+      final_name = name.to_s
+      return final_name unless @config.field_overrides[final_name]
+
+      if @config.field_overrides[final_name]&.to_s != "optional"
+        final_name = @config.field_overrides[final_name]&.to_s
+
+        final_name = map_name(final_name) if @config.field_overrides[final_name]
+      end
+      final_name
     end
 
     def map_associations(model)

data/lib/ts_schema/version.rb

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

data/lib/ts_schema.rb

@@ -34,4 +34,3 @@ module TsSchema
 end
 
 require "generators/install_generator"
-require "generators/generate_generator"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ts_schema
 version: !ruby/object:Gem::Version
-  version: 0.1.12
+  version: 0.1.13
 platform: ruby
 authors:
 - Avram Walden
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-06 00:00:00.000000000 Z
+date: 2022-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -63,7 +63,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/aviemet
   source_code_uri: https://github.com/aviemet/ts_schema
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -79,7 +79,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.2.32
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Generates typescript definitions from ActiveRecord
 test_files: []