seed-snapshot 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e364fa35f42da8d2117d456964ec7981b6733bec
+  data.tar.gz: 6f675c704dcafe46cfac09faa3f850a075c39519
+SHA512:
+  metadata.gz: e292f7ce0c52cdfbe323239f955b589fd21faa20bd9eeb495bddd88322634de1864d4b68adb2aed1242a436eaa7ea8dc5b02dda53301ad39061ea003fd435741
+  data.tar.gz: 35634c999b8d4bd412bb5bb08af9c9a6c98b823b48d310add17e25b848b7671b5b6fe650180d45a7707acb7ed8ba84a9a048c0ecefb92c0873abe7826bf1cca5

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+.DS_Store
+/vendor
+
+debug.log
+test/config.yml

data/.travis.yml

@@ -0,0 +1,17 @@
+language: ruby
+rvm:
+  - 2.3.4
+  - 2.4.1
+  - ruby-head
+env:
+  - "AR_VERSION=4.2.8"
+  - "AR_VERSION=4.2.9"
+  - "AR_VERSION=5.0.4"
+  - "AR_VERSION=5.1.3"
+sudo: false
+cache: bundler
+branches:
+  only:
+    - master
+before_install:
+  - mysql -e "create database activerecord_unittest;"

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem "activerecord", "~> #{ENV['AR_VERSION']}" if ENV['AR_VERSION']
+
+# Specify your gem's dependencies in seed-snapshot.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 yo_waka
+
+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,75 @@
+# SeedSnapshot
+
+[![Build Status](https://travis-ci.org/waka/seed-snapshot.png?branch=master)](https://travis-ci.org/waka/seed-snapshot)
+
+This library manage of dump/restore data by database.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+group :test do
+  gem 'seed-snapshot'
+end
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install seed-snapshot
+
+## Usage
+
+Configuration in RSpec with DatabaseCleaner (optional).
+
+```
+require 'seed-snapshot'
+
+RSpec.configure do |config|
+  tables = [User, Item]
+
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :transaction
+
+    if SeedSnapshot.exists?
+      SeedSnapshot.restore(tables)
+    else
+      # load seed data normally
+    end
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.start
+  end
+
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
+
+  config.after(:suite) do
+    unless SeedSnapshot.exists?
+      SeedSnapshot.dump(tables)
+    end
+  end
+end
+```
+
+## Development
+
+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.
+
+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/waka/seed-snapshot.
+
+
+## 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,9 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "lib" << "test"
+  t.test_files = Dir.glob("test/**/*_test.rb")
+end
+
+task default: :test

data/bin/console

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

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/lib/seed-snapshot.rb

@@ -0,0 +1,34 @@
+require 'seed/configuration'
+require 'seed/mysql'
+require 'seed/snapshot'
+
+module SeedSnapshot
+  # @param Array[ActiveRecord::Base] classes
+  # @param Array[ActiveRecord::Base] ignore_classes
+  # @param Boolean force
+  def self.dump(classes: [], ignore_classes: [], force: false)
+    snapshot = Seed::Snapshot.new(self.configuration)
+    snapshot.dump(classes, ignore_classes, force)
+  end
+
+  def self.restore
+    snapshot = Seed::Snapshot.new(self.configuration)
+    snapshot.restore
+  end
+
+  # @return Boolean
+  def self.exists?
+    snapshot = Seed::Snapshot.new(self.configuration)
+    snapshot.exist_path?
+  end
+
+  def self.clean
+    snapshot = Seed::Snapshot.new(self.configuration)
+    snapshot.clean
+  end
+
+  # @return Seed::Configuration
+  def self.configuration
+    Seed::Configuration.new
+  end
+end

data/lib/seed/configuration.rb

@@ -0,0 +1,36 @@
+require 'active_record'
+
+module Seed
+  class Configuration
+    def initialize
+      # error if adapter is not mysql
+      raise 'seed-snapshot support only MySQL' unless adapter_name == 'Mysql2'
+    end
+
+    def adapter_name
+      @adapter_name ||= ActiveRecord::Base.connection.adapter_name
+    end
+
+    def schema_version
+      @schema_version ||= ActiveRecord::Migrator.current_version
+    end
+
+    def database_options
+      @options ||= ActiveRecord::Base.connection.raw_connection.query_options
+    end
+
+    # ${Rails.root}/tmp/dump
+    def base_path
+      Pathname.new(Dir.pwd).join('tmp').join('dump')
+    end
+
+    # ${Rails.root}/tmp/dump/123456789.sql'
+    def current_version_path
+      base_path.join(schema_version.to_s + '.sql')
+    end
+
+    def make_tmp_dir
+      FileUtils.mkdir_p(base_path) unless File.exist?(base_path)
+    end
+  end
+end

data/lib/seed/mysql.rb

@@ -0,0 +1,23 @@
+module Seed
+  class Mysql
+    def self.dump(file_path, username:, password:, host:, port:, database:, tables:, ignore_tables:)
+      host = 'localhost' unless host
+      cmd = "MYSQL_PWD=#{password} mysqldump -u #{username} -h #{host} #{database} -t #{allow_tables_option(tables)} #{ignore_tables_option(ignore_tables)} > #{file_path}"
+      system cmd
+    end
+
+    def self.restore(file_path, username:, password:, host:, port:, database:)
+      host = 'localhost' unless host
+      cmd = "MYSQL_PWD=#{password} mysql -u #{username} -h #{host} #{database} < #{file_path}"
+      system cmd
+    end
+
+    def self.allow_tables_option(tables)
+      tables.join(' ')
+    end
+
+    def self.ignore_tables_option(tables)
+      tables.map { |table| "--ignore-table=#{table}" }.join(' ')
+    end
+  end
+end

data/lib/seed/snapshot.rb

@@ -0,0 +1,75 @@
+module Seed
+  class Snapshot
+    def initialize(configuration)
+      @configuration = configuration
+    end
+
+    def dump(classes = [], ignore_classes = [], force_dump = false)
+      @configuration.make_tmp_dir
+
+      if exist_path? && !force_dump
+        puts 'Dump file already exists for current schema.'
+        return
+      end
+
+      Mysql.dump(
+        @configuration.current_version_path,
+        options.merge({
+          tables: tables(classes),
+          ignore_tables: ignore_tables(ignore_classes)
+        })
+      )
+    end
+
+    def restore
+      @configuration.make_tmp_dir
+
+      unless exist_path?
+        puts "Dump file does not exist for current schema."
+        return
+      end
+
+      Mysql.restore(
+        @configuration.current_version_path,
+        options
+      )
+    end
+
+    def clean
+      unless exist_path?
+        puts "Dump file does not exist for current schema."
+        return
+      end
+
+      version_path = @configuration.current_version_path
+      File.delete(version_path)
+    end
+
+    def exist_path?
+      version_path = @configuration.current_version_path
+      File.exist?(version_path)
+    end
+
+    def options
+      db = @configuration.database_options
+      {
+        username: db[:username],
+        password: db[:password],
+        host:     db[:host],
+        port:     db[:port],
+        database: db[:database]
+      }
+    end
+
+    def tables(classes)
+      classes.map do |cls|
+        cls.table_name
+      end
+    end
+
+    def ignore_tables(classes)
+      db = @configuration.database_options[:database]
+      tables(classes).push("#{db}.schema_migrations")
+    end
+  end
+end

data/lib/seed/version.rb

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

data/lib/seed_snapshot/version.rb

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

data/seed-snapshot.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'seed_snapshot/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'seed-snapshot'
+  spec.version       = SeedSnapshot::VERSION
+  spec.authors       = ['yo_waka']
+  spec.email         = ['y.wakahara@gmail.com']
+
+  spec.summary       = %q{Easy dump/restore tool for ActiveRecord.}
+  spec.description   = %q{Easy dump/restore tool for ActiveRecord.}
+  spec.homepage      = 'https://github.com/waka/seed-snapshot'
+  spec.license       = 'MIT'
+
+  spec.require_paths = ['lib']
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'erubis'
+  spec.add_development_dependency 'mysql2', '>= 0.3', '< 0.4'
+  spec.add_runtime_dependency 'activerecord', '>= 4.2'
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: seed-snapshot
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- yo_waka
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-08-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: erubis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+description: Easy dump/restore tool for ActiveRecord.
+email:
+- y.wakahara@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/seed-snapshot.rb
+- lib/seed/configuration.rb
+- lib/seed/mysql.rb
+- lib/seed/snapshot.rb
+- lib/seed/version.rb
+- lib/seed_snapshot/version.rb
+- seed-snapshot.gemspec
+homepage: https://github.com/waka/seed-snapshot
+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.5.2
+signing_key: 
+specification_version: 4
+summary: Easy dump/restore tool for ActiveRecord.
+test_files: []