schema2type 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2fcde311f61daf06a1d64a12f7e70ee27b548621bd3993fd719f187a9b503390
+  data.tar.gz: 2b8074204ba5df39032669c71fe8f2b63b06d95ecb9976f38b823f229af79c00
+SHA512:
+  metadata.gz: b42f752d2d9b2f288dd2e3a37a7180a8b2ada496180dc27cee30007ea311026ae7a9371b6831963acb0461fb0ab9e1307a42ca163207e27e65c87cb6eb15fd1c
+  data.tar.gz: 3c15d5cbea0721acb31e45fb01a4d751b24d6e857fd7eb5c70f13032a3d360187f816502a02e7a777e5897d125d7e841aa638e1e6dd59d7e9015135b3ca12b51

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.1
+before_install: gem install bundler -v 2.0.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at ba068082@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in schema2type.gemspec
+gemspec
+
+gem "activesupport"

data/Gemfile.lock

@@ -0,0 +1,49 @@
+PATH
+  remote: .
+  specs:
+    schema2type (0.1.0)
+      activesupport
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    concurrent-ruby (1.1.4)
+    diff-lcs (1.3)
+    i18n (1.5.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)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport
+  bundler (~> 2.0)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  schema2type!
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 ryo
+
+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,63 @@
+# schema2type
+Using schema2type, you can generate TypeScript type definitions from Rails'schema.rb automatically.
+
+Start with a schema.rb:
+
+```ruby
+ActiveRecord::Schema.define(version: xxxx) do
+  create_table "Users", force: :cascade, options: "ENGINE=InnoDB DEFAULT CHARSET=utf8" do |t|
+    t.string "name"
+    t.integer "age"
+    t.bigint "sales"
+    t.boolean "paid", null: false
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+    t.index ["patient_id"], name: "index_histories_on_patient_id"
+  end
+end
+```
+
+Automatically have the following TypesScript type generated
+
+```typescript
+declare namespace schema {
+  type User = {
+    name: string | null
+    age: number | null
+    sales: number | null
+    paid: boolean
+    created_at: Date
+    updated_at: Date
+  }
+}
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'schema2type'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install schema2type
+    
+
+
+## Usage
+
+```
+bundle exec schema2type -s schema.rb -o schema.d.ts -n production_name
+```
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "schema2type"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/schema2type

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'schema2type'
+
+params = ARGV.getopts('s:o:n:')
+
+Schema2type.execute(input_file: params["s"], out_file: params["o"], name_space: params["n"])

data/lib/schema2type/cli.rb

@@ -0,0 +1,48 @@
+require 'date'
+
+module Schema2type
+
+  $convert_types = []
+  $schema_version = ''
+
+  def self.execute(input_file:, out_file:, name_space:)
+
+    eval(File.read(input_file))
+
+    convert_type_text = $convert_types.map { |t| "  #{t}" }.join("\n").strip
+
+    File.open(out_file, "w") do |f|
+    f.puts <<-EOS
+/* eslint no-unused-vars: 0 */
+
+/**
+ * auto-generated file @#{Date.today.to_time}
+ * schema version: #{$schema_version}
+ * This file was automatically generated by schema2type
+ */
+declare namespace #{name_space ||= "schema"} {
+  #{convert_type_text}
+}
+      EOS
+    end
+  end
+
+  private
+
+  def self.create_table(table_name, *arg, &block)
+    converter = SchemaConverter.new(table_name: table_name)
+    block.call(converter)
+    converter.finalize
+
+    $convert_types.concat(converter.out_text)
+  end
+
+  module ActiveRecord
+    class Schema
+      def self.define(version, &block)
+        $schema_version = version[:version]
+        block.call
+      end
+    end
+  end
+end

data/lib/schema2type/schema_converter.rb

@@ -0,0 +1,79 @@
+require "active_support/inflector"
+
+module Schema2type
+  class SchemaConverter
+    attr_accessor :out_text
+    attr_reader :table_name
+
+    TYPE_STRING = "string"
+    TYPE_NUMBER = "number"
+    TYPE_BOOLEAN = "string"
+    TYPE_DATE = "Date"
+
+    def initialize(table_name:)
+      @out_text = []
+      @table_name = table_name
+    end
+
+    def finalize
+      @out_text.unshift "type #{@table_name.singularize.camelize} = {"
+      @out_text << "}\n"
+    end
+
+    def date(name, *options)
+      push_property_line name: name, type: TYPE_STRING, options: options
+    end
+
+    def string(name, *options)
+      push_property_line name: name, type: TYPE_STRING, options: options
+    end
+
+    def integer(name, *options)
+      push_property_line name: name, type: TYPE_NUMBER, options: options
+    end
+
+    def bigint(name, *options)
+      push_property_line name: name, type: TYPE_NUMBER, options: options
+    end
+
+    def text(name, *options)
+      push_property_line name: name, type: TYPE_STRING, options: options
+    end
+
+    def boolean(name, *options)
+      push_property_line name: name, type: TYPE_BOOLEAN, options: options
+    end
+
+    def decimal(name, *options)
+      push_property_line name: name, type: TYPE_NUMBER, options: options
+    end
+
+    def json(name, *options)
+      push_property_line name: name, type: TYPE_STRING, options: options
+    end
+
+    def binary(name, *options)
+      push_property_line name: name, type: TYPE_STRING, options: options
+    end
+
+    def datetime(name, *options)
+      push_property_line name: name, type: TYPE_DATE, options: options
+    end
+
+    def timestamp(name, *options)
+      push_property_line name: name, type: TYPE_DATE, options: options
+    end
+
+    def index(*arg)
+    end
+
+    private
+
+    def push_property_line(name:, type:, options:)
+      is_non_nullable = options[0] && options[0].has_key?(:null) && !options[0][:null]
+      property_line = is_non_nullable ? "#{name}: #{type}" : "#{name}: #{type} | null"
+
+      @out_text << "  #{property_line}"
+    end
+  end
+end

data/lib/schema2type/version.rb

@@ -0,0 +1,3 @@
+module Schema2type
+  VERSION = "0.1.0"
+end

data/lib/schema2type.rb

@@ -0,0 +1,4 @@
+require "schema2type/version"
+require 'schema2type/schema_converter'
+require "schema2type/cli"
+

data/schema2type.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "schema2type/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "schema2type"
+  spec.version       = Schema2type::VERSION
+  spec.authors       = ["ryo"]
+  spec.email         = ["ba068082@gmail.com"]
+
+  spec.summary       = %q{generate TypeScript type definitions from Rails schema.rb}
+  spec.description   = %q{Using schema2type, you can generate TypeScript type definitions from Rails'schema.rb automatically.}
+  spec.homepage      = "https://github.com/kawamataryo/schema2type"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  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 "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: schema2type
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ryo
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-04-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Using schema2type, you can generate TypeScript type definitions from
+  Rails'schema.rb automatically.
+email:
+- ba068082@gmail.com
+executables:
+- schema2type
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/schema2type
+- lib/schema2type.rb
+- lib/schema2type/cli.rb
+- lib/schema2type/schema_converter.rb
+- lib/schema2type/version.rb
+- schema2type.gemspec
+homepage: https://github.com/kawamataryo/schema2type
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.2
+signing_key: 
+specification_version: 4
+summary: generate TypeScript type definitions from Rails schema.rb
+test_files: []