activerecord-mysql-structure 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9e8079dbc65050e8cd8e2533b2580eb1c6931ea3
+  data.tar.gz: e72fac50dbe88c0db284679643405d7d0a396e14
+SHA512:
+  metadata.gz: cc78a906a23c9009aba879cdb885b5db1bfedd9fa53154d13bfb117904dc10e513ef849d17577d4c70c6259be80cb87701933fdd4467ce95a63416243e25fcc7
+  data.tar.gz: 1df09131d3bb0c325a1dd1a73320e0e2b2bae84f6933505945c07fea7c0af432c8e742fc3b979fea2696d723ff8ff2b9f1208785f05bb3386fafc6ccee83955e

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.1.2
+  - 2.1

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,13 @@
+#License and Copyright
+Copyright (c) 2014, PagerDuty
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+* Neither the name of activerecord-mysql-structure nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,26 @@
+# ActiveRecord::Mysql::Structure
+
+This gem improves ActiveRecord's dumping of MySQL schema to a `structure.sql` file.
+- `AUTO_INCREMENT` values will not be written, preventing noisy diffs
+- `DROP TABLE IF EXISTS` statements will be prepended to `CREATE_TABLE` statements, mimicking the `force: true` option normally captured in `schema.rb`
+- adds newline to EOF
+
+It is intended for use with ActiveRecord 3 only.
+The `AUTO_INCREMENT` functionality is unlikely to ever be added to Rails master as it uses the `mysqldump` command directly.
+As of this writing, `mysqldump` has no support for ignoring `AUTO_INCREMENT` output.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activerecord-mysql-structure'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activerecord-mysql-structure

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+

data/activerecord-mysql-structure.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'activerecord-mysql-structure/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'activerecord-mysql-structure'
+  spec.version       = ActiveRecord::Mysql::Structure::VERSION
+  spec.authors       = ['Steve Rice']
+  spec.email         = ['steve@pagerduty.com']
+  spec.summary       = 'Cleaner structure.sql for MySQL.'
+  spec.description   = ''
+  spec.homepage      = 'https://github.com/PagerDuty/activerecord-mysql-structure'
+  spec.license       = 'Apache 2'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+
+  spec.add_runtime_dependency 'activerecord', '~> 3'
+end

data/lib/activerecord-mysql-structure.rb

@@ -0,0 +1,15 @@
+require 'active_support'
+
+begin
+  require 'rails'
+rescue LoadError
+  # nothing to do! yay!
+end
+
+if defined? Rails
+  require 'activerecord-mysql-structure/railtie'
+else
+  ActiveSupport.on_load :active_record do
+    require 'activerecord-mysql-structure/base'
+  end
+end

data/lib/activerecord-mysql-structure/active_record/v3/connection_adapters/abstract_mysql_adapter.rb

@@ -0,0 +1,27 @@
+require 'active_record/connection_adapters/abstract_mysql_adapter'
+
+module ActiveRecord
+  module ConnectionAdapters
+    class AbstractMysqlAdapter < AbstractAdapter
+
+      # Override this to add DROP TABLE IF EXISTS statements to each CREATE TABLE
+      def structure_dump #:nodoc:
+        if supports_views?
+          sql = "SHOW FULL TABLES WHERE Table_type = 'BASE TABLE'"
+        else
+          sql = "SHOW TABLES"
+        end
+
+        select_all(sql).map { |table|
+          table.delete('Table_type')
+          sql = "SHOW CREATE TABLE #{quote_table_name(table.to_a.first.last)}"
+          "DROP TABLE IF EXISTS #{quote_table_name(table.to_a.first.last)};\n\n" + exec_query(sql).first['Create Table'] + ";\n\n" # CHANGE 1 of 2 FROM RAILS
+        }.join.gsub(/\s+AUTO_INCREMENT=\d+\s+/, ' ') # CHANGE 2 of 2 FROM RAILS
+      end
+
+      def dump_schema_information #:nodoc:
+        "#{super}\n"
+      end
+    end
+  end
+end

data/lib/activerecord-mysql-structure/base.rb

@@ -0,0 +1,5 @@
+if ActiveRecord::VERSION::MAJOR == 3
+  require 'activerecord-mysql-structure/active_record/v3/connection_adapters/abstract_mysql_adapter'
+else
+  raise 'activerecord-mysql-structure supports ActiveRecord version 3 only'
+end

data/lib/activerecord-mysql-structure/railtie.rb

@@ -0,0 +1,13 @@
+module ActiveRecord
+  module Mysql
+    module Structure
+      class Railtie < Rails::Railtie
+        initializer 'activerecord-mysql-structure' do
+          ActiveSupport.on_load :active_record do
+            require 'activerecord-mysql-structure/base'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/activerecord-mysql-structure/version.rb

@@ -0,0 +1,7 @@
+module ActiveRecord
+  module Mysql
+    module Structure
+      VERSION = '0.0.2'
+    end
+  end
+end

data/spec/activerecord/mysql/structure_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+require 'active_record'
+require 'activerecord-mysql-structure/base'
+
+describe ActiveRecord::Mysql::Structure do
+  it 'has a version number' do
+    expect(ActiveRecord::Mysql::Structure::VERSION).not_to be nil
+  end
+
+  context 'AbstractMysqlAdapter' do
+    let(:adapter) { ActiveRecord::ConnectionAdapters::AbstractMysqlAdapter.new(nil, nil, nil, prepared_statements: true) }
+
+    describe '#structure_dump' do
+      before do
+        expect(adapter).to receive(:select_all).with(anything).and_return [{'Tables_in_database' => 'foobar'}]
+        expect(adapter).to receive(:structure_dump).and_call_original
+        expect(adapter).to receive(:supports_views?).and_return false
+        expect(adapter).to receive(:exec_query).and_return [{
+          'Create Table' => <<-sql
+            CREATE TABLE `foobar` (
+              `id` int(11) NOT NULL AUTO_INCREMENT,
+              `some_column` varchar(255) COLLATE utf8mb4_unicode_ci NOT NULL
+              PRIMARY KEY (`id`)
+            ) ENGINE=InnoDB AUTO_INCREMENT=#{(0..1000).to_a.sample} DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci ROW_FORMAT=DYNAMIC;
+          sql
+        }]
+      end
+
+      it 'adds DROP TABLE IF EXISTS statements' do
+        expect(adapter.structure_dump).to include 'DROP TABLE IF EXISTS `foobar`'
+      end
+
+      it 'does not include AUTO_INCREMENT value' do
+        expect(adapter.structure_dump).not_to include 'AUTO_INCREMENT='
+      end
+
+      it 'ends with a newline' do
+        expect(adapter.structure_dump.slice(-1)).to eq "\n"
+      end
+    end
+
+    describe '#dump_schema_information' do
+      before do
+        expect(adapter).to receive(:select_values).and_return %w(
+          20140407202440
+          20140407220022
+          20140407220125
+          20140409230054
+          20140424221613
+        )
+      end
+
+      it 'ends with a newline' do
+        expect(adapter.dump_schema_information.slice(-1)).to eq "\n"
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'activerecord-mysql-structure'

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-mysql-structure
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Steve Rice
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+description: ''
+email:
+- steve@pagerduty.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- activerecord-mysql-structure.gemspec
+- lib/activerecord-mysql-structure.rb
+- lib/activerecord-mysql-structure/active_record/v3/connection_adapters/abstract_mysql_adapter.rb
+- lib/activerecord-mysql-structure/base.rb
+- lib/activerecord-mysql-structure/railtie.rb
+- lib/activerecord-mysql-structure/version.rb
+- spec/activerecord/mysql/structure_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/PagerDuty/activerecord-mysql-structure
+licenses:
+- Apache 2
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Cleaner structure.sql for MySQL.
+test_files:
+- spec/activerecord/mysql/structure_spec.rb
+- spec/spec_helper.rb