activerecord_sane_schema_dumper 0.0.1 → 0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4346ff041884ed58c8867b5ab3241c1da130bec6
-  data.tar.gz: ac308af02b60616a8e9beb6830ecde852b0f34d8
+  metadata.gz: e0a3ab715250150b68f6f394053ef5da57c9e596
+  data.tar.gz: 8762689073395c68326f974953dc0c1a06654b41
 SHA512:
-  metadata.gz: d4eb1cf8bdfe77dcdf091a523b0c32160ab8e3dbbae226051f87975ff640e1bd313432ea8cc83c35204a832f63a30d694556d7f9711d9be027d1fa0a7d9db22e
-  data.tar.gz: 8b768e623c20120215baed959dd5231bc1e5eee28b732e4dbc2ee70ea34b6b33e3a497b744af482cee8af4491e21918daf6179dc9766873cd18d7fc6e5bd3385
+  metadata.gz: 2ae60194b404d8da358d456025a155fe568f02c5c06f97695a4c8af7d642c8e636eab5c7a6bccd47d6d6d19905dff9f660d9996eda847a148d4ea0a6f386b105
+  data.tar.gz: f00e32d3da594094a77728b88a63a6b24bef27a3374eaaa20cd61ae72de94b0e8f7337e3d4e86513b4957b190c239028ffe2822399f157ab34a9fca96da43559

data/README.md

@@ -16,7 +16,35 @@ gem 'activerecord_sane_schema_dumper'
 
 ## Usage
 
-The gem modifies the behavior of Rails’ `rake db:schema:dump` task.
+The gem modifies the behavior of Rails’ `rake db:schema:dump` task. This task
+is part of Rails migrations process to ensure that `db/schema.rb` stays in-sync
+with your local database.
+
+It removes all useless whitespace that Rails adds so adding/modifying/removing
+columns from your tables only touches relevant lines (because other table lines
+do not try to stay aligned).
+
+### Before
+
+```ruby
+create_table "event_data", force: true do |t|
+  t.string   "event_external_id"
+  t.json     "data",              default: {}
+  t.datetime "created_at",                     null: false
+  t.datetime "updated_at",                     null: false
+end
+```
+
+### After
+
+```ruby
+create_table "event_data", force: true do |t|
+  t.string "event_external_id"
+  t.json "data", default: {}
+  t.datetime "created_at", null: false
+  t.datetime "updated_at", null: false
+end
+```
 
 ## License
 

data/activerecord_sane_schema_dumper.gemspec

@@ -20,4 +20,6 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 1.7'
   spec.add_development_dependency 'rake', '~> 10.0'
+
+  spec.add_dependency 'rails', '> 4', '< 5'
 end

data/lib/active_record/sane_schema_dumper/extension.rb

@@ -0,0 +1,24 @@
+module ActiveRecord
+  module SaneSchemaDumper
+    module Extension
+      extend ActiveSupport::Concern
+
+      included do
+        alias_method_chain :table, :sane_alignment
+      end
+
+      def table_with_sane_alignment(table, main_stream)
+        # Call the original method to populate our custom stream
+        stream = StringIO.new
+        table_without_sane_alignment(table, stream)
+
+        # Rewind the stream and remove useless whitespace
+        content = stream.tap(&:rewind).read.gsub(/(?<!^)(?<!\s)[ ]{2,}/, ' ')
+        main_stream.print(content)
+
+        # Rails expects the `#table` method to return the main stream
+        main_stream
+      end
+    end
+  end
+end

data/lib/active_record/sane_schema_dumper/railtie.rb

@@ -0,0 +1,12 @@
+require 'activerecord_sane_schema_dumper'
+require 'rails'
+
+module ActiveRecord::SaneSchemaDumper
+  class Railtie < Rails::Railtie
+    initializer 'activerecord_sane_schema_dumper.active_record' do
+      ActiveSupport.on_load :active_record do
+        ActiveRecord::SchemaDumper.send(:include, ActiveRecord::SaneSchemaDumper::Extension)
+      end
+    end
+  end
+end

data/lib/active_record/sane_schema_dumper/version.rb

@@ -1,6 +1,5 @@
 module ActiveRecord
-end
-
-module ActiveRecord::SaneSchemaDumper
-  VERSION = '0.0.1'
+  module SaneSchemaDumper
+    VERSION = '0.1'.freeze
+  end
 end

data/lib/activerecord_sane_schema_dumper.rb

@@ -1,4 +1,10 @@
+# Version
 require 'active_record/sane_schema_dumper/version'
 
-module ActiveRecord::SaneSchemaDumper
-end
+# Dependencies
+require 'active_record'
+require 'active_support'
+
+# Modules
+require 'active_record/sane_schema_dumper/extension'
+require 'active_record/sane_schema_dumper/railtie'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activerecord_sane_schema_dumper
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: '0.1'
 platform: ruby
 authors:
 - Rémi Prévost
@@ -38,6 +38,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
 description: ActiveRecord::SaneSchemaDumper removes useless/harmful whitespace from
   Rails’ generated `db/schema.rb` files.
 email:
@@ -52,6 +72,8 @@ files:
 - README.md
 - Rakefile
 - activerecord_sane_schema_dumper.gemspec
+- lib/active_record/sane_schema_dumper/extension.rb
+- lib/active_record/sane_schema_dumper/railtie.rb
 - lib/active_record/sane_schema_dumper/version.rb
 - lib/activerecord_sane_schema_dumper.rb
 homepage: https://github.com/mirego/activerecord_sane_schema_dumper