sqldef 0.0.0 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9df5d37c2955058f654420ef2cdf85130477dc75446c3407e5d010e781997cbf
-  data.tar.gz: 29f0f569604a5b0dbeccb89d484e0231e098e31329a70e6a0dee8a38c8e8e623
+  metadata.gz: 54c5bb0e7a737257f4270bb013a2e29140ede972ef5cf586431eb8bb0d23b09e
+  data.tar.gz: bee04b0a4b23e709c4f9211f89bac792efb7906248242ab8898a8cab18a35fe4
 SHA512:
-  metadata.gz: 237e64c10ef093881093da17f1c96435fcd5b5559b0751778490570e8d61108e5b526f479cd04e137f5a59b95a96d23a2b578293032a98cc00cebbf862ebadf4
-  data.tar.gz: c3135845cbf2ac3f2680821bd2c9ce902545b2e99986d31ae67980f7888cc22a0e41d99419a72b3e2371b68deb85a966ccd075f9956c8f78762f9e56af892a61
+  metadata.gz: 6c5e34db8bf2ed57bc4f82cfcc6b6165dcdd3185b7a222e1b4b5cf768b8f937bb8398005a1e5bf12b8891bfef27b5ec0e930893a343a15749976386a625c12ea
+  data.tar.gz: 10bc6159532d7bd5a7d18bb14d1e4f453c833a5a9a52f479c04dc85fc24823a864367bfba49fb96908a356ed69bcd74d4024726dc0a7e836f35d3a2c3638ab6e

data/.github/workflows/main.yml

@@ -0,0 +1,18 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.0.0
+    - name: Run the default task
+      run: |
+        gem install bundler -v 2.2.3
+        bundle install
+        bundle exec rake

data/Gemfile

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
 # Specify your gem's dependencies in sqldef.gemspec
 gemspec
 
-gem "rake", "~> 12.0"
+gem "rake", "~> 13.0"

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2020 Takashi Kokubun
+Copyright (c) 2021 Takashi Kokubun
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,39 +1,72 @@
-# Sqldef
+# sqldef-ruby
 
-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/sqldef`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Ruby interface to call [sqldef](https://github.com/k0kubun/sqldef).
 
 ## Installation
 
-Add this line to your application's Gemfile:
-
 ```ruby
 gem 'sqldef'
 ```
 
-And then execute:
+## Usage
+### Download
 
-    $ bundle install
+You can download `mysqldef`, `psqldef`, or `sqlite3def`.
 
-Or install it yourself as:
+```rb
+Sqldef.bin = './bin'
+Sqldef.download(:psqldef)
+```
 
-    $ gem install sqldef
+`download` is automatically executed by the following methods too.
 
-## Usage
+### Export
 
-TODO: Write usage instructions here
+You can export the database schema to a file.
 
-## Development
+```rb
+Sqldef.export(
+  command:  :psqldef,
+  host:     host,
+  port:     port,
+  user:     user,
+  password: password,
+  database: database,
+  path:     'db/schema.sql',
+)
+```
+
+### Dry Run
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+You can show DDLs to be executed.
 
-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).
+```rb
+Sqldef.dry_run(
+  command:  :psqldef,
+  host:     host,
+  port:     port,
+  user:     user,
+  password: password,
+  database: database,
+  path:     'db/schema.sql',
+)
+```
 
-## Contributing
+### Apply
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/sqldef.
+You can run DDLs to match the schema.
 
+```rb
+Sqldef.apply(
+  command:  :psqldef,
+  host:     host,
+  port:     port,
+  user:     user,
+  password: password,
+  database: database,
+  path:     'db/schema.sql',
+)
+```
 
 ## License
 

data/Rakefile

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
-task :default => :spec
+task default: %i[]

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "bundler/setup"
 require "sqldef"

data/lib/sqldef.rb

@@ -1,6 +1,128 @@
-require "sqldef/version"
+# frozen_string_literal: true
+
+require 'etc'
+require 'fileutils'
+require 'net/http'
+require 'rubygems/package'
+require 'stringio'
+require 'uri'
+require 'zlib'
+require_relative 'sqldef/version'
 
 module Sqldef
-  class Error < StandardError; end
-  # Your code goes here...
+  GOARCH = {
+    'x86_64'  => 'amd64',
+    'aarch64' => 'arm64',
+    # TODO: add arm and 386
+  }
+  private_constant :GOARCH
+
+  COMMANDS = %w[
+    mysqldef
+    psqldef
+    sqlite3def
+  ]
+  private_constant :COMMANDS
+
+  @bin = Dir.pwd
+
+  class << self
+    attr_accessor :bin
+
+    # @param [String,Symbol] command - mysqldef, psqldef, sqllite3def
+    # @param [String] path - Schema export path
+    def export(command:, path:, host:, port: nil, user:, password: nil, database:)
+      sqldef = download(command)
+      schema = IO.popen(
+        [
+          sqldef,
+          "--user=#{user}", *(["--password=#{password}"] if password),
+          "--host=#{host}", *(["--port=#{port}"] if port),
+          '--export', database,
+        ],
+        &:read
+      )
+      raise "Failed to execute '#{sqldef}'" unless $?.success?
+      File.write(path, schema)
+    end
+
+    # @param [String,Symbol] command - mysqldef, psqldef, sqllite3def
+    # @param [String] path - Schema file path
+    def dry_run(command:, path:, host:, port: nil, user:, password: nil, database:)
+      sqldef = download(command)
+      execute(
+        sqldef,
+        "--user=#{user}", *(["--password=#{password}"] if password),
+        "--host=#{host}", *(["--port=#{port}"] if port),
+        '--dry-run', database,
+        in: path,
+      )
+    end
+
+    # @param [String,Symbol] command - mysqldef, psqldef, sqllite3def
+    # @param [String] path - Schema file path
+    def apply(command:, path:, host:, port: nil, user:, password: nil, database:)
+      sqldef = download(command)
+      execute(
+        sqldef,
+        "--user=#{user}", *(["--password=#{password}"] if password),
+        "--host=#{host}", *(["--port=#{port}"] if port),
+        database,
+        in: path,
+      )
+    end
+
+    # @param [String,Symbol] command - mysqldef, psqldef, sqllite3def
+    # @return String - command path
+    def download(command)
+      path = File.join(bin, command = command.to_s)
+      return path if File.executable?(path)
+
+      print("Downloading '#{command}' under '#{bin}'... ")
+      resp = get(build_url(command), code: 302) # Latest
+      resp = get(resp['location'],   code: 302) # vX.Y.Z
+      resp = get(resp['location'],   code: 200) # Binary
+
+      gzip = Zlib::GzipReader.new(StringIO.new(resp.body))
+      Gem::Package::TarReader.new(gzip) do |tar|
+        unless file = tar.find { |f| f.full_name == command }
+          raise "'#{command}' was not found in the archive"
+        end
+        File.binwrite(path, file.read)
+      end
+
+      FileUtils.chmod('+x', path)
+      puts 'done.'
+      path
+    end
+
+    private
+
+    def execute(*cmd, **opts)
+      unless system(*cmd, **opts)
+        raise "Failed to execute '#{cmd.first}'"
+      end
+    end
+
+    def build_url(command)
+      unless COMMANDS.include?(command)
+        raise "Unexpected sqldef command: #{command}" 
+      end
+      os = Etc.uname.fetch(:sysname).downcase
+      arch = GOARCH.fetch(Etc.uname.fetch(:machine))
+      "https://github.com/k0kubun/sqldef/releases/latest/download/#{command}_#{os}_#{arch}.tar.gz"
+    end
+
+    # TODO: Retry transient errors
+    def get(url, code: nil)
+      uri = URI.parse(url)
+      Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == 'https') do |http|
+        http.get("#{uri.path}?#{uri.query}")
+      end.tap do |resp|
+        if code && resp.code != code.to_s
+          raise "Expected '#{url}' to return #{code}, but got #{resp.code}: #{resp.body}"
+        end
+      end
+    end
+  end
 end

data/lib/sqldef/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Sqldef
-  VERSION = "0.0.0"
+  VERSION = '0.1.0'
 end

data/sqldef.gemspec

@@ -1,24 +1,28 @@
+# frozen_string_literal: true
+
 require_relative 'lib/sqldef/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "sqldef"
+  spec.name          = 'sqldef'
   spec.version       = Sqldef::VERSION
-  spec.authors       = ["Takashi Kokubun"]
-  spec.email         = ["takashikkbn@gmail.com"]
+  spec.authors       = ['Takashi Kokubun']
+  spec.email         = ['takashikkbn@gmail.com']
 
-  spec.summary       = %q{Placeholder for future sqldef}
-  spec.description   = %q{Placeholder for future sqldef}
-  spec.homepage      = "https://github.com/k0kubun/sqldef"
-  spec.license       = "MIT"
+  spec.summary       = 'Idempotent MySQL/PostgreSQL schema management by SQL'
+  spec.description   = 'Idempotent MySQL/PostgreSQL schema management by SQL'
+  spec.homepage      = 'https://github.com/sqldef/sqldef-ruby'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
 
-  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
 
   # 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)/}) }
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
 end

metadata

@@ -1,25 +1,25 @@
 --- !ruby/object:Gem::Specification
 name: sqldef
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors:
 - Takashi Kokubun
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-07 00:00:00.000000000 Z
+date: 2021-03-13 00:00:00.000000000 Z
 dependencies: []
-description: Placeholder for future sqldef
+description: Idempotent MySQL/PostgreSQL schema management by SQL
 email:
 - takashikkbn@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/main.yml"
 - ".gitignore"
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -28,12 +28,13 @@ files:
 - lib/sqldef.rb
 - lib/sqldef/version.rb
 - sqldef.gemspec
-homepage: https://github.com/k0kubun/sqldef
+homepage: https://github.com/sqldef/sqldef-ruby
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/k0kubun/sqldef
-post_install_message: 
+  homepage_uri: https://github.com/sqldef/sqldef-ruby
+  source_code_uri: https://github.com/sqldef/sqldef-ruby
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -41,15 +42,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
-summary: Placeholder for future sqldef
+summary: Idempotent MySQL/PostgreSQL schema management by SQL
 test_files: []

data/Gemfile.lock

@@ -1,19 +0,0 @@
-PATH
-  remote: .
-  specs:
-    sqldef (0.1.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    rake (12.3.3)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  rake (~> 12.0)
-  sqldef!
-
-BUNDLED WITH
-   2.1.2