activerecord-clean-db-structure 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4d348caa1f27c948da0884c8ee3529031ead8486
+  data.tar.gz: a2f4f3a742cc2314d501d5e271d0e08299794d5c
+SHA512:
+  metadata.gz: 7c375392618769115389a416fa27387e567f89fe16f01cd1823b3b88e8a7cad4ffdd63ee86d97d8a42e78129a8d785ba753b1b17b14d1ef5fe243ffadf90e3ac
+  data.tar.gz: 05e165a2a0dd1479cabb35999fa0720154a7229f302834ec4ec4303621561ad85a9cd759f995eee43e137f77aefe4e7aca063fbfc8779c645129a2ae88c0cdff

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## 0.0.1    2017-02-12
+
+* Initial release.

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,116 @@
+PATH
+  remote: .
+  specs:
+    activerecord-clean-db-structure (0.1.0)
+      rails (>= 4.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (5.0.1)
+      actionpack (= 5.0.1)
+      nio4r (~> 1.2)
+      websocket-driver (~> 0.6.1)
+    actionmailer (5.0.1)
+      actionpack (= 5.0.1)
+      actionview (= 5.0.1)
+      activejob (= 5.0.1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.0.1)
+      actionview (= 5.0.1)
+      activesupport (= 5.0.1)
+      rack (~> 2.0)
+      rack-test (~> 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.0.1)
+      activesupport (= 5.0.1)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    activejob (5.0.1)
+      activesupport (= 5.0.1)
+      globalid (>= 0.3.6)
+    activemodel (5.0.1)
+      activesupport (= 5.0.1)
+    activerecord (5.0.1)
+      activemodel (= 5.0.1)
+      activesupport (= 5.0.1)
+      arel (~> 7.0)
+    activesupport (5.0.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (7.1.4)
+    builder (3.2.3)
+    concurrent-ruby (1.0.4)
+    erubis (2.7.0)
+    globalid (0.3.7)
+      activesupport (>= 4.1.0)
+    i18n (0.8.0)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    mail (2.6.4)
+      mime-types (>= 1.16, < 4)
+    method_source (0.8.2)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    mini_portile2 (2.1.0)
+    minitest (5.10.1)
+    nio4r (1.2.1)
+    nokogiri (1.7.0.1)
+      mini_portile2 (~> 2.1.0)
+    rack (2.0.1)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (5.0.1)
+      actioncable (= 5.0.1)
+      actionmailer (= 5.0.1)
+      actionpack (= 5.0.1)
+      actionview (= 5.0.1)
+      activejob (= 5.0.1)
+      activemodel (= 5.0.1)
+      activerecord (= 5.0.1)
+      activesupport (= 5.0.1)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 5.0.1)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.2)
+      activesupport (>= 4.2.0, < 6.0)
+      nokogiri (~> 1.6)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (5.0.1)
+      actionpack (= 5.0.1)
+      activesupport (= 5.0.1)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (12.0.0)
+    sprockets (3.7.1)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.0)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (0.19.4)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    websocket-driver (0.6.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord-clean-db-structure!
+
+BUNDLED WITH
+   1.12.5

data/LICENSE

@@ -0,0 +1,28 @@
+Copyright (c) 2017, Lukas Fittl
+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 Lukas Fittl 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,42 @@
+## activerecord-clean-db-structure [ ![](https://img.shields.io/gem/v/activerecord-clean-db-structure.svg)](https://rubygems.org/gems/activerecord-clean-db-structure) [ ![](https://img.shields.io/gem/dt/activerecord-clean-db-structure.svg)](https://rubygems.org/gems/activerecord-clean-db-structure)
+
+Ever been annoyed at a constantly changing `db/structure.sql` file when using ActiveRecord and Postgres?
+
+Spent hours trying to decipher why that one team member keeps changing the file?
+
+This library is here to help!
+
+It cleans away all the unnecessary output in the file every time its updated automatically. This helps avoid merge conflicts, as well as increase readability.
+
+## Installation
+
+Add the following to your Gemfile:
+
+```ruby
+gem 'activerecord-clean-db-structure'
+```
+
+This will automatically hook the library into your `rake db:migrate` task.
+
+## Supported Rails versions
+
+Whilst there is no reason this shouldn't work on earlier versions, this has only been tested on Rails 4.2 and newer.
+
+It also assumes you use ActiveRecord with PostgreSQL - other ORMs or databases are not supported.
+
+## Caveats
+
+Currently the library assumes all your `id` columns are either SERIAL, BIGSERIAL or uuid. It also assumes the `id` is the primary key.
+
+Multi-column primary keys, as well as tables that don't have `id` as the primary key are not supported right now, and might lead to wrong output.
+
+Patches and test cases welcome!
+
+## Authors
+
+* [Lukas Fittl](https://github.com/lfittl)
+
+## License
+
+Copyright (c) 2017, Lukas Fittl<br>
+activerecord-clean-db-structure is licensed under the 3-clause BSD license, see LICENSE file for details.

data/Rakefile

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'bundler/gem_tasks'

data/activerecord-clean-db-structure.gemspec

@@ -0,0 +1,19 @@
+$:.push File.expand_path('../lib', __FILE__)
+require 'activerecord-clean-db-structure/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'activerecord-clean-db-structure'
+  s.version     = ActiveRecordCleanDbStructure::VERSION
+  s.summary     = 'Automatic cleanup for the Rails db/structure.sql file (ActiveRecord/PostgreSQL)'
+  s.description = 'Never worry about weird diffs and merge conflicts again'
+  s.authors     = ['Lukas Fittl']
+  s.email       = 'lukas@fittl.com'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {spec}/*`.split("\n")
+  s.require_paths = ['lib']
+  s.homepage      = 'https://github.com/lfittl/activerecord-clean-db-structure'
+  s.license       = 'MIT'
+
+  s.add_dependency('rails','>= 4.2')
+end

data/lib/activerecord-clean-db-structure.rb

@@ -0,0 +1 @@
+require 'activerecord-clean-db-structure/railtie' if defined?(Rails)

data/lib/activerecord-clean-db-structure/clean_dump.rb

@@ -0,0 +1,59 @@
+module ActiveRecordCleanDbStructure
+  class CleanDump
+    attr_reader :dump
+    def initialize(dump)
+      @dump = dump
+    end
+
+    def run
+      # Remove trailing whitespace
+      dump.gsub!(/[ \t]+$/, '')
+      dump.gsub!(/\A\n/, '')
+      dump.gsub!(/\n\n\z/, "\n")
+
+      # Remove version-specific output
+      dump.gsub!(/^-- Dumped.*/, '')
+      dump.gsub!(/^SET row_security = off;$/, '') # 9.5
+      dump.gsub!(/^SET idle_in_transaction_session_timeout = 0;$/, '') # 9.6
+
+      # Remove pg_stat_statements extension (its not relevant to the code)
+      dump.gsub!(/^CREATE EXTENSION IF NOT EXISTS pg_stat_statements.*/, '')
+      dump.gsub!(/^COMMENT ON EXTENSION pg_stat_statements.*/, '')
+      dump.gsub!(/^-- Name: (EXTENSION )?pg_stat_statements;.*/, '')
+
+      # Remove useless, version-specific parts of comments
+      dump.gsub!(/^-- (.*); Schema: (public|-); Owner: -.*/, '-- \1')
+
+      # Remove useless comment lines
+      dump.gsub!(/^--$/, '')
+
+      # Reduce noise for id fields by making them SERIAL instead of integer+sequence stuff
+      #
+      # This is a bit optimistic, but works as long as you don't have an id field thats not a sequence/uuid
+      dump.gsub!(/^    id integer NOT NULL,$/, '    id SERIAL PRIMARY KEY,')
+      dump.gsub!(/^    id bigint NOT NULL,$/, '    id BIGSERIAL PRIMARY KEY,')
+      dump.gsub!(/^    id uuid DEFAULT uuid_generate_v4\(\) NOT NULL,$/, '    id uuid DEFAULT uuid_generate_v4() PRIMARY KEY,')
+      dump.gsub!(/^CREATE SEQUENCE \w+_id_seq\s+START WITH 1\s+INCREMENT BY 1\s+NO MINVALUE\s+NO MAXVALUE\s+CACHE 1;$/, '')
+      dump.gsub!(/^ALTER SEQUENCE \w+_id_seq OWNED BY .*;$/, '')
+      dump.gsub!(/^ALTER TABLE ONLY \w+ ALTER COLUMN id SET DEFAULT nextval\('\w+_id_seq'::regclass\);$/, '')
+      dump.gsub!(/^ALTER TABLE ONLY \w+\s+ADD CONSTRAINT \w+_pkey PRIMARY KEY \(id\);$/, '')
+      dump.gsub!(/^-- Name: [\w_]+ id; Type: DEFAULT$/, '')
+      dump.gsub!(/^-- .*_id_seq; Type: SEQUENCE.*/, '')
+      dump.gsub!(/^-- Name: [\w_]+ \w+_pkey; Type: CONSTRAINT$/, '')
+
+      # Remove inherited tables
+      inherited_tables_regexp = /-- Name: ([\w_]+); Type: TABLE\n\n[^;]+?INHERITS \([\w_]+\);/m
+      inherited_tables = dump.scan(inherited_tables_regexp).map(&:first)
+      dump.gsub!(inherited_tables_regexp, '')
+      inherited_tables.each do |inherited_table|
+        dump.gsub!(/ALTER TABLE ONLY #{inherited_table}[^;]+;/, '')
+      end
+
+      # Remove whitespace between schema migration INSERTS to make editing easier
+      dump.gsub!(/^(INSERT INTO schema_migrations .*)\n\n/, "\\1\n")
+
+      # Reduce 2+ lines of whitespace to one line of whitespace
+      dump.gsub!(/\n{2,}/m, "\n\n")
+    end
+  end
+end

data/lib/activerecord-clean-db-structure/railtie.rb

@@ -0,0 +1,7 @@
+module ActiveRecordCleanDbStructure
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load 'activerecord-clean-db-structure/tasks/clean_db_structure.rake'
+    end
+  end
+end

data/lib/activerecord-clean-db-structure/tasks/clean_db_structure.rake

@@ -0,0 +1,13 @@
+require 'activerecord-clean-db-structure/clean_dump'
+
+Rake::Task['db:structure:dump'].enhance do
+  Rake::Task['clean_db_structure'].invoke
+end
+
+task :clean_db_structure do
+  filename = ENV['DB_STRUCTURE'] || File.join(ActiveRecord::Tasks::DatabaseTasks.db_dir, 'structure.sql')
+
+  cleaner = ActiveRecordCleanDbStructure::CleanDump.new(File.read(filename))
+  cleaner.run
+  File.write(filename, cleaner.dump)
+end

data/lib/activerecord-clean-db-structure/version.rb

@@ -0,0 +1,3 @@
+module ActiveRecordCleanDbStructure
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-clean-db-structure
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Lukas Fittl
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-02-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  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: Never worry about weird diffs and merge conflicts again
+email: lukas@fittl.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- activerecord-clean-db-structure.gemspec
+- lib/activerecord-clean-db-structure.rb
+- lib/activerecord-clean-db-structure/clean_dump.rb
+- lib/activerecord-clean-db-structure/railtie.rb
+- lib/activerecord-clean-db-structure/tasks/clean_db_structure.rake
+- lib/activerecord-clean-db-structure/version.rb
+homepage: https://github.com/lfittl/activerecord-clean-db-structure
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Automatic cleanup for the Rails db/structure.sql file (ActiveRecord/PostgreSQL)
+test_files: []