schema_auto_foreign_keys 0.1.0

data/spec/schema_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe ActiveRecord::Schema do
+
+  let(:connection) { ActiveRecord::Base.connection }
+
+  context "defining with auto_index and auto_create" do
+
+    before(:each) do
+      with_fk_config(auto_create: true, auto_index: true) do
+        ActiveRecord::Schema.define do
+
+          create_table :users, :force => :cascade do
+          end
+
+          create_table :colors, :force => :cascade do
+          end
+
+          create_table :shoes, :force => :cascade do
+          end
+
+          create_table :posts, :force => true do |t|
+            t.integer :user_id, :references => :users, :index => true
+            t.integer :shoe_id, :references => :shoes   # should not have an index (except mysql)
+            t.integer :color_id   # should not have a foreign key nor index
+          end
+        end
+      end
+    end
+
+    it "creates only explicity added indexes" do
+      expected = SchemaDev::Rspec::Helpers.mysql? ? 2 : 1
+      expect(connection.tables.collect { |table| connection.indexes(table) }.flatten.size).to eq(expected)
+    end
+
+    it "should create only explicity added foriegn keys" do
+      expect(connection.tables.collect { |table| connection.foreign_keys(table) }.flatten.size).to eq(2)
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,52 @@
+require 'simplecov'
+require 'simplecov-gem-profile'
+SimpleCov.start "gem"
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rspec'
+require 'active_record'
+require 'schema_auto_foreign_keys'
+require 'schema_dev/rspec'
+
+SchemaDev::Rspec.setup
+
+Dir[File.dirname(__FILE__) + "/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  config.include(SchemaPlus::Matchers)
+  config.warnings = true
+  config.around(:each) do |example|
+    with_fk_config(auto_create: true, auto_index: true) do
+      ActiveRecord::Migration.suppress_messages do
+        example.run
+      end
+    end
+  end
+end
+
+def with_fk_config(opts={}, &block)
+  save = opts.keys.map{|key| [key, SchemaPlus::ForeignKeys.config.send(key)]}.to_h
+  begin
+    SchemaPlus::ForeignKeys.config.update_attributes(opts)
+    yield
+  ensure
+    SchemaPlus::ForeignKeys.config.update_attributes(save)
+  end
+end
+
+def with_fk_auto_create(value = true, &block)
+  with_fk_config(:auto_create => value, &block)
+end
+
+def define_schema(&block)
+  ActiveRecord::Schema.define do
+    connection.tables.each do |table|
+      drop_table table, force: :cascade
+    end
+    instance_eval &block
+  end
+end
+
+SimpleCov.command_name "[ruby#{RUBY_VERSION}-activerecord#{::ActiveRecord.version}-#{ActiveRecord::Base.connection.adapter_name}]"

data/spec/support/matchers/automatic_foreign_key_matchers.rb

@@ -0,0 +1,2 @@
+require 'support/matchers/reference'
+require 'support/matchers/have_index'

data/spec/support/matchers/have_index.rb

@@ -0,0 +1,60 @@
+module SchemaPlus::Matchers
+
+  class HaveIndex
+
+    def initialize(expectation, options = {})
+      set_required_columns(expectation)
+      @unique = options.delete(:unique)
+      @name   = options.delete(:name)
+    end
+
+    def matches?(model)
+      @too_many = nil
+      @model = model
+      indexes = @model.indexes.select { |index| index.columns.to_set == @required_columns }
+      if indexes.length > 1
+        @too_many = indexes.length
+        return false
+      end
+      index = indexes.first
+      return index && (@unique ? index.unique : true) && (@name ? index.name == @name.to_s : true)
+    end
+
+    def failure_message(should_not = false)
+      invert = should_not ? "not to" : "to"
+      what = ""
+      what += "unique " if @unique
+      what += "named '{@name}'" if @name
+      msg = "Expected #{@model.table_name} #{invert} contain one #{what}index on #{@required_columns.entries.inspect}"
+      msg += "; found #{@too_many} indexes" if @too_many
+      msg
+    end
+
+    def failure_message_when_negated
+      failure_message(true)
+    end
+
+    def on(expectation)
+      set_required_columns(expectation)
+      self
+    end
+
+    private
+    def set_required_columns(expectation)
+      @required_columns = Array(expectation).collect(&:to_s).to_set
+    end
+
+  end
+
+  def have_index(*expectation)
+    options = expectation.extract_options!
+    HaveIndex.new(expectation, options)
+  end
+
+  def have_unique_index(*expectation)
+    options = expectation.extract_options!
+    options[:unique] = true
+    HaveIndex.new(expectation, options)
+  end
+
+end

data/spec/support/matchers/reference.rb

@@ -0,0 +1,79 @@
+module SchemaPlus::Matchers
+
+  class Reference
+    def initialize(expected)
+      @column = @on_update = @on_delete = @deferrable = @name = @to_table = @primary_key = nil
+      unless expected.empty?
+        @to_table, @primary_key = Array(expected).map(&:to_s)
+      end
+    end
+
+    def matches?(model)
+      @model = model
+      if @to_table
+        @result = @model.foreign_keys.select do |fk|
+          fk.to_table == @to_table &&
+            @primary_key.blank? ? true : fk.primary_key == @primary_key
+        end
+      else
+        @result = @model.foreign_keys
+      end
+      @result.keep_if {|fk| Array.wrap(fk.column) == @column } if @column
+      @result.keep_if {|fk| fk.on_update == @on_update } if @on_update
+      @result.keep_if {|fk| fk.on_delete == @on_delete } if @on_delete
+      @result.keep_if {|fk| fk.deferrable == @deferrable } if @deferrable
+      @result.keep_if {|fk| fk.name == @name } if @name
+      !@result.empty?
+    end
+
+    def failure_message(should_not = false)
+      target_column = @column.present? ? "(#{Array.wrap(@column).join(', ')})" : ""
+      destinantion_column = @to_table ? "#{@to_table}(#{Array.wrap(@primary_key).join(', ')})" : "anything"
+      invert = should_not ? 'not' : ''
+      msg = "Expected #{@model.table_name}#{target_column} to #{invert} reference #{destinantion_column}"
+      with = []
+      with << "on_update=#{@on_update.inspect}" if @on_update
+      with << "on_delete=#{@on_delete.inspect}" if @on_delete
+      with << "deferrable=#{@deferrable.inspect}" if @deferrable
+      with << "name=#{@name.inspect}" if @name
+      msg += " with #{with.join(" and ")}" if with.any?
+      msg
+    end
+
+    def failure_message_when_negated
+      failure_message(true)
+    end
+
+    def on(*column)
+      @column = column.collect(&:to_s)
+      self
+    end
+
+    def on_update(action)
+      @on_update = action
+      self
+    end
+
+    def deferrable(action)
+      @deferrable = action
+      self
+    end
+
+    def on_delete(action)
+      @on_delete = action
+      self
+    end
+
+    def with_name(action)
+      @name = action
+      self
+    end
+
+  end
+
+  def reference(*expect)
+    Reference.new(expect)
+  end
+
+end
+

metadata

@@ -0,0 +1,191 @@
+--- !ruby/object:Gem::Specification
+name: schema_auto_foreign_keys
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ronen barzel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: schema_plus_foreign_keys
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: schema_plus_indexes
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: schema_dev
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: simplecov-gem-profile
+  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'
+description: In an ActiveRecord migration, set the default to create a foreign key
+  and index for all columns that define relatoins.
+email:
+- ronen@barzel.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- gemfiles/Gemfile.base
+- gemfiles/activerecord-4.2.0/Gemfile.base
+- gemfiles/activerecord-4.2.0/Gemfile.mysql2
+- gemfiles/activerecord-4.2.0/Gemfile.postgresql
+- gemfiles/activerecord-4.2.0/Gemfile.sqlite3
+- gemfiles/activerecord-4.2.1/Gemfile.base
+- gemfiles/activerecord-4.2.1/Gemfile.mysql2
+- gemfiles/activerecord-4.2.1/Gemfile.postgresql
+- gemfiles/activerecord-4.2.1/Gemfile.sqlite3
+- lib/schema_auto_foreign_keys.rb
+- lib/schema_auto_foreign_keys/active_record/connection_adapters/sqlite3_adapter.rb
+- lib/schema_auto_foreign_keys/middleware/migration.rb
+- lib/schema_auto_foreign_keys/middleware/schema.rb
+- lib/schema_auto_foreign_keys/version.rb
+- schema_auto_foreign_keys.gemspec
+- schema_dev.yml
+- spec/migration_spec.rb
+- spec/schema_spec.rb
+- spec/spec_helper.rb
+- spec/support/matchers/automatic_foreign_key_matchers.rb
+- spec/support/matchers/have_index.rb
+- spec/support/matchers/reference.rb
+homepage: https://github.com/SchemaPlus/schema_auto_foreign_keys
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Automatically define foreign key constraints in ActiveRecord
+test_files:
+- spec/migration_spec.rb
+- spec/schema_spec.rb
+- spec/spec_helper.rb
+- spec/support/matchers/automatic_foreign_key_matchers.rb
+- spec/support/matchers/have_index.rb
+- spec/support/matchers/reference.rb