activerecord_sane_schema_dumper 0.1 → 0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e0a3ab715250150b68f6f394053ef5da57c9e596
-  data.tar.gz: 8762689073395c68326f974953dc0c1a06654b41
+  metadata.gz: 93d6a00e2896f8ff62dff58d34e84ea54f71a890
+  data.tar.gz: 839677fa461fd1ba75b13167bb6ef9cd703a4fc7
 SHA512:
-  metadata.gz: 2ae60194b404d8da358d456025a155fe568f02c5c06f97695a4c8af7d642c8e636eab5c7a6bccd47d6d6d19905dff9f660d9996eda847a148d4ea0a6f386b105
-  data.tar.gz: f00e32d3da594094a77728b88a63a6b24bef27a3374eaaa20cd61ae72de94b0e8f7337e3d4e86513b4957b190c239028ffe2822399f157ab34a9fca96da43559
+  metadata.gz: ccac16c207e2766dffb85da326f78aaebd47fd8d7957ccb66f5fc4e8951f3014ae44a9cd952607d10aa00ffe84aecfc01a337ea9caa85cb33006f06809067f0f
+  data.tar.gz: 4cdabf8e177ce1c108c63410005d9aa27eac6a2faab33f39477355e9db8f475e6fe029a32e2329e50b23d4f86596280dec9378406b227930c2341034dcecf29e

data/.rspec

@@ -0,0 +1 @@
+--colour

data/.rubocop.yml

@@ -0,0 +1,50 @@
+AllCops:
+  Include:
+    - Rakefile
+
+Documentation:
+  Enabled: false
+
+Encoding:
+  Enabled: false
+
+LineLength:
+  Max: 200
+
+AccessModifierIndentation:
+  EnforcedStyle: outdent
+
+IfUnlessModifier:
+  Enabled: false
+
+CaseIndentation:
+  IndentWhenRelativeTo: case
+  IndentOneStep: true
+
+MethodLength:
+  CountComments: false
+  Max: 20
+
+SignalException:
+  Enabled: false
+
+ColonMethodCall:
+  Enabled: false
+
+AsciiComments:
+  Enabled: false
+
+Lambda:
+  Enabled: false
+
+RegexpLiteral:
+  Enabled: false
+
+RedundantBegin:
+  Enabled: false
+
+AssignmentInCondition:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+
+rvm:
+  - 2.1.5
+
+script: "echo 'DO IT' && bundle exec rake spec"
+
+before_script:
+  - psql -c 'create database activerecord_sane_schema_dumper_test;' -U postgres

data/README.md

@@ -5,13 +5,16 @@
 contain any useless/harmful whitespace column alignment.
 
 [![Gem Version](http://img.shields.io/gem/v/activerecord_sane_schema_dumper.svg)](https://rubygems.org/gems/activerecord_sane_schema_dumper)
+[![Build Status](http://img.shields.io/travis/mirego/activerecord_sane_schema_dumper.svg)](https://travis-ci.org/mirego/activerecord_sane_schema_dumper)
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add this line to your application’s Gemfile in your `development` group:
 
 ```ruby
-gem 'activerecord_sane_schema_dumper'
+group :development do
+  gem 'activerecord_sane_schema_dumper'
+end
 ```
 
 ## Usage
@@ -27,6 +30,7 @@ do not try to stay aligned).
 ### Before
 
 ```ruby
+# db/schema.rb
 create_table "event_data", force: true do |t|
   t.string   "event_external_id"
   t.json     "data",              default: {}
@@ -35,9 +39,25 @@ create_table "event_data", force: true do |t|
 end
 ```
 
+But what happens if I remove the `data` column and regenerate `db/schema.rb`? Here’s the resulting diff:
+
+```ruby
+   create_table "event_data", force: true do |t|
+     t.string   "event_external_id"
+-    t.datetime "created_at",                     null: false
+-    t.datetime "updated_at",                     null: false
+-    t.json     "data",              default: {}
++    t.datetime "created_at",        null: false
++    t.datetime "updated_at",        null: false
+   end
+```
+
+We’ve removed the `data` column but `created_at` and `updated_at` lines are affected too. This is not good.
+
 ### After
 
 ```ruby
+# db/schema.rb
 create_table "event_data", force: true do |t|
   t.string "event_external_id"
   t.json "data", default: {}
@@ -46,9 +66,22 @@ create_table "event_data", force: true do |t|
 end
 ```
 
+If I remove the `data` column and regenerate the `db/schema.rb` file, only the relevant line will be touched:
+
+```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
+```
+
+One removed column, one affected line in the table definition. Much better.
+
 ## License
 
-`ActiveRecord::SaneSchemaDumper` is © 2014 [Mirego](http://www.mirego.com) and may be freely distributed under the [New BSD license](http://opensource.org/licenses/BSD-3-Clause).  See the [`LICENSE.md`](https://github.com/mirego/activerecord_json_validator/blob/master/LICENSE.md) file.
+`ActiveRecord::SaneSchemaDumper` is © 2014 [Mirego](http://www.mirego.com) and may be freely distributed under the [New BSD license](http://opensource.org/licenses/BSD-3-Clause).  See the [`LICENSE.md`](https://github.com/mirego/activerecord_sane_schema_dumper/blob/master/LICENSE.md) file.
 
 ## About Mirego
 

data/Rakefile

@@ -1 +1,10 @@
+require 'rake'
 require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+task default: :spec
+
+desc 'Run all specs'
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.pattern = 'spec/**/*_spec.rb'
+end

data/activerecord_sane_schema_dumper.gemspec

@@ -20,6 +20,10 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 1.7'
   spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rubocop', '0.27.1'
+  spec.add_development_dependency 'phare'
+  spec.add_development_dependency 'rspec', '~> 3.1'
+  spec.add_development_dependency 'pg'
 
-  spec.add_dependency 'rails', '> 4', '< 5'
+  spec.add_dependency 'rails', '>= 4', '< 5'
 end

data/lib/active_record/sane_schema_dumper/railtie.rb

@@ -1,11 +1,13 @@
 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)
+module ActiveRecord
+  module 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,5 +1,5 @@
 module ActiveRecord
   module SaneSchemaDumper
-    VERSION = '0.1'.freeze
+    VERSION = '0.2'.freeze
   end
 end

data/spec/activerecord_sane_schema_dumper_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+describe ActiveRecord::SaneSchemaDumper do
+  before do
+    run_migration do
+      create_table(:users, force: true) do |t|
+        t.string :name, limit: 100
+        t.text :profile
+        t.datetime :created_at, null: false
+        t.datetime :updated_at, null: false
+      end
+    end
+  end
+
+  let(:stream) { StringIO.new }
+  let(:output) do
+    ActiveRecord::SchemaDumper.dump(ActiveRecord::Base.connection, stream)
+    stream.rewind
+    stream.read
+  end
+
+  context 'with SaneSchemaDumper behavior' do
+    before do
+      ActiveRecord::SchemaDumper.send(:include, ActiveRecord::SaneSchemaDumper::Extension)
+    end
+
+    let(:expected_table) do
+      <<EOF
+  create_table "users", force: true do |t|
+    t.string "name", limit: 100
+    t.text "profile"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+  end
+EOF
+    end
+
+    it { expect(output).to include(expected_table) }
+  end
+
+  context 'without SaneSchemaDumper behavior' do
+    before do
+      allow_any_instance_of(ActiveRecord::SchemaDumper).to receive(:table) do |instance, *args|
+        instance.send :table_without_sane_alignment, *args
+      end
+    end
+
+    let(:expected_table) do
+      <<EOF
+  create_table "users", force: true do |t|
+    t.string   "name",       limit: 100
+    t.text     "profile"
+    t.datetime "created_at",             null: false
+    t.datetime "updated_at",             null: false
+  end
+EOF
+    end
+
+    it { expect(output).to include(expected_table) }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+
+# RSpec
+require 'rspec'
+
+# Database
+require 'pg'
+
+# ActiveRecord::SaneSchemaDumper
+require 'activerecord_sane_schema_dumper'
+
+# Require our macros and extensions
+Dir[File.expand_path('../../spec/support/macros/**/*.rb', __FILE__)].map(&method(:require))
+
+RSpec.configure do |config|
+  # Include our macros
+  config.include DatabaseMacros
+
+  config.before :each do
+    ActiveRecord::Base.establish_connection(
+      adapter: 'postgresql',
+      database: 'activerecord_sane_schema_dumper_test',
+      user: 'postgres',
+      schema_search_path: 'public'
+    )
+
+    ActiveRecord::Base.logger = ActiveRecord::Migration.verbose = false
+  end
+end

data/spec/support/macros/database_macros.rb

@@ -0,0 +1,13 @@
+module DatabaseMacros
+  # Run migrations in the test database
+  def run_migration(&block)
+    # Create a new migration class
+    klass = Class.new(ActiveRecord::Migration)
+
+    # Create a new `up` that executes the argument
+    klass.send(:define_method, :up) { instance_exec(&block) }
+
+    # Create a new instance of it and execute its `up` method
+    klass.new.up
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord_sane_schema_dumper
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: '0.2'
 platform: ruby
 authors:
 - Rémi Prévost
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-14 00:00:00.000000000 Z
+date: 2014-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,11 +38,67 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.27.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.27.1
+- !ruby/object:Gem::Dependency
+  name: phare
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: pg
+  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: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4'
     - - "<"
@@ -52,7 +108,7 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4'
     - - "<"
@@ -67,6 +123,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
 - Gemfile
 - LICENSE.md
 - README.md
@@ -76,6 +135,9 @@ files:
 - lib/active_record/sane_schema_dumper/railtie.rb
 - lib/active_record/sane_schema_dumper/version.rb
 - lib/activerecord_sane_schema_dumper.rb
+- spec/activerecord_sane_schema_dumper_spec.rb
+- spec/spec_helper.rb
+- spec/support/macros/database_macros.rb
 homepage: https://github.com/mirego/activerecord_sane_schema_dumper
 licenses:
 - BSD 3-Clause
@@ -101,4 +163,7 @@ signing_key:
 specification_version: 4
 summary: ActiveRecord::SaneSchemaDumper removes useless/harmful whitespace from Rails’
   generated `db/schema.rb` files.
-test_files: []
+test_files:
+- spec/activerecord_sane_schema_dumper_spec.rb
+- spec/spec_helper.rb
+- spec/support/macros/database_macros.rb