schema_extractor 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 00af36b44554c23c33829b3c21cb5c392e2d15a9
+  data.tar.gz: 0c9aca168e4f9c53f8a95c20dc1bd44f8aea5182
+SHA512:
+  metadata.gz: fa8e4f468f32f9ef901a8c1c7f6dddc1e1cdaa698eb2b4e03db30b9062fffe2737c64e3133771ad15369ea9c0f54429673723e3489bdc00082fdcef43d3db055
+  data.tar.gz: d73cb1ff9a7aebb3eb9fe4fe5b06994eb76f6388f864f37a29fd2636c1fc5eed788f370369d577ef69c01f893e08e5ff6f6590e222bed70efc55577fa9ccc528

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.14.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in schema_extractor.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 nownabe
+
+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,41 @@
+# SchemaExtractor
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/schema_extractor`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'schema_extractor'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install schema_extractor
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/schema_extractor.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "schema_extractor"
+
+# 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/schema_extractor

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+lib = File.expand_path("../../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "schema_extractor/runner"
+
+SchemaExtractor::Runner.new(ARGV).run

data/lib/schema_extractor/extractors.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module SchemaExtractor
+  module Extractors
+    EXTRACTORS = {
+      mysql: "mysql",
+    }.freeze
+
+    class << self
+      def sources
+        EXTRACTORS.keys
+      end
+
+      def get_extractor(source, options)
+        underscored_name = EXTRACTORS[source.to_sym]
+        require "schema_extractor/#{underscored_name}/extractor"
+        klass = SchemaExtractor.const_get("#{underscored_name.capitalize}::Extractor")
+        klass.new(options)
+      end
+    end
+  end
+end

data/lib/schema_extractor/field.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module SchemaExtractor
+  class Field
+    class InvalidFieldNameError < StandardError; end
+    class InvalidFieldTypeError < StandardError; end
+    class InvalidNullableValueError < StandardError; end
+
+    TYPES = %i[
+      date
+      datetime
+      decimal
+      float
+      integer
+      string
+    ].freeze
+    attr_reader :name
+    attr_reader :type
+    attr_reader :nullable
+    attr_reader :default
+
+    def initialize(name:, type:, nullable:, default: nil)
+      @name = validate_name!(name)
+      @type = validate_type!(type)
+      @nullable = validate_nullable!(nullable)
+      @default = validate_default!(default)
+    end
+
+    def nullable?
+      nullable
+    end
+
+    private
+
+    def validate_default!(default)
+      default
+    end
+
+    def validate_name!(name)
+      return name if name&.instance_of?(String) && !name.empty?
+      raise InvalidFieldNameError, "#{name} is invalid field name."
+    end
+
+    def validate_nullable!(nullable)
+      unless [true, false].include?(nullable)
+        raise(InvalidNullableValueError, "#{nullable} is invalid for nullable value.")
+      end
+      nullable
+    end
+
+    def validate_type!(type)
+      type = type&.to_sym
+      return type if type && TYPES.include?(type)
+      raise(InvalidFieldTypeError, "#{type} is invalid field type.")
+    end
+  end
+end

data/lib/schema_extractor/formatters/bigquery.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require "json"
+
+module SchemaExtractor
+  module Formatters
+    class Bigquery
+      class InvalidBigqueryFieldTypeError < StandardError; end
+
+      def format(schema)
+        JSON.pretty_generate(
+          schema.fields.map do |f|
+            {
+              name: f.name,
+              type: bq_type(f),
+              mode: bq_mode(f)
+            }
+          end
+        )
+      end
+
+      def extension
+        ".json"
+      end
+
+      private
+
+      def bq_mode(f)
+        f.nullable? && f.default.nil? ? "NULLABLE" : "REQUIRED"
+      end
+
+      def bq_type(f)
+        case f.type
+        when :decimal, :float
+          "FLOAT"
+        when :integer
+          "INTEGER"
+        when :string
+          "STRING"
+        when :date
+          "DATE"
+        when :datetime
+          "TIMESTAMP"
+        else
+          raise InvalidBigqueryFieldTypeError, "#{f.type} is invalid type for bigquery field."
+        end
+      end
+    end
+  end
+end

data/lib/schema_extractor/formatters.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module SchemaExtractor
+  module Formatters
+    FORMATTERS = {
+      bq: "bigquery",
+      bigquery: "bigquery",
+    }.freeze
+
+    class << self
+      def formats
+        FORMATTERS.keys
+      end
+
+      def get_formatter(format)
+        underscored_name = FORMATTERS[format.to_sym]
+        require "schema_extractor/formatters/#{underscored_name}"
+        klass = SchemaExtractor::Formatters.const_get(underscored_name.capitalize)
+        klass.new
+      end
+    end
+  end
+end

data/lib/schema_extractor/mysql/extractor.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require "io/console"
+
+require "mysql2"
+
+require "schema_extractor/field"
+require "schema_extractor/schema"
+
+module SchemaExtractor
+  module Mysql
+    class UnknownFieldTypeError < StandardError; end
+
+    class Extractor
+      attr_reader :options
+
+      def initialize(options)
+        @options = options
+      end
+
+      def extract
+        tables.map { |t| get_schema(t) }
+      end
+
+      private
+
+      def ask_password
+        print "Password: "
+        STDIN.noecho(&:gets).chomp.tap { puts }
+      end
+
+      def build_field(row)
+        Field.new(
+          name: detect_name(row),
+          type: detect_type(row),
+          nullable: detect_nullable(row),
+          default: detect_default_value(row)
+        )
+      end
+
+      def client
+        @client ||= Mysql2::Client.new(
+          host: options.fetch(:host, "localhost"),
+          port: options.fetch(:port, "3306"),
+          username: options.fetch(:user, "root"),
+          password: options.fetch(:password) { ask_password },
+          database: options.fetch(:database)
+        )
+      end
+
+      def detect_default_value(row)
+        row["Default"]
+      end
+
+      def detect_name(row)
+        row["Field"]
+      end
+
+      def detect_nullable(row)
+        row["Null"] == "YES"
+      end
+
+      def detect_type(row)
+        case row["Type"]
+        when /^date/
+          :date
+        when /^datetime/
+          :datetime
+        when /^decimal/
+          :decimal
+        when /^float/
+          :float
+        when /^bigint/, /^int/, /^smallint/, /^tinyint/
+          :integer
+        when /^longtext/, /^text/, /^varchar/
+          :string
+        else
+          raise UnknownFieldTypeError, "#{row['Type']} is unknown type."
+        end
+      end
+
+      def get_schema(table)
+        schema = Schema.new(table)
+        client.query("describe #{table}").each { |r| schema.add(build_field(r)) }
+        schema
+      end
+
+      def tables
+        @tables ||= client.query("show tables").map { |row| row.values.first }
+      end
+    end
+  end
+end

data/lib/schema_extractor/option_parser.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require "slop"
+
+require "schema_extractor/extractors"
+require "schema_extractor/formatters"
+
+module SchemaExtractor
+  class OptionParser
+    def parse(args)
+      parser.parse(args)
+    end
+
+    private
+
+    def banner
+      "usage: schema_extractor [options]"
+    end
+
+    def formats
+      Formatters.formats.join(", ")
+    end
+
+    def options
+      Slop::Options.new do |o|
+        o.banner = banner
+
+        o.string(
+          "-s",
+          "--source",
+          "Source database type. Supported sources: #{sources}",
+          default: "mysql"
+        )
+        o.string(
+          "-f",
+          "--format",
+          "Output format. Supported formats: #{formats}",
+          default: "bigquery"
+        )
+        o.string(
+          "-o",
+          "--output",
+          "Output directory.",
+          default: "."
+        )
+
+        o.string "-h", "--host", "Host of database."
+        o.string "-u", "--user", "User of database."
+        o.string "-p", "--password", "Password of database."
+        o.string "-P", "--port", "Port of database."
+        o.string "-d", "--database", "Database name."
+
+        o.on "-v", "--version", "Show version." do
+          require "schema_extractor/version"
+          puts SchemaExtractor::VERSION
+          exit
+        end
+
+        o.on "--help", "Show this message." do
+          puts o
+          exit
+        end
+      end
+    end
+
+    def parser
+      Slop::Parser.new(options)
+    end
+
+    def sources
+      Extractors.sources.join(", ")
+    end
+  end
+end

data/lib/schema_extractor/runner.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "schema_extractor/extractors"
+require "schema_extractor/formatters"
+require "schema_extractor/option_parser"
+
+module SchemaExtractor
+  class Runner
+    attr_reader :options
+
+    def initialize(args)
+      @options = OptionParser.new.parse(args)
+    end
+
+    def run
+      schemas = extractor.extract
+      schemas.each { |s| output(s) }
+    end
+
+    private
+
+    def extractor
+      SchemaExtractor::Extractors.get_extractor(options[:source], options.to_hash.compact)
+    end
+
+    def formatter
+      @formatter ||= SchemaExtractor::Formatters.get_formatter(options[:format])
+    end
+
+    def output(schema)
+      path = File.join(options[:output], "#{schema.name}#{formatter.extension}")
+      File.write(path, formatter.format(schema))
+    end
+  end
+end

data/lib/schema_extractor/schema.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module SchemaExtractor
+  class Schema
+    attr_reader :fields
+    attr_reader :name
+
+    def initialize(name)
+      @name = name
+      @fields = []
+    end
+
+    def add(field)
+      fields.push(field)
+    end
+  end
+end

data/lib/schema_extractor/version.rb

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

data/lib/schema_extractor.rb

@@ -0,0 +1,5 @@
+require "schema_extractor/version"
+
+module SchemaExtractor
+  # Your code goes here...
+end

data/schema_extractor.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "schema_extractor/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "schema_extractor"
+  spec.version       = SchemaExtractor::VERSION
+  spec.authors       = ["nownabe"]
+  spec.email         = ["nownabe@gmail.com"]
+
+  spec.summary       = "Extract DB schema."
+  spec.homepage      = "https://github.com/nownabe/schema_extractor"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+
+  spec.add_runtime_dependency "mysql2"
+  spec.add_runtime_dependency "slop"
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: schema_extractor
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- nownabe
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  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: slop
+  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'
+description: 
+email:
+- nownabe@gmail.com
+executables:
+- schema_extractor
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/schema_extractor
+- lib/schema_extractor.rb
+- lib/schema_extractor/extractors.rb
+- lib/schema_extractor/field.rb
+- lib/schema_extractor/formatters.rb
+- lib/schema_extractor/formatters/bigquery.rb
+- lib/schema_extractor/mysql/extractor.rb
+- lib/schema_extractor/option_parser.rb
+- lib/schema_extractor/runner.rb
+- lib/schema_extractor/schema.rb
+- lib/schema_extractor/version.rb
+- schema_extractor.gemspec
+homepage: https://github.com/nownabe/schema_extractor
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Extract DB schema.
+test_files: []