schema2type 0.2.2 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d907bb961b8e4dd1d7c94732012dc0aafd75c4e29aef02027ef5b5c7751889f
-  data.tar.gz: 6494b9e501419c0f9a300ff5b2d056f9224296ddb262b4f709337dd53cabe765
+  metadata.gz: 66c06b1860fe83c6983e2c0249715531317885d9c62616908afc9e02d56eaa3f
+  data.tar.gz: afa4290333490132677c1da1387d5b7905a09541e5150addc5bdf5c3b97a8698
 SHA512:
-  metadata.gz: 92b851eb75ea3a0a08bbb9a1e9d9f9c097d47b5d81b8d129afc396cd5f9cc27f7e1d8958a702e167457f9adf6c7b8044cd07d4c0a99f59422e5e7b7d3f4c1320
-  data.tar.gz: 8e4cec8d0f67e5835ff6dd7c28a457b364c27458f9ce1734a211961ffb28772b726183d990fcbc6682c56cddca568900a51361df75b859b5c2dcaf338ccfec95
+  metadata.gz: 653ce6ec1e4cf47eeb7f79c70ea9da58d348f8cc401949e567e6c8bd807897e6e5a4fbb770b28f98e215ae2abfc2ef71e688227f556df67daefd2e8d07af6017
+  data.tar.gz: d050b51ab3cf3be417eedba84208cd35a98fa68a15ca89a509c3730392345dac06d71d8bccffdcefeeb1742c5b1b205d6f22b55b0cf72353207ab37787dbc020

data/.ruby-version

@@ -0,0 +1 @@
+2.7.0

data/Gemfile

@@ -1,4 +1,5 @@
 source "https://rubygems.org"
+ruby '2.7.0'
 
 # Specify your gem's dependencies in schema2type.gemspec
 gemspec

data/Gemfile.lock

@@ -1,39 +1,41 @@
 PATH
   remote: .
   specs:
-    schema2type (0.2.2)
+    schema2type (0.3.0)
       activesupport
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.2.2)
+    activesupport (6.0.3.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-    concurrent-ruby (1.1.4)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    concurrent-ruby (1.1.6)
     diff-lcs (1.3)
-    i18n (1.5.3)
+    i18n (1.8.3)
       concurrent-ruby (~> 1.0)
-    minitest (5.11.3)
-    rake (10.5.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.2)
+    minitest (5.14.1)
+    rake (13.0.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
     thread_safe (0.3.6)
-    tzinfo (1.2.5)
+    tzinfo (1.2.7)
       thread_safe (~> 0.1)
+    zeitwerk (2.3.0)
 
 PLATFORMS
   ruby
@@ -41,9 +43,12 @@ PLATFORMS
 DEPENDENCIES
   activesupport
   bundler (~> 2.0)
-  rake (~> 10.0)
+  rake (~> 13.0)
   rspec (~> 3.0)
   schema2type!
 
+RUBY VERSION
+   ruby 2.7.0p0
+
 BUNDLED WITH
-   2.0.1
+   2.1.4

data/README.md

@@ -22,12 +22,13 @@ Automatically have the following TypesScript type generated.
 ```typescript
 declare namespace schema {
   type User = {
-    name: string | null
-    age: number | null
-    sales: number | null
-    paid: boolean
-    createdAt: Date
-    updatedAt: Date
+    id: number;
+    name: string | null;
+    age: number | null;
+    sales: number | null;
+    paid: boolean;
+    createdAt: string;
+    updatedAt: string;
   }
 }
 ```
@@ -81,10 +82,10 @@ the schema2type convert as per this conversion table.
 | float | number |
 | decimal | number |
 | boolean | boolean |
-| date | Date |
-| datetime | Date |
-| timestamp | Date |
-| datetime_with_timezone | Date |
+| date | string |
+| datetime | string |
+| timestamp | string |
+| datetime_with_timezone | string |
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/exe/schema2type

@@ -5,4 +5,4 @@ require 'schema2type'
 
 params = ARGV.getopts('s:o:n:', 'snake')
 
-Schema2type.execute(input_file: params['s'], out_file: params['o'], name_space: params['n'], snake_case: params['snake'])
+Schema2type.execute(input_file: params['s'], out_file: params['o'], name_space: params['n'], is_snake_case: params['snake'])

data/lib/schema2type/cli.rb

@@ -1,11 +1,9 @@
 module Schema2type
-
   DEFAULT_SCHEMA_PATH = "./db/schema.rb".freeze
   DEFAULT_NAME_SPACE = "schema".freeze
 
-  def self.execute(input_file:, out_file:, name_space:, snake_case:)
-
-    result = eval(File.read(input_file || DEFAULT_SCHEMA_PATH), CovertService.new(snake_case).get_binding)
+  def self.execute(input_file:, out_file:, name_space:, is_snake_case:)
+    resultHash = eval(File.read(input_file || DEFAULT_SCHEMA_PATH), CovertService.new(is_snake_case).get_binding)
 
     File.open(out_file, "w") do |f|
       f.puts <<~EOS
@@ -13,11 +11,11 @@ module Schema2type
 
         /**
          * auto-generated file
-         * schema version: #{result[:version]}
+         * schema version: #{resultHash[:version]}
          * This file was automatically generated by schema2type
          */
         declare namespace #{name_space || DEFAULT_NAME_SPACE} {
-          #{result[:lines]}
+          #{resultHash[:lines]}
         }
       EOS
     end

data/lib/schema2type/conversion_table.yml

@@ -10,7 +10,7 @@ bigint: number
 float: number
 decimal: number
 boolean: boolean
-date: Date
-datetime: Date
-timestamp: Date
-datetime_with_timezone: Date
+date: string
+datetime: string
+timestamp: string
+datetime_with_timezone: string

data/lib/schema2type/covert_service.rb

@@ -1,28 +1,36 @@
 module Schema2type
   class CovertService
-    def initialize(snake_case)
+    def initialize(is_snake_case)
       @converted_types = []
-      @snake_case = snake_case
+      @is_snake_case = is_snake_case
     end
 
     def get_binding
       binding
     end
 
-    def create_table(table_name, *)
-      converter = SchemaConverter.new(table_name: table_name, snake_case: @snake_case)
+    # mock method for create_table in schema.rb
+    def convert_schema_to_type(table_name, *)
+      converter = SchemaConverter.new(table_name: table_name, is_snake_case: @is_snake_case)
       yield converter
-      @converted_types.concat converter.result
+      @converted_types.concat converter.converted_type_lines
+    end
+
+    def skip_dsl(*)
+      @converted_types
     end
 
     def method_missing(*)
       # To exclude unnecessary methods
+      # TODO: add error handling
     end
 
     def self.method_missing(*)
       # To exclude unnecessary methods
+      # TODO: add error handling
     end
 
+    # mock module and method for shcema.rb
     module ActiveRecord
       module Schema
         def self.define(*arg)
@@ -35,5 +43,8 @@ module Schema2type
         end
       end
     end
+
+    alias create_table convert_schema_to_type
+    alias add_foreign_key skip_dsl
   end
 end

data/lib/schema2type/schema_converter.rb

@@ -3,43 +3,41 @@ require 'active_support/inflector'
 
 module Schema2type
   class SchemaConverter
-    attr_reader :property_lines, :table_name, :snake_case
+    attr_reader :property_lines, :table_name, :is_snake_case
 
-    TYPE_STRING = 'string'.freeze
-    TYPE_NUMBER = 'number'.freeze
-    TYPE_BOOLEAN = 'boolean'.freeze
-    TYPE_DATE = 'Date'.freeze
     COLUMN_METHODS = YAML.load_file(File.expand_path(__dir__) + '/conversion_table.yml').to_a
+    ID_PROPERTY_LINE_TEXT = "  id: number;".freeze
 
     def self.define_convert_methods(methods)
       methods.each do |m|
         define_method(m[0]) do |name, *options|
-          push_property_line name: name, type: m[1], options: options
+          convert_property_line_and_push name: name, type: m[1], options: options
         end
       end
     end
 
     define_convert_methods COLUMN_METHODS
 
-    def initialize(table_name:, snake_case: false)
+    def initialize(table_name:, is_snake_case: false)
       @property_lines = []
       @table_name = table_name.singularize.camelize
-      @snake_case = snake_case
+      @is_snake_case = is_snake_case
     end
 
-    def result
-      ["type #{table_name} = {", property_lines, "}\n"].flatten
+    def converted_type_lines
+      ["type #{table_name} = {", ID_PROPERTY_LINE_TEXT, property_lines, "}\n"].flatten
     end
 
     def method_missing(*)
       # To exclude unnecessary methods
+      # TODO: add error handling
     end
 
     private
 
-    def push_property_line(name:, type:, options:)
+    def convert_property_line_and_push(name:, type:, options:)
       is_non_nullable = options[0] && options[0].key?(:null) && !options[0][:null]
-      formatted_name = snake_case ? name.underscore : name.camelcase(:lower)
+      formatted_name = is_snake_case ? name.underscore : name.camelcase(:lower)
       property_line = is_non_nullable ? "#{formatted_name}: #{type};" : "#{formatted_name}: #{type} | null;"
 
       property_lines << "  #{property_line}"

data/lib/schema2type/version.rb

@@ -1,3 +1,3 @@
 module Schema2type
-  VERSION = '0.2.2'
+  VERSION = '0.3.1'
 end

data/schema2type.gemspec

@@ -24,6 +24,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.add_runtime_dependency "activesupport"
   spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: schema2type
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.1
 platform: ruby
 authors:
 - ryo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-22 00:00:00.000000000 Z
+date: 2021-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -77,6 +77,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".ruby-version"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -113,7 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: generate TypeScript type definitions from Rails schema.rb